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