1 use crate::CodeSuggestion;
2 use crate::SuggestionStyle;
3 use crate::SubstitutionPart;
4 use crate::Substitution;
5 use crate::Applicability;
7 use crate::snippet::Style;
9 use syntax_pos::{MultiSpan, Span};
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>,
22 #[derive(Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
23 pub enum DiagnosticId {
28 /// For example a note attached to an error.
29 #[derive(Clone, Debug, PartialEq, Hash, RustcEncodable, RustcDecodable)]
30 pub struct SubDiagnostic {
32 pub message: Vec<(String, Style)>,
34 pub render_span: Option<MultiSpan>,
37 #[derive(PartialEq, Eq)]
38 pub struct DiagnosticStyledString(pub Vec<StringPart>);
40 impl DiagnosticStyledString {
41 pub fn new() -> DiagnosticStyledString {
42 DiagnosticStyledString(vec![])
44 pub fn push_normal<S: Into<String>>(&mut self, t: S) {
45 self.0.push(StringPart::Normal(t.into()));
47 pub fn push_highlighted<S: Into<String>>(&mut self, t: S) {
48 self.0.push(StringPart::Highlighted(t.into()));
50 pub fn normal<S: Into<String>>(t: S) -> DiagnosticStyledString {
51 DiagnosticStyledString(vec![StringPart::Normal(t.into())])
54 pub fn highlighted<S: Into<String>>(t: S) -> DiagnosticStyledString {
55 DiagnosticStyledString(vec![StringPart::Highlighted(t.into())])
58 pub fn content(&self) -> String {
59 self.0.iter().map(|x| x.content()).collect::<String>()
63 #[derive(PartialEq, Eq)]
70 pub fn content(&self) -> &str {
72 &StringPart::Normal(ref s) | & StringPart::Highlighted(ref s) => s
78 pub fn new(level: Level, message: &str) -> Self {
79 Diagnostic::new_with_code(level, None, message)
82 pub fn new_with_code(level: Level, code: Option<DiagnosticId>, message: &str) -> Self {
85 message: vec![(message.to_owned(), Style::NoStyle)],
87 span: MultiSpan::new(),
93 pub fn is_error(&self) -> bool {
99 Level::FailureNote => {
106 Level::Cancelled => {
112 /// Cancel the diagnostic (a structured diagnostic must either be emitted or
113 /// canceled or it will panic when dropped).
114 pub fn cancel(&mut self) {
115 self.level = Level::Cancelled;
118 pub fn cancelled(&self) -> bool {
119 self.level == Level::Cancelled
122 /// Adds a span/label to be included in the resulting snippet.
123 /// This is pushed onto the `MultiSpan` that was created when the
124 /// diagnostic was first built. If you don't call this function at
125 /// all, and you just supplied a `Span` to create the diagnostic,
126 /// then the snippet will just include that `Span`, which is
127 /// called the primary span.
128 pub fn span_label<T: Into<String>>(&mut self, span: Span, label: T) -> &mut Self {
129 self.span.push_span_label(span, label.into());
133 pub fn replace_span_with(&mut self, after: Span) -> &mut Self {
134 let before = self.span.clone();
135 self.set_span(after);
136 for span_label in before.span_labels() {
137 if let Some(label) = span_label.label {
138 self.span_label(after, label);
144 pub fn note_expected_found(&mut self,
145 label: &dyn fmt::Display,
146 expected: DiagnosticStyledString,
147 found: DiagnosticStyledString)
150 self.note_expected_found_extra(label, expected, found, &"", &"")
153 pub fn note_expected_found_extra(&mut self,
154 label: &dyn fmt::Display,
155 expected: DiagnosticStyledString,
156 found: DiagnosticStyledString,
157 expected_extra: &dyn fmt::Display,
158 found_extra: &dyn fmt::Display)
161 let mut msg: Vec<_> = vec![(format!("expected {} `", label), Style::NoStyle)];
162 msg.extend(expected.0.iter()
164 StringPart::Normal(ref s) => (s.to_owned(), Style::NoStyle),
165 StringPart::Highlighted(ref s) => (s.to_owned(), Style::Highlight),
167 msg.push((format!("`{}\n", expected_extra), Style::NoStyle));
168 msg.push((format!(" found {} `", label), Style::NoStyle));
169 msg.extend(found.0.iter()
171 StringPart::Normal(ref s) => (s.to_owned(), Style::NoStyle),
172 StringPart::Highlighted(ref s) => (s.to_owned(), Style::Highlight),
174 msg.push((format!("`{}", found_extra), Style::NoStyle));
176 // For now, just attach these as notes
177 self.highlighted_note(msg);
181 pub fn note_trait_signature(&mut self, name: String, signature: String) -> &mut Self {
182 self.highlighted_note(vec![
183 (format!("`{}` from trait: `", name), Style::NoStyle),
184 (signature, Style::Highlight),
185 ("`".to_string(), Style::NoStyle)]);
189 pub fn note(&mut self, msg: &str) -> &mut Self {
190 self.sub(Level::Note, msg, MultiSpan::new(), None);
194 pub fn highlighted_note(&mut self, msg: Vec<(String, Style)>) -> &mut Self {
195 self.sub_with_highlights(Level::Note, msg, MultiSpan::new(), None);
199 pub fn span_note<S: Into<MultiSpan>>(&mut self,
203 self.sub(Level::Note, msg, sp.into(), None);
207 pub fn warn(&mut self, msg: &str) -> &mut Self {
208 self.sub(Level::Warning, msg, MultiSpan::new(), None);
212 pub fn span_warn<S: Into<MultiSpan>>(&mut self,
216 self.sub(Level::Warning, msg, sp.into(), None);
220 pub fn help(&mut self , msg: &str) -> &mut Self {
221 self.sub(Level::Help, msg, MultiSpan::new(), None);
225 pub fn span_help<S: Into<MultiSpan>>(&mut self,
229 self.sub(Level::Help, msg, sp.into(), None);
233 pub fn multipart_suggestion(
236 suggestion: Vec<(Span, String)>,
237 applicability: Applicability,
239 self.suggestions.push(CodeSuggestion {
240 substitutions: vec![Substitution {
243 .map(|(span, snippet)| SubstitutionPart { snippet, span })
247 style: SuggestionStyle::ShowCode,
253 /// Prints out a message with for a multipart suggestion without showing the suggested code.
255 /// This is intended to be used for suggestions that are obvious in what the changes need to
256 /// be from the message, showing the span label inline would be visually unpleasant
257 /// (marginally overlapping spans or multiline spans) and showing the snippet window wouldn't
258 /// improve understandability.
259 pub fn tool_only_multipart_suggestion(
262 suggestion: Vec<(Span, String)>,
263 applicability: Applicability,
265 self.suggestions.push(CodeSuggestion {
266 substitutions: vec![Substitution {
269 .map(|(span, snippet)| SubstitutionPart { snippet, span })
273 style: SuggestionStyle::CompletelyHidden,
279 /// Prints out a message with a suggested edit of the code.
281 /// In case of short messages and a simple suggestion, rustc displays it as a label:
284 /// try adding parentheses: `(tup.0).1`
289 /// * should not end in any punctuation (a `:` is added automatically)
290 /// * should not be a question (avoid language like "did you mean")
291 /// * should not contain any phrases like "the following", "as shown", etc.
292 /// * may look like "to do xyz, use" or "to do xyz, use abc"
293 /// * may contain a name of a function, variable, or type, but not whole expressions
295 /// See `CodeSuggestion` for more information.
296 pub fn span_suggestion(&mut self, sp: Span, msg: &str,
298 applicability: Applicability) -> &mut Self {
299 self.suggestions.push(CodeSuggestion {
300 substitutions: vec![Substitution {
301 parts: vec![SubstitutionPart {
307 style: SuggestionStyle::ShowCode,
313 /// Prints out a message with multiple suggested edits of the code.
314 pub fn span_suggestions(&mut self, sp: Span, msg: &str,
315 suggestions: impl Iterator<Item = String>, applicability: Applicability) -> &mut Self
317 self.suggestions.push(CodeSuggestion {
318 substitutions: suggestions.map(|snippet| Substitution {
319 parts: vec![SubstitutionPart {
325 style: SuggestionStyle::ShowCode,
331 /// Prints out a message with a suggested edit of the code. If the suggestion is presented
332 /// inline, it will only show the message and not the suggestion.
334 /// See `CodeSuggestion` for more information.
335 pub fn span_suggestion_short(
336 &mut self, sp: Span, msg: &str, suggestion: String, applicability: Applicability
338 self.suggestions.push(CodeSuggestion {
339 substitutions: vec![Substitution {
340 parts: vec![SubstitutionPart {
346 style: SuggestionStyle::HideCodeInline,
352 /// Prints out a message with for a suggestion without showing the suggested code.
354 /// This is intended to be used for suggestions that are obvious in what the changes need to
355 /// be from the message, showing the span label inline would be visually unpleasant
356 /// (marginally overlapping spans or multiline spans) and showing the snippet window wouldn't
357 /// improve understandability.
358 pub fn span_suggestion_hidden(
359 &mut self, sp: Span, msg: &str, suggestion: String, applicability: Applicability
361 self.suggestions.push(CodeSuggestion {
362 substitutions: vec![Substitution {
363 parts: vec![SubstitutionPart {
369 style: SuggestionStyle::HideCodeAlways,
375 /// Adds a suggestion to the json output, but otherwise remains silent/undisplayed in the cli.
377 /// This is intended to be used for suggestions that are *very* obvious in what the changes
378 /// need to be from the message, but we still want other tools to be able to apply them.
379 pub fn tool_only_span_suggestion(
380 &mut self, sp: Span, msg: &str, suggestion: String, applicability: Applicability
382 self.suggestions.push(CodeSuggestion {
383 substitutions: vec![Substitution {
384 parts: vec![SubstitutionPart {
390 style: SuggestionStyle::CompletelyHidden,
391 applicability: applicability,
396 pub fn set_span<S: Into<MultiSpan>>(&mut self, sp: S) -> &mut Self {
397 self.span = sp.into();
401 pub fn code(&mut self, s: DiagnosticId) -> &mut Self {
406 pub fn get_code(&self) -> Option<DiagnosticId> {
410 pub fn message(&self) -> String {
411 self.message.iter().map(|i| i.0.as_str()).collect::<String>()
414 pub fn styled_message(&self) -> &Vec<(String, Style)> {
418 /// Used by a lint. Copies over all details *but* the "main
420 pub fn copy_details_not_message(&mut self, from: &Diagnostic) {
421 self.span = from.span.clone();
422 self.code = from.code.clone();
423 self.children.extend(from.children.iter().cloned())
426 /// Convenience function for internal use, clients should use one of the
427 /// public methods above.
428 pub fn sub(&mut self,
432 render_span: Option<MultiSpan>) {
433 let sub = SubDiagnostic {
435 message: vec![(message.to_owned(), Style::NoStyle)],
439 self.children.push(sub);
442 /// Convenience function for internal use, clients should use one of the
443 /// public methods above.
444 fn sub_with_highlights(&mut self,
446 message: Vec<(String, Style)>,
448 render_span: Option<MultiSpan>) {
449 let sub = SubDiagnostic {
455 self.children.push(sub);
460 pub fn message(&self) -> String {
461 self.message.iter().map(|i| i.0.as_str()).collect::<String>()
464 pub fn styled_message(&self) -> &Vec<(String, Style)> {