src/libproc_macro/diagnostic.rs

   1 use crate::Span;
   2
   3 /// An enum representing a diagnostic level.
   4 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
   5 #[derive(Copy, Clone, Debug)]
   6 #[non_exhaustive]
   7 pub enum Level {
   8     /// An error.
   9     Error,
  10     /// A warning.
  11     Warning,
  12     /// A note.
  13     Note,
  14     /// A help message.
  15     Help,
  16 }
  17
  18 /// Trait implemented by types that can be converted into a set of `Span`s.
  19 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  20 pub trait MultiSpan {
  21     /// Converts `self` into a `Vec<Span>`.
  22     fn into_spans(self) -> Vec<Span>;
  23 }
  24
  25 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  26 impl MultiSpan for Span {
  27     fn into_spans(self) -> Vec<Span> {
  28         vec![self]
  29     }
  30 }
  31
  32 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  33 impl MultiSpan for Vec<Span> {
  34     fn into_spans(self) -> Vec<Span> {
  35         self
  36     }
  37 }
  38
  39 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  40 impl<'a> MultiSpan for &'a [Span] {
  41     fn into_spans(self) -> Vec<Span> {
  42         self.to_vec()
  43     }
  44 }
  45
  46 /// A structure representing a diagnostic message and associated children
  47 /// messages.
  48 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  49 #[derive(Clone, Debug)]
  50 pub struct Diagnostic {
  51     level: Level,
  52     message: String,
  53     spans: Vec<Span>,
  54     children: Vec<Diagnostic>
  55 }
  56
  57 macro_rules! diagnostic_child_methods {
  58     ($spanned:ident, $regular:ident, $level:expr) => (
  59         /// Adds a new child diagnostic message to `self` with the level
  60         /// identified by this method's name with the given `spans` and
  61         /// `message`.
  62         #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  63         pub fn $spanned<S, T>(mut self, spans: S, message: T) -> Diagnostic
  64             where S: MultiSpan, T: Into<String>
  65         {
  66             self.children.push(Diagnostic::spanned(spans, $level, message));
  67             self
  68         }
  69
  70         /// Adds a new child diagnostic message to `self` with the level
  71         /// identified by this method's name with the given `message`.
  72         #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  73         pub fn $regular<T: Into<String>>(mut self, message: T) -> Diagnostic {
  74             self.children.push(Diagnostic::new($level, message));
  75             self
  76         }
  77     )
  78 }
  79
  80 /// Iterator over the children diagnostics of a `Diagnostic`.
  81 #[derive(Debug, Clone)]
  82 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  83 pub struct Children<'a>(std::slice::Iter<'a, Diagnostic>);
  84
  85 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  86 impl<'a> Iterator for Children<'a> {
  87     type Item = &'a Diagnostic;
  88
  89     fn next(&mut self) -> Option<Self::Item> {
  90         self.0.next()
  91     }
  92 }
  93
  94 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  95 impl Diagnostic {
  96     /// Creates a new diagnostic with the given `level` and `message`.
  97     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  98     pub fn new<T: Into<String>>(level: Level, message: T) -> Diagnostic {
  99         Diagnostic {
 100             level: level,
 101             message: message.into(),
 102             spans: vec![],
 103             children: vec![]
 104         }
 105     }
 106
 107     /// Creates a new diagnostic with the given `level` and `message` pointing to
 108     /// the given set of `spans`.
 109     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 110     pub fn spanned<S, T>(spans: S, level: Level, message: T) -> Diagnostic
 111         where S: MultiSpan, T: Into<String>
 112     {
 113         Diagnostic {
 114             level: level,
 115             message: message.into(),
 116             spans: spans.into_spans(),
 117             children: vec![]
 118         }
 119     }
 120
 121     diagnostic_child_methods!(span_error, error, Level::Error);
 122     diagnostic_child_methods!(span_warning, warning, Level::Warning);
 123     diagnostic_child_methods!(span_note, note, Level::Note);
 124     diagnostic_child_methods!(span_help, help, Level::Help);
 125
 126     /// Returns the diagnostic `level` for `self`.
 127     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 128     pub fn level(&self) -> Level {
 129         self.level
 130     }
 131
 132     /// Sets the level in `self` to `level`.
 133     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 134     pub fn set_level(&mut self, level: Level) {
 135         self.level = level;
 136     }
 137
 138     /// Returns the message in `self`.
 139     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 140     pub fn message(&self) -> &str {
 141         &self.message
 142     }
 143
 144     /// Sets the message in `self` to `message`.
 145     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 146     pub fn set_message<T: Into<String>>(&mut self, message: T) {
 147         self.message = message.into();
 148     }
 149
 150     /// Returns the `Span`s in `self`.
 151     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 152     pub fn spans(&self) -> &[Span] {
 153         &self.spans
 154     }
 155
 156     /// Sets the `Span`s in `self` to `spans`.
 157     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 158     pub fn set_spans<S: MultiSpan>(&mut self, spans: S) {
 159         self.spans = spans.into_spans();
 160     }
 161
 162     /// Returns an iterator over the children diagnostics of `self`.
 163     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 164     pub fn children(&self) -> Children<'_> {
 165         Children(self.children.iter())
 166     }
 167
 168     /// Emit the diagnostic.
 169     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 170     pub fn emit(self) {
 171         fn to_internal(spans: Vec<Span>) -> crate::bridge::client::MultiSpan {
 172             let mut multi_span = crate::bridge::client::MultiSpan::new();
 173             for span in spans {
 174                 multi_span.push(span.0);
 175             }
 176             multi_span
 177         }
 178
 179         let mut diag = crate::bridge::client::Diagnostic::new(
 180             self.level,
 181             &self.message[..],
 182             to_internal(self.spans),
 183         );
 184         for c in self.children {
 185             diag.sub(c.level, &c.message[..], to_internal(c.spans));
 186         }
 187         diag.emit();
 188     }
 189 }