swamp_ast/
lib.rs

1/*
2 * Copyright (c) Peter Bjorklund. All rights reserved. https://github.com/swamp/swamp
3 * Licensed under the MIT License. See LICENSE in the project root for license information.
4 */
5pub mod prelude;
6
7use std::fmt;
8use std::fmt::{Debug, Formatter};
9use std::hash::Hash;
10
11#[derive(PartialEq, Eq, Hash, Default, Clone)]
12pub struct SpanWithoutFileId {
13    pub offset: u32,
14    pub length: u16,
15}
16
17impl Debug for SpanWithoutFileId {
18    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
19        write!(f, "<{}:{}>", self.offset, self.length)
20    }
21}
22
23// Common metadata that can be shared across all AST nodes
24#[derive(PartialEq, Eq, Hash, Default, Clone)]
25pub struct Node {
26    pub span: SpanWithoutFileId,
27    // TODO: Add comments and attributes
28}
29
30impl Debug for Node {
31    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
32        write!(f, "{:?}", self.span)
33    }
34}
35
36/// Identifiers ================
37#[derive(Debug, PartialEq, Eq, Clone, Hash)]
38pub struct QualifiedTypeIdentifier {
39    pub name: LocalTypeIdentifier,
40    pub module_path: Option<ModulePath>,
41    pub generic_params: Vec<GenericParameter>,
42}
43
44impl QualifiedTypeIdentifier {
45    #[must_use]
46    pub fn new(name: LocalTypeIdentifier, module_path: Vec<Node>) -> Self {
47        let module_path = if module_path.is_empty() {
48            None
49        } else {
50            Some(ModulePath(module_path))
51        };
52
53        Self {
54            name,
55            module_path,
56            generic_params: Vec::new(),
57        }
58    }
59
60    #[must_use]
61    pub fn new_with_generics(
62        name: LocalTypeIdentifier,
63        module_path: Vec<Node>,
64        generic_params: Vec<GenericParameter>,
65    ) -> Self {
66        let module_path = if module_path.is_empty() {
67            None
68        } else {
69            Some(ModulePath(module_path))
70        };
71
72        Self {
73            name,
74            module_path,
75            generic_params,
76        }
77    }
78}
79
80#[derive(Debug, PartialEq, Eq, Hash, Clone)]
81pub struct QualifiedIdentifier {
82    pub name: Node,
83    pub module_path: Option<ModulePath>,
84    pub generic_params: Vec<GenericParameter>,
85}
86
87impl QualifiedIdentifier {
88    #[must_use]
89    pub fn new(name: Node, module_path: Vec<Node>) -> Self {
90        let module_path = if module_path.is_empty() {
91            None
92        } else {
93            Some(ModulePath(module_path))
94        };
95
96        Self {
97            name,
98            module_path,
99            generic_params: vec![],
100        }
101    }
102
103    #[must_use]
104    pub fn new_with_generics(
105        name: Node,
106        module_path: Vec<Node>,
107        generic_params: Vec<GenericParameter>,
108    ) -> Self {
109        let module_path = if module_path.is_empty() {
110            None
111        } else {
112            Some(ModulePath(module_path))
113        };
114
115        Self {
116            name,
117            module_path,
118            generic_params,
119        }
120    }
121}
122
123#[derive(Debug, PartialEq, Eq, Hash, Default, Clone)]
124pub struct LocalTypeIdentifier(pub Node);
125
126impl LocalTypeIdentifier {
127    #[must_use]
128    pub const fn new(node: Node) -> Self {
129        Self(node)
130    }
131}
132
133#[derive(Debug, PartialEq, Eq, Hash, Default, Clone)]
134pub struct TypeVariable(pub Node);
135
136#[derive(Debug, PartialEq, Eq, Hash, Default, Clone)]
137pub struct LocalTypeIdentifierWithOptionalTypeVariables {
138    pub name: Node,
139    pub type_variables: Vec<TypeVariable>,
140}
141
142#[derive(PartialEq, Eq, Hash, Debug, Clone)]
143pub struct LocalIdentifier(pub Node);
144
145impl LocalIdentifier {
146    #[must_use]
147    pub const fn new(node: Node) -> Self {
148        Self(node)
149    }
150}
151
152#[derive(Debug, PartialEq, Eq, Hash, Default, Clone)]
153pub struct LocalConstantIdentifier(pub Node);
154
155#[derive(Debug, PartialEq, Eq, Clone, Hash)]
156pub struct QualifiedConstantIdentifier {
157    pub name: Node,
158    pub module_path: Option<ModulePath>,
159}
160
161impl QualifiedConstantIdentifier {
162    #[must_use]
163    pub const fn new(name: Node, module_path: Option<ModulePath>) -> Self {
164        Self { name, module_path }
165    }
166}
167
168#[derive(Debug, Eq, Hash, Clone, PartialEq)]
169pub struct FieldName(pub Node);
170
171#[derive(Debug, Eq, Hash, PartialEq, Clone)]
172pub struct ModulePath(pub Vec<Node>);
173
174impl Default for ModulePath {
175    fn default() -> Self {
176        Self::new()
177    }
178}
179
180impl ModulePath {
181    #[must_use]
182    pub const fn new() -> Self {
183        Self(vec![])
184    }
185}
186
187#[derive(Debug, Clone)]
188pub enum ImportItem {
189    Identifier(LocalIdentifier),
190    Type(LocalTypeIdentifier),
191}
192
193#[derive(Debug, Clone)]
194pub enum ImportItems {
195    Nothing,
196    Items(Vec<ImportItem>),
197    All,
198}
199
200#[derive(Debug, Clone)]
201pub struct Mod {
202    pub module_path: ModulePath,
203    pub items: ImportItems,
204}
205
206#[derive(Debug, Clone)]
207pub struct Use {
208    pub module_path: ModulePath,
209    pub items: ImportItems,
210}
211
212#[derive(Debug, Eq, Clone, PartialEq)]
213pub struct AliasType {
214    pub identifier: LocalTypeIdentifier,
215    pub referenced_type: Type,
216}
217
218#[derive(Debug, Eq, PartialEq, Hash, Clone, Default)]
219pub struct AnonymousStructType {
220    pub fields: Vec<StructTypeField>,
221}
222
223impl AnonymousStructType {
224    #[must_use]
225    pub const fn new(fields: Vec<StructTypeField>) -> Self {
226        Self { fields }
227    }
228}
229
230#[derive(Debug, Clone)]
231pub struct ConstantInfo {
232    pub constant_identifier: LocalConstantIdentifier,
233    pub annotation: Option<Type>,
234    pub expression: Box<Expression>,
235}
236
237#[derive(Debug, Clone)]
238pub struct NamedStructDef {
239    pub identifier: LocalTypeIdentifierWithOptionalTypeVariables,
240    pub struct_type: AnonymousStructType,
241}
242
243#[derive(Debug, Clone)]
244pub enum DefinitionKind {
245    AliasDef(AliasType),
246    NamedStructDef(NamedStructDef),
247    EnumDef(
248        LocalTypeIdentifierWithOptionalTypeVariables,
249        Vec<EnumVariantType>,
250    ),
251    FunctionDef(Function),
252    ImplDef(LocalTypeIdentifierWithOptionalTypeVariables, Vec<Function>),
253    Mod(Mod),
254    Use(Use),
255    // Other
256    Constant(ConstantInfo),
257}
258
259#[derive(Debug, Clone)]
260pub struct Definition {
261    pub node: Node,
262    pub kind: DefinitionKind,
263    pub attributes: Vec<Attribute>,
264}
265
266#[derive(Debug, Clone)]
267pub struct ForVar {
268    pub identifier: Node,
269    pub is_mut: Option<Node>,
270}
271
272#[derive(Debug, Clone)]
273pub enum ForPattern {
274    Single(ForVar),
275    Pair(ForVar, ForVar),
276}
277
278impl ForPattern {
279    #[must_use]
280    pub const fn is_key_variable_mut(&self) -> bool {
281        match self {
282            Self::Single(_a) => false,
283            Self::Pair(a, _b) => a.is_mut.is_some(),
284        }
285    }
286    #[must_use]
287    pub fn is_value_mut(&self) -> Option<Node> {
288        match self {
289            Self::Single(a) => a.is_mut.clone(),
290            Self::Pair(a, b) => {
291                assert!(
292                    a.is_mut.is_none(),
293                    "key target var is not allowed to be mut"
294                );
295                b.is_mut.clone()
296            }
297        }
298    }
299}
300
301#[derive(Debug, Clone)]
302pub struct IterableExpression {
303    pub expression: Box<Expression>,
304}
305
306#[derive(Clone, Eq, PartialEq)]
307pub struct Variable {
308    pub name: Node,
309    pub is_mutable: Option<Node>,
310}
311
312#[derive(Debug, Clone)]
313pub struct VariableBinding {
314    pub variable: Variable,
315    pub expression: Option<Expression>,
316}
317
318impl Variable {
319    #[must_use]
320    pub const fn new(name: Node, is_mutable: Option<Node>) -> Self {
321        Self { name, is_mutable }
322    }
323}
324
325// Since this is a helper struct, we want to implement the debug output for it
326// to have it more concise
327impl Debug for Variable {
328    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
329        if let Some(found) = &self.is_mutable {
330            write!(f, "mut {found:?} {:?}", self.name)
331        } else {
332            write!(f, "{:?}", self.name)
333        }
334    }
335}
336
337#[derive(Debug, Eq, Clone, PartialEq)]
338pub struct Parameter {
339    pub variable: Variable,
340    pub param_type: Type,
341}
342
343#[derive(Debug, Clone)]
344pub struct FunctionDeclaration {
345    pub name: Node,
346    pub params: Vec<Parameter>,
347    pub self_parameter: Option<SelfParameter>,
348    pub return_type: Option<Type>,
349}
350
351#[derive(Debug, Clone)]
352pub struct FunctionWithBody {
353    pub attributes: Vec<Attribute>,
354    pub declaration: FunctionDeclaration,
355    pub body: Expression,
356}
357
358#[derive(Debug, Clone)]
359pub enum Function {
360    Internal(FunctionWithBody),
361    External(Node, FunctionDeclaration),
362}
363
364impl Function {
365    #[must_use]
366    pub const fn node(&self) -> &Node {
367        match self {
368            Self::Internal(func_with_body) => &func_with_body.body.node,
369            Self::External(node, _) => node,
370        }
371    }
372}
373
374#[derive(Debug, Clone)]
375pub struct SelfParameter {
376    pub is_mutable: Option<Node>,
377    pub self_node: Node,
378}
379
380#[derive(Debug, PartialEq, Eq)]
381pub enum AssignmentOperatorKind {
382    Compound(CompoundOperatorKind),
383    Assign, // =
384}
385
386#[derive(Debug, PartialEq, Eq, Clone)]
387pub enum CompoundOperatorKind {
388    Add,    // +=
389    Sub,    // -=
390    Mul,    // *=
391    Div,    // /=
392    Modulo, // %=
393}
394
395#[derive(Debug, Clone)]
396pub struct CompoundOperator {
397    pub node: Node,
398    pub kind: CompoundOperatorKind,
399}
400
401#[derive(Debug, Clone)]
402pub enum RangeMode {
403    Inclusive,
404    Exclusive,
405}
406
407#[derive(Clone)]
408pub struct Expression {
409    pub kind: ExpressionKind,
410    pub node: Node,
411}
412
413impl Debug for Expression {
414    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), fmt::Error> {
415        write!(f, "{:?}{:?}", self.node.span, self.kind)
416    }
417}
418
419#[derive(Debug, Clone)]
420pub enum Postfix {
421    FieldAccess(Node),
422    Subscript(Expression),
423    MemberCall(Node, Option<Vec<GenericParameter>>, Vec<Expression>),
424    FunctionCall(Node, Option<Vec<GenericParameter>>, Vec<Expression>),
425    OptionalChainingOperator(Node),     // ?-postfix
426    SubscriptTuple(Expression, Expression),
427}
428
429#[derive(Debug, Clone)]
430pub struct PostfixChain {
431    pub base: Box<Expression>,
432    pub postfixes: Vec<Postfix>,
433}
434
435#[derive(Debug, Clone)]
436pub enum ExpressionKind {
437    // Access
438    PostfixChain(PostfixChain),
439
440    // References
441    ContextAccess, // Context/Lone/Bare-dot. TODO: Not implemented yet.
442    VariableReference(Variable),
443    ConstantReference(QualifiedConstantIdentifier),
444    StaticMemberFunctionReference(QualifiedTypeIdentifier, Node),
445    IdentifierReference(QualifiedIdentifier),
446
447    // Assignments
448    VariableDefinition(Variable, Option<Type>, Box<Expression>),
449    VariableAssignment(Variable, Box<Expression>),
450    Assignment(Box<Expression>, Box<Expression>),
451    CompoundAssignment(Box<Expression>, CompoundOperator, Box<Expression>),
452    DestructuringAssignment(Vec<Variable>, Box<Expression>),
453
454    // Operators
455    BinaryOp(Box<Expression>, BinaryOperator, Box<Expression>),
456    UnaryOp(UnaryOperator, Box<Expression>),
457
458    // Blocks
459    Block(Vec<Expression>),
460    With(Vec<VariableBinding>, Box<Expression>),
461    When(
462        Vec<VariableBinding>,
463        Box<Expression>,
464        Option<Box<Expression>>,
465    ),
466
467    // Control flow
468    ForLoop(ForPattern, IterableExpression, Box<Expression>),
469    WhileLoop(Box<Expression>, Box<Expression>),
470
471    // Compare and Matching
472    If(Box<Expression>, Box<Expression>, Option<Box<Expression>>),
473    Match(Box<Expression>, Vec<MatchArm>),
474    Guard(Vec<GuardExpr>),
475
476    InterpolatedString(Vec<StringPart>),
477
478    // Literals
479    AnonymousStructLiteral(Vec<FieldExpression>, bool),
480    NamedStructLiteral(QualifiedTypeIdentifier, Vec<FieldExpression>, bool),
481    Range(Box<Expression>, Box<Expression>, RangeMode),
482    Literal(LiteralKind),
483
484    Lambda(Vec<Variable>, Box<Expression>),
485    Error, // Something was wrong in parsing
486}
487
488#[derive(Debug, Clone)]
489pub struct MatchArm {
490    pub pattern: Pattern,
491    pub expression: Expression,
492}
493
494// TODO: Add literals for Codepoint and Byte
495#[derive(Debug, Clone)]
496pub enum LiteralKind {
497    Int,
498    Float,
499    String(String),
500    Bool,
501    EnumVariant(EnumVariantLiteral),
502    Tuple(Vec<Expression>),
503    InternalInitializerList(Vec<Expression>),
504    InternalInitializerPairList(Vec<(Expression, Expression)>),
505    None,
506}
507
508#[derive(Debug, Clone)]
509pub struct FieldExpression {
510    pub field_name: FieldName,
511    pub expression: Expression,
512}
513
514#[derive(Debug, Eq, Hash, Clone, PartialEq)]
515pub struct StructTypeField {
516    pub field_name: FieldName,
517    pub field_type: Type,
518}
519
520#[derive(Debug, Clone)]
521pub enum EnumVariantLiteral {
522    Simple(QualifiedTypeIdentifier, LocalTypeIdentifier),
523    Tuple(
524        QualifiedTypeIdentifier,
525        LocalTypeIdentifier,
526        Vec<Expression>,
527    ),
528    Struct(
529        QualifiedTypeIdentifier,
530        LocalTypeIdentifier,
531        Vec<FieldExpression>,
532        bool,
533    ),
534}
535
536impl EnumVariantLiteral {
537    #[must_use]
538    pub const fn node(&self) -> &Node {
539        match self {
540            Self::Tuple(ident, _, _) | Self::Struct(ident, _, _, _) | Self::Simple(ident, _) => {
541                &ident.name.0
542            }
543        }
544    }
545}
546
547#[derive(Debug, Clone)]
548pub enum EnumVariantType {
549    Simple(Node),
550    Direct(Node, Type),
551    Tuple(Node, Vec<Type>),
552    Struct(Node, AnonymousStructType),
553}
554
555#[derive(Debug, PartialEq, Eq, Clone, Hash)]
556pub struct TypeForParameter {
557    pub ast_type: Type,
558    pub is_mutable: bool,
559}
560
561#[derive(Debug, Clone, PartialEq, Eq, Hash)]
562pub enum GenericParameter {
563    Type(Type),
564    UnsignedInt(Node),
565    UnsignedTupleInt(Node, Node),
566}
567
568impl GenericParameter {
569    #[must_use]
570    pub fn get_unsigned_int_node(&self) -> &Node {
571        let Self::UnsignedInt(node) = self else {
572            panic!("wasn't unsigned int")
573        };
574        node
575    }
576
577    #[must_use]
578    pub fn get_unsigned_int_tuple_nodes(&self) -> (&Node, &Node) {
579        let Self::UnsignedTupleInt(first, second) = self else {
580            panic!("wasn't unsigned int tuple")
581        };
582        (first, second)
583    }
584}
585
586impl GenericParameter {
587    #[must_use]
588    pub fn get_type(&self) -> &Type {
589        let Self::Type(ty) = self else {
590            panic!("{}", format!("wasn't type {self:?}"))
591        };
592        ty
593    }
594}
595
596#[derive(Debug, PartialEq, Eq, Clone, Hash)]
597pub enum Type {
598    // Composite
599    FixedCapacityArray(Box<Type>, Node),          // `[T; N]`
600    Slice(Box<Type>), // `[T]`. Contiguous memory segments without ownership, Unsized Type (DST) that has inline data
601    FixedCapacityMap(Box<Type>, Box<Type>, Node), // `[K:V;N]`
602    DynamicLengthMap(Box<Type>, Box<Type>), // `[K:V]`
603
604    AnonymousStruct(AnonymousStructType),
605    Unit,
606    Tuple(Vec<Type>),
607    Function(Vec<TypeForParameter>, Box<Type>),
608
609    Named(QualifiedTypeIdentifier),
610
611    Optional(Box<Type>, Node),
612}
613
614#[derive(Debug, Clone)]
615pub struct BinaryOperator {
616    pub kind: BinaryOperatorKind,
617    pub node: Node,
618}
619
620// Takes a left and right side expression
621#[derive(Debug, Clone, PartialEq)]
622pub enum BinaryOperatorKind {
623    Add,
624    Subtract,
625    Multiply,
626    Divide,
627    Modulo,
628    LogicalOr,
629    LogicalAnd,
630    Equal,
631    NotEqual,
632    LessThan,
633    LessEqual,
634    GreaterThan,
635    GreaterEqual,
636    NoneCoalescingOperator,
637}
638
639// Only takes one expression argument
640#[derive(Debug, Clone)]
641pub enum UnaryOperator {
642    Not(Node),
643    Negate(Node),
644    BorrowMutRef(Node),
645}
646
647#[derive(Debug, Clone)]
648pub struct GuardExpr {
649    pub clause: GuardClause,
650    pub result: Expression,
651}
652
653#[derive(Debug, Clone)]
654pub enum GuardClause {
655    Wildcard(Node),
656    Expression(Expression),
657}
658
659// Patterns are used in matching and destructuring
660#[derive(Debug, Clone)]
661pub enum Pattern {
662    Wildcard(Node),
663    ConcretePattern(Node, ConcretePattern, Option<GuardClause>),
664}
665
666#[derive(Debug, Clone)]
667pub enum ConcretePattern {
668    EnumPattern(Node, DestructuringPattern), // VariantName <destructuring>
669    Literal(LiteralKind),                    // 42 or "hello" or 2.42
670}
671
672#[derive(Debug, Clone)]
673pub enum PatternVariableOrWildcard {
674    Variable(Variable),
675    Wildcard(Node),
676}
677
678// Which destructuring to use, or none
679#[derive(Debug, Clone)]
680pub enum DestructuringPattern {
681    /// A struct-like variant: `Variant { field, .. }`
682    Struct { fields: Vec<Variable> },
683
684    /// A tuple-like variant: `Variant(item, ..)`
685    Tuple {
686        elements: Vec<PatternVariableOrWildcard>,
687    },
688
689    /// A single payload variable: `Some(payload)` or `Ok(value)`
690    None { variable: Variable },
691
692    /// A unit variant with no payload: `Red`, `Green`, `Blue`
693    Unit,
694}
695
696#[derive(Debug, Clone)]
697pub enum StringPart {
698    Literal(Node, String),
699    Interpolation(Box<Expression>, Option<FormatSpecifier>),
700}
701
702// TODO: Implement them again
703// with a to_format() call or similar.
704#[derive(Debug, Clone)]
705pub enum FormatSpecifier {
706    LowerHex(Node),                      // :x
707    UpperHex(Node),                      // :X
708    Binary(Node),                        // :b
709    Float(Node),                         // :f
710    Precision(u32, Node, PrecisionType), // :..2f or :..5s
711}
712
713#[derive(Debug, Clone)]
714pub enum PrecisionType {
715    Float(Node),
716    String(Node),
717}
718
719#[derive(Debug, Clone)]
720pub enum AttributeArg {
721    /// A path/identifier, e.g. `Debug` or `unix`
722    Path(QualifiedIdentifier),
723    /// A literal value, e.g. `"foo"`, `42`, `true`
724    Literal(AttributeValue),
725    /// A function call, e.g. `any(unix, windows)` or `rename = "foo"`
726    Function(QualifiedIdentifier, Vec<AttributeArg>),
727}
728
729#[derive(Debug, Clone)]
730pub enum AttributeLiteralKind {
731    Int,
732    String(String),
733    Bool,
734}
735
736#[derive(Debug, Clone)]
737pub enum AttributeValue {
738    Literal(Node, AttributeLiteralKind),
739    Path(QualifiedIdentifier),
740    Function(QualifiedIdentifier, Vec<AttributeArg>),
741}
742
743#[derive(Debug, Clone)]
744pub struct Attribute {
745    pub is_inner: bool,
746    pub path: QualifiedIdentifier,
747    pub args: Vec<AttributeArg>,
748    pub node: Node,
749}
750
751#[derive()]
752pub struct Module {
753    pub expression: Option<Expression>,
754    pub definitions: Vec<Definition>,
755}
756
757impl Debug for Module {
758    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
759        for definition in &self.definitions {
760            writeln!(f, "{definition:?}")?;
761        }
762
763        if !self.definitions.is_empty() && self.expression.is_some() {
764            writeln!(f, "---")?;
765        }
766
767        if let Some(found_expression) = &self.expression {
768            match &found_expression.kind {
769                ExpressionKind::Block(expressions) => {
770                    for expression in expressions {
771                        writeln!(f, "{expression:?}")?;
772                    }
773                }
774                _ => writeln!(f, "{found_expression:?}")?,
775            }
776        }
777
778        Ok(())
779    }
780}
781
782impl Module {
783    #[must_use]
784    pub const fn new(definitions: Vec<Definition>, expression: Option<Expression>) -> Self {
785        Self {
786            expression,
787            definitions,
788        }
789    }
790
791    #[must_use]
792    pub const fn expression(&self) -> &Option<Expression> {
793        &self.expression
794    }
795
796    #[must_use]
797    pub const fn definitions(&self) -> &Vec<Definition> {
798        &self.definitions
799    }
800
801    #[must_use]
802    pub fn imports(&self) -> Vec<&Use> {
803        let mut use_items = Vec::new();
804
805        for def in &self.definitions {
806            if let DefinitionKind::Use(use_info) = &def.kind {
807                use_items.push(use_info);
808            }
809        }
810
811        use_items
812    }
813}
swamp_ast/lib.rs

swamp_ast/
lib.rs
