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.
16 pub use config::ReportTactic;
18 const TO_DO_CHARS: &'static [char] = &['T', 'O', 'D', 'O'];
19 const FIX_ME_CHARS: &'static [char] = &['F', 'I', 'X', 'M', 'E'];
21 // Enabled implementation detail is here because it is
22 // irrelevant outside the issues module
24 fn is_enabled(&self) -> bool {
26 ReportTactic::Always => true,
27 ReportTactic::Unnumbered => true,
28 ReportTactic::Never => false,
33 #[derive(Clone, Copy)]
45 #[derive(Clone, Copy)]
53 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
55 issue_type: IssueType,
56 // Indicates whether we're looking for issues with missing numbers, or
57 // all issues of this type.
61 impl fmt::Display for Issue {
62 fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
63 let msg = match self.issue_type {
64 IssueType::Todo => "TODO",
65 IssueType::Fixme => "FIXME",
67 let details = if self.missing_number {
68 " without issue number"
73 write!(fmt, "{}{}", msg, details)
77 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
83 enum IssueClassification {
89 pub struct BadIssueSeeker {
91 report_todo: ReportTactic,
92 report_fixme: ReportTactic,
96 pub fn new(report_todo: ReportTactic, report_fixme: ReportTactic) -> BadIssueSeeker {
98 state: Seeking::Issue {
102 report_todo: report_todo,
103 report_fixme: report_fixme,
107 // Check whether or not the current char is conclusive evidence for an
108 // unnumbered TO-DO or FIX-ME.
109 pub fn inspect(&mut self, c: char) -> Option<Issue> {
111 Seeking::Issue { todo_idx, fixme_idx } => {
112 self.state = self.inspect_issue(c, todo_idx, fixme_idx);
114 Seeking::Number { issue, part } => {
115 let result = self.inspect_number(c, issue, part);
117 if let IssueClassification::None = result {
121 self.state = Seeking::Issue {
126 if let IssueClassification::Bad(issue) = result {
135 fn inspect_issue(&mut self, c: char, mut todo_idx: usize, mut fixme_idx: usize) -> Seeking {
136 // FIXME: Should we also check for lower case characters?
137 if self.report_todo.is_enabled() && c == TO_DO_CHARS[todo_idx] {
139 if todo_idx == TO_DO_CHARS.len() {
140 return Seeking::Number {
142 issue_type: IssueType::Todo,
143 missing_number: if let ReportTactic::Unnumbered = self.report_todo {
149 part: NumberPart::OpenParen,
153 } else if self.report_fixme.is_enabled() && c == FIX_ME_CHARS[fixme_idx] {
154 // Exploit the fact that the character sets of todo and fixme
155 // are disjoint by adding else.
157 if fixme_idx == FIX_ME_CHARS.len() {
158 return Seeking::Number {
160 issue_type: IssueType::Fixme,
161 missing_number: if let ReportTactic::Unnumbered = self.report_fixme {
167 part: NumberPart::OpenParen,
178 fixme_idx: fixme_idx,
182 fn inspect_number(&mut self,
185 mut part: NumberPart)
186 -> IssueClassification {
187 if !issue.missing_number || c == '\n' {
188 return IssueClassification::Bad(issue);
190 return if let NumberPart::CloseParen = part {
191 IssueClassification::Good
193 IssueClassification::Bad(issue)
198 NumberPart::OpenParen => {
200 return IssueClassification::Bad(issue);
202 part = NumberPart::Pound;
205 NumberPart::Pound => {
207 part = NumberPart::Number;
210 NumberPart::Number => {
211 if c >= '0' && c <= '9' {
212 part = NumberPart::CloseParen;
214 return IssueClassification::Bad(issue);
217 NumberPart::CloseParen => {}
220 self.state = Seeking::Number {
225 IssueClassification::None
230 fn find_unnumbered_issue() {
231 fn check_fail(text: &str, failing_pos: usize) {
232 let mut seeker = BadIssueSeeker::new(ReportTactic::Unnumbered, ReportTactic::Unnumbered);
233 assert_eq!(Some(failing_pos),
234 text.chars().position(|c| seeker.inspect(c).is_some()));
237 fn check_pass(text: &str) {
238 let mut seeker = BadIssueSeeker::new(ReportTactic::Unnumbered, ReportTactic::Unnumbered);
239 assert_eq!(None, text.chars().position(|c| seeker.inspect(c).is_some()));
242 check_fail("TODO\n", 4);
243 check_pass(" TO FIX DOME\n");
244 check_fail(" \n FIXME\n", 8);
245 check_fail("FIXME(\n", 6);
246 check_fail("FIXME(#\n", 7);
247 check_fail("FIXME(#1\n", 8);
248 check_fail("FIXME(#)1\n", 7);
249 check_pass("FIXME(#1222)\n");
250 check_fail("FIXME(#12\n22)\n", 9);
251 check_pass("FIXME(@maintainer, #1222, hello)\n");
252 check_fail("TODO(#22) FIXME\n", 15);
257 fn is_bad_issue(text: &str, report_todo: ReportTactic, report_fixme: ReportTactic) -> bool {
258 let mut seeker = BadIssueSeeker::new(report_todo, report_fixme);
259 text.chars().any(|c| seeker.inspect(c).is_some())
262 assert!(is_bad_issue("TODO(@maintainer, #1222, hello)\n",
263 ReportTactic::Always,
264 ReportTactic::Never));
266 assert!(!is_bad_issue("TODO: no number\n",
268 ReportTactic::Always));
270 assert!(is_bad_issue("This is a FIXME(#1)\n",
272 ReportTactic::Always));
274 assert!(!is_bad_issue("bad FIXME\n", ReportTactic::Always, ReportTactic::Never));
279 let mut seeker = BadIssueSeeker::new(ReportTactic::Always, ReportTactic::Never);
280 let expected = Some(Issue {
281 issue_type: IssueType::Todo,
282 missing_number: false,
286 "TODO(#100): more awesomeness"
288 .map(|c| seeker.inspect(c))
289 .find(Option::is_some)
292 let mut seeker = BadIssueSeeker::new(ReportTactic::Never, ReportTactic::Unnumbered);
293 let expected = Some(Issue {
294 issue_type: IssueType::Fixme,
295 missing_number: true,
299 "Test. FIXME: bad, bad, not good"
301 .map(|c| seeker.inspect(c))
302 .find(Option::is_some)