i_slint_compiler/

diagnostics.rs

// Copyright © SixtyFPS GmbH <info@slint.dev>
// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Royalty-free-2.0 OR LicenseRef-Slint-Software-3.0

use std::io::Read;
use std::path::{Path, PathBuf};
use std::sync::Arc;

use crate::parser::TextSize;
use std::collections::BTreeSet;

/// Span represent an error location within a file.
///
/// Currently, it is just an offset in byte within the file + the corresponding length.
#[derive(Debug, Clone, PartialEq)]
pub struct Span {
    pub offset: usize,
    pub length: usize,
}

impl Span {
    pub fn is_valid(&self) -> bool {
        self.offset != usize::MAX
    }

    pub fn new(offset: usize, length: usize) -> Self {
        Self { offset, length }
    }
}

impl Default for Span {
    fn default() -> Self {
        Span { offset: usize::MAX, length: 0 }
    }
}

/// Returns a span.  This is implemented for tokens and nodes
pub trait Spanned {
    fn span(&self) -> Span;
    fn source_file(&self) -> Option<&SourceFile>;
    fn to_source_location(&self) -> SourceLocation {
        SourceLocation { source_file: self.source_file().cloned(), span: self.span() }
    }
}

#[derive(Default)]
pub struct SourceFileInner {
    path: PathBuf,

    /// Complete source code of the path, used to map from offset to line number
    source: Option<String>,

    /// The offset of each linebreak
    line_offsets: std::sync::OnceLock<Vec<usize>>,
}

impl std::fmt::Debug for SourceFileInner {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{:?}", self.path)
    }
}

impl SourceFileInner {
    pub fn new(path: PathBuf, source: String) -> Self {
        Self { path, source: Some(source), line_offsets: Default::default() }
    }

    pub fn path(&self) -> &Path {
        &self.path
    }

    /// Create a SourceFile that has just a path, but no contents
    pub fn from_path_only(path: PathBuf) -> Arc<Self> {
        Arc::new(Self { path, ..Default::default() })
    }

    /// Returns a tuple with the line (starting at 1) and column number (starting at 1)
    pub fn line_column(&self, offset: usize, format: ByteFormat) -> (usize, usize) {
        let adjust_utf16 = |line_begin, col| {
            if format == ByteFormat::Utf16
                && let Some(source) = &self.source
            {
                return i_slint_common::unicode_utils::byte_offset_to_utf16_offset(
                    &source[line_begin..],
                    col,
                );
            }
            col
        };

        let line_offsets = self.line_offsets();
        line_offsets.binary_search(&offset).map_or_else(
            |line| {
                if line == 0 {
                    (1, adjust_utf16(0, offset) + 1)
                } else {
                    let line_begin = *line_offsets.get(line - 1).unwrap_or(&0);
                    (line + 1, adjust_utf16(line_begin, offset - line_begin) + 1)
                }
            },
            |line| (line + 2, 1),
        )
    }

    pub fn text_size_to_file_line_column(
        &self,
        size: TextSize,
        format: ByteFormat,
    ) -> (String, usize, usize, usize, usize) {
        let file_name = self.path().to_string_lossy().to_string();
        let (start_line, start_column) = self.line_column(size.into(), format);
        (file_name, start_line, start_column, start_line, start_column)
    }

    /// Returns the offset that corresponds to the line/column
    pub fn offset(&self, line: usize, column: usize, format: ByteFormat) -> usize {
        let adjust_utf16 = |line_begin, col| {
            if format == ByteFormat::Utf16
                && let Some(source) = &self.source
            {
                return i_slint_common::unicode_utils::utf16_offset_to_byte_offset_clamped(
                    &source[line_begin..],
                    col,
                );
            }
            col
        };

        let col_offset = column.saturating_sub(1);
        if line <= 1 {
            // line == 0 is actually invalid!
            return adjust_utf16(0, col_offset);
        }
        let offsets = self.line_offsets();
        let index = std::cmp::min(line.saturating_sub(1), offsets.len());
        let line_offset = *offsets.get(index.saturating_sub(1)).unwrap_or(&0);
        line_offset.saturating_add(adjust_utf16(line_offset, col_offset))
    }

    fn line_offsets(&self) -> &[usize] {
        self.line_offsets.get_or_init(|| {
            self.source
                .as_ref()
                .map(|s| {
                    s.bytes()
                        .enumerate()
                        // Add the offset one past the '\n' into the index: That's the first char
                        // of the new line!
                        .filter_map(|(i, c)| if c == b'\n' { Some(i + 1) } else { None })
                        .collect()
                })
                .unwrap_or_default()
        })
    }

    pub fn source(&self) -> Option<&str> {
        self.source.as_deref()
    }
}

#[derive(Copy, Clone, Eq, PartialEq, Debug)]
/// When converting between line/columns to offset, specify if the format of the column is UTF-8 or UTF-16
pub enum ByteFormat {
    Utf8,
    Utf16,
}

pub type SourceFile = Arc<SourceFileInner>;

pub fn load_from_path(path: &Path) -> Result<String, Diagnostic> {
    let string = (if path == Path::new("-") {
        let mut buffer = Vec::new();
        let r = std::io::stdin().read_to_end(&mut buffer);
        r.and_then(|_| {
            String::from_utf8(buffer)
                .map_err(|err| std::io::Error::new(std::io::ErrorKind::InvalidData, err))
        })
    } else {
        std::fs::read_to_string(path)
    })
    .map_err(|err| Diagnostic {
        message: format!("Could not load {}: {}", path.display(), err),
        span: SourceLocation {
            source_file: Some(SourceFileInner::from_path_only(path.to_owned())),
            span: Default::default(),
        },
        level: DiagnosticLevel::Error,
    })?;

    if path.extension().is_some_and(|e| e == "rs") {
        return crate::lexer::extract_rust_macro(string).ok_or_else(|| Diagnostic {
            message: "No `slint!` macro".into(),
            span: SourceLocation {
                source_file: Some(SourceFileInner::from_path_only(path.to_owned())),
                span: Default::default(),
            },
            level: DiagnosticLevel::Error,
        });
    }

    Ok(string)
}

#[derive(Debug, Clone, Default)]
pub struct SourceLocation {
    pub source_file: Option<SourceFile>,
    pub span: Span,
}

impl Spanned for SourceLocation {
    fn span(&self) -> Span {
        self.span.clone()
    }

    fn source_file(&self) -> Option<&SourceFile> {
        self.source_file.as_ref()
    }
}

impl Spanned for Option<SourceLocation> {
    fn span(&self) -> crate::diagnostics::Span {
        self.as_ref().map(|n| n.span()).unwrap_or_default()
    }

    fn source_file(&self) -> Option<&SourceFile> {
        self.as_ref().map(|n| n.source_file.as_ref()).unwrap_or_default()
    }
}

/// This enum describes the level or severity of a diagnostic message produced by the compiler.
#[derive(Debug, PartialEq, Copy, Clone, Default)]
#[non_exhaustive]
pub enum DiagnosticLevel {
    /// The diagnostic found is an error that prevents successful compilation.
    #[default]
    Error,
    /// The diagnostic found is a warning.
    Warning,
    /// The diagnostic is an note to further help with the error or warning
    Note,
}

/// This structure represent a diagnostic emitted while compiling .slint code.
///
/// It is basically a message, a level (warning or error), attached to a
/// position in the code
#[derive(Debug, Clone)]
pub struct Diagnostic {
    message: String,
    span: SourceLocation,
    level: DiagnosticLevel,
}

//NOTE! Diagnostic is re-exported in the public API of the interpreter
impl Diagnostic {
    /// Return the level for this diagnostic
    pub fn level(&self) -> DiagnosticLevel {
        self.level
    }

    /// Return a message for this diagnostic
    pub fn message(&self) -> &str {
        &self.message
    }

    /// Returns a tuple with the line (starting at 1) and column number (starting at 1)
    ///
    /// Can also return (0, 0) if the span is invalid
    pub fn line_column(&self) -> (usize, usize) {
        if !self.span.span.is_valid() {
            return (0, 0);
        }
        let offset = self.span.span.offset;

        match &self.span.source_file {
            None => (0, 0),
            Some(sl) => sl.line_column(offset, ByteFormat::Utf8),
        }
    }

    /// Return the length of this diagnostic in UTF-8 encoded bytes.
    pub fn length(&self) -> usize {
        self.span.span.length
    }

    // NOTE: The return-type differs from the Spanned trait.
    // Because this is public API (Diagnostic is re-exported by the Interpreter), we cannot change
    // this.
    /// return the path of the source file where this error is attached
    pub fn source_file(&self) -> Option<&Path> {
        self.span.source_file().map(|sf| sf.path())
    }
}

impl std::fmt::Display for Diagnostic {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        if let Some(sf) = self.span.source_file() {
            let (line, _) = self.line_column();
            write!(f, "{}:{}: {}", sf.path.display(), line, self.message)
        } else {
            write!(f, "{}", self.message)
        }
    }
}

impl std::fmt::Display for SourceLocation {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        if let Some(sf) = &self.source_file {
            let (line, col) = sf.line_column(self.span.offset, ByteFormat::Utf8);
            write!(f, "{}:{line}:{col}", sf.path.display())
        } else {
            write!(f, "<unknown>")
        }
    }
}

pub fn diagnostic_line_column_with_format(
    diagnostic: &Diagnostic,
    format: ByteFormat,
) -> (usize, usize) {
    let Some(sf) = &diagnostic.span.source_file else { return (0, 0) };
    sf.line_column(diagnostic.span.span.offset, format)
}

pub fn diagnostic_end_line_column_with_format(
    diagnostic: &Diagnostic,
    format: ByteFormat,
) -> (usize, usize) {
    let Some(sf) = &diagnostic.span.source_file else { return (0, 0) };
    // The end_line_column is exclusive.
    // Even if the span indicates a length of 0, the diagnostic should always
    // return an end_line_column that is at least one offset further.
    // Diagnostic::length ensures this.
    let offset = diagnostic.span.span.offset + diagnostic.length();
    sf.line_column(offset, format)
}

#[derive(Default)]
pub struct BuildDiagnostics {
    inner: Vec<Diagnostic>,

    /// When false, throw error for experimental features
    pub enable_experimental: bool,

    /// When true, reject features not supported by the safety-critical subset
    #[cfg(feature = "slint-sc")]
    pub slint_sc: bool,

    /// This is the list of all loaded files (with or without diagnostic)
    /// does not include the main file.
    /// FIXME: this doesn't really belong in the diagnostics, it should be somehow returned in another way
    /// (maybe in a compilation state that include the diagnostics?)
    pub all_loaded_files: BTreeSet<PathBuf>,
}

impl IntoIterator for BuildDiagnostics {
    type Item = Diagnostic;
    type IntoIter = <Vec<Diagnostic> as IntoIterator>::IntoIter;
    fn into_iter(self) -> Self::IntoIter {
        self.inner.into_iter()
    }
}

impl BuildDiagnostics {
    pub fn push_diagnostic_with_span(
        &mut self,
        message: String,
        span: SourceLocation,
        level: DiagnosticLevel,
    ) {
        debug_assert!(
            !message.as_str().ends_with('.'),
            "Error message should not end with a period: ({message:?})"
        );
        self.inner.push(Diagnostic { message, span, level });
    }
    pub fn push_error_with_span(&mut self, message: String, span: SourceLocation) {
        self.push_diagnostic_with_span(message, span, DiagnosticLevel::Error)
    }
    pub fn push_error(&mut self, message: String, source: &dyn Spanned) {
        self.push_error_with_span(message, source.to_source_location());
    }
    pub fn push_warning_with_span(&mut self, message: String, span: SourceLocation) {
        self.push_diagnostic_with_span(message, span, DiagnosticLevel::Warning)
    }
    pub fn push_warning(&mut self, message: String, source: &dyn Spanned) {
        self.push_warning_with_span(message, source.to_source_location());
    }
    pub fn push_note_with_span(&mut self, message: String, span: SourceLocation) {
        self.push_diagnostic_with_span(message, span, DiagnosticLevel::Note)
    }
    pub fn push_note(&mut self, message: String, source: &dyn Spanned) {
        self.push_note_with_span(message, source.to_source_location());
    }
    pub fn push_compiler_error(&mut self, error: Diagnostic) {
        self.inner.push(error);
    }

    /// Whether the compilation targets the Slint SC subset. Callable without
    /// the `slint-sc` feature, unlike reading the field, so call sites need
    /// no `cfg` of their own.
    pub fn is_slint_sc(&self) -> bool {
        #[cfg(feature = "slint-sc")]
        return self.slint_sc;
        #[cfg(not(feature = "slint-sc"))]
        false
    }

    /// If in safety-critical mode, push an error saying that `feature` is not
    /// supported.
    ///
    /// Errors are suppressed for builtin files (paths starting with `builtin:`)
    /// since those are loaded automatically by the compiler and are not user code.
    #[cfg(feature = "slint-sc")]
    pub fn slint_sc_error(&mut self, feature: &str, source: &dyn Spanned) {
        if self.slint_sc
            && !source
                .source_file()
                .is_some_and(|sf| sf.path().to_string_lossy().starts_with("builtin:"))
        {
            self.push_error(format!("{feature} not supported in Slint SC"), source);
        }
    }

    pub fn push_property_deprecation_warning(
        &mut self,
        old_property: &str,
        new_property: &str,
        source: &dyn Spanned,
    ) {
        self.push_property_deprecation_warning_with_message(
            old_property,
            &format!("Please use '{new_property}' instead"),
            source,
        )
    }

    /// Same as [`Self::push_property_deprecation_warning`], but with a free-form message shown
    /// after "The property 'xxx' has been deprecated."
    pub fn push_property_deprecation_warning_with_message(
        &mut self,
        old_property: &str,
        message: &str,
        source: &dyn Spanned,
    ) {
        self.push_diagnostic_with_span(
            format!("The property '{old_property}' has been deprecated. {message}"),
            source.to_source_location(),
            crate::diagnostics::DiagnosticLevel::Warning,
        )
    }

    /// Return true if there is at least one compilation error for this file
    pub fn has_errors(&self) -> bool {
        self.inner.iter().any(|diag| diag.level == DiagnosticLevel::Error)
    }

    /// Return true if there are no diagnostics (warnings or errors); false otherwise.
    pub fn is_empty(&self) -> bool {
        self.inner.is_empty()
    }

    #[cfg(feature = "display-diagnostics")]
    fn call_diagnostics(
        &self,
        mut handle_no_source: Option<&mut dyn FnMut(&Diagnostic)>,
    ) -> String {
        if self.inner.is_empty() {
            return Default::default();
        }

        let report: Vec<_> = self
            .inner
            .iter()
            .filter_map(|d| {
                let annotate_snippets_level = match d.level {
                    DiagnosticLevel::Error => annotate_snippets::Level::ERROR,
                    DiagnosticLevel::Warning => annotate_snippets::Level::WARNING,
                    DiagnosticLevel::Note => annotate_snippets::Level::NOTE,
                };
                let message = annotate_snippets_level.primary_title(d.message());

                let group = if !d.span.span.is_valid() {
                    annotate_snippets::Group::with_title(message)
                } else if let Some(sf) = &d.span.source_file {
                    if let Some(source) = &sf.source {
                        let start_offset = d.span.span.offset;
                        let end_offset = d.span.span.offset + d.length();
                        message.element(
                            annotate_snippets::Snippet::source(source)
                                .path(sf.path.to_string_lossy())
                                .annotation(
                                    annotate_snippets::AnnotationKind::Primary
                                        .span(start_offset..end_offset),
                                ),
                        )
                    } else {
                        if let Some(ref mut handle_no_source) = handle_no_source {
                            drop(message);
                            handle_no_source(d);
                            return None;
                        }
                        message.element(annotate_snippets::Origin::path(sf.path.to_string_lossy()))
                    }
                } else {
                    annotate_snippets::Group::with_title(message)
                };
                Some(group)
            })
            .collect();

        annotate_snippets::Renderer::styled().render(&report)
    }

    #[cfg(feature = "display-diagnostics")]
    /// Print the diagnostics on the console
    pub fn print(self) {
        use std::io::Write;
        let to_print = self.call_diagnostics(None);
        if !to_print.is_empty() {
            let _ = writeln!(std::io::stderr(), "{to_print}");
        }
    }

    #[cfg(feature = "display-diagnostics")]
    /// Print into a string
    pub fn diagnostics_as_string(self) -> String {
        self.call_diagnostics(None)
    }

    #[cfg(all(feature = "proc_macro_span", feature = "display-diagnostics"))]
    /// Will convert the diagnostics that only have offsets to the actual proc_macro::Span
    ///
    /// `tokens` are the tokens the document was parsed from, in document order.
    pub fn report_macro_diagnostic(
        self,
        tokens: &[crate::parser::Token],
    ) -> proc_macro::TokenStream {
        let mut result = proc_macro::TokenStream::default();
        let mut needs_error = self.has_errors();
        let output = self.call_diagnostics(
            Some(&mut |diag| {
                // A diagnostic only carries an offset into the document, which is the
                // concatenation of the token texts: find the token that offset lands in.
                let span = if diag.span.span.is_valid() {
                    let index = tokens
                        .binary_search_by_key(&diag.span.span.offset, |t| t.offset)
                        .unwrap_or_else(|i| i.saturating_sub(1));
                    tokens.get(index).and_then(|t| t.span)
                } else {
                    None
                };
                let message = &diag.message;

                let span: proc_macro2::Span = if let Some(span) = span {
                    span.into()
                } else {
                    proc_macro2::Span::call_site()
                };
                match diag.level {
                    DiagnosticLevel::Error => {
                        needs_error = false;
                        result.extend(proc_macro::TokenStream::from(
                            quote::quote_spanned!(span => compile_error!{ #message })
                        ));
                    }
                    DiagnosticLevel::Warning => {
                        result.extend(proc_macro::TokenStream::from(
                            quote::quote_spanned!(span => const _ : () = { #[deprecated(note = #message)] const WARNING: () = (); WARNING };)
                        ));
                    },
                    DiagnosticLevel::Note => {
                        // TODO: Notes are not (yet) supported in proc-macros, we'll just print them as warnings for now.
                        // We can fix this once proc-macro diagnostics support notes
                        let message = format!("note: {message}");
                        result.extend(proc_macro::TokenStream::from(
                            quote::quote_spanned!(span => const _ : () = { #[deprecated(note = #message)] const NOTE: () = (); NOTE };)
                        ));
                    },
                }
            }),
        );
        if !output.is_empty() {
            eprintln!("{output}");
        }

        if needs_error {
            result.extend(proc_macro::TokenStream::from(quote::quote!(
                compile_error! { "Error occurred" }
            )))
        }
        result
    }

    pub fn to_string_vec(&self) -> Vec<String> {
        self.inner.iter().map(|d| d.to_string()).collect()
    }

    pub fn push_diagnostic(
        &mut self,
        message: String,
        source: &dyn Spanned,
        level: DiagnosticLevel,
    ) {
        self.push_diagnostic_with_span(message, source.to_source_location(), level)
    }

    pub fn push_internal_error(&mut self, err: Diagnostic) {
        self.inner.push(err)
    }

    pub fn iter(&self) -> impl Iterator<Item = &Diagnostic> {
        self.inner.iter()
    }

    #[cfg(feature = "display-diagnostics")]
    #[must_use]
    pub fn check_and_exit_on_error(self) -> Self {
        if self.has_errors() {
            self.print();
            std::process::exit(-1);
        }
        self
    }

    #[cfg(feature = "display-diagnostics")]
    pub fn print_warnings_and_exit_on_error(self) {
        let has_error = self.has_errors();
        self.print();
        if has_error {
            std::process::exit(-1);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_source_file_offset_line_column_mapping() {
        let content = r#"import { LineEdit, Button, Slider, HorizontalBox, VerticalBox } from "std-widgets.slint";

component MainWindow inherits Window {
    property <duration> total-time: slider.value * 1s;

    callback tick(duration);
    VerticalBox {
        HorizontalBox {
            padding-left: 0;
            Text { text: "Elapsed Time:"; }
            Rectangle {
                Rectangle {
                    height: 100%;
                    background: lightblue;
                }
            }
        }
    }


}


    "#.to_string();
        let sf = SourceFileInner::new(PathBuf::from("foo.slint"), content.clone());

        let mut line = 1;
        let mut column = 1;
        for offset in 0..content.len() {
            let b = *content.as_bytes().get(offset).unwrap();

            assert_eq!(sf.offset(line, column, ByteFormat::Utf8), offset);
            assert_eq!(sf.line_column(offset, ByteFormat::Utf8), (line, column));

            if b == b'\n' {
                line += 1;
                column = 1;
            } else {
                column += 1;
            }
        }
    }
}