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)]
38 extern crate rustc_mir;
39 extern crate rustc_target;
40 extern crate syntax_pos;
43 use rustc::lint::builtin::{BARE_TRAIT_OBJECT, ABSOLUTE_PATH_STARTING_WITH_MODULE};
48 use syntax::edition::Edition;
50 use lint::FutureIncompatibleInfo;
62 /// Tell the `LintStore` about all the built-in lints (the ones
63 /// defined in this crate and the ones defined in
64 /// `rustc::lint::builtin`).
65 pub fn register_builtins(store: &mut lint::LintStore, sess: Option<&Session>) {
66 macro_rules! add_builtin {
67 ($sess:ident, $($name:ident),*,) => (
69 store.register_late_pass($sess, false, box $name);
74 macro_rules! add_early_builtin {
75 ($sess:ident, $($name:ident),*,) => (
77 store.register_early_pass($sess, false, box $name);
82 macro_rules! add_builtin_with_new {
83 ($sess:ident, $($name:ident),*,) => (
85 store.register_late_pass($sess, false, box $name::new());
90 macro_rules! add_early_builtin_with_new {
91 ($sess:ident, $($name:ident),*,) => (
93 store.register_early_pass($sess, false, box $name::new());
98 macro_rules! add_lint_group {
99 ($sess:ident, $name:expr, $($lint:ident),*) => (
100 store.register_group($sess, false, $name, vec![$(LintId::of($lint)),*]);
104 add_early_builtin!(sess,
111 add_early_builtin_with_new!(sess,
119 VariantSizeDifferences,
127 NonShorthandFieldPatterns,
130 MissingCopyImplementations,
132 UnconditionalRecursion,
133 InvalidNoMangleItems,
136 UnionsWithDropFields,
142 add_builtin_with_new!(sess,
145 MissingDebugImplementations,
149 add_lint_group!(sess,
151 NON_CAMEL_CASE_TYPES,
153 NON_UPPER_CASE_GLOBALS);
155 add_lint_group!(sess,
157 NON_CAMEL_CASE_TYPES,
159 NON_UPPER_CASE_GLOBALS);
161 add_lint_group!(sess,
169 UNREACHABLE_PATTERNS,
177 UNUSED_EXTERN_CRATES,
181 add_lint_group!(sess,
182 "rust_2018_migration",
185 UNNECESSARY_EXTERN_CRATE);
187 // Guidelines for creating a future incompatibility lint:
189 // - Create a lint defaulting to warn as normal, with ideally the same error
190 // message you would normally give
191 // - Add a suitable reference, typically an RFC or tracking issue. Go ahead
192 // and include the full URL, sort items in ascending order of issue numbers.
193 // - Later, change lint to error
194 // - Eventually, remove lint
195 store.register_future_incompatible(sess,
197 FutureIncompatibleInfo {
198 id: LintId::of(PRIVATE_IN_PUBLIC),
199 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
202 FutureIncompatibleInfo {
203 id: LintId::of(PUB_USE_OF_PRIVATE_EXTERN_CRATE),
204 reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
207 FutureIncompatibleInfo {
208 id: LintId::of(PATTERNS_IN_FNS_WITHOUT_BODY),
209 reference: "issue #35203 <https://github.com/rust-lang/rust/issues/35203>",
212 FutureIncompatibleInfo {
213 id: LintId::of(SAFE_EXTERN_STATICS),
214 reference: "issue #36247 <https://github.com/rust-lang/rust/issues/36247>",
217 FutureIncompatibleInfo {
218 id: LintId::of(INVALID_TYPE_PARAM_DEFAULT),
219 reference: "issue #36887 <https://github.com/rust-lang/rust/issues/36887>",
222 FutureIncompatibleInfo {
223 id: LintId::of(LEGACY_DIRECTORY_OWNERSHIP),
224 reference: "issue #37872 <https://github.com/rust-lang/rust/issues/37872>",
227 FutureIncompatibleInfo {
228 id: LintId::of(LEGACY_IMPORTS),
229 reference: "issue #38260 <https://github.com/rust-lang/rust/issues/38260>",
232 FutureIncompatibleInfo {
233 id: LintId::of(LEGACY_CONSTRUCTOR_VISIBILITY),
234 reference: "issue #39207 <https://github.com/rust-lang/rust/issues/39207>",
237 FutureIncompatibleInfo {
238 id: LintId::of(MISSING_FRAGMENT_SPECIFIER),
239 reference: "issue #40107 <https://github.com/rust-lang/rust/issues/40107>",
242 FutureIncompatibleInfo {
243 id: LintId::of(ILLEGAL_FLOATING_POINT_LITERAL_PATTERN),
244 reference: "issue #41620 <https://github.com/rust-lang/rust/issues/41620>",
247 FutureIncompatibleInfo {
248 id: LintId::of(ANONYMOUS_PARAMETERS),
249 reference: "issue #41686 <https://github.com/rust-lang/rust/issues/41686>",
252 FutureIncompatibleInfo {
253 id: LintId::of(PARENTHESIZED_PARAMS_IN_TYPES_AND_MODULES),
254 reference: "issue #42238 <https://github.com/rust-lang/rust/issues/42238>",
257 FutureIncompatibleInfo {
258 id: LintId::of(LATE_BOUND_LIFETIME_ARGUMENTS),
259 reference: "issue #42868 <https://github.com/rust-lang/rust/issues/42868>",
262 FutureIncompatibleInfo {
263 id: LintId::of(SAFE_PACKED_BORROWS),
264 reference: "issue #46043 <https://github.com/rust-lang/rust/issues/46043>",
267 FutureIncompatibleInfo {
268 id: LintId::of(INCOHERENT_FUNDAMENTAL_IMPLS),
269 reference: "issue #46205 <https://github.com/rust-lang/rust/issues/46205>",
272 FutureIncompatibleInfo {
273 id: LintId::of(TYVAR_BEHIND_RAW_POINTER),
274 reference: "issue #46906 <https://github.com/rust-lang/rust/issues/46906>",
275 edition: Some(Edition::Edition2018),
277 FutureIncompatibleInfo {
278 id: LintId::of(UNSTABLE_NAME_COLLISION),
279 reference: "issue #48919 <https://github.com/rust-lang/rust/issues/48919>",
281 // Note: this item represents future incompatibility of all unstable functions in the
282 // standard library, and thus should never be removed or changed to an error.
284 FutureIncompatibleInfo {
285 id: LintId::of(ABSOLUTE_PATH_STARTING_WITH_MODULE),
286 reference: "issue TBD",
287 edition: Some(Edition::Edition2018),
291 // Register renamed and removed lints
292 store.register_renamed("unknown_features", "unused_features");
293 store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate");
294 store.register_removed("negate_unsigned", "cast a signed value instead");
295 store.register_removed("raw_pointer_derive", "using derive with raw pointers is ok");
296 // This was renamed to raw_pointer_derive, which was then removed,
297 // so it is also considered removed
298 store.register_removed("raw_pointer_deriving", "using derive with raw pointers is ok");
299 store.register_removed("drop_with_repr_extern", "drop flags have been removed");
300 store.register_removed("fat_ptr_transmutes", "was accidentally removed back in 2014");
301 store.register_removed("deprecated_attr", "use `deprecated` instead");
302 store.register_removed("transmute_from_fn_item_types",
303 "always cast functions before transmuting them");
304 store.register_removed("hr_lifetime_in_assoc_type",
305 "converted into hard error, see https://github.com/rust-lang/rust/issues/33685");
306 store.register_removed("inaccessible_extern_crate",
307 "converted into hard error, see https://github.com/rust-lang/rust/issues/36886");
308 store.register_removed("super_or_self_in_global_path",
309 "converted into hard error, see https://github.com/rust-lang/rust/issues/36888");
310 store.register_removed("overlapping_inherent_impls",
311 "converted into hard error, see https://github.com/rust-lang/rust/issues/36889");
312 store.register_removed("illegal_floating_point_constant_pattern",
313 "converted into hard error, see https://github.com/rust-lang/rust/issues/36890");
314 store.register_removed("illegal_struct_or_enum_constant_pattern",
315 "converted into hard error, see https://github.com/rust-lang/rust/issues/36891");
316 store.register_removed("lifetime_underscore",
317 "converted into hard error, see https://github.com/rust-lang/rust/issues/36892");
318 store.register_removed("extra_requirement_in_impl",
319 "converted into hard error, see https://github.com/rust-lang/rust/issues/37166");
320 store.register_removed("coerce_never",
321 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");
322 store.register_removed("resolve_trait_on_defaulted_unit",
323 "converted into hard error, see https://github.com/rust-lang/rust/issues/48950");