]>
git.proxmox.com Git - rustc.git/blob - 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.
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.
11 //! Tidy check to enforce various stylistic guidelines on the Rust codebase.
13 //! Example checks are:
15 //! * No lines over 100 characters
17 //! * No trailing whitespace
18 //! * No CR characters
19 //! * No `TODO` or `XXX` directives
20 //! * A valid license header is at the top
22 //! A number of these checks can be opted-out of with various directives like
23 //! `// ignore-tidy-linelength`.
26 use std
::io
::prelude
::*;
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.
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.";
41 /// Parser states for line_is_url.
43 #[allow(non_camel_case_types)]
44 enum LIUState
{ EXP_COMMENT_START
,
45 EXP_LINK_LABEL_OR_URL
,
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
;
59 for tok
in line
.split_whitespace() {
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
,
65 (EXP_LINK_LABEL_OR_URL
, w
)
66 if w
.len() >= 4 && w
.starts_with("[") && w
.ends_with("]:")
69 (EXP_LINK_LABEL_OR_URL
, w
)
70 if w
.starts_with("http://") || w
.starts_with("https://")
74 if w
.starts_with("http://") || w
.starts_with("https://")
77 (_
, _
) => return false,
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
) {
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(".#") {
104 if filename
== "miniz.c" {
108 contents
.truncate(0);
109 t
!(t
!(File
::open(file
), file
).read_to_string(&mut contents
));
111 if contents
.is_empty() {
112 tidy_error
!(bad
, "{}: empty file", file
.display());
115 let skip_cr
= contents
.contains("ignore-tidy-cr");
116 let skip_tab
= contents
.contains("ignore-tidy-tab");
117 let skip_length
= contents
.contains("ignore-tidy-linelength");
118 let skip_end_whitespace
= contents
.contains("ignore-tidy-end-whitespace");
119 for (i
, line
) in contents
.split("\n").enumerate() {
120 let mut err
= |msg
: &str| {
121 tidy_error
!(bad
, "{}:{}: {}", file
.display(), i
+ 1, msg
);
123 if !skip_length
&& line
.chars().count() > COLS
124 && !long_line_is_ok(line
) {
125 err(&format
!("line longer than {} chars", COLS
));
127 if line
.contains("\t") && !skip_tab
{
128 err("tab character");
130 if !skip_end_whitespace
&& (line
.ends_with(" ") || line
.ends_with("\t")) {
131 err("trailing whitespace");
133 if line
.contains("\r") && !skip_cr
{
136 if filename
!= "style.rs" {
137 if line
.contains("TODO") {
138 err("TODO is deprecated; use FIXME")
140 if line
.contains("//") && line
.contains(" XXX") {
141 err("XXX is deprecated; use FIXME")
145 if !licenseck(file
, &contents
) {
146 tidy_error
!(bad
, "{}: incorrect license", file
.display());
151 fn licenseck(file
: &Path
, contents
: &str) -> bool
{
152 if contents
.contains("ignore-license") {
156 "libstd/sync/mpsc/mpsc_queue.rs",
157 "libstd/sync/mpsc/spsc_queue.rs",
159 if exceptions
.iter().any(|f
| file
.ends_with(f
)) {
163 // Skip the BOM if it's there
164 let bom
= "\u{feff}";
165 let contents
= if contents
.starts_with(bom
) {&contents[3..]}
else {contents}
;
167 // See if the license shows up in the first 100 lines
168 let lines
= contents
.lines().take(100).collect
::<Vec
<_
>>();
169 lines
.windows(LICENSE
.lines().count()).any(|window
| {
170 let offset
= if window
.iter().all(|w
| w
.starts_with("//")) {
172 } else if window
.iter().all(|w
| w
.starts_with("#")) {
177 window
.iter().map(|a
| a
[offset
..].trim())
178 .zip(LICENSE
.lines()).all(|(a
, b
)| {
179 a
== b
|| match b
.find("<year>") {
180 Some(i
) => a
.starts_with(&b
[..i
]) && a
.ends_with(&b
[i
+6..]),