src/comment.rs

   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.
   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 // Formatting and tools for comments.
  12
  13 use std::{self, iter};
  14
  15 use syntax::codemap::Span;
  16
  17 use {Indent, Shape};
  18 use config::Config;
  19 use rewrite::RewriteContext;
  20 use string::{rewrite_string, StringFormat};
  21 use utils::{first_line_width, last_line_width, wrap_str};
  22
  23 fn is_custom_comment(comment: &str) -> bool {
  24     if !comment.starts_with("//") {
  25         false
  26     } else if let Some(c) = comment.chars().nth(2) {
  27         !c.is_alphanumeric() && !c.is_whitespace()
  28     } else {
  29         false
  30     }
  31 }
  32
  33 #[derive(Copy, Clone, PartialEq, Eq)]
  34 pub enum CommentStyle<'a> {
  35     DoubleSlash,
  36     TripleSlash,
  37     Doc,
  38     SingleBullet,
  39     DoubleBullet,
  40     Exclamation,
  41     Custom(&'a str),
  42 }
  43
  44 fn custom_opener(s: &str) -> &str {
  45     s.lines().next().map_or("", |first_line| {
  46         first_line
  47             .find(' ')
  48             .map_or(first_line, |space_index| &first_line[0..space_index + 1])
  49     })
  50 }
  51
  52 impl<'a> CommentStyle<'a> {
  53     pub fn opener(&self) -> &'a str {
  54         match *self {
  55             CommentStyle::DoubleSlash => "// ",
  56             CommentStyle::TripleSlash => "/// ",
  57             CommentStyle::Doc => "//! ",
  58             CommentStyle::SingleBullet => "/* ",
  59             CommentStyle::DoubleBullet => "/** ",
  60             CommentStyle::Exclamation => "/*! ",
  61             CommentStyle::Custom(opener) => opener,
  62         }
  63     }
  64
  65     pub fn closer(&self) -> &'a str {
  66         match *self {
  67             CommentStyle::DoubleSlash |
  68             CommentStyle::TripleSlash |
  69             CommentStyle::Custom(..) |
  70             CommentStyle::Doc => "",
  71             CommentStyle::DoubleBullet => " **/",
  72             CommentStyle::SingleBullet | CommentStyle::Exclamation => " */",
  73         }
  74     }
  75
  76     pub fn line_start(&self) -> &'a str {
  77         match *self {
  78             CommentStyle::DoubleSlash => "// ",
  79             CommentStyle::TripleSlash => "/// ",
  80             CommentStyle::Doc => "//! ",
  81             CommentStyle::SingleBullet | CommentStyle::Exclamation => " * ",
  82             CommentStyle::DoubleBullet => " ** ",
  83             CommentStyle::Custom(opener) => opener,
  84         }
  85     }
  86
  87     pub fn to_str_tuplet(&self) -> (&'a str, &'a str, &'a str) {
  88         (self.opener(), self.closer(), self.line_start())
  89     }
  90
  91     pub fn line_with_same_comment_style(&self, line: &str, normalize_comments: bool) -> bool {
  92         match *self {
  93             CommentStyle::DoubleSlash | CommentStyle::TripleSlash | CommentStyle::Doc => {
  94                 line.trim_left().starts_with(self.line_start().trim_left()) ||
  95                     comment_style(line, normalize_comments) == *self
  96             }
  97             CommentStyle::DoubleBullet | CommentStyle::SingleBullet | CommentStyle::Exclamation => {
  98                 line.trim_left().starts_with(self.closer().trim_left()) ||
  99                     line.trim_left().starts_with(self.line_start().trim_left()) ||
 100                     comment_style(line, normalize_comments) == *self
 101             }
 102             CommentStyle::Custom(opener) => line.trim_left().starts_with(opener.trim_right()),
 103         }
 104     }
 105 }
 106
 107 fn comment_style(orig: &str, normalize_comments: bool) -> CommentStyle {
 108     if !normalize_comments {
 109         if orig.starts_with("/**") && !orig.starts_with("/**/") {
 110             CommentStyle::DoubleBullet
 111         } else if orig.starts_with("/*!") {
 112             CommentStyle::Exclamation
 113         } else if orig.starts_with("/*") {
 114             CommentStyle::SingleBullet
 115         } else if orig.starts_with("///") && orig.chars().nth(3).map_or(true, |c| c != '/') {
 116             CommentStyle::TripleSlash
 117         } else if orig.starts_with("//!") {
 118             CommentStyle::Doc
 119         } else if is_custom_comment(orig) {
 120             CommentStyle::Custom(custom_opener(orig))
 121         } else {
 122             CommentStyle::DoubleSlash
 123         }
 124     } else if (orig.starts_with("///") && orig.chars().nth(3).map_or(true, |c| c != '/')) ||
 125         (orig.starts_with("/**") && !orig.starts_with("/**/"))
 126     {
 127         CommentStyle::TripleSlash
 128     } else if orig.starts_with("//!") || orig.starts_with("/*!") {
 129         CommentStyle::Doc
 130     } else if is_custom_comment(orig) {
 131         CommentStyle::Custom(custom_opener(orig))
 132     } else {
 133         CommentStyle::DoubleSlash
 134     }
 135 }
 136
 137 pub fn combine_strs_with_missing_comments(
 138     context: &RewriteContext,
 139     prev_str: &str,
 140     next_str: &str,
 141     span: Span,
 142     shape: Shape,
 143     allow_extend: bool,
 144 ) -> Option<String> {
 145     let mut allow_one_line = !prev_str.contains('\n') && !next_str.contains('\n');
 146     let first_sep = if prev_str.is_empty() || next_str.is_empty() {
 147         ""
 148     } else {
 149         " "
 150     };
 151     let mut one_line_width =
 152         last_line_width(prev_str) + first_line_width(next_str) + first_sep.len();
 153
 154     let indent_str = shape.indent.to_string(context.config);
 155     let missing_comment = try_opt!(rewrite_missing_comment(span, shape, context));
 156
 157     if missing_comment.is_empty() {
 158         if allow_extend && prev_str.len() + first_sep.len() + next_str.len() <= shape.width {
 159             return Some(format!("{}{}{}", prev_str, first_sep, next_str));
 160         } else {
 161             let sep = if prev_str.is_empty() {
 162                 String::new()
 163             } else {
 164                 String::from("\n") + &indent_str
 165             };
 166             return Some(format!("{}{}{}", prev_str, sep, next_str));
 167         }
 168     }
 169
 170     // We have a missing comment between the first expression and the second expression.
 171
 172     // Peek the the original source code and find out whether there is a newline between the first
 173     // expression and the second expression or the missing comment. We will preserve the orginal
 174     // layout whenever possible.
 175     let original_snippet = context.snippet(span);
 176     let prefer_same_line = if let Some(pos) = original_snippet.chars().position(|c| c == '/') {
 177         !original_snippet[..pos].contains('\n')
 178     } else {
 179         !original_snippet.contains('\n')
 180     };
 181
 182     one_line_width -= first_sep.len();
 183     let first_sep = if prev_str.is_empty() || missing_comment.is_empty() {
 184         String::new()
 185     } else {
 186         let one_line_width = last_line_width(prev_str) + first_line_width(&missing_comment) + 1;
 187         if prefer_same_line && one_line_width <= shape.width {
 188             String::from(" ")
 189         } else {
 190             format!("\n{}", indent_str)
 191         }
 192     };
 193     let second_sep = if missing_comment.is_empty() || next_str.is_empty() {
 194         String::new()
 195     } else if missing_comment.starts_with("//") {
 196         format!("\n{}", indent_str)
 197     } else {
 198         one_line_width += missing_comment.len() + first_sep.len() + 1;
 199         allow_one_line &= !missing_comment.starts_with("//") && !missing_comment.contains('\n');
 200         if prefer_same_line && allow_one_line && one_line_width <= shape.width {
 201             String::from(" ")
 202         } else {
 203             format!("\n{}", indent_str)
 204         }
 205     };
 206     Some(format!(
 207         "{}{}{}{}{}",
 208         prev_str,
 209         first_sep,
 210         missing_comment,
 211         second_sep,
 212         next_str,
 213     ))
 214 }
 215
 216 pub fn rewrite_comment(
 217     orig: &str,
 218     block_style: bool,
 219     shape: Shape,
 220     config: &Config,
 221 ) -> Option<String> {
 222     // If there are lines without a starting sigil, we won't format them correctly
 223     // so in that case we won't even re-align (if !config.normalize_comments()) and
 224     // we should stop now.
 225     let num_bare_lines = orig.lines()
 226         .map(|line| line.trim())
 227         .filter(|l| {
 228             !(l.starts_with('*') || l.starts_with("//") || l.starts_with("/*"))
 229         })
 230         .count();
 231     if num_bare_lines > 0 && !config.normalize_comments() {
 232         return Some(orig.to_owned());
 233     }
 234     if !config.normalize_comments() && !config.wrap_comments() {
 235         return light_rewrite_comment(orig, shape.indent, config);
 236     }
 237
 238     identify_comment(orig, block_style, shape, config)
 239 }
 240
 241 fn identify_comment(
 242     orig: &str,
 243     block_style: bool,
 244     shape: Shape,
 245     config: &Config,
 246 ) -> Option<String> {
 247     let style = comment_style(orig, false);
 248     let first_group = orig.lines()
 249         .take_while(|l| style.line_with_same_comment_style(l, false))
 250         .collect::<Vec<_>>()
 251         .join("\n");
 252     let rest = orig.lines()
 253         .skip(first_group.lines().count())
 254         .collect::<Vec<_>>()
 255         .join("\n");
 256
 257     let first_group_str = try_opt!(rewrite_comment_inner(
 258         &first_group,
 259         block_style,
 260         style,
 261         shape,
 262         config,
 263     ));
 264     if rest.is_empty() {
 265         Some(first_group_str)
 266     } else {
 267         identify_comment(&rest, block_style, shape, config).map(|rest_str| {
 268             format!(
 269                 "{}\n{}{}",
 270                 first_group_str,
 271                 shape.indent.to_string(config),
 272                 rest_str
 273             )
 274         })
 275     }
 276 }
 277
 278 fn rewrite_comment_inner(
 279     orig: &str,
 280     block_style: bool,
 281     style: CommentStyle,
 282     shape: Shape,
 283     config: &Config,
 284 ) -> Option<String> {
 285     let (opener, closer, line_start) = if block_style {
 286         CommentStyle::SingleBullet.to_str_tuplet()
 287     } else {
 288         comment_style(orig, config.normalize_comments()).to_str_tuplet()
 289     };
 290
 291     let max_chars = shape
 292         .width
 293         .checked_sub(closer.len() + opener.len())
 294         .unwrap_or(1);
 295     let indent_str = shape.indent.to_string(config);
 296     let fmt = StringFormat {
 297         opener: "",
 298         closer: "",
 299         line_start: line_start,
 300         line_end: "",
 301         shape: Shape::legacy(max_chars, shape.indent + (opener.len() - line_start.len())),
 302         trim_end: true,
 303         config: config,
 304     };
 305
 306     let line_breaks = orig.trim_right().chars().filter(|&c| c == '\n').count();
 307     let lines = orig.lines()
 308         .enumerate()
 309         .map(|(i, mut line)| {
 310             line = line.trim();
 311             // Drop old closer.
 312             if i == line_breaks && line.ends_with("*/") && !line.starts_with("//") {
 313                 line = line[..(line.len() - 2)].trim_right();
 314             }
 315
 316             line
 317         })
 318         .map(|s| left_trim_comment_line(s, &style))
 319         .map(|line| if orig.starts_with("/*") && line_breaks == 0 {
 320             line.trim_left()
 321         } else {
 322             line
 323         });
 324
 325     let mut result = opener.to_owned();
 326     for line in lines {
 327         if result == opener {
 328             if line.is_empty() {
 329                 continue;
 330             }
 331         } else {
 332             result.push('\n');
 333             result.push_str(&indent_str);
 334             result.push_str(line_start);
 335         }
 336
 337         if config.wrap_comments() && line.len() > max_chars {
 338             let rewrite = rewrite_string(line, &fmt).unwrap_or_else(|| line.to_owned());
 339             result.push_str(&rewrite);
 340         } else {
 341             if line.is_empty() && result.ends_with(' ') {
 342                 // Remove space if this is an empty comment or a doc comment.
 343                 result.pop();
 344             }
 345             result.push_str(line);
 346         }
 347     }
 348
 349     result.push_str(closer);
 350     if result == opener && result.ends_with(' ') {
 351         // Trailing space.
 352         result.pop();
 353     }
 354
 355     Some(result)
 356 }
 357
 358 /// Given the span, rewrite the missing comment inside it if available.
 359 /// Note that the given span must only include comments (or leading/trailing whitespaces).
 360 pub fn rewrite_missing_comment(
 361     span: Span,
 362     shape: Shape,
 363     context: &RewriteContext,
 364 ) -> Option<String> {
 365     let missing_snippet = context.snippet(span);
 366     let trimmed_snippet = missing_snippet.trim();
 367     if !trimmed_snippet.is_empty() {
 368         rewrite_comment(trimmed_snippet, false, shape, context.config)
 369     } else {
 370         Some(String::new())
 371     }
 372 }
 373
 374 /// Recover the missing comments in the specified span, if available.
 375 /// The layout of the comments will be preserved as long as it does not break the code
 376 /// and its total width does not exceed the max width.
 377 pub fn recover_missing_comment_in_span(
 378     span: Span,
 379     shape: Shape,
 380     context: &RewriteContext,
 381     used_width: usize,
 382 ) -> Option<String> {
 383     let missing_comment = try_opt!(rewrite_missing_comment(span, shape, context));
 384     if missing_comment.is_empty() {
 385         Some(String::new())
 386     } else {
 387         let missing_snippet = context.snippet(span);
 388         let pos = missing_snippet.chars().position(|c| c == '/').unwrap_or(0);
 389         // 1 = ` `
 390         let total_width = missing_comment.len() + used_width + 1;
 391         let force_new_line_before_comment =
 392             missing_snippet[..pos].contains('\n') || total_width > context.config.max_width();
 393         let sep = if force_new_line_before_comment {
 394             format!("\n{}", shape.indent.to_string(context.config))
 395         } else {
 396             String::from(" ")
 397         };
 398         Some(format!("{}{}", sep, missing_comment))
 399     }
 400 }
 401
 402 /// Trims whitespace and aligns to indent, but otherwise does not change comments.
 403 fn light_rewrite_comment(orig: &str, offset: Indent, config: &Config) -> Option<String> {
 404     let lines: Vec<&str> = orig.lines()
 405         .map(|l| {
 406             // This is basically just l.trim(), but in the case that a line starts
 407             // with `*` we want to leave one space before it, so it aligns with the
 408             // `*` in `/*`.
 409             let first_non_whitespace = l.find(|c| !char::is_whitespace(c));
 410             if let Some(fnw) = first_non_whitespace {
 411                 if l.as_bytes()[fnw] == b'*' && fnw > 0 {
 412                     &l[fnw - 1..]
 413                 } else {
 414                     &l[fnw..]
 415                 }
 416             } else {
 417                 ""
 418             }.trim_right()
 419         })
 420         .collect();
 421     Some(lines.join(&format!("\n{}", offset.to_string(config))))
 422 }
 423
 424 /// Trims comment characters and possibly a single space from the left of a string.
 425 /// Does not trim all whitespace.
 426 fn left_trim_comment_line<'a>(line: &'a str, style: &CommentStyle) -> &'a str {
 427     if line.starts_with("//! ") || line.starts_with("/// ") || line.starts_with("/*! ") ||
 428         line.starts_with("/** ")
 429     {
 430         &line[4..]
 431     } else if let CommentStyle::Custom(opener) = *style {
 432         if line.starts_with(opener) {
 433             &line[opener.len()..]
 434         } else {
 435             &line[opener.trim_right().len()..]
 436         }
 437     } else if line.starts_with("/* ") || line.starts_with("// ") || line.starts_with("//!") ||
 438         line.starts_with("///") || line.starts_with("** ") ||
 439         line.starts_with("/*!") ||
 440         (line.starts_with("/**") && !line.starts_with("/**/"))
 441     {
 442         &line[3..]
 443     } else if line.starts_with("/*") || line.starts_with("* ") || line.starts_with("//") ||
 444         line.starts_with("**")
 445     {
 446         &line[2..]
 447     } else if line.starts_with('*') {
 448         &line[1..]
 449     } else {
 450         line
 451     }
 452 }
 453
 454 pub trait FindUncommented {
 455     fn find_uncommented(&self, pat: &str) -> Option<usize>;
 456 }
 457
 458 impl FindUncommented for str {
 459     fn find_uncommented(&self, pat: &str) -> Option<usize> {
 460         let mut needle_iter = pat.chars();
 461         for (kind, (i, b)) in CharClasses::new(self.char_indices()) {
 462             match needle_iter.next() {
 463                 None => {
 464                     return Some(i - pat.len());
 465                 }
 466                 Some(c) => match kind {
 467                     FullCodeCharKind::Normal if b == c => {}
 468                     _ => {
 469                         needle_iter = pat.chars();
 470                     }
 471                 },
 472             }
 473         }
 474
 475         // Handle case where the pattern is a suffix of the search string
 476         match needle_iter.next() {
 477             Some(_) => None,
 478             None => Some(self.len() - pat.len()),
 479         }
 480     }
 481 }
 482
 483 // Returns the first byte position after the first comment. The given string
 484 // is expected to be prefixed by a comment, including delimiters.
 485 // Good: "/* /* inner */ outer */ code();"
 486 // Bad:  "code(); // hello\n world!"
 487 pub fn find_comment_end(s: &str) -> Option<usize> {
 488     let mut iter = CharClasses::new(s.char_indices());
 489     for (kind, (i, _c)) in &mut iter {
 490         if kind == FullCodeCharKind::Normal {
 491             return Some(i);
 492         }
 493     }
 494
 495     // Handle case where the comment ends at the end of s.
 496     if iter.status == CharClassesStatus::Normal {
 497         Some(s.len())
 498     } else {
 499         None
 500     }
 501 }
 502
 503 /// Returns true if text contains any comment.
 504 pub fn contains_comment(text: &str) -> bool {
 505     CharClasses::new(text.chars()).any(|(kind, _)| kind.is_comment())
 506 }
 507
 508 struct CharClasses<T>
 509 where
 510     T: Iterator,
 511     T::Item: RichChar,
 512 {
 513     base: iter::Peekable<T>,
 514     status: CharClassesStatus,
 515 }
 516
 517 trait RichChar {
 518     fn get_char(&self) -> char;
 519 }
 520
 521 impl RichChar for char {
 522     fn get_char(&self) -> char {
 523         *self
 524     }
 525 }
 526
 527 impl RichChar for (usize, char) {
 528     fn get_char(&self) -> char {
 529         self.1
 530     }
 531 }
 532
 533 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
 534 enum CharClassesStatus {
 535     Normal,
 536     LitString,
 537     LitStringEscape,
 538     LitChar,
 539     LitCharEscape,
 540     // The u32 is the nesting deepness of the comment
 541     BlockComment(u32),
 542     // Status when the '/' has been consumed, but not yet the '*', deepness is
 543     // the new deepness (after the comment opening).
 544     BlockCommentOpening(u32),
 545     // Status when the '*' has been consumed, but not yet the '/', deepness is
 546     // the new deepness (after the comment closing).
 547     BlockCommentClosing(u32),
 548     LineComment,
 549 }
 550
 551 /// Distinguish between functional part of code and comments
 552 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
 553 pub enum CodeCharKind {
 554     Normal,
 555     Comment,
 556 }
 557
 558 /// Distinguish between functional part of code and comments,
 559 /// describing opening and closing of comments for ease when chunking
 560 /// code from tagged characters
 561 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
 562 enum FullCodeCharKind {
 563     Normal,
 564     /// The first character of a comment, there is only one for a comment (always '/')
 565     StartComment,
 566     /// Any character inside a comment including the second character of comment
 567     /// marks ("//", "/*")
 568     InComment,
 569     /// Last character of a comment, '\n' for a line comment, '/' for a block comment.
 570     EndComment,
 571 }
 572
 573 impl FullCodeCharKind {
 574     fn is_comment(&self) -> bool {
 575         match *self {
 576             FullCodeCharKind::Normal => false,
 577             FullCodeCharKind::StartComment |
 578             FullCodeCharKind::InComment |
 579             FullCodeCharKind::EndComment => true,
 580         }
 581     }
 582
 583     fn to_codecharkind(&self) -> CodeCharKind {
 584         if self.is_comment() {
 585             CodeCharKind::Comment
 586         } else {
 587             CodeCharKind::Normal
 588         }
 589     }
 590 }
 591
 592 impl<T> CharClasses<T>
 593 where
 594     T: Iterator,
 595     T::Item: RichChar,
 596 {
 597     fn new(base: T) -> CharClasses<T> {
 598         CharClasses {
 599             base: base.peekable(),
 600             status: CharClassesStatus::Normal,
 601         }
 602     }
 603 }
 604
 605 impl<T> Iterator for CharClasses<T>
 606 where
 607     T: Iterator,
 608     T::Item: RichChar,
 609 {
 610     type Item = (FullCodeCharKind, T::Item);
 611
 612     fn next(&mut self) -> Option<(FullCodeCharKind, T::Item)> {
 613         let item = try_opt!(self.base.next());
 614         let chr = item.get_char();
 615         self.status = match self.status {
 616             CharClassesStatus::LitString => match chr {
 617                 '"' => CharClassesStatus::Normal,
 618                 '\\' => CharClassesStatus::LitStringEscape,
 619                 _ => CharClassesStatus::LitString,
 620             },
 621             CharClassesStatus::LitStringEscape => CharClassesStatus::LitString,
 622             CharClassesStatus::LitChar => match chr {
 623                 '\\' => CharClassesStatus::LitCharEscape,
 624                 '\'' => CharClassesStatus::Normal,
 625                 _ => CharClassesStatus::LitChar,
 626             },
 627             CharClassesStatus::LitCharEscape => CharClassesStatus::LitChar,
 628             CharClassesStatus::Normal => match chr {
 629                 '"' => CharClassesStatus::LitString,
 630                 '\'' => CharClassesStatus::LitChar,
 631                 '/' => match self.base.peek() {
 632                     Some(next) if next.get_char() == '*' => {
 633                         self.status = CharClassesStatus::BlockCommentOpening(1);
 634                         return Some((FullCodeCharKind::StartComment, item));
 635                     }
 636                     Some(next) if next.get_char() == '/' => {
 637                         self.status = CharClassesStatus::LineComment;
 638                         return Some((FullCodeCharKind::StartComment, item));
 639                     }
 640                     _ => CharClassesStatus::Normal,
 641                 },
 642                 _ => CharClassesStatus::Normal,
 643             },
 644             CharClassesStatus::BlockComment(deepness) => {
 645                 assert_ne!(deepness, 0);
 646                 self.status = match self.base.peek() {
 647                     Some(next) if next.get_char() == '/' && chr == '*' => {
 648                         CharClassesStatus::BlockCommentClosing(deepness - 1)
 649                     }
 650                     Some(next) if next.get_char() == '*' && chr == '/' => {
 651                         CharClassesStatus::BlockCommentOpening(deepness + 1)
 652                     }
 653                     _ => CharClassesStatus::BlockComment(deepness),
 654                 };
 655                 return Some((FullCodeCharKind::InComment, item));
 656             }
 657             CharClassesStatus::BlockCommentOpening(deepness) => {
 658                 assert_eq!(chr, '*');
 659                 self.status = CharClassesStatus::BlockComment(deepness);
 660                 return Some((FullCodeCharKind::InComment, item));
 661             }
 662             CharClassesStatus::BlockCommentClosing(deepness) => {
 663                 assert_eq!(chr, '/');
 664                 if deepness == 0 {
 665                     self.status = CharClassesStatus::Normal;
 666                     return Some((FullCodeCharKind::EndComment, item));
 667                 } else {
 668                     self.status = CharClassesStatus::BlockComment(deepness);
 669                     return Some((FullCodeCharKind::InComment, item));
 670                 }
 671             }
 672             CharClassesStatus::LineComment => match chr {
 673                 '\n' => {
 674                     self.status = CharClassesStatus::Normal;
 675                     return Some((FullCodeCharKind::EndComment, item));
 676                 }
 677                 _ => {
 678                     self.status = CharClassesStatus::LineComment;
 679                     return Some((FullCodeCharKind::InComment, item));
 680                 }
 681             },
 682         };
 683         Some((FullCodeCharKind::Normal, item))
 684     }
 685 }
 686
 687 /// Iterator over functional and commented parts of a string. Any part of a string is either
 688 /// functional code, either *one* block comment, either *one* line comment. Whitespace between
 689 /// comments is functional code. Line comments contain their ending newlines.
 690 struct UngroupedCommentCodeSlices<'a> {
 691     slice: &'a str,
 692     iter: iter::Peekable<CharClasses<std::str::CharIndices<'a>>>,
 693 }
 694
 695 impl<'a> UngroupedCommentCodeSlices<'a> {
 696     fn new(code: &'a str) -> UngroupedCommentCodeSlices<'a> {
 697         UngroupedCommentCodeSlices {
 698             slice: code,
 699             iter: CharClasses::new(code.char_indices()).peekable(),
 700         }
 701     }
 702 }
 703
 704 impl<'a> Iterator for UngroupedCommentCodeSlices<'a> {
 705     type Item = (CodeCharKind, usize, &'a str);
 706
 707     fn next(&mut self) -> Option<Self::Item> {
 708         let (kind, (start_idx, _)) = try_opt!(self.iter.next());
 709         match kind {
 710             FullCodeCharKind::Normal => {
 711                 // Consume all the Normal code
 712                 while let Some(&(FullCodeCharKind::Normal, (_, _))) = self.iter.peek() {
 713                     let _ = self.iter.next();
 714                 }
 715             }
 716             FullCodeCharKind::StartComment => {
 717                 // Consume the whole comment
 718                 while let Some((FullCodeCharKind::InComment, (_, _))) = self.iter.next() {}
 719             }
 720             _ => panic!(),
 721         }
 722         let slice = match self.iter.peek() {
 723             Some(&(_, (end_idx, _))) => &self.slice[start_idx..end_idx],
 724             None => &self.slice[start_idx..],
 725         };
 726         Some((
 727             if kind.is_comment() {
 728                 CodeCharKind::Comment
 729             } else {
 730                 CodeCharKind::Normal
 731             },
 732             start_idx,
 733             slice,
 734         ))
 735     }
 736 }
 737
 738
 739
 740
 741 /// Iterator over an alternating sequence of functional and commented parts of
 742 /// a string. The first item is always a, possibly zero length, subslice of
 743 /// functional text. Line style comments contain their ending newlines.
 744 pub struct CommentCodeSlices<'a> {
 745     slice: &'a str,
 746     last_slice_kind: CodeCharKind,
 747     last_slice_end: usize,
 748 }
 749
 750 impl<'a> CommentCodeSlices<'a> {
 751     pub fn new(slice: &'a str) -> CommentCodeSlices<'a> {
 752         CommentCodeSlices {
 753             slice: slice,
 754             last_slice_kind: CodeCharKind::Comment,
 755             last_slice_end: 0,
 756         }
 757     }
 758 }
 759
 760 impl<'a> Iterator for CommentCodeSlices<'a> {
 761     type Item = (CodeCharKind, usize, &'a str);
 762
 763     fn next(&mut self) -> Option<Self::Item> {
 764         if self.last_slice_end == self.slice.len() {
 765             return None;
 766         }
 767
 768         let mut sub_slice_end = self.last_slice_end;
 769         let mut first_whitespace = None;
 770         let subslice = &self.slice[self.last_slice_end..];
 771         let mut iter = CharClasses::new(subslice.char_indices());
 772
 773         for (kind, (i, c)) in &mut iter {
 774             let is_comment_connector = self.last_slice_kind == CodeCharKind::Normal &&
 775                 &subslice[..2] == "//" &&
 776                 [' ', '\t'].contains(&c);
 777
 778             if is_comment_connector && first_whitespace.is_none() {
 779                 first_whitespace = Some(i);
 780             }
 781
 782             if kind.to_codecharkind() == self.last_slice_kind && !is_comment_connector {
 783                 let last_index = match first_whitespace {
 784                     Some(j) => j,
 785                     None => i,
 786                 };
 787                 sub_slice_end = self.last_slice_end + last_index;
 788                 break;
 789             }
 790
 791             if !is_comment_connector {
 792                 first_whitespace = None;
 793             }
 794         }
 795
 796         if let (None, true) = (iter.next(), sub_slice_end == self.last_slice_end) {
 797             // This was the last subslice.
 798             sub_slice_end = match first_whitespace {
 799                 Some(i) => self.last_slice_end + i,
 800                 None => self.slice.len(),
 801             };
 802         }
 803
 804         let kind = match self.last_slice_kind {
 805             CodeCharKind::Comment => CodeCharKind::Normal,
 806             CodeCharKind::Normal => CodeCharKind::Comment,
 807         };
 808         let res = (
 809             kind,
 810             self.last_slice_end,
 811             &self.slice[self.last_slice_end..sub_slice_end],
 812         );
 813         self.last_slice_end = sub_slice_end;
 814         self.last_slice_kind = kind;
 815
 816         Some(res)
 817     }
 818 }
 819
 820 /// Checks is `new` didn't miss any comment from `span`, if it removed any, return previous text
 821 /// (if it fits in the width/offset, else return None), else return `new`
 822 pub fn recover_comment_removed(
 823     new: String,
 824     span: Span,
 825     context: &RewriteContext,
 826     shape: Shape,
 827 ) -> Option<String> {
 828     let snippet = context.snippet(span);
 829     if changed_comment_content(&snippet, &new) {
 830         // We missed some comments
 831         // Keep previous formatting if it satisfies the constrains
 832         wrap_str(snippet, context.config.max_width(), shape)
 833     } else {
 834         Some(new)
 835     }
 836 }
 837
 838 /// Return true if the two strings of code have the same payload of comments.
 839 /// The payload of comments is everything in the string except:
 840 ///     - actual code (not comments)
 841 ///     - comment start/end marks
 842 ///     - whitespace
 843 ///     - '*' at the beginning of lines in block comments
 844 fn changed_comment_content(orig: &str, new: &str) -> bool {
 845     // Cannot write this as a fn since we cannot return types containing closures
 846     let code_comment_content = |code| {
 847         let slices = UngroupedCommentCodeSlices::new(code);
 848         slices
 849             .filter(|&(ref kind, _, _)| *kind == CodeCharKind::Comment)
 850             .flat_map(|(_, _, s)| CommentReducer::new(s))
 851     };
 852     let res = code_comment_content(orig).ne(code_comment_content(new));
 853     debug!(
 854         "comment::changed_comment_content: {}\norig: '{}'\nnew: '{}'\nraw_old: {}\nraw_new: {}",
 855         res,
 856         orig,
 857         new,
 858         code_comment_content(orig).collect::<String>(),
 859         code_comment_content(new).collect::<String>()
 860     );
 861     res
 862 }
 863
 864
 865 /// Iterator over the 'payload' characters of a comment.
 866 /// It skips whitespace, comment start/end marks, and '*' at the beginning of lines.
 867 /// The comment must be one comment, ie not more than one start mark (no multiple line comments,
 868 /// for example).
 869 struct CommentReducer<'a> {
 870     is_block: bool,
 871     at_start_line: bool,
 872     iter: std::str::Chars<'a>,
 873 }
 874
 875 impl<'a> CommentReducer<'a> {
 876     fn new(comment: &'a str) -> CommentReducer<'a> {
 877         let is_block = comment.starts_with("/*");
 878         let comment = remove_comment_header(comment);
 879         CommentReducer {
 880             is_block: is_block,
 881             at_start_line: false, // There are no supplementary '*' on the first line
 882             iter: comment.chars(),
 883         }
 884     }
 885 }
 886
 887 impl<'a> Iterator for CommentReducer<'a> {
 888     type Item = char;
 889     fn next(&mut self) -> Option<Self::Item> {
 890         loop {
 891             let mut c = try_opt!(self.iter.next());
 892             if self.is_block && self.at_start_line {
 893                 while c.is_whitespace() {
 894                     c = try_opt!(self.iter.next());
 895                 }
 896                 // Ignore leading '*'
 897                 if c == '*' {
 898                     c = try_opt!(self.iter.next());
 899                 }
 900             } else if c == '\n' {
 901                 self.at_start_line = true;
 902             }
 903             if !c.is_whitespace() {
 904                 return Some(c);
 905             }
 906         }
 907     }
 908 }
 909
 910
 911 fn remove_comment_header(comment: &str) -> &str {
 912     if comment.starts_with("///") || comment.starts_with("//!") {
 913         &comment[3..]
 914     } else if comment.starts_with("//") {
 915         &comment[2..]
 916     } else if (comment.starts_with("/**") && !comment.starts_with("/**/")) ||
 917         comment.starts_with("/*!")
 918     {
 919         &comment[3..comment.len() - 2]
 920     } else {
 921         assert!(
 922             comment.starts_with("/*"),
 923             format!("string '{}' is not a comment", comment)
 924         );
 925         &comment[2..comment.len() - 2]
 926     }
 927 }
 928
 929 #[cfg(test)]
 930 mod test {
 931     use super::{contains_comment, rewrite_comment, CharClasses, CodeCharKind, CommentCodeSlices,
 932                 FindUncommented, FullCodeCharKind};
 933     use {Indent, Shape};
 934
 935     #[test]
 936     fn char_classes() {
 937         let mut iter = CharClasses::new("//\n\n".chars());
 938
 939         assert_eq!((FullCodeCharKind::StartComment, '/'), iter.next().unwrap());
 940         assert_eq!((FullCodeCharKind::InComment, '/'), iter.next().unwrap());
 941         assert_eq!((FullCodeCharKind::EndComment, '\n'), iter.next().unwrap());
 942         assert_eq!((FullCodeCharKind::Normal, '\n'), iter.next().unwrap());
 943         assert_eq!(None, iter.next());
 944     }
 945
 946     #[test]
 947     fn comment_code_slices() {
 948         let input = "code(); /* test */ 1 + 1";
 949         let mut iter = CommentCodeSlices::new(input);
 950
 951         assert_eq!((CodeCharKind::Normal, 0, "code(); "), iter.next().unwrap());
 952         assert_eq!(
 953             (CodeCharKind::Comment, 8, "/* test */"),
 954             iter.next().unwrap()
 955         );
 956         assert_eq!((CodeCharKind::Normal, 18, " 1 + 1"), iter.next().unwrap());
 957         assert_eq!(None, iter.next());
 958     }
 959
 960     #[test]
 961     fn comment_code_slices_two() {
 962         let input = "// comment\n    test();";
 963         let mut iter = CommentCodeSlices::new(input);
 964
 965         assert_eq!((CodeCharKind::Normal, 0, ""), iter.next().unwrap());
 966         assert_eq!(
 967             (CodeCharKind::Comment, 0, "// comment\n"),
 968             iter.next().unwrap()
 969         );
 970         assert_eq!(
 971             (CodeCharKind::Normal, 11, "    test();"),
 972             iter.next().unwrap()
 973         );
 974         assert_eq!(None, iter.next());
 975     }
 976
 977     #[test]
 978     fn comment_code_slices_three() {
 979         let input = "1 // comment\n    // comment2\n\n";
 980         let mut iter = CommentCodeSlices::new(input);
 981
 982         assert_eq!((CodeCharKind::Normal, 0, "1 "), iter.next().unwrap());
 983         assert_eq!(
 984             (CodeCharKind::Comment, 2, "// comment\n    // comment2\n"),
 985             iter.next().unwrap()
 986         );
 987         assert_eq!((CodeCharKind::Normal, 29, "\n"), iter.next().unwrap());
 988         assert_eq!(None, iter.next());
 989     }
 990
 991     #[test]
 992     #[cfg_attr(rustfmt, rustfmt_skip)]
 993     fn format_comments() {
 994         let mut config: ::config::Config = Default::default();
 995         config.set().wrap_comments(true);
 996         config.set().normalize_comments(true);
 997
 998         let comment = rewrite_comment(" //test",
 999                                       true,
1000                                       Shape::legacy(100, Indent::new(0, 100)),
1001                                       &config).unwrap();
1002         assert_eq!("/* test */", comment);
1003
1004         let comment = rewrite_comment("// comment on a",
1005                                       false,
1006                                       Shape::legacy(10, Indent::empty()),
1007                                       &config).unwrap();
1008         assert_eq!("// comment\n// on a", comment);
1009
1010         let comment = rewrite_comment("//  A multi line comment\n             // between args.",
1011                                       false,
1012                                       Shape::legacy(60, Indent::new(0, 12)),
1013                                       &config).unwrap();
1014         assert_eq!("//  A multi line comment\n            // between args.", comment);
1015
1016         let input = "// comment";
1017         let expected =
1018             "/* comment */";
1019         let comment = rewrite_comment(input,
1020                                       true,
1021                                       Shape::legacy(9, Indent::new(0, 69)),
1022                                       &config).unwrap();
1023         assert_eq!(expected, comment);
1024
1025         let comment = rewrite_comment("/*   trimmed    */",
1026                                       true,
1027                                       Shape::legacy(100, Indent::new(0, 100)),
1028                                       &config).unwrap();
1029         assert_eq!("/* trimmed */", comment);
1030     }
1031
1032     // This is probably intended to be a non-test fn, but it is not used. I'm
1033     // keeping it around unless it helps us test stuff.
1034     fn uncommented(text: &str) -> String {
1035         CharClasses::new(text.chars())
1036             .filter_map(|(s, c)| match s {
1037                 FullCodeCharKind::Normal => Some(c),
1038                 _ => None,
1039             })
1040             .collect()
1041     }
1042
1043     #[test]
1044     fn test_uncommented() {
1045         assert_eq!(&uncommented("abc/*...*/"), "abc");
1046         assert_eq!(
1047             &uncommented("// .... /* \n../* /* *** / */ */a/* // */c\n"),
1048             "..ac\n"
1049         );
1050         assert_eq!(&uncommented("abc \" /* */\" qsdf"), "abc \" /* */\" qsdf");
1051     }
1052
1053     #[test]
1054     fn test_contains_comment() {
1055         assert_eq!(contains_comment("abc"), false);
1056         assert_eq!(contains_comment("abc // qsdf"), true);
1057         assert_eq!(contains_comment("abc /* kqsdf"), true);
1058         assert_eq!(contains_comment("abc \" /* */\" qsdf"), false);
1059     }
1060
1061     #[test]
1062     fn test_find_uncommented() {
1063         fn check(haystack: &str, needle: &str, expected: Option<usize>) {
1064             assert_eq!(expected, haystack.find_uncommented(needle));
1065         }
1066
1067         check("/*/ */test", "test", Some(6));
1068         check("//test\ntest", "test", Some(7));
1069         check("/* comment only */", "whatever", None);
1070         check(
1071             "/* comment */ some text /* more commentary */ result",
1072             "result",
1073             Some(46),
1074         );
1075         check("sup // sup", "p", Some(2));
1076         check("sup", "x", None);
1077         check(r#"π? /**/ π is nice!"#, r#"π is nice"#, Some(9));
1078         check("/*sup yo? \n sup*/ sup", "p", Some(20));
1079         check("hel/*lohello*/lo", "hello", None);
1080         check("acb", "ab", None);
1081         check(",/*A*/ ", ",", Some(0));
1082         check("abc", "abc", Some(0));
1083         check("/* abc */", "abc", None);
1084         check("/**/abc/* */", "abc", Some(4));
1085         check("\"/* abc */\"", "abc", Some(4));
1086         check("\"/* abc", "abc", Some(4));
1087     }
1088 }