1 // Formatting and tools for comments.
3 use std::{self, borrow::Cow, iter};
5 use itertools::{multipeek, MultiPeek};
6 use lazy_static::lazy_static;
10 use crate::config::Config;
11 use crate::rewrite::RewriteContext;
12 use crate::shape::{Indent, Shape};
13 use crate::string::{rewrite_string, StringFormat};
15 count_newlines, first_line_width, last_line_width, trim_left_preserve_layout,
16 trimmed_last_line_width, unicode_str_width,
18 use crate::{ErrorKind, FormattingError};
21 /// A regex matching reference doc links.
26 /// /// [example]: this::is::a::link
28 static ref REFERENCE_LINK_URL: Regex = Regex::new(r"^\[.+\]\s?:").unwrap();
31 fn is_custom_comment(comment: &str) -> bool {
32 if !comment.starts_with("//") {
34 } else if let Some(c) = comment.chars().nth(2) {
35 !c.is_alphanumeric() && !c.is_whitespace()
41 #[derive(Copy, Clone, PartialEq, Eq)]
42 pub(crate) enum CommentStyle<'a> {
52 fn custom_opener(s: &str) -> &str {
53 s.lines().next().map_or("", |first_line| {
56 .map_or(first_line, |space_index| &first_line[0..=space_index])
60 impl<'a> CommentStyle<'a> {
61 /// Returns `true` if the commenting style covers a line only.
62 pub(crate) fn is_line_comment(&self) -> bool {
64 CommentStyle::DoubleSlash
65 | CommentStyle::TripleSlash
67 | CommentStyle::Custom(_) => true,
72 /// Returns `true` if the commenting style can span over multiple lines.
73 pub(crate) fn is_block_comment(&self) -> bool {
75 CommentStyle::SingleBullet | CommentStyle::DoubleBullet | CommentStyle::Exclamation => {
82 /// Returns `true` if the commenting style is for documentation.
83 pub(crate) fn is_doc_comment(&self) -> bool {
84 matches!(*self, CommentStyle::TripleSlash | CommentStyle::Doc)
87 pub(crate) fn opener(&self) -> &'a str {
89 CommentStyle::DoubleSlash => "// ",
90 CommentStyle::TripleSlash => "/// ",
91 CommentStyle::Doc => "//! ",
92 CommentStyle::SingleBullet => "/* ",
93 CommentStyle::DoubleBullet => "/** ",
94 CommentStyle::Exclamation => "/*! ",
95 CommentStyle::Custom(opener) => opener,
99 pub(crate) fn closer(&self) -> &'a str {
101 CommentStyle::DoubleSlash
102 | CommentStyle::TripleSlash
103 | CommentStyle::Custom(..)
104 | CommentStyle::Doc => "",
105 CommentStyle::SingleBullet | CommentStyle::DoubleBullet | CommentStyle::Exclamation => {
111 pub(crate) fn line_start(&self) -> &'a str {
113 CommentStyle::DoubleSlash => "// ",
114 CommentStyle::TripleSlash => "/// ",
115 CommentStyle::Doc => "//! ",
116 CommentStyle::SingleBullet | CommentStyle::DoubleBullet | CommentStyle::Exclamation => {
119 CommentStyle::Custom(opener) => opener,
123 pub(crate) fn to_str_tuplet(&self) -> (&'a str, &'a str, &'a str) {
124 (self.opener(), self.closer(), self.line_start())
128 pub(crate) fn comment_style(orig: &str, normalize_comments: bool) -> CommentStyle<'_> {
129 if !normalize_comments {
130 if orig.starts_with("/**") && !orig.starts_with("/**/") {
131 CommentStyle::DoubleBullet
132 } else if orig.starts_with("/*!") {
133 CommentStyle::Exclamation
134 } else if orig.starts_with("/*") {
135 CommentStyle::SingleBullet
136 } else if orig.starts_with("///") && orig.chars().nth(3).map_or(true, |c| c != '/') {
137 CommentStyle::TripleSlash
138 } else if orig.starts_with("//!") {
140 } else if is_custom_comment(orig) {
141 CommentStyle::Custom(custom_opener(orig))
143 CommentStyle::DoubleSlash
145 } else if (orig.starts_with("///") && orig.chars().nth(3).map_or(true, |c| c != '/'))
146 || (orig.starts_with("/**") && !orig.starts_with("/**/"))
148 CommentStyle::TripleSlash
149 } else if orig.starts_with("//!") || orig.starts_with("/*!") {
151 } else if is_custom_comment(orig) {
152 CommentStyle::Custom(custom_opener(orig))
154 CommentStyle::DoubleSlash
158 /// Returns true if the last line of the passed string finishes with a block-comment.
159 pub(crate) fn is_last_comment_block(s: &str) -> bool {
160 s.trim_end().ends_with("*/")
163 /// Combine `prev_str` and `next_str` into a single `String`. `span` may contain
164 /// comments between two strings. If there are such comments, then that will be
165 /// recovered. If `allow_extend` is true and there is no comment between the two
166 /// strings, then they will be put on a single line as long as doing so does not
167 /// exceed max width.
168 pub(crate) fn combine_strs_with_missing_comments(
169 context: &RewriteContext<'_>,
175 ) -> Option<String> {
177 "combine_strs_with_missing_comments `{}` `{}` {:?} {:?}",
185 String::with_capacity(prev_str.len() + next_str.len() + shape.indent.width() + 128);
186 result.push_str(prev_str);
187 let mut allow_one_line = !prev_str.contains('\n') && !next_str.contains('\n');
189 if prev_str.is_empty() || next_str.is_empty() || trimmed_last_line_width(prev_str) == 0 {
194 let mut one_line_width =
195 last_line_width(prev_str) + first_line_width(next_str) + first_sep.len();
197 let config = context.config;
198 let indent = shape.indent;
199 let missing_comment = rewrite_missing_comment(span, shape, context)?;
201 if missing_comment.is_empty() {
202 if allow_extend && one_line_width <= shape.width {
203 result.push_str(first_sep);
204 } else if !prev_str.is_empty() {
205 result.push_str(&indent.to_string_with_newline(config))
207 result.push_str(next_str);
211 // We have a missing comment between the first expression and the second expression.
213 // Peek the the original source code and find out whether there is a newline between the first
214 // expression and the second expression or the missing comment. We will preserve the original
215 // layout whenever possible.
216 let original_snippet = context.snippet(span);
217 let prefer_same_line = if let Some(pos) = original_snippet.find('/') {
218 !original_snippet[..pos].contains('\n')
220 !original_snippet.contains('\n')
223 one_line_width -= first_sep.len();
224 let first_sep = if prev_str.is_empty() || missing_comment.is_empty() {
227 let one_line_width = last_line_width(prev_str) + first_line_width(&missing_comment) + 1;
228 if prefer_same_line && one_line_width <= shape.width {
231 indent.to_string_with_newline(config)
234 result.push_str(&first_sep);
235 result.push_str(&missing_comment);
237 let second_sep = if missing_comment.is_empty() || next_str.is_empty() {
239 } else if missing_comment.starts_with("//") {
240 indent.to_string_with_newline(config)
242 one_line_width += missing_comment.len() + first_sep.len() + 1;
243 allow_one_line &= !missing_comment.starts_with("//") && !missing_comment.contains('\n');
244 if prefer_same_line && allow_one_line && one_line_width <= shape.width {
247 indent.to_string_with_newline(config)
250 result.push_str(&second_sep);
251 result.push_str(next_str);
256 pub(crate) fn rewrite_doc_comment(orig: &str, shape: Shape, config: &Config) -> Option<String> {
257 identify_comment(orig, false, shape, config, true)
260 pub(crate) fn rewrite_comment(
265 ) -> Option<String> {
266 identify_comment(orig, block_style, shape, config, false)
274 is_doc_comment: bool,
275 ) -> Option<String> {
276 let style = comment_style(orig, false);
278 // Computes the byte length of line taking into account a newline if the line is part of a
280 fn compute_len(orig: &str, line: &str) -> usize {
281 if orig.len() > line.len() {
282 if orig.as_bytes()[line.len()] == b'\r' {
292 // Get the first group of line comments having the same commenting style.
294 // Returns a tuple with:
295 // - a boolean indicating if there is a blank line
296 // - a number indicating the size of the first group of comments
297 fn consume_same_line_comments(
298 style: CommentStyle<'_>,
302 let mut first_group_ending = 0;
305 for line in orig.lines() {
306 let trimmed_line = line.trim_start();
307 if trimmed_line.is_empty() {
310 } else if trimmed_line.starts_with(line_start)
311 || comment_style(trimmed_line, false) == style
313 first_group_ending += compute_len(&orig[first_group_ending..], line);
318 (hbl, first_group_ending)
321 let (has_bare_lines, first_group_ending) = match style {
322 CommentStyle::DoubleSlash | CommentStyle::TripleSlash | CommentStyle::Doc => {
323 let line_start = style.line_start().trim_start();
324 consume_same_line_comments(style, orig, line_start)
326 CommentStyle::Custom(opener) => {
327 let trimmed_opener = opener.trim_end();
328 consume_same_line_comments(style, orig, trimmed_opener)
330 // for a block comment, search for the closing symbol
331 CommentStyle::DoubleBullet | CommentStyle::SingleBullet | CommentStyle::Exclamation => {
332 let closer = style.closer().trim_start();
333 let mut count = orig.matches(closer).count();
334 let mut closing_symbol_offset = 0;
336 let mut first = true;
337 for line in orig.lines() {
338 closing_symbol_offset += compute_len(&orig[closing_symbol_offset..], line);
339 let mut trimmed_line = line.trim_start();
340 if !trimmed_line.starts_with('*')
341 && !trimmed_line.starts_with("//")
342 && !trimmed_line.starts_with("/*")
347 // Remove opener from consideration when searching for closer
349 let opener = style.opener().trim_end();
350 trimmed_line = &trimmed_line[opener.len()..];
353 if trimmed_line.ends_with(closer) {
360 (hbl, closing_symbol_offset)
364 let (first_group, rest) = orig.split_at(first_group_ending);
365 let rewritten_first_group =
366 if !config.normalize_comments() && has_bare_lines && style.is_block_comment() {
367 trim_left_preserve_layout(first_group, shape.indent, config)?
368 } else if !config.normalize_comments()
369 && !config.wrap_comments()
370 && !config.format_code_in_doc_comments()
372 light_rewrite_comment(first_group, shape.indent, config, is_doc_comment)
374 rewrite_comment_inner(
380 is_doc_comment || style.is_doc_comment(),
384 Some(rewritten_first_group)
396 rewritten_first_group,
397 // insert back the blank line
398 if has_bare_lines && style.is_line_comment() {
403 shape.indent.to_string(config),
410 /// Enum indicating if the code block contains rust based on attributes
411 enum CodeBlockAttribute {
416 impl CodeBlockAttribute {
417 /// Parse comma separated attributes list. Return rust only if all
418 /// attributes are valid rust attributes
419 /// See <https://doc.rust-lang.org/rustdoc/print.html#attributes>
420 fn new(attributes: &str) -> CodeBlockAttribute {
421 for attribute in attributes.split(',') {
422 match attribute.trim() {
423 "" | "rust" | "should_panic" | "no_run" | "edition2015" | "edition2018"
424 | "edition2021" => (),
425 "ignore" | "compile_fail" | "text" => return CodeBlockAttribute::NotRust,
426 _ => return CodeBlockAttribute::NotRust,
429 CodeBlockAttribute::Rust
433 /// Block that is formatted as an item.
435 /// An item starts with either a star `*` a dash `-` or a greater-than `>`.
436 /// Different level of indentation are handled by shrinking the shape accordingly.
437 struct ItemizedBlock {
438 /// the lines that are identified as part of an itemized block
440 /// the number of characters (typically whitespaces) up to the item sigil
442 /// the string that marks the start of an item
444 /// sequence of characters (typically whitespaces) to prefix new lines that are part of the item
449 /// Returns `true` if the line is formatted as an item
450 fn is_itemized_line(line: &str) -> bool {
451 let trimmed = line.trim_start();
452 trimmed.starts_with("* ") || trimmed.starts_with("- ") || trimmed.starts_with("> ")
455 /// Creates a new ItemizedBlock described with the given line.
456 /// The `is_itemized_line` needs to be called first.
457 fn new(line: &str) -> ItemizedBlock {
458 let space_to_sigil = line.chars().take_while(|c| c.is_whitespace()).count();
459 // +2 = '* ', which will add the appropriate amount of whitespace to keep itemized
460 // content formatted correctly.
461 let mut indent = space_to_sigil + 2;
462 let mut line_start = " ".repeat(indent);
464 // Markdown blockquote start with a "> "
465 if line.trim_start().starts_with(">") {
466 // remove the original +2 indent because there might be multiple nested block quotes
467 // and it's easier to reason about the final indent by just taking the length
468 // of th new line_start. We update the indent because it effects the max width
469 // of each formatted line.
470 line_start = itemized_block_quote_start(line, line_start, 2);
471 indent = line_start.len();
474 lines: vec![line[indent..].to_string()],
476 opener: line[..indent].to_string(),
481 /// Returns a `StringFormat` used for formatting the content of an item.
482 fn create_string_format<'a>(&'a self, fmt: &'a StringFormat<'_>) -> StringFormat<'a> {
488 shape: Shape::legacy(fmt.shape.width.saturating_sub(self.indent), Indent::empty()),
494 /// Returns `true` if the line is part of the current itemized block.
495 /// If it is, then it is added to the internal lines list.
496 fn add_line(&mut self, line: &str) -> bool {
497 if !ItemizedBlock::is_itemized_line(line)
498 && self.indent <= line.chars().take_while(|c| c.is_whitespace()).count()
500 self.lines.push(line.to_string());
506 /// Returns the block as a string, with each line trimmed at the start.
507 fn trimmed_block_as_string(&self) -> String {
510 .map(|line| format!("{} ", line.trim_start()))
514 /// Returns the block as a string under its original form.
515 fn original_block_as_string(&self) -> String {
516 self.lines.join("\n")
520 /// Determine the line_start when formatting markdown block quotes.
521 /// The original line_start likely contains indentation (whitespaces), which we'd like to
522 /// replace with '> ' characters.
523 fn itemized_block_quote_start(line: &str, mut line_start: String, remove_indent: usize) -> String {
524 let quote_level = line
526 .take_while(|c| !c.is_alphanumeric())
527 .fold(0, |acc, c| if c == '>' { acc + 1 } else { acc });
529 for _ in 0..remove_indent {
533 for _ in 0..quote_level {
534 line_start.push_str("> ")
539 struct CommentRewrite<'a> {
541 code_block_buffer: String,
542 is_prev_line_multi_line: bool,
543 code_block_attr: Option<CodeBlockAttribute>,
544 item_block: Option<ItemizedBlock>,
545 comment_line_separator: String,
549 fmt: StringFormat<'a>,
554 style: CommentStyle<'a>,
557 impl<'a> CommentRewrite<'a> {
563 ) -> CommentRewrite<'a> {
564 let ((opener, closer, line_start), style) = if block_style {
566 CommentStyle::SingleBullet.to_str_tuplet(),
567 CommentStyle::SingleBullet,
570 let style = comment_style(orig, config.normalize_comments());
571 (style.to_str_tuplet(), style)
574 let max_width = shape
576 .checked_sub(closer.len() + opener.len())
578 let indent_str = shape.indent.to_string_with_newline(config).to_string();
580 let mut cr = CommentRewrite {
581 result: String::with_capacity(orig.len() * 2),
582 code_block_buffer: String::with_capacity(128),
583 is_prev_line_multi_line: false,
584 code_block_attr: None,
586 comment_line_separator: format!("{}{}", indent_str, line_start),
589 fmt_indent: shape.indent,
596 shape: Shape::legacy(max_width, shape.indent),
601 opener: opener.to_owned(),
602 closer: closer.to_owned(),
603 line_start: line_start.to_owned(),
606 cr.result.push_str(opener);
610 fn join_block(s: &str, sep: &str) -> String {
611 let mut result = String::with_capacity(s.len() + 128);
612 let mut iter = s.lines().peekable();
613 while let Some(line) = iter.next() {
614 result.push_str(line);
615 result.push_str(match iter.peek() {
616 Some(next_line) if next_line.is_empty() => sep.trim_end(),
624 /// Check if any characters were written to the result buffer after the start of the comment.
625 /// when calling [`CommentRewrite::new()`] the result buffer is initiazlied with the opening
626 /// characters for the comment.
627 fn buffer_contains_comment(&self) -> bool {
628 // if self.result.len() < self.opener.len() then an empty comment is in the buffer
629 // if self.result.len() > self.opener.len() then a non empty comment is in the buffer
630 self.result.len() != self.opener.len()
633 fn finish(mut self) -> String {
634 if !self.code_block_buffer.is_empty() {
635 // There is a code block that is not properly enclosed by backticks.
636 // We will leave them untouched.
637 self.result.push_str(&self.comment_line_separator);
638 self.result.push_str(&Self::join_block(
639 &trim_custom_comment_prefix(&self.code_block_buffer),
640 &self.comment_line_separator,
644 if let Some(ref ib) = self.item_block {
645 // the last few lines are part of an itemized block
646 self.fmt.shape = Shape::legacy(self.max_width, self.fmt_indent);
647 let item_fmt = ib.create_string_format(&self.fmt);
649 // only push a comment_line_separator for ItemizedBlocks if the comment is not empty
650 if self.buffer_contains_comment() {
651 self.result.push_str(&self.comment_line_separator);
654 self.result.push_str(&ib.opener);
655 match rewrite_string(
656 &ib.trimmed_block_as_string(),
658 self.max_width.saturating_sub(ib.indent),
660 Some(s) => self.result.push_str(&Self::join_block(
662 &format!("{}{}", self.comment_line_separator, ib.line_start),
664 None => self.result.push_str(&Self::join_block(
665 &ib.original_block_as_string(),
666 &self.comment_line_separator,
671 self.result.push_str(&self.closer);
672 if self.result.ends_with(&self.opener) && self.opener.ends_with(' ') {
685 has_leading_whitespace: bool,
686 is_doc_comment: bool,
688 let num_newlines = count_newlines(orig);
689 let is_last = i == num_newlines;
690 let needs_new_comment_line = if self.style.is_block_comment() {
691 num_newlines > 0 || self.buffer_contains_comment()
693 self.buffer_contains_comment()
696 if let Some(ref mut ib) = self.item_block {
697 if ib.add_line(line) {
700 self.is_prev_line_multi_line = false;
701 self.fmt.shape = Shape::legacy(self.max_width, self.fmt_indent);
702 let item_fmt = ib.create_string_format(&self.fmt);
704 // only push a comment_line_separator if we need to start a new comment line
705 if needs_new_comment_line {
706 self.result.push_str(&self.comment_line_separator);
709 self.result.push_str(&ib.opener);
710 match rewrite_string(
711 &ib.trimmed_block_as_string(),
713 self.max_width.saturating_sub(ib.indent),
715 Some(s) => self.result.push_str(&Self::join_block(
717 &format!("{}{}", self.comment_line_separator, ib.line_start),
719 None => self.result.push_str(&Self::join_block(
720 &ib.original_block_as_string(),
721 &self.comment_line_separator,
724 } else if self.code_block_attr.is_some() {
725 if line.starts_with("```") {
726 let code_block = match self.code_block_attr.as_ref().unwrap() {
727 CodeBlockAttribute::Rust
728 if self.fmt.config.format_code_in_doc_comments()
729 && !self.code_block_buffer.is_empty() =>
731 let mut config = self.fmt.config.clone();
732 config.set().wrap_comments(false);
733 let comment_max_width = config
734 .doc_comment_code_block_width()
735 .min(config.max_width());
736 config.set().max_width(comment_max_width);
738 crate::format_code_block(&self.code_block_buffer, &config, false)
740 trim_custom_comment_prefix(&s.snippet)
742 trim_custom_comment_prefix(&self.code_block_buffer)
745 _ => trim_custom_comment_prefix(&self.code_block_buffer),
747 if !code_block.is_empty() {
748 self.result.push_str(&self.comment_line_separator);
750 .push_str(&Self::join_block(&code_block, &self.comment_line_separator));
752 self.code_block_buffer.clear();
753 self.result.push_str(&self.comment_line_separator);
754 self.result.push_str(line);
755 self.code_block_attr = None;
757 self.code_block_buffer
758 .push_str(&hide_sharp_behind_comment(line));
759 self.code_block_buffer.push('\n');
764 self.code_block_attr = None;
765 self.item_block = None;
766 if let Some(stripped) = line.strip_prefix("```") {
767 self.code_block_attr = Some(CodeBlockAttribute::new(stripped))
768 } else if self.fmt.config.wrap_comments() && ItemizedBlock::is_itemized_line(line) {
769 let ib = ItemizedBlock::new(line);
770 self.item_block = Some(ib);
774 if self.result == self.opener {
775 let force_leading_whitespace = &self.opener == "/* " && count_newlines(orig) == 0;
776 if !has_leading_whitespace && !force_leading_whitespace && self.result.ends_with(' ') {
782 } else if self.is_prev_line_multi_line && !line.is_empty() {
783 self.result.push(' ')
784 } else if is_last && line.is_empty() {
785 // trailing blank lines are unwanted
786 if !self.closer.is_empty() {
787 self.result.push_str(&self.indent_str);
791 self.result.push_str(&self.comment_line_separator);
792 if !has_leading_whitespace && self.result.ends_with(' ') {
797 let is_markdown_header_doc_comment = is_doc_comment && line.starts_with("#");
799 // We only want to wrap the comment if:
800 // 1) wrap_comments = true is configured
801 // 2) The comment is not the start of a markdown header doc comment
802 // 3) The comment width exceeds the shape's width
803 // 4) No URLS were found in the comment
804 let should_wrap_comment = self.fmt.config.wrap_comments()
805 && !is_markdown_header_doc_comment
806 && unicode_str_width(line) > self.fmt.shape.width
809 if should_wrap_comment {
810 match rewrite_string(line, &self.fmt, self.max_width) {
812 self.is_prev_line_multi_line = s.contains('\n');
813 self.result.push_str(s);
815 None if self.is_prev_line_multi_line => {
816 // We failed to put the current `line` next to the previous `line`.
817 // Remove the trailing space, then start rewrite on the next line.
819 self.result.push_str(&self.comment_line_separator);
820 self.fmt.shape = Shape::legacy(self.max_width, self.fmt_indent);
821 match rewrite_string(line, &self.fmt, self.max_width) {
823 self.is_prev_line_multi_line = s.contains('\n');
824 self.result.push_str(s);
827 self.is_prev_line_multi_line = false;
828 self.result.push_str(line);
833 self.is_prev_line_multi_line = false;
834 self.result.push_str(line);
838 self.fmt.shape = if self.is_prev_line_multi_line {
840 let offset = 1 + last_line_width(&self.result) - self.line_start.len();
842 width: self.max_width.saturating_sub(offset),
843 indent: self.fmt_indent,
844 offset: self.fmt.shape.offset + offset,
847 Shape::legacy(self.max_width, self.fmt_indent)
850 if line.is_empty() && self.result.ends_with(' ') && !is_last {
851 // Remove space if this is an empty comment or a doc comment.
854 self.result.push_str(line);
855 self.fmt.shape = Shape::legacy(self.max_width, self.fmt_indent);
856 self.is_prev_line_multi_line = false;
863 fn rewrite_comment_inner(
866 style: CommentStyle<'_>,
869 is_doc_comment: bool,
870 ) -> Option<String> {
871 let mut rewriter = CommentRewrite::new(orig, block_style, shape, config);
873 let line_breaks = count_newlines(orig.trim_end());
877 .map(|(i, mut line)| {
878 line = trim_end_unless_two_whitespaces(line.trim_start(), is_doc_comment);
880 if i == line_breaks && line.ends_with("*/") && !line.starts_with("//") {
881 line = line[..(line.len() - 2)].trim_end();
886 .map(|s| left_trim_comment_line(s, &style))
887 .map(|(line, has_leading_whitespace)| {
888 if orig.starts_with("/*") && line_breaks == 0 {
891 has_leading_whitespace || config.normalize_comments(),
894 (line, has_leading_whitespace || config.normalize_comments())
898 for (i, (line, has_leading_whitespace)) in lines.enumerate() {
899 if rewriter.handle_line(orig, i, line, has_leading_whitespace, is_doc_comment) {
904 Some(rewriter.finish())
907 const RUSTFMT_CUSTOM_COMMENT_PREFIX: &str = "//#### ";
909 fn hide_sharp_behind_comment(s: &str) -> Cow<'_, str> {
910 let s_trimmed = s.trim();
911 if s_trimmed.starts_with("# ") || s_trimmed == "#" {
912 Cow::from(format!("{}{}", RUSTFMT_CUSTOM_COMMENT_PREFIX, s))
918 fn trim_custom_comment_prefix(s: &str) -> String {
921 let left_trimmed = line.trim_start();
922 if left_trimmed.starts_with(RUSTFMT_CUSTOM_COMMENT_PREFIX) {
923 left_trimmed.trim_start_matches(RUSTFMT_CUSTOM_COMMENT_PREFIX)
932 /// Returns `true` if the given string MAY include URLs or alike.
933 fn has_url(s: &str) -> bool {
934 // This function may return false positive, but should get its job done in most cases.
935 s.contains("https://")
936 || s.contains("http://")
937 || s.contains("ftp://")
938 || s.contains("file://")
939 || REFERENCE_LINK_URL.is_match(s)
942 /// Given the span, rewrite the missing comment inside it if available.
943 /// Note that the given span must only include comments (or leading/trailing whitespaces).
944 pub(crate) fn rewrite_missing_comment(
947 context: &RewriteContext<'_>,
948 ) -> Option<String> {
949 let missing_snippet = context.snippet(span);
950 let trimmed_snippet = missing_snippet.trim();
951 // check the span starts with a comment
952 let pos = trimmed_snippet.find('/');
953 if !trimmed_snippet.is_empty() && pos.is_some() {
954 rewrite_comment(trimmed_snippet, false, shape, context.config)
960 /// Recover the missing comments in the specified span, if available.
961 /// The layout of the comments will be preserved as long as it does not break the code
962 /// and its total width does not exceed the max width.
963 pub(crate) fn recover_missing_comment_in_span(
966 context: &RewriteContext<'_>,
968 ) -> Option<String> {
969 let missing_comment = rewrite_missing_comment(span, shape, context)?;
970 if missing_comment.is_empty() {
973 let missing_snippet = context.snippet(span);
974 let pos = missing_snippet.find('/')?;
976 let total_width = missing_comment.len() + used_width + 1;
977 let force_new_line_before_comment =
978 missing_snippet[..pos].contains('\n') || total_width > context.config.max_width();
979 let sep = if force_new_line_before_comment {
980 shape.indent.to_string_with_newline(context.config)
984 Some(format!("{}{}", sep, missing_comment))
988 /// Trim trailing whitespaces unless they consist of two or more whitespaces.
989 fn trim_end_unless_two_whitespaces(s: &str, is_doc_comment: bool) -> &str {
990 if is_doc_comment && s.ends_with(" ") {
997 /// Trims whitespace and aligns to indent, but otherwise does not change comments.
998 fn light_rewrite_comment(
1002 is_doc_comment: bool,
1004 let lines: Vec<&str> = orig
1007 // This is basically just l.trim(), but in the case that a line starts
1008 // with `*` we want to leave one space before it, so it aligns with the
1010 let first_non_whitespace = l.find(|c| !char::is_whitespace(c));
1011 let left_trimmed = if let Some(fnw) = first_non_whitespace {
1012 if l.as_bytes()[fnw] == b'*' && fnw > 0 {
1020 // Preserve markdown's double-space line break syntax in doc comment.
1021 trim_end_unless_two_whitespaces(left_trimmed, is_doc_comment)
1024 lines.join(&format!("\n{}", offset.to_string(config)))
1027 /// Trims comment characters and possibly a single space from the left of a string.
1028 /// Does not trim all whitespace. If a single space is trimmed from the left of the string,
1029 /// this function returns true.
1030 fn left_trim_comment_line<'a>(line: &'a str, style: &CommentStyle<'_>) -> (&'a str, bool) {
1031 if line.starts_with("//! ")
1032 || line.starts_with("/// ")
1033 || line.starts_with("/*! ")
1034 || line.starts_with("/** ")
1037 } else if let CommentStyle::Custom(opener) = *style {
1038 if let Some(stripped) = line.strip_prefix(opener) {
1041 (&line[opener.trim_end().len()..], false)
1043 } else if line.starts_with("/* ")
1044 || line.starts_with("// ")
1045 || line.starts_with("//!")
1046 || line.starts_with("///")
1047 || line.starts_with("** ")
1048 || line.starts_with("/*!")
1049 || (line.starts_with("/**") && !line.starts_with("/**/"))
1051 (&line[3..], line.chars().nth(2).unwrap() == ' ')
1052 } else if line.starts_with("/*")
1053 || line.starts_with("* ")
1054 || line.starts_with("//")
1055 || line.starts_with("**")
1057 (&line[2..], line.chars().nth(1).unwrap() == ' ')
1058 } else if let Some(stripped) = line.strip_prefix('*') {
1061 (line, line.starts_with(' '))
1065 pub(crate) trait FindUncommented {
1066 fn find_uncommented(&self, pat: &str) -> Option<usize>;
1067 fn find_last_uncommented(&self, pat: &str) -> Option<usize>;
1070 impl FindUncommented for str {
1071 fn find_uncommented(&self, pat: &str) -> Option<usize> {
1072 let mut needle_iter = pat.chars();
1073 for (kind, (i, b)) in CharClasses::new(self.char_indices()) {
1074 match needle_iter.next() {
1076 return Some(i - pat.len());
1078 Some(c) => match kind {
1079 FullCodeCharKind::Normal | FullCodeCharKind::InString if b == c => {}
1081 needle_iter = pat.chars();
1087 // Handle case where the pattern is a suffix of the search string
1088 match needle_iter.next() {
1090 None => Some(self.len() - pat.len()),
1094 fn find_last_uncommented(&self, pat: &str) -> Option<usize> {
1095 if let Some(left) = self.find_uncommented(pat) {
1096 let mut result = left;
1097 // add 1 to use find_last_uncommented for &str after pat
1098 while let Some(next) = self[(result + 1)..].find_last_uncommented(pat) {
1108 // Returns the first byte position after the first comment. The given string
1109 // is expected to be prefixed by a comment, including delimiters.
1110 // Good: `/* /* inner */ outer */ code();`
1111 // Bad: `code(); // hello\n world!`
1112 pub(crate) fn find_comment_end(s: &str) -> Option<usize> {
1113 let mut iter = CharClasses::new(s.char_indices());
1114 for (kind, (i, _c)) in &mut iter {
1115 if kind == FullCodeCharKind::Normal || kind == FullCodeCharKind::InString {
1120 // Handle case where the comment ends at the end of `s`.
1121 if iter.status == CharClassesStatus::Normal {
1128 /// Returns `true` if text contains any comment.
1129 pub(crate) fn contains_comment(text: &str) -> bool {
1130 CharClasses::new(text.chars()).any(|(kind, _)| kind.is_comment())
1133 pub(crate) struct CharClasses<T>
1139 status: CharClassesStatus,
1142 pub(crate) trait RichChar {
1143 fn get_char(&self) -> char;
1146 impl RichChar for char {
1147 fn get_char(&self) -> char {
1152 impl RichChar for (usize, char) {
1153 fn get_char(&self) -> char {
1158 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
1159 enum CharClassesStatus {
1161 /// Character is within a string
1164 /// Character is within a raw string
1166 RawStringPrefix(u32),
1167 RawStringSuffix(u32),
1170 /// Character inside a block comment, with the integer indicating the nesting deepness of the
1173 /// Character inside a block-commented string, with the integer indicating the nesting deepness
1175 StringInBlockComment(u32),
1176 /// Status when the '/' has been consumed, but not yet the '*', deepness is
1177 /// the new deepness (after the comment opening).
1178 BlockCommentOpening(u32),
1179 /// Status when the '*' has been consumed, but not yet the '/', deepness is
1180 /// the new deepness (after the comment closing).
1181 BlockCommentClosing(u32),
1182 /// Character is within a line comment
1186 /// Distinguish between functional part of code and comments
1187 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
1188 pub(crate) enum CodeCharKind {
1193 /// Distinguish between functional part of code and comments,
1194 /// describing opening and closing of comments for ease when chunking
1195 /// code from tagged characters
1196 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
1197 pub(crate) enum FullCodeCharKind {
1199 /// The first character of a comment, there is only one for a comment (always '/')
1201 /// Any character inside a comment including the second character of comment
1202 /// marks ("//", "/*")
1204 /// Last character of a comment, '\n' for a line comment, '/' for a block comment.
1206 /// Start of a mutlitine string inside a comment
1207 StartStringCommented,
1208 /// End of a mutlitine string inside a comment
1210 /// Inside a commented string
1212 /// Start of a mutlitine string
1214 /// End of a mutlitine string
1216 /// Inside a string.
1220 impl FullCodeCharKind {
1221 pub(crate) fn is_comment(self) -> bool {
1223 FullCodeCharKind::StartComment
1224 | FullCodeCharKind::InComment
1225 | FullCodeCharKind::EndComment
1226 | FullCodeCharKind::StartStringCommented
1227 | FullCodeCharKind::InStringCommented
1228 | FullCodeCharKind::EndStringCommented => true,
1233 /// Returns true if the character is inside a comment
1234 pub(crate) fn inside_comment(self) -> bool {
1236 FullCodeCharKind::InComment
1237 | FullCodeCharKind::StartStringCommented
1238 | FullCodeCharKind::InStringCommented
1239 | FullCodeCharKind::EndStringCommented => true,
1244 pub(crate) fn is_string(self) -> bool {
1245 self == FullCodeCharKind::InString || self == FullCodeCharKind::StartString
1248 /// Returns true if the character is within a commented string
1249 pub(crate) fn is_commented_string(self) -> bool {
1250 self == FullCodeCharKind::InStringCommented
1251 || self == FullCodeCharKind::StartStringCommented
1254 fn to_codecharkind(self) -> CodeCharKind {
1255 if self.is_comment() {
1256 CodeCharKind::Comment
1258 CodeCharKind::Normal
1263 impl<T> CharClasses<T>
1268 pub(crate) fn new(base: T) -> CharClasses<T> {
1270 base: multipeek(base),
1271 status: CharClassesStatus::Normal,
1276 fn is_raw_string_suffix<T>(iter: &mut MultiPeek<T>, count: u32) -> bool
1283 Some(c) if c.get_char() == '#' => continue,
1290 impl<T> Iterator for CharClasses<T>
1295 type Item = (FullCodeCharKind, T::Item);
1297 fn next(&mut self) -> Option<(FullCodeCharKind, T::Item)> {
1298 let item = self.base.next()?;
1299 let chr = item.get_char();
1300 let mut char_kind = FullCodeCharKind::Normal;
1301 self.status = match self.status {
1302 CharClassesStatus::LitRawString(sharps) => {
1303 char_kind = FullCodeCharKind::InString;
1307 char_kind = FullCodeCharKind::Normal;
1308 CharClassesStatus::Normal
1309 } else if is_raw_string_suffix(&mut self.base, sharps) {
1310 CharClassesStatus::RawStringSuffix(sharps)
1312 CharClassesStatus::LitRawString(sharps)
1315 _ => CharClassesStatus::LitRawString(sharps),
1318 CharClassesStatus::RawStringPrefix(sharps) => {
1319 char_kind = FullCodeCharKind::InString;
1321 '#' => CharClassesStatus::RawStringPrefix(sharps + 1),
1322 '"' => CharClassesStatus::LitRawString(sharps),
1323 _ => CharClassesStatus::Normal, // Unreachable.
1326 CharClassesStatus::RawStringSuffix(sharps) => {
1330 CharClassesStatus::Normal
1332 char_kind = FullCodeCharKind::InString;
1333 CharClassesStatus::RawStringSuffix(sharps - 1)
1336 _ => CharClassesStatus::Normal, // Unreachable
1339 CharClassesStatus::LitString => {
1340 char_kind = FullCodeCharKind::InString;
1342 '"' => CharClassesStatus::Normal,
1343 '\\' => CharClassesStatus::LitStringEscape,
1344 _ => CharClassesStatus::LitString,
1347 CharClassesStatus::LitStringEscape => {
1348 char_kind = FullCodeCharKind::InString;
1349 CharClassesStatus::LitString
1351 CharClassesStatus::LitChar => match chr {
1352 '\\' => CharClassesStatus::LitCharEscape,
1353 '\'' => CharClassesStatus::Normal,
1354 _ => CharClassesStatus::LitChar,
1356 CharClassesStatus::LitCharEscape => CharClassesStatus::LitChar,
1357 CharClassesStatus::Normal => match chr {
1358 'r' => match self.base.peek().map(RichChar::get_char) {
1359 Some('#') | Some('"') => {
1360 char_kind = FullCodeCharKind::InString;
1361 CharClassesStatus::RawStringPrefix(0)
1363 _ => CharClassesStatus::Normal,
1366 char_kind = FullCodeCharKind::InString;
1367 CharClassesStatus::LitString
1370 // HACK: Work around mut borrow.
1371 match self.base.peek() {
1372 Some(next) if next.get_char() == '\\' => {
1373 self.status = CharClassesStatus::LitChar;
1374 return Some((char_kind, item));
1379 match self.base.peek() {
1380 Some(next) if next.get_char() == '\'' => CharClassesStatus::LitChar,
1381 _ => CharClassesStatus::Normal,
1384 '/' => match self.base.peek() {
1385 Some(next) if next.get_char() == '*' => {
1386 self.status = CharClassesStatus::BlockCommentOpening(1);
1387 return Some((FullCodeCharKind::StartComment, item));
1389 Some(next) if next.get_char() == '/' => {
1390 self.status = CharClassesStatus::LineComment;
1391 return Some((FullCodeCharKind::StartComment, item));
1393 _ => CharClassesStatus::Normal,
1395 _ => CharClassesStatus::Normal,
1397 CharClassesStatus::StringInBlockComment(deepness) => {
1398 char_kind = FullCodeCharKind::InStringCommented;
1400 CharClassesStatus::BlockComment(deepness)
1401 } else if chr == '*' && self.base.peek().map(RichChar::get_char) == Some('/') {
1402 char_kind = FullCodeCharKind::InComment;
1403 CharClassesStatus::BlockCommentClosing(deepness - 1)
1405 CharClassesStatus::StringInBlockComment(deepness)
1408 CharClassesStatus::BlockComment(deepness) => {
1409 assert_ne!(deepness, 0);
1410 char_kind = FullCodeCharKind::InComment;
1411 match self.base.peek() {
1412 Some(next) if next.get_char() == '/' && chr == '*' => {
1413 CharClassesStatus::BlockCommentClosing(deepness - 1)
1415 Some(next) if next.get_char() == '*' && chr == '/' => {
1416 CharClassesStatus::BlockCommentOpening(deepness + 1)
1418 _ if chr == '"' => CharClassesStatus::StringInBlockComment(deepness),
1422 CharClassesStatus::BlockCommentOpening(deepness) => {
1423 assert_eq!(chr, '*');
1424 self.status = CharClassesStatus::BlockComment(deepness);
1425 return Some((FullCodeCharKind::InComment, item));
1427 CharClassesStatus::BlockCommentClosing(deepness) => {
1428 assert_eq!(chr, '/');
1430 self.status = CharClassesStatus::Normal;
1431 return Some((FullCodeCharKind::EndComment, item));
1433 self.status = CharClassesStatus::BlockComment(deepness);
1434 return Some((FullCodeCharKind::InComment, item));
1437 CharClassesStatus::LineComment => match chr {
1439 self.status = CharClassesStatus::Normal;
1440 return Some((FullCodeCharKind::EndComment, item));
1443 self.status = CharClassesStatus::LineComment;
1444 return Some((FullCodeCharKind::InComment, item));
1448 Some((char_kind, item))
1452 /// An iterator over the lines of a string, paired with the char kind at the
1453 /// end of the line.
1454 pub(crate) struct LineClasses<'a> {
1455 base: iter::Peekable<CharClasses<std::str::Chars<'a>>>,
1456 kind: FullCodeCharKind,
1459 impl<'a> LineClasses<'a> {
1460 pub(crate) fn new(s: &'a str) -> Self {
1462 base: CharClasses::new(s.chars()).peekable(),
1463 kind: FullCodeCharKind::Normal,
1468 impl<'a> Iterator for LineClasses<'a> {
1469 type Item = (FullCodeCharKind, String);
1471 fn next(&mut self) -> Option<Self::Item> {
1474 let mut line = String::new();
1476 let start_kind = match self.base.peek() {
1477 Some((kind, _)) => *kind,
1478 None => unreachable!(),
1481 for (kind, c) in self.base.by_ref() {
1482 // needed to set the kind of the ending character on the last line
1485 self.kind = match (start_kind, kind) {
1486 (FullCodeCharKind::Normal, FullCodeCharKind::InString) => {
1487 FullCodeCharKind::StartString
1489 (FullCodeCharKind::InString, FullCodeCharKind::Normal) => {
1490 FullCodeCharKind::EndString
1492 (FullCodeCharKind::InComment, FullCodeCharKind::InStringCommented) => {
1493 FullCodeCharKind::StartStringCommented
1495 (FullCodeCharKind::InStringCommented, FullCodeCharKind::InComment) => {
1496 FullCodeCharKind::EndStringCommented
1505 // Workaround for CRLF newline.
1506 if line.ends_with('\r') {
1510 Some((self.kind, line))
1514 /// Iterator over functional and commented parts of a string. Any part of a string is either
1515 /// functional code, either *one* block comment, either *one* line comment. Whitespace between
1516 /// comments is functional code. Line comments contain their ending newlines.
1517 struct UngroupedCommentCodeSlices<'a> {
1519 iter: iter::Peekable<CharClasses<std::str::CharIndices<'a>>>,
1522 impl<'a> UngroupedCommentCodeSlices<'a> {
1523 fn new(code: &'a str) -> UngroupedCommentCodeSlices<'a> {
1524 UngroupedCommentCodeSlices {
1526 iter: CharClasses::new(code.char_indices()).peekable(),
1531 impl<'a> Iterator for UngroupedCommentCodeSlices<'a> {
1532 type Item = (CodeCharKind, usize, &'a str);
1534 fn next(&mut self) -> Option<Self::Item> {
1535 let (kind, (start_idx, _)) = self.iter.next()?;
1537 FullCodeCharKind::Normal | FullCodeCharKind::InString => {
1538 // Consume all the Normal code
1539 while let Some(&(char_kind, _)) = self.iter.peek() {
1540 if char_kind.is_comment() {
1543 let _ = self.iter.next();
1546 FullCodeCharKind::StartComment => {
1547 // Consume the whole comment
1549 match self.iter.next() {
1550 Some((kind, ..)) if kind.inside_comment() => continue,
1557 let slice = match self.iter.peek() {
1558 Some(&(_, (end_idx, _))) => &self.slice[start_idx..end_idx],
1559 None => &self.slice[start_idx..],
1562 if kind.is_comment() {
1563 CodeCharKind::Comment
1565 CodeCharKind::Normal
1573 /// Iterator over an alternating sequence of functional and commented parts of
1574 /// a string. The first item is always a, possibly zero length, subslice of
1575 /// functional text. Line style comments contain their ending newlines.
1576 pub(crate) struct CommentCodeSlices<'a> {
1578 last_slice_kind: CodeCharKind,
1579 last_slice_end: usize,
1582 impl<'a> CommentCodeSlices<'a> {
1583 pub(crate) fn new(slice: &'a str) -> CommentCodeSlices<'a> {
1586 last_slice_kind: CodeCharKind::Comment,
1592 impl<'a> Iterator for CommentCodeSlices<'a> {
1593 type Item = (CodeCharKind, usize, &'a str);
1595 fn next(&mut self) -> Option<Self::Item> {
1596 if self.last_slice_end == self.slice.len() {
1600 let mut sub_slice_end = self.last_slice_end;
1601 let mut first_whitespace = None;
1602 let subslice = &self.slice[self.last_slice_end..];
1603 let mut iter = CharClasses::new(subslice.char_indices());
1605 for (kind, (i, c)) in &mut iter {
1606 let is_comment_connector = self.last_slice_kind == CodeCharKind::Normal
1607 && &subslice[..2] == "//"
1608 && [' ', '\t'].contains(&c);
1610 if is_comment_connector && first_whitespace.is_none() {
1611 first_whitespace = Some(i);
1614 if kind.to_codecharkind() == self.last_slice_kind && !is_comment_connector {
1615 let last_index = match first_whitespace {
1619 sub_slice_end = self.last_slice_end + last_index;
1623 if !is_comment_connector {
1624 first_whitespace = None;
1628 if let (None, true) = (iter.next(), sub_slice_end == self.last_slice_end) {
1629 // This was the last subslice.
1630 sub_slice_end = match first_whitespace {
1631 Some(i) => self.last_slice_end + i,
1632 None => self.slice.len(),
1636 let kind = match self.last_slice_kind {
1637 CodeCharKind::Comment => CodeCharKind::Normal,
1638 CodeCharKind::Normal => CodeCharKind::Comment,
1642 self.last_slice_end,
1643 &self.slice[self.last_slice_end..sub_slice_end],
1645 self.last_slice_end = sub_slice_end;
1646 self.last_slice_kind = kind;
1652 /// Checks is `new` didn't miss any comment from `span`, if it removed any, return previous text
1653 /// (if it fits in the width/offset, else return `None`), else return `new`
1654 pub(crate) fn recover_comment_removed(
1657 context: &RewriteContext<'_>,
1658 ) -> Option<String> {
1659 let snippet = context.snippet(span);
1660 if snippet != new && changed_comment_content(snippet, &new) {
1661 // We missed some comments. Warn and keep the original text.
1662 if context.config.error_on_unformatted() {
1663 context.report.append(
1664 context.parse_sess.span_to_filename(span),
1665 vec![FormattingError::from_span(
1668 ErrorKind::LostComment,
1672 Some(snippet.to_owned())
1678 pub(crate) fn filter_normal_code(code: &str) -> String {
1679 let mut buffer = String::with_capacity(code.len());
1680 LineClasses::new(code).for_each(|(kind, line)| match kind {
1681 FullCodeCharKind::Normal
1682 | FullCodeCharKind::StartString
1683 | FullCodeCharKind::InString
1684 | FullCodeCharKind::EndString => {
1685 buffer.push_str(&line);
1690 if !code.ends_with('\n') && buffer.ends_with('\n') {
1696 /// Returns `true` if the two strings of code have the same payload of comments.
1697 /// The payload of comments is everything in the string except:
1698 /// - actual code (not comments),
1699 /// - comment start/end marks,
1701 /// - '*' at the beginning of lines in block comments.
1702 fn changed_comment_content(orig: &str, new: &str) -> bool {
1703 // Cannot write this as a fn since we cannot return types containing closures.
1704 let code_comment_content = |code| {
1705 let slices = UngroupedCommentCodeSlices::new(code);
1707 .filter(|&(ref kind, _, _)| *kind == CodeCharKind::Comment)
1708 .flat_map(|(_, _, s)| CommentReducer::new(s))
1710 let res = code_comment_content(orig).ne(code_comment_content(new));
1712 "comment::changed_comment_content: {}\norig: '{}'\nnew: '{}'\nraw_old: {}\nraw_new: {}",
1716 code_comment_content(orig).collect::<String>(),
1717 code_comment_content(new).collect::<String>()
1722 /// Iterator over the 'payload' characters of a comment.
1723 /// It skips whitespace, comment start/end marks, and '*' at the beginning of lines.
1724 /// The comment must be one comment, ie not more than one start mark (no multiple line comments,
1726 struct CommentReducer<'a> {
1728 at_start_line: bool,
1729 iter: std::str::Chars<'a>,
1732 impl<'a> CommentReducer<'a> {
1733 fn new(comment: &'a str) -> CommentReducer<'a> {
1734 let is_block = comment.starts_with("/*");
1735 let comment = remove_comment_header(comment);
1738 // There are no supplementary '*' on the first line.
1739 at_start_line: false,
1740 iter: comment.chars(),
1745 impl<'a> Iterator for CommentReducer<'a> {
1748 fn next(&mut self) -> Option<Self::Item> {
1750 let mut c = self.iter.next()?;
1751 if self.is_block && self.at_start_line {
1752 while c.is_whitespace() {
1753 c = self.iter.next()?;
1755 // Ignore leading '*'.
1757 c = self.iter.next()?;
1759 } else if c == '\n' {
1760 self.at_start_line = true;
1762 if !c.is_whitespace() {
1769 fn remove_comment_header(comment: &str) -> &str {
1770 if comment.starts_with("///") || comment.starts_with("//!") {
1772 } else if let Some(stripped) = comment.strip_prefix("//") {
1774 } else if (comment.starts_with("/**") && !comment.starts_with("/**/"))
1775 || comment.starts_with("/*!")
1777 &comment[3..comment.len() - 2]
1780 comment.starts_with("/*"),
1781 "string '{}' is not a comment",
1784 &comment[2..comment.len() - 2]
1791 use crate::shape::{Indent, Shape};
1795 let mut iter = CharClasses::new("//\n\n".chars());
1797 assert_eq!((FullCodeCharKind::StartComment, '/'), iter.next().unwrap());
1798 assert_eq!((FullCodeCharKind::InComment, '/'), iter.next().unwrap());
1799 assert_eq!((FullCodeCharKind::EndComment, '\n'), iter.next().unwrap());
1800 assert_eq!((FullCodeCharKind::Normal, '\n'), iter.next().unwrap());
1801 assert_eq!(None, iter.next());
1805 fn comment_code_slices() {
1806 let input = "code(); /* test */ 1 + 1";
1807 let mut iter = CommentCodeSlices::new(input);
1809 assert_eq!((CodeCharKind::Normal, 0, "code(); "), iter.next().unwrap());
1811 (CodeCharKind::Comment, 8, "/* test */"),
1812 iter.next().unwrap()
1814 assert_eq!((CodeCharKind::Normal, 18, " 1 + 1"), iter.next().unwrap());
1815 assert_eq!(None, iter.next());
1819 fn comment_code_slices_two() {
1820 let input = "// comment\n test();";
1821 let mut iter = CommentCodeSlices::new(input);
1823 assert_eq!((CodeCharKind::Normal, 0, ""), iter.next().unwrap());
1825 (CodeCharKind::Comment, 0, "// comment\n"),
1826 iter.next().unwrap()
1829 (CodeCharKind::Normal, 11, " test();"),
1830 iter.next().unwrap()
1832 assert_eq!(None, iter.next());
1836 fn comment_code_slices_three() {
1837 let input = "1 // comment\n // comment2\n\n";
1838 let mut iter = CommentCodeSlices::new(input);
1840 assert_eq!((CodeCharKind::Normal, 0, "1 "), iter.next().unwrap());
1842 (CodeCharKind::Comment, 2, "// comment\n // comment2\n"),
1843 iter.next().unwrap()
1845 assert_eq!((CodeCharKind::Normal, 29, "\n"), iter.next().unwrap());
1846 assert_eq!(None, iter.next());
1851 fn format_doc_comments() {
1852 let mut wrap_normalize_config: crate::config::Config = Default::default();
1853 wrap_normalize_config.set().wrap_comments(true);
1854 wrap_normalize_config.set().normalize_comments(true);
1856 let mut wrap_config: crate::config::Config = Default::default();
1857 wrap_config.set().wrap_comments(true);
1859 let comment = rewrite_comment(" //test",
1861 Shape::legacy(100, Indent::new(0, 100)),
1862 &wrap_normalize_config).unwrap();
1863 assert_eq!("/* test */", comment);
1865 let comment = rewrite_comment("// comment on a",
1867 Shape::legacy(10, Indent::empty()),
1868 &wrap_normalize_config).unwrap();
1869 assert_eq!("// comment\n// on a", comment);
1871 let comment = rewrite_comment("// A multi line comment\n // between args.",
1873 Shape::legacy(60, Indent::new(0, 12)),
1874 &wrap_normalize_config).unwrap();
1875 assert_eq!("// A multi line comment\n // between args.", comment);
1877 let input = "// comment";
1880 let comment = rewrite_comment(input,
1882 Shape::legacy(9, Indent::new(0, 69)),
1883 &wrap_normalize_config).unwrap();
1884 assert_eq!(expected, comment);
1886 let comment = rewrite_comment("/* trimmed */",
1888 Shape::legacy(100, Indent::new(0, 100)),
1889 &wrap_normalize_config).unwrap();
1890 assert_eq!("/* trimmed */", comment);
1892 // Check that different comment style are properly recognised.
1893 let comment = rewrite_comment(r#"/// test1
1899 Shape::legacy(100, Indent::new(0, 0)),
1900 &wrap_normalize_config).unwrap();
1901 assert_eq!("/// test1\n/// test2\n// test3", comment);
1903 // Check that the blank line marks the end of a commented paragraph.
1904 let comment = rewrite_comment(r#"// test1
1908 Shape::legacy(100, Indent::new(0, 0)),
1909 &wrap_normalize_config).unwrap();
1910 assert_eq!("// test1\n\n// test2", comment);
1912 // Check that the blank line marks the end of a custom-commented paragraph.
1913 let comment = rewrite_comment(r#"//@ test1
1917 Shape::legacy(100, Indent::new(0, 0)),
1918 &wrap_normalize_config).unwrap();
1919 assert_eq!("//@ test1\n\n//@ test2", comment);
1921 // Check that bare lines are just indented but otherwise left unchanged.
1922 let comment = rewrite_comment(r#"// test1
1929 Shape::legacy(100, Indent::new(0, 0)),
1930 &wrap_config).unwrap();
1931 assert_eq!("// test1\n/*\n a bare line!\n\n another bare line!\n*/", comment);
1934 // This is probably intended to be a non-test fn, but it is not used.
1935 // We should keep this around unless it helps us test stuff to remove it.
1936 fn uncommented(text: &str) -> String {
1937 CharClasses::new(text.chars())
1938 .filter_map(|(s, c)| match s {
1939 FullCodeCharKind::Normal | FullCodeCharKind::InString => Some(c),
1946 fn test_uncommented() {
1947 assert_eq!(&uncommented("abc/*...*/"), "abc");
1949 &uncommented("// .... /* \n../* /* *** / */ */a/* // */c\n"),
1952 assert_eq!(&uncommented("abc \" /* */\" qsdf"), "abc \" /* */\" qsdf");
1956 fn test_contains_comment() {
1957 assert_eq!(contains_comment("abc"), false);
1958 assert_eq!(contains_comment("abc // qsdf"), true);
1959 assert_eq!(contains_comment("abc /* kqsdf"), true);
1960 assert_eq!(contains_comment("abc \" /* */\" qsdf"), false);
1964 fn test_find_uncommented() {
1965 fn check(haystack: &str, needle: &str, expected: Option<usize>) {
1966 assert_eq!(expected, haystack.find_uncommented(needle));
1969 check("/*/ */test", "test", Some(6));
1970 check("//test\ntest", "test", Some(7));
1971 check("/* comment only */", "whatever", None);
1973 "/* comment */ some text /* more commentary */ result",
1977 check("sup // sup", "p", Some(2));
1978 check("sup", "x", None);
1979 check(r#"π? /**/ π is nice!"#, r#"π is nice"#, Some(9));
1980 check("/*sup yo? \n sup*/ sup", "p", Some(20));
1981 check("hel/*lohello*/lo", "hello", None);
1982 check("acb", "ab", None);
1983 check(",/*A*/ ", ",", Some(0));
1984 check("abc", "abc", Some(0));
1985 check("/* abc */", "abc", None);
1986 check("/**/abc/* */", "abc", Some(4));
1987 check("\"/* abc */\"", "abc", Some(4));
1988 check("\"/* abc", "abc", Some(4));
1992 fn test_filter_normal_code() {
1995 println!("hello, world");
1998 assert_eq!(s, filter_normal_code(s));
1999 let s_with_comment = r#"
2002 println!("hello, world");
2005 assert_eq!(s, filter_normal_code(s_with_comment));