Feat(Compiler-Base): Add code snippet component (#190)

* refactor(compiler-base): refactor trait component and add errors.

add 'errors.rs' to report error for 'components.rs'.
refactor trait `Component` to supports report errors.

issue #115

* move test cases from error/diagnostic/tests.rs to error/tests.rs

* add component StringWithStyle

* feat(compiler-base): Add code snippet pendant.

add UnderLine, IndentWithPrefix, StringWithStyle, CodeSnippet in compiler_base/error/src/diagnostic/components.rs to show code context in diagnostic.

issue #115

* fix CR comments

* add inline

* replace label by symbol.

* fix typo

Author: zong-zhe

kclvm/compiler_base/3rdparty/rustc_errors/src/styled_buffer.rs

@@ -29,6 +29,32 @@ where
     pub style: Option<T>,
 }
 
+impl<T> StyledString<T>
+where
+    T: Clone + PartialEq + Eq + Style,
+{
+    /// Constructs a new `StyledString` by string and style.
+    /// 
+    /// # Examples
+    /// 
+    /// ```ignore
+    /// // You need to choose a style for the generic parameter `T` of `StyledString`.
+    /// #[derive(Clone, PartialEq, Eq)]
+    /// enum MyStyle{
+    ///     Style_1
+    /// }
+    /// impl Style for MyStyle {
+    ///     ...
+    /// }
+    /// 
+    /// let styled_string = StyledString::<MyStyle>::new("Hello Styled String".to_string(), Some<MyStyle::Style_1>);
+    /// ```
+    #[inline]
+    pub fn new(text: String, style: Option<T>) -> Self {
+        StyledString { text, style }
+    }
+}
+
 impl<T> StyledChar<T>
 where
     T: Clone + PartialEq + Eq + Style,

kclvm/compiler_base/error/src/diagnostic/components.rs

@@ -1,7 +1,10 @@
 //! 'components.rs' defines all components with style `DiagnosticStyle` that builtin in compiler_base_error.
+use std::sync::Arc;
+
 use super::{style::DiagnosticStyle, Component};
 use crate::errors::ComponentFormatError;
-use rustc_errors::styled_buffer::StyledBuffer;
+use compiler_base_span::{span_to_filename_string, SourceMap, Span};
+use rustc_errors::styled_buffer::{StyledBuffer, StyledString};
 
 /// `Label` can be considered as a component of diagnostic to display a short label message in `Diagnositc`.
 /// `Label` provides "error", "warning", "note" and "Help" four kinds of labels.
@@ -54,3 +57,333 @@ impl Component<DiagnosticStyle> for Label {
         }
     }
 }
+
+// Make `StyledString` into a component of diagnostic to display a string with style.
+// For more information about `StyledString`, see doc in `/compiler_base/3rdparty/rustc_errors/src/styled_buffer.rs`.
+impl Component<DiagnosticStyle> for StyledString<DiagnosticStyle> {
+    #[inline]
+    fn format(&self, sb: &mut StyledBuffer<DiagnosticStyle>, _: &mut Vec<ComponentFormatError>) {
+        sb.appendl(&self.text, self.style);
+    }
+}
+
+/// `IndentWithPrefix` is a component of diagnostic to display an indent with prefix.
+/// An indent is a whitespace.
+/// ```ignore
+/// "|   " is three indent with prefix "|".
+/// ```
+pub struct IndentWithPrefix {
+    indent: usize,
+    prefix: StyledString<DiagnosticStyle>,
+}
+
+const DEFAULT_INDENT_PREFIX_LABEL: &str = "|";
+
+impl IndentWithPrefix {
+    /// Constructs a new `IndentWithPrefix` by default label with 0 indent.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// # use compiler_base_error::Component;
+    /// # use compiler_base_error::components::IndentWithPrefix;
+    /// # use compiler_base_error::DiagnosticStyle;
+    /// # use rustc_errors::styled_buffer::StyledBuffer;
+    ///
+    /// let mut sb = StyledBuffer::<DiagnosticStyle>::new();
+    /// let mut errs = vec![];
+    ///
+    /// // If you want to render default text: "|"
+    /// let indent = IndentWithPrefix::default();
+    /// indent.format(&mut sb, &mut errs);
+    /// ```
+    #[inline]
+    pub fn default() -> Self {
+        Self {
+            indent: 0,
+            prefix: StyledString::<DiagnosticStyle> {
+                text: DEFAULT_INDENT_PREFIX_LABEL.to_string(),
+                style: None,
+            },
+        }
+    }
+
+    /// Constructs a new `IndentWithPrefix` by default label with custom indents.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// # use compiler_base_error::Component;
+    /// # use compiler_base_error::components::IndentWithPrefix;
+    /// # use compiler_base_error::DiagnosticStyle;
+    /// # use rustc_errors::styled_buffer::StyledBuffer;
+    ///
+    /// let mut sb = StyledBuffer::<DiagnosticStyle>::new();
+    /// let mut errs = vec![];
+    ///
+    /// // If you want to add 3 indents and render text: "   |"
+    /// let indent = IndentWithPrefix::new_with_default_label(3, None);
+    /// indent.format(&mut sb, &mut errs);
+    /// ```
+    #[inline]
+    pub fn new_with_default_label(indent: usize, style: Option<DiagnosticStyle>) -> Self {
+        Self {
+            indent,
+            prefix: StyledString::<DiagnosticStyle>::new(
+                DEFAULT_INDENT_PREFIX_LABEL.to_string(),
+                style,
+            ),
+        }
+    }
+
+    /// Constructs a new `IndentWithPrefix` by custom label with custom indents.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// # use compiler_base_error::Component;
+    /// # use compiler_base_error::components::IndentWithPrefix;
+    /// # use compiler_base_error::DiagnosticStyle;
+    /// # use rustc_errors::styled_buffer::StyledBuffer;
+    ///
+    /// let mut sb = StyledBuffer::<DiagnosticStyle>::new();
+    /// let mut errs = vec![];
+    /// // If you want to add 3 indents and rendering text: "   ^"
+    /// let indent = IndentWithPrefix::new("^".to_string(), 3, None);
+    /// indent.format(&mut sb, &mut errs);
+    /// ```
+    #[inline]
+    pub fn new(prefix: String, indent: usize, prefix_style: Option<DiagnosticStyle>) -> Self {
+        Self {
+            indent,
+            prefix: StyledString::<DiagnosticStyle>::new(prefix, prefix_style),
+        }
+    }
+}
+
+impl Component<DiagnosticStyle> for IndentWithPrefix {
+    #[inline]
+    fn format(&self, sb: &mut StyledBuffer<DiagnosticStyle>, errs: &mut Vec<ComponentFormatError>) {
+        let indent = self.indent;
+        sb.appendl(&format!("{:>indent$}", ""), None);
+        self.prefix.format(sb, errs)
+    }
+}
+
+/// `UnderLine` is a component of diagnostic to display an underline.
+///
+/// ```ignore
+/// int test = 0;
+///     ^^^^ This is an underline under variable `test`
+/// ```
+pub struct UnderLine {
+    start: usize,
+    end: usize,
+    symbol: StyledString<DiagnosticStyle>,
+}
+
+const DEFAULT_UNDERLINE_LABEL: &str = "^";
+impl UnderLine {
+    /// Constructs a new `UnderLine` with a default label.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// # use compiler_base_error::Component;
+    /// # use compiler_base_error::components::UnderLine;
+    /// # use compiler_base_error::DiagnosticStyle;
+    /// # use rustc_errors::styled_buffer::StyledBuffer;
+    ///
+    /// let mut sb = StyledBuffer::<DiagnosticStyle>::new();
+    /// let mut errs = vec![];
+    ///
+    /// // rendering text: "^^^^^^^^^^"
+    /// let ul = UnderLine::new_with_default_label(0, 10, None);
+    /// ul.format(&mut sb, &mut errs);
+    ///
+    /// // rendering text: "^^^^^^^^^^" in `DiagnosticStyle::NeedFix`.
+    /// let ul_need_fix = UnderLine::new_with_default_label(0, 10, Some(DiagnosticStyle::NeedFix));
+    /// ul_need_fix.format(&mut sb, &mut errs);
+    /// ```
+    #[inline]
+    pub fn new_with_default_label(
+        start: usize,
+        end: usize,
+        style: Option<DiagnosticStyle>,
+    ) -> Self {
+        Self {
+            start,
+            end,
+            symbol: StyledString::<DiagnosticStyle>::new(
+                DEFAULT_UNDERLINE_LABEL.to_string(),
+                style,
+            ),
+        }
+    }
+
+    /// Constructs a new `UnderLine` with a custom label.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// # use compiler_base_error::Component;
+    /// # use compiler_base_error::components::UnderLine;
+    /// # use compiler_base_error::DiagnosticStyle;
+    /// # use rustc_errors::styled_buffer::StyledBuffer;
+    ///
+    /// let mut sb = StyledBuffer::<DiagnosticStyle>::new();
+    /// let mut errs = vec![];
+    ///
+    /// // rendering text: "__________"
+    /// let ul = UnderLine::new(0, 10, "_".to_string(), None);
+    /// ul.format(&mut sb, &mut errs);
+    ///
+    /// // rendering text: "~~" in `DiagnosticStyle::NeedFix`.
+    /// let ul_need_fix = UnderLine::new(0, 2, "~".to_string(), Some(DiagnosticStyle::NeedFix));
+    /// ul_need_fix.format(&mut sb, &mut errs);
+    /// ```
+    #[inline]
+    pub fn new(start: usize, end: usize, label: String, style: Option<DiagnosticStyle>) -> Self {
+        Self {
+            start,
+            end,
+            symbol: StyledString::<DiagnosticStyle>::new(label.to_string(), style),
+        }
+    }
+}
+
+impl Component<DiagnosticStyle> for UnderLine {
+    fn format(&self, sb: &mut StyledBuffer<DiagnosticStyle>, errs: &mut Vec<ComponentFormatError>) {
+        if self.start < self.end {
+            IndentWithPrefix::new("".to_string(), self.start, None).format(sb, errs);
+            for _ in self.start..self.end {
+                self.symbol.format(sb, errs);
+            }
+        } else if self.start > self.end {
+            errs.push(ComponentFormatError::new(
+                "UnderLine",
+                "Failed to Format UnderLine in One Line.",
+            ))
+        }
+    }
+}
+
+/// `CodeSnippet` is a component of diagnostic to display code snippets.
+pub struct CodeSnippet {
+    code_span: Span,
+    source_map: Arc<SourceMap>,
+}
+
+impl CodeSnippet {
+    /// # Examples
+    ///
+    /// If you want to get one line code snippet from 'compiler_base/error/src/diagnostic/test_datas/code_snippet' file
+    /// ```ignore
+    /// Line 1 Code Snippet.
+    /// Line 2 Code Snippet.
+    /// ```
+    ///
+    /// ```rust
+    /// # use compiler_base_error::{
+    /// #     Component,
+    /// #     DiagnosticStyle,
+    /// # };
+    /// # use compiler_base_span::{
+    /// #     SourceMap,
+    /// #     FilePathMapping,
+    /// #     span_to_filename_string
+    /// # };
+    /// # use rustc_errors::styled_buffer::StyledBuffer;
+    /// # use compiler_base_span::{span::new_byte_pos, SpanData};
+    /// # use compiler_base_error::components::CodeSnippet;
+    /// # use std::{path::PathBuf, sync::Arc, fs};
+    ///
+    /// let mut sb = StyledBuffer::<DiagnosticStyle>::new();
+    /// let mut errs = vec![];
+    ///
+    /// // 1. You shouled load the file and create the `SourceFile`
+    /// let filename = fs::canonicalize(&PathBuf::from("./src/diagnostic/test_datas/code_snippet"))
+    ///     .unwrap()
+    ///     .display()
+    ///     .to_string();
+    ///
+    /// let src = std::fs::read_to_string(filename.clone()).unwrap();
+    /// let sm = SourceMap::new(FilePathMapping::empty());
+    /// sm.new_source_file(PathBuf::from(filename.clone()).into(), src.to_string());
+    ///
+    /// // 2. You should create a code span for the code snippet.
+    /// let code_span = SpanData {
+    ///     lo: new_byte_pos(22),
+    ///     hi: new_byte_pos(42),
+    /// }.span();
+    ///
+    /// // 3. You can create the `CodeSnippet` by the `SourceFile`,
+    /// // and render text "Line 2 Code Snippet.".
+    /// let code_snippet = CodeSnippet::new(code_span, Arc::new(sm));
+    /// code_snippet.format(&mut sb, &mut errs);
+    /// ```
+    #[inline]
+    pub fn new(code_span: Span, source_map: Arc<SourceMap>) -> Self {
+        Self {
+            code_span,
+            source_map,
+        }
+    }
+}
+
+const DEFAULT_FILE_PATH_PREFIX: &str = "---> File: ";
+
+impl Component<DiagnosticStyle> for CodeSnippet {
+    fn format(&self, sb: &mut StyledBuffer<DiagnosticStyle>, errs: &mut Vec<ComponentFormatError>) {
+        sb.pushs(DEFAULT_FILE_PATH_PREFIX, Some(DiagnosticStyle::Url));
+        let file_info = self.source_map.span_to_diagnostic_string(self.code_span);
+        sb.appendl(&file_info, Some(DiagnosticStyle::Url));
+        sb.appendl("\n", None);
+        match self.source_map.span_to_lines(self.code_span) {
+            Ok(affected_lines) => {
+                match self
+                    .source_map
+                    .source_file_by_filename(&span_to_filename_string(
+                        &self.code_span,
+                        &self.source_map,
+                    )) {
+                    Some(sf) => {
+                        for line in affected_lines.lines {
+                            let line_index = line.line_index.to_string();
+                            let indent = line_index.len() + 1;
+                            IndentWithPrefix::new(line_index, indent, Some(DiagnosticStyle::Url))
+                                .format(sb, errs);
+                            IndentWithPrefix::default().format(sb, errs);
+                            if let Some(line) = sf.get_line(line.line_index) {
+                                sb.appendl(&line.to_string(), None);
+                            } else {
+                                errs.push(ComponentFormatError::new(
+                                    "CodeSnippet",
+                                    "Failed to Display Code Snippet.",
+                                ))
+                            }
+                            sb.appendl("\n", None);
+                            IndentWithPrefix::new_with_default_label(indent + 1, None)
+                                .format(sb, errs);
+                            UnderLine::new_with_default_label(
+                                line.start_col.0,
+                                line.end_col.0,
+                                Some(DiagnosticStyle::NeedFix),
+                            )
+                            .format(sb, errs);
+                            sb.appendl("\n", None);
+                        }
+                    }
+                    None => errs.push(ComponentFormatError::new(
+                        "CodeSnippet",
+                        "Failed to Load Source File",
+                    )),
+                };
+            }
+            Err(_) => errs.push(ComponentFormatError::new(
+                "CodeSnippet",
+                "Failed to Display Code Snippet Lines",
+            )),
+        };
+    }
+}

kclvm/compiler_base/error/src/diagnostic/test_datas/code_snippet

@@ -0,0 +1,2 @@
+Line 1 Code Snippet.
+Line 2 Code Snippet.