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