forked from google/go-jsonnet
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vm.go
193 lines (167 loc) · 5.37 KB
/
vm.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/*
Copyright 2017 Google Inc. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package jsonnet
import (
"errors"
"fmt"
"runtime/debug"
"github.com/google/go-jsonnet/ast"
"github.com/google/go-jsonnet/parser"
)
// Note: There are no garbage collection params because we're using the native
// Go garbage collector.
// VM is the core interpreter and is the touchpoint used to parse and execute
// Jsonnet.
type VM struct {
MaxStack int
ext vmExtMap
tla vmExtMap
nativeFuncs map[string]*NativeFunction
importer Importer
ErrorFormatter ErrorFormatter
StringOutput bool
}
// External variable or top level argument provided before execution
type vmExt struct {
// jsonnet code to evaluate or string to pass
value string
// isCode determines whether it should be evaluated as jsonnet code or
// treated as string.
isCode bool
}
type vmExtMap map[string]vmExt
// MakeVM creates a new VM with default parameters.
func MakeVM() *VM {
return &VM{
MaxStack: 500,
ext: make(vmExtMap),
tla: make(vmExtMap),
nativeFuncs: make(map[string]*NativeFunction),
ErrorFormatter: &termErrorFormatter{pretty: false, maxStackTraceSize: 20},
importer: &FileImporter{},
}
}
// ExtVar binds a Jsonnet external var to the given value.
func (vm *VM) ExtVar(key string, val string) {
vm.ext[key] = vmExt{value: val, isCode: false}
}
// ExtCode binds a Jsonnet external code var to the given code.
func (vm *VM) ExtCode(key string, val string) {
vm.ext[key] = vmExt{value: val, isCode: true}
}
// TLAVar binds a Jsonnet top level argument to the given value.
func (vm *VM) TLAVar(key string, val string) {
vm.tla[key] = vmExt{value: val, isCode: false}
}
// TLACode binds a Jsonnet top level argument to the given code.
func (vm *VM) TLACode(key string, val string) {
vm.tla[key] = vmExt{value: val, isCode: true}
}
// Importer sets Importer to use during evaluation (import callback).
func (vm *VM) Importer(i Importer) {
vm.importer = i
}
type evalKind int
const (
evalKindRegular = iota
evalKindMulti = iota
evalKindStream = iota
)
func (vm *VM) evaluateSnippet(filename string, snippet string, kind evalKind) (output interface{}, err error) {
defer func() {
if r := recover(); r != nil {
err = fmt.Errorf("(CRASH) %v\n%s", r, debug.Stack())
}
}()
node, err := snippetToAST(filename, snippet)
if err != nil {
return "", err
}
switch kind {
case evalKindRegular:
output, err = evaluate(node, vm.ext, vm.tla, vm.nativeFuncs, vm.MaxStack, vm.importer, vm.StringOutput)
case evalKindMulti:
output, err = evaluateMulti(node, vm.ext, vm.tla, vm.nativeFuncs, vm.MaxStack, vm.importer, vm.StringOutput)
case evalKindStream:
output, err = evaluateStream(node, vm.ext, vm.tla, vm.nativeFuncs, vm.MaxStack, vm.importer)
}
if err != nil {
return "", err
}
return output, nil
}
// NativeFunction registers a native function.
func (vm *VM) NativeFunction(f *NativeFunction) {
vm.nativeFuncs[f.Name] = f
}
// EvaluateSnippet evaluates a string containing Jsonnet code, return a JSON
// string.
//
// The filename parameter is only used for error messages.
func (vm *VM) EvaluateSnippet(filename string, snippet string) (json string, formattedErr error) {
output, err := vm.evaluateSnippet(filename, snippet, evalKindRegular)
if err != nil {
return "", errors.New(vm.ErrorFormatter.Format(err))
}
json = output.(string)
return
}
// EvaluateSnippetStream evaluates a string containing Jsonnet code to an array.
// The array is returned as an array of JSON strings.
//
// The filename parameter is only used for error messages.
func (vm *VM) EvaluateSnippetStream(filename string, snippet string) (docs []string, formattedErr error) {
output, err := vm.evaluateSnippet(filename, snippet, evalKindStream)
if err != nil {
return nil, errors.New(vm.ErrorFormatter.Format(err))
}
docs = output.([]string)
return
}
// EvaluateSnippetMulti evaluates a string containing Jsonnet code to key-value
// pairs. The keys are field name strings and the values are JSON strings.
//
// The filename parameter is only used for error messages.
func (vm *VM) EvaluateSnippetMulti(filename string, snippet string) (files map[string]string, formattedErr error) {
output, err := vm.evaluateSnippet(filename, snippet, evalKindMulti)
if err != nil {
return nil, errors.New(vm.ErrorFormatter.Format(err))
}
files = output.(map[string]string)
return
}
func snippetToAST(filename string, snippet string) (ast.Node, error) {
tokens, err := parser.Lex(filename, snippet)
if err != nil {
return nil, err
}
node, err := parser.Parse(tokens)
if err != nil {
return nil, err
}
err = desugarFile(&node)
if err != nil {
return nil, err
}
err = analyze(node)
if err != nil {
return nil, err
}
return node, nil
}
func SnippetToAST(filename string, snippet string) (ast.Node, error) {
return snippetToAST(filename, snippet)
}
func Version() string {
return "v0.9.5"
}