clippy_lints/src/doc.rs

   1 use clippy_utils::diagnostics::{span_lint, span_lint_and_help, span_lint_and_note};
   2 use clippy_utils::source::first_line_of_span;
   3 use clippy_utils::ty::{implements_trait, is_type_diagnostic_item};
   4 use clippy_utils::{is_entrypoint_fn, is_expn_of, match_panic_def_id, method_chain_args, return_ty};
   5 use if_chain::if_chain;
   6 use itertools::Itertools;
   7 use rustc_ast::ast::{Async, AttrKind, Attribute, FnKind, FnRetTy, ItemKind};
   8 use rustc_ast::token::CommentKind;
   9 use rustc_data_structures::fx::FxHashSet;
  10 use rustc_data_structures::sync::Lrc;
  11 use rustc_errors::emitter::EmitterWriter;
  12 use rustc_errors::Handler;
  13 use rustc_hir as hir;
  14 use rustc_hir::intravisit::{self, NestedVisitorMap, Visitor};
  15 use rustc_hir::{AnonConst, Expr, ExprKind, QPath};
  16 use rustc_lint::{LateContext, LateLintPass};
  17 use rustc_middle::hir::map::Map;
  18 use rustc_middle::lint::in_external_macro;
  19 use rustc_middle::ty;
  20 use rustc_parse::maybe_new_parser_from_source_str;
  21 use rustc_parse::parser::ForceCollect;
  22 use rustc_session::parse::ParseSess;
  23 use rustc_session::{declare_tool_lint, impl_lint_pass};
  24 use rustc_span::def_id::LocalDefId;
  25 use rustc_span::edition::Edition;
  26 use rustc_span::source_map::{BytePos, FilePathMapping, MultiSpan, SourceMap, Span};
  27 use rustc_span::{sym, FileName, Pos};
  28 use std::io;
  29 use std::ops::Range;
  30 use std::thread;
  31 use url::Url;
  32
  33 declare_clippy_lint! {
  34     /// ### What it does
  35     /// Checks for the presence of `_`, `::` or camel-case words
  36     /// outside ticks in documentation.
  37     ///
  38     /// ### Why is this bad?
  39     /// *Rustdoc* supports markdown formatting, `_`, `::` and
  40     /// camel-case probably indicates some code which should be included between
  41     /// ticks. `_` can also be used for emphasis in markdown, this lint tries to
  42     /// consider that.
  43     ///
  44     /// ### Known problems
  45     /// Lots of bad docs won’t be fixed, what the lint checks
  46     /// for is limited, and there are still false positives. HTML elements and their
  47     /// content are not linted.
  48     ///
  49     /// In addition, when writing documentation comments, including `[]` brackets
  50     /// inside a link text would trip the parser. Therfore, documenting link with
  51     /// `[`SmallVec<[T; INLINE_CAPACITY]>`]` and then [`SmallVec<[T; INLINE_CAPACITY]>`]: SmallVec
  52     /// would fail.
  53     ///
  54     /// ### Examples
  55     /// ```rust
  56     /// /// Do something with the foo_bar parameter. See also
  57     /// /// that::other::module::foo.
  58     /// // ^ `foo_bar` and `that::other::module::foo` should be ticked.
  59     /// fn doit(foo_bar: usize) {}
  60     /// ```
  61     ///
  62     /// ```rust
  63     /// // Link text with `[]` brackets should be written as following:
  64     /// /// Consume the array and return the inner
  65     /// /// [`SmallVec<[T; INLINE_CAPACITY]>`][SmallVec].
  66     /// /// [SmallVec]: SmallVec
  67     /// fn main() {}
  68     /// ```
  69     pub DOC_MARKDOWN,
  70     pedantic,
  71     "presence of `_`, `::` or camel-case outside backticks in documentation"
  72 }
  73
  74 declare_clippy_lint! {
  75     /// ### What it does
  76     /// Checks for the doc comments of publicly visible
  77     /// unsafe functions and warns if there is no `# Safety` section.
  78     ///
  79     /// ### Why is this bad?
  80     /// Unsafe functions should document their safety
  81     /// preconditions, so that users can be sure they are using them safely.
  82     ///
  83     /// ### Examples
  84     /// ```rust
  85     ///# type Universe = ();
  86     /// /// This function should really be documented
  87     /// pub unsafe fn start_apocalypse(u: &mut Universe) {
  88     ///     unimplemented!();
  89     /// }
  90     /// ```
  91     ///
  92     /// At least write a line about safety:
  93     ///
  94     /// ```rust
  95     ///# type Universe = ();
  96     /// /// # Safety
  97     /// ///
  98     /// /// This function should not be called before the horsemen are ready.
  99     /// pub unsafe fn start_apocalypse(u: &mut Universe) {
 100     ///     unimplemented!();
 101     /// }
 102     /// ```
 103     pub MISSING_SAFETY_DOC,
 104     style,
 105     "`pub unsafe fn` without `# Safety` docs"
 106 }
 107
 108 declare_clippy_lint! {
 109     /// ### What it does
 110     /// Checks the doc comments of publicly visible functions that
 111     /// return a `Result` type and warns if there is no `# Errors` section.
 112     ///
 113     /// ### Why is this bad?
 114     /// Documenting the type of errors that can be returned from a
 115     /// function can help callers write code to handle the errors appropriately.
 116     ///
 117     /// ### Examples
 118     /// Since the following function returns a `Result` it has an `# Errors` section in
 119     /// its doc comment:
 120     ///
 121     /// ```rust
 122     ///# use std::io;
 123     /// /// # Errors
 124     /// ///
 125     /// /// Will return `Err` if `filename` does not exist or the user does not have
 126     /// /// permission to read it.
 127     /// pub fn read(filename: String) -> io::Result<String> {
 128     ///     unimplemented!();
 129     /// }
 130     /// ```
 131     pub MISSING_ERRORS_DOC,
 132     pedantic,
 133     "`pub fn` returns `Result` without `# Errors` in doc comment"
 134 }
 135
 136 declare_clippy_lint! {
 137     /// ### What it does
 138     /// Checks the doc comments of publicly visible functions that
 139     /// may panic and warns if there is no `# Panics` section.
 140     ///
 141     /// ### Why is this bad?
 142     /// Documenting the scenarios in which panicking occurs
 143     /// can help callers who do not want to panic to avoid those situations.
 144     ///
 145     /// ### Examples
 146     /// Since the following function may panic it has a `# Panics` section in
 147     /// its doc comment:
 148     ///
 149     /// ```rust
 150     /// /// # Panics
 151     /// ///
 152     /// /// Will panic if y is 0
 153     /// pub fn divide_by(x: i32, y: i32) -> i32 {
 154     ///     if y == 0 {
 155     ///         panic!("Cannot divide by 0")
 156     ///     } else {
 157     ///         x / y
 158     ///     }
 159     /// }
 160     /// ```
 161     pub MISSING_PANICS_DOC,
 162     pedantic,
 163     "`pub fn` may panic without `# Panics` in doc comment"
 164 }
 165
 166 declare_clippy_lint! {
 167     /// ### What it does
 168     /// Checks for `fn main() { .. }` in doctests
 169     ///
 170     /// ### Why is this bad?
 171     /// The test can be shorter (and likely more readable)
 172     /// if the `fn main()` is left implicit.
 173     ///
 174     /// ### Examples
 175     /// ``````rust
 176     /// /// An example of a doctest with a `main()` function
 177     /// ///
 178     /// /// # Examples
 179     /// ///
 180     /// /// ```
 181     /// /// fn main() {
 182     /// ///     // this needs not be in an `fn`
 183     /// /// }
 184     /// /// ```
 185     /// fn needless_main() {
 186     ///     unimplemented!();
 187     /// }
 188     /// ``````
 189     pub NEEDLESS_DOCTEST_MAIN,
 190     style,
 191     "presence of `fn main() {` in code examples"
 192 }
 193
 194 #[allow(clippy::module_name_repetitions)]
 195 #[derive(Clone)]
 196 pub struct DocMarkdown {
 197     valid_idents: FxHashSet<String>,
 198     in_trait_impl: bool,
 199 }
 200
 201 impl DocMarkdown {
 202     pub fn new(valid_idents: FxHashSet<String>) -> Self {
 203         Self {
 204             valid_idents,
 205             in_trait_impl: false,
 206         }
 207     }
 208 }
 209
 210 impl_lint_pass!(DocMarkdown =>
 211     [DOC_MARKDOWN, MISSING_SAFETY_DOC, MISSING_ERRORS_DOC, MISSING_PANICS_DOC, NEEDLESS_DOCTEST_MAIN]
 212 );
 213
 214 impl<'tcx> LateLintPass<'tcx> for DocMarkdown {
 215     fn check_crate(&mut self, cx: &LateContext<'tcx>, _: &'tcx hir::Crate<'_>) {
 216         let attrs = cx.tcx.hir().attrs(hir::CRATE_HIR_ID);
 217         check_attrs(cx, &self.valid_idents, attrs);
 218     }
 219
 220     fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::Item<'_>) {
 221         let attrs = cx.tcx.hir().attrs(item.hir_id());
 222         let headers = check_attrs(cx, &self.valid_idents, attrs);
 223         match item.kind {
 224             hir::ItemKind::Fn(ref sig, _, body_id) => {
 225                 if !(is_entrypoint_fn(cx, item.def_id.to_def_id()) || in_external_macro(cx.tcx.sess, item.span)) {
 226                     let body = cx.tcx.hir().body(body_id);
 227                     let mut fpu = FindPanicUnwrap {
 228                         cx,
 229                         typeck_results: cx.tcx.typeck(item.def_id),
 230                         panic_span: None,
 231                     };
 232                     fpu.visit_expr(&body.value);
 233                     lint_for_missing_headers(cx, item.def_id, item.span, sig, headers, Some(body_id), fpu.panic_span);
 234                 }
 235             },
 236             hir::ItemKind::Impl(ref impl_) => {
 237                 self.in_trait_impl = impl_.of_trait.is_some();
 238             },
 239             hir::ItemKind::Trait(_, unsafety, ..) => {
 240                 if !headers.safety && unsafety == hir::Unsafety::Unsafe {
 241                     span_lint(
 242                         cx,
 243                         MISSING_SAFETY_DOC,
 244                         item.span,
 245                         "unsafe trait's docs miss `# Safety` section",
 246                     );
 247                 }
 248             },
 249             _ => (),
 250         }
 251     }
 252
 253     fn check_item_post(&mut self, _cx: &LateContext<'tcx>, item: &'tcx hir::Item<'_>) {
 254         if let hir::ItemKind::Impl { .. } = item.kind {
 255             self.in_trait_impl = false;
 256         }
 257     }
 258
 259     fn check_trait_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::TraitItem<'_>) {
 260         let attrs = cx.tcx.hir().attrs(item.hir_id());
 261         let headers = check_attrs(cx, &self.valid_idents, attrs);
 262         if let hir::TraitItemKind::Fn(ref sig, ..) = item.kind {
 263             if !in_external_macro(cx.tcx.sess, item.span) {
 264                 lint_for_missing_headers(cx, item.def_id, item.span, sig, headers, None, None);
 265             }
 266         }
 267     }
 268
 269     fn check_impl_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::ImplItem<'_>) {
 270         let attrs = cx.tcx.hir().attrs(item.hir_id());
 271         let headers = check_attrs(cx, &self.valid_idents, attrs);
 272         if self.in_trait_impl || in_external_macro(cx.tcx.sess, item.span) {
 273             return;
 274         }
 275         if let hir::ImplItemKind::Fn(ref sig, body_id) = item.kind {
 276             let body = cx.tcx.hir().body(body_id);
 277             let mut fpu = FindPanicUnwrap {
 278                 cx,
 279                 typeck_results: cx.tcx.typeck(item.def_id),
 280                 panic_span: None,
 281             };
 282             fpu.visit_expr(&body.value);
 283             lint_for_missing_headers(cx, item.def_id, item.span, sig, headers, Some(body_id), fpu.panic_span);
 284         }
 285     }
 286 }
 287
 288 fn lint_for_missing_headers<'tcx>(
 289     cx: &LateContext<'tcx>,
 290     def_id: LocalDefId,
 291     span: impl Into<MultiSpan> + Copy,
 292     sig: &hir::FnSig<'_>,
 293     headers: DocHeaders,
 294     body_id: Option<hir::BodyId>,
 295     panic_span: Option<Span>,
 296 ) {
 297     if !cx.access_levels.is_exported(def_id) {
 298         return; // Private functions do not require doc comments
 299     }
 300     if !headers.safety && sig.header.unsafety == hir::Unsafety::Unsafe {
 301         span_lint(
 302             cx,
 303             MISSING_SAFETY_DOC,
 304             span,
 305             "unsafe function's docs miss `# Safety` section",
 306         );
 307     }
 308     if !headers.panics && panic_span.is_some() {
 309         span_lint_and_note(
 310             cx,
 311             MISSING_PANICS_DOC,
 312             span,
 313             "docs for function which may panic missing `# Panics` section",
 314             panic_span,
 315             "first possible panic found here",
 316         );
 317     }
 318     if !headers.errors {
 319         let hir_id = cx.tcx.hir().local_def_id_to_hir_id(def_id);
 320         if is_type_diagnostic_item(cx, return_ty(cx, hir_id), sym::result_type) {
 321             span_lint(
 322                 cx,
 323                 MISSING_ERRORS_DOC,
 324                 span,
 325                 "docs for function returning `Result` missing `# Errors` section",
 326             );
 327         } else {
 328             if_chain! {
 329                 if let Some(body_id) = body_id;
 330                 if let Some(future) = cx.tcx.lang_items().future_trait();
 331                 let typeck = cx.tcx.typeck_body(body_id);
 332                 let body = cx.tcx.hir().body(body_id);
 333                 let ret_ty = typeck.expr_ty(&body.value);
 334                 if implements_trait(cx, ret_ty, future, &[]);
 335                 if let ty::Opaque(_, subs) = ret_ty.kind();
 336                 if let Some(gen) = subs.types().next();
 337                 if let ty::Generator(_, subs, _) = gen.kind();
 338                 if is_type_diagnostic_item(cx, subs.as_generator().return_ty(), sym::result_type);
 339                 then {
 340                     span_lint(
 341                         cx,
 342                         MISSING_ERRORS_DOC,
 343                         span,
 344                         "docs for function returning `Result` missing `# Errors` section",
 345                     );
 346                 }
 347             }
 348         }
 349     }
 350 }
 351
 352 /// Cleanup documentation decoration.
 353 ///
 354 /// We can't use `rustc_ast::attr::AttributeMethods::with_desugared_doc` or
 355 /// `rustc_ast::parse::lexer::comments::strip_doc_comment_decoration` because we
 356 /// need to keep track of
 357 /// the spans but this function is inspired from the later.
 358 #[allow(clippy::cast_possible_truncation)]
 359 #[must_use]
 360 pub fn strip_doc_comment_decoration(doc: &str, comment_kind: CommentKind, span: Span) -> (String, Vec<(usize, Span)>) {
 361     // one-line comments lose their prefix
 362     if comment_kind == CommentKind::Line {
 363         let mut doc = doc.to_owned();
 364         doc.push('\n');
 365         let len = doc.len();
 366         // +3 skips the opening delimiter
 367         return (doc, vec![(len, span.with_lo(span.lo() + BytePos(3)))]);
 368     }
 369
 370     let mut sizes = vec![];
 371     let mut contains_initial_stars = false;
 372     for line in doc.lines() {
 373         let offset = line.as_ptr() as usize - doc.as_ptr() as usize;
 374         debug_assert_eq!(offset as u32 as usize, offset);
 375         contains_initial_stars |= line.trim_start().starts_with('*');
 376         // +1 adds the newline, +3 skips the opening delimiter
 377         sizes.push((line.len() + 1, span.with_lo(span.lo() + BytePos(3 + offset as u32))));
 378     }
 379     if !contains_initial_stars {
 380         return (doc.to_string(), sizes);
 381     }
 382     // remove the initial '*'s if any
 383     let mut no_stars = String::with_capacity(doc.len());
 384     for line in doc.lines() {
 385         let mut chars = line.chars();
 386         for c in &mut chars {
 387             if c.is_whitespace() {
 388                 no_stars.push(c);
 389             } else {
 390                 no_stars.push(if c == '*' { ' ' } else { c });
 391                 break;
 392             }
 393         }
 394         no_stars.push_str(chars.as_str());
 395         no_stars.push('\n');
 396     }
 397
 398     (no_stars, sizes)
 399 }
 400
 401 #[derive(Copy, Clone)]
 402 struct DocHeaders {
 403     safety: bool,
 404     errors: bool,
 405     panics: bool,
 406 }
 407
 408 fn check_attrs<'a>(cx: &LateContext<'_>, valid_idents: &FxHashSet<String>, attrs: &'a [Attribute]) -> DocHeaders {
 409     let mut doc = String::new();
 410     let mut spans = vec![];
 411
 412     for attr in attrs {
 413         if let AttrKind::DocComment(comment_kind, comment) = attr.kind {
 414             let (comment, current_spans) = strip_doc_comment_decoration(&comment.as_str(), comment_kind, attr.span);
 415             spans.extend_from_slice(&current_spans);
 416             doc.push_str(&comment);
 417         } else if attr.has_name(sym::doc) {
 418             // ignore mix of sugared and non-sugared doc
 419             // don't trigger the safety or errors check
 420             return DocHeaders {
 421                 safety: true,
 422                 errors: true,
 423                 panics: true,
 424             };
 425         }
 426     }
 427
 428     let mut current = 0;
 429     for &mut (ref mut offset, _) in &mut spans {
 430         let offset_copy = *offset;
 431         *offset = current;
 432         current += offset_copy;
 433     }
 434
 435     if doc.is_empty() {
 436         return DocHeaders {
 437             safety: false,
 438             errors: false,
 439             panics: false,
 440         };
 441     }
 442
 443     let parser = pulldown_cmark::Parser::new(&doc).into_offset_iter();
 444     // Iterate over all `Events` and combine consecutive events into one
 445     let events = parser.coalesce(|previous, current| {
 446         use pulldown_cmark::Event::Text;
 447
 448         let previous_range = previous.1;
 449         let current_range = current.1;
 450
 451         match (previous.0, current.0) {
 452             (Text(previous), Text(current)) => {
 453                 let mut previous = previous.to_string();
 454                 previous.push_str(&current);
 455                 Ok((Text(previous.into()), previous_range))
 456             },
 457             (previous, current) => Err(((previous, previous_range), (current, current_range))),
 458         }
 459     });
 460     check_doc(cx, valid_idents, events, &spans)
 461 }
 462
 463 const RUST_CODE: &[&str] = &["rust", "no_run", "should_panic", "compile_fail"];
 464
 465 fn check_doc<'a, Events: Iterator<Item = (pulldown_cmark::Event<'a>, Range<usize>)>>(
 466     cx: &LateContext<'_>,
 467     valid_idents: &FxHashSet<String>,
 468     events: Events,
 469     spans: &[(usize, Span)],
 470 ) -> DocHeaders {
 471     // true if a safety header was found
 472     use pulldown_cmark::Event::{
 473         Code, End, FootnoteReference, HardBreak, Html, Rule, SoftBreak, Start, TaskListMarker, Text,
 474     };
 475     use pulldown_cmark::Tag::{CodeBlock, Heading, Item, Link, Paragraph};
 476     use pulldown_cmark::{CodeBlockKind, CowStr};
 477
 478     let mut headers = DocHeaders {
 479         safety: false,
 480         errors: false,
 481         panics: false,
 482     };
 483     let mut in_code = false;
 484     let mut in_link = None;
 485     let mut in_heading = false;
 486     let mut is_rust = false;
 487     let mut edition = None;
 488     let mut ticks_unbalanced = false;
 489     let mut text_to_check: Vec<(CowStr<'_>, Span)> = Vec::new();
 490     let mut paragraph_span = spans.get(0).expect("function isn't called if doc comment is empty").1;
 491     for (event, range) in events {
 492         match event {
 493             Start(CodeBlock(ref kind)) => {
 494                 in_code = true;
 495                 if let CodeBlockKind::Fenced(lang) = kind {
 496                     for item in lang.split(',') {
 497                         if item == "ignore" {
 498                             is_rust = false;
 499                             break;
 500                         }
 501                         if let Some(stripped) = item.strip_prefix("edition") {
 502                             is_rust = true;
 503                             edition = stripped.parse::<Edition>().ok();
 504                         } else if item.is_empty() || RUST_CODE.contains(&item) {
 505                             is_rust = true;
 506                         }
 507                     }
 508                 }
 509             },
 510             End(CodeBlock(_)) => {
 511                 in_code = false;
 512                 is_rust = false;
 513             },
 514             Start(Link(_, url, _)) => in_link = Some(url),
 515             End(Link(..)) => in_link = None,
 516             Start(Heading(_) | Paragraph | Item) => {
 517                 if let Start(Heading(_)) = event {
 518                     in_heading = true;
 519                 }
 520                 ticks_unbalanced = false;
 521                 let (_, span) = get_current_span(spans, range.start);
 522                 paragraph_span = first_line_of_span(cx, span);
 523             },
 524             End(Heading(_) | Paragraph | Item) => {
 525                 if let End(Heading(_)) = event {
 526                     in_heading = false;
 527                 }
 528                 if ticks_unbalanced {
 529                     span_lint_and_help(
 530                         cx,
 531                         DOC_MARKDOWN,
 532                         paragraph_span,
 533                         "backticks are unbalanced",
 534                         None,
 535                         "a backtick may be missing a pair",
 536                     );
 537                 } else {
 538                     for (text, span) in text_to_check {
 539                         check_text(cx, valid_idents, &text, span);
 540                     }
 541                 }
 542                 text_to_check = Vec::new();
 543             },
 544             Start(_tag) | End(_tag) => (), // We don't care about other tags
 545             Html(_html) => (),             // HTML is weird, just ignore it
 546             SoftBreak | HardBreak | TaskListMarker(_) | Code(_) | Rule => (),
 547             FootnoteReference(text) | Text(text) => {
 548                 let (begin, span) = get_current_span(spans, range.start);
 549                 paragraph_span = paragraph_span.with_hi(span.hi());
 550                 ticks_unbalanced |= text.contains('`') && !in_code;
 551                 if Some(&text) == in_link.as_ref() || ticks_unbalanced {
 552                     // Probably a link of the form `<http://example.com>`
 553                     // Which are represented as a link to "http://example.com" with
 554                     // text "http://example.com" by pulldown-cmark
 555                     continue;
 556                 }
 557                 headers.safety |= in_heading && text.trim() == "Safety";
 558                 headers.errors |= in_heading && text.trim() == "Errors";
 559                 headers.panics |= in_heading && text.trim() == "Panics";
 560                 if in_code {
 561                     if is_rust {
 562                         let edition = edition.unwrap_or_else(|| cx.tcx.sess.edition());
 563                         check_code(cx, &text, edition, span);
 564                     }
 565                 } else {
 566                     // Adjust for the beginning of the current `Event`
 567                     let span = span.with_lo(span.lo() + BytePos::from_usize(range.start - begin));
 568                     text_to_check.push((text, span));
 569                 }
 570             },
 571         }
 572     }
 573     headers
 574 }
 575
 576 fn get_current_span(spans: &[(usize, Span)], idx: usize) -> (usize, Span) {
 577     let index = match spans.binary_search_by(|c| c.0.cmp(&idx)) {
 578         Ok(o) => o,
 579         Err(e) => e - 1,
 580     };
 581     spans[index]
 582 }
 583
 584 fn check_code(cx: &LateContext<'_>, text: &str, edition: Edition, span: Span) {
 585     fn has_needless_main(code: String, edition: Edition) -> bool {
 586         rustc_driver::catch_fatal_errors(|| {
 587             rustc_span::create_session_globals_then(edition, || {
 588                 let filename = FileName::anon_source_code(&code);
 589
 590                 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
 591                 let emitter = EmitterWriter::new(Box::new(io::sink()), None, false, false, false, None, false);
 592                 let handler = Handler::with_emitter(false, None, Box::new(emitter));
 593                 let sess = ParseSess::with_span_handler(handler, sm);
 594
 595                 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, code) {
 596                     Ok(p) => p,
 597                     Err(errs) => {
 598                         for mut err in errs {
 599                             err.cancel();
 600                         }
 601                         return false;
 602                     },
 603                 };
 604
 605                 let mut relevant_main_found = false;
 606                 loop {
 607                     match parser.parse_item(ForceCollect::No) {
 608                         Ok(Some(item)) => match &item.kind {
 609                             // Tests with one of these items are ignored
 610                             ItemKind::Static(..)
 611                             | ItemKind::Const(..)
 612                             | ItemKind::ExternCrate(..)
 613                             | ItemKind::ForeignMod(..) => return false,
 614                             // We found a main function ...
 615                             ItemKind::Fn(box FnKind(_, sig, _, Some(block))) if item.ident.name == sym::main => {
 616                                 let is_async = matches!(sig.header.asyncness, Async::Yes { .. });
 617                                 let returns_nothing = match &sig.decl.output {
 618                                     FnRetTy::Default(..) => true,
 619                                     FnRetTy::Ty(ty) if ty.kind.is_unit() => true,
 620                                     FnRetTy::Ty(_) => false,
 621                                 };
 622
 623                                 if returns_nothing && !is_async && !block.stmts.is_empty() {
 624                                     // This main function should be linted, but only if there are no other functions
 625                                     relevant_main_found = true;
 626                                 } else {
 627                                     // This main function should not be linted, we're done
 628                                     return false;
 629                                 }
 630                             },
 631                             // Another function was found; this case is ignored too
 632                             ItemKind::Fn(..) => return false,
 633                             _ => {},
 634                         },
 635                         Ok(None) => break,
 636                         Err(mut e) => {
 637                             e.cancel();
 638                             return false;
 639                         },
 640                     }
 641                 }
 642
 643                 relevant_main_found
 644             })
 645         })
 646         .ok()
 647         .unwrap_or_default()
 648     }
 649
 650     // Because of the global session, we need to create a new session in a different thread with
 651     // the edition we need.
 652     let text = text.to_owned();
 653     if thread::spawn(move || has_needless_main(text, edition))
 654         .join()
 655         .expect("thread::spawn failed")
 656     {
 657         span_lint(cx, NEEDLESS_DOCTEST_MAIN, span, "needless `fn main` in doctest");
 658     }
 659 }
 660
 661 fn check_text(cx: &LateContext<'_>, valid_idents: &FxHashSet<String>, text: &str, span: Span) {
 662     for word in text.split(|c: char| c.is_whitespace() || c == '\'') {
 663         // Trim punctuation as in `some comment (see foo::bar).`
 664         //                                                   ^^
 665         // Or even as in `_foo bar_` which is emphasized.
 666         let word = word.trim_matches(|c: char| !c.is_alphanumeric());
 667
 668         if valid_idents.contains(word) {
 669             continue;
 670         }
 671
 672         // Adjust for the current word
 673         let offset = word.as_ptr() as usize - text.as_ptr() as usize;
 674         let span = Span::new(
 675             span.lo() + BytePos::from_usize(offset),
 676             span.lo() + BytePos::from_usize(offset + word.len()),
 677             span.ctxt(),
 678         );
 679
 680         check_word(cx, word, span);
 681     }
 682 }
 683
 684 fn check_word(cx: &LateContext<'_>, word: &str, span: Span) {
 685     /// Checks if a string is camel-case, i.e., contains at least two uppercase
 686     /// letters (`Clippy` is ok) and one lower-case letter (`NASA` is ok).
 687     /// Plurals are also excluded (`IDs` is ok).
 688     fn is_camel_case(s: &str) -> bool {
 689         if s.starts_with(|c: char| c.is_digit(10)) {
 690             return false;
 691         }
 692
 693         let s = s.strip_suffix('s').unwrap_or(s);
 694
 695         s.chars().all(char::is_alphanumeric)
 696             && s.chars().filter(|&c| c.is_uppercase()).take(2).count() > 1
 697             && s.chars().filter(|&c| c.is_lowercase()).take(1).count() > 0
 698     }
 699
 700     fn has_underscore(s: &str) -> bool {
 701         s != "_" && !s.contains("\\_") && s.contains('_')
 702     }
 703
 704     fn has_hyphen(s: &str) -> bool {
 705         s != "-" && s.contains('-')
 706     }
 707
 708     if let Ok(url) = Url::parse(word) {
 709         // try to get around the fact that `foo::bar` parses as a valid URL
 710         if !url.cannot_be_a_base() {
 711             span_lint(
 712                 cx,
 713                 DOC_MARKDOWN,
 714                 span,
 715                 "you should put bare URLs between `<`/`>` or make a proper Markdown link",
 716             );
 717
 718             return;
 719         }
 720     }
 721
 722     // We assume that mixed-case words are not meant to be put inside bacticks. (Issue #2343)
 723     if has_underscore(word) && has_hyphen(word) {
 724         return;
 725     }
 726
 727     if has_underscore(word) || word.contains("::") || is_camel_case(word) {
 728         span_lint(
 729             cx,
 730             DOC_MARKDOWN,
 731             span,
 732             &format!("you should put `{}` between ticks in the documentation", word),
 733         );
 734     }
 735 }
 736
 737 struct FindPanicUnwrap<'a, 'tcx> {
 738     cx: &'a LateContext<'tcx>,
 739     panic_span: Option<Span>,
 740     typeck_results: &'tcx ty::TypeckResults<'tcx>,
 741 }
 742
 743 impl<'a, 'tcx> Visitor<'tcx> for FindPanicUnwrap<'a, 'tcx> {
 744     type Map = Map<'tcx>;
 745
 746     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
 747         if self.panic_span.is_some() {
 748             return;
 749         }
 750
 751         // check for `begin_panic`
 752         if_chain! {
 753             if let ExprKind::Call(func_expr, _) = expr.kind;
 754             if let ExprKind::Path(QPath::Resolved(_, path)) = func_expr.kind;
 755             if let Some(path_def_id) = path.res.opt_def_id();
 756             if match_panic_def_id(self.cx, path_def_id);
 757             if is_expn_of(expr.span, "unreachable").is_none();
 758             if !is_expn_of_debug_assertions(expr.span);
 759             then {
 760                 self.panic_span = Some(expr.span);
 761             }
 762         }
 763
 764         // check for `assert_eq` or `assert_ne`
 765         if is_expn_of(expr.span, "assert_eq").is_some() || is_expn_of(expr.span, "assert_ne").is_some() {
 766             self.panic_span = Some(expr.span);
 767         }
 768
 769         // check for `unwrap`
 770         if let Some(arglists) = method_chain_args(expr, &["unwrap"]) {
 771             let reciever_ty = self.typeck_results.expr_ty(&arglists[0][0]).peel_refs();
 772             if is_type_diagnostic_item(self.cx, reciever_ty, sym::option_type)
 773                 || is_type_diagnostic_item(self.cx, reciever_ty, sym::result_type)
 774             {
 775                 self.panic_span = Some(expr.span);
 776             }
 777         }
 778
 779         // and check sub-expressions
 780         intravisit::walk_expr(self, expr);
 781     }
 782
 783     // Panics in const blocks will cause compilation to fail.
 784     fn visit_anon_const(&mut self, _: &'tcx AnonConst) {}
 785
 786     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
 787         NestedVisitorMap::OnlyBodies(self.cx.tcx.hir())
 788     }
 789 }
 790
 791 fn is_expn_of_debug_assertions(span: Span) -> bool {
 792     const MACRO_NAMES: &[&str] = &["debug_assert", "debug_assert_eq", "debug_assert_ne"];
 793     MACRO_NAMES.iter().any(|name| is_expn_of(span, name).is_some())
 794 }