trunk/js/jsatom.h

/* -*- 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 "jsversion.h"
#include "jstypes.h"
#include "jshash.h" /* Added by JSIFY */
#include "jsdhash.h"
#include "jsapi.h"
#include "jsprvtd.h"
#include "jspubtd.h"
#include "jslock.h"

JS_BEGIN_EXTERN_C

#define ATOM_PINNED     0x1       /* atom is pinned against GC */
#define ATOM_INTERNED   0x2       /* pinned variant for JS_Intern* API */
#define ATOM_NOCOPY     0x4       /* don't copy atom string bytes */
#define ATOM_TMPSTR     0x8       /* internal, to avoid extra string */

#define ATOM_KEY(atom)            ((jsval)(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))

JS_STATIC_ASSERT(sizeof(JSHashNumber) == 4);
JS_STATIC_ASSERT(sizeof(JSAtom *) == JS_BYTES_PER_WORD);

#if JS_BYTES_PER_WORD == 4
# define ATOM_HASH(atom)          ((JSHashNumber)(atom) >> 2)
#elif JS_BYTES_PER_WORD == 8
# define ATOM_HASH(atom)          (((JSHashNumber)(jsuword)(atom) >> 3) ^     \
                                   (JSHashNumber)((jsuword)(atom) >> 32))
#else
# error "Unsupported configuration"
#endif

/*
 * 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 const char *
js_AtomToPrintableString(JSContext *cx, JSAtom *atom);

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) JS_PTR_TO_UINT32((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, v)   ((ale)->entry.value = (void *)(v))

struct JSAtomList {
    JSHashEntry         *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_HASH(_atom),      \
                                         _atom);                              \
            _ale = *_hep ? (JSAtomListElement *) *_hep : NULL;                \
        } else {                                                              \
            JSHashEntry **_alep = &(_al)->list;                               \
            _hep = NULL;                                                      \
            while ((_ale = (JSAtomListElement *)*_alep) != NULL) {            \
                if (ALE_ATOM(_ale) == (_atom)) {                              \
                    /* Hit, move atom's element to the front of the list. */  \
                    *_alep = (_ale)->entry.next;                              \
                    (_ale)->entry.next = (_al)->list;                         \
                    (_al)->list = &_ale->entry;                               \
                    break;                                                    \
                }                                                             \
                _alep = &_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 {
    JSDHashTable        stringAtoms;    /* hash table with shared strings */
    JSDHashTable        doubleAtoms;    /* hash table with shared doubles */
#ifdef JS_THREADSAFE
    JSThinLock          lock;
#endif

    /*
     * From this point until the end of struct definition the struct must
     * contain only JSAtom fields. We use this to access the storage occupied
     * by the common atoms in js_FinishCommonAtoms.
     *
     * js_common_atom_names defined in jsatom.c contains C strings for atoms
     * in the order of atom fields here. Therefore you must update that array
     * if you change member order here.
     */

    /* 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;

    /* Standard class constructor or prototype names. */
    JSAtom              *classAtoms[JSProto_LIMIT];

    /* Various built-in or commonly-used atoms, pinned on first context. */
    JSAtom              *anonymousAtom;
    JSAtom              *argumentsAtom;
    JSAtom              *arityAtom;
    JSAtom              *calleeAtom;
    JSAtom              *callerAtom;
    JSAtom              *classPrototypeAtom;
    JSAtom              *constructorAtom;
    JSAtom              *countAtom;
    JSAtom              *eachAtom;
    JSAtom              *evalAtom;
    JSAtom              *fileNameAtom;
    JSAtom              *getAtom;
    JSAtom              *getterAtom;
    JSAtom              *indexAtom;
    JSAtom              *inputAtom;
    JSAtom              *iteratorAtom;
    JSAtom              *lengthAtom;
    JSAtom              *lineNumberAtom;
    JSAtom              *messageAtom;
    JSAtom              *nameAtom;
    JSAtom              *nextAtom;
    JSAtom              *noSuchMethodAtom;
    JSAtom              *parentAtom;
    JSAtom              *protoAtom;
    JSAtom              *setAtom;
    JSAtom              *setterAtom;
    JSAtom              *stackAtom;
    JSAtom              *toLocaleStringAtom;
    JSAtom              *toSourceAtom;
    JSAtom              *toStringAtom;
    JSAtom              *valueOfAtom;
    JSAtom              *toJSONAtom;
    JSAtom              *void0Atom;

#if JS_HAS_XML_SUPPORT
    JSAtom              *etagoAtom;
    JSAtom              *namespaceAtom;
    JSAtom              *ptagcAtom;
    JSAtom              *qualifierAtom;
    JSAtom              *spaceAtom;
    JSAtom              *stagoAtom;
    JSAtom              *starAtom;
    JSAtom              *starQualifierAtom;
    JSAtom              *tagcAtom;
    JSAtom              *xmlAtom;
#endif

#ifdef NARCISSUS
    JSAtom              *callAtom;
    JSAtom              *constructAtom;
    JSAtom              *hasInstanceAtom;
    JSAtom              *ExecutionContextAtom;
    JSAtom              *currentAtom;
#endif

    /* Less frequently used atoms, pinned lazily by JS_ResolveStandardClass. */
    struct {
        JSAtom          *InfinityAtom;
        JSAtom          *NaNAtom;
        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;
};

#define ATOM_OFFSET_START       offsetof(JSAtomState, emptyAtom)
#define LAZY_ATOM_OFFSET_START  offsetof(JSAtomState, lazy)
#define ATOM_OFFSET_LIMIT       (sizeof(JSAtomState))

#define COMMON_ATOMS_START(state)                                             \
    (JSAtom **)((uint8 *)(state) + ATOM_OFFSET_START)

/* Start and limit offsets should correspond to atoms. */
JS_STATIC_ASSERT(ATOM_OFFSET_START % sizeof(JSAtom *) == 0);
JS_STATIC_ASSERT(ATOM_OFFSET_LIMIT % sizeof(JSAtom *) == 0);

#define ATOM_OFFSET(name)       offsetof(JSAtomState, name##Atom)
#define OFFSET_TO_ATOM(rt,off)  (*(JSAtom **)((char*)&(rt)->atomState + (off)))
#define CLASS_ATOM_OFFSET(name) offsetof(JSAtomState,classAtoms[JSProto_##name])

#define CLASS_ATOM(cx,name) \
    ((cx)->runtime->atomState.classAtoms[JSProto_##name])

extern const char *const js_common_atom_names[];

/*
 * Macros to access C strings for JSType and boolean literals together with
 * checks that type names and booleans starts from index 1 and 1+JSTYPE_LIMIT
 * correspondingly.
 */
#define JS_TYPE_STR(type)    (js_common_atom_names[1 + (type)])
#define JS_BOOLEAN_STR(type) (js_common_atom_names[1 + JSTYPE_LIMIT + (type)])

JS_STATIC_ASSERT(1 * sizeof(JSAtom *) ==
                 offsetof(JSAtomState, typeAtoms) - ATOM_OFFSET_START);
JS_STATIC_ASSERT((1 + JSTYPE_LIMIT) * sizeof(JSAtom *) ==
                 offsetof(JSAtomState, booleanAtoms) - ATOM_OFFSET_START);

/* Well-known predefined C strings. */
#define JS_PROTO(name,code,init) extern const char js_##name##_str[];
#include "jsproto.tbl"
#undef JS_PROTO

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_close_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_fileName_str[];
extern const char   js_get_str[];
extern const char   js_getter_str[];
extern const char   js_index_str[];
extern const char   js_input_str[];
extern const char   js_iterator_str[];
extern const char   js_length_str[];
extern const char   js_lineNumber_str[];
extern const char   js_message_str[];
extern const char   js_name_str[];
extern const char   js_namespace_str[];
extern const char   js_next_str[];
extern const char   js_noSuchMethod_str[];
extern const char   js_object_str[];
extern const char   js_parent_str[];
extern const char   js_proto_str[];
extern const char   js_ptagc_str[];
extern const char   js_qualifier_str[];
extern const char   js_send_str[];
extern const char   js_setter_str[];
extern const char   js_set_str[];
extern const char   js_space_str[];
extern const char   js_stack_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_undefined_str[];
extern const char   js_valueOf_str[];
extern const char   js_toJSON_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 on failure to allocate
 * memory. The caller must zero rt->atomState before calling this function and
 * only call it after js_InitGC successfully returns.
 */
extern JSBool
js_InitAtomState(JSRuntime *rt);

/*
 * Free and clear atom state including any interned string atoms. This
 * function must be called before js_FinishGC.
 */
extern void
js_FinishAtomState(JSRuntime *rt);

/*
 * Atom tracing and garbage collection hooks.
 */

extern void
js_TraceAtomState(JSTracer *trc, JSBool allAtoms);

extern void
js_SweepAtomState(JSContext *cx);

extern JSBool
js_InitCommonAtoms(JSContext *cx);

extern void
js_FinishCommonAtoms(JSContext *cx);

/*
 * Find or create the atom for a double value. Return null on failure to
 * allocate memory.
 */
extern JSAtom *
js_AtomizeDouble(JSContext *cx, jsdouble d);

/*
 * Find or create the atom for a string. Return null on failure to allocate
 * memory.
 */
extern JSAtom *
js_AtomizeString(JSContext *cx, JSString *str, uintN flags);

extern JSAtom *
js_Atomize(JSContext *cx, const char *bytes, size_t length, uintN flags);

extern JSAtom *
js_AtomizeChars(JSContext *cx, const jschar *chars, size_t length, uintN flags);

/*
 * Return an existing atom for the given char array or null if the char
 * sequence is currently not atomized.
 */
extern JSAtom *
js_GetExistingStringAtom(JSContext *cx, const jschar *chars, size_t length);

/*
 * This variant handles all primitive values.
 */
JSBool
js_AtomizePrimitiveValue(JSContext *cx, jsval v, JSAtom **atomp);

/*
 * Convert v to an atomized string and wrap it as an id.
 */
extern JSBool
js_ValueToStringId(JSContext *cx, jsval v, jsid *idp);

#ifdef DEBUG

extern JS_FRIEND_API(void)
js_DumpAtoms(JSContext *cx, FILE *fp);

#endif

/*
 * Assign atom an index and insert it on al.
 */
extern JSAtomListElement *
js_IndexAtom(JSContext *cx, JSAtom *atom, JSAtomList *al);

/*
 * For all unmapped atoms recorded in al, add a mapping from the atom's index
 * to its address. map->length must already be set to the number of atoms in
 * the list and map->vector must point to pre-allocated memory.
 */
extern void
js_InitAtomMap(JSContext *cx, JSAtomMap *map, JSAtomList *al);

JS_END_EXTERN_C

#endif /* jsatom_h___ */
1	siliconforks	332	/* -- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 --
2			*
3			* *** BEGIN LICENSE BLOCK ***
4			* Version: MPL 1.1/GPL 2.0/LGPL 2.1
5			*
6			* The contents of this file are subject to the Mozilla Public License Version
7			* 1.1 (the "License"); you may not use this file except in compliance with
8			* the License. You may obtain a copy of the License at
9			* http://www.mozilla.org/MPL/
10			*
11			* Software distributed under the License is distributed on an "AS IS" basis,
12			* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13			* for the specific language governing rights and limitations under the
14			* License.
15			*
16			* The Original Code is Mozilla Communicator client code, released
17			* March 31, 1998.
18			*
19			* The Initial Developer of the Original Code is
20			* Netscape Communications Corporation.
21			* Portions created by the Initial Developer are Copyright (C) 1998
22			* the Initial Developer. All Rights Reserved.
23			*
24			* Contributor(s):
25			*
26			* Alternatively, the contents of this file may be used under the terms of
27			* either of the GNU General Public License Version 2 or later (the "GPL"),
28			* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29			* in which case the provisions of the GPL or the LGPL are applicable instead
30			* of those above. If you wish to allow use of your version of this file only
31			* under the terms of either the GPL or the LGPL, and not to allow others to
32			* use your version of this file under the terms of the MPL, indicate your
33			* decision by deleting the provisions above and replace them with the notice
34			* and other provisions required by the GPL or the LGPL. If you do not delete
35			* the provisions above, a recipient may use your version of this file under
36			* the terms of any one of the MPL, the GPL or the LGPL.
37			*
38			* *** END LICENSE BLOCK *** */
39
40			#ifndef jsatom_h___
41			#define jsatom_h___
42			/*
43			* JS atom table.
44			*/
45			#include <stddef.h>
46			#include "jsversion.h"
47			#include "jstypes.h"
48			#include "jshash.h" /* Added by JSIFY */
49			#include "jsdhash.h"
50			#include "jsapi.h"
51			#include "jsprvtd.h"
52			#include "jspubtd.h"
53			#include "jslock.h"
54
55			JS_BEGIN_EXTERN_C
56
57			#define ATOM_PINNED 0x1 /* atom is pinned against GC */
58			#define ATOM_INTERNED 0x2 /* pinned variant for JS_Intern* API */
59			#define ATOM_NOCOPY 0x4 /* don't copy atom string bytes */
60			#define ATOM_TMPSTR 0x8 /* internal, to avoid extra string */
61
62			#define ATOM_KEY(atom) ((jsval)(atom))
63			#define ATOM_IS_DOUBLE(atom) JSVAL_IS_DOUBLE(ATOM_KEY(atom))
64			#define ATOM_TO_DOUBLE(atom) JSVAL_TO_DOUBLE(ATOM_KEY(atom))
65			#define ATOM_IS_STRING(atom) JSVAL_IS_STRING(ATOM_KEY(atom))
66			#define ATOM_TO_STRING(atom) JSVAL_TO_STRING(ATOM_KEY(atom))
67
68			JS_STATIC_ASSERT(sizeof(JSHashNumber) == 4);
69			JS_STATIC_ASSERT(sizeof(JSAtom *) == JS_BYTES_PER_WORD);
70
71			#if JS_BYTES_PER_WORD == 4
72			# define ATOM_HASH(atom) ((JSHashNumber)(atom) >> 2)
73			#elif JS_BYTES_PER_WORD == 8
74			# define ATOM_HASH(atom) (((JSHashNumber)(jsuword)(atom) >> 3) ^ \
75			(JSHashNumber)((jsuword)(atom) >> 32))
76			#else
77			# error "Unsupported configuration"
78			#endif
79
80			/*
81			* Return a printable, lossless char[] representation of a string-type atom.
82			* The lifetime of the result extends at least until the next GC activation,
83			* longer if cx's string newborn root is not overwritten.
84			*/
85			extern const char *
86			js_AtomToPrintableString(JSContext cx, JSAtom atom);
87
88			struct JSAtomListElement {
89			JSHashEntry entry;
90			};
91
92			#define ALE_ATOM(ale) ((JSAtom *) (ale)->entry.key)
93			#define ALE_INDEX(ale) ((jsatomid) JS_PTR_TO_UINT32((ale)->entry.value))
94			#define ALE_JSOP(ale) ((JSOp) JS_PTR_TO_UINT32((ale)->entry.value))
95			#define ALE_VALUE(ale) ((jsval) (ale)->entry.value)
96			#define ALE_NEXT(ale) ((JSAtomListElement *) (ale)->entry.next)
97
98			#define ALE_SET_ATOM(ale,atom) ((ale)->entry.key = (const void *)(atom))
99			#define ALE_SET_INDEX(ale,index)((ale)->entry.value = JS_UINT32_TO_PTR(index))
100			#define ALE_SET_JSOP(ale,op) ((ale)->entry.value = JS_UINT32_TO_PTR(op))
101			#define ALE_SET_VALUE(ale, v) ((ale)->entry.value = (void *)(v))
102
103			struct JSAtomList {
104			JSHashEntry list; / literals indexed for mapping */
105			JSHashTable table; / hash table if list gets too long */
106			jsuint count; /* count of indexed literals */
107			};
108
109			#define ATOM_LIST_INIT(al) ((al)->list = NULL, (al)->table = NULL, \
110			(al)->count = 0)
111
112			#define ATOM_LIST_SEARCH(_ale,_al,_atom) \
113			JS_BEGIN_MACRO \
114			JSHashEntry **_hep; \
115			ATOM_LIST_LOOKUP(_ale, _hep, _al, _atom); \
116			JS_END_MACRO
117
118			#define ATOM_LIST_LOOKUP(_ale,_hep,_al,_atom) \
119			JS_BEGIN_MACRO \
120			if ((_al)->table) { \
121			_hep = JS_HashTableRawLookup((_al)->table, ATOM_HASH(_atom), \
122			_atom); \
123			_ale = _hep ? (JSAtomListElement ) *_hep : NULL; \
124			} else { \
125			JSHashEntry **_alep = &(_al)->list; \
126			_hep = NULL; \
127			while ((_ale = (JSAtomListElement )_alep) != NULL) { \
128			if (ALE_ATOM(_ale) == (_atom)) { \
129			/* Hit, move atom's element to the front of the list. */ \
130			*_alep = (_ale)->entry.next; \
131			(_ale)->entry.next = (_al)->list; \
132			(_al)->list = &_ale->entry; \
133			break; \
134			} \
135			_alep = &_ale->entry.next; \
136			} \
137			} \
138			JS_END_MACRO
139
140			struct JSAtomMap {
141			JSAtom *vector; / array of ptrs to indexed atoms */
142			jsatomid length; /* count of (to-be-)indexed atoms */
143			};
144
145			struct JSAtomState {
146			JSDHashTable stringAtoms; /* hash table with shared strings */
147			JSDHashTable doubleAtoms; /* hash table with shared doubles */
148			#ifdef JS_THREADSAFE
149			JSThinLock lock;
150			#endif
151
152			/*
153			* From this point until the end of struct definition the struct must
154			* contain only JSAtom fields. We use this to access the storage occupied
155			* by the common atoms in js_FinishCommonAtoms.
156			*
157			* js_common_atom_names defined in jsatom.c contains C strings for atoms
158			* in the order of atom fields here. Therefore you must update that array
159			* if you change member order here.
160			*/
161
162			/* The rt->emptyString atom, see jsstr.c's js_InitRuntimeStringState. */
163			JSAtom *emptyAtom;
164
165			/* Type names and value literals. */
166			JSAtom *typeAtoms[JSTYPE_LIMIT];
167			JSAtom *booleanAtoms[2];
168			JSAtom *nullAtom;
169
170			/* Standard class constructor or prototype names. */
171			JSAtom *classAtoms[JSProto_LIMIT];
172
173			/* Various built-in or commonly-used atoms, pinned on first context. */
174			JSAtom *anonymousAtom;
175			JSAtom *argumentsAtom;
176			JSAtom *arityAtom;
177			JSAtom *calleeAtom;
178			JSAtom *callerAtom;
179			JSAtom *classPrototypeAtom;
180			JSAtom *constructorAtom;
181			JSAtom *countAtom;
182			JSAtom *eachAtom;
183			JSAtom *evalAtom;
184			JSAtom *fileNameAtom;
185			JSAtom *getAtom;
186			JSAtom *getterAtom;
187			JSAtom *indexAtom;
188			JSAtom *inputAtom;
189			JSAtom *iteratorAtom;
190			JSAtom *lengthAtom;
191			JSAtom *lineNumberAtom;
192			JSAtom *messageAtom;
193			JSAtom *nameAtom;
194			JSAtom *nextAtom;
195			JSAtom *noSuchMethodAtom;
196			JSAtom *parentAtom;
197			JSAtom *protoAtom;
198			JSAtom *setAtom;
199			JSAtom *setterAtom;
200			JSAtom *stackAtom;
201			JSAtom *toLocaleStringAtom;
202			JSAtom *toSourceAtom;
203			JSAtom *toStringAtom;
204			JSAtom *valueOfAtom;
205			JSAtom *toJSONAtom;
206			JSAtom *void0Atom;
207
208			#if JS_HAS_XML_SUPPORT
209			JSAtom *etagoAtom;
210			JSAtom *namespaceAtom;
211			JSAtom *ptagcAtom;
212			JSAtom *qualifierAtom;
213			JSAtom *spaceAtom;
214			JSAtom *stagoAtom;
215			JSAtom *starAtom;
216			JSAtom *starQualifierAtom;
217			JSAtom *tagcAtom;
218			JSAtom *xmlAtom;
219			#endif
220
221			#ifdef NARCISSUS
222			JSAtom *callAtom;
223			JSAtom *constructAtom;
224			JSAtom *hasInstanceAtom;
225			JSAtom *ExecutionContextAtom;
226			JSAtom *currentAtom;
227			#endif
228
229			/* Less frequently used atoms, pinned lazily by JS_ResolveStandardClass. */
230			struct {
231			JSAtom *InfinityAtom;
232			JSAtom *NaNAtom;
233			JSAtom *XMLListAtom;
234			JSAtom *decodeURIAtom;
235			JSAtom *decodeURIComponentAtom;
236			JSAtom *defineGetterAtom;
237			JSAtom *defineSetterAtom;
238			JSAtom *encodeURIAtom;
239			JSAtom *encodeURIComponentAtom;
240			JSAtom *escapeAtom;
241			JSAtom *functionNamespaceURIAtom;
242			JSAtom *hasOwnPropertyAtom;
243			JSAtom *isFiniteAtom;
244			JSAtom *isNaNAtom;
245			JSAtom *isPrototypeOfAtom;
246			JSAtom *isXMLNameAtom;
247			JSAtom *lookupGetterAtom;
248			JSAtom *lookupSetterAtom;
249			JSAtom *parseFloatAtom;
250			JSAtom *parseIntAtom;
251			JSAtom *propertyIsEnumerableAtom;
252			JSAtom *unescapeAtom;
253			JSAtom *unevalAtom;
254			JSAtom *unwatchAtom;
255			JSAtom *watchAtom;
256			} lazy;
257			};
258
259			#define ATOM_OFFSET_START offsetof(JSAtomState, emptyAtom)
260			#define LAZY_ATOM_OFFSET_START offsetof(JSAtomState, lazy)
261			#define ATOM_OFFSET_LIMIT (sizeof(JSAtomState))
262
263			#define COMMON_ATOMS_START(state) \
264			(JSAtom *)((uint8 )(state) + ATOM_OFFSET_START)
265
266			/* Start and limit offsets should correspond to atoms. */
267			JS_STATIC_ASSERT(ATOM_OFFSET_START % sizeof(JSAtom *) == 0);
268			JS_STATIC_ASSERT(ATOM_OFFSET_LIMIT % sizeof(JSAtom *) == 0);
269
270			#define ATOM_OFFSET(name) offsetof(JSAtomState, name##Atom)
271			#define OFFSET_TO_ATOM(rt,off) ((JSAtom )((char)&(rt)->atomState + (off)))
272			#define CLASS_ATOM_OFFSET(name) offsetof(JSAtomState,classAtoms[JSProto_##name])
273
274			#define CLASS_ATOM(cx,name) \
275			((cx)->runtime->atomState.classAtoms[JSProto_##name])
276
277			extern const char *const js_common_atom_names[];
278
279			/*
280			* Macros to access C strings for JSType and boolean literals together with
281			* checks that type names and booleans starts from index 1 and 1+JSTYPE_LIMIT
282			* correspondingly.
283			*/
284			#define JS_TYPE_STR(type) (js_common_atom_names[1 + (type)])
285			#define JS_BOOLEAN_STR(type) (js_common_atom_names[1 + JSTYPE_LIMIT + (type)])
286
287			JS_STATIC_ASSERT(1 * sizeof(JSAtom *) ==
288			offsetof(JSAtomState, typeAtoms) - ATOM_OFFSET_START);
289			JS_STATIC_ASSERT((1 + JSTYPE_LIMIT) * sizeof(JSAtom *) ==
290			offsetof(JSAtomState, booleanAtoms) - ATOM_OFFSET_START);
291
292			/* Well-known predefined C strings. */
293			#define JS_PROTO(name,code,init) extern const char js_##name##_str[];
294			#include "jsproto.tbl"
295			#undef JS_PROTO
296
297			extern const char js_anonymous_str[];
298			extern const char js_arguments_str[];
299			extern const char js_arity_str[];
300			extern const char js_callee_str[];
301			extern const char js_caller_str[];
302			extern const char js_class_prototype_str[];
303			extern const char js_close_str[];
304			extern const char js_constructor_str[];
305			extern const char js_count_str[];
306			extern const char js_etago_str[];
307			extern const char js_each_str[];
308			extern const char js_eval_str[];
309			extern const char js_fileName_str[];
310			extern const char js_get_str[];
311			extern const char js_getter_str[];
312			extern const char js_index_str[];
313			extern const char js_input_str[];
314			extern const char js_iterator_str[];
315			extern const char js_length_str[];
316			extern const char js_lineNumber_str[];
317			extern const char js_message_str[];
318			extern const char js_name_str[];
319			extern const char js_namespace_str[];
320			extern const char js_next_str[];
321			extern const char js_noSuchMethod_str[];
322			extern const char js_object_str[];
323			extern const char js_parent_str[];
324			extern const char js_proto_str[];
325			extern const char js_ptagc_str[];
326			extern const char js_qualifier_str[];
327			extern const char js_send_str[];
328			extern const char js_setter_str[];
329			extern const char js_set_str[];
330			extern const char js_space_str[];
331			extern const char js_stack_str[];
332			extern const char js_stago_str[];
333			extern const char js_star_str[];
334			extern const char js_starQualifier_str[];
335			extern const char js_tagc_str[];
336			extern const char js_toSource_str[];
337			extern const char js_toString_str[];
338			extern const char js_toLocaleString_str[];
339			extern const char js_undefined_str[];
340			extern const char js_valueOf_str[];
341			extern const char js_toJSON_str[];
342			extern const char js_xml_str[];
343
344			#ifdef NARCISSUS
345			extern const char js_call_str[];
346			extern const char js_construct_str[];
347			extern const char js_hasInstance_str[];
348			extern const char js_ExecutionContext_str[];
349			extern const char js_current_str[];
350			#endif
351
352			/*
353			* Initialize atom state. Return true on success, false on failure to allocate
354			* memory. The caller must zero rt->atomState before calling this function and
355			* only call it after js_InitGC successfully returns.
356			*/
357			extern JSBool
358			js_InitAtomState(JSRuntime *rt);
359
360			/*
361			* Free and clear atom state including any interned string atoms. This
362			* function must be called before js_FinishGC.
363			*/
364			extern void
365			js_FinishAtomState(JSRuntime *rt);
366
367			/*
368			* Atom tracing and garbage collection hooks.
369			*/
370
371			extern void
372			js_TraceAtomState(JSTracer *trc, JSBool allAtoms);
373
374			extern void
375			js_SweepAtomState(JSContext *cx);
376
377			extern JSBool
378			js_InitCommonAtoms(JSContext *cx);
379
380			extern void
381			js_FinishCommonAtoms(JSContext *cx);
382
383			/*
384			* Find or create the atom for a double value. Return null on failure to
385			* allocate memory.
386			*/
387			extern JSAtom *
388			js_AtomizeDouble(JSContext *cx, jsdouble d);
389
390			/*
391			* Find or create the atom for a string. Return null on failure to allocate
392			* memory.
393			*/
394			extern JSAtom *
395			js_AtomizeString(JSContext cx, JSString str, uintN flags);
396
397			extern JSAtom *
398			js_Atomize(JSContext cx, const char bytes, size_t length, uintN flags);
399
400			extern JSAtom *
401			js_AtomizeChars(JSContext cx, const jschar chars, size_t length, uintN flags);
402
403			/*
404			* Return an existing atom for the given char array or null if the char
405			* sequence is currently not atomized.
406			*/
407			extern JSAtom *
408			js_GetExistingStringAtom(JSContext cx, const jschar chars, size_t length);
409
410			/*
411			* This variant handles all primitive values.
412			*/
413			JSBool
414			js_AtomizePrimitiveValue(JSContext cx, jsval v, JSAtom *atomp);
415
416			/*
417			* Convert v to an atomized string and wrap it as an id.
418			*/
419			extern JSBool
420			js_ValueToStringId(JSContext cx, jsval v, jsid idp);
421
422			#ifdef DEBUG
423
424			extern JS_FRIEND_API(void)
425			js_DumpAtoms(JSContext cx, FILE fp);
426
427			#endif
428
429			/*
430			* Assign atom an index and insert it on al.
431			*/
432			extern JSAtomListElement *
433			js_IndexAtom(JSContext cx, JSAtom atom, JSAtomList *al);
434
435			/*
436			* For all unmapped atoms recorded in al, add a mapping from the atom's index
437			* to its address. map->length must already be set to the number of atoms in
438			* the list and map->vector must point to pre-allocated memory.
439			*/
440			extern void
441			js_InitAtomMap(JSContext cx, JSAtomMap map, JSAtomList *al);
442
443			JS_END_EXTERN_C
444
445			#endif /* jsatom_h___ */