src/tools/tidy/src/style.rs

   1 // Copyright 2016 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Tidy check to enforce various stylistic guidelines on the Rust codebase.
  12 //!
  13 //! Example checks are:
  14 //!
  15 //! * No lines over 100 characters
  16 //! * No tabs
  17 //! * No trailing whitespace
  18 //! * No CR characters
  19 //! * No `TODO` or `XXX` directives
  20 //! * A valid license header is at the top
  21 //!
  22 //! A number of these checks can be opted-out of with various directives like
  23 //! `// ignore-tidy-linelength`.
  24
  25 use std::fs::File;
  26 use std::io::prelude::*;
  27 use std::path::Path;
  28
  29 const COLS: usize = 100;
  30 const LICENSE: &'static str = "\
  31 Copyright <year> The Rust Project Developers. See the COPYRIGHT
  32 file at the top-level directory of this distribution and at
  33 http://rust-lang.org/COPYRIGHT.
  34
  35 Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
  36 http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
  37 <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
  38 option. This file may not be copied, modified, or distributed
  39 except according to those terms.";
  40
  41 /// Parser states for line_is_url.
  42 #[derive(PartialEq)]
  43 #[allow(non_camel_case_types)]
  44 enum LIUState { EXP_COMMENT_START,
  45                 EXP_LINK_LABEL_OR_URL,
  46                 EXP_URL,
  47                 EXP_END }
  48
  49 /// True if LINE appears to be a line comment containing an URL,
  50 /// possibly with a Markdown link label in front, and nothing else.
  51 /// The Markdown link label, if present, may not contain whitespace.
  52 /// Lines of this form are allowed to be overlength, because Markdown
  53 /// offers no way to split a line in the middle of a URL, and the lengths
  54 /// of URLs to external references are beyond our control.
  55 fn line_is_url(line: &str) -> bool {
  56     use self::LIUState::*;
  57     let mut state: LIUState = EXP_COMMENT_START;
  58
  59     for tok in line.split_whitespace() {
  60         match (state, tok) {
  61             (EXP_COMMENT_START, "//") => state = EXP_LINK_LABEL_OR_URL,
  62             (EXP_COMMENT_START, "///") => state = EXP_LINK_LABEL_OR_URL,
  63             (EXP_COMMENT_START, "//!") => state = EXP_LINK_LABEL_OR_URL,
  64
  65             (EXP_LINK_LABEL_OR_URL, w)
  66                 if w.len() >= 4 && w.starts_with("[") && w.ends_with("]:")
  67                 => state = EXP_URL,
  68
  69             (EXP_LINK_LABEL_OR_URL, w)
  70                 if w.starts_with("http://") || w.starts_with("https://")
  71                 => state = EXP_END,
  72
  73             (EXP_URL, w)
  74                 if w.starts_with("http://") || w.starts_with("https://")
  75                 => state = EXP_END,
  76
  77             (_, _) => return false,
  78         }
  79     }
  80
  81     state == EXP_END
  82 }
  83
  84 /// True if LINE is allowed to be longer than the normal limit.
  85 /// Currently there is only one exception, for long URLs, but more
  86 /// may be added in the future.
  87 fn long_line_is_ok(line: &str) -> bool {
  88     if line_is_url(line) {
  89         return true;
  90     }
  91
  92     false
  93 }
  94
  95 pub fn check(path: &Path, bad: &mut bool) {
  96     let mut contents = String::new();
  97     super::walk(path, &mut super::filter_dirs, &mut |file| {
  98         let filename = file.file_name().unwrap().to_string_lossy();
  99         let extensions = [".rs", ".py", ".js", ".sh", ".c", ".h"];
 100         if extensions.iter().all(|e| !filename.ends_with(e)) ||
 101            filename.starts_with(".#") {
 102             return
 103         }
 104         if filename == "miniz.c" || filename.contains("jquery") {
 105             return
 106         }
 107
 108         contents.truncate(0);
 109         t!(t!(File::open(file), file).read_to_string(&mut contents));
 110         let skip_cr = contents.contains("ignore-tidy-cr");
 111         let skip_tab = contents.contains("ignore-tidy-tab");
 112         let skip_length = contents.contains("ignore-tidy-linelength");
 113         let skip_end_whitespace = contents.contains("ignore-tidy-end-whitespace");
 114         for (i, line) in contents.split("\n").enumerate() {
 115             let mut err = |msg: &str| {
 116                 println!("{}:{}: {}", file.display(), i + 1, msg);
 117                 *bad = true;
 118             };
 119             if !skip_length && line.chars().count() > COLS
 120                 && !long_line_is_ok(line) {
 121                     err(&format!("line longer than {} chars", COLS));
 122             }
 123             if line.contains("\t") && !skip_tab {
 124                 err("tab character");
 125             }
 126             if !skip_end_whitespace && (line.ends_with(" ") || line.ends_with("\t")) {
 127                 err("trailing whitespace");
 128             }
 129             if line.contains("\r") && !skip_cr {
 130                 err("CR character");
 131             }
 132             if filename != "style.rs" {
 133                 if line.contains("TODO") {
 134                     err("TODO is deprecated; use FIXME")
 135                 }
 136                 if line.contains("//") && line.contains(" XXX") {
 137                     err("XXX is deprecated; use FIXME")
 138                 }
 139             }
 140         }
 141         if !licenseck(file, &contents) {
 142             println!("{}: incorrect license", file.display());
 143             *bad = true;
 144         }
 145     })
 146 }
 147
 148 fn licenseck(file: &Path, contents: &str) -> bool {
 149     if contents.contains("ignore-license") {
 150         return true
 151     }
 152     let exceptions = [
 153         "libstd/sync/mpsc/mpsc_queue.rs",
 154         "libstd/sync/mpsc/spsc_queue.rs",
 155     ];
 156     if exceptions.iter().any(|f| file.ends_with(f)) {
 157         return true
 158     }
 159
 160     // Skip the BOM if it's there
 161     let bom = "\u{feff}";
 162     let contents = if contents.starts_with(bom) {&contents[3..]} else {contents};
 163
 164     // See if the license shows up in the first 100 lines
 165     let lines = contents.lines().take(100).collect::<Vec<_>>();
 166     lines.windows(LICENSE.lines().count()).any(|window| {
 167         let offset = if window.iter().all(|w| w.starts_with("//")) {
 168             2
 169         } else if window.iter().all(|w| w.starts_with("#")) {
 170             1
 171         } else {
 172             return false
 173         };
 174         window.iter().map(|a| a[offset..].trim())
 175               .zip(LICENSE.lines()).all(|(a, b)| {
 176             a == b || match b.find("<year>") {
 177                 Some(i) => a.starts_with(&b[..i]) && a.ends_with(&b[i+6..]),
 178                 None => false,
 179             }
 180         })
 181     })
 182
 183 }