src/librustc_lint/nonstandard_style.rs

   1 use rustc::lint::{EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintContext};
   2 use rustc::ty;
   3 use rustc_errors::Applicability;
   4 use rustc_hir as hir;
   5 use rustc_hir::def::{DefKind, Res};
   6 use rustc_hir::intravisit::FnKind;
   7 use rustc_hir::{GenericParamKind, PatKind};
   8 use rustc_span::symbol::sym;
   9 use rustc_span::{symbol::Ident, BytePos, Span};
  10 use rustc_target::spec::abi::Abi;
  11 use syntax::ast;
  12 use syntax::attr;
  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     pub NON_CAMEL_CASE_TYPES,
  35     Warn,
  36     "types, variants, traits and type parameters should have camel case names"
  37 }
  38
  39 declare_lint_pass!(NonCamelCaseTypes => [NON_CAMEL_CASE_TYPES]);
  40
  41 fn char_has_case(c: char) -> bool {
  42     c.is_lowercase() || c.is_uppercase()
  43 }
  44
  45 fn is_camel_case(name: &str) -> bool {
  46     let name = name.trim_matches('_');
  47     if name.is_empty() {
  48         return true;
  49     }
  50
  51     // start with a non-lowercase letter rather than non-uppercase
  52     // ones (some scripts don't have a concept of upper/lowercase)
  53     !name.chars().next().unwrap().is_lowercase()
  54         && !name.contains("__")
  55         && !name.chars().collect::<Vec<_>>().windows(2).any(|pair| {
  56             // contains a capitalisable character followed by, or preceded by, an underscore
  57             char_has_case(pair[0]) && pair[1] == '_' || char_has_case(pair[1]) && pair[0] == '_'
  58         })
  59 }
  60
  61 fn to_camel_case(s: &str) -> String {
  62     s.trim_matches('_')
  63         .split('_')
  64         .filter(|component| !component.is_empty())
  65         .map(|component| {
  66             let mut camel_cased_component = String::new();
  67
  68             let mut new_word = true;
  69             let mut prev_is_lower_case = true;
  70
  71             for c in component.chars() {
  72                 // Preserve the case if an uppercase letter follows a lowercase letter, so that
  73                 // `camelCase` is converted to `CamelCase`.
  74                 if prev_is_lower_case && c.is_uppercase() {
  75                     new_word = true;
  76                 }
  77
  78                 if new_word {
  79                     camel_cased_component.push_str(&c.to_uppercase().to_string());
  80                 } else {
  81                     camel_cased_component.push_str(&c.to_lowercase().to_string());
  82                 }
  83
  84                 prev_is_lower_case = c.is_lowercase();
  85                 new_word = false;
  86             }
  87
  88             camel_cased_component
  89         })
  90         .fold((String::new(), None), |(acc, prev): (String, Option<String>), next| {
  91             // separate two components with an underscore if their boundary cannot
  92             // be distinguished using a uppercase/lowercase case distinction
  93             let join = if let Some(prev) = prev {
  94                 let l = prev.chars().last().unwrap();
  95                 let f = next.chars().next().unwrap();
  96                 !char_has_case(l) && !char_has_case(f)
  97             } else {
  98                 false
  99             };
 100             (acc + if join { "_" } else { "" } + &next, Some(next))
 101         })
 102         .0
 103 }
 104
 105 impl NonCamelCaseTypes {
 106     fn check_case(&self, cx: &EarlyContext<'_>, sort: &str, ident: &Ident) {
 107         let name = &ident.name.as_str();
 108
 109         if !is_camel_case(name) {
 110             let msg = format!("{} `{}` should have an upper camel case name", sort, name);
 111             cx.struct_span_lint(NON_CAMEL_CASE_TYPES, ident.span, &msg)
 112                 .span_suggestion(
 113                     ident.span,
 114                     "convert the identifier to upper camel case",
 115                     to_camel_case(name),
 116                     Applicability::MaybeIncorrect,
 117                 )
 118                 .emit();
 119         }
 120     }
 121 }
 122
 123 impl EarlyLintPass for NonCamelCaseTypes {
 124     fn check_item(&mut self, cx: &EarlyContext<'_>, it: &ast::Item) {
 125         let has_repr_c = it
 126             .attrs
 127             .iter()
 128             .any(|attr| attr::find_repr_attrs(&cx.sess.parse_sess, attr).contains(&attr::ReprC));
 129
 130         if has_repr_c {
 131             return;
 132         }
 133
 134         match it.kind {
 135             ast::ItemKind::TyAlias(..)
 136             | ast::ItemKind::Enum(..)
 137             | ast::ItemKind::Struct(..)
 138             | ast::ItemKind::Union(..) => self.check_case(cx, "type", &it.ident),
 139             ast::ItemKind::Trait(..) => self.check_case(cx, "trait", &it.ident),
 140             _ => (),
 141         }
 142     }
 143
 144     fn check_trait_item(&mut self, cx: &EarlyContext<'_>, it: &ast::AssocItem) {
 145         if let ast::AssocItemKind::TyAlias(..) = it.kind {
 146             self.check_case(cx, "associated type", &it.ident);
 147         }
 148     }
 149
 150     fn check_variant(&mut self, cx: &EarlyContext<'_>, v: &ast::Variant) {
 151         self.check_case(cx, "variant", &v.ident);
 152     }
 153
 154     fn check_generic_param(&mut self, cx: &EarlyContext<'_>, param: &ast::GenericParam) {
 155         if let ast::GenericParamKind::Type { .. } = param.kind {
 156             self.check_case(cx, "type parameter", &param.ident);
 157         }
 158     }
 159 }
 160
 161 declare_lint! {
 162     pub NON_SNAKE_CASE,
 163     Warn,
 164     "variables, methods, functions, lifetime parameters and modules should have snake case names"
 165 }
 166
 167 declare_lint_pass!(NonSnakeCase => [NON_SNAKE_CASE]);
 168
 169 impl NonSnakeCase {
 170     fn to_snake_case(mut str: &str) -> String {
 171         let mut words = vec![];
 172         // Preserve leading underscores
 173         str = str.trim_start_matches(|c: char| {
 174             if c == '_' {
 175                 words.push(String::new());
 176                 true
 177             } else {
 178                 false
 179             }
 180         });
 181         for s in str.split('_') {
 182             let mut last_upper = false;
 183             let mut buf = String::new();
 184             if s.is_empty() {
 185                 continue;
 186             }
 187             for ch in s.chars() {
 188                 if !buf.is_empty() && buf != "'" && ch.is_uppercase() && !last_upper {
 189                     words.push(buf);
 190                     buf = String::new();
 191                 }
 192                 last_upper = ch.is_uppercase();
 193                 buf.extend(ch.to_lowercase());
 194             }
 195             words.push(buf);
 196         }
 197         words.join("_")
 198     }
 199
 200     /// Checks if a given identifier is snake case, and reports a diagnostic if not.
 201     fn check_snake_case(&self, cx: &LateContext<'_, '_>, sort: &str, ident: &Ident) {
 202         fn is_snake_case(ident: &str) -> bool {
 203             if ident.is_empty() {
 204                 return true;
 205             }
 206             let ident = ident.trim_start_matches('\'');
 207             let ident = ident.trim_matches('_');
 208
 209             let mut allow_underscore = true;
 210             ident.chars().all(|c| {
 211                 allow_underscore = match c {
 212                     '_' if !allow_underscore => return false,
 213                     '_' => false,
 214                     // It would be more obvious to use `c.is_lowercase()`,
 215                     // but some characters do not have a lowercase form
 216                     c if !c.is_uppercase() => true,
 217                     _ => return false,
 218                 };
 219                 true
 220             })
 221         }
 222
 223         let name = &ident.name.as_str();
 224
 225         if !is_snake_case(name) {
 226             let sc = NonSnakeCase::to_snake_case(name);
 227
 228             let msg = format!("{} `{}` should have a snake case name", sort, name);
 229             let mut err = cx.struct_span_lint(NON_SNAKE_CASE, ident.span, &msg);
 230
 231             // We have a valid span in almost all cases, but we don't have one when linting a crate
 232             // name provided via the command line.
 233             if !ident.span.is_dummy() {
 234                 err.span_suggestion(
 235                     ident.span,
 236                     "convert the identifier to snake case",
 237                     sc,
 238                     Applicability::MaybeIncorrect,
 239                 );
 240             } else {
 241                 err.help(&format!("convert the identifier to snake case: `{}`", sc));
 242             }
 243
 244             err.emit();
 245         }
 246     }
 247 }
 248
 249 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NonSnakeCase {
 250     fn check_mod(
 251         &mut self,
 252         cx: &LateContext<'_, '_>,
 253         _: &'tcx hir::Mod<'tcx>,
 254         _: Span,
 255         id: hir::HirId,
 256     ) {
 257         if id != hir::CRATE_HIR_ID {
 258             return;
 259         }
 260
 261         let crate_ident = if let Some(name) = &cx.tcx.sess.opts.crate_name {
 262             Some(Ident::from_str(name))
 263         } else {
 264             attr::find_by_name(&cx.tcx.hir().attrs(hir::CRATE_HIR_ID), sym::crate_name)
 265                 .and_then(|attr| attr.meta())
 266                 .and_then(|meta| {
 267                     meta.name_value_literal().and_then(|lit| {
 268                         if let ast::LitKind::Str(name, ..) = lit.kind {
 269                             // Discard the double quotes surrounding the literal.
 270                             let sp = cx
 271                                 .sess()
 272                                 .source_map()
 273                                 .span_to_snippet(lit.span)
 274                                 .ok()
 275                                 .and_then(|snippet| {
 276                                     let left = snippet.find('"')?;
 277                                     let right =
 278                                         snippet.rfind('"').map(|pos| snippet.len() - pos)?;
 279
 280                                     Some(
 281                                         lit.span
 282                                             .with_lo(lit.span.lo() + BytePos(left as u32 + 1))
 283                                             .with_hi(lit.span.hi() - BytePos(right as u32)),
 284                                     )
 285                                 })
 286                                 .unwrap_or_else(|| lit.span);
 287
 288                             Some(Ident::new(name, sp))
 289                         } else {
 290                             None
 291                         }
 292                     })
 293                 })
 294         };
 295
 296         if let Some(ident) = &crate_ident {
 297             self.check_snake_case(cx, "crate", ident);
 298         }
 299     }
 300
 301     fn check_generic_param(&mut self, cx: &LateContext<'_, '_>, param: &hir::GenericParam<'_>) {
 302         if let GenericParamKind::Lifetime { .. } = param.kind {
 303             self.check_snake_case(cx, "lifetime", &param.name.ident());
 304         }
 305     }
 306
 307     fn check_fn(
 308         &mut self,
 309         cx: &LateContext<'_, '_>,
 310         fk: FnKind<'_>,
 311         _: &hir::FnDecl<'_>,
 312         _: &hir::Body<'_>,
 313         _: Span,
 314         id: hir::HirId,
 315     ) {
 316         match &fk {
 317             FnKind::Method(ident, ..) => match method_context(cx, id) {
 318                 MethodLateContext::PlainImpl => {
 319                     self.check_snake_case(cx, "method", ident);
 320                 }
 321                 MethodLateContext::TraitAutoImpl => {
 322                     self.check_snake_case(cx, "trait method", ident);
 323                 }
 324                 _ => (),
 325             },
 326             FnKind::ItemFn(ident, _, header, _, attrs) => {
 327                 // Skip foreign-ABI #[no_mangle] functions (Issue #31924)
 328                 if header.abi != Abi::Rust && attr::contains_name(attrs, sym::no_mangle) {
 329                     return;
 330                 }
 331                 self.check_snake_case(cx, "function", ident);
 332             }
 333             FnKind::Closure(_) => (),
 334         }
 335     }
 336
 337     fn check_item(&mut self, cx: &LateContext<'_, '_>, it: &hir::Item<'_>) {
 338         if let hir::ItemKind::Mod(_) = it.kind {
 339             self.check_snake_case(cx, "module", &it.ident);
 340         }
 341     }
 342
 343     fn check_trait_item(&mut self, cx: &LateContext<'_, '_>, item: &hir::TraitItem<'_>) {
 344         if let hir::TraitItemKind::Method(_, hir::TraitMethod::Required(pnames)) = item.kind {
 345             self.check_snake_case(cx, "trait method", &item.ident);
 346             for param_name in pnames {
 347                 self.check_snake_case(cx, "variable", param_name);
 348             }
 349         }
 350     }
 351
 352     fn check_pat(&mut self, cx: &LateContext<'_, '_>, p: &hir::Pat<'_>) {
 353         if let &PatKind::Binding(_, _, ident, _) = &p.kind {
 354             self.check_snake_case(cx, "variable", &ident);
 355         }
 356     }
 357
 358     fn check_struct_def(&mut self, cx: &LateContext<'_, '_>, s: &hir::VariantData<'_>) {
 359         for sf in s.fields() {
 360             self.check_snake_case(cx, "structure field", &sf.ident);
 361         }
 362     }
 363 }
 364
 365 declare_lint! {
 366     pub NON_UPPER_CASE_GLOBALS,
 367     Warn,
 368     "static constants should have uppercase identifiers"
 369 }
 370
 371 declare_lint_pass!(NonUpperCaseGlobals => [NON_UPPER_CASE_GLOBALS]);
 372
 373 impl NonUpperCaseGlobals {
 374     fn check_upper_case(cx: &LateContext<'_, '_>, sort: &str, ident: &Ident) {
 375         let name = &ident.name.as_str();
 376
 377         if name.chars().any(|c| c.is_lowercase()) {
 378             let uc = NonSnakeCase::to_snake_case(&name).to_uppercase();
 379
 380             let msg = format!("{} `{}` should have an upper case name", sort, name);
 381             cx.struct_span_lint(NON_UPPER_CASE_GLOBALS, ident.span, &msg)
 382                 .span_suggestion(
 383                     ident.span,
 384                     "convert the identifier to upper case",
 385                     uc,
 386                     Applicability::MaybeIncorrect,
 387                 )
 388                 .emit();
 389         }
 390     }
 391 }
 392
 393 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NonUpperCaseGlobals {
 394     fn check_item(&mut self, cx: &LateContext<'_, '_>, it: &hir::Item<'_>) {
 395         match it.kind {
 396             hir::ItemKind::Static(..) if !attr::contains_name(&it.attrs, sym::no_mangle) => {
 397                 NonUpperCaseGlobals::check_upper_case(cx, "static variable", &it.ident);
 398             }
 399             hir::ItemKind::Const(..) => {
 400                 NonUpperCaseGlobals::check_upper_case(cx, "constant", &it.ident);
 401             }
 402             _ => {}
 403         }
 404     }
 405
 406     fn check_trait_item(&mut self, cx: &LateContext<'_, '_>, ti: &hir::TraitItem<'_>) {
 407         if let hir::TraitItemKind::Const(..) = ti.kind {
 408             NonUpperCaseGlobals::check_upper_case(cx, "associated constant", &ti.ident);
 409         }
 410     }
 411
 412     fn check_impl_item(&mut self, cx: &LateContext<'_, '_>, ii: &hir::ImplItem<'_>) {
 413         if let hir::ImplItemKind::Const(..) = ii.kind {
 414             NonUpperCaseGlobals::check_upper_case(cx, "associated constant", &ii.ident);
 415         }
 416     }
 417
 418     fn check_pat(&mut self, cx: &LateContext<'_, '_>, p: &hir::Pat<'_>) {
 419         // Lint for constants that look like binding identifiers (#7526)
 420         if let PatKind::Path(hir::QPath::Resolved(None, ref path)) = p.kind {
 421             if let Res::Def(DefKind::Const, _) = path.res {
 422                 if path.segments.len() == 1 {
 423                     NonUpperCaseGlobals::check_upper_case(
 424                         cx,
 425                         "constant in pattern",
 426                         &path.segments[0].ident,
 427                     );
 428                 }
 429             }
 430         }
 431     }
 432
 433     fn check_generic_param(&mut self, cx: &LateContext<'_, '_>, param: &hir::GenericParam<'_>) {
 434         if let GenericParamKind::Const { .. } = param.kind {
 435             NonUpperCaseGlobals::check_upper_case(cx, "const parameter", &param.name.ident());
 436         }
 437     }
 438 }
 439
 440 #[cfg(test)]
 441 mod tests;