2007-03-22 10:30:00 -07:00
|
|
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
2008-06-03 14:48:47 -07:00
|
|
|
* vim: set ts=8 sw=4 et tw=79 ft=cpp:
|
2007-03-22 10:30:00 -07:00
|
|
|
*
|
|
|
|
* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*
|
|
|
|
* The Original Code is Mozilla Communicator client code, released
|
|
|
|
* March 31, 1998.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either of the GNU General Public License Version 2 or later (the "GPL"),
|
|
|
|
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
|
|
|
#ifndef jsscript_h___
|
|
|
|
#define jsscript_h___
|
|
|
|
/*
|
|
|
|
* JS script descriptor.
|
|
|
|
*/
|
|
|
|
#include "jsatom.h"
|
|
|
|
#include "jsprvtd.h"
|
2009-02-18 16:31:09 -08:00
|
|
|
#include "jsdbgapi.h"
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
JS_BEGIN_EXTERN_C
|
|
|
|
|
|
|
|
/*
|
2008-06-03 14:48:47 -07:00
|
|
|
* Type of try note associated with each catch or finally block, and also with
|
|
|
|
* for-in loops.
|
2007-05-24 00:51:46 -07:00
|
|
|
*/
|
|
|
|
typedef enum JSTryNoteKind {
|
2008-10-09 10:10:17 -07:00
|
|
|
JSTRY_CATCH,
|
|
|
|
JSTRY_FINALLY,
|
|
|
|
JSTRY_ITER
|
2007-05-24 00:51:46 -07:00
|
|
|
} JSTryNoteKind;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Exception handling record.
|
2007-03-22 10:30:00 -07:00
|
|
|
*/
|
|
|
|
struct JSTryNote {
|
2007-05-24 00:51:46 -07:00
|
|
|
uint8 kind; /* one of JSTryNoteKind */
|
|
|
|
uint8 padding; /* explicit padding on uint16 boundary */
|
|
|
|
uint16 stackDepth; /* stack depth upon exception handler entry */
|
2007-07-02 05:13:23 -07:00
|
|
|
uint32 start; /* start of the try statement or for-in loop
|
|
|
|
relative to script->main */
|
|
|
|
uint32 length; /* length of the try statement or for-in loop */
|
2007-03-22 10:30:00 -07:00
|
|
|
};
|
|
|
|
|
2007-05-24 00:51:46 -07:00
|
|
|
typedef struct JSTryNoteArray {
|
2007-07-08 02:03:34 -07:00
|
|
|
JSTryNote *vector; /* array of indexed try notes */
|
2008-05-28 19:07:32 -07:00
|
|
|
uint32 length; /* count of indexed try notes */
|
2007-05-24 00:51:46 -07:00
|
|
|
} JSTryNoteArray;
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2007-07-08 02:03:34 -07:00
|
|
|
typedef struct JSObjectArray {
|
|
|
|
JSObject **vector; /* array of indexed objects */
|
2008-05-28 19:07:32 -07:00
|
|
|
uint32 length; /* count of indexed objects */
|
2007-07-08 02:03:34 -07:00
|
|
|
} JSObjectArray;
|
|
|
|
|
2008-08-21 03:47:33 -07:00
|
|
|
typedef struct JSUpvarArray {
|
|
|
|
uint32 *vector; /* array of indexed upvar cookies */
|
|
|
|
uint32 length; /* count of indexed upvar cookies */
|
|
|
|
} JSUpvarArray;
|
|
|
|
|
2009-04-09 18:44:54 -07:00
|
|
|
#define CALLEE_UPVAR_SLOT 0xffff
|
|
|
|
#define FREE_STATIC_LEVEL 0xffff
|
2009-04-05 21:17:22 -07:00
|
|
|
#define FREE_UPVAR_COOKIE 0xffffffff
|
2008-08-21 03:47:33 -07:00
|
|
|
#define MAKE_UPVAR_COOKIE(skip,slot) ((skip) << 16 | (slot))
|
|
|
|
#define UPVAR_FRAME_SKIP(cookie) ((uint32)(cookie) >> 16)
|
|
|
|
#define UPVAR_FRAME_SLOT(cookie) ((uint16)(cookie))
|
|
|
|
|
2007-07-08 02:03:34 -07:00
|
|
|
#define JS_OBJECT_ARRAY_SIZE(length) \
|
|
|
|
(offsetof(JSObjectArray, vector) + sizeof(JSObject *) * (length))
|
|
|
|
|
2008-02-07 15:18:45 -08:00
|
|
|
#if defined DEBUG && defined JS_THREADSAFE
|
|
|
|
# define CHECK_SCRIPT_OWNER 1
|
|
|
|
#endif
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
struct JSScript {
|
2007-07-08 02:03:34 -07:00
|
|
|
jsbytecode *code; /* bytecodes and their immediate operands */
|
|
|
|
uint32 length; /* length of code vector */
|
|
|
|
uint16 version; /* JS version under which script was compiled */
|
2008-07-20 13:13:17 -07:00
|
|
|
uint16 nfixed; /* number of slots besides stack operands in
|
|
|
|
slot array */
|
2007-07-08 02:03:34 -07:00
|
|
|
uint8 objectsOffset; /* offset to the array of nested function,
|
|
|
|
block, scope, xml and one-time regexps
|
|
|
|
objects or 0 if none */
|
2008-08-21 03:47:33 -07:00
|
|
|
uint8 upvarsOffset; /* offset of the array of display ("up")
|
|
|
|
closure vars or 0 if none */
|
2007-07-08 02:03:34 -07:00
|
|
|
uint8 regexpsOffset; /* offset to the array of to-be-cloned
|
|
|
|
regexps or 0 if none. */
|
|
|
|
uint8 trynotesOffset; /* offset to the array of try notes or
|
|
|
|
0 if none */
|
2008-07-26 16:12:01 -07:00
|
|
|
uint8 flags; /* see below */
|
2007-07-08 02:03:34 -07:00
|
|
|
jsbytecode *main; /* main entry point, after predef'ing prolog */
|
|
|
|
JSAtomMap atomMap; /* maps immediate index to literal struct */
|
|
|
|
const char *filename; /* source filename or null */
|
2008-08-21 03:47:33 -07:00
|
|
|
uint32 lineno; /* base line number of script */
|
|
|
|
uint16 nslots; /* vars plus maximum stack depth */
|
2009-04-05 21:17:22 -07:00
|
|
|
uint16 staticLevel;/* static level for display maintenance */
|
2007-07-08 02:03:34 -07:00
|
|
|
JSPrincipals *principals;/* principals for this script */
|
2008-08-20 22:18:42 -07:00
|
|
|
union {
|
|
|
|
JSObject *object; /* optional Script-class object wrapper */
|
|
|
|
JSScript *nextToGC; /* next to GC in rt->scriptsToGC list */
|
|
|
|
} u;
|
2008-02-07 15:18:45 -08:00
|
|
|
#ifdef CHECK_SCRIPT_OWNER
|
|
|
|
JSThread *owner; /* for thread-safe life-cycle assertions */
|
|
|
|
#endif
|
2007-03-22 10:30:00 -07:00
|
|
|
};
|
|
|
|
|
2008-07-26 16:12:01 -07:00
|
|
|
#define JSSF_NO_SCRIPT_RVAL 0x01 /* no need for result value of last
|
|
|
|
expression statement */
|
2009-01-27 19:56:55 -08:00
|
|
|
#define JSSF_SAVED_CALLER_FUN 0x02 /* object 0 is caller function */
|
2008-07-26 16:12:01 -07:00
|
|
|
|
2008-07-29 10:53:03 -07:00
|
|
|
static JS_INLINE uintN
|
2008-07-20 13:13:17 -07:00
|
|
|
StackDepth(JSScript *script)
|
|
|
|
{
|
2008-07-23 15:55:41 -07:00
|
|
|
return script->nslots - script->nfixed;
|
2008-07-20 13:13:17 -07:00
|
|
|
}
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
/* No need to store script->notes now that it is allocated right after code. */
|
|
|
|
#define SCRIPT_NOTES(script) ((jssrcnote*)((script)->code+(script)->length))
|
|
|
|
|
2007-07-08 02:03:34 -07:00
|
|
|
#define JS_SCRIPT_OBJECTS(script) \
|
|
|
|
(JS_ASSERT((script)->objectsOffset != 0), \
|
|
|
|
(JSObjectArray *)((uint8 *)(script) + (script)->objectsOffset))
|
|
|
|
|
2008-08-21 03:47:33 -07:00
|
|
|
#define JS_SCRIPT_UPVARS(script) \
|
|
|
|
(JS_ASSERT((script)->upvarsOffset != 0), \
|
|
|
|
(JSUpvarArray *)((uint8 *)(script) + (script)->upvarsOffset))
|
|
|
|
|
2007-07-08 02:03:34 -07:00
|
|
|
#define JS_SCRIPT_REGEXPS(script) \
|
|
|
|
(JS_ASSERT((script)->regexpsOffset != 0), \
|
|
|
|
(JSObjectArray *)((uint8 *)(script) + (script)->regexpsOffset))
|
|
|
|
|
|
|
|
#define JS_SCRIPT_TRYNOTES(script) \
|
|
|
|
(JS_ASSERT((script)->trynotesOffset != 0), \
|
|
|
|
(JSTryNoteArray *)((uint8 *)(script) + (script)->trynotesOffset))
|
|
|
|
|
2008-11-17 16:56:01 -08:00
|
|
|
#define JS_GET_SCRIPT_ATOM(script_, index, atom) \
|
2007-07-08 02:03:34 -07:00
|
|
|
JS_BEGIN_MACRO \
|
2008-12-22 08:07:40 -08:00
|
|
|
JSStackFrame *fp_ = js_GetTopStackFrame(cx); \
|
|
|
|
if (fp_ && fp_->imacpc && fp_->script == script_) { \
|
2008-11-13 00:30:20 -08:00
|
|
|
JS_ASSERT((size_t)(index) < js_common_atom_count); \
|
|
|
|
(atom) = COMMON_ATOMS_START(&cx->runtime->atomState)[index]; \
|
|
|
|
} else { \
|
2008-11-17 16:56:01 -08:00
|
|
|
JSAtomMap *atoms_ = &(script_)->atomMap; \
|
2008-11-13 00:30:20 -08:00
|
|
|
JS_ASSERT((uint32)(index) < atoms_->length); \
|
|
|
|
(atom) = atoms_->vector[index]; \
|
|
|
|
} \
|
2007-07-08 02:03:34 -07:00
|
|
|
JS_END_MACRO
|
|
|
|
|
|
|
|
#define JS_GET_SCRIPT_OBJECT(script, index, obj) \
|
|
|
|
JS_BEGIN_MACRO \
|
|
|
|
JSObjectArray *objects_ = JS_SCRIPT_OBJECTS(script); \
|
|
|
|
JS_ASSERT((uint32)(index) < objects_->length); \
|
2008-11-13 00:30:20 -08:00
|
|
|
(obj) = objects_->vector[index]; \
|
2007-07-08 02:03:34 -07:00
|
|
|
JS_END_MACRO
|
|
|
|
|
2008-04-02 00:46:12 -07:00
|
|
|
#define JS_GET_SCRIPT_FUNCTION(script, index, fun) \
|
|
|
|
JS_BEGIN_MACRO \
|
|
|
|
JSObject *funobj_; \
|
|
|
|
\
|
|
|
|
JS_GET_SCRIPT_OBJECT(script, index, funobj_); \
|
|
|
|
JS_ASSERT(HAS_FUNCTION_CLASS(funobj_)); \
|
|
|
|
JS_ASSERT(funobj_ == (JSObject *) STOBJ_GET_PRIVATE(funobj_)); \
|
|
|
|
(fun) = (JSFunction *) funobj_; \
|
|
|
|
JS_ASSERT(FUN_INTERPRETED(fun)); \
|
|
|
|
JS_END_MACRO
|
|
|
|
|
2007-07-08 02:03:34 -07:00
|
|
|
#define JS_GET_SCRIPT_REGEXP(script, index, obj) \
|
|
|
|
JS_BEGIN_MACRO \
|
|
|
|
JSObjectArray *regexps_ = JS_SCRIPT_REGEXPS(script); \
|
|
|
|
JS_ASSERT((uint32)(index) < regexps_->length); \
|
2008-11-13 00:30:20 -08:00
|
|
|
(obj) = regexps_->vector[index]; \
|
2007-07-08 02:03:34 -07:00
|
|
|
JS_ASSERT(STOBJ_GET_CLASS(obj) == &js_RegExpClass); \
|
|
|
|
JS_END_MACRO
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
/*
|
2007-05-24 00:51:46 -07:00
|
|
|
* Check if pc is inside a try block that has finally code. GC calls this to
|
|
|
|
* check if it is necessary to schedule generator.close() invocation for an
|
|
|
|
* unreachable generator.
|
2007-03-22 10:30:00 -07:00
|
|
|
*/
|
2007-05-24 00:51:46 -07:00
|
|
|
JSBool
|
|
|
|
js_IsInsideTryWithFinally(JSScript *script, jsbytecode *pc);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
extern JS_FRIEND_DATA(JSClass) js_ScriptClass;
|
|
|
|
|
|
|
|
extern JSObject *
|
|
|
|
js_InitScriptClass(JSContext *cx, JSObject *obj);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* On first new context in rt, initialize script runtime state, specifically
|
|
|
|
* the script filename table and its lock.
|
|
|
|
*/
|
|
|
|
extern JSBool
|
|
|
|
js_InitRuntimeScriptState(JSRuntime *rt);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* On last context destroy for rt, if script filenames are all GC'd, free the
|
|
|
|
* script filename table and its lock.
|
|
|
|
*/
|
|
|
|
extern void
|
|
|
|
js_FinishRuntimeScriptState(JSRuntime *rt);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* On JS_DestroyRuntime(rt), forcibly free script filename prefixes and any
|
|
|
|
* script filename table entries that have not been GC'd, the latter using
|
|
|
|
* js_FinishRuntimeScriptState.
|
|
|
|
*
|
|
|
|
* This allows script filename prefixes to outlive any context in rt.
|
|
|
|
*/
|
|
|
|
extern void
|
|
|
|
js_FreeRuntimeScriptState(JSRuntime *rt);
|
|
|
|
|
|
|
|
extern const char *
|
|
|
|
js_SaveScriptFilename(JSContext *cx, const char *filename);
|
|
|
|
|
|
|
|
extern const char *
|
|
|
|
js_SaveScriptFilenameRT(JSRuntime *rt, const char *filename, uint32 flags);
|
|
|
|
|
|
|
|
extern uint32
|
|
|
|
js_GetScriptFilenameFlags(const char *filename);
|
|
|
|
|
|
|
|
extern void
|
|
|
|
js_MarkScriptFilename(const char *filename);
|
|
|
|
|
|
|
|
extern void
|
|
|
|
js_MarkScriptFilenames(JSRuntime *rt, JSBool keepAtoms);
|
|
|
|
|
|
|
|
extern void
|
|
|
|
js_SweepScriptFilenames(JSRuntime *rt);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Two successively less primitive ways to make a new JSScript. The first
|
|
|
|
* does *not* call a non-null cx->runtime->newScriptHook -- only the second,
|
|
|
|
* js_NewScriptFromCG, calls this optional debugger hook.
|
|
|
|
*
|
|
|
|
* The js_NewScript function can't know whether the script it creates belongs
|
|
|
|
* to a function, or is top-level or eval code, but the debugger wants access
|
|
|
|
* to the newly made script's function, if any -- so callers of js_NewScript
|
|
|
|
* are responsible for notifying the debugger after successfully creating any
|
|
|
|
* kind (function or other) of new JSScript.
|
|
|
|
*/
|
|
|
|
extern JSScript *
|
2008-08-21 03:47:33 -07:00
|
|
|
js_NewScript(JSContext *cx, uint32 length, uint32 nsrcnotes, uint32 natoms,
|
|
|
|
uint32 nobjects, uint32 nupvars, uint32 nregexps,
|
|
|
|
uint32 ntrynotes);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2007-11-29 06:49:42 -08:00
|
|
|
extern JSScript *
|
|
|
|
js_NewScriptFromCG(JSContext *cx, JSCodeGenerator *cg);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
/*
|
|
|
|
* New-script-hook calling is factored from js_NewScriptFromCG so that it
|
|
|
|
* and callers of js_XDRScript can share this code. In the case of callers
|
|
|
|
* of js_XDRScript, the hook should be invoked only after successful decode
|
|
|
|
* of any owning function (the fun parameter) or script object (null fun).
|
|
|
|
*/
|
2008-03-29 03:34:29 -07:00
|
|
|
extern JS_FRIEND_API(void)
|
|
|
|
js_CallNewScriptHook(JSContext *cx, JSScript *script, JSFunction *fun);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2008-03-29 03:34:29 -07:00
|
|
|
extern JS_FRIEND_API(void)
|
2007-03-22 10:30:00 -07:00
|
|
|
js_CallDestroyScriptHook(JSContext *cx, JSScript *script);
|
|
|
|
|
|
|
|
extern void
|
|
|
|
js_DestroyScript(JSContext *cx, JSScript *script);
|
|
|
|
|
|
|
|
extern void
|
2007-04-16 23:53:37 -07:00
|
|
|
js_TraceScript(JSTracer *trc, JSScript *script);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
/*
|
|
|
|
* To perturb as little code as possible, we introduce a js_GetSrcNote lookup
|
|
|
|
* cache without adding an explicit cx parameter. Thus js_GetSrcNote becomes
|
|
|
|
* a macro that uses cx from its calls' lexical environments.
|
|
|
|
*/
|
|
|
|
#define js_GetSrcNote(script,pc) js_GetSrcNoteCached(cx, script, pc)
|
|
|
|
|
|
|
|
extern jssrcnote *
|
|
|
|
js_GetSrcNoteCached(JSContext *cx, JSScript *script, jsbytecode *pc);
|
|
|
|
|
2008-11-13 00:30:20 -08:00
|
|
|
/*
|
|
|
|
* NOTE: use js_FramePCToLineNumber(cx, fp) when you have an active fp, in
|
|
|
|
* preference to js_PCToLineNumber (cx, fp->script fp->regs->pc), because
|
|
|
|
* fp->imacpc may be non-null, indicating an active imacro.
|
|
|
|
*/
|
|
|
|
extern uintN
|
|
|
|
js_FramePCToLineNumber(JSContext *cx, JSStackFrame *fp);
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
extern uintN
|
|
|
|
js_PCToLineNumber(JSContext *cx, JSScript *script, jsbytecode *pc);
|
|
|
|
|
|
|
|
extern jsbytecode *
|
|
|
|
js_LineNumberToPC(JSScript *script, uintN lineno);
|
|
|
|
|
|
|
|
extern JS_FRIEND_API(uintN)
|
|
|
|
js_GetScriptLineExtent(JSScript *script);
|
|
|
|
|
2009-02-18 16:31:09 -08:00
|
|
|
static JS_INLINE JSOp
|
|
|
|
js_GetOpcode(JSContext *cx, JSScript *script, jsbytecode *pc)
|
|
|
|
{
|
|
|
|
JSOp op = (JSOp) *pc;
|
|
|
|
if (op == JSOP_TRAP)
|
|
|
|
op = JS_GetTrapOpcode(cx, script, pc);
|
|
|
|
return op;
|
|
|
|
}
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
/*
|
|
|
|
* If magic is non-null, js_XDRScript succeeds on magic number mismatch but
|
|
|
|
* returns false in *magic; it reflects a match via a true *magic out param.
|
|
|
|
* If magic is null, js_XDRScript returns false on bad magic number errors,
|
|
|
|
* which it reports.
|
|
|
|
*
|
|
|
|
* NB: callers must call js_CallNewScriptHook after successful JSXDR_DECODE
|
|
|
|
* and subsequent set-up of owning function or script object, if any.
|
|
|
|
*/
|
|
|
|
extern JSBool
|
|
|
|
js_XDRScript(JSXDRState *xdr, JSScript **scriptp, JSBool *magic);
|
|
|
|
|
|
|
|
JS_END_EXTERN_C
|
|
|
|
|
|
|
|
#endif /* jsscript_h___ */
|