rule

type Builder interface {
	Node

	// Name returns name of rule
	Name() string
	// SetName set rule name
	SetName(string)

	Parameter
	Ranges
	Matrix
	Matcher
	Requirements
}

type Error int8

type Literal struct {
	NodeType
	// contains filtered or unexported fields
}

type Matcher interface {
	Node

	// Pattern returns regexp literal
	// eg: @string='s'/\w+/ => string value must match \w+
	Pattern() string
	SetPattern(string) error
	// Regexp returns compiled regexp
	Regexp() *regexp.Regexp
}

type Matrix interface {
	Node

	// ValueMatrix returns fields enumerated values
	// eg: @int{1,2,3} => int value must in {1,2,3}
	ValueMatrix() [][]*Literal
	AppendValues(...[]*Literal)
}

type Node interface {
	// Type presents rule node type
	Type() NodeType
	// IsNil returns if node is nil
	IsNil() bool
	// Bytes returns formatted node content
	Bytes() []byte
}

type NodeType int8

type Parameter interface {
	Node

	// Parameters returns parameter of rule
	// eg:
	//	@map<@string,@int?> => map value with string key and int value
	//	@string<byte>[10] => string value with max 10 byte length
	//	@string<rune>[10] => string value with max 10 rune length
	//	@slice<@float64<10,4>[-1000.0001,1000.0002]> => slice with float64 with width 10 and precision 4 and between -1000.0001 and 1000.0002
	Parameters() []Node
	AddParameters(...Node)
}

type Ranges interface {
	Node

	Min() (*Literal, bool)
	SetMin(*Literal, bool)
	Max() (*Literal, bool)
	SetMax(*Literal, bool)

	LengthMode() bool
	SetLengthMode(bool)
}

type Requirements interface {
	Node

	// Optional returns if field is optional
	// eg: @string? => optional string value
	Optional() bool
	SetOptional(bool)

	// Defaults returns default value of field
	// eg: @string='abc' => string value defaults is "abc" if not assigned
	Defaults() *Literal
	SetDefaults(*Literal)
}

type Rule interface {
	Node

	// Name returns name of rule
	Name() string
	// Parameters returns parameter of rule
	// eg:
	//	@map<@string,@int?> => map value with string key and int value
	//	@string<byte>[10] => string value with max 10 byte length
	//	@string<rune>[10] => string value with max 10 rune length
	//	@slice<@float64<10,4>[-1000.0001,1000.0002]> => slice with float64 with width 10 and precision 4 and between -1000.0001 and 1000.0002
	Parameters() []Node
	// Min returns range minimum value and exclusive
	// eg: @int(0,10) => min: 0 exclusive: true
	Min() (*Literal, bool)
	// Max returns range maximum value and exclusive
	// eg: @int(0,10] => max: 10 exclusive: false
	Max() (*Literal, bool)
	// LengthMode return if range use LengthMode
	// eg: @string[10] => length of string must be 10
	LengthMode() bool
	// ValueMatrix returns value's enumeration value matrix
	// eg:
	//	@string{A,B,C} value must be A, B or C
	//	@slice<@int>{1,2,3}{4,5,6} slice value must be []int{1,2,3} or []int{4,5,6}
	ValueMatrix() [][]*Literal
	// Pattern returns regexp literal
	// eg: @string='s'/\w+/ => string value must match \w+
	Pattern() string
	// Regexp returns compiled regexp
	Regexp() *regexp.Regexp
	// Optional returns if field is optional
	// eg: @string? => optional string value
	Optional() bool
	// Defaults returns default value of field
	// eg: @string='abc' => string value defaults is "abc" if not assigned
	Defaults() *Literal
}