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::source_map::MultiSpan;
25 use syntax::feature_gate;
26 use syntax::symbol::Symbol;
27 use util::nodemap::FxHashMap;
29 pub struct LintLevelSets {
36 // -A,-W,-D flags, a `Symbol` for the flag itself and `Level` for which
38 specs: FxHashMap<LintId, (Level, LintSource)>,
42 specs: FxHashMap<LintId, (Level, LintSource)>,
48 pub fn new(sess: &Session) -> LintLevelSets {
49 let mut me = LintLevelSets {
51 lint_cap: Level::Forbid,
53 me.process_command_line(sess);
57 pub fn builder(sess: &Session) -> LintLevelsBuilder {
58 LintLevelsBuilder::new(sess, LintLevelSets::new(sess))
61 fn process_command_line(&mut self, sess: &Session) {
62 let store = sess.lint_store.borrow();
63 let mut specs = FxHashMap();
64 self.lint_cap = sess.opts.lint_cap.unwrap_or(Level::Forbid);
66 for &(ref lint_name, level) in &sess.opts.lint_opts {
67 store.check_lint_name_cmdline(sess, &lint_name, level);
69 // If the cap is less than this specified level, e.g. if we've got
70 // `--cap-lints allow` but we've also got `-D foo` then we ignore
71 // this specification as the lint cap will set it to allow anyway.
72 let level = cmp::min(level, self.lint_cap);
74 let lint_flag_val = Symbol::intern(lint_name);
75 let ids = match store.find_lints(&lint_name) {
77 Err(_) => continue, // errors handled in check_lint_name_cmdline above
80 let src = LintSource::CommandLine(lint_flag_val);
81 specs.insert(id, (level, src));
85 self.list.push(LintSet::CommandLine {
90 fn get_lint_level(&self,
93 aux: Option<&FxHashMap<LintId, (Level, LintSource)>>,
95 -> (Level, LintSource)
97 let (level, mut src) = self.get_lint_id_level(LintId::of(lint), idx, aux);
99 // If `level` is none then we actually assume the default level for this
101 let mut level = level.unwrap_or(lint.default_level(sess));
103 // If we're about to issue a warning, check at the last minute for any
104 // directives against the warnings "lint". If, for example, there's an
105 // `allow(warnings)` in scope then we want to respect that instead.
106 if level == Level::Warn {
107 let (warnings_level, warnings_src) =
108 self.get_lint_id_level(LintId::of(lint::builtin::WARNINGS),
111 if let Some(configured_warning_level) = warnings_level {
112 if configured_warning_level != Level::Warn {
113 level = configured_warning_level;
119 // Ensure that we never exceed the `--cap-lints` argument.
120 level = cmp::min(level, self.lint_cap);
122 if let Some(driver_level) = sess.driver_lint_caps.get(&LintId::of(lint)) {
123 // Ensure that we never exceed driver level.
124 level = cmp::min(*driver_level, level);
130 fn get_lint_id_level(&self,
133 aux: Option<&FxHashMap<LintId, (Level, LintSource)>>)
134 -> (Option<Level>, LintSource)
136 if let Some(specs) = aux {
137 if let Some(&(level, src)) = specs.get(&id) {
138 return (Some(level), src)
142 match self.list[idx as usize] {
143 LintSet::CommandLine { ref specs } => {
144 if let Some(&(level, src)) = specs.get(&id) {
145 return (Some(level), src)
147 return (None, LintSource::Default)
149 LintSet::Node { ref specs, parent } => {
150 if let Some(&(level, src)) = specs.get(&id) {
151 return (Some(level), src)
160 pub struct LintLevelsBuilder<'a> {
163 id_to_set: FxHashMap<HirId, u32>,
165 warn_about_weird_lints: bool,
168 pub struct BuilderPush {
172 impl<'a> LintLevelsBuilder<'a> {
173 pub fn new(sess: &'a Session, sets: LintLevelSets) -> LintLevelsBuilder<'a> {
174 assert_eq!(sets.list.len(), 1);
179 id_to_set: FxHashMap(),
180 warn_about_weird_lints: sess.buffered_lints.borrow().is_some(),
184 /// Pushes a list of AST lint attributes onto this context.
186 /// This function will return a `BuilderPush` object which should be be
187 /// passed to `pop` when this scope for the attributes provided is exited.
189 /// This function will perform a number of tasks:
191 /// * It'll validate all lint-related attributes in `attrs`
192 /// * It'll mark all lint-related attriutes as used
193 /// * Lint levels will be updated based on the attributes provided
194 /// * Lint attributes are validated, e.g. a #[forbid] can't be switched to
197 /// Don't forget to call `pop`!
198 pub fn push(&mut self, attrs: &[ast::Attribute]) -> BuilderPush {
199 let mut specs = FxHashMap();
200 let store = self.sess.lint_store.borrow();
201 let sess = self.sess;
202 let bad_attr = |span| {
203 span_err!(sess, span, E0452,
204 "malformed lint attribute");
207 let level = match Level::from_str(&attr.name().as_str()) {
212 let meta = unwrap_or!(attr.meta(), continue);
213 attr::mark_used(attr);
215 let metas = if let Some(metas) = meta.meta_item_list() {
223 let word = match li.word() {
230 let tool_name = if let Some(lint_tool) = word.is_scoped() {
231 let gate_feature = !self.sess.features_untracked().tool_lints;
232 let known_tool = attr::is_known_lint_tool(lint_tool);
234 feature_gate::emit_feature_err(
238 feature_gate::GateIssue::Language,
239 &format!("scoped lint `{}` is experimental", word.ident),
247 "an unknown tool name found in scoped lint: `{}`",
252 if gate_feature || !known_tool {
256 Some(lint_tool.as_str())
260 let name = word.name();
261 match store.check_lint_name(&name.as_str(), tool_name) {
262 CheckLintNameResult::Ok(ids) => {
263 let src = LintSource::Node(name, li.span);
265 specs.insert(*id, (level, src));
269 CheckLintNameResult::Tool(result) => {
272 let complete_name = &format!("{}::{}", tool_name.unwrap(), name);
273 let src = LintSource::Node(Symbol::intern(complete_name), li.span);
275 specs.insert(*id, (level, src));
278 Err((Some(ids), new_lint_name)) => {
279 let lint = builtin::RENAMED_AND_REMOVED_LINTS;
282 .get_lint_level(lint, self.cur, Some(&specs), &sess);
284 "lint name `{}` is deprecated \
285 and may not have an effect in the future \
286 Also `cfg_attr(cargo-clippy)` won't be necessary anymore",
289 let mut err = lint::struct_lint_level(
294 Some(li.span.into()),
297 err.span_suggestion_with_applicability(
300 new_lint_name.to_string(),
301 Applicability::MachineApplicable,
304 let src = LintSource::Node(Symbol::intern(&new_lint_name), li.span);
306 specs.insert(*id, (level, src));
310 // If Tool(Err(None, _)) is returned, then either the lint does not
311 // exist in the tool or the code was not compiled with the tool and
312 // therefore the lint was never added to the `LintStore`. To detect
313 // this is the responsibility of the lint tool.
318 _ if !self.warn_about_weird_lints => {}
320 CheckLintNameResult::Warning(msg, renamed) => {
321 let lint = builtin::RENAMED_AND_REMOVED_LINTS;
322 let (level, src) = self.sets.get_lint_level(lint,
326 let mut err = lint::struct_lint_level(self.sess,
330 Some(li.span.into()),
332 if let Some(new_name) = renamed {
333 err.span_suggestion_with_applicability(
337 Applicability::MachineApplicable
342 CheckLintNameResult::NoLint => {
343 let lint = builtin::UNKNOWN_LINTS;
344 let (level, src) = self.sets.get_lint_level(lint,
348 let msg = format!("unknown lint: `{}`", name);
349 let mut db = lint::struct_lint_level(self.sess,
353 Some(li.span.into()),
355 if name.as_str().chars().any(|c| c.is_uppercase()) {
356 let name_lower = name.as_str().to_lowercase().to_string();
357 if let CheckLintNameResult::NoLint =
358 store.check_lint_name(&name_lower, tool_name) {
361 db.span_suggestion_with_applicability(
363 "lowercase the lint name",
365 Applicability::MachineApplicable
376 for (id, &(level, ref src)) in specs.iter() {
377 if level == Level::Forbid {
380 let forbid_src = match self.sets.get_lint_id_level(*id, self.cur, None) {
381 (Some(Level::Forbid), src) => src,
384 let forbidden_lint_name = match forbid_src {
385 LintSource::Default => id.to_string(),
386 LintSource::Node(name, _) => name.to_string(),
387 LintSource::CommandLine(name) => name.to_string(),
389 let (lint_attr_name, lint_attr_span) = match *src {
390 LintSource::Node(name, span) => (name, span),
393 let mut diag_builder = struct_span_err!(self.sess,
396 "{}({}) overruled by outer forbid({})",
399 forbidden_lint_name);
400 diag_builder.span_label(lint_attr_span, "overruled by previous forbid");
402 LintSource::Default => &mut diag_builder,
403 LintSource::Node(_, forbid_source_span) => {
404 diag_builder.span_label(forbid_source_span,
405 "`forbid` level set here")
407 LintSource::CommandLine(_) => {
408 diag_builder.note("`forbid` lint level was set on command line")
411 // don't set a separate error for every lint in the group
417 self.cur = self.sets.list.len() as u32;
418 self.sets.list.push(LintSet::Node {
429 /// Called after `push` when the scope of a set of attributes are exited.
430 pub fn pop(&mut self, push: BuilderPush) {
431 self.cur = push.prev;
434 /// Used to emit a lint-related diagnostic based on the current state of
435 /// this lint context.
436 pub fn struct_lint(&self,
438 span: Option<MultiSpan>,
440 -> DiagnosticBuilder<'a>
442 let (level, src) = self.sets.get_lint_level(lint, self.cur, None, self.sess);
443 lint::struct_lint_level(self.sess, lint, level, src, span, msg)
446 /// Registers the ID provided with the current set of lints stored in
448 pub fn register_id(&mut self, id: HirId) {
449 self.id_to_set.insert(id, self.cur);
452 pub fn build(self) -> LintLevelSets {
456 pub fn build_map(self) -> LintLevelMap {
459 id_to_set: self.id_to_set,
464 pub struct LintLevelMap {
466 id_to_set: FxHashMap<HirId, u32>,
470 /// If the `id` was previously registered with `register_id` when building
471 /// this `LintLevelMap` this returns the corresponding lint level and source
472 /// of the lint level for the lint provided.
474 /// If the `id` was not previously registered, returns `None`. If `None` is
475 /// returned then the parent of `id` should be acquired and this function
476 /// should be called again.
477 pub fn level_and_source(&self, lint: &'static Lint, id: HirId, session: &Session)
478 -> Option<(Level, LintSource)>
480 self.id_to_set.get(&id).map(|idx| {
481 self.sets.get_lint_level(lint, *idx, None, session)
485 /// Returns if this `id` has lint level information.
486 pub fn lint_level_set(&self, id: HirId) -> Option<u32> {
487 self.id_to_set.get(&id).cloned()
491 impl<'a> HashStable<StableHashingContext<'a>> for LintLevelMap {
493 fn hash_stable<W: StableHasherResult>(&self,
494 hcx: &mut StableHashingContext<'a>,
495 hasher: &mut StableHasher<W>) {
501 id_to_set.hash_stable(hcx, hasher);
508 lint_cap.hash_stable(hcx, hasher);
510 hcx.while_hashing_spans(true, |hcx| {
511 list.len().hash_stable(hcx, hasher);
513 // We are working under the assumption here that the list of
514 // lint-sets is built in a deterministic order.
515 for lint_set in list {
516 ::std::mem::discriminant(lint_set).hash_stable(hcx, hasher);
519 LintSet::CommandLine { ref specs } => {
520 specs.hash_stable(hcx, hasher);
522 LintSet::Node { ref specs, parent } => {
523 specs.hash_stable(hcx, hasher);
524 parent.hash_stable(hcx, hasher);
532 impl<HCX> HashStable<HCX> for LintId {
534 fn hash_stable<W: StableHasherResult>(&self,
536 hasher: &mut StableHasher<W>) {
537 self.lint_name_raw().hash_stable(hcx, hasher);
541 impl<HCX> ToStableHashKey<HCX> for LintId {
542 type KeyType = &'static str;
545 fn to_stable_hash_key(&self, _: &HCX) -> &'static str {