trixy 0.4.0

A rust crate used to generate multi-language apis for your application
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

/*
* Copyright (C) 2023 - 2024:
* The Trinitrix Project <soispha@vhack.eu, antifallobst@systemausfall.org>
* SPDX-License-Identifier: GPL-3.0-or-later
*
* This file is part of the Trixy crate for Trinitrix.
*
* Trixy is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* and the GNU General Public License along with this program.
* If not, see <https://www.gnu.org/licenses/>.
*/

use std::{error::Error, fmt::Display};
use thiserror::Error;

use crate::parser::error::{AdditionalHelp, ErrorContext, ErrorContextDisplay};

#[derive(Error, Debug)]
pub enum LexingError {
    #[error("No matches were found")]
    NoMatchesTaken,
    #[error("Expected an token, but reached end of file")]
    UnexpectedEOF,
    #[error("Char ('{0}') is not a know token!")]
    UnknownCharacter(char),
    #[error("The Arrow token must be of the form: ->")]
    ExpectedArrow,
    #[error("The Comment token must start with two slashes")]
    ExpectedComment,
    #[error("It seams like, you have a un-closed quote")]
    RunawayQuote,
}

impl AdditionalHelp for LexingError {
    fn additional_help(&self) -> String {
        match self {
            LexingError::NoMatchesTaken => "This is probably a bug, please open an issue at the issue tracker".to_owned(),
            LexingError::UnexpectedEOF => "This eof was completely unexpected".to_owned(),
            LexingError::ExpectedArrow => "The `-` token is interpretet as a started arrow (`->`), but we could not find the arrow tip (`>`)".to_owned(),
            LexingError::UnknownCharacter(char) => {
                format!("This char: `{char}`; is not a valid token")
            },
            LexingError::ExpectedComment => "The '/' started comment parsing, but I could not find a matching '/'".to_owned(),
            LexingError::RunawayQuote => "Add a quote, somewhere.".to_owned(),
            }
    }
}

#[derive(Debug)]
pub struct SpannedLexingError {
    pub source: LexingError,
    pub context: ErrorContext,
}

impl Error for SpannedLexingError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        Some(&self.source)
    }
}

impl ErrorContextDisplay for SpannedLexingError {
    type Error = LexingError;

    fn context(&self) -> &crate::parser::error::ErrorContext {
        &self.context
    }

    fn line_number(&self) -> usize {
        self.context.line_number
    }

    fn line_above(&self) -> &str {
        &self.context.line_above
    }

    fn line_below(&self) -> &str {
        &self.context.line_below
    }

    fn line(&self) -> &str {
        &self.context.line
    }

    fn source(&self) -> &<SpannedLexingError as ErrorContextDisplay>::Error {
        &self.source
    }
}
impl Display for SpannedLexingError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.error_fmt(f)
    }
}