1 //! Lints, aka compiler warnings.
3 //! A 'lint' check is a kind of miscellaneous constraint that a user _might_
4 //! want to enforce, but might reasonably want to permit as well, on a
5 //! module-by-module basis. They contrast with static constraints enforced by
6 //! other phases of the compiler, which are generally required to hold in order
7 //! to compile the program at all.
9 //! Most lints can be written as `LintPass` instances. These run after
10 //! all other analyses. The `LintPass`es built into rustc are defined
11 //! within `rustc_session::lint::builtin`,
12 //! which has further comments on how to add such a lint.
13 //! rustc can also load user-defined lint plugins via the plugin mechanism.
15 //! Some of rustc's lints are defined elsewhere in the compiler and work by
16 //! calling `add_lint()` on the overall `Session` object. This works when
17 //! it happens before the main lint pass, which emits the lints stored by
18 //! `add_lint()`. To emit lints after the main lint pass (from codegen, for
19 //! example) requires more effort. See `emit_lint` and `GatherNodeLevels`
22 //! Some code also exists in `rustc_session::lint`, `rustc::lint`.
26 //! This API is completely unstable and subject to change.
28 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
29 #![cfg_attr(test, feature(test))]
30 #![feature(bool_to_option)]
31 #![feature(box_patterns)]
32 #![feature(box_syntax)]
33 #![feature(crate_visibility_modifier)]
34 #![feature(never_type)]
36 #![recursion_limit = "256"]
41 extern crate rustc_session;
51 mod nonstandard_style;
53 mod redundant_semicolon;
57 use rustc::ty::query::Providers;
58 use rustc::ty::TyCtxt;
60 use rustc_hir::def_id::DefId;
61 use rustc_session::lint::builtin::{
62 BARE_TRAIT_OBJECTS, ELIDED_LIFETIMES_IN_PATHS, EXPLICIT_OUTLIVES_REQUIREMENTS,
63 INTRA_DOC_LINK_RESOLUTION_FAILURE, MISSING_DOC_CODE_EXAMPLES, PRIVATE_DOC_TESTS,
68 use array_into_iter::ArrayIntoIter;
71 use non_ascii_idents::*;
72 use nonstandard_style::*;
73 use redundant_semicolon::*;
77 /// Useful for other parts of the compiler / Clippy.
78 pub use builtin::SoftLints;
79 pub use context::{CheckLintNameResult, EarlyContext, LateContext, LintContext, LintStore};
80 pub use early::check_ast_crate;
81 pub use late::check_crate;
82 pub use passes::{EarlyLintPass, LateLintPass};
83 pub use rustc_session::lint::Level::{self, *};
84 pub use rustc_session::lint::{BufferedEarlyLint, FutureIncompatibleInfo, Lint, LintId};
85 pub use rustc_session::lint::{LintArray, LintPass};
87 pub fn provide(providers: &mut Providers<'_>) {
88 levels::provide(providers);
89 *providers = Providers { lint_mod, ..*providers };
92 fn lint_mod(tcx: TyCtxt<'_>, module_def_id: DefId) {
93 late::late_lint_mod(tcx, module_def_id, BuiltinCombinedModuleLateLintPass::new());
96 macro_rules! pre_expansion_lint_passes {
97 ($macro:path, $args:tt) => {
98 $macro!($args, [KeywordIdents: KeywordIdents, UnusedDocComment: UnusedDocComment,]);
102 macro_rules! early_lint_passes {
103 ($macro:path, $args:tt) => {
107 UnusedParens: UnusedParens,
108 UnusedImportBraces: UnusedImportBraces,
109 UnsafeCode: UnsafeCode,
110 AnonymousParameters: AnonymousParameters,
111 EllipsisInclusiveRangePatterns: EllipsisInclusiveRangePatterns::default(),
112 NonCamelCaseTypes: NonCamelCaseTypes,
113 DeprecatedAttr: DeprecatedAttr::new(),
114 WhileTrue: WhileTrue,
115 NonAsciiIdents: NonAsciiIdents,
116 IncompleteFeatures: IncompleteFeatures,
117 RedundantSemicolon: RedundantSemicolon,
123 macro_rules! declare_combined_early_pass {
124 ([$name:ident], $passes:tt) => (
125 early_lint_methods!(declare_combined_early_lint_pass, [pub $name, $passes]);
129 pre_expansion_lint_passes!(declare_combined_early_pass, [BuiltinCombinedPreExpansionLintPass]);
130 early_lint_passes!(declare_combined_early_pass, [BuiltinCombinedEarlyLintPass]);
132 macro_rules! late_lint_passes {
133 ($macro:path, $args:tt) => {
137 // FIXME: Look into regression when this is used as a module lint
138 // May Depend on constants elsewhere
139 UnusedBrokenConst: UnusedBrokenConst,
140 // Uses attr::is_used which is untracked, can't be an incremental module pass.
141 UnusedAttributes: UnusedAttributes::new(),
142 // Needs to run after UnusedAttributes as it marks all `feature` attributes as used.
143 UnstableFeatures: UnstableFeatures,
144 // Tracks state across modules
145 UnnameableTestItems: UnnameableTestItems::new(),
146 // Tracks attributes of parents
147 MissingDoc: MissingDoc::new(),
148 // Depends on access levels
149 // FIXME: Turn the computation of types which implement Debug into a query
150 // and change this to a module lint pass
151 MissingDebugImplementations: MissingDebugImplementations::default(),
152 ArrayIntoIter: ArrayIntoIter,
158 macro_rules! late_lint_mod_passes {
159 ($macro:path, $args:tt) => {
163 HardwiredLints: HardwiredLints,
164 ImproperCTypes: ImproperCTypes,
165 VariantSizeDifferences: VariantSizeDifferences,
166 BoxPointers: BoxPointers,
167 PathStatements: PathStatements,
168 // Depends on referenced function signatures in expressions
169 UnusedResults: UnusedResults,
170 NonUpperCaseGlobals: NonUpperCaseGlobals,
171 NonShorthandFieldPatterns: NonShorthandFieldPatterns,
172 UnusedAllocation: UnusedAllocation,
173 // Depends on types used in type definitions
174 MissingCopyImplementations: MissingCopyImplementations,
175 // Depends on referenced function signatures in expressions
176 MutableTransmutes: MutableTransmutes,
177 TypeAliasBounds: TypeAliasBounds,
178 TrivialConstraints: TrivialConstraints,
179 TypeLimits: TypeLimits::new(),
180 NonSnakeCase: NonSnakeCase,
181 InvalidNoMangleItems: InvalidNoMangleItems,
182 // Depends on access levels
183 UnreachablePub: UnreachablePub,
184 ExplicitOutlivesRequirements: ExplicitOutlivesRequirements,
185 InvalidValue: InvalidValue,
191 macro_rules! declare_combined_late_pass {
192 ([$v:vis $name:ident], $passes:tt) => (
193 late_lint_methods!(declare_combined_late_lint_pass, [$v $name, $passes], ['tcx]);
197 // FIXME: Make a separate lint type which do not require typeck tables
198 late_lint_passes!(declare_combined_late_pass, [pub BuiltinCombinedLateLintPass]);
200 late_lint_mod_passes!(declare_combined_late_pass, [BuiltinCombinedModuleLateLintPass]);
202 pub fn new_lint_store(no_interleave_lints: bool, internal_lints: bool) -> LintStore {
203 let mut lint_store = LintStore::new();
205 register_builtins(&mut lint_store, no_interleave_lints);
207 register_internals(&mut lint_store);
213 /// Tell the `LintStore` about all the built-in lints (the ones
214 /// defined in this crate and the ones defined in
215 /// `rustc::lint::builtin`).
216 fn register_builtins(store: &mut LintStore, no_interleave_lints: bool) {
217 macro_rules! add_lint_group {
218 ($name:expr, $($lint:ident),*) => (
219 store.register_group(false, $name, None, vec![$(LintId::of($lint)),*]);
223 macro_rules! register_pass {
224 ($method:ident, $ty:ident, $constructor:expr) => {
225 store.register_lints(&$ty::get_lints());
226 store.$method(|| box $constructor);
230 macro_rules! register_passes {
231 ($method:ident, [$($passes:ident: $constructor:expr,)*]) => (
233 register_pass!($method, $passes, $constructor);
238 if no_interleave_lints {
239 pre_expansion_lint_passes!(register_passes, register_pre_expansion_pass);
240 early_lint_passes!(register_passes, register_early_pass);
241 late_lint_passes!(register_passes, register_late_pass);
242 late_lint_mod_passes!(register_passes, register_late_mod_pass);
244 store.register_lints(&BuiltinCombinedPreExpansionLintPass::get_lints());
245 store.register_lints(&BuiltinCombinedEarlyLintPass::get_lints());
246 store.register_lints(&BuiltinCombinedModuleLateLintPass::get_lints());
247 store.register_lints(&BuiltinCombinedLateLintPass::get_lints());
252 NON_CAMEL_CASE_TYPES,
254 NON_UPPER_CASE_GLOBALS
265 UNREACHABLE_PATTERNS,
266 OVERLAPPING_PATTERNS,
274 UNUSED_EXTERN_CRATES,
283 UNUSED_EXTERN_CRATES,
284 ELLIPSIS_INCLUSIVE_RANGE_PATTERNS,
285 ELIDED_LIFETIMES_IN_PATHS,
286 EXPLICIT_OUTLIVES_REQUIREMENTS // FIXME(#52665, #47816) not always applicable and not all
287 // macros are ready for this yet.
290 // FIXME macro crates are not up for this yet, too much
291 // breakage is seen if we try to encourage this lint.
292 // MACRO_USE_EXTERN_CRATE
297 INTRA_DOC_LINK_RESOLUTION_FAILURE,
298 MISSING_DOC_CODE_EXAMPLES,
302 // Register renamed and removed lints.
303 store.register_renamed("single_use_lifetime", "single_use_lifetimes");
304 store.register_renamed("elided_lifetime_in_path", "elided_lifetimes_in_paths");
305 store.register_renamed("bare_trait_object", "bare_trait_objects");
306 store.register_renamed("unstable_name_collision", "unstable_name_collisions");
307 store.register_renamed("unused_doc_comment", "unused_doc_comments");
308 store.register_renamed("async_idents", "keyword_idents");
309 store.register_removed("unknown_features", "replaced by an error");
310 store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate");
311 store.register_removed("negate_unsigned", "cast a signed value instead");
312 store.register_removed("raw_pointer_derive", "using derive with raw pointers is ok");
313 // Register lint group aliases.
314 store.register_group_alias("nonstandard_style", "bad_style");
315 // This was renamed to `raw_pointer_derive`, which was then removed,
316 // so it is also considered removed.
317 store.register_removed("raw_pointer_deriving", "using derive with raw pointers is ok");
318 store.register_removed("drop_with_repr_extern", "drop flags have been removed");
319 store.register_removed("fat_ptr_transmutes", "was accidentally removed back in 2014");
320 store.register_removed("deprecated_attr", "use `deprecated` instead");
321 store.register_removed(
322 "transmute_from_fn_item_types",
323 "always cast functions before transmuting them",
325 store.register_removed(
326 "hr_lifetime_in_assoc_type",
327 "converted into hard error, see issue #33685 \
328 <https://github.com/rust-lang/rust/issues/33685> for more information",
330 store.register_removed(
331 "inaccessible_extern_crate",
332 "converted into hard error, see issue #36886 \
333 <https://github.com/rust-lang/rust/issues/36886> for more information",
335 store.register_removed(
336 "super_or_self_in_global_path",
337 "converted into hard error, see issue #36888 \
338 <https://github.com/rust-lang/rust/issues/36888> for more information",
340 store.register_removed(
341 "overlapping_inherent_impls",
342 "converted into hard error, see issue #36889 \
343 <https://github.com/rust-lang/rust/issues/36889> for more information",
345 store.register_removed(
346 "illegal_floating_point_constant_pattern",
347 "converted into hard error, see issue #36890 \
348 <https://github.com/rust-lang/rust/issues/36890> for more information",
350 store.register_removed(
351 "illegal_struct_or_enum_constant_pattern",
352 "converted into hard error, see issue #36891 \
353 <https://github.com/rust-lang/rust/issues/36891> for more information",
355 store.register_removed(
356 "lifetime_underscore",
357 "converted into hard error, see issue #36892 \
358 <https://github.com/rust-lang/rust/issues/36892> for more information",
360 store.register_removed(
361 "extra_requirement_in_impl",
362 "converted into hard error, see issue #37166 \
363 <https://github.com/rust-lang/rust/issues/37166> for more information",
365 store.register_removed(
367 "converted into hard error, see issue #38260 \
368 <https://github.com/rust-lang/rust/issues/38260> for more information",
370 store.register_removed(
372 "converted into hard error, see issue #48950 \
373 <https://github.com/rust-lang/rust/issues/48950> for more information",
375 store.register_removed(
376 "resolve_trait_on_defaulted_unit",
377 "converted into hard error, see issue #48950 \
378 <https://github.com/rust-lang/rust/issues/48950> for more information",
380 store.register_removed(
381 "private_no_mangle_fns",
382 "no longer a warning, `#[no_mangle]` functions always exported",
384 store.register_removed(
385 "private_no_mangle_statics",
386 "no longer a warning, `#[no_mangle]` statics always exported",
388 store.register_removed("bad_repr", "replaced with a generic attribute input check");
389 store.register_removed(
390 "duplicate_matcher_binding_name",
391 "converted into hard error, see issue #57742 \
392 <https://github.com/rust-lang/rust/issues/57742> for more information",
394 store.register_removed(
395 "incoherent_fundamental_impls",
396 "converted into hard error, see issue #46205 \
397 <https://github.com/rust-lang/rust/issues/46205> for more information",
399 store.register_removed(
400 "legacy_constructor_visibility",
401 "converted into hard error, see issue #39207 \
402 <https://github.com/rust-lang/rust/issues/39207> for more information",
404 store.register_removed(
405 "legacy_directory_ownership",
406 "converted into hard error, see issue #37872 \
407 <https://github.com/rust-lang/rust/issues/37872> for more information",
409 store.register_removed(
410 "safe_extern_statics",
411 "converted into hard error, see issue #36247 \
412 <https://github.com/rust-lang/rust/issues/36247> for more information",
414 store.register_removed(
415 "parenthesized_params_in_types_and_modules",
416 "converted into hard error, see issue #42238 \
417 <https://github.com/rust-lang/rust/issues/42238> for more information",
419 store.register_removed(
420 "duplicate_macro_exports",
421 "converted into hard error, see issue #35896 \
422 <https://github.com/rust-lang/rust/issues/35896> for more information",
424 store.register_removed(
426 "converted into hard error, see issue #59014 \
427 <https://github.com/rust-lang/rust/issues/59014> for more information",
429 store.register_removed("plugin_as_library", "plugins have been deprecated and retired");
432 fn register_internals(store: &mut LintStore) {
433 store.register_lints(&DefaultHashTypes::get_lints());
434 store.register_early_pass(|| box DefaultHashTypes::new());
435 store.register_lints(&LintPassImpl::get_lints());
436 store.register_early_pass(|| box LintPassImpl);
437 store.register_lints(&TyTyKind::get_lints());
438 store.register_late_pass(|| box TyTyKind);
439 store.register_group(
444 LintId::of(DEFAULT_HASH_TYPES),
445 LintId::of(USAGE_OF_TY_TYKIND),
446 LintId::of(LINT_PASS_IMPL_WITHOUT_MACRO),
447 LintId::of(TY_PASS_BY_REFERENCE),
448 LintId::of(USAGE_OF_QUALIFIED_TY),