1 //! Emit diagnostics using the `annotate-snippets` library
3 //! This is the equivalent of `./emitter.rs` but making use of the
4 //! [`annotate-snippets`][annotate_snippets] library instead of building the output ourselves.
6 //! [annotate_snippets]: https://docs.rs/crate/annotate-snippets/
8 use crate::emitter::FileWithAnnotatedLines;
9 use crate::snippet::Line;
10 use crate::translation::{to_fluent_args, Translate};
12 CodeSuggestion, Diagnostic, DiagnosticId, DiagnosticMessage, Emitter, FluentBundle,
13 LazyFallbackBundle, Level, MultiSpan, Style, SubDiagnostic,
15 use annotate_snippets::display_list::{DisplayList, FormatOptions};
16 use annotate_snippets::snippet::*;
17 use rustc_data_structures::sync::Lrc;
18 use rustc_error_messages::FluentArgs;
19 use rustc_span::source_map::SourceMap;
20 use rustc_span::SourceFile;
22 /// Generates diagnostics using annotate-snippet
23 pub struct AnnotateSnippetEmitterWriter {
24 source_map: Option<Lrc<SourceMap>>,
25 fluent_bundle: Option<Lrc<FluentBundle>>,
26 fallback_bundle: LazyFallbackBundle,
28 /// If true, hides the longer explanation text
30 /// If true, will normalize line numbers with `LL` to prevent noise in UI test diffs.
33 macro_backtrace: bool,
36 impl Translate for AnnotateSnippetEmitterWriter {
37 fn fluent_bundle(&self) -> Option<&Lrc<FluentBundle>> {
38 self.fluent_bundle.as_ref()
41 fn fallback_fluent_bundle(&self) -> &FluentBundle {
42 &**self.fallback_bundle
46 impl Emitter for AnnotateSnippetEmitterWriter {
47 /// The entry point for the diagnostics generation
48 fn emit_diagnostic(&mut self, diag: &Diagnostic) {
49 let fluent_args = to_fluent_args(diag.args());
51 let mut children = diag.children.clone();
52 let (mut primary_span, suggestions) = self.primary_span_formatted(&diag, &fluent_args);
54 self.fix_multispans_in_extern_macros_and_render_macro_backtrace(
62 self.emit_messages_default(
73 fn source_map(&self) -> Option<&Lrc<SourceMap>> {
74 self.source_map.as_ref()
77 fn should_show_explain(&self) -> bool {
82 /// Provides the source string for the given `line` of `file`
83 fn source_string(file: Lrc<SourceFile>, line: &Line) -> String {
84 file.get_line(line.line_index - 1).map(|a| a.to_string()).unwrap_or_default()
87 /// Maps `Diagnostic::Level` to `snippet::AnnotationType`
88 fn annotation_type_for_level(level: Level) -> AnnotationType {
90 Level::Bug | Level::DelayedBug | Level::Fatal | Level::Error { .. } => {
93 Level::Warning(_) => AnnotationType::Warning,
94 Level::Note | Level::OnceNote => AnnotationType::Note,
95 Level::Help => AnnotationType::Help,
96 // FIXME(#59346): Not sure how to map this level
97 Level::FailureNote => AnnotationType::Error,
98 Level::Allow => panic!("Should not call with Allow"),
99 Level::Expect(_) => panic!("Should not call with Expect"),
103 impl AnnotateSnippetEmitterWriter {
105 source_map: Option<Lrc<SourceMap>>,
106 fluent_bundle: Option<Lrc<FluentBundle>>,
107 fallback_bundle: LazyFallbackBundle,
109 macro_backtrace: bool,
121 /// Allows to modify `Self` to enable or disable the `ui_testing` flag.
123 /// If this is set to true, line numbers will be normalized as `LL` in the output.
124 pub fn ui_testing(mut self, ui_testing: bool) -> Self {
125 self.ui_testing = ui_testing;
129 fn emit_messages_default(
132 messages: &[(DiagnosticMessage, Style)],
133 args: &FluentArgs<'_>,
134 code: &Option<DiagnosticId>,
136 _children: &[SubDiagnostic],
137 _suggestions: &[CodeSuggestion],
139 let message = self.translate_messages(messages, args);
140 if let Some(source_map) = &self.source_map {
141 // Make sure our primary file comes first
142 let primary_lo = if let Some(ref primary_span) = msp.primary_span().as_ref() {
143 if primary_span.is_dummy() {
144 // FIXME(#59346): Not sure when this is the case and what
145 // should be done if it happens
148 source_map.lookup_char_pos(primary_span.lo())
151 // FIXME(#59346): Not sure when this is the case and what
152 // should be done if it happens
155 let mut annotated_files = FileWithAnnotatedLines::collect_annotations(self, args, msp);
157 annotated_files.binary_search_by(|x| x.file.name.cmp(&primary_lo.file.name))
159 annotated_files.swap(0, pos);
161 // owned: line source, line index, annotations
162 type Owned = (String, usize, Vec<crate::snippet::Annotation>);
163 let filename = source_map.filename_for_diagnostics(&primary_lo.file.name);
164 let origin = filename.to_string_lossy();
165 let annotated_files: Vec<Owned> = annotated_files
167 .flat_map(|annotated_file| {
168 let file = annotated_file.file;
173 (source_string(file.clone(), &line), line.line_index, line.annotations)
175 .collect::<Vec<Owned>>()
178 let snippet = Snippet {
179 title: Some(Annotation {
180 label: Some(&message),
181 id: code.as_ref().map(|c| match c {
182 DiagnosticId::Error(val) | DiagnosticId::Lint { name: val, .. } => {
186 annotation_type: annotation_type_for_level(*level),
191 anonymized_line_numbers: self.ui_testing,
194 slices: annotated_files
196 .map(|(source, line_index, annotations)| {
199 line_start: *line_index,
200 origin: Some(&origin),
201 // FIXME(#59346): Not really sure when `fold` should be true or false
203 annotations: annotations
205 .map(|annotation| SourceAnnotation {
206 range: (annotation.start_col, annotation.end_col),
207 label: annotation.label.as_deref().unwrap_or_default(),
208 annotation_type: annotation_type_for_level(*level),
215 // FIXME(#59346): Figure out if we can _always_ print to stderr or not.
216 // `emitter.rs` has the `Destination` enum that lists various possible output
218 eprintln!("{}", DisplayList::from(snippet))
220 // FIXME(#59346): Is it ok to return None if there's no source_map?