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 config::Config;
  18 use rewrite::RewriteContext;
  19 use shape::{Indent, Shape};
  20 use string::{rewrite_string, StringFormat};
  21 use utils::{first_line_width, last_line_width};
  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 = 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 original
 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 = rewrite_comment_inner(&first_group, block_style, style, shape, config)?;
 258     if rest.is_empty() {
 259         Some(first_group_str)
 260     } else {
 261         identify_comment(&rest, block_style, shape, config).map(|rest_str| {
 262             format!(
 263                 "{}\n{}{}",
 264                 first_group_str,
 265                 shape.indent.to_string(config),
 266                 rest_str
 267             )
 268         })
 269     }
 270 }
 271
 272 fn rewrite_comment_inner(
 273     orig: &str,
 274     block_style: bool,
 275     style: CommentStyle,
 276     shape: Shape,
 277     config: &Config,
 278 ) -> Option<String> {
 279     let (opener, closer, line_start) = if block_style {
 280         CommentStyle::SingleBullet.to_str_tuplet()
 281     } else {
 282         comment_style(orig, config.normalize_comments()).to_str_tuplet()
 283     };
 284
 285     let max_chars = shape
 286         .width
 287         .checked_sub(closer.len() + opener.len())
 288         .unwrap_or(1);
 289     let indent_str = shape.indent.to_string(config);
 290     let fmt_indent = shape.indent + (opener.len() - line_start.len());
 291     let mut fmt = StringFormat {
 292         opener: "",
 293         closer: "",
 294         line_start: line_start,
 295         line_end: "",
 296         shape: Shape::legacy(max_chars, fmt_indent),
 297         trim_end: true,
 298         config: config,
 299     };
 300
 301     let line_breaks = orig.trim_right().chars().filter(|&c| c == '\n').count();
 302     let lines = orig.lines()
 303         .enumerate()
 304         .map(|(i, mut line)| {
 305             line = line.trim();
 306             // Drop old closer.
 307             if i == line_breaks && line.ends_with("*/") && !line.starts_with("//") {
 308                 line = line[..(line.len() - 2)].trim_right();
 309             }
 310
 311             line
 312         })
 313         .map(|s| left_trim_comment_line(s, &style))
 314         .map(|line| {
 315             if orig.starts_with("/*") && line_breaks == 0 {
 316                 line.trim_left()
 317             } else {
 318                 line
 319             }
 320         });
 321
 322     let mut result = opener.to_owned();
 323     let mut is_prev_line_multi_line = false;
 324     let comment_line_separator = format!("\n{}{}", indent_str, line_start);
 325     for line in lines {
 326         if result == opener {
 327             if line.is_empty() {
 328                 continue;
 329             }
 330         } else {
 331             if is_prev_line_multi_line && !line.is_empty() {
 332                 result.push(' ')
 333             } else {
 334                 result.push_str(&comment_line_separator);
 335             }
 336         }
 337
 338         if config.wrap_comments() && line.len() > fmt.shape.width && !has_url(line) {
 339             match rewrite_string(line, &fmt, Some(max_chars)) {
 340                 Some(ref s) => {
 341                     is_prev_line_multi_line = s.contains('\n');
 342                     result.push_str(s);
 343                 }
 344                 None if is_prev_line_multi_line => {
 345                     // We failed to put the current `line` next to the previous `line`.
 346                     // Remove the trailing space, then start rewrite on the next line.
 347                     result.pop();
 348                     result.push_str(&comment_line_separator);
 349                     fmt.shape = Shape::legacy(max_chars, fmt_indent);
 350                     match rewrite_string(line, &fmt, Some(max_chars)) {
 351                         Some(ref s) => {
 352                             is_prev_line_multi_line = s.contains('\n');
 353                             result.push_str(s);
 354                         }
 355                         None => {
 356                             is_prev_line_multi_line = false;
 357                             result.push_str(line);
 358                         }
 359                     }
 360                 }
 361                 None => {
 362                     is_prev_line_multi_line = false;
 363                     result.push_str(line);
 364                 }
 365             }
 366
 367             fmt.shape = if is_prev_line_multi_line {
 368                 // 1 = " "
 369                 let offset = 1 + last_line_width(&result) - line_start.len();
 370                 Shape {
 371                     width: max_chars.checked_sub(offset).unwrap_or(0),
 372                     indent: fmt_indent,
 373                     offset: fmt.shape.offset + offset,
 374                 }
 375             } else {
 376                 Shape::legacy(max_chars, fmt_indent)
 377             };
 378         } else {
 379             if line.is_empty() && result.ends_with(' ') {
 380                 // Remove space if this is an empty comment or a doc comment.
 381                 result.pop();
 382             }
 383             result.push_str(line);
 384             fmt.shape = Shape::legacy(max_chars, fmt_indent);
 385             is_prev_line_multi_line = false;
 386         }
 387     }
 388
 389     result.push_str(closer);
 390     if result == opener && result.ends_with(' ') {
 391         // Trailing space.
 392         result.pop();
 393     }
 394
 395     Some(result)
 396 }
 397
 398 /// Returns true if the given string MAY include URLs or alike.
 399 fn has_url(s: &str) -> bool {
 400     // This function may return false positive, but should get its job done in most cases.
 401     s.contains("https://") || s.contains("http://") || s.contains("ftp://") || s.contains("file://")
 402 }
 403
 404 /// Given the span, rewrite the missing comment inside it if available.
 405 /// Note that the given span must only include comments (or leading/trailing whitespaces).
 406 pub fn rewrite_missing_comment(
 407     span: Span,
 408     shape: Shape,
 409     context: &RewriteContext,
 410 ) -> Option<String> {
 411     let missing_snippet = context.snippet(span);
 412     let trimmed_snippet = missing_snippet.trim();
 413     if !trimmed_snippet.is_empty() {
 414         rewrite_comment(trimmed_snippet, false, shape, context.config)
 415     } else {
 416         Some(String::new())
 417     }
 418 }
 419
 420 /// Recover the missing comments in the specified span, if available.
 421 /// The layout of the comments will be preserved as long as it does not break the code
 422 /// and its total width does not exceed the max width.
 423 pub fn recover_missing_comment_in_span(
 424     span: Span,
 425     shape: Shape,
 426     context: &RewriteContext,
 427     used_width: usize,
 428 ) -> Option<String> {
 429     let missing_comment = rewrite_missing_comment(span, shape, context)?;
 430     if missing_comment.is_empty() {
 431         Some(String::new())
 432     } else {
 433         let missing_snippet = context.snippet(span);
 434         let pos = missing_snippet.chars().position(|c| c == '/').unwrap_or(0);
 435         // 1 = ` `
 436         let total_width = missing_comment.len() + used_width + 1;
 437         let force_new_line_before_comment =
 438             missing_snippet[..pos].contains('\n') || total_width > context.config.max_width();
 439         let sep = if force_new_line_before_comment {
 440             format!("\n{}", shape.indent.to_string(context.config))
 441         } else {
 442             String::from(" ")
 443         };
 444         Some(format!("{}{}", sep, missing_comment))
 445     }
 446 }
 447
 448 /// Trims whitespace and aligns to indent, but otherwise does not change comments.
 449 fn light_rewrite_comment(orig: &str, offset: Indent, config: &Config) -> Option<String> {
 450     let lines: Vec<&str> = orig.lines()
 451         .map(|l| {
 452             // This is basically just l.trim(), but in the case that a line starts
 453             // with `*` we want to leave one space before it, so it aligns with the
 454             // `*` in `/*`.
 455             let first_non_whitespace = l.find(|c| !char::is_whitespace(c));
 456             if let Some(fnw) = first_non_whitespace {
 457                 if l.as_bytes()[fnw] == b'*' && fnw > 0 {
 458                     &l[fnw - 1..]
 459                 } else {
 460                     &l[fnw..]
 461                 }
 462             } else {
 463                 ""
 464             }.trim_right()
 465         })
 466         .collect();
 467     Some(lines.join(&format!("\n{}", offset.to_string(config))))
 468 }
 469
 470 /// Trims comment characters and possibly a single space from the left of a string.
 471 /// Does not trim all whitespace.
 472 fn left_trim_comment_line<'a>(line: &'a str, style: &CommentStyle) -> &'a str {
 473     if line.starts_with("//! ") || line.starts_with("/// ") || line.starts_with("/*! ")
 474         || line.starts_with("/** ")
 475     {
 476         &line[4..]
 477     } else if let CommentStyle::Custom(opener) = *style {
 478         if line.starts_with(opener) {
 479             &line[opener.len()..]
 480         } else {
 481             &line[opener.trim_right().len()..]
 482         }
 483     } else if line.starts_with("/* ") || line.starts_with("// ") || line.starts_with("//!")
 484         || line.starts_with("///") || line.starts_with("** ")
 485         || line.starts_with("/*!")
 486         || (line.starts_with("/**") && !line.starts_with("/**/"))
 487     {
 488         &line[3..]
 489     } else if line.starts_with("/*") || line.starts_with("* ") || line.starts_with("//")
 490         || line.starts_with("**")
 491     {
 492         &line[2..]
 493     } else if line.starts_with('*') {
 494         &line[1..]
 495     } else {
 496         line
 497     }
 498 }
 499
 500 pub trait FindUncommented {
 501     fn find_uncommented(&self, pat: &str) -> Option<usize>;
 502 }
 503
 504 impl FindUncommented for str {
 505     fn find_uncommented(&self, pat: &str) -> Option<usize> {
 506         let mut needle_iter = pat.chars();
 507         for (kind, (i, b)) in CharClasses::new(self.char_indices()) {
 508             match needle_iter.next() {
 509                 None => {
 510                     return Some(i - pat.len());
 511                 }
 512                 Some(c) => match kind {
 513                     FullCodeCharKind::Normal | FullCodeCharKind::InString if b == c => {}
 514                     _ => {
 515                         needle_iter = pat.chars();
 516                     }
 517                 },
 518             }
 519         }
 520
 521         // Handle case where the pattern is a suffix of the search string
 522         match needle_iter.next() {
 523             Some(_) => None,
 524             None => Some(self.len() - pat.len()),
 525         }
 526     }
 527 }
 528
 529 // Returns the first byte position after the first comment. The given string
 530 // is expected to be prefixed by a comment, including delimiters.
 531 // Good: "/* /* inner */ outer */ code();"
 532 // Bad:  "code(); // hello\n world!"
 533 pub fn find_comment_end(s: &str) -> Option<usize> {
 534     let mut iter = CharClasses::new(s.char_indices());
 535     for (kind, (i, _c)) in &mut iter {
 536         if kind == FullCodeCharKind::Normal || kind == FullCodeCharKind::InString {
 537             return Some(i);
 538         }
 539     }
 540
 541     // Handle case where the comment ends at the end of s.
 542     if iter.status == CharClassesStatus::Normal {
 543         Some(s.len())
 544     } else {
 545         None
 546     }
 547 }
 548
 549 /// Returns true if text contains any comment.
 550 pub fn contains_comment(text: &str) -> bool {
 551     CharClasses::new(text.chars()).any(|(kind, _)| kind.is_comment())
 552 }
 553
 554 /// Remove trailing spaces from the specified snippet. We do not remove spaces
 555 /// inside strings or comments.
 556 pub fn remove_trailing_white_spaces(text: &str) -> String {
 557     let mut buffer = String::with_capacity(text.len());
 558     let mut space_buffer = String::with_capacity(128);
 559     for (char_kind, c) in CharClasses::new(text.chars()) {
 560         match c {
 561             '\n' => {
 562                 if char_kind == FullCodeCharKind::InString {
 563                     buffer.push_str(&space_buffer);
 564                 }
 565                 space_buffer.clear();
 566                 buffer.push('\n');
 567             }
 568             _ if c.is_whitespace() => {
 569                 space_buffer.push(c);
 570             }
 571             _ => {
 572                 if !space_buffer.is_empty() {
 573                     buffer.push_str(&space_buffer);
 574                     space_buffer.clear();
 575                 }
 576                 buffer.push(c);
 577             }
 578         }
 579     }
 580     buffer
 581 }
 582
 583 struct CharClasses<T>
 584 where
 585     T: Iterator,
 586     T::Item: RichChar,
 587 {
 588     base: iter::Peekable<T>,
 589     status: CharClassesStatus,
 590 }
 591
 592 trait RichChar {
 593     fn get_char(&self) -> char;
 594 }
 595
 596 impl RichChar for char {
 597     fn get_char(&self) -> char {
 598         *self
 599     }
 600 }
 601
 602 impl RichChar for (usize, char) {
 603     fn get_char(&self) -> char {
 604         self.1
 605     }
 606 }
 607
 608 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
 609 enum CharClassesStatus {
 610     Normal,
 611     LitString,
 612     LitStringEscape,
 613     LitChar,
 614     LitCharEscape,
 615     // The u32 is the nesting deepness of the comment
 616     BlockComment(u32),
 617     // Status when the '/' has been consumed, but not yet the '*', deepness is
 618     // the new deepness (after the comment opening).
 619     BlockCommentOpening(u32),
 620     // Status when the '*' has been consumed, but not yet the '/', deepness is
 621     // the new deepness (after the comment closing).
 622     BlockCommentClosing(u32),
 623     LineComment,
 624 }
 625
 626 /// Distinguish between functional part of code and comments
 627 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
 628 pub enum CodeCharKind {
 629     Normal,
 630     Comment,
 631 }
 632
 633 /// Distinguish between functional part of code and comments,
 634 /// describing opening and closing of comments for ease when chunking
 635 /// code from tagged characters
 636 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
 637 enum FullCodeCharKind {
 638     Normal,
 639     /// The first character of a comment, there is only one for a comment (always '/')
 640     StartComment,
 641     /// Any character inside a comment including the second character of comment
 642     /// marks ("//", "/*")
 643     InComment,
 644     /// Last character of a comment, '\n' for a line comment, '/' for a block comment.
 645     EndComment,
 646     /// Inside a string.
 647     InString,
 648 }
 649
 650 impl FullCodeCharKind {
 651     fn is_comment(&self) -> bool {
 652         match *self {
 653             FullCodeCharKind::StartComment |
 654             FullCodeCharKind::InComment |
 655             FullCodeCharKind::EndComment => true,
 656             _ => false,
 657         }
 658     }
 659
 660     fn to_codecharkind(&self) -> CodeCharKind {
 661         if self.is_comment() {
 662             CodeCharKind::Comment
 663         } else {
 664             CodeCharKind::Normal
 665         }
 666     }
 667 }
 668
 669 impl<T> CharClasses<T>
 670 where
 671     T: Iterator,
 672     T::Item: RichChar,
 673 {
 674     fn new(base: T) -> CharClasses<T> {
 675         CharClasses {
 676             base: base.peekable(),
 677             status: CharClassesStatus::Normal,
 678         }
 679     }
 680 }
 681
 682 impl<T> Iterator for CharClasses<T>
 683 where
 684     T: Iterator,
 685     T::Item: RichChar,
 686 {
 687     type Item = (FullCodeCharKind, T::Item);
 688
 689     fn next(&mut self) -> Option<(FullCodeCharKind, T::Item)> {
 690         let item = self.base.next()?;
 691         let chr = item.get_char();
 692         let mut char_kind = FullCodeCharKind::Normal;
 693         self.status = match self.status {
 694             CharClassesStatus::LitString => match chr {
 695                 '"' => CharClassesStatus::Normal,
 696                 '\\' => {
 697                     char_kind = FullCodeCharKind::InString;
 698                     CharClassesStatus::LitStringEscape
 699                 }
 700                 _ => {
 701                     char_kind = FullCodeCharKind::InString;
 702                     CharClassesStatus::LitString
 703                 }
 704             },
 705             CharClassesStatus::LitStringEscape => {
 706                 char_kind = FullCodeCharKind::InString;
 707                 CharClassesStatus::LitString
 708             }
 709             CharClassesStatus::LitChar => match chr {
 710                 '\\' => CharClassesStatus::LitCharEscape,
 711                 '\'' => CharClassesStatus::Normal,
 712                 _ => CharClassesStatus::LitChar,
 713             },
 714             CharClassesStatus::LitCharEscape => CharClassesStatus::LitChar,
 715             CharClassesStatus::Normal => match chr {
 716                 '"' => {
 717                     char_kind = FullCodeCharKind::InString;
 718                     CharClassesStatus::LitString
 719                 }
 720                 '\'' => CharClassesStatus::LitChar,
 721                 '/' => match self.base.peek() {
 722                     Some(next) if next.get_char() == '*' => {
 723                         self.status = CharClassesStatus::BlockCommentOpening(1);
 724                         return Some((FullCodeCharKind::StartComment, item));
 725                     }
 726                     Some(next) if next.get_char() == '/' => {
 727                         self.status = CharClassesStatus::LineComment;
 728                         return Some((FullCodeCharKind::StartComment, item));
 729                     }
 730                     _ => CharClassesStatus::Normal,
 731                 },
 732                 _ => CharClassesStatus::Normal,
 733             },
 734             CharClassesStatus::BlockComment(deepness) => {
 735                 assert_ne!(deepness, 0);
 736                 self.status = match self.base.peek() {
 737                     Some(next) if next.get_char() == '/' && chr == '*' => {
 738                         CharClassesStatus::BlockCommentClosing(deepness - 1)
 739                     }
 740                     Some(next) if next.get_char() == '*' && chr == '/' => {
 741                         CharClassesStatus::BlockCommentOpening(deepness + 1)
 742                     }
 743                     _ => CharClassesStatus::BlockComment(deepness),
 744                 };
 745                 return Some((FullCodeCharKind::InComment, item));
 746             }
 747             CharClassesStatus::BlockCommentOpening(deepness) => {
 748                 assert_eq!(chr, '*');
 749                 self.status = CharClassesStatus::BlockComment(deepness);
 750                 return Some((FullCodeCharKind::InComment, item));
 751             }
 752             CharClassesStatus::BlockCommentClosing(deepness) => {
 753                 assert_eq!(chr, '/');
 754                 if deepness == 0 {
 755                     self.status = CharClassesStatus::Normal;
 756                     return Some((FullCodeCharKind::EndComment, item));
 757                 } else {
 758                     self.status = CharClassesStatus::BlockComment(deepness);
 759                     return Some((FullCodeCharKind::InComment, item));
 760                 }
 761             }
 762             CharClassesStatus::LineComment => match chr {
 763                 '\n' => {
 764                     self.status = CharClassesStatus::Normal;
 765                     return Some((FullCodeCharKind::EndComment, item));
 766                 }
 767                 _ => {
 768                     self.status = CharClassesStatus::LineComment;
 769                     return Some((FullCodeCharKind::InComment, item));
 770                 }
 771             },
 772         };
 773         Some((char_kind, item))
 774     }
 775 }
 776
 777 /// Iterator over functional and commented parts of a string. Any part of a string is either
 778 /// functional code, either *one* block comment, either *one* line comment. Whitespace between
 779 /// comments is functional code. Line comments contain their ending newlines.
 780 struct UngroupedCommentCodeSlices<'a> {
 781     slice: &'a str,
 782     iter: iter::Peekable<CharClasses<std::str::CharIndices<'a>>>,
 783 }
 784
 785 impl<'a> UngroupedCommentCodeSlices<'a> {
 786     fn new(code: &'a str) -> UngroupedCommentCodeSlices<'a> {
 787         UngroupedCommentCodeSlices {
 788             slice: code,
 789             iter: CharClasses::new(code.char_indices()).peekable(),
 790         }
 791     }
 792 }
 793
 794 impl<'a> Iterator for UngroupedCommentCodeSlices<'a> {
 795     type Item = (CodeCharKind, usize, &'a str);
 796
 797     fn next(&mut self) -> Option<Self::Item> {
 798         let (kind, (start_idx, _)) = self.iter.next()?;
 799         match kind {
 800             FullCodeCharKind::Normal | FullCodeCharKind::InString => {
 801                 // Consume all the Normal code
 802                 while let Some(&(char_kind, _)) = self.iter.peek() {
 803                     if char_kind.is_comment() {
 804                         break;
 805                     }
 806                     let _ = self.iter.next();
 807                 }
 808             }
 809             FullCodeCharKind::StartComment => {
 810                 // Consume the whole comment
 811                 while let Some((FullCodeCharKind::InComment, (_, _))) = self.iter.next() {}
 812             }
 813             _ => panic!(),
 814         }
 815         let slice = match self.iter.peek() {
 816             Some(&(_, (end_idx, _))) => &self.slice[start_idx..end_idx],
 817             None => &self.slice[start_idx..],
 818         };
 819         Some((
 820             if kind.is_comment() {
 821                 CodeCharKind::Comment
 822             } else {
 823                 CodeCharKind::Normal
 824             },
 825             start_idx,
 826             slice,
 827         ))
 828     }
 829 }
 830
 831
 832
 833
 834 /// Iterator over an alternating sequence of functional and commented parts of
 835 /// a string. The first item is always a, possibly zero length, subslice of
 836 /// functional text. Line style comments contain their ending newlines.
 837 pub struct CommentCodeSlices<'a> {
 838     slice: &'a str,
 839     last_slice_kind: CodeCharKind,
 840     last_slice_end: usize,
 841 }
 842
 843 impl<'a> CommentCodeSlices<'a> {
 844     pub fn new(slice: &'a str) -> CommentCodeSlices<'a> {
 845         CommentCodeSlices {
 846             slice: slice,
 847             last_slice_kind: CodeCharKind::Comment,
 848             last_slice_end: 0,
 849         }
 850     }
 851 }
 852
 853 impl<'a> Iterator for CommentCodeSlices<'a> {
 854     type Item = (CodeCharKind, usize, &'a str);
 855
 856     fn next(&mut self) -> Option<Self::Item> {
 857         if self.last_slice_end == self.slice.len() {
 858             return None;
 859         }
 860
 861         let mut sub_slice_end = self.last_slice_end;
 862         let mut first_whitespace = None;
 863         let subslice = &self.slice[self.last_slice_end..];
 864         let mut iter = CharClasses::new(subslice.char_indices());
 865
 866         for (kind, (i, c)) in &mut iter {
 867             let is_comment_connector = self.last_slice_kind == CodeCharKind::Normal
 868                 && &subslice[..2] == "//"
 869                 && [' ', '\t'].contains(&c);
 870
 871             if is_comment_connector && first_whitespace.is_none() {
 872                 first_whitespace = Some(i);
 873             }
 874
 875             if kind.to_codecharkind() == self.last_slice_kind && !is_comment_connector {
 876                 let last_index = match first_whitespace {
 877                     Some(j) => j,
 878                     None => i,
 879                 };
 880                 sub_slice_end = self.last_slice_end + last_index;
 881                 break;
 882             }
 883
 884             if !is_comment_connector {
 885                 first_whitespace = None;
 886             }
 887         }
 888
 889         if let (None, true) = (iter.next(), sub_slice_end == self.last_slice_end) {
 890             // This was the last subslice.
 891             sub_slice_end = match first_whitespace {
 892                 Some(i) => self.last_slice_end + i,
 893                 None => self.slice.len(),
 894             };
 895         }
 896
 897         let kind = match self.last_slice_kind {
 898             CodeCharKind::Comment => CodeCharKind::Normal,
 899             CodeCharKind::Normal => CodeCharKind::Comment,
 900         };
 901         let res = (
 902             kind,
 903             self.last_slice_end,
 904             &self.slice[self.last_slice_end..sub_slice_end],
 905         );
 906         self.last_slice_end = sub_slice_end;
 907         self.last_slice_kind = kind;
 908
 909         Some(res)
 910     }
 911 }
 912
 913 /// Checks is `new` didn't miss any comment from `span`, if it removed any, return previous text
 914 /// (if it fits in the width/offset, else return None), else return `new`
 915 pub fn recover_comment_removed(
 916     new: String,
 917     span: Span,
 918     context: &RewriteContext,
 919 ) -> Option<String> {
 920     let snippet = context.snippet(span);
 921     if snippet != new && changed_comment_content(&snippet, &new) {
 922         // We missed some comments. Keep the original text.
 923         Some(snippet)
 924     } else {
 925         Some(new)
 926     }
 927 }
 928
 929 /// Return true if the two strings of code have the same payload of comments.
 930 /// The payload of comments is everything in the string except:
 931 ///     - actual code (not comments)
 932 ///     - comment start/end marks
 933 ///     - whitespace
 934 ///     - '*' at the beginning of lines in block comments
 935 fn changed_comment_content(orig: &str, new: &str) -> bool {
 936     // Cannot write this as a fn since we cannot return types containing closures
 937     let code_comment_content = |code| {
 938         let slices = UngroupedCommentCodeSlices::new(code);
 939         slices
 940             .filter(|&(ref kind, _, _)| *kind == CodeCharKind::Comment)
 941             .flat_map(|(_, _, s)| CommentReducer::new(s))
 942     };
 943     let res = code_comment_content(orig).ne(code_comment_content(new));
 944     debug!(
 945         "comment::changed_comment_content: {}\norig: '{}'\nnew: '{}'\nraw_old: {}\nraw_new: {}",
 946         res,
 947         orig,
 948         new,
 949         code_comment_content(orig).collect::<String>(),
 950         code_comment_content(new).collect::<String>()
 951     );
 952     res
 953 }
 954
 955
 956 /// Iterator over the 'payload' characters of a comment.
 957 /// It skips whitespace, comment start/end marks, and '*' at the beginning of lines.
 958 /// The comment must be one comment, ie not more than one start mark (no multiple line comments,
 959 /// for example).
 960 struct CommentReducer<'a> {
 961     is_block: bool,
 962     at_start_line: bool,
 963     iter: std::str::Chars<'a>,
 964 }
 965
 966 impl<'a> CommentReducer<'a> {
 967     fn new(comment: &'a str) -> CommentReducer<'a> {
 968         let is_block = comment.starts_with("/*");
 969         let comment = remove_comment_header(comment);
 970         CommentReducer {
 971             is_block: is_block,
 972             at_start_line: false, // There are no supplementary '*' on the first line
 973             iter: comment.chars(),
 974         }
 975     }
 976 }
 977
 978 impl<'a> Iterator for CommentReducer<'a> {
 979     type Item = char;
 980     fn next(&mut self) -> Option<Self::Item> {
 981         loop {
 982             let mut c = self.iter.next()?;
 983             if self.is_block && self.at_start_line {
 984                 while c.is_whitespace() {
 985                     c = self.iter.next()?;
 986                 }
 987                 // Ignore leading '*'
 988                 if c == '*' {
 989                     c = self.iter.next()?;
 990                 }
 991             } else if c == '\n' {
 992                 self.at_start_line = true;
 993             }
 994             if !c.is_whitespace() {
 995                 return Some(c);
 996             }
 997         }
 998     }
 999 }
1000
1001
1002 fn remove_comment_header(comment: &str) -> &str {
1003     if comment.starts_with("///") || comment.starts_with("//!") {
1004         &comment[3..]
1005     } else if comment.starts_with("//") {
1006         &comment[2..]
1007     } else if (comment.starts_with("/**") && !comment.starts_with("/**/"))
1008         || comment.starts_with("/*!")
1009     {
1010         &comment[3..comment.len() - 2]
1011     } else {
1012         assert!(
1013             comment.starts_with("/*"),
1014             format!("string '{}' is not a comment", comment)
1015         );
1016         &comment[2..comment.len() - 2]
1017     }
1018 }
1019
1020 #[cfg(test)]
1021 mod test {
1022     use super::{contains_comment, rewrite_comment, CharClasses, CodeCharKind, CommentCodeSlices,
1023                 FindUncommented, FullCodeCharKind};
1024     use shape::{Indent, Shape};
1025
1026     #[test]
1027     fn char_classes() {
1028         let mut iter = CharClasses::new("//\n\n".chars());
1029
1030         assert_eq!((FullCodeCharKind::StartComment, '/'), iter.next().unwrap());
1031         assert_eq!((FullCodeCharKind::InComment, '/'), iter.next().unwrap());
1032         assert_eq!((FullCodeCharKind::EndComment, '\n'), iter.next().unwrap());
1033         assert_eq!((FullCodeCharKind::Normal, '\n'), iter.next().unwrap());
1034         assert_eq!(None, iter.next());
1035     }
1036
1037     #[test]
1038     fn comment_code_slices() {
1039         let input = "code(); /* test */ 1 + 1";
1040         let mut iter = CommentCodeSlices::new(input);
1041
1042         assert_eq!((CodeCharKind::Normal, 0, "code(); "), iter.next().unwrap());
1043         assert_eq!(
1044             (CodeCharKind::Comment, 8, "/* test */"),
1045             iter.next().unwrap()
1046         );
1047         assert_eq!((CodeCharKind::Normal, 18, " 1 + 1"), iter.next().unwrap());
1048         assert_eq!(None, iter.next());
1049     }
1050
1051     #[test]
1052     fn comment_code_slices_two() {
1053         let input = "// comment\n    test();";
1054         let mut iter = CommentCodeSlices::new(input);
1055
1056         assert_eq!((CodeCharKind::Normal, 0, ""), iter.next().unwrap());
1057         assert_eq!(
1058             (CodeCharKind::Comment, 0, "// comment\n"),
1059             iter.next().unwrap()
1060         );
1061         assert_eq!(
1062             (CodeCharKind::Normal, 11, "    test();"),
1063             iter.next().unwrap()
1064         );
1065         assert_eq!(None, iter.next());
1066     }
1067
1068     #[test]
1069     fn comment_code_slices_three() {
1070         let input = "1 // comment\n    // comment2\n\n";
1071         let mut iter = CommentCodeSlices::new(input);
1072
1073         assert_eq!((CodeCharKind::Normal, 0, "1 "), iter.next().unwrap());
1074         assert_eq!(
1075             (CodeCharKind::Comment, 2, "// comment\n    // comment2\n"),
1076             iter.next().unwrap()
1077         );
1078         assert_eq!((CodeCharKind::Normal, 29, "\n"), iter.next().unwrap());
1079         assert_eq!(None, iter.next());
1080     }
1081
1082     #[test]
1083     #[cfg_attr(rustfmt, rustfmt_skip)]
1084     fn format_comments() {
1085         let mut config: ::config::Config = Default::default();
1086         config.set().wrap_comments(true);
1087         config.set().normalize_comments(true);
1088
1089         let comment = rewrite_comment(" //test",
1090                                       true,
1091                                       Shape::legacy(100, Indent::new(0, 100)),
1092                                       &config).unwrap();
1093         assert_eq!("/* test */", comment);
1094
1095         let comment = rewrite_comment("// comment on a",
1096                                       false,
1097                                       Shape::legacy(10, Indent::empty()),
1098                                       &config).unwrap();
1099         assert_eq!("// comment\n// on a", comment);
1100
1101         let comment = rewrite_comment("//  A multi line comment\n             // between args.",
1102                                       false,
1103                                       Shape::legacy(60, Indent::new(0, 12)),
1104                                       &config).unwrap();
1105         assert_eq!("//  A multi line comment\n            // between args.", comment);
1106
1107         let input = "// comment";
1108         let expected =
1109             "/* comment */";
1110         let comment = rewrite_comment(input,
1111                                       true,
1112                                       Shape::legacy(9, Indent::new(0, 69)),
1113                                       &config).unwrap();
1114         assert_eq!(expected, comment);
1115
1116         let comment = rewrite_comment("/*   trimmed    */",
1117                                       true,
1118                                       Shape::legacy(100, Indent::new(0, 100)),
1119                                       &config).unwrap();
1120         assert_eq!("/* trimmed */", comment);
1121     }
1122
1123     // This is probably intended to be a non-test fn, but it is not used. I'm
1124     // keeping it around unless it helps us test stuff.
1125     fn uncommented(text: &str) -> String {
1126         CharClasses::new(text.chars())
1127             .filter_map(|(s, c)| match s {
1128                 FullCodeCharKind::Normal | FullCodeCharKind::InString => Some(c),
1129                 _ => None,
1130             })
1131             .collect()
1132     }
1133
1134     #[test]
1135     fn test_uncommented() {
1136         assert_eq!(&uncommented("abc/*...*/"), "abc");
1137         assert_eq!(
1138             &uncommented("// .... /* \n../* /* *** / */ */a/* // */c\n"),
1139             "..ac\n"
1140         );
1141         assert_eq!(&uncommented("abc \" /* */\" qsdf"), "abc \" /* */\" qsdf");
1142     }
1143
1144     #[test]
1145     fn test_contains_comment() {
1146         assert_eq!(contains_comment("abc"), false);
1147         assert_eq!(contains_comment("abc // qsdf"), true);
1148         assert_eq!(contains_comment("abc /* kqsdf"), true);
1149         assert_eq!(contains_comment("abc \" /* */\" qsdf"), false);
1150     }
1151
1152     #[test]
1153     fn test_find_uncommented() {
1154         fn check(haystack: &str, needle: &str, expected: Option<usize>) {
1155             assert_eq!(expected, haystack.find_uncommented(needle));
1156         }
1157
1158         check("/*/ */test", "test", Some(6));
1159         check("//test\ntest", "test", Some(7));
1160         check("/* comment only */", "whatever", None);
1161         check(
1162             "/* comment */ some text /* more commentary */ result",
1163             "result",
1164             Some(46),
1165         );
1166         check("sup // sup", "p", Some(2));
1167         check("sup", "x", None);
1168         check(r#"π? /**/ π is nice!"#, r#"π is nice"#, Some(9));
1169         check("/*sup yo? \n sup*/ sup", "p", Some(20));
1170         check("hel/*lohello*/lo", "hello", None);
1171         check("acb", "ab", None);
1172         check(",/*A*/ ", ",", Some(0));
1173         check("abc", "abc", Some(0));
1174         check("/* abc */", "abc", None);
1175         check("/**/abc/* */", "abc", Some(4));
1176         check("\"/* abc */\"", "abc", Some(4));
1177         check("\"/* abc", "abc", Some(4));
1178     }
1179 }