/* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Contributor(s):
* Norris Boyd
*
* Alternatively, the contents of this file may be used under the terms of
* the GNU General Public License Version 2 or later (the "GPL"), in which
* case the provisions of the GPL are applicable instead of those above. If
* you wish to allow use of your version of this file only under the terms of
* the GPL and not to allow others to use your version of this file under the
* MPL, indicate your decision by deleting the provisions above and replacing
* them with the notice and other provisions required by the GPL. If you do
* not delete the provisions above, a recipient may use your version of this
* file under either the MPL or the GPL.
*
* ***** END LICENSE BLOCK ***** */
package org.mozilla.javascript;
import org.mozilla.javascript.ast.ScriptNode;
import java.util.List;
/**
* Abstraction of evaluation, which can be implemented either by an
* interpreter or compiler.
*/
public interface Evaluator {
/**
* Compile the script or function from intermediate representation
* tree into an executable form.
*
* @param compilerEnv Compiler environment
* @param tree parse tree
* @param encodedSource encoding of the source code for decompilation
* @param returnFunction if true, compiling a function
* @return an opaque object that can be passed to either
* createFunctionObject or createScriptObject, depending on the
* value of returnFunction
*/
public Object compile(CompilerEnvirons compilerEnv,
ScriptNode tree,
String encodedSource,
boolean returnFunction);
/**
* Create a function object.
*
* @param cx Current context
* @param scope scope of the function
* @param bytecode opaque object returned by compile
* @param staticSecurityDomain security domain
* @return Function object that can be called
*/
public Function createFunctionObject(Context cx, Scriptable scope,
Object bytecode, Object staticSecurityDomain);
/**
* Create a script object.
*
* @param bytecode opaque object returned by compile
* @param staticSecurityDomain security domain
* @return Script object that can be evaluated
*/
public Script createScriptObject(Object bytecode,
Object staticSecurityDomain);
/**
* Capture stack information from the given exception.
* @param ex an exception thrown during execution
*/
public void captureStackInfo(RhinoException ex);
/**
* Get the source position information by examining the stack.
* @param cx Context
* @param linep Array object of length >= 1; getSourcePositionFromStack
* will assign the line number to linep[0].
* @return the name of the file or other source container
*/
public String getSourcePositionFromStack(Context cx, int[] linep);
/**
* Given a native stack trace, patch it with script-specific source
* and line information
* @param ex exception
* @param nativeStackTrace the native stack trace
* @return patched stack trace
*/
public String getPatchedStack(RhinoException ex,
String nativeStackTrace);
/**
* Get the script stack for the given exception
* @param ex exception from execution
* @return list of strings for the stack trace
*/
public List<String> getScriptStack(RhinoException ex);
/**
* Mark the given script to indicate it was created by a call to
* eval() or to a Function constructor.
* @param script script to mark as from eval
*/
public void setEvalScriptFlag(Script script);
}