compiler

Documentation

Index

• Constants
• type BaseCompilerError
• type CompiledSchema
  • func Compile(schema InputSchema, prefix ObjectPrefixOption, opts ...Option) (*CompiledSchema, error)
  • func (cs CompiledSchema) SourcePositionToRunePosition(source input.Source, position input.Position) (int, error)
• type DSLNode
• type ErrorWithContext
  • func (ewc ErrorWithContext) DetailsMetadata() map[string]string
  • func (ewc ErrorWithContext) Unwrap() error
• type InputSchema
• type NodeChain
  • func PositionToAstNodeChain(schema *CompiledSchema, source input.Source, position input.Position) (*NodeChain, error)
  • func (nc *NodeChain) FindNodeOfType(nodeType dslshape.NodeType) DSLNode
  • func (nc *NodeChain) ForRunePosition() int
  • func (nc *NodeChain) HasHeadType(nodeType dslshape.NodeType) bool
  • func (nc *NodeChain) Head() DSLNode
  • func (nc *NodeChain) String() string
• type ObjectPrefixOption
  • func AllowUnprefixedObjectType() ObjectPrefixOption
  • func ObjectTypePrefix(prefix string) ObjectPrefixOption
  • func RequirePrefixedObjectType() ObjectPrefixOption
• type Option
  • func SkipValidation() Option
• type SchemaDefinition

Constants

const Ellipsis = "..."

Types

type BaseCompilerError

type BaseCompilerError struct {
	BaseMessage string
	// contains filtered or unexported fields
}

BaseCompilerError defines an error with contains the base message of the issue that occurred.

type CompiledSchema

type CompiledSchema struct {
	// ObjectDefinitions holds the object definitions in the schema.
	ObjectDefinitions []*core.NamespaceDefinition

	// CaveatDefinitions holds the caveat definitions in the schema.
	CaveatDefinitions []*core.CaveatDefinition

	// OrderedDefinitions holds the object and caveat definitions in the schema, in the
	// order in which they were found.
	OrderedDefinitions []SchemaDefinition
	// contains filtered or unexported fields
}

CompiledSchema is the result of compiling a schema when there are no errors.

func Compile

func Compile(schema InputSchema, prefix ObjectPrefixOption, opts ...Option) (*CompiledSchema, error)

Compile compilers the input schema into a set of namespace definition protos.

func (CompiledSchema) SourcePositionToRunePosition

func (cs CompiledSchema) SourcePositionToRunePosition(source input.Source, position input.Position) (int, error)

SourcePositionToRunePosition converts a source position to a rune position.

type DSLNode

type DSLNode interface {
	GetType() dslshape.NodeType
	GetString(predicateName string) (string, error)
	GetInt(predicateName string) (int, error)
	Lookup(predicateName string) (DSLNode, error)
}

DSLNode is a node in the DSL AST.

type ErrorWithContext

type ErrorWithContext struct {
	BaseCompilerError
	SourceRange     input.SourceRange
	Source          input.Source
	ErrorSourceCode string
}

ErrorWithContext defines an error which contains contextual information.

func (ErrorWithContext) DetailsMetadata

func (ewc ErrorWithContext) DetailsMetadata() map[string]string

DetailsMetadata returns the metadata for details for this error.

func (ErrorWithContext) Unwrap

func (ewc ErrorWithContext) Unwrap() error

type InputSchema

type InputSchema struct {
	// Source is the source of the schema being compiled.
	Source input.Source

	// Schema is the contents being compiled.
	SchemaString string
}

InputSchema defines the input for a Compile.

type NodeChain

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

NodeChain is a chain of nodes in the DSL AST.

func PositionToAstNodeChain

func PositionToAstNodeChain(schema *CompiledSchema, source input.Source, position input.Position) (*NodeChain, error)

PositionToAstNodeChain returns the AST node, and its parents (if any), found at the given position in the source, if any.

func (*NodeChain) FindNodeOfType

func (nc *NodeChain) FindNodeOfType(nodeType dslshape.NodeType) DSLNode

FindNodeOfType returns the first node of the given type in the chain, if any.

func (*NodeChain) ForRunePosition

func (nc *NodeChain) ForRunePosition() int

ForRunePosition returns the rune position of the chain.

func (*NodeChain) HasHeadType

func (nc *NodeChain) HasHeadType(nodeType dslshape.NodeType) bool

HasHeadType returns true if the head node of the chain is of the given type.

func (*NodeChain) Head

func (nc *NodeChain) Head() DSLNode

Head returns the head node of the chain.

func (*NodeChain) String

func (nc *NodeChain) String() string

type ObjectPrefixOption

type ObjectPrefixOption func(*config)

func AllowUnprefixedObjectType

func AllowUnprefixedObjectType() ObjectPrefixOption

func ObjectTypePrefix

func ObjectTypePrefix(prefix string) ObjectPrefixOption

func RequirePrefixedObjectType

func RequirePrefixedObjectType() ObjectPrefixOption

type Option

type Option func(*config)

func SkipValidation

func SkipValidation() Option

type SchemaDefinition

type SchemaDefinition interface {
	proto.Message

	GetName() string
}

SchemaDefinition represents an object or caveat definition in a schema.