1
/*
2
 * Hurl (https://hurl.dev)
3
 * Copyright (C) 2024 Orange
4
 *
5
 * Licensed under the Apache License, Version 2.0 (the "License");
6
 * you may not use this file except in compliance with the License.
7
 * You may obtain a copy of the License at
8
 *
9
 *          http://www.apache.org/licenses/LICENSE-2.0
10
 *
11
 * Unless required by applicable law or agreed to in writing, software
12
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 * See the License for the specific language governing permissions and
15
 * limitations under the License.
16
 *
17
 */
18
use crate::reader::Reader;
19

            
20
/// Represent a parser error. This type of error ca be recoverable or not and
21
/// implements conversion to recoverable / non-recoverable instance.
22
pub trait ParseError {
23
    /// Is this error recoverable or not?
24
    fn is_recoverable(&self) -> bool;
25

            
26
    /// Transforms this error to a recoverable one.
27
    fn to_recoverable(self) -> Self;
28

            
29
    /// Transforms this error to a non-recoverable one.
30
    fn to_non_recoverable(self) -> Self;
31
}
32

            
33
/// A parser func.
34
pub type ParseFunc<T, E> = fn(&mut Reader) -> Result<T, E>;
35

            
36
/// Try to consume one instances of the provided parser.
37
323035
pub fn optional<T, E>(f: ParseFunc<T, E>, reader: &mut Reader) -> Result<Option<T>, E>
38
323035
where
39
323035
    E: ParseError,
40
323035
{
41
323035
    let start = reader.cursor();
42
323035
    match f(reader) {
43
28780
        Ok(r) => Ok(Some(r)),
44
294255
        Err(e) => {
45
294255
            if e.is_recoverable() {
46
294120
                reader.seek(start);
47
294120
                Ok(None)
48
            } else {
49
135
                Err(e)
50
            }
51
        }
52
    }
53
}
54

            
55
/// Makes an error recoverable but does not reset cursor.
56
264315
pub fn recover<T, E>(f: ParseFunc<T, E>, reader: &mut Reader) -> Result<T, E>
57
264315
where
58
264315
    E: ParseError,
59
264315
{
60
264315
    match f(reader) {
61
88090
        Ok(r) => Ok(r),
62
176225
        Err(e) => Err(e.to_recoverable()),
63
    }
64
}
65

            
66
/// Makes an error non recoverable.
67
2480
pub fn non_recover<T, E>(f: ParseFunc<T, E>, reader: &mut Reader) -> Result<T, E>
68
2480
where
69
2480
    E: ParseError,
70
2480
{
71
2480
    match f(reader) {
72
2365
        Ok(r) => Ok(r),
73
115
        Err(e) => Err(e.to_non_recoverable()),
74
    }
75
}
76

            
77
/// Consumes zero or more instances of the provided parser.
78
750917
pub fn zero_or_more<T, E>(f: ParseFunc<T, E>, reader: &mut Reader) -> Result<Vec<T>, E>
79
750917
where
80
750917
    E: ParseError,
81
750917
{
82
750917
    let mut v = Vec::new();
83
    loop {
84
953071
        let initial_state = reader.cursor();
85
953071
        if reader.is_eof() {
86
25487
            return Ok(v);
87
        }
88
927584

            
89
927584
        match f(reader) {
90
202154
            Ok(r) => {
91
202154
                v.push(r);
92
            }
93
725430
            Err(e) => {
94
725430
                return if e.is_recoverable() {
95
724992
                    reader.seek(initial_state);
96
724992
                    Ok(v)
97
                } else {
98
438
                    Err(e)
99
                };
100
            }
101
        }
102
    }
103
}
104

            
105
/// Consumes one or more instances of the provided parser.
106
61415
pub fn one_or_more<T, E>(f: ParseFunc<T, E>, reader: &mut Reader) -> Result<Vec<T>, E>
107
61415
where
108
61415
    E: ParseError,
109
61415
{
110
61415
    match f(reader) {
111
61405
        Ok(first) => {
112
61405
            let mut v = vec![first];
113
            loop {
114
61785
                let initial_state = reader.cursor();
115
61785
                match f(reader) {
116
380
                    Ok(r) => {
117
380
                        v.push(r);
118
                    }
119
61405
                    Err(e) => {
120
61405
                        return if e.is_recoverable() {
121
61405
                            reader.seek(initial_state);
122
61405
                            Ok(v)
123
                        } else {
124
                            Err(e)
125
                        };
126
                    }
127
                }
128
            }
129
        }
130
        // if zero occurrence => should fail?
131
10
        Err(e) => Err(e.to_non_recoverable()),
132
    }
133
}
134

            
135
/// Tries to apply the list of parser until one of them succeeds.
136
/// Typically, this should be recoverable
137
144544
pub fn choice<T, E>(fs: &[ParseFunc<T, E>], reader: &mut Reader) -> Result<T, E>
138
144544
where
139
144544
    E: ParseError,
140
144544
{
141
1148269
    for (pos, f) in fs.iter().enumerate() {
142
1148269
        let start = reader.cursor();
143
1148269
        if pos == fs.len() - 1 {
144
79321
            return f(reader);
145
        }
146
1068948
        match f(reader) {
147
1003869
            Err(err) if err.is_recoverable() => {
148
1003725
                reader.seek(start);
149
1003725
                continue;
150
            }
151
65223
            x => return x,
152
        }
153
    }
154
    unreachable!("You can't call choice with an empty vector of choice")
155
}