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