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