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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
use super::*;

use cl_lexer::error::{Error as LexError, Reason};
use std::fmt::Display;
pub type PResult<T> = Result<T, Error>;

/// Contains information about [Parser] errors
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Error {
    pub reason: ErrorKind,
    pub while_parsing: Parsing,
    pub loc: Loc,
}
impl std::error::Error for Error {}

/// Represents the reason for parse failure
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum ErrorKind {
    Lexical(LexError),
    EndOfInput,
    UnmatchedParentheses,
    UnmatchedCurlyBraces,
    UnmatchedSquareBrackets,
    Unexpected(TokenKind),
    ExpectedToken {
        want: TokenKind,
        got: TokenKind,
    },
    ExpectedParsing {
        want: Parsing,
    },
    /// Indicates unfinished code
    Todo(&'static str),
}
impl From<LexError> for ErrorKind {
    fn from(value: LexError) -> Self {
        match value.reason() {
            Reason::EndOfFile => Self::EndOfInput,
            _ => Self::Lexical(value),
        }
    }
}

/// Compactly represents the stage of parsing an [Error] originated in
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Parsing {
    Mutability,
    Visibility,
    Identifier,
    Literal,

    File,

    Attrs,
    Meta,
    MetaKind,

    Item,
    ItemKind,
    Alias,
    Const,
    Static,
    Module,
    ModuleKind,
    Function,
    Param,
    Struct,
    StructKind,
    StructMember,
    Enum,
    EnumKind,
    Variant,
    VariantKind,
    Impl,
    ImplKind,
    Use,
    UseTree,

    Ty,
    TyKind,
    TyTuple,
    TyRef,
    TyFn,

    Path,
    PathPart,

    Stmt,
    StmtKind,
    Let,

    Expr,
    ExprKind,
    Assign,
    AssignKind,
    Binary,
    BinaryKind,
    Unary,
    UnaryKind,
    Index,
    Structor,
    Fielder,
    Call,
    Member,
    Array,
    ArrayRep,
    AddrOf,
    Block,
    Group,
    Tuple,
    Loop,
    While,
    If,
    For,
    Else,
    Break,
    Return,
    Continue,
}

impl Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let Self { reason, while_parsing, loc } = self;
        match reason {
            // TODO entries are debug-printed
            ErrorKind::Todo(_) => write!(f, "{loc} {reason} {while_parsing:?}"),
            // lexical errors print their own higher-resolution loc info
            ErrorKind::Lexical(e) => write!(f, "{e} (while parsing {while_parsing})"),
            _ => write!(f, "{loc} {reason} while parsing {while_parsing}"),
        }
    }
}
impl Display for ErrorKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ErrorKind::Lexical(e) => e.fmt(f),
            ErrorKind::EndOfInput => write!(f, "End of input"),
            ErrorKind::UnmatchedParentheses => write!(f, "Unmatched parentheses"),
            ErrorKind::UnmatchedCurlyBraces => write!(f, "Unmatched curly braces"),
            ErrorKind::UnmatchedSquareBrackets => write!(f, "Unmatched square brackets"),
            ErrorKind::Unexpected(t) => write!(f, "Encountered unexpected token `{t}`"),
            ErrorKind::ExpectedToken { want: e, got: g } => write!(f, "Expected `{e}`, got `{g}`"),
            ErrorKind::ExpectedParsing { want } => write!(f, "Expected {want}"),
            ErrorKind::Todo(unfinished) => write!(f, "TODO: {unfinished}"),
        }
    }
}
impl Display for Parsing {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Parsing::Visibility => "a visibility qualifier",
            Parsing::Mutability => "a mutability qualifier",
            Parsing::Identifier => "an identifier",
            Parsing::Literal => "a literal",

            Parsing::File => "a file",

            Parsing::Attrs => "an attribute-set",
            Parsing::Meta => "an attribute",
            Parsing::MetaKind => "an attribute's arguments",
            Parsing::Item => "an item",
            Parsing::ItemKind => "an item",
            Parsing::Alias => "a type alias",
            Parsing::Const => "a const item",
            Parsing::Static => "a static variable",
            Parsing::Module => "a module",
            Parsing::ModuleKind => "a module",
            Parsing::Function => "a function",
            Parsing::Param => "a function parameter",
            Parsing::Struct => "a struct",
            Parsing::StructKind => "a struct",
            Parsing::StructMember => "a struct member",
            Parsing::Enum => "an enum",
            Parsing::EnumKind => "an enum",
            Parsing::Variant => "an enum variant",
            Parsing::VariantKind => "an enum variant",
            Parsing::Impl => "an impl block",
            Parsing::ImplKind => "the target of an impl block",
            Parsing::Use => "a use item",
            Parsing::UseTree => "a use-tree",

            Parsing::Ty => "a type",
            Parsing::TyKind => "a type",
            Parsing::TyTuple => "a tuple of types",
            Parsing::TyRef => "a reference type",
            Parsing::TyFn => "a function pointer type",

            Parsing::Path => "a path",
            Parsing::PathPart => "a path component",
            
            Parsing::Stmt => "a statement",
            Parsing::StmtKind => "a statement",
            Parsing::Let => "a local variable declaration",

            Parsing::Expr => "an expression",
            Parsing::ExprKind => "an expression",
            Parsing::Assign => "an assignment",
            Parsing::AssignKind => "an assignment operator",
            Parsing::Binary => "a binary expression",
            Parsing::BinaryKind => "a binary operator",
            Parsing::Unary => "a unary expression",
            Parsing::UnaryKind => "a unary operator",
            Parsing::Index => "an indexing expression",
            Parsing::Structor => "a struct constructor expression",
            Parsing::Fielder => "a struct field expression",
            Parsing::Call => "a call expression",
            Parsing::Member => "a member access expression",
            Parsing::Array => "an array",
            Parsing::ArrayRep => "an array of form [k;N]",
            Parsing::AddrOf => "a borrow op",
            Parsing::Block => "a block",
            Parsing::Group => "a grouped expression",
            Parsing::Tuple => "a tuple",
            Parsing::Loop => "an unconditional loop expression",
            Parsing::While => "a while expression",
            Parsing::If => "an if expression",
            Parsing::For => "a for expression",
            Parsing::Else => "an else block",
            Parsing::Break => "a break expression",
            Parsing::Return => "a return expression",
            Parsing::Continue => "a continue expression",
        }
        .fmt(f)
    }
}