clippy_lints/src/doc.rs

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