parser

type LocationError ¶ added in v0.13.7

type LocationError struct {
	Location []Range
	// contains filtered or unexported fields
}

LocationError gives a location in source code that caused the error.

func (e *LocationError) Unwrap() error

type Node ¶

type Node struct {
	Value       string          // actual content
	Next        *Node           // the next item in the current sexp
	Children    []*Node         // the children of this sexp
	Attributes  map[string]bool // special attributes for this node
	Original    string          // original line used before parsing
	Flags       []string        // only top Node should have this set
	StartLine   int             // the line in the original dockerfile where the node begins
	EndLine     int             // the line in the original dockerfile where the node ends
	PrevComment []string
}

Node is a structure used to represent a parse tree.

In the node there are three fields, Value, Next, and Children. Value is the current token's string value. Next is always the next non-child token, and children contains all the children. Here's an example:

(value next (child child-next child-next-next) next-next)

This data structure is frankly pretty lousy for handling complex languages, but lucky for us the SpecFile isn't very complicated. This structure works a little more effectively than a "proper" parse tree for our needs.

func (node *Node) AddChild(child *Node, startLine, endLine int)

func (node *Node) Dump() string

func (node *Node) Location() []Range

type Position ¶

type Position struct {
	Line      int
	Character int
}

Position is a point in source code.

type Range ¶

type Range struct {
	Start Position
	End   Position
}

Range is a code section between two positions.

type Result ¶

type Result struct {
	AST         *Node
	EscapeToken rune
	Warnings    []string
}

Result is the result of parsing a SpecFile.

func Parse(rwc io.Reader) (*Result, error)

func (r *Result) PrintWarnings(out io.Writer)