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::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 a 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 msg = format!("{} `{}` should have an upper camel case name", sort, name);
 141                 let mut err = lint.build(&msg);
 142                 let cc = to_camel_case(name);
 143                 // We cannot provide meaningful suggestions
 144                 // if the characters are in the category of "Lowercase Letter".
 145                 if *name != cc {
 146                     err.span_suggestion(
 147                         ident.span,
 148                         "convert the identifier to upper camel case",
 149                         to_camel_case(name),
 150                         Applicability::MaybeIncorrect,
 151                     );
 152                 } else {
 153                     err.span_label(ident.span, "should have an UpperCamelCase name");
 154                 }
 155
 156                 err.emit();
 157             })
 158         }
 159     }
 160 }
 161
 162 impl EarlyLintPass for NonCamelCaseTypes {
 163     fn check_item(&mut self, cx: &EarlyContext<'_>, it: &ast::Item) {
 164         let has_repr_c = it
 165             .attrs
 166             .iter()
 167             .any(|attr| attr::find_repr_attrs(&cx.sess, attr).contains(&attr::ReprC));
 168
 169         if has_repr_c {
 170             return;
 171         }
 172
 173         match it.kind {
 174             ast::ItemKind::TyAlias(..)
 175             | ast::ItemKind::Enum(..)
 176             | ast::ItemKind::Struct(..)
 177             | ast::ItemKind::Union(..) => self.check_case(cx, "type", &it.ident),
 178             ast::ItemKind::Trait(..) => self.check_case(cx, "trait", &it.ident),
 179             ast::ItemKind::TraitAlias(..) => self.check_case(cx, "trait alias", &it.ident),
 180             _ => (),
 181         }
 182     }
 183
 184     fn check_trait_item(&mut self, cx: &EarlyContext<'_>, it: &ast::AssocItem) {
 185         if let ast::AssocItemKind::TyAlias(..) = it.kind {
 186             self.check_case(cx, "associated type", &it.ident);
 187         }
 188     }
 189
 190     fn check_variant(&mut self, cx: &EarlyContext<'_>, v: &ast::Variant) {
 191         self.check_case(cx, "variant", &v.ident);
 192     }
 193
 194     fn check_generic_param(&mut self, cx: &EarlyContext<'_>, param: &ast::GenericParam) {
 195         if let ast::GenericParamKind::Type { .. } = param.kind {
 196             self.check_case(cx, "type parameter", &param.ident);
 197         }
 198     }
 199 }
 200
 201 declare_lint! {
 202     /// The `non_snake_case` lint detects variables, methods, functions,
 203     /// lifetime parameters and modules that don't have snake case names.
 204     ///
 205     /// ### Example
 206     ///
 207     /// ```rust
 208     /// let MY_VALUE = 5;
 209     /// ```
 210     ///
 211     /// {{produces}}
 212     ///
 213     /// ### Explanation
 214     ///
 215     /// The preferred style for these identifiers is to use "snake case",
 216     /// where all the characters are in lowercase, with words separated with a
 217     /// single underscore, such as `my_value`.
 218     pub NON_SNAKE_CASE,
 219     Warn,
 220     "variables, methods, functions, lifetime parameters and modules should have snake case names"
 221 }
 222
 223 declare_lint_pass!(NonSnakeCase => [NON_SNAKE_CASE]);
 224
 225 impl NonSnakeCase {
 226     fn to_snake_case(mut str: &str) -> String {
 227         let mut words = vec![];
 228         // Preserve leading underscores
 229         str = str.trim_start_matches(|c: char| {
 230             if c == '_' {
 231                 words.push(String::new());
 232                 true
 233             } else {
 234                 false
 235             }
 236         });
 237         for s in str.split('_') {
 238             let mut last_upper = false;
 239             let mut buf = String::new();
 240             if s.is_empty() {
 241                 continue;
 242             }
 243             for ch in s.chars() {
 244                 if !buf.is_empty() && buf != "'" && ch.is_uppercase() && !last_upper {
 245                     words.push(buf);
 246                     buf = String::new();
 247                 }
 248                 last_upper = ch.is_uppercase();
 249                 buf.extend(ch.to_lowercase());
 250             }
 251             words.push(buf);
 252         }
 253         words.join("_")
 254     }
 255
 256     /// Checks if a given identifier is snake case, and reports a diagnostic if not.
 257     fn check_snake_case(&self, cx: &LateContext<'_>, sort: &str, ident: &Ident) {
 258         fn is_snake_case(ident: &str) -> bool {
 259             if ident.is_empty() {
 260                 return true;
 261             }
 262             let ident = ident.trim_start_matches('\'');
 263             let ident = ident.trim_matches('_');
 264
 265             let mut allow_underscore = true;
 266             ident.chars().all(|c| {
 267                 allow_underscore = match c {
 268                     '_' if !allow_underscore => return false,
 269                     '_' => false,
 270                     // It would be more obvious to use `c.is_lowercase()`,
 271                     // but some characters do not have a lowercase form
 272                     c if !c.is_uppercase() => true,
 273                     _ => return false,
 274                 };
 275                 true
 276             })
 277         }
 278
 279         let name = &ident.name.as_str();
 280
 281         if !is_snake_case(name) {
 282             cx.struct_span_lint(NON_SNAKE_CASE, ident.span, |lint| {
 283                 let sc = NonSnakeCase::to_snake_case(name);
 284                 let msg = format!("{} `{}` should have a snake case name", sort, name);
 285                 let mut err = lint.build(&msg);
 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                                 ("rename the identifier or convert it to a snake case raw identifier", sc_ident.to_string())
 299                             } else {
 300                                 err.note(&format!("`{}` cannot be used as a raw identifier", sc));
 301                                 ("rename the identifier", String::new())
 302                             }
 303                         } else {
 304                             ("convert the identifier to snake case", sc)
 305                         };
 306
 307                         err.span_suggestion(
 308                             ident.span,
 309                             message,
 310                             suggestion,
 311                             Applicability::MaybeIncorrect,
 312                         );
 313                     } else {
 314                         err.help(&format!("convert the identifier to snake case: `{}`", sc));
 315                     }
 316                 } else {
 317                     err.span_label(ident.span, "should have a snake_case name");
 318                 }
 319
 320                 err.emit();
 321             });
 322         }
 323     }
 324 }
 325
 326 impl<'tcx> LateLintPass<'tcx> for NonSnakeCase {
 327     fn check_mod(
 328         &mut self,
 329         cx: &LateContext<'_>,
 330         _: &'tcx hir::Mod<'tcx>,
 331         _: Span,
 332         id: hir::HirId,
 333     ) {
 334         if id != hir::CRATE_HIR_ID {
 335             return;
 336         }
 337
 338         let crate_ident = if let Some(name) = &cx.tcx.sess.opts.crate_name {
 339             Some(Ident::from_str(name))
 340         } else {
 341             cx.sess()
 342                 .find_by_name(&cx.tcx.hir().attrs(hir::CRATE_HIR_ID), sym::crate_name)
 343                 .and_then(|attr| attr.meta())
 344                 .and_then(|meta| {
 345                     meta.name_value_literal().and_then(|lit| {
 346                         if let ast::LitKind::Str(name, ..) = lit.kind {
 347                             // Discard the double quotes surrounding the literal.
 348                             let sp = cx
 349                                 .sess()
 350                                 .source_map()
 351                                 .span_to_snippet(lit.span)
 352                                 .ok()
 353                                 .and_then(|snippet| {
 354                                     let left = snippet.find('"')?;
 355                                     let right =
 356                                         snippet.rfind('"').map(|pos| snippet.len() - pos)?;
 357
 358                                     Some(
 359                                         lit.span
 360                                             .with_lo(lit.span.lo() + BytePos(left as u32 + 1))
 361                                             .with_hi(lit.span.hi() - BytePos(right as u32)),
 362                                     )
 363                                 })
 364                                 .unwrap_or(lit.span);
 365
 366                             Some(Ident::new(name, sp))
 367                         } else {
 368                             None
 369                         }
 370                     })
 371                 })
 372         };
 373
 374         if let Some(ident) = &crate_ident {
 375             self.check_snake_case(cx, "crate", ident);
 376         }
 377     }
 378
 379     fn check_generic_param(&mut self, cx: &LateContext<'_>, param: &hir::GenericParam<'_>) {
 380         if let GenericParamKind::Lifetime { .. } = param.kind {
 381             self.check_snake_case(cx, "lifetime", &param.name.ident());
 382         }
 383     }
 384
 385     fn check_fn(
 386         &mut self,
 387         cx: &LateContext<'_>,
 388         fk: FnKind<'_>,
 389         _: &hir::FnDecl<'_>,
 390         _: &hir::Body<'_>,
 391         _: Span,
 392         id: hir::HirId,
 393     ) {
 394         match &fk {
 395             FnKind::Method(ident, ..) => match method_context(cx, id) {
 396                 MethodLateContext::PlainImpl => {
 397                     self.check_snake_case(cx, "method", ident);
 398                 }
 399                 MethodLateContext::TraitAutoImpl => {
 400                     self.check_snake_case(cx, "trait method", ident);
 401                 }
 402                 _ => (),
 403             },
 404             FnKind::ItemFn(ident, _, header, _) => {
 405                 let attrs = cx.tcx.hir().attrs(id);
 406                 // Skip foreign-ABI #[no_mangle] functions (Issue #31924)
 407                 if header.abi != Abi::Rust && cx.sess().contains_name(attrs, sym::no_mangle) {
 408                     return;
 409                 }
 410                 self.check_snake_case(cx, "function", ident);
 411             }
 412             FnKind::Closure => (),
 413         }
 414     }
 415
 416     fn check_item(&mut self, cx: &LateContext<'_>, it: &hir::Item<'_>) {
 417         if let hir::ItemKind::Mod(_) = it.kind {
 418             self.check_snake_case(cx, "module", &it.ident);
 419         }
 420     }
 421
 422     fn check_trait_item(&mut self, cx: &LateContext<'_>, item: &hir::TraitItem<'_>) {
 423         if let hir::TraitItemKind::Fn(_, hir::TraitFn::Required(pnames)) = item.kind {
 424             self.check_snake_case(cx, "trait method", &item.ident);
 425             for param_name in pnames {
 426                 self.check_snake_case(cx, "variable", param_name);
 427             }
 428         }
 429     }
 430
 431     fn check_pat(&mut self, cx: &LateContext<'_>, p: &hir::Pat<'_>) {
 432         if let PatKind::Binding(_, hid, ident, _) = p.kind {
 433             if let hir::Node::Pat(parent_pat) = cx.tcx.hir().get(cx.tcx.hir().get_parent_node(hid))
 434             {
 435                 if let PatKind::Struct(_, field_pats, _) = &parent_pat.kind {
 436                     for field in field_pats.iter() {
 437                         if field.ident != ident {
 438                             // Only check if a new name has been introduced, to avoid warning
 439                             // on both the struct definition and this pattern.
 440                             self.check_snake_case(cx, "variable", &ident);
 441                         }
 442                     }
 443                     return;
 444                 }
 445             }
 446             self.check_snake_case(cx, "variable", &ident);
 447         }
 448     }
 449
 450     fn check_struct_def(&mut self, cx: &LateContext<'_>, s: &hir::VariantData<'_>) {
 451         for sf in s.fields() {
 452             self.check_snake_case(cx, "structure field", &sf.ident);
 453         }
 454     }
 455 }
 456
 457 declare_lint! {
 458     /// The `non_upper_case_globals` lint detects static items that don't have
 459     /// uppercase identifiers.
 460     ///
 461     /// ### Example
 462     ///
 463     /// ```rust
 464     /// static max_points: i32 = 5;
 465     /// ```
 466     ///
 467     /// {{produces}}
 468     ///
 469     /// ### Explanation
 470     ///
 471     /// The preferred style is for static item names to use all uppercase
 472     /// letters such as `MAX_POINTS`.
 473     pub NON_UPPER_CASE_GLOBALS,
 474     Warn,
 475     "static constants should have uppercase identifiers"
 476 }
 477
 478 declare_lint_pass!(NonUpperCaseGlobals => [NON_UPPER_CASE_GLOBALS]);
 479
 480 impl NonUpperCaseGlobals {
 481     fn check_upper_case(cx: &LateContext<'_>, sort: &str, ident: &Ident) {
 482         let name = &ident.name.as_str();
 483         if name.chars().any(|c| c.is_lowercase()) {
 484             cx.struct_span_lint(NON_UPPER_CASE_GLOBALS, ident.span, |lint| {
 485                 let uc = NonSnakeCase::to_snake_case(&name).to_uppercase();
 486                 let mut err =
 487                     lint.build(&format!("{} `{}` should have an upper case name", sort, name));
 488                 // We cannot provide meaningful suggestions
 489                 // if the characters are in the category of "Lowercase Letter".
 490                 if *name != uc {
 491                     err.span_suggestion(
 492                         ident.span,
 493                         "convert the identifier to upper case",
 494                         uc,
 495                         Applicability::MaybeIncorrect,
 496                     );
 497                 } else {
 498                     err.span_label(ident.span, "should have an UPPER_CASE name");
 499                 }
 500
 501                 err.emit();
 502             })
 503         }
 504     }
 505 }
 506
 507 impl<'tcx> LateLintPass<'tcx> for NonUpperCaseGlobals {
 508     fn check_item(&mut self, cx: &LateContext<'_>, it: &hir::Item<'_>) {
 509         let attrs = cx.tcx.hir().attrs(it.hir_id());
 510         match it.kind {
 511             hir::ItemKind::Static(..) if !cx.sess().contains_name(attrs, sym::no_mangle) => {
 512                 NonUpperCaseGlobals::check_upper_case(cx, "static variable", &it.ident);
 513             }
 514             hir::ItemKind::Const(..) => {
 515                 NonUpperCaseGlobals::check_upper_case(cx, "constant", &it.ident);
 516             }
 517             _ => {}
 518         }
 519     }
 520
 521     fn check_trait_item(&mut self, cx: &LateContext<'_>, ti: &hir::TraitItem<'_>) {
 522         if let hir::TraitItemKind::Const(..) = ti.kind {
 523             NonUpperCaseGlobals::check_upper_case(cx, "associated constant", &ti.ident);
 524         }
 525     }
 526
 527     fn check_impl_item(&mut self, cx: &LateContext<'_>, ii: &hir::ImplItem<'_>) {
 528         if let hir::ImplItemKind::Const(..) = ii.kind {
 529             NonUpperCaseGlobals::check_upper_case(cx, "associated constant", &ii.ident);
 530         }
 531     }
 532
 533     fn check_pat(&mut self, cx: &LateContext<'_>, p: &hir::Pat<'_>) {
 534         // Lint for constants that look like binding identifiers (#7526)
 535         if let PatKind::Path(hir::QPath::Resolved(None, ref path)) = p.kind {
 536             if let Res::Def(DefKind::Const, _) = path.res {
 537                 if path.segments.len() == 1 {
 538                     NonUpperCaseGlobals::check_upper_case(
 539                         cx,
 540                         "constant in pattern",
 541                         &path.segments[0].ident,
 542                     );
 543                 }
 544             }
 545         }
 546     }
 547
 548     fn check_generic_param(&mut self, cx: &LateContext<'_>, param: &hir::GenericParam<'_>) {
 549         if let GenericParamKind::Const { .. } = param.kind {
 550             NonUpperCaseGlobals::check_upper_case(cx, "const parameter", &param.name.ident());
 551         }
 552     }
 553 }
 554
 555 #[cfg(test)]
 556 mod tests;