src/librustdoc/passes/html_tags.rs

   1 use super::{span_of_attrs, Pass};
   2 use crate::clean::*;
   3 use crate::core::DocContext;
   4 use crate::fold::DocFolder;
   5 use crate::html::markdown::opts;
   6 use core::ops::Range;
   7 use pulldown_cmark::{Event, Parser};
   8 use rustc_feature::UnstableFeatures;
   9 use rustc_session::lint;
  10
  11 pub const CHECK_INVALID_HTML_TAGS: Pass = Pass {
  12     name: "check-invalid-html-tags",
  13     run: check_invalid_html_tags,
  14     description: "detects invalid HTML tags in doc comments",
  15 };
  16
  17 struct InvalidHtmlTagsLinter<'a, 'tcx> {
  18     cx: &'a DocContext<'tcx>,
  19 }
  20
  21 impl<'a, 'tcx> InvalidHtmlTagsLinter<'a, 'tcx> {
  22     fn new(cx: &'a DocContext<'tcx>) -> Self {
  23         InvalidHtmlTagsLinter { cx }
  24     }
  25 }
  26
  27 pub fn check_invalid_html_tags(krate: Crate, cx: &DocContext<'_>) -> Crate {
  28     if !UnstableFeatures::from_environment().is_nightly_build() {
  29         krate
  30     } else {
  31         let mut coll = InvalidHtmlTagsLinter::new(cx);
  32
  33         coll.fold_crate(krate)
  34     }
  35 }
  36
  37 const ALLOWED_UNCLOSED: &[&str] = &[
  38     "area", "base", "br", "col", "embed", "hr", "img", "input", "keygen", "link", "meta", "param",
  39     "source", "track", "wbr",
  40 ];
  41
  42 fn drop_tag(
  43     tags: &mut Vec<(String, Range<usize>)>,
  44     tag_name: String,
  45     range: Range<usize>,
  46     f: &impl Fn(&str, &Range<usize>),
  47 ) {
  48     if let Some(pos) = tags.iter().rev().position(|(t, _)| *t == tag_name) {
  49         // Because this is from a `rev` iterator, the position is reversed as well!
  50         let pos = tags.len() - 1 - pos;
  51         for (last_tag_name, last_tag_span) in tags.drain(pos + 1..) {
  52             if ALLOWED_UNCLOSED.iter().any(|&at| at == &last_tag_name) {
  53                 continue;
  54             }
  55             // `tags` is used as a queue, meaning that everything after `pos` is included inside it.
  56             // So `<h2><h3></h2>` will look like `["h2", "h3"]`. So when closing `h2`, we will still
  57             // have `h3`, meaning the tag wasn't closed as it should have.
  58             f(&format!("unclosed HTML tag `{}`", last_tag_name), &last_tag_span);
  59         }
  60         // Remove the `tag_name` that was originally closed
  61         tags.pop();
  62     } else {
  63         // It can happen for example in this case: `<h2></script></h2>` (the `h2` tag isn't required
  64         // but it helps for the visualization).
  65         f(&format!("unopened HTML tag `{}`", tag_name), &range);
  66     }
  67 }
  68
  69 fn extract_tag(
  70     tags: &mut Vec<(String, Range<usize>)>,
  71     text: &str,
  72     range: Range<usize>,
  73     f: &impl Fn(&str, &Range<usize>),
  74 ) {
  75     let mut iter = text.chars().enumerate().peekable();
  76
  77     while let Some((start_pos, c)) = iter.next() {
  78         if c == '<' {
  79             let mut tag_name = String::new();
  80             let mut is_closing = false;
  81             while let Some((pos, c)) = iter.peek() {
  82                 // Checking if this is a closing tag (like `</a>` for `<a>`).
  83                 if *c == '/' && tag_name.is_empty() {
  84                     is_closing = true;
  85                 } else if c.is_ascii_alphanumeric() && !c.is_ascii_uppercase() {
  86                     tag_name.push(*c);
  87                 } else {
  88                     if !tag_name.is_empty() {
  89                         let mut r =
  90                             Range { start: range.start + start_pos, end: range.start + pos };
  91                         if *c == '>' {
  92                             // In case we have a tag without attribute, we can consider the span to
  93                             // refer to it fully.
  94                             r.end += 1;
  95                         }
  96                         if is_closing {
  97                             drop_tag(tags, tag_name, r, f);
  98                         } else {
  99                             tags.push((tag_name, r));
 100                         }
 101                     }
 102                     break;
 103                 }
 104                 iter.next();
 105             }
 106         }
 107     }
 108 }
 109
 110 impl<'a, 'tcx> DocFolder for InvalidHtmlTagsLinter<'a, 'tcx> {
 111     fn fold_item(&mut self, item: Item) -> Option<Item> {
 112         let hir_id = match self.cx.as_local_hir_id(item.def_id) {
 113             Some(hir_id) => hir_id,
 114             None => {
 115                 // If non-local, no need to check anything.
 116                 return self.fold_item_recur(item);
 117             }
 118         };
 119         let dox = item.attrs.collapsed_doc_value().unwrap_or_default();
 120         if !dox.is_empty() {
 121             let cx = &self.cx;
 122             let report_diag = |msg: &str, range: &Range<usize>| {
 123                 let sp = match super::source_span_for_markdown_range(cx, &dox, range, &item.attrs) {
 124                     Some(sp) => sp,
 125                     None => span_of_attrs(&item.attrs).unwrap_or(item.source.span()),
 126                 };
 127                 cx.tcx.struct_span_lint_hir(lint::builtin::INVALID_HTML_TAGS, hir_id, sp, |lint| {
 128                     lint.build(msg).emit()
 129                 });
 130             };
 131
 132             let mut tags = Vec::new();
 133
 134             let p = Parser::new_ext(&dox, opts()).into_offset_iter();
 135
 136             for (event, range) in p {
 137                 match event {
 138                     Event::Html(text) => extract_tag(&mut tags, &text, range, &report_diag),
 139                     _ => {}
 140                 }
 141             }
 142
 143             for (tag, range) in
 144                 tags.iter().filter(|(t, _)| ALLOWED_UNCLOSED.iter().find(|&at| at == t).is_none())
 145             {
 146                 report_diag(&format!("unclosed HTML tag `{}`", tag), range);
 147             }
 148         }
 149
 150         self.fold_item_recur(item)
 151     }
 152 }