tlast

type Arithmetic struct {
	Nums []uint32
	Res  uint32
}

type ArithmeticOrType struct {
	IsArith bool
	Arith   Arithmetic
	T       TypeRef // PR of T can also be used for Arith
}

type Combinator struct {
	Builtin           bool
	IsFunction        bool
	Modifiers         []Modifier // TODO - rename to annotations
	Construct         Constructor
	TemplateArguments []TemplateArgument
	Fields            []Field
	TypeDecl          TypeDeclaration
	FuncDecl          TypeRef

	OriginalDescriptor *Combinator // hack - if some replacements were made, original descriptor is saved here
	OriginalOrderIndex int         // declaration order index (needed in TLO generation)

	TemplateArgumentsPR PositionRange // especially useful when 0 arguments
	PR                  PositionRange
	SectionPR           PositionRange // section headers
	AllPR               PositionRange // with all whitespace in file (except sections and last section) accounted for

	CommentBefore string // comment before combinator
	CommentRight  string // comment to the right of combinator
}

type CombinatorField struct {
	Comb       *Combinator
	FieldIndex int
}

type Constructor struct {
	Name       Name
	ID         uint32
	IDExplicit bool // if false, ID is calculated immediately after parsing

	NamePR PositionRange
	IDPR   PositionRange
}

type Field struct {
	FieldName string
	Mask      *FieldMask
	Excl      bool

	IsRepeated  bool
	ScaleRepeat RepeatWithScale
	FieldType   TypeRef

	PR     PositionRange
	PRName PositionRange
	AllPR  PositionRange // with all whitespace in file (except sections and last section) accounted for

	CommentBefore string // comment before field
	CommentRight  string // comment to the right of field
	NewlineRight  bool

	// this is set during type resolution, so the information
	// about argument references not erased from the type
	UsedAsMask     bool
	UsedAsMaskPR   PositionRange
	UsedAsSize     bool
	UsedAsSizePR   PositionRange
	AffectedFields []CombinatorField
}

type FieldMask struct {
	MaskName  string
	BitNumber uint32

	PRName PositionRange
	PRBits PositionRange
}

type LexerLanguage int

type LexerOptions struct {
	AllowBuiltin bool // allows constructor to start from '_' (underscore), used only internally by tlgen
	AllowDirty   bool // allows to use '_' (underscore) as constructor name, will be removed after combined.tl is cleaned up

	LexerLanguage // default value is TL1
}

type Modifier struct {
	Name string
	PR   PositionRange
}

type Name struct {
	Namespace string
	Name      string
}

type OptionalParse[T any] func(tokens tokenIterator, position Position) (state OptionalState, restTokens tokenIterator, result T)

type OptionalState struct {
	StartProcessing bool
	Error           *ParseError
}

type ParseError struct {
	Err error

	Pos PositionRange
	// contains filtered or unexported fields
}

type Position struct {
	// contains filtered or unexported fields
}

type PositionRange struct {
	Outer Position // in lexer, it is empty, in parser set to start of combinator
	Begin Position
	End   Position
}

type RepeatWithScale struct {
	ExplicitScale bool
	Scale         ScaleFactor
	Rep           []Field

	PR PositionRange
}

type ScaleFactor struct {
	IsArith bool
	Arith   Arithmetic
	Scale   string

	PR PositionRange
}

type TL []*Combinator

type TL2Annotation struct {
	Name string
	PR   PositionRange
}

type TL2BracketType struct {
	IndexType TL2TypeArgument
	ArrayType TL2TypeRef

	HasIndex bool

	PR PositionRange
}

type TL2Combinator struct {
	Annotations []TL2Annotation

	TypeDecl TL2TypeDeclaration
	FuncDecl TL2FuncDeclaration

	IsFunction bool

	PR PositionRange

	CommentBefore string
}

type TL2Field struct {
	Name       string
	IsOptional bool
	IsIgnored  bool
	Type       TL2TypeRef

	PR     PositionRange
	PRName PositionRange

	CommentBefore string
	CommentRight  string
}

type TL2File struct {
	Combinators []TL2Combinator
}

type TL2FuncDeclaration struct {
	Name       TL2TypeName
	Magic      uint32
	Arguments  []TL2Field
	ReturnType TL2TypeDefinition

	PR     PositionRange
	PRName PositionRange
	PRID   PositionRange
}

type TL2StructTypeDefinition struct {
	ConstructorFields []TL2Field
	UnionType         TL2UnionType

	IsUnionType bool

	PR PositionRange
}

type TL2TypeApplication struct {
	Name      TL2TypeName
	Arguments []TL2TypeArgument

	PR          PositionRange
	PRName      PositionRange
	PRArguments PositionRange

	// this is part of TL1 support. The hybrid kernel first converts all.
	// type references to the same (TL2) format for type resolution purposes.
	// this field is false for all TL2-originated type references.
	Bare bool
}

type TL2TypeArgument struct {
	Type   TL2TypeRef
	Number uint32

	IsNumber bool

	PR PositionRange

	// this is set during type resolution, so the information
	// about argument references not erased from the type
	// TODO - decide on moving into TL2TypeRef when working on C++ gen
	OriginalArgumentName string
}

type TL2TypeCategory struct {
	IsNatValue bool
}

type TL2TypeDeclaration struct {
	Name              TL2TypeName
	Magic             uint32
	TemplateArguments []TL2TypeTemplate
	Type              TL2TypeDefinition

	// TODO -TemplateArgumentsPR
	PR     PositionRange
	PRName PositionRange
	PRID   PositionRange
}

type TL2TypeDefinition struct {
	StructType TL2StructTypeDefinition
	TypeAlias  TL2TypeRef

	IsTypeAlias bool

	PR PositionRange
}

type TL2TypeName struct {
	Namespace string
	Name      string
}

type TL2TypeRef struct {
	SomeType    TL2TypeApplication
	BracketType *TL2BracketType

	PR PositionRange
}

type TL2TypeTemplate struct {
	Name     string
	Category TL2TypeCategory

	PR         PositionRange
	PRName     PositionRange
	PRCategory PositionRange
}

type TL2UnionConstructor struct {
	Name string

	Fields    []TL2Field
	TypeAlias TL2TypeRef

	IsTypeAlias bool

	PR     PositionRange
	PRName PositionRange

	CommentBefore string
}

type TL2UnionType struct {
	Variants []TL2UnionConstructor // at least 1

	PR PositionRange
}

type TemplateArgument struct {
	FieldName string
	IsNat     bool
	PR        PositionRange // TODO - split into type and name
}

type TypeDeclaration struct {
	Name      Name
	Arguments []string

	PR          PositionRange
	NamePR      PositionRange
	ArgumentsPR []PositionRange
}

type TypeRef struct {
	Type Name
	Args []ArithmeticOrType
	Bare bool

	PR     PositionRange
	PRArgs PositionRange
}