parser

Documentation

Overview

Package parser reads Jsonnet files and parses them into AST nodes.

Index

• func Children(node ast.Node) []ast.Node
• func DirectChildren(node ast.Node) []ast.Node
• func IsValidIdentifier(str string) bool
• func Parse(t Tokens) (ast.Node, ast.Fodder, errors.StaticError)
• func SnippetToRawAST(diagnosticFilename ast.DiagnosticFileName, importedFilename, snippet string) (ast.Node, ast.Fodder, error)
• func StringEscape(s string, single bool) string
• func StringUnescape(loc *ast.LocationRange, s string) (string, error)
• type Tokens
  • func Lex(diagnosticFilename ast.DiagnosticFileName, importedFilename, input string) (Tokens, error)

Functions

func Children

func Children(node ast.Node) []ast.Node

Children returns all children of a node. It supports ASTs before and after desugaring.

func DirectChildren

func DirectChildren(node ast.Node) []ast.Node

DirectChildren are children of AST node that are executed in the same context and environment as their parent. It supports ASTs before and after desugaring.

They must satisfy the following rules: * (no-delayed-evaluation) They are evaluated when their parent is evaluated or never. * (no-indirect-evaluation) They cannot be evaluated during evaluation of any non-direct children * (same-environment) They must be evaluated in the same environment as their parent

func IsValidIdentifier

func IsValidIdentifier(str string) bool

IsValidIdentifier is true if the string could be a valid identifier.

func Parse

func Parse(t Tokens) (ast.Node, ast.Fodder, errors.StaticError)

Parse parses a slice of tokens into a parse tree. Any fodder after the final token is returned as well.

func SnippetToRawAST

func SnippetToRawAST(diagnosticFilename ast.DiagnosticFileName, importedFilename, snippet string) (ast.Node, ast.Fodder, error)

SnippetToRawAST converts a Jsonnet code snippet to an AST (without any transformations). Any fodder after the final token is returned as well.

func StringEscape

func StringEscape(s string, single bool) string

StringEscape does the opposite of StringUnescape

func StringUnescape

func StringUnescape(loc *ast.LocationRange, s string) (string, error)

StringUnescape compiles out the escape codes in the string

Types

type Tokens

type Tokens []token

Tokens is a slice of token structs.

func Lex

func Lex(diagnosticFilename ast.DiagnosticFileName, importedFilename, input string) (Tokens, error)

Lex returns a slice of tokens recognised in input.