vimwiki-core 0.1.0

Core library elements for vimwiki data structures, parsing, and more
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

use super::Span;
use nom::error::{ContextError, ErrorKind, FromExternalError, ParseError};
use std::{borrow::Cow, fmt};

/// Represents an encapsulated error that is encountered
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct LangParserError<'a> {
    ctx: Cow<'a, str>,
    input: Span<'a>,
    next: Option<Box<Self>>,
}

impl<'a> From<nom::Err<LangParserError<'a>>> for LangParserError<'a> {
    fn from(nom_err: nom::Err<LangParserError<'a>>) -> Self {
        match nom_err {
            nom::Err::Error(x) | nom::Err::Failure(x) => x,
            nom::Err::Incomplete(_) => {
                Self::from_ctx(&Span::default(), "Incomplete")
            }
        }
    }
}

impl<'a> fmt::Display for LangParserError<'a> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        // Display our context along with the starting line/column
        // NOTE: This is an expensive operation to calculate the line/column
        writeln!(
            f,
            "{}: Line {}, Column {}",
            self.ctx,
            self.input.line(),
            self.input.column()
        )?;

        // Produce the first line of our input, limiting to no more than
        // 100 characters to prevent really long lines
        writeln!(
            f,
            "{}",
            &self
                .input
                .as_unsafe_remaining_str()
                .lines()
                .next()
                .unwrap_or_default()
                .chars()
                .take(100)
                .collect::<String>()
        )?;

        if let Some(next) = self.next.as_ref() {
            next.fmt(f)?;
        }

        Ok(())
    }
}

impl<'a> std::error::Error for LangParserError<'a> {}

impl<'a> LangParserError<'a> {
    pub fn unsupported() -> Self {
        Self {
            ctx: Cow::from("Unsupported"),
            input: Span::from(""),
            next: None,
        }
    }

    pub fn from_ctx(input: &Span<'a>, ctx: &'static str) -> Self {
        Self {
            ctx: Cow::from(ctx),
            input: *input,
            next: None,
        }
    }
}

impl<'a, E> FromExternalError<Span<'a>, E> for LangParserError<'a> {
    fn from_external_error(input: Span<'a>, kind: ErrorKind, _e: E) -> Self {
        // TODO: Support unique external error rendering
        Self::from_error_kind(input, kind)
    }
}

impl<'a> ParseError<Span<'a>> for LangParserError<'a> {
    fn from_error_kind(input: Span<'a>, kind: ErrorKind) -> Self {
        Self {
            ctx: Cow::from(kind.description().to_string()),
            input,
            next: None,
        }
    }

    fn append(input: Span<'a>, kind: ErrorKind, other: Self) -> Self {
        let mut e = Self::from_error_kind(input, kind);
        e.next = Some(Box::new(other));
        e
    }

    fn from_char(input: Span<'a>, c: char) -> Self {
        Self {
            ctx: Cow::from(format!("Char {}", c)),
            input,
            next: None,
        }
    }

    fn or(self, other: Self) -> Self {
        // Pick error that has progressed further
        if self.input.start_offset() > other.input.start_offset() {
            self
        } else {
            other
        }
    }
}

impl<'a> ContextError<Span<'a>> for LangParserError<'a> {
    fn add_context(input: Span<'a>, ctx: &'static str, other: Self) -> Self {
        Self {
            ctx: Cow::from(ctx),
            input,
            next: Some(Box::new(other)),
        }
    }
}