runtime_error.go

/*
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 "github.com/google/go-jsonnet/ast"

// RuntimeError is an error discovered during evaluation of the program
type RuntimeError struct {
	Msg        string
	StackTrace []TraceFrame
}

func makeRuntimeError(msg string, stackTrace []TraceFrame) RuntimeError {
	return RuntimeError{
		Msg:        msg,
		StackTrace: stackTrace,
	}
}

func (err RuntimeError) Error() string {
	return "RUNTIME ERROR: " + err.Msg
}

// The stack

// TraceFrame is tracing information about a single frame of the call stack.
// TODO(sbarzowski) the difference from traceElement. Do we even need this?
type TraceFrame struct {
	Name string
	Loc  ast.LocationRange
}

func traceElementToTraceFrame(trace traceElement) TraceFrame {
	tf := TraceFrame{Loc: *trace.loc}
	if trace.context != nil {
		// TODO(sbarzowski) maybe it should never be nil
		tf.Name = *trace.context
	} else {
		tf.Name = ""
	}
	return tf
}

// traceElement represents tracing information, including a location range and a
// surrounding context.
// TODO(sbarzowski) better name
type traceElement struct {
	loc     *ast.LocationRange
	context ast.Context
}