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::{
49 ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
50 MACRO_USE_EXTERN_CRATE,
51 ELIDED_LIFETIMES_IN_PATHS,
52 parser::QUESTION_MARK_MACRO_SEP
62 use syntax::edition::Edition;
64 use lint::FutureIncompatibleInfo;
76 /// Useful for other parts of the compiler.
77 pub use builtin::SoftLints;
79 /// Tell the `LintStore` about all the built-in lints (the ones
80 /// defined in this crate and the ones defined in
81 /// `rustc::lint::builtin`).
82 pub fn register_builtins(store: &mut lint::LintStore, sess: Option<&Session>) {
83 macro_rules! add_early_builtin {
84 ($sess:ident, $($name:ident),*,) => (
86 store.register_early_pass($sess, false, box $name);
91 macro_rules! add_pre_expansion_builtin {
92 ($sess:ident, $($name:ident),*,) => (
94 store.register_early_pass($sess, false, box $name);
99 macro_rules! add_early_builtin_with_new {
100 ($sess:ident, $($name:ident),*,) => (
102 store.register_early_pass($sess, false, box $name::new());
107 macro_rules! add_lint_group {
108 ($sess:ident, $name:expr, $($lint:ident),*) => (
109 store.register_group($sess, false, $name, vec![$(LintId::of($lint)),*]);
113 add_pre_expansion_builtin!(sess,
117 add_early_builtin!(sess,
123 EllipsisInclusiveRangePatterns,
126 add_early_builtin_with_new!(sess,
130 late_lint_methods!(declare_combined_late_lint_pass, [BuiltinCombinedLateLintPass, [
131 HardwiredLints: HardwiredLints,
132 WhileTrue: WhileTrue,
133 ImproperCTypes: ImproperCTypes,
134 VariantSizeDifferences: VariantSizeDifferences,
135 BoxPointers: BoxPointers,
136 UnusedAttributes: UnusedAttributes,
137 PathStatements: PathStatements,
138 UnusedResults: UnusedResults,
139 NonCamelCaseTypes: NonCamelCaseTypes,
140 NonSnakeCase: NonSnakeCase,
141 NonUpperCaseGlobals: NonUpperCaseGlobals,
142 NonShorthandFieldPatterns: NonShorthandFieldPatterns,
143 UnsafeCode: UnsafeCode,
144 UnusedAllocation: UnusedAllocation,
145 MissingCopyImplementations: MissingCopyImplementations,
146 UnstableFeatures: UnstableFeatures,
147 UnconditionalRecursion: UnconditionalRecursion,
148 InvalidNoMangleItems: InvalidNoMangleItems,
149 PluginAsLibrary: PluginAsLibrary,
150 MutableTransmutes: MutableTransmutes,
151 UnionsWithDropFields: UnionsWithDropFields,
152 UnreachablePub: UnreachablePub,
153 UnnameableTestFunctions: UnnameableTestFunctions,
154 TypeAliasBounds: TypeAliasBounds,
155 UnusedBrokenConst: UnusedBrokenConst,
156 TrivialConstraints: TrivialConstraints,
157 TypeLimits: TypeLimits::new(),
158 MissingDoc: MissingDoc::new(),
159 MissingDebugImplementations: MissingDebugImplementations::new(),
162 store.register_late_pass(sess, false, box BuiltinCombinedLateLintPass::new());
164 add_lint_group!(sess,
166 NON_CAMEL_CASE_TYPES,
168 NON_UPPER_CASE_GLOBALS);
170 add_lint_group!(sess,
172 NON_CAMEL_CASE_TYPES,
174 NON_UPPER_CASE_GLOBALS);
176 add_lint_group!(sess,
184 UNREACHABLE_PATTERNS,
192 UNUSED_EXTERN_CRATES,
197 add_lint_group!(sess,
201 UNUSED_EXTERN_CRATES,
202 MACRO_USE_EXTERN_CRATE,
203 ELIDED_LIFETIMES_IN_PATHS,
204 ELLIPSIS_INCLUSIVE_RANGE_PATTERNS);
206 // Guidelines for creating a future incompatibility lint:
208 // - Create a lint defaulting to warn as normal, with ideally the same error
209 // message you would normally give
210 // - Add a suitable reference, typically an RFC or tracking issue. Go ahead
211 // and include the full URL, sort items in ascending order of issue numbers.
212 // - Later, change lint to error
213 // - Eventually, remove lint
214 store.register_future_incompatible(sess,
216 FutureIncompatibleInfo {
217 id: LintId::of(PRIVATE_IN_PUBLIC),
218 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
221 FutureIncompatibleInfo {
222 id: LintId::of(PUB_USE_OF_PRIVATE_EXTERN_CRATE),
223 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
226 FutureIncompatibleInfo {
227 id: LintId::of(PATTERNS_IN_FNS_WITHOUT_BODY),
228 reference: "issue #35203 <https://github.com/rust-lang/rust/issues/35203>",
231 FutureIncompatibleInfo {
232 id: LintId::of(DUPLICATE_MACRO_EXPORTS),
233 reference: "issue #35896 <https://github.com/rust-lang/rust/issues/35896>",
234 edition: Some(Edition::Edition2018),
236 FutureIncompatibleInfo {
237 id: LintId::of(ASYNC_IDENTS),
238 reference: "issue #49716 <https://github.com/rust-lang/rust/issues/49716>",
239 edition: Some(Edition::Edition2018),
241 FutureIncompatibleInfo {
242 id: LintId::of(SAFE_EXTERN_STATICS),
243 reference: "issue #36247 <https://github.com/rust-lang/rust/issues/36247>",
246 FutureIncompatibleInfo {
247 id: LintId::of(INVALID_TYPE_PARAM_DEFAULT),
248 reference: "issue #36887 <https://github.com/rust-lang/rust/issues/36887>",
251 FutureIncompatibleInfo {
252 id: LintId::of(LEGACY_DIRECTORY_OWNERSHIP),
253 reference: "issue #37872 <https://github.com/rust-lang/rust/issues/37872>",
256 FutureIncompatibleInfo {
257 id: LintId::of(LEGACY_CONSTRUCTOR_VISIBILITY),
258 reference: "issue #39207 <https://github.com/rust-lang/rust/issues/39207>",
261 FutureIncompatibleInfo {
262 id: LintId::of(MISSING_FRAGMENT_SPECIFIER),
263 reference: "issue #40107 <https://github.com/rust-lang/rust/issues/40107>",
266 FutureIncompatibleInfo {
267 id: LintId::of(ILLEGAL_FLOATING_POINT_LITERAL_PATTERN),
268 reference: "issue #41620 <https://github.com/rust-lang/rust/issues/41620>",
271 FutureIncompatibleInfo {
272 id: LintId::of(ANONYMOUS_PARAMETERS),
273 reference: "issue #41686 <https://github.com/rust-lang/rust/issues/41686>",
276 FutureIncompatibleInfo {
277 id: LintId::of(PARENTHESIZED_PARAMS_IN_TYPES_AND_MODULES),
278 reference: "issue #42238 <https://github.com/rust-lang/rust/issues/42238>",
281 FutureIncompatibleInfo {
282 id: LintId::of(LATE_BOUND_LIFETIME_ARGUMENTS),
283 reference: "issue #42868 <https://github.com/rust-lang/rust/issues/42868>",
286 FutureIncompatibleInfo {
287 id: LintId::of(SAFE_PACKED_BORROWS),
288 reference: "issue #46043 <https://github.com/rust-lang/rust/issues/46043>",
291 FutureIncompatibleInfo {
292 id: LintId::of(INCOHERENT_FUNDAMENTAL_IMPLS),
293 reference: "issue #46205 <https://github.com/rust-lang/rust/issues/46205>",
296 FutureIncompatibleInfo {
297 id: LintId::of(TYVAR_BEHIND_RAW_POINTER),
298 reference: "issue #46906 <https://github.com/rust-lang/rust/issues/46906>",
299 edition: Some(Edition::Edition2018),
301 FutureIncompatibleInfo {
302 id: LintId::of(UNSTABLE_NAME_COLLISIONS),
303 reference: "issue #48919 <https://github.com/rust-lang/rust/issues/48919>",
305 // Note: this item represents future incompatibility of all unstable functions in the
306 // standard library, and thus should never be removed or changed to an error.
308 FutureIncompatibleInfo {
309 id: LintId::of(ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE),
310 reference: "issue TBD",
311 edition: Some(Edition::Edition2018),
313 FutureIncompatibleInfo {
314 id: LintId::of(WHERE_CLAUSES_OBJECT_SAFETY),
315 reference: "issue #51443 <https://github.com/rust-lang/rust/issues/51443>",
318 FutureIncompatibleInfo {
319 id: LintId::of(DUPLICATE_ASSOCIATED_TYPE_BINDINGS),
320 reference: "issue #50589 <https://github.com/rust-lang/rust/issues/50589>",
323 FutureIncompatibleInfo {
324 id: LintId::of(PROC_MACRO_DERIVE_RESOLUTION_FALLBACK),
325 reference: "issue #50504 <https://github.com/rust-lang/rust/issues/50504>",
328 FutureIncompatibleInfo {
329 id: LintId::of(QUESTION_MARK_MACRO_SEP),
330 reference: "issue #48075 <https://github.com/rust-lang/rust/issues/48075>",
331 edition: Some(Edition::Edition2018),
335 // Register renamed and removed lints
336 store.register_renamed("single_use_lifetime", "single_use_lifetimes");
337 store.register_renamed("elided_lifetime_in_path", "elided_lifetimes_in_paths");
338 store.register_renamed("bare_trait_object", "bare_trait_objects");
339 store.register_renamed("unstable_name_collision", "unstable_name_collisions");
340 store.register_renamed("unused_doc_comment", "unused_doc_comments");
341 store.register_renamed("unknown_features", "unused_features");
342 store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate");
343 store.register_removed("negate_unsigned", "cast a signed value instead");
344 store.register_removed("raw_pointer_derive", "using derive with raw pointers is ok");
345 // This was renamed to raw_pointer_derive, which was then removed,
346 // so it is also considered removed
347 store.register_removed("raw_pointer_deriving", "using derive with raw pointers is ok");
348 store.register_removed("drop_with_repr_extern", "drop flags have been removed");
349 store.register_removed("fat_ptr_transmutes", "was accidentally removed back in 2014");
350 store.register_removed("deprecated_attr", "use `deprecated` instead");
351 store.register_removed("transmute_from_fn_item_types",
352 "always cast functions before transmuting them");
353 store.register_removed("hr_lifetime_in_assoc_type",
354 "converted into hard error, see https://github.com/rust-lang/rust/issues/33685");
355 store.register_removed("inaccessible_extern_crate",
356 "converted into hard error, see https://github.com/rust-lang/rust/issues/36886");
357 store.register_removed("super_or_self_in_global_path",
358 "converted into hard error, see https://github.com/rust-lang/rust/issues/36888");
359 store.register_removed("overlapping_inherent_impls",
360 "converted into hard error, see https://github.com/rust-lang/rust/issues/36889");
361 store.register_removed("illegal_floating_point_constant_pattern",
362 "converted into hard error, see https://github.com/rust-lang/rust/issues/36890");
363 store.register_removed("illegal_struct_or_enum_constant_pattern",
364 "converted into hard error, see https://github.com/rust-lang/rust/issues/36891");
365 store.register_removed("lifetime_underscore",
366 "converted into hard error, see https://github.com/rust-lang/rust/issues/36892");
367 store.register_removed("extra_requirement_in_impl",
368 "converted into hard error, see https://github.com/rust-lang/rust/issues/37166");
369 store.register_removed("legacy_imports",
370 "converted into hard error, see https://github.com/rust-lang/rust/issues/38260");
371 store.register_removed("coerce_never",
372 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
373 store.register_removed("resolve_trait_on_defaulted_unit",
374 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");