-// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
-// file at the top-level directory of this distribution and at
-// http://rust-lang.org/COPYRIGHT.
-//
-// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
-// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
-// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
-// option. This file may not be copied, modified, or distributed
-// except according to those terms.
-
// Formatting and tools for comments.
use std::{self, borrow::Cow, iter};
use itertools::{multipeek, MultiPeek};
-use syntax::source_map::Span;
-
-use config::Config;
-use rewrite::RewriteContext;
-use shape::{Indent, Shape};
-use string::{rewrite_string, StringFormat};
-use utils::{count_newlines, first_line_width, last_line_width, trim_left_preserve_layout};
-use {ErrorKind, FormattingError};
+use lazy_static::lazy_static;
+use regex::Regex;
+use rustc_span::Span;
+
+use crate::config::Config;
+use crate::rewrite::RewriteContext;
+use crate::shape::{Indent, Shape};
+use crate::string::{rewrite_string, StringFormat};
+use crate::utils::{
+ count_newlines, first_line_width, last_line_width, trim_left_preserve_layout,
+ trimmed_last_line_width, unicode_str_width,
+};
+use crate::{ErrorKind, FormattingError};
+
+lazy_static! {
+ /// A regex matching reference doc links.
+ ///
+ /// ```markdown
+ /// /// An [example].
+ /// ///
+ /// /// [example]: this::is::a::link
+ /// ```
+ static ref REFERENCE_LINK_URL: Regex = Regex::new(r"^\[.+\]\s?:").unwrap();
+}
fn is_custom_comment(comment: &str) -> bool {
if !comment.starts_with("//") {
}
#[derive(Copy, Clone, PartialEq, Eq)]
-pub enum CommentStyle<'a> {
+pub(crate) enum CommentStyle<'a> {
DoubleSlash,
TripleSlash,
Doc,
}
impl<'a> CommentStyle<'a> {
- /// Returns true if the commenting style covers a line only.
- pub fn is_line_comment(&self) -> bool {
+ /// Returns `true` if the commenting style covers a line only.
+ pub(crate) fn is_line_comment(&self) -> bool {
match *self {
CommentStyle::DoubleSlash
| CommentStyle::TripleSlash
}
}
- /// Returns true if the commenting style can span over multiple lines.
- pub fn is_block_comment(&self) -> bool {
+ /// Returns `true` if the commenting style can span over multiple lines.
+ pub(crate) fn is_block_comment(&self) -> bool {
match *self {
CommentStyle::SingleBullet | CommentStyle::DoubleBullet | CommentStyle::Exclamation => {
true
}
}
- /// Returns true if the commenting style is for documentation.
- pub fn is_doc_comment(&self) -> bool {
- match *self {
- CommentStyle::TripleSlash | CommentStyle::Doc => true,
- _ => false,
- }
+ /// Returns `true` if the commenting style is for documentation.
+ pub(crate) fn is_doc_comment(&self) -> bool {
+ matches!(*self, CommentStyle::TripleSlash | CommentStyle::Doc)
}
- pub fn opener(&self) -> &'a str {
+ pub(crate) fn opener(&self) -> &'a str {
match *self {
CommentStyle::DoubleSlash => "// ",
CommentStyle::TripleSlash => "/// ",
}
}
- pub fn closer(&self) -> &'a str {
+ pub(crate) fn closer(&self) -> &'a str {
match *self {
CommentStyle::DoubleSlash
| CommentStyle::TripleSlash
| CommentStyle::Custom(..)
| CommentStyle::Doc => "",
- CommentStyle::DoubleBullet => " **/",
- CommentStyle::SingleBullet | CommentStyle::Exclamation => " */",
+ CommentStyle::SingleBullet | CommentStyle::DoubleBullet | CommentStyle::Exclamation => {
+ " */"
+ }
}
}
- pub fn line_start(&self) -> &'a str {
+ pub(crate) fn line_start(&self) -> &'a str {
match *self {
CommentStyle::DoubleSlash => "// ",
CommentStyle::TripleSlash => "/// ",
CommentStyle::Doc => "//! ",
- CommentStyle::SingleBullet | CommentStyle::Exclamation => " * ",
- CommentStyle::DoubleBullet => " ** ",
+ CommentStyle::SingleBullet | CommentStyle::DoubleBullet | CommentStyle::Exclamation => {
+ " * "
+ }
CommentStyle::Custom(opener) => opener,
}
}
- pub fn to_str_tuplet(&self) -> (&'a str, &'a str, &'a str) {
+ pub(crate) fn to_str_tuplet(&self) -> (&'a str, &'a str, &'a str) {
(self.opener(), self.closer(), self.line_start())
}
}
-fn comment_style(orig: &str, normalize_comments: bool) -> CommentStyle {
+pub(crate) fn comment_style(orig: &str, normalize_comments: bool) -> CommentStyle<'_> {
if !normalize_comments {
if orig.starts_with("/**") && !orig.starts_with("/**/") {
CommentStyle::DoubleBullet
}
}
+/// Returns true if the last line of the passed string finishes with a block-comment.
+pub(crate) fn is_last_comment_block(s: &str) -> bool {
+ s.trim_end().ends_with("*/")
+}
+
/// Combine `prev_str` and `next_str` into a single `String`. `span` may contain
/// comments between two strings. If there are such comments, then that will be
/// recovered. If `allow_extend` is true and there is no comment between the two
/// strings, then they will be put on a single line as long as doing so does not
/// exceed max width.
-pub fn combine_strs_with_missing_comments(
- context: &RewriteContext,
+pub(crate) fn combine_strs_with_missing_comments(
+ context: &RewriteContext<'_>,
prev_str: &str,
next_str: &str,
span: Span,
String::with_capacity(prev_str.len() + next_str.len() + shape.indent.width() + 128);
result.push_str(prev_str);
let mut allow_one_line = !prev_str.contains('\n') && !next_str.contains('\n');
- let first_sep = if prev_str.is_empty() || next_str.is_empty() {
- ""
- } else {
- " "
- };
+ let first_sep =
+ if prev_str.is_empty() || next_str.is_empty() || trimmed_last_line_width(prev_str) == 0 {
+ ""
+ } else {
+ " "
+ };
let mut one_line_width =
last_line_width(prev_str) + first_line_width(next_str) + first_sep.len();
let missing_comment = rewrite_missing_comment(span, shape, context)?;
if missing_comment.is_empty() {
- if allow_extend && prev_str.len() + first_sep.len() + next_str.len() <= shape.width {
+ if allow_extend && one_line_width <= shape.width {
result.push_str(first_sep);
} else if !prev_str.is_empty() {
result.push_str(&indent.to_string_with_newline(config))
Some(result)
}
-pub fn rewrite_doc_comment(orig: &str, shape: Shape, config: &Config) -> Option<String> {
+pub(crate) fn rewrite_doc_comment(orig: &str, shape: Shape, config: &Config) -> Option<String> {
identify_comment(orig, false, shape, config, true)
}
-pub fn rewrite_comment(
+pub(crate) fn rewrite_comment(
orig: &str,
block_style: bool,
shape: Shape,
) -> Option<String> {
let style = comment_style(orig, false);
- // Computes the len of line taking into account a newline if the line is part of a paragraph.
+ // Computes the byte length of line taking into account a newline if the line is part of a
+ // paragraph.
fn compute_len(orig: &str, line: &str) -> usize {
if orig.len() > line.len() {
if orig.as_bytes()[line.len()] == b'\r' {
// - a boolean indicating if there is a blank line
// - a number indicating the size of the first group of comments
fn consume_same_line_comments(
- style: CommentStyle,
+ style: CommentStyle<'_>,
orig: &str,
line_start: &str,
) -> (bool, usize) {
// for a block comment, search for the closing symbol
CommentStyle::DoubleBullet | CommentStyle::SingleBullet | CommentStyle::Exclamation => {
let closer = style.closer().trim_start();
+ let mut count = orig.matches(closer).count();
let mut closing_symbol_offset = 0;
let mut hbl = false;
let mut first = true;
first = false;
}
if trimmed_line.ends_with(closer) {
- break;
+ count -= 1;
+ if count == 0 {
+ break;
+ }
}
}
(hbl, closing_symbol_offset)
trim_left_preserve_layout(first_group, shape.indent, config)?
} else if !config.normalize_comments()
&& !config.wrap_comments()
- && !config.format_doc_comments()
+ && !config.format_code_in_doc_comments()
{
light_rewrite_comment(first_group, shape.indent, config, is_doc_comment)
} else {
}
}
-/// Attributes for code blocks in rustdoc.
-/// See https://doc.rust-lang.org/rustdoc/print.html#attributes
+/// Enum indicating if the code block contains rust based on attributes
enum CodeBlockAttribute {
Rust,
- Ignore,
- Text,
- ShouldPanic,
- NoRun,
- CompileFail,
+ NotRust,
}
impl CodeBlockAttribute {
- fn new(attribute: &str) -> CodeBlockAttribute {
- match attribute {
- "rust" | "" => CodeBlockAttribute::Rust,
- "ignore" => CodeBlockAttribute::Ignore,
- "text" => CodeBlockAttribute::Text,
- "should_panic" => CodeBlockAttribute::ShouldPanic,
- "no_run" => CodeBlockAttribute::NoRun,
- "compile_fail" => CodeBlockAttribute::CompileFail,
- _ => CodeBlockAttribute::Text,
+ /// Parse comma separated attributes list. Return rust only if all
+ /// attributes are valid rust attributes
+ /// See <https://doc.rust-lang.org/rustdoc/print.html#attributes>
+ fn new(attributes: &str) -> CodeBlockAttribute {
+ for attribute in attributes.split(',') {
+ match attribute.trim() {
+ "" | "rust" | "should_panic" | "no_run" | "edition2015" | "edition2018"
+ | "edition2021" => (),
+ "ignore" | "compile_fail" | "text" => return CodeBlockAttribute::NotRust,
+ _ => return CodeBlockAttribute::NotRust,
+ }
}
+ CodeBlockAttribute::Rust
}
}
/// An item starts with either a star `*` or a dash `-`. Different level of indentation are
/// handled by shrinking the shape accordingly.
struct ItemizedBlock {
+ /// the lines that are identified as part of an itemized block
+ lines: Vec<String>,
/// the number of whitespaces up to the item sigil
indent: usize,
/// the string that marks the start of an item
}
impl ItemizedBlock {
- /// Returns true if the line is formatted as an item
+ /// Returns `true` if the line is formatted as an item
fn is_itemized_line(line: &str) -> bool {
let trimmed = line.trim_start();
trimmed.starts_with("* ") || trimmed.starts_with("- ")
let space_to_sigil = line.chars().take_while(|c| c.is_whitespace()).count();
let indent = space_to_sigil + 2;
ItemizedBlock {
+ lines: vec![line[indent..].to_string()],
indent,
opener: line[..indent].to_string(),
line_start: " ".repeat(indent),
}
}
- /// Returns a `StringFormat` used for formatting the content of an item
- fn create_string_format<'a>(&'a self, fmt: &'a StringFormat) -> StringFormat<'a> {
+ /// Returns a `StringFormat` used for formatting the content of an item.
+ fn create_string_format<'a>(&'a self, fmt: &'a StringFormat<'_>) -> StringFormat<'a> {
StringFormat {
opener: "",
closer: "",
}
}
- /// Returns true if the line is part of the current itemized block
- fn in_block(&self, line: &str) -> bool {
- !ItemizedBlock::is_itemized_line(line)
+ /// Returns `true` if the line is part of the current itemized block.
+ /// If it is, then it is added to the internal lines list.
+ fn add_line(&mut self, line: &str) -> bool {
+ if !ItemizedBlock::is_itemized_line(line)
&& self.indent <= line.chars().take_while(|c| c.is_whitespace()).count()
+ {
+ self.lines.push(line.to_string());
+ return true;
+ }
+ false
+ }
+
+ /// Returns the block as a string, with each line trimmed at the start.
+ fn trimmed_block_as_string(&self) -> String {
+ self.lines
+ .iter()
+ .map(|line| format!("{} ", line.trim_start()))
+ .collect::<String>()
+ }
+
+ /// Returns the block as a string under its original form.
+ fn original_block_as_string(&self) -> String {
+ self.lines.join("\n")
}
}
code_block_buffer: String,
is_prev_line_multi_line: bool,
code_block_attr: Option<CodeBlockAttribute>,
- item_block_buffer: String,
item_block: Option<ItemizedBlock>,
comment_line_separator: String,
indent_str: String,
- max_chars: usize,
+ max_width: usize,
fmt_indent: Indent,
fmt: StringFormat<'a>,
comment_style(orig, config.normalize_comments()).to_str_tuplet()
};
- let max_chars = shape
+ let max_width = shape
.width
.checked_sub(closer.len() + opener.len())
.unwrap_or(1);
let indent_str = shape.indent.to_string_with_newline(config).to_string();
- let fmt_indent = shape.indent + (opener.len() - line_start.len());
let mut cr = CommentRewrite {
result: String::with_capacity(orig.len() * 2),
code_block_buffer: String::with_capacity(128),
is_prev_line_multi_line: false,
code_block_attr: None,
- item_block_buffer: String::with_capacity(128),
item_block: None,
comment_line_separator: format!("{}{}", indent_str, line_start),
- max_chars,
+ max_width,
indent_str,
- fmt_indent,
+ fmt_indent: shape.indent,
fmt: StringFormat {
opener: "",
closer: "",
line_start,
line_end: "",
- shape: Shape::legacy(max_chars, fmt_indent),
+ shape: Shape::legacy(max_width, shape.indent),
trim_end: true,
config,
},
result.push_str(line);
result.push_str(match iter.peek() {
Some(next_line) if next_line.is_empty() => sep.trim_end(),
- Some(..) => &sep,
+ Some(..) => sep,
None => "",
});
}
));
}
- if !self.item_block_buffer.is_empty() {
+ if let Some(ref ib) = self.item_block {
// the last few lines are part of an itemized block
- self.fmt.shape = Shape::legacy(self.max_chars, self.fmt_indent);
- let mut ib = None;
- ::std::mem::swap(&mut ib, &mut self.item_block);
- let ib = ib.unwrap();
+ self.fmt.shape = Shape::legacy(self.max_width, self.fmt_indent);
let item_fmt = ib.create_string_format(&self.fmt);
self.result.push_str(&self.comment_line_separator);
self.result.push_str(&ib.opener);
match rewrite_string(
- &self.item_block_buffer.replace("\n", " "),
+ &ib.trimmed_block_as_string(),
&item_fmt,
- self.max_chars.saturating_sub(ib.indent),
+ self.max_width.saturating_sub(ib.indent),
) {
Some(s) => self.result.push_str(&Self::join_block(
&s,
- &format!("{}{}", &self.comment_line_separator, ib.line_start),
+ &format!("{}{}", self.comment_line_separator, ib.line_start),
)),
None => self.result.push_str(&Self::join_block(
- &self.item_block_buffer,
+ &ib.original_block_as_string(),
&self.comment_line_separator,
)),
};
) -> bool {
let is_last = i == count_newlines(orig);
- if let Some(ref ib) = self.item_block {
- if ib.in_block(&line) {
- self.item_block_buffer.push_str(line.trim_start());
- self.item_block_buffer.push('\n');
+ if let Some(ref mut ib) = self.item_block {
+ if ib.add_line(line) {
return false;
}
self.is_prev_line_multi_line = false;
- self.fmt.shape = Shape::legacy(self.max_chars, self.fmt_indent);
+ self.fmt.shape = Shape::legacy(self.max_width, self.fmt_indent);
let item_fmt = ib.create_string_format(&self.fmt);
self.result.push_str(&self.comment_line_separator);
self.result.push_str(&ib.opener);
match rewrite_string(
- &self.item_block_buffer.replace("\n", " "),
+ &ib.trimmed_block_as_string(),
&item_fmt,
- self.max_chars.saturating_sub(ib.indent),
+ self.max_width.saturating_sub(ib.indent),
) {
Some(s) => self.result.push_str(&Self::join_block(
&s,
- &format!("{}{}", &self.comment_line_separator, ib.line_start),
+ &format!("{}{}", self.comment_line_separator, ib.line_start),
)),
None => self.result.push_str(&Self::join_block(
- &self.item_block_buffer,
+ &ib.original_block_as_string(),
&self.comment_line_separator,
)),
};
- self.item_block_buffer.clear();
} else if self.code_block_attr.is_some() {
if line.starts_with("```") {
let code_block = match self.code_block_attr.as_ref().unwrap() {
- CodeBlockAttribute::Ignore | CodeBlockAttribute::Text => {
- trim_custom_comment_prefix(&self.code_block_buffer)
- }
- _ if self.code_block_buffer.is_empty() => String::new(),
- _ => {
+ CodeBlockAttribute::Rust
+ if self.fmt.config.format_code_in_doc_comments()
+ && !self.code_block_buffer.is_empty() =>
+ {
let mut config = self.fmt.config.clone();
config.set().wrap_comments(false);
- match ::format_code_block(&self.code_block_buffer, &config) {
- Some(ref s) => trim_custom_comment_prefix(&s.snippet),
- None => trim_custom_comment_prefix(&self.code_block_buffer),
+ if let Some(s) =
+ crate::format_code_block(&self.code_block_buffer, &config, false)
+ {
+ trim_custom_comment_prefix(&s.snippet)
+ } else {
+ trim_custom_comment_prefix(&self.code_block_buffer)
}
}
+ _ => trim_custom_comment_prefix(&self.code_block_buffer),
};
if !code_block.is_empty() {
self.result.push_str(&self.comment_line_separator);
self.code_block_attr = None;
self.item_block = None;
- if line.starts_with("```") {
- self.code_block_attr = Some(CodeBlockAttribute::new(&line[3..]))
- } else if self.fmt.config.wrap_comments() && ItemizedBlock::is_itemized_line(&line) {
- let ib = ItemizedBlock::new(&line);
- self.item_block_buffer.push_str(&line[ib.indent..]);
- self.item_block_buffer.push('\n');
+ if let Some(stripped) = line.strip_prefix("```") {
+ self.code_block_attr = Some(CodeBlockAttribute::new(stripped))
+ } else if self.fmt.config.wrap_comments() && ItemizedBlock::is_itemized_line(line) {
+ let ib = ItemizedBlock::new(line);
self.item_block = Some(ib);
return false;
}
}
}
- if self.fmt.config.wrap_comments() && line.len() > self.fmt.shape.width && !has_url(line) {
- match rewrite_string(line, &self.fmt, self.max_chars) {
+ if self.fmt.config.wrap_comments()
+ && unicode_str_width(line) > self.fmt.shape.width
+ && !has_url(line)
+ {
+ match rewrite_string(line, &self.fmt, self.max_width) {
Some(ref s) => {
self.is_prev_line_multi_line = s.contains('\n');
self.result.push_str(s);
// Remove the trailing space, then start rewrite on the next line.
self.result.pop();
self.result.push_str(&self.comment_line_separator);
- self.fmt.shape = Shape::legacy(self.max_chars, self.fmt_indent);
- match rewrite_string(line, &self.fmt, self.max_chars) {
+ self.fmt.shape = Shape::legacy(self.max_width, self.fmt_indent);
+ match rewrite_string(line, &self.fmt, self.max_width) {
Some(ref s) => {
self.is_prev_line_multi_line = s.contains('\n');
self.result.push_str(s);
// 1 = " "
let offset = 1 + last_line_width(&self.result) - self.line_start.len();
Shape {
- width: self.max_chars.saturating_sub(offset),
+ width: self.max_width.saturating_sub(offset),
indent: self.fmt_indent,
offset: self.fmt.shape.offset + offset,
}
} else {
- Shape::legacy(self.max_chars, self.fmt_indent)
+ Shape::legacy(self.max_width, self.fmt_indent)
};
} else {
if line.is_empty() && self.result.ends_with(' ') && !is_last {
self.result.pop();
}
self.result.push_str(line);
- self.fmt.shape = Shape::legacy(self.max_chars, self.fmt_indent);
+ self.fmt.shape = Shape::legacy(self.max_width, self.fmt_indent);
self.is_prev_line_multi_line = false;
}
fn rewrite_comment_inner(
orig: &str,
block_style: bool,
- style: CommentStyle,
+ style: CommentStyle<'_>,
shape: Shape,
config: &Config,
is_doc_comment: bool,
const RUSTFMT_CUSTOM_COMMENT_PREFIX: &str = "//#### ";
-fn hide_sharp_behind_comment(s: &str) -> Cow<str> {
- if s.trim_start().starts_with("# ") {
+fn hide_sharp_behind_comment(s: &str) -> Cow<'_, str> {
+ let s_trimmed = s.trim();
+ if s_trimmed.starts_with("# ") || s_trimmed == "#" {
Cow::from(format!("{}{}", RUSTFMT_CUSTOM_COMMENT_PREFIX, s))
} else {
Cow::from(s)
.join("\n")
}
-/// Returns true if the given string MAY include URLs or alike.
+/// Returns `true` if the given string MAY include URLs or alike.
fn has_url(s: &str) -> bool {
// This function may return false positive, but should get its job done in most cases.
- s.contains("https://") || s.contains("http://") || s.contains("ftp://") || s.contains("file://")
+ s.contains("https://")
+ || s.contains("http://")
+ || s.contains("ftp://")
+ || s.contains("file://")
+ || REFERENCE_LINK_URL.is_match(s)
}
/// Given the span, rewrite the missing comment inside it if available.
/// Note that the given span must only include comments (or leading/trailing whitespaces).
-pub fn rewrite_missing_comment(
+pub(crate) fn rewrite_missing_comment(
span: Span,
shape: Shape,
- context: &RewriteContext,
+ context: &RewriteContext<'_>,
) -> Option<String> {
let missing_snippet = context.snippet(span);
let trimmed_snippet = missing_snippet.trim();
- if !trimmed_snippet.is_empty() {
+ // check the span starts with a comment
+ let pos = trimmed_snippet.find('/');
+ if !trimmed_snippet.is_empty() && pos.is_some() {
rewrite_comment(trimmed_snippet, false, shape, context.config)
} else {
Some(String::new())
/// Recover the missing comments in the specified span, if available.
/// The layout of the comments will be preserved as long as it does not break the code
/// and its total width does not exceed the max width.
-pub fn recover_missing_comment_in_span(
+pub(crate) fn recover_missing_comment_in_span(
span: Span,
shape: Shape,
- context: &RewriteContext,
+ context: &RewriteContext<'_>,
used_width: usize,
) -> Option<String> {
let missing_comment = rewrite_missing_comment(span, shape, context)?;
Some(String::new())
} else {
let missing_snippet = context.snippet(span);
- let pos = missing_snippet.find('/').unwrap_or(0);
+ let pos = missing_snippet.find('/')?;
// 1 = ` `
let total_width = missing_comment.len() + used_width + 1;
let force_new_line_before_comment =
/// Trims comment characters and possibly a single space from the left of a string.
/// Does not trim all whitespace. If a single space is trimmed from the left of the string,
/// this function returns true.
-fn left_trim_comment_line<'a>(line: &'a str, style: &CommentStyle) -> (&'a str, bool) {
+fn left_trim_comment_line<'a>(line: &'a str, style: &CommentStyle<'_>) -> (&'a str, bool) {
if line.starts_with("//! ")
|| line.starts_with("/// ")
|| line.starts_with("/*! ")
{
(&line[4..], true)
} else if let CommentStyle::Custom(opener) = *style {
- if line.starts_with(opener) {
- (&line[opener.len()..], true)
+ if let Some(stripped) = line.strip_prefix(opener) {
+ (stripped, true)
} else {
(&line[opener.trim_end().len()..], false)
}
|| line.starts_with("**")
{
(&line[2..], line.chars().nth(1).unwrap() == ' ')
- } else if line.starts_with('*') {
- (&line[1..], false)
+ } else if let Some(stripped) = line.strip_prefix('*') {
+ (stripped, false)
} else {
(line, line.starts_with(' '))
}
}
-pub trait FindUncommented {
+pub(crate) trait FindUncommented {
fn find_uncommented(&self, pat: &str) -> Option<usize>;
+ fn find_last_uncommented(&self, pat: &str) -> Option<usize>;
}
impl FindUncommented for str {
None => Some(self.len() - pat.len()),
}
}
+
+ fn find_last_uncommented(&self, pat: &str) -> Option<usize> {
+ if let Some(left) = self.find_uncommented(pat) {
+ let mut result = left;
+ // add 1 to use find_last_uncommented for &str after pat
+ while let Some(next) = self[(result + 1)..].find_last_uncommented(pat) {
+ result += next + 1;
+ }
+ Some(result)
+ } else {
+ None
+ }
+ }
}
// Returns the first byte position after the first comment. The given string
// is expected to be prefixed by a comment, including delimiters.
-// Good: "/* /* inner */ outer */ code();"
-// Bad: "code(); // hello\n world!"
-pub fn find_comment_end(s: &str) -> Option<usize> {
+// Good: `/* /* inner */ outer */ code();`
+// Bad: `code(); // hello\n world!`
+pub(crate) fn find_comment_end(s: &str) -> Option<usize> {
let mut iter = CharClasses::new(s.char_indices());
for (kind, (i, _c)) in &mut iter {
if kind == FullCodeCharKind::Normal || kind == FullCodeCharKind::InString {
}
}
- // Handle case where the comment ends at the end of s.
+ // Handle case where the comment ends at the end of `s`.
if iter.status == CharClassesStatus::Normal {
Some(s.len())
} else {
}
}
-/// Returns true if text contains any comment.
-pub fn contains_comment(text: &str) -> bool {
+/// Returns `true` if text contains any comment.
+pub(crate) fn contains_comment(text: &str) -> bool {
CharClasses::new(text.chars()).any(|(kind, _)| kind.is_comment())
}
-pub struct CharClasses<T>
+pub(crate) struct CharClasses<T>
where
T: Iterator,
T::Item: RichChar,
status: CharClassesStatus,
}
-pub trait RichChar {
+pub(crate) trait RichChar {
fn get_char(&self) -> char;
}
/// Distinguish between functional part of code and comments
#[derive(PartialEq, Eq, Debug, Clone, Copy)]
-pub enum CodeCharKind {
+pub(crate) enum CodeCharKind {
Normal,
Comment,
}
/// describing opening and closing of comments for ease when chunking
/// code from tagged characters
#[derive(PartialEq, Eq, Debug, Clone, Copy)]
-pub enum FullCodeCharKind {
+pub(crate) enum FullCodeCharKind {
Normal,
/// The first character of a comment, there is only one for a comment (always '/')
StartComment,
}
impl FullCodeCharKind {
- pub fn is_comment(self) -> bool {
+ pub(crate) fn is_comment(self) -> bool {
match self {
FullCodeCharKind::StartComment
| FullCodeCharKind::InComment
}
/// Returns true if the character is inside a comment
- pub fn inside_comment(self) -> bool {
+ pub(crate) fn inside_comment(self) -> bool {
match self {
FullCodeCharKind::InComment
| FullCodeCharKind::StartStringCommented
}
}
- pub fn is_string(self) -> bool {
+ pub(crate) fn is_string(self) -> bool {
self == FullCodeCharKind::InString || self == FullCodeCharKind::StartString
}
/// Returns true if the character is within a commented string
- pub fn is_commented_string(self) -> bool {
+ pub(crate) fn is_commented_string(self) -> bool {
self == FullCodeCharKind::InStringCommented
|| self == FullCodeCharKind::StartStringCommented
}
T: Iterator,
T::Item: RichChar,
{
- pub fn new(base: T) -> CharClasses<T> {
+ pub(crate) fn new(base: T) -> CharClasses<T> {
CharClasses {
base: multipeek(base),
status: CharClassesStatus::Normal,
},
CharClassesStatus::LitCharEscape => CharClassesStatus::LitChar,
CharClassesStatus::Normal => match chr {
- 'r' => match self.base.peek().map(|c| c.get_char()) {
+ 'r' => match self.base.peek().map(RichChar::get_char) {
Some('#') | Some('"') => {
char_kind = FullCodeCharKind::InString;
CharClassesStatus::RawStringPrefix(0)
char_kind = FullCodeCharKind::InStringCommented;
if chr == '"' {
CharClassesStatus::BlockComment(deepness)
+ } else if chr == '*' && self.base.peek().map(RichChar::get_char) == Some('/') {
+ char_kind = FullCodeCharKind::InComment;
+ CharClassesStatus::BlockCommentClosing(deepness - 1)
} else {
CharClassesStatus::StringInBlockComment(deepness)
}
/// An iterator over the lines of a string, paired with the char kind at the
/// end of the line.
-pub struct LineClasses<'a> {
+pub(crate) struct LineClasses<'a> {
base: iter::Peekable<CharClasses<std::str::Chars<'a>>>,
kind: FullCodeCharKind,
}
impl<'a> LineClasses<'a> {
- pub fn new(s: &'a str) -> Self {
+ pub(crate) fn new(s: &'a str) -> Self {
LineClasses {
base: CharClasses::new(s.chars()).peekable(),
kind: FullCodeCharKind::Normal,
None => unreachable!(),
};
- while let Some((kind, c)) = self.base.next() {
+ for (kind, c) in self.base.by_ref() {
// needed to set the kind of the ending character on the last line
self.kind = kind;
if c == '\n' {
/// Iterator over an alternating sequence of functional and commented parts of
/// a string. The first item is always a, possibly zero length, subslice of
/// functional text. Line style comments contain their ending newlines.
-pub struct CommentCodeSlices<'a> {
+pub(crate) struct CommentCodeSlices<'a> {
slice: &'a str,
last_slice_kind: CodeCharKind,
last_slice_end: usize,
}
impl<'a> CommentCodeSlices<'a> {
- pub fn new(slice: &'a str) -> CommentCodeSlices<'a> {
+ pub(crate) fn new(slice: &'a str) -> CommentCodeSlices<'a> {
CommentCodeSlices {
slice,
last_slice_kind: CodeCharKind::Comment,
}
/// Checks is `new` didn't miss any comment from `span`, if it removed any, return previous text
-/// (if it fits in the width/offset, else return None), else return `new`
-pub fn recover_comment_removed(
+/// (if it fits in the width/offset, else return `None`), else return `new`
+pub(crate) fn recover_comment_removed(
new: String,
span: Span,
- context: &RewriteContext,
+ context: &RewriteContext<'_>,
) -> Option<String> {
let snippet = context.snippet(span);
if snippet != new && changed_comment_content(snippet, &new) {
// We missed some comments. Warn and keep the original text.
if context.config.error_on_unformatted() {
context.report.append(
- context.source_map.span_to_filename(span).into(),
+ context.parse_sess.span_to_filename(span),
vec![FormattingError::from_span(
span,
- &context.source_map,
+ context.parse_sess,
ErrorKind::LostComment,
)],
);
}
}
-pub fn filter_normal_code(code: &str) -> String {
+pub(crate) fn filter_normal_code(code: &str) -> String {
let mut buffer = String::with_capacity(code.len());
LineClasses::new(code).for_each(|(kind, line)| match kind {
FullCodeCharKind::Normal
buffer
}
-/// Return true if the two strings of code have the same payload of comments.
+/// Returns `true` if the two strings of code have the same payload of comments.
/// The payload of comments is everything in the string except:
-/// - actual code (not comments)
-/// - comment start/end marks
-/// - whitespace
-/// - '*' at the beginning of lines in block comments
+/// - actual code (not comments),
+/// - comment start/end marks,
+/// - whitespace,
+/// - '*' at the beginning of lines in block comments.
fn changed_comment_content(orig: &str, new: &str) -> bool {
- // Cannot write this as a fn since we cannot return types containing closures
+ // Cannot write this as a fn since we cannot return types containing closures.
let code_comment_content = |code| {
let slices = UngroupedCommentCodeSlices::new(code);
slices
let comment = remove_comment_header(comment);
CommentReducer {
is_block,
- at_start_line: false, // There are no supplementary '*' on the first line
+ // There are no supplementary '*' on the first line.
+ at_start_line: false,
iter: comment.chars(),
}
}
while c.is_whitespace() {
c = self.iter.next()?;
}
- // Ignore leading '*'
+ // Ignore leading '*'.
if c == '*' {
c = self.iter.next()?;
}
fn remove_comment_header(comment: &str) -> &str {
if comment.starts_with("///") || comment.starts_with("//!") {
&comment[3..]
- } else if comment.starts_with("//") {
- &comment[2..]
+ } else if let Some(stripped) = comment.strip_prefix("//") {
+ stripped
} else if (comment.starts_with("/**") && !comment.starts_with("/**/"))
|| comment.starts_with("/*!")
{
} else {
assert!(
comment.starts_with("/*"),
- format!("string '{}' is not a comment", comment)
+ "string '{}' is not a comment",
+ comment
);
&comment[2..comment.len() - 2]
}
#[cfg(test)]
mod test {
use super::*;
- use shape::{Indent, Shape};
+ use crate::shape::{Indent, Shape};
#[test]
fn char_classes() {
#[test]
#[rustfmt::skip]
fn format_doc_comments() {
- let mut wrap_normalize_config: ::config::Config = Default::default();
+ let mut wrap_normalize_config: crate::config::Config = Default::default();
wrap_normalize_config.set().wrap_comments(true);
wrap_normalize_config.set().normalize_comments(true);
- let mut wrap_config: ::config::Config = Default::default();
+ let mut wrap_config: crate::config::Config = Default::default();
wrap_config.set().wrap_comments(true);
let comment = rewrite_comment(" //test",
&wrap_normalize_config).unwrap();
assert_eq!("/* trimmed */", comment);
- // check that different comment style are properly recognised
+ // Check that different comment style are properly recognised.
let comment = rewrite_comment(r#"/// test1
/// test2
/*
&wrap_normalize_config).unwrap();
assert_eq!("/// test1\n/// test2\n// test3", comment);
- // check that the blank line marks the end of a commented paragraph
+ // Check that the blank line marks the end of a commented paragraph.
let comment = rewrite_comment(r#"// test1
// test2"#,
&wrap_normalize_config).unwrap();
assert_eq!("// test1\n\n// test2", comment);
- // check that the blank line marks the end of a custom-commented paragraph
+ // Check that the blank line marks the end of a custom-commented paragraph.
let comment = rewrite_comment(r#"//@ test1
//@ test2"#,
&wrap_normalize_config).unwrap();
assert_eq!("//@ test1\n\n//@ test2", comment);
- // check that bare lines are just indented but left unchanged otherwise
+ // Check that bare lines are just indented but otherwise left unchanged.
let comment = rewrite_comment(r#"// test1
/*
a bare line!
assert_eq!("// test1\n/*\n a bare line!\n\n another bare line!\n*/", comment);
}
- // This is probably intended to be a non-test fn, but it is not used. I'm
- // keeping it around unless it helps us test stuff.
+ // This is probably intended to be a non-test fn, but it is not used.
+ // We should keep this around unless it helps us test stuff to remove it.
fn uncommented(text: &str) -> String {
CharClasses::new(text.chars())
.filter_map(|(s, c)| match s {
projects / rust.git / blobdiff