src/librustdoc/passes/check_code_block_syntax.rs

   1 //! Validates syntax inside Rust code blocks (\`\`\`rust).
   2 use rustc_data_structures::sync::{Lock, Lrc};
   3 use rustc_errors::{
   4     emitter::Emitter, translation::Translate, Applicability, Diagnostic, Handler,
   5     LazyFallbackBundle,
   6 };
   7 use rustc_parse::parse_stream_from_source_str;
   8 use rustc_session::parse::ParseSess;
   9 use rustc_span::hygiene::{AstPass, ExpnData, ExpnKind, LocalExpnId};
  10 use rustc_span::source_map::{FilePathMapping, SourceMap};
  11 use rustc_span::{FileName, InnerSpan, DUMMY_SP};
  12
  13 use crate::clean;
  14 use crate::core::DocContext;
  15 use crate::html::markdown::{self, RustCodeBlock};
  16 use crate::passes::Pass;
  17 use crate::visit::DocVisitor;
  18
  19 pub(crate) const CHECK_CODE_BLOCK_SYNTAX: Pass = Pass {
  20     name: "check-code-block-syntax",
  21     run: check_code_block_syntax,
  22     description: "validates syntax inside Rust code blocks",
  23 };
  24
  25 pub(crate) fn check_code_block_syntax(
  26     krate: clean::Crate,
  27     cx: &mut DocContext<'_>,
  28 ) -> clean::Crate {
  29     SyntaxChecker { cx }.visit_crate(&krate);
  30     krate
  31 }
  32
  33 struct SyntaxChecker<'a, 'tcx> {
  34     cx: &'a DocContext<'tcx>,
  35 }
  36
  37 impl<'a, 'tcx> SyntaxChecker<'a, 'tcx> {
  38     fn check_rust_syntax(&self, item: &clean::Item, dox: &str, code_block: RustCodeBlock) {
  39         let buffer = Lrc::new(Lock::new(Buffer::default()));
  40         let fallback_bundle =
  41             rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
  42         let emitter = BufferEmitter { buffer: Lrc::clone(&buffer), fallback_bundle };
  43
  44         let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
  45         let handler = Handler::with_emitter(false, None, Box::new(emitter));
  46         let source = dox[code_block.code].to_owned();
  47         let sess = ParseSess::with_span_handler(handler, sm);
  48
  49         let edition = code_block.lang_string.edition.unwrap_or_else(|| self.cx.tcx.sess.edition());
  50         let expn_data = ExpnData::default(
  51             ExpnKind::AstPass(AstPass::TestHarness),
  52             DUMMY_SP,
  53             edition,
  54             None,
  55             None,
  56         );
  57         let expn_id =
  58             self.cx.tcx.with_stable_hashing_context(|hcx| LocalExpnId::fresh(expn_data, hcx));
  59         let span = DUMMY_SP.fresh_expansion(expn_id);
  60
  61         let is_empty = rustc_driver::catch_fatal_errors(|| {
  62             parse_stream_from_source_str(
  63                 FileName::Custom(String::from("doctest")),
  64                 source,
  65                 &sess,
  66                 Some(span),
  67             )
  68             .is_empty()
  69         })
  70         .unwrap_or(false);
  71         let buffer = buffer.borrow();
  72
  73         if !buffer.has_errors && !is_empty {
  74             // No errors in a non-empty program.
  75             return;
  76         }
  77
  78         let Some(local_id) = item.item_id.as_def_id().and_then(|x| x.as_local())
  79         else {
  80             // We don't need to check the syntax for other crates so returning
  81             // without doing anything should not be a problem.
  82             return;
  83         };
  84
  85         let hir_id = self.cx.tcx.hir().local_def_id_to_hir_id(local_id);
  86         let empty_block = code_block.lang_string == Default::default() && code_block.is_fenced;
  87         let is_ignore = code_block.lang_string.ignore != markdown::Ignore::None;
  88
  89         // The span and whether it is precise or not.
  90         let (sp, precise_span) = match super::source_span_for_markdown_range(
  91             self.cx.tcx,
  92             dox,
  93             &code_block.range,
  94             &item.attrs,
  95         ) {
  96             Some(sp) => (sp, true),
  97             None => (item.attr_span(self.cx.tcx), false),
  98         };
  99
 100         let msg = if buffer.has_errors {
 101             "could not parse code block as Rust code"
 102         } else {
 103             "Rust code block is empty"
 104         };
 105
 106         // Finally build and emit the completed diagnostic.
 107         // All points of divergence have been handled earlier so this can be
 108         // done the same way whether the span is precise or not.
 109         self.cx.tcx.struct_span_lint_hir(
 110             crate::lint::INVALID_RUST_CODEBLOCKS,
 111             hir_id,
 112             sp,
 113             msg,
 114             |lint| {
 115                 let explanation = if is_ignore {
 116                     "`ignore` code blocks require valid Rust code for syntax highlighting; \
 117                     mark blocks that do not contain Rust code as text"
 118                 } else {
 119                     "mark blocks that do not contain Rust code as text"
 120                 };
 121
 122                 if precise_span {
 123                     if is_ignore {
 124                         // giving an accurate suggestion is hard because `ignore` might not have come first in the list.
 125                         // just give a `help` instead.
 126                         lint.span_help(
 127                             sp.from_inner(InnerSpan::new(0, 3)),
 128                             &format!("{}: ```text", explanation),
 129                         );
 130                     } else if empty_block {
 131                         lint.span_suggestion(
 132                             sp.from_inner(InnerSpan::new(0, 3)).shrink_to_hi(),
 133                             explanation,
 134                             "text",
 135                             Applicability::MachineApplicable,
 136                         );
 137                     }
 138                 } else if empty_block || is_ignore {
 139                     lint.help(&format!("{}: ```text", explanation));
 140                 }
 141
 142                 // FIXME(#67563): Provide more context for these errors by displaying the spans inline.
 143                 for message in buffer.messages.iter() {
 144                     lint.note(message);
 145                 }
 146
 147                 lint
 148             },
 149         );
 150     }
 151 }
 152
 153 impl<'a, 'tcx> DocVisitor for SyntaxChecker<'a, 'tcx> {
 154     fn visit_item(&mut self, item: &clean::Item) {
 155         if let Some(dox) = &item.attrs.collapsed_doc_value() {
 156             let sp = item.attr_span(self.cx.tcx);
 157             let extra = crate::html::markdown::ExtraInfo::new_did(
 158                 self.cx.tcx,
 159                 item.item_id.expect_def_id(),
 160                 sp,
 161             );
 162             for code_block in markdown::rust_code_blocks(dox, &extra) {
 163                 self.check_rust_syntax(item, dox, code_block);
 164             }
 165         }
 166
 167         self.visit_item_recur(item)
 168     }
 169 }
 170
 171 #[derive(Default)]
 172 struct Buffer {
 173     messages: Vec<String>,
 174     has_errors: bool,
 175 }
 176
 177 struct BufferEmitter {
 178     buffer: Lrc<Lock<Buffer>>,
 179     fallback_bundle: LazyFallbackBundle,
 180 }
 181
 182 impl Translate for BufferEmitter {
 183     fn fluent_bundle(&self) -> Option<&Lrc<rustc_errors::FluentBundle>> {
 184         None
 185     }
 186
 187     fn fallback_fluent_bundle(&self) -> &rustc_errors::FluentBundle {
 188         &**self.fallback_bundle
 189     }
 190 }
 191
 192 impl Emitter for BufferEmitter {
 193     fn emit_diagnostic(&mut self, diag: &Diagnostic) {
 194         let mut buffer = self.buffer.borrow_mut();
 195
 196         let fluent_args = self.to_fluent_args(diag.args());
 197         let translated_main_message = self.translate_message(&diag.message[0].0, &fluent_args);
 198
 199         buffer.messages.push(format!("error from rustc: {}", translated_main_message));
 200         if diag.is_error() {
 201             buffer.has_errors = true;
 202         }
 203     }
 204
 205     fn source_map(&self) -> Option<&Lrc<SourceMap>> {
 206         None
 207     }
 208 }