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::builtin::{BARE_TRAIT_OBJECTS, ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE};
49 use syntax::edition::Edition;
51 use lint::FutureIncompatibleInfo;
63 /// Useful for other parts of the compiler.
64 pub use builtin::SoftLints;
66 /// Tell the `LintStore` about all the built-in lints (the ones
67 /// defined in this crate and the ones defined in
68 /// `rustc::lint::builtin`).
69 pub fn register_builtins(store: &mut lint::LintStore, sess: Option<&Session>) {
70 macro_rules! add_builtin {
71 ($sess:ident, $($name:ident),*,) => (
73 store.register_late_pass($sess, false, box $name);
78 macro_rules! add_early_builtin {
79 ($sess:ident, $($name:ident),*,) => (
81 store.register_early_pass($sess, false, box $name);
86 macro_rules! add_builtin_with_new {
87 ($sess:ident, $($name:ident),*,) => (
89 store.register_late_pass($sess, false, box $name::new());
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_early_builtin!(sess,
116 add_early_builtin_with_new!(sess,
124 VariantSizeDifferences,
132 NonShorthandFieldPatterns,
135 MissingCopyImplementations,
137 UnconditionalRecursion,
138 InvalidNoMangleItems,
141 UnionsWithDropFields,
148 add_builtin_with_new!(sess,
151 MissingDebugImplementations,
154 add_lint_group!(sess,
156 NON_CAMEL_CASE_TYPES,
158 NON_UPPER_CASE_GLOBALS);
160 add_lint_group!(sess,
162 NON_CAMEL_CASE_TYPES,
164 NON_UPPER_CASE_GLOBALS);
166 add_lint_group!(sess,
174 UNREACHABLE_PATTERNS,
182 UNUSED_EXTERN_CRATES,
187 add_lint_group!(sess,
191 UNUSED_EXTERN_CRATES);
193 // Guidelines for creating a future incompatibility lint:
195 // - Create a lint defaulting to warn as normal, with ideally the same error
196 // message you would normally give
197 // - Add a suitable reference, typically an RFC or tracking issue. Go ahead
198 // and include the full URL, sort items in ascending order of issue numbers.
199 // - Later, change lint to error
200 // - Eventually, remove lint
201 store.register_future_incompatible(sess,
203 FutureIncompatibleInfo {
204 id: LintId::of(PRIVATE_IN_PUBLIC),
205 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
208 FutureIncompatibleInfo {
209 id: LintId::of(PUB_USE_OF_PRIVATE_EXTERN_CRATE),
210 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
213 FutureIncompatibleInfo {
214 id: LintId::of(PATTERNS_IN_FNS_WITHOUT_BODY),
215 reference: "issue #35203 <https://github.com/rust-lang/rust/issues/35203>",
218 FutureIncompatibleInfo {
219 id: LintId::of(DUPLICATE_MACRO_EXPORTS),
220 reference: "issue #35896 <https://github.com/rust-lang/rust/issues/35896>",
221 edition: Some(Edition::Edition2018),
223 FutureIncompatibleInfo {
224 id: LintId::of(SAFE_EXTERN_STATICS),
225 reference: "issue #36247 <https://github.com/rust-lang/rust/issues/36247>",
228 FutureIncompatibleInfo {
229 id: LintId::of(INVALID_TYPE_PARAM_DEFAULT),
230 reference: "issue #36887 <https://github.com/rust-lang/rust/issues/36887>",
233 FutureIncompatibleInfo {
234 id: LintId::of(LEGACY_DIRECTORY_OWNERSHIP),
235 reference: "issue #37872 <https://github.com/rust-lang/rust/issues/37872>",
238 FutureIncompatibleInfo {
239 id: LintId::of(LEGACY_CONSTRUCTOR_VISIBILITY),
240 reference: "issue #39207 <https://github.com/rust-lang/rust/issues/39207>",
243 FutureIncompatibleInfo {
244 id: LintId::of(MISSING_FRAGMENT_SPECIFIER),
245 reference: "issue #40107 <https://github.com/rust-lang/rust/issues/40107>",
248 FutureIncompatibleInfo {
249 id: LintId::of(ILLEGAL_FLOATING_POINT_LITERAL_PATTERN),
250 reference: "issue #41620 <https://github.com/rust-lang/rust/issues/41620>",
253 FutureIncompatibleInfo {
254 id: LintId::of(ANONYMOUS_PARAMETERS),
255 reference: "issue #41686 <https://github.com/rust-lang/rust/issues/41686>",
258 FutureIncompatibleInfo {
259 id: LintId::of(PARENTHESIZED_PARAMS_IN_TYPES_AND_MODULES),
260 reference: "issue #42238 <https://github.com/rust-lang/rust/issues/42238>",
263 FutureIncompatibleInfo {
264 id: LintId::of(LATE_BOUND_LIFETIME_ARGUMENTS),
265 reference: "issue #42868 <https://github.com/rust-lang/rust/issues/42868>",
268 FutureIncompatibleInfo {
269 id: LintId::of(SAFE_PACKED_BORROWS),
270 reference: "issue #46043 <https://github.com/rust-lang/rust/issues/46043>",
273 FutureIncompatibleInfo {
274 id: LintId::of(INCOHERENT_FUNDAMENTAL_IMPLS),
275 reference: "issue #46205 <https://github.com/rust-lang/rust/issues/46205>",
278 FutureIncompatibleInfo {
279 id: LintId::of(TYVAR_BEHIND_RAW_POINTER),
280 reference: "issue #46906 <https://github.com/rust-lang/rust/issues/46906>",
281 edition: Some(Edition::Edition2018),
283 FutureIncompatibleInfo {
284 id: LintId::of(UNSTABLE_NAME_COLLISIONS),
285 reference: "issue #48919 <https://github.com/rust-lang/rust/issues/48919>",
287 // Note: this item represents future incompatibility of all unstable functions in the
288 // standard library, and thus should never be removed or changed to an error.
290 FutureIncompatibleInfo {
291 id: LintId::of(ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE),
292 reference: "issue TBD",
293 edition: Some(Edition::Edition2018),
295 FutureIncompatibleInfo {
296 id: LintId::of(DUPLICATE_ASSOCIATED_TYPE_BINDINGS),
297 reference: "issue #50589 <https://github.com/rust-lang/rust/issues/50589>",
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("unknown_features", "unused_features");
309 store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate");
310 store.register_removed("negate_unsigned", "cast a signed value instead");
311 store.register_removed("raw_pointer_derive", "using derive with raw pointers is ok");
312 // This was renamed to raw_pointer_derive, which was then removed,
313 // so it is also considered removed
314 store.register_removed("raw_pointer_deriving", "using derive with raw pointers is ok");
315 store.register_removed("drop_with_repr_extern", "drop flags have been removed");
316 store.register_removed("fat_ptr_transmutes", "was accidentally removed back in 2014");
317 store.register_removed("deprecated_attr", "use `deprecated` instead");
318 store.register_removed("transmute_from_fn_item_types",
319 "always cast functions before transmuting them");
320 store.register_removed("hr_lifetime_in_assoc_type",
321 "converted into hard error, see https://github.com/rust-lang/rust/issues/33685");
322 store.register_removed("inaccessible_extern_crate",
323 "converted into hard error, see https://github.com/rust-lang/rust/issues/36886");
324 store.register_removed("super_or_self_in_global_path",
325 "converted into hard error, see https://github.com/rust-lang/rust/issues/36888");
326 store.register_removed("overlapping_inherent_impls",
327 "converted into hard error, see https://github.com/rust-lang/rust/issues/36889");
328 store.register_removed("illegal_floating_point_constant_pattern",
329 "converted into hard error, see https://github.com/rust-lang/rust/issues/36890");
330 store.register_removed("illegal_struct_or_enum_constant_pattern",
331 "converted into hard error, see https://github.com/rust-lang/rust/issues/36891");
332 store.register_removed("lifetime_underscore",
333 "converted into hard error, see https://github.com/rust-lang/rust/issues/36892");
334 store.register_removed("extra_requirement_in_impl",
335 "converted into hard error, see https://github.com/rust-lang/rust/issues/37166");
336 store.register_removed("legacy_imports",
337 "converted into hard error, see https://github.com/rust-lang/rust/issues/38260");
338 store.register_removed("coerce_never",
339 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
340 store.register_removed("resolve_trait_on_defaulted_unit",
341 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");