dbc-rs 0.5.0

Database CAN (DBC) parsing and editing library
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
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289

use super::Parser;
use crate::Error;

impl<'a> Parser<'a> {
    pub fn skip_whitespace(&mut self) -> crate::Result<&mut Self> {
        let input_len = self.input.len();
        if self.pos >= input_len {
            return Err(self.err_unexpected_eof());
        }

        if self.input[self.pos] == b' ' {
            // Skip consecutive spaces (optimize: use cached input_len)
            while self.pos + 1 < input_len && self.input[self.pos + 1] == b' ' {
                self.pos += 1;
            }
            self.pos += 1; // Skip the last space
            Ok(self)
        } else {
            Err(self.err_expected(Error::EXPECTED_WHITESPACE))
        }
    }

    pub fn skip_newlines_and_spaces(&mut self) {
        let input_len = self.input.len();
        while self.pos < input_len {
            match self.input[self.pos] {
                b'\n' => {
                    self.pos += 1;
                    self.line += 1;
                }
                b'\r' => {
                    self.pos += 1;
                    // Handle \r\n as a single newline
                    if self.pos < input_len && self.input[self.pos] == b'\n' {
                        self.pos += 1;
                    }
                    self.line += 1;
                }
                b' ' | b'\t' => {
                    self.pos += 1;
                }
                _ => break,
            }
        }
    }

    pub fn skip_to_end_of_line(&mut self) {
        let input_len = self.input.len();
        while self.pos < input_len {
            let byte = self.input[self.pos];
            match byte {
                b'\n' => {
                    self.pos += 1;
                    self.line += 1;
                    break;
                }
                b'\r' => {
                    self.pos += 1;
                    // Handle \r\n
                    if self.pos < input_len && self.input[self.pos] == b'\n' {
                        self.pos += 1;
                    }
                    self.line += 1;
                    break;
                }
                _ => {
                    self.pos += 1;
                }
            }
        }
    }

    /// Skip whitespace optionally (don't error if no whitespace).
    /// Consolidates the pattern: `let _ = parser.skip_whitespace();` or `skip_whitespace().ok()`.
    #[inline]
    pub fn skip_whitespace_optional(&mut self) {
        let _ = self.skip_whitespace();
    }
}

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

    #[test]
    fn skip_whitespace_succeeds_with_space() {
        let input = b" test";
        let mut parser = Parser::new(input).unwrap();
        let result = parser.skip_whitespace();
        assert!(result.is_ok());
        assert_eq!(parser.remaining(), b"test");
        assert_eq!(parser.pos, 1);
    }

    #[test]
    fn skip_whitespace_fails_with_tab() {
        let input = b"\ttest";
        let mut parser = Parser::new(input).unwrap();
        let result = parser.skip_whitespace();
        assert!(result.is_err());
        match result.unwrap_err() {
            Error::Expected { msg, line } => {
                assert_eq!(msg, Error::EXPECTED_WHITESPACE);
                assert_eq!(line, Some(1));
            }
            _ => panic!("Expected Error::Expected"),
        }
    }

    #[test]
    fn skip_whitespace_fails_with_newline() {
        let input = b"\ntest";
        let mut parser = Parser::new(input).unwrap();
        let result = parser.skip_whitespace();
        assert!(result.is_err());
        match result.unwrap_err() {
            Error::Expected { msg, line } => {
                assert_eq!(msg, Error::EXPECTED_WHITESPACE);
                assert_eq!(line, Some(1));
            }
            _ => panic!("Expected Error::Expected"),
        }
    }

    #[test]
    fn skip_whitespace_fails_with_carriage_return() {
        let input = b"\rtest";
        let mut parser = Parser::new(input).unwrap();
        let result = parser.skip_whitespace();
        assert!(result.is_err());
        match result.unwrap_err() {
            Error::Expected { msg, line } => {
                assert_eq!(msg, Error::EXPECTED_WHITESPACE);
                assert_eq!(line, Some(1));
            }
            _ => panic!("Expected Error::Expected"),
        }
    }

    #[test]
    fn skip_whitespace_fails_with_form_feed() {
        let input = b"\x0ctest";
        let mut parser = Parser::new(input).unwrap();
        let result = parser.skip_whitespace();
        assert!(result.is_err());
        match result.unwrap_err() {
            Error::Expected { msg, line } => {
                assert_eq!(msg, Error::EXPECTED_WHITESPACE);
                assert_eq!(line, Some(1));
            }
            _ => panic!("Expected Error::Expected"),
        }
    }

    #[test]
    fn skip_whitespace_fails_with_non_whitespace() {
        let input = b"test";
        let mut parser = Parser::new(input).unwrap();
        let result = parser.skip_whitespace();
        assert!(result.is_err());
        match result.unwrap_err() {
            Error::Expected { msg, line } => {
                assert_eq!(msg, Error::EXPECTED_WHITESPACE);
                assert_eq!(line, Some(1));
            }
            _ => panic!("Expected Error::Expected"),
        }
        // Input should remain unchanged
        assert_eq!(parser.remaining(), b"test");
        assert_eq!(parser.pos, 0);
    }

    #[test]
    fn skip_whitespace_fails_with_empty_input() {
        let input = b" ";
        let mut parser = Parser::new(input).unwrap();
        // Skip the only character to make position at end
        parser.pos = input.len();
        let result = parser.skip_whitespace();
        assert!(result.is_err());
        match result.unwrap_err() {
            Error::UnexpectedEof { .. } => {}
            _ => panic!("Expected Error::UnexpectedEof"),
        }
    }

    #[test]
    fn skip_whitespace_skips_multiple_spaces() {
        let input = b"  test";
        let mut parser = Parser::new(input).unwrap();
        let result = parser.skip_whitespace();
        assert!(result.is_ok());
        assert_eq!(parser.remaining(), b"test");
        assert_eq!(parser.pos, 2);
    }

    #[test]
    fn skip_whitespace_chaining_stops_on_error() {
        let input = b" test";
        let mut parser = Parser::new(input).unwrap();
        let result = parser.skip_whitespace().and_then(|p| p.skip_whitespace());
        assert!(result.is_err());
        match result.unwrap_err() {
            Error::Expected { msg, line } => {
                assert_eq!(msg, Error::EXPECTED_WHITESPACE);
                assert_eq!(line, Some(1));
            }
            _ => panic!("Expected Error::Expected"),
        }
    }

    #[test]
    fn line_number_increments_on_newline() {
        let input = b"line1\nline2";
        let mut parser = Parser::new(input).unwrap();
        assert_eq!(parser.line(), 1);

        // Advance past "line1" to reach the newline
        parser.expect(b"line1").unwrap();
        assert_eq!(parser.line(), 1);

        // Now skip the newline
        parser.skip_newlines_and_spaces();
        assert_eq!(parser.line(), 2);
    }

    #[test]
    fn line_number_increments_on_carriage_return() {
        let input = b"line1\rline2";
        let mut parser = Parser::new(input).unwrap();
        assert_eq!(parser.line(), 1);

        // Advance past "line1" to reach the carriage return
        parser.expect(b"line1").unwrap();
        assert_eq!(parser.line(), 1);

        parser.skip_newlines_and_spaces();
        assert_eq!(parser.line(), 2);
    }

    #[test]
    fn line_number_treats_crlf_as_single_newline() {
        let input = b"line1\r\nline2";
        let mut parser = Parser::new(input).unwrap();
        assert_eq!(parser.line(), 1);

        // Advance past "line1" to reach the \r\n
        parser.expect(b"line1").unwrap();
        assert_eq!(parser.line(), 1);

        parser.skip_newlines_and_spaces();
        assert_eq!(parser.line(), 2);
    }

    #[test]
    fn line_number_counts_multiple_newlines() {
        let input = b"line1\n\n\nline4";
        let mut parser = Parser::new(input).unwrap();
        assert_eq!(parser.line(), 1);

        // Advance past "line1" to reach the newlines
        parser.expect(b"line1").unwrap();
        assert_eq!(parser.line(), 1);

        parser.skip_newlines_and_spaces();
        assert_eq!(parser.line(), 4);
    }

    #[test]
    fn skip_to_end_of_line_increments_line() {
        let input = b"line1\nline2";
        let mut parser = Parser::new(input).unwrap();
        assert_eq!(parser.line(), 1);

        parser.skip_to_end_of_line();
        assert_eq!(parser.line(), 2);
    }

    #[test]
    fn expect_increments_line_when_skipping_newlines() {
        let input = b"test\nrest";
        let mut parser = Parser::new(input).unwrap();
        assert_eq!(parser.line(), 1);

        // expect will skip "test\n" which contains a newline
        parser.expect(b"test\n").unwrap();
        assert_eq!(parser.line(), 2);
    }
}