1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
use std::mem;
use std::ops::AddAssign;
use std::path::PathBuf;

use sort::Sort::*;
use sort::Sort;
use stats::Stats;

/// Struct representing a single Language.
#[cfg_attr(feature = "io", derive(Deserialize, Serialize))]
#[derive(Clone, Debug)]
pub struct Language {
    /// Number of blank lines.
    pub blanks: usize,
    /// Number of lines of code.
    pub code: usize,
    /// Number of comments(both single, and multi-line)
    pub comments: usize,
    /// A collection of files to be analysed.
    #[cfg_attr(feature = "io", serde(skip_deserializing, skip_serializing))]
    pub files: Vec<PathBuf>,
    /// A collection of statistics based on the files provide from `files`
    pub stats: Vec<Stats>,
    /// Number of total lines.
    pub lines: usize,
    /// A collection of single line comments in the language. ie. `//` in Rust.
    #[cfg_attr(feature = "io", serde(skip_deserializing, skip_serializing))]
    pub line_comment: &'static [&'static str],
    /// A collection of tuples representing the start and end of multi line
    /// comments. ie. `/* comment */` in Rust.
    #[cfg_attr(feature = "io", serde(skip_deserializing, skip_serializing))]
    pub multi_line: &'static [(&'static str, &'static str)],
    /// Whether the language supports nested multi line comments or not.
    #[cfg_attr(feature = "io", serde(skip_deserializing, skip_serializing))]
    pub nested: bool,
    /// A list of specific nested comments if this is empty all `multi_line`
    /// comments count.
    #[cfg_attr(feature = "io", serde(skip_deserializing, skip_serializing))]
    pub nested_comments: &'static [(&'static str, &'static str)],
    /// A list of quotes by default it is `""`.
    #[cfg_attr(feature = "io", serde(skip_deserializing, skip_serializing))]
    pub quotes: &'static [(&'static str, &'static str)],
}

impl Language {
    /// Constructs a new empty Language with the comments provided.
    ///
    /// ```
    /// # use tokei::*;
    /// let mut rust = Language::new(&["//"], &[("/*", "*/")]);
    /// ```
    pub fn new(line_comment: &'static [&'static str],
               multi_line: &'static [(&'static str, &'static str)])
        -> Self
    {
        Language {
            line_comment: line_comment,
            multi_line: multi_line,
            quotes: &[("\"", "\"")],
            ..Self::default()
        }
    }

    /// Convenience constructor for creating a language that has no commenting
    /// syntax.
    ///
    /// ```
    /// # use tokei::*;
    /// let empty_array: &'static [&'static str] = &[];
    /// let json = Language::new_blank();
    /// assert_eq!(json.line_comment, empty_array);
    /// ```
    pub fn new_blank() -> Self {
        Self::default()
    }

    /// Convenience constructor for creating a language that has the same
    /// commenting syntax as C like languages.
    ///
    /// ```
    /// # use tokei::*;
    /// let rust = Language::new(&["//"], &[("/*", "*/")]);
    /// let c = Language::new_c();
    ///
    /// assert_eq!(rust.line_comment, c.line_comment);
    /// assert_eq!(rust.multi_line, c.multi_line);
    /// ```
    pub fn new_c() -> Self {
        Language {
            line_comment: &["//"],
            multi_line: &[("/*", "*/")],
            quotes: &[("\"", "\"")],
            ..Self::default()
        }
    }

    /// Convenience constructor for creating a language that has the same
    /// commenting syntax as ML like languages.
    ///
    /// ```
    /// # use tokei::*;
    /// let ocaml = Language::new_multi(&[("(*", "*)")]);
    /// let coq = Language::new_func();
    ///
    /// assert_eq!(ocaml.line_comment, coq.line_comment);
    /// assert_eq!(ocaml.multi_line, coq.multi_line);
    /// ```
    pub fn new_func() -> Self {
        Language {
            multi_line: &[("(*", "*)")],
            quotes: &[("\"", "\"")],
            ..Self::default()
        }
    }

    /// Convenience constructor for creating a language that has the same
    /// commenting syntax as HTML like languages.
    ///
    /// ```
    /// # use tokei::*;
    /// let xml = Language::new_multi(&[("<!--", "-->")]);
    /// let html = Language::new_html();
    ///
    /// assert_eq!(xml.line_comment, html.line_comment);
    /// assert_eq!(xml.multi_line, html.multi_line);
    /// ```
    pub fn new_html() -> Self {
        Language {
            multi_line: &[("<!--", "-->")],
            quotes: &[("\"", "\"")],
            ..Self::default()
        }
    }

    /// Convenience constructor for creating a language that has the same
    /// commenting syntax as Bash.
    ///
    /// ```
    /// # use tokei::*;
    /// let bash = Language::new_single(&["#"]);
    /// let yaml = Language::new_hash();
    ///
    /// assert_eq!(bash.line_comment, yaml.line_comment);
    /// assert_eq!(bash.multi_line, yaml.multi_line);
    /// ```
    pub fn new_hash() -> Self {
        Self::new_single(&["#"])
    }

    /// Convenience constructor for creating a language that has the same
    /// commenting syntax as Haskell.
    ///
    /// ```
    /// # use tokei::*;
    /// let haskell = Language::new(&["--"], &[("{-", "-}")]).nested();
    /// let idris = Language::new_haskell();
    ///
    /// assert_eq!(haskell.line_comment, idris.line_comment);
    /// assert_eq!(haskell.multi_line, idris.multi_line);
    /// ```
    pub fn new_haskell() -> Self {
        Language {
            line_comment: &["--"],
            multi_line: &[("{-", "-}")],
            nested: true,
            ..Self::default()
        }
    }

    /// Convenience constructor for creating a language that only has multi line
    /// comments.
    ///
    /// ```
    /// # use tokei::*;
    /// let mustache = Language::new_multi(&[("{{!", "}}")]);
    /// ```
    pub fn new_multi(multi_line: &'static [(&'static str, &'static str)]) -> Self {
        Language {
            multi_line: multi_line,
            quotes: &[("\"", "\"")],
            ..Self::default()
        }
    }

    /// Convenience constructor for creating a language that has the same
    /// commenting syntax as Prolog.
    ///
    /// ```
    /// # use tokei::*;
    /// let prolog = Language::new(&["%"], &[("/*", "*/")]);
    /// let oz = Language::new_pro();
    ///
    /// assert_eq!(prolog.line_comment, oz.line_comment);
    /// assert_eq!(prolog.multi_line, oz.multi_line);
    /// ```
    pub fn new_pro() -> Self {
        Language {
            line_comment: &["%"],
            multi_line: &[("/*", "*/")],
            quotes: &[("\"", "\"")],
            ..Self::default()
        }
    }

    /// Convenience constructor for creating a language that only has single line
    /// comments.
    ///
    /// ```
    /// # use tokei::*;
    /// let haskell = Language::new_single(&["--"]);
    /// ```
    pub fn new_single(line_comment: &'static [&'static str]) -> Self {
        Language {
            line_comment: line_comment,
            quotes: &[("\"", "\"")],
            ..Self::default()
        }
    }

    /// Checks if the language is empty. Empty meaning it doesn't have any
    /// statistics.
    ///
    /// ```
    /// # use tokei::*;
    /// let rust = Language::new_c();
    ///
    /// assert!(rust.is_empty());
    /// ```
    pub fn is_empty(&self) -> bool {
        self.code == 0 &&
            self.comments == 0 &&
            self.blanks == 0 &&
            self.lines == 0
    }

    /// Checks if the language doesn't contain any comments.
    ///
    /// ```
    /// # use tokei::*;
    /// let json = Language::new_blank();
    ///
    /// assert!(json.is_blank());
    /// ```
    pub fn is_blank(&self) -> bool {
        self.line_comment.is_empty() && self.multi_line.is_empty()
    }

    /// Specify if the the language supports nested multi line comments.
    ///
    /// ```
    /// # use tokei::*;
    /// let mut rust = Language::new(&["//"], &[("/*", "*/")]).nested();
    /// assert!(rust.nested);
    /// ```
    pub fn nested(mut self) -> Self {
        self.nested = true;
        self
    }

    /// Specify if the the language supports nested multi line comments.
    /// And which are nested. If this is specified there is no need to
    /// call the `nested` function.
    ///
    /// ```
    /// # use tokei::*;
    /// let mut d = Language::new(&["//"], &[("/*", "*/")])
    ///                         .nested_comments(&[("/+", "+/")]);
    /// assert!(d.nested);
    /// assert_eq!(d.nested_comments, &[("/+", "+/")]);
    /// ```
    pub fn nested_comments(mut self,
                           nested_comments: &'static [(&'static str, &'static str)])
        -> Self
    {
        self.nested = true;
        self.nested_comments = nested_comments;
        self
    }

    /// Specifies if the language has a quotes to define a string where
    /// the commenting syntax would be ignored. By default it is only
    /// `""` quotes that are ignored.
    ///
    /// ```
    /// # use tokei::*;
    /// let mut javascript = Language::new(&["//"], &[("/*", "*/")])
    ///                         .set_quotes(&[("\"", "\""), ("'", "'")]);
    /// assert!(!javascript.quotes.is_empty());
    /// ```
    pub fn set_quotes(mut self,
                      quotes: &'static [(&'static str, &'static str)])
        -> Self
    {
        self.quotes = quotes;
        self
    }

    /// Sorts each of the `Stats` structs contained in the language based
    /// on what category is provided
    /// panic!'s if given the wrong category.
    ///
    /// ```
    /// use tokei::{Language, Stats, Sort};
    /// use std::path::PathBuf;
    ///
    /// let mut rust = Language::new_c();
    /// let mut foo_stats = Stats::new(PathBuf::from("foo"));
    /// let mut bar_stats = Stats::new(PathBuf::from("bar"));
    ///
    /// foo_stats.code += 20;
    /// bar_stats.code += 10;
    ///
    /// rust.stats.push(bar_stats.clone());
    /// rust.stats.push(foo_stats.clone());
    ///
    /// assert_eq!(rust.stats, vec![bar_stats.clone(), foo_stats.clone()]);
    ///
    /// rust.sort_by(Sort::Code);
    ///
    /// assert_eq!(rust.stats, vec![foo_stats, bar_stats]);
    ///
    /// ```
    pub fn sort_by(&mut self, category: Sort) {
        match category {
            Blanks => self.stats.sort_by(|a, b| b.blanks.cmp(&a.blanks)),
            Comments => self.stats.sort_by(|a, b| b.comments.cmp(&a.comments)),
            Code => self.stats.sort_by(|a, b| b.code.cmp(&a.code)),
            Files => self.stats.sort_by(|a, b| a.name.cmp(&b.name)),
            Lines => self.stats.sort_by(|a, b| b.lines.cmp(&a.lines)),
        }
    }
}

impl AddAssign for Language {
    fn add_assign(&mut self, mut rhs: Self) {
        self.lines += rhs.lines;
        self.comments += rhs.comments;
        self.blanks += rhs.blanks;
        self.code += rhs.code;
        self.stats.extend(mem::replace(&mut rhs.stats, Vec::new()));
    }
}

impl AddAssign<Stats> for Language {
    fn add_assign(&mut self, rhs: Stats) {
        self.lines += rhs.lines;
        self.code += rhs.code;
        self.comments += rhs.comments;
        self.blanks += rhs.blanks;
        self.stats.push(rhs);
    }
}

impl Default for Language {
    fn default() -> Self {
        Language {
            blanks: 0,
            code: 0,
            comments: 0,
            files: Vec::new(),
            stats: Vec::new(),
            lines: 0,
            line_comment: &[],
            multi_line: &[],
            nested: false,
            nested_comments: &[],
            quotes: &[],
        }
    }
}