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
226
227
228
229
230
231
232
233
234
235
236
237
238
use std::{
    collections::VecDeque,
    fmt,
    sync::mpsc::{sync_channel, Receiver, RecvError, SyncSender},
};

/// Represents a start and end of something in a sequence
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Span(pub usize, pub usize);

/// Defines a Token of type T and with a Position
#[derive(PartialEq, Eq)]
pub struct Token<T>(pub T, pub Span);

impl<T: fmt::Debug> fmt::Debug for Token<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:?} {}:{}", self.0, self.1 .0, self.1 .1)
    }
}

/// A error struct with a reason and position
pub struct ParseError {
    pub reason: String,
    pub position: Option<Span>,
}

impl fmt::Debug for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "ParseError: {}{}",
            self.reason,
            if let Some(pos) = &self.position {
                format!(" {:?}", pos)
            } else {
                "".to_owned()
            }
        )
    }
}

/// Trait for a reader which returns tokens over a current sequence
pub trait TokenReader<T>
where
    T: PartialEq + fmt::Debug,
{
    /// Returns reference to next token but does not advance iterator forward
    fn peek(&mut self) -> Option<&Token<T>>;
    /// Returns token and advances forward
    fn next(&mut self) -> Option<Token<T>>;

    /// Tests that next token matches an expected type. Will return `ParseError` if does not
    /// match. Else it will return the position of the correctly matching token
    fn expect_next(&mut self, expected_type: T) -> Result<Span, ParseError> {
        match self.next() {
            Some(Token(token_type, position)) => {
                if token_type != expected_type {
                    Err(ParseError {
                        reason: format!("Expected {:?}, received {:?}", expected_type, token_type),
                        position: Some(position),
                    })
                } else {
                    Ok(position)
                }
            }
            None => Err(ParseError {
                reason: format!("Expected {:?} but reached end of source", expected_type),
                position: None,
            }),
        }
    }
}

/// Trait for a sender that can append a token to a sequence
pub trait TokenSender<T> {
    /// Appends new Token
    fn push(&mut self, token: Token<T>);
}

/// A synchronous "channel" which can be used as a sender and reader. Will
/// buffer all tokens into a `VecDeque` before reading
pub struct StaticTokenChannel<T> {
    tokens: VecDeque<Token<T>>,
}

impl<T> StaticTokenChannel<T> {
    pub fn new() -> Self {
        StaticTokenChannel {
            tokens: VecDeque::new(),
        }
    }
}

impl<T> TokenSender<T> for StaticTokenChannel<T> {
    fn push(&mut self, token: Token<T>) {
        self.tokens.push_back(token)
    }
}

impl<T: PartialEq + fmt::Debug> TokenReader<T> for StaticTokenChannel<T> {
    fn peek(&mut self) -> Option<&Token<T>> {
        self.tokens.front()
    }

    fn next(&mut self) -> Option<Token<T>> {
        self.tokens.pop_front()
    }
}

pub struct StreamedTokenSender<T>(SyncSender<Token<T>>);
pub struct StreamedTokenReader<T> {
    receiver: Receiver<Token<T>>,
    cache: VecDeque<Token<T>>,
}

impl<T> TokenSender<T> for StreamedTokenSender<T> {
    fn push(&mut self, token: Token<T>) {
        self.0.send(token).unwrap();
    }
}

/// Will return a `TokenSender` and `TokenReader` for use when lexing and parsing in separate threads
/// Unlike `StaticTokenChannel` it does not buffer all the tokens before parsing can begin
pub fn get_streamed_token_channel<T>() -> (StreamedTokenSender<T>, StreamedTokenReader<T>) {
    let (sender, receiver) = sync_channel::<Token<T>>(20);
    (
        StreamedTokenSender(sender),
        StreamedTokenReader {
            receiver,
            cache: VecDeque::new(),
        },
    )
}

impl<T: PartialEq + fmt::Debug> TokenReader<T> for StreamedTokenReader<T> {
    fn peek(&mut self) -> Option<&Token<T>> {
        if self.cache.is_empty() {
            match self.receiver.recv() {
                Ok(val) => self.cache.push_back(val),
                // Err is reader has dropped e.g. no more tokens
                Err(RecvError) => {
                    return None;
                }
            }
        }
        self.cache.front()
    }

    fn next(&mut self) -> Option<Token<T>> {
        if !self.cache.is_empty() {
            return self.cache.pop_front();
        }
        self.receiver.recv().ok()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn static_token_channel() {
        let mut stc = StaticTokenChannel::new();
        stc.push(Token(12, Span(0, 2)));
        stc.push(Token(32, Span(2, 4)));
        stc.push(Token(52, Span(4, 8)));

        assert_eq!(stc.next().unwrap(), Token(12, Span(0, 2)));
        assert_eq!(stc.next().unwrap(), Token(32, Span(2, 4)));
        assert_eq!(stc.next().unwrap(), Token(52, Span(4, 8)));
        assert_eq!(stc.next(), None);
    }

    #[test]
    fn static_token_channel_peek() {
        let mut stc = StaticTokenChannel::new();
        stc.push(Token(12, Span(0, 2)));

        assert_eq!(stc.peek().unwrap(), &Token(12, Span(0, 2)));
        assert_eq!(stc.next().unwrap(), Token(12, Span(0, 2)));
        assert_eq!(stc.next(), None);
    }

    #[test]
    fn static_token_channel_expect_next() {
        let mut stc = StaticTokenChannel::new();
        stc.push(Token(12, Span(0, 2)));
        stc.push(Token(24, Span(2, 4)));

        assert_eq!(stc.expect_next(12).unwrap(), Span(0, 2));
        let err = stc.expect_next(10).unwrap_err();
        assert_eq!(err.position, Some(Span(2, 4)));
        assert_eq!(err.reason, "Expected 10, received 24".to_owned());
        assert_eq!(stc.next(), None);
    }

    #[test]
    fn streamed_token_channel() {
        let (mut sender, mut reader) = get_streamed_token_channel();
        std::thread::spawn(move || {
            sender.push(Token(12, Span(0, 2)));
            sender.push(Token(32, Span(2, 4)));
            sender.push(Token(52, Span(4, 8)));
        });

        assert_eq!(reader.next().unwrap(), Token(12, Span(0, 2)));
        assert_eq!(reader.next().unwrap(), Token(32, Span(2, 4)));
        assert_eq!(reader.next().unwrap(), Token(52, Span(4, 8)));
        assert_eq!(reader.next(), None);
    }

    #[test]
    fn streamed_token_channel_peek() {
        let (mut sender, mut reader) = get_streamed_token_channel();
        std::thread::spawn(move || {
            sender.push(Token(12, Span(0, 2)));
        });

        assert_eq!(reader.peek().unwrap(), &Token(12, Span(0, 2)));
        assert_eq!(reader.next().unwrap(), Token(12, Span(0, 2)));
        assert_eq!(reader.next(), None);
    }

    #[test]
    fn streamed_token_channel_expect_next() {
        let (mut sender, mut reader) = get_streamed_token_channel();
        std::thread::spawn(move || {
            sender.push(Token(12, Span(0, 2)));
            sender.push(Token(24, Span(2, 4)));
        });

        assert_eq!(reader.expect_next(12).unwrap(), Span(0, 2));
        let err = reader.expect_next(10).unwrap_err();
        assert_eq!(err.position, Some(Span(2, 4)));
        assert_eq!(err.reason, "Expected 10, received 24".to_owned());
        assert_eq!(reader.next(), None);
    }
}