Rename diagnostic span methods in accordance with their usage patterns

Diagnostic:: * labeled_primary_span -> span * labeled_secondary_span -> label * primary_span -> unlabeled_span * secondary_span -> unlabeled_secondary_span + made private * labeled_primary_spans -> spans * primary_spans -> unlabeled_spans
fmease · Mar 18, 2023 · 2a5d029 · 2a5d029
1 parent acb4aac
commit 2a5d029
Show file tree

Hide file tree

Showing 21 changed files with 215 additions and 216 deletions.
diff --git a/compiler/diagnostics/src/format/test.rs b/compiler/diagnostics/src/format/test.rs
@@ -32,7 +32,7 @@ fn format_single_line_primary_highlight() {
 
     let diagnostic = Diagnostic::error()
         .message("message")
-        .primary_span(span(8, 11));
+        .unlabeled_span(span(8, 11));
 
     assert_format(
         &diagnostic,
@@ -51,7 +51,7 @@ fn format_two_line_primary_highlight() {
     let mut map = SourceMap::default();
     map.add_str(Anonymous, "alpha\nbeta\n");
 
-    let diagnostic = Diagnostic::error().primary_span(span(1, 9));
+    let diagnostic = Diagnostic::error().unlabeled_span(span(1, 9));
 
     assert_format(
         &diagnostic,
@@ -75,7 +75,7 @@ fn format_multi_line_primary_highlight() {
     let diagnostic = Diagnostic::error()
         .code(ErrorCode::E000)
         .message("explanation")
-        .primary_span(span(9, 23));
+        .unlabeled_span(span(9, 23));
 
     assert_format(
         &diagnostic,
@@ -106,7 +106,7 @@ fn format_triple_digit_line_number() {
 
     let diagnostic = Diagnostic::warning()
         .message("this is a sentence")
-        .primary_span(span(124, 133));
+        .unlabeled_span(span(124, 133));
 
     assert_format(
         &diagnostic,
@@ -128,9 +128,9 @@ fn format_primary_secondary_highlights() {
     let diagnostic = Diagnostic::error()
         .code(ErrorCode::E001)
         .message("important")
-        .primary_span(span(7, 11))
-        .secondary_span(span(1, 4))
-        .secondary_span(span(15, 17));
+        .unlabeled_span(span(7, 11))
+        .unlabeled_secondary_span(span(1, 4))
+        .unlabeled_secondary_span(span(15, 17));
 
     assert_format(
         &diagnostic,
@@ -161,8 +161,8 @@ fn format_primary_secondary_highlight_differing_line_number_widths() {
 
     let diagnostic = Diagnostic::bug()
         .message("placeholder")
-        .primary_span(span(3, 7))
-        .secondary_span(span(19, 28));
+        .unlabeled_span(span(3, 7))
+        .unlabeled_secondary_span(span(19, 28));
 
     assert_format(
         &diagnostic,
@@ -188,8 +188,8 @@ fn format_highlights_in_different_files() {
     map.add_str("TWO", "zyx");
 
     let diagnostic = Diagnostic::debug()
-        .primary_span(span(4, 5))
-        .secondary_span(span(11, 13));
+        .unlabeled_span(span(4, 5))
+        .unlabeled_secondary_span(span(11, 13));
 
     assert_format(
         &diagnostic,
@@ -215,8 +215,8 @@ fn format_highlights_same_line() {
 
     let diagnostic = Diagnostic::error()
         .message("tag")
-        .primary_span(span(1, 6))
-        .secondary_span(span(5, 9));
+        .unlabeled_span(span(1, 6))
+        .unlabeled_secondary_span(span(5, 9));
 
     assert_format(
         &diagnostic,
@@ -242,10 +242,10 @@ fn format_labeled_highlights() {
 
     let diagnostic = Diagnostic::error()
         .message("labels")
-        .labeled_primary_span(span(2, 4), "pointer")
-        .labeled_secondary_span(span(7, 11), "content")
-        .labeled_primary_span(span(12, 23), "explanation")
-        .labeled_secondary_span(span(28, 33), "message");
+        .span(span(2, 4), "pointer")
+        .label(span(7, 11), "content")
+        .span(span(12, 23), "explanation")
+        .label(span(28, 33), "message");
 
     assert_format(
         &diagnostic,
@@ -285,10 +285,10 @@ fn format_multi_line_labeled_highlights() {
 
     let diagnostic = Diagnostic::error()
         .message("multi-line labels")
-        .labeled_primary_span(span(2, 4), "pointer\ncontext\nfiller")
-        .labeled_secondary_span(span(7, 11), "content\n  indented")
-        .labeled_primary_span(span(12, 23), "explanation\naddendum")
-        .labeled_secondary_span(span(28, 33), "message\n\nbottom");
+        .span(span(2, 4), "pointer\ncontext\nfiller")
+        .label(span(7, 11), "content\n  indented")
+        .span(span(12, 23), "explanation\naddendum")
+        .label(span(28, 33), "message\n\nbottom");
 
     assert_format(
         &diagnostic,
@@ -334,10 +334,10 @@ fn format_multi_line_labeled_highlights_no_trailing_line_break() {
 
     let diagnostic = Diagnostic::error()
         .message("multi-line labels")
-        .labeled_primary_span(span(2, 4), "pointer\ncontext\nfiller")
-        .labeled_secondary_span(span(7, 11), "content\n  indented")
-        .labeled_primary_span(span(12, 23), "explanation\naddendum")
-        .labeled_secondary_span(span(28, 33), "message\n\nbottom");
+        .span(span(2, 4), "pointer\ncontext\nfiller")
+        .label(span(7, 11), "content\n  indented")
+        .span(span(12, 23), "explanation\naddendum")
+        .label(span(28, 33), "message\n\nbottom");
 
     assert_format(
         &diagnostic,
@@ -403,7 +403,7 @@ fn format_subdiagnostics() {
 
     let diagnostic = Diagnostic::warning()
         .message("it")
-        .primary_span(span(5, 7))
+        .unlabeled_span(span(5, 7))
         .help("helpful")
         .help("less helpful");
 
@@ -429,7 +429,7 @@ fn format_subdiagnostics_two_digit_line_numbers() {
 
     let diagnostic = Diagnostic::warning()
         .message("it")
-        .primary_span(span(104, 106))
+        .unlabeled_span(span(104, 106))
         .help("helpful")
         .help("less helpful");
 
@@ -455,7 +455,7 @@ fn format_multi_line_subdiagnostics() {
 
     let diagnostic = Diagnostic::warning()
         .message("it")
-        .primary_span(span(5, 7))
+        .unlabeled_span(span(5, 7))
         .help("helpful\ntip\nhopefully")
         .help("less helpful\ntip\n");
 
@@ -482,7 +482,7 @@ fn format_multiple_primary_highlights() {
     let mut map = SourceMap::default();
     map.add_str(Anonymous, "gamma\n");
 
-    let diagnostic = Diagnostic::error().primary_spans([span(1, 2), span(3, 4), span(5, 6)]);
+    let diagnostic = Diagnostic::error().unlabeled_spans([span(1, 2), span(3, 4), span(5, 6)]);
 
     assert_format(
         &diagnostic,
@@ -511,7 +511,9 @@ fn format_zero_length_highlight() {
     let mut map = SourceMap::default();
     map.add_str(Anonymous, "sample\n");
 
-    let diagnostic = Diagnostic::debug().message("nil").primary_span(span(3, 3));
+    let diagnostic = Diagnostic::debug()
+        .message("nil")
+        .unlabeled_span(span(3, 3));
 
     assert_format(
         &diagnostic,
@@ -530,7 +532,9 @@ fn format_zero_length_highlight_start_of_line() {
     let mut map = SourceMap::default();
     map.add_str(Anonymous, "sample\n");
 
-    let diagnostic = Diagnostic::debug().message("nil").primary_span(span(1, 1));
+    let diagnostic = Diagnostic::debug()
+        .message("nil")
+        .unlabeled_span(span(1, 1));
 
     assert_format(
         &diagnostic,
@@ -551,7 +555,7 @@ fn format_zero_length_secondary_highlight() {
 
     let diagnostic = Diagnostic::debug()
         .message("nil")
-        .secondary_span(span(3, 3));
+        .unlabeled_secondary_span(span(3, 3));
 
     assert_format(
         &diagnostic,
@@ -573,7 +577,7 @@ fn format_highlight_line_break() {
         "This is a sentence.\nThis is a follow-up sentence.\n",
     );
 
-    let diagnostic = Diagnostic::error().labeled_primary_span(span(20, 20), "EOL");
+    let diagnostic = Diagnostic::error().span(span(20, 20), "EOL");
 
     assert_format(
         &diagnostic,
@@ -592,7 +596,7 @@ fn format_highlight_end_of_input() {
     let mut map = SourceMap::default();
     map.add_str(Anonymous, "This is a sentence.");
 
-    let diagnostic = Diagnostic::error().labeled_primary_span(span(20, 20), "EOI");
+    let diagnostic = Diagnostic::error().span(span(20, 20), "EOI");
 
     assert_format(
         &diagnostic,
@@ -613,7 +617,7 @@ fn format_highlight_end_of_input_with_trailing_line_break() {
     let mut map = SourceMap::default();
     map.add_str(Anonymous, "This is a sentence.\n");
 
-    let diagnostic = Diagnostic::error().labeled_primary_span(span(21, 21), "EOI");
+    let diagnostic = Diagnostic::error().span(span(21, 21), "EOI");
 
     assert_format(
         &diagnostic,
@@ -638,7 +642,7 @@ fn format_highlight_containing_final_line_break() {
 
     let diagnostic = Diagnostic::warning()
         .message("weird corner case")
-        .primary_span(span(1, 21));
+        .unlabeled_span(span(1, 21));
 
     assert_format(
         &diagnostic,
@@ -661,7 +665,7 @@ fn format_highlight_containing_final_end_of_input() {
     let mut map = SourceMap::default();
     map.add_str(Anonymous, "EVERYTHING\n");
 
-    let diagnostic = Diagnostic::bug().primary_span(span(1, 13));
+    let diagnostic = Diagnostic::bug().unlabeled_span(span(1, 13));
 
     assert_format(
         &diagnostic,
@@ -682,7 +686,7 @@ fn format_highlight_in_empty_file() {
 
     let diagnostic = Diagnostic::error()
         .message("this file has to contain something reasonable")
-        .primary_span(span(1, 1));
+        .unlabeled_span(span(1, 1));
 
     assert_format(
         &diagnostic,
@@ -733,7 +737,7 @@ fn format_path_together_with_highlight() {
     let diagnostic = Diagnostic::error()
         .message("this file is not acceptable")
         .path("problematic.txt".into())
-        .labeled_primary_span(span(20, 25), "because you set this");
+        .span(span(20, 25), "because you set this");
 
     assert_format(
         &diagnostic,
@@ -774,7 +778,7 @@ fn format_two_line_break_highlight_containing_first() {
     let mut map = SourceMap::default();
     map.add_str(Anonymous, "alpha\nbeta\n\ngamma");
 
-    let diagnostic = Diagnostic::bug().primary_span(span(1, 12));
+    let diagnostic = Diagnostic::bug().unlabeled_span(span(1, 12));
 
     // @Note I don't actually know how it should be rendered
     assert_format(
@@ -798,7 +802,7 @@ fn format_two_line_breaks_highlight_containing_second() {
     let mut map = SourceMap::default();
     map.add_str(Anonymous, "alpha\n\n");
 
-    let diagnostic = Diagnostic::bug().primary_span(span(1, 8));
+    let diagnostic = Diagnostic::bug().unlabeled_span(span(1, 8));
 
     // @Note I don't actually know how it should be rendered
     assert_format(

diff --git a/compiler/diagnostics/src/lib.rs b/compiler/diagnostics/src/lib.rs
@@ -1,17 +1,5 @@
 //! The diagnostics system.
-//!
-//! # Unimplemented Features
-//!
-//! * (maybe) subdiagnostics with a span
-//! * display style: rich (current system) <-> short
-//! * a rust script (in /misc) that finds the lowest [`ErrorCode`] that can be used
-//!   as well as any unused error codes (searching `compiler/`)
-#![feature(
-    adt_const_params,
-    anonymous_lifetime_in_impl_trait,
-    associated_type_bounds,
-    default_free_fn
-)]
+#![feature(adt_const_params, associated_type_bounds, default_free_fn)]
 #![allow(incomplete_features)] // adt_const_params
 
 pub use code::{Code, ErrorCode, LintCode};
@@ -59,7 +47,7 @@ impl<const S: Severity> Diagnostic<S> {
         self
     }
 
-    fn span(mut self, spanning: impl Spanning, label: Option<Str>, role: Role) -> Self {
+    fn _span(mut self, spanning: impl Spanning, label: Option<Str>, role: Role) -> Self {
         self.untagged.highlights.insert(Highlight {
             span: spanning.span(),
             label: label.map(Into::into),
@@ -68,27 +56,27 @@ impl<const S: Severity> Diagnostic<S> {
         self
     }
 
-    /// Reference a code snippet as one of the focal points of the diagnostic.
-    pub fn primary_span(self, spanning: impl Spanning) -> Self {
-        self.span(spanning, None, Role::Primary)
-    }
-
     /// Reference and label a code snippet as one of the focal points of the diagnostic.
-    pub fn labeled_primary_span(self, spanning: impl Spanning, label: impl Into<Str>) -> Self {
-        self.span(spanning, Some(label.into()), Role::Primary)
+    pub fn span(self, spanning: impl Spanning, label: impl Into<Str>) -> Self {
+        self._span(spanning, Some(label.into()), Role::Primary)
     }
 
-    /// Reference a code snippet as auxiliary information for the diagnostic.
-    pub fn secondary_span(self, spanning: impl Spanning) -> Self {
-        self.span(spanning, None, Role::Secondary)
+    /// Reference a code snippet as one of the focal points of the diagnostic.
+    pub fn unlabeled_span(self, spanning: impl Spanning) -> Self {
+        self._span(spanning, None, Role::Primary)
     }
 
     /// Reference and label a code snippet as auxiliary information for the diagnostic.
-    pub fn labeled_secondary_span(self, spanning: impl Spanning, label: impl Into<Str>) -> Self {
-        self.span(spanning, Some(label.into()), Role::Secondary)
+    pub fn label(self, spanning: impl Spanning, label: impl Into<Str>) -> Self {
+        self._span(spanning, Some(label.into()), Role::Secondary)
+    }
+
+    #[cfg(test)]
+    fn unlabeled_secondary_span(self, spanning: impl Spanning) -> Self {
+        self._span(spanning, None, Role::Secondary)
     }
 
-    fn spans<I>(mut self, spannings: I, label: Option<Str>, role: Role) -> Self
+    fn _spans<I>(mut self, spannings: I, label: Option<Str>, role: Role) -> Self
     where
         I: Iterator<Item: Spanning>,
     {
@@ -101,20 +89,20 @@ impl<const S: Severity> Diagnostic<S> {
         self
     }
 
-    /// Reference several equally important code snippets.
-    pub fn primary_spans<I>(self, spannings: I) -> Self
+    /// Reference and label several very and equally important code snippets.
+    pub fn spans<I>(self, spannings: I, label: impl Into<Str>) -> Self
     where
         I: IntoIterator<Item: Spanning>,
     {
-        self.spans(spannings.into_iter(), None, Role::Primary)
+        self._spans(spannings.into_iter(), Some(label.into()), Role::Primary)
     }
 
-    /// Reference and label several very and equally important code snippets.
-    pub fn labeled_primary_spans<I>(self, spannings: I, label: impl Into<Str>) -> Self
+    /// Reference several equally important code snippets.
+    pub fn unlabeled_spans<I>(self, spannings: I) -> Self
     where
         I: IntoIterator<Item: Spanning>,
     {
-        self.spans(spannings.into_iter(), Some(label.into()), Role::Primary)
+        self._spans(spannings.into_iter(), None, Role::Primary)
     }
 
     fn subdiagnostic(mut self, severity: Subseverity, message: Str) -> Self {

diff --git a/compiler/diagnostics/src/lib.rs.rej b/compiler/diagnostics/src/lib.rs.rej
@@ -0,0 +1,23 @@
+--- reporter.rs
++++ reporter.rs
+@@ -13,6 +13,9 @@ use std::{
+ };
+ use utilities::{pluralize, Conjunction, ListingExt};
+
++// @Task diagnostic formatting options
++// like display style: verbose (current default) vs. terse
++
+ /// A diagnostic reporter.
+ pub struct Reporter {
+     kind: ReporterKind,
+--- lib.rs
++++ lib.rs
+@@ -163,7 +163,7 @@ impl fmt::Display for Conjunction {
+     }
+ }
+
+-/// Use the singular or form the plural of the given word depending on the given amount.
++/// Use the singular or the plural form of the given word depending on the given amount.
+ ///
+ /// # Examples
+ ///