1 // Copyright 2017 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.
13 use errors
::{Applicability, DiagnosticBuilder}
;
15 use ich
::StableHashingContext
;
17 use lint
::context
::CheckLintNameResult
;
18 use lint
::{self, Lint, LintId, Level, LintSource}
;
19 use rustc_data_structures
::stable_hasher
::{HashStable
, ToStableHashKey
,
20 StableHasher
, StableHasherResult
};
24 use syntax
::codemap
::MultiSpan
;
25 use syntax
::symbol
::Symbol
;
26 use util
::nodemap
::FxHashMap
;
28 pub struct LintLevelSets
{
35 // -A,-W,-D flags, a `Symbol` for the flag itself and `Level` for which
37 specs
: FxHashMap
<LintId
, (Level
, LintSource
)>,
41 specs
: FxHashMap
<LintId
, (Level
, LintSource
)>,
47 pub fn new(sess
: &Session
) -> LintLevelSets
{
48 let mut me
= LintLevelSets
{
50 lint_cap
: Level
::Forbid
,
52 me
.process_command_line(sess
);
56 pub fn builder(sess
: &Session
) -> LintLevelsBuilder
{
57 LintLevelsBuilder
::new(sess
, LintLevelSets
::new(sess
))
60 fn process_command_line(&mut self, sess
: &Session
) {
61 let store
= sess
.lint_store
.borrow();
62 let mut specs
= FxHashMap();
63 self.lint_cap
= sess
.opts
.lint_cap
.unwrap_or(Level
::Forbid
);
65 for &(ref lint_name
, level
) in &sess
.opts
.lint_opts
{
66 store
.check_lint_name_cmdline(sess
, &lint_name
, level
);
68 // If the cap is less than this specified level, e.g. if we've got
69 // `--cap-lints allow` but we've also got `-D foo` then we ignore
70 // this specification as the lint cap will set it to allow anyway.
71 let level
= cmp
::min(level
, self.lint_cap
);
73 let lint_flag_val
= Symbol
::intern(lint_name
);
74 let ids
= match store
.find_lints(&lint_name
) {
76 Err(_
) => continue, // errors handled in check_lint_name_cmdline above
79 let src
= LintSource
::CommandLine(lint_flag_val
);
80 specs
.insert(id
, (level
, src
));
84 self.list
.push(LintSet
::CommandLine
{
89 fn get_lint_level(&self,
92 aux
: Option
<&FxHashMap
<LintId
, (Level
, LintSource
)>>,
94 -> (Level
, LintSource
)
96 let (level
, mut src
) = self.get_lint_id_level(LintId
::of(lint
), idx
, aux
);
98 // If `level` is none then we actually assume the default level for this
100 let mut level
= level
.unwrap_or(lint
.default_level(sess
));
102 // If we're about to issue a warning, check at the last minute for any
103 // directives against the warnings "lint". If, for example, there's an
104 // `allow(warnings)` in scope then we want to respect that instead.
105 if level
== Level
::Warn
{
106 let (warnings_level
, warnings_src
) =
107 self.get_lint_id_level(LintId
::of(lint
::builtin
::WARNINGS
),
110 if let Some(configured_warning_level
) = warnings_level
{
111 if configured_warning_level
!= Level
::Warn
{
112 level
= configured_warning_level
;
118 // Ensure that we never exceed the `--cap-lints` argument.
119 level
= cmp
::min(level
, self.lint_cap
);
121 if let Some(driver_level
) = sess
.driver_lint_caps
.get(&LintId
::of(lint
)) {
122 // Ensure that we never exceed driver level.
123 level
= cmp
::min(*driver_level
, level
);
129 fn get_lint_id_level(&self,
132 aux
: Option
<&FxHashMap
<LintId
, (Level
, LintSource
)>>)
133 -> (Option
<Level
>, LintSource
)
135 if let Some(specs
) = aux
{
136 if let Some(&(level
, src
)) = specs
.get(&id
) {
137 return (Some(level
), src
)
141 match self.list
[idx
as usize] {
142 LintSet
::CommandLine { ref specs }
=> {
143 if let Some(&(level
, src
)) = specs
.get(&id
) {
144 return (Some(level
), src
)
146 return (None
, LintSource
::Default
)
148 LintSet
::Node { ref specs, parent }
=> {
149 if let Some(&(level
, src
)) = specs
.get(&id
) {
150 return (Some(level
), src
)
159 pub struct LintLevelsBuilder
<'a
> {
162 id_to_set
: FxHashMap
<HirId
, u32>,
164 warn_about_weird_lints
: bool
,
167 pub struct BuilderPush
{
171 impl<'a
> LintLevelsBuilder
<'a
> {
172 pub fn new(sess
: &'a Session
, sets
: LintLevelSets
) -> LintLevelsBuilder
<'a
> {
173 assert_eq
!(sets
.list
.len(), 1);
178 id_to_set
: FxHashMap(),
179 warn_about_weird_lints
: sess
.buffered_lints
.borrow().is_some(),
183 /// Pushes a list of AST lint attributes onto this context.
185 /// This function will return a `BuilderPush` object which should be be
186 /// passed to `pop` when this scope for the attributes provided is exited.
188 /// This function will perform a number of tasks:
190 /// * It'll validate all lint-related attributes in `attrs`
191 /// * It'll mark all lint-related attriutes as used
192 /// * Lint levels will be updated based on the attributes provided
193 /// * Lint attributes are validated, e.g. a #[forbid] can't be switched to
196 /// Don't forget to call `pop`!
197 pub fn push(&mut self, attrs
: &[ast
::Attribute
]) -> BuilderPush
{
198 let mut specs
= FxHashMap();
199 let store
= self.sess
.lint_store
.borrow();
200 let sess
= self.sess
;
201 let bad_attr
= |span
| {
202 span_err
!(sess
, span
, E0452
,
203 "malformed lint attribute");
206 let level
= match Level
::from_str(&attr
.name().as_str()) {
211 let meta
= unwrap_or
!(attr
.meta(), continue);
212 attr
::mark_used(attr
);
214 let metas
= if let Some(metas
) = meta
.meta_item_list() {
222 let word
= match li
.word() {
229 let name
= word
.name();
230 match store
.check_lint_name(&name
.as_str()) {
231 CheckLintNameResult
::Ok(ids
) => {
232 let src
= LintSource
::Node(name
, li
.span
);
234 specs
.insert(*id
, (level
, src
));
238 _
if !self.warn_about_weird_lints
=> {}
240 CheckLintNameResult
::Warning(ref msg
) => {
241 let lint
= builtin
::RENAMED_AND_REMOVED_LINTS
;
242 let (level
, src
) = self.sets
.get_lint_level(lint
,
246 lint
::struct_lint_level(self.sess
,
250 Some(li
.span
.into()),
254 CheckLintNameResult
::NoLint
=> {
255 let lint
= builtin
::UNKNOWN_LINTS
;
256 let (level
, src
) = self.sets
.get_lint_level(lint
,
260 let msg
= format
!("unknown lint: `{}`", name
);
261 let mut db
= lint
::struct_lint_level(self.sess
,
265 Some(li
.span
.into()),
267 if name
.as_str().chars().any(|c
| c
.is_uppercase()) {
268 let name_lower
= name
.as_str().to_lowercase().to_string();
269 if let CheckLintNameResult
::NoLint
=
270 store
.check_lint_name(&name_lower
) {
273 db
.span_suggestion_with_applicability(
275 "lowercase the lint name",
277 Applicability
::MachineApplicable
288 for (id
, &(level
, ref src
)) in specs
.iter() {
289 if level
== Level
::Forbid
{
292 let forbid_src
= match self.sets
.get_lint_id_level(*id
, self.cur
, None
) {
293 (Some(Level
::Forbid
), src
) => src
,
296 let forbidden_lint_name
= match forbid_src
{
297 LintSource
::Default
=> id
.to_string(),
298 LintSource
::Node(name
, _
) => name
.to_string(),
299 LintSource
::CommandLine(name
) => name
.to_string(),
301 let (lint_attr_name
, lint_attr_span
) = match *src
{
302 LintSource
::Node(name
, span
) => (name
, span
),
305 let mut diag_builder
= struct_span_err
!(self.sess
,
308 "{}({}) overruled by outer forbid({})",
311 forbidden_lint_name
);
312 diag_builder
.span_label(lint_attr_span
, "overruled by previous forbid");
314 LintSource
::Default
=> &mut diag_builder
,
315 LintSource
::Node(_
, forbid_source_span
) => {
316 diag_builder
.span_label(forbid_source_span
,
317 "`forbid` level set here")
319 LintSource
::CommandLine(_
) => {
320 diag_builder
.note("`forbid` lint level was set on command line")
323 // don't set a separate error for every lint in the group
329 self.cur
= self.sets
.list
.len() as u32;
330 self.sets
.list
.push(LintSet
::Node
{
341 /// Called after `push` when the scope of a set of attributes are exited.
342 pub fn pop(&mut self, push
: BuilderPush
) {
343 self.cur
= push
.prev
;
346 /// Used to emit a lint-related diagnostic based on the current state of
347 /// this lint context.
348 pub fn struct_lint(&self,
350 span
: Option
<MultiSpan
>,
352 -> DiagnosticBuilder
<'a
>
354 let (level
, src
) = self.sets
.get_lint_level(lint
, self.cur
, None
, self.sess
);
355 lint
::struct_lint_level(self.sess
, lint
, level
, src
, span
, msg
)
358 /// Registers the ID provided with the current set of lints stored in
360 pub fn register_id(&mut self, id
: HirId
) {
361 self.id_to_set
.insert(id
, self.cur
);
364 pub fn build(self) -> LintLevelSets
{
368 pub fn build_map(self) -> LintLevelMap
{
371 id_to_set
: self.id_to_set
,
376 pub struct LintLevelMap
{
378 id_to_set
: FxHashMap
<HirId
, u32>,
382 /// If the `id` was previously registered with `register_id` when building
383 /// this `LintLevelMap` this returns the corresponding lint level and source
384 /// of the lint level for the lint provided.
386 /// If the `id` was not previously registered, returns `None`. If `None` is
387 /// returned then the parent of `id` should be acquired and this function
388 /// should be called again.
389 pub fn level_and_source(&self, lint
: &'
static Lint
, id
: HirId
, session
: &Session
)
390 -> Option
<(Level
, LintSource
)>
392 self.id_to_set
.get(&id
).map(|idx
| {
393 self.sets
.get_lint_level(lint
, *idx
, None
, session
)
397 /// Returns if this `id` has lint level information.
398 pub fn lint_level_set(&self, id
: HirId
) -> Option
<u32> {
399 self.id_to_set
.get(&id
).cloned()
403 impl<'a
> HashStable
<StableHashingContext
<'a
>> for LintLevelMap
{
405 fn hash_stable
<W
: StableHasherResult
>(&self,
406 hcx
: &mut StableHashingContext
<'a
>,
407 hasher
: &mut StableHasher
<W
>) {
413 id_to_set
.hash_stable(hcx
, hasher
);
420 lint_cap
.hash_stable(hcx
, hasher
);
422 hcx
.while_hashing_spans(true, |hcx
| {
423 list
.len().hash_stable(hcx
, hasher
);
425 // We are working under the assumption here that the list of
426 // lint-sets is built in a deterministic order.
427 for lint_set
in list
{
428 ::std
::mem
::discriminant(lint_set
).hash_stable(hcx
, hasher
);
431 LintSet
::CommandLine { ref specs }
=> {
432 specs
.hash_stable(hcx
, hasher
);
434 LintSet
::Node { ref specs, parent }
=> {
435 specs
.hash_stable(hcx
, hasher
);
436 parent
.hash_stable(hcx
, hasher
);
444 impl<HCX
> HashStable
<HCX
> for LintId
{
446 fn hash_stable
<W
: StableHasherResult
>(&self,
448 hasher
: &mut StableHasher
<W
>) {
449 self.lint_name_raw().hash_stable(hcx
, hasher
);
453 impl<HCX
> ToStableHashKey
<HCX
> for LintId
{
454 type KeyType
= &'
static str;
457 fn to_stable_hash_key(&self, _
: &HCX
) -> &'
static str {