src/libproc_macro/diagnostic.rs

   1 // Copyright 2017 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use Span;
  12
  13 use rustc_errors as errors;
  14
  15 /// An enum representing a diagnostic level.
  16 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  17 #[derive(Copy, Clone, Debug)]
  18 #[non_exhaustive]
  19 pub enum Level {
  20     /// An error.
  21     Error,
  22     /// A warning.
  23     Warning,
  24     /// A note.
  25     Note,
  26     /// A help message.
  27     Help,
  28 }
  29
  30 /// Trait implemented by types that can be converted into a set of `Span`s.
  31 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  32 pub trait MultiSpan {
  33     /// Converts `self` into a `Vec<Span>`.
  34     fn into_spans(self) -> Vec<Span>;
  35 }
  36
  37 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  38 impl MultiSpan for Span {
  39     fn into_spans(self) -> Vec<Span> {
  40         vec![self]
  41     }
  42 }
  43
  44 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  45 impl MultiSpan for Vec<Span> {
  46     fn into_spans(self) -> Vec<Span> {
  47         self
  48     }
  49 }
  50
  51 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  52 impl<'a> MultiSpan for &'a [Span] {
  53     fn into_spans(self) -> Vec<Span> {
  54         self.to_vec()
  55     }
  56 }
  57
  58 /// A structure representing a diagnostic message and associated children
  59 /// messages.
  60 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  61 #[derive(Clone, Debug)]
  62 pub struct Diagnostic {
  63     level: Level,
  64     message: String,
  65     spans: Vec<Span>,
  66     children: Vec<Diagnostic>
  67 }
  68
  69 macro_rules! diagnostic_child_methods {
  70     ($spanned:ident, $regular:ident, $level:expr) => (
  71         /// Add a new child diagnostic message to `self` with the level
  72         /// identified by this method's name with the given `spans` and
  73         /// `message`.
  74         #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  75         pub fn $spanned<S, T>(mut self, spans: S, message: T) -> Diagnostic
  76             where S: MultiSpan, T: Into<String>
  77         {
  78             self.children.push(Diagnostic::spanned(spans, $level, message));
  79             self
  80         }
  81
  82         /// Add a new child diagnostic message to `self` with the level
  83         /// identified by this method's name with the given `message`.
  84         #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  85         pub fn $regular<T: Into<String>>(mut self, message: T) -> Diagnostic {
  86             self.children.push(Diagnostic::new($level, message));
  87             self
  88         }
  89     )
  90 }
  91
  92 /// Iterator over the children diagnostics of a `Diagnostic`.
  93 #[derive(Debug, Clone)]
  94 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  95 pub struct Children<'a>(::std::slice::Iter<'a, Diagnostic>);
  96
  97 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
  98 impl<'a> Iterator for Children<'a> {
  99     type Item = &'a Diagnostic;
 100
 101     fn next(&mut self) -> Option<Self::Item> {
 102         self.0.next()
 103     }
 104 }
 105
 106 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 107 impl Diagnostic {
 108     /// Create a new diagnostic with the given `level` and `message`.
 109     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 110     pub fn new<T: Into<String>>(level: Level, message: T) -> Diagnostic {
 111         Diagnostic {
 112             level: level,
 113             message: message.into(),
 114             spans: vec![],
 115             children: vec![]
 116         }
 117     }
 118
 119     /// Create a new diagnostic with the given `level` and `message` pointing to
 120     /// the given set of `spans`.
 121     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 122     pub fn spanned<S, T>(spans: S, level: Level, message: T) -> Diagnostic
 123         where S: MultiSpan, T: Into<String>
 124     {
 125         Diagnostic {
 126             level: level,
 127             message: message.into(),
 128             spans: spans.into_spans(),
 129             children: vec![]
 130         }
 131     }
 132
 133     diagnostic_child_methods!(span_error, error, Level::Error);
 134     diagnostic_child_methods!(span_warning, warning, Level::Warning);
 135     diagnostic_child_methods!(span_note, note, Level::Note);
 136     diagnostic_child_methods!(span_help, help, Level::Help);
 137
 138     /// Returns the diagnostic `level` for `self`.
 139     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 140     pub fn level(&self) -> Level {
 141         self.level
 142     }
 143
 144     /// Sets the level in `self` to `level`.
 145     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 146     pub fn set_level(&mut self, level: Level) {
 147         self.level = level;
 148     }
 149
 150     /// Returns the message in `self`.
 151     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 152     pub fn message(&self) -> &str {
 153         &self.message
 154     }
 155
 156     /// Sets the message in `self` to `message`.
 157     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 158     pub fn set_message<T: Into<String>>(&mut self, message: T) {
 159         self.message = message.into();
 160     }
 161
 162     /// Returns the `Span`s in `self`.
 163     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 164     pub fn spans(&self) -> &[Span] {
 165         &self.spans
 166     }
 167
 168     /// Sets the `Span`s in `self` to `spans`.
 169     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 170     pub fn set_spans<S: MultiSpan>(&mut self, spans: S) {
 171         self.spans = spans.into_spans();
 172     }
 173
 174     /// Returns an iterator over the children diagnostics of `self`.
 175     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 176     pub fn children(&self) -> Children {
 177         Children(self.children.iter())
 178     }
 179
 180     /// Emit the diagnostic.
 181     #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
 182     pub fn emit(self) {
 183         fn to_internal(spans: Vec<Span>) -> ::syntax_pos::MultiSpan {
 184             let spans: Vec<_> = spans.into_iter().map(|s| s.0).collect();
 185             ::syntax_pos::MultiSpan::from_spans(spans)
 186         }
 187
 188         let level = self.level.to_internal();
 189         let mut diag = errors::Diagnostic::new(level, &*self.message);
 190         diag.set_span(to_internal(self.spans));
 191
 192         for child in self.children {
 193             let level = child.level.to_internal();
 194             diag.sub(level, &*child.message, to_internal(child.spans), None);
 195         }
 196
 197         ::__internal::with_sess(move |sess, _| {
 198             errors::DiagnosticBuilder::new_diagnostic(&sess.span_diagnostic, diag).emit();
 199         });
 200     }
 201 }