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.
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.
11 // Formatting and tools for comments.
13 use std::{self, iter};
15 use syntax::codemap::Span;
18 use rewrite::RewriteContext;
19 use shape::{Indent, Shape};
20 use string::{rewrite_string, StringFormat};
21 use utils::{first_line_width, last_line_width};
23 fn is_custom_comment(comment: &str) -> bool {
24 if !comment.starts_with("//") {
26 } else if let Some(c) = comment.chars().nth(2) {
27 !c.is_alphanumeric() && !c.is_whitespace()
33 #[derive(Copy, Clone, PartialEq, Eq)]
34 pub enum CommentStyle<'a> {
44 fn custom_opener(s: &str) -> &str {
45 s.lines().next().map_or("", |first_line| {
48 .map_or(first_line, |space_index| &first_line[0..space_index + 1])
52 impl<'a> CommentStyle<'a> {
53 pub fn opener(&self) -> &'a str {
55 CommentStyle::DoubleSlash => "// ",
56 CommentStyle::TripleSlash => "/// ",
57 CommentStyle::Doc => "//! ",
58 CommentStyle::SingleBullet => "/* ",
59 CommentStyle::DoubleBullet => "/** ",
60 CommentStyle::Exclamation => "/*! ",
61 CommentStyle::Custom(opener) => opener,
65 pub fn closer(&self) -> &'a str {
67 CommentStyle::DoubleSlash |
68 CommentStyle::TripleSlash |
69 CommentStyle::Custom(..) |
70 CommentStyle::Doc => "",
71 CommentStyle::DoubleBullet => " **/",
72 CommentStyle::SingleBullet | CommentStyle::Exclamation => " */",
76 pub fn line_start(&self) -> &'a str {
78 CommentStyle::DoubleSlash => "// ",
79 CommentStyle::TripleSlash => "/// ",
80 CommentStyle::Doc => "//! ",
81 CommentStyle::SingleBullet | CommentStyle::Exclamation => " * ",
82 CommentStyle::DoubleBullet => " ** ",
83 CommentStyle::Custom(opener) => opener,
87 pub fn to_str_tuplet(&self) -> (&'a str, &'a str, &'a str) {
88 (self.opener(), self.closer(), self.line_start())
91 pub fn line_with_same_comment_style(&self, line: &str, normalize_comments: bool) -> bool {
93 CommentStyle::DoubleSlash | CommentStyle::TripleSlash | CommentStyle::Doc => {
94 line.trim_left().starts_with(self.line_start().trim_left())
95 || comment_style(line, normalize_comments) == *self
97 CommentStyle::DoubleBullet | CommentStyle::SingleBullet | CommentStyle::Exclamation => {
98 line.trim_left().starts_with(self.closer().trim_left())
99 || line.trim_left().starts_with(self.line_start().trim_left())
100 || comment_style(line, normalize_comments) == *self
102 CommentStyle::Custom(opener) => line.trim_left().starts_with(opener.trim_right()),
107 fn comment_style(orig: &str, normalize_comments: bool) -> CommentStyle {
108 if !normalize_comments {
109 if orig.starts_with("/**") && !orig.starts_with("/**/") {
110 CommentStyle::DoubleBullet
111 } else if orig.starts_with("/*!") {
112 CommentStyle::Exclamation
113 } else if orig.starts_with("/*") {
114 CommentStyle::SingleBullet
115 } else if orig.starts_with("///") && orig.chars().nth(3).map_or(true, |c| c != '/') {
116 CommentStyle::TripleSlash
117 } else if orig.starts_with("//!") {
119 } else if is_custom_comment(orig) {
120 CommentStyle::Custom(custom_opener(orig))
122 CommentStyle::DoubleSlash
124 } else if (orig.starts_with("///") && orig.chars().nth(3).map_or(true, |c| c != '/'))
125 || (orig.starts_with("/**") && !orig.starts_with("/**/"))
127 CommentStyle::TripleSlash
128 } else if orig.starts_with("//!") || orig.starts_with("/*!") {
130 } else if is_custom_comment(orig) {
131 CommentStyle::Custom(custom_opener(orig))
133 CommentStyle::DoubleSlash
137 pub fn combine_strs_with_missing_comments(
138 context: &RewriteContext,
144 ) -> Option<String> {
145 let mut allow_one_line = !prev_str.contains('\n') && !next_str.contains('\n');
146 let first_sep = if prev_str.is_empty() || next_str.is_empty() {
151 let mut one_line_width =
152 last_line_width(prev_str) + first_line_width(next_str) + first_sep.len();
154 let indent_str = shape.indent.to_string(context.config);
155 let missing_comment = rewrite_missing_comment(span, shape, context)?;
157 if missing_comment.is_empty() {
158 if allow_extend && prev_str.len() + first_sep.len() + next_str.len() <= shape.width {
159 return Some(format!("{}{}{}", prev_str, first_sep, next_str));
161 let sep = if prev_str.is_empty() {
164 String::from("\n") + &indent_str
166 return Some(format!("{}{}{}", prev_str, sep, next_str));
170 // We have a missing comment between the first expression and the second expression.
172 // Peek the the original source code and find out whether there is a newline between the first
173 // expression and the second expression or the missing comment. We will preserve the orginal
174 // layout whenever possible.
175 let original_snippet = context.snippet(span);
176 let prefer_same_line = if let Some(pos) = original_snippet.chars().position(|c| c == '/') {
177 !original_snippet[..pos].contains('\n')
179 !original_snippet.contains('\n')
182 one_line_width -= first_sep.len();
183 let first_sep = if prev_str.is_empty() || missing_comment.is_empty() {
186 let one_line_width = last_line_width(prev_str) + first_line_width(&missing_comment) + 1;
187 if prefer_same_line && one_line_width <= shape.width {
190 format!("\n{}", indent_str)
193 let second_sep = if missing_comment.is_empty() || next_str.is_empty() {
195 } else if missing_comment.starts_with("//") {
196 format!("\n{}", indent_str)
198 one_line_width += missing_comment.len() + first_sep.len() + 1;
199 allow_one_line &= !missing_comment.starts_with("//") && !missing_comment.contains('\n');
200 if prefer_same_line && allow_one_line && one_line_width <= shape.width {
203 format!("\n{}", indent_str)
216 pub fn rewrite_comment(
221 ) -> Option<String> {
222 // If there are lines without a starting sigil, we won't format them correctly
223 // so in that case we won't even re-align (if !config.normalize_comments()) and
224 // we should stop now.
225 let num_bare_lines = orig.lines()
226 .map(|line| line.trim())
228 !(l.starts_with('*') || l.starts_with("//") || l.starts_with("/*"))
231 if num_bare_lines > 0 && !config.normalize_comments() {
232 return Some(orig.to_owned());
234 if !config.normalize_comments() && !config.wrap_comments() {
235 return light_rewrite_comment(orig, shape.indent, config);
238 identify_comment(orig, block_style, shape, config)
246 ) -> Option<String> {
247 let style = comment_style(orig, false);
248 let first_group = orig.lines()
249 .take_while(|l| style.line_with_same_comment_style(l, false))
252 let rest = orig.lines()
253 .skip(first_group.lines().count())
257 let first_group_str = rewrite_comment_inner(&first_group, block_style, style, shape, config)?;
259 Some(first_group_str)
261 identify_comment(&rest, block_style, shape, config).map(|rest_str| {
265 shape.indent.to_string(config),
272 fn rewrite_comment_inner(
278 ) -> Option<String> {
279 let (opener, closer, line_start) = if block_style {
280 CommentStyle::SingleBullet.to_str_tuplet()
282 comment_style(orig, config.normalize_comments()).to_str_tuplet()
285 let max_chars = shape
287 .checked_sub(closer.len() + opener.len())
289 let indent_str = shape.indent.to_string(config);
290 let fmt = StringFormat {
293 line_start: line_start,
295 shape: Shape::legacy(max_chars, shape.indent + (opener.len() - line_start.len())),
300 let line_breaks = orig.trim_right().chars().filter(|&c| c == '\n').count();
301 let lines = orig.lines()
303 .map(|(i, mut line)| {
306 if i == line_breaks && line.ends_with("*/") && !line.starts_with("//") {
307 line = line[..(line.len() - 2)].trim_right();
312 .map(|s| left_trim_comment_line(s, &style))
313 .map(|line| if orig.starts_with("/*") && line_breaks == 0 {
319 let mut result = opener.to_owned();
321 if result == opener {
327 result.push_str(&indent_str);
328 result.push_str(line_start);
331 if config.wrap_comments() && line.len() > max_chars {
332 let rewrite = rewrite_string(line, &fmt).unwrap_or_else(|| line.to_owned());
333 result.push_str(&rewrite);
335 if line.is_empty() && result.ends_with(' ') {
336 // Remove space if this is an empty comment or a doc comment.
339 result.push_str(line);
343 result.push_str(closer);
344 if result == opener && result.ends_with(' ') {
352 /// Given the span, rewrite the missing comment inside it if available.
353 /// Note that the given span must only include comments (or leading/trailing whitespaces).
354 pub fn rewrite_missing_comment(
357 context: &RewriteContext,
358 ) -> Option<String> {
359 let missing_snippet = context.snippet(span);
360 let trimmed_snippet = missing_snippet.trim();
361 if !trimmed_snippet.is_empty() {
362 rewrite_comment(trimmed_snippet, false, shape, context.config)
368 /// Recover the missing comments in the specified span, if available.
369 /// The layout of the comments will be preserved as long as it does not break the code
370 /// and its total width does not exceed the max width.
371 pub fn recover_missing_comment_in_span(
374 context: &RewriteContext,
376 ) -> Option<String> {
377 let missing_comment = rewrite_missing_comment(span, shape, context)?;
378 if missing_comment.is_empty() {
381 let missing_snippet = context.snippet(span);
382 let pos = missing_snippet.chars().position(|c| c == '/').unwrap_or(0);
384 let total_width = missing_comment.len() + used_width + 1;
385 let force_new_line_before_comment =
386 missing_snippet[..pos].contains('\n') || total_width > context.config.max_width();
387 let sep = if force_new_line_before_comment {
388 format!("\n{}", shape.indent.to_string(context.config))
392 Some(format!("{}{}", sep, missing_comment))
396 /// Trims whitespace and aligns to indent, but otherwise does not change comments.
397 fn light_rewrite_comment(orig: &str, offset: Indent, config: &Config) -> Option<String> {
398 let lines: Vec<&str> = orig.lines()
400 // This is basically just l.trim(), but in the case that a line starts
401 // with `*` we want to leave one space before it, so it aligns with the
403 let first_non_whitespace = l.find(|c| !char::is_whitespace(c));
404 if let Some(fnw) = first_non_whitespace {
405 if l.as_bytes()[fnw] == b'*' && fnw > 0 {
415 Some(lines.join(&format!("\n{}", offset.to_string(config))))
418 /// Trims comment characters and possibly a single space from the left of a string.
419 /// Does not trim all whitespace.
420 fn left_trim_comment_line<'a>(line: &'a str, style: &CommentStyle) -> &'a str {
421 if line.starts_with("//! ") || line.starts_with("/// ") || line.starts_with("/*! ")
422 || line.starts_with("/** ")
425 } else if let CommentStyle::Custom(opener) = *style {
426 if line.starts_with(opener) {
427 &line[opener.len()..]
429 &line[opener.trim_right().len()..]
431 } else if line.starts_with("/* ") || line.starts_with("// ") || line.starts_with("//!")
432 || line.starts_with("///") || line.starts_with("** ")
433 || line.starts_with("/*!")
434 || (line.starts_with("/**") && !line.starts_with("/**/"))
437 } else if line.starts_with("/*") || line.starts_with("* ") || line.starts_with("//")
438 || line.starts_with("**")
441 } else if line.starts_with('*') {
448 pub trait FindUncommented {
449 fn find_uncommented(&self, pat: &str) -> Option<usize>;
452 impl FindUncommented for str {
453 fn find_uncommented(&self, pat: &str) -> Option<usize> {
454 let mut needle_iter = pat.chars();
455 for (kind, (i, b)) in CharClasses::new(self.char_indices()) {
456 match needle_iter.next() {
458 return Some(i - pat.len());
460 Some(c) => match kind {
461 FullCodeCharKind::Normal | FullCodeCharKind::InString if b == c => {}
463 needle_iter = pat.chars();
469 // Handle case where the pattern is a suffix of the search string
470 match needle_iter.next() {
472 None => Some(self.len() - pat.len()),
477 // Returns the first byte position after the first comment. The given string
478 // is expected to be prefixed by a comment, including delimiters.
479 // Good: "/* /* inner */ outer */ code();"
480 // Bad: "code(); // hello\n world!"
481 pub fn find_comment_end(s: &str) -> Option<usize> {
482 let mut iter = CharClasses::new(s.char_indices());
483 for (kind, (i, _c)) in &mut iter {
484 if kind == FullCodeCharKind::Normal || kind == FullCodeCharKind::InString {
489 // Handle case where the comment ends at the end of s.
490 if iter.status == CharClassesStatus::Normal {
497 /// Returns true if text contains any comment.
498 pub fn contains_comment(text: &str) -> bool {
499 CharClasses::new(text.chars()).any(|(kind, _)| kind.is_comment())
502 /// Remove trailing spaces from the specified snippet. We do not remove spaces
503 /// inside strings or comments.
504 pub fn remove_trailing_white_spaces(text: &str) -> String {
505 let mut buffer = String::with_capacity(text.len());
506 let mut space_buffer = String::with_capacity(128);
507 for (char_kind, c) in CharClasses::new(text.chars()) {
510 if char_kind == FullCodeCharKind::InString {
511 buffer.push_str(&space_buffer);
513 space_buffer.clear();
516 _ if c.is_whitespace() => {
517 space_buffer.push(c);
520 if !space_buffer.is_empty() {
521 buffer.push_str(&space_buffer);
522 space_buffer.clear();
531 struct CharClasses<T>
536 base: iter::Peekable<T>,
537 status: CharClassesStatus,
541 fn get_char(&self) -> char;
544 impl RichChar for char {
545 fn get_char(&self) -> char {
550 impl RichChar for (usize, char) {
551 fn get_char(&self) -> char {
556 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
557 enum CharClassesStatus {
563 // The u32 is the nesting deepness of the comment
565 // Status when the '/' has been consumed, but not yet the '*', deepness is
566 // the new deepness (after the comment opening).
567 BlockCommentOpening(u32),
568 // Status when the '*' has been consumed, but not yet the '/', deepness is
569 // the new deepness (after the comment closing).
570 BlockCommentClosing(u32),
574 /// Distinguish between functional part of code and comments
575 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
576 pub enum CodeCharKind {
581 /// Distinguish between functional part of code and comments,
582 /// describing opening and closing of comments for ease when chunking
583 /// code from tagged characters
584 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
585 enum FullCodeCharKind {
587 /// The first character of a comment, there is only one for a comment (always '/')
589 /// Any character inside a comment including the second character of comment
590 /// marks ("//", "/*")
592 /// Last character of a comment, '\n' for a line comment, '/' for a block comment.
598 impl FullCodeCharKind {
599 fn is_comment(&self) -> bool {
601 FullCodeCharKind::StartComment |
602 FullCodeCharKind::InComment |
603 FullCodeCharKind::EndComment => true,
608 fn to_codecharkind(&self) -> CodeCharKind {
609 if self.is_comment() {
610 CodeCharKind::Comment
617 impl<T> CharClasses<T>
622 fn new(base: T) -> CharClasses<T> {
624 base: base.peekable(),
625 status: CharClassesStatus::Normal,
630 impl<T> Iterator for CharClasses<T>
635 type Item = (FullCodeCharKind, T::Item);
637 fn next(&mut self) -> Option<(FullCodeCharKind, T::Item)> {
638 let item = self.base.next()?;
639 let chr = item.get_char();
640 let mut char_kind = FullCodeCharKind::Normal;
641 self.status = match self.status {
642 CharClassesStatus::LitString => match chr {
643 '"' => CharClassesStatus::Normal,
645 char_kind = FullCodeCharKind::InString;
646 CharClassesStatus::LitStringEscape
649 char_kind = FullCodeCharKind::InString;
650 CharClassesStatus::LitString
653 CharClassesStatus::LitStringEscape => {
654 char_kind = FullCodeCharKind::InString;
655 CharClassesStatus::LitString
657 CharClassesStatus::LitChar => match chr {
658 '\\' => CharClassesStatus::LitCharEscape,
659 '\'' => CharClassesStatus::Normal,
660 _ => CharClassesStatus::LitChar,
662 CharClassesStatus::LitCharEscape => CharClassesStatus::LitChar,
663 CharClassesStatus::Normal => match chr {
665 char_kind = FullCodeCharKind::InString;
666 CharClassesStatus::LitString
668 '\'' => CharClassesStatus::LitChar,
669 '/' => match self.base.peek() {
670 Some(next) if next.get_char() == '*' => {
671 self.status = CharClassesStatus::BlockCommentOpening(1);
672 return Some((FullCodeCharKind::StartComment, item));
674 Some(next) if next.get_char() == '/' => {
675 self.status = CharClassesStatus::LineComment;
676 return Some((FullCodeCharKind::StartComment, item));
678 _ => CharClassesStatus::Normal,
680 _ => CharClassesStatus::Normal,
682 CharClassesStatus::BlockComment(deepness) => {
683 assert_ne!(deepness, 0);
684 self.status = match self.base.peek() {
685 Some(next) if next.get_char() == '/' && chr == '*' => {
686 CharClassesStatus::BlockCommentClosing(deepness - 1)
688 Some(next) if next.get_char() == '*' && chr == '/' => {
689 CharClassesStatus::BlockCommentOpening(deepness + 1)
691 _ => CharClassesStatus::BlockComment(deepness),
693 return Some((FullCodeCharKind::InComment, item));
695 CharClassesStatus::BlockCommentOpening(deepness) => {
696 assert_eq!(chr, '*');
697 self.status = CharClassesStatus::BlockComment(deepness);
698 return Some((FullCodeCharKind::InComment, item));
700 CharClassesStatus::BlockCommentClosing(deepness) => {
701 assert_eq!(chr, '/');
703 self.status = CharClassesStatus::Normal;
704 return Some((FullCodeCharKind::EndComment, item));
706 self.status = CharClassesStatus::BlockComment(deepness);
707 return Some((FullCodeCharKind::InComment, item));
710 CharClassesStatus::LineComment => match chr {
712 self.status = CharClassesStatus::Normal;
713 return Some((FullCodeCharKind::EndComment, item));
716 self.status = CharClassesStatus::LineComment;
717 return Some((FullCodeCharKind::InComment, item));
721 Some((char_kind, item))
725 /// Iterator over functional and commented parts of a string. Any part of a string is either
726 /// functional code, either *one* block comment, either *one* line comment. Whitespace between
727 /// comments is functional code. Line comments contain their ending newlines.
728 struct UngroupedCommentCodeSlices<'a> {
730 iter: iter::Peekable<CharClasses<std::str::CharIndices<'a>>>,
733 impl<'a> UngroupedCommentCodeSlices<'a> {
734 fn new(code: &'a str) -> UngroupedCommentCodeSlices<'a> {
735 UngroupedCommentCodeSlices {
737 iter: CharClasses::new(code.char_indices()).peekable(),
742 impl<'a> Iterator for UngroupedCommentCodeSlices<'a> {
743 type Item = (CodeCharKind, usize, &'a str);
745 fn next(&mut self) -> Option<Self::Item> {
746 let (kind, (start_idx, _)) = self.iter.next()?;
748 FullCodeCharKind::Normal | FullCodeCharKind::InString => {
749 // Consume all the Normal code
750 while let Some(&(char_kind, _)) = self.iter.peek() {
751 if char_kind.is_comment() {
754 let _ = self.iter.next();
757 FullCodeCharKind::StartComment => {
758 // Consume the whole comment
759 while let Some((FullCodeCharKind::InComment, (_, _))) = self.iter.next() {}
763 let slice = match self.iter.peek() {
764 Some(&(_, (end_idx, _))) => &self.slice[start_idx..end_idx],
765 None => &self.slice[start_idx..],
768 if kind.is_comment() {
769 CodeCharKind::Comment
782 /// Iterator over an alternating sequence of functional and commented parts of
783 /// a string. The first item is always a, possibly zero length, subslice of
784 /// functional text. Line style comments contain their ending newlines.
785 pub struct CommentCodeSlices<'a> {
787 last_slice_kind: CodeCharKind,
788 last_slice_end: usize,
791 impl<'a> CommentCodeSlices<'a> {
792 pub fn new(slice: &'a str) -> CommentCodeSlices<'a> {
795 last_slice_kind: CodeCharKind::Comment,
801 impl<'a> Iterator for CommentCodeSlices<'a> {
802 type Item = (CodeCharKind, usize, &'a str);
804 fn next(&mut self) -> Option<Self::Item> {
805 if self.last_slice_end == self.slice.len() {
809 let mut sub_slice_end = self.last_slice_end;
810 let mut first_whitespace = None;
811 let subslice = &self.slice[self.last_slice_end..];
812 let mut iter = CharClasses::new(subslice.char_indices());
814 for (kind, (i, c)) in &mut iter {
815 let is_comment_connector = self.last_slice_kind == CodeCharKind::Normal
816 && &subslice[..2] == "//"
817 && [' ', '\t'].contains(&c);
819 if is_comment_connector && first_whitespace.is_none() {
820 first_whitespace = Some(i);
823 if kind.to_codecharkind() == self.last_slice_kind && !is_comment_connector {
824 let last_index = match first_whitespace {
828 sub_slice_end = self.last_slice_end + last_index;
832 if !is_comment_connector {
833 first_whitespace = None;
837 if let (None, true) = (iter.next(), sub_slice_end == self.last_slice_end) {
838 // This was the last subslice.
839 sub_slice_end = match first_whitespace {
840 Some(i) => self.last_slice_end + i,
841 None => self.slice.len(),
845 let kind = match self.last_slice_kind {
846 CodeCharKind::Comment => CodeCharKind::Normal,
847 CodeCharKind::Normal => CodeCharKind::Comment,
852 &self.slice[self.last_slice_end..sub_slice_end],
854 self.last_slice_end = sub_slice_end;
855 self.last_slice_kind = kind;
861 /// Checks is `new` didn't miss any comment from `span`, if it removed any, return previous text
862 /// (if it fits in the width/offset, else return None), else return `new`
863 pub fn recover_comment_removed(
866 context: &RewriteContext,
867 ) -> Option<String> {
868 let snippet = context.snippet(span);
869 if snippet != new && changed_comment_content(&snippet, &new) {
870 // We missed some comments. Keep the original text.
877 /// Return true if the two strings of code have the same payload of comments.
878 /// The payload of comments is everything in the string except:
879 /// - actual code (not comments)
880 /// - comment start/end marks
882 /// - '*' at the beginning of lines in block comments
883 fn changed_comment_content(orig: &str, new: &str) -> bool {
884 // Cannot write this as a fn since we cannot return types containing closures
885 let code_comment_content = |code| {
886 let slices = UngroupedCommentCodeSlices::new(code);
888 .filter(|&(ref kind, _, _)| *kind == CodeCharKind::Comment)
889 .flat_map(|(_, _, s)| CommentReducer::new(s))
891 let res = code_comment_content(orig).ne(code_comment_content(new));
893 "comment::changed_comment_content: {}\norig: '{}'\nnew: '{}'\nraw_old: {}\nraw_new: {}",
897 code_comment_content(orig).collect::<String>(),
898 code_comment_content(new).collect::<String>()
904 /// Iterator over the 'payload' characters of a comment.
905 /// It skips whitespace, comment start/end marks, and '*' at the beginning of lines.
906 /// The comment must be one comment, ie not more than one start mark (no multiple line comments,
908 struct CommentReducer<'a> {
911 iter: std::str::Chars<'a>,
914 impl<'a> CommentReducer<'a> {
915 fn new(comment: &'a str) -> CommentReducer<'a> {
916 let is_block = comment.starts_with("/*");
917 let comment = remove_comment_header(comment);
920 at_start_line: false, // There are no supplementary '*' on the first line
921 iter: comment.chars(),
926 impl<'a> Iterator for CommentReducer<'a> {
928 fn next(&mut self) -> Option<Self::Item> {
930 let mut c = self.iter.next()?;
931 if self.is_block && self.at_start_line {
932 while c.is_whitespace() {
933 c = self.iter.next()?;
935 // Ignore leading '*'
937 c = self.iter.next()?;
939 } else if c == '\n' {
940 self.at_start_line = true;
942 if !c.is_whitespace() {
950 fn remove_comment_header(comment: &str) -> &str {
951 if comment.starts_with("///") || comment.starts_with("//!") {
953 } else if comment.starts_with("//") {
955 } else if (comment.starts_with("/**") && !comment.starts_with("/**/"))
956 || comment.starts_with("/*!")
958 &comment[3..comment.len() - 2]
961 comment.starts_with("/*"),
962 format!("string '{}' is not a comment", comment)
964 &comment[2..comment.len() - 2]
970 use super::{contains_comment, rewrite_comment, CharClasses, CodeCharKind, CommentCodeSlices,
971 FindUncommented, FullCodeCharKind};
972 use shape::{Indent, Shape};
976 let mut iter = CharClasses::new("//\n\n".chars());
978 assert_eq!((FullCodeCharKind::StartComment, '/'), iter.next().unwrap());
979 assert_eq!((FullCodeCharKind::InComment, '/'), iter.next().unwrap());
980 assert_eq!((FullCodeCharKind::EndComment, '\n'), iter.next().unwrap());
981 assert_eq!((FullCodeCharKind::Normal, '\n'), iter.next().unwrap());
982 assert_eq!(None, iter.next());
986 fn comment_code_slices() {
987 let input = "code(); /* test */ 1 + 1";
988 let mut iter = CommentCodeSlices::new(input);
990 assert_eq!((CodeCharKind::Normal, 0, "code(); "), iter.next().unwrap());
992 (CodeCharKind::Comment, 8, "/* test */"),
995 assert_eq!((CodeCharKind::Normal, 18, " 1 + 1"), iter.next().unwrap());
996 assert_eq!(None, iter.next());
1000 fn comment_code_slices_two() {
1001 let input = "// comment\n test();";
1002 let mut iter = CommentCodeSlices::new(input);
1004 assert_eq!((CodeCharKind::Normal, 0, ""), iter.next().unwrap());
1006 (CodeCharKind::Comment, 0, "// comment\n"),
1007 iter.next().unwrap()
1010 (CodeCharKind::Normal, 11, " test();"),
1011 iter.next().unwrap()
1013 assert_eq!(None, iter.next());
1017 fn comment_code_slices_three() {
1018 let input = "1 // comment\n // comment2\n\n";
1019 let mut iter = CommentCodeSlices::new(input);
1021 assert_eq!((CodeCharKind::Normal, 0, "1 "), iter.next().unwrap());
1023 (CodeCharKind::Comment, 2, "// comment\n // comment2\n"),
1024 iter.next().unwrap()
1026 assert_eq!((CodeCharKind::Normal, 29, "\n"), iter.next().unwrap());
1027 assert_eq!(None, iter.next());
1031 #[cfg_attr(rustfmt, rustfmt_skip)]
1032 fn format_comments() {
1033 let mut config: ::config::Config = Default::default();
1034 config.set().wrap_comments(true);
1035 config.set().normalize_comments(true);
1037 let comment = rewrite_comment(" //test",
1039 Shape::legacy(100, Indent::new(0, 100)),
1041 assert_eq!("/* test */", comment);
1043 let comment = rewrite_comment("// comment on a",
1045 Shape::legacy(10, Indent::empty()),
1047 assert_eq!("// comment\n// on a", comment);
1049 let comment = rewrite_comment("// A multi line comment\n // between args.",
1051 Shape::legacy(60, Indent::new(0, 12)),
1053 assert_eq!("// A multi line comment\n // between args.", comment);
1055 let input = "// comment";
1058 let comment = rewrite_comment(input,
1060 Shape::legacy(9, Indent::new(0, 69)),
1062 assert_eq!(expected, comment);
1064 let comment = rewrite_comment("/* trimmed */",
1066 Shape::legacy(100, Indent::new(0, 100)),
1068 assert_eq!("/* trimmed */", comment);
1071 // This is probably intended to be a non-test fn, but it is not used. I'm
1072 // keeping it around unless it helps us test stuff.
1073 fn uncommented(text: &str) -> String {
1074 CharClasses::new(text.chars())
1075 .filter_map(|(s, c)| match s {
1076 FullCodeCharKind::Normal | FullCodeCharKind::InString => Some(c),
1083 fn test_uncommented() {
1084 assert_eq!(&uncommented("abc/*...*/"), "abc");
1086 &uncommented("// .... /* \n../* /* *** / */ */a/* // */c\n"),
1089 assert_eq!(&uncommented("abc \" /* */\" qsdf"), "abc \" /* */\" qsdf");
1093 fn test_contains_comment() {
1094 assert_eq!(contains_comment("abc"), false);
1095 assert_eq!(contains_comment("abc // qsdf"), true);
1096 assert_eq!(contains_comment("abc /* kqsdf"), true);
1097 assert_eq!(contains_comment("abc \" /* */\" qsdf"), false);
1101 fn test_find_uncommented() {
1102 fn check(haystack: &str, needle: &str, expected: Option<usize>) {
1103 assert_eq!(expected, haystack.find_uncommented(needle));
1106 check("/*/ */test", "test", Some(6));
1107 check("//test\ntest", "test", Some(7));
1108 check("/* comment only */", "whatever", None);
1110 "/* comment */ some text /* more commentary */ result",
1114 check("sup // sup", "p", Some(2));
1115 check("sup", "x", None);
1116 check(r#"π? /**/ π is nice!"#, r#"π is nice"#, Some(9));
1117 check("/*sup yo? \n sup*/ sup", "p", Some(20));
1118 check("hel/*lohello*/lo", "hello", None);
1119 check("acb", "ab", None);
1120 check(",/*A*/ ", ",", Some(0));
1121 check("abc", "abc", Some(0));
1122 check("/* abc */", "abc", None);
1123 check("/**/abc/* */", "abc", Some(4));
1124 check("\"/* abc */\"", "abc", Some(4));
1125 check("\"/* abc", "abc", Some(4));