mirror of
https://github.com/rust-lang/rust.git
synced 2025-01-24 05:33:41 +00:00
The method trim_left_preserve_layout didn't handle tabs properly.
This is fixed by taking the method macros::indent_macro_snippet which essentially does the same: it indents a paragraph while preserving the layout.
This commit is contained in:
Stéphane Campinas
parent
b2706ebecc
commit
2d718a3fc2
@ -332,7 +332,7 @@ fn identify_comment(
|
||||
let (first_group, rest) = orig.split_at(first_group_ending);
|
||||
let rewritten_first_group =
|
||||
if !config.normalize_comments() && has_bare_lines && style.is_block_comment() {
|
||||
trim_left_preserve_layout(first_group, &shape.indent, config)
|
||||
trim_left_preserve_layout(first_group, &shape.indent, config)?
|
||||
} else if !config.normalize_comments()
|
||||
&& !config.wrap_comments()
|
||||
&& !config.format_doc_comments()
|
||||
|
||||
109
src/macros.rs
109
src/macros.rs
@ -40,7 +40,10 @@ use rewrite::{Rewrite, RewriteContext};
|
||||
use shape::{Indent, Shape};
|
||||
use source_map::SpanUtils;
|
||||
use spanned::Spanned;
|
||||
use utils::{format_visibility, mk_sp, remove_trailing_white_spaces, rewrite_ident, wrap_str};
|
||||
use utils::{
|
||||
format_visibility, is_empty_line, mk_sp, remove_trailing_white_spaces, rewrite_ident,
|
||||
trim_left_preserve_layout, wrap_str,
|
||||
};
|
||||
use visitor::FmtVisitor;
|
||||
|
||||
const FORCED_BRACKET_MACROS: &[&str] = &["vec!"];
|
||||
@ -373,7 +376,7 @@ pub fn rewrite_macro_inner(
|
||||
}
|
||||
DelimToken::Brace => {
|
||||
// Skip macro invocations with braces, for now.
|
||||
indent_macro_snippet(context, context.snippet(mac.span), shape.indent)
|
||||
trim_left_preserve_layout(context.snippet(mac.span), &shape.indent, &context.config)
|
||||
}
|
||||
_ => unreachable!(),
|
||||
}
|
||||
@ -1101,108 +1104,6 @@ fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> DelimToken {
|
||||
}
|
||||
}
|
||||
|
||||
/// Indent each line according to the specified `indent`.
|
||||
/// e.g.
|
||||
///
|
||||
/// ```rust,ignore
|
||||
/// foo!{
|
||||
/// x,
|
||||
/// y,
|
||||
/// foo(
|
||||
/// a,
|
||||
/// b,
|
||||
/// c,
|
||||
/// ),
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// will become
|
||||
///
|
||||
/// ```rust,ignore
|
||||
/// foo!{
|
||||
/// x,
|
||||
/// y,
|
||||
/// foo(
|
||||
/// a,
|
||||
/// b,
|
||||
/// c,
|
||||
/// ),
|
||||
/// }
|
||||
/// ```
|
||||
fn indent_macro_snippet(
|
||||
context: &RewriteContext,
|
||||
macro_str: &str,
|
||||
indent: Indent,
|
||||
) -> Option<String> {
|
||||
let mut lines = LineClasses::new(macro_str);
|
||||
let first_line = lines.next().map(|(_, s)| s.trim_right().to_owned())?;
|
||||
let mut trimmed_lines = Vec::with_capacity(16);
|
||||
|
||||
let mut veto_trim = false;
|
||||
let min_prefix_space_width = lines
|
||||
.filter_map(|(kind, line)| {
|
||||
let mut trimmed = true;
|
||||
let prefix_space_width = if is_empty_line(&line) {
|
||||
None
|
||||
} else {
|
||||
Some(get_prefix_space_width(context, &line))
|
||||
};
|
||||
|
||||
let line = if veto_trim || (kind.is_string() && !line.ends_with('\\')) {
|
||||
veto_trim = kind.is_string() && !line.ends_with('\\');
|
||||
trimmed = false;
|
||||
line
|
||||
} else {
|
||||
line.trim().to_owned()
|
||||
};
|
||||
trimmed_lines.push((trimmed, line, prefix_space_width));
|
||||
|
||||
// when computing the minimum, do not consider lines within a string
|
||||
match kind {
|
||||
FullCodeCharKind::InString | FullCodeCharKind::EndString => None,
|
||||
_ => prefix_space_width,
|
||||
}
|
||||
})
|
||||
.min()?;
|
||||
|
||||
Some(
|
||||
first_line
|
||||
+ "\n"
|
||||
+ &trimmed_lines
|
||||
.iter()
|
||||
.map(
|
||||
|&(trimmed, ref line, prefix_space_width)| match prefix_space_width {
|
||||
_ if !trimmed => line.to_owned(),
|
||||
Some(original_indent_width) => {
|
||||
let new_indent_width = indent.width()
|
||||
+ original_indent_width.saturating_sub(min_prefix_space_width);
|
||||
let new_indent = Indent::from_width(context.config, new_indent_width);
|
||||
format!("{}{}", new_indent.to_string(context.config), line)
|
||||
}
|
||||
None => String::new(),
|
||||
},
|
||||
)
|
||||
.collect::<Vec<_>>()
|
||||
.join("\n"),
|
||||
)
|
||||
}
|
||||
|
||||
fn get_prefix_space_width(context: &RewriteContext, s: &str) -> usize {
|
||||
let mut width = 0;
|
||||
for c in s.chars() {
|
||||
match c {
|
||||
' ' => width += 1,
|
||||
'\t' => width += context.config.tab_spaces(),
|
||||
_ => return width,
|
||||
}
|
||||
}
|
||||
width
|
||||
}
|
||||
|
||||
fn is_empty_line(s: &str) -> bool {
|
||||
s.is_empty() || s.chars().all(char::is_whitespace)
|
||||
}
|
||||
|
||||
// A very simple parser that just parses a macros 2.0 definition into its branches.
|
||||
// Currently we do not attempt to parse any further than that.
|
||||
#[derive(new)]
|
||||
|
||||
141
src/utils.rs
141
src/utils.rs
@ -20,7 +20,7 @@ use syntax::ast::{
|
||||
use syntax::ptr;
|
||||
use syntax::source_map::{BytePos, Span, NO_EXPANSION};
|
||||
|
||||
use comment::{filter_normal_code, CharClasses, FullCodeCharKind};
|
||||
use comment::{filter_normal_code, CharClasses, FullCodeCharKind, LineClasses};
|
||||
use config::Config;
|
||||
use rewrite::RewriteContext;
|
||||
use shape::{Indent, Shape};
|
||||
@ -483,46 +483,123 @@ pub fn remove_trailing_white_spaces(text: &str) -> String {
|
||||
buffer
|
||||
}
|
||||
|
||||
/// Trims a minimum of leading whitespaces so that the content layout is kept and aligns to indent.
|
||||
pub fn trim_left_preserve_layout(orig: &str, indent: &Indent, config: &Config) -> String {
|
||||
let prefix_whitespace_min = orig
|
||||
.lines()
|
||||
// skip the line with the starting sigil since the leading whitespace is removed
|
||||
// otherwise, the minimum would always be zero
|
||||
.skip(1)
|
||||
.filter(|line| !line.is_empty())
|
||||
.map(|line| {
|
||||
/// Indent each line according to the specified `indent`.
|
||||
/// e.g.
|
||||
///
|
||||
/// ```rust,ignore
|
||||
/// foo!{
|
||||
/// x,
|
||||
/// y,
|
||||
/// foo(
|
||||
/// a,
|
||||
/// b,
|
||||
/// c,
|
||||
/// ),
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// will become
|
||||
///
|
||||
/// ```rust,ignore
|
||||
/// foo!{
|
||||
/// x,
|
||||
/// y,
|
||||
/// foo(
|
||||
/// a,
|
||||
/// b,
|
||||
/// c,
|
||||
/// ),
|
||||
/// }
|
||||
/// ```
|
||||
pub fn trim_left_preserve_layout(orig: &str, indent: &Indent, config: &Config) -> Option<String> {
|
||||
let mut lines = LineClasses::new(orig);
|
||||
let first_line = lines.next().map(|(_, s)| s.trim_right().to_owned())?;
|
||||
let mut trimmed_lines = Vec::with_capacity(16);
|
||||
|
||||
let mut veto_trim = false;
|
||||
let min_prefix_space_width = lines
|
||||
.filter_map(|(kind, line)| {
|
||||
let mut trimmed = true;
|
||||
let prefix_space_width = if is_empty_line(&line) {
|
||||
None
|
||||
} else {
|
||||
Some(get_prefix_space_width(config, &line))
|
||||
};
|
||||
|
||||
let line = if veto_trim || (kind.is_string() && !line.ends_with('\\')) {
|
||||
veto_trim = kind.is_string() && !line.ends_with('\\');
|
||||
trimmed = false;
|
||||
line
|
||||
} else {
|
||||
line.trim().to_owned()
|
||||
};
|
||||
trimmed_lines.push((trimmed, line, prefix_space_width));
|
||||
|
||||
// When computing the minimum, do not consider lines within a string.
|
||||
// The reason is there is a veto against trimming and indenting such lines
|
||||
match kind {
|
||||
FullCodeCharKind::InString | FullCodeCharKind::EndString => None,
|
||||
_ => prefix_space_width,
|
||||
}
|
||||
})
|
||||
.min()?;
|
||||
|
||||
Some(
|
||||
first_line
|
||||
+ "\n"
|
||||
+ &trimmed_lines
|
||||
.iter()
|
||||
.map(
|
||||
|&(trimmed, ref line, prefix_space_width)| match prefix_space_width {
|
||||
_ if !trimmed => line.to_owned(),
|
||||
Some(original_indent_width) => {
|
||||
let new_indent_width = indent.width()
|
||||
+ original_indent_width.saturating_sub(min_prefix_space_width);
|
||||
let new_indent = Indent::from_width(config, new_indent_width);
|
||||
format!("{}{}", new_indent.to_string(config), line)
|
||||
}
|
||||
None => String::new(),
|
||||
},
|
||||
)
|
||||
.collect::<Vec<_>>()
|
||||
.join("\n"),
|
||||
)
|
||||
}
|
||||
|
||||
pub fn is_empty_line(s: &str) -> bool {
|
||||
s.is_empty() || s.chars().all(char::is_whitespace)
|
||||
}
|
||||
|
||||
fn get_prefix_space_width(config: &Config, s: &str) -> usize {
|
||||
let mut width = 0;
|
||||
for c in line.chars() {
|
||||
for c in s.chars() {
|
||||
match c {
|
||||
' ' => width += 1,
|
||||
'\t' => width += config.tab_spaces(),
|
||||
_ => break,
|
||||
_ => return width,
|
||||
}
|
||||
}
|
||||
width
|
||||
})
|
||||
.min()
|
||||
.unwrap_or(0);
|
||||
|
||||
let indent_str = indent.to_string(config);
|
||||
let mut lines = orig.lines();
|
||||
let first_line = lines.next().unwrap();
|
||||
let rest = lines
|
||||
.map(|line| {
|
||||
if line.is_empty() {
|
||||
String::from("\n")
|
||||
} else {
|
||||
format!("\n{}{}", indent_str, &line[prefix_whitespace_min..])
|
||||
}
|
||||
})
|
||||
.collect::<Vec<String>>()
|
||||
.concat();
|
||||
format!("{}{}", first_line, rest)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_remove_trailing_white_spaces() {
|
||||
#[cfg(test)]
|
||||
mod test {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn test_remove_trailing_white_spaces() {
|
||||
let s = " r#\"\n test\n \"#";
|
||||
assert_eq!(remove_trailing_white_spaces(&s), s);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_trim_left_preserve_layout() {
|
||||
let s = "aaa\n\tbbb\n ccc";
|
||||
let config = Config::default();
|
||||
let indent = Indent::new(4, 0);
|
||||
assert_eq!(
|
||||
trim_left_preserve_layout(&s, &indent, &config),
|
||||
Some("aaa\n bbb\n ccc".to_string())
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
13
tests/source/issue-3132.rs
Normal file
13
tests/source/issue-3132.rs
Normal file
@ -0,0 +1,13 @@
|
||||
fn test() {
|
||||
/*
|
||||
a
|
||||
*/
|
||||
let x = 42;
|
||||
/*
|
||||
aaa
|
||||
"line 1
|
||||
line 2
|
||||
line 3"
|
||||
*/
|
||||
let x = 42;
|
||||
}
|
||||
13
tests/target/issue-3132.rs
Normal file
13
tests/target/issue-3132.rs
Normal file
@ -0,0 +1,13 @@
|
||||
fn test() {
|
||||
/*
|
||||
a
|
||||
*/
|
||||
let x = 42;
|
||||
/*
|
||||
aaa
|
||||
"line 1
|
||||
line 2
|
||||
line 3"
|
||||
*/
|
||||
let x = 42;
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user