cpp_parser 0.1.1

A lossless C++ parser over the preprocessed text: the tree every layer above it reads.
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
437
438
439
440
441
442
443
444
445
446
//! Statement nodes.
//!
//! Statements are the largest family of node types, and they are where a C++ parser's tolerance
//! shows: an editor sees half-written `if`s and unclosed blocks constantly, so every accessor here
//! returns `Option` and nothing asserts structure.

use crate::{
    CppSyntaxNode,
    kind::CppSyntaxKind,
    syntax::traits::{CppAstChildren, CppAstNode},
};

use super::{CppExpr, CppNameToken, CppParamList, CppParenExpr};
use crate::syntax::node::CppStat;
// ============================================================================

/// A compound statement: `{ ... }`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppCompoundStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppCompoundStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        kind == CppSyntaxKind::CompoundStat
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppCompoundStat {
    /// The statements in the block, in order.
    ///
    /// Returns the statement sum type rather than a `CppStat` wrapper, because C++ statements and
    /// declarations are the same construct: `int x;` inside a block is a `CppDeclaration`.
    pub fn get_stats(&self) -> CppAstChildren<CppStat> {
        self.children()
    }
}

/// An `if` statement, including any `else`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppIfStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppIfStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        kind == CppSyntaxKind::IfStat
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppIfStat {
    /// The condition. It may be an expression or a declaration (`if (Foo* p = f())`).
    pub fn get_condition(&self) -> Option<CppParenExpr> {
        self.child()
    }

    /// The `then` branch.
    pub fn get_then_branch(&self) -> Option<CppStat> {
        self.children::<CppStat>().find(|stat| {
            !matches!(
                CppSyntaxKind::from(stat.syntax().kind()),
                CppSyntaxKind::ElseStat | CppSyntaxKind::ParenExpr
            )
        })
    }

    pub fn get_else_branch(&self) -> Option<CppElseStat> {
        self.child()
    }
}

/// An `else` clause.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppElseStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppElseStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        matches!(kind, CppSyntaxKind::ElseStat | CppSyntaxKind::ElseIfStat)
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppElseStat {
    /// The body of the else clause. For `else if`, this is the nested `if`.
    pub fn get_stat(&self) -> Option<CppStat> {
        self.children().find(|stat: &CppStat| {
            CppSyntaxKind::from(stat.syntax().kind()) != CppSyntaxKind::ParenExpr
        })
    }

    pub fn is_else_if(&self) -> bool {
        CppSyntaxKind::from(self.syntax().kind()) == CppSyntaxKind::ElseIfStat
    }
}

/// A `while` loop.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppWhileStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppWhileStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        kind == CppSyntaxKind::WhileStat
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppWhileStat {
    pub fn get_condition(&self) -> Option<CppParenExpr> {
        self.child()
    }

    pub fn get_body(&self) -> Option<CppStat> {
        self.children().find(|stat: &CppStat| {
            CppSyntaxKind::from(stat.syntax().kind()) != CppSyntaxKind::ParenExpr
        })
    }
}

/// A `do ... while` loop.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppDoWhileStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppDoWhileStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        kind == CppSyntaxKind::DoWhileStat
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppDoWhileStat {
    pub fn get_body(&self) -> Option<CppStat> {
        self.children().find(|stat: &CppStat| {
            CppSyntaxKind::from(stat.syntax().kind()) != CppSyntaxKind::ParenExpr
        })
    }

    pub fn get_condition(&self) -> Option<CppParenExpr> {
        self.child()
    }
}

/// A `for` loop. Check `is_range_for` to tell the two forms apart.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppForStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppForStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        matches!(kind, CppSyntaxKind::ForStat | CppSyntaxKind::RangeForStat)
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppForStat {
    /// Is this `for (decl : range)`?
    pub fn is_range_for(&self) -> bool {
        CppSyntaxKind::from(self.syntax().kind()) == CppSyntaxKind::RangeForStat
    }

    pub fn get_body(&self) -> Option<CppStat> {
        self.children::<CppStat>().find(|stat| {
            !matches!(
                CppSyntaxKind::from(stat.syntax().kind()),
                CppSyntaxKind::ParenExpr
                    | CppSyntaxKind::Declaration
                    | CppSyntaxKind::ExpressionStat
            )
        })
    }
}

/// A `switch` statement.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppSwitchStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppSwitchStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        kind == CppSyntaxKind::SwitchStat
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppSwitchStat {
    pub fn get_condition(&self) -> Option<CppParenExpr> {
        self.child()
    }

    /// The `case` and `default` labels.
    pub fn get_labels(&self) -> Vec<CppStat> {
        self.syntax()
            .children()
            .filter(|node| {
                matches!(
                    CppSyntaxKind::from(node.kind()),
                    CppSyntaxKind::CaseStat | CppSyntaxKind::DefaultStat
                )
            })
            .filter_map(CppStat::cast)
            .collect()
    }
}

/// A `try` block with its handlers.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppTryStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppTryStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        kind == CppSyntaxKind::TryStat
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppTryStat {
    pub fn get_body(&self) -> Option<CppCompoundStat> {
        self.child()
    }

    pub fn get_catch_handlers(&self) -> CppAstChildren<CppCatchStat> {
        self.children()
    }
}

/// A `catch` handler.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppCatchStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppCatchStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        kind == CppSyntaxKind::CatchStat
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppCatchStat {
    pub fn get_param_list(&self) -> Option<CppParamList> {
        self.child()
    }

    pub fn get_body(&self) -> Option<CppCompoundStat> {
        self.child()
    }
}

/// A `return` statement.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppReturnStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppReturnStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        kind == CppSyntaxKind::ReturnStat
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppReturnStat {
    /// The returned expression. `return;` has none.
    pub fn get_expr(&self) -> Option<CppExpr> {
        self.child()
    }
}

/// A `goto` statement.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppGotoStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppGotoStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        kind == CppSyntaxKind::GotoStat
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppGotoStat {
    pub fn get_label(&self) -> Option<CppNameToken> {
        self.token()
    }
}

/// A label: `again:`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppLabelStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppLabelStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        kind == CppSyntaxKind::LabelStat
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppLabelStat {
    pub fn get_label(&self) -> Option<CppNameToken> {
        self.token()
    }
}

/// An expression statement: `f(x);`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppExpressionStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppExpressionStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        kind == CppSyntaxKind::ExpressionStat
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}

impl CppExpressionStat {
    pub fn get_expr(&self) -> Option<CppExpr> {
        self.child()
    }
}

/// A `break` or `continue` statement.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CppJumpStat {
    syntax: CppSyntaxNode,
}

impl CppAstNode for CppJumpStat {
    fn syntax(&self) -> &CppSyntaxNode {
        &self.syntax
    }

    fn can_cast(kind: CppSyntaxKind) -> bool {
        matches!(kind, CppSyntaxKind::BreakStat | CppSyntaxKind::ContinueStat)
    }

    fn cast(syntax: CppSyntaxNode) -> Option<Self> {
        Self::can_cast(syntax.kind().into()).then_some(Self { syntax })
    }
}