zigsyn 0.1.0

A pure Rust Zig syntax scanner and parser.
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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
use std::path::PathBuf;
use std::rc::Rc;

use crate::token::{CommentKind, Keyword, LitKind, Token};

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct File {
    pub path: PathBuf,
    pub line_info: Vec<usize>,
    pub container_docs: Vec<Rc<Comment>>,
    pub members: Vec<ContainerMember>,
    pub comments: Vec<Rc<Comment>>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Comment {
    pub pos: usize,
    pub kind: CommentKind,
    pub text: String,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum ContainerMember {
    Field(Box<ContainerField>),
    Fn(Box<FnDecl>),
    Var(Box<VarDecl>),
    Test(Box<TestDecl>),
    Comptime(Box<ComptimeDecl>),
}

impl ContainerMember {
    pub fn pos(&self) -> usize {
        match self {
            Self::Field(node) => node.pos,
            Self::Fn(node) => node.pos,
            Self::Var(node) => node.pos,
            Self::Test(node) => node.pos,
            Self::Comptime(node) => node.pos,
        }
    }
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ContainerField {
    pub pos: usize,
    pub docs: Vec<Rc<Comment>>,
    pub comptime: bool,
    pub name: Option<Ident>,
    pub ty: Option<Expression>,
    pub align: Option<Expression>,
    pub default: Option<Expression>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct FnDecl {
    pub pos: usize,
    pub docs: Vec<Rc<Comment>>,
    pub visibility: Option<Keyword>,
    pub modifier: Option<FnModifier>,
    pub name: Option<Ident>,
    pub params: Vec<ParamDecl>,
    pub align: Option<Expression>,
    pub addrspace: Option<Expression>,
    pub linksection: Option<Expression>,
    pub callconv: Option<Expression>,
    pub bang: bool,
    pub ret: Option<Box<Expression>>,
    pub body: Option<Block>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct VarDecl {
    pub pos: usize,
    pub docs: Vec<Rc<Comment>>,
    pub visibility: Option<Keyword>,
    pub extern_export: Option<VarModifier>,
    pub threadlocal: bool,
    pub keyword: Keyword,
    pub lhs: Vec<VarProtoOrExpr>,
    pub ty: Option<Expression>,
    pub align: Option<Expression>,
    pub addrspace: Option<Expression>,
    pub linksection: Option<Expression>,
    pub init: Option<Expression>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct TestDecl {
    pub pos: usize,
    pub docs: Vec<Rc<Comment>>,
    pub name: Option<Expression>,
    pub body: Block,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ComptimeDecl {
    pub pos: usize,
    pub docs: Vec<Rc<Comment>>,
    pub block: Block,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Ident {
    pub pos: usize,
    pub name: String,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum VarProtoOrExpr {
    VarProto {
        pos: usize,
        keyword: Keyword,
        name: Ident,
        ty: Option<Expression>,
    },
    Expr(Expression),
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum FnModifier {
    Export,
    Extern(Option<String>),
    Inline,
    NoInline,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum VarModifier {
    Export,
    Extern(Option<String>),
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum Expression {
    Ident(Ident),
    BasicLit(BasicLit),
    MultilineStr(MultilineStr),
    BuiltinCall(BuiltinCall),
    EnumLiteral(EnumLiteral),
    AnonInit(AnonInit),
    ErrorValue(ErrorValue),
    ErrorSetDecl(ErrorSetDecl),
    Grouped(Box<Expression>),
    Unreachable(usize),
    AnyframeType(AnyframeType),
    Unary(UnaryOp),
    Binary(BinaryOp),
    Catch(CatchExpr),
    Assign(AssignExpr),
    If(IfExpr),
    While(WhileExpr),
    For(ForExpr),
    Switch(SwitchExpr),
    Block(Block),
    Break(BreakExpr),
    Continue(ContinueExpr),
    Return(ReturnExpr),
    Comptime(Box<Expression>),
    Nosuspend(Box<Expression>),
    Resume(Box<Expression>),
    Asm(AsmExpr),
    Call(Call),
    Index(Index),
    Slice(Slice),
    FieldAccess(FieldAccess),
    Deref(Deref),
    Unwrap(Unwrap),
    InitList(CurlyInit),
    Optional(OptionalType),
    ErrorUnion(ErrorUnionType),
    Pointer(PointerType),
    SliceType(SliceType),
    ArrayType(ArrayType),
    Container(ContainerDecl),
    FnProto(Box<FnDecl>),
}

impl Expression {
    pub fn pos(&self) -> usize {
        match self {
            Self::Ident(node) => node.pos,
            Self::BasicLit(node) => node.pos,
            Self::MultilineStr(node) => node.pos,
            Self::BuiltinCall(node) => node.pos,
            Self::EnumLiteral(node) => node.pos,
            Self::AnonInit(node) => node.pos,
            Self::ErrorValue(node) => node.pos,
            Self::ErrorSetDecl(node) => node.pos,
            Self::Grouped(expr) => expr.pos(),
            Self::Unreachable(pos) => *pos,
            Self::AnyframeType(node) => node.pos,
            Self::Unary(node) => node.pos,
            Self::Binary(node) => node.pos,
            Self::Catch(node) => node.pos,
            Self::Assign(node) => node.pos,
            Self::If(node) => node.pos,
            Self::While(node) => node.pos,
            Self::For(node) => node.pos,
            Self::Switch(node) => node.pos,
            Self::Block(node) => node.pos,
            Self::Break(node) => node.pos,
            Self::Continue(node) => node.pos,
            Self::Return(node) => node.pos,
            Self::Comptime(expr) => expr.pos(),
            Self::Nosuspend(expr) => expr.pos(),
            Self::Resume(expr) => expr.pos(),
            Self::Asm(node) => node.pos,
            Self::Call(node) => node.pos,
            Self::Index(node) => node.pos,
            Self::Slice(node) => node.pos,
            Self::FieldAccess(node) => node.pos,
            Self::Deref(node) => node.pos,
            Self::Unwrap(node) => node.pos,
            Self::InitList(node) => node.pos,
            Self::Optional(node) => node.pos,
            Self::ErrorUnion(node) => node.pos,
            Self::Pointer(node) => node.pos,
            Self::SliceType(node) => node.pos,
            Self::ArrayType(node) => node.pos,
            Self::Container(node) => node.pos,
            Self::FnProto(node) => node.pos,
        }
    }
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct BasicLit {
    pub pos: usize,
    pub kind: LitKind,
    pub text: String,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct MultilineStr {
    pub pos: usize,
    pub text: String,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct BuiltinCall {
    pub pos: usize,
    pub name: String,
    pub args: Vec<Expression>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct EnumLiteral {
    pub pos: usize,
    pub name: Ident,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct AnonInit {
    pub pos: usize,
    pub fields: Vec<Expression>,
    pub entries: Vec<InitEntry>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ErrorValue {
    pub pos: usize,
    pub name: Ident,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ErrorSetDecl {
    pub pos: usize,
    pub names: Vec<Ident>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum InitEntry {
    Field { name: Ident, value: Expression },
    Expr(Expression),
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct AnyframeType {
    pub pos: usize,
    pub result: Option<Box<Expression>>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct UnaryOp {
    pub pos: usize,
    pub op: Token,
    pub expr: Box<Expression>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct BinaryOp {
    pub pos: usize,
    pub op: Token,
    pub lhs: Box<Expression>,
    pub rhs: Box<Expression>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct CatchExpr {
    pub pos: usize,
    pub lhs: Box<Expression>,
    pub payload: Option<Payload>,
    pub rhs: Box<Expression>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct AssignExpr {
    pub pos: usize,
    pub lhs: Vec<Expression>,
    pub op: Token,
    pub rhs: Box<Expression>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct IfExpr {
    pub pos: usize,
    pub condition: Option<Box<Expression>>,
    pub payload: Option<Payload>,
    pub then_branch: Option<Box<Expression>>,
    pub else_payload: Option<Payload>,
    pub else_branch: Option<Box<Expression>>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct WhileExpr {
    pub pos: usize,
    pub label: Option<Ident>,
    pub inline_: bool,
    pub condition: Option<Box<Expression>>,
    pub payload: Option<Payload>,
    pub continue_expr: Option<Box<Expression>>,
    pub body: Option<Box<Expression>>,
    pub else_payload: Option<Payload>,
    pub else_branch: Option<Box<Expression>>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ForExpr {
    pub pos: usize,
    pub label: Option<Ident>,
    pub inline_: bool,
    pub items: Vec<ForItem>,
    pub payload: Option<Payload>,
    pub body: Option<Box<Expression>>,
    pub else_branch: Option<Box<Expression>>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct SwitchExpr {
    pub pos: usize,
    pub label: Option<Ident>,
    pub target: Option<Box<Expression>>,
    pub prongs: Vec<SwitchProng>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct Block {
    pub pos: usize,
    pub label: Option<Ident>,
    pub statements: Vec<Statement>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct BreakExpr {
    pub pos: usize,
    pub label: Option<Ident>,
    pub value: Option<Box<Expression>>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ContinueExpr {
    pub pos: usize,
    pub label: Option<Ident>,
    pub value: Option<Box<Expression>>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ReturnExpr {
    pub pos: usize,
    pub value: Option<Box<Expression>>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct AsmExpr {
    pub pos: usize,
    pub volatile: bool,
    pub expr: Option<Box<Expression>>,
    pub outputs: Vec<AsmOutput>,
    pub inputs: Vec<AsmInput>,
    pub clobbers: Option<Box<Expression>>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct Call {
    pub pos: usize,
    pub callee: Box<Expression>,
    pub args: Vec<Expression>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct Index {
    pub pos: usize,
    pub expr: Box<Expression>,
    pub index: Box<Expression>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct Slice {
    pub pos: usize,
    pub expr: Box<Expression>,
    pub start: Option<Box<Expression>>,
    pub end: Option<Box<Expression>>,
    pub sentinel: Option<Box<Expression>>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct FieldAccess {
    pub pos: usize,
    pub expr: Box<Expression>,
    pub field: Ident,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct Deref {
    pub pos: usize,
    pub expr: Box<Expression>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct Unwrap {
    pub pos: usize,
    pub expr: Box<Expression>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct CurlyInit {
    pub pos: usize,
    pub ty: Box<Expression>,
    pub entries: Vec<InitEntry>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct OptionalType {
    pub pos: usize,
    pub child: Box<Expression>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ErrorUnionType {
    pub pos: usize,
    pub error: Box<Expression>,
    pub payload: Box<Expression>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct PointerType {
    pub pos: usize,
    pub kind: PointerKind,
    pub modifiers: Vec<PointerModifier>,
    pub child: Box<Expression>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct SliceType {
    pub pos: usize,
    pub sentinel: Option<Box<Expression>>,
    pub modifiers: Vec<PointerModifier>,
    pub child: Box<Expression>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ArrayType {
    pub pos: usize,
    pub len: Box<Expression>,
    pub sentinel: Option<Box<Expression>>,
    pub child: Box<Expression>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ContainerDecl {
    pub pos: usize,
    pub layout: Option<Keyword>,
    pub kind: Keyword,
    pub arg: Option<ContainerArg>,
    pub members: Vec<ContainerMember>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum ContainerArg {
    Expr(Box<Expression>),
    Enum {
        pos: usize,
        tag_type: Option<Box<Expression>>,
        tokens: Vec<Token>,
    },
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum PointerKind {
    One,
    Many,
    C,
    Sentinel(Box<Expression>),
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum PointerModifier {
    Align(Vec<Expression>),
    AddrSpace(Box<Expression>),
    Const,
    Volatile,
    AllowZero,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct AsmOutput {
    pub pos: usize,
    pub name: Ident,
    pub constraint: Expression,
    pub target: AsmOutputTarget,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum AsmOutputTarget {
    Type(Expression),
    Ident(Ident),
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct AsmInput {
    pub pos: usize,
    pub name: Ident,
    pub constraint: Expression,
    pub expr: Expression,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum Statement {
    Var(Box<VarDecl>),
    Defer(Box<DeferStmt>),
    If(Box<IfStmt>),
    Loop(Box<LoopStmt>),
    Switch(Box<SwitchStmt>),
    Suspend(Box<SuspendStmt>),
    Nosuspend(Box<NosuspendStmt>),
    Comptime(Box<ComptimeStmt>),
    Assign(Box<AssignStmt>),
    Expr(Box<ExprStmt>),
    Block(Box<Block>),
}

impl Statement {
    pub fn pos(&self) -> usize {
        match self {
            Self::Var(node) => node.pos,
            Self::Defer(node) => node.pos,
            Self::If(node) => node.pos,
            Self::Loop(node) => node.pos,
            Self::Switch(node) => node.pos,
            Self::Suspend(node) => node.pos,
            Self::Nosuspend(node) => node.pos,
            Self::Comptime(node) => node.pos,
            Self::Assign(node) => node.pos,
            Self::Expr(node) => node.pos,
            Self::Block(node) => node.pos,
        }
    }
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct DeferStmt {
    pub pos: usize,
    pub err: bool,
    pub payload: Option<Payload>,
    pub body: Box<Statement>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct IfStmt {
    pub pos: usize,
    pub condition: Expression,
    pub payload: Option<Payload>,
    pub then_branch: Box<Statement>,
    pub else_payload: Option<Payload>,
    pub else_branch: Option<Box<Statement>>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct LoopStmt {
    pub pos: usize,
    pub label: Option<Ident>,
    pub inline_: bool,
    pub kind: LoopKind,
    pub body: Box<Statement>,
    pub else_payload: Option<Payload>,
    pub else_branch: Option<Box<Statement>>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum LoopKind {
    While {
        condition: Box<Expression>,
        payload: Option<Payload>,
        continue_expr: Option<Box<Expression>>,
    },
    For {
        items: Vec<ForItem>,
        payload: Payload,
    },
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct SwitchStmt {
    pub pos: usize,
    pub label: Option<Ident>,
    pub expr: SwitchExpr,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct SuspendStmt {
    pub pos: usize,
    pub body: Box<Statement>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct NosuspendStmt {
    pub pos: usize,
    pub body: Box<Statement>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ComptimeStmt {
    pub pos: usize,
    pub body: Box<Statement>,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct AssignStmt {
    pub pos: usize,
    pub lhs: Vec<Expression>,
    pub op: Token,
    pub rhs: Expression,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ExprStmt {
    pub pos: usize,
    pub expr: Expression,
    pub semicolon: bool,
    pub tokens: Vec<Token>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct Payload {
    pub pos: usize,
    pub star: bool,
    pub names: Vec<Ident>,
    pub stars: Vec<bool>,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ParamDecl {
    pub pos: usize,
    pub docs: Vec<Rc<Comment>>,
    pub noalias: bool,
    pub comptime: bool,
    pub name: Option<Ident>,
    pub ty: ParamType,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum ParamType {
    AnyType(usize),
    Type(Box<Expression>),
    VarArgs(usize),
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct SwitchProng {
    pub pos: usize,
    pub inline_: bool,
    pub cases: Vec<SwitchItem>,
    pub payload: Option<Payload>,
    pub body: Expression,
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub enum SwitchItem {
    Expr(Box<Expression>),
    Range(Box<Expression>, Box<Expression>),
    Else(usize),
}

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct ForItem {
    pub pos: usize,
    pub expr: Expression,
    pub range: Option<Option<Expression>>,
}

#[cfg(test)]
mod tests {
    use crate::token::Symbol;

    use super::*;

    #[test]
    fn expression_pos_uses_inner_node() {
        let expr = Expression::Binary(BinaryOp {
            pos: 12,
            op: Token::Symbol(Symbol::Plus),
            lhs: Box::new(Expression::Ident(Ident {
                pos: 10,
                name: "a".to_owned(),
            })),
            rhs: Box::new(Expression::BasicLit(BasicLit {
                pos: 14,
                kind: LitKind::Integer,
                text: "1".to_owned(),
            })),
        });

        assert_eq!(expr.pos(), 12);
    }
}