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 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
23 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
24 html_root_url = "https://doc.rust-lang.org/nightly/")]
26 #![cfg_attr(test, feature(test))]
27 #![feature(box_patterns)]
28 #![feature(box_syntax)]
29 #![feature(macro_vis_matcher)]
31 #![feature(rustc_diagnostic_macros)]
32 #![feature(macro_at_most_once_rep)]
39 extern crate rustc_mir;
40 extern crate rustc_target;
41 extern crate syntax_pos;
44 use rustc::lint::{LateContext, LateLintPass, LintPass, LintArray};
45 use rustc::lint::builtin::{BARE_TRAIT_OBJECTS, ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE};
54 use syntax::edition::Edition;
56 use lint::FutureIncompatibleInfo;
68 /// Useful for other parts of the compiler.
69 pub use builtin::SoftLints;
71 /// Tell the `LintStore` about all the built-in lints (the ones
72 /// defined in this crate and the ones defined in
73 /// `rustc::lint::builtin`).
74 pub fn register_builtins(store: &mut lint::LintStore, sess: Option<&Session>) {
75 macro_rules! add_early_builtin {
76 ($sess:ident, $($name:ident),*,) => (
78 store.register_early_pass($sess, false, box $name);
83 macro_rules! add_early_builtin_with_new {
84 ($sess:ident, $($name:ident),*,) => (
86 store.register_early_pass($sess, false, box $name::new());
91 macro_rules! add_lint_group {
92 ($sess:ident, $name:expr, $($lint:ident),*) => (
93 store.register_group($sess, false, $name, vec![$(LintId::of($lint)),*]);
97 add_early_builtin!(sess,
105 add_early_builtin_with_new!(sess,
109 late_lint_methods!(declare_combined_late_lint_pass, [BuiltinCombinedLateLintPass, [
110 HardwiredLints: HardwiredLints,
111 WhileTrue: WhileTrue,
112 ImproperCTypes: ImproperCTypes,
113 VariantSizeDifferences: VariantSizeDifferences,
114 BoxPointers: BoxPointers,
115 UnusedAttributes: UnusedAttributes,
116 PathStatements: PathStatements,
117 UnusedResults: UnusedResults,
118 NonCamelCaseTypes: NonCamelCaseTypes,
119 NonSnakeCase: NonSnakeCase,
120 NonUpperCaseGlobals: NonUpperCaseGlobals,
121 NonShorthandFieldPatterns: NonShorthandFieldPatterns,
122 UnsafeCode: UnsafeCode,
123 UnusedAllocation: UnusedAllocation,
124 MissingCopyImplementations: MissingCopyImplementations,
125 UnstableFeatures: UnstableFeatures,
126 UnconditionalRecursion: UnconditionalRecursion,
127 InvalidNoMangleItems: InvalidNoMangleItems,
128 PluginAsLibrary: PluginAsLibrary,
129 MutableTransmutes: MutableTransmutes,
130 UnionsWithDropFields: UnionsWithDropFields,
131 UnreachablePub: UnreachablePub,
132 TypeAliasBounds: TypeAliasBounds,
133 UnusedBrokenConst: UnusedBrokenConst,
134 TrivialConstraints: TrivialConstraints,
135 TypeLimits: TypeLimits::new(),
136 MissingDoc: MissingDoc::new(),
137 MissingDebugImplementations: MissingDebugImplementations::new(),
140 store.register_late_pass(sess, false, box BuiltinCombinedLateLintPass::new());
142 add_lint_group!(sess,
144 NON_CAMEL_CASE_TYPES,
146 NON_UPPER_CASE_GLOBALS);
148 add_lint_group!(sess,
150 NON_CAMEL_CASE_TYPES,
152 NON_UPPER_CASE_GLOBALS);
154 add_lint_group!(sess,
162 UNREACHABLE_PATTERNS,
170 UNUSED_EXTERN_CRATES,
175 add_lint_group!(sess,
179 UNUSED_EXTERN_CRATES);
181 // Guidelines for creating a future incompatibility lint:
183 // - Create a lint defaulting to warn as normal, with ideally the same error
184 // message you would normally give
185 // - Add a suitable reference, typically an RFC or tracking issue. Go ahead
186 // and include the full URL, sort items in ascending order of issue numbers.
187 // - Later, change lint to error
188 // - Eventually, remove lint
189 store.register_future_incompatible(sess,
191 FutureIncompatibleInfo {
192 id: LintId::of(PRIVATE_IN_PUBLIC),
193 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
196 FutureIncompatibleInfo {
197 id: LintId::of(PUB_USE_OF_PRIVATE_EXTERN_CRATE),
198 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
201 FutureIncompatibleInfo {
202 id: LintId::of(PATTERNS_IN_FNS_WITHOUT_BODY),
203 reference: "issue #35203 <https://github.com/rust-lang/rust/issues/35203>",
206 FutureIncompatibleInfo {
207 id: LintId::of(DUPLICATE_MACRO_EXPORTS),
208 reference: "issue #35896 <https://github.com/rust-lang/rust/issues/35896>",
209 edition: Some(Edition::Edition2018),
211 FutureIncompatibleInfo {
212 id: LintId::of(SAFE_EXTERN_STATICS),
213 reference: "issue #36247 <https://github.com/rust-lang/rust/issues/36247>",
216 FutureIncompatibleInfo {
217 id: LintId::of(INVALID_TYPE_PARAM_DEFAULT),
218 reference: "issue #36887 <https://github.com/rust-lang/rust/issues/36887>",
221 FutureIncompatibleInfo {
222 id: LintId::of(LEGACY_DIRECTORY_OWNERSHIP),
223 reference: "issue #37872 <https://github.com/rust-lang/rust/issues/37872>",
226 FutureIncompatibleInfo {
227 id: LintId::of(LEGACY_CONSTRUCTOR_VISIBILITY),
228 reference: "issue #39207 <https://github.com/rust-lang/rust/issues/39207>",
231 FutureIncompatibleInfo {
232 id: LintId::of(MISSING_FRAGMENT_SPECIFIER),
233 reference: "issue #40107 <https://github.com/rust-lang/rust/issues/40107>",
236 FutureIncompatibleInfo {
237 id: LintId::of(ILLEGAL_FLOATING_POINT_LITERAL_PATTERN),
238 reference: "issue #41620 <https://github.com/rust-lang/rust/issues/41620>",
241 FutureIncompatibleInfo {
242 id: LintId::of(ANONYMOUS_PARAMETERS),
243 reference: "issue #41686 <https://github.com/rust-lang/rust/issues/41686>",
246 FutureIncompatibleInfo {
247 id: LintId::of(PARENTHESIZED_PARAMS_IN_TYPES_AND_MODULES),
248 reference: "issue #42238 <https://github.com/rust-lang/rust/issues/42238>",
251 FutureIncompatibleInfo {
252 id: LintId::of(LATE_BOUND_LIFETIME_ARGUMENTS),
253 reference: "issue #42868 <https://github.com/rust-lang/rust/issues/42868>",
256 FutureIncompatibleInfo {
257 id: LintId::of(SAFE_PACKED_BORROWS),
258 reference: "issue #46043 <https://github.com/rust-lang/rust/issues/46043>",
261 FutureIncompatibleInfo {
262 id: LintId::of(INCOHERENT_FUNDAMENTAL_IMPLS),
263 reference: "issue #46205 <https://github.com/rust-lang/rust/issues/46205>",
266 FutureIncompatibleInfo {
267 id: LintId::of(TYVAR_BEHIND_RAW_POINTER),
268 reference: "issue #46906 <https://github.com/rust-lang/rust/issues/46906>",
269 edition: Some(Edition::Edition2018),
271 FutureIncompatibleInfo {
272 id: LintId::of(UNSTABLE_NAME_COLLISIONS),
273 reference: "issue #48919 <https://github.com/rust-lang/rust/issues/48919>",
275 // Note: this item represents future incompatibility of all unstable functions in the
276 // standard library, and thus should never be removed or changed to an error.
278 FutureIncompatibleInfo {
279 id: LintId::of(ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE),
280 reference: "issue TBD",
281 edition: Some(Edition::Edition2018),
283 FutureIncompatibleInfo {
284 id: LintId::of(WHERE_CLAUSES_OBJECT_SAFETY),
285 reference: "issue #51443 <https://github.com/rust-lang/rust/issues/51443>",
288 FutureIncompatibleInfo {
289 id: LintId::of(DUPLICATE_ASSOCIATED_TYPE_BINDINGS),
290 reference: "issue #50589 <https://github.com/rust-lang/rust/issues/50589>",
295 // Register renamed and removed lints
296 store.register_renamed("single_use_lifetime", "single_use_lifetimes");
297 store.register_renamed("elided_lifetime_in_path", "elided_lifetimes_in_paths");
298 store.register_renamed("bare_trait_object", "bare_trait_objects");
299 store.register_renamed("unstable_name_collision", "unstable_name_collisions");
300 store.register_renamed("unused_doc_comment", "unused_doc_comments");
301 store.register_renamed("unknown_features", "unused_features");
302 store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate");
303 store.register_removed("negate_unsigned", "cast a signed value instead");
304 store.register_removed("raw_pointer_derive", "using derive with raw pointers is ok");
305 // This was renamed to raw_pointer_derive, which was then removed,
306 // so it is also considered removed
307 store.register_removed("raw_pointer_deriving", "using derive with raw pointers is ok");
308 store.register_removed("drop_with_repr_extern", "drop flags have been removed");
309 store.register_removed("fat_ptr_transmutes", "was accidentally removed back in 2014");
310 store.register_removed("deprecated_attr", "use `deprecated` instead");
311 store.register_removed("transmute_from_fn_item_types",
312 "always cast functions before transmuting them");
313 store.register_removed("hr_lifetime_in_assoc_type",
314 "converted into hard error, see https://github.com/rust-lang/rust/issues/33685");
315 store.register_removed("inaccessible_extern_crate",
316 "converted into hard error, see https://github.com/rust-lang/rust/issues/36886");
317 store.register_removed("super_or_self_in_global_path",
318 "converted into hard error, see https://github.com/rust-lang/rust/issues/36888");
319 store.register_removed("overlapping_inherent_impls",
320 "converted into hard error, see https://github.com/rust-lang/rust/issues/36889");
321 store.register_removed("illegal_floating_point_constant_pattern",
322 "converted into hard error, see https://github.com/rust-lang/rust/issues/36890");
323 store.register_removed("illegal_struct_or_enum_constant_pattern",
324 "converted into hard error, see https://github.com/rust-lang/rust/issues/36891");
325 store.register_removed("lifetime_underscore",
326 "converted into hard error, see https://github.com/rust-lang/rust/issues/36892");
327 store.register_removed("extra_requirement_in_impl",
328 "converted into hard error, see https://github.com/rust-lang/rust/issues/37166");
329 store.register_removed("legacy_imports",
330 "converted into hard error, see https://github.com/rust-lang/rust/issues/38260");
331 store.register_removed("coerce_never",
332 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
333 store.register_removed("resolve_trait_on_defaulted_unit",
334 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");