ast.yaml

#
# CEKF - VM supporting amb
# Copyright (C) 2022-2024  Bill Hails
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#

config:
    name: ast
    description: Abstract Syntax Tree structures generated by the parser.
    parserInfo: true
    limited_includes:
    - bigint.h
    - file_id.h


structs:
    AstProg:
        preamble: AstDefinitions
        namespaces: AstNamespaceArray
        body: AstExpressions

    AstNest:
        definitions: AstDefinitions
        expressions: AstExpressions

    AstNamespaceImpl:
        id: file_id
        definitions: AstDefinitions

    AstNamespace:
        symbol: HashSymbol
        reference: index # index into a table of namespace implementations

    AstDefinitions:
        definition: AstDefinition
        next: AstDefinitions

    AstDefine:
        symbol: HashSymbol
        expression: AstExpression

    AstAlias:
        name: HashSymbol
        type: AstType

    AstExprAlias:
        name: HashSymbol
        value: AstExpression

    AstDefMacro:
        name: HashSymbol
        definition: AstAltFunction

    AstTypeDef:
        userType: AstUserType
        typeBody: AstTypeBody

    AstUserType:
        symbol: HashSymbol
        typeSymbols: AstTypeSymbols

    AstTypeSymbols:
        typeSymbol: HashSymbol
        next: AstTypeSymbols

    AstTypeBody:
        typeConstructor: AstTypeConstructor
        next: AstTypeBody

    AstTypeConstructor:
        symbol: HashSymbol
        args: AstTypeConstructorArgs

    AstTypeFunction:
        symbol: AstLookupOrSymbol
        typeList: AstTypeList

    AstTypeList:
        type: AstType
        next: AstTypeList

    AstTypeMap:
        key: HashSymbol
        type: AstType
        next: AstTypeMap

    AstType:
        typeClause: AstTypeClause
        next: AstType

    AstCompositeFunction:
        unsafe: bool = false
        function: AstFunction
        next: AstCompositeFunction

    AstFunction:
        argList: AstArgList
        nest: AstNest

    AstArgList:
        arg: AstArg
        next: AstArgList

    AstTaggedArgList:
        tag: HashSymbol
        arg: AstArg
        next: AstTaggedArgList

    AstAltArgs: # temp struct used by the parser for `fn (...) | (...) { ... }` alternative arguments
        argList: AstArgList
        next: AstAltArgs

    AstAltFunction: # ditto
        altArgs: AstAltArgs
        nest: AstNest

    AstUnpack:
        symbol: AstLookupOrSymbol
        argList: AstArgList

    AstUnpackStruct:
        symbol: AstLookupOrSymbol
        argList: AstTaggedArgList

    AstNamedArg:
        name: HashSymbol
        arg: AstArg

    AstFunCall:
        function: AstExpression
        arguments: AstExpressions

    AstExpressions:
        expression: AstExpression
        next: AstExpressions

    AstLookupSymbol:
        nsid: int
        nsSymbol: HashSymbol
        symbol: HashSymbol

    AstLookup:
        nsid: int
        nsSymbol: HashSymbol
        expression: AstExpression

    AstIff:
        test: AstExpression
        consequent: AstNest
        alternative: AstNest

    AstPrint:
        exp: AstExpression

    AstStruct:
        symbol: AstLookupOrSymbol
        expressions: AstTaggedExpressions

    AstTaggedExpressions:
        tag: HashSymbol
        expression: AstExpression
        next: AstTaggedExpressions

enums:
    AstPosition:
        - PREFIX
        - INFIX
        - POSTFIX

unions:
    AstTypeConstructorArgs:
        list: AstTypeList
        map: AstTypeMap

    AstLookupOrSymbol:
        symbol: HashSymbol
        lookup: AstLookupSymbol

    AstDefinition:
        define: AstDefine
        typeDef: AstTypeDef
        macro: AstDefMacro
        alias: AstAlias
        blank: void_ptr

    AstTypeClause:
        integer: void_ptr
        character: void_ptr
        var: HashSymbol
        typeFunction: AstTypeFunction
        typeTuple: AstTypeList

    AstArg:
        wildcard: void_ptr
        symbol: HashSymbol
        lookup: AstLookupSymbol
        named: AstNamedArg
        unpack: AstUnpack
        unpackStruct: AstUnpackStruct
        number: MaybeBigInt
        character: character
        tuple: AstArgList

    AstExpression:
        back: void_ptr
        wildcard: void_ptr
        alias: AstExprAlias
        funCall: AstFunCall
        lookup: AstLookup
        symbol: HashSymbol
        number: MaybeBigInt
        character: character
        fun: AstCompositeFunction
        nest: AstNest
        iff: AstIff
        print: AstPrint
        tuple: AstExpressions
        env: void_ptr
        structure: AstStruct
        assertion: AstExpression
        error: AstExpression

hashes:
    AstIntTable:
        entries: int

arrays:
    AstNamespaceArray:
        dimension: 1
        entries: AstNamespaceImpl

    AstFileIdArray:
        dimension: 1
        entries: file_id

    AstStringArray:
        dimension: 1
        entries: string

primitives: !include primitives.yaml