oak-cpp 0.0.10

C++ systems programming language parser with support for modern C++ features and object-oriented programming.
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
#![doc = include_str!("readme.md")]
/// Element type definition.
pub mod element_type;
pub use element_type::CppElementType;

use crate::{
    language::CppLanguage,
    lexer::{CppLexer, CppTokenType},
};
use oak_core::{
    GreenNode, OakError,
    parser::{Associativity, ParseCache, ParseOutput, Parser, ParserState, Pratt, PrattParser, parse_with_lexer},
    source::{Source, TextEdit},
};

pub(crate) type State<'a, S> = ParserState<'a, CppLanguage, S>;

/// Parser for the C++ language.
///
/// This parser transforms a stream of tokens into a green tree of C++ syntax nodes,
/// using a combination of top-down recursive descent and Pratt parsing for expressions.
pub struct CppParser<'config> {
    pub(crate) config: &'config CppLanguage,
}

impl<'config> CppParser<'config> {
    /// Creates a new `CppParser` with the given configuration.
    pub fn new(config: &'config CppLanguage) -> Self {
        Self { config }
    }

    /// Parses a single C++ statement.
    ///
    /// This includes keywords, compound statements, preprocessor directives,
    /// and expressions followed by a semicolon.
    fn parse_statement<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), OakError> {
        use crate::lexer::CppTokenType::*;
        self.skip_trivia(state);
        match state.peek_kind() {
            Some(LeftBrace) => self.parse_compound_statement(state)?,
            Some(Preprocessor) => {
                // Skip preprocessor directives
                while state.not_at_end() && !state.at(Newline) {
                    state.bump();
                }
            }
            _ => {
                // Skip any tokens until semicolon or brace
                while state.not_at_end() && !state.at(Semicolon) && !state.at(LeftBrace) && !state.at(RightBrace) {
                    state.bump();
                }
                if state.at(Semicolon) {
                    state.bump();
                }
                else if state.at(LeftBrace) {
                    self.parse_compound_statement(state)?;
                }
            }
        }
        Ok(())
    }

    /// Skips trivia tokens (whitespace and comments).
    fn skip_trivia<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) {
        use crate::lexer::CppTokenType::*;
        while let Some(kind) = state.peek_kind() {
            if matches!(kind, Whitespace | Newline | Comment) {
                state.bump();
            }
            else {
                break;
            }
        }
    }

    /// Parses a compound statement (a block of statements enclosed in braces).
    fn parse_compound_statement<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), OakError> {
        let cp = state.checkpoint();
        if !state.eat(CppTokenType::LeftBrace) {
            // Skip until right brace or end of file
            while state.not_at_end() && !state.at(CppTokenType::RightBrace) {
                state.bump();
            }
            if state.at(CppTokenType::RightBrace) {
                state.bump();
            }
            state.finish_at(cp, CppElementType::CompoundStatement);
            return Ok(());
        }

        while state.not_at_end() && !state.at(CppTokenType::RightBrace) {
            self.parse_statement(state)?;
        }

        if !state.eat(CppTokenType::RightBrace) {
            // Skip until end of file or next statement
            while state.not_at_end() && !state.at(CppTokenType::Semicolon) && !state.at(CppTokenType::LeftBrace) {
                state.bump();
            }
        }

        state.finish_at(cp, CppElementType::CompoundStatement);
        Ok(())
    }

    /// Parses an if statement.
    fn parse_if_statement<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), OakError> {
        let cp = state.checkpoint();
        state.bump(); // if
        self.skip_trivia(state);
        state.expect(CppTokenType::LeftParen).ok();
        while state.not_at_end() && !state.at(CppTokenType::RightParen) {
            state.bump();
        }
        state.expect(CppTokenType::RightParen).ok();
        self.parse_statement(state)?;
        self.skip_trivia(state);
        if state.at(CppTokenType::Keyword) {
            state.bump();
            self.parse_statement(state)?;
        }
        state.finish_at(cp, CppElementType::IfStatement);
        Ok(())
    }

    /// Parses a while statement.
    fn parse_while_statement<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), OakError> {
        let cp = state.checkpoint();
        state.bump(); // while
        self.skip_trivia(state);
        state.expect(CppTokenType::LeftParen).ok();
        let expr = PrattParser::parse(state, 0, self);
        state.push_child(expr);
        state.expect(CppTokenType::RightParen).ok();
        self.parse_statement(state)?;
        state.finish_at(cp, CppElementType::WhileStatement);
        Ok(())
    }

    /// Parses a for statement.
    fn parse_for_statement<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), OakError> {
        let cp = state.checkpoint();
        state.bump(); // for
        self.skip_trivia(state);
        state.expect(CppTokenType::LeftParen).ok();

        // Initialize
        self.skip_trivia(state);
        if !state.at(CppTokenType::Semicolon) {
            let expr = PrattParser::parse(state, 0, self);
            state.push_child(expr);
        }
        state.expect(CppTokenType::Semicolon).ok();

        // Condition
        self.skip_trivia(state);
        if !state.at(CppTokenType::Semicolon) {
            let expr = PrattParser::parse(state, 0, self);
            state.push_child(expr);
        }
        state.expect(CppTokenType::Semicolon).ok();

        // Increment
        self.skip_trivia(state);
        if !state.at(CppTokenType::RightParen) {
            let expr = PrattParser::parse(state, 0, self);
            state.push_child(expr);
        }
        state.expect(CppTokenType::RightParen).ok();

        self.parse_statement(state)?;
        state.finish_at(cp, CppElementType::ForStatement);
        Ok(())
    }

    /// Parses a return statement.
    fn parse_return_statement<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), OakError> {
        let cp = state.checkpoint();
        state.bump(); // return
        self.skip_trivia(state);
        if !state.at(CppTokenType::Semicolon) {
            let expr = PrattParser::parse(state, 0, self);
            state.push_child(expr);
        }
        state.eat(CppTokenType::Semicolon);
        state.finish_at(cp, CppElementType::ReturnStatement);
        Ok(())
    }

    /// Parses a declaration statement.
    fn parse_declaration<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), OakError> {
        let cp = state.checkpoint();

        // Parse type specifiers and qualifiers
        while state.not_at_end() && !state.at(CppTokenType::Semicolon) && !state.at(CppTokenType::LeftParen) {
            state.bump();
        }

        // Check if it's a function declaration
        if state.at(CppTokenType::LeftParen) {
            // Function declaration
            self.parse_function_definition(state)?;
        }
        else {
            // Variable declaration
            while state.not_at_end() && !state.at(CppTokenType::Semicolon) {
                state.bump();
            }
            state.eat(CppTokenType::Semicolon);
            state.finish_at(cp, CppElementType::DeclarationStatement);
        }

        Ok(())
    }

    /// Parses a function definition.
    fn parse_function_definition<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), OakError> {
        let cp = state.checkpoint();

        // Parse function name
        if state.at(CppTokenType::Identifier) {
            state.bump();
        }

        // Parse parameters
        self.skip_trivia(state);
        state.expect(CppTokenType::LeftParen).ok();
        while state.not_at_end() && !state.at(CppTokenType::RightParen) {
            self.skip_trivia(state);
            // Parse parameter
            while state.not_at_end() && !state.at(CppTokenType::Comma) && !state.at(CppTokenType::RightParen) {
                state.bump();
            }
            if state.at(CppTokenType::Comma) {
                state.bump();
            }
        }
        state.expect(CppTokenType::RightParen).ok();

        // Parse function body
        self.skip_trivia(state);
        if state.at(CppTokenType::LeftBrace) {
            self.parse_compound_statement(state)?;
        }

        state.finish_at(cp, CppElementType::FunctionDefinition);
        Ok(())
    }

    /// Parses a class definition.
    fn parse_class_definition<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), OakError> {
        let cp = state.checkpoint();
        state.bump(); // class/struct/enum

        // Parse class name
        self.skip_trivia(state);
        if state.at(CppTokenType::Identifier) {
            state.bump();
        }

        // Parse template parameters (if any)
        self.skip_trivia(state);
        if state.at(CppTokenType::Less) {
            while state.not_at_end() && !state.at(CppTokenType::Greater) {
                state.bump();
            }
            state.eat(CppTokenType::Greater);
        }

        // Parse base classes (if any)
        self.skip_trivia(state);
        if state.at(CppTokenType::Colon) {
            state.bump();
            while state.not_at_end() && !state.at(CppTokenType::LeftBrace) {
                state.bump();
            }
        }

        // Parse class body
        self.skip_trivia(state);
        if state.at(CppTokenType::LeftBrace) {
            state.bump();
            while state.not_at_end() && !state.at(CppTokenType::RightBrace) {
                // Parse class members
                self.skip_trivia(state);
                if state.at(CppTokenType::Keyword) {
                    state.bump();
                    if state.at(CppTokenType::Colon) {
                        state.bump();
                    }
                }
                // Parse member declaration
                while state.not_at_end() && !state.at(CppTokenType::Semicolon) && !state.at(CppTokenType::RightBrace) {
                    state.bump();
                }
                state.eat(CppTokenType::Semicolon);
            }
            state.expect(CppTokenType::RightBrace).ok();
        }

        state.eat(CppTokenType::Semicolon);
        state.finish_at(cp, CppElementType::ClassDefinition);
        Ok(())
    }

    /// Parses a namespace definition.
    fn parse_namespace_definition<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), OakError> {
        let cp = state.checkpoint();
        state.bump(); // namespace

        // Parse namespace name
        self.skip_trivia(state);
        if state.at(CppTokenType::Identifier) {
            state.bump();
            // Handle nested namespaces (::)
            while state.at(CppTokenType::Scope) {
                state.bump();
                if state.at(CppTokenType::Identifier) {
                    state.bump();
                }
            }
        }

        // Parse namespace body
        self.skip_trivia(state);
        if state.at(CppTokenType::LeftBrace) {
            state.bump();
            while state.not_at_end() && !state.at(CppTokenType::RightBrace) {
                self.parse_statement(state)?;
            }
            state.expect(CppTokenType::RightBrace).ok();
        }

        state.finish_at(cp, CppElementType::NamespaceDefinition);
        Ok(())
    }
}

impl<'config> Parser<CppLanguage> for CppParser<'config> {
    /// Parses the entire C++ source file.
    fn parse<'a, S: Source + ?Sized>(&self, text: &'a S, edits: &[TextEdit], cache: &'a mut impl ParseCache<CppLanguage>) -> ParseOutput<'a, CppLanguage> {
        let lexer = CppLexer::new(self.config);
        parse_with_lexer(&lexer, text, edits, cache, |state| {
            let cp = state.checkpoint();
            while state.not_at_end() {
                self.parse_statement(state)?
            }
            Ok(state.finish_at(cp, CppElementType::SourceFile))
        })
    }
}

impl<'config> Pratt<CppLanguage> for CppParser<'config> {
    /// Parses a primary expression (e.g., identifiers, literals, parenthesized expressions).
    fn primary<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> &'a GreenNode<'a, CppLanguage> {
        use crate::lexer::CppTokenType::*;
        self.skip_trivia(state);
        let cp = state.checkpoint();
        match state.peek_kind() {
            Some(Identifier) => {
                state.bump();
                state.finish_at(cp, CppElementType::Token(Identifier))
            }
            Some(IntegerLiteral) | Some(FloatLiteral) | Some(CharacterLiteral) | Some(StringLiteral) | Some(BooleanLiteral) => {
                state.bump();
                state.finish_at(cp, CppElementType::ExpressionStatement)
            }
            Some(LeftParen) => {
                state.bump();
                let expr = PrattParser::parse(state, 0, self);
                state.push_child(expr);
                self.skip_trivia(state);
                state.expect(RightParen).ok();
                state.finish_at(cp, CppElementType::ExpressionStatement)
            }
            _ => {
                state.bump();
                state.finish_at(cp, CppElementType::Error)
            }
        }
    }

    fn prefix<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> &'a GreenNode<'a, CppLanguage> {
        self.primary(state)
    }

    fn infix<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>, left: &'a GreenNode<'a, CppLanguage>, min_precedence: u8) -> Option<&'a GreenNode<'a, CppLanguage>> {
        use crate::lexer::CppTokenType::*;
        self.skip_trivia(state);
        let kind = state.peek_kind()?;

        let (prec, assoc) = match kind {
            Assign | PlusAssign | MinusAssign | StarAssign | SlashAssign | PercentAssign | AndAssign | OrAssign | XorAssign | LeftShiftAssign | RightShiftAssign => (1, Associativity::Right),
            LogicalOr => (2, Associativity::Left),
            LogicalAnd => (3, Associativity::Left),
            Equal | NotEqual | Less | Greater | LessEqual | GreaterEqual => (4, Associativity::Left),
            Plus | Minus => (10, Associativity::Left),
            Star | Slash | Percent => (11, Associativity::Left),
            LeftParen | LeftBracket | Dot | Arrow => (15, Associativity::Left),
            Scope => (16, Associativity::Left),
            _ => return None,
        };

        if prec < min_precedence {
            return None;
        }

        match kind {
            LeftParen => {
                let cp = state.checkpoint();
                state.push_child(left);
                state.expect(LeftParen).ok();
                while state.not_at_end() && !state.at(RightParen) {
                    self.skip_trivia(state);
                    let expr = PrattParser::parse(state, 0, self);
                    state.push_child(expr);
                    self.skip_trivia(state);
                    if !state.eat(Comma) {
                        break;
                    }
                }
                state.expect(RightParen).ok();
                Some(state.finish_at(cp, CppElementType::FunctionCall))
            }
            _ => {
                let cp = state.checkpoint();
                state.push_child(left);
                state.bump();
                self.skip_trivia(state);
                let right = PrattParser::parse(state, prec + (assoc as u8), self);
                state.push_child(right);
                Some(state.finish_at(cp, CppElementType::ExpressionStatement))
            }
        }
    }
}