arf/parser/tree.go

package parser

import "git.tebibyte.media/sashakoshka/arf/file"
import "git.tebibyte.media/sashakoshka/arf/types"

// SyntaxTree represents an abstract syntax tree. It covers an entire module. It
// can be expected to be syntactically correct, but it might not be semantically
// correct (because it has not been analyzed yet.)
type SyntaxTree struct {
	license string
	author  string

	requires     []string
	typeSections map[string] *TypeSection
	objtSections map[string] *ObjtSection
	enumSections map[string] *EnumSection
	faceSections map[string] *FaceSection
	dataSections map[string] *DataSection
}

// Identifier represents a chain of arguments separated by a dot.
type Identifier struct {
	location file.Location
	trail    []string
}

// TypeKind represents what kind of type a type is
type TypeKind int

const (
	// TypeKindBasic either means it's a primitive, or it inherits from
	// something.
	TypeKindBasic TypeKind = iota

	// TypeKindPointer means it's a pointer
	TypeKindPointer

	// TypeKindArray means it's an array.
	TypeKindArray
)

// Type represents a type specifier
type Type struct {
	location file.Location

	mutable bool
	kind TypeKind

	// only applicable for arrays. a value of zero means it has an
	// undefined/dynamic length.
	length uint64

	// only applicable for basic.
        name Identifier

	// not applicable for basic.
	points *Type
}

// Declaration represents a variable declaration.
type Declaration struct {
	location file.Location
	name     string
	what     Type
}

// ObjectInitializationValues represents a list of object member initialization
// attributes.
type ObjectInitializationValues struct {
	location   file.Location
	attributes map[string] Argument
}

// ArrayInitializationValues represents a list of attributes initializing an
// array.
type ArrayInitializationValues struct {
	location file.Location
	values   []Argument
}

// Phrase represents a function call or operator. In ARF they are the same
// syntactical concept.
type Phrase struct {
	location  file.Location
	command   Argument
	arguments []Argument
	returnsTo []Argument
}

// ArgumentKind specifies the type of thing the value of an argument should be
// cast to.
type ArgumentKind int

const (
	ArgumentKindNil ArgumentKind = iota
	
	// [name argument]
	// [name argument argument]
	// etc...
	ArgumentKindPhrase = iota

	// {name}
	ArgumentKindDereference
	
	// {name 23}
	ArgumentKindSubscript

	// .name value
	// but like, a lot of them
	ArgumentKindObjectInitializationValues

	// value value...
	ArgumentKindArrayInitializationValues

	// name.name
	// name.name.name
	// etc...
	ArgumentKindIdentifier

	// name:Type
	// name:{Type}
	// name:{Type ..}
	// name:{Type 23}
	// etc...
	ArgumentKindDeclaration

	// -1337
	ArgumentKindInt

	// 1337
	ArgumentKindUInt

	// 0.44
	ArgumentKindFloat

	// "hello world"
	ArgumentKindString

	// 'S'
	ArgumentKindRune

	// + - * / etc...
	// this is only used as a phrase command
	ArgumentKindOperator
)

// Argument represents a value that can be placed anywhere a value goes. This
// allows things like phrases being arguments to other phrases.
type Argument struct {
	location file.Location
	kind     ArgumentKind
	value    any
	// TODO: if there is an argument expansion operator its existence should
	// be stored here in a boolean.
}

// DataSection represents a global variable.
type DataSection struct {
	location file.Location
	name     string
	
	what       Type
	permission types.Permission
	value      Argument
}

// TypeSection represents a blind type definition.
type TypeSection struct {
	location file.Location
	name     string
	
	inherits     Type
	permission   types.Permission
	defaultValue Argument
}

// ObjtMember represents a part of an object type definition.
type ObjtMember struct {
	location file.Location
	name     string

	what         Type
	bitWidth     int
	permission   types.Permission
	defaultValue Argument
}

// ObjtSection represents an object type definition
type ObjtSection struct {
	location file.Location
	name     string

	// TODO: make this Identifier instead of Type
	inherits     Type
	permission   types.Permission
	// TODO: order matters here we need to store these in an array
	// TODO: add bitfield support (:n)
	members      map[string] ObjtMember
}

type EnumMember struct {
	location file.Location
	name     string
	value    Argument
}

// EnumSection represents an enumerated type section.
type EnumSection struct {
	location file.Location
	name     string
	
	what       Type
	permission types.Permission
	members    []EnumMember
}

// FaceBehavior represents a behavior of an interface section.
type FaceBehavior struct {
	location file.Location
	name string

	inputs  []Declaration
	outputs []Declaration
}

// FaceSection represents an interface type section.
type FaceSection struct {
	location file.Location
	name     string
	// TODO: make this Identifier instead of string
	inherits string
	
	permission types.Permission
	behaviors  map[string] FaceBehavior
}