1 // Copyright 2015 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.
11 //! Lints in the Rust compiler.
13 //! This currently only contains the definitions and implementations
14 //! of most of the lints that `rustc` supports directly, it does not
15 //! contain the infrastructure for defining/registering lints. That is
16 //! available in `rustc::lint` and `rustc_plugin` respectively.
20 //! This API is completely unstable and subject to change.
22 #![deny(bare_trait_objects)]
24 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
25 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
26 html_root_url = "https://doc.rust-lang.org/nightly/")]
28 #![cfg_attr(test, feature(test))]
29 #![feature(box_patterns)]
30 #![feature(box_syntax)]
31 #![feature(macro_vis_matcher)]
33 #![feature(rustc_diagnostic_macros)]
34 #![feature(macro_at_most_once_rep)]
41 extern crate rustc_mir;
42 extern crate rustc_target;
43 extern crate syntax_pos;
46 use rustc::lint::{LateContext, LateLintPass, LintPass, LintArray};
47 use rustc::lint::builtin::{BARE_TRAIT_OBJECTS, ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE};
48 use rustc::lint::builtin::MACRO_USE_EXTERN_CRATE;
57 use syntax::edition::Edition;
59 use lint::FutureIncompatibleInfo;
71 /// Useful for other parts of the compiler.
72 pub use builtin::SoftLints;
74 /// Tell the `LintStore` about all the built-in lints (the ones
75 /// defined in this crate and the ones defined in
76 /// `rustc::lint::builtin`).
77 pub fn register_builtins(store: &mut lint::LintStore, sess: Option<&Session>) {
78 macro_rules! add_early_builtin {
79 ($sess:ident, $($name:ident),*,) => (
81 store.register_early_pass($sess, false, box $name);
86 macro_rules! add_pre_expansion_builtin {
87 ($sess:ident, $($name:ident),*,) => (
89 store.register_early_pass($sess, false, box $name);
94 macro_rules! add_early_builtin_with_new {
95 ($sess:ident, $($name:ident),*,) => (
97 store.register_early_pass($sess, false, box $name::new());
102 macro_rules! add_lint_group {
103 ($sess:ident, $name:expr, $($lint:ident),*) => (
104 store.register_group($sess, false, $name, vec![$(LintId::of($lint)),*]);
108 add_pre_expansion_builtin!(sess,
112 add_early_builtin!(sess,
118 EllipsisInclusiveRangePatterns,
121 add_early_builtin_with_new!(sess,
125 late_lint_methods!(declare_combined_late_lint_pass, [BuiltinCombinedLateLintPass, [
126 HardwiredLints: HardwiredLints,
127 WhileTrue: WhileTrue,
128 ImproperCTypes: ImproperCTypes,
129 VariantSizeDifferences: VariantSizeDifferences,
130 BoxPointers: BoxPointers,
131 UnusedAttributes: UnusedAttributes,
132 PathStatements: PathStatements,
133 UnusedResults: UnusedResults,
134 NonCamelCaseTypes: NonCamelCaseTypes,
135 NonSnakeCase: NonSnakeCase,
136 NonUpperCaseGlobals: NonUpperCaseGlobals,
137 NonShorthandFieldPatterns: NonShorthandFieldPatterns,
138 UnsafeCode: UnsafeCode,
139 UnusedAllocation: UnusedAllocation,
140 MissingCopyImplementations: MissingCopyImplementations,
141 UnstableFeatures: UnstableFeatures,
142 UnconditionalRecursion: UnconditionalRecursion,
143 InvalidNoMangleItems: InvalidNoMangleItems,
144 PluginAsLibrary: PluginAsLibrary,
145 MutableTransmutes: MutableTransmutes,
146 UnionsWithDropFields: UnionsWithDropFields,
147 UnreachablePub: UnreachablePub,
148 UnnameableTestFunctions: UnnameableTestFunctions,
149 TypeAliasBounds: TypeAliasBounds,
150 UnusedBrokenConst: UnusedBrokenConst,
151 TrivialConstraints: TrivialConstraints,
152 TypeLimits: TypeLimits::new(),
153 MissingDoc: MissingDoc::new(),
154 MissingDebugImplementations: MissingDebugImplementations::new(),
157 store.register_late_pass(sess, false, box BuiltinCombinedLateLintPass::new());
159 add_lint_group!(sess,
161 NON_CAMEL_CASE_TYPES,
163 NON_UPPER_CASE_GLOBALS);
165 add_lint_group!(sess,
167 NON_CAMEL_CASE_TYPES,
169 NON_UPPER_CASE_GLOBALS);
171 add_lint_group!(sess,
179 UNREACHABLE_PATTERNS,
187 UNUSED_EXTERN_CRATES,
192 add_lint_group!(sess,
196 UNUSED_EXTERN_CRATES,
197 MACRO_USE_EXTERN_CRATE,
198 ELLIPSIS_INCLUSIVE_RANGE_PATTERNS);
200 // Guidelines for creating a future incompatibility lint:
202 // - Create a lint defaulting to warn as normal, with ideally the same error
203 // message you would normally give
204 // - Add a suitable reference, typically an RFC or tracking issue. Go ahead
205 // and include the full URL, sort items in ascending order of issue numbers.
206 // - Later, change lint to error
207 // - Eventually, remove lint
208 store.register_future_incompatible(sess,
210 FutureIncompatibleInfo {
211 id: LintId::of(PRIVATE_IN_PUBLIC),
212 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
215 FutureIncompatibleInfo {
216 id: LintId::of(PUB_USE_OF_PRIVATE_EXTERN_CRATE),
217 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
220 FutureIncompatibleInfo {
221 id: LintId::of(PATTERNS_IN_FNS_WITHOUT_BODY),
222 reference: "issue #35203 <https://github.com/rust-lang/rust/issues/35203>",
225 FutureIncompatibleInfo {
226 id: LintId::of(DUPLICATE_MACRO_EXPORTS),
227 reference: "issue #35896 <https://github.com/rust-lang/rust/issues/35896>",
228 edition: Some(Edition::Edition2018),
230 FutureIncompatibleInfo {
231 id: LintId::of(ASYNC_IDENTS),
232 reference: "issue #49716 <https://github.com/rust-lang/rust/issues/49716>",
233 edition: Some(Edition::Edition2018),
235 FutureIncompatibleInfo {
236 id: LintId::of(SAFE_EXTERN_STATICS),
237 reference: "issue #36247 <https://github.com/rust-lang/rust/issues/36247>",
240 FutureIncompatibleInfo {
241 id: LintId::of(INVALID_TYPE_PARAM_DEFAULT),
242 reference: "issue #36887 <https://github.com/rust-lang/rust/issues/36887>",
245 FutureIncompatibleInfo {
246 id: LintId::of(LEGACY_DIRECTORY_OWNERSHIP),
247 reference: "issue #37872 <https://github.com/rust-lang/rust/issues/37872>",
250 FutureIncompatibleInfo {
251 id: LintId::of(LEGACY_CONSTRUCTOR_VISIBILITY),
252 reference: "issue #39207 <https://github.com/rust-lang/rust/issues/39207>",
255 FutureIncompatibleInfo {
256 id: LintId::of(MISSING_FRAGMENT_SPECIFIER),
257 reference: "issue #40107 <https://github.com/rust-lang/rust/issues/40107>",
260 FutureIncompatibleInfo {
261 id: LintId::of(ILLEGAL_FLOATING_POINT_LITERAL_PATTERN),
262 reference: "issue #41620 <https://github.com/rust-lang/rust/issues/41620>",
265 FutureIncompatibleInfo {
266 id: LintId::of(ANONYMOUS_PARAMETERS),
267 reference: "issue #41686 <https://github.com/rust-lang/rust/issues/41686>",
270 FutureIncompatibleInfo {
271 id: LintId::of(PARENTHESIZED_PARAMS_IN_TYPES_AND_MODULES),
272 reference: "issue #42238 <https://github.com/rust-lang/rust/issues/42238>",
275 FutureIncompatibleInfo {
276 id: LintId::of(LATE_BOUND_LIFETIME_ARGUMENTS),
277 reference: "issue #42868 <https://github.com/rust-lang/rust/issues/42868>",
280 FutureIncompatibleInfo {
281 id: LintId::of(SAFE_PACKED_BORROWS),
282 reference: "issue #46043 <https://github.com/rust-lang/rust/issues/46043>",
285 FutureIncompatibleInfo {
286 id: LintId::of(INCOHERENT_FUNDAMENTAL_IMPLS),
287 reference: "issue #46205 <https://github.com/rust-lang/rust/issues/46205>",
290 FutureIncompatibleInfo {
291 id: LintId::of(TYVAR_BEHIND_RAW_POINTER),
292 reference: "issue #46906 <https://github.com/rust-lang/rust/issues/46906>",
293 edition: Some(Edition::Edition2018),
295 FutureIncompatibleInfo {
296 id: LintId::of(UNSTABLE_NAME_COLLISIONS),
297 reference: "issue #48919 <https://github.com/rust-lang/rust/issues/48919>",
299 // Note: this item represents future incompatibility of all unstable functions in the
300 // standard library, and thus should never be removed or changed to an error.
302 FutureIncompatibleInfo {
303 id: LintId::of(ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE),
304 reference: "issue TBD",
305 edition: Some(Edition::Edition2018),
307 FutureIncompatibleInfo {
308 id: LintId::of(WHERE_CLAUSES_OBJECT_SAFETY),
309 reference: "issue #51443 <https://github.com/rust-lang/rust/issues/51443>",
312 FutureIncompatibleInfo {
313 id: LintId::of(DUPLICATE_ASSOCIATED_TYPE_BINDINGS),
314 reference: "issue #50589 <https://github.com/rust-lang/rust/issues/50589>",
317 FutureIncompatibleInfo {
318 id: LintId::of(PROC_MACRO_DERIVE_RESOLUTION_FALLBACK),
319 reference: "issue #50504 <https://github.com/rust-lang/rust/issues/50504>",
324 // Register renamed and removed lints
325 store.register_renamed("single_use_lifetime", "single_use_lifetimes");
326 store.register_renamed("elided_lifetime_in_path", "elided_lifetimes_in_paths");
327 store.register_renamed("bare_trait_object", "bare_trait_objects");
328 store.register_renamed("unstable_name_collision", "unstable_name_collisions");
329 store.register_renamed("unused_doc_comment", "unused_doc_comments");
330 store.register_renamed("unknown_features", "unused_features");
331 store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate");
332 store.register_removed("negate_unsigned", "cast a signed value instead");
333 store.register_removed("raw_pointer_derive", "using derive with raw pointers is ok");
334 // This was renamed to raw_pointer_derive, which was then removed,
335 // so it is also considered removed
336 store.register_removed("raw_pointer_deriving", "using derive with raw pointers is ok");
337 store.register_removed("drop_with_repr_extern", "drop flags have been removed");
338 store.register_removed("fat_ptr_transmutes", "was accidentally removed back in 2014");
339 store.register_removed("deprecated_attr", "use `deprecated` instead");
340 store.register_removed("transmute_from_fn_item_types",
341 "always cast functions before transmuting them");
342 store.register_removed("hr_lifetime_in_assoc_type",
343 "converted into hard error, see https://github.com/rust-lang/rust/issues/33685");
344 store.register_removed("inaccessible_extern_crate",
345 "converted into hard error, see https://github.com/rust-lang/rust/issues/36886");
346 store.register_removed("super_or_self_in_global_path",
347 "converted into hard error, see https://github.com/rust-lang/rust/issues/36888");
348 store.register_removed("overlapping_inherent_impls",
349 "converted into hard error, see https://github.com/rust-lang/rust/issues/36889");
350 store.register_removed("illegal_floating_point_constant_pattern",
351 "converted into hard error, see https://github.com/rust-lang/rust/issues/36890");
352 store.register_removed("illegal_struct_or_enum_constant_pattern",
353 "converted into hard error, see https://github.com/rust-lang/rust/issues/36891");
354 store.register_removed("lifetime_underscore",
355 "converted into hard error, see https://github.com/rust-lang/rust/issues/36892");
356 store.register_removed("extra_requirement_in_impl",
357 "converted into hard error, see https://github.com/rust-lang/rust/issues/37166");
358 store.register_removed("legacy_imports",
359 "converted into hard error, see https://github.com/rust-lang/rust/issues/38260");
360 store.register_removed("coerce_never",
361 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
362 store.register_removed("resolve_trait_on_defaulted_unit",
363 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");