feat: Add custom Levels

Muscraft · Muscraft · commit 6974a3232ecf · 2025-04-16T10:19:02.000-06:00
diff --git a/benches/bench.rs b/benches/bench.rs
@@ -1,4 +1,4 @@
-use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};
+use annotate_snippets::{level::Level, AnnotationKind, Group, Renderer, Snippet};
 
 #[divan::bench]
 fn simple() -> String {
@@ -24,7 +24,7 @@ fn simple() -> String {
             _ => continue,
         }
     }"#;
-    let message = Level::Error.message("mismatched types").id("E0308").group(
+    let message = Level::ERROR.message("mismatched types").id("E0308").group(
         Group::new().element(
             Snippet::source(source)
                 .line_start(51)
@@ -69,7 +69,7 @@ fn fold(bencher: divan::Bencher<'_, '_>, context: usize) {
             (input, span)
         })
         .bench_values(|(input, span)| {
-            let message = Level::Error.message("mismatched types").id("E0308").group(
+            let message = Level::ERROR.message("mismatched types").id("E0308").group(
                 Group::new().element(
                     Snippet::source(&input)
                         .fold(true)
diff --git a/examples/custom_error.rs b/examples/custom_error.rs
@@ -1,5 +1,5 @@
 use annotate_snippets::renderer::OutputTheme;
-use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};
+use annotate_snippets::{level::Level, AnnotationKind, Group, Renderer, Snippet};
 
 fn main() {
     let source = r#"//@ compile-flags: -Ztreat-err-as-bug
@@ -15,8 +15,10 @@ fn main() {
 pub static C: u32 = 0 - 1;
 //~^ ERROR could not evaluate static initializer
 "#;
-    let message = Level::None
-        .message("error: internal compiler error[E0080]: could not evaluate static initializer")
+    let message = Level::ERROR
+        .text(Some("error: internal compiler error"))
+        .message("could not evaluate static initializer")
+        .id("E0080")
         .group(
             Group::new().element(
                 Snippet::source(source)
diff --git a/examples/custom_error.svg b/examples/custom_error.svg
@@ -3,6 +3,7 @@
     .fg { fill: #AAAAAA }
     .bg { background: #000000 }
     .fg-bright-blue { fill: #5555FF }
+    .fg-bright-red { fill: #FF5555 }
     .container {
       padding: 0 10px;
       line-height: 18px;
@@ -18,15 +19,15 @@
   <rect width="100%" height="100%" y="0" rx="4.5" class="bg" />
 
   <text xml:space="preserve" class="container fg">
-    <tspan x="10px" y="28px"><tspan class="bold">error: internal compiler error[E0080]: could not evaluate static initializer</tspan>
+    <tspan x="10px" y="28px"><tspan class="fg-bright-red bold">error: internal compiler error[E0080]</tspan><tspan class="bold">: could not evaluate static initializer</tspan>
 </tspan>
     <tspan x="10px" y="46px"><tspan>  </tspan><tspan class="fg-bright-blue bold"> ╭▸ </tspan><tspan>$DIR/err.rs:11:21</tspan>
 </tspan>
     <tspan x="10px" y="64px"><tspan>   </tspan><tspan class="fg-bright-blue bold">│</tspan>
 </tspan>
     <tspan x="10px" y="82px"><tspan class="fg-bright-blue bold">11</tspan><tspan> </tspan><tspan class="fg-bright-blue bold">│</tspan><tspan> pub static C: u32 = 0 - 1;</tspan>
 </tspan>
-    <tspan x="10px" y="100px"><tspan>   </tspan><tspan class="fg-bright-blue bold">╰╴</tspan><tspan>                    ━━━━━ attempt to compute `0_u32 - 1_u32`, which would overflow</tspan>
+    <tspan x="10px" y="100px"><tspan>   </tspan><tspan class="fg-bright-blue bold">╰╴</tspan><tspan>                    </tspan><tspan class="fg-bright-red bold">━━━━━</tspan><tspan> </tspan><tspan class="fg-bright-red bold">attempt to compute `0_u32 - 1_u32`, which would overflow</tspan>
 </tspan>
     <tspan x="10px" y="118px">
 </tspan>
diff --git a/examples/custom_level.rs b/examples/custom_level.rs
@@ -1,5 +1,5 @@
 use annotate_snippets::renderer::OutputTheme;
-use annotate_snippets::{AnnotationKind, Group, Level, Patch, Renderer, Snippet};
+use annotate_snippets::{level::Level, AnnotationKind, Group, Patch, Renderer, Snippet};
 
 fn main() {
     let source = r#"// Regression test for issue #114529
@@ -29,7 +29,7 @@ fn main() {
     }
 }
 "#;
-    let message = Level::Error
+    let message = Level::ERROR
         .message("`break` with value from a `while` loop")
         .id("E0571")
         .group(
@@ -52,9 +52,11 @@ fn main() {
         )
         .group(
             Group::new()
-                .element(Level::None.title(
-                    "suggestion: use `break` on its own without a value inside this `while` loop",
-                ))
+                .element(
+                    Level::HELP
+                        .text(Some("suggestion"))
+                        .title("use `break` on its own without a value inside this `while` loop"),
+                )
                 .element(
                     Snippet::source(source)
                         .line_start(1)
diff --git a/examples/custom_level.svg b/examples/custom_level.svg
@@ -3,6 +3,7 @@
     .fg { fill: #AAAAAA }
     .bg { background: #000000 }
     .fg-bright-blue { fill: #5555FF }
+    .fg-bright-cyan { fill: #55FFFF }
     .fg-bright-green { fill: #55FF55 }
     .fg-bright-red { fill: #FF5555 }
     .container {
@@ -40,7 +41,7 @@
 </tspan>
     <tspan x="10px" y="190px"><tspan>   </tspan><tspan class="fg-bright-blue bold">╰╴</tspan>
 </tspan>
-    <tspan x="10px" y="208px"><tspan class="bold">suggestion: use `break` on its own without a value inside this `while` loop</tspan>
+    <tspan x="10px" y="208px"><tspan class="fg-bright-cyan bold">suggestion</tspan><tspan class="bold">: use `break` on its own without a value inside this `while` loop</tspan>
 </tspan>
     <tspan x="10px" y="226px"><tspan>   </tspan><tspan class="fg-bright-blue bold">╭╴</tspan>
 </tspan>
diff --git a/examples/expected_type.rs b/examples/expected_type.rs
@@ -1,12 +1,12 @@
-use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};
+use annotate_snippets::{level::Level, AnnotationKind, Group, Renderer, Snippet};
 
 fn main() {
     let source = r#"                annotations: vec![SourceAnnotation {
                 label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
                     ,
                 range: <22, 25>,"#;
     let message =
-        Level::Error.message("expected type, found `22`").group(
+        Level::ERROR.message("expected type, found `22`").group(
             Group::new().element(
                 Snippet::source(source)
                     .line_start(26)
diff --git a/examples/footer.rs b/examples/footer.rs
@@ -1,7 +1,7 @@
-use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};
+use annotate_snippets::{level::Level, AnnotationKind, Group, Renderer, Snippet};
 
 fn main() {
-    let message = Level::Error
+    let message = Level::ERROR
         .message("mismatched types")
         .id("E0308")
         .group(
@@ -14,7 +14,7 @@ fn main() {
                     )),
             ),
         )
-        .group(Group::new().element(Level::Note.title(
+        .group(Group::new().element(Level::NOTE.title(
             "expected type: `snippet::Annotation`\n   found type: `__&__snippet::Annotation`",
         )));
 
diff --git a/examples/format.rs b/examples/format.rs
@@ -1,4 +1,4 @@
-use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};
+use annotate_snippets::{level::Level, AnnotationKind, Group, Renderer, Snippet};
 
 fn main() {
     let source = r#") -> Option<String> {
@@ -23,7 +23,7 @@ fn main() {
             _ => continue,
         }
     }"#;
-    let message = Level::Error.message("mismatched types").id("E0308").group(
+    let message = Level::ERROR.message("mismatched types").id("E0308").group(
         Group::new().element(
             Snippet::source(source)
                 .line_start(51)
diff --git a/examples/highlight_source.rs b/examples/highlight_source.rs
@@ -1,4 +1,4 @@
-use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};
+use annotate_snippets::{level::Level, AnnotationKind, Group, Renderer, Snippet};
 
 fn main() {
     let source = r#"//@ compile-flags: -Z teach
@@ -9,7 +9,7 @@ const CON: Vec<i32> = vec![1, 2, 3]; //~ ERROR E0010
 //~| ERROR cannot call non-const method
 fn main() {}
 "#;
-    let message = Level::Error
+    let message = Level::ERROR
         .message("allocations are not allowed in constants")
         .id("E0010")
         .group(
@@ -26,7 +26,7 @@ fn main() {}
                         ),
                 )
                 .element(
-                    Level::Note.title("The runtime heap is not yet available at compile-time, so no runtime heap allocations can be created."),
+                    Level::NOTE.title("The runtime heap is not yet available at compile-time, so no runtime heap allocations can be created."),
                 ),
         );
 
diff --git a/examples/highlight_title.rs b/examples/highlight_title.rs
@@ -1,4 +1,4 @@
-use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};
+use annotate_snippets::{level::Level, AnnotationKind, Group, Renderer, Snippet};
 use anstyle::Effects;
 
 fn main() {
@@ -43,7 +43,7 @@ fn main() {
         magenta.render_reset()
     );
 
-    let message = Level::Error.message("mismatched types").id("E0308").group(
+    let message = Level::ERROR.message("mismatched types").id("E0308").group(
         Group::new()
             .element(
                 Snippet::source(source)
@@ -60,7 +60,7 @@ fn main() {
                             .label("arguments to this function are incorrect"),
                     ),
             )
-            .element(Level::Note.title(&title)),
+            .element(Level::NOTE.title(&title)),
     );
 
     let renderer = Renderer::styled().anonymized_line_numbers(true);
diff --git a/examples/multislice.rs b/examples/multislice.rs
@@ -1,7 +1,7 @@
-use annotate_snippets::{Annotation, Group, Level, Renderer, Snippet};
+use annotate_snippets::{level::Level, Annotation, Group, Renderer, Snippet};
 
 fn main() {
-    let message = Level::Error.message("mismatched types").group(
+    let message = Level::ERROR.message("mismatched types").group(
         Group::new()
             .element(
                 Snippet::<Annotation<'_>>::source("Foo")
diff --git a/src/level.rs b/src/level.rs
@@ -0,0 +1,128 @@
+use crate::renderer::stylesheet::Stylesheet;
+use crate::snippet::{ERROR_TXT, HELP_TXT, INFO_TXT, NOTE_TXT, WARNING_TXT};
+use crate::{Element, Group, Message, Title};
+use anstyle::Style;
+
+pub const ERROR: Level<'_> = Level {
+    name: None,
+    level: LevelInner::Error,
+};
+
+pub const WARNING: Level<'_> = Level {
+    name: None,
+    level: LevelInner::Warning,
+};
+
+pub const INFO: Level<'_> = Level {
+    name: None,
+    level: LevelInner::Info,
+};
+
+pub const NOTE: Level<'_> = Level {
+    name: None,
+    level: LevelInner::Note,
+};
+
+pub const HELP: Level<'_> = Level {
+    name: None,
+    level: LevelInner::Help,
+};
+
+#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
+pub struct Level<'a> {
+    pub(crate) name: Option<Option<&'a str>>,
+    pub(crate) level: LevelInner,
+}
+
+#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
+pub enum Level2<'a> {
+    Builtin(LevelInner),
+    Custom {
+        name: Option<&'a str>,
+        level: LevelInner,
+    },
+    None,
+}
+
+impl<'a> Level<'a> {
+    pub const ERROR: Level<'a> = ERROR;
+    pub const WARNING: Level<'a> = WARNING;
+    pub const INFO: Level<'a> = INFO;
+    pub const NOTE: Level<'a> = NOTE;
+    pub const HELP: Level<'a> = HELP;
+
+    /// Text passed to this function is considered "untrusted input", as such
+    /// all text is passed through a normalization function. Pre-styled text is
+    /// not allowed to be passed to this function.
+    pub fn text(self, text: Option<&'a str>) -> Level<'a> {
+        Level {
+            name: Some(text),
+            level: self.level,
+        }
+    }
+}
+
+impl<'a> Level<'a> {
+    /// Text passed to this function is considered "untrusted input", as such
+    /// all text is passed through a normalization function. Pre-styled text is
+    /// not allowed to be passed to this function.
+    pub fn message(self, title: &'a str) -> Message<'a> {
+        Message {
+            id: None,
+            groups: vec![Group::new().element(Element::Title(Title {
+                level: self,
+                title,
+                primary: true,
+            }))],
+        }
+    }
+
+    /// Text passed to this function is allowed to be pre-styled, as such all
+    /// text is considered "trusted input" and has no normalizations applied to
+    /// it. [`normalize_untrusted_str`](crate::normalize_untrusted_str) can be
+    /// used to normalize untrusted text before it is passed to this function.
+    pub fn title(self, title: &'a str) -> Title<'a> {
+        Title {
+            level: self,
+            title,
+            primary: false,
+        }
+    }
+
+    pub(crate) fn as_str(&self) -> &'a str {
+        match (self.name, self.level) {
+            (Some(Some(name)), _) => name,
+            (Some(None), _) => "",
+            (None, LevelInner::Error) => ERROR_TXT,
+            (None, LevelInner::Warning) => WARNING_TXT,
+            (None, LevelInner::Info) => INFO_TXT,
+            (None, LevelInner::Note) => NOTE_TXT,
+            (None, LevelInner::Help) => HELP_TXT,
+        }
+    }
+
+    pub(crate) fn style(&self, stylesheet: &Stylesheet) -> Style {
+        self.level.style(stylesheet)
+    }
+}
+
+#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
+pub enum LevelInner {
+    Error,
+    Warning,
+    Info,
+    Note,
+    Help,
+}
+
+impl LevelInner {
+    pub(crate) fn style(self, stylesheet: &Stylesheet) -> Style {
+        match self {
+            LevelInner::Error => stylesheet.error,
+            LevelInner::Warning => stylesheet.warning,
+            LevelInner::Info => stylesheet.info,
+            LevelInner::Note => stylesheet.note,
+            LevelInner::Help => stylesheet.help,
+        }
+    }
+}
diff --git a/src/lib.rs b/src/lib.rs
@@ -42,6 +42,7 @@
 #![warn(clippy::print_stdout)]
 #![warn(missing_debug_implementations)]
 
+pub mod level;
 pub mod renderer;
 mod snippet;
 
diff --git a/src/renderer/mod.rs b/src/renderer/mod.rs
diff --git a/src/renderer/styled_buffer.rs b/src/renderer/styled_buffer.rs
diff --git a/src/snippet.rs b/src/snippet.rs
diff --git a/tests/fixtures/deserialize.rs b/tests/fixtures/deserialize.rs
diff --git a/tests/formatter.rs b/tests/formatter.rs
diff --git a/tests/rustc_tests.rs b/tests/rustc_tests.rs
