wazabin-qcode-parser 0.4.0

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct SourcePosition {
    pub offset: usize,
    pub line: usize,
    pub column: usize,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct SourceSpan {
    pub start: SourcePosition,
    pub end: SourcePosition,
}

impl SourceSpan {
    pub fn contains_offset(&self, offset: usize) -> bool {
        self.start.offset <= offset && offset < self.end.offset
    }
}

#[derive(Clone, Debug)]
pub enum Atom {
    /// `{name}` — captures a Rust variable from the surrounding scope.
    External(String),
    /// `%name` — references an SSA instruction result.
    Ssa(String),
    /// `@name` — references a block parameter.
    BlockParam(String),
    /// bare `name` — references a varnode (valid only in pointer positions).
    Varnode(String),
    /// `&name` — takes the address of a varnode.
    AddressOf(String),
    Int(u64),
    /// `true` / `false` — a byte-stored `bool` constant.
    Bool(bool),
}

#[derive(Clone, Debug)]
pub struct TypedAtom {
    pub size_bytes: Option<usize>,
    pub atom: Atom,
    pub span: SourceSpan,
}

/// A direct function reference in textual QCode.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Callee {
    Named(String),
    /// An unresolved pass-local function slot, written `<minted:N>`.
    Minted(u32),
}

#[derive(Clone, Debug)]
pub struct TupleField {
    pub name: Option<String>,
    pub value: TypedAtom,
}

#[derive(Clone, Debug)]
pub enum ExtractField {
    Name(String),
    Index(u64),
}

/// The field selector of a `gep(...)` — by field name or by raw byte offset.
#[derive(Clone, Debug)]
pub enum GepField {
    Name(String),
    Offset(u64),
}

/// The declared type of a struct field: either a scalar of `n` bytes, or a
/// pointer to a named (nominal) struct, written `Foo*`.
#[derive(Clone, Debug)]
pub enum StructFieldType {
    Int(usize),
    StructPtr(String),
}

/// One field of a `type Foo { ... }` declaration. A field named `_` is padding:
/// it advances the running offset by its byte size without naming a slot.
#[derive(Clone, Debug)]
pub struct StructFieldDecl {
    pub name: String,
    pub ty: StructFieldType,
}

impl StructFieldDecl {
    pub fn is_padding(&self) -> bool {
        self.name == "_"
    }
}

/// A nominal struct definition: `type Foo { a: 4, _: 5, b: 2 }`. Field offsets
/// are the running byte sum (padding included); the struct `size` is the total.
#[derive(Clone, Debug)]
pub struct StructDecl {
    pub name: String,
    pub fields: Vec<StructFieldDecl>,
    pub span: SourceSpan,
}

#[derive(Clone, Debug)]
pub enum ExprNode {
    Atom(TypedAtom),
    Unop {
        op: String,
        src: TypedAtom,
    },
    Binary {
        lhs: TypedAtom,
        op: String,
        rhs: TypedAtom,
    },
    Cast {
        op: CastOp,
        size_bytes: usize,
        src: TypedAtom,
    },
    /// `load(space:size, ptr)` — read `size` bytes from address `ptr` in the
    /// named `space`.
    Load {
        space: String,
        size_bytes: usize,
        ptr: TypedAtom,
    },
    /// `store(space:size, ptr <- value)` — write `value` (`size` bytes) to
    /// address `ptr` in the named `space`.
    Store {
        space: String,
        size_bytes: usize,
        ptr: TypedAtom,
        src: TypedAtom,
    },
    FuncCall {
        op: String,
        args: Vec<TypedAtom>,
    },
    /// A pure intrinsic call, e.g. `$rol(%x, %k)`. `name` excludes the `$`.
    Intrinsic {
        name: String,
        args: Vec<TypedAtom>,
    },
    /// `apply lambda(args...)` — value-level application of a pure lambda.
    Apply {
        target: Callee,
        args: Vec<TypedAtom>,
    },
    /// `body <$> src` / `(body c0 c1) <$> src` — an element-wise `map` over the
    /// array `src`. `body` is a named function or an unresolved minted callee;
    /// `captures` are the loop-invariant operands the body closes over.
    Map {
        body: Callee,
        src: TypedAtom,
        captures: Vec<TypedAtom>,
    },
    /// `scanl @body init src` / `scanl (@body c0 c1) init src` — a left-scan over
    /// the array `src`. Named bodies are stored without the `@`; minted bodies
    /// use their explicit placeholder. `init` is the initial accumulator;
    /// `captures` are loop-invariant operands.
    Scan {
        body: Callee,
        init: TypedAtom,
        src: TypedAtom,
        captures: Vec<TypedAtom>,
    },
    /// `pack(a=x, b=y)` — build an aggregate value from its named fields.
    Tuple {
        fields: Vec<TupleField>,
    },
    /// `extract(agg.field)` — project a field out of an aggregate value.
    Extract {
        agg: TypedAtom,
        field: ExtractField,
    },
    /// `gep(base.field)` — compute the address of a struct field (typed, named
    /// pointer arithmetic; no memory access).
    Gep {
        base: TypedAtom,
        field: GepField,
    },
    /// `src[start:end]` — extract the byte range `[start, end)` of `src`. A
    /// missing `start` defaults to 0; a missing `end` defaults to `src`'s width.
    Range {
        src: TypedAtom,
        start: Option<u64>,
        end: Option<u64>,
    },
}

#[derive(Clone, Copy, Debug)]
pub enum CastOp {
    Zext,
    Sext,
    IntToFloat,
    FloatToFloat,
    Trunc,
}

#[derive(Clone, Debug)]
pub struct BlockParamDecl {
    pub name: String,
    pub size_bytes: Option<usize>,
}

/// A branch target or label declaration — either a named label or a block address.
#[derive(Clone, Debug)]
pub enum Label {
    /// A named label such as `<entry>` or `<done @v1 @v2>`. Generates a `BlockId` binding.
    Named {
        name: String,
        /// Block parameters declared on this label (e.g. `@v1`, `@v2:i64`).
        /// Non-empty only when this `Label` appears inside a `LabelDecl`.
        params: Vec<BlockParamDecl>,
        span: SourceSpan,
    },
    /// A numeric address such as `<0x1001>`. Sets the block's address; no binding generated.
    Address { value: u64, span: SourceSpan },
}

impl Label {
    pub fn span(&self) -> &SourceSpan {
        match self {
            Self::Named { span, .. } | Self::Address { span, .. } => span,
        }
    }

    pub fn name(&self) -> Option<&str> {
        match self {
            Self::Named { name, .. } => Some(name),
            Self::Address { .. } => None,
        }
    }
}

/// Per-parameter arguments on a branch edge: `(param_name, value)` in
/// declaration order. Empty unless the edge was written as
/// `goto <block @v1=e1 @v2=e2>`.
pub type BlockArgs = Vec<(String, TypedAtom)>;

/// One `switch` arm: `(case value, target block, arguments on that edge)`.
pub type SwitchCase = (u64, Label, BlockArgs);

#[derive(Clone, Debug)]
pub enum Statement {
    LocalDecl {
        name: String,
        name_span: SourceSpan,
        display_name: String,
        size_bytes: usize,
        span: SourceSpan,
    },
    Assign {
        name: String,
        name_span: SourceSpan,
        expr: ExprNode,
        /// A `Foo*` struct-pointer type declared on the assignment, if any. When
        /// present, the result value is retyped to that struct pointer (used to
        /// seed struct typing in tests). A plain `iN`/`fN` declared type is not
        /// recorded here — it only drives size coercion of the rhs.
        decl_struct_ptr: Option<String>,
        span: SourceSpan,
    },
    Expr(ExprNode),
    LabelDecl {
        label: Label,
        span: SourceSpan,
    },
    Branch {
        target: Label,
        /// Per-parameter arguments: `(param_name, value)` in declaration order.
        /// Non-empty when the branch was written as `goto <block @v1=e1 @v2=e2>`.
        args: BlockArgs,
        span: SourceSpan,
    },
    BranchInd {
        ptr: TypedAtom,
        /// Resolved jump targets, from a `// -> <a>, <b>` edge hint. The indirect
        /// jump's own syntax encodes no successors, so without this the block has
        /// no out-edges.
        targets: Vec<Label>,
        span: SourceSpan,
    },
    /// Multi-way dispatch: `switch %idx { 0x0 => <a>, default => <d> }`.
    Switch {
        scrutinee: TypedAtom,
        /// `(case value, target, per-parameter arguments)` in written order.
        cases: Vec<SwitchCase>,
        /// The `default => <block>` arm, when written.
        default: Option<(Label, BlockArgs)>,
        span: SourceSpan,
    },
    CBranch {
        condition: TypedAtom,
        target: Label,
        target_args: BlockArgs,
        fallthrough: Label,
        fallthrough_args: BlockArgs,
        span: SourceSpan,
    },
    Call {
        target: Callee,
        /// `true` for `tailcall fn ...`, which has no return-edge hint.
        tail: bool,
        /// Arguments passed to the callee, one per inferred callee input, in
        /// order. The name in each pair is the callee's parameter name as
        /// printed (`@r0`, `@arg1`, …); it is decorative and discarded on
        /// lowering, where only the positional atoms matter.
        args: BlockArgs,
        /// The call's return (fall-through) block(s), from a `// -> <ret>` edge
        /// hint. A `call` terminates its block; this records where control resumes
        /// after the callee returns. Empty for a non-returning call.
        targets: Vec<Label>,
        span: SourceSpan,
    },
    CallInd {
        ptr: TypedAtom,
        /// Positional arguments passed to the indirect callee.
        args: Vec<TypedAtom>,
        /// The call's return (fall-through) block(s), from a `// -> <ret>` edge
        /// hint. See [`Statement::Call`].
        targets: Vec<Label>,
        span: SourceSpan,
    },
    Return {
        ptr: TypedAtom,
        value: Option<TypedAtom>,
        span: SourceSpan,
    },
    ReturnValue {
        value: TypedAtom,
        span: SourceSpan,
    },
    /// Bytes that did not decode to a valid instruction; a terminator with no
    /// successors and no operands.
    BadInsn {
        span: SourceSpan,
    },
    Assert {
        condition: TypedAtom,
        span: SourceSpan,
    },
    /// A comment attached to this statement, written as `# text` on the preceding line.
    Commented {
        comment: String,
        inner: Box<Statement>,
    },
}

impl Statement {
    /// Strips any wrapping `Commented` variant and returns the inner statement.
    pub fn inner(&self) -> &Statement {
        match self {
            Self::Commented { inner, .. } => inner.inner(),
            other => other,
        }
    }
}

/// A function declaration (`fn name: <entry> stmts...`).
#[derive(Clone, Debug)]
pub struct FnDecl {
    pub kind: FnKind,
    pub name: String,
    pub name_span: SourceSpan,
    pub span: SourceSpan,
    pub statements: Vec<Statement>,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum FnKind {
    Machine,
    Lambda,
}

/// Top-level program representation. Any leading `type` declarations are
/// collected into `structs`; `kind` is the statement or function body.
#[derive(Clone, Debug)]
pub struct Program {
    pub structs: Vec<StructDecl>,
    pub kind: ProgramKind,
}

#[derive(Clone, Debug)]
pub enum ProgramKind {
    Statements(Vec<Statement>),
    Functions {
        varnodes: Vec<Statement>,
        fns: Vec<FnDecl>,
    },
}