472 lines
18 KiB
C
472 lines
18 KiB
C
/* -*- 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 jsatom_h___
|
|
#define jsatom_h___
|
|
/*
|
|
* JS atom table.
|
|
*/
|
|
#include <stddef.h>
|
|
#include "jstypes.h"
|
|
#include "jshash.h" /* Added by JSIFY */
|
|
#include "jsapi.h"
|
|
#include "jsprvtd.h"
|
|
#include "jspubtd.h"
|
|
|
|
#ifdef JS_THREADSAFE
|
|
#include "jslock.h"
|
|
#endif
|
|
|
|
JS_BEGIN_EXTERN_C
|
|
|
|
#define ATOM_PINNED 0x01 /* atom is pinned against GC */
|
|
#define ATOM_INTERNED 0x02 /* pinned variant for JS_Intern* API */
|
|
#define ATOM_MARK 0x04 /* atom is reachable via GC */
|
|
#define ATOM_HIDDEN 0x08 /* atom is in special hidden subspace */
|
|
#define ATOM_NOCOPY 0x40 /* don't copy atom string bytes */
|
|
#define ATOM_TMPSTR 0x80 /* internal, to avoid extra string */
|
|
|
|
struct JSAtom {
|
|
JSHashEntry entry; /* key is jsval, value keyword info or
|
|
unhidden atom if ATOM_HIDDEN */
|
|
uint32 flags; /* pinned, interned, and mark flags */
|
|
jsatomid number; /* atom serial number and hash code */
|
|
};
|
|
|
|
#define ATOM_KEY(atom) ((jsval)(atom)->entry.key)
|
|
#define ATOM_IS_OBJECT(atom) JSVAL_IS_OBJECT(ATOM_KEY(atom))
|
|
#define ATOM_TO_OBJECT(atom) JSVAL_TO_OBJECT(ATOM_KEY(atom))
|
|
#define ATOM_IS_INT(atom) JSVAL_IS_INT(ATOM_KEY(atom))
|
|
#define ATOM_TO_INT(atom) JSVAL_TO_INT(ATOM_KEY(atom))
|
|
#define ATOM_IS_DOUBLE(atom) JSVAL_IS_DOUBLE(ATOM_KEY(atom))
|
|
#define ATOM_TO_DOUBLE(atom) JSVAL_TO_DOUBLE(ATOM_KEY(atom))
|
|
#define ATOM_IS_STRING(atom) JSVAL_IS_STRING(ATOM_KEY(atom))
|
|
#define ATOM_TO_STRING(atom) JSVAL_TO_STRING(ATOM_KEY(atom))
|
|
#define ATOM_IS_BOOLEAN(atom) JSVAL_IS_BOOLEAN(ATOM_KEY(atom))
|
|
#define ATOM_TO_BOOLEAN(atom) JSVAL_TO_BOOLEAN(ATOM_KEY(atom))
|
|
|
|
/*
|
|
* Return a printable, lossless char[] representation of a string-type atom.
|
|
* The lifetime of the result extends at least until the next GC activation,
|
|
* longer if cx's string newborn root is not overwritten.
|
|
*/
|
|
extern JS_FRIEND_API(const char *)
|
|
js_AtomToPrintableString(JSContext *cx, JSAtom *atom);
|
|
|
|
#define ATOM_KEYWORD(atom) ((struct keyword *)(atom)->entry.value)
|
|
#define ATOM_SET_KEYWORD(atom,kw) ((atom)->entry.value = (kw))
|
|
|
|
struct JSAtomListElement {
|
|
JSHashEntry entry;
|
|
};
|
|
|
|
#define ALE_ATOM(ale) ((JSAtom *) (ale)->entry.key)
|
|
#define ALE_INDEX(ale) ((jsatomid) JS_PTR_TO_UINT32((ale)->entry.value))
|
|
#define ALE_JSOP(ale) ((JSOp) (ale)->entry.value)
|
|
#define ALE_VALUE(ale) ((jsval) (ale)->entry.value)
|
|
#define ALE_NEXT(ale) ((JSAtomListElement *) (ale)->entry.next)
|
|
|
|
#define ALE_SET_ATOM(ale,atom) ((ale)->entry.key = (const void *)(atom))
|
|
#define ALE_SET_INDEX(ale,index)((ale)->entry.value = JS_UINT32_TO_PTR(index))
|
|
#define ALE_SET_JSOP(ale,op) ((ale)->entry.value = JS_UINT32_TO_PTR(op))
|
|
#define ALE_SET_VALUE(ale,val) ((ale)->entry.value = (JSHashEntry *)(val))
|
|
#define ALE_SET_NEXT(ale,link) ((ale)->entry.next = (JSHashEntry *)(link))
|
|
|
|
struct JSAtomList {
|
|
JSAtomListElement *list; /* literals indexed for mapping */
|
|
JSHashTable *table; /* hash table if list gets too long */
|
|
jsuint count; /* count of indexed literals */
|
|
};
|
|
|
|
#define ATOM_LIST_INIT(al) ((al)->list = NULL, (al)->table = NULL, \
|
|
(al)->count = 0)
|
|
|
|
#define ATOM_LIST_SEARCH(_ale,_al,_atom) \
|
|
JS_BEGIN_MACRO \
|
|
JSHashEntry **_hep; \
|
|
ATOM_LIST_LOOKUP(_ale, _hep, _al, _atom); \
|
|
JS_END_MACRO
|
|
|
|
#define ATOM_LIST_LOOKUP(_ale,_hep,_al,_atom) \
|
|
JS_BEGIN_MACRO \
|
|
if ((_al)->table) { \
|
|
_hep = JS_HashTableRawLookup((_al)->table, _atom->number, _atom); \
|
|
_ale = *_hep ? (JSAtomListElement *) *_hep : NULL; \
|
|
} else { \
|
|
JSAtomListElement **_alep = &(_al)->list; \
|
|
_hep = NULL; \
|
|
while ((_ale = *_alep) != NULL) { \
|
|
if (ALE_ATOM(_ale) == (_atom)) { \
|
|
/* Hit, move atom's element to the front of the list. */ \
|
|
*_alep = ALE_NEXT(_ale); \
|
|
ALE_SET_NEXT(_ale, (_al)->list); \
|
|
(_al)->list = _ale; \
|
|
break; \
|
|
} \
|
|
_alep = (JSAtomListElement **)&_ale->entry.next; \
|
|
} \
|
|
} \
|
|
JS_END_MACRO
|
|
|
|
struct JSAtomMap {
|
|
JSAtom **vector; /* array of ptrs to indexed atoms */
|
|
jsatomid length; /* count of (to-be-)indexed atoms */
|
|
};
|
|
|
|
struct JSAtomState {
|
|
JSRuntime *runtime; /* runtime that owns us */
|
|
JSHashTable *table; /* hash table containing all atoms */
|
|
jsatomid number; /* one beyond greatest atom number */
|
|
jsatomid liveAtoms; /* number of live atoms after last GC */
|
|
|
|
/* The rt->emptyString atom, see jsstr.c's js_InitRuntimeStringState. */
|
|
JSAtom *emptyAtom;
|
|
|
|
/* Type names and value literals. */
|
|
JSAtom *typeAtoms[JSTYPE_LIMIT];
|
|
JSAtom *booleanAtoms[2];
|
|
JSAtom *nullAtom;
|
|
|
|
/* Various built-in or commonly-used atoms, pinned on first context. */
|
|
JSAtom *ArgumentsAtom;
|
|
JSAtom *ArrayAtom;
|
|
JSAtom *BooleanAtom;
|
|
JSAtom *CallAtom;
|
|
JSAtom *DateAtom;
|
|
JSAtom *ErrorAtom;
|
|
JSAtom *FunctionAtom;
|
|
JSAtom *MathAtom;
|
|
JSAtom *NamespaceAtom;
|
|
JSAtom *NumberAtom;
|
|
JSAtom *ObjectAtom;
|
|
JSAtom *QNameAtom;
|
|
JSAtom *RegExpAtom;
|
|
JSAtom *ScriptAtom;
|
|
JSAtom *StringAtom;
|
|
JSAtom *XMLAtom;
|
|
JSAtom *FileAtom;
|
|
JSAtom *anonymousAtom;
|
|
JSAtom *argumentsAtom;
|
|
JSAtom *arityAtom;
|
|
JSAtom *calleeAtom;
|
|
JSAtom *callerAtom;
|
|
JSAtom *classPrototypeAtom;
|
|
JSAtom *constructorAtom;
|
|
JSAtom *countAtom;
|
|
JSAtom *eachAtom;
|
|
JSAtom *etagoAtom;
|
|
JSAtom *evalAtom;
|
|
JSAtom *getAtom;
|
|
JSAtom *getterAtom;
|
|
JSAtom *indexAtom;
|
|
JSAtom *inputAtom;
|
|
JSAtom *lengthAtom;
|
|
JSAtom *nameAtom;
|
|
JSAtom *namespaceAtom;
|
|
JSAtom *noSuchMethodAtom;
|
|
JSAtom *parentAtom;
|
|
JSAtom *protoAtom;
|
|
JSAtom *ptagcAtom;
|
|
JSAtom *qualifierAtom;
|
|
JSAtom *setAtom;
|
|
JSAtom *setterAtom;
|
|
JSAtom *spaceAtom;
|
|
JSAtom *stagoAtom;
|
|
JSAtom *starAtom;
|
|
JSAtom *starQualifierAtom;
|
|
JSAtom *tagcAtom;
|
|
JSAtom *toLocaleStringAtom;
|
|
JSAtom *toSourceAtom;
|
|
JSAtom *toStringAtom;
|
|
JSAtom *valueOfAtom;
|
|
JSAtom *xmlAtom;
|
|
#ifdef OSSP
|
|
JSAtom *DSOAtom;
|
|
#endif
|
|
|
|
/* Less frequently used atoms, pinned lazily by JS_ResolveStandardClass. */
|
|
struct {
|
|
JSAtom *AnyNameAtom;
|
|
JSAtom *AttributeNameAtom;
|
|
JSAtom *EvalErrorAtom;
|
|
JSAtom *InfinityAtom;
|
|
JSAtom *InternalErrorAtom;
|
|
JSAtom *NaNAtom;
|
|
JSAtom *RangeErrorAtom;
|
|
JSAtom *ReferenceErrorAtom;
|
|
JSAtom *SyntaxErrorAtom;
|
|
JSAtom *TypeErrorAtom;
|
|
JSAtom *URIErrorAtom;
|
|
JSAtom *XMLListAtom;
|
|
JSAtom *decodeURIAtom;
|
|
JSAtom *decodeURIComponentAtom;
|
|
JSAtom *defineGetterAtom;
|
|
JSAtom *defineSetterAtom;
|
|
JSAtom *encodeURIAtom;
|
|
JSAtom *encodeURIComponentAtom;
|
|
JSAtom *escapeAtom;
|
|
JSAtom *functionNamespaceURIAtom;
|
|
JSAtom *hasOwnPropertyAtom;
|
|
JSAtom *isFiniteAtom;
|
|
JSAtom *isNaNAtom;
|
|
JSAtom *isPrototypeOfAtom;
|
|
JSAtom *isXMLNameAtom;
|
|
JSAtom *lookupGetterAtom;
|
|
JSAtom *lookupSetterAtom;
|
|
JSAtom *parseFloatAtom;
|
|
JSAtom *parseIntAtom;
|
|
JSAtom *propertyIsEnumerableAtom;
|
|
JSAtom *unescapeAtom;
|
|
JSAtom *unevalAtom;
|
|
JSAtom *unwatchAtom;
|
|
JSAtom *watchAtom;
|
|
} lazy;
|
|
|
|
#ifdef JS_THREADSAFE
|
|
JSThinLock lock;
|
|
volatile uint32 tablegen;
|
|
#endif
|
|
#ifdef NARCISSUS
|
|
JSAtom *callAtom;
|
|
JSAtom *constructAtom;
|
|
JSAtom *hasInstanceAtom;
|
|
JSAtom *ExecutionContextAtom;
|
|
JSAtom *currentAtom;
|
|
#endif
|
|
};
|
|
|
|
/* Well-known predefined strings and their atoms. */
|
|
extern const char *js_type_str[];
|
|
extern const char *js_boolean_str[];
|
|
|
|
extern const char js_Arguments_str[];
|
|
extern const char js_Array_str[];
|
|
extern const char js_Boolean_str[];
|
|
extern const char js_Call_str[];
|
|
extern const char js_Date_str[];
|
|
extern const char js_Function_str[];
|
|
extern const char js_Math_str[];
|
|
extern const char js_Namespace_str[];
|
|
extern const char js_Number_str[];
|
|
extern const char js_Object_str[];
|
|
extern const char js_QName_str[];
|
|
extern const char js_RegExp_str[];
|
|
extern const char js_Script_str[];
|
|
extern const char js_String_str[];
|
|
extern const char js_XML_str[];
|
|
extern const char js_File_str[];
|
|
extern const char js_anonymous_str[];
|
|
extern const char js_arguments_str[];
|
|
extern const char js_arity_str[];
|
|
extern const char js_callee_str[];
|
|
extern const char js_caller_str[];
|
|
extern const char js_class_prototype_str[];
|
|
extern const char js_constructor_str[];
|
|
extern const char js_count_str[];
|
|
extern const char js_etago_str[];
|
|
extern const char js_each_str[];
|
|
extern const char js_eval_str[];
|
|
extern const char js_getter_str[];
|
|
extern const char js_get_str[];
|
|
extern const char js_index_str[];
|
|
extern const char js_input_str[];
|
|
extern const char js_length_str[];
|
|
extern const char js_name_str[];
|
|
extern const char js_namespace_str[];
|
|
extern const char js_noSuchMethod_str[];
|
|
extern const char js_object_str[];
|
|
extern const char js_parent_str[];
|
|
extern const char js_private_str[];
|
|
extern const char js_proto_str[];
|
|
extern const char js_ptagc_str[];
|
|
extern const char js_qualifier_str[];
|
|
extern const char js_setter_str[];
|
|
extern const char js_set_str[];
|
|
extern const char js_space_str[];
|
|
extern const char js_stago_str[];
|
|
extern const char js_star_str[];
|
|
extern const char js_starQualifier_str[];
|
|
extern const char js_tagc_str[];
|
|
extern const char js_toSource_str[];
|
|
extern const char js_toString_str[];
|
|
extern const char js_toLocaleString_str[];
|
|
extern const char js_valueOf_str[];
|
|
extern const char js_xml_str[];
|
|
|
|
#ifdef NARCISSUS
|
|
extern const char js_call_str[];
|
|
extern const char js_construct_str[];
|
|
extern const char js_hasInstance_str[];
|
|
extern const char js_ExecutionContext_str[];
|
|
extern const char js_current_str[];
|
|
#endif
|
|
|
|
/*
|
|
* Initialize atom state. Return true on success, false with an out of
|
|
* memory error report on failure.
|
|
*/
|
|
extern JSBool
|
|
js_InitAtomState(JSContext *cx, JSAtomState *state);
|
|
|
|
/*
|
|
* Free and clear atom state (except for any interned string atoms).
|
|
*/
|
|
extern void
|
|
js_FreeAtomState(JSContext *cx, JSAtomState *state);
|
|
|
|
/*
|
|
* Interned strings are atoms that live until state's runtime is destroyed.
|
|
* This function frees all interned string atoms, and then frees and clears
|
|
* state's members (just as js_FreeAtomState does), unless there aren't any
|
|
* interned strings in state -- in which case state must be "free" already.
|
|
*
|
|
* NB: js_FreeAtomState is called for each "last" context being destroyed in
|
|
* a runtime, where there may yet be another context created in the runtime;
|
|
* whereas js_FinishAtomState is called from JS_DestroyRuntime, when we know
|
|
* that no more contexts will be created. Thus we minimize garbage during
|
|
* context-free episodes on a runtime, while preserving atoms created by the
|
|
* JS_Intern*String APIs for the life of the runtime.
|
|
*/
|
|
extern void
|
|
js_FinishAtomState(JSAtomState *state);
|
|
|
|
/*
|
|
* Atom garbage collection hooks.
|
|
*/
|
|
typedef void
|
|
(*JSGCThingMarker)(void *thing, void *data);
|
|
|
|
extern void
|
|
js_MarkAtomState(JSAtomState *state, uintN gcflags, JSGCThingMarker mark,
|
|
void *data);
|
|
|
|
extern void
|
|
js_SweepAtomState(JSAtomState *state);
|
|
|
|
extern JSBool
|
|
js_InitPinnedAtoms(JSContext *cx, JSAtomState *state);
|
|
|
|
extern void
|
|
js_UnpinPinnedAtoms(JSAtomState *state);
|
|
|
|
/*
|
|
* Find or create the atom for an object. If we create a new atom, give it the
|
|
* type indicated in flags. Return 0 on failure to allocate memory.
|
|
*/
|
|
extern JSAtom *
|
|
js_AtomizeObject(JSContext *cx, JSObject *obj, uintN flags);
|
|
|
|
/*
|
|
* Find or create the atom for a Boolean value. If we create a new atom, give
|
|
* it the type indicated in flags. Return 0 on failure to allocate memory.
|
|
*/
|
|
extern JSAtom *
|
|
js_AtomizeBoolean(JSContext *cx, JSBool b, uintN flags);
|
|
|
|
/*
|
|
* Find or create the atom for an integer value. If we create a new atom, give
|
|
* it the type indicated in flags. Return 0 on failure to allocate memory.
|
|
*/
|
|
extern JSAtom *
|
|
js_AtomizeInt(JSContext *cx, jsint i, uintN flags);
|
|
|
|
/*
|
|
* Find or create the atom for a double value. If we create a new atom, give
|
|
* it the type indicated in flags. Return 0 on failure to allocate memory.
|
|
*/
|
|
extern JSAtom *
|
|
js_AtomizeDouble(JSContext *cx, jsdouble d, uintN flags);
|
|
|
|
/*
|
|
* Find or create the atom for a string. If we create a new atom, give it the
|
|
* type indicated in flags. Return 0 on failure to allocate memory.
|
|
*/
|
|
extern JSAtom *
|
|
js_AtomizeString(JSContext *cx, JSString *str, uintN flags);
|
|
|
|
extern JS_FRIEND_API(JSAtom *)
|
|
js_Atomize(JSContext *cx, const char *bytes, size_t length, uintN flags);
|
|
|
|
extern JS_FRIEND_API(JSAtom *)
|
|
js_AtomizeChars(JSContext *cx, const jschar *chars, size_t length, uintN flags);
|
|
|
|
/*
|
|
* This variant handles all value tag types.
|
|
*/
|
|
extern JSAtom *
|
|
js_AtomizeValue(JSContext *cx, jsval value, uintN flags);
|
|
|
|
/*
|
|
* Convert v to an atomized string.
|
|
*/
|
|
extern JSAtom *
|
|
js_ValueToStringAtom(JSContext *cx, jsval v);
|
|
|
|
/*
|
|
* Assign atom an index and insert it on al.
|
|
*/
|
|
extern JSAtomListElement *
|
|
js_IndexAtom(JSContext *cx, JSAtom *atom, JSAtomList *al);
|
|
|
|
/*
|
|
* Get the atom with index i from map.
|
|
*/
|
|
extern JS_FRIEND_API(JSAtom *)
|
|
js_GetAtom(JSContext *cx, JSAtomMap *map, jsatomid i);
|
|
|
|
/*
|
|
* For all unmapped atoms recorded in al, add a mapping from the atom's index
|
|
* to its address. The GC must not run until all indexed atoms in atomLists
|
|
* have been mapped by scripts connected to live objects (Function and Script
|
|
* class objects have scripts as/in their private data -- the GC knows about
|
|
* these two classes).
|
|
*/
|
|
extern JS_FRIEND_API(JSBool)
|
|
js_InitAtomMap(JSContext *cx, JSAtomMap *map, JSAtomList *al);
|
|
|
|
/*
|
|
* Free map->vector and clear map.
|
|
*/
|
|
extern JS_FRIEND_API(void)
|
|
js_FreeAtomMap(JSContext *cx, JSAtomMap *map);
|
|
|
|
JS_END_EXTERN_C
|
|
|
|
#endif /* jsatom_h___ */
|