tqlgen

type Annotation struct {
	Key    bool         `parser:"  @'@key'"`
	Unique bool         `parser:"| @'@unique'"`
	Card   *CardAnnot   `parser:"| @@"`
	Regex  *RegexAnnot  `parser:"| @@"`
	Values *ValuesAnnot `parser:"| @@"`
	Range  *RangeAnnot  `parser:"| @@"`
}

type AsClause struct {
	Parent string `parser:"'as' @Ident"`
}

type AttrDef struct {
	Name      string       `parser:"'attribute' @Ident ','?"`
	ValueType string       `parser:"'value' @Ident"`
	Annots    []Annotation `parser:"@@*"`
	Semi      string       `parser:"';'"`
}

type AttributeSpec struct {
	// Name is the name of the attribute type.
	Name string
	// ValueType is the base value type of the attribute (string, integer, double, boolean, datetime).
	ValueType string

	// Regex is an optional regular expression constraint for the attribute values.
	Regex string
	// Values is an optional list of allowed values (enumeration constraint).
	Values []string
	// RangeOp is an optional range constraint (e.g., "1..5").
	RangeOp string
}

type CardAnnot struct {
	Expr string `parser:"'@card' '(' @CardExpr ')'"`
}

type EntityClause struct {
	Owns  *OwnsDef  `parser:"  @@"`
	Plays *PlaysDef `parser:"| @@"`
}

type EntityDef struct {
	Name     string         `parser:"'entity' @Ident"`
	Parent   *SubClause     `parser:"@@?"`
	Abstract bool           `parser:"@'@abstract'?"`
	Comma    string         `parser:"','?"`
	Clauses  []EntityClause `parser:"( @@ ( ',' @@ )* )? ';'"`
}

type EntitySpec struct {
	// Name is the name of the entity type.
	Name string
	// Parent is the name of the parent entity type if this is a subtype.
	Parent string
	// Abstract indicates whether the entity type is defined as abstract.
	Abstract bool

	// Owns is a list of attributes owned by this entity type.
	Owns []OwnsSpec
	// Plays is a list of relation roles this entity type can play.
	Plays []PlaysSpec
}

type FunBodyTok struct {
	Tok string `parser:"@(Ident | Keyword | Punct | String | CardExpr | AnnotKW | Var | Arrow | Operator)"`
}

type FunDef struct {
	Name string       `parser:"FunKW @Ident"`
	Body []FunBodyTok `parser:"@@*"`
}

type FunctionSpec struct {
	// Name is the name of the function.
	Name string
	// Parameters is a list of parameters accepted by the function.
	Parameters []ParameterSpec
	// ReturnType is the TypeQL return type of the function.
	ReturnType string
}

type OwnsDef struct {
	Attribute string       `parser:"'owns' @Ident"`
	Annots    []Annotation `parser:"@@*"`
}

type OwnsSpec struct {
	// Attribute is the name of the attribute type being owned.
	Attribute string
	// Key indicates whether this attribute is a key for the owner.
	Key bool
	// Unique indicates whether the attribute value must be unique across all instances.
	Unique bool
	// Card specifies the cardinality of the ownership (e.g., "0..1", "1..5").
	Card string
}

type ParameterSpec struct {
	// Name is the name of the parameter (without the '$' prefix).
	Name string
	// TypeName is the TypeQL type name expected for this parameter.
	TypeName string
}

type ParsedSchema struct {
	// Attributes is a list of all attribute definitions in the schema.
	Attributes []AttributeSpec
	// Entities is a list of all entity definitions in the schema.
	Entities []EntitySpec
	// Relations is a list of all relation definitions in the schema.
	Relations []RelationSpec
	// Functions is a list of all function signatures in the schema.
	Functions []FunctionSpec
	// Structs is a list of all struct definitions in the schema.
	Structs []StructSpec
}

type PlaysDef struct {
	Relation string `parser:"'plays' @Ident"`
	Role     string `parser:"':' @Ident"`
}

type PlaysSpec struct {
	// Relation is the name of the relation type.
	Relation string
	// Role is the name of the role played by the owner within that relation.
	Role string
}

type RangeAnnot struct {
	Expr string `parser:"'@range' '(' @CardExpr ')'"`
}

type RegexAnnot struct {
	Pattern string `parser:"'@regex' '(' @String ')'"`
}

type RelatesDef struct {
	Role     string       `parser:"'relates' @Ident"`
	AsParent *AsClause    `parser:"@@?"`
	Annots   []Annotation `parser:"@@*"`
}

type RelatesSpec struct {
	// Role is the name of the role in the relation.
	Role string
	// AsParent specifies an overridden role from a parent relation type.
	AsParent string
	// Card specifies the cardinality of players allowed for this role.
	Card string
}

type RelationClause struct {
	Relates *RelatesDef `parser:"  @@"`
	Owns    *OwnsDef    `parser:"| @@"`
	Plays   *PlaysDef   `parser:"| @@"`
}

type RelationDef struct {
	Name     string           `parser:"'relation' @Ident"`
	Parent   *SubClause       `parser:"@@?"`
	Abstract bool             `parser:"@'@abstract'?"`
	Comma    string           `parser:"','?"`
	Clauses  []RelationClause `parser:"( @@ ( ',' @@ )* )? ';'"`
}

type RelationSpec struct {
	// Name is the name of the relation type.
	Name string
	// Parent is the name of the parent relation type if this is a subtype.
	Parent string
	// Abstract indicates whether the relation type is defined as abstract.
	Abstract bool

	// Relates is a list of roles involved in this relation.
	Relates []RelatesSpec
	// Owns is a list of attributes owned by this relation type.
	Owns []OwnsSpec
	// Plays is a list of relation roles this relation type can play.
	Plays []PlaysSpec
}

type RenderConfig struct {
	// PackageName is the name of the Go package for the generated code.
	PackageName string
	// ModulePath is the module import path for the 'gotype' package.
	ModulePath string
	// UseAcronyms, if true, applies Go acronym naming conventions (e.g., 'ID' instead of 'Id').
	UseAcronyms bool
	// SkipAbstract, if true, excludes abstract TypeDB types from the generated Go code.
	SkipAbstract bool
	// SchemaVersion is an optional string included in the generated file header.
	SchemaVersion string
}

type SimpleDef struct {
	Attribute *AttrDef     `parser:"  @@"`
	Entity    *EntityDef   `parser:"| @@"`
	Relation  *RelationDef `parser:"| @@"`
	Struct    *StructDefP  `parser:"| @@"`
	Fun       *FunDef      `parser:"| @@"`
}

type StructDefP struct {
	Name   string         `parser:"'struct' @Ident (':' | ',')"`
	Fields []StructFieldP `parser:"@@ (',' @@)* ','? ';'"`
}

type StructFieldP struct {
	FieldName string `parser:"( @Ident 'value' | 'value' @Ident )"`
	ValueType string `parser:"@Ident"`
	Optional  bool   `parser:"@'?'?"`
}

type StructFieldSpec struct {
	// Name is the name of the field.
	Name string
	// ValueType is the TypeQL type of the field's value.
	ValueType string
	// Optional indicates whether the field is marked as optional in the schema.
	Optional bool
}

type StructSpec struct {
	// Name is the name of the struct type.
	Name string
	// Fields is a list of fields defined within the struct.
	Fields []StructFieldSpec
}

type SubClause struct {
	Parent string `parser:"'sub' @Ident"`
}

type TQLFileSimple struct {
	Define      string      `parser:"'define'"`
	Definitions []SimpleDef `parser:"@@*"`
}

type ValuesAnnot struct {
	Values []string `parser:"'@values' '(' @String ( ',' @String )* ')'"`
}