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