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)]
31 #![feature(rustc_diagnostic_macros)]
32 #![feature(macro_at_most_once_rep)]
40 extern crate rustc_mir;
41 extern crate rustc_target;
42 extern crate syntax_pos;
45 use rustc::lint::{LateContext, LateLintPass, LintPass, LintArray};
46 use rustc::lint::builtin::{
48 ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
49 ELIDED_LIFETIMES_IN_PATHS,
50 EXPLICIT_OUTLIVES_REQUIREMENTS,
51 parser::QUESTION_MARK_MACRO_SEP
61 use syntax::edition::Edition;
63 use lint::FutureIncompatibleInfo;
66 mod nonstandard_style;
71 use nonstandard_style::*;
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_pre_expansion_pass($sess, 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, None, 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 InvalidNoMangleItems: InvalidNoMangleItems,
148 PluginAsLibrary: PluginAsLibrary,
149 MutableTransmutes: MutableTransmutes,
150 UnionsWithDropFields: UnionsWithDropFields,
151 UnreachablePub: UnreachablePub,
152 UnnameableTestItems: UnnameableTestItems::new(),
153 TypeAliasBounds: TypeAliasBounds,
154 UnusedBrokenConst: UnusedBrokenConst,
155 TrivialConstraints: TrivialConstraints,
156 TypeLimits: TypeLimits::new(),
157 MissingDoc: MissingDoc::new(),
158 MissingDebugImplementations: MissingDebugImplementations::new(),
159 ExplicitOutlivesRequirements: ExplicitOutlivesRequirements,
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,
200 UNUSED_EXTERN_CRATES,
201 ELLIPSIS_INCLUSIVE_RANGE_PATTERNS,
202 ELIDED_LIFETIMES_IN_PATHS,
203 EXPLICIT_OUTLIVES_REQUIREMENTS
205 // FIXME(#52665, #47816) not always applicable and not all
206 // macros are ready for this yet.
209 // FIXME macro crates are not up for this yet, too much
210 // breakage is seen if we try to encourage this lint.
211 // MACRO_USE_EXTERN_CRATE,
214 // Guidelines for creating a future incompatibility lint:
216 // - Create a lint defaulting to warn as normal, with ideally the same error
217 // message you would normally give
218 // - Add a suitable reference, typically an RFC or tracking issue. Go ahead
219 // and include the full URL, sort items in ascending order of issue numbers.
220 // - Later, change lint to error
221 // - Eventually, remove lint
222 store.register_future_incompatible(sess,
224 FutureIncompatibleInfo {
225 id: LintId::of(PRIVATE_IN_PUBLIC),
226 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
229 FutureIncompatibleInfo {
230 id: LintId::of(PUB_USE_OF_PRIVATE_EXTERN_CRATE),
231 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
234 FutureIncompatibleInfo {
235 id: LintId::of(PATTERNS_IN_FNS_WITHOUT_BODY),
236 reference: "issue #35203 <https://github.com/rust-lang/rust/issues/35203>",
239 FutureIncompatibleInfo {
240 id: LintId::of(DUPLICATE_MACRO_EXPORTS),
241 reference: "issue #35896 <https://github.com/rust-lang/rust/issues/35896>",
242 edition: Some(Edition::Edition2018),
244 FutureIncompatibleInfo {
245 id: LintId::of(KEYWORD_IDENTS),
246 reference: "issue #49716 <https://github.com/rust-lang/rust/issues/49716>",
247 edition: Some(Edition::Edition2018),
249 FutureIncompatibleInfo {
250 id: LintId::of(SAFE_EXTERN_STATICS),
251 reference: "issue #36247 <https://github.com/rust-lang/rust/issues/36247>",
254 FutureIncompatibleInfo {
255 id: LintId::of(INVALID_TYPE_PARAM_DEFAULT),
256 reference: "issue #36887 <https://github.com/rust-lang/rust/issues/36887>",
259 FutureIncompatibleInfo {
260 id: LintId::of(LEGACY_DIRECTORY_OWNERSHIP),
261 reference: "issue #37872 <https://github.com/rust-lang/rust/issues/37872>",
264 FutureIncompatibleInfo {
265 id: LintId::of(LEGACY_CONSTRUCTOR_VISIBILITY),
266 reference: "issue #39207 <https://github.com/rust-lang/rust/issues/39207>",
269 FutureIncompatibleInfo {
270 id: LintId::of(MISSING_FRAGMENT_SPECIFIER),
271 reference: "issue #40107 <https://github.com/rust-lang/rust/issues/40107>",
274 FutureIncompatibleInfo {
275 id: LintId::of(ILLEGAL_FLOATING_POINT_LITERAL_PATTERN),
276 reference: "issue #41620 <https://github.com/rust-lang/rust/issues/41620>",
279 FutureIncompatibleInfo {
280 id: LintId::of(ANONYMOUS_PARAMETERS),
281 reference: "issue #41686 <https://github.com/rust-lang/rust/issues/41686>",
282 edition: Some(Edition::Edition2018),
284 FutureIncompatibleInfo {
285 id: LintId::of(PARENTHESIZED_PARAMS_IN_TYPES_AND_MODULES),
286 reference: "issue #42238 <https://github.com/rust-lang/rust/issues/42238>",
289 FutureIncompatibleInfo {
290 id: LintId::of(LATE_BOUND_LIFETIME_ARGUMENTS),
291 reference: "issue #42868 <https://github.com/rust-lang/rust/issues/42868>",
294 FutureIncompatibleInfo {
295 id: LintId::of(SAFE_PACKED_BORROWS),
296 reference: "issue #46043 <https://github.com/rust-lang/rust/issues/46043>",
299 FutureIncompatibleInfo {
300 id: LintId::of(INCOHERENT_FUNDAMENTAL_IMPLS),
301 reference: "issue #46205 <https://github.com/rust-lang/rust/issues/46205>",
304 FutureIncompatibleInfo {
305 id: LintId::of(TYVAR_BEHIND_RAW_POINTER),
306 reference: "issue #46906 <https://github.com/rust-lang/rust/issues/46906>",
307 edition: Some(Edition::Edition2018),
309 FutureIncompatibleInfo {
310 id: LintId::of(UNSTABLE_NAME_COLLISIONS),
311 reference: "issue #48919 <https://github.com/rust-lang/rust/issues/48919>",
313 // Note: this item represents future incompatibility of all unstable functions in the
314 // standard library, and thus should never be removed or changed to an error.
316 FutureIncompatibleInfo {
317 id: LintId::of(ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE),
318 reference: "issue TBD",
319 edition: Some(Edition::Edition2018),
321 FutureIncompatibleInfo {
322 id: LintId::of(WHERE_CLAUSES_OBJECT_SAFETY),
323 reference: "issue #51443 <https://github.com/rust-lang/rust/issues/51443>",
326 FutureIncompatibleInfo {
327 id: LintId::of(DUPLICATE_ASSOCIATED_TYPE_BINDINGS),
328 reference: "issue #50589 <https://github.com/rust-lang/rust/issues/50589>",
331 FutureIncompatibleInfo {
332 id: LintId::of(PROC_MACRO_DERIVE_RESOLUTION_FALLBACK),
333 reference: "issue #50504 <https://github.com/rust-lang/rust/issues/50504>",
336 FutureIncompatibleInfo {
337 id: LintId::of(QUESTION_MARK_MACRO_SEP),
338 reference: "issue #48075 <https://github.com/rust-lang/rust/issues/48075>",
339 edition: Some(Edition::Edition2018),
341 FutureIncompatibleInfo {
342 id: LintId::of(MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS),
343 reference: "issue #52234 <https://github.com/rust-lang/rust/issues/52234>",
348 // Register renamed and removed lints
349 store.register_renamed("single_use_lifetime", "single_use_lifetimes");
350 store.register_renamed("elided_lifetime_in_path", "elided_lifetimes_in_paths");
351 store.register_renamed("bare_trait_object", "bare_trait_objects");
352 store.register_renamed("unstable_name_collision", "unstable_name_collisions");
353 store.register_renamed("unused_doc_comment", "unused_doc_comments");
354 store.register_renamed("async_idents", "keyword_idents");
355 store.register_removed("unknown_features", "replaced by an error");
356 store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate");
357 store.register_removed("negate_unsigned", "cast a signed value instead");
358 store.register_removed("raw_pointer_derive", "using derive with raw pointers is ok");
359 // This was renamed to raw_pointer_derive, which was then removed,
360 // so it is also considered removed
361 store.register_removed("raw_pointer_deriving", "using derive with raw pointers is ok");
362 store.register_removed("drop_with_repr_extern", "drop flags have been removed");
363 store.register_removed("fat_ptr_transmutes", "was accidentally removed back in 2014");
364 store.register_removed("deprecated_attr", "use `deprecated` instead");
365 store.register_removed("transmute_from_fn_item_types",
366 "always cast functions before transmuting them");
367 store.register_removed("hr_lifetime_in_assoc_type",
368 "converted into hard error, see https://github.com/rust-lang/rust/issues/33685");
369 store.register_removed("inaccessible_extern_crate",
370 "converted into hard error, see https://github.com/rust-lang/rust/issues/36886");
371 store.register_removed("super_or_self_in_global_path",
372 "converted into hard error, see https://github.com/rust-lang/rust/issues/36888");
373 store.register_removed("overlapping_inherent_impls",
374 "converted into hard error, see https://github.com/rust-lang/rust/issues/36889");
375 store.register_removed("illegal_floating_point_constant_pattern",
376 "converted into hard error, see https://github.com/rust-lang/rust/issues/36890");
377 store.register_removed("illegal_struct_or_enum_constant_pattern",
378 "converted into hard error, see https://github.com/rust-lang/rust/issues/36891");
379 store.register_removed("lifetime_underscore",
380 "converted into hard error, see https://github.com/rust-lang/rust/issues/36892");
381 store.register_removed("extra_requirement_in_impl",
382 "converted into hard error, see https://github.com/rust-lang/rust/issues/37166");
383 store.register_removed("legacy_imports",
384 "converted into hard error, see https://github.com/rust-lang/rust/issues/38260");
385 store.register_removed("coerce_never",
386 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
387 store.register_removed("resolve_trait_on_defaulted_unit",
388 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");