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