Skip to content

Commit

Permalink
Remove suggestions for macro expansions, only use first line of span
Browse files Browse the repository at this point in the history
  • Loading branch information
@Serial-ATA
Serial-ATA committed Oct 6, 2021
1 parent 89a2a3b commit b450d0d
Show file tree
Hide file tree
Showing 3 changed files with 110 additions and 104 deletions.
1 change: 1 addition & 0 deletions clippy_lints/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,7 @@ mod transmute;
mod transmuting_null;
mod try_err;
mod types;
mod undocumented_unsafe_blocks;
mod undropped_manually_drops;
mod unicode;
mod unit_return_expecting_ord;
Expand Down
189 changes: 103 additions & 86 deletions clippy_lints/src/undocumented_unsafe_blocks.rs
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
use clippy_utils::diagnostics::span_lint_and_sugg;
use clippy_utils::source::{snippet, indent_of, reindent_multiline};
use clippy_utils::diagnostics::{span_lint_and_help, span_lint_and_sugg};
use clippy_utils::source::{indent_of, reindent_multiline, snippet};
use clippy_utils::{in_macro, is_lint_allowed};
use rustc_errors::Applicability;
use rustc_hir::intravisit::{walk_expr, NestedVisitorMap, Visitor};
use rustc_hir::{Block, BlockCheckMode, Expr, ExprKind, HirId, Local, UnsafeSource};
use rustc_lexer::TokenKind;
use rustc_middle::hir::map::Map;
use rustc_lint::{LateContext, LateLintPass};
use rustc_middle::hir::map::Map;
use rustc_middle::lint::in_external_macro;
use rustc_middle::ty::TyCtxt;
use rustc_session::{impl_lint_pass, declare_tool_lint};
use rustc_session::{declare_tool_lint, impl_lint_pass};
use rustc_span::{BytePos, Span};
use std::borrow::Cow;
use clippy_utils::{is_lint_allowed, in_macro};
use rustc_hir::intravisit::{NestedVisitorMap, Visitor, walk_expr};

declare_clippy_lint! {
/// ### What it does
Expand Down Expand Up @@ -53,6 +53,10 @@ pub struct UndocumentedUnsafeBlocks {
// The local was already checked for an overall safety comment
// There is no need to continue checking the blocks in the local
pub local_checked: bool,
// Since we can only check the blocks from expanded macros
// We have to omit the suggestion due to the actual definition
// Not being available to us
pub macro_expansion: bool,
}

impl LateLintPass<'_> for UndocumentedUnsafeBlocks {
Expand All @@ -63,22 +67,22 @@ impl LateLintPass<'_> for UndocumentedUnsafeBlocks {
if !in_external_macro(cx.tcx.sess, block.span);
if let BlockCheckMode::UnsafeBlock(UnsafeSource::UserProvided) = block.rules;
if let Some(enclosing_scope_hir_id) = cx.tcx.hir().get_enclosing_scope(block.hir_id);
if block_has_safety_comment(cx.tcx, enclosing_scope_hir_id, block.span) == Some(false);
if self.block_has_safety_comment(cx.tcx, enclosing_scope_hir_id, block.span) == Some(false);
then {
let mut span = block.span;

if let Some(local_span) = self.local_span {
span = local_span;

let result = block_has_safety_comment(cx.tcx, enclosing_scope_hir_id, span);
let result = self.block_has_safety_comment(cx.tcx, enclosing_scope_hir_id, span);

if result.unwrap_or(true) {
self.local_checked = true;
return;
}
}

lint(cx, span);
self.lint(cx, span);
}
}
}
Expand Down Expand Up @@ -118,91 +122,104 @@ impl<'hir> Visitor<'hir> for UndocumentedUnsafeBlocks {
fn visit_expr(&mut self, ex: &'v Expr<'v>) {
match ex.kind {
ExprKind::Block(_, _) => self.local_level = self.local_level.saturating_add(1),
_ => walk_expr(self, ex)
_ => walk_expr(self, ex),
}
}
}

fn lint(cx: &LateContext<'_>, span: Span) {
let block_indent = indent_of(cx, span);
let suggestion = format!("// Safety: ...\n{}", snippet(cx, span, ".."));

span_lint_and_sugg(
cx,
UNDOCUMENTED_UNSAFE_BLOCKS,
span,
"unsafe block missing a safety comment",
"consider adding a safety comment",
reindent_multiline(Cow::Borrowed(&suggestion), true, block_indent).to_string(),
Applicability::HasPlaceholders,
);
}

fn block_has_safety_comment(
tcx: TyCtxt<'_>,
enclosing_hir_id: HirId,
block_span: Span,
) -> Option<bool> {
let map = tcx.hir();
let source_map = tcx.sess.source_map();

let enclosing_scope_span = map.opt_span(enclosing_hir_id)?;

let between_span = if in_macro(block_span) {
enclosing_scope_span.with_hi(block_span.hi())
} else {
enclosing_scope_span.to(block_span)
};

let file_name = source_map.span_to_filename(between_span);
let source_file = source_map.get_source_file(&file_name)?;

let lex_start = (between_span.lo().0 + 1) as usize;
let src_str = source_file.src.as_ref()?[lex_start..between_span.hi().0 as usize].to_string();

let mut pos = 0;
let mut comment = false;

for token in rustc_lexer::tokenize(&src_str) {
match token.kind {
TokenKind::LineComment { doc_style: None }
| TokenKind::BlockComment {
doc_style: None,
terminated: true,
} => {
let comment_str = src_str[pos + 2..pos + token.len].to_ascii_uppercase();

if comment_str.contains("SAFETY:") {
comment = true;
}
}
// We need to add all whitespace to `pos` before checking the comment's line number
TokenKind::Whitespace => {}
_ => {
if comment {
// Get the line number of the "comment" (really wherever the trailing whitespace ended)
let comment_line_num = source_file
.lookup_file_pos_with_col_display(BytePos(
(lex_start + pos).try_into().unwrap(),
))
.0;
// Find the block/local's line number
let block_line_num =
tcx.sess.source_map().lookup_char_pos(block_span.lo()).line;

// Check the comment is immediately followed by the block/local
if block_line_num == comment_line_num + 1 || block_line_num == comment_line_num
{
return Some(true);
impl UndocumentedUnsafeBlocks {
fn block_has_safety_comment(&mut self, tcx: TyCtxt<'_>, enclosing_hir_id: HirId, block_span: Span) -> Option<bool> {
let map = tcx.hir();
let source_map = tcx.sess.source_map();

let enclosing_scope_span = map.opt_span(enclosing_hir_id)?;

let between_span = if in_macro(block_span) {
self.macro_expansion = true;
enclosing_scope_span.with_hi(block_span.hi())
} else {
self.macro_expansion = false;
enclosing_scope_span.to(block_span)
};

let file_name = source_map.span_to_filename(between_span);
let source_file = source_map.get_source_file(&file_name)?;

let lex_start = (between_span.lo().0 + 1) as usize;
let src_str = source_file.src.as_ref()?[lex_start..between_span.hi().0 as usize].to_string();

let mut pos = 0;
let mut comment = false;

for token in rustc_lexer::tokenize(&src_str) {
match token.kind {
TokenKind::LineComment { doc_style: None }
| TokenKind::BlockComment {
doc_style: None,
terminated: true,
} => {
let comment_str = src_str[pos + 2..pos + token.len].to_ascii_uppercase();

if comment_str.contains("SAFETY:") {
comment = true;
}

comment = false;
}
},
// We need to add all whitespace to `pos` before checking the comment's line number
TokenKind::Whitespace => {},
_ => {
if comment {
// Get the line number of the "comment" (really wherever the trailing whitespace ended)
let comment_line_num = source_file
.lookup_file_pos_with_col_display(BytePos((lex_start + pos).try_into().unwrap()))
.0;
// Find the block/local's line number
let block_line_num = tcx.sess.source_map().lookup_char_pos(block_span.lo()).line;

// Check the comment is immediately followed by the block/local
if block_line_num == comment_line_num + 1 || block_line_num == comment_line_num {
return Some(true);
}

comment = false;
}
},
}

pos += token.len;
}

pos += token.len;
Some(false)
}

Some(false)
fn lint(&self, cx: &LateContext<'_>, mut span: Span) {
let source_map = cx.tcx.sess.source_map();

if source_map.is_multiline(span) {
span = source_map.span_until_char(span, '\n');
}

if self.macro_expansion {
span_lint_and_help(
cx,
UNDOCUMENTED_UNSAFE_BLOCKS,
span,
"unsafe block in macro expansion missing a safety comment",
None,
"consider adding a safety comment in the macro definition",
);
} else {
let block_indent = indent_of(cx, span);
let suggestion = format!("// Safety: ...\n{}", snippet(cx, span, ".."));

span_lint_and_sugg(
cx,
UNDOCUMENTED_UNSAFE_BLOCKS,
span,
"unsafe block missing a safety comment",
"consider adding a safety comment",
reindent_multiline(Cow::Borrowed(&suggestion), true, block_indent).to_string(),
Applicability::HasPlaceholders,
);
}
}
}
24 changes: 6 additions & 18 deletions tests/ui/undocumented_unsafe_blocks.stderr
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,13 @@ LL + let _ = *unsafe { &42 };
error: unsafe block missing a safety comment
--> $DIR/undocumented_unsafe_blocks.rs:232:5
|
LL | / let _ = match unsafe {} {
LL | | _ => {},
LL | | };
| |______^
LL | let _ = match unsafe {} {
| ^^^^^^^^^^^^^^^^^^^^^^^^^
|
help: consider adding a safety comment
|
LL ~ // Safety: ...
LL + let _ = match unsafe {} {
LL + _ => {},
LL + };
|

error: unsafe block missing a safety comment
Expand Down Expand Up @@ -111,7 +107,7 @@ LL ~ t!(// Safety: ...
LL ~ unsafe {});
|

error: unsafe block missing a safety comment
error: unsafe block in macro expansion missing a safety comment
--> $DIR/undocumented_unsafe_blocks.rs:262:13
|
LL | unsafe {}
Expand All @@ -120,12 +116,8 @@ LL | unsafe {}
LL | t!();
| ----- in this macro invocation
|
= help: consider adding a safety comment in the macro definition
= note: this error originates in the macro `t` (in Nightly builds, run with -Z macro-backtrace for more info)
help: consider adding a safety comment
|
LL ~ // Safety: ...
LL + unsafe {}
|

error: unsafe block missing a safety comment
--> $DIR/undocumented_unsafe_blocks.rs:270:5
Expand All @@ -142,17 +134,13 @@ LL ~ unsafe {} // Safety:
error: unsafe block missing a safety comment
--> $DIR/undocumented_unsafe_blocks.rs:274:5
|
LL | / unsafe {
LL | | // Safety:
LL | | }
| |_____^
LL | unsafe {
| ^^^^^^^^
|
help: consider adding a safety comment
|
LL ~ // Safety: ...
LL + unsafe {
LL + // Safety:
LL + }
|

error: unsafe block missing a safety comment
Expand Down

0 comments on commit b450d0d

Please sign in to comment.