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