1 // Copyright 2015 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 // Objects for seeking through a char stream for occurences of TODO and FIXME.
12 // Depending on the loaded configuration, may also check that these have an
13 // associated issue number.
17 static TO_DO_CHARS: &'static [char] = &['T', 'O', 'D', 'O'];
18 static FIX_ME_CHARS: &'static [char] = &['F', 'I', 'X', 'M', 'E'];
20 #[derive(Clone, Copy)]
21 pub enum ReportTactic {
28 fn is_enabled(&self) -> bool {
30 ReportTactic::Always => true,
31 ReportTactic::Unnumbered => true,
32 ReportTactic::Never => false
37 impl_enum_decodable!(ReportTactic, Always, Unnumbered, Never);
39 #[derive(Clone, Copy)]
51 #[derive(Clone, Copy)]
59 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
61 issue_type: IssueType,
62 // Indicates whether we're looking for issues with missing numbers, or
63 // all issues of this type.
67 impl fmt::Display for Issue {
68 fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
69 let msg = match self.issue_type {
70 IssueType::Todo => "TODO",
71 IssueType::Fixme => "FIXME",
73 let details = if self.missing_number { " without issue number" } else { "" };
75 write!(fmt, "{}{}", msg, details)
79 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
85 enum IssueClassification {
91 pub struct BadIssueSeeker {
93 report_todo: ReportTactic,
94 report_fixme: ReportTactic,
98 pub fn new(report_todo: ReportTactic, report_fixme: ReportTactic) -> BadIssueSeeker {
99 BadIssueSeeker { state: Seeking::Issue { todo_idx: 0, fixme_idx: 0 },
100 report_todo: report_todo,
101 report_fixme: report_fixme, }
104 // Check whether or not the current char is conclusive evidence for an
105 // unnumbered TO-DO or FIX-ME.
106 pub fn inspect(&mut self, c: char) -> Option<Issue> {
108 Seeking::Issue { todo_idx, fixme_idx } => {
109 self.state = self.inspect_issue(c, todo_idx, fixme_idx);
111 Seeking::Number { issue, part } => {
112 let result = self.inspect_number(c, issue, part);
114 if let IssueClassification::None = result {
118 self.state = Seeking::Issue { todo_idx: 0, fixme_idx: 0 };
120 if let IssueClassification::Bad(issue) = result {
129 fn inspect_issue(&mut self, c: char, mut todo_idx: usize, mut fixme_idx: usize) -> Seeking {
130 // FIXME: Should we also check for lower case characters?
131 if self.report_todo.is_enabled() && c == TO_DO_CHARS[todo_idx] {
133 if todo_idx == TO_DO_CHARS.len() {
134 return Seeking::Number {
136 issue_type: IssueType::Todo,
137 missing_number: if let ReportTactic::Unnumbered = self.report_todo {
143 part: NumberPart::OpenParen
147 } else if self.report_fixme.is_enabled() && c == FIX_ME_CHARS[fixme_idx] {
148 // Exploit the fact that the character sets of todo and fixme
149 // are disjoint by adding else.
151 if fixme_idx == FIX_ME_CHARS.len() {
152 return Seeking::Number {
154 issue_type: IssueType::Fixme,
155 missing_number: if let ReportTactic::Unnumbered = self.report_fixme {
161 part: NumberPart::OpenParen
170 Seeking::Issue { todo_idx: todo_idx, fixme_idx: fixme_idx }
173 fn inspect_number(&mut self,
176 mut part: NumberPart)
177 -> IssueClassification {
178 if ! issue.missing_number || c == '\n' {
179 return IssueClassification::Bad(issue);
181 return if let NumberPart::CloseParen = part {
182 IssueClassification::Good
184 IssueClassification::Bad(issue)
189 NumberPart::OpenParen => {
191 return IssueClassification::Bad(issue);
193 part = NumberPart::Pound;
196 NumberPart::Pound => {
198 part = NumberPart::Number;
201 NumberPart::Number => {
202 if c >= '0' && c <= '9' {
203 part = NumberPart::CloseParen;
205 return IssueClassification::Bad(issue);
208 NumberPart::CloseParen => {}
211 self.state = Seeking::Number {
216 IssueClassification::None
221 fn find_unnumbered_issue() {
222 fn check_fail(text: &str, failing_pos: usize) {
223 let mut seeker = BadIssueSeeker::new(ReportTactic::Unnumbered, ReportTactic::Unnumbered);
224 assert_eq!(Some(failing_pos), text.chars().position(|c| seeker.inspect(c).is_some()));
227 fn check_pass(text: &str) {
228 let mut seeker = BadIssueSeeker::new(ReportTactic::Unnumbered, ReportTactic::Unnumbered);
229 assert_eq!(None, text.chars().position(|c| seeker.inspect(c).is_some()));
232 check_fail("TODO\n", 4);
233 check_pass(" TO FIX DOME\n");
234 check_fail(" \n FIXME\n", 8);
235 check_fail("FIXME(\n", 6);
236 check_fail("FIXME(#\n", 7);
237 check_fail("FIXME(#1\n", 8);
238 check_fail("FIXME(#)1\n", 7);
239 check_pass("FIXME(#1222)\n");
240 check_fail("FIXME(#12\n22)\n", 9);
241 check_pass("FIXME(@maintainer, #1222, hello)\n");
242 check_fail("TODO(#22) FIXME\n", 15);
247 fn is_bad_issue(text: &str, report_todo: ReportTactic, report_fixme: ReportTactic) -> bool {
248 let mut seeker = BadIssueSeeker::new(report_todo, report_fixme);
249 text.chars().any(|c| seeker.inspect(c).is_some())
252 assert!(is_bad_issue("TODO(@maintainer, #1222, hello)\n",
253 ReportTactic::Always,
254 ReportTactic::Never));
256 assert!(! is_bad_issue("TODO: no number\n",
258 ReportTactic::Always));
260 assert!(is_bad_issue("This is a FIXME(#1)\n",
262 ReportTactic::Always));
264 assert!(! is_bad_issue("bad FIXME\n",
265 ReportTactic::Always,
266 ReportTactic::Never));
271 let mut seeker = BadIssueSeeker::new(ReportTactic::Always, ReportTactic::Never);
272 let expected = Some(Issue { issue_type: IssueType::Todo, missing_number: false });
275 "TODO(#100): more awesomeness".chars()
276 .map(|c| seeker.inspect(c))
277 .find(Option::is_some)
280 let mut seeker = BadIssueSeeker::new(ReportTactic::Never, ReportTactic::Unnumbered);
281 let expected = Some(Issue { issue_type: IssueType::Fixme, missing_number: true });
284 "Test. FIXME: bad, bad, not good".chars()
285 .map(|c| seeker.inspect(c))
286 .find(Option::is_some)