compiler

Documentation

Index

• Constants
• func Pretty(pretty bool) func(*Grammar) error
• func Size(size int) func(*Grammar) error
• type ArrayExpr
  • func (a ArrayExpr) ToGoAST() dst.Expr
  • func (a ArrayExpr) ToGoValue() []interface{}
• type Compiler
  • func NewCompiler(file string) *Compiler
  • func (c *Compiler) Compile() *dst.File
  • func (c *Compiler) Load() error
  • func (c *Compiler) PackageResources() error
  • func (c *Compiler) Validate() error
• type FunctionExpr
  • func (f *FunctionExpr) ToGoAST() dst.Expr
  • func (f *FunctionExpr) ToGoValue() []interface{}
• type Grammar
  • func (t *Grammar) AST() *node32
  • func (t *Grammar) Add(rule pegRule, begin, end, index uint32)
  • func (p *Grammar) Init(options ...func(*Grammar) error) error
  • func (g *Grammar) LoadUAST()
  • func (p *Grammar) Parse(rule ...int) error
  • func (t *Grammar) PrettyPrintSyntaxTree(buffer string)
  • func (t *Grammar) Print()
  • func (p *Grammar) PrintSyntaxTree()
  • func (p *Grammar) Reset()
  • func (p *Grammar) SprintSyntaxTree() string
  • func (t *Grammar) Tokens() []token32
  • func (t *Grammar) Trim(length uint32)
  • func (p *Grammar) WriteSyntaxTree(w io.Writer)
• type NumberExpr
  • func (n *NumberExpr) ToGoAST() dst.Expr
  • func (n *NumberExpr) ToGoValue() interface{}
• type ObjectExpr
  • func (o ObjectExpr) ToGoAST() dst.Expr
  • func (o ObjectExpr) ToGoValue() map[string]interface{}
• type PairExpr
• type TaskExpr
• type Type
• type UAST
  • func NewUAST() *UAST
• type ValueExpr
  • func (v *ValueExpr) Equal(other *ValueExpr) bool
  • func (v *ValueExpr) ToGoAST() dst.Expr
  • func (v *ValueExpr) ToGoValue() interface{}
  • func (v *ValueExpr) Type() Type

Constants

const (
	UnknownType = iota
	ArrayType
	BoolType
	FunctionType
	NumberType
	ObjectType
	StringType
)

Functions

func Pretty

func Pretty(pretty bool) func(*Grammar) error

func Size

func Size(size int) func(*Grammar) error

Types

type ArrayExpr

type ArrayExpr []*ValueExpr

func (ArrayExpr) ToGoAST

func (a ArrayExpr) ToGoAST() dst.Expr

func (ArrayExpr) ToGoValue

func (a ArrayExpr) ToGoValue() []interface{}

type Compiler

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

func NewCompiler

func NewCompiler(file string) *Compiler

func (*Compiler) Compile

func (c *Compiler) Compile() *dst.File

Compile returns a `*dst.File` which can be formatted into Go using `go/format` or `go/printer`. The Load() method must be called before this.

func (*Compiler) Load

func (c *Compiler) Load() error

Load the compiler's playbook file and parse it into the Unobin AST or return an error.

func (*Compiler) PackageResources

func (c *Compiler) PackageResources() error

PackageResources bundles files from a playbook's resources directory into a file called resources.go using github.com/go-bindata/go-bindata.

func (*Compiler) Validate

func (c *Compiler) Validate() error

Validate checks for errors not caught by the parser. For example, the parser only knows that attributes should be pairs of string -> value, but does not enforce the underlying type required for the value. This function ensures that:

• Required attributes are present: name, description, imports, and input-schema, and that they are the correct type.
• Imports are defined as an object with string keys and string values, and that the import paths are correctly formatted. TODO: check that module exists on the given path.
• The input schema is a valid JSON schema.
• Tasks refer only to modules that are defined in imports.

type FunctionExpr

type FunctionExpr struct {
	Name string
	Args ArrayExpr
}

func (*FunctionExpr) ToGoAST

func (f *FunctionExpr) ToGoAST() dst.Expr

func (*FunctionExpr) ToGoValue

func (f *FunctionExpr) ToGoValue() []interface{}

type Grammar

type Grammar struct {
	Buffer string

	Pretty bool
	// contains filtered or unexported fields
}

func (*Grammar) AST

func (t *Grammar) AST() *node32

func (*Grammar) Add

func (t *Grammar) Add(rule pegRule, begin, end, index uint32)

func (*Grammar) Init

func (p *Grammar) Init(options ...func(*Grammar) error) error

func (*Grammar) LoadUAST

func (g *Grammar) LoadUAST()

func (*Grammar) Parse

func (p *Grammar) Parse(rule ...int) error

func (*Grammar) PrettyPrintSyntaxTree

func (t *Grammar) PrettyPrintSyntaxTree(buffer string)

func (*Grammar) Print

func (t *Grammar) Print()

func (*Grammar) PrintSyntaxTree

func (p *Grammar) PrintSyntaxTree()

func (*Grammar) Reset

func (p *Grammar) Reset()

func (*Grammar) SprintSyntaxTree

func (p *Grammar) SprintSyntaxTree() string

func (*Grammar) Tokens

func (t *Grammar) Tokens() []token32

func (*Grammar) Trim

func (t *Grammar) Trim(length uint32)

func (*Grammar) WriteSyntaxTree

func (p *Grammar) WriteSyntaxTree(w io.Writer)

type NumberExpr

type NumberExpr struct {
	Int   *int64
	Float *float64
}

func (*NumberExpr) ToGoAST

func (n *NumberExpr) ToGoAST() dst.Expr

func (*NumberExpr) ToGoValue

func (n *NumberExpr) ToGoValue() interface{}

type ObjectExpr

type ObjectExpr map[string]*ValueExpr

func (ObjectExpr) ToGoAST

func (o ObjectExpr) ToGoAST() dst.Expr

func (ObjectExpr) ToGoValue

func (o ObjectExpr) ToGoValue() map[string]interface{}

type PairExpr

type PairExpr struct {
	Name  string
	Value *ValueExpr
}

type TaskExpr

type TaskExpr struct {
	Description string
	Module      string
	When        *FunctionExpr
	Args        ObjectExpr
	Body        []*TaskExpr
	Rescue      []*TaskExpr
	Always      []*TaskExpr
}

type Type

type Type int

type UAST

type UAST struct {
	Attributes ObjectExpr
	Tasks      []*TaskExpr
}

UAST is the Unobin AST, so named to avoid confusion with the Go AST, which is generated during compilation.

func NewUAST

func NewUAST() *UAST

type ValueExpr

type ValueExpr struct {
	Array    ArrayExpr
	Bool     *bool
	Function *FunctionExpr
	Number   *NumberExpr
	Object   ObjectExpr
	String   *string
}

func (*ValueExpr) Equal

func (v *ValueExpr) Equal(other *ValueExpr) bool

func (*ValueExpr) ToGoAST

func (v *ValueExpr) ToGoAST() dst.Expr

func (*ValueExpr) ToGoValue

func (v *ValueExpr) ToGoValue() interface{}

func (*ValueExpr) Type

func (v *ValueExpr) Type() Type