ast

Documentation

Overview

Package ast provides structures for representing parsed source code.

The structures in this package will be initialized from the parser package.

Index

• type Argument
• type Array
  • func (node *Array) Position() string
• type Assert
  • func (node *Assert) Position() string
• type Assign
  • func (node *Assign) Position() string
• type Binary
  • func (node *Binary) Position() string
• type Break
  • func (node *Break) Position() string
• type Call
  • func (node *Call) Position() string
• type Case
  • func (node *Case) Position() string
• type Comment
  • func (c *Comment) Position() string
  • func (c *Comment) String() string
• type Continue
  • func (node *Continue) Position() string
• type ErrorScope
  • func (node *ErrorScope) Position() string
• type For
  • func (node *For) Position() string
• type Func
  • func (f *Func) Position() string
  • func (f *Func) String() string
• type Group
  • func (node *Group) Position() string
• type Identifier
  • func (node *Identifier) Position() string
• type If
  • func (node *If) Position() string
• type Import
  • func (node *Import) Position() string
• type In
  • func (node *In) Position() string
• type Interpolate
  • func (node *Interpolate) Position() string
• type Key
  • func (node *Key) Position() string
• type KeyValue
  • func (node *KeyValue) Position() string
• type Literal
  • func (node *Literal) Position() string
• type Map
  • func (node *Map) Position() string
• type Node
• type On
  • func (node *On) Position() string
• type Raise
  • func (node *Raise) Position() string
• type Return
  • func (node *Return) Position() string
• type Switch
  • func (node *Switch) Position() string
• type Test
  • func (node *Test) Position() string
• type Unary
  • func (node *Unary) Position() string

Types

type Argument

type Argument struct {
	Name string
	Type string
}

Argument is used to define a name and type for a function argument.

type Array

type Array struct {
	Kind     string
	Elements []Node
	Pos      string
}

Array is zero or more elements.

func (*Array) Position

func (node *Array) Position() string

Position returns the position.

type Assert

type Assert struct {
	Expr *Binary
	Pos  string
}

Assert is used in tests.

func (*Assert) Position

func (node *Assert) Position() string

Position returns the position.

type Assign

type Assign struct {
	// There will always be at least one Lefts element.
	Lefts []Node

	// There may be one Right element, or the same number of elements as Lefts.
	Rights []Node
}

Assign is a specific case of Binary, just for "=".

func (*Assign) Position

func (node *Assign) Position() string

Position returns the position.

type Binary

type Binary struct {
	// Op is TokenPlus, TokenMinusAssign, etc. It will never be TokenAssign,
	// this special case is handled in an Assign operation.
	Op string

	Left, Right Node
}

Binary is an binary operator operation.

func (*Binary) Position

func (node *Binary) Position() string

Position returns the position.

type Break

type Break struct {
	Pos string
}

Break represents a "break" statement.

func (*Break) Position

func (node *Break) Position() string

Position returns the position.

type Call

type Call struct {
	// FunctionName is the name of the function being invoked.
	FunctionName string

	// Arguments contains zero or more elements that represent each of the
	// arguments respectively.
	Arguments []Node

	Pos string
}

Call represents a function call with zero or more arguments.

func (*Call) Position

func (node *Call) Position() string

Position returns the position.

type Case

type Case struct {
	// Conditions will always contain at least one element.
	Conditions []Node

	// Statements may be nil.
	Statements []Node

	Pos string
}

Case represents a switch case statement.

func (*Case) Position

func (node *Case) Position() string

Position returns the position.

type Comment

type Comment struct {
	Comment string

	// Func will be the name of the function this comment is attached to;
	// otherwise it will be empty.
	Func string

	Pos string
}

Comment represents a single or multiline comment. All characters immediately following `//` are part of the comment (even the proceeding space) up to but not including the new line.

func (*Comment) Position

func (c *Comment) Position() string

Position returns the position.

func (*Comment) String

func (c *Comment) String() string

String returns the cleaner presentation version of the comment.

type Continue

type Continue struct {
	Pos string
}

Continue represents a "continue" statement.

func (*Continue) Position

func (node *Continue) Position() string

Position returns the position.

type ErrorScope

type ErrorScope struct {
	// Statements is what will be run in this scope. It is allowed to be nil.
	Statements []Node

	On  []*On
	Pos string
}

ErrorScope represents the try/on error scope.

func (*ErrorScope) Position

func (node *ErrorScope) Position() string

Position returns the position.

type For

type For struct {
	// All of Init, Condition and Next may be nil.
	Init, Condition, Next Node

	// Statements may be nil.
	Statements []Node

	Pos string
}

For represents a for loop.

func (*For) Position

func (node *For) Position() string

Position returns the position.

type Func

type Func struct {
	// Name is the name of the function being declared.
	Name string

	// Arguments may contain zero or more elements. They will always be in the
	// order in which their are declared.
	Arguments []*Argument

	// Returns may contain zero or more types. They will always be in the order
	// in which they are declared.
	Returns []string

	// Statements can have zero or more elements for each of the ordered
	// discreet statements in the function.
	Statements []Node

	Pos string
}

Func represents the definition of a function.

func (*Func) Position

func (f *Func) Position() string

Position returns the position.

func (*Func) String

func (f *Func) String() string

String returns the signature, like `Foo(x number, y number) (string, string)`.

type Group

type Group struct {
	Expr Node
	Pos  string
}

Group is an expression wrapped in "()".

func (*Group) Position

func (node *Group) Position() string

Position returns the position.

type Identifier

type Identifier struct {
	Name string
	Pos  string
}

Identifier could refer to a variable, function, etc.

func (*Identifier) Position

func (node *Identifier) Position() string

Position returns the position.

type If

type If struct {
	Condition Node

	// Either or both is allowed to be nil.
	True, False []Node

	Pos string
}

If represents an if/else combination.

func (*If) Position

func (node *If) Position() string

Position returns the position.

type Import

type Import struct {
	PackageName string
	Pos         string
}

Import is used to include packages.

func (*Import) Position

func (node *Import) Position() string

Position returns the position.

type In

type In struct {
	Key, Value string
	Expr       Node
	Pos        string
}

In represents an "in" expression in for loops.

func (*In) Position

func (node *In) Position() string

Position returns the position.

type Interpolate

type Interpolate struct {
	// Parts will have at least one element. Each element will be one of
	// StringLiteral or Group. However, they can appear in any order.
	Parts []Node

	Pos string
}

Interpolate is a string literal that contains expressions.

func (*Interpolate) Position

func (node *Interpolate) Position() string

Position returns the position.

type Key

type Key struct {
	Expr Node
	Key  Node
	Pos  string
}

Key returns the value based on the index. It is used for arrays, maps and objects.

func (*Key) Position

func (node *Key) Position() string

Position returns the position.

type KeyValue

type KeyValue struct {
	Key, Value Node
}

KeyValue represents a key-value pair used in maps and object initialization.

func (*KeyValue) Position

func (node *KeyValue) Position() string

Position returns the position.

type Literal

type Literal struct {
	Kind  string
	Value string

	// Array is also used to hold the keys of the map. This is required for
	// iteration.
	Array []*Literal

	Map map[string]*Literal

	Pos string
}

Literal represents a literal of any type.

func (*Literal) Position

func (node *Literal) Position() string

Position returns the position.

type Map

type Map struct {
	Kind     string
	Elements []*KeyValue
	Pos      string
}

Map is zero or more elements.

func (*Map) Position

func (node *Map) Position() string

Position returns the position.

type Node

type Node interface {
	Position() string
}

Node is the interface for all ast structures.

type On

type On struct {
	// Type is the type name, like "MyError".
	Type string

	// Statement may be nil.
	Statements []Node

	Pos string
}

On a error handler for an ErrorScope.

func (*On) Position

func (node *On) Position() string

Position returns the position.

type Raise

type Raise struct {
	Err *Call
	Pos string
}

Raise will raise an error to be handled. An error must be in the form of a constructor call, this is for simplicity right now.

func (*Raise) Position

func (node *Raise) Position() string

Position returns the position.

type Return

type Return struct {
	// Exprs can be zero or more elements.
	Exprs []Node
	Pos   string
}

Return is a statement to return values.

func (*Return) Position

func (node *Return) Position() string

Position returns the position.

type Switch

type Switch struct {
	// Expr may be nil.
	Expr Node

	// Cases may be nil.
	Cases []*Case

	// Else may be nil.
	Else []Node

	Pos string
}

Switch represents a switch statement.

func (*Switch) Position

func (node *Switch) Position() string

Position returns the position.

type Test

type Test struct {
	Name       string
	Statements []Node
	Pos        string
}

Test is a named test.

func (*Test) Position

func (node *Test) Position() string

Position returns the position.

type Unary

type Unary struct {
	// Op is TokenMinus, TokenNot, TokenIncrement or TokenDecrement.
	Op   string
	Expr Node
	Pos  string
}

Unary is an unary operator operation.

func (*Unary) Position

func (node *Unary) Position() string

Position returns the position.