1 use crate::snippet::Style;
2 use crate::Applicability;
3 use crate::CodeSuggestion;
5 use crate::Substitution;
6 use crate::SubstitutionPart;
7 use crate::SuggestionStyle;
8 use rustc_span::{MultiSpan, Span, DUMMY_SP};
12 #[derive(Clone, Debug, PartialEq, Hash, RustcEncodable, RustcDecodable)]
13 pub struct Diagnostic {
15 pub message: Vec<(String, Style)>,
16 pub code: Option<DiagnosticId>,
18 pub children: Vec<SubDiagnostic>,
19 pub suggestions: Vec<CodeSuggestion>,
21 /// This is not used for highlighting or rendering any error message. Rather, it can be used
22 /// as a sort key to sort a buffer of diagnostics. By default, it is the primary span of
23 /// `span` if there is one. Otherwise, it is `DUMMY_SP`.
27 #[derive(Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
28 pub enum DiagnosticId {
33 /// For example a note attached to an error.
34 #[derive(Clone, Debug, PartialEq, Hash, RustcEncodable, RustcDecodable)]
35 pub struct SubDiagnostic {
37 pub message: Vec<(String, Style)>,
39 pub render_span: Option<MultiSpan>,
42 #[derive(Debug, PartialEq, Eq)]
43 pub struct DiagnosticStyledString(pub Vec<StringPart>);
45 impl DiagnosticStyledString {
46 pub fn new() -> DiagnosticStyledString {
47 DiagnosticStyledString(vec![])
49 pub fn push_normal<S: Into<String>>(&mut self, t: S) {
50 self.0.push(StringPart::Normal(t.into()));
52 pub fn push_highlighted<S: Into<String>>(&mut self, t: S) {
53 self.0.push(StringPart::Highlighted(t.into()));
55 pub fn push<S: Into<String>>(&mut self, t: S, highlight: bool) {
57 self.push_highlighted(t);
62 pub fn normal<S: Into<String>>(t: S) -> DiagnosticStyledString {
63 DiagnosticStyledString(vec![StringPart::Normal(t.into())])
66 pub fn highlighted<S: Into<String>>(t: S) -> DiagnosticStyledString {
67 DiagnosticStyledString(vec![StringPart::Highlighted(t.into())])
70 pub fn content(&self) -> String {
71 self.0.iter().map(|x| x.content()).collect::<String>()
75 #[derive(Debug, PartialEq, Eq)]
82 pub fn content(&self) -> &str {
84 &StringPart::Normal(ref s) | &StringPart::Highlighted(ref s) => s,
90 pub fn new(level: Level, message: &str) -> Self {
91 Diagnostic::new_with_code(level, None, message)
94 pub fn new_with_code(level: Level, code: Option<DiagnosticId>, message: &str) -> Self {
97 message: vec![(message.to_owned(), Style::NoStyle)],
99 span: MultiSpan::new(),
106 pub fn is_error(&self) -> bool {
108 Level::Bug | Level::Fatal | Level::Error | Level::FailureNote => true,
110 Level::Warning | Level::Note | Level::Help | Level::Cancelled => false,
114 /// Cancel the diagnostic (a structured diagnostic must either be emitted or
115 /// canceled or it will panic when dropped).
116 pub fn cancel(&mut self) {
117 self.level = Level::Cancelled;
120 pub fn cancelled(&self) -> bool {
121 self.level == Level::Cancelled
124 /// Set the sorting span.
125 pub fn set_sort_span(&mut self, sp: Span) {
129 /// Adds a span/label to be included in the resulting snippet.
130 /// This label will be shown together with the original span/label used when creating the
131 /// diagnostic, *not* a span added by one of the `span_*` methods.
133 /// This is pushed onto the `MultiSpan` that was created when the
134 /// diagnostic was first built. If you don't call this function at
135 /// all, and you just supplied a `Span` to create the diagnostic,
136 /// then the snippet will just include that `Span`, which is
137 /// called the primary span.
138 pub fn span_label<T: Into<String>>(&mut self, span: Span, label: T) -> &mut Self {
139 self.span.push_span_label(span, label.into());
143 pub fn replace_span_with(&mut self, after: Span) -> &mut Self {
144 let before = self.span.clone();
145 self.set_span(after);
146 for span_label in before.span_labels() {
147 if let Some(label) = span_label.label {
148 self.span_label(after, label);
154 pub fn note_expected_found(
156 expected_label: &dyn fmt::Display,
157 expected: DiagnosticStyledString,
158 found_label: &dyn fmt::Display,
159 found: DiagnosticStyledString,
161 self.note_expected_found_extra(expected_label, expected, found_label, found, &"", &"")
164 pub fn note_unsuccessfull_coercion(
166 expected: DiagnosticStyledString,
167 found: DiagnosticStyledString,
169 let mut msg: Vec<_> =
170 vec![(format!("required when trying to coerce from type `"), Style::NoStyle)];
171 msg.extend(expected.0.iter().map(|x| match *x {
172 StringPart::Normal(ref s) => (s.to_owned(), Style::NoStyle),
173 StringPart::Highlighted(ref s) => (s.to_owned(), Style::Highlight),
175 msg.push((format!("` to type '"), Style::NoStyle));
176 msg.extend(found.0.iter().map(|x| match *x {
177 StringPart::Normal(ref s) => (s.to_owned(), Style::NoStyle),
178 StringPart::Highlighted(ref s) => (s.to_owned(), Style::Highlight),
180 msg.push((format!("`"), Style::NoStyle));
182 // For now, just attach these as notes
183 self.highlighted_note(msg);
187 pub fn note_expected_found_extra(
189 expected_label: &dyn fmt::Display,
190 expected: DiagnosticStyledString,
191 found_label: &dyn fmt::Display,
192 found: DiagnosticStyledString,
193 expected_extra: &dyn fmt::Display,
194 found_extra: &dyn fmt::Display,
196 let expected_label = format!("expected {}", expected_label);
197 let found_label = format!("found {}", found_label);
198 let (found_padding, expected_padding) = if expected_label.len() > found_label.len() {
199 (expected_label.len() - found_label.len(), 0)
201 (0, found_label.len() - expected_label.len())
203 let mut msg: Vec<_> =
204 vec![(format!("{}{} `", " ".repeat(expected_padding), expected_label), Style::NoStyle)];
205 msg.extend(expected.0.iter().map(|x| match *x {
206 StringPart::Normal(ref s) => (s.to_owned(), Style::NoStyle),
207 StringPart::Highlighted(ref s) => (s.to_owned(), Style::Highlight),
209 msg.push((format!("`{}\n", expected_extra), Style::NoStyle));
210 msg.push((format!("{}{} `", " ".repeat(found_padding), found_label), Style::NoStyle));
211 msg.extend(found.0.iter().map(|x| match *x {
212 StringPart::Normal(ref s) => (s.to_owned(), Style::NoStyle),
213 StringPart::Highlighted(ref s) => (s.to_owned(), Style::Highlight),
215 msg.push((format!("`{}", found_extra), Style::NoStyle));
217 // For now, just attach these as notes.
218 self.highlighted_note(msg);
222 pub fn note_trait_signature(&mut self, name: String, signature: String) -> &mut Self {
223 self.highlighted_note(vec![
224 (format!("`{}` from trait: `", name), Style::NoStyle),
225 (signature, Style::Highlight),
226 ("`".to_string(), Style::NoStyle),
231 pub fn note(&mut self, msg: &str) -> &mut Self {
232 self.sub(Level::Note, msg, MultiSpan::new(), None);
236 pub fn highlighted_note(&mut self, msg: Vec<(String, Style)>) -> &mut Self {
237 self.sub_with_highlights(Level::Note, msg, MultiSpan::new(), None);
241 /// Prints the span with a note above it.
242 pub fn span_note<S: Into<MultiSpan>>(&mut self, sp: S, msg: &str) -> &mut Self {
243 self.sub(Level::Note, msg, sp.into(), None);
247 pub fn warn(&mut self, msg: &str) -> &mut Self {
248 self.sub(Level::Warning, msg, MultiSpan::new(), None);
252 /// Prints the span with a warn above it.
253 pub fn span_warn<S: Into<MultiSpan>>(&mut self, sp: S, msg: &str) -> &mut Self {
254 self.sub(Level::Warning, msg, sp.into(), None);
258 pub fn help(&mut self, msg: &str) -> &mut Self {
259 self.sub(Level::Help, msg, MultiSpan::new(), None);
263 /// Prints the span with some help above it.
264 pub fn span_help<S: Into<MultiSpan>>(&mut self, sp: S, msg: &str) -> &mut Self {
265 self.sub(Level::Help, msg, sp.into(), None);
269 pub fn multipart_suggestion(
272 suggestion: Vec<(Span, String)>,
273 applicability: Applicability,
275 self.suggestions.push(CodeSuggestion {
276 substitutions: vec![Substitution {
279 .map(|(span, snippet)| SubstitutionPart { snippet, span })
283 style: SuggestionStyle::ShowCode,
289 /// Prints out a message with for a multipart suggestion without showing the suggested code.
291 /// This is intended to be used for suggestions that are obvious in what the changes need to
292 /// be from the message, showing the span label inline would be visually unpleasant
293 /// (marginally overlapping spans or multiline spans) and showing the snippet window wouldn't
294 /// improve understandability.
295 pub fn tool_only_multipart_suggestion(
298 suggestion: Vec<(Span, String)>,
299 applicability: Applicability,
301 self.suggestions.push(CodeSuggestion {
302 substitutions: vec![Substitution {
305 .map(|(span, snippet)| SubstitutionPart { snippet, span })
309 style: SuggestionStyle::CompletelyHidden,
315 /// Prints out a message with a suggested edit of the code.
317 /// In case of short messages and a simple suggestion, rustc displays it as a label:
320 /// try adding parentheses: `(tup.0).1`
325 /// * should not end in any punctuation (a `:` is added automatically)
326 /// * should not be a question (avoid language like "did you mean")
327 /// * should not contain any phrases like "the following", "as shown", etc.
328 /// * may look like "to do xyz, use" or "to do xyz, use abc"
329 /// * may contain a name of a function, variable, or type, but not whole expressions
331 /// See `CodeSuggestion` for more information.
332 pub fn span_suggestion(
337 applicability: Applicability,
339 self.span_suggestion_with_style(
344 SuggestionStyle::ShowCode,
349 pub fn span_suggestion_with_style(
354 applicability: Applicability,
355 style: SuggestionStyle,
357 self.suggestions.push(CodeSuggestion {
358 substitutions: vec![Substitution {
359 parts: vec![SubstitutionPart { snippet: suggestion, span: sp }],
368 pub fn span_suggestion_verbose(
373 applicability: Applicability,
375 self.span_suggestion_with_style(
380 SuggestionStyle::ShowAlways,
385 /// Prints out a message with multiple suggested edits of the code.
386 pub fn span_suggestions(
390 suggestions: impl Iterator<Item = String>,
391 applicability: Applicability,
393 self.suggestions.push(CodeSuggestion {
394 substitutions: suggestions
395 .map(|snippet| Substitution { parts: vec![SubstitutionPart { snippet, span: sp }] })
398 style: SuggestionStyle::ShowCode,
404 /// Prints out a message with a suggested edit of the code. If the suggestion is presented
405 /// inline, it will only show the message and not the suggestion.
407 /// See `CodeSuggestion` for more information.
408 pub fn span_suggestion_short(
413 applicability: Applicability,
415 self.span_suggestion_with_style(
420 SuggestionStyle::HideCodeInline,
425 /// Prints out a message with for a suggestion without showing the suggested code.
427 /// This is intended to be used for suggestions that are obvious in what the changes need to
428 /// be from the message, showing the span label inline would be visually unpleasant
429 /// (marginally overlapping spans or multiline spans) and showing the snippet window wouldn't
430 /// improve understandability.
431 pub fn span_suggestion_hidden(
436 applicability: Applicability,
438 self.span_suggestion_with_style(
443 SuggestionStyle::HideCodeAlways,
448 /// Adds a suggestion to the json output, but otherwise remains silent/undisplayed in the cli.
450 /// This is intended to be used for suggestions that are *very* obvious in what the changes
451 /// need to be from the message, but we still want other tools to be able to apply them.
452 pub fn tool_only_span_suggestion(
457 applicability: Applicability,
459 self.span_suggestion_with_style(
464 SuggestionStyle::CompletelyHidden,
469 pub fn set_span<S: Into<MultiSpan>>(&mut self, sp: S) -> &mut Self {
470 self.span = sp.into();
471 if let Some(span) = self.span.primary_span() {
472 self.sort_span = span;
477 pub fn code(&mut self, s: DiagnosticId) -> &mut Self {
482 pub fn clear_code(&mut self) -> &mut Self {
487 pub fn get_code(&self) -> Option<DiagnosticId> {
491 pub fn set_primary_message<M: Into<String>>(&mut self, msg: M) -> &mut Self {
492 self.message[0] = (msg.into(), Style::NoStyle);
496 pub fn message(&self) -> String {
497 self.message.iter().map(|i| i.0.as_str()).collect::<String>()
500 pub fn styled_message(&self) -> &Vec<(String, Style)> {
504 /// Used by a lint. Copies over all details *but* the "main
506 pub fn copy_details_not_message(&mut self, from: &Diagnostic) {
507 self.span = from.span.clone();
508 self.code = from.code.clone();
509 self.children.extend(from.children.iter().cloned())
512 /// Convenience function for internal use, clients should use one of the
513 /// public methods above.
519 render_span: Option<MultiSpan>,
521 let sub = SubDiagnostic {
523 message: vec![(message.to_owned(), Style::NoStyle)],
527 self.children.push(sub);
530 /// Convenience function for internal use, clients should use one of the
531 /// public methods above.
532 fn sub_with_highlights(
535 message: Vec<(String, Style)>,
537 render_span: Option<MultiSpan>,
539 let sub = SubDiagnostic { level, message, span, render_span };
540 self.children.push(sub);
545 pub fn message(&self) -> String {
546 self.message.iter().map(|i| i.0.as_str()).collect::<String>()
549 pub fn styled_message(&self) -> &Vec<(String, Style)> {