src/librustc_errors/diagnostic.rs

   1 use crate::snippet::Style;
   2 use crate::Applicability;
   3 use crate::CodeSuggestion;
   4 use crate::Level;
   5 use crate::Substitution;
   6 use crate::SubstitutionPart;
   7 use crate::SuggestionStyle;
   8 use rustc_span::{MultiSpan, Span, DUMMY_SP};
   9 use std::fmt;
  10
  11 #[must_use]
  12 #[derive(Clone, Debug, PartialEq, Hash, RustcEncodable, RustcDecodable)]
  13 pub struct Diagnostic {
  14     pub level: Level,
  15     pub message: Vec<(String, Style)>,
  16     pub code: Option<DiagnosticId>,
  17     pub span: MultiSpan,
  18     pub children: Vec<SubDiagnostic>,
  19     pub suggestions: Vec<CodeSuggestion>,
  20
  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`.
  24     pub sort_span: Span,
  25 }
  26
  27 #[derive(Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
  28 pub enum DiagnosticId {
  29     Error(String),
  30     Lint(String),
  31 }
  32
  33 /// For example a note attached to an error.
  34 #[derive(Clone, Debug, PartialEq, Hash, RustcEncodable, RustcDecodable)]
  35 pub struct SubDiagnostic {
  36     pub level: Level,
  37     pub message: Vec<(String, Style)>,
  38     pub span: MultiSpan,
  39     pub render_span: Option<MultiSpan>,
  40 }
  41
  42 #[derive(Debug, PartialEq, Eq)]
  43 pub struct DiagnosticStyledString(pub Vec<StringPart>);
  44
  45 impl DiagnosticStyledString {
  46     pub fn new() -> DiagnosticStyledString {
  47         DiagnosticStyledString(vec![])
  48     }
  49     pub fn push_normal<S: Into<String>>(&mut self, t: S) {
  50         self.0.push(StringPart::Normal(t.into()));
  51     }
  52     pub fn push_highlighted<S: Into<String>>(&mut self, t: S) {
  53         self.0.push(StringPart::Highlighted(t.into()));
  54     }
  55     pub fn push<S: Into<String>>(&mut self, t: S, highlight: bool) {
  56         if highlight {
  57             self.push_highlighted(t);
  58         } else {
  59             self.push_normal(t);
  60         }
  61     }
  62     pub fn normal<S: Into<String>>(t: S) -> DiagnosticStyledString {
  63         DiagnosticStyledString(vec![StringPart::Normal(t.into())])
  64     }
  65
  66     pub fn highlighted<S: Into<String>>(t: S) -> DiagnosticStyledString {
  67         DiagnosticStyledString(vec![StringPart::Highlighted(t.into())])
  68     }
  69
  70     pub fn content(&self) -> String {
  71         self.0.iter().map(|x| x.content()).collect::<String>()
  72     }
  73 }
  74
  75 #[derive(Debug, PartialEq, Eq)]
  76 pub enum StringPart {
  77     Normal(String),
  78     Highlighted(String),
  79 }
  80
  81 impl StringPart {
  82     pub fn content(&self) -> &str {
  83         match self {
  84             &StringPart::Normal(ref s) | &StringPart::Highlighted(ref s) => s,
  85         }
  86     }
  87 }
  88
  89 impl Diagnostic {
  90     pub fn new(level: Level, message: &str) -> Self {
  91         Diagnostic::new_with_code(level, None, message)
  92     }
  93
  94     pub fn new_with_code(level: Level, code: Option<DiagnosticId>, message: &str) -> Self {
  95         Diagnostic {
  96             level,
  97             message: vec![(message.to_owned(), Style::NoStyle)],
  98             code,
  99             span: MultiSpan::new(),
 100             children: vec![],
 101             suggestions: vec![],
 102             sort_span: DUMMY_SP,
 103         }
 104     }
 105
 106     pub fn is_error(&self) -> bool {
 107         match self.level {
 108             Level::Bug | Level::Fatal | Level::Error | Level::FailureNote => true,
 109
 110             Level::Warning | Level::Note | Level::Help | Level::Cancelled => false,
 111         }
 112     }
 113
 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;
 118     }
 119
 120     pub fn cancelled(&self) -> bool {
 121         self.level == Level::Cancelled
 122     }
 123
 124     /// Set the sorting span.
 125     pub fn set_sort_span(&mut self, sp: Span) {
 126         self.sort_span = sp;
 127     }
 128
 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.
 132     ///
 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());
 140         self
 141     }
 142
 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);
 149             }
 150         }
 151         self
 152     }
 153
 154     pub fn note_expected_found(
 155         &mut self,
 156         expected_label: &dyn fmt::Display,
 157         expected: DiagnosticStyledString,
 158         found_label: &dyn fmt::Display,
 159         found: DiagnosticStyledString,
 160     ) -> &mut Self {
 161         self.note_expected_found_extra(expected_label, expected, found_label, found, &"", &"")
 162     }
 163
 164     pub fn note_unsuccessfull_coercion(
 165         &mut self,
 166         expected: DiagnosticStyledString,
 167         found: DiagnosticStyledString,
 168     ) -> &mut Self {
 169         let mut msg: Vec<_> =
 170             vec![("required when trying to coerce from type `".to_string(), 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),
 174         }));
 175         msg.push(("` to type '".to_string(), 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),
 179         }));
 180         msg.push(("`".to_string(), Style::NoStyle));
 181
 182         // For now, just attach these as notes
 183         self.highlighted_note(msg);
 184         self
 185     }
 186
 187     pub fn note_expected_found_extra(
 188         &mut self,
 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,
 195     ) -> &mut Self {
 196         let expected_label = expected_label.to_string();
 197         let expected_label = if expected_label.is_empty() {
 198             "expected".to_string()
 199         } else {
 200             format!("expected {}", expected_label)
 201         };
 202         let found_label = found_label.to_string();
 203         let found_label = if found_label.is_empty() {
 204             "found".to_string()
 205         } else {
 206             format!("found {}", found_label)
 207         };
 208         let (found_padding, expected_padding) = if expected_label.len() > found_label.len() {
 209             (expected_label.len() - found_label.len(), 0)
 210         } else {
 211             (0, found_label.len() - expected_label.len())
 212         };
 213         let mut msg: Vec<_> =
 214             vec![(format!("{}{} `", " ".repeat(expected_padding), expected_label), Style::NoStyle)];
 215         msg.extend(expected.0.iter().map(|x| match *x {
 216             StringPart::Normal(ref s) => (s.to_owned(), Style::NoStyle),
 217             StringPart::Highlighted(ref s) => (s.to_owned(), Style::Highlight),
 218         }));
 219         msg.push((format!("`{}\n", expected_extra), Style::NoStyle));
 220         msg.push((format!("{}{} `", " ".repeat(found_padding), found_label), Style::NoStyle));
 221         msg.extend(found.0.iter().map(|x| match *x {
 222             StringPart::Normal(ref s) => (s.to_owned(), Style::NoStyle),
 223             StringPart::Highlighted(ref s) => (s.to_owned(), Style::Highlight),
 224         }));
 225         msg.push((format!("`{}", found_extra), Style::NoStyle));
 226
 227         // For now, just attach these as notes.
 228         self.highlighted_note(msg);
 229         self
 230     }
 231
 232     pub fn note_trait_signature(&mut self, name: String, signature: String) -> &mut Self {
 233         self.highlighted_note(vec![
 234             (format!("`{}` from trait: `", name), Style::NoStyle),
 235             (signature, Style::Highlight),
 236             ("`".to_string(), Style::NoStyle),
 237         ]);
 238         self
 239     }
 240
 241     pub fn note(&mut self, msg: &str) -> &mut Self {
 242         self.sub(Level::Note, msg, MultiSpan::new(), None);
 243         self
 244     }
 245
 246     pub fn highlighted_note(&mut self, msg: Vec<(String, Style)>) -> &mut Self {
 247         self.sub_with_highlights(Level::Note, msg, MultiSpan::new(), None);
 248         self
 249     }
 250
 251     /// Prints the span with a note above it.
 252     pub fn span_note<S: Into<MultiSpan>>(&mut self, sp: S, msg: &str) -> &mut Self {
 253         self.sub(Level::Note, msg, sp.into(), None);
 254         self
 255     }
 256
 257     pub fn warn(&mut self, msg: &str) -> &mut Self {
 258         self.sub(Level::Warning, msg, MultiSpan::new(), None);
 259         self
 260     }
 261
 262     /// Prints the span with a warn above it.
 263     pub fn span_warn<S: Into<MultiSpan>>(&mut self, sp: S, msg: &str) -> &mut Self {
 264         self.sub(Level::Warning, msg, sp.into(), None);
 265         self
 266     }
 267
 268     pub fn help(&mut self, msg: &str) -> &mut Self {
 269         self.sub(Level::Help, msg, MultiSpan::new(), None);
 270         self
 271     }
 272
 273     /// Prints the span with some help above it.
 274     pub fn span_help<S: Into<MultiSpan>>(&mut self, sp: S, msg: &str) -> &mut Self {
 275         self.sub(Level::Help, msg, sp.into(), None);
 276         self
 277     }
 278
 279     pub fn multipart_suggestion(
 280         &mut self,
 281         msg: &str,
 282         suggestion: Vec<(Span, String)>,
 283         applicability: Applicability,
 284     ) -> &mut Self {
 285         self.suggestions.push(CodeSuggestion {
 286             substitutions: vec![Substitution {
 287                 parts: suggestion
 288                     .into_iter()
 289                     .map(|(span, snippet)| SubstitutionPart { snippet, span })
 290                     .collect(),
 291             }],
 292             msg: msg.to_owned(),
 293             style: SuggestionStyle::ShowCode,
 294             applicability,
 295         });
 296         self
 297     }
 298
 299     /// Prints out a message with for a multipart suggestion without showing the suggested code.
 300     ///
 301     /// This is intended to be used for suggestions that are obvious in what the changes need to
 302     /// be from the message, showing the span label inline would be visually unpleasant
 303     /// (marginally overlapping spans or multiline spans) and showing the snippet window wouldn't
 304     /// improve understandability.
 305     pub fn tool_only_multipart_suggestion(
 306         &mut self,
 307         msg: &str,
 308         suggestion: Vec<(Span, String)>,
 309         applicability: Applicability,
 310     ) -> &mut Self {
 311         self.suggestions.push(CodeSuggestion {
 312             substitutions: vec![Substitution {
 313                 parts: suggestion
 314                     .into_iter()
 315                     .map(|(span, snippet)| SubstitutionPart { snippet, span })
 316                     .collect(),
 317             }],
 318             msg: msg.to_owned(),
 319             style: SuggestionStyle::CompletelyHidden,
 320             applicability,
 321         });
 322         self
 323     }
 324
 325     /// Prints out a message with a suggested edit of the code.
 326     ///
 327     /// In case of short messages and a simple suggestion, rustc displays it as a label:
 328     ///
 329     /// ```text
 330     /// try adding parentheses: `(tup.0).1`
 331     /// ```
 332     ///
 333     /// The message
 334     ///
 335     /// * should not end in any punctuation (a `:` is added automatically)
 336     /// * should not be a question (avoid language like "did you mean")
 337     /// * should not contain any phrases like "the following", "as shown", etc.
 338     /// * may look like "to do xyz, use" or "to do xyz, use abc"
 339     /// * may contain a name of a function, variable, or type, but not whole expressions
 340     ///
 341     /// See `CodeSuggestion` for more information.
 342     pub fn span_suggestion(
 343         &mut self,
 344         sp: Span,
 345         msg: &str,
 346         suggestion: String,
 347         applicability: Applicability,
 348     ) -> &mut Self {
 349         self.span_suggestion_with_style(
 350             sp,
 351             msg,
 352             suggestion,
 353             applicability,
 354             SuggestionStyle::ShowCode,
 355         );
 356         self
 357     }
 358
 359     pub fn span_suggestion_with_style(
 360         &mut self,
 361         sp: Span,
 362         msg: &str,
 363         suggestion: String,
 364         applicability: Applicability,
 365         style: SuggestionStyle,
 366     ) -> &mut Self {
 367         self.suggestions.push(CodeSuggestion {
 368             substitutions: vec![Substitution {
 369                 parts: vec![SubstitutionPart { snippet: suggestion, span: sp }],
 370             }],
 371             msg: msg.to_owned(),
 372             style,
 373             applicability,
 374         });
 375         self
 376     }
 377
 378     pub fn span_suggestion_verbose(
 379         &mut self,
 380         sp: Span,
 381         msg: &str,
 382         suggestion: String,
 383         applicability: Applicability,
 384     ) -> &mut Self {
 385         self.span_suggestion_with_style(
 386             sp,
 387             msg,
 388             suggestion,
 389             applicability,
 390             SuggestionStyle::ShowAlways,
 391         );
 392         self
 393     }
 394
 395     /// Prints out a message with multiple suggested edits of the code.
 396     pub fn span_suggestions(
 397         &mut self,
 398         sp: Span,
 399         msg: &str,
 400         suggestions: impl Iterator<Item = String>,
 401         applicability: Applicability,
 402     ) -> &mut Self {
 403         self.suggestions.push(CodeSuggestion {
 404             substitutions: suggestions
 405                 .map(|snippet| Substitution { parts: vec![SubstitutionPart { snippet, span: sp }] })
 406                 .collect(),
 407             msg: msg.to_owned(),
 408             style: SuggestionStyle::ShowCode,
 409             applicability,
 410         });
 411         self
 412     }
 413
 414     /// Prints out a message with a suggested edit of the code. If the suggestion is presented
 415     /// inline, it will only show the message and not the suggestion.
 416     ///
 417     /// See `CodeSuggestion` for more information.
 418     pub fn span_suggestion_short(
 419         &mut self,
 420         sp: Span,
 421         msg: &str,
 422         suggestion: String,
 423         applicability: Applicability,
 424     ) -> &mut Self {
 425         self.span_suggestion_with_style(
 426             sp,
 427             msg,
 428             suggestion,
 429             applicability,
 430             SuggestionStyle::HideCodeInline,
 431         );
 432         self
 433     }
 434
 435     /// Prints out a message with for a suggestion without showing the suggested code.
 436     ///
 437     /// This is intended to be used for suggestions that are obvious in what the changes need to
 438     /// be from the message, showing the span label inline would be visually unpleasant
 439     /// (marginally overlapping spans or multiline spans) and showing the snippet window wouldn't
 440     /// improve understandability.
 441     pub fn span_suggestion_hidden(
 442         &mut self,
 443         sp: Span,
 444         msg: &str,
 445         suggestion: String,
 446         applicability: Applicability,
 447     ) -> &mut Self {
 448         self.span_suggestion_with_style(
 449             sp,
 450             msg,
 451             suggestion,
 452             applicability,
 453             SuggestionStyle::HideCodeAlways,
 454         );
 455         self
 456     }
 457
 458     /// Adds a suggestion to the json output, but otherwise remains silent/undisplayed in the cli.
 459     ///
 460     /// This is intended to be used for suggestions that are *very* obvious in what the changes
 461     /// need to be from the message, but we still want other tools to be able to apply them.
 462     pub fn tool_only_span_suggestion(
 463         &mut self,
 464         sp: Span,
 465         msg: &str,
 466         suggestion: String,
 467         applicability: Applicability,
 468     ) -> &mut Self {
 469         self.span_suggestion_with_style(
 470             sp,
 471             msg,
 472             suggestion,
 473             applicability,
 474             SuggestionStyle::CompletelyHidden,
 475         );
 476         self
 477     }
 478
 479     pub fn set_span<S: Into<MultiSpan>>(&mut self, sp: S) -> &mut Self {
 480         self.span = sp.into();
 481         if let Some(span) = self.span.primary_span() {
 482             self.sort_span = span;
 483         }
 484         self
 485     }
 486
 487     pub fn code(&mut self, s: DiagnosticId) -> &mut Self {
 488         self.code = Some(s);
 489         self
 490     }
 491
 492     pub fn clear_code(&mut self) -> &mut Self {
 493         self.code = None;
 494         self
 495     }
 496
 497     pub fn get_code(&self) -> Option<DiagnosticId> {
 498         self.code.clone()
 499     }
 500
 501     pub fn set_primary_message<M: Into<String>>(&mut self, msg: M) -> &mut Self {
 502         self.message[0] = (msg.into(), Style::NoStyle);
 503         self
 504     }
 505
 506     pub fn message(&self) -> String {
 507         self.message.iter().map(|i| i.0.as_str()).collect::<String>()
 508     }
 509
 510     pub fn styled_message(&self) -> &Vec<(String, Style)> {
 511         &self.message
 512     }
 513
 514     /// Used by a lint. Copies over all details *but* the "main
 515     /// message".
 516     pub fn copy_details_not_message(&mut self, from: &Diagnostic) {
 517         self.span = from.span.clone();
 518         self.code = from.code.clone();
 519         self.children.extend(from.children.iter().cloned())
 520     }
 521
 522     /// Convenience function for internal use, clients should use one of the
 523     /// public methods above.
 524     pub fn sub(
 525         &mut self,
 526         level: Level,
 527         message: &str,
 528         span: MultiSpan,
 529         render_span: Option<MultiSpan>,
 530     ) {
 531         let sub = SubDiagnostic {
 532             level,
 533             message: vec![(message.to_owned(), Style::NoStyle)],
 534             span,
 535             render_span,
 536         };
 537         self.children.push(sub);
 538     }
 539
 540     /// Convenience function for internal use, clients should use one of the
 541     /// public methods above.
 542     fn sub_with_highlights(
 543         &mut self,
 544         level: Level,
 545         message: Vec<(String, Style)>,
 546         span: MultiSpan,
 547         render_span: Option<MultiSpan>,
 548     ) {
 549         let sub = SubDiagnostic { level, message, span, render_span };
 550         self.children.push(sub);
 551     }
 552 }
 553
 554 impl SubDiagnostic {
 555     pub fn message(&self) -> String {
 556         self.message.iter().map(|i| i.0.as_str()).collect::<String>()
 557     }
 558
 559     pub fn styled_message(&self) -> &Vec<(String, Style)> {
 560         &self.message
 561     }
 562 }