kind-driver 0.1.3

Driver for the kind compiler
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! Errors created by the driver. All of them
//! are related with paths and unbounded variables.

use std::{path::PathBuf, fmt::Display, error::Error};

use kind_report::{data::{Color, Diagnostic, DiagnosticFrame, Marker, Severity, Subtitle, Word}, RenderConfig};
use kind_tree::symbol::{Ident, QualifiedIdent};

#[derive(Debug)]
pub struct GenericDriverError;

impl Display for GenericDriverError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "driver pass error")
    }
}

impl Error for GenericDriverError { }

/// Describes all of the possible errors inside each
/// of the passes inside this crate.
pub(crate) enum DriverDiagnostic {
    CannotFindFile(String),
    UnboundVariable(Vec<Ident>, Vec<String>),
    MultiplePaths(QualifiedIdent, Vec<PathBuf>),
    DefinedMultipleTimes(QualifiedIdent, QualifiedIdent),
    ThereIsntAMain,
}

impl Diagnostic for DriverDiagnostic {
    fn get_syntax_ctx(&self) -> Option<kind_span::SyntaxCtxIndex> {
        match self {
            DriverDiagnostic::CannotFindFile(_) => None,
            DriverDiagnostic::ThereIsntAMain => None,
            DriverDiagnostic::UnboundVariable(v, _) => Some(v[0].range.ctx),
            DriverDiagnostic::MultiplePaths(id, _) => Some(id.range.ctx),
            DriverDiagnostic::DefinedMultipleTimes(fst, _) => Some(fst.range.ctx),
        }
    }

    fn to_diagnostic_frame(&self, _: &RenderConfig) -> DiagnosticFrame {
        match self {
            DriverDiagnostic::UnboundVariable(idents, suggestions) => DiagnosticFrame {
                code: 100,
                severity: Severity::Error,
                title: format!("Cannot find the definition '{}'.", idents[0].to_str()),
                subtitles: vec![],
                hints: vec![if !suggestions.is_empty() {
                    format!(
                        "Maybe you're looking for {}",
                        suggestions.iter().map(|x| format!("'{}'", x)).collect::<Vec<String>>().join(", ")
                    )
                } else {
                    "Take a look at the rules for name searching at https://github.com/Kindelia/Kind2/blob/master/guide/naming.md".to_string()
                }],
                positions: idents
                    .iter()
                    .map(|ident| Marker {
                        position: ident.range,
                        color: Color::Fst,
                        text: "Here!".to_string(),
                        no_code: false,
                        main: true,
                    })
                    .collect(),
            },
            DriverDiagnostic::MultiplePaths(ident, paths) => DiagnosticFrame {
                code: 101,
                severity: Severity::Error,
                title: "Ambiguous definition location for the same name".to_string(),
                subtitles: paths
                    .iter()
                    .map(|path| Subtitle::Phrase(Color::Fst, vec![Word::White(path.display().to_string())]))
                    .collect(),
                hints: vec!["Take a look at the rules for name searching at https://github.com/Kindelia/Kind2/blob/master/guide/naming.md".to_string()],
                positions: vec![Marker {
                    position: ident.range,
                    color: Color::Fst,
                    text: "Here!".to_string(),
                    no_code: false,
                    main: true,
                }],
            },
            DriverDiagnostic::DefinedMultipleTimes(fst, snd) => DiagnosticFrame {
                code: 102,
                severity: Severity::Error,
                title: "Defined multiple times for the same name".to_string(),
                subtitles: vec![],
                hints: vec!["Rename one of the definitions or remove and look at how names work in Kind at https://github.com/Kindelia/Kind2/blob/master/guide/naming.md".to_string()],
                positions: vec![
                    Marker {
                        position: fst.range,
                        color: Color::Fst,
                        text: "The first ocorrence".to_string(),
                        no_code: false,
                        main: true,
                    },
                    Marker {
                        position: snd.range,
                        color: Color::Snd,
                        text: "Second occorrence here!".to_string(),
                        no_code: false,
                        main: false,
                    },
                ],
            },
            DriverDiagnostic::CannotFindFile(file) => DiagnosticFrame {
                code: 103,
                severity: Severity::Error,
                title: format!("Cannot find file '{}'", file),
                subtitles: vec![],
                hints: vec![],
                positions: vec![],
            },

            DriverDiagnostic::ThereIsntAMain => DiagnosticFrame {
                code: 103,
                severity: Severity::Error,
                title: "Cannot find 'Main' function to run the file.".to_string(),
                subtitles: vec![],
                hints: vec![],
                positions: vec![],
            },
        }
    }

    fn get_severity(&self) -> Severity {
        use DriverDiagnostic::*;
        match self {
            CannotFindFile(_)
            | UnboundVariable(_, _)
            | MultiplePaths(_, _)
            | DefinedMultipleTimes(_, _)
            | ThereIsntAMain => Severity::Error
        }
    }
}