2010-03-17 07:29:37 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
2013-04-16 20:47:10 +00:00
|
|
|
* vim: set ts=8 sts=4 et sw=4 tw=99:
|
2012-05-21 11:12:37 +00:00
|
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2013-02-01 22:24:37 +00:00
|
|
|
/* JavaScript API. */
|
|
|
|
|
2013-06-20 00:59:46 +00:00
|
|
|
#ifndef jsapi_h
|
|
|
|
#define jsapi_h
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
|
2012-01-23 11:43:16 +00:00
|
|
|
#include "mozilla/FloatingPoint.h"
|
2013-06-23 11:21:01 +00:00
|
|
|
#include "mozilla/MemoryReporting.h"
|
2012-10-31 01:28:34 +00:00
|
|
|
#include "mozilla/RangedPtr.h"
|
2012-12-27 17:20:22 +00:00
|
|
|
#include "mozilla/StandardInteger.h"
|
2012-10-31 01:28:34 +00:00
|
|
|
#include "mozilla/ThreadLocal.h"
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
|
2013-04-24 06:44:36 +00:00
|
|
|
#include <stdarg.h>
|
1998-03-28 02:44:41 +00:00
|
|
|
#include <stddef.h>
|
1999-04-27 15:18:57 +00:00
|
|
|
#include <stdio.h>
|
2013-02-01 21:07:10 +00:00
|
|
|
|
2008-10-29 15:29:37 +00:00
|
|
|
#include "js-config.h"
|
2013-02-01 21:07:10 +00:00
|
|
|
#include "jsalloc.h"
|
1998-03-28 02:44:41 +00:00
|
|
|
#include "jspubtd.h"
|
|
|
|
|
2013-03-01 04:07:23 +00:00
|
|
|
#include "js/CallArgs.h"
|
2013-01-28 13:46:10 +00:00
|
|
|
#include "js/CharacterEncoding.h"
|
2013-02-01 21:07:10 +00:00
|
|
|
#include "js/HashTable.h"
|
2013-03-12 21:05:57 +00:00
|
|
|
#include "js/RootingAPI.h"
|
2013-02-01 21:07:10 +00:00
|
|
|
#include "js/Utility.h"
|
2013-02-01 22:24:37 +00:00
|
|
|
#include "js/Value.h"
|
2013-02-01 21:07:10 +00:00
|
|
|
#include "js/Vector.h"
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/************************************************************************/
|
|
|
|
|
|
|
|
namespace JS {
|
|
|
|
|
2012-10-08 22:04:36 +00:00
|
|
|
typedef mozilla::RangedPtr<const jschar> CharPtr;
|
|
|
|
|
|
|
|
class StableCharPtr : public CharPtr {
|
|
|
|
public:
|
|
|
|
StableCharPtr(const StableCharPtr &s) : CharPtr(s) {}
|
|
|
|
StableCharPtr(const mozilla::RangedPtr<const jschar> &s) : CharPtr(s) {}
|
|
|
|
StableCharPtr(const jschar *s, size_t len) : CharPtr(s, len) {}
|
|
|
|
StableCharPtr(const jschar *pos, const jschar *start, size_t len)
|
|
|
|
: CharPtr(pos, start, len)
|
|
|
|
{}
|
|
|
|
};
|
|
|
|
|
2012-01-11 08:23:08 +00:00
|
|
|
#if defined JS_THREADSAFE && defined DEBUG
|
|
|
|
|
|
|
|
class JS_PUBLIC_API(AutoCheckRequestDepth)
|
|
|
|
{
|
|
|
|
JSContext *cx;
|
|
|
|
public:
|
|
|
|
AutoCheckRequestDepth(JSContext *cx);
|
2013-07-10 15:29:52 +00:00
|
|
|
AutoCheckRequestDepth(js::ContextFriendFields *cx);
|
2012-01-11 08:23:08 +00:00
|
|
|
~AutoCheckRequestDepth();
|
|
|
|
};
|
|
|
|
|
|
|
|
# define CHECK_REQUEST(cx) \
|
|
|
|
JS::AutoCheckRequestDepth _autoCheckRequestDepth(cx)
|
|
|
|
|
|
|
|
#else
|
|
|
|
|
|
|
|
# define CHECK_REQUEST(cx) \
|
|
|
|
((void) 0)
|
|
|
|
|
2012-03-28 23:35:21 +00:00
|
|
|
#endif /* JS_THREADSAFE && DEBUG */
|
|
|
|
|
|
|
|
#ifdef DEBUG
|
2012-08-02 19:59:30 +00:00
|
|
|
/*
|
|
|
|
* Assert that we're not doing GC on cx, that we're in a request as
|
|
|
|
* needed, and that the compartments for cx and v are correct.
|
|
|
|
* Also check that GC would be safe at this point.
|
|
|
|
*/
|
2012-03-28 23:35:21 +00:00
|
|
|
JS_PUBLIC_API(void)
|
|
|
|
AssertArgumentsAreSane(JSContext *cx, const Value &v);
|
|
|
|
#else
|
|
|
|
inline void AssertArgumentsAreSane(JSContext *cx, const Value &v) {
|
|
|
|
/* Do nothing */
|
|
|
|
}
|
|
|
|
#endif /* DEBUG */
|
2012-01-11 08:23:08 +00:00
|
|
|
|
|
|
|
class JS_PUBLIC_API(AutoGCRooter) {
|
|
|
|
public:
|
|
|
|
AutoGCRooter(JSContext *cx, ptrdiff_t tag);
|
2013-07-10 15:29:52 +00:00
|
|
|
AutoGCRooter(js::ContextFriendFields *cx, ptrdiff_t tag);
|
2012-02-29 12:18:16 +00:00
|
|
|
|
|
|
|
~AutoGCRooter() {
|
|
|
|
JS_ASSERT(this == *stackTop);
|
|
|
|
*stackTop = down;
|
|
|
|
}
|
2012-01-11 08:23:08 +00:00
|
|
|
|
2012-12-13 21:50:56 +00:00
|
|
|
/* Implemented in gc/RootMarking.cpp. */
|
2012-01-11 08:23:08 +00:00
|
|
|
inline void trace(JSTracer *trc);
|
2012-02-29 12:18:16 +00:00
|
|
|
static void traceAll(JSTracer *trc);
|
2012-10-04 05:44:30 +00:00
|
|
|
static void traceAllWrappers(JSTracer *trc);
|
2012-01-11 08:23:08 +00:00
|
|
|
|
|
|
|
protected:
|
|
|
|
AutoGCRooter * const down;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Discriminates actual subclass of this being used. If non-negative, the
|
|
|
|
* subclass roots an array of values of the length stored in this field.
|
|
|
|
* If negative, meaning is indicated by the corresponding value in the enum
|
|
|
|
* below. Any other negative value indicates some deeper problem such as
|
|
|
|
* memory corruption.
|
|
|
|
*/
|
2013-02-18 06:56:32 +00:00
|
|
|
ptrdiff_t tag_;
|
2012-01-11 08:23:08 +00:00
|
|
|
|
|
|
|
enum {
|
2013-02-08 21:44:35 +00:00
|
|
|
VALARRAY = -2, /* js::AutoValueArray */
|
2012-07-09 18:54:28 +00:00
|
|
|
PARSER = -3, /* js::frontend::Parser */
|
2012-01-11 08:23:08 +00:00
|
|
|
SHAPEVECTOR = -4, /* js::AutoShapeVector */
|
|
|
|
IDARRAY = -6, /* js::AutoIdArray */
|
|
|
|
DESCRIPTORS = -7, /* js::AutoPropDescArrayRooter */
|
2013-04-04 09:39:05 +00:00
|
|
|
ID = -9, /* js::AutoIdRooter */
|
|
|
|
VALVECTOR = -10, /* js::AutoValueVector */
|
|
|
|
DESCRIPTOR = -11, /* js::AutoPropertyDescriptorRooter */
|
|
|
|
STRING = -12, /* js::AutoStringRooter */
|
|
|
|
IDVECTOR = -13, /* js::AutoIdVector */
|
|
|
|
OBJVECTOR = -14, /* js::AutoObjectVector */
|
|
|
|
STRINGVECTOR =-15, /* js::AutoStringVector */
|
|
|
|
SCRIPTVECTOR =-16, /* js::AutoScriptVector */
|
|
|
|
NAMEVECTOR = -17, /* js::AutoNameVector */
|
|
|
|
HASHABLEVALUE=-18, /* js::HashableValue */
|
|
|
|
IONMASM = -19, /* js::ion::MacroAssembler */
|
|
|
|
IONALLOC = -20, /* js::ion::AutoTempAllocatorRooter */
|
|
|
|
WRAPVECTOR = -21, /* js::AutoWrapperVector */
|
|
|
|
WRAPPER = -22, /* js::AutoWrapperRooter */
|
|
|
|
OBJOBJHASHMAP=-23, /* js::AutoObjectObjectHashMap */
|
|
|
|
OBJU32HASHMAP=-24, /* js::AutoObjectUnsigned32HashMap */
|
|
|
|
OBJHASHSET = -25, /* js::AutoObjectHashSet */
|
|
|
|
JSONPARSER = -26, /* js::JSONParser */
|
2013-06-14 20:48:39 +00:00
|
|
|
CUSTOM = -27, /* js::CustomAutoRooter */
|
|
|
|
FUNVECTOR = -28 /* js::AutoFunctionVector */
|
2012-01-11 08:23:08 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
private:
|
2012-02-29 12:18:16 +00:00
|
|
|
AutoGCRooter ** const stackTop;
|
|
|
|
|
2012-01-11 08:23:08 +00:00
|
|
|
/* No copy or assignment semantics. */
|
|
|
|
AutoGCRooter(AutoGCRooter &ida) MOZ_DELETE;
|
|
|
|
void operator=(AutoGCRooter &ida) MOZ_DELETE;
|
|
|
|
};
|
|
|
|
|
2012-01-11 08:23:08 +00:00
|
|
|
class AutoStringRooter : private AutoGCRooter {
|
|
|
|
public:
|
|
|
|
AutoStringRooter(JSContext *cx, JSString *str = NULL
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2013-02-18 06:56:32 +00:00
|
|
|
: AutoGCRooter(cx, STRING), str_(str)
|
2012-01-11 08:23:08 +00:00
|
|
|
{
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2012-01-11 08:23:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void setString(JSString *str) {
|
2013-02-18 06:56:32 +00:00
|
|
|
str_ = str;
|
2012-01-11 08:23:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
JSString * string() const {
|
2013-02-18 06:56:32 +00:00
|
|
|
return str_;
|
2012-01-11 08:23:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
JSString ** addr() {
|
2013-02-18 06:56:32 +00:00
|
|
|
return &str_;
|
2012-01-11 08:23:08 +00:00
|
|
|
}
|
|
|
|
|
2012-11-02 15:12:45 +00:00
|
|
|
JSString * const * addr() const {
|
2013-02-18 06:56:32 +00:00
|
|
|
return &str_;
|
2012-11-02 15:12:45 +00:00
|
|
|
}
|
|
|
|
|
2012-01-11 08:23:08 +00:00
|
|
|
friend void AutoGCRooter::trace(JSTracer *trc);
|
|
|
|
|
|
|
|
private:
|
2013-02-18 06:56:32 +00:00
|
|
|
JSString *str_;
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2012-01-11 08:23:08 +00:00
|
|
|
};
|
|
|
|
|
2012-01-11 08:23:09 +00:00
|
|
|
class AutoArrayRooter : private AutoGCRooter {
|
|
|
|
public:
|
|
|
|
AutoArrayRooter(JSContext *cx, size_t len, Value *vec
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2012-05-01 00:10:30 +00:00
|
|
|
: AutoGCRooter(cx, len), array(vec), skip(cx, array, len)
|
2012-01-11 08:23:09 +00:00
|
|
|
{
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2013-02-18 06:56:32 +00:00
|
|
|
JS_ASSERT(tag_ >= 0);
|
2012-01-11 08:23:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void changeLength(size_t newLength) {
|
2013-02-18 06:56:32 +00:00
|
|
|
tag_ = ptrdiff_t(newLength);
|
|
|
|
JS_ASSERT(tag_ >= 0);
|
2012-01-11 08:23:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void changeArray(Value *newArray, size_t newLength) {
|
|
|
|
changeLength(newLength);
|
|
|
|
array = newArray;
|
|
|
|
}
|
|
|
|
|
|
|
|
Value *array;
|
|
|
|
|
2013-01-11 08:42:59 +00:00
|
|
|
MutableHandleValue handleAt(size_t i)
|
|
|
|
{
|
2013-02-18 06:56:32 +00:00
|
|
|
JS_ASSERT(i < size_t(tag_));
|
2013-01-11 08:42:59 +00:00
|
|
|
return MutableHandleValue::fromMarkedLocation(&array[i]);
|
|
|
|
}
|
|
|
|
HandleValue handleAt(size_t i) const
|
|
|
|
{
|
2013-02-18 06:56:32 +00:00
|
|
|
JS_ASSERT(i < size_t(tag_));
|
2013-01-11 08:42:59 +00:00
|
|
|
return HandleValue::fromMarkedLocation(&array[i]);
|
|
|
|
}
|
|
|
|
|
2012-01-11 08:23:09 +00:00
|
|
|
friend void AutoGCRooter::trace(JSTracer *trc);
|
|
|
|
|
|
|
|
private:
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2012-05-01 00:10:30 +00:00
|
|
|
|
2012-09-25 01:08:22 +00:00
|
|
|
js::SkipRoot skip;
|
2012-01-11 08:23:09 +00:00
|
|
|
};
|
|
|
|
|
2012-01-15 08:13:11 +00:00
|
|
|
template<class T>
|
|
|
|
class AutoVectorRooter : protected AutoGCRooter
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
explicit AutoVectorRooter(JSContext *cx, ptrdiff_t tag
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2012-04-12 16:23:51 +00:00
|
|
|
: AutoGCRooter(cx, tag), vector(cx), vectorRoot(cx, &vector)
|
2012-01-15 08:13:11 +00:00
|
|
|
{
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2012-01-15 08:13:11 +00:00
|
|
|
}
|
|
|
|
|
2013-07-10 15:29:52 +00:00
|
|
|
explicit AutoVectorRooter(js::ContextFriendFields *cx, ptrdiff_t tag
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
|
|
|
: AutoGCRooter(cx, tag), vector(cx), vectorRoot(cx, &vector)
|
|
|
|
{
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
|
|
|
}
|
|
|
|
|
2012-07-30 18:38:53 +00:00
|
|
|
typedef T ElementType;
|
|
|
|
|
2012-01-15 08:13:11 +00:00
|
|
|
size_t length() const { return vector.length(); }
|
2012-08-13 01:50:49 +00:00
|
|
|
bool empty() const { return vector.empty(); }
|
2012-01-15 08:13:11 +00:00
|
|
|
|
|
|
|
bool append(const T &v) { return vector.append(v); }
|
2013-07-09 23:33:29 +00:00
|
|
|
bool appendAll(const AutoVectorRooter<T> &other) {
|
|
|
|
return vector.appendAll(other.vector);
|
2012-08-10 11:55:55 +00:00
|
|
|
}
|
2012-01-15 08:13:11 +00:00
|
|
|
|
2013-04-10 18:04:24 +00:00
|
|
|
bool insert(T *p, const T &val) { return vector.insert(p, val); }
|
|
|
|
|
2012-01-15 08:13:11 +00:00
|
|
|
/* For use when space has already been reserved. */
|
|
|
|
void infallibleAppend(const T &v) { vector.infallibleAppend(v); }
|
|
|
|
|
|
|
|
void popBack() { vector.popBack(); }
|
|
|
|
T popCopy() { return vector.popCopy(); }
|
|
|
|
|
|
|
|
bool growBy(size_t inc) {
|
|
|
|
size_t oldLength = vector.length();
|
|
|
|
if (!vector.growByUninitialized(inc))
|
|
|
|
return false;
|
|
|
|
makeRangeGCSafe(oldLength);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool resize(size_t newLength) {
|
|
|
|
size_t oldLength = vector.length();
|
|
|
|
if (newLength <= oldLength) {
|
|
|
|
vector.shrinkBy(oldLength - newLength);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
if (!vector.growByUninitialized(newLength - oldLength))
|
|
|
|
return false;
|
|
|
|
makeRangeGCSafe(oldLength);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
void clear() { vector.clear(); }
|
|
|
|
|
|
|
|
bool reserve(size_t newLength) {
|
|
|
|
return vector.reserve(newLength);
|
|
|
|
}
|
|
|
|
|
|
|
|
T &operator[](size_t i) { return vector[i]; }
|
|
|
|
const T &operator[](size_t i) const { return vector[i]; }
|
|
|
|
|
2012-07-18 21:31:24 +00:00
|
|
|
JS::MutableHandle<T> handleAt(size_t i) { return JS::MutableHandle<T>::fromMarkedLocation(&vector[i]); }
|
2012-06-21 21:18:02 +00:00
|
|
|
JS::Handle<T> handleAt(size_t i) const { return JS::Handle<T>::fromMarkedLocation(&vector[i]); }
|
|
|
|
|
2012-01-15 08:13:11 +00:00
|
|
|
const T *begin() const { return vector.begin(); }
|
|
|
|
T *begin() { return vector.begin(); }
|
|
|
|
|
|
|
|
const T *end() const { return vector.end(); }
|
|
|
|
T *end() { return vector.end(); }
|
|
|
|
|
|
|
|
const T &back() const { return vector.back(); }
|
|
|
|
|
|
|
|
friend void AutoGCRooter::trace(JSTracer *trc);
|
|
|
|
|
|
|
|
private:
|
|
|
|
void makeRangeGCSafe(size_t oldLength) {
|
|
|
|
T *t = vector.begin() + oldLength;
|
|
|
|
for (size_t i = oldLength; i < vector.length(); ++i, ++t)
|
|
|
|
memset(t, 0, sizeof(T));
|
|
|
|
}
|
|
|
|
|
|
|
|
typedef js::Vector<T, 8> VectorImpl;
|
|
|
|
VectorImpl vector;
|
2012-04-12 16:23:51 +00:00
|
|
|
|
|
|
|
/* Prevent overwriting of inline elements in vector. */
|
2012-09-25 01:08:22 +00:00
|
|
|
js::SkipRoot vectorRoot;
|
2012-04-12 16:23:51 +00:00
|
|
|
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2012-01-15 08:13:11 +00:00
|
|
|
};
|
|
|
|
|
2012-12-13 21:50:56 +00:00
|
|
|
template<class Key, class Value>
|
|
|
|
class AutoHashMapRooter : protected AutoGCRooter
|
|
|
|
{
|
|
|
|
private:
|
|
|
|
typedef js::HashMap<Key, Value> HashMapImpl;
|
|
|
|
|
|
|
|
public:
|
|
|
|
explicit AutoHashMapRooter(JSContext *cx, ptrdiff_t tag
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2012-12-13 21:50:56 +00:00
|
|
|
: AutoGCRooter(cx, tag), map(cx)
|
|
|
|
{
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2012-12-13 21:50:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
typedef Key KeyType;
|
|
|
|
typedef Value ValueType;
|
|
|
|
typedef typename HashMapImpl::Lookup Lookup;
|
|
|
|
typedef typename HashMapImpl::Ptr Ptr;
|
|
|
|
typedef typename HashMapImpl::AddPtr AddPtr;
|
|
|
|
|
|
|
|
bool init(uint32_t len = 16) {
|
|
|
|
return map.init(len);
|
|
|
|
}
|
|
|
|
bool initialized() const {
|
|
|
|
return map.initialized();
|
|
|
|
}
|
|
|
|
Ptr lookup(const Lookup &l) const {
|
|
|
|
return map.lookup(l);
|
|
|
|
}
|
|
|
|
void remove(Ptr p) {
|
|
|
|
map.remove(p);
|
|
|
|
}
|
|
|
|
AddPtr lookupForAdd(const Lookup &l) const {
|
|
|
|
return map.lookupForAdd(l);
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename KeyInput, typename ValueInput>
|
|
|
|
bool add(AddPtr &p, const KeyInput &k, const ValueInput &v) {
|
2013-02-07 08:22:28 +00:00
|
|
|
return map.add(p, k, v);
|
2012-12-13 21:50:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
bool add(AddPtr &p, const Key &k) {
|
|
|
|
return map.add(p, k);
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename KeyInput, typename ValueInput>
|
|
|
|
bool relookupOrAdd(AddPtr &p, const KeyInput &k, const ValueInput &v) {
|
|
|
|
return map.relookupOrAdd(p, k, v);
|
|
|
|
}
|
|
|
|
|
|
|
|
typedef typename HashMapImpl::Range Range;
|
|
|
|
Range all() const {
|
|
|
|
return map.all();
|
|
|
|
}
|
|
|
|
|
|
|
|
typedef typename HashMapImpl::Enum Enum;
|
|
|
|
|
|
|
|
void clear() {
|
|
|
|
map.clear();
|
|
|
|
}
|
|
|
|
|
|
|
|
void finish() {
|
|
|
|
map.finish();
|
|
|
|
}
|
|
|
|
|
|
|
|
bool empty() const {
|
|
|
|
return map.empty();
|
|
|
|
}
|
|
|
|
|
|
|
|
uint32_t count() const {
|
|
|
|
return map.count();
|
|
|
|
}
|
|
|
|
|
|
|
|
size_t capacity() const {
|
|
|
|
return map.capacity();
|
|
|
|
}
|
|
|
|
|
2013-06-23 11:21:01 +00:00
|
|
|
size_t sizeOfExcludingThis(mozilla::MallocSizeOf mallocSizeOf) const {
|
2012-12-13 21:50:56 +00:00
|
|
|
return map.sizeOfExcludingThis(mallocSizeOf);
|
|
|
|
}
|
2013-06-23 11:21:01 +00:00
|
|
|
size_t sizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf) const {
|
2012-12-13 21:50:56 +00:00
|
|
|
return map.sizeOfIncludingThis(mallocSizeOf);
|
|
|
|
}
|
|
|
|
|
|
|
|
unsigned generation() const {
|
|
|
|
return map.generation();
|
|
|
|
}
|
|
|
|
|
|
|
|
/************************************************** Shorthand operations */
|
|
|
|
|
|
|
|
bool has(const Lookup &l) const {
|
|
|
|
return map.has(l);
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename KeyInput, typename ValueInput>
|
|
|
|
bool put(const KeyInput &k, const ValueInput &v) {
|
|
|
|
return map.put(k, v);
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename KeyInput, typename ValueInput>
|
|
|
|
bool putNew(const KeyInput &k, const ValueInput &v) {
|
|
|
|
return map.putNew(k, v);
|
|
|
|
}
|
|
|
|
|
|
|
|
Ptr lookupWithDefault(const Key &k, const Value &defaultValue) {
|
|
|
|
return map.lookupWithDefault(k, defaultValue);
|
|
|
|
}
|
|
|
|
|
|
|
|
void remove(const Lookup &l) {
|
|
|
|
map.remove(l);
|
|
|
|
}
|
|
|
|
|
|
|
|
friend void AutoGCRooter::trace(JSTracer *trc);
|
|
|
|
|
|
|
|
private:
|
|
|
|
AutoHashMapRooter(const AutoHashMapRooter &hmr) MOZ_DELETE;
|
|
|
|
AutoHashMapRooter &operator=(const AutoHashMapRooter &hmr) MOZ_DELETE;
|
|
|
|
|
|
|
|
HashMapImpl map;
|
|
|
|
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2012-12-13 21:50:56 +00:00
|
|
|
};
|
|
|
|
|
2013-02-07 08:22:28 +00:00
|
|
|
template<class T>
|
|
|
|
class AutoHashSetRooter : protected AutoGCRooter
|
|
|
|
{
|
|
|
|
private:
|
|
|
|
typedef js::HashSet<T> HashSetImpl;
|
|
|
|
|
|
|
|
public:
|
|
|
|
explicit AutoHashSetRooter(JSContext *cx, ptrdiff_t tag
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
|
|
|
: AutoGCRooter(cx, tag), set(cx)
|
|
|
|
{
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
|
|
|
}
|
|
|
|
|
|
|
|
typedef typename HashSetImpl::Lookup Lookup;
|
|
|
|
typedef typename HashSetImpl::Ptr Ptr;
|
|
|
|
typedef typename HashSetImpl::AddPtr AddPtr;
|
|
|
|
|
|
|
|
bool init(uint32_t len = 16) {
|
|
|
|
return set.init(len);
|
|
|
|
}
|
|
|
|
bool initialized() const {
|
|
|
|
return set.initialized();
|
|
|
|
}
|
|
|
|
Ptr lookup(const Lookup &l) const {
|
|
|
|
return set.lookup(l);
|
|
|
|
}
|
|
|
|
void remove(Ptr p) {
|
|
|
|
set.remove(p);
|
|
|
|
}
|
|
|
|
AddPtr lookupForAdd(const Lookup &l) const {
|
|
|
|
return set.lookupForAdd(l);
|
|
|
|
}
|
|
|
|
|
|
|
|
bool add(AddPtr &p, const T &t) {
|
|
|
|
return set.add(p, t);
|
|
|
|
}
|
|
|
|
|
|
|
|
bool relookupOrAdd(AddPtr &p, const Lookup &l, const T &t) {
|
|
|
|
return set.relookupOrAdd(p, l, t);
|
|
|
|
}
|
|
|
|
|
|
|
|
typedef typename HashSetImpl::Range Range;
|
|
|
|
Range all() const {
|
|
|
|
return set.all();
|
|
|
|
}
|
|
|
|
|
|
|
|
typedef typename HashSetImpl::Enum Enum;
|
|
|
|
|
|
|
|
void clear() {
|
|
|
|
set.clear();
|
|
|
|
}
|
|
|
|
|
|
|
|
void finish() {
|
|
|
|
set.finish();
|
|
|
|
}
|
|
|
|
|
|
|
|
bool empty() const {
|
|
|
|
return set.empty();
|
|
|
|
}
|
|
|
|
|
|
|
|
uint32_t count() const {
|
|
|
|
return set.count();
|
|
|
|
}
|
|
|
|
|
|
|
|
size_t capacity() const {
|
|
|
|
return set.capacity();
|
|
|
|
}
|
|
|
|
|
2013-06-23 11:21:01 +00:00
|
|
|
size_t sizeOfExcludingThis(mozilla::MallocSizeOf mallocSizeOf) const {
|
2013-02-07 08:22:28 +00:00
|
|
|
return set.sizeOfExcludingThis(mallocSizeOf);
|
|
|
|
}
|
2013-06-23 11:21:01 +00:00
|
|
|
size_t sizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf) const {
|
2013-02-07 08:22:28 +00:00
|
|
|
return set.sizeOfIncludingThis(mallocSizeOf);
|
|
|
|
}
|
|
|
|
|
|
|
|
unsigned generation() const {
|
|
|
|
return set.generation();
|
|
|
|
}
|
|
|
|
|
|
|
|
/************************************************** Shorthand operations */
|
|
|
|
|
|
|
|
bool has(const Lookup &l) const {
|
|
|
|
return set.has(l);
|
|
|
|
}
|
|
|
|
|
|
|
|
bool put(const T &t) {
|
|
|
|
return set.put(t);
|
|
|
|
}
|
|
|
|
|
|
|
|
bool putNew(const T &t) {
|
|
|
|
return set.putNew(t);
|
|
|
|
}
|
|
|
|
|
|
|
|
void remove(const Lookup &l) {
|
|
|
|
set.remove(l);
|
|
|
|
}
|
|
|
|
|
|
|
|
friend void AutoGCRooter::trace(JSTracer *trc);
|
|
|
|
|
|
|
|
private:
|
|
|
|
AutoHashSetRooter(const AutoHashSetRooter &hmr) MOZ_DELETE;
|
|
|
|
AutoHashSetRooter &operator=(const AutoHashSetRooter &hmr) MOZ_DELETE;
|
|
|
|
|
|
|
|
HashSetImpl set;
|
|
|
|
|
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
|
|
|
};
|
|
|
|
|
2012-01-15 08:13:11 +00:00
|
|
|
class AutoValueVector : public AutoVectorRooter<Value>
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
explicit AutoValueVector(JSContext *cx
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2012-01-15 08:13:11 +00:00
|
|
|
: AutoVectorRooter<Value>(cx, VALVECTOR)
|
|
|
|
{
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2012-01-15 08:13:11 +00:00
|
|
|
}
|
|
|
|
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2012-01-15 08:13:11 +00:00
|
|
|
};
|
|
|
|
|
2012-01-15 08:13:11 +00:00
|
|
|
class AutoIdVector : public AutoVectorRooter<jsid>
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
explicit AutoIdVector(JSContext *cx
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2012-01-15 08:13:11 +00:00
|
|
|
: AutoVectorRooter<jsid>(cx, IDVECTOR)
|
|
|
|
{
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2012-01-15 08:13:11 +00:00
|
|
|
}
|
|
|
|
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2012-01-15 08:13:11 +00:00
|
|
|
};
|
|
|
|
|
2013-05-03 20:53:07 +00:00
|
|
|
class AutoObjectVector : public AutoVectorRooter<JSObject *>
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
explicit AutoObjectVector(JSContext *cx
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
|
|
|
: AutoVectorRooter<JSObject *>(cx, OBJVECTOR)
|
|
|
|
{
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
|
|
|
}
|
|
|
|
|
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
|
|
|
};
|
|
|
|
|
2013-06-14 20:48:39 +00:00
|
|
|
class AutoFunctionVector : public AutoVectorRooter<JSFunction *>
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
explicit AutoFunctionVector(JSContext *cx
|
2013-07-10 15:29:52 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
|
|
|
: AutoVectorRooter<JSFunction *>(cx, FUNVECTOR)
|
|
|
|
{
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
|
|
|
}
|
|
|
|
|
|
|
|
explicit AutoFunctionVector(js::ContextFriendFields *cx
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2013-06-14 20:48:39 +00:00
|
|
|
: AutoVectorRooter<JSFunction *>(cx, FUNVECTOR)
|
|
|
|
{
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
|
|
|
}
|
|
|
|
|
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
|
|
|
};
|
|
|
|
|
2012-03-03 01:19:56 +00:00
|
|
|
class AutoScriptVector : public AutoVectorRooter<JSScript *>
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
explicit AutoScriptVector(JSContext *cx
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2012-03-03 01:19:56 +00:00
|
|
|
: AutoVectorRooter<JSScript *>(cx, SCRIPTVECTOR)
|
|
|
|
{
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2012-03-03 01:19:56 +00:00
|
|
|
}
|
|
|
|
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2012-03-03 01:19:56 +00:00
|
|
|
};
|
|
|
|
|
2013-04-04 09:39:05 +00:00
|
|
|
/*
|
|
|
|
* Cutsom rooting behavior for internal and external clients.
|
|
|
|
*/
|
|
|
|
class JS_PUBLIC_API(CustomAutoRooter) : private AutoGCRooter
|
|
|
|
{
|
|
|
|
public:
|
2013-07-10 15:29:52 +00:00
|
|
|
template <typename CX>
|
|
|
|
explicit CustomAutoRooter(CX *cx MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2013-04-04 09:39:05 +00:00
|
|
|
: AutoGCRooter(cx, CUSTOM)
|
|
|
|
{
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
|
|
|
}
|
|
|
|
|
|
|
|
friend void AutoGCRooter::trace(JSTracer *trc);
|
|
|
|
|
|
|
|
protected:
|
|
|
|
/* Supplied by derived class to trace roots. */
|
|
|
|
virtual void trace(JSTracer *trc) = 0;
|
|
|
|
|
|
|
|
private:
|
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
|
|
|
};
|
|
|
|
|
2012-07-04 00:44:22 +00:00
|
|
|
/* Returns true if |v| is considered an acceptable this-value. */
|
|
|
|
typedef bool (*IsAcceptableThis)(const Value &v);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Implements the guts of a method; guaranteed to be provided an acceptable
|
|
|
|
* this-value, as determined by a corresponding IsAcceptableThis method.
|
|
|
|
*/
|
|
|
|
typedef bool (*NativeImpl)(JSContext *cx, CallArgs args);
|
|
|
|
|
|
|
|
namespace detail {
|
|
|
|
|
|
|
|
/* DON'T CALL THIS DIRECTLY. It's for use only by CallNonGenericMethod! */
|
|
|
|
extern JS_PUBLIC_API(bool)
|
|
|
|
CallMethodIfWrapped(JSContext *cx, IsAcceptableThis test, NativeImpl impl, CallArgs args);
|
|
|
|
|
|
|
|
} /* namespace detail */
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Methods usually act upon |this| objects only from a single global object and
|
|
|
|
* compartment. Sometimes, however, a method must act upon |this| values from
|
|
|
|
* multiple global objects or compartments. In such cases the |this| value a
|
|
|
|
* method might see will be wrapped, such that various access to the object --
|
|
|
|
* to its class, its private data, its reserved slots, and so on -- will not
|
|
|
|
* work properly without entering that object's compartment. This method
|
|
|
|
* implements a solution to this problem.
|
|
|
|
*
|
|
|
|
* To implement a method that accepts |this| values from multiple compartments,
|
|
|
|
* define two functions. The first function matches the IsAcceptableThis type
|
|
|
|
* and indicates whether the provided value is an acceptable |this| for the
|
|
|
|
* method; it must be a pure function only of its argument.
|
|
|
|
*
|
|
|
|
* static JSClass AnswerClass = { ... };
|
|
|
|
*
|
|
|
|
* static bool
|
|
|
|
* IsAnswerObject(const Value &v)
|
|
|
|
* {
|
|
|
|
* if (!v.isObject())
|
|
|
|
* return false;
|
|
|
|
* return JS_GetClass(&v.toObject()) == &AnswerClass;
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* The second function implements the NativeImpl signature and defines the
|
|
|
|
* behavior of the method when it is provided an acceptable |this| value.
|
|
|
|
* Aside from some typing niceties -- see the CallArgs interface for details --
|
|
|
|
* its interface is the same as that of JSNative.
|
|
|
|
*
|
|
|
|
* static bool
|
|
|
|
* answer_getAnswer_impl(JSContext *cx, JS::CallArgs args)
|
|
|
|
* {
|
|
|
|
* args.rval().setInt32(42);
|
|
|
|
* return true;
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* The implementation function is guaranteed to be called *only* with a |this|
|
|
|
|
* value which is considered acceptable.
|
|
|
|
*
|
|
|
|
* Now to implement the actual method, write a JSNative that calls the method
|
2012-08-16 18:40:05 +00:00
|
|
|
* declared below, passing the appropriate template and runtime arguments.
|
2012-07-04 00:44:22 +00:00
|
|
|
*
|
|
|
|
* static JSBool
|
|
|
|
* answer_getAnswer(JSContext *cx, unsigned argc, JS::Value *vp)
|
|
|
|
* {
|
|
|
|
* JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
|
2012-08-16 18:40:05 +00:00
|
|
|
* return JS::CallNonGenericMethod<IsAnswerObject, answer_getAnswer_impl>(cx, args);
|
2012-07-04 00:44:22 +00:00
|
|
|
* }
|
|
|
|
*
|
2012-08-16 18:40:05 +00:00
|
|
|
* Note that, because they are used as template arguments, the predicate
|
|
|
|
* and implementation functions must have external linkage. (This is
|
|
|
|
* unfortunate, but GCC wasn't inlining things as one would hope when we
|
|
|
|
* passed them as function arguments.)
|
|
|
|
*
|
2012-07-04 00:44:22 +00:00
|
|
|
* JS::CallNonGenericMethod will test whether |args.thisv()| is acceptable. If
|
|
|
|
* it is, it will call the provided implementation function, which will return
|
|
|
|
* a value and indicate success. If it is not, it will attempt to unwrap
|
|
|
|
* |this| and call the implementation function on the unwrapped |this|. If
|
|
|
|
* that succeeds, all well and good. If it doesn't succeed, a TypeError will
|
|
|
|
* be thrown.
|
|
|
|
*
|
|
|
|
* Note: JS::CallNonGenericMethod will only work correctly if it's called in
|
|
|
|
* tail position in a JSNative. Do not call it from any other place.
|
|
|
|
*/
|
2012-08-16 18:40:05 +00:00
|
|
|
template<IsAcceptableThis Test, NativeImpl Impl>
|
2012-07-04 00:44:22 +00:00
|
|
|
JS_ALWAYS_INLINE bool
|
2012-08-16 18:40:05 +00:00
|
|
|
CallNonGenericMethod(JSContext *cx, CallArgs args)
|
2012-07-04 00:44:22 +00:00
|
|
|
{
|
|
|
|
const Value &thisv = args.thisv();
|
2012-08-16 18:40:05 +00:00
|
|
|
if (Test(thisv))
|
|
|
|
return Impl(cx, args);
|
2012-07-04 00:44:22 +00:00
|
|
|
|
2012-08-16 18:40:05 +00:00
|
|
|
return detail::CallMethodIfWrapped(cx, Test, Impl, args);
|
|
|
|
}
|
|
|
|
|
2012-07-04 00:44:22 +00:00
|
|
|
JS_ALWAYS_INLINE bool
|
2012-08-16 18:40:05 +00:00
|
|
|
CallNonGenericMethod(JSContext *cx, IsAcceptableThis Test, NativeImpl Impl, CallArgs args)
|
2012-07-04 00:44:22 +00:00
|
|
|
{
|
|
|
|
const Value &thisv = args.thisv();
|
2012-08-16 18:40:05 +00:00
|
|
|
if (Test(thisv))
|
|
|
|
return Impl(cx, args);
|
2012-07-04 00:44:22 +00:00
|
|
|
|
2012-08-16 18:40:05 +00:00
|
|
|
return detail::CallMethodIfWrapped(cx, Test, Impl, args);
|
2012-07-04 00:44:22 +00:00
|
|
|
}
|
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
} /* namespace JS */
|
|
|
|
|
|
|
|
/************************************************************************/
|
|
|
|
|
2011-09-20 18:40:24 +00:00
|
|
|
/* JSClass operation signatures. */
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
2013-04-06 04:19:10 +00:00
|
|
|
* Add or get a property named by id in obj. Note the jsid id type -- id may
|
|
|
|
* be a string (Unicode property identifier) or an int (element index). The
|
|
|
|
* *vp out parameter, on success, is the new property value after the action.
|
2011-09-19 16:34:49 +00:00
|
|
|
*/
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSPropertyOp)(JSContext *cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id, JS::MutableHandle<JS::Value> vp);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Set a property named by id in obj, treating the assignment as strict
|
|
|
|
* mode code if strict is true. Note the jsid id type -- id may be a string
|
|
|
|
* (Unicode property identifier) or an int (element index). The *vp out
|
|
|
|
* parameter, on success, is the new property value after the
|
|
|
|
* set.
|
|
|
|
*/
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSStrictPropertyOp)(JSContext *cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id, JSBool strict, JS::MutableHandle<JS::Value> vp);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
2013-04-06 04:19:10 +00:00
|
|
|
/*
|
|
|
|
* Delete a property named by id in obj.
|
|
|
|
*
|
|
|
|
* If an error occurred, return false as per normal JSAPI error practice.
|
|
|
|
*
|
|
|
|
* If no error occurred, but the deletion attempt wasn't allowed (perhaps
|
|
|
|
* because the property was non-configurable), set *succeeded to false and
|
|
|
|
* return true. This will cause |delete obj[id]| to evaluate to false in
|
|
|
|
* non-strict mode code, and to throw a TypeError in strict mode code.
|
|
|
|
*
|
|
|
|
* If no error occurred and the deletion wasn't disallowed (this is *not* the
|
|
|
|
* same as saying that a deletion actually occurred -- deleting a non-existent
|
|
|
|
* property, or an inherited property, is allowed -- it's just pointless),
|
|
|
|
* set *succeeded to true and return true.
|
|
|
|
*/
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSDeletePropertyOp)(JSContext *cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id, JSBool *succeeded);
|
2013-04-06 04:19:10 +00:00
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
/*
|
|
|
|
* This function type is used for callbacks that enumerate the properties of
|
|
|
|
* a JSObject. The behavior depends on the value of enum_op:
|
|
|
|
*
|
|
|
|
* JSENUMERATE_INIT
|
|
|
|
* A new, opaque iterator state should be allocated and stored in *statep.
|
|
|
|
* (You can use PRIVATE_TO_JSVAL() to tag the pointer to be stored).
|
|
|
|
*
|
|
|
|
* The number of properties that will be enumerated should be returned as
|
|
|
|
* an integer jsval in *idp, if idp is non-null, and provided the number of
|
|
|
|
* enumerable properties is known. If idp is non-null and the number of
|
|
|
|
* enumerable properties can't be computed in advance, *idp should be set
|
|
|
|
* to JSVAL_ZERO.
|
|
|
|
*
|
|
|
|
* JSENUMERATE_INIT_ALL
|
|
|
|
* Used identically to JSENUMERATE_INIT, but exposes all properties of the
|
|
|
|
* object regardless of enumerability.
|
|
|
|
*
|
|
|
|
* JSENUMERATE_NEXT
|
|
|
|
* A previously allocated opaque iterator state is passed in via statep.
|
|
|
|
* Return the next jsid in the iteration using *idp. The opaque iterator
|
|
|
|
* state pointed at by statep is destroyed and *statep is set to JSVAL_NULL
|
|
|
|
* if there are no properties left to enumerate.
|
|
|
|
*
|
|
|
|
* JSENUMERATE_DESTROY
|
|
|
|
* Destroy the opaque iterator state previously allocated in *statep by a
|
|
|
|
* call to this function when enum_op was JSENUMERATE_INIT or
|
|
|
|
* JSENUMERATE_INIT_ALL.
|
|
|
|
*
|
|
|
|
* The return value is used to indicate success, with a value of JS_FALSE
|
|
|
|
* indicating failure.
|
|
|
|
*/
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSNewEnumerateOp)(JSContext *cx, JS::Handle<JSObject*> obj, JSIterateOp enum_op,
|
2013-06-19 10:32:27 +00:00
|
|
|
JS::MutableHandle<JS::Value> statep, JS::MutableHandleId idp);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* The old-style JSClass.enumerate op should define all lazy properties not
|
|
|
|
* yet reflected in obj.
|
|
|
|
*/
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSEnumerateOp)(JSContext *cx, JS::Handle<JSObject*> obj);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Resolve a lazy property named by id in obj by defining it directly in obj.
|
|
|
|
* Lazy properties are those reflected from some peer native property space
|
|
|
|
* (e.g., the DOM attributes for a given node reflected as obj) on demand.
|
|
|
|
*
|
|
|
|
* JS looks for a property in an object, and if not found, tries to resolve
|
|
|
|
* the given id. If resolve succeeds, the engine looks again in case resolve
|
|
|
|
* defined obj[id]. If no such property exists directly in obj, the process
|
|
|
|
* is repeated with obj's prototype, etc.
|
|
|
|
*
|
|
|
|
* NB: JSNewResolveOp provides a cheaper way to resolve lazy properties.
|
|
|
|
*/
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSResolveOp)(JSContext *cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Like JSResolveOp, but flags provide contextual information as follows:
|
|
|
|
*
|
|
|
|
* JSRESOLVE_ASSIGNING obj[id] is on the left-hand side of an assignment
|
|
|
|
*
|
|
|
|
* The *objp out parameter, on success, should be null to indicate that id
|
|
|
|
* was not resolved; and non-null, referring to obj or one of its prototypes,
|
2012-06-06 00:39:30 +00:00
|
|
|
* if id was resolved. The hook may assume *objp is null on entry.
|
2011-09-19 16:34:49 +00:00
|
|
|
*
|
|
|
|
* This hook instead of JSResolveOp is called via the JSClass.resolve member
|
|
|
|
* if JSCLASS_NEW_RESOLVE is set in JSClass.flags.
|
|
|
|
*/
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSNewResolveOp)(JSContext *cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id, unsigned flags,
|
2013-04-16 23:20:44 +00:00
|
|
|
JS::MutableHandleObject objp);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Convert obj to the given type, returning true with the resulting value in
|
|
|
|
* *vp on success, and returning false on error or exception.
|
|
|
|
*/
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSConvertOp)(JSContext *cx, JS::Handle<JSObject*> obj, JSType type,
|
|
|
|
JS::MutableHandle<JS::Value> vp);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
2012-03-19 14:34:55 +00:00
|
|
|
typedef struct JSFreeOp JSFreeOp;
|
|
|
|
|
|
|
|
struct JSFreeOp {
|
|
|
|
private:
|
|
|
|
JSRuntime *runtime_;
|
|
|
|
|
|
|
|
protected:
|
2012-03-19 14:34:58 +00:00
|
|
|
JSFreeOp(JSRuntime *rt)
|
|
|
|
: runtime_(rt) { }
|
2012-03-19 14:34:55 +00:00
|
|
|
|
|
|
|
public:
|
|
|
|
JSRuntime *runtime() const {
|
|
|
|
return runtime_;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
/*
|
|
|
|
* Finalize obj, which the garbage collector has determined to be unreachable
|
|
|
|
* from other live objects or from GC roots. Obviously, finalizers must never
|
|
|
|
* store a reference to obj.
|
|
|
|
*/
|
|
|
|
typedef void
|
2012-03-19 14:34:55 +00:00
|
|
|
(* JSFinalizeOp)(JSFreeOp *fop, JSObject *obj);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
2012-02-07 18:44:54 +00:00
|
|
|
* Finalizes external strings created by JS_NewExternalString.
|
2011-09-19 16:34:49 +00:00
|
|
|
*/
|
2012-02-07 18:44:54 +00:00
|
|
|
typedef struct JSStringFinalizer JSStringFinalizer;
|
|
|
|
|
|
|
|
struct JSStringFinalizer {
|
|
|
|
void (*finalize)(const JSStringFinalizer *fin, jschar *chars);
|
|
|
|
};
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* JSClass.checkAccess type: check whether obj[id] may be accessed per mode,
|
|
|
|
* returning false on error/exception, true on success with obj[id]'s last-got
|
|
|
|
* value in *vp, and its attributes in *attrsp. As for JSPropertyOp above, id
|
|
|
|
* is either a string or an int jsval.
|
|
|
|
*/
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSCheckAccessOp)(JSContext *cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id,
|
|
|
|
JSAccessMode mode, JS::MutableHandle<JS::Value> vp);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Check whether v is an instance of obj. Return false on error or exception,
|
|
|
|
* true on success with JS_TRUE in *bp if v is an instance of obj, JS_FALSE in
|
|
|
|
* *bp otherwise.
|
|
|
|
*/
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSHasInstanceOp)(JSContext *cx, JS::Handle<JSObject*> obj, JS::MutableHandle<JS::Value> vp,
|
|
|
|
JSBool *bp);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Function type for trace operation of the class called to enumerate all
|
|
|
|
* traceable things reachable from obj's private data structure. For each such
|
2013-03-28 20:37:22 +00:00
|
|
|
* thing, a trace implementation must call one of the JS_Call*Tracer variants
|
|
|
|
* on the thing.
|
2011-09-19 16:34:49 +00:00
|
|
|
*
|
|
|
|
* JSTraceOp implementation can assume that no other threads mutates object
|
|
|
|
* state. It must not change state of the object or corresponding native
|
|
|
|
* structures. The only exception for this rule is the case when the embedding
|
|
|
|
* needs a tight integration with GC. In that case the embedding can check if
|
|
|
|
* the traversal is a part of the marking phase through calling
|
|
|
|
* JS_IsGCMarkingTracer and apply a special code like emptying caches or
|
|
|
|
* marking its native structures.
|
|
|
|
*/
|
|
|
|
typedef void
|
2013-04-16 01:16:13 +00:00
|
|
|
(* JSTraceOp)(JSTracer *trc, JSObject *obj);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
2013-03-26 22:10:34 +00:00
|
|
|
* Callback that JSTraceOp implementation can provide to return a string
|
|
|
|
* describing the reference traced with JS_CallTracer.
|
2011-09-19 16:34:49 +00:00
|
|
|
*/
|
|
|
|
typedef void
|
|
|
|
(* JSTraceNamePrinter)(JSTracer *trc, char *buf, size_t bufsize);
|
|
|
|
|
2013-04-16 01:16:13 +00:00
|
|
|
typedef JSObject *
|
|
|
|
(* JSWeakmapKeyDelegateOp)(JSObject *obj);
|
2012-10-09 01:22:47 +00:00
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
/* Callbacks and their arguments. */
|
|
|
|
|
|
|
|
typedef enum JSContextOp {
|
|
|
|
JSCONTEXT_NEW,
|
|
|
|
JSCONTEXT_DESTROY
|
|
|
|
} JSContextOp;
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2010-06-30 22:25:47 +00:00
|
|
|
/*
|
2011-09-19 16:34:49 +00:00
|
|
|
* The possible values for contextOp when the runtime calls the callback are:
|
|
|
|
* JSCONTEXT_NEW JS_NewContext successfully created a new JSContext
|
|
|
|
* instance. The callback can initialize the instance as
|
|
|
|
* required. If the callback returns false, the instance
|
|
|
|
* will be destroyed and JS_NewContext returns null. In
|
|
|
|
* this case the callback is not called again.
|
|
|
|
* JSCONTEXT_DESTROY One of JS_DestroyContext* methods is called. The
|
|
|
|
* callback may perform its own cleanup and must always
|
|
|
|
* return true.
|
|
|
|
* Any other value For future compatibility the callback must do nothing
|
|
|
|
* and return true in this case.
|
|
|
|
*/
|
|
|
|
typedef JSBool
|
2012-02-28 23:11:11 +00:00
|
|
|
(* JSContextCallback)(JSContext *cx, unsigned contextOp);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
typedef enum JSGCStatus {
|
|
|
|
JSGC_BEGIN,
|
2012-02-29 20:23:38 +00:00
|
|
|
JSGC_END
|
2011-09-19 16:34:49 +00:00
|
|
|
} JSGCStatus;
|
|
|
|
|
2012-02-29 20:23:38 +00:00
|
|
|
typedef void
|
2013-07-09 14:28:15 +00:00
|
|
|
(* JSGCCallback)(JSRuntime *rt, JSGCStatus status, void *data);
|
2012-02-29 20:23:38 +00:00
|
|
|
|
|
|
|
typedef enum JSFinalizeStatus {
|
2012-10-12 09:45:30 +00:00
|
|
|
/*
|
|
|
|
* Called when preparing to sweep a group of compartments, before anything
|
|
|
|
* has been swept. The collector will not yield to the mutator before
|
|
|
|
* calling the callback with JSFINALIZE_GROUP_END status.
|
|
|
|
*/
|
|
|
|
JSFINALIZE_GROUP_START,
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Called when preparing to sweep a group of compartments. Weak references
|
|
|
|
* to unmarked things have been removed and things that are not swept
|
|
|
|
* incrementally have been finalized at this point. The collector may yield
|
|
|
|
* to the mutator after this point.
|
|
|
|
*/
|
|
|
|
JSFINALIZE_GROUP_END,
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Called at the end of collection when everything has been swept.
|
|
|
|
*/
|
|
|
|
JSFINALIZE_COLLECTION_END
|
2012-02-29 20:23:38 +00:00
|
|
|
} JSFinalizeStatus;
|
|
|
|
|
|
|
|
typedef void
|
2012-05-25 18:06:13 +00:00
|
|
|
(* JSFinalizeCallback)(JSFreeOp *fop, JSFinalizeStatus status, JSBool isCompartment);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Generic trace operation that calls JS_CallTracer on each traceable thing
|
|
|
|
* stored in data.
|
|
|
|
*/
|
|
|
|
typedef void
|
|
|
|
(* JSTraceDataOp)(JSTracer *trc, void *data);
|
|
|
|
|
|
|
|
typedef JSBool
|
|
|
|
(* JSOperationCallback)(JSContext *cx);
|
|
|
|
|
|
|
|
typedef void
|
|
|
|
(* JSErrorReporter)(JSContext *cx, const char *message, JSErrorReport *report);
|
|
|
|
|
2011-12-01 19:25:37 +00:00
|
|
|
#ifdef MOZ_TRACE_JSCALLS
|
|
|
|
typedef void
|
|
|
|
(* JSFunctionCallback)(const JSFunction *fun,
|
|
|
|
const JSScript *scr,
|
|
|
|
const JSContext *cx,
|
|
|
|
int entering);
|
|
|
|
#endif
|
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
/*
|
|
|
|
* Possible exception types. These types are part of a JSErrorFormatString
|
|
|
|
* structure. They define which error to throw in case of a runtime error.
|
|
|
|
* JSEXN_NONE marks an unthrowable error.
|
|
|
|
*/
|
|
|
|
typedef enum JSExnType {
|
|
|
|
JSEXN_NONE = -1,
|
|
|
|
JSEXN_ERR,
|
|
|
|
JSEXN_INTERNALERR,
|
|
|
|
JSEXN_EVALERR,
|
|
|
|
JSEXN_RANGEERR,
|
|
|
|
JSEXN_REFERENCEERR,
|
|
|
|
JSEXN_SYNTAXERR,
|
|
|
|
JSEXN_TYPEERR,
|
|
|
|
JSEXN_URIERR,
|
|
|
|
JSEXN_LIMIT
|
|
|
|
} JSExnType;
|
|
|
|
|
|
|
|
typedef struct JSErrorFormatString {
|
2012-10-29 20:55:17 +00:00
|
|
|
/* The error format string in ASCII. */
|
2011-09-19 16:34:49 +00:00
|
|
|
const char *format;
|
|
|
|
|
|
|
|
/* The number of arguments to expand in the formatted error message. */
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
uint16_t argCount;
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/* One of the JSExnType constants above. */
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
int16_t exnType;
|
2011-09-19 16:34:49 +00:00
|
|
|
} JSErrorFormatString;
|
|
|
|
|
|
|
|
typedef const JSErrorFormatString *
|
|
|
|
(* JSErrorCallback)(void *userRef, const char *locale,
|
2012-02-28 23:11:11 +00:00
|
|
|
const unsigned errorNumber);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSLocaleToUpperCase)(JSContext *cx, JS::Handle<JSString*> src,
|
|
|
|
JS::MutableHandle<JS::Value> rval);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSLocaleToLowerCase)(JSContext *cx, JS::Handle<JSString*> src,
|
|
|
|
JS::MutableHandle<JS::Value> rval);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
typedef JSBool
|
2013-06-21 13:12:46 +00:00
|
|
|
(* JSLocaleCompare)(JSContext *cx, JS::Handle<JSString*> src1, JS::Handle<JSString*> src2,
|
2013-06-19 10:32:27 +00:00
|
|
|
JS::MutableHandle<JS::Value> rval);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
typedef JSBool
|
2013-06-19 10:32:27 +00:00
|
|
|
(* JSLocaleToUnicode)(JSContext *cx, const char *src, JS::MutableHandle<JS::Value> rval);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Security protocol types.
|
|
|
|
*/
|
|
|
|
|
2012-03-09 09:48:50 +00:00
|
|
|
typedef void
|
|
|
|
(* JSDestroyPrincipalsOp)(JSPrincipals *principals);
|
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
/*
|
|
|
|
* Used to check if a CSP instance wants to disable eval() and friends.
|
|
|
|
* See js_CheckCSPPermitsJSAction() in jsobj.
|
|
|
|
*/
|
|
|
|
typedef JSBool
|
|
|
|
(* JSCSPEvalChecker)(JSContext *cx);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Callback used to ask the embedding for the cross compartment wrapper handler
|
|
|
|
* that implements the desired prolicy for this kind of object in the
|
2012-09-12 00:14:24 +00:00
|
|
|
* destination compartment. |obj| is the object to be wrapped. If |existing| is
|
|
|
|
* non-NULL, it will point to an existing wrapper object that should be re-used
|
|
|
|
* if possible. |existing| is guaranteed to be a cross-compartment wrapper with
|
|
|
|
* a lazily-defined prototype and the correct global. It is guaranteed not to
|
|
|
|
* wrap a function.
|
2011-09-19 16:34:49 +00:00
|
|
|
*/
|
|
|
|
typedef JSObject *
|
2013-04-15 17:32:55 +00:00
|
|
|
(* JSWrapObjectCallback)(JSContext *cx, JS::HandleObject existing, JS::HandleObject obj,
|
|
|
|
JS::HandleObject proto, JS::HandleObject parent,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned flags);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Callback used by the wrap hook to ask the embedding to prepare an object
|
|
|
|
* for wrapping in a context. This might include unwrapping other wrappers
|
|
|
|
* or even finding a more suitable object for the new compartment.
|
|
|
|
*/
|
|
|
|
typedef JSObject *
|
2013-04-15 17:32:55 +00:00
|
|
|
(* JSPreWrapCallback)(JSContext *cx, JS::HandleObject scope, JS::HandleObject obj,
|
|
|
|
unsigned flags);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
2012-05-14 21:30:07 +00:00
|
|
|
/*
|
|
|
|
* Callback used when wrapping determines that the underlying object is already
|
|
|
|
* in the compartment for which it is being wrapped. This allows consumers to
|
|
|
|
* maintain same-compartment wrapping invariants.
|
|
|
|
*
|
|
|
|
* |obj| is guaranteed to be same-compartment as |cx|, but it may (or may not)
|
|
|
|
* be a security or cross-compartment wrapper. This is an unfortunate contract,
|
|
|
|
* but is important for to avoid unnecessarily recomputing every cross-
|
|
|
|
* compartment wrapper that gets passed to wrap.
|
|
|
|
*/
|
|
|
|
typedef JSObject *
|
2013-04-15 17:32:55 +00:00
|
|
|
(* JSSameCompartmentWrapObjectCallback)(JSContext *cx, JS::HandleObject obj);
|
2012-05-14 21:30:07 +00:00
|
|
|
|
2012-03-20 10:22:05 +00:00
|
|
|
typedef void
|
|
|
|
(* JSDestroyCompartmentCallback)(JSFreeOp *fop, JSCompartment *compartment);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
2012-07-26 01:25:47 +00:00
|
|
|
typedef void
|
|
|
|
(* JSCompartmentNameCallback)(JSRuntime *rt, JSCompartment *compartment,
|
|
|
|
char *buf, size_t bufsize);
|
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
/*
|
|
|
|
* Read structured data from the reader r. This hook is used to read a value
|
|
|
|
* previously serialized by a call to the WriteStructuredCloneOp hook.
|
2010-06-30 22:25:47 +00:00
|
|
|
*
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
* tag and data are the pair of uint32_t values from the header. The callback
|
|
|
|
* may use the JS_Read* APIs to read any other relevant parts of the object
|
|
|
|
* from the reader r. closure is any value passed to the JS_ReadStructuredClone
|
2011-09-19 16:34:49 +00:00
|
|
|
* function. Return the new object on success, NULL on error/exception.
|
|
|
|
*/
|
|
|
|
typedef JSObject *(*ReadStructuredCloneOp)(JSContext *cx, JSStructuredCloneReader *r,
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
uint32_t tag, uint32_t data, void *closure);
|
2011-09-19 16:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Structured data serialization hook. The engine can write primitive values,
|
|
|
|
* Objects, Arrays, Dates, RegExps, TypedArrays, and ArrayBuffers. Any other
|
|
|
|
* type of object requires application support. This callback must first use
|
|
|
|
* the JS_WriteUint32Pair API to write an object header, passing a value
|
|
|
|
* greater than JS_SCTAG_USER to the tag parameter. Then it can use the
|
|
|
|
* JS_Write* APIs to write any other relevant parts of the value v to the
|
|
|
|
* writer w. closure is any value passed to the JS_WriteStructuredCLone function.
|
2010-06-30 22:25:47 +00:00
|
|
|
*
|
2011-09-19 16:34:49 +00:00
|
|
|
* Return true on success, false on error/exception.
|
2010-06-30 22:25:47 +00:00
|
|
|
*/
|
2011-09-19 16:34:49 +00:00
|
|
|
typedef JSBool (*WriteStructuredCloneOp)(JSContext *cx, JSStructuredCloneWriter *w,
|
2013-05-09 07:27:40 +00:00
|
|
|
JS::Handle<JSObject*> obj, void *closure);
|
2010-06-30 22:25:47 +00:00
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
/*
|
2012-10-03 22:19:22 +00:00
|
|
|
* This is called when JS_WriteStructuredClone is given an invalid transferable.
|
|
|
|
* To follow HTML5, the application must throw a DATA_CLONE_ERR DOMException
|
|
|
|
* with error set to one of the JS_SCERR_* values.
|
2011-09-19 16:34:49 +00:00
|
|
|
*/
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
typedef void (*StructuredCloneErrorOp)(JSContext *cx, uint32_t errorid);
|
2010-06-30 22:25:47 +00:00
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
/************************************************************************/
|
2010-06-30 22:25:47 +00:00
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
/*
|
2013-02-02 00:15:49 +00:00
|
|
|
* JS constants. For efficiency, prefer predicates (e.g. v.isNull()) and
|
|
|
|
* constructing values from scratch (e.g. Int32Value(0)). These constants are
|
|
|
|
* stored in memory and initialized at startup, so testing against them and
|
|
|
|
* using them requires memory loads and will be correspondingly slow.
|
2011-09-19 16:34:49 +00:00
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_DATA(const jsval) JSVAL_NULL;
|
|
|
|
extern JS_PUBLIC_DATA(const jsval) JSVAL_ZERO;
|
|
|
|
extern JS_PUBLIC_DATA(const jsval) JSVAL_ONE;
|
|
|
|
extern JS_PUBLIC_DATA(const jsval) JSVAL_FALSE;
|
|
|
|
extern JS_PUBLIC_DATA(const jsval) JSVAL_TRUE;
|
|
|
|
extern JS_PUBLIC_DATA(const jsval) JSVAL_VOID;
|
|
|
|
|
2012-08-02 00:59:47 +00:00
|
|
|
static JS_ALWAYS_INLINE jsval
|
|
|
|
JS_NumberValue(double d)
|
|
|
|
{
|
|
|
|
int32_t i;
|
|
|
|
d = JS_CANONICALIZE_NAN(d);
|
2013-05-01 20:55:13 +00:00
|
|
|
if (mozilla::DoubleIsInt32(d, &i))
|
2012-08-02 00:59:47 +00:00
|
|
|
return INT_TO_JSVAL(i);
|
|
|
|
return DOUBLE_TO_JSVAL(d);
|
|
|
|
}
|
|
|
|
|
2010-06-17 01:21:34 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
2010-06-18 07:59:10 +00:00
|
|
|
/*
|
|
|
|
* A jsid is an identifier for a property or method of an object which is
|
2013-01-25 05:24:57 +00:00
|
|
|
* either a 31-bit signed integer, interned string or object. Also, there is
|
|
|
|
* an additional jsid value, JSID_VOID, which does not occur in JS scripts but
|
|
|
|
* may be used to indicate the absence of a valid jsid.
|
2010-06-18 07:59:10 +00:00
|
|
|
*
|
|
|
|
* A jsid is not implicitly convertible to or from a jsval; JS_ValueToId or
|
|
|
|
* JS_IdToValue must be used instead.
|
|
|
|
*/
|
|
|
|
|
2010-07-05 08:41:42 +00:00
|
|
|
#define JSID_TYPE_STRING 0x0
|
|
|
|
#define JSID_TYPE_INT 0x1
|
|
|
|
#define JSID_TYPE_VOID 0x2
|
|
|
|
#define JSID_TYPE_OBJECT 0x4
|
2010-06-17 01:21:34 +00:00
|
|
|
#define JSID_TYPE_MASK 0x7
|
|
|
|
|
2010-06-22 18:54:27 +00:00
|
|
|
/*
|
2010-08-29 18:57:08 +00:00
|
|
|
* Avoid using canonical 'id' for jsid parameters since this is a magic word in
|
2010-06-22 18:54:27 +00:00
|
|
|
* Objective-C++ which, apparently, wants to be able to #include jsapi.h.
|
|
|
|
*/
|
2010-08-29 18:57:08 +00:00
|
|
|
#define id iden
|
2010-06-22 18:54:27 +00:00
|
|
|
|
2010-06-17 01:21:34 +00:00
|
|
|
static JS_ALWAYS_INLINE JSBool
|
2010-08-29 18:57:08 +00:00
|
|
|
JSID_IS_STRING(jsid id)
|
2010-06-17 01:21:34 +00:00
|
|
|
{
|
2010-08-29 18:57:08 +00:00
|
|
|
return (JSID_BITS(id) & JSID_TYPE_MASK) == 0;
|
2010-06-17 01:21:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE JSString *
|
2010-08-29 18:57:08 +00:00
|
|
|
JSID_TO_STRING(jsid id)
|
2010-06-17 01:21:34 +00:00
|
|
|
{
|
2010-08-29 18:57:08 +00:00
|
|
|
JS_ASSERT(JSID_IS_STRING(id));
|
2011-09-19 16:34:49 +00:00
|
|
|
return (JSString *)JSID_BITS(id);
|
2010-06-17 01:21:34 +00:00
|
|
|
}
|
|
|
|
|
2010-11-09 00:20:22 +00:00
|
|
|
static JS_ALWAYS_INLINE JSBool
|
|
|
|
JSID_IS_ZERO(jsid id)
|
|
|
|
{
|
2010-11-09 19:50:24 +00:00
|
|
|
return JSID_BITS(id) == 0;
|
2010-11-09 00:20:22 +00:00
|
|
|
}
|
|
|
|
|
2010-06-18 06:51:54 +00:00
|
|
|
JS_PUBLIC_API(JSBool)
|
2011-05-17 19:15:12 +00:00
|
|
|
JS_StringHasBeenInterned(JSContext *cx, JSString *str);
|
2010-06-18 06:51:54 +00:00
|
|
|
|
2011-05-17 19:15:12 +00:00
|
|
|
/*
|
|
|
|
* Only JSStrings that have been interned via the JSAPI can be turned into
|
|
|
|
* jsids by API clients.
|
|
|
|
*
|
|
|
|
* N.B. if a jsid is backed by a string which has not been interned, that
|
|
|
|
* string must be appropriately rooted to avoid being collected by the GC.
|
|
|
|
*/
|
2012-05-06 20:45:19 +00:00
|
|
|
JS_PUBLIC_API(jsid)
|
|
|
|
INTERNED_STRING_TO_JSID(JSContext *cx, JSString *str);
|
2010-06-18 06:51:54 +00:00
|
|
|
|
2010-06-17 01:21:34 +00:00
|
|
|
static JS_ALWAYS_INLINE JSBool
|
2010-08-29 18:57:08 +00:00
|
|
|
JSID_IS_INT(jsid id)
|
2010-06-17 01:21:34 +00:00
|
|
|
{
|
2010-08-29 18:57:08 +00:00
|
|
|
return !!(JSID_BITS(id) & JSID_TYPE_INT);
|
2010-06-17 01:21:34 +00:00
|
|
|
}
|
|
|
|
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
static JS_ALWAYS_INLINE int32_t
|
2010-08-29 18:57:08 +00:00
|
|
|
JSID_TO_INT(jsid id)
|
2010-06-17 01:21:34 +00:00
|
|
|
{
|
2010-08-29 18:57:08 +00:00
|
|
|
JS_ASSERT(JSID_IS_INT(id));
|
2012-05-06 20:45:19 +00:00
|
|
|
return ((uint32_t)JSID_BITS(id)) >> 1;
|
2010-06-17 01:21:34 +00:00
|
|
|
}
|
|
|
|
|
2012-05-06 20:45:19 +00:00
|
|
|
#define JSID_INT_MIN 0
|
2012-05-06 23:43:15 +00:00
|
|
|
#define JSID_INT_MAX INT32_MAX
|
2010-06-17 01:21:34 +00:00
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE JSBool
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
INT_FITS_IN_JSID(int32_t i)
|
2010-06-17 01:21:34 +00:00
|
|
|
{
|
2012-05-06 20:45:19 +00:00
|
|
|
return i >= 0;
|
2010-06-17 01:21:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE jsid
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
INT_TO_JSID(int32_t i)
|
2010-06-17 01:21:34 +00:00
|
|
|
{
|
2010-08-29 18:57:08 +00:00
|
|
|
jsid id;
|
2010-06-18 06:51:54 +00:00
|
|
|
JS_ASSERT(INT_FITS_IN_JSID(i));
|
2010-08-29 18:57:08 +00:00
|
|
|
JSID_BITS(id) = ((i << 1) | JSID_TYPE_INT);
|
|
|
|
return id;
|
2010-06-17 01:21:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE JSBool
|
2010-08-29 18:57:08 +00:00
|
|
|
JSID_IS_OBJECT(jsid id)
|
2010-06-17 01:21:34 +00:00
|
|
|
{
|
2010-08-29 18:57:08 +00:00
|
|
|
return (JSID_BITS(id) & JSID_TYPE_MASK) == JSID_TYPE_OBJECT &&
|
|
|
|
(size_t)JSID_BITS(id) != JSID_TYPE_OBJECT;
|
2010-06-17 01:21:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE JSObject *
|
2010-08-29 18:57:08 +00:00
|
|
|
JSID_TO_OBJECT(jsid id)
|
2010-06-17 01:21:34 +00:00
|
|
|
{
|
2010-08-29 18:57:08 +00:00
|
|
|
JS_ASSERT(JSID_IS_OBJECT(id));
|
|
|
|
return (JSObject *)(JSID_BITS(id) & ~(size_t)JSID_TYPE_MASK);
|
2010-06-17 01:21:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE jsid
|
2013-04-16 01:16:13 +00:00
|
|
|
OBJECT_TO_JSID(JSObject *obj)
|
2010-06-17 01:21:34 +00:00
|
|
|
{
|
2010-08-29 18:57:08 +00:00
|
|
|
jsid id;
|
2010-06-17 05:58:31 +00:00
|
|
|
JS_ASSERT(obj != NULL);
|
2010-06-17 01:21:34 +00:00
|
|
|
JS_ASSERT(((size_t)obj & JSID_TYPE_MASK) == 0);
|
2010-08-29 18:57:08 +00:00
|
|
|
JSID_BITS(id) = ((size_t)obj | JSID_TYPE_OBJECT);
|
|
|
|
return id;
|
2010-06-17 01:21:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE JSBool
|
2010-08-29 18:57:08 +00:00
|
|
|
JSID_IS_GCTHING(jsid id)
|
2010-06-17 01:21:34 +00:00
|
|
|
{
|
2010-08-29 18:57:08 +00:00
|
|
|
return JSID_IS_STRING(id) || JSID_IS_OBJECT(id);
|
2010-06-17 01:21:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE void *
|
2010-08-29 18:57:08 +00:00
|
|
|
JSID_TO_GCTHING(jsid id)
|
2010-06-17 01:21:34 +00:00
|
|
|
{
|
2010-08-29 18:57:08 +00:00
|
|
|
return (void *)(JSID_BITS(id) & ~(size_t)JSID_TYPE_MASK);
|
2010-06-17 01:21:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* A void jsid is not a valid id and only arises as an exceptional API return
|
2010-06-30 22:25:47 +00:00
|
|
|
* value, such as in JS_NextProperty. Embeddings must not pass JSID_VOID into
|
|
|
|
* JSAPI entry points expecting a jsid and do not need to handle JSID_VOID in
|
|
|
|
* hooks receiving a jsid except when explicitly noted in the API contract.
|
2010-06-17 01:21:34 +00:00
|
|
|
*/
|
|
|
|
|
2010-06-15 22:43:41 +00:00
|
|
|
static JS_ALWAYS_INLINE JSBool
|
2013-04-30 22:41:04 +00:00
|
|
|
JSID_IS_VOID(const jsid id)
|
2010-06-15 22:43:41 +00:00
|
|
|
{
|
2010-08-29 18:57:08 +00:00
|
|
|
JS_ASSERT_IF(((size_t)JSID_BITS(id) & JSID_TYPE_MASK) == JSID_TYPE_VOID,
|
|
|
|
JSID_BITS(id) == JSID_TYPE_VOID);
|
|
|
|
return ((size_t)JSID_BITS(id) == JSID_TYPE_VOID);
|
2010-06-15 22:43:41 +00:00
|
|
|
}
|
|
|
|
|
2010-08-29 18:57:08 +00:00
|
|
|
static JS_ALWAYS_INLINE JSBool
|
2013-04-30 22:41:04 +00:00
|
|
|
JSID_IS_EMPTY(const jsid id)
|
2010-08-29 18:57:08 +00:00
|
|
|
{
|
|
|
|
return ((size_t)JSID_BITS(id) == JSID_TYPE_OBJECT);
|
|
|
|
}
|
|
|
|
|
|
|
|
#undef id
|
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
#ifdef JS_USE_JSID_STRUCT_TYPES
|
2013-06-18 01:31:47 +00:00
|
|
|
extern JS_PUBLIC_DATA(const jsid) JSID_VOID;
|
|
|
|
extern JS_PUBLIC_DATA(const jsid) JSID_EMPTY;
|
2010-06-18 06:51:54 +00:00
|
|
|
#else
|
2011-09-19 16:34:49 +00:00
|
|
|
# define JSID_VOID ((jsid)JSID_TYPE_VOID)
|
|
|
|
# define JSID_EMPTY ((jsid)JSID_TYPE_OBJECT)
|
2010-06-18 06:51:54 +00:00
|
|
|
#endif
|
|
|
|
|
2011-11-08 01:01:29 +00:00
|
|
|
/*
|
|
|
|
* Returns true iff the given jsval is immune to GC and can be used across
|
|
|
|
* multiple JSRuntimes without requiring any conversion API.
|
|
|
|
*/
|
|
|
|
static JS_ALWAYS_INLINE JSBool
|
|
|
|
JSVAL_IS_UNIVERSAL(jsval v)
|
|
|
|
{
|
|
|
|
return !JSVAL_IS_GCTHING(v);
|
|
|
|
}
|
|
|
|
|
2012-01-11 08:23:09 +00:00
|
|
|
namespace JS {
|
|
|
|
|
|
|
|
class AutoIdRooter : private AutoGCRooter
|
|
|
|
{
|
|
|
|
public:
|
2013-02-18 06:56:32 +00:00
|
|
|
explicit AutoIdRooter(JSContext *cx, jsid aId = INT_TO_JSID(0)
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2013-02-18 06:56:32 +00:00
|
|
|
: AutoGCRooter(cx, ID), id_(aId)
|
2012-01-11 08:23:09 +00:00
|
|
|
{
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2012-01-11 08:23:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
jsid id() {
|
|
|
|
return id_;
|
|
|
|
}
|
|
|
|
|
|
|
|
jsid * addr() {
|
|
|
|
return &id_;
|
|
|
|
}
|
|
|
|
|
|
|
|
friend void AutoGCRooter::trace(JSTracer *trc);
|
|
|
|
|
|
|
|
private:
|
|
|
|
jsid id_;
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2012-01-11 08:23:09 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
} /* namespace JS */
|
|
|
|
|
2010-06-17 01:21:34 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
/* Property attributes, set in JSPropertySpec and passed to API functions. */
|
1998-03-28 02:44:41 +00:00
|
|
|
#define JSPROP_ENUMERATE 0x01 /* property is visible to for/in loop */
|
2011-12-15 19:40:57 +00:00
|
|
|
#define JSPROP_READONLY 0x02 /* not settable: assignment is no-op.
|
|
|
|
This flag is only valid when neither
|
|
|
|
JSPROP_GETTER nor JSPROP_SETTER is
|
|
|
|
set. */
|
1998-03-28 02:44:41 +00:00
|
|
|
#define JSPROP_PERMANENT 0x04 /* property cannot be deleted */
|
2012-11-02 04:35:09 +00:00
|
|
|
#define JSPROP_NATIVE_ACCESSORS 0x08 /* set in JSPropertyDescriptor.flags
|
|
|
|
if getters/setters are JSNatives */
|
1999-09-21 00:13:48 +00:00
|
|
|
#define JSPROP_GETTER 0x10 /* property holds getter function */
|
|
|
|
#define JSPROP_SETTER 0x20 /* property holds setter function */
|
2000-12-05 21:47:23 +00:00
|
|
|
#define JSPROP_SHARED 0x40 /* don't allocate a value slot for this
|
|
|
|
property; don't copy the property on
|
|
|
|
set of the same-named property in an
|
|
|
|
object that delegates to a prototype
|
|
|
|
containing this property */
|
2012-03-02 02:54:01 +00:00
|
|
|
#define JSPROP_INDEX 0x80 /* name is actually (int) index */
|
2012-11-02 04:35:09 +00:00
|
|
|
#define JSPROP_SHORTID 0x100 /* set in JS_DefineProperty attrs
|
2010-05-19 02:21:43 +00:00
|
|
|
if getters/setters use a shortid */
|
2006-07-06 18:40:03 +00:00
|
|
|
|
2012-11-02 04:35:09 +00:00
|
|
|
#define JSFUN_STUB_GSOPS 0x200 /* use JS_PropertyStub getter/setter
|
2008-02-07 23:18:45 +00:00
|
|
|
instead of defaulting to class gsops
|
|
|
|
for property holding function */
|
|
|
|
|
2012-11-02 04:35:09 +00:00
|
|
|
#define JSFUN_CONSTRUCTOR 0x400 /* native that can be called as a ctor */
|
|
|
|
|
|
|
|
|
2005-08-30 04:28:45 +00:00
|
|
|
/*
|
2012-11-02 04:35:09 +00:00
|
|
|
* Specify a generic native prototype methods, i.e., methods of a class
|
|
|
|
* prototype that are exposed as static methods taking an extra leading
|
|
|
|
* argument: the generic |this| parameter.
|
2005-08-30 04:28:45 +00:00
|
|
|
*
|
|
|
|
* If you set this flag in a JSFunctionSpec struct's flags initializer, then
|
|
|
|
* that struct must live at least as long as the native static method object
|
|
|
|
* created due to this flag by JS_DefineFunctions or JS_InitClass. Typically
|
|
|
|
* JSFunctionSpec structs are allocated in static arrays.
|
|
|
|
*/
|
2012-11-02 04:35:09 +00:00
|
|
|
#define JSFUN_GENERIC_NATIVE 0x800
|
|
|
|
|
|
|
|
#define JSFUN_FLAGS_MASK 0xe00 /* | of all the JSFUN_* flags */
|
2005-08-30 04:28:45 +00:00
|
|
|
|
2011-09-11 18:37:43 +00:00
|
|
|
/*
|
|
|
|
* The first call to JS_CallOnce by any thread in a process will call 'func'.
|
|
|
|
* Later calls to JS_CallOnce with the same JSCallOnceType object will be
|
|
|
|
* suppressed.
|
|
|
|
*
|
|
|
|
* Equivalently: each distinct JSCallOnceType object will allow one JS_CallOnce
|
|
|
|
* to invoke its JSInitCallback.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_CallOnce(JSCallOnceType *once, JSInitCallback func);
|
|
|
|
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
/* Microseconds since the epoch, midnight, January 1, 1970 UTC. */
|
|
|
|
extern JS_PUBLIC_API(int64_t)
|
2007-11-07 09:17:35 +00:00
|
|
|
JS_Now(void);
|
2002-02-27 09:17:21 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
/* Don't want to export data, so provide accessors for non-inline jsvals. */
|
|
|
|
extern JS_PUBLIC_API(jsval)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_GetNaNValue(JSContext *cx);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(jsval)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_GetNegativeInfinityValue(JSContext *cx);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(jsval)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_GetPositiveInfinityValue(JSContext *cx);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(jsval)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_GetEmptyStringValue(JSContext *cx);
|
|
|
|
|
2010-11-24 16:56:43 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
|
|
|
JS_GetEmptyString(JSRuntime *rt);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
/*
|
|
|
|
* Format is a string of the following characters (spaces are insignificant),
|
|
|
|
* specifying the tabulated type conversions:
|
|
|
|
*
|
|
|
|
* b JSBool Boolean
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
* c uint16_t/jschar ECMA uint16_t, Unicode char
|
|
|
|
* i int32_t ECMA int32_t
|
|
|
|
* u uint32_t ECMA uint32_t
|
|
|
|
* j int32_t Rounded int32_t (coordinate)
|
2012-02-24 22:19:52 +00:00
|
|
|
* d double IEEE double
|
|
|
|
* I double Integral IEEE double
|
1999-03-02 02:38:45 +00:00
|
|
|
* S JSString * Unicode string, accessed by a JSString pointer
|
|
|
|
* W jschar * Unicode character vector, 0-terminated (W for wide)
|
1998-04-24 00:31:11 +00:00
|
|
|
* o JSObject * Object reference
|
|
|
|
* f JSFunction * Function private
|
|
|
|
* v jsval Argument value (no conversion)
|
|
|
|
* * N/A Skip this argument (no vararg)
|
|
|
|
* / N/A End of required arguments
|
|
|
|
*
|
|
|
|
* The variable argument list after format must consist of &b, &c, &s, e.g.,
|
|
|
|
* where those variables have the types given above. For the pointer types
|
|
|
|
* char *, JSString *, and JSObject *, the pointed-at memory returned belongs
|
1998-08-25 08:23:34 +00:00
|
|
|
* to the JS runtime, not to the calling native code. The runtime promises
|
1998-04-24 00:31:11 +00:00
|
|
|
* to keep this memory valid so long as argv refers to allocated stack space
|
|
|
|
* (so long as the native function is active).
|
|
|
|
*
|
|
|
|
* Fewer arguments than format specifies may be passed only if there is a /
|
|
|
|
* in format after the last required argument specifier and argc is at least
|
|
|
|
* the number of required arguments. More arguments than format specifies
|
|
|
|
* may be passed without error; it is up to the caller to deal with trailing
|
|
|
|
* unconverted arguments.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_ConvertArguments(JSContext *cx, unsigned argc, jsval *argv, const char *format,
|
2000-09-08 21:24:14 +00:00
|
|
|
...);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
1999-06-08 02:15:57 +00:00
|
|
|
#ifdef va_start
|
1999-11-23 01:02:28 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_ConvertArgumentsVA(JSContext *cx, unsigned argc, jsval *argv,
|
2000-09-08 21:24:14 +00:00
|
|
|
const char *format, va_list ap);
|
1999-06-08 02:15:57 +00:00
|
|
|
#endif
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_ConvertValue(JSContext *cx, jsval v, JSType type, jsval *vp);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_ValueToObject(JSContext *cx, jsval v, JSObject **objp);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_ValueToFunction(JSContext *cx, jsval v);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
|
|
|
JS_ValueToConstructor(JSContext *cx, jsval v);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSString *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_ValueToString(JSContext *cx, jsval v);
|
|
|
|
|
2008-11-03 22:28:36 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
|
|
|
JS_ValueToSource(JSContext *cx, jsval v);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-02-24 22:19:52 +00:00
|
|
|
JS_ValueToNumber(JSContext *cx, jsval v, double *dp);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2012-03-28 23:35:21 +00:00
|
|
|
namespace js {
|
|
|
|
/*
|
|
|
|
* DO NOT CALL THIS. Use JS::ToNumber
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(bool)
|
|
|
|
ToNumberSlow(JSContext *cx, JS::Value v, double *dp);
|
2012-07-25 05:59:55 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* DO NOT CALL THIS. Use JS::ToBoolean
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(bool)
|
|
|
|
ToBooleanSlow(const JS::Value &v);
|
2012-03-28 23:35:21 +00:00
|
|
|
} /* namespace js */
|
|
|
|
|
|
|
|
namespace JS {
|
|
|
|
|
|
|
|
/* ES5 9.3 ToNumber. */
|
|
|
|
JS_ALWAYS_INLINE bool
|
2013-06-22 01:19:11 +00:00
|
|
|
ToNumber(JSContext *cx, HandleValue v, double *out)
|
2012-03-28 23:35:21 +00:00
|
|
|
{
|
|
|
|
AssertArgumentsAreSane(cx, v);
|
2012-08-02 19:59:30 +00:00
|
|
|
{
|
2012-09-25 01:08:22 +00:00
|
|
|
js::SkipRoot root(cx, &v);
|
|
|
|
js::MaybeCheckStackRoots(cx);
|
2012-08-02 19:59:30 +00:00
|
|
|
}
|
2012-05-01 00:10:30 +00:00
|
|
|
|
2012-03-28 23:35:21 +00:00
|
|
|
if (v.isNumber()) {
|
|
|
|
*out = v.toNumber();
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return js::ToNumberSlow(cx, v, out);
|
|
|
|
}
|
|
|
|
|
2012-07-25 05:59:55 +00:00
|
|
|
JS_ALWAYS_INLINE bool
|
|
|
|
ToBoolean(const Value &v)
|
|
|
|
{
|
|
|
|
if (v.isBoolean())
|
|
|
|
return v.toBoolean();
|
|
|
|
if (v.isInt32())
|
|
|
|
return v.toInt32() != 0;
|
|
|
|
if (v.isNullOrUndefined())
|
|
|
|
return false;
|
|
|
|
if (v.isDouble()) {
|
|
|
|
double d = v.toDouble();
|
2013-05-01 20:55:13 +00:00
|
|
|
return !mozilla::IsNaN(d) && d != 0;
|
2012-07-25 05:59:55 +00:00
|
|
|
}
|
|
|
|
|
2012-09-15 18:19:54 +00:00
|
|
|
/* The slow path handles strings and objects. */
|
2012-07-25 05:59:55 +00:00
|
|
|
return js::ToBooleanSlow(v);
|
|
|
|
}
|
|
|
|
|
2012-03-28 23:35:21 +00:00
|
|
|
} /* namespace JS */
|
|
|
|
|
2010-03-01 21:30:23 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-03-02 02:54:01 +00:00
|
|
|
JS_DoubleIsInt32(double d, int32_t *ip);
|
2010-03-01 21:30:23 +00:00
|
|
|
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
extern JS_PUBLIC_API(int32_t)
|
2012-02-24 22:19:52 +00:00
|
|
|
JS_DoubleToInt32(double d);
|
2011-03-30 02:19:15 +00:00
|
|
|
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
extern JS_PUBLIC_API(uint32_t)
|
2012-02-24 22:19:52 +00:00
|
|
|
JS_DoubleToUint32(double d);
|
2011-03-30 02:19:15 +00:00
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/*
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
* Convert a value to a number, then to an int32_t, according to the ECMA rules
|
1998-04-24 00:31:11 +00:00
|
|
|
* for ToInt32.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_ValueToECMAInt32(JSContext *cx, jsval v, int32_t *ip);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2012-08-03 22:15:04 +00:00
|
|
|
/*
|
|
|
|
* Convert a value to a number, then to an int64_t, according to the WebIDL
|
|
|
|
* rules for ToInt64: http://dev.w3.org/2006/webapi/WebIDL/#es-long-long
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ValueToInt64(JSContext *cx, jsval v, int64_t *ip);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Convert a value to a number, then to an uint64_t, according to the WebIDL
|
|
|
|
* rules for ToUint64: http://dev.w3.org/2006/webapi/WebIDL/#es-unsigned-long-long
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ValueToUint64(JSContext *cx, jsval v, uint64_t *ip);
|
|
|
|
|
2012-03-28 23:35:21 +00:00
|
|
|
namespace js {
|
2012-08-02 19:59:30 +00:00
|
|
|
/* DO NOT CALL THIS. Use JS::ToInt16. */
|
|
|
|
extern JS_PUBLIC_API(bool)
|
|
|
|
ToUint16Slow(JSContext *cx, const JS::Value &v, uint16_t *out);
|
|
|
|
|
|
|
|
/* DO NOT CALL THIS. Use JS::ToInt32. */
|
2012-03-28 23:35:21 +00:00
|
|
|
extern JS_PUBLIC_API(bool)
|
|
|
|
ToInt32Slow(JSContext *cx, const JS::Value &v, int32_t *out);
|
2012-08-02 19:59:30 +00:00
|
|
|
|
|
|
|
/* DO NOT CALL THIS. Use JS::ToUint32. */
|
|
|
|
extern JS_PUBLIC_API(bool)
|
|
|
|
ToUint32Slow(JSContext *cx, const JS::Value &v, uint32_t *out);
|
2012-08-03 22:15:04 +00:00
|
|
|
|
|
|
|
/* DO NOT CALL THIS. Use JS::ToInt64. */
|
|
|
|
extern JS_PUBLIC_API(bool)
|
|
|
|
ToInt64Slow(JSContext *cx, const JS::Value &v, int64_t *out);
|
|
|
|
|
|
|
|
/* DO NOT CALL THIS. Use JS::ToUint64. */
|
|
|
|
extern JS_PUBLIC_API(bool)
|
|
|
|
ToUint64Slow(JSContext *cx, const JS::Value &v, uint64_t *out);
|
2012-03-28 23:35:21 +00:00
|
|
|
} /* namespace js */
|
|
|
|
|
|
|
|
namespace JS {
|
|
|
|
|
2012-08-02 19:59:30 +00:00
|
|
|
JS_ALWAYS_INLINE bool
|
2013-03-19 10:35:41 +00:00
|
|
|
ToUint16(JSContext *cx, const JS::Value &v, uint16_t *out)
|
2012-08-02 19:59:30 +00:00
|
|
|
{
|
|
|
|
AssertArgumentsAreSane(cx, v);
|
|
|
|
{
|
2012-09-25 01:08:22 +00:00
|
|
|
js::SkipRoot skip(cx, &v);
|
|
|
|
js::MaybeCheckStackRoots(cx);
|
2012-08-02 19:59:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (v.isInt32()) {
|
|
|
|
*out = uint16_t(v.toInt32());
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return js::ToUint16Slow(cx, v, out);
|
|
|
|
}
|
|
|
|
|
2012-03-28 23:35:21 +00:00
|
|
|
JS_ALWAYS_INLINE bool
|
2013-03-19 10:35:41 +00:00
|
|
|
ToInt32(JSContext *cx, const JS::Value &v, int32_t *out)
|
2012-03-28 23:35:21 +00:00
|
|
|
{
|
|
|
|
AssertArgumentsAreSane(cx, v);
|
2012-08-02 19:59:30 +00:00
|
|
|
{
|
2012-09-25 01:08:22 +00:00
|
|
|
js::SkipRoot root(cx, &v);
|
|
|
|
js::MaybeCheckStackRoots(cx);
|
2012-08-02 19:59:30 +00:00
|
|
|
}
|
|
|
|
|
2012-03-28 23:35:21 +00:00
|
|
|
if (v.isInt32()) {
|
|
|
|
*out = v.toInt32();
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return js::ToInt32Slow(cx, v, out);
|
|
|
|
}
|
|
|
|
|
2012-08-02 19:59:30 +00:00
|
|
|
JS_ALWAYS_INLINE bool
|
2013-03-19 10:35:41 +00:00
|
|
|
ToUint32(JSContext *cx, const JS::Value &v, uint32_t *out)
|
2012-08-02 19:59:30 +00:00
|
|
|
{
|
|
|
|
AssertArgumentsAreSane(cx, v);
|
|
|
|
{
|
2012-09-25 01:08:22 +00:00
|
|
|
js::SkipRoot root(cx, &v);
|
|
|
|
js::MaybeCheckStackRoots(cx);
|
2012-08-02 19:59:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (v.isInt32()) {
|
|
|
|
*out = uint32_t(v.toInt32());
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return js::ToUint32Slow(cx, v, out);
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:15:04 +00:00
|
|
|
JS_ALWAYS_INLINE bool
|
2013-03-19 10:35:41 +00:00
|
|
|
ToInt64(JSContext *cx, const JS::Value &v, int64_t *out)
|
2012-08-03 22:15:04 +00:00
|
|
|
{
|
|
|
|
AssertArgumentsAreSane(cx, v);
|
|
|
|
{
|
2012-09-25 01:08:22 +00:00
|
|
|
js::SkipRoot skip(cx, &v);
|
|
|
|
js::MaybeCheckStackRoots(cx);
|
2012-08-03 22:15:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (v.isInt32()) {
|
|
|
|
*out = int64_t(v.toInt32());
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
return js::ToInt64Slow(cx, v, out);
|
|
|
|
}
|
|
|
|
|
|
|
|
JS_ALWAYS_INLINE bool
|
2013-03-19 10:35:41 +00:00
|
|
|
ToUint64(JSContext *cx, const JS::Value &v, uint64_t *out)
|
2012-08-03 22:15:04 +00:00
|
|
|
{
|
|
|
|
AssertArgumentsAreSane(cx, v);
|
|
|
|
{
|
2012-09-25 01:08:22 +00:00
|
|
|
js::SkipRoot skip(cx, &v);
|
|
|
|
js::MaybeCheckStackRoots(cx);
|
2012-08-03 22:15:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (v.isInt32()) {
|
2012-08-07 21:32:24 +00:00
|
|
|
/* Account for sign extension of negatives into the longer 64bit space. */
|
2012-08-03 22:15:04 +00:00
|
|
|
*out = uint64_t(int64_t(v.toInt32()));
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
return js::ToUint64Slow(cx, v, out);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2012-03-28 23:35:21 +00:00
|
|
|
} /* namespace JS */
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
/*
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
* Convert a value to a number, then to a uint32_t, according to the ECMA rules
|
1998-04-24 00:31:11 +00:00
|
|
|
* for ToUint32.
|
1998-03-28 02:44:41 +00:00
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_ValueToECMAUint32(JSContext *cx, jsval v, uint32_t *ip);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
|
|
|
/*
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
* Convert a value to a number, then to an int32_t if it fits by rounding to
|
1998-04-24 00:31:11 +00:00
|
|
|
* nearest; but failing with an error report if the double is out of range
|
|
|
|
* or unordered.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_ValueToInt32(JSContext *cx, jsval v, int32_t *ip);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
/*
|
|
|
|
* ECMA ToUint16, for mapping a jsval to a Unicode point.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_ValueToUint16(JSContext *cx, jsval v, uint16_t *ip);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_ValueToBoolean(JSContext *cx, jsval v, JSBool *bp);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSType)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_TypeOfValue(JSContext *cx, jsval v);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(const char *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_GetTypeName(JSContext *cx, JSType type);
|
|
|
|
|
2009-05-15 19:51:02 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2010-12-03 08:24:17 +00:00
|
|
|
JS_StrictlyEqual(JSContext *cx, jsval v1, jsval v2, JSBool *equal);
|
2009-05-15 19:51:02 +00:00
|
|
|
|
2011-03-21 17:04:43 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_LooselyEqual(JSContext *cx, jsval v1, jsval v2, JSBool *equal);
|
|
|
|
|
2009-09-09 18:51:52 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2010-12-03 08:24:17 +00:00
|
|
|
JS_SameValue(JSContext *cx, jsval v1, jsval v2, JSBool *same);
|
2009-09-09 18:51:52 +00:00
|
|
|
|
2011-03-03 03:57:44 +00:00
|
|
|
/* True iff fun is the global eval function. */
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_IsBuiltinEvalFunction(JSFunction *fun);
|
|
|
|
|
|
|
|
/* True iff fun is the Function constructor. */
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_IsBuiltinFunctionConstructor(JSFunction *fun);
|
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Initialization, locking, contexts, and memory allocation.
|
2007-02-08 19:49:35 +00:00
|
|
|
*
|
|
|
|
* It is important that the first runtime and first context be created in a
|
|
|
|
* single-threaded fashion, otherwise the behavior of the library is undefined.
|
|
|
|
* See: http://developer.mozilla.org/en/docs/Category:JSAPI_Reference
|
1998-03-28 02:44:41 +00:00
|
|
|
*/
|
|
|
|
|
2012-10-16 18:57:09 +00:00
|
|
|
typedef enum JSUseHelperThreads
|
|
|
|
{
|
|
|
|
JS_NO_HELPER_THREADS,
|
|
|
|
JS_USE_HELPER_THREADS
|
|
|
|
} JSUseHelperThreads;
|
|
|
|
|
2013-07-20 03:14:34 +00:00
|
|
|
/**
|
|
|
|
* Initialize SpiderMonkey, returning true only if initialization succeeded.
|
|
|
|
* Once this method has succeeded, it is safe to call JS_NewRuntime and other
|
|
|
|
* JSAPI methods.
|
|
|
|
*
|
|
|
|
* This method must be called before any other JSAPI method is used on any
|
|
|
|
* thread. Once it has been used, it is safe to call any JSAPI method, and it
|
|
|
|
* remains safe to do so until JS_ShutDown is correctly called.
|
|
|
|
*
|
|
|
|
* It is currently not possible to initialize SpiderMonkey multiple times (that
|
|
|
|
* is, calling JS_Init/JSAPI methods/JS_ShutDown in that order, then doing so
|
|
|
|
* again). This restriction may eventually be lifted.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_Init(void);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Destroy free-standing resources allocated by SpiderMonkey, not associated
|
|
|
|
* with any runtime, context, or other structure.
|
|
|
|
*
|
|
|
|
* This method should be called after all other JSAPI data has been properly
|
|
|
|
* cleaned up: every new runtime must have been destroyed, every new context
|
|
|
|
* must have been destroyed, and so on. Calling this method before all other
|
|
|
|
* resources have been destroyed has undefined behavior.
|
|
|
|
*
|
|
|
|
* Failure to call this method, at present, has no adverse effects other than
|
|
|
|
* leaking memory. This may not always be the case; it's recommended that all
|
|
|
|
* embedders call this method when all other JSAPI operations have completed.
|
|
|
|
*
|
|
|
|
* It is currently not possible to initialize SpiderMonkey multiple times (that
|
|
|
|
* is, calling JS_Init/JSAPI methods/JS_ShutDown in that order, then doing so
|
|
|
|
* again). This restriction may eventually be lifted.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_ShutDown(void);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSRuntime *)
|
2012-10-16 18:57:09 +00:00
|
|
|
JS_NewRuntime(uint32_t maxbytes, JSUseHelperThreads useHelperThreads);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_DestroyRuntime(JSRuntime *rt);
|
|
|
|
|
2013-07-08 03:29:14 +00:00
|
|
|
// These are equivalent to ICU's |UMemAllocFn|, |UMemReallocFn|, and
|
|
|
|
// |UMemFreeFn| types. The first argument (called |context| in the ICU docs)
|
|
|
|
// will always be NULL, and should be ignored.
|
|
|
|
typedef void *(*JS_ICUAllocFn)(const void *, size_t size);
|
|
|
|
typedef void *(*JS_ICUReallocFn)(const void *, void *p, size_t size);
|
|
|
|
typedef void (*JS_ICUFreeFn)(const void *, void *p);
|
|
|
|
|
|
|
|
// This function can be used to track memory used by ICU.
|
|
|
|
// Do not use it unless you know what you are doing!
|
|
|
|
extern JS_PUBLIC_API(bool)
|
|
|
|
JS_SetICUMemoryFunctions(JS_ICUAllocFn allocFn, JS_ICUReallocFn reallocFn, JS_ICUFreeFn freeFn);
|
|
|
|
|
2000-05-17 06:23:03 +00:00
|
|
|
JS_PUBLIC_API(void *)
|
|
|
|
JS_GetRuntimePrivate(JSRuntime *rt);
|
|
|
|
|
2011-07-18 21:54:48 +00:00
|
|
|
extern JS_PUBLIC_API(JSRuntime *)
|
|
|
|
JS_GetRuntime(JSContext *cx);
|
|
|
|
|
2000-05-17 06:23:03 +00:00
|
|
|
JS_PUBLIC_API(void)
|
|
|
|
JS_SetRuntimePrivate(JSRuntime *rt, void *data);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_BeginRequest(JSContext *cx);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_EndRequest(JSContext *cx);
|
|
|
|
|
2010-11-26 14:11:14 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2011-07-18 21:54:48 +00:00
|
|
|
JS_IsInRequest(JSRuntime *rt);
|
|
|
|
|
2012-04-12 16:23:51 +00:00
|
|
|
namespace JS {
|
|
|
|
|
2011-12-31 14:32:04 +00:00
|
|
|
inline bool
|
|
|
|
IsPoisonedId(jsid iden)
|
|
|
|
{
|
|
|
|
if (JSID_IS_STRING(iden))
|
|
|
|
return JS::IsPoisonedPtr(JSID_TO_STRING(iden));
|
|
|
|
if (JSID_IS_OBJECT(iden))
|
|
|
|
return JS::IsPoisonedPtr(JSID_TO_OBJECT(iden));
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2012-09-25 01:08:22 +00:00
|
|
|
} /* namespace JS */
|
|
|
|
|
|
|
|
namespace js {
|
2012-04-12 16:23:51 +00:00
|
|
|
|
2013-06-19 10:32:26 +00:00
|
|
|
template <> struct GCMethods<jsid>
|
2012-04-12 16:23:51 +00:00
|
|
|
{
|
|
|
|
static jsid initial() { return JSID_VOID; }
|
|
|
|
static ThingRootKind kind() { return THING_ROOT_ID; }
|
2013-03-19 10:35:41 +00:00
|
|
|
static bool poisoned(jsid id) { return JS::IsPoisonedId(id); }
|
2013-05-27 11:51:25 +00:00
|
|
|
static bool needsPostBarrier(jsid id) { return false; }
|
|
|
|
#ifdef JSGC_GENERATIONAL
|
|
|
|
static void postBarrier(jsid *idp) {}
|
|
|
|
static void relocate(jsid *idp) {}
|
|
|
|
#endif
|
2012-04-12 16:23:51 +00:00
|
|
|
};
|
|
|
|
|
2012-09-25 01:08:22 +00:00
|
|
|
} /* namespace js */
|
2012-04-12 16:23:51 +00:00
|
|
|
|
2012-12-27 17:20:22 +00:00
|
|
|
class JSAutoRequest
|
|
|
|
{
|
2005-08-17 16:26:14 +00:00
|
|
|
public:
|
2012-12-27 17:20:22 +00:00
|
|
|
JSAutoRequest(JSContext *cx
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
|
|
|
: mContext(cx)
|
|
|
|
{
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2005-08-17 16:26:14 +00:00
|
|
|
JS_BeginRequest(mContext);
|
|
|
|
}
|
|
|
|
~JSAutoRequest() {
|
|
|
|
JS_EndRequest(mContext);
|
|
|
|
}
|
|
|
|
|
2008-07-17 16:37:32 +00:00
|
|
|
protected:
|
|
|
|
JSContext *mContext;
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2008-07-17 16:37:32 +00:00
|
|
|
|
|
|
|
#if 0
|
|
|
|
private:
|
|
|
|
static void *operator new(size_t) CPP_THROW_NEW { return 0; };
|
|
|
|
static void operator delete(void *, size_t) { };
|
|
|
|
#endif
|
|
|
|
};
|
|
|
|
|
2012-12-27 17:20:22 +00:00
|
|
|
class JSAutoCheckRequest
|
|
|
|
{
|
2010-11-26 14:11:14 +00:00
|
|
|
public:
|
2012-12-27 17:20:22 +00:00
|
|
|
JSAutoCheckRequest(JSContext *cx
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
|
|
|
{
|
2010-11-26 14:11:14 +00:00
|
|
|
#if defined JS_THREADSAFE && defined DEBUG
|
|
|
|
mContext = cx;
|
2011-07-18 21:54:48 +00:00
|
|
|
JS_ASSERT(JS_IsInRequest(JS_GetRuntime(cx)));
|
2010-11-26 14:11:14 +00:00
|
|
|
#endif
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2010-11-26 14:11:14 +00:00
|
|
|
}
|
2011-01-04 23:47:12 +00:00
|
|
|
|
2010-11-26 14:11:14 +00:00
|
|
|
~JSAutoCheckRequest() {
|
|
|
|
#if defined JS_THREADSAFE && defined DEBUG
|
2011-07-18 21:54:48 +00:00
|
|
|
JS_ASSERT(JS_IsInRequest(JS_GetRuntime(mContext)));
|
2010-11-26 14:11:14 +00:00
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
#if defined JS_THREADSAFE && defined DEBUG
|
|
|
|
JSContext *mContext;
|
|
|
|
#endif
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2010-11-26 14:11:14 +00:00
|
|
|
};
|
|
|
|
|
2006-06-27 12:09:09 +00:00
|
|
|
extern JS_PUBLIC_API(JSContextCallback)
|
|
|
|
JS_SetContextCallback(JSRuntime *rt, JSContextCallback cxCallback);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSContext *)
|
2000-03-23 23:50:29 +00:00
|
|
|
JS_NewContext(JSRuntime *rt, size_t stackChunkSize);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_DestroyContext(JSContext *cx);
|
|
|
|
|
1999-06-23 14:18:56 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_DestroyContextNoGC(JSContext *cx);
|
|
|
|
|
2000-02-04 02:01:49 +00:00
|
|
|
extern JS_PUBLIC_API(void *)
|
1998-04-24 00:31:11 +00:00
|
|
|
JS_GetContextPrivate(JSContext *cx);
|
|
|
|
|
1999-11-23 01:02:28 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
1998-07-31 00:07:22 +00:00
|
|
|
JS_SetContextPrivate(JSContext *cx, void *data);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2012-01-11 08:23:07 +00:00
|
|
|
extern JS_PUBLIC_API(void *)
|
|
|
|
JS_GetSecondContextPrivate(JSContext *cx);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetSecondContextPrivate(JSContext *cx, void *data);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSRuntime *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_GetRuntime(JSContext *cx);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSContext *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_ContextIterator(JSRuntime *rt, JSContext **iterp);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSVersion)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_GetVersion(JSContext *cx);
|
|
|
|
|
2013-06-29 15:11:19 +00:00
|
|
|
// Mutate the version on the compartment. This is generally discouraged, but
|
|
|
|
// necessary to support the version mutation in the js and xpc shell command
|
|
|
|
// set.
|
|
|
|
//
|
|
|
|
// It would be nice to put this in jsfriendapi, but the linkage requirements
|
|
|
|
// of the shells make that impossible.
|
|
|
|
JS_PUBLIC_API(void)
|
|
|
|
JS_SetVersionForCompartment(JSCompartment *compartment, JSVersion version);
|
|
|
|
|
1999-10-29 22:44:35 +00:00
|
|
|
extern JS_PUBLIC_API(const char *)
|
|
|
|
JS_VersionToString(JSVersion version);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSVersion)
|
|
|
|
JS_StringToVersion(const char *string);
|
|
|
|
|
1999-11-12 06:03:40 +00:00
|
|
|
/*
|
|
|
|
* JS options are orthogonal to version, and may be freely composed with one
|
|
|
|
* another as well as with version.
|
2001-01-20 02:02:48 +00:00
|
|
|
*
|
|
|
|
* JSOPTION_VAROBJFIX is recommended -- see the comments associated with the
|
|
|
|
* prototypes for JS_ExecuteScript, JS_EvaluateScript, etc.
|
1999-11-12 06:03:40 +00:00
|
|
|
*/
|
2013-06-11 19:49:11 +00:00
|
|
|
#define JSOPTION_EXTRA_WARNINGS JS_BIT(0) /* warn on dubious practices */
|
2000-01-18 11:06:05 +00:00
|
|
|
#define JSOPTION_WERROR JS_BIT(1) /* convert warning to error */
|
2001-01-20 01:41:55 +00:00
|
|
|
#define JSOPTION_VAROBJFIX JS_BIT(2) /* make JS_EvaluateScript use
|
|
|
|
the last object on its 'obj'
|
|
|
|
param's scope chain as the
|
|
|
|
ECMA 'variables object' */
|
2001-08-07 05:27:42 +00:00
|
|
|
#define JSOPTION_PRIVATE_IS_NSISUPPORTS \
|
|
|
|
JS_BIT(3) /* context private data points
|
|
|
|
to an nsISupports subclass */
|
2004-04-13 01:25:17 +00:00
|
|
|
#define JSOPTION_COMPILE_N_GO JS_BIT(4) /* caller of JS_Compile*Script
|
|
|
|
promises to execute compiled
|
|
|
|
script once only; enables
|
|
|
|
compile-time scope chain
|
|
|
|
resolution of consts. */
|
2013-03-11 21:27:34 +00:00
|
|
|
|
|
|
|
/* JS_BIT(5) is currently unused. */
|
2013-01-25 05:24:57 +00:00
|
|
|
|
|
|
|
/* JS_BIT(6) is currently unused. */
|
|
|
|
|
|
|
|
/* JS_BIT(7) is currently unused. */
|
|
|
|
|
2012-05-30 20:05:59 +00:00
|
|
|
#define JSOPTION_DONT_REPORT_UNCAUGHT \
|
2006-01-18 00:29:35 +00:00
|
|
|
JS_BIT(8) /* When returning from the
|
|
|
|
outermost API call, prevent
|
|
|
|
uncaught exceptions from
|
|
|
|
being converted to error
|
|
|
|
reports */
|
1999-11-12 06:03:40 +00:00
|
|
|
|
2012-10-19 01:06:42 +00:00
|
|
|
/* JS_BIT(9) is currently unused. */
|
|
|
|
|
2011-06-21 16:53:19 +00:00
|
|
|
/* JS_BIT(10) is currently unused. */
|
2007-02-17 06:33:09 +00:00
|
|
|
|
2011-11-28 22:57:31 +00:00
|
|
|
/* JS_BIT(11) is currently unused. */
|
2008-06-27 08:22:53 +00:00
|
|
|
|
2008-07-25 23:23:12 +00:00
|
|
|
#define JSOPTION_NO_SCRIPT_RVAL JS_BIT(12) /* A promise to the compiler
|
|
|
|
that a null rval out-param
|
|
|
|
will be passed to each call
|
|
|
|
to JS_ExecuteScript. */
|
2008-12-15 06:40:10 +00:00
|
|
|
#define JSOPTION_UNROOTED_GLOBAL JS_BIT(13) /* The GC will not root the
|
2013-05-22 21:42:45 +00:00
|
|
|
contexts' default compartment
|
|
|
|
object, leaving that up to the
|
2009-01-28 03:56:55 +00:00
|
|
|
embedding. */
|
2008-07-25 23:23:12 +00:00
|
|
|
|
2013-05-22 12:50:45 +00:00
|
|
|
#define JSOPTION_BASELINE JS_BIT(14) /* Baseline compiler. */
|
2011-11-28 22:57:31 +00:00
|
|
|
|
2013-05-22 12:50:45 +00:00
|
|
|
#define JSOPTION_TYPE_INFERENCE JS_BIT(16) /* Perform type inference. */
|
|
|
|
#define JSOPTION_STRICT_MODE JS_BIT(17) /* Provides a way to force
|
2012-05-05 19:26:16 +00:00
|
|
|
strict mode for all code
|
|
|
|
without requiring
|
|
|
|
"use strict" annotations. */
|
2011-03-03 22:07:48 +00:00
|
|
|
|
2013-05-22 12:50:45 +00:00
|
|
|
#define JSOPTION_ION JS_BIT(18) /* IonMonkey */
|
2012-04-18 18:56:50 +00:00
|
|
|
|
2013-05-22 12:50:45 +00:00
|
|
|
#define JSOPTION_ASMJS JS_BIT(19) /* optimizingasm.js compiler */
|
2012-12-05 16:09:06 +00:00
|
|
|
|
2013-05-22 12:50:45 +00:00
|
|
|
#define JSOPTION_MASK JS_BITMASK(20)
|
2010-05-23 00:09:52 +00:00
|
|
|
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
extern JS_PUBLIC_API(uint32_t)
|
1999-11-12 06:03:40 +00:00
|
|
|
JS_GetOptions(JSContext *cx);
|
|
|
|
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
extern JS_PUBLIC_API(uint32_t)
|
|
|
|
JS_SetOptions(JSContext *cx, uint32_t options);
|
1999-11-12 06:03:40 +00:00
|
|
|
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
extern JS_PUBLIC_API(uint32_t)
|
|
|
|
JS_ToggleOptions(JSContext *cx, uint32_t options);
|
1999-11-12 06:03:40 +00:00
|
|
|
|
2012-02-14 05:36:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetJitHardening(JSRuntime *rt, JSBool enabled);
|
|
|
|
|
1998-07-31 00:07:22 +00:00
|
|
|
extern JS_PUBLIC_API(const char *)
|
|
|
|
JS_GetImplementationVersion(void);
|
|
|
|
|
2012-03-20 10:22:05 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetDestroyCompartmentCallback(JSRuntime *rt, JSDestroyCompartmentCallback callback);
|
2010-07-19 20:36:49 +00:00
|
|
|
|
2012-07-26 01:25:47 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetCompartmentNameCallback(JSRuntime *rt, JSCompartmentNameCallback callback);
|
|
|
|
|
2010-06-24 21:45:32 +00:00
|
|
|
extern JS_PUBLIC_API(JSWrapObjectCallback)
|
2010-10-10 22:36:38 +00:00
|
|
|
JS_SetWrapObjectCallbacks(JSRuntime *rt,
|
|
|
|
JSWrapObjectCallback callback,
|
2012-05-14 21:30:07 +00:00
|
|
|
JSSameCompartmentWrapObjectCallback sccallback,
|
2010-10-10 22:36:38 +00:00
|
|
|
JSPreWrapCallback precallback);
|
2010-06-24 21:45:32 +00:00
|
|
|
|
2012-02-29 12:18:16 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetCompartmentPrivate(JSCompartment *compartment, void *data);
|
2010-07-19 20:36:49 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void *)
|
2012-02-29 12:18:16 +00:00
|
|
|
JS_GetCompartmentPrivate(JSCompartment *compartment);
|
2010-07-19 20:36:49 +00:00
|
|
|
|
2010-08-23 22:14:38 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2010-09-16 18:32:18 +00:00
|
|
|
JS_WrapObject(JSContext *cx, JSObject **objp);
|
2010-08-23 22:14:38 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2010-09-16 18:32:18 +00:00
|
|
|
JS_WrapValue(JSContext *cx, jsval *vp);
|
2010-08-23 22:14:38 +00:00
|
|
|
|
2012-12-20 19:26:35 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_WrapId(JSContext *cx, jsid *idp);
|
|
|
|
|
2010-09-17 21:54:40 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2013-06-14 00:09:55 +00:00
|
|
|
JS_TransplantObject(JSContext *cx, JS::HandleObject origobj, JS::HandleObject target);
|
2010-09-17 21:54:40 +00:00
|
|
|
|
2011-02-12 00:17:25 +00:00
|
|
|
extern JS_FRIEND_API(JSObject *)
|
|
|
|
js_TransplantObjectWithWrapper(JSContext *cx,
|
2013-06-14 00:09:55 +00:00
|
|
|
JS::HandleObject origobj,
|
|
|
|
JS::HandleObject origwrapper,
|
|
|
|
JS::HandleObject targetobj,
|
|
|
|
JS::HandleObject targetwrapper);
|
2011-02-12 00:17:25 +00:00
|
|
|
|
2012-05-14 10:52:16 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_RefreshCrossCompartmentWrappers(JSContext *cx, JSObject *ob);
|
2011-02-12 00:17:25 +00:00
|
|
|
|
2012-08-27 20:32:51 +00:00
|
|
|
/*
|
|
|
|
* At any time, a JSContext has a current (possibly-NULL) compartment.
|
|
|
|
* Compartments are described in:
|
|
|
|
*
|
|
|
|
* developer.mozilla.org/en-US/docs/SpiderMonkey/SpiderMonkey_compartments
|
|
|
|
*
|
|
|
|
* The current compartment of a context may be changed. The preferred way to do
|
|
|
|
* this is with JSAutoCompartment:
|
|
|
|
*
|
|
|
|
* void foo(JSContext *cx, JSObject *obj) {
|
|
|
|
* // in some compartment 'c'
|
|
|
|
* {
|
|
|
|
* JSAutoCompartment ac(cx, obj); // constructor enters
|
|
|
|
* // in the compartment of 'obj'
|
|
|
|
* } // destructor leaves
|
|
|
|
* // back in compartment 'c'
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* For more complicated uses that don't neatly fit in a C++ stack frame, the
|
|
|
|
* compartment can entered and left using separate function calls:
|
|
|
|
*
|
|
|
|
* void foo(JSContext *cx, JSObject *obj) {
|
|
|
|
* // in 'oldCompartment'
|
|
|
|
* JSCompartment *oldCompartment = JS_EnterCompartment(cx, obj);
|
|
|
|
* // in the compartment of 'obj'
|
|
|
|
* JS_LeaveCompartment(cx, oldCompartment);
|
|
|
|
* // back in 'oldCompartment'
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* Note: these calls must still execute in a LIFO manner w.r.t all other
|
|
|
|
* enter/leave calls on the context. Furthermore, only the return value of a
|
|
|
|
* JS_EnterCompartment call may be passed as the 'oldCompartment' argument of
|
|
|
|
* the corresponding JS_LeaveCompartment call.
|
|
|
|
*/
|
|
|
|
|
2012-08-22 01:42:53 +00:00
|
|
|
class JS_PUBLIC_API(JSAutoCompartment)
|
2010-06-24 21:44:18 +00:00
|
|
|
{
|
2012-08-18 01:05:06 +00:00
|
|
|
JSContext *cx_;
|
|
|
|
JSCompartment *oldCompartment_;
|
2010-06-24 21:44:18 +00:00
|
|
|
public:
|
2013-04-16 01:16:13 +00:00
|
|
|
JSAutoCompartment(JSContext *cx, JSObject *target);
|
2012-08-27 20:32:51 +00:00
|
|
|
JSAutoCompartment(JSContext *cx, JSScript *target);
|
2012-08-22 01:42:53 +00:00
|
|
|
~JSAutoCompartment();
|
2010-06-24 21:44:18 +00:00
|
|
|
};
|
|
|
|
|
2012-08-27 20:32:51 +00:00
|
|
|
/* NB: This API is infallible; a NULL return value does not indicate error. */
|
|
|
|
extern JS_PUBLIC_API(JSCompartment *)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_EnterCompartment(JSContext *cx, JSObject *target);
|
2012-08-27 20:32:51 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_LeaveCompartment(JSContext *cx, JSCompartment *oldCompartment);
|
|
|
|
|
2012-02-29 20:23:53 +00:00
|
|
|
typedef void (*JSIterateCompartmentCallback)(JSRuntime *rt, void *data, JSCompartment *compartment);
|
2012-02-17 06:10:39 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* This function calls |compartmentCallback| on every compartment. Beware that
|
|
|
|
* there is no guarantee that the compartment will survive after the callback
|
|
|
|
* returns.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
2012-02-29 20:23:53 +00:00
|
|
|
JS_IterateCompartments(JSRuntime *rt, void *data,
|
2012-02-17 06:10:39 +00:00
|
|
|
JSIterateCompartmentCallback compartmentCallback);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_SetGlobalObject(JSContext *cx, JSObject *obj);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2000-08-19 08:37:07 +00:00
|
|
|
/*
|
|
|
|
* Initialize standard JS class constructors, prototypes, and any top-level
|
|
|
|
* functions and constants associated with the standard classes (e.g. isNaN
|
|
|
|
* for Number).
|
|
|
|
*
|
|
|
|
* NB: This sets cx's global object to obj if it was null.
|
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_InitStandardClasses(JSContext *cx, JSObject *obj);
|
|
|
|
|
2000-08-19 08:37:07 +00:00
|
|
|
/*
|
|
|
|
* Resolve id, which must contain either a string or an int, to a standard
|
|
|
|
* class name in obj if possible, defining the class's constructor and/or
|
|
|
|
* prototype and storing true in *resolved. If id does not name a standard
|
|
|
|
* class or a top-level property induced by initializing a standard class,
|
|
|
|
* store false in *resolved and just return true. Return false on error,
|
|
|
|
* as usual for JSBool result-typed API entry points.
|
|
|
|
*
|
|
|
|
* This API can be called directly from a global object class's resolve op,
|
|
|
|
* to define standard classes lazily. The class's enumerate op should call
|
|
|
|
* JS_EnumerateStandardClasses(cx, obj), to define eagerly during for..in
|
|
|
|
* loops any classes not yet resolved lazily.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-06-14 00:10:00 +00:00
|
|
|
JS_ResolveStandardClass(JSContext *cx, JS::HandleObject obj, JS::HandleId id,
|
2000-08-19 08:37:07 +00:00
|
|
|
JSBool *resolved);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-06-14 00:10:00 +00:00
|
|
|
JS_EnumerateStandardClasses(JSContext *cx, JS::HandleObject obj);
|
2000-08-19 08:37:07 +00:00
|
|
|
|
2006-04-19 00:22:43 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_GetClassObject(JSContext *cx, JSObject *obj, JSProtoKey key, JSObject **objp);
|
2006-04-19 00:22:43 +00:00
|
|
|
|
2012-07-27 10:15:46 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_GetClassPrototype(JSContext *cx, JSProtoKey key, JSObject **objp);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSProtoKey)
|
|
|
|
JS_IdentifyClassPrototype(JSContext *cx, JSObject *obj);
|
|
|
|
|
2012-02-10 22:49:39 +00:00
|
|
|
/*
|
|
|
|
* Returns the original value of |Function.prototype| from the global object in
|
|
|
|
* which |forObj| was created.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_GetFunctionPrototype(JSContext *cx, JSObject *forObj);
|
2012-02-10 22:49:39 +00:00
|
|
|
|
2012-02-07 19:45:18 +00:00
|
|
|
/*
|
|
|
|
* Returns the original value of |Object.prototype| from the global object in
|
|
|
|
* which |forObj| was created.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_GetObjectPrototype(JSContext *cx, JSObject *forObj);
|
2012-02-07 19:45:18 +00:00
|
|
|
|
2013-05-14 18:17:09 +00:00
|
|
|
/*
|
|
|
|
* Returns the original value of |Array.prototype| from the global object in
|
|
|
|
* which |forObj| was created.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
|
|
|
JS_GetArrayPrototype(JSContext *cx, JSObject *forObj);
|
|
|
|
|
2007-08-09 22:19:59 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_GetGlobalForObject(JSContext *cx, JSObject *obj);
|
2007-08-09 22:19:59 +00:00
|
|
|
|
2012-10-25 15:01:08 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_IsGlobalObject(JSObject *obj);
|
2012-10-25 15:01:08 +00:00
|
|
|
|
2012-07-06 04:12:37 +00:00
|
|
|
/*
|
|
|
|
* May return NULL, if |c| never had a global (e.g. the atoms compartment), or
|
|
|
|
* if |c|'s global has been collected.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
|
|
|
JS_GetGlobalForCompartmentOrNull(JSContext *cx, JSCompartment *c);
|
|
|
|
|
2010-05-21 12:27:00 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
|
|
|
JS_GetGlobalForScopeChain(JSContext *cx);
|
|
|
|
|
2013-03-24 16:27:09 +00:00
|
|
|
/*
|
|
|
|
* This method returns the global corresponding to the most recent scripted
|
|
|
|
* frame, which may not match the cx's current compartment. This is extremely
|
|
|
|
* dangerous, because it can bypass compartment security invariants in subtle
|
|
|
|
* ways. To use it safely, the caller must perform a subsequent security
|
|
|
|
* check. There is currently only one consumer of this function in Gecko, and
|
|
|
|
* it should probably stay that way. If you'd like to use it, please consult
|
|
|
|
* the XPConnect module owner first.
|
|
|
|
*/
|
2012-04-16 19:30:04 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
|
|
|
JS_GetScriptedGlobal(JSContext *cx);
|
|
|
|
|
2011-06-28 17:57:16 +00:00
|
|
|
/*
|
|
|
|
* Initialize the 'Reflect' object on a global object.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
|
|
|
JS_InitReflect(JSContext *cx, JSObject *global);
|
|
|
|
|
2010-04-02 20:07:41 +00:00
|
|
|
#ifdef JS_HAS_CTYPES
|
|
|
|
/*
|
|
|
|
* Initialize the 'ctypes' object on a global variable 'obj'. The 'ctypes'
|
|
|
|
* object will be sealed.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_InitCTypesClass(JSContext *cx, JSObject *global);
|
2010-09-13 17:54:02 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Convert a unicode string 'source' of length 'slen' to the platform native
|
|
|
|
* charset, returning a null-terminated string allocated with JS_malloc. On
|
|
|
|
* failure, this function should report an error.
|
|
|
|
*/
|
|
|
|
typedef char *
|
|
|
|
(* JSCTypesUnicodeToNativeFun)(JSContext *cx, const jschar *source, size_t slen);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Set of function pointers that ctypes can use for various internal functions.
|
|
|
|
* See JS_SetCTypesCallbacks below. Providing NULL for a function is safe,
|
|
|
|
* and will result in the applicable ctypes functionality not being available.
|
|
|
|
*/
|
|
|
|
struct JSCTypesCallbacks {
|
|
|
|
JSCTypesUnicodeToNativeFun unicodeToNative;
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef struct JSCTypesCallbacks JSCTypesCallbacks;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Set the callbacks on the provided 'ctypesObj' object. 'callbacks' should be a
|
|
|
|
* pointer to static data that exists for the lifetime of 'ctypesObj', but it
|
|
|
|
* may safely be altered after calling this function and without having
|
|
|
|
* to call this function again.
|
|
|
|
*/
|
2012-02-05 20:07:23 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_SetCTypesCallbacks(JSObject *ctypesObj, JSCTypesCallbacks *callbacks);
|
2010-04-02 20:07:41 +00:00
|
|
|
#endif
|
|
|
|
|
2011-07-08 00:31:18 +00:00
|
|
|
typedef JSBool
|
|
|
|
(* JSEnumerateDiagnosticMemoryCallback)(void *ptr, size_t length);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Enumerate memory regions that contain diagnostic information
|
|
|
|
* intended to be included in crash report minidumps.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_EnumerateDiagnosticMemoryRegions(JSEnumerateDiagnosticMemoryCallback callback);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_malloc(JSContext *cx, size_t nbytes);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_realloc(JSContext *cx, void *p, size_t nbytes);
|
|
|
|
|
2012-03-19 14:34:55 +00:00
|
|
|
/*
|
|
|
|
* A wrapper for js_free(p) that may delay js_free(p) invocation as a
|
|
|
|
* performance optimization.
|
2012-11-02 10:42:59 +00:00
|
|
|
* cx may be NULL.
|
2012-03-19 14:34:55 +00:00
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_free(JSContext *cx, void *p);
|
|
|
|
|
2012-03-19 14:34:55 +00:00
|
|
|
/*
|
|
|
|
* A wrapper for js_free(p) that may delay js_free(p) invocation as a
|
|
|
|
* performance optimization as specified by the given JSFreeOp instance.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_freeop(JSFreeOp *fop, void *p);
|
|
|
|
|
2012-03-19 14:34:58 +00:00
|
|
|
extern JS_PUBLIC_API(JSFreeOp *)
|
2012-05-19 19:56:17 +00:00
|
|
|
JS_GetDefaultFreeOp(JSRuntime *rt);
|
2012-03-19 14:34:58 +00:00
|
|
|
|
2009-10-29 18:48:18 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_updateMallocCounter(JSContext *cx, size_t nbytes);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(char *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_strdup(JSContext *cx, const char *s);
|
|
|
|
|
2013-02-08 02:04:11 +00:00
|
|
|
/* Duplicate a string. Does not report an error on failure. */
|
|
|
|
extern JS_PUBLIC_API(char *)
|
|
|
|
JS_strdup(JSRuntime *rt, const char *s);
|
|
|
|
|
2010-05-18 01:49:58 +00:00
|
|
|
|
2000-05-14 23:00:51 +00:00
|
|
|
/*
|
2010-06-08 00:05:02 +00:00
|
|
|
* A GC root is a pointer to a jsval, JSObject * or JSString * that itself
|
|
|
|
* points into the GC heap. JS_AddValueRoot takes a pointer to a jsval and
|
|
|
|
* JS_AddGCThingRoot takes a pointer to a JSObject * or JString *.
|
2010-05-11 05:01:31 +00:00
|
|
|
*
|
2010-06-08 00:05:02 +00:00
|
|
|
* Note that, since JS_Add*Root stores the address of a variable (of type
|
|
|
|
* jsval, JSString *, or JSObject *), that variable must live until
|
|
|
|
* JS_Remove*Root is called to remove that variable. For example, after:
|
2000-05-14 23:00:51 +00:00
|
|
|
*
|
2010-06-08 00:05:02 +00:00
|
|
|
* void some_function() {
|
|
|
|
* jsval v;
|
2013-02-06 14:23:45 +00:00
|
|
|
* JS_AddNamedValueRoot(cx, &v, "name");
|
2010-05-11 05:01:31 +00:00
|
|
|
*
|
|
|
|
* the caller must perform
|
|
|
|
*
|
2013-02-06 14:23:45 +00:00
|
|
|
* JS_RemoveValueRoot(cx, &v);
|
2010-05-11 05:01:31 +00:00
|
|
|
*
|
2010-06-08 00:05:02 +00:00
|
|
|
* before some_function() returns.
|
2000-05-14 23:00:51 +00:00
|
|
|
*
|
2010-06-08 00:05:02 +00:00
|
|
|
* Also, use JS_AddNamed*Root(cx, &structPtr->memberObj, "structPtr->memberObj")
|
|
|
|
* in preference to JS_Add*Root(cx, &structPtr->memberObj), in order to identify
|
2000-05-14 23:00:51 +00:00
|
|
|
* roots by their source callsites. This way, you can find the callsite while
|
2010-06-08 00:05:02 +00:00
|
|
|
* debugging if you should fail to do JS_Remove*Root(cx, &structPtr->memberObj)
|
2000-05-14 23:00:51 +00:00
|
|
|
* before freeing structPtr's memory.
|
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2010-05-18 04:21:44 +00:00
|
|
|
JS_AddValueRoot(JSContext *cx, jsval *vp);
|
2010-05-11 05:01:31 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_AddStringRoot(JSContext *cx, JSString **rp);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_AddObjectRoot(JSContext *cx, JSObject **rp);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2003-02-25 03:29:24 +00:00
|
|
|
#ifdef NAME_ALL_GC_ROOTS
|
|
|
|
#define JS_DEFINE_TO_TOKEN(def) #def
|
|
|
|
#define JS_DEFINE_TO_STRING(def) JS_DEFINE_TO_TOKEN(def)
|
2010-05-11 05:01:31 +00:00
|
|
|
#define JS_AddValueRoot(cx,vp) JS_AddNamedValueRoot((cx), (vp), (__FILE__ ":" JS_TOKEN_TO_STRING(__LINE__))
|
|
|
|
#define JS_AddStringRoot(cx,rp) JS_AddNamedStringRoot((cx), (rp), (__FILE__ ":" JS_TOKEN_TO_STRING(__LINE__))
|
|
|
|
#define JS_AddObjectRoot(cx,rp) JS_AddNamedObjectRoot((cx), (rp), (__FILE__ ":" JS_TOKEN_TO_STRING(__LINE__))
|
2003-02-25 03:29:24 +00:00
|
|
|
#endif
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2010-05-18 04:21:44 +00:00
|
|
|
JS_AddNamedValueRoot(JSContext *cx, jsval *vp, const char *name);
|
2010-05-11 05:01:31 +00:00
|
|
|
|
2013-01-29 02:25:23 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_AddNamedValueRootRT(JSRuntime *rt, jsval *vp, const char *name);
|
|
|
|
|
2010-05-11 05:01:31 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_AddNamedStringRoot(JSContext *cx, JSString **rp, const char *name);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_AddNamedObjectRoot(JSContext *cx, JSObject **rp, const char *name);
|
|
|
|
|
2011-09-02 06:46:00 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_AddNamedScriptRoot(JSContext *cx, JSScript **rp, const char *name);
|
|
|
|
|
2012-03-19 14:34:58 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2010-05-18 04:21:44 +00:00
|
|
|
JS_RemoveValueRoot(JSContext *cx, jsval *vp);
|
2010-05-11 05:01:31 +00:00
|
|
|
|
2012-03-19 14:34:58 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2010-05-11 05:01:31 +00:00
|
|
|
JS_RemoveStringRoot(JSContext *cx, JSString **rp);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2012-03-19 14:34:58 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2010-05-11 05:01:31 +00:00
|
|
|
JS_RemoveObjectRoot(JSContext *cx, JSObject **rp);
|
1999-06-23 14:18:56 +00:00
|
|
|
|
2012-03-19 14:34:58 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2011-09-02 06:46:00 +00:00
|
|
|
JS_RemoveScriptRoot(JSContext *cx, JSScript **rp);
|
|
|
|
|
2012-03-19 14:34:58 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_RemoveValueRootRT(JSRuntime *rt, jsval *vp);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_RemoveStringRootRT(JSRuntime *rt, JSString **rp);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_RemoveObjectRootRT(JSRuntime *rt, JSObject **rp);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_RemoveScriptRootRT(JSRuntime *rt, JSScript **rp);
|
|
|
|
|
2010-06-04 23:55:08 +00:00
|
|
|
/* TODO: remove these APIs */
|
2010-05-11 05:01:31 +00:00
|
|
|
|
2012-03-19 14:34:58 +00:00
|
|
|
extern JS_FRIEND_API(void)
|
2010-06-04 23:55:08 +00:00
|
|
|
js_RemoveRoot(JSRuntime *rt, void *rp);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2011-02-03 13:06:21 +00:00
|
|
|
/*
|
|
|
|
* C-compatible version of the Anchor class. It should be called after the last
|
|
|
|
* use of the variable it protects.
|
|
|
|
*/
|
|
|
|
extern JS_NEVER_INLINE JS_PUBLIC_API(void)
|
|
|
|
JS_AnchorPtr(void *p);
|
|
|
|
|
2007-05-01 10:09:46 +00:00
|
|
|
/*
|
|
|
|
* Register externally maintained GC roots.
|
|
|
|
*
|
|
|
|
* traceOp: the trace operation. For each root the implementation should call
|
|
|
|
* JS_CallTracer whenever the root contains a traceable thing.
|
|
|
|
* data: the data argument to pass to each invocation of traceOp.
|
|
|
|
*/
|
2013-07-03 07:24:32 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_AddExtraGCRootsTracer(JSRuntime *rt, JSTraceDataOp traceOp, void *data);
|
|
|
|
|
|
|
|
/* Undo a call to JS_AddExtraGCRootsTracer. */
|
2007-05-01 10:09:46 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2013-07-03 07:24:32 +00:00
|
|
|
JS_RemoveExtraGCRootsTracer(JSRuntime *rt, JSTraceDataOp traceOp, void *data);
|
2007-05-01 10:09:46 +00:00
|
|
|
|
2007-04-17 06:53:37 +00:00
|
|
|
/*
|
|
|
|
* JS_CallTracer API and related macros for implementors of JSTraceOp, to
|
|
|
|
* enumerate all references to traceable things reachable via a property or
|
|
|
|
* other strong ref identified for debugging purposes by name or index or
|
2007-06-10 22:08:17 +00:00
|
|
|
* a naming callback.
|
2000-08-26 02:30:22 +00:00
|
|
|
*
|
2011-09-19 16:34:49 +00:00
|
|
|
* See the JSTraceOp typedef.
|
2007-04-17 06:53:37 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Use the following macros to check if a particular jsval is a traceable
|
|
|
|
* thing and to extract the thing and its kind to pass to JS_CallTracer.
|
|
|
|
*/
|
2010-05-11 05:01:31 +00:00
|
|
|
static JS_ALWAYS_INLINE JSBool
|
|
|
|
JSVAL_IS_TRACEABLE(jsval v)
|
|
|
|
{
|
2011-09-19 16:34:49 +00:00
|
|
|
return JSVAL_IS_TRACEABLE_IMPL(JSVAL_TO_IMPL(v));
|
2010-05-11 05:01:31 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE void *
|
|
|
|
JSVAL_TO_TRACEABLE(jsval v)
|
|
|
|
{
|
|
|
|
return JSVAL_TO_GCTHING(v);
|
|
|
|
}
|
|
|
|
|
2011-09-01 18:43:46 +00:00
|
|
|
static JS_ALWAYS_INLINE JSGCTraceKind
|
2010-05-11 05:01:31 +00:00
|
|
|
JSVAL_TRACE_KIND(jsval v)
|
|
|
|
{
|
2010-05-25 18:20:59 +00:00
|
|
|
JS_ASSERT(JSVAL_IS_GCTHING(v));
|
2011-09-19 16:34:49 +00:00
|
|
|
return (JSGCTraceKind) JSVAL_TRACE_KIND_IMPL(JSVAL_TO_IMPL(v));
|
2010-05-11 05:01:31 +00:00
|
|
|
}
|
2007-04-17 06:53:37 +00:00
|
|
|
|
2011-09-01 18:43:46 +00:00
|
|
|
/*
|
|
|
|
* Tracer callback, called for each traceable thing directly referenced by a
|
|
|
|
* particular object or runtime structure. It is the callback responsibility
|
|
|
|
* to ensure the traversal of the full object graph via calling eventually
|
|
|
|
* JS_TraceChildren on the passed thing. In this case the callback must be
|
|
|
|
* prepared to deal with cycles in the traversal graph.
|
|
|
|
*
|
|
|
|
* kind argument is one of JSTRACE_OBJECT, JSTRACE_STRING or a tag denoting
|
|
|
|
* internal implementation-specific traversal kind. In the latter case the only
|
|
|
|
* operations on thing that the callback can do is to call JS_TraceChildren or
|
2012-06-14 15:52:54 +00:00
|
|
|
* JS_GetTraceThingInfo.
|
2011-09-04 18:25:49 +00:00
|
|
|
*
|
|
|
|
* If eagerlyTraceWeakMaps is true, when we trace a WeakMap visit all
|
|
|
|
* of its mappings. This should be used in cases where the tracer
|
|
|
|
* wants to use the existing liveness of entries.
|
2011-09-01 18:43:46 +00:00
|
|
|
*/
|
|
|
|
typedef void
|
2012-02-16 00:28:41 +00:00
|
|
|
(* JSTraceCallback)(JSTracer *trc, void **thingp, JSGCTraceKind kind);
|
2011-09-01 18:43:46 +00:00
|
|
|
|
2013-03-07 18:49:30 +00:00
|
|
|
enum WeakMapTraceKind {
|
|
|
|
DoNotTraceWeakMaps = 0,
|
2013-03-13 22:12:24 +00:00
|
|
|
TraceWeakMapValues = 1,
|
|
|
|
TraceWeakMapKeysValues = 2
|
2013-03-07 18:49:30 +00:00
|
|
|
};
|
|
|
|
|
2007-04-17 06:53:37 +00:00
|
|
|
struct JSTracer {
|
2011-10-25 23:07:42 +00:00
|
|
|
JSRuntime *runtime;
|
2007-04-17 06:53:37 +00:00
|
|
|
JSTraceCallback callback;
|
|
|
|
JSTraceNamePrinter debugPrinter;
|
|
|
|
const void *debugPrintArg;
|
|
|
|
size_t debugPrintIndex;
|
2013-03-07 18:49:30 +00:00
|
|
|
WeakMapTraceKind eagerlyTraceWeakMaps;
|
2012-06-21 01:48:56 +00:00
|
|
|
#ifdef JS_GC_ZEAL
|
2012-04-05 23:10:53 +00:00
|
|
|
void *realLocation;
|
|
|
|
#endif
|
2007-04-17 06:53:37 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Set debugging information about a reference to a traceable thing to prepare
|
|
|
|
* for the following call to JS_CallTracer.
|
|
|
|
*
|
|
|
|
* When printer is null, arg must be const char * or char * C string naming
|
|
|
|
* the reference and index must be either (size_t)-1 indicating that the name
|
|
|
|
* alone describes the reference or it must be an index into some array vector
|
|
|
|
* that stores the reference.
|
|
|
|
*
|
|
|
|
* When printer callback is not null, the arg and index arguments are
|
Bug 672736: Implement the 'findReferences' shell function. r=jorendorff
findReferences(thing)
Walk the entire heap, looking for references to |thing|, and return a
"references object" describing what we found.
Each property of the references object describes one kind of reference. The
property's name is the label supplied to MarkObject, JS_CALL_TRACER, or what
have you, prefixed with "edge: " to avoid collisions with system properties
(like "toString" and "__proto__"). The property's value is an array of things
that refer to |thing| via that kind of reference. Ordinary references from
one object to another are named after the property name (with the "edge: "
prefix).
Garbage collection roots appear as references from 'null'. We use the name
given to the root (with the "edge: " prefix) as the name of the reference.
Note that the references object does record references from objects that are
only reachable via |thing| itself, not just the references reachable
themselves from roots that keep |thing| from being collected. (We could make
this distinction if it is useful.)
If any references are found by the conservative scanner, the references
object will have a property named "edge: machine stack"; the referrers will
be 'null', because they are roots.
js> var o = { x: { y: { z: {} } }}
js> findReferences(o.x.y.z)
({'edge: z':[{z:{}}], 'edge: machine stack':[null, null, null, null, null]})
js> o = { get x() { return 42 } }
({get x () {return 42;}})
js> findReferences(Object.getOwnPropertyDescriptor(o, 'x').get)
({'edge: shape; x getter':[{get x () {return 42;}}],
'edge: constructor':[{}],
'edge: machine stack':[null, null, null, null, null],
'edge: get':[{configurable:true,
enumerable:true,
get:#1=(function () {return 42;}),
set:(void 0)}]})
js> findReferences(Math.atan2)
({'edge: atan2':[Math], 'edge: machine stack':[null, null, null, null, null]})
js> findReferences(o)
({'edge: o':[{o:{get x () {return 42;}}}], 'edge: machine stack':[null, null, null, null, null]})
js>
2011-08-04 03:19:38 +00:00
|
|
|
* available to the callback as debugPrintArg and debugPrintIndex fields
|
2007-04-17 06:53:37 +00:00
|
|
|
* of JSTracer.
|
|
|
|
*
|
|
|
|
* The storage for name or callback's arguments needs to live only until
|
|
|
|
* the following call to JS_CallTracer returns.
|
|
|
|
*/
|
|
|
|
# define JS_SET_TRACING_DETAILS(trc, printer, arg, index) \
|
|
|
|
JS_BEGIN_MACRO \
|
|
|
|
(trc)->debugPrinter = (printer); \
|
|
|
|
(trc)->debugPrintArg = (arg); \
|
|
|
|
(trc)->debugPrintIndex = (index); \
|
|
|
|
JS_END_MACRO
|
2000-08-26 02:30:22 +00:00
|
|
|
|
2012-04-05 23:10:53 +00:00
|
|
|
/*
|
|
|
|
* Sets the real location for a marked reference, when passing the address
|
|
|
|
* directly is not feasable.
|
2012-06-21 01:48:56 +00:00
|
|
|
*
|
|
|
|
* FIXME: This is currently overcomplicated by our need to nest calls for Values
|
|
|
|
* stored as keys in hash tables, but will get simplified once we can rekey
|
|
|
|
* in-place.
|
2012-04-05 23:10:53 +00:00
|
|
|
*/
|
2012-06-21 01:48:56 +00:00
|
|
|
#ifdef JS_GC_ZEAL
|
2012-04-05 23:10:53 +00:00
|
|
|
# define JS_SET_TRACING_LOCATION(trc, location) \
|
|
|
|
JS_BEGIN_MACRO \
|
2012-07-30 20:58:18 +00:00
|
|
|
if (!(trc)->realLocation || !(location)) \
|
2012-06-21 01:48:56 +00:00
|
|
|
(trc)->realLocation = (location); \
|
2012-04-05 23:10:53 +00:00
|
|
|
JS_END_MACRO
|
2012-09-06 23:50:46 +00:00
|
|
|
# define JS_UNSET_TRACING_LOCATION(trc) \
|
|
|
|
JS_BEGIN_MACRO \
|
|
|
|
(trc)->realLocation = NULL; \
|
|
|
|
JS_END_MACRO
|
2012-04-05 23:10:53 +00:00
|
|
|
#else
|
|
|
|
# define JS_SET_TRACING_LOCATION(trc, location) \
|
|
|
|
JS_BEGIN_MACRO \
|
|
|
|
JS_END_MACRO
|
2012-09-06 23:50:46 +00:00
|
|
|
# define JS_UNSET_TRACING_LOCATION(trc) \
|
|
|
|
JS_BEGIN_MACRO \
|
|
|
|
JS_END_MACRO
|
2012-04-05 23:10:53 +00:00
|
|
|
#endif
|
|
|
|
|
|
|
|
|
2007-04-17 06:53:37 +00:00
|
|
|
/*
|
|
|
|
* Convenience macro to describe the argument of JS_CallTracer using C string
|
|
|
|
* and index.
|
|
|
|
*/
|
|
|
|
# define JS_SET_TRACING_INDEX(trc, name, index) \
|
|
|
|
JS_SET_TRACING_DETAILS(trc, NULL, name, index)
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Convenience macro to describe the argument of JS_CallTracer using C string.
|
|
|
|
*/
|
|
|
|
# define JS_SET_TRACING_NAME(trc, name) \
|
|
|
|
JS_SET_TRACING_DETAILS(trc, NULL, name, (size_t)-1)
|
|
|
|
|
2013-03-28 20:37:22 +00:00
|
|
|
/*
|
|
|
|
* The JS_Call*Tracer family of functions traces the given GC thing reference.
|
|
|
|
* This performs the tracing action configured on the given JSTracer:
|
|
|
|
* typically calling the JSTracer::callback or marking the thing as live.
|
|
|
|
*
|
|
|
|
* The argument to JS_Call*Tracer is an in-out param: when the function
|
|
|
|
* returns, the garbage collector might have moved the GC thing. In this case,
|
|
|
|
* the reference passed to JS_Call*Tracer will be updated to the object's new
|
|
|
|
* location. Callers of this method are responsible for updating any state
|
|
|
|
* that is dependent on the object's address. For example, if the object's
|
|
|
|
* address is used as a key in a hashtable, then the object must be removed
|
|
|
|
* and re-inserted with the correct hash.
|
|
|
|
*/
|
2013-03-26 22:10:34 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2013-03-28 20:37:22 +00:00
|
|
|
JS_CallValueTracer(JSTracer *trc, JS::Value *valuep, const char *name);
|
2007-04-17 06:53:37 +00:00
|
|
|
|
2013-03-26 22:10:34 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2013-03-28 20:37:22 +00:00
|
|
|
JS_CallIdTracer(JSTracer *trc, jsid *idp, const char *name);
|
2007-04-17 06:53:37 +00:00
|
|
|
|
2013-03-26 22:10:34 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2013-03-28 20:37:22 +00:00
|
|
|
JS_CallObjectTracer(JSTracer *trc, JSObject **objp, const char *name);
|
2007-04-17 06:53:37 +00:00
|
|
|
|
2013-03-26 22:10:34 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2013-03-28 20:37:22 +00:00
|
|
|
JS_CallStringTracer(JSTracer *trc, JSString **strp, const char *name);
|
2007-04-17 06:53:37 +00:00
|
|
|
|
2013-03-26 22:10:34 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2013-03-28 20:37:22 +00:00
|
|
|
JS_CallScriptTracer(JSTracer *trc, JSScript **scriptp, const char *name);
|
2013-03-26 22:10:34 +00:00
|
|
|
|
2013-05-27 11:51:25 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_CallHeapValueTracer(JSTracer *trc, JS::Heap<JS::Value> *valuep, const char *name);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_CallHeapIdTracer(JSTracer *trc, JS::Heap<jsid> *idp, const char *name);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_CallHeapObjectTracer(JSTracer *trc, JS::Heap<JSObject *> *objp, const char *name);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_CallHeapStringTracer(JSTracer *trc, JS::Heap<JSString *> *strp, const char *name);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_CallHeapScriptTracer(JSTracer *trc, JS::Heap<JSScript *> *scriptp, const char *name);
|
|
|
|
|
2013-03-28 20:37:22 +00:00
|
|
|
template <typename HashSetEnum>
|
|
|
|
inline void
|
|
|
|
JS_CallHashSetObjectTracer(JSTracer *trc, HashSetEnum &e, JSObject *const &key, const char *name)
|
|
|
|
{
|
|
|
|
JSObject *updated = key;
|
|
|
|
JS_SET_TRACING_LOCATION(trc, reinterpret_cast<void *>(&const_cast<JSObject *&>(key)));
|
|
|
|
JS_CallObjectTracer(trc, &updated, name);
|
|
|
|
if (updated != key)
|
|
|
|
e.rekeyFront(key, updated);
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
2013-07-23 09:58:26 +00:00
|
|
|
* Trace an object that is known to always be tenured. No post barriers are
|
|
|
|
* required in this case.
|
2013-03-28 20:37:22 +00:00
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
2013-07-23 09:58:26 +00:00
|
|
|
JS_CallTenuredObjectTracer(JSTracer *trc, JS::TenuredHeap<JSObject *> *objp, const char *name);
|
2013-03-28 20:37:22 +00:00
|
|
|
|
2007-04-17 06:53:37 +00:00
|
|
|
/*
|
|
|
|
* API for JSTraceCallback implementations.
|
|
|
|
*/
|
2012-01-15 08:13:10 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2012-02-29 20:23:38 +00:00
|
|
|
JS_TracerInit(JSTracer *trc, JSRuntime *rt, JSTraceCallback callback);
|
2007-04-17 06:53:37 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
2011-09-01 18:43:46 +00:00
|
|
|
JS_TraceChildren(JSTracer *trc, void *thing, JSGCTraceKind kind);
|
2007-04-17 06:53:37 +00:00
|
|
|
|
2007-04-25 13:43:18 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_TraceRuntime(JSTracer *trc);
|
|
|
|
|
2007-04-17 06:53:37 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2012-06-14 15:52:54 +00:00
|
|
|
JS_GetTraceThingInfo(char *buf, size_t bufsize, JSTracer *trc,
|
|
|
|
void *thing, JSGCTraceKind kind, JSBool includeDetails);
|
2007-04-29 21:49:00 +00:00
|
|
|
|
2011-10-20 16:25:31 +00:00
|
|
|
extern JS_PUBLIC_API(const char *)
|
|
|
|
JS_GetTraceEdgeName(JSTracer *trc, char *buffer, int bufferSize);
|
|
|
|
|
2012-06-14 15:52:54 +00:00
|
|
|
#ifdef DEBUG
|
|
|
|
|
2007-04-25 13:43:18 +00:00
|
|
|
/*
|
2007-04-29 21:49:00 +00:00
|
|
|
* DEBUG-only method to dump the object graph of heap-allocated things.
|
2007-04-25 13:43:18 +00:00
|
|
|
*
|
2007-04-29 21:49:00 +00:00
|
|
|
* fp: file for the dump output.
|
|
|
|
* start: when non-null, dump only things reachable from start
|
|
|
|
* thing. Otherwise dump all things reachable from the
|
|
|
|
* runtime roots.
|
2011-09-01 18:43:46 +00:00
|
|
|
* startKind: trace kind of start if start is not null. Must be
|
|
|
|
* JSTRACE_OBJECT when start is null.
|
2007-04-29 21:49:00 +00:00
|
|
|
* thingToFind: dump only paths in the object graph leading to thingToFind
|
|
|
|
* when non-null.
|
|
|
|
* maxDepth: the upper bound on the number of edges to descend from the
|
|
|
|
* graph roots.
|
|
|
|
* thingToIgnore: thing to ignore during the graph traversal when non-null.
|
2007-04-25 13:43:18 +00:00
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-02-29 20:23:38 +00:00
|
|
|
JS_DumpHeap(JSRuntime *rt, FILE *fp, void* startThing, JSGCTraceKind kind,
|
2007-04-29 21:49:00 +00:00
|
|
|
void *thingToFind, size_t maxDepth, void *thingToIgnore);
|
|
|
|
|
2007-04-17 06:53:37 +00:00
|
|
|
#endif
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Garbage collector API.
|
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2012-03-28 10:13:30 +00:00
|
|
|
JS_GC(JSRuntime *rt);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_MaybeGC(JSContext *cx);
|
|
|
|
|
2012-02-29 20:23:38 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2013-07-09 14:28:15 +00:00
|
|
|
JS_SetGCCallback(JSRuntime *rt, JSGCCallback cb, void *data);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2012-02-29 20:23:38 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetFinalizeCallback(JSRuntime *rt, JSFinalizeCallback cb);
|
2000-05-14 23:00:51 +00:00
|
|
|
|
2007-04-17 06:53:37 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_IsGCMarkingTracer(JSTracer *trc);
|
|
|
|
|
2013-03-28 20:27:29 +00:00
|
|
|
/*
|
|
|
|
* JS_IsAboutToBeFinalized checks if the given object is going to be finalized
|
|
|
|
* at the end of the current GC. When called outside of the context of a GC,
|
|
|
|
* this function will return false. Typically this function is used on weak
|
|
|
|
* references, where the reference should be nulled out or destroyed if the
|
|
|
|
* given object is about to be finalized.
|
|
|
|
*
|
|
|
|
* The argument to JS_IsAboutToBeFinalized is an in-out param: when the
|
|
|
|
* function returns false, the object being referenced is still alive, but the
|
|
|
|
* garbage collector might have moved it. In this case, the reference passed
|
|
|
|
* to JS_IsAboutToBeFinalized will be updated to the object's new location.
|
|
|
|
* Callers of this method are responsible for updating any state that is
|
|
|
|
* dependent on the object's address. For example, if the object's address is
|
|
|
|
* used as a key in a hashtable, then the object must be removed and
|
|
|
|
* re-inserted with the correct hash.
|
|
|
|
*/
|
2001-02-02 08:44:24 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-06-05 23:40:02 +00:00
|
|
|
JS_IsAboutToBeFinalized(JS::Heap<JSObject *> *objp);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_IsAboutToBeFinalizedUnbarriered(JSObject **objp);
|
2001-02-02 08:44:24 +00:00
|
|
|
|
2006-02-22 05:52:13 +00:00
|
|
|
typedef enum JSGCParamKey {
|
2008-01-30 02:11:30 +00:00
|
|
|
/* Maximum nominal heap before last ditch GC. */
|
|
|
|
JSGC_MAX_BYTES = 0,
|
|
|
|
|
2009-08-25 21:42:42 +00:00
|
|
|
/* Number of JS_malloc bytes before last ditch GC. */
|
|
|
|
JSGC_MAX_MALLOC_BYTES = 1,
|
|
|
|
|
2009-01-27 17:21:51 +00:00
|
|
|
/* Amount of bytes allocated by the GC. */
|
2011-05-11 05:37:11 +00:00
|
|
|
JSGC_BYTES = 3,
|
2009-01-27 17:21:51 +00:00
|
|
|
|
|
|
|
/* Number of times when GC was invoked. */
|
2011-05-11 05:37:11 +00:00
|
|
|
JSGC_NUMBER = 4,
|
2009-04-22 23:52:59 +00:00
|
|
|
|
|
|
|
/* Max size of the code cache in bytes. */
|
2011-05-11 05:37:11 +00:00
|
|
|
JSGC_MAX_CODE_CACHE_BYTES = 5,
|
2011-01-10 06:57:21 +00:00
|
|
|
|
|
|
|
/* Select GC mode. */
|
2011-05-11 05:37:11 +00:00
|
|
|
JSGC_MODE = 6,
|
2011-02-20 06:59:49 +00:00
|
|
|
|
2011-09-23 14:14:26 +00:00
|
|
|
/* Number of cached empty GC chunks. */
|
2011-07-29 22:17:41 +00:00
|
|
|
JSGC_UNUSED_CHUNKS = 7,
|
|
|
|
|
|
|
|
/* Total number of allocated GC chunks. */
|
2012-02-17 22:35:20 +00:00
|
|
|
JSGC_TOTAL_CHUNKS = 8,
|
|
|
|
|
|
|
|
/* Max milliseconds to spend in an incremental GC slice. */
|
2012-02-24 18:42:42 +00:00
|
|
|
JSGC_SLICE_TIME_BUDGET = 9,
|
|
|
|
|
|
|
|
/* Maximum size the GC mark stack can grow to. */
|
2012-07-11 18:09:53 +00:00
|
|
|
JSGC_MARK_STACK_LIMIT = 10,
|
|
|
|
|
|
|
|
/*
|
|
|
|
* GCs less than this far apart in time will be considered 'high-frequency GCs'.
|
|
|
|
* See setGCLastBytes in jsgc.cpp.
|
|
|
|
*/
|
|
|
|
JSGC_HIGH_FREQUENCY_TIME_LIMIT = 11,
|
|
|
|
|
|
|
|
/* Start of dynamic heap growth. */
|
|
|
|
JSGC_HIGH_FREQUENCY_LOW_LIMIT = 12,
|
|
|
|
|
|
|
|
/* End of dynamic heap growth. */
|
|
|
|
JSGC_HIGH_FREQUENCY_HIGH_LIMIT = 13,
|
|
|
|
|
|
|
|
/* Upper bound of heap growth. */
|
|
|
|
JSGC_HIGH_FREQUENCY_HEAP_GROWTH_MAX = 14,
|
|
|
|
|
|
|
|
/* Lower bound of heap growth. */
|
|
|
|
JSGC_HIGH_FREQUENCY_HEAP_GROWTH_MIN = 15,
|
|
|
|
|
|
|
|
/* Heap growth for low frequency GCs. */
|
|
|
|
JSGC_LOW_FREQUENCY_HEAP_GROWTH = 16,
|
|
|
|
|
|
|
|
/*
|
|
|
|
* If false, the heap growth factor is fixed at 3. If true, it is determined
|
|
|
|
* based on whether GCs are high- or low- frequency.
|
|
|
|
*/
|
|
|
|
JSGC_DYNAMIC_HEAP_GROWTH = 17,
|
|
|
|
|
|
|
|
/* If true, high-frequency GCs will use a longer mark slice. */
|
2012-08-22 18:28:34 +00:00
|
|
|
JSGC_DYNAMIC_MARK_SLICE = 18,
|
|
|
|
|
|
|
|
/* Number of megabytes of analysis data to allocate before purging. */
|
2012-10-26 23:06:19 +00:00
|
|
|
JSGC_ANALYSIS_PURGE_TRIGGER = 19,
|
|
|
|
|
|
|
|
/* Lower limit after which we limit the heap growth. */
|
2013-06-21 01:06:53 +00:00
|
|
|
JSGC_ALLOCATION_THRESHOLD = 20,
|
|
|
|
|
|
|
|
/*
|
|
|
|
* We decommit memory lazily. If more than this number of megabytes is
|
|
|
|
* available to be decommitted, then JS_MaybeGC will trigger a shrinking GC
|
|
|
|
* to decommit it.
|
|
|
|
*/
|
|
|
|
JSGC_DECOMMIT_THRESHOLD = 21
|
2006-02-22 05:52:13 +00:00
|
|
|
} JSGCParamKey;
|
|
|
|
|
2011-01-10 06:57:21 +00:00
|
|
|
typedef enum JSGCMode {
|
|
|
|
/* Perform only global GCs. */
|
|
|
|
JSGC_MODE_GLOBAL = 0,
|
|
|
|
|
|
|
|
/* Perform per-compartment GCs until too much garbage has accumulated. */
|
2012-02-17 22:35:20 +00:00
|
|
|
JSGC_MODE_COMPARTMENT = 1,
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Collect in short time slices rather than all at once. Implies
|
|
|
|
* JSGC_MODE_COMPARTMENT.
|
|
|
|
*/
|
|
|
|
JSGC_MODE_INCREMENTAL = 2
|
2011-01-10 06:57:21 +00:00
|
|
|
} JSGCMode;
|
|
|
|
|
2006-02-22 05:52:13 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_SetGCParameter(JSRuntime *rt, JSGCParamKey key, uint32_t value);
|
2006-02-22 05:52:13 +00:00
|
|
|
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
extern JS_PUBLIC_API(uint32_t)
|
2009-01-27 17:21:51 +00:00
|
|
|
JS_GetGCParameter(JSRuntime *rt, JSGCParamKey key);
|
|
|
|
|
2009-04-22 23:52:59 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_SetGCParameterForThread(JSContext *cx, JSGCParamKey key, uint32_t value);
|
2009-04-22 23:52:59 +00:00
|
|
|
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
extern JS_PUBLIC_API(uint32_t)
|
2009-04-22 23:52:59 +00:00
|
|
|
JS_GetGCParameterForThread(JSContext *cx, JSGCParamKey key);
|
|
|
|
|
2000-09-02 20:37:37 +00:00
|
|
|
/*
|
|
|
|
* Create a new JSString whose chars member refers to external memory, i.e.,
|
2012-02-07 18:44:54 +00:00
|
|
|
* memory requiring application-specific finalization.
|
2011-04-21 01:34:49 +00:00
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSString *)
|
2012-02-07 18:44:54 +00:00
|
|
|
JS_NewExternalString(JSContext *cx, const jschar *chars, size_t length,
|
|
|
|
const JSStringFinalizer *fin);
|
2011-04-21 01:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Return whether 'str' was created with JS_NewExternalString or
|
|
|
|
* JS_NewExternalStringWithClosure.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-02-07 18:44:54 +00:00
|
|
|
JS_IsExternalString(JSString *str);
|
2011-04-21 01:34:49 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Return the 'closure' arg passed to JS_NewExternalStringWithClosure or NULL
|
|
|
|
* if the external string was created via JS_NewExternalString.
|
|
|
|
*/
|
2012-02-07 18:44:54 +00:00
|
|
|
extern JS_PUBLIC_API(const JSStringFinalizer *)
|
|
|
|
JS_GetExternalStringFinalizer(JSString *str);
|
2000-09-02 20:37:37 +00:00
|
|
|
|
2010-05-19 08:29:05 +00:00
|
|
|
/*
|
|
|
|
* Set the size of the native stack that should not be exceed. To disable
|
|
|
|
* stack size checking pass 0.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
2012-01-31 22:28:22 +00:00
|
|
|
JS_SetNativeStackQuota(JSRuntime *cx, size_t stackSize);
|
2010-05-19 08:29:05 +00:00
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Classes, objects, and properties.
|
|
|
|
*/
|
2010-06-12 16:29:04 +00:00
|
|
|
typedef void (*JSClassInternal)();
|
- Add JS_GetReservedSlot, JS_SetReservedSlot, and JSCLASS_HAS_RESERVED_SLOTS(n)
to the JS API, for per class extra slots beyond JSSLOT_PRIVATE (or starting
there for a class that lacks JSCLASS_HAS_PRIVATE). To avoid penalizing all
instances, these slots are allocated only upon first property-owned slot
allocation, or upon first JS_SetReservedSlot.
This entailed adding getRequiredSlot and setRequiredSlot hooks to the
JSObjectOps struct, and making obj->slots self-describing, a la BSTR. It
also afforded me a chance to clean up obj->slots locking so that non-native
JSObjectOps didn't risk unlocked accesses! Now there are thread-safe hooks
for all uses of obj.
First consumer is the new, DOM-glue-unifying XPConnect, which needs two
slots per wrapped function. Hence the change to js_FunctionClass.flags'
initializer.
- Commented the heck out of JSClass and JSObjectOps function typedefs in
jspubtd.h. I hope embedders see these comments!
- Fix JS_XDRValue's default case to handle int exclusively, there is no other
possible type (and therefore no JSMSG_BAD_JVAL_TYPE error).
- Clean up tabs in select old, tab-ridden files and sections.
- s/\<fh\>/file/g for stdio FILE * canonical variable names.
2001-04-05 01:53:24 +00:00
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
struct JSClass {
|
2000-08-19 19:17:32 +00:00
|
|
|
const char *name;
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
uint32_t flags;
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2013-07-02 08:42:01 +00:00
|
|
|
/* Mandatory function pointer members. */
|
1998-04-24 00:31:11 +00:00
|
|
|
JSPropertyOp addProperty;
|
2013-04-06 04:19:10 +00:00
|
|
|
JSDeletePropertyOp delProperty;
|
1998-04-24 00:31:11 +00:00
|
|
|
JSPropertyOp getProperty;
|
2011-02-09 19:31:40 +00:00
|
|
|
JSStrictPropertyOp setProperty;
|
1998-04-24 00:31:11 +00:00
|
|
|
JSEnumerateOp enumerate;
|
|
|
|
JSResolveOp resolve;
|
|
|
|
JSConvertOp convert;
|
|
|
|
|
2013-07-02 08:42:01 +00:00
|
|
|
/* Optional members (may be null). */
|
|
|
|
JSFinalizeOp finalize;
|
1998-04-24 00:31:11 +00:00
|
|
|
JSCheckAccessOp checkAccess;
|
|
|
|
JSNative call;
|
|
|
|
JSHasInstanceOp hasInstance;
|
2012-05-07 19:44:08 +00:00
|
|
|
JSNative construct;
|
2011-03-05 22:50:11 +00:00
|
|
|
JSTraceOp trace;
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2011-08-12 18:26:48 +00:00
|
|
|
void *reserved[40];
|
2004-11-17 07:43:01 +00:00
|
|
|
};
|
|
|
|
|
- Add JS_GetReservedSlot, JS_SetReservedSlot, and JSCLASS_HAS_RESERVED_SLOTS(n)
to the JS API, for per class extra slots beyond JSSLOT_PRIVATE (or starting
there for a class that lacks JSCLASS_HAS_PRIVATE). To avoid penalizing all
instances, these slots are allocated only upon first property-owned slot
allocation, or upon first JS_SetReservedSlot.
This entailed adding getRequiredSlot and setRequiredSlot hooks to the
JSObjectOps struct, and making obj->slots self-describing, a la BSTR. It
also afforded me a chance to clean up obj->slots locking so that non-native
JSObjectOps didn't risk unlocked accesses! Now there are thread-safe hooks
for all uses of obj.
First consumer is the new, DOM-glue-unifying XPConnect, which needs two
slots per wrapped function. Hence the change to js_FunctionClass.flags'
initializer.
- Commented the heck out of JSClass and JSObjectOps function typedefs in
jspubtd.h. I hope embedders see these comments!
- Fix JS_XDRValue's default case to handle int exclusively, there is no other
possible type (and therefore no JSMSG_BAD_JVAL_TYPE error).
- Clean up tabs in select old, tab-ridden files and sections.
- s/\<fh\>/file/g for stdio FILE * canonical variable names.
2001-04-05 01:53:24 +00:00
|
|
|
#define JSCLASS_HAS_PRIVATE (1<<0) /* objects have private slot */
|
|
|
|
#define JSCLASS_NEW_ENUMERATE (1<<1) /* has JSNewEnumerateOp hook */
|
|
|
|
#define JSCLASS_NEW_RESOLVE (1<<2) /* has JSNewResolveOp hook */
|
|
|
|
#define JSCLASS_PRIVATE_IS_NSISUPPORTS (1<<3) /* private is (nsISupports *) */
|
2012-07-12 03:55:19 +00:00
|
|
|
#define JSCLASS_IS_DOMJSCLASS (1<<4) /* objects are DOM */
|
2012-02-17 22:35:20 +00:00
|
|
|
#define JSCLASS_IMPLEMENTS_BARRIERS (1<<5) /* Correctly implements GC read
|
|
|
|
and write barriers */
|
2012-09-15 18:19:54 +00:00
|
|
|
#define JSCLASS_EMULATES_UNDEFINED (1<<6) /* objects of this class act
|
|
|
|
like the value undefined,
|
|
|
|
in some contexts */
|
2012-03-28 21:50:31 +00:00
|
|
|
#define JSCLASS_USERBIT1 (1<<7) /* Reserved for embeddings. */
|
- Add JS_GetReservedSlot, JS_SetReservedSlot, and JSCLASS_HAS_RESERVED_SLOTS(n)
to the JS API, for per class extra slots beyond JSSLOT_PRIVATE (or starting
there for a class that lacks JSCLASS_HAS_PRIVATE). To avoid penalizing all
instances, these slots are allocated only upon first property-owned slot
allocation, or upon first JS_SetReservedSlot.
This entailed adding getRequiredSlot and setRequiredSlot hooks to the
JSObjectOps struct, and making obj->slots self-describing, a la BSTR. It
also afforded me a chance to clean up obj->slots locking so that non-native
JSObjectOps didn't risk unlocked accesses! Now there are thread-safe hooks
for all uses of obj.
First consumer is the new, DOM-glue-unifying XPConnect, which needs two
slots per wrapped function. Hence the change to js_FunctionClass.flags'
initializer.
- Commented the heck out of JSClass and JSObjectOps function typedefs in
jspubtd.h. I hope embedders see these comments!
- Fix JS_XDRValue's default case to handle int exclusively, there is no other
possible type (and therefore no JSMSG_BAD_JVAL_TYPE error).
- Clean up tabs in select old, tab-ridden files and sections.
- s/\<fh\>/file/g for stdio FILE * canonical variable names.
2001-04-05 01:53:24 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* To reserve slots fetched and stored via JS_Get/SetReservedSlot, bitwise-or
|
|
|
|
* JSCLASS_HAS_RESERVED_SLOTS(n) into the initializer for JSClass.flags, where
|
|
|
|
* n is a constant in [1, 255]. Reserved slots are indexed from 0 to n-1.
|
|
|
|
*/
|
|
|
|
#define JSCLASS_RESERVED_SLOTS_SHIFT 8 /* room for 8 flags below */
|
|
|
|
#define JSCLASS_RESERVED_SLOTS_WIDTH 8 /* and 16 above this field */
|
|
|
|
#define JSCLASS_RESERVED_SLOTS_MASK JS_BITMASK(JSCLASS_RESERVED_SLOTS_WIDTH)
|
2004-04-13 01:25:17 +00:00
|
|
|
#define JSCLASS_HAS_RESERVED_SLOTS(n) (((n) & JSCLASS_RESERVED_SLOTS_MASK) \
|
- Add JS_GetReservedSlot, JS_SetReservedSlot, and JSCLASS_HAS_RESERVED_SLOTS(n)
to the JS API, for per class extra slots beyond JSSLOT_PRIVATE (or starting
there for a class that lacks JSCLASS_HAS_PRIVATE). To avoid penalizing all
instances, these slots are allocated only upon first property-owned slot
allocation, or upon first JS_SetReservedSlot.
This entailed adding getRequiredSlot and setRequiredSlot hooks to the
JSObjectOps struct, and making obj->slots self-describing, a la BSTR. It
also afforded me a chance to clean up obj->slots locking so that non-native
JSObjectOps didn't risk unlocked accesses! Now there are thread-safe hooks
for all uses of obj.
First consumer is the new, DOM-glue-unifying XPConnect, which needs two
slots per wrapped function. Hence the change to js_FunctionClass.flags'
initializer.
- Commented the heck out of JSClass and JSObjectOps function typedefs in
jspubtd.h. I hope embedders see these comments!
- Fix JS_XDRValue's default case to handle int exclusively, there is no other
possible type (and therefore no JSMSG_BAD_JVAL_TYPE error).
- Clean up tabs in select old, tab-ridden files and sections.
- s/\<fh\>/file/g for stdio FILE * canonical variable names.
2001-04-05 01:53:24 +00:00
|
|
|
<< JSCLASS_RESERVED_SLOTS_SHIFT)
|
|
|
|
#define JSCLASS_RESERVED_SLOTS(clasp) (((clasp)->flags \
|
2004-04-13 01:25:17 +00:00
|
|
|
>> JSCLASS_RESERVED_SLOTS_SHIFT) \
|
- Add JS_GetReservedSlot, JS_SetReservedSlot, and JSCLASS_HAS_RESERVED_SLOTS(n)
to the JS API, for per class extra slots beyond JSSLOT_PRIVATE (or starting
there for a class that lacks JSCLASS_HAS_PRIVATE). To avoid penalizing all
instances, these slots are allocated only upon first property-owned slot
allocation, or upon first JS_SetReservedSlot.
This entailed adding getRequiredSlot and setRequiredSlot hooks to the
JSObjectOps struct, and making obj->slots self-describing, a la BSTR. It
also afforded me a chance to clean up obj->slots locking so that non-native
JSObjectOps didn't risk unlocked accesses! Now there are thread-safe hooks
for all uses of obj.
First consumer is the new, DOM-glue-unifying XPConnect, which needs two
slots per wrapped function. Hence the change to js_FunctionClass.flags'
initializer.
- Commented the heck out of JSClass and JSObjectOps function typedefs in
jspubtd.h. I hope embedders see these comments!
- Fix JS_XDRValue's default case to handle int exclusively, there is no other
possible type (and therefore no JSMSG_BAD_JVAL_TYPE error).
- Clean up tabs in select old, tab-ridden files and sections.
- s/\<fh\>/file/g for stdio FILE * canonical variable names.
2001-04-05 01:53:24 +00:00
|
|
|
& JSCLASS_RESERVED_SLOTS_MASK)
|
2000-08-26 02:30:22 +00:00
|
|
|
|
2004-11-17 07:43:01 +00:00
|
|
|
#define JSCLASS_HIGH_FLAGS_SHIFT (JSCLASS_RESERVED_SLOTS_SHIFT + \
|
|
|
|
JSCLASS_RESERVED_SLOTS_WIDTH)
|
|
|
|
|
2012-07-03 21:34:56 +00:00
|
|
|
#define JSCLASS_IS_ANONYMOUS (1<<(JSCLASS_HIGH_FLAGS_SHIFT+0))
|
|
|
|
#define JSCLASS_IS_GLOBAL (1<<(JSCLASS_HIGH_FLAGS_SHIFT+1))
|
|
|
|
#define JSCLASS_INTERNAL_FLAG2 (1<<(JSCLASS_HIGH_FLAGS_SHIFT+2))
|
|
|
|
#define JSCLASS_INTERNAL_FLAG3 (1<<(JSCLASS_HIGH_FLAGS_SHIFT+3))
|
2010-07-07 07:53:50 +00:00
|
|
|
|
2010-10-23 23:24:32 +00:00
|
|
|
/* Indicate whether the proto or ctor should be frozen. */
|
2012-07-03 21:34:56 +00:00
|
|
|
#define JSCLASS_FREEZE_PROTO (1<<(JSCLASS_HIGH_FLAGS_SHIFT+4))
|
|
|
|
#define JSCLASS_FREEZE_CTOR (1<<(JSCLASS_HIGH_FLAGS_SHIFT+5))
|
2010-10-23 23:24:32 +00:00
|
|
|
|
2012-03-28 21:50:31 +00:00
|
|
|
/* Reserved for embeddings. */
|
2012-10-25 15:01:09 +00:00
|
|
|
#define JSCLASS_USERBIT2 (1<<(JSCLASS_HIGH_FLAGS_SHIFT+6))
|
|
|
|
#define JSCLASS_USERBIT3 (1<<(JSCLASS_HIGH_FLAGS_SHIFT+7))
|
2012-03-28 21:50:31 +00:00
|
|
|
|
2013-02-15 10:18:46 +00:00
|
|
|
#define JSCLASS_BACKGROUND_FINALIZE (1<<(JSCLASS_HIGH_FLAGS_SHIFT+8))
|
|
|
|
|
2012-03-28 21:50:31 +00:00
|
|
|
/*
|
|
|
|
* Bits 26 through 31 are reserved for the CACHED_PROTO_KEY mechanism, see
|
|
|
|
* below.
|
|
|
|
*/
|
|
|
|
|
2011-02-14 04:55:33 +00:00
|
|
|
/* Global flags. */
|
|
|
|
#define JSGLOBAL_FLAGS_CLEARED 0x1
|
2010-08-03 06:52:12 +00:00
|
|
|
|
2006-05-20 22:27:28 +00:00
|
|
|
/*
|
|
|
|
* ECMA-262 requires that most constructors used internally create objects
|
|
|
|
* with "the original Foo.prototype value" as their [[Prototype]] (__proto__)
|
|
|
|
* member initial value. The "original ... value" verbiage is there because
|
|
|
|
* in ECMA-262, global properties naming class objects are read/write and
|
|
|
|
* deleteable, for the most part.
|
|
|
|
*
|
|
|
|
* Implementing this efficiently requires that global objects have classes
|
2010-05-22 21:46:18 +00:00
|
|
|
* with the following flags. Failure to use JSCLASS_GLOBAL_FLAGS was
|
|
|
|
* prevously allowed, but is now an ES5 violation and thus unsupported.
|
2006-05-20 22:27:28 +00:00
|
|
|
*/
|
2013-06-12 22:58:21 +00:00
|
|
|
#define JSCLASS_GLOBAL_SLOT_COUNT (JSProto_LIMIT * 3 + 25)
|
2011-05-24 10:45:39 +00:00
|
|
|
#define JSCLASS_GLOBAL_FLAGS_WITH_SLOTS(n) \
|
|
|
|
(JSCLASS_IS_GLOBAL | JSCLASS_HAS_RESERVED_SLOTS(JSCLASS_GLOBAL_SLOT_COUNT + (n)))
|
2010-08-03 06:52:12 +00:00
|
|
|
#define JSCLASS_GLOBAL_FLAGS \
|
2011-05-24 10:45:39 +00:00
|
|
|
JSCLASS_GLOBAL_FLAGS_WITH_SLOTS(0)
|
|
|
|
#define JSCLASS_HAS_GLOBAL_FLAG_AND_SLOTS(clasp) \
|
|
|
|
(((clasp)->flags & JSCLASS_IS_GLOBAL) \
|
|
|
|
&& JSCLASS_RESERVED_SLOTS(clasp) >= JSCLASS_GLOBAL_SLOT_COUNT)
|
2006-04-19 00:22:43 +00:00
|
|
|
|
|
|
|
/* Fast access to the original value of each standard class's prototype. */
|
2012-03-28 21:50:31 +00:00
|
|
|
#define JSCLASS_CACHED_PROTO_SHIFT (JSCLASS_HIGH_FLAGS_SHIFT + 10)
|
|
|
|
#define JSCLASS_CACHED_PROTO_WIDTH 6
|
2006-04-19 00:22:43 +00:00
|
|
|
#define JSCLASS_CACHED_PROTO_MASK JS_BITMASK(JSCLASS_CACHED_PROTO_WIDTH)
|
2012-03-26 02:14:27 +00:00
|
|
|
#define JSCLASS_HAS_CACHED_PROTO(key) (uint32_t(key) << JSCLASS_CACHED_PROTO_SHIFT)
|
2007-07-05 20:37:47 +00:00
|
|
|
#define JSCLASS_CACHED_PROTO_KEY(clasp) ((JSProtoKey) \
|
|
|
|
(((clasp)->flags \
|
|
|
|
>> JSCLASS_CACHED_PROTO_SHIFT) \
|
|
|
|
& JSCLASS_CACHED_PROTO_MASK))
|
2004-11-17 07:43:01 +00:00
|
|
|
|
2000-08-26 02:30:22 +00:00
|
|
|
/* Initializer for unused members of statically initialized JSClass structs. */
|
2012-02-13 08:02:21 +00:00
|
|
|
#define JSCLASS_NO_INTERNAL_MEMBERS {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}
|
|
|
|
#define JSCLASS_NO_OPTIONAL_MEMBERS 0,0,0,0,0,JSCLASS_NO_INTERNAL_MEMBERS
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2012-03-02 02:54:01 +00:00
|
|
|
extern JS_PUBLIC_API(int)
|
2011-10-25 23:07:42 +00:00
|
|
|
JS_IdArrayLength(JSContext *cx, JSIdArray *ida);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(jsid)
|
2012-03-02 02:54:01 +00:00
|
|
|
JS_IdArrayGet(JSContext *cx, JSIdArray *ida, int index);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_DestroyIdArray(JSContext *cx, JSIdArray *ida);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2012-01-11 08:23:09 +00:00
|
|
|
namespace JS {
|
|
|
|
|
2012-12-27 17:20:22 +00:00
|
|
|
class AutoIdArray : private AutoGCRooter
|
|
|
|
{
|
2012-01-11 08:23:09 +00:00
|
|
|
public:
|
2012-12-27 17:20:22 +00:00
|
|
|
AutoIdArray(JSContext *cx, JSIdArray *ida
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2012-02-29 12:18:16 +00:00
|
|
|
: AutoGCRooter(cx, IDARRAY), context(cx), idArray(ida)
|
2012-01-11 08:23:09 +00:00
|
|
|
{
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2012-01-11 08:23:09 +00:00
|
|
|
}
|
|
|
|
~AutoIdArray() {
|
|
|
|
if (idArray)
|
|
|
|
JS_DestroyIdArray(context, idArray);
|
|
|
|
}
|
|
|
|
bool operator!() {
|
|
|
|
return !idArray;
|
|
|
|
}
|
|
|
|
jsid operator[](size_t i) const {
|
|
|
|
JS_ASSERT(idArray);
|
|
|
|
JS_ASSERT(i < length());
|
|
|
|
return JS_IdArrayGet(context, idArray, i);
|
|
|
|
}
|
|
|
|
size_t length() const {
|
|
|
|
return JS_IdArrayLength(context, idArray);
|
|
|
|
}
|
|
|
|
|
|
|
|
friend void AutoGCRooter::trace(JSTracer *trc);
|
|
|
|
|
|
|
|
JSIdArray *steal() {
|
|
|
|
JSIdArray *copy = idArray;
|
|
|
|
idArray = NULL;
|
|
|
|
return copy;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
inline void trace(JSTracer *trc);
|
|
|
|
|
|
|
|
private:
|
2012-02-29 12:18:16 +00:00
|
|
|
JSContext *context;
|
2012-01-11 08:23:09 +00:00
|
|
|
JSIdArray *idArray;
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2012-01-11 08:23:09 +00:00
|
|
|
|
|
|
|
/* No copy or assignment semantics. */
|
|
|
|
AutoIdArray(AutoIdArray &ida) MOZ_DELETE;
|
|
|
|
void operator=(AutoIdArray &ida) MOZ_DELETE;
|
|
|
|
};
|
|
|
|
|
|
|
|
} /* namespace JS */
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ValueToId(JSContext *cx, jsval v, jsid *idp);
|
|
|
|
|
2010-06-04 23:55:08 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-04-24 00:31:11 +00:00
|
|
|
JS_IdToValue(JSContext *cx, jsid id, jsval *vp);
|
|
|
|
|
2004-10-05 10:19:07 +00:00
|
|
|
/*
|
|
|
|
* JSNewResolveOp flag bits.
|
|
|
|
*/
|
2012-09-15 18:19:55 +00:00
|
|
|
#define JSRESOLVE_ASSIGNING 0x01 /* resolve on the left of assignment */
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2011-10-14 23:27:50 +00:00
|
|
|
/*
|
|
|
|
* Invoke the [[DefaultValue]] hook (see ES5 8.6.2) with the provided hint on
|
|
|
|
* the specified object, computing a primitive default value for the object.
|
|
|
|
* The hint must be JSTYPE_STRING, JSTYPE_NUMBER, or JSTYPE_VOID (no hint). On
|
|
|
|
* success the resulting value is stored in *vp.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_DefaultValue(JSContext *cx, JSObject *obj, JSType hint, jsval *vp);
|
|
|
|
|
2010-05-19 16:55:27 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-06-21 13:12:46 +00:00
|
|
|
JS_PropertyStub(JSContext *cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id,
|
|
|
|
JS::MutableHandle<JS::Value> vp);
|
2010-05-19 16:55:27 +00:00
|
|
|
|
2011-02-09 19:31:40 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-06-21 13:12:46 +00:00
|
|
|
JS_StrictPropertyStub(JSContext *cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id, JSBool strict,
|
|
|
|
JS::MutableHandle<JS::Value> vp);
|
2011-02-09 19:31:40 +00:00
|
|
|
|
2013-04-06 04:19:10 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-06-21 13:12:46 +00:00
|
|
|
JS_DeletePropertyStub(JSContext *cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id,
|
|
|
|
JSBool *succeeded);
|
2013-04-06 04:19:10 +00:00
|
|
|
|
2010-05-19 16:55:27 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-06-21 13:12:46 +00:00
|
|
|
JS_EnumerateStub(JSContext *cx, JS::Handle<JSObject*> obj);
|
2010-05-19 16:55:27 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-06-21 13:12:46 +00:00
|
|
|
JS_ResolveStub(JSContext *cx, JS::Handle<JSObject*> obj, JS::Handle<jsid> id);
|
2010-05-19 16:55:27 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-06-21 13:12:46 +00:00
|
|
|
JS_ConvertStub(JSContext *cx, JS::Handle<JSObject*> obj, JSType type,
|
|
|
|
JS::MutableHandle<JS::Value> vp);
|
2010-05-19 16:55:27 +00:00
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
struct JSConstDoubleSpec {
|
2012-02-24 22:19:52 +00:00
|
|
|
double dval;
|
1998-03-28 02:44:41 +00:00
|
|
|
const char *name;
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
uint8_t flags;
|
|
|
|
uint8_t spare[3];
|
1998-03-28 02:44:41 +00:00
|
|
|
};
|
|
|
|
|
2012-08-08 05:26:18 +00:00
|
|
|
typedef struct JSJitInfo JSJitInfo;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Wrappers to replace {Strict,}PropertyOp for JSPropertySpecs. This will allow
|
|
|
|
* us to pass one JSJitInfo per function with the property spec, without
|
|
|
|
* additional field overhead.
|
|
|
|
*/
|
|
|
|
typedef struct JSStrictPropertyOpWrapper {
|
|
|
|
JSStrictPropertyOp op;
|
|
|
|
const JSJitInfo *info;
|
|
|
|
} JSStrictPropertyOpWrapper;
|
|
|
|
|
|
|
|
typedef struct JSPropertyOpWrapper {
|
|
|
|
JSPropertyOp op;
|
|
|
|
const JSJitInfo *info;
|
|
|
|
} JSPropertyOpWrapper;
|
|
|
|
|
|
|
|
/*
|
2012-08-08 05:26:19 +00:00
|
|
|
* Wrapper to do as above, but for JSNatives for JSFunctionSpecs.
|
|
|
|
*/
|
|
|
|
typedef struct JSNativeWrapper {
|
|
|
|
JSNative op;
|
|
|
|
const JSJitInfo *info;
|
|
|
|
} JSNativeWrapper;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Macro static initializers which make it easy to pass no JSJitInfo as part of a
|
|
|
|
* JSPropertySpec or JSFunctionSpec.
|
2012-08-08 05:26:18 +00:00
|
|
|
*/
|
|
|
|
#define JSOP_WRAPPER(op) {op, NULL}
|
|
|
|
#define JSOP_NULLWRAPPER JSOP_WRAPPER(NULL)
|
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/*
|
|
|
|
* To define an array element rather than a named property member, cast the
|
|
|
|
* element's index to (const char *) and initialize name with it, and set the
|
|
|
|
* JSPROP_INDEX bit in flags.
|
|
|
|
*/
|
|
|
|
struct JSPropertySpec {
|
2012-08-08 05:26:18 +00:00
|
|
|
const char *name;
|
|
|
|
int8_t tinyid;
|
|
|
|
uint8_t flags;
|
|
|
|
JSPropertyOpWrapper getter;
|
|
|
|
JSStrictPropertyOpWrapper setter;
|
1998-03-28 02:44:41 +00:00
|
|
|
};
|
|
|
|
|
2012-07-23 21:01:54 +00:00
|
|
|
/*
|
|
|
|
* To define a native function, set call to a JSNativeWrapper. To define a
|
|
|
|
* self-hosted function, set selfHostedName to the name of a function
|
|
|
|
* compiled during JSRuntime::initSelfHosting.
|
|
|
|
*/
|
1998-03-28 02:44:41 +00:00
|
|
|
struct JSFunctionSpec {
|
|
|
|
const char *name;
|
2012-08-08 05:26:19 +00:00
|
|
|
JSNativeWrapper call;
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
uint16_t nargs;
|
|
|
|
uint16_t flags;
|
2012-07-23 21:01:54 +00:00
|
|
|
const char *selfHostedName;
|
1998-03-28 02:44:41 +00:00
|
|
|
};
|
|
|
|
|
2007-08-02 04:33:52 +00:00
|
|
|
/*
|
|
|
|
* Terminating sentinel initializer to put at the end of a JSFunctionSpec array
|
|
|
|
* that's passed to JS_DefineFunctions or JS_InitClass.
|
|
|
|
*/
|
2010-08-16 19:35:04 +00:00
|
|
|
#define JS_FS_END JS_FS(NULL,NULL,0,0)
|
2007-08-02 04:33:52 +00:00
|
|
|
|
|
|
|
/*
|
2010-08-16 19:35:04 +00:00
|
|
|
* Initializer macros for a JSFunctionSpec array element. JS_FN (whose name
|
|
|
|
* pays homage to the old JSNative/JSFastNative split) simply adds the flag
|
2012-08-08 05:26:19 +00:00
|
|
|
* JSFUN_STUB_GSOPS. JS_FNINFO allows the simple adding of JSJitInfos.
|
2007-08-02 04:33:52 +00:00
|
|
|
*/
|
2010-08-16 19:35:04 +00:00
|
|
|
#define JS_FS(name,call,nargs,flags) \
|
2012-08-08 05:26:19 +00:00
|
|
|
{name, JSOP_WRAPPER(call), nargs, flags}
|
2010-08-16 19:35:04 +00:00
|
|
|
#define JS_FN(name,call,nargs,flags) \
|
2012-08-08 05:26:19 +00:00
|
|
|
{name, JSOP_WRAPPER(call), nargs, (flags) | JSFUN_STUB_GSOPS}
|
|
|
|
#define JS_FNINFO(name,call,info,nargs,flags) \
|
|
|
|
{name,{call,info},nargs,flags}
|
2007-08-02 04:33:52 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_InitClass(JSContext *cx, JSObject *obj, JSObject *parent_proto,
|
2012-02-28 23:11:11 +00:00
|
|
|
JSClass *clasp, JSNative constructor, unsigned nargs,
|
2013-04-22 20:17:38 +00:00
|
|
|
const JSPropertySpec *ps, const JSFunctionSpec *fs,
|
|
|
|
const JSPropertySpec *static_ps, const JSFunctionSpec *static_fs);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2012-02-01 03:40:49 +00:00
|
|
|
/*
|
|
|
|
* Set up ctor.prototype = proto and proto.constructor = ctor with the
|
|
|
|
* right property flags.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_LinkConstructorAndPrototype(JSContext *cx, JSObject *ctor, JSObject *proto);
|
|
|
|
|
1998-10-14 10:22:38 +00:00
|
|
|
extern JS_PUBLIC_API(JSClass *)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_GetClass(JSObject *obj);
|
1999-11-12 06:03:40 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_InstanceOf(JSContext *cx, JSObject *obj, JSClass *clasp, jsval *argv);
|
|
|
|
|
2005-05-10 19:53:44 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_HasInstance(JSContext *cx, JSObject *obj, jsval v, JSBool *bp);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void *)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_GetPrivate(JSObject *obj);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2012-02-05 20:07:23 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_SetPrivate(JSObject *obj, void *data);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_GetInstancePrivate(JSContext *cx, JSObject *obj, JSClass *clasp,
|
2000-09-08 21:24:14 +00:00
|
|
|
jsval *argv);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2012-09-03 23:42:17 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_GetPrototype(JSContext *cx, JSObject *obj, JSObject **protop);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_SetPrototype(JSContext *cx, JSObject *obj, JSObject *proto);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_GetParent(JSObject *obj);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_SetParent(JSContext *cx, JSObject *obj, JSObject *parent);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_GetConstructor(JSContext *cx, JSObject *proto);
|
|
|
|
|
2003-12-22 06:10:51 +00:00
|
|
|
/*
|
|
|
|
* Get a unique identifier for obj, good for the lifetime of obj (even if it
|
|
|
|
* is moved by a copying GC). Return false on failure (likely out of memory),
|
|
|
|
* and true with *idp containing the unique id on success.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_GetObjectId(JSContext *cx, JSObject *obj, jsid *idp);
|
2003-12-22 06:10:51 +00:00
|
|
|
|
2013-03-17 03:36:37 +00:00
|
|
|
namespace JS {
|
|
|
|
|
|
|
|
enum {
|
|
|
|
FreshZone,
|
|
|
|
SystemZone,
|
|
|
|
SpecificZones
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef uintptr_t ZoneSpecifier;
|
|
|
|
|
|
|
|
inline ZoneSpecifier
|
|
|
|
SameZoneAs(JSObject *obj)
|
|
|
|
{
|
|
|
|
JS_ASSERT(uintptr_t(obj) > SpecificZones);
|
|
|
|
return ZoneSpecifier(obj);
|
|
|
|
}
|
|
|
|
|
2013-06-29 15:11:17 +00:00
|
|
|
struct JS_PUBLIC_API(CompartmentOptions) {
|
|
|
|
ZoneSpecifier zoneSpec;
|
2013-06-29 15:11:17 +00:00
|
|
|
JSVersion version;
|
2013-06-29 15:11:17 +00:00
|
|
|
|
|
|
|
explicit CompartmentOptions() : zoneSpec(JS::FreshZone)
|
2013-06-29 15:11:17 +00:00
|
|
|
, version(JSVERSION_UNKNOWN)
|
2013-06-29 15:11:17 +00:00
|
|
|
{}
|
|
|
|
|
|
|
|
CompartmentOptions &setZone(ZoneSpecifier spec) { zoneSpec = spec; return *this; }
|
2013-07-03 05:30:37 +00:00
|
|
|
CompartmentOptions &setVersion(JSVersion version_) {
|
|
|
|
JS_ASSERT(version_ != JSVERSION_UNKNOWN);
|
|
|
|
version = version_;
|
|
|
|
return *this;
|
|
|
|
}
|
2013-06-29 15:11:17 +00:00
|
|
|
};
|
|
|
|
|
2013-03-17 03:36:37 +00:00
|
|
|
} /* namespace JS */
|
|
|
|
|
2010-06-04 23:32:10 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2013-03-17 03:36:37 +00:00
|
|
|
JS_NewGlobalObject(JSContext *cx, JSClass *clasp, JSPrincipals *principals,
|
2013-06-29 15:11:17 +00:00
|
|
|
const JS::CompartmentOptions &options = JS::CompartmentOptions());
|
2010-06-23 21:35:10 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2010-12-19 04:44:51 +00:00
|
|
|
JS_NewObject(JSContext *cx, JSClass *clasp, JSObject *proto, JSObject *parent);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2010-09-21 18:35:30 +00:00
|
|
|
/* Queries the [[Extensible]] property of the object. */
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-06-28 21:01:09 +00:00
|
|
|
JS_IsExtensible(JSContext *cx, JS::HandleObject obj, JSBool *extensible);
|
2010-09-21 18:35:30 +00:00
|
|
|
|
2011-04-08 21:21:08 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_IsNative(JSObject *obj);
|
2011-04-08 21:21:08 +00:00
|
|
|
|
2012-02-29 20:23:38 +00:00
|
|
|
extern JS_PUBLIC_API(JSRuntime *)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_GetObjectRuntime(JSObject *obj);
|
2012-02-29 20:23:38 +00:00
|
|
|
|
2008-02-14 05:10:42 +00:00
|
|
|
/*
|
|
|
|
* Unlike JS_NewObject, JS_NewObjectWithGivenProto does not compute a default
|
|
|
|
* proto if proto's actual parameter value is null.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
|
|
|
JS_NewObjectWithGivenProto(JSContext *cx, JSClass *clasp, JSObject *proto,
|
2010-12-19 04:44:51 +00:00
|
|
|
JSObject *parent);
|
2008-02-14 05:10:42 +00:00
|
|
|
|
2010-09-21 18:35:29 +00:00
|
|
|
/*
|
|
|
|
* Freeze obj, and all objects it refers to, recursively. This will not recurse
|
|
|
|
* through non-extensible objects, on the assumption that those are already
|
|
|
|
* deep-frozen.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_DeepFreezeObject(JSContext *cx, JSObject *obj);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Freezes an object; see ES5's Object.freeze(obj) method.
|
|
|
|
*/
|
2003-03-14 05:24:58 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2010-09-21 18:35:29 +00:00
|
|
|
JS_FreezeObject(JSContext *cx, JSObject *obj);
|
2003-03-14 05:24:58 +00:00
|
|
|
|
2013-07-03 07:24:32 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_PreventExtensions(JSContext *cx, JS::HandleObject obj);
|
|
|
|
|
2010-03-17 15:22:13 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_New(JSContext *cx, JSObject *ctor, unsigned argc, jsval *argv);
|
2010-03-17 15:22:13 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_DefineObject(JSContext *cx, JSObject *obj, const char *name, JSClass *clasp,
|
2012-02-28 23:11:11 +00:00
|
|
|
JSObject *proto, unsigned attrs);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-06-18 01:31:47 +00:00
|
|
|
JS_DefineConstDoubles(JSContext *cx, JSObject *obj, const JSConstDoubleSpec *cds);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-04-03 00:20:38 +00:00
|
|
|
JS_DefineProperties(JSContext *cx, JSObject *obj, const JSPropertySpec *ps);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_DefineProperty(JSContext *cx, JSObject *obj, const char *name, jsval value,
|
2012-02-28 23:11:11 +00:00
|
|
|
JSPropertyOp getter, JSStrictPropertyOp setter, unsigned attrs);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2008-10-24 17:09:09 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_DefinePropertyById(JSContext *cx, JSObject *obj, jsid id, jsval value,
|
2012-02-28 23:11:11 +00:00
|
|
|
JSPropertyOp getter, JSStrictPropertyOp setter, unsigned attrs);
|
2008-10-24 17:09:09 +00:00
|
|
|
|
2010-03-24 19:36:42 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_DefineOwnProperty(JSContext *cx, JSObject *obj, jsid id, jsval descriptor, JSBool *bp);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
/*
|
|
|
|
* Determine the attributes (JSPROP_* flags) of a property on a given object.
|
|
|
|
*
|
|
|
|
* If the object does not have a property by that name, *foundp will be
|
|
|
|
* JS_FALSE and the value of *attrsp is undefined.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_GetPropertyAttributes(JSContext *cx, JSObject *obj, const char *name,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned *attrsp, JSBool *foundp);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2005-04-26 04:11:59 +00:00
|
|
|
/*
|
|
|
|
* The same, but if the property is native, return its getter and setter via
|
|
|
|
* *getterp and *setterp, respectively (and only if the out parameter pointer
|
|
|
|
* is not null).
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_GetPropertyAttrsGetterAndSetter(JSContext *cx, JSObject *obj,
|
|
|
|
const char *name,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned *attrsp, JSBool *foundp,
|
2005-04-26 04:11:59 +00:00
|
|
|
JSPropertyOp *getterp,
|
2011-02-09 19:31:40 +00:00
|
|
|
JSStrictPropertyOp *setterp);
|
2005-04-26 04:11:59 +00:00
|
|
|
|
2009-01-23 23:44:01 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_GetPropertyAttrsGetterAndSetterById(JSContext *cx, JSObject *obj,
|
|
|
|
jsid id,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned *attrsp, JSBool *foundp,
|
2009-01-23 23:44:01 +00:00
|
|
|
JSPropertyOp *getterp,
|
2011-02-09 19:31:40 +00:00
|
|
|
JSStrictPropertyOp *setterp);
|
2009-01-23 23:44:01 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
/*
|
|
|
|
* Set the attributes of a property on a given object.
|
|
|
|
*
|
|
|
|
* If the object does not have a property by that name, *foundp will be
|
|
|
|
* JS_FALSE and nothing will be altered.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_SetPropertyAttributes(JSContext *cx, JSObject *obj, const char *name,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned attrs, JSBool *foundp);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_DefinePropertyWithTinyId(JSContext *cx, JSObject *obj, const char *name,
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
int8_t tinyid, jsval value,
|
2011-02-09 19:31:40 +00:00
|
|
|
JSPropertyOp getter, JSStrictPropertyOp setter,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned attrs);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2007-11-13 08:28:47 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_AlreadyHasOwnProperty(JSContext *cx, JSObject *obj, const char *name,
|
|
|
|
JSBool *foundp);
|
|
|
|
|
2008-10-24 17:09:09 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_AlreadyHasOwnPropertyById(JSContext *cx, JSObject *obj, jsid id,
|
|
|
|
JSBool *foundp);
|
|
|
|
|
2004-07-17 02:39:55 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_HasProperty(JSContext *cx, JSObject *obj, const char *name, JSBool *foundp);
|
|
|
|
|
2008-10-24 17:09:09 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_HasPropertyById(JSContext *cx, JSObject *obj, jsid id, JSBool *foundp);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_LookupProperty(JSContext *cx, JSObject *obj, const char *name, jsval *vp);
|
|
|
|
|
2008-10-24 17:09:09 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_LookupPropertyById(JSContext *cx, JSObject *obj, jsid id, jsval *vp);
|
|
|
|
|
2004-09-01 20:51:39 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_LookupPropertyWithFlags(JSContext *cx, JSObject *obj, const char *name,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned flags, jsval *vp);
|
2004-09-01 20:51:39 +00:00
|
|
|
|
2008-09-25 16:13:31 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2008-10-24 17:09:09 +00:00
|
|
|
JS_LookupPropertyWithFlagsById(JSContext *cx, JSObject *obj, jsid id,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned flags, JSObject **objp, jsval *vp);
|
2008-09-25 16:13:31 +00:00
|
|
|
|
2009-03-10 22:21:25 +00:00
|
|
|
struct JSPropertyDescriptor {
|
2011-02-09 19:31:40 +00:00
|
|
|
JSObject *obj;
|
2012-04-17 17:45:38 +00:00
|
|
|
unsigned attrs;
|
|
|
|
unsigned shortid;
|
2011-02-09 19:31:40 +00:00
|
|
|
JSPropertyOp getter;
|
|
|
|
JSStrictPropertyOp setter;
|
2013-04-12 23:34:27 +00:00
|
|
|
JS::Value value;
|
2012-11-06 01:49:44 +00:00
|
|
|
|
|
|
|
JSPropertyDescriptor() : obj(NULL), attrs(0), shortid(0), getter(NULL),
|
|
|
|
setter(NULL), value(JSVAL_VOID)
|
|
|
|
{}
|
2013-04-12 23:34:27 +00:00
|
|
|
|
|
|
|
void trace(JSTracer *trc);
|
|
|
|
};
|
|
|
|
|
|
|
|
namespace JS {
|
|
|
|
|
|
|
|
template <typename Outer>
|
|
|
|
class PropertyDescriptorOperations
|
|
|
|
{
|
|
|
|
const JSPropertyDescriptor * desc() const { return static_cast<const Outer*>(this)->extract(); }
|
|
|
|
JSPropertyDescriptor * desc() { return static_cast<Outer*>(this)->extract(); }
|
|
|
|
|
|
|
|
public:
|
|
|
|
bool isEnumerable() const { return desc()->attrs & JSPROP_ENUMERATE; }
|
|
|
|
bool isReadonly() const { return desc()->attrs & JSPROP_READONLY; }
|
|
|
|
bool isPermanent() const { return desc()->attrs & JSPROP_PERMANENT; }
|
|
|
|
bool hasNativeAccessors() const { return desc()->attrs & JSPROP_NATIVE_ACCESSORS; }
|
|
|
|
bool hasGetterObject() const { return desc()->attrs & JSPROP_GETTER; }
|
|
|
|
bool hasSetterObject() const { return desc()->attrs & JSPROP_SETTER; }
|
|
|
|
bool isShared() const { return desc()->attrs & JSPROP_SHARED; }
|
|
|
|
bool isIndex() const { return desc()->attrs & JSPROP_INDEX; }
|
|
|
|
bool hasShortId() const { return desc()->attrs & JSPROP_SHORTID; }
|
|
|
|
bool hasAttributes(unsigned attrs) const { return desc()->attrs & attrs; }
|
|
|
|
|
|
|
|
JS::MutableHandleObject object() { return JS::MutableHandleObject::fromMarkedLocation(&desc()->obj); }
|
|
|
|
unsigned attributes() const { return desc()->attrs; }
|
|
|
|
unsigned shortid() const {
|
|
|
|
MOZ_ASSERT(hasShortId());
|
|
|
|
return desc()->shortid;
|
|
|
|
}
|
2013-04-15 17:33:27 +00:00
|
|
|
JSPropertyOp getter() const { return desc()->getter; }
|
|
|
|
JSStrictPropertyOp setter() const { return desc()->setter; }
|
2013-04-12 23:34:27 +00:00
|
|
|
JS::HandleObject getterObject() const {
|
|
|
|
MOZ_ASSERT(hasGetterObject());
|
|
|
|
return JS::HandleObject::fromMarkedLocation(reinterpret_cast<JSObject *const *>(&desc()->getter));
|
|
|
|
}
|
|
|
|
JS::HandleObject setterObject() const {
|
|
|
|
MOZ_ASSERT(hasSetterObject());
|
|
|
|
return JS::HandleObject::fromMarkedLocation(reinterpret_cast<JSObject *const *>(&desc()->setter));
|
|
|
|
}
|
|
|
|
JS::MutableHandleValue value() { return JS::MutableHandleValue::fromMarkedLocation(&desc()->value); }
|
|
|
|
|
|
|
|
void setAttributes(unsigned attrs) { desc()->attrs = attrs; }
|
|
|
|
void setShortId(unsigned id) { desc()->shortid = id; }
|
|
|
|
void setGetter(JSPropertyOp op) { desc()->getter = op; }
|
|
|
|
void setSetter(JSStrictPropertyOp op) { desc()->setter = op; }
|
|
|
|
void setGetterObject(JSObject *obj) { desc()->getter = reinterpret_cast<JSPropertyOp>(obj); }
|
|
|
|
void setSetterObject(JSObject *obj) { desc()->setter = reinterpret_cast<JSStrictPropertyOp>(obj); }
|
2009-03-10 22:21:25 +00:00
|
|
|
};
|
|
|
|
|
2013-04-12 23:34:27 +00:00
|
|
|
} /* namespace JS */
|
|
|
|
|
|
|
|
namespace js {
|
|
|
|
|
|
|
|
template <>
|
2013-06-19 10:32:26 +00:00
|
|
|
struct GCMethods<JSPropertyDescriptor> {
|
2013-04-12 23:34:27 +00:00
|
|
|
static JSPropertyDescriptor initial() { return JSPropertyDescriptor(); }
|
|
|
|
static ThingRootKind kind() { return THING_ROOT_PROPERTY_DESCRIPTOR; }
|
|
|
|
static bool poisoned(const JSPropertyDescriptor &desc) {
|
|
|
|
return (desc.obj && JS::IsPoisonedPtr(desc.obj)) ||
|
|
|
|
(desc.attrs & JSPROP_GETTER && desc.getter && JS::IsPoisonedPtr(desc.getter)) ||
|
|
|
|
(desc.attrs & JSPROP_SETTER && desc.setter && JS::IsPoisonedPtr(desc.setter)) ||
|
|
|
|
(desc.value.isGCThing() && JS::IsPoisonedPtr(desc.value.toGCThing()));
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
template <>
|
|
|
|
class RootedBase<JSPropertyDescriptor>
|
|
|
|
: public JS::PropertyDescriptorOperations<JS::Rooted<JSPropertyDescriptor> >
|
|
|
|
{
|
|
|
|
friend class JS::PropertyDescriptorOperations<JS::Rooted<JSPropertyDescriptor> >;
|
|
|
|
const JSPropertyDescriptor *extract() const {
|
|
|
|
return static_cast<const JS::Rooted<JSPropertyDescriptor>*>(this)->address();
|
|
|
|
}
|
|
|
|
JSPropertyDescriptor *extract() {
|
|
|
|
return static_cast<JS::Rooted<JSPropertyDescriptor>*>(this)->address();
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
template <>
|
|
|
|
class HandleBase<JSPropertyDescriptor>
|
|
|
|
: public JS::PropertyDescriptorOperations<JS::Handle<JSPropertyDescriptor> >
|
|
|
|
{
|
2013-04-15 17:33:27 +00:00
|
|
|
friend class JS::PropertyDescriptorOperations<JS::Handle<JSPropertyDescriptor> >;
|
2013-04-12 23:34:27 +00:00
|
|
|
const JSPropertyDescriptor *extract() const {
|
|
|
|
return static_cast<const JS::Handle<JSPropertyDescriptor>*>(this)->address();
|
|
|
|
}
|
2013-04-15 17:33:27 +00:00
|
|
|
public:
|
|
|
|
JS::HandleValue value() const { return JS::HandleValue::fromMarkedLocation(&extract()->value); }
|
|
|
|
JS::HandleObject obj() const { return JS::HandleObject::fromMarkedLocation(&extract()->obj); }
|
2013-04-12 23:34:27 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
template <>
|
|
|
|
class MutableHandleBase<JSPropertyDescriptor>
|
|
|
|
: public JS::PropertyDescriptorOperations<JS::MutableHandle<JSPropertyDescriptor> >
|
|
|
|
{
|
2013-04-15 17:33:27 +00:00
|
|
|
friend class JS::PropertyDescriptorOperations<JS::MutableHandle<JSPropertyDescriptor> >;
|
2013-04-12 23:34:27 +00:00
|
|
|
const JSPropertyDescriptor *extract() const {
|
|
|
|
return static_cast<const JS::MutableHandle<JSPropertyDescriptor>*>(this)->address();
|
|
|
|
}
|
|
|
|
JSPropertyDescriptor *extract() {
|
|
|
|
return static_cast<JS::MutableHandle<JSPropertyDescriptor>*>(this)->address();
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
} /* namespace js */
|
|
|
|
|
2009-03-10 22:21:25 +00:00
|
|
|
/*
|
|
|
|
* Like JS_GetPropertyAttrsGetterAndSetterById but will return a property on
|
|
|
|
* an object on the prototype chain (returned in objp). If data->obj is null,
|
|
|
|
* then this property was not found on the prototype chain.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_GetPropertyDescriptorById(JSContext *cx, JSObject *obj, jsid id, unsigned flags,
|
2009-03-10 22:21:25 +00:00
|
|
|
JSPropertyDescriptor *desc);
|
|
|
|
|
2010-03-24 19:36:42 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_GetOwnPropertyDescriptor(JSContext *cx, JSObject *obj, jsid id, jsval *vp);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-07-26 10:34:25 +00:00
|
|
|
JS_GetProperty(JSContext *cx, JSObject *obj, const char *name, jsval *vp);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2010-10-19 16:00:51 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-07-26 10:34:25 +00:00
|
|
|
JS_GetPropertyDefault(JSContext *cx, JSObject *obj, const char *name, jsval def, jsval *vp);
|
2010-10-19 16:00:51 +00:00
|
|
|
|
2008-10-24 17:09:09 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-07-26 10:34:25 +00:00
|
|
|
JS_GetPropertyById(JSContext *cx, JSObject *obj, jsid id, jsval *vp);
|
2008-10-24 17:09:09 +00:00
|
|
|
|
2010-10-19 16:00:51 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-07-26 10:34:25 +00:00
|
|
|
JS_GetPropertyByIdDefault(JSContext *cx, JSObject *obj, jsid id, jsval def, jsval *vp);
|
2010-10-19 16:00:51 +00:00
|
|
|
|
2011-11-04 16:18:38 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-07-26 10:34:25 +00:00
|
|
|
JS_ForwardGetPropertyTo(JSContext *cx, JSObject *obj, jsid id, JSObject *onBehalfOf, jsval *vp);
|
2011-11-04 16:18:38 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-07-26 09:00:38 +00:00
|
|
|
JS_SetProperty(JSContext *cx, JSObject *obj, const char *name, JS::Handle<JS::Value> v);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2008-10-24 17:09:09 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-07-26 09:00:38 +00:00
|
|
|
JS_SetPropertyById(JSContext *cx, JSObject *obj, jsid id, JS::Handle<JS::Value> v);
|
2008-10-24 17:09:09 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_DeleteProperty(JSContext *cx, JSObject *obj, const char *name);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_DeleteProperty2(JSContext *cx, JSObject *obj, const char *name,
|
2000-09-08 21:24:14 +00:00
|
|
|
jsval *rval);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2008-10-24 17:09:09 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_DeletePropertyById(JSContext *cx, JSObject *obj, jsid id);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_DeletePropertyById2(JSContext *cx, JSObject *obj, jsid id, jsval *rval);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_DefineUCProperty(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
const jschar *name, size_t namelen, jsval value,
|
2011-02-09 19:31:40 +00:00
|
|
|
JSPropertyOp getter, JSStrictPropertyOp setter,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned attrs);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
1998-10-14 10:22:38 +00:00
|
|
|
/*
|
|
|
|
* Determine the attributes (JSPROP_* flags) of a property on a given object.
|
|
|
|
*
|
|
|
|
* If the object does not have a property by that name, *foundp will be
|
|
|
|
* JS_FALSE and the value of *attrsp is undefined.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_GetUCPropertyAttributes(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
const jschar *name, size_t namelen,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned *attrsp, JSBool *foundp);
|
1998-10-14 10:22:38 +00:00
|
|
|
|
2005-04-26 04:11:59 +00:00
|
|
|
/*
|
|
|
|
* The same, but if the property is native, return its getter and setter via
|
|
|
|
* *getterp and *setterp, respectively (and only if the out parameter pointer
|
|
|
|
* is not null).
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_GetUCPropertyAttrsGetterAndSetter(JSContext *cx, JSObject *obj,
|
|
|
|
const jschar *name, size_t namelen,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned *attrsp, JSBool *foundp,
|
2005-04-26 04:11:59 +00:00
|
|
|
JSPropertyOp *getterp,
|
2011-02-09 19:31:40 +00:00
|
|
|
JSStrictPropertyOp *setterp);
|
2005-04-26 04:11:59 +00:00
|
|
|
|
1998-10-14 10:22:38 +00:00
|
|
|
/*
|
|
|
|
* Set the attributes of a property on a given object.
|
|
|
|
*
|
|
|
|
* If the object does not have a property by that name, *foundp will be
|
|
|
|
* JS_FALSE and nothing will be altered.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_SetUCPropertyAttributes(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
const jschar *name, size_t namelen,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned attrs, JSBool *foundp);
|
1998-10-14 10:22:38 +00:00
|
|
|
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_DefineUCPropertyWithTinyId(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
const jschar *name, size_t namelen,
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
int8_t tinyid, jsval value,
|
2011-02-09 19:31:40 +00:00
|
|
|
JSPropertyOp getter, JSStrictPropertyOp setter,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned attrs);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2007-11-13 08:28:47 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_AlreadyHasOwnUCProperty(JSContext *cx, JSObject *obj, const jschar *name,
|
|
|
|
size_t namelen, JSBool *foundp);
|
|
|
|
|
2004-07-17 02:39:55 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_HasUCProperty(JSContext *cx, JSObject *obj,
|
|
|
|
const jschar *name, size_t namelen,
|
|
|
|
JSBool *vp);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_LookupUCProperty(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
const jschar *name, size_t namelen,
|
|
|
|
jsval *vp);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_GetUCProperty(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
const jschar *name, size_t namelen,
|
2013-07-26 10:34:25 +00:00
|
|
|
jsval *vp);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_SetUCProperty(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
const jschar *name, size_t namelen,
|
2013-07-26 09:00:38 +00:00
|
|
|
JS::Handle<JS::Value> v);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_DeleteUCProperty2(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
const jschar *name, size_t namelen,
|
|
|
|
jsval *rval);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2012-03-02 02:54:01 +00:00
|
|
|
JS_NewArrayObject(JSContext *cx, int length, jsval *vector);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_IsArrayObject(JSContext *cx, JSObject *obj);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-03-06 23:52:55 +00:00
|
|
|
JS_GetArrayLength(JSContext *cx, JSObject *obj, uint32_t *lengthp);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-03-06 23:52:55 +00:00
|
|
|
JS_SetArrayLength(JSContext *cx, JSObject *obj, uint32_t length);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_DefineElement(JSContext *cx, JSObject *obj, uint32_t index, jsval value,
|
2012-02-28 23:11:11 +00:00
|
|
|
JSPropertyOp getter, JSStrictPropertyOp setter, unsigned attrs);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_AlreadyHasOwnElement(JSContext *cx, JSObject *obj, uint32_t index, JSBool *foundp);
|
2007-11-13 08:28:47 +00:00
|
|
|
|
2004-07-17 02:39:55 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_HasElement(JSContext *cx, JSObject *obj, uint32_t index, JSBool *foundp);
|
2004-07-17 02:39:55 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_LookupElement(JSContext *cx, JSObject *obj, uint32_t index, jsval *vp);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_GetElement(JSContext *cx, JSObject *obj, uint32_t index, jsval *vp);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2011-11-04 16:18:38 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_ForwardGetElementTo(JSContext *cx, JSObject *obj, uint32_t index, JSObject *onBehalfOf,
|
|
|
|
jsval *vp);
|
2011-11-04 16:18:38 +00:00
|
|
|
|
2011-11-04 16:19:13 +00:00
|
|
|
/*
|
|
|
|
* Get the property with name given by |index|, if it has one. If
|
|
|
|
* not, |*present| will be set to false and the value of |vp| must not
|
|
|
|
* be relied on.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_GetElementIfPresent(JSContext *cx, JSObject *obj, uint32_t index, JSObject *onBehalfOf,
|
2011-11-04 16:19:13 +00:00
|
|
|
jsval *vp, JSBool* present);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_SetElement(JSContext *cx, JSObject *obj, uint32_t index, jsval *vp);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_DeleteElement(JSContext *cx, JSObject *obj, uint32_t index);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_DeleteElement2(JSContext *cx, JSObject *obj, uint32_t index, jsval *rval);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2012-08-23 18:23:28 +00:00
|
|
|
/*
|
|
|
|
* Remove all configurable properties from the given (non-global) object and
|
|
|
|
* assign undefined to all writable data properties.
|
|
|
|
*/
|
|
|
|
JS_PUBLIC_API(void)
|
|
|
|
JS_ClearNonGlobalObject(JSContext *cx, JSObject *objArg);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Assign 'undefined' to all of the object's non-reserved slots. Note: this is
|
|
|
|
* done for all slots, regardless of the associated property descriptor.
|
|
|
|
*/
|
|
|
|
JS_PUBLIC_API(void)
|
|
|
|
JS_SetAllNonReservedSlotsToUndefined(JSContext *cx, JSObject *objArg);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2012-08-24 04:29:42 +00:00
|
|
|
/*
|
|
|
|
* Create a new array buffer with the given contents, which must have been
|
|
|
|
* returned by JS_AllocateArrayBufferContents or JS_StealArrayBufferContents.
|
|
|
|
* The new array buffer takes ownership. After calling this function, do not
|
|
|
|
* free |contents| or use |contents| from another thread.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
|
|
|
JS_NewArrayBufferWithContents(JSContext *cx, void *contents);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Steal the contents of the given array buffer. The array buffer has its
|
|
|
|
* length set to 0 and its contents array cleared. The caller takes ownership
|
2012-11-02 10:42:59 +00:00
|
|
|
* of |*contents| and must free it or transfer ownership via
|
2012-08-24 04:29:42 +00:00
|
|
|
* JS_NewArrayBufferWithContents when done using it.
|
2012-11-02 10:42:59 +00:00
|
|
|
* To free |*contents|, call free().
|
|
|
|
* A pointer to the buffer's data is returned in |*data|. This pointer can
|
|
|
|
* be used until |*contents| is freed or has its ownership transferred.
|
2012-08-24 04:29:42 +00:00
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-11-02 10:42:59 +00:00
|
|
|
JS_StealArrayBufferContents(JSContext *cx, JSObject *obj, void **contents,
|
|
|
|
uint8_t **data);
|
2012-08-24 04:29:42 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Allocate memory that may be eventually passed to
|
|
|
|
* JS_NewArrayBufferWithContents. |nbytes| is the number of payload bytes
|
|
|
|
* required. The pointer to pass to JS_NewArrayBufferWithContents is returned
|
|
|
|
* in |contents|. The pointer to the |nbytes| of usable memory is returned in
|
|
|
|
* |data|. (*|contents| will contain a header before |data|.) The only legal
|
2013-04-27 19:25:24 +00:00
|
|
|
* operations on *|contents| is to free it, or pass it to
|
|
|
|
* JS_NewArrayBufferWithContents or JS_ReallocateArrayBufferContents.
|
2012-08-24 04:29:42 +00:00
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_AllocateArrayBufferContents(JSContext *cx, uint32_t nbytes, void **contents, uint8_t **data);
|
|
|
|
|
2013-04-27 19:25:24 +00:00
|
|
|
/*
|
|
|
|
* Reallocate memory allocated by JS_AllocateArrayBufferContents, growing or shrinking it
|
|
|
|
* as appropriate. The new data pointer will be returned in data. If *contents is NULL,
|
|
|
|
* behaves like JS_AllocateArrayBufferContents.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ReallocateArrayBufferContents(JSContext *cx, uint32_t nbytes, void **contents, uint8_t **data);
|
2012-08-24 04:29:42 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSIdArray *)
|
|
|
|
JS_Enumerate(JSContext *cx, JSObject *obj);
|
|
|
|
|
2005-09-29 23:39:48 +00:00
|
|
|
/*
|
|
|
|
* Create an object to iterate over enumerable properties of obj, in arbitrary
|
|
|
|
* property definition order. NB: This differs from longstanding for..in loop
|
|
|
|
* order, which uses order of property definition in obj.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
|
|
|
JS_NewPropertyIterator(JSContext *cx, JSObject *obj);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Return true on success with *idp containing the id of the next enumerable
|
2010-06-17 01:21:34 +00:00
|
|
|
* property to visit using iterobj, or JSID_IS_VOID if there is no such property
|
2005-09-29 23:39:48 +00:00
|
|
|
* left to visit. Return false on error.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_NextProperty(JSContext *cx, JSObject *iterobj, jsid *idp);
|
|
|
|
|
2012-02-07 18:57:17 +00:00
|
|
|
/*
|
2012-07-03 21:34:56 +00:00
|
|
|
* A JSNative that creates and returns a new iterator that iterates over the
|
|
|
|
* elements of |this|, up to |this.length|, in index order. This can be used to
|
|
|
|
* make any array-like object iterable. Just give the object an obj.iterator()
|
|
|
|
* method using this JSNative as the implementation.
|
2012-02-07 18:57:17 +00:00
|
|
|
*/
|
2012-07-03 21:34:56 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ArrayIterator(JSContext *cx, unsigned argc, jsval *vp);
|
2012-02-07 18:57:17 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_CheckAccess(JSContext *cx, JSObject *obj, jsid id, JSAccessMode mode,
|
2012-02-28 23:11:11 +00:00
|
|
|
jsval *vp, unsigned *attrsp);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2012-02-05 20:07:23 +00:00
|
|
|
extern JS_PUBLIC_API(jsval)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_GetReservedSlot(JSObject *obj, uint32_t index);
|
- Add JS_GetReservedSlot, JS_SetReservedSlot, and JSCLASS_HAS_RESERVED_SLOTS(n)
to the JS API, for per class extra slots beyond JSSLOT_PRIVATE (or starting
there for a class that lacks JSCLASS_HAS_PRIVATE). To avoid penalizing all
instances, these slots are allocated only upon first property-owned slot
allocation, or upon first JS_SetReservedSlot.
This entailed adding getRequiredSlot and setRequiredSlot hooks to the
JSObjectOps struct, and making obj->slots self-describing, a la BSTR. It
also afforded me a chance to clean up obj->slots locking so that non-native
JSObjectOps didn't risk unlocked accesses! Now there are thread-safe hooks
for all uses of obj.
First consumer is the new, DOM-glue-unifying XPConnect, which needs two
slots per wrapped function. Hence the change to js_FunctionClass.flags'
initializer.
- Commented the heck out of JSClass and JSObjectOps function typedefs in
jspubtd.h. I hope embedders see these comments!
- Fix JS_XDRValue's default case to handle int exclusively, there is no other
possible type (and therefore no JSMSG_BAD_JVAL_TYPE error).
- Clean up tabs in select old, tab-ridden files and sections.
- s/\<fh\>/file/g for stdio FILE * canonical variable names.
2001-04-05 01:53:24 +00:00
|
|
|
|
2012-02-05 20:07:23 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_SetReservedSlot(JSObject *obj, uint32_t index, jsval v);
|
- Add JS_GetReservedSlot, JS_SetReservedSlot, and JSCLASS_HAS_RESERVED_SLOTS(n)
to the JS API, for per class extra slots beyond JSSLOT_PRIVATE (or starting
there for a class that lacks JSCLASS_HAS_PRIVATE). To avoid penalizing all
instances, these slots are allocated only upon first property-owned slot
allocation, or upon first JS_SetReservedSlot.
This entailed adding getRequiredSlot and setRequiredSlot hooks to the
JSObjectOps struct, and making obj->slots self-describing, a la BSTR. It
also afforded me a chance to clean up obj->slots locking so that non-native
JSObjectOps didn't risk unlocked accesses! Now there are thread-safe hooks
for all uses of obj.
First consumer is the new, DOM-glue-unifying XPConnect, which needs two
slots per wrapped function. Hence the change to js_FunctionClass.flags'
initializer.
- Commented the heck out of JSClass and JSObjectOps function typedefs in
jspubtd.h. I hope embedders see these comments!
- Fix JS_XDRValue's default case to handle int exclusively, there is no other
possible type (and therefore no JSMSG_BAD_JVAL_TYPE error).
- Clean up tabs in select old, tab-ridden files and sections.
- s/\<fh\>/file/g for stdio FILE * canonical variable names.
2001-04-05 01:53:24 +00:00
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Security protocol.
|
|
|
|
*/
|
2001-07-31 19:05:34 +00:00
|
|
|
struct JSPrincipals {
|
1998-03-28 02:44:41 +00:00
|
|
|
/* Don't call "destroy"; use reference counting macros below. */
|
2012-03-01 19:43:17 +00:00
|
|
|
int refcount;
|
2005-07-08 23:26:36 +00:00
|
|
|
|
2012-03-09 09:48:50 +00:00
|
|
|
#ifdef DEBUG
|
|
|
|
/* A helper to facilitate principals debugging. */
|
|
|
|
uint32_t debugToken;
|
|
|
|
#endif
|
2003-11-02 01:04:50 +00:00
|
|
|
|
2012-03-09 09:48:50 +00:00
|
|
|
void setDebugToken(uint32_t token) {
|
|
|
|
# ifdef DEBUG
|
|
|
|
debugToken = token;
|
|
|
|
# endif
|
|
|
|
}
|
2003-11-02 01:04:50 +00:00
|
|
|
|
2012-03-09 09:48:50 +00:00
|
|
|
/*
|
|
|
|
* This is not defined by the JS engine but should be provided by the
|
|
|
|
* embedding.
|
|
|
|
*/
|
|
|
|
JS_PUBLIC_API(void) dump();
|
|
|
|
};
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2012-03-09 09:48:50 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_HoldPrincipals(JSPrincipals *principals);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_DropPrincipals(JSRuntime *rt, JSPrincipals *principals);
|
2001-07-31 19:05:34 +00:00
|
|
|
|
2008-09-05 23:24:53 +00:00
|
|
|
struct JSSecurityCallbacks {
|
2010-03-08 08:24:50 +00:00
|
|
|
JSCheckAccessOp checkObjectAccess;
|
|
|
|
JSCSPEvalChecker contentSecurityPolicyAllows;
|
2008-09-05 23:24:53 +00:00
|
|
|
};
|
|
|
|
|
2012-03-09 09:48:50 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetSecurityCallbacks(JSRuntime *rt, const JSSecurityCallbacks *callbacks);
|
2008-09-05 23:24:53 +00:00
|
|
|
|
2012-03-09 09:48:50 +00:00
|
|
|
extern JS_PUBLIC_API(const JSSecurityCallbacks *)
|
|
|
|
JS_GetSecurityCallbacks(JSRuntime *rt);
|
2003-11-02 01:04:50 +00:00
|
|
|
|
2011-06-30 16:26:56 +00:00
|
|
|
/*
|
|
|
|
* Code running with "trusted" principals will be given a deeper stack
|
|
|
|
* allocation than ordinary scripts. This allows trusted script to run after
|
|
|
|
* untrusted script has exhausted the stack. This function sets the
|
|
|
|
* runtime-wide trusted principal.
|
|
|
|
*
|
|
|
|
* This principals is not held (via JS_HoldPrincipals/JS_DropPrincipals) since
|
|
|
|
* there is no available JSContext. Instead, the caller must ensure that the
|
|
|
|
* given principals stays valid for as long as 'rt' may point to it. If the
|
|
|
|
* principals would be destroyed before 'rt', JS_SetTrustedPrincipals must be
|
|
|
|
* called again, passing NULL for 'prin'.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetTrustedPrincipals(JSRuntime *rt, JSPrincipals *prin);
|
|
|
|
|
2012-03-09 09:48:50 +00:00
|
|
|
/*
|
|
|
|
* Initialize the callback that is called to destroy JSPrincipals instance
|
|
|
|
* when its reference counter drops to zero. The initialization can be done
|
|
|
|
* only once per JS runtime.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_InitDestroyPrincipalsCallback(JSRuntime *rt, JSDestroyPrincipalsOp destroyPrincipals);
|
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Functions and scripts.
|
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_NewFunction(JSContext *cx, JSNative call, unsigned nargs, unsigned flags,
|
2011-05-30 20:28:01 +00:00
|
|
|
JSObject *parent, const char *name);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2010-10-28 15:15:53 +00:00
|
|
|
/*
|
|
|
|
* Create the function with the name given by the id. JSID_IS_STRING(id) must
|
|
|
|
* be true.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_NewFunctionById(JSContext *cx, JSNative call, unsigned nargs, unsigned flags,
|
2010-10-28 15:15:53 +00:00
|
|
|
JSObject *parent, jsid id);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_GetFunctionObject(JSFunction *fun);
|
|
|
|
|
2002-03-12 21:58:27 +00:00
|
|
|
/*
|
|
|
|
* Return the function's identifier as a JSString, or null if fun is unnamed.
|
|
|
|
* The returned string lives as long as fun, so you don't need to root a saved
|
|
|
|
* reference to it if fun is well-connected or rooted, and provided you bound
|
|
|
|
* the use of the saved reference by fun's lifetime.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSString *)
|
|
|
|
JS_GetFunctionId(JSFunction *fun);
|
|
|
|
|
2012-08-19 04:45:54 +00:00
|
|
|
/*
|
|
|
|
* Return a function's display name. This is the defined name if one was given
|
|
|
|
* where the function was defined, or it could be an inferred name by the JS
|
|
|
|
* engine in the case that the function was defined to be anonymous. This can
|
|
|
|
* still return NULL if a useful display name could not be inferred. The same
|
|
|
|
* restrictions on rooting as those in JS_GetFunctionId apply.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSString *)
|
|
|
|
JS_GetFunctionDisplayId(JSFunction *fun);
|
|
|
|
|
2006-06-07 20:21:40 +00:00
|
|
|
/*
|
|
|
|
* Return the arity (length) of fun.
|
|
|
|
*/
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
extern JS_PUBLIC_API(uint16_t)
|
2006-06-07 20:21:40 +00:00
|
|
|
JS_GetFunctionArity(JSFunction *fun);
|
|
|
|
|
2002-03-12 21:58:27 +00:00
|
|
|
/*
|
|
|
|
* Infallible predicate to test whether obj is a function object (faster than
|
|
|
|
* comparing obj's class name to "Function", but equivalent unless someone has
|
|
|
|
* overwritten the "Function" identifier with a different constructor and then
|
|
|
|
* created instances using that constructor that might be passed in as obj).
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_ObjectIsFunction(JSContext *cx, JSObject *obj);
|
2002-03-12 21:58:27 +00:00
|
|
|
|
2011-01-11 22:24:52 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_ObjectIsCallable(JSContext *cx, JSObject *obj);
|
2002-03-12 21:58:27 +00:00
|
|
|
|
2011-05-23 15:39:25 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_IsNativeFunction(JSObject *funobj, JSNative call);
|
2011-05-23 15:39:25 +00:00
|
|
|
|
2012-11-02 04:35:09 +00:00
|
|
|
/* Return whether the given function is a valid constructor. */
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_IsConstructor(JSFunction *fun);
|
|
|
|
|
2012-04-05 17:14:52 +00:00
|
|
|
/*
|
|
|
|
* Bind the given callable to use the given object as "this".
|
|
|
|
*
|
|
|
|
* If |callable| is not callable, will throw and return NULL.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSObject*)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_BindCallable(JSContext *cx, JSObject *callable, JSObject *newThis);
|
2012-04-05 17:14:52 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-04-03 00:20:38 +00:00
|
|
|
JS_DefineFunctions(JSContext *cx, JSObject *obj, const JSFunctionSpec *fs);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
2011-05-30 20:28:01 +00:00
|
|
|
JS_DefineFunction(JSContext *cx, JSObject *obj, const char *name, JSNative call,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned nargs, unsigned attrs);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2004-05-07 03:21:30 +00:00
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
|
|
|
JS_DefineUCFunction(JSContext *cx, JSObject *obj,
|
|
|
|
const jschar *name, size_t namelen, JSNative call,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned nargs, unsigned attrs);
|
2004-05-07 03:21:30 +00:00
|
|
|
|
2010-10-28 15:15:53 +00:00
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
|
|
|
JS_DefineFunctionById(JSContext *cx, JSObject *obj, jsid id, JSNative call,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned nargs, unsigned attrs);
|
2010-10-28 15:15:53 +00:00
|
|
|
|
2012-07-03 17:24:36 +00:00
|
|
|
/*
|
|
|
|
* Clone a top-level function into a new scope. This function will dynamically
|
|
|
|
* fail if funobj was lexically nested inside some other function.
|
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_CloneFunctionObject(JSContext *cx, JSObject *funobj, JSObject *parent);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
2000-02-08 01:38:20 +00:00
|
|
|
/*
|
|
|
|
* Given a buffer, return JS_FALSE if the buffer might become a valid
|
|
|
|
* javascript statement with the addition of more lines. Otherwise return
|
|
|
|
* JS_TRUE. The intent is to support interactive compilation - accumulate
|
|
|
|
* lines in a buffer until JS_BufferIsCompilableUnit is true, then pass it to
|
|
|
|
* the compiler.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-10-29 20:55:17 +00:00
|
|
|
JS_BufferIsCompilableUnit(JSContext *cx, JSObject *obj, const char *utf8, size_t length);
|
2000-02-08 01:38:20 +00:00
|
|
|
|
2011-09-02 06:46:00 +00:00
|
|
|
extern JS_PUBLIC_API(JSScript *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_CompileScript(JSContext *cx, JSObject *obj,
|
2012-10-29 20:55:17 +00:00
|
|
|
const char *ascii, size_t length,
|
2012-02-28 23:11:11 +00:00
|
|
|
const char *filename, unsigned lineno);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2011-09-02 06:46:00 +00:00
|
|
|
extern JS_PUBLIC_API(JSScript *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_CompileScriptForPrincipals(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
JSPrincipals *principals,
|
2012-10-29 20:55:17 +00:00
|
|
|
const char *ascii, size_t length,
|
2012-02-28 23:11:11 +00:00
|
|
|
const char *filename, unsigned lineno);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2011-09-02 06:46:00 +00:00
|
|
|
extern JS_PUBLIC_API(JSScript *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_CompileUCScript(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
const jschar *chars, size_t length,
|
2012-02-28 23:11:11 +00:00
|
|
|
const char *filename, unsigned lineno);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2011-09-02 06:46:00 +00:00
|
|
|
extern JS_PUBLIC_API(JSScript *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_CompileUCScriptForPrincipals(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
JSPrincipals *principals,
|
|
|
|
const jschar *chars, size_t length,
|
2012-02-28 23:11:11 +00:00
|
|
|
const char *filename, unsigned lineno);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2011-09-02 06:46:00 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2011-09-22 10:08:55 +00:00
|
|
|
JS_GetGlobalFromScript(JSScript *script);
|
2011-09-02 06:46:00 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_CompileFunction(JSContext *cx, JSObject *obj, const char *name,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned nargs, const char **argnames,
|
2000-09-08 21:24:14 +00:00
|
|
|
const char *bytes, size_t length,
|
2012-02-28 23:11:11 +00:00
|
|
|
const char *filename, unsigned lineno);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_CompileFunctionForPrincipals(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
JSPrincipals *principals, const char *name,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned nargs, const char **argnames,
|
2000-09-08 21:24:14 +00:00
|
|
|
const char *bytes, size_t length,
|
2012-02-28 23:11:11 +00:00
|
|
|
const char *filename, unsigned lineno);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_CompileUCFunction(JSContext *cx, JSObject *obj, const char *name,
|
2012-02-28 23:11:11 +00:00
|
|
|
unsigned nargs, const char **argnames,
|
2000-09-08 21:24:14 +00:00
|
|
|
const jschar *chars, size_t length,
|
2012-02-28 23:11:11 +00:00
|
|
|
const char *filename, unsigned lineno);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2012-07-26 00:23:04 +00:00
|
|
|
namespace JS {
|
|
|
|
|
|
|
|
/* Options for JavaScript compilation. */
|
2012-08-02 21:07:31 +00:00
|
|
|
struct JS_PUBLIC_API(CompileOptions) {
|
2012-07-26 00:23:04 +00:00
|
|
|
JSPrincipals *principals;
|
|
|
|
JSPrincipals *originPrincipals;
|
|
|
|
JSVersion version;
|
|
|
|
bool versionSet;
|
|
|
|
bool utf8;
|
|
|
|
const char *filename;
|
|
|
|
unsigned lineno;
|
2013-05-30 12:29:56 +00:00
|
|
|
unsigned column;
|
2013-06-01 03:37:47 +00:00
|
|
|
HandleObject element;
|
2012-07-26 00:23:04 +00:00
|
|
|
bool compileAndGo;
|
2013-05-07 14:27:14 +00:00
|
|
|
bool forEval;
|
2012-07-26 00:23:04 +00:00
|
|
|
bool noScriptRval;
|
2012-07-23 21:01:54 +00:00
|
|
|
bool selfHostingMode;
|
2013-05-30 12:29:56 +00:00
|
|
|
bool canLazilyParse;
|
2013-07-10 15:29:52 +00:00
|
|
|
bool strictOption;
|
|
|
|
bool extraWarningsOption;
|
|
|
|
bool werrorOption;
|
|
|
|
bool asmJSOption;
|
2012-08-07 17:39:45 +00:00
|
|
|
enum SourcePolicy {
|
|
|
|
NO_SOURCE,
|
|
|
|
LAZY_SOURCE,
|
|
|
|
SAVE_SOURCE
|
|
|
|
} sourcePolicy;
|
2012-07-26 00:23:04 +00:00
|
|
|
|
2013-06-14 11:58:28 +00:00
|
|
|
explicit CompileOptions(JSContext *cx, JSVersion version = JSVERSION_UNKNOWN);
|
2012-07-26 00:23:04 +00:00
|
|
|
CompileOptions &setPrincipals(JSPrincipals *p) { principals = p; return *this; }
|
|
|
|
CompileOptions &setOriginPrincipals(JSPrincipals *p) { originPrincipals = p; return *this; }
|
|
|
|
CompileOptions &setVersion(JSVersion v) { version = v; versionSet = true; return *this; }
|
|
|
|
CompileOptions &setUTF8(bool u) { utf8 = u; return *this; }
|
|
|
|
CompileOptions &setFileAndLine(const char *f, unsigned l) {
|
|
|
|
filename = f; lineno = l; return *this;
|
|
|
|
}
|
2013-05-30 12:29:56 +00:00
|
|
|
CompileOptions &setColumn(unsigned c) { column = c; return *this; }
|
2013-06-01 03:37:47 +00:00
|
|
|
CompileOptions &setElement(HandleObject e) { element = e; return *this; }
|
2012-07-26 00:23:04 +00:00
|
|
|
CompileOptions &setCompileAndGo(bool cng) { compileAndGo = cng; return *this; }
|
2013-05-07 14:27:14 +00:00
|
|
|
CompileOptions &setForEval(bool eval) { forEval = eval; return *this; }
|
2012-07-26 00:23:04 +00:00
|
|
|
CompileOptions &setNoScriptRval(bool nsr) { noScriptRval = nsr; return *this; }
|
2012-07-23 21:01:54 +00:00
|
|
|
CompileOptions &setSelfHostingMode(bool shm) { selfHostingMode = shm; return *this; }
|
2013-05-30 12:29:56 +00:00
|
|
|
CompileOptions &setCanLazilyParse(bool clp) { canLazilyParse = clp; return *this; }
|
2012-08-07 17:39:45 +00:00
|
|
|
CompileOptions &setSourcePolicy(SourcePolicy sp) { sourcePolicy = sp; return *this; }
|
2012-07-26 00:23:04 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSScript *)
|
2013-06-21 13:12:46 +00:00
|
|
|
Compile(JSContext *cx, JS::Handle<JSObject*> obj, CompileOptions options,
|
2012-07-26 00:23:04 +00:00
|
|
|
const char *bytes, size_t length);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSScript *)
|
2013-06-21 13:12:46 +00:00
|
|
|
Compile(JSContext *cx, JS::Handle<JSObject*> obj, CompileOptions options,
|
2012-07-26 00:23:04 +00:00
|
|
|
const jschar *chars, size_t length);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSScript *)
|
2013-06-21 13:12:46 +00:00
|
|
|
Compile(JSContext *cx, JS::Handle<JSObject*> obj, CompileOptions options, FILE *file);
|
2012-07-26 00:23:04 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSScript *)
|
2013-06-21 13:12:46 +00:00
|
|
|
Compile(JSContext *cx, JS::Handle<JSObject*> obj, CompileOptions options, const char *filename);
|
2012-07-26 00:23:04 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
2013-06-21 13:12:46 +00:00
|
|
|
CompileFunction(JSContext *cx, JS::Handle<JSObject*> obj, CompileOptions options,
|
2012-07-26 00:23:04 +00:00
|
|
|
const char *name, unsigned nargs, const char **argnames,
|
|
|
|
const char *bytes, size_t length);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSFunction *)
|
2013-06-21 13:12:46 +00:00
|
|
|
CompileFunction(JSContext *cx, JS::Handle<JSObject*> obj, CompileOptions options,
|
2012-07-26 00:23:04 +00:00
|
|
|
const char *name, unsigned nargs, const char **argnames,
|
|
|
|
const jschar *chars, size_t length);
|
|
|
|
|
|
|
|
} /* namespace JS */
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_DecompileScript(JSContext *cx, JSScript *script, const char *name, unsigned indent);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1999-09-21 00:13:48 +00:00
|
|
|
/*
|
|
|
|
* API extension: OR this into indent to avoid pretty-printing the decompiled
|
|
|
|
* source resulting from JS_DecompileFunction{,Body}.
|
|
|
|
*/
|
2012-02-28 23:11:11 +00:00
|
|
|
#define JS_DONT_PRETTY_PRINT ((unsigned)0x8000)
|
1999-09-21 00:13:48 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_DecompileFunction(JSContext *cx, JSFunction *fun, unsigned indent);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_DecompileFunctionBody(JSContext *cx, JSFunction *fun, unsigned indent);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2001-01-20 01:41:55 +00:00
|
|
|
/*
|
2010-03-27 02:37:45 +00:00
|
|
|
* NB: JS_ExecuteScript and the JS_Evaluate*Script* quadruplets use the obj
|
|
|
|
* parameter as the initial scope chain header, the 'this' keyword value, and
|
|
|
|
* the variables object (ECMA parlance for where 'var' and 'function' bind
|
|
|
|
* names) of the execution context for script.
|
2001-01-20 01:41:55 +00:00
|
|
|
*
|
|
|
|
* Using obj as the variables object is problematic if obj's parent (which is
|
|
|
|
* the scope chain link; see JS_SetParent and JS_NewObject) is not null: in
|
|
|
|
* this case, variables created by 'var x = 0', e.g., go in obj, but variables
|
|
|
|
* created by assignment to an unbound id, 'x = 0', go in the last object on
|
|
|
|
* the scope chain linked by parent.
|
|
|
|
*
|
|
|
|
* ECMA calls that last scoping object the "global object", but note that many
|
|
|
|
* embeddings have several such objects. ECMA requires that "global code" be
|
|
|
|
* executed with the variables object equal to this global object. But these
|
|
|
|
* JS API entry points provide freedom to execute code against a "sub-global",
|
|
|
|
* i.e., a parented or scoped object, in which case the variables object will
|
|
|
|
* differ from the last object on the scope chain, resulting in confusing and
|
|
|
|
* non-ECMA explicit vs. implicit variable creation.
|
|
|
|
*
|
|
|
|
* Caveat embedders: unless you already depend on this buggy variables object
|
|
|
|
* binding behavior, you should call JS_SetOptions(cx, JSOPTION_VAROBJFIX) or
|
|
|
|
* JS_SetOptions(cx, JS_GetOptions(cx) | JSOPTION_VAROBJFIX) -- the latter if
|
|
|
|
* someone may have set other options on cx already -- for each context in the
|
|
|
|
* application, if you pass parented objects as the obj parameter, or may ever
|
|
|
|
* pass such objects in the future.
|
|
|
|
*
|
|
|
|
* Why a runtime option? The alternative is to add six or so new API entry
|
|
|
|
* points with signatures matching the following six, and that doesn't seem
|
|
|
|
* worth the code bloat cost. Such new entry points would probably have less
|
|
|
|
* obvious names, too, so would not tend to be used. The JS_SetOption call,
|
|
|
|
* OTOH, can be more easily hacked into existing code that does not depend on
|
|
|
|
* the bug; such code can continue to use the familiar JS_EvaluateScript,
|
|
|
|
* etc., entry points.
|
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2011-09-02 06:46:00 +00:00
|
|
|
JS_ExecuteScript(JSContext *cx, JSObject *obj, JSScript *script, jsval *rval);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2010-11-02 00:33:22 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2011-09-02 06:46:00 +00:00
|
|
|
JS_ExecuteScriptVersion(JSContext *cx, JSObject *obj, JSScript *script, jsval *rval,
|
2010-11-02 00:33:22 +00:00
|
|
|
JSVersion version);
|
|
|
|
|
2000-02-11 22:21:15 +00:00
|
|
|
/*
|
|
|
|
* Execute either the function-defining prolog of a script, or the script's
|
|
|
|
* main body, but not both.
|
|
|
|
*/
|
|
|
|
typedef enum JSExecPart { JSEXEC_PROLOG, JSEXEC_MAIN } JSExecPart;
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_EvaluateScript(JSContext *cx, JSObject *obj,
|
2012-02-28 23:11:11 +00:00
|
|
|
const char *bytes, unsigned length,
|
|
|
|
const char *filename, unsigned lineno,
|
2000-09-08 21:24:14 +00:00
|
|
|
jsval *rval);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_EvaluateScriptForPrincipals(JSContext *cx, JSObject *obj,
|
2000-09-08 21:24:14 +00:00
|
|
|
JSPrincipals *principals,
|
2012-02-28 23:11:11 +00:00
|
|
|
const char *bytes, unsigned length,
|
|
|
|
const char *filename, unsigned lineno,
|
2000-09-08 21:24:14 +00:00
|
|
|
jsval *rval);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2010-11-03 19:09:24 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_EvaluateScriptForPrincipalsVersion(JSContext *cx, JSObject *obj,
|
|
|
|
JSPrincipals *principals,
|
2012-02-28 23:11:11 +00:00
|
|
|
const char *bytes, unsigned length,
|
|
|
|
const char *filename, unsigned lineno,
|
2010-11-03 19:09:24 +00:00
|
|
|
jsval *rval, JSVersion version);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_EvaluateUCScript(JSContext *cx, JSObject *obj,
|
2012-02-28 23:11:11 +00:00
|
|
|
const jschar *chars, unsigned length,
|
|
|
|
const char *filename, unsigned lineno,
|
2000-09-08 21:24:14 +00:00
|
|
|
jsval *rval);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2011-06-28 00:42:53 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_EvaluateUCScriptForPrincipals(JSContext *cx, JSObject *obj,
|
|
|
|
JSPrincipals *principals,
|
2012-02-28 23:11:11 +00:00
|
|
|
const jschar *chars, unsigned length,
|
|
|
|
const char *filename, unsigned lineno,
|
2011-06-28 00:42:53 +00:00
|
|
|
jsval *rval);
|
|
|
|
|
2010-09-13 16:38:22 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_EvaluateUCScriptForPrincipalsVersion(JSContext *cx, JSObject *obj,
|
|
|
|
JSPrincipals *principals,
|
2012-02-28 23:11:11 +00:00
|
|
|
const jschar *chars, unsigned length,
|
|
|
|
const char *filename, unsigned lineno,
|
2010-09-13 16:38:22 +00:00
|
|
|
jsval *rval, JSVersion version);
|
|
|
|
|
2011-06-28 00:42:53 +00:00
|
|
|
/*
|
|
|
|
* JSAPI clients may optionally specify the 'originPrincipals' of a script.
|
|
|
|
* A script's originPrincipals may be retrieved through the debug API (via
|
|
|
|
* JS_GetScriptOriginPrincipals) and the originPrincipals are transitively
|
|
|
|
* assigned to any nested scripts (including scripts dynamically created via
|
2012-02-10 12:40:34 +00:00
|
|
|
* eval and the Function constructor). If originPrincipals is null, then the
|
|
|
|
* value of principals is used as origin principals for the script.
|
2011-06-28 00:42:53 +00:00
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2011-06-28 00:42:53 +00:00
|
|
|
JS_EvaluateUCScriptForPrincipalsVersionOrigin(JSContext *cx, JSObject *obj,
|
|
|
|
JSPrincipals *principals,
|
|
|
|
JSPrincipals *originPrincipals,
|
2012-02-28 23:11:11 +00:00
|
|
|
const jschar *chars, unsigned length,
|
|
|
|
const char *filename, unsigned lineno,
|
2011-06-28 00:42:53 +00:00
|
|
|
jsval *rval, JSVersion version);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2012-07-26 00:23:04 +00:00
|
|
|
namespace JS {
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(bool)
|
2013-06-21 13:12:46 +00:00
|
|
|
Evaluate(JSContext *cx, JS::Handle<JSObject*> obj, CompileOptions options,
|
2012-07-26 00:23:04 +00:00
|
|
|
const jschar *chars, size_t length, jsval *rval);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(bool)
|
2013-06-21 13:12:46 +00:00
|
|
|
Evaluate(JSContext *cx, JS::Handle<JSObject*> obj, CompileOptions options,
|
2012-07-26 00:23:04 +00:00
|
|
|
const char *bytes, size_t length, jsval *rval);
|
|
|
|
|
2012-07-31 22:25:41 +00:00
|
|
|
extern JS_PUBLIC_API(bool)
|
2013-06-21 13:12:46 +00:00
|
|
|
Evaluate(JSContext *cx, JS::Handle<JSObject*> obj, CompileOptions options,
|
2012-07-31 22:25:41 +00:00
|
|
|
const char *filename, jsval *rval);
|
|
|
|
|
2012-07-26 00:23:04 +00:00
|
|
|
} /* namespace JS */
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_CallFunction(JSContext *cx, JSObject *obj, JSFunction *fun, unsigned argc,
|
2000-09-08 21:24:14 +00:00
|
|
|
jsval *argv, jsval *rval);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_CallFunctionName(JSContext *cx, JSObject *obj, const char *name, unsigned argc,
|
2000-09-08 21:24:14 +00:00
|
|
|
jsval *argv, jsval *rval);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_CallFunctionValue(JSContext *cx, JSObject *obj, jsval fval, unsigned argc,
|
2000-09-08 21:24:14 +00:00
|
|
|
jsval *argv, jsval *rval);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2010-10-12 18:50:03 +00:00
|
|
|
namespace JS {
|
|
|
|
|
|
|
|
static inline bool
|
2013-07-24 07:40:01 +00:00
|
|
|
Call(JSContext *cx, JSObject *thisObj, JSFunction *fun, unsigned argc, jsval *argv,
|
|
|
|
MutableHandle<Value> rval)
|
|
|
|
{
|
|
|
|
return !!JS_CallFunction(cx, thisObj, fun, argc, argv, rval.address());
|
2010-10-12 18:50:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline bool
|
2013-07-24 07:40:01 +00:00
|
|
|
Call(JSContext *cx, JSObject *thisObj, const char *name, unsigned argc, jsval *argv,
|
|
|
|
MutableHandle<Value> rval)
|
|
|
|
{
|
|
|
|
return !!JS_CallFunctionName(cx, thisObj, name, argc, argv, rval.address());
|
2010-10-12 18:50:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline bool
|
2013-07-24 07:40:01 +00:00
|
|
|
Call(JSContext *cx, JSObject *thisObj, jsval fun, unsigned argc, jsval *argv,
|
|
|
|
MutableHandle<Value> rval)
|
|
|
|
{
|
|
|
|
return !!JS_CallFunctionValue(cx, thisObj, fun, argc, argv, rval.address());
|
2010-10-12 18:50:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(bool)
|
2013-07-24 07:40:01 +00:00
|
|
|
Call(JSContext *cx, jsval thisv, jsval fun, unsigned argc, jsval *argv, MutableHandle<Value> rval);
|
2010-10-12 18:50:03 +00:00
|
|
|
|
|
|
|
static inline bool
|
2013-07-24 07:40:01 +00:00
|
|
|
Call(JSContext *cx, jsval thisv, JSObject *funObj, unsigned argc, jsval *argv,
|
|
|
|
MutableHandle<Value> rval)
|
|
|
|
{
|
2010-10-12 18:50:03 +00:00
|
|
|
return Call(cx, thisv, OBJECT_TO_JSVAL(funObj), argc, argv, rval);
|
|
|
|
}
|
|
|
|
|
2011-10-04 14:06:54 +00:00
|
|
|
} /* namespace JS */
|
2010-10-12 18:50:03 +00:00
|
|
|
|
2008-01-03 09:28:40 +00:00
|
|
|
/*
|
2009-02-10 11:45:36 +00:00
|
|
|
* These functions allow setting an operation callback that will be called
|
2012-02-24 11:03:28 +00:00
|
|
|
* from the JS thread some time after any thread triggered the callback using
|
|
|
|
* JS_TriggerOperationCallback(rt).
|
2009-07-28 01:40:12 +00:00
|
|
|
*
|
2012-02-24 11:03:28 +00:00
|
|
|
* To schedule the GC and for other activities the engine internally triggers
|
|
|
|
* operation callbacks. The embedding should thus not rely on callbacks being
|
|
|
|
* triggered through the external API only.
|
2009-07-28 01:40:12 +00:00
|
|
|
*
|
2009-02-10 11:45:36 +00:00
|
|
|
* Important note: Additional callbacks can occur inside the callback handler
|
|
|
|
* if it re-enters the JS engine. The embedding must ensure that the callback
|
|
|
|
* is disconnected before attempting such re-entry.
|
2008-01-03 09:28:40 +00:00
|
|
|
*/
|
2009-02-10 11:45:36 +00:00
|
|
|
extern JS_PUBLIC_API(JSOperationCallback)
|
|
|
|
JS_SetOperationCallback(JSContext *cx, JSOperationCallback callback);
|
2009-01-14 17:23:51 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSOperationCallback)
|
|
|
|
JS_GetOperationCallback(JSContext *cx);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
2012-02-24 11:03:28 +00:00
|
|
|
JS_TriggerOperationCallback(JSRuntime *rt);
|
2009-02-20 12:47:46 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_IsRunning(JSContext *cx);
|
|
|
|
|
2007-04-13 19:20:22 +00:00
|
|
|
/*
|
|
|
|
* Saving and restoring frame chains.
|
|
|
|
*
|
2007-05-04 18:34:56 +00:00
|
|
|
* These two functions are used to set aside cx's call stack while that stack
|
|
|
|
* is inactive. After a call to JS_SaveFrameChain, it looks as if there is no
|
2007-04-13 19:20:22 +00:00
|
|
|
* code running on cx. Before calling JS_RestoreFrameChain, cx's call stack
|
|
|
|
* must be balanced and all nested calls to JS_SaveFrameChain must have had
|
|
|
|
* matching JS_RestoreFrameChain calls.
|
|
|
|
*
|
2011-05-13 15:56:26 +00:00
|
|
|
* JS_SaveFrameChain deals with cx not having any code running on it.
|
2007-04-13 19:20:22 +00:00
|
|
|
*/
|
2011-05-13 15:56:26 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2007-04-13 19:20:22 +00:00
|
|
|
JS_SaveFrameChain(JSContext *cx);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
2011-05-13 15:56:26 +00:00
|
|
|
JS_RestoreFrameChain(JSContext *cx);
|
2007-04-13 19:20:22 +00:00
|
|
|
|
2011-12-01 19:25:37 +00:00
|
|
|
#ifdef MOZ_TRACE_JSCALLS
|
|
|
|
/*
|
|
|
|
* The callback is expected to be quick and noninvasive. It should not
|
|
|
|
* trigger interrupts, turn on debugging, or produce uncaught JS
|
|
|
|
* exceptions. The state of the stack and registers in the context
|
|
|
|
* cannot be relied upon, since this callback may be invoked directly
|
|
|
|
* from either JIT. The 'entering' field means we are entering a
|
|
|
|
* function if it is positive, leaving a function if it is zero or
|
|
|
|
* negative.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetFunctionCallback(JSContext *cx, JSFunctionCallback fcb);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSFunctionCallback)
|
|
|
|
JS_GetFunctionCallback(JSContext *cx);
|
|
|
|
#endif /* MOZ_TRACE_JSCALLS */
|
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Strings.
|
2000-05-14 23:00:51 +00:00
|
|
|
*
|
2010-12-10 11:50:50 +00:00
|
|
|
* NB: JS_NewUCString takes ownership of bytes on success, avoiding a copy;
|
|
|
|
* but on error (signified by null return), it leaves chars owned by the
|
|
|
|
* caller. So the caller must free bytes in the error case, if it has no use
|
|
|
|
* for them. In contrast, all the JS_New*StringCopy* functions do not take
|
|
|
|
* ownership of the character memory passed to them -- they copy it.
|
1998-03-28 02:44:41 +00:00
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_NewStringCopyN(JSContext *cx, const char *s, size_t n);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_NewStringCopyZ(JSContext *cx, const char *s);
|
|
|
|
|
2010-12-03 08:24:17 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
|
|
|
JS_InternJSString(JSContext *cx, JSString *str);
|
|
|
|
|
2012-07-31 19:26:14 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
|
|
|
JS_InternStringN(JSContext *cx, const char *s, size_t length);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_InternString(JSContext *cx, const char *s);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_NewUCString(JSContext *cx, jschar *chars, size_t length);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_NewUCStringCopyN(JSContext *cx, const jschar *s, size_t n);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_NewUCStringCopyZ(JSContext *cx, const jschar *s);
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSString *)
|
|
|
|
JS_InternUCStringN(JSContext *cx, const jschar *s, size_t length);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSString *)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_InternUCString(JSContext *cx, const jschar *s);
|
|
|
|
|
2010-12-03 08:24:17 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_CompareStrings(JSContext *cx, JSString *str1, JSString *str2, int32_t *result);
|
2010-12-03 08:24:17 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_StringEqualsAscii(JSContext *cx, JSString *str, const char *asciiBytes, JSBool *match);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(size_t)
|
|
|
|
JS_PutEscapedString(JSContext *cx, char *buffer, size_t size, JSString *str, char quote);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_FileEscapedString(FILE *fp, JSString *str, char quote);
|
|
|
|
|
2010-10-28 15:15:53 +00:00
|
|
|
/*
|
2010-12-03 08:24:17 +00:00
|
|
|
* Extracting string characters and length.
|
|
|
|
*
|
|
|
|
* While getting the length of a string is infallible, getting the chars can
|
|
|
|
* fail. As indicated by the lack of a JSContext parameter, there are two
|
|
|
|
* special cases where getting the chars is infallible:
|
|
|
|
*
|
|
|
|
* The first case is interned strings, i.e., strings from JS_InternString or
|
|
|
|
* JSID_TO_STRING(id), using JS_GetInternedStringChars*.
|
|
|
|
*
|
|
|
|
* The second case is "flat" strings that have been explicitly prepared in a
|
|
|
|
* fallible context by JS_FlattenString. To catch errors, a separate opaque
|
|
|
|
* JSFlatString type is returned by JS_FlattenString and expected by
|
|
|
|
* JS_GetFlatStringChars. Note, though, that this is purely a syntactic
|
|
|
|
* distinction: the input and output of JS_FlattenString are the same actual
|
|
|
|
* GC-thing so only one needs to be rooted. If a JSString is known to be flat,
|
|
|
|
* JS_ASSERT_STRING_IS_FLAT can be used to make a debug-checked cast. Example:
|
|
|
|
*
|
|
|
|
* // in a fallible context
|
|
|
|
* JSFlatString *fstr = JS_FlattenString(cx, str);
|
|
|
|
* if (!fstr)
|
|
|
|
* return JS_FALSE;
|
|
|
|
* JS_ASSERT(fstr == JS_ASSERT_STRING_IS_FLAT(str));
|
|
|
|
*
|
|
|
|
* // in an infallible context, for the same 'str'
|
|
|
|
* const jschar *chars = JS_GetFlatStringChars(fstr)
|
|
|
|
* JS_ASSERT(chars);
|
|
|
|
*
|
|
|
|
* The CharsZ APIs guarantee that the returned array has a null character at
|
|
|
|
* chars[length]. This can require additional copying so clients should prefer
|
|
|
|
* APIs without CharsZ if possible. The infallible functions also return
|
|
|
|
* null-terminated arrays. (There is no additional cost or non-Z alternative
|
|
|
|
* for the infallible functions, so 'Z' is left out of the identifier.)
|
2010-10-28 15:15:53 +00:00
|
|
|
*/
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(size_t)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_GetStringLength(JSString *str);
|
|
|
|
|
2010-10-28 15:15:53 +00:00
|
|
|
extern JS_PUBLIC_API(const jschar *)
|
2010-12-03 08:24:17 +00:00
|
|
|
JS_GetStringCharsAndLength(JSContext *cx, JSString *str, size_t *length);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(const jschar *)
|
|
|
|
JS_GetInternedStringChars(JSString *str);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(const jschar *)
|
|
|
|
JS_GetInternedStringCharsAndLength(JSString *str, size_t *length);
|
2010-10-28 15:15:53 +00:00
|
|
|
|
2009-10-02 17:42:02 +00:00
|
|
|
extern JS_PUBLIC_API(const jschar *)
|
|
|
|
JS_GetStringCharsZ(JSContext *cx, JSString *str);
|
|
|
|
|
2010-12-03 08:24:17 +00:00
|
|
|
extern JS_PUBLIC_API(const jschar *)
|
|
|
|
JS_GetStringCharsZAndLength(JSContext *cx, JSString *str, size_t *length);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2010-12-03 08:24:17 +00:00
|
|
|
extern JS_PUBLIC_API(JSFlatString *)
|
|
|
|
JS_FlattenString(JSContext *cx, JSString *str);
|
2010-10-28 15:15:53 +00:00
|
|
|
|
2010-12-03 08:24:17 +00:00
|
|
|
extern JS_PUBLIC_API(const jschar *)
|
|
|
|
JS_GetFlatStringChars(JSFlatString *str);
|
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE JSFlatString *
|
|
|
|
JSID_TO_FLAT_STRING(jsid id)
|
|
|
|
{
|
|
|
|
JS_ASSERT(JSID_IS_STRING(id));
|
|
|
|
return (JSFlatString *)(JSID_BITS(id));
|
|
|
|
}
|
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE JSFlatString *
|
|
|
|
JS_ASSERT_STRING_IS_FLAT(JSString *str)
|
|
|
|
{
|
|
|
|
JS_ASSERT(JS_GetFlatStringChars((JSFlatString *)str));
|
|
|
|
return (JSFlatString *)str;
|
|
|
|
}
|
|
|
|
|
|
|
|
static JS_ALWAYS_INLINE JSString *
|
|
|
|
JS_FORGET_STRING_FLATNESS(JSFlatString *fstr)
|
|
|
|
{
|
|
|
|
return (JSString *)fstr;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Additional APIs that avoid fallibility when given a flat string.
|
|
|
|
*/
|
2010-10-28 15:15:53 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2010-12-03 08:24:17 +00:00
|
|
|
JS_FlatStringEqualsAscii(JSFlatString *str, const char *asciiBytes);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(size_t)
|
|
|
|
JS_PutEscapedFlatString(char *buffer, size_t size, JSFlatString *str, char quote);
|
2010-10-28 15:15:53 +00:00
|
|
|
|
2010-07-17 00:41:22 +00:00
|
|
|
/*
|
|
|
|
* This function is now obsolete and behaves the same as JS_NewUCString. Use
|
|
|
|
* JS_NewUCString instead.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSString *)
|
|
|
|
JS_NewGrowableString(JSContext *cx, jschar *chars, size_t length);
|
|
|
|
|
2001-10-25 00:26:38 +00:00
|
|
|
/*
|
|
|
|
* Create a dependent string, i.e., a string that owns no character storage,
|
|
|
|
* but that refers to a slice of another string's chars. Dependent strings
|
|
|
|
* are mutable by definition, so the thread safety comments above apply.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSString *)
|
|
|
|
JS_NewDependentString(JSContext *cx, JSString *str, size_t start,
|
|
|
|
size_t length);
|
|
|
|
|
|
|
|
/*
|
2010-07-17 00:41:22 +00:00
|
|
|
* Concatenate two strings, possibly resulting in a rope.
|
|
|
|
* See above for thread safety comments.
|
2001-10-25 00:26:38 +00:00
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSString *)
|
|
|
|
JS_ConcatStrings(JSContext *cx, JSString *left, JSString *right);
|
|
|
|
|
2005-11-05 01:06:30 +00:00
|
|
|
/*
|
2012-10-29 20:55:17 +00:00
|
|
|
* For JS_DecodeBytes, set *dstlenp to the size of the destination buffer before
|
|
|
|
* the call; on return, *dstlenp contains the number of jschars actually stored.
|
|
|
|
* To determine the necessary destination buffer size, make a sizing call that
|
|
|
|
* passes NULL for dst.
|
2005-12-03 02:31:21 +00:00
|
|
|
*
|
|
|
|
* On errors, the functions report the error. In that case, *dstlenp contains
|
|
|
|
* the number of characters or bytes transferred so far. If cx is NULL, no
|
|
|
|
* error is reported on failure, and the functions simply return JS_FALSE.
|
|
|
|
*
|
2012-10-29 20:55:17 +00:00
|
|
|
* NB: This function does not store an additional zero byte or jschar after the
|
2005-12-03 02:31:21 +00:00
|
|
|
* transcoded string.
|
2005-11-05 01:06:30 +00:00
|
|
|
*/
|
|
|
|
JS_PUBLIC_API(JSBool)
|
2005-12-03 02:31:21 +00:00
|
|
|
JS_DecodeBytes(JSContext *cx, const char *src, size_t srclen, jschar *dst,
|
|
|
|
size_t *dstlenp);
|
2005-11-05 01:06:30 +00:00
|
|
|
|
2007-12-11 10:09:58 +00:00
|
|
|
/*
|
|
|
|
* A variation on JS_EncodeCharacters where a null terminated string is
|
|
|
|
* returned that you are expected to call JS_free on when done.
|
|
|
|
*/
|
|
|
|
JS_PUBLIC_API(char *)
|
2013-04-16 21:33:00 +00:00
|
|
|
JS_EncodeString(JSContext *cx, JSString *str);
|
2007-12-11 10:09:58 +00:00
|
|
|
|
2013-02-22 02:58:52 +00:00
|
|
|
/*
|
|
|
|
* Same behavior as JS_EncodeString(), but encode into UTF-8 string
|
|
|
|
*/
|
|
|
|
JS_PUBLIC_API(char *)
|
2013-04-16 21:33:00 +00:00
|
|
|
JS_EncodeStringToUTF8(JSContext *cx, JSString *str);
|
2013-02-22 02:58:52 +00:00
|
|
|
|
2010-11-08 12:17:31 +00:00
|
|
|
/*
|
|
|
|
* Get number of bytes in the string encoding (without accounting for a
|
|
|
|
* terminating zero bytes. The function returns (size_t) -1 if the string
|
|
|
|
* can not be encoded into bytes and reports an error using cx accordingly.
|
|
|
|
*/
|
|
|
|
JS_PUBLIC_API(size_t)
|
|
|
|
JS_GetStringEncodingLength(JSContext *cx, JSString *str);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Encode string into a buffer. The function does not stores an additional
|
|
|
|
* zero byte. The function returns (size_t) -1 if the string can not be
|
|
|
|
* encoded into bytes with no error reported. Otherwise it returns the number
|
|
|
|
* of bytes that are necessary to encode the string. If that exceeds the
|
|
|
|
* length parameter, the string will be cut and only length bytes will be
|
|
|
|
* written into the buffer.
|
|
|
|
*/
|
|
|
|
JS_PUBLIC_API(size_t)
|
2012-11-09 17:45:25 +00:00
|
|
|
JS_EncodeStringToBuffer(JSContext *cx, JSString *str, char *buffer, size_t length);
|
2010-11-08 12:17:31 +00:00
|
|
|
|
2012-12-27 17:20:22 +00:00
|
|
|
class JSAutoByteString
|
|
|
|
{
|
2010-11-11 20:40:29 +00:00
|
|
|
public:
|
2012-12-27 17:20:22 +00:00
|
|
|
JSAutoByteString(JSContext *cx, JSString *str
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
|
2012-12-27 17:20:22 +00:00
|
|
|
: mBytes(JS_EncodeString(cx, str))
|
|
|
|
{
|
2010-11-11 20:40:29 +00:00
|
|
|
JS_ASSERT(cx);
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2010-11-11 20:40:29 +00:00
|
|
|
}
|
|
|
|
|
2012-12-27 17:20:22 +00:00
|
|
|
JSAutoByteString(MOZ_GUARD_OBJECT_NOTIFIER_ONLY_PARAM)
|
|
|
|
: mBytes(NULL)
|
|
|
|
{
|
|
|
|
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
|
2010-11-11 20:40:29 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
~JSAutoByteString() {
|
2012-08-31 22:01:33 +00:00
|
|
|
js_free(mBytes);
|
2010-11-11 20:40:29 +00:00
|
|
|
}
|
|
|
|
|
2010-12-09 10:22:15 +00:00
|
|
|
/* Take ownership of the given byte array. */
|
|
|
|
void initBytes(char *bytes) {
|
|
|
|
JS_ASSERT(!mBytes);
|
|
|
|
mBytes = bytes;
|
|
|
|
}
|
|
|
|
|
2013-02-21 09:48:17 +00:00
|
|
|
char *encodeLatin1(JSContext *cx, JSString *str) {
|
2010-11-11 20:40:29 +00:00
|
|
|
JS_ASSERT(!mBytes);
|
|
|
|
JS_ASSERT(cx);
|
|
|
|
mBytes = JS_EncodeString(cx, str);
|
|
|
|
return mBytes;
|
|
|
|
}
|
|
|
|
|
2013-07-10 15:29:52 +00:00
|
|
|
char *encodeLatin1(js::ContextFriendFields *cx, JSString *str);
|
|
|
|
|
2013-02-22 02:58:52 +00:00
|
|
|
char *encodeUtf8(JSContext *cx, JSString *str) {
|
|
|
|
JS_ASSERT(!mBytes);
|
|
|
|
JS_ASSERT(cx);
|
|
|
|
mBytes = JS_EncodeStringToUTF8(cx, str);
|
|
|
|
return mBytes;
|
|
|
|
}
|
|
|
|
|
2010-11-11 20:40:29 +00:00
|
|
|
void clear() {
|
2012-08-31 22:01:33 +00:00
|
|
|
js_free(mBytes);
|
2010-11-11 20:40:29 +00:00
|
|
|
mBytes = NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
char *ptr() const {
|
|
|
|
return mBytes;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool operator!() const {
|
|
|
|
return !mBytes;
|
|
|
|
}
|
|
|
|
|
2013-02-22 02:58:52 +00:00
|
|
|
size_t length() const {
|
|
|
|
if (!mBytes)
|
|
|
|
return 0;
|
|
|
|
return strlen(mBytes);
|
|
|
|
}
|
|
|
|
|
2010-11-11 20:40:29 +00:00
|
|
|
private:
|
|
|
|
char *mBytes;
|
2012-12-27 17:20:22 +00:00
|
|
|
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
|
2010-11-11 20:40:29 +00:00
|
|
|
|
|
|
|
/* Copy and assignment are not supported. */
|
|
|
|
JSAutoByteString(const JSAutoByteString &another);
|
|
|
|
JSAutoByteString &operator=(const JSAutoByteString &another);
|
|
|
|
};
|
|
|
|
|
2008-10-01 06:13:58 +00:00
|
|
|
/************************************************************************/
|
|
|
|
/*
|
|
|
|
* JSON functions
|
|
|
|
*/
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
typedef JSBool (* JSONWriteCallback)(const jschar *buf, uint32_t len, void *data);
|
2008-10-01 06:13:58 +00:00
|
|
|
|
|
|
|
/*
|
2011-03-21 18:42:14 +00:00
|
|
|
* JSON.stringify as specified by ES5.
|
2008-10-01 06:13:58 +00:00
|
|
|
*/
|
|
|
|
JS_PUBLIC_API(JSBool)
|
2009-05-07 20:28:21 +00:00
|
|
|
JS_Stringify(JSContext *cx, jsval *vp, JSObject *replacer, jsval space,
|
2008-10-01 06:13:58 +00:00
|
|
|
JSONWriteCallback callback, void *data);
|
|
|
|
|
|
|
|
/*
|
2011-03-21 18:42:14 +00:00
|
|
|
* JSON.parse as specified by ES5.
|
2008-10-01 06:13:58 +00:00
|
|
|
*/
|
2011-03-21 18:42:06 +00:00
|
|
|
JS_PUBLIC_API(JSBool)
|
2013-05-29 08:28:03 +00:00
|
|
|
JS_ParseJSON(JSContext *cx, const jschar *chars, uint32_t len, JS::MutableHandle<JS::Value> vp);
|
2011-03-21 18:42:06 +00:00
|
|
|
|
|
|
|
JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_ParseJSONWithReviver(JSContext *cx, const jschar *chars, uint32_t len, jsval reviver,
|
|
|
|
jsval *vp);
|
2011-03-21 18:42:06 +00:00
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
2010-10-01 00:47:10 +00:00
|
|
|
/* API for the HTML5 internal structured cloning algorithm. */
|
|
|
|
|
|
|
|
/* The maximum supported structured-clone serialization format version. */
|
2013-02-22 21:43:28 +00:00
|
|
|
#define JS_STRUCTURED_CLONE_VERSION 2
|
2010-10-01 00:47:10 +00:00
|
|
|
|
2011-01-07 06:21:30 +00:00
|
|
|
struct JSStructuredCloneCallbacks {
|
|
|
|
ReadStructuredCloneOp read;
|
|
|
|
WriteStructuredCloneOp write;
|
|
|
|
StructuredCloneErrorOp reportError;
|
|
|
|
};
|
|
|
|
|
2012-10-03 22:19:22 +00:00
|
|
|
/* Note: if the *data contains transferable objects, it can be read
|
|
|
|
* only once */
|
2010-10-01 00:47:10 +00:00
|
|
|
JS_PUBLIC_API(JSBool)
|
2012-10-03 22:19:22 +00:00
|
|
|
JS_ReadStructuredClone(JSContext *cx, uint64_t *data, size_t nbytes,
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
uint32_t version, jsval *vp,
|
2011-01-07 06:21:30 +00:00
|
|
|
const JSStructuredCloneCallbacks *optionalCallbacks,
|
|
|
|
void *closure);
|
2010-10-01 00:47:10 +00:00
|
|
|
|
2012-10-03 22:19:22 +00:00
|
|
|
/* Note: On success, the caller is responsible for calling
|
|
|
|
* JS_ClearStructuredClone(*datap, nbytesp). */
|
2010-10-01 00:47:10 +00:00
|
|
|
JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_WriteStructuredClone(JSContext *cx, jsval v, uint64_t **datap, size_t *nbytesp,
|
2011-01-07 06:21:30 +00:00
|
|
|
const JSStructuredCloneCallbacks *optionalCallbacks,
|
2012-10-03 22:19:22 +00:00
|
|
|
void *closure, jsval transferable);
|
|
|
|
|
|
|
|
JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ClearStructuredClone(const uint64_t *data, size_t nbytes);
|
|
|
|
|
|
|
|
JS_PUBLIC_API(JSBool)
|
|
|
|
JS_StructuredCloneHasTransferables(const uint64_t *data, size_t nbytes,
|
|
|
|
JSBool *hasTransferable);
|
2010-10-01 00:47:10 +00:00
|
|
|
|
|
|
|
JS_PUBLIC_API(JSBool)
|
2011-01-07 06:21:30 +00:00
|
|
|
JS_StructuredClone(JSContext *cx, jsval v, jsval *vp,
|
|
|
|
const JSStructuredCloneCallbacks *optionalCallbacks,
|
|
|
|
void *closure);
|
2010-10-01 00:47:10 +00:00
|
|
|
|
|
|
|
/* RAII sugar for JS_WriteStructuredClone. */
|
2011-07-12 17:42:24 +00:00
|
|
|
class JS_PUBLIC_API(JSAutoStructuredCloneBuffer) {
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
uint64_t *data_;
|
2010-10-01 00:47:10 +00:00
|
|
|
size_t nbytes_;
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
uint32_t version_;
|
2010-10-01 00:47:10 +00:00
|
|
|
|
|
|
|
public:
|
2010-12-21 16:02:04 +00:00
|
|
|
JSAutoStructuredCloneBuffer()
|
2011-07-12 17:42:24 +00:00
|
|
|
: data_(NULL), nbytes_(0), version_(JS_STRUCTURED_CLONE_VERSION) {}
|
2010-11-24 20:14:02 +00:00
|
|
|
|
2010-10-01 00:47:10 +00:00
|
|
|
~JSAutoStructuredCloneBuffer() { clear(); }
|
|
|
|
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
uint64_t *data() const { return data_; }
|
2010-10-01 00:47:10 +00:00
|
|
|
size_t nbytes() const { return nbytes_; }
|
|
|
|
|
2011-07-12 17:42:24 +00:00
|
|
|
void clear();
|
|
|
|
|
|
|
|
/* Copy some memory. It will be automatically freed by the destructor. */
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
bool copy(const uint64_t *data, size_t nbytes, uint32_t version=JS_STRUCTURED_CLONE_VERSION);
|
2010-10-01 00:47:10 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Adopt some memory. It will be automatically freed by the destructor.
|
2011-07-12 17:42:24 +00:00
|
|
|
* data must have been allocated by the JS engine (e.g., extracted via
|
|
|
|
* JSAutoStructuredCloneBuffer::steal).
|
2010-10-01 00:47:10 +00:00
|
|
|
*/
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
void adopt(uint64_t *data, size_t nbytes, uint32_t version=JS_STRUCTURED_CLONE_VERSION);
|
2010-10-01 00:47:10 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Remove the buffer so that it will not be automatically freed.
|
2011-07-12 17:42:24 +00:00
|
|
|
* After this, the caller is responsible for feeding the memory back to
|
|
|
|
* JSAutoStructuredCloneBuffer::adopt.
|
2010-10-01 00:47:10 +00:00
|
|
|
*/
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
void steal(uint64_t **datap, size_t *nbytesp, uint32_t *versionp=NULL);
|
2010-10-01 00:47:10 +00:00
|
|
|
|
2011-07-12 17:42:24 +00:00
|
|
|
bool read(JSContext *cx, jsval *vp,
|
2011-01-07 06:21:30 +00:00
|
|
|
const JSStructuredCloneCallbacks *optionalCallbacks=NULL,
|
2012-10-03 22:19:22 +00:00
|
|
|
void *closure=NULL);
|
|
|
|
|
|
|
|
bool write(JSContext *cx, jsval v,
|
|
|
|
const JSStructuredCloneCallbacks *optionalCallbacks=NULL,
|
|
|
|
void *closure=NULL);
|
2010-10-01 00:47:10 +00:00
|
|
|
|
2011-01-07 06:21:30 +00:00
|
|
|
bool write(JSContext *cx, jsval v,
|
2012-10-03 22:19:22 +00:00
|
|
|
jsval transferable,
|
2011-01-07 06:21:30 +00:00
|
|
|
const JSStructuredCloneCallbacks *optionalCallbacks=NULL,
|
2011-07-12 17:42:24 +00:00
|
|
|
void *closure=NULL);
|
2010-12-21 16:02:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Swap ownership with another JSAutoStructuredCloneBuffer.
|
|
|
|
*/
|
2011-07-12 17:42:24 +00:00
|
|
|
void swap(JSAutoStructuredCloneBuffer &other);
|
2010-12-21 16:02:04 +00:00
|
|
|
|
|
|
|
private:
|
|
|
|
/* Copy and assignment are not supported. */
|
|
|
|
JSAutoStructuredCloneBuffer(const JSAutoStructuredCloneBuffer &other);
|
|
|
|
JSAutoStructuredCloneBuffer &operator=(const JSAutoStructuredCloneBuffer &other);
|
2010-10-01 00:47:10 +00:00
|
|
|
};
|
2011-07-12 17:42:24 +00:00
|
|
|
|
2010-10-01 00:47:10 +00:00
|
|
|
/* API for implementing custom serialization behavior (for ImageData, File, etc.) */
|
|
|
|
|
|
|
|
/* The range of tag values the application may use for its own custom object types. */
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
#define JS_SCTAG_USER_MIN ((uint32_t) 0xFFFF8000)
|
|
|
|
#define JS_SCTAG_USER_MAX ((uint32_t) 0xFFFFFFFF)
|
2010-10-01 00:47:10 +00:00
|
|
|
|
|
|
|
#define JS_SCERR_RECURSION 0
|
2012-10-03 22:19:22 +00:00
|
|
|
#define JS_SCERR_TRANSFERABLE 1
|
2010-10-01 00:47:10 +00:00
|
|
|
|
|
|
|
JS_PUBLIC_API(void)
|
|
|
|
JS_SetStructuredCloneCallbacks(JSRuntime *rt, const JSStructuredCloneCallbacks *callbacks);
|
|
|
|
|
|
|
|
JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_ReadUint32Pair(JSStructuredCloneReader *r, uint32_t *p1, uint32_t *p2);
|
2010-10-01 00:47:10 +00:00
|
|
|
|
|
|
|
JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ReadBytes(JSStructuredCloneReader *r, void *p, size_t len);
|
|
|
|
|
2012-04-24 10:58:07 +00:00
|
|
|
JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ReadTypedArray(JSStructuredCloneReader *r, jsval *vp);
|
|
|
|
|
2010-10-01 00:47:10 +00:00
|
|
|
JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_WriteUint32Pair(JSStructuredCloneWriter *w, uint32_t tag, uint32_t data);
|
2010-10-01 00:47:10 +00:00
|
|
|
|
|
|
|
JS_PUBLIC_API(JSBool)
|
|
|
|
JS_WriteBytes(JSStructuredCloneWriter *w, const void *p, size_t len);
|
|
|
|
|
2012-04-24 10:58:07 +00:00
|
|
|
JS_PUBLIC_API(JSBool)
|
|
|
|
JS_WriteTypedArray(JSStructuredCloneWriter *w, jsval v);
|
|
|
|
|
2010-10-01 00:47:10 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
2013-01-03 18:29:09 +00:00
|
|
|
/*
|
|
|
|
* The default locale for the ECMAScript Internationalization API
|
|
|
|
* (Intl.Collator, Intl.NumberFormat, Intl.DateTimeFormat).
|
|
|
|
* Note that the Internationalization API encourages clients to
|
|
|
|
* specify their own locales.
|
|
|
|
* The locale string remains owned by the caller.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-02-08 02:04:11 +00:00
|
|
|
JS_SetDefaultLocale(JSRuntime *rt, const char *locale);
|
2013-01-03 18:29:09 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Reset the default locale to OS defaults.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
2013-02-08 02:04:11 +00:00
|
|
|
JS_ResetDefaultLocale(JSRuntime *rt);
|
2013-01-03 18:29:09 +00:00
|
|
|
|
2000-08-09 21:46:03 +00:00
|
|
|
/*
|
2005-12-03 02:31:21 +00:00
|
|
|
* Locale specific string conversion and error message callbacks.
|
2000-08-09 21:46:03 +00:00
|
|
|
*/
|
|
|
|
struct JSLocaleCallbacks {
|
|
|
|
JSLocaleToUpperCase localeToUpperCase;
|
|
|
|
JSLocaleToLowerCase localeToLowerCase;
|
2013-03-21 21:50:06 +00:00
|
|
|
JSLocaleCompare localeCompare; // not used #if ENABLE_INTL_API
|
2004-06-15 16:38:43 +00:00
|
|
|
JSLocaleToUnicode localeToUnicode;
|
2005-12-03 02:31:21 +00:00
|
|
|
JSErrorCallback localeGetErrorMessage;
|
2000-08-09 21:46:03 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
2000-09-08 21:24:14 +00:00
|
|
|
* Establish locale callbacks. The pointer must persist as long as the
|
2013-02-08 02:04:11 +00:00
|
|
|
* JSRuntime. Passing NULL restores the default behaviour.
|
2000-08-09 21:46:03 +00:00
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
2013-02-08 02:04:11 +00:00
|
|
|
JS_SetLocaleCallbacks(JSRuntime *rt, JSLocaleCallbacks *callbacks);
|
2000-08-09 21:46:03 +00:00
|
|
|
|
2000-09-08 21:24:14 +00:00
|
|
|
/*
|
|
|
|
* Return the address of the current locale callbacks struct, which may
|
|
|
|
* be NULL.
|
|
|
|
*/
|
2000-09-02 20:37:37 +00:00
|
|
|
extern JS_PUBLIC_API(JSLocaleCallbacks *)
|
2013-02-08 02:04:11 +00:00
|
|
|
JS_GetLocaleCallbacks(JSRuntime *rt);
|
2000-08-09 21:46:03 +00:00
|
|
|
|
|
|
|
/************************************************************************/
|
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/*
|
|
|
|
* Error reporting.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Report an exception represented by the sprintf-like conversion of format
|
|
|
|
* and its arguments. This exception message string is passed to a pre-set
|
2011-09-19 16:34:49 +00:00
|
|
|
* JSErrorReporter function (set by JS_SetErrorReporter).
|
1998-03-28 02:44:41 +00:00
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_ReportError(JSContext *cx, const char *format, ...);
|
|
|
|
|
1998-10-14 10:22:38 +00:00
|
|
|
/*
|
|
|
|
* Use an errorNumber to retrieve the format string, args are char *
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_ReportErrorNumber(JSContext *cx, JSErrorCallback errorCallback,
|
2012-02-28 23:11:11 +00:00
|
|
|
void *userRef, const unsigned errorNumber, ...);
|
1998-10-14 10:22:38 +00:00
|
|
|
|
2012-07-18 10:36:08 +00:00
|
|
|
#ifdef va_start
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_ReportErrorNumberVA(JSContext *cx, JSErrorCallback errorCallback,
|
|
|
|
void *userRef, const unsigned errorNumber, va_list ap);
|
|
|
|
#endif
|
|
|
|
|
1998-10-14 10:22:38 +00:00
|
|
|
/*
|
|
|
|
* Use an errorNumber to retrieve the format string, args are jschar *
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_ReportErrorNumberUC(JSContext *cx, JSErrorCallback errorCallback,
|
2012-02-28 23:11:11 +00:00
|
|
|
void *userRef, const unsigned errorNumber, ...);
|
1998-10-14 10:22:38 +00:00
|
|
|
|
2012-11-06 23:23:14 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_ReportErrorNumberUCArray(JSContext *cx, JSErrorCallback errorCallback,
|
|
|
|
void *userRef, const unsigned errorNumber,
|
|
|
|
const jschar **args);
|
|
|
|
|
1998-10-14 10:22:38 +00:00
|
|
|
/*
|
2000-01-18 11:06:05 +00:00
|
|
|
* As above, but report a warning instead (JSREPORT_IS_WARNING(report.flags)).
|
|
|
|
* Return true if there was no error trying to issue the warning, and if the
|
|
|
|
* warning was not converted into an error due to the JSOPTION_WERROR option
|
|
|
|
* being set, false otherwise.
|
1998-10-14 10:22:38 +00:00
|
|
|
*/
|
2000-01-18 11:06:05 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
1998-10-14 10:22:38 +00:00
|
|
|
JS_ReportWarning(JSContext *cx, const char *format, ...);
|
|
|
|
|
2000-01-18 11:06:05 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_ReportErrorFlagsAndNumber(JSContext *cx, unsigned flags,
|
2000-01-18 11:06:05 +00:00
|
|
|
JSErrorCallback errorCallback, void *userRef,
|
2012-02-28 23:11:11 +00:00
|
|
|
const unsigned errorNumber, ...);
|
2000-01-18 11:06:05 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_ReportErrorFlagsAndNumberUC(JSContext *cx, unsigned flags,
|
2000-01-18 11:06:05 +00:00
|
|
|
JSErrorCallback errorCallback, void *userRef,
|
2012-02-28 23:11:11 +00:00
|
|
|
const unsigned errorNumber, ...);
|
2000-01-18 11:06:05 +00:00
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/*
|
|
|
|
* Complain when out of memory.
|
|
|
|
*/
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_ReportOutOfMemory(JSContext *cx);
|
|
|
|
|
2008-03-12 23:07:47 +00:00
|
|
|
/*
|
|
|
|
* Complain when an allocation size overflows the maximum supported limit.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_ReportAllocationOverflow(JSContext *cx);
|
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
struct JSErrorReport {
|
1998-10-14 10:22:38 +00:00
|
|
|
const char *filename; /* source file name, URL, etc., or null */
|
2011-06-28 00:42:53 +00:00
|
|
|
JSPrincipals *originPrincipals; /* see 'originPrincipals' comment above */
|
2012-08-31 22:01:33 +00:00
|
|
|
unsigned lineno; /* source line number */
|
1998-10-14 10:22:38 +00:00
|
|
|
const char *linebuf; /* offending source line without final \n */
|
|
|
|
const char *tokenptr; /* pointer to error token in linebuf */
|
|
|
|
const jschar *uclinebuf; /* unicode (original) line buffer */
|
|
|
|
const jschar *uctokenptr; /* unicode (original) token pointer */
|
2012-08-31 22:01:33 +00:00
|
|
|
unsigned flags; /* error/warning, etc. */
|
|
|
|
unsigned errorNumber; /* the error number, e.g. see js.msg */
|
1998-10-14 10:22:38 +00:00
|
|
|
const jschar *ucmessage; /* the (default) error message */
|
|
|
|
const jschar **messageArgs; /* arguments for the error message */
|
2012-07-18 10:36:08 +00:00
|
|
|
int16_t exnType; /* One of the JSExnType constants */
|
2012-08-31 22:01:33 +00:00
|
|
|
unsigned column; /* zero-based column index in line */
|
1998-03-28 02:44:41 +00:00
|
|
|
};
|
|
|
|
|
1998-10-14 10:22:38 +00:00
|
|
|
/*
|
2000-01-18 11:06:05 +00:00
|
|
|
* JSErrorReport flag values. These may be freely composed.
|
1998-10-14 10:22:38 +00:00
|
|
|
*/
|
2000-01-18 11:06:05 +00:00
|
|
|
#define JSREPORT_ERROR 0x0 /* pseudo-flag for default case */
|
|
|
|
#define JSREPORT_WARNING 0x1 /* reported via JS_ReportWarning */
|
|
|
|
#define JSREPORT_EXCEPTION 0x2 /* exception was thrown */
|
|
|
|
#define JSREPORT_STRICT 0x4 /* error or warning due to strict option */
|
1998-10-14 10:22:38 +00:00
|
|
|
|
2009-11-19 17:23:20 +00:00
|
|
|
/*
|
|
|
|
* This condition is an error in strict mode code, a warning if
|
|
|
|
* JS_HAS_STRICT_OPTION(cx), and otherwise should not be reported at
|
|
|
|
* all. We check the strictness of the context's top frame's script;
|
|
|
|
* where that isn't appropriate, the caller should do the right checks
|
|
|
|
* itself instead of using this flag.
|
|
|
|
*/
|
|
|
|
#define JSREPORT_STRICT_MODE_ERROR 0x8
|
|
|
|
|
1998-10-14 10:22:38 +00:00
|
|
|
/*
|
|
|
|
* If JSREPORT_EXCEPTION is set, then a JavaScript-catchable exception
|
|
|
|
* has been thrown for this runtime error, and the host should ignore it.
|
|
|
|
* Exception-aware hosts should also check for JS_IsExceptionPending if
|
|
|
|
* JS_ExecuteScript returns failure, and signal or propagate the exception, as
|
|
|
|
* appropriate.
|
|
|
|
*/
|
2000-01-18 11:06:05 +00:00
|
|
|
#define JSREPORT_IS_WARNING(flags) (((flags) & JSREPORT_WARNING) != 0)
|
|
|
|
#define JSREPORT_IS_EXCEPTION(flags) (((flags) & JSREPORT_EXCEPTION) != 0)
|
|
|
|
#define JSREPORT_IS_STRICT(flags) (((flags) & JSREPORT_STRICT) != 0)
|
2009-11-19 17:23:20 +00:00
|
|
|
#define JSREPORT_IS_STRICT_MODE_ERROR(flags) (((flags) & \
|
|
|
|
JSREPORT_STRICT_MODE_ERROR) != 0)
|
2012-01-15 08:13:09 +00:00
|
|
|
extern JS_PUBLIC_API(JSErrorReporter)
|
|
|
|
JS_GetErrorReporter(JSContext *cx);
|
1998-10-14 10:22:38 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSErrorReporter)
|
1998-03-28 02:44:41 +00:00
|
|
|
JS_SetErrorReporter(JSContext *cx, JSErrorReporter er);
|
|
|
|
|
|
|
|
/************************************************************************/
|
|
|
|
|
2011-01-18 22:11:03 +00:00
|
|
|
/*
|
|
|
|
* Dates.
|
|
|
|
*/
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
|
|
|
JS_NewDateObject(JSContext *cx, int year, int mon, int mday, int hour, int min, int sec);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2012-02-24 22:19:52 +00:00
|
|
|
JS_NewDateObjectMsec(JSContext *cx, double msec);
|
2011-01-18 22:11:03 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Infallible predicate to test whether obj is a date object.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_ObjectIsDate(JSContext *cx, JSObject *obj);
|
2011-01-18 22:11:03 +00:00
|
|
|
|
2012-07-13 22:56:08 +00:00
|
|
|
/*
|
|
|
|
* Clears the cache of calculated local time from each Date object.
|
|
|
|
* Call to propagate a system timezone change.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_ClearDateCaches(JSContext *cx);
|
|
|
|
|
2011-01-18 22:11:03 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/*
|
|
|
|
* Regular Expressions.
|
|
|
|
*/
|
|
|
|
#define JSREG_FOLD 0x01 /* fold uppercase to lowercase */
|
|
|
|
#define JSREG_GLOB 0x02 /* global exec, creates array of matches */
|
1999-04-27 15:18:57 +00:00
|
|
|
#define JSREG_MULTILINE 0x04 /* treat ^ and $ as begin and end of line */
|
2007-03-11 19:36:59 +00:00
|
|
|
#define JSREG_STICKY 0x08 /* only match starting at lastIndex */
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_NewRegExpObject(JSContext *cx, JSObject *obj, char *bytes, size_t length, unsigned flags);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_NewUCRegExpObject(JSContext *cx, JSObject *obj, jschar *chars, size_t length, unsigned flags);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2010-09-13 22:53:50 +00:00
|
|
|
JS_SetRegExpInput(JSContext *cx, JSObject *obj, JSString *input, JSBool multiline);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2010-09-13 22:53:50 +00:00
|
|
|
JS_ClearRegExpStatics(JSContext *cx, JSObject *obj);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2010-08-18 19:26:22 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
2010-09-13 22:53:50 +00:00
|
|
|
JS_ExecuteRegExp(JSContext *cx, JSObject *obj, JSObject *reobj, jschar *chars, size_t length,
|
2010-08-18 19:26:22 +00:00
|
|
|
size_t *indexp, JSBool test, jsval *rval);
|
|
|
|
|
2010-09-13 22:53:50 +00:00
|
|
|
/* RegExp interface for clients without a global object. */
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_NewRegExpObjectNoStatics(JSContext *cx, char *bytes, size_t length, unsigned flags);
|
2010-09-13 22:53:50 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2012-02-28 23:11:11 +00:00
|
|
|
JS_NewUCRegExpObjectNoStatics(JSContext *cx, jschar *chars, size_t length, unsigned flags);
|
2010-09-13 22:53:50 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ExecuteRegExpNoStatics(JSContext *cx, JSObject *reobj, jschar *chars, size_t length,
|
|
|
|
size_t *indexp, JSBool test, jsval *rval);
|
1998-03-28 02:44:41 +00:00
|
|
|
|
2011-05-18 03:04:28 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ObjectIsRegExp(JSContext *cx, JSObject *obj);
|
|
|
|
|
2012-02-28 23:11:11 +00:00
|
|
|
extern JS_PUBLIC_API(unsigned)
|
2011-05-09 03:10:21 +00:00
|
|
|
JS_GetRegExpFlags(JSContext *cx, JSObject *obj);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSString *)
|
|
|
|
JS_GetRegExpSource(JSContext *cx, JSObject *obj);
|
|
|
|
|
1998-03-28 02:44:41 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_IsExceptionPending(JSContext *cx);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_GetPendingException(JSContext *cx, jsval *vp);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetPendingException(JSContext *cx, jsval v);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_ClearPendingException(JSContext *cx);
|
2004-07-17 02:39:55 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ReportPendingException(JSContext *cx);
|
1998-04-24 00:31:11 +00:00
|
|
|
|
1999-06-08 02:15:57 +00:00
|
|
|
/*
|
2002-02-09 06:28:58 +00:00
|
|
|
* Save the current exception state. This takes a snapshot of cx's current
|
1999-06-08 02:15:57 +00:00
|
|
|
* exception state without making any change to that state.
|
|
|
|
*
|
2002-02-09 06:28:58 +00:00
|
|
|
* The returned state pointer MUST be passed later to JS_RestoreExceptionState
|
|
|
|
* (to restore that saved state, overriding any more recent state) or else to
|
|
|
|
* JS_DropExceptionState (to free the state struct in case it is not correct
|
|
|
|
* or desirable to restore it). Both Restore and Drop free the state struct,
|
|
|
|
* so callers must stop using the pointer returned from Save after calling the
|
|
|
|
* Release or Drop API.
|
1999-06-08 02:15:57 +00:00
|
|
|
*/
|
1998-11-05 00:08:43 +00:00
|
|
|
extern JS_PUBLIC_API(JSExceptionState *)
|
|
|
|
JS_SaveExceptionState(JSContext *cx);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_RestoreExceptionState(JSContext *cx, JSExceptionState *state);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_DropExceptionState(JSContext *cx, JSExceptionState *state);
|
|
|
|
|
1999-10-05 21:07:23 +00:00
|
|
|
/*
|
2002-02-09 06:28:58 +00:00
|
|
|
* If the given value is an exception object that originated from an error,
|
|
|
|
* the exception will contain an error report struct, and this API will return
|
|
|
|
* the address of that struct. Otherwise, it returns NULL. The lifetime of
|
|
|
|
* the error report struct that might be returned is the same as the lifetime
|
|
|
|
* of the exception object.
|
1999-10-05 21:07:23 +00:00
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSErrorReport *)
|
|
|
|
JS_ErrorFromException(JSContext *cx, jsval v);
|
|
|
|
|
2005-07-20 03:35:40 +00:00
|
|
|
/*
|
|
|
|
* Given a reported error's message and JSErrorReport struct pointer, throw
|
|
|
|
* the corresponding exception on cx.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ThrowReportedError(JSContext *cx, const char *message,
|
|
|
|
JSErrorReport *reportp);
|
|
|
|
|
2007-10-01 00:31:22 +00:00
|
|
|
/*
|
|
|
|
* Throws a StopIteration exception on cx.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_ThrowStopIteration(JSContext *cx);
|
|
|
|
|
2012-01-11 08:23:07 +00:00
|
|
|
extern JS_PUBLIC_API(intptr_t)
|
|
|
|
JS_GetCurrentThread();
|
|
|
|
|
2011-07-01 21:11:31 +00:00
|
|
|
/*
|
|
|
|
* A JS runtime always has an "owner thread". The owner thread is set when the
|
|
|
|
* runtime is created (to the current thread) and practically all entry points
|
|
|
|
* into the JS engine check that a runtime (or anything contained in the
|
|
|
|
* runtime: context, compartment, object, etc) is only touched by its owner
|
|
|
|
* thread. Embeddings may check this invariant outside the JS engine by calling
|
|
|
|
* JS_AbortIfWrongThread (which will abort if not on the owner thread, even for
|
|
|
|
* non-debug builds).
|
|
|
|
*
|
|
|
|
* It is possible to "move" a runtime between threads. This is accomplished by
|
|
|
|
* calling JS_ClearRuntimeThread on a runtime's owner thread and then calling
|
|
|
|
* JS_SetRuntimeThread on the new owner thread. The runtime must not be
|
|
|
|
* accessed between JS_ClearRuntimeThread and JS_SetRuntimeThread. Also, the
|
|
|
|
* caller is responsible for synchronizing the calls to Set/Clear.
|
|
|
|
*/
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_AbortIfWrongThread(JSRuntime *rt);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_ClearRuntimeThread(JSRuntime *rt);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetRuntimeThread(JSRuntime *rt);
|
|
|
|
|
|
|
|
class JSAutoSetRuntimeThread
|
|
|
|
{
|
2013-02-18 06:56:32 +00:00
|
|
|
JSRuntime *runtime_;
|
2011-07-01 21:11:31 +00:00
|
|
|
|
|
|
|
public:
|
2013-02-18 06:56:32 +00:00
|
|
|
JSAutoSetRuntimeThread(JSRuntime *runtime) : runtime_(runtime) {
|
|
|
|
JS_SetRuntimeThread(runtime_);
|
2011-07-01 21:11:31 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
~JSAutoSetRuntimeThread() {
|
2013-02-18 06:56:32 +00:00
|
|
|
JS_ClearRuntimeThread(runtime_);
|
2011-07-01 21:11:31 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
1998-04-24 00:31:11 +00:00
|
|
|
/************************************************************************/
|
|
|
|
|
2010-08-16 19:35:04 +00:00
|
|
|
/*
|
|
|
|
* JS_IsConstructing must be called from within a native given the
|
|
|
|
* native's original cx and vp arguments. If JS_IsConstructing is true,
|
|
|
|
* JS_THIS must not be used; the constructor should construct and return a
|
|
|
|
* new object. Otherwise, the native is called as an ordinary function and
|
|
|
|
* JS_THIS may be used.
|
|
|
|
*/
|
|
|
|
static JS_ALWAYS_INLINE JSBool
|
|
|
|
JS_IsConstructing(JSContext *cx, const jsval *vp)
|
|
|
|
{
|
|
|
|
#ifdef DEBUG
|
|
|
|
JSObject *callee = JSVAL_TO_OBJECT(JS_CALLEE(cx, vp));
|
|
|
|
if (JS_ObjectIsFunction(cx, callee)) {
|
|
|
|
JSFunction *fun = JS_ValueToFunction(cx, JS_CALLEE(cx, vp));
|
2012-11-02 04:35:09 +00:00
|
|
|
JS_ASSERT(JS_IsConstructor(fun));
|
2010-08-16 19:35:04 +00:00
|
|
|
} else {
|
2012-02-04 00:54:57 +00:00
|
|
|
JS_ASSERT(JS_GetClass(callee)->construct != NULL);
|
2010-08-16 19:35:04 +00:00
|
|
|
}
|
2012-02-16 01:41:59 +00:00
|
|
|
#else
|
|
|
|
(void)cx;
|
2010-08-16 19:35:04 +00:00
|
|
|
#endif
|
|
|
|
|
2011-09-19 16:34:49 +00:00
|
|
|
return JSVAL_IS_MAGIC_IMPL(JSVAL_TO_IMPL(vp[1]));
|
2010-08-16 19:35:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
2012-03-12 23:16:40 +00:00
|
|
|
* A constructor can request that the JS engine create a default new 'this'
|
|
|
|
* object of the given class, using the callee to determine parentage and
|
|
|
|
* [[Prototype]].
|
2010-08-16 19:35:04 +00:00
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
2012-03-12 23:16:40 +00:00
|
|
|
JS_NewObjectForConstructor(JSContext *cx, JSClass *clasp, const jsval *vp);
|
2010-08-16 19:35:04 +00:00
|
|
|
|
|
|
|
/************************************************************************/
|
|
|
|
|
2007-05-15 23:27:20 +00:00
|
|
|
#ifdef JS_GC_ZEAL
|
2011-06-02 00:48:52 +00:00
|
|
|
#define JS_DEFAULT_ZEAL_FREQ 100
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
2012-04-03 18:41:56 +00:00
|
|
|
JS_SetGCZeal(JSContext *cx, uint8_t zeal, uint32_t frequency);
|
2011-06-02 00:48:52 +00:00
|
|
|
|
2007-05-15 23:27:20 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
2012-04-03 18:41:56 +00:00
|
|
|
JS_ScheduleGC(JSContext *cx, uint32_t count);
|
2007-05-15 23:27:20 +00:00
|
|
|
#endif
|
|
|
|
|
2012-11-26 21:30:37 +00:00
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetParallelCompilationEnabled(JSContext *cx, bool enabled);
|
|
|
|
|
2013-06-24 12:10:55 +00:00
|
|
|
typedef enum JSCompilerOption {
|
|
|
|
JSCOMPILER_BASELINE_USECOUNT_TRIGGER,
|
|
|
|
JSCOMPILER_ION_USECOUNT_TRIGGER,
|
|
|
|
JSCOMPILER_PJS_ENABLE
|
|
|
|
} JSCompilerOption;
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void)
|
|
|
|
JS_SetGlobalCompilerOption(JSContext *cx, JSCompilerOption opt, uint32_t value);
|
|
|
|
|
2011-11-04 16:19:07 +00:00
|
|
|
/*
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
* Convert a uint32_t index into a jsid.
|
2011-11-04 16:19:07 +00:00
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
Bug 708735 - Use <stdint.h> types in JSAPI and throughout SpiderMonkey. Continue to provide the {u,}int{8,16,32,64} and JS{Uint,Int}{8,16,32,64} integer types through a single header, however, for a simpler backout strategy -- and also to ease the transition for embedders. r=timeless on switching the jsd API to use the <stdint.h> types, r=luke, r=dmandelin
2011-12-09 03:54:10 +00:00
|
|
|
JS_IndexToId(JSContext *cx, uint32_t index, jsid *id);
|
2011-11-04 16:19:07 +00:00
|
|
|
|
2013-01-28 13:46:10 +00:00
|
|
|
/*
|
|
|
|
* Convert chars into a jsid.
|
|
|
|
*
|
|
|
|
* |chars| may not be an index.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_CharsToId(JSContext* cx, JS::TwoByteChars chars, jsid *idp);
|
|
|
|
|
2011-11-21 14:56:24 +00:00
|
|
|
/*
|
|
|
|
* Test if the given string is a valid ECMAScript identifier
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_IsIdentifier(JSContext *cx, JSString *str, JSBool *isIdentifier);
|
|
|
|
|
2012-03-06 23:33:12 +00:00
|
|
|
/*
|
|
|
|
* Return the current script and line number of the most currently running
|
|
|
|
* frame. Returns true if a scripted frame was found, false otherwise.
|
|
|
|
*/
|
|
|
|
extern JS_PUBLIC_API(JSBool)
|
|
|
|
JS_DescribeScriptedCaller(JSContext *cx, JSScript **script, unsigned *lineno);
|
|
|
|
|
|
|
|
|
2012-02-20 10:58:00 +00:00
|
|
|
/*
|
|
|
|
* Encode/Decode interpreted scripts and functions to/from memory.
|
|
|
|
*/
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void *)
|
|
|
|
JS_EncodeScript(JSContext *cx, JSScript *script, uint32_t *lengthp);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(void *)
|
2013-04-16 01:16:13 +00:00
|
|
|
JS_EncodeInterpretedFunction(JSContext *cx, JSObject *funobj, uint32_t *lengthp);
|
2012-02-20 10:58:00 +00:00
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSScript *)
|
|
|
|
JS_DecodeScript(JSContext *cx, const void *data, uint32_t length,
|
|
|
|
JSPrincipals *principals, JSPrincipals *originPrincipals);
|
|
|
|
|
|
|
|
extern JS_PUBLIC_API(JSObject *)
|
|
|
|
JS_DecodeInterpretedFunction(JSContext *cx, const void *data, uint32_t length,
|
|
|
|
JSPrincipals *principals, JSPrincipals *originPrincipals);
|
|
|
|
|
2013-03-21 12:56:39 +00:00
|
|
|
namespace JS {
|
|
|
|
|
2013-05-03 23:29:08 +00:00
|
|
|
extern JS_PUBLIC_DATA(const HandleValue) NullHandleValue;
|
|
|
|
extern JS_PUBLIC_DATA(const HandleValue) UndefinedHandleValue;
|
|
|
|
|
2013-03-21 12:56:39 +00:00
|
|
|
extern JS_PUBLIC_DATA(const HandleId) JSID_VOIDHANDLE;
|
|
|
|
extern JS_PUBLIC_DATA(const HandleId) JSID_EMPTYHANDLE;
|
|
|
|
|
2013-04-08 14:18:50 +00:00
|
|
|
} /* namespace JS */
|
2013-03-21 12:56:39 +00:00
|
|
|
|
2013-03-19 10:35:41 +00:00
|
|
|
namespace js {
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Import some JS:: names into the js namespace so we can make unqualified
|
|
|
|
* references to them.
|
|
|
|
*/
|
|
|
|
|
|
|
|
using JS::Value;
|
|
|
|
using JS::IsPoisonedValue;
|
|
|
|
using JS::NullValue;
|
|
|
|
using JS::UndefinedValue;
|
|
|
|
using JS::Int32Value;
|
|
|
|
using JS::DoubleValue;
|
|
|
|
using JS::StringValue;
|
|
|
|
using JS::BooleanValue;
|
|
|
|
using JS::ObjectValue;
|
|
|
|
using JS::MagicValue;
|
|
|
|
using JS::NumberValue;
|
|
|
|
using JS::ObjectOrNullValue;
|
|
|
|
using JS::PrivateValue;
|
|
|
|
using JS::PrivateUint32Value;
|
|
|
|
|
|
|
|
using JS::IsPoisonedPtr;
|
|
|
|
using JS::IsPoisonedId;
|
|
|
|
|
|
|
|
using JS::StableCharPtr;
|
|
|
|
using JS::TwoByteChars;
|
|
|
|
using JS::Latin1CharsZ;
|
|
|
|
|
|
|
|
using JS::AutoIdVector;
|
|
|
|
using JS::AutoValueVector;
|
2013-05-03 20:53:07 +00:00
|
|
|
using JS::AutoObjectVector;
|
2013-06-14 20:48:39 +00:00
|
|
|
using JS::AutoFunctionVector;
|
2013-03-19 10:35:41 +00:00
|
|
|
using JS::AutoScriptVector;
|
|
|
|
using JS::AutoIdArray;
|
|
|
|
|
|
|
|
using JS::AutoGCRooter;
|
|
|
|
using JS::AutoArrayRooter;
|
|
|
|
using JS::AutoVectorRooter;
|
|
|
|
using JS::AutoHashMapRooter;
|
|
|
|
using JS::AutoHashSetRooter;
|
|
|
|
|
|
|
|
using JS::CallArgs;
|
|
|
|
using JS::IsAcceptableThis;
|
|
|
|
using JS::NativeImpl;
|
|
|
|
using JS::CallReceiver;
|
|
|
|
using JS::CompileOptions;
|
|
|
|
using JS::CallNonGenericMethod;
|
|
|
|
|
|
|
|
using JS::Rooted;
|
|
|
|
using JS::RootedObject;
|
|
|
|
using JS::RootedModule;
|
|
|
|
using JS::RootedFunction;
|
|
|
|
using JS::RootedScript;
|
|
|
|
using JS::RootedString;
|
|
|
|
using JS::RootedId;
|
|
|
|
using JS::RootedValue;
|
|
|
|
|
|
|
|
using JS::Handle;
|
|
|
|
using JS::HandleObject;
|
|
|
|
using JS::HandleModule;
|
|
|
|
using JS::HandleFunction;
|
|
|
|
using JS::HandleScript;
|
|
|
|
using JS::HandleString;
|
|
|
|
using JS::HandleId;
|
|
|
|
using JS::HandleValue;
|
|
|
|
|
|
|
|
using JS::MutableHandle;
|
|
|
|
using JS::MutableHandleObject;
|
|
|
|
using JS::MutableHandleFunction;
|
|
|
|
using JS::MutableHandleScript;
|
|
|
|
using JS::MutableHandleString;
|
|
|
|
using JS::MutableHandleId;
|
|
|
|
using JS::MutableHandleValue;
|
|
|
|
|
|
|
|
using JS::Zone;
|
|
|
|
|
2013-04-08 14:18:50 +00:00
|
|
|
} /* namespace js */
|
2013-03-19 10:35:41 +00:00
|
|
|
|
2013-06-20 00:59:46 +00:00
|
|
|
#endif /* jsapi_h */
|