/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- * * ***** 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 jsprvtd_h___ #define jsprvtd_h___ /* * JS private typename definitions. * * This header is included only in other .h files, for convenience and for * simplicity of type naming. The alternative for structures is to use tags, * which are named the same as their typedef names (legal in C/C++, and less * noisy than suffixing the typedef name with "Struct" or "Str"). Instead, * all .h files that include this file may use the same typedef name, whether * declaring a pointer to struct type, or defining a member of struct type. * * A few fundamental scalar types are defined here too. Neither the scalar * nor the struct typedefs should change much, therefore the nearly-global * make dependency induced by this file should not prove painful. */ #include "jspubtd.h" /* Internal identifier (jsid) macros. */ #define JSID_IS_ATOM(id) JSVAL_IS_STRING((jsval)(id)) #define JSID_TO_ATOM(id) ((JSAtom *)(id)) #define ATOM_TO_JSID(atom) (JS_ASSERT(ATOM_IS_STRING(atom)), \ (jsid)(atom)) #define JSID_IS_INT(id) JSVAL_IS_INT((jsval)(id)) #define JSID_TO_INT(id) JSVAL_TO_INT((jsval)(id)) #define INT_TO_JSID(i) ((jsid)INT_TO_JSVAL(i)) #define INT_JSVAL_TO_JSID(v) ((jsid)(v)) #define INT_JSID_TO_JSVAL(id) ((jsval)(id)) #define JSID_IS_OBJECT(id) JSVAL_IS_OBJECT((jsval)(id)) #define JSID_TO_OBJECT(id) JSVAL_TO_OBJECT((jsval)(id)) #define OBJECT_TO_JSID(obj) ((jsid)OBJECT_TO_JSVAL(obj)) #define OBJECT_JSVAL_TO_JSID(v) ((jsid)v) #define ID_TO_VALUE(id) ((jsval)(id)) /* * Convenience constants. */ #define JS_BITS_PER_UINT32_LOG2 5 #define JS_BITS_PER_UINT32 32 /* Scalar typedefs. */ typedef uint8 jsbytecode; typedef uint8 jssrcnote; typedef uint32 jsatomid; /* Struct typedefs. */ typedef struct JSArgumentFormatMap JSArgumentFormatMap; typedef struct JSCodeGenerator JSCodeGenerator; typedef struct JSGCThing JSGCThing; typedef struct JSGenerator JSGenerator; typedef struct JSNativeEnumerator JSNativeEnumerator; typedef struct JSParseContext JSParseContext; typedef struct JSParsedObjectBox JSParsedObjectBox; typedef struct JSParseNode JSParseNode; typedef struct JSPropCacheEntry JSPropCacheEntry; typedef struct JSSharpObjectMap JSSharpObjectMap; typedef struct JSTempValueRooter JSTempValueRooter; typedef struct JSThread JSThread; typedef struct JSToken JSToken; typedef struct JSTokenPos JSTokenPos; typedef struct JSTokenPtr JSTokenPtr; typedef struct JSTokenStream JSTokenStream; typedef struct JSTreeContext JSTreeContext; typedef struct JSTryNote JSTryNote; typedef struct JSWeakRoots JSWeakRoots; /* Friend "Advanced API" typedefs. */ typedef struct JSAtom JSAtom; typedef struct JSAtomList JSAtomList; typedef struct JSAtomListElement JSAtomListElement; typedef struct JSAtomMap JSAtomMap; typedef struct JSAtomState JSAtomState; typedef struct JSCodeSpec JSCodeSpec; typedef struct JSPrinter JSPrinter; typedef struct JSRegExp JSRegExp; typedef struct JSRegExpStatics JSRegExpStatics; typedef struct JSScope JSScope; typedef struct JSScopeOps JSScopeOps; typedef struct JSScopeProperty JSScopeProperty; typedef struct JSStackHeader JSStackHeader; typedef struct JSStringBuffer JSStringBuffer; typedef struct JSSubString JSSubString; typedef struct JSTraceableNative JSTraceableNative; typedef struct JSXML JSXML; typedef struct JSXMLArray JSXMLArray; typedef struct JSXMLArrayCursor JSXMLArrayCursor; /* "Friend" types used by jscntxt.h and jsdbgapi.h. */ typedef enum JSTrapStatus { JSTRAP_ERROR, JSTRAP_CONTINUE, JSTRAP_RETURN, JSTRAP_THROW, JSTRAP_LIMIT } JSTrapStatus; typedef JSTrapStatus (* JSTrapHandler)(JSContext *cx, JSScript *script, jsbytecode *pc, jsval *rval, void *closure); typedef JSBool (* JSWatchPointHandler)(JSContext *cx, JSObject *obj, jsval id, jsval old, jsval *newp, void *closure); /* called just after script creation */ typedef void (* JSNewScriptHook)(JSContext *cx, const char *filename, /* URL of script */ uintN lineno, /* first line */ JSScript *script, JSFunction *fun, void *callerdata); /* called just before script destruction */ typedef void (* JSDestroyScriptHook)(JSContext *cx, JSScript *script, void *callerdata); typedef void (* JSSourceHandler)(const char *filename, uintN lineno, jschar *str, size_t length, void **listenerTSData, void *closure); /* * This hook captures high level script execution and function calls (JS or * native). It is used by JS_SetExecuteHook to hook top level scripts and by * JS_SetCallHook to hook function calls. It will get called twice per script * or function call: just before execution begins and just after it finishes. * In both cases the 'current' frame is that of the executing code. * * The 'before' param is JS_TRUE for the hook invocation before the execution * and JS_FALSE for the invocation after the code has run. * * The 'ok' param is significant only on the post execution invocation to * signify whether or not the code completed 'normally'. * * The 'closure' param is as passed to JS_SetExecuteHook or JS_SetCallHook * for the 'before'invocation, but is whatever value is returned from that * invocation for the 'after' invocation. Thus, the hook implementor *could* * allocate a structure in the 'before' invocation and return a pointer to that * structure. The pointer would then be handed to the hook for the 'after' * invocation. Alternately, the 'before' could just return the same value as * in 'closure' to cause the 'after' invocation to be called with the same * 'closure' value as the 'before'. * * Returning NULL in the 'before' hook will cause the 'after' hook *not* to * be called. */ typedef void * (* JSInterpreterHook)(JSContext *cx, JSStackFrame *fp, JSBool before, JSBool *ok, void *closure); typedef void (* JSObjectHook)(JSContext *cx, JSObject *obj, JSBool isNew, void *closure); typedef JSBool (* JSDebugErrorHook)(JSContext *cx, const char *message, JSErrorReport *report, void *closure); typedef struct JSDebugHooks { JSTrapHandler interruptHandler; void *interruptHandlerData; JSNewScriptHook newScriptHook; void *newScriptHookData; JSDestroyScriptHook destroyScriptHook; void *destroyScriptHookData; JSTrapHandler debuggerHandler; void *debuggerHandlerData; JSSourceHandler sourceHandler; void *sourceHandlerData; JSInterpreterHook executeHook; void *executeHookData; JSInterpreterHook callHook; void *callHookData; JSObjectHook objectHook; void *objectHookData; JSTrapHandler throwHook; void *throwHookData; JSDebugErrorHook debugErrorHook; void *debugErrorHookData; } JSDebugHooks; /* * Type definitions for temporary GC roots that register with GC local C * variables. See jscntxt.h for details. */ typedef void (* JSTempValueTrace)(JSTracer *trc, JSTempValueRooter *tvr); typedef union JSTempValueUnion { jsval value; JSObject *object; JSString *string; JSXML *xml; JSTempValueTrace trace; JSScopeProperty *sprop; JSWeakRoots *weakRoots; JSParseContext *parseContext; JSScript *script; jsval *array; } JSTempValueUnion; struct JSTempValueRooter { JSTempValueRooter *down; ptrdiff_t count; JSTempValueUnion u; }; /* * The following determines whether JS_EncodeCharacters and JS_DecodeBytes * treat char[] as utf-8 or simply as bytes that need to be inflated/deflated. */ #ifdef JS_C_STRINGS_ARE_UTF8 # define js_CStringsAreUTF8 JS_TRUE #else extern JSBool js_CStringsAreUTF8; #endif #endif /* jsprvtd_h___ */