nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-02-25 21:34:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into normalize-multiline-doc-attributes

Browse Source
This commit is contained in:
Ruben Schmidmeister 2019-05-18 11:26:03 +02:00
commit 9b98dd774e
No known key found for this signature in database
GPG Key ID: 29387B5A7AAF863F
33 changed files with 200 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.travis.yml
View File

@ -26,12 +26,13 @@ matrix:
- env: INTEGRATION=log
- env: INTEGRATION=mdbook
- env: INTEGRATION=packed_simd
- env: INTEGRATION=rand
- env: INTEGRATION=rust-semverver
- env: INTEGRATION=stdsimd TARGET=x86_64-unknown-linux-gnu
- env: INTEGRATION=tempdir
- env: INTEGRATION=futures-rs
allow_failures:
# Using old configuration option
- env: INTEGRATION=rand
# Doesn't build - keep this in allow_failures as it's fragile to breaking changes of rustc.
- env: INTEGRATION=rust-clippy
# Doesn't build - seems to be because of an option

1
CHANGELOG.md
View File

@ -2,6 +2,7 @@
## [Unreleased]
- Change option `format_doc_comment` to `format_code_in_doc_comment`.
- `use_small_heuristics` changed to be an enum and stabilised. Configuration
options are now ready for 1.0.

4
Configurations.md
View File

@ -1978,9 +1978,9 @@ fn main() {
}
```
## `format_doc_comments`
## `format_code_in_doc_comments`
Format doc comments.
Format code snippet included in doc comments.
- **Default value**: `false`
- **Possible values**: `true`, `false`

14
src/attr.rs
View File

@ -56,12 +56,11 @@ fn is_derive(attr: &ast::Attribute) -> bool {
}
/// Returns the arguments of `#[derive(...)]`.
fn get_derive_spans(attr: &ast::Attribute) -> Option<Vec<Span>> {
fn get_derive_spans<'a>(attr: &'a ast::Attribute) -> Option<impl Iterator<Item = Span> + 'a> {
attr.meta_item_list().map(|meta_item_list| {
meta_item_list
.iter()
.into_iter()
.map(|nested_meta_item| nested_meta_item.span)
.collect()
})
}
@ -412,10 +411,11 @@ impl<'a> Rewrite for [ast::Attribute] {
// Handle derives if we will merge them.
if context.config.merge_derives() && is_derive(&attrs[0]) {
let derives = take_while_with_pred(context, attrs, is_derive);
let mut derive_spans = vec![];
for derive in derives {
derive_spans.append(&mut get_derive_spans(derive)?);
}
let derive_spans: Vec<_> = derives
.iter()
.filter_map(get_derive_spans)
.flatten()
.collect();
let derive_str =
format_derive(&derive_spans, attr_prefix(&attrs[0]), shape, context)?;
result.push_str(&derive_str);

76
src/checkstyle.rs
View File

@ -1,3 +1,4 @@
use std::fmt::{self, Display};
use std::io::{self, Write};
use std::path::Path;
@ -9,9 +10,9 @@ use crate::rustfmt_diff::{DiffLine, Mismatch};
/// future version of Rustfmt.
pub(crate) fn header() -> String {
let mut xml_heading = String::new();
xml_heading.push_str("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
xml_heading.push_str(r#"<?xml version="1.0" encoding="utf-8"?>"#);
xml_heading.push_str("\n");
xml_heading.push_str("<checkstyle version=\"4.3\">");
xml_heading.push_str(r#"<checkstyle version="4.3">"#);
xml_heading
}
@ -31,17 +32,16 @@ pub(crate) fn output_checkstyle_file<T>(
where
T: Write,
{
write!(writer, "<file name=\"{}\">", filename.display())?;
write!(writer, r#"<file name="{}">"#, filename.display())?;
for mismatch in diff {
for line in mismatch.lines {
// Do nothing with `DiffLine::Context` and `DiffLine::Resulting`.
if let DiffLine::Expected(ref str) = line {
let message = xml_escape_str(str);
if let DiffLine::Expected(message) = line {
write!(
writer,
"<error line=\"{}\" severity=\"warning\" message=\"Should be `{}`\" \
/>",
mismatch.line_number, message
r#"<error line="{}" severity="warning" message="Should be `{}`" />"#,
mismatch.line_number,
XmlEscaped(&message)
)?;
}
}
@ -50,19 +50,53 @@ where
Ok(())
}
// Convert special characters into XML entities.
// This is needed for checkstyle output.
fn xml_escape_str(string: &str) -> String {
let mut out = String::new();
for c in string.chars() {
match c {
'<' => out.push_str("&lt;"),
'>' => out.push_str("&gt;"),
'"' => out.push_str("&quot;"),
'\'' => out.push_str("&apos;"),
'&' => out.push_str("&amp;"),
_ => out.push(c),
/// Convert special characters into XML entities.
/// This is needed for checkstyle output.
struct XmlEscaped<'a>(&'a str);
impl<'a> Display for XmlEscaped<'a> {
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
for char in self.0.chars() {
match char {
'<' => write!(formatter, "&lt;"),
'>' => write!(formatter, "&gt;"),
'"' => write!(formatter, "&quot;"),
'\'' => write!(formatter, "&apos;"),
'&' => write!(formatter, "&amp;"),
_ => write!(formatter, "{}", char),
}?;
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn special_characters_are_escaped() {
assert_eq!(
"&lt;&gt;&quot;&apos;&amp;",
format!("{}", XmlEscaped(r#"<>"'&"#)),
);
}
#[test]
fn special_characters_are_escaped_in_string_with_other_characters() {
assert_eq!(
"The quick brown &quot;🦊&quot; jumps &lt;over&gt; the lazy 🐶",
format!(
"{}",
XmlEscaped(r#"The quick brown "🦊" jumps <over> the lazy 🐶"#)
),
);
}
#[test]
fn other_characters_are_not_escaped() {
let string = "The quick brown 🦊 jumps over the lazy 🐶";
assert_eq!(string, format!("{}", XmlEscaped(string)));
}
out
}

15
src/comment.rs
View File

@ -353,7 +353,7 @@ fn identify_comment(
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 {
@ -656,9 +656,16 @@ impl<'a> CommentRewrite<'a> {
_ => {
let mut config = self.fmt.config.clone();
config.set().wrap_comments(false);
match crate::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 config.format_code_in_doc_comments() {
if let Some(s) =
crate::format_code_block(&self.code_block_buffer, &config)
{
trim_custom_comment_prefix(&s.snippet)
} else {
trim_custom_comment_prefix(&self.code_block_buffer)
}
} else {
trim_custom_comment_prefix(&self.code_block_buffer)
}
}
};

18
src/config/config_type.rs
View File

@ -50,22 +50,6 @@ impl ConfigType for IgnoreList {
}
}
/// Checks if we're in a nightly build.
///
/// The environment variable `CFG_RELEASE_CHANNEL` is set during the rustc bootstrap
/// to "stable", "beta", or "nightly" depending on what toolchain is being built.
/// If we are being built as part of the stable or beta toolchains, we want
/// to disable unstable configuration options.
///
/// If we're being built by cargo (e.g., `cargo +nightly install rustfmt-nightly`),
/// `CFG_RELEASE_CHANNEL` is not set. As we only support being built against the
/// nightly compiler when installed from crates.io, default to nightly mode.
macro_rules! is_nightly_channel {
() => {
option_env!("CFG_RELEASE_CHANNEL").map_or(true, |c| c == "nightly" || c == "dev")
};
}
macro_rules! create_config {
($($i:ident: $ty:ty, $def:expr, $stb:expr, $( $dstring:expr ),+ );+ $(;)*) => (
#[cfg(test)]
@ -159,7 +143,7 @@ macro_rules! create_config {
self.$i.1 = true;
self.$i.2 = val;
} else {
if is_nightly_channel!() {
if crate::is_nightly_channel!() {
self.$i.1 = true;
self.$i.2 = val;
} else {

2
src/config/mod.rs
View File

@ -40,7 +40,7 @@ create_config! {
// Comments. macros, and strings
wrap_comments: bool, false, false, "Break comments to fit on the line";
format_doc_comments: bool, false, false, "Format doc comments.";
format_code_in_doc_comments: bool, false, false, "Format the code snippet in doc comments.";
comment_width: usize, 80, false,
"Maximum length of comments. No effect unless wrap_comments = true";
normalize_comments: bool, false, false, "Convert /* */ comments to // comments where possible";

25
src/formatting.rs
View File

@ -458,8 +458,7 @@ struct FormatLines<'a> {
errors: Vec<FormattingError>,
issue_seeker: BadIssueSeeker,
line_buffer: String,
// `true` if the current line contains a string literal.
is_string: bool,
current_line_contains_string_literal: bool,
format_line: bool,
allow_issue_seek: bool,
config: &'a Config,
@ -483,7 +482,7 @@ impl<'a> FormatLines<'a> {
allow_issue_seek: !issue_seeker.is_disabled(),
issue_seeker,
line_buffer: String::with_capacity(config.max_width() * 2),
is_string: false,
current_line_contains_string_literal: false,
format_line: config.file_lines().contains_line(name, 1),
config,
}
@ -547,7 +546,7 @@ impl<'a> FormatLines<'a> {
&& !self.is_skipped_line()
&& self.should_report_error(kind, &error_kind)
{
let is_string = self.is_string;
let is_string = self.current_line_contains_string_literal;
self.push_err(error_kind, kind.is_comment(), is_string);
}
}
@ -561,7 +560,7 @@ impl<'a> FormatLines<'a> {
self.newline_count += 1;
self.last_was_space = false;
self.line_buffer.clear();
self.is_string = false;
self.current_line_contains_string_literal = false;
}
fn char(&mut self, c: char, kind: FullCodeCharKind) {
@ -574,7 +573,7 @@ impl<'a> FormatLines<'a> {
self.last_was_space = c.is_whitespace();
self.line_buffer.push(c);
if kind.is_string() {
self.is_string = true;
self.current_line_contains_string_literal = true;
}
}
@ -589,12 +588,14 @@ impl<'a> FormatLines<'a> {
}
fn should_report_error(&self, char_kind: FullCodeCharKind, error_kind: &ErrorKind) -> bool {
let allow_error_report =
if char_kind.is_comment() || self.is_string || error_kind.is_comment() {
self.config.error_on_unformatted()
} else {
true
};
let allow_error_report = if char_kind.is_comment()
|| self.current_line_contains_string_literal
|| error_kind.is_comment()
{
self.config.error_on_unformatted()
} else {
true
};
match error_kind {
ErrorKind::LineOverflow(..) => {

3
src/items.rs
View File

@ -664,7 +664,6 @@ pub(crate) fn format_impl(
context: &RewriteContext<'_>,
item: &ast::Item,
offset: Indent,
where_span_end: Option<BytePos>,
) -> Option<String> {
if let ast::ItemKind::Impl(_, _, _, ref generics, _, ref self_ty, ref items) = item.node {
let mut result = String::with_capacity(128);
@ -691,6 +690,8 @@ pub(crate) fn format_impl(
option.compress_where();
}
let misssing_span = mk_sp(self_ty.span.hi(), item.span.hi());
let where_span_end = context.snippet_provider.opt_span_before(misssing_span, "{");
let where_clause_str = rewrite_where_clause(
context,
&generics.where_clause,

3
src/lib.rs
View File

@ -40,6 +40,9 @@ pub use crate::rustfmt_diff::{ModifiedChunk, ModifiedLines};
#[macro_use]
mod utils;
#[macro_use]
mod release_channel;
mod attr;
mod chains;
pub(crate) mod checkstyle;

16
src/release_channel.rs Normal file
View File

@ -0,0 +1,16 @@
/// Checks if we're in a nightly build.
///
/// The environment variable `CFG_RELEASE_CHANNEL` is set during the rustc bootstrap
/// to "stable", "beta", or "nightly" depending on what toolchain is being built.
/// If we are being built as part of the stable or beta toolchains, we want
/// to disable unstable configuration options.
///
/// If we're being built by cargo (e.g., `cargo +nightly install rustfmt-nightly`),
/// `CFG_RELEASE_CHANNEL` is not set. As we only support being built against the
/// nightly compiler when installed from crates.io, default to nightly mode.
#[macro_export]
macro_rules! is_nightly_channel {
() => {
option_env!("CFG_RELEASE_CHANNEL").map_or(true, |c| c == "nightly" || c == "dev")
};
}

12
src/test/mod.rs
View File

@ -11,6 +11,7 @@ use std::thread;
use crate::config::{Color, Config, EmitMode, FileName, NewlineStyle, ReportTactic};
use crate::formatting::{ReportedErrors, SourceFile};
use crate::is_nightly_channel;
use crate::rustfmt_diff::{make_diff, print_diff, DiffLine, Mismatch, ModifiedChunk, OutputWriter};
use crate::source_file;
use crate::{FormatReport, FormatReportFormatterBuilder, Input, Session};
@ -260,7 +261,7 @@ fn assert_output(source: &Path, expected_filename: &Path) {
fn idempotence_tests() {
run_test_with(&TestSetting::default(), || {
// these tests require nightly
if !is_nightly() {
if !is_nightly_channel!() {
return;
}
// Get all files in the tests/target directory.
@ -278,7 +279,7 @@ fn idempotence_tests() {
#[test]
fn self_tests() {
// Issue-3443: these tests require nightly
if !is_nightly() {
if !is_nightly_channel!() {
return;
}
let mut files = get_test_files(Path::new("tests"), false);
@ -313,11 +314,6 @@ fn self_tests() {
);
}
fn is_nightly() -> bool {
let release_channel = option_env!("CFG_RELEASE_CHANNEL");
release_channel.is_none() || release_channel == Some("nightly")
}
#[test]
fn stdin_formatting_smoke_test() {
let input = Input::Text("fn main () {}".to_owned());
@ -432,7 +428,7 @@ fn check_files(files: Vec<PathBuf>, opt_config: &Option<PathBuf>) -> (Vec<Format
for file_name in files {
let sig_comments = read_significant_comments(&file_name);
if sig_comments.contains_key("unstable") && !is_nightly() {
if sig_comments.contains_key("unstable") && !is_nightly_channel!() {
debug!(
"Skipping '{}' because it requires unstable \
features which are only available on nightly...",

9
src/visitor.rs
View File

@ -5,7 +5,7 @@ use syntax::source_map::{self, BytePos, Pos, SourceMap, Span};
use syntax::{ast, visit};
use crate::attr::*;
use crate::comment::{CodeCharKind, CommentCodeSlices, FindUncommented};
use crate::comment::{CodeCharKind, CommentCodeSlices};
use crate::config::file_lines::FileName;
use crate::config::{BraceStyle, Config, Version};
use crate::expr::{format_expr, ExprType};
@ -359,13 +359,8 @@ impl<'b, 'a: 'b> FmtVisitor<'a> {
match item.node {
ast::ItemKind::Use(ref tree) => self.format_import(item, tree),
ast::ItemKind::Impl(..) => {
let snippet = self.snippet(item.span);
let where_span_end = snippet
.find_uncommented("{")
.map(|x| BytePos(x as u32) + source!(self, item.span).lo());
let block_indent = self.block_indent;
let rw = self
.with_context(|ctx| format_impl(&ctx, item, block_indent, where_span_end));
let rw = self.with_context(|ctx| format_impl(&ctx, item, block_indent));
self.push_rewrite(item.span, rw);
}
ast::ItemKind::Trait(..) => {

2
tests/source/doc-comment-with-example.rs
View File

@ -1,4 +1,4 @@
// rustfmt-format_doc_comments: true
// rustfmt-format_code_in_doc_comments: true
/// Foo
///

2
tests/source/invalid-rust-code-in-doc-comment.rs
View File

@ -1,4 +1,4 @@
// rustfmt-format_doc_comments: true
// rustfmt-format_code_in_doc_comments: true
/// ```rust
/// if (true) { … }

1
tests/source/issue-2520.rs
View File

@ -1,4 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
//! ```rust
//! println!( "hello, world" );

1
tests/source/issue-2523.rs
View File

@ -1,4 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
// Do not unindent macro calls in comment with unformattable syntax.
//! ```rust

1
tests/source/issue-3055/original.rs
View File

@ -1,4 +1,5 @@
// rustfmt-wrap_comments: true
// rustfmt-format_code_in_doc_comments: true
/// Vestibulum elit nibh, rhoncus non, euismod sit amet, pretium eu, enim. Nunc commodo ultricies dui.
///

1
tests/source/itemized-blocks/no_wrap.rs
View File

@ -1,4 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
//! This is a list:
//! * Outer

1
tests/source/itemized-blocks/wrap.rs
View File

@ -1,4 +1,5 @@
// rustfmt-wrap_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-max_width: 50
//! This is a list:

15
tests/source/normalize_doc_attributes_should_not_imply_format_doc_comments.rs Normal file
View File

@ -0,0 +1,15 @@
// rustfmt-normalize_doc_attributes: true
/// Foo
///
/// # Example
/// ```
/// # #![cfg_attr(not(dox), feature(cfg_target_feature, target_feature, stdsimd))]
/// # #![cfg_attr(not(dox), no_std)]
/// fn foo() { }
/// ```
///
fn foo() {}
#[doc = "Bar documents"]
fn bar() {}

16
tests/source/wrap_comments_should_not_imply_format_doc_comments.rs Normal file
View File

@ -0,0 +1,16 @@
// rustfmt-wrap_comments: true
/// Foo
///
/// # Example
/// ```
/// # #![cfg_attr(not(dox), feature(cfg_target_feature, target_feature, stdsimd))]
/// # #![cfg_attr(not(dox), no_std)]
/// fn foo() { }
/// ```
///
fn foo() {}
/// A long commment for wrapping
/// This is a long long long long long long long long long long long long long long long long long long long long sentence.
fn bar() {}

2
tests/target/doc-comment-with-example.rs
View File

@ -1,4 +1,4 @@
// rustfmt-format_doc_comments: true
// rustfmt-format_code_in_doc_comments: true
/// Foo
///

2
tests/target/invalid-rust-code-in-doc-comment.rs
View File

@ -1,4 +1,4 @@
// rustfmt-format_doc_comments: true
// rustfmt-format_code_in_doc_comments: true
/// ```rust
/// if (true) { … }

1
tests/target/issue-2520.rs
View File

@ -1,4 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
//! ```rust
//! println!("hello, world");

1
tests/target/issue-2523.rs
View File

@ -1,4 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
// Do not unindent macro calls in comment with unformattable syntax.
//! ```rust

1
tests/target/issue-3055/original.rs
View File

@ -1,4 +1,5 @@
// rustfmt-wrap_comments: true
// rustfmt-format_code_in_doc_comments: true
/// Vestibulum elit nibh, rhoncus non, euismod sit amet, pretium eu, enim. Nunc
/// commodo ultricies dui.

4
tests/target/issue-3554.rs Normal file
View File

@ -0,0 +1,4 @@
#![feature(const_generics)]
pub struct S<const N: usize>;
impl S<{ 0 }> {}

1
tests/target/itemized-blocks/no_wrap.rs
View File

@ -1,4 +1,5 @@
// rustfmt-normalize_comments: true
// rustfmt-format_code_in_doc_comments: true
//! This is a list:
//! * Outer

1
tests/target/itemized-blocks/wrap.rs
View File

@ -1,4 +1,5 @@
// rustfmt-wrap_comments: true
// rustfmt-format_code_in_doc_comments: true
// rustfmt-max_width: 50
//! This is a list:

15
tests/target/normalize_doc_attributes_should_not_imply_format_doc_comments.rs Normal file
View File

@ -0,0 +1,15 @@
// rustfmt-normalize_doc_attributes: true
/// Foo
///
/// # Example
/// ```
/// # #![cfg_attr(not(dox), feature(cfg_target_feature, target_feature, stdsimd))]
/// # #![cfg_attr(not(dox), no_std)]
/// fn foo() { }
/// ```
///
fn foo() {}
///Bar documents
fn bar() {}

16
tests/target/wrap_comments_should_not_imply_format_doc_comments.rs Normal file
View File

@ -0,0 +1,16 @@
// rustfmt-wrap_comments: true
/// Foo
///
/// # Example
/// ```
/// # #![cfg_attr(not(dox), feature(cfg_target_feature, target_feature, stdsimd))]
/// # #![cfg_attr(not(dox), no_std)]
/// fn foo() { }
/// ```
fn foo() {}
/// A long commment for wrapping
/// This is a long long long long long long long long long long long long long
/// long long long long long long long sentence.
fn bar() {}