compiler/rustc_lint/src/nonstandard_style.rs

   1 use crate::{EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintContext};
   2 use rustc_ast as ast;
   3 use rustc_attr as attr;
   4 use rustc_errors::{fluent, Applicability};
   5 use rustc_hir as hir;
   6 use rustc_hir::def::{DefKind, Res};
   7 use rustc_hir::intravisit::FnKind;
   8 use rustc_hir::{GenericParamKind, PatKind};
   9 use rustc_middle::ty;
  10 use rustc_span::symbol::sym;
  11 use rustc_span::{symbol::Ident, BytePos, Span};
  12 use rustc_target::spec::abi::Abi;
  13
  14 #[derive(PartialEq)]
  15 pub enum MethodLateContext {
  16     TraitAutoImpl,
  17     TraitImpl,
  18     PlainImpl,
  19 }
  20
  21 pub fn method_context(cx: &LateContext<'_>, id: hir::HirId) -> MethodLateContext {
  22     let def_id = cx.tcx.hir().local_def_id(id);
  23     let item = cx.tcx.associated_item(def_id);
  24     match item.container {
  25         ty::TraitContainer(..) => MethodLateContext::TraitAutoImpl,
  26         ty::ImplContainer(cid) => match cx.tcx.impl_trait_ref(cid) {
  27             Some(_) => MethodLateContext::TraitImpl,
  28             None => MethodLateContext::PlainImpl,
  29         },
  30     }
  31 }
  32
  33 declare_lint! {
  34     /// The `non_camel_case_types` lint detects types, variants, traits and
  35     /// type parameters that don't have camel case names.
  36     ///
  37     /// ### Example
  38     ///
  39     /// ```rust
  40     /// struct my_struct;
  41     /// ```
  42     ///
  43     /// {{produces}}
  44     ///
  45     /// ### Explanation
  46     ///
  47     /// The preferred style for these identifiers is to use "camel case", such
  48     /// as `MyStruct`, where the first letter should not be lowercase, and
  49     /// should not use underscores between letters. Underscores are allowed at
  50     /// the beginning and end of the identifier, as well as between
  51     /// non-letters (such as `X86_64`).
  52     pub NON_CAMEL_CASE_TYPES,
  53     Warn,
  54     "types, variants, traits and type parameters should have camel case names"
  55 }
  56
  57 declare_lint_pass!(NonCamelCaseTypes => [NON_CAMEL_CASE_TYPES]);
  58
  59 /// Some unicode characters *have* case, are considered upper case or lower case, but they *can't*
  60 /// be upper cased or lower cased. For the purposes of the lint suggestion, we care about being able
  61 /// to change the char's case.
  62 fn char_has_case(c: char) -> bool {
  63     let mut l = c.to_lowercase();
  64     let mut u = c.to_uppercase();
  65     while let Some(l) = l.next() {
  66         match u.next() {
  67             Some(u) if l != u => return true,
  68             _ => {}
  69         }
  70     }
  71     u.next().is_some()
  72 }
  73
  74 fn is_camel_case(name: &str) -> bool {
  75     let name = name.trim_matches('_');
  76     if name.is_empty() {
  77         return true;
  78     }
  79
  80     // start with a non-lowercase letter rather than non-uppercase
  81     // ones (some scripts don't have a concept of upper/lowercase)
  82     !name.chars().next().unwrap().is_lowercase()
  83         && !name.contains("__")
  84         && !name.chars().collect::<Vec<_>>().array_windows().any(|&[fst, snd]| {
  85             // contains a capitalisable character followed by, or preceded by, an underscore
  86             char_has_case(fst) && snd == '_' || char_has_case(snd) && fst == '_'
  87         })
  88 }
  89
  90 fn to_camel_case(s: &str) -> String {
  91     s.trim_matches('_')
  92         .split('_')
  93         .filter(|component| !component.is_empty())
  94         .map(|component| {
  95             let mut camel_cased_component = String::new();
  96
  97             let mut new_word = true;
  98             let mut prev_is_lower_case = true;
  99
 100             for c in component.chars() {
 101                 // Preserve the case if an uppercase letter follows a lowercase letter, so that
 102                 // `camelCase` is converted to `CamelCase`.
 103                 if prev_is_lower_case && c.is_uppercase() {
 104                     new_word = true;
 105                 }
 106
 107                 if new_word {
 108                     camel_cased_component.extend(c.to_uppercase());
 109                 } else {
 110                     camel_cased_component.extend(c.to_lowercase());
 111                 }
 112
 113                 prev_is_lower_case = c.is_lowercase();
 114                 new_word = false;
 115             }
 116
 117             camel_cased_component
 118         })
 119         .fold((String::new(), None), |(acc, prev): (String, Option<String>), next| {
 120             // separate two components with an underscore if their boundary cannot
 121             // be distinguished using an uppercase/lowercase case distinction
 122             let join = if let Some(prev) = prev {
 123                 let l = prev.chars().last().unwrap();
 124                 let f = next.chars().next().unwrap();
 125                 !char_has_case(l) && !char_has_case(f)
 126             } else {
 127                 false
 128             };
 129             (acc + if join { "_" } else { "" } + &next, Some(next))
 130         })
 131         .0
 132 }
 133
 134 impl NonCamelCaseTypes {
 135     fn check_case(&self, cx: &EarlyContext<'_>, sort: &str, ident: &Ident) {
 136         let name = ident.name.as_str();
 137
 138         if !is_camel_case(name) {
 139             cx.struct_span_lint(NON_CAMEL_CASE_TYPES, ident.span, |lint| {
 140                 let mut err = lint.build(fluent::lint::non_camel_case_type);
 141                 let cc = to_camel_case(name);
 142                 // We cannot provide meaningful suggestions
 143                 // if the characters are in the category of "Lowercase Letter".
 144                 if *name != cc {
 145                     err.span_suggestion(
 146                         ident.span,
 147                         fluent::lint::suggestion,
 148                         to_camel_case(name),
 149                         Applicability::MaybeIncorrect,
 150                     );
 151                 } else {
 152                     err.span_label(ident.span, fluent::lint::label);
 153                 }
 154
 155                 err.set_arg("sort", sort);
 156                 err.set_arg("name", name);
 157                 err.emit();
 158             })
 159         }
 160     }
 161 }
 162
 163 impl EarlyLintPass for NonCamelCaseTypes {
 164     fn check_item(&mut self, cx: &EarlyContext<'_>, it: &ast::Item) {
 165         let has_repr_c = it
 166             .attrs
 167             .iter()
 168             .any(|attr| attr::find_repr_attrs(cx.sess(), attr).contains(&attr::ReprC));
 169
 170         if has_repr_c {
 171             return;
 172         }
 173
 174         match it.kind {
 175             ast::ItemKind::TyAlias(..)
 176             | ast::ItemKind::Enum(..)
 177             | ast::ItemKind::Struct(..)
 178             | ast::ItemKind::Union(..) => self.check_case(cx, "type", &it.ident),
 179             ast::ItemKind::Trait(..) => self.check_case(cx, "trait", &it.ident),
 180             ast::ItemKind::TraitAlias(..) => self.check_case(cx, "trait alias", &it.ident),
 181             _ => (),
 182         }
 183     }
 184
 185     fn check_trait_item(&mut self, cx: &EarlyContext<'_>, it: &ast::AssocItem) {
 186         if let ast::AssocItemKind::TyAlias(..) = it.kind {
 187             self.check_case(cx, "associated type", &it.ident);
 188         }
 189     }
 190
 191     fn check_variant(&mut self, cx: &EarlyContext<'_>, v: &ast::Variant) {
 192         self.check_case(cx, "variant", &v.ident);
 193     }
 194
 195     fn check_generic_param(&mut self, cx: &EarlyContext<'_>, param: &ast::GenericParam) {
 196         if let ast::GenericParamKind::Type { .. } = param.kind {
 197             self.check_case(cx, "type parameter", &param.ident);
 198         }
 199     }
 200 }
 201
 202 declare_lint! {
 203     /// The `non_snake_case` lint detects variables, methods, functions,
 204     /// lifetime parameters and modules that don't have snake case names.
 205     ///
 206     /// ### Example
 207     ///
 208     /// ```rust
 209     /// let MY_VALUE = 5;
 210     /// ```
 211     ///
 212     /// {{produces}}
 213     ///
 214     /// ### Explanation
 215     ///
 216     /// The preferred style for these identifiers is to use "snake case",
 217     /// where all the characters are in lowercase, with words separated with a
 218     /// single underscore, such as `my_value`.
 219     pub NON_SNAKE_CASE,
 220     Warn,
 221     "variables, methods, functions, lifetime parameters and modules should have snake case names"
 222 }
 223
 224 declare_lint_pass!(NonSnakeCase => [NON_SNAKE_CASE]);
 225
 226 impl NonSnakeCase {
 227     fn to_snake_case(mut str: &str) -> String {
 228         let mut words = vec![];
 229         // Preserve leading underscores
 230         str = str.trim_start_matches(|c: char| {
 231             if c == '_' {
 232                 words.push(String::new());
 233                 true
 234             } else {
 235                 false
 236             }
 237         });
 238         for s in str.split('_') {
 239             let mut last_upper = false;
 240             let mut buf = String::new();
 241             if s.is_empty() {
 242                 continue;
 243             }
 244             for ch in s.chars() {
 245                 if !buf.is_empty() && buf != "'" && ch.is_uppercase() && !last_upper {
 246                     words.push(buf);
 247                     buf = String::new();
 248                 }
 249                 last_upper = ch.is_uppercase();
 250                 buf.extend(ch.to_lowercase());
 251             }
 252             words.push(buf);
 253         }
 254         words.join("_")
 255     }
 256
 257     /// Checks if a given identifier is snake case, and reports a diagnostic if not.
 258     fn check_snake_case(&self, cx: &LateContext<'_>, sort: &str, ident: &Ident) {
 259         fn is_snake_case(ident: &str) -> bool {
 260             if ident.is_empty() {
 261                 return true;
 262             }
 263             let ident = ident.trim_start_matches('\'');
 264             let ident = ident.trim_matches('_');
 265
 266             let mut allow_underscore = true;
 267             ident.chars().all(|c| {
 268                 allow_underscore = match c {
 269                     '_' if !allow_underscore => return false,
 270                     '_' => false,
 271                     // It would be more obvious to use `c.is_lowercase()`,
 272                     // but some characters do not have a lowercase form
 273                     c if !c.is_uppercase() => true,
 274                     _ => return false,
 275                 };
 276                 true
 277             })
 278         }
 279
 280         let name = ident.name.as_str();
 281
 282         if !is_snake_case(name) {
 283             cx.struct_span_lint(NON_SNAKE_CASE, ident.span, |lint| {
 284                 let sc = NonSnakeCase::to_snake_case(name);
 285                 let mut err = lint.build(fluent::lint::non_snake_case);
 286                 // We cannot provide meaningful suggestions
 287                 // if the characters are in the category of "Uppercase Letter".
 288                 if name != sc {
 289                     // We have a valid span in almost all cases, but we don't have one when linting a crate
 290                     // name provided via the command line.
 291                     if !ident.span.is_dummy() {
 292                         let sc_ident = Ident::from_str_and_span(&sc, ident.span);
 293                         let (message, suggestion) = if sc_ident.is_reserved() {
 294                             // We shouldn't suggest a reserved identifier to fix non-snake-case identifiers.
 295                             // Instead, recommend renaming the identifier entirely or, if permitted,
 296                             // escaping it to create a raw identifier.
 297                             if sc_ident.name.can_be_raw() {
 298                                 (fluent::lint::rename_or_convert_suggestion, sc_ident.to_string())
 299                             } else {
 300                                 err.note(fluent::lint::cannot_convert_note);
 301                                 (fluent::lint::rename_suggestion, String::new())
 302                             }
 303                         } else {
 304                             (fluent::lint::convert_suggestion, sc.clone())
 305                         };
 306
 307                         err.span_suggestion(
 308                             ident.span,
 309                             message,
 310                             suggestion,
 311                             Applicability::MaybeIncorrect,
 312                         );
 313                     } else {
 314                         err.help(fluent::lint::help);
 315                     }
 316                 } else {
 317                     err.span_label(ident.span, fluent::lint::label);
 318                 }
 319
 320                 err.set_arg("sort", sort);
 321                 err.set_arg("name", name);
 322                 err.set_arg("sc", sc);
 323                 err.emit();
 324             });
 325         }
 326     }
 327 }
 328
 329 impl<'tcx> LateLintPass<'tcx> for NonSnakeCase {
 330     fn check_mod(
 331         &mut self,
 332         cx: &LateContext<'_>,
 333         _: &'tcx hir::Mod<'tcx>,
 334         _: Span,
 335         id: hir::HirId,
 336     ) {
 337         if id != hir::CRATE_HIR_ID {
 338             return;
 339         }
 340
 341         let crate_ident = if let Some(name) = &cx.tcx.sess.opts.crate_name {
 342             Some(Ident::from_str(name))
 343         } else {
 344             cx.sess()
 345                 .find_by_name(&cx.tcx.hir().attrs(hir::CRATE_HIR_ID), sym::crate_name)
 346                 .and_then(|attr| attr.meta())
 347                 .and_then(|meta| {
 348                     meta.name_value_literal().and_then(|lit| {
 349                         if let ast::LitKind::Str(name, ..) = lit.kind {
 350                             // Discard the double quotes surrounding the literal.
 351                             let sp = cx
 352                                 .sess()
 353                                 .source_map()
 354                                 .span_to_snippet(lit.span)
 355                                 .ok()
 356                                 .and_then(|snippet| {
 357                                     let left = snippet.find('"')?;
 358                                     let right =
 359                                         snippet.rfind('"').map(|pos| snippet.len() - pos)?;
 360
 361                                     Some(
 362                                         lit.span
 363                                             .with_lo(lit.span.lo() + BytePos(left as u32 + 1))
 364                                             .with_hi(lit.span.hi() - BytePos(right as u32)),
 365                                     )
 366                                 })
 367                                 .unwrap_or(lit.span);
 368
 369                             Some(Ident::new(name, sp))
 370                         } else {
 371                             None
 372                         }
 373                     })
 374                 })
 375         };
 376
 377         if let Some(ident) = &crate_ident {
 378             self.check_snake_case(cx, "crate", ident);
 379         }
 380     }
 381
 382     fn check_generic_param(&mut self, cx: &LateContext<'_>, param: &hir::GenericParam<'_>) {
 383         if let GenericParamKind::Lifetime { .. } = param.kind {
 384             self.check_snake_case(cx, "lifetime", &param.name.ident());
 385         }
 386     }
 387
 388     fn check_fn(
 389         &mut self,
 390         cx: &LateContext<'_>,
 391         fk: FnKind<'_>,
 392         _: &hir::FnDecl<'_>,
 393         _: &hir::Body<'_>,
 394         _: Span,
 395         id: hir::HirId,
 396     ) {
 397         let attrs = cx.tcx.hir().attrs(id);
 398         match &fk {
 399             FnKind::Method(ident, sig, ..) => match method_context(cx, id) {
 400                 MethodLateContext::PlainImpl => {
 401                     if sig.header.abi != Abi::Rust && cx.sess().contains_name(attrs, sym::no_mangle)
 402                     {
 403                         return;
 404                     }
 405                     self.check_snake_case(cx, "method", ident);
 406                 }
 407                 MethodLateContext::TraitAutoImpl => {
 408                     self.check_snake_case(cx, "trait method", ident);
 409                 }
 410                 _ => (),
 411             },
 412             FnKind::ItemFn(ident, _, header) => {
 413                 // Skip foreign-ABI #[no_mangle] functions (Issue #31924)
 414                 if header.abi != Abi::Rust && cx.sess().contains_name(attrs, sym::no_mangle) {
 415                     return;
 416                 }
 417                 self.check_snake_case(cx, "function", ident);
 418             }
 419             FnKind::Closure => (),
 420         }
 421     }
 422
 423     fn check_item(&mut self, cx: &LateContext<'_>, it: &hir::Item<'_>) {
 424         if let hir::ItemKind::Mod(_) = it.kind {
 425             self.check_snake_case(cx, "module", &it.ident);
 426         }
 427     }
 428
 429     fn check_trait_item(&mut self, cx: &LateContext<'_>, item: &hir::TraitItem<'_>) {
 430         if let hir::TraitItemKind::Fn(_, hir::TraitFn::Required(pnames)) = item.kind {
 431             self.check_snake_case(cx, "trait method", &item.ident);
 432             for param_name in pnames {
 433                 self.check_snake_case(cx, "variable", param_name);
 434             }
 435         }
 436     }
 437
 438     fn check_pat(&mut self, cx: &LateContext<'_>, p: &hir::Pat<'_>) {
 439         if let PatKind::Binding(_, hid, ident, _) = p.kind {
 440             if let hir::Node::Pat(parent_pat) = cx.tcx.hir().get(cx.tcx.hir().get_parent_node(hid))
 441             {
 442                 if let PatKind::Struct(_, field_pats, _) = &parent_pat.kind {
 443                     if field_pats
 444                         .iter()
 445                         .any(|field| !field.is_shorthand && field.pat.hir_id == p.hir_id)
 446                     {
 447                         // Only check if a new name has been introduced, to avoid warning
 448                         // on both the struct definition and this pattern.
 449                         self.check_snake_case(cx, "variable", &ident);
 450                     }
 451                     return;
 452                 }
 453             }
 454             self.check_snake_case(cx, "variable", &ident);
 455         }
 456     }
 457
 458     fn check_struct_def(&mut self, cx: &LateContext<'_>, s: &hir::VariantData<'_>) {
 459         for sf in s.fields() {
 460             self.check_snake_case(cx, "structure field", &sf.ident);
 461         }
 462     }
 463 }
 464
 465 declare_lint! {
 466     /// The `non_upper_case_globals` lint detects static items that don't have
 467     /// uppercase identifiers.
 468     ///
 469     /// ### Example
 470     ///
 471     /// ```rust
 472     /// static max_points: i32 = 5;
 473     /// ```
 474     ///
 475     /// {{produces}}
 476     ///
 477     /// ### Explanation
 478     ///
 479     /// The preferred style is for static item names to use all uppercase
 480     /// letters such as `MAX_POINTS`.
 481     pub NON_UPPER_CASE_GLOBALS,
 482     Warn,
 483     "static constants should have uppercase identifiers"
 484 }
 485
 486 declare_lint_pass!(NonUpperCaseGlobals => [NON_UPPER_CASE_GLOBALS]);
 487
 488 impl NonUpperCaseGlobals {
 489     fn check_upper_case(cx: &LateContext<'_>, sort: &str, ident: &Ident) {
 490         let name = ident.name.as_str();
 491         if name.chars().any(|c| c.is_lowercase()) {
 492             cx.struct_span_lint(NON_UPPER_CASE_GLOBALS, ident.span, |lint| {
 493                 let uc = NonSnakeCase::to_snake_case(&name).to_uppercase();
 494                 let mut err = lint.build(fluent::lint::non_upper_case_global);
 495                 // We cannot provide meaningful suggestions
 496                 // if the characters are in the category of "Lowercase Letter".
 497                 if *name != uc {
 498                     err.span_suggestion(
 499                         ident.span,
 500                         fluent::lint::suggestion,
 501                         uc,
 502                         Applicability::MaybeIncorrect,
 503                     );
 504                 } else {
 505                     err.span_label(ident.span, fluent::lint::label);
 506                 }
 507
 508                 err.set_arg("sort", sort);
 509                 err.set_arg("name", name);
 510                 err.emit();
 511             })
 512         }
 513     }
 514 }
 515
 516 impl<'tcx> LateLintPass<'tcx> for NonUpperCaseGlobals {
 517     fn check_item(&mut self, cx: &LateContext<'_>, it: &hir::Item<'_>) {
 518         let attrs = cx.tcx.hir().attrs(it.hir_id());
 519         match it.kind {
 520             hir::ItemKind::Static(..) if !cx.sess().contains_name(attrs, sym::no_mangle) => {
 521                 NonUpperCaseGlobals::check_upper_case(cx, "static variable", &it.ident);
 522             }
 523             hir::ItemKind::Const(..) => {
 524                 NonUpperCaseGlobals::check_upper_case(cx, "constant", &it.ident);
 525             }
 526             _ => {}
 527         }
 528     }
 529
 530     fn check_trait_item(&mut self, cx: &LateContext<'_>, ti: &hir::TraitItem<'_>) {
 531         if let hir::TraitItemKind::Const(..) = ti.kind {
 532             NonUpperCaseGlobals::check_upper_case(cx, "associated constant", &ti.ident);
 533         }
 534     }
 535
 536     fn check_impl_item(&mut self, cx: &LateContext<'_>, ii: &hir::ImplItem<'_>) {
 537         if let hir::ImplItemKind::Const(..) = ii.kind {
 538             NonUpperCaseGlobals::check_upper_case(cx, "associated constant", &ii.ident);
 539         }
 540     }
 541
 542     fn check_pat(&mut self, cx: &LateContext<'_>, p: &hir::Pat<'_>) {
 543         // Lint for constants that look like binding identifiers (#7526)
 544         if let PatKind::Path(hir::QPath::Resolved(None, ref path)) = p.kind {
 545             if let Res::Def(DefKind::Const, _) = path.res {
 546                 if path.segments.len() == 1 {
 547                     NonUpperCaseGlobals::check_upper_case(
 548                         cx,
 549                         "constant in pattern",
 550                         &path.segments[0].ident,
 551                     );
 552                 }
 553             }
 554         }
 555     }
 556
 557     fn check_generic_param(&mut self, cx: &LateContext<'_>, param: &hir::GenericParam<'_>) {
 558         if let GenericParamKind::Const { .. } = param.kind {
 559             NonUpperCaseGlobals::check_upper_case(cx, "const parameter", &param.name.ident());
 560         }
 561     }
 562 }
 563
 564 #[cfg(test)]
 565 mod tests;