Search completed in 0.85 seconds.
nsIXPConnect
void clearallwrappednativesecuritypolicies(); nsixpconnectjsobjectholder createsandbox(in
jscontextptr cx, in nsiprincipal principal); native code only!
...inenumber, in nsistackframe acaller); void debugdump(in short depth); void debugdumpevalinjsstackframe(in pruint32 aframenumber, in string asourcetext); void debugdumpjsstack(in prbool showargs, in prbool showlocals, in prbool showthisprops); void debugdumpobject(in nsisupports acomobj, in short depth); [noscript,notxpcom] prbool definedomquickstubs(in
jscontextptr cx, in jsobjectptr proto, in pruint32 flags, in pruint32 interfacecount, [array, size_is(interfacecount)] in nsiidptr interfacearray); jsval evalinsandboxobject(in astring source, in
jscontextptr cx, in nsixpconnectjsobjectholder sandbox, in prbool returnstringonly); native code only!
... void flagsystemfilenameprefix(in string afilenameprefix, in prbool awantnativewrappers); void garbagecollect(); [noscript,notxpcom] void getcaller(out
jscontextptr a
jscontext, out jsobjectptr aobject); jsval getcowforobject(in
jscontextptr a
jscontext, in jsobjectptr aparent, in jsobjectptr awrappedobj); native code only!
...And 41 more matches
WebIDL bindings
non-static methods that use certain webidl types like any or object will get a
jscontext* argument prepended to the argument list.
... static methods will be passed a const globalobject& for the relevant global and can get a
jscontext* by calling context() on it.
...icoperation(any arg); }; will require these method declarations: class myclass { void dosomething(int32_t anumber); double dosomething(myclass* aotherinstance); already_addrefed<myinterface> dosomethingelse(optional<int32_t> amaybenumber, errorresult& rv); void dosomethingelse(myclass& aotherinstance, errorresult& rv); void dotheother(
jscontext* cx, js::value asomething); void doyetanotherthing(bool aactuallydoit); static void staticoperation(const globalobject& aglobal, js::value asomething); } c++ reflections of webidl attributes a webidl attribute is turned into a pair of method calls for the getter and setter on the underlying c++ object.
...And 24 more matches
JSAPI User Guide
the spidermonkey universe in order to run any javascript code in spidermonkey, an application must have three key elements: a jsruntime, a
jscontext, and a global object.
...every
jscontext and every object in an application lives within a jsruntime.
...a
jscontext, or context, is like a little machine that can do many things involving javascript code and objects.
...And 16 more matches
Index
24 js::autosaveexceptionstate jsapi reference, reference, référence(2), spidermonkey js::autosaveexceptionstate saves and later restores the current exception state of a given
jscontext.
...the finalizer's job is to clean up any resources allocated by the instance which wouldn't normally be cleaned up by the garbage collector (private data stored in the object by the application, file handles, etc.) 108 jsfreeop jsapi reference, reference, référence(2), spidermonkey various finalization api takes not
jscontext * but rather either jsfreeop structure or its library-private counterpart freeop.
... these structures wrap parameters that are passed to the finalizers removing most of explicit dependencies on
jscontext in the finalization code.
...And 11 more matches
nsIXPCScriptable
last changed in gecko 1.9.1 (firefox 3.5 / thunderbird 3.0 / seamonkey 2.0) inherits from: nsisupports method overview void precreate(in nsisupports nativeobj, in
jscontextptr cx, in jsobjectptr globalobj, out jsobjectptr parentobj); void create(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj); void postcreate(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj); prbool addproperty(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj, in jsval id, in jsvalptr vp); prbool delpropert...
...y(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj, in jsval id, in jsvalptr vp); prbool getproperty(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj, in jsval id, in jsvalptr vp); prbool setproperty(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj, in jsval id, in jsvalptr vp); prbool enumerate(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj); prbool newenumerate(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj, in pruint32 enum_op, in jsvalptr statep, out jsid idp); prbool newresolve(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj, in jsval id, in pruint32 flags, out jsobjectptr objp); prbool convert(in nsixpconnectwr...
...appednative wrapper, in
jscontextptr cx, in jsobjectptr obj, in pruint32 type, in jsvalptr vp); void finalize(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj); prbool checkaccess(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj, in jsval id, in pruint32 mode, in jsvalptr vp); prbool call(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj, in pruint32 argc, in jsvalptr argv, in jsvalptr vp); prbool construct(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj, in pruint32 argc, in jsvalptr argv, in jsvalptr vp); prbool hasinstance(in nsixpconnectwrappednative wrapper, in
jscontextptr cx, in jsobjectptr obj, in jsval val, out prbool bp); void trace(in nsixpconnectwrappednative wrapp...
...And 10 more matches
GC Rooting Guide
js::rooted must be constructed with a
jscontext*, and optionally an initial value.
... for example, instead of: jsobject * somefunction(
jscontext *cx, jsobject* obj) { // ...
... } you should write: jsobject * somefunction(
jscontext *cx, js::handleobject obj) { // ...
...And 8 more matches
JS::CompileOptions
constructor js::readonlycompileoptions(); // added in spidermonkey 31 js::owningcompileoptions(
jscontext *cx); // added in spidermonkey 31 js::compileoptions(
jscontext *cx, jsversion version = jsversion_unknown); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
... bool copy(
jscontext *cx, const readonlycompileoptions &rhs) copy compile options from rhs.
...And 5 more matches
JS_NewContext
create a new
jscontext.
... syntax
jscontext * js_newcontext(jsruntime *rt, size_t stackchunksize); name type description rt jsruntime * parent runtime for the new context.
... description js_newcontext creates a new
jscontext in the runtime rt.
...And 5 more matches
JS_SetContextCallback
specifies a callback function that is automatically called whenever a
jscontext is created or destroyed.
... syntax void js_setcontextcallback(jsruntime *rt,
jscontextcallback cxcallback, void *data); name type description rt jsruntime * pointer to a js runtime.
... cxcallback
jscontextcallback pointer to the callback function, described below.
...And 5 more matches
JS::PersistentRooted
syntax js::persistentrooted<t> var; // added in spidermonkey 38 js::persistentrooted<t> var(cx); js::persistentrooted<t> var(cx, initial); js::persistentrooted<t> var(rt); js::persistentrooted<t> var(rt, initial); name type description cx
jscontext * the context to get the runtime in which to add the root rt jsruntime * the runtime in which to add the root.
... method description void init(
jscontext* cx) initialize with optional initial value (if not provided, it will be initialized with the initial value of the type).
... added in spidermonkey 38 void init(
jscontext* cx, t initial) void init(jsruntime* rt) void init(jsruntime* rt, t initial) void reset() reset the value to initial value of the type.
...And 4 more matches
JSRuntime
all javascript code and most jsapi calls run within a
jscontext.
... the
jscontext is a child of the jsruntime.
...exception handling, error reporting, and some language options are per-
jscontext.
...And 4 more matches
JS_ClearContextThread
transfer a
jscontext from one thread to another.
... syntax jsword js_clearcontextthread(
jscontext *cx); jsword js_setcontextthread(
jscontext *cx); name type description cx
jscontext * the context to transfer from one thread to another.
... description an application that creates or uses a
jscontext in one thread, then uses or destroys it in another thread, must use js_clearcontextthread and js_setcontextthread to transfer the
jscontext safely from one thread to the other.
...And 4 more matches
JS_DefineProperty
syntax bool js_defineproperty(
jscontext *cx, js::handleobject obj, const char *name, js::handlevalue value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineproperty(
jscontext *cx, js::handleobject obj, const char *name, js::handleobject value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineproperty(
jscontext *cx, js::handleobject obj, const char *name, js::handlestring value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineproperty(
jscontext *cx, js::handleobject obj, const char *name, int32_t value, unsigned attrs, ...
... jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineproperty(
jscontext *cx, js::handleobject obj, const char *name, uint32_t value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineproperty(
jscontext *cx, js::handleobject obj, const char *name, double value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineucproperty(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, js::handlevalue value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineucproperty(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, ...
... js::handleobject value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineucproperty(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, js::handlestring value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineucproperty(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, int32_t value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineucproperty(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, uint32_t value, unsigned attrs, jsnative getter = nullptr, jsnative sette...
...And 4 more matches
JS_THREADSAFE
*/ js_endrequest(cx); a request is always associated with a specific
jscontext and runs from start to finish on a single thread.
...in this reference, these jsapi functions are marked with the words "requires request", like this: name type description cx
jscontext * the context to use.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
...And 4 more matches
Mozilla DOM Hacking Guide
static nsresult throwjsexception(
jscontext *cx, nsresult aresult);: help me!
... static nsresult initdomjsclass(
jscontext *cx, jsobject *obj);: help me!
... nsresult resolveconstructor(
jscontext *cx, jsobject *obj, jsobject **objp);: help me!
...And 3 more matches
How to embed the JavaScript engine
*/ static jsclass global_class = { "global", jsclass_global_flags, js_propertystub, js_deletepropertystub, js_propertystub, js_strictpropertystub, js_enumeratestub, js_resolvestub, js_convertstub, }; int main(int argc, const char *argv[]) { jsruntime *rt = js_newruntime(8l * 1024 * 1024, js_use_helper_threads); if (!rt) return 1;
jscontext *cx = js_newcontext(rt, 8192); if (!cx) return 1; { // scope for our various stack objects (jsautorequest, rootedobject), so they all go // out of scope before we js_destroycontext.
...rtystub, js_deletepropertystub, js_propertystub, js_strictpropertystub, js_enumeratestub, js_resolvestub, js_convertstub, nullptr, nullptr, nullptr, nullptr, js_globalobjecttracehook }; int main(int argc, const char *argv[]) { js_init(); jsruntime *rt = js_newruntime(8l * 1024 * 1024, js_use_helper_threads); if (!rt) return 1;
jscontext *cx = js_newcontext(rt, 8192); if (!cx) return 1; { // scope for our various stack objects (jsautorequest, rootedobject), so they all go // out of scope before we js_destroycontext.
...*/ static jsclass global_class = { "global", jsclass_global_flags, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, js_globalobjecttracehook }; int main(int argc, const char *argv[]) { js_init(); jsruntime *rt = js_newruntime(8l * 1024 * 1024); if (!rt) return 1;
jscontext *cx = js_newcontext(rt, 8192); if (!cx) return 1; { // scope for our various stack objects (jsautorequest, rootedobject), so they all go // out of scope before we js_destroycontext.
...And 3 more matches
SpiderMonkey Internals: Thread Safety
all js code and most jsapi calls run within a
jscontext.
... the
jscontext can be thought of as a machine that knows how to run javascript code, or as an abstraction of the notion of a thread.
... exception handling, for example, is per-
jscontext.
...And 3 more matches
nsIJSON
jsobject decode(in astring str); obsolete since gecko 7.0 jsval decodetojsval(in astring str, in
jscontext cx); native code only!
... jsobject decodefromstream(in nsiinputstream stream, in long contentlength); astring encode(in jsobject value); obsolete since gecko 7.0 astring encodefromjsval(in jsvaljsval value, in
jscontext cx); native code only!
... void encodetostream(in nsioutputstream stream, in string charset, in boolean writebom, in jsobject value); jsval legacydecode(in astring str); deprecated since gecko 2.0 jsval legacydecodefromstream(in astring str); deprecated since gecko 2.0 jsval legacydecodetojsval(in astring str, in
jscontext cx); native code only!
...And 3 more matches
JSAPI Cookbook
but in a jsnative the correct way to do this is: /* jsapi */ bool mynative(
jscontext *cx, unsigned argc, js::value *vp) { js::callargs args = js::callargsfromvp(argc, vp); jsobject *global = js_getglobalforobject(cx, &args.callee()); ...
... } defining a function // javascript function justforfun() { return null; } /* jsapi */ bool justforfun(
jscontext *cx, unsigned argc, js::value *vp) { js::callargs args = js::callargsfromvp(argc, vp); args.rval().setnull(); return true; } ...
... /* * add this to your
jscontext setup code.
...And 2 more matches
JS_ContextIterator
syntax
jscontext * js_contextiterator(jsruntime *rt,
jscontext **iterp); name type description rt jsruntime * the runtime to walk.
... iterp
jscontext * in-out parameter.
... iterp must point to a variable of type
jscontext *.
...And 2 more matches
XPIDL
the implicit_
jscontext and optional_argc parameters are properties which help native code implementations determine how the call was made from script.
... if implicit_
jscontext is present on a method, then an additional
jscontext *cx parameter is added just after the regular list which receives the context of the caller.
...note that if both properties are set, the
jscontext *cx is added first, followed by the uint8_t _argc, and then ending with return value parameter.
...And 2 more matches
Hacking Tips
t/bin/js ./foo.js […] spidermonkey unwinder is disabled by default, to enable it type: enable unwinder .* spidermonkey (gdb) b js::math_cos (gdb) run […] #0 js::math_cos (cx=0x14f2640, argc=1, vp=0x7fffffff6a88) at js/src/jsmath.cpp:338 338 callargs args = callargsfromvp(argc, vp); (gdb) enable unwinder .* spidermonkey (gdb) backtrace 10 #0 0x0000000000f89979 in js::math_cos(
jscontext*, unsigned int, js::value*) (cx=0x14f2640, argc=1, vp=0x7fffffff6a88) at js/src/jsmath.cpp:338 #1 0x0000000000ca9c6e in js::calljsnative(
jscontext*, bool (*)(
jscontext*, unsigned int, js::value*), js::callargs const&) (cx=0x14f2640, native=0xf89960 , args=...) at js/src/jscntxtinlines.h:235 #2 0x0000000000c87625 in js::invoke(
jscontext*, js::callargs const&, js::maybeconstruct) (cx=0x14f2640, a...
...rgs=..., construct=js::no_construct) at js/src/vm/interpreter.cpp:476 #3 0x000000000069bdcf in js::jit::docallfallback(
jscontext*, js::jit::baselineframe*, js::jit::iccall_fallback*, uint32_t, js::value*, js::mutablehandlevalue) (cx=0x14f2640, frame=0x7fffffff6ad8, stub_=0x1798838, argc=1, vp=0x7fffffff6a88, res=jsval_void) at js/src/jit/baselineic.cpp:6113 #4 0x00007ffff7f41395 in <<jitframe_exit>> () #5 0x00007ffff7f42223 in <<jitframe_baselinestub>> () #6 0x00007ffff7f4423d in <<jitframe_baselinejs>> () #7 0x00007ffff7f4222e in <<jitframe_baselinestub>> () #8 0x00007ffff7f4326a in <<jitframe_baselinejs>> () #9 0x00007ffff7f38d5f in <<jitframe_entry>> () #10 0x00000000006a86de in enterbaseline(
jscontext*, js::jit::enterjitdata&) (cx=0x14f2640, data=...) at js/src/jit/baselinejit.cpp:150 ...
...[new thread 0xf7903b40 (lwp 12563)] [new thread 0xf6bdeb40 (lwp 12564)] run#0 breakpoint 1, js::ion::codegenerator::link (this=0x86badf8) at /home/code/mozilla-central/js/src/ion/codegenerator.cpp:4780 4780 { (gdb) n 4781
jscontext *cx = getioncontext()->cx; (gdb) n 4783 linker linker(masm); (gdb) n 4784 ioncode *code = linker.newcode(cx, jsc::ion_code); (gdb) n 4785 if (!code) (gdb) p code->code_ $1 = (uint8_t *) 0xf7fd25a8 "\201", <incomplete sequence \354\200> (gdb) x/2i 0xf7fd25a8 0xf7fd25a8: sub $0x80,%esp 0xf7fd25ae: mov 0x94(%esp),%ecx on arm, the compiled js code will always...
... report oom to the context if you have one if a function has a
jscontext* argument, usually it should call js::reportoutofmemory(cx) on allocation failure to report this to the context.
JS::AutoSaveExceptionState
this article covers features introduced in spidermonkey 31 save and later restore the current exception state of a given
jscontext.
... syntax js::autosaveexceptionstate(
jscontext *cx); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
... description js::autosaveexceptionstate saves and later restores the current exception state of a given
jscontext.
JS::AutoValueArray
syntax js::autovaluearray<n> vp(cx); name type description cx
jscontext * the context in which to add the root.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
... bool somefunction1(
jscontext *cx, unsigned argc, const js::value *argv) { /* ...
... bool somefunction2(
jscontext *cx, const js::handlevaluearray &args) { /* ...
JS::Compile
syntax // added in spidermonkey 45 bool js::compile(
jscontext *cx, const js::readonlycompileoptions &options, js::sourcebufferholder &srcbuf, js::mutablehandlescript script); bool js::compile(
jscontext *cx, const js::readonlycompileoptions &options, const char *bytes, size_t length, js::mutablehandlescript script); bool js::compile(
jscontext *cx, const js::readonlycompileoptions &options, const char16_t *chars, size_t length, js::mutablehandlescript script); bool js::compile(
jscontext *cx, const js::readonlycompileoptions &options, file *file, js::mutablehandlescript script); bool js::compile(jscon...
...text *cx, const js::readonlycompileoptions &options, const char *filename, js::mutablehandlescript script); // obsolete since jsapi 39 bool js::compile(
jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, js::sourcebufferholder &srcbuf, js::mutablehandlescript script); bool js::compile(
jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, const char *bytes, size_t length, js::mutablehandlescript script); bool js::compile(
jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, const char16_t *chars, size_t length, js::mutablehandlescript script); bool js::compile(
jscontext *cx, js::handleobject obj, const js::rea...
...donlycompileoptions &options, file *file, js::mutablehandlescript script); bool js::compile(
jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, const char *filename, js::mutablehandlescript script); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::Evaluate
syntax // added in spidermonkey 45 bool js::evaluate(
jscontext *cx, const js::readonlycompileoptions &options, js::sourcebufferholder &srcbuf, js::mutablehandlevalue rval); bool js::evaluate(
jscontext *cx, const js::readonlycompileoptions &options, const char16_t *chars, size_t length, js::mutablehandlevalue rval); bool js::evaluate(
jscontext *cx, const js::readonlycompileoptions &options, const char *bytes, size_t length, js::mutablehandlevalue rval); bool js::evaluate(
jscontext *cx, const js::readonlycompileoptions &options, const char *filename, js::mutablehandlevalue rval); bool ...
...js::evaluate(
jscontext *cx, js::autoobjectvector &scopechain, const readonlycompileoptions &options, const char16_t *chars, size_t length, js::mutablehandlevalue rval); // added in spidermonkey 17 bool js::evaluate(
jscontext *cx, js::autoobjectvector &scopechain, const js::readonlycompileoptions &options, js::sourcebufferholder &srcbuf, js::mutablehandlevalue rval); // obsolete since jsapi 39 bool js::evaluate(
jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, js::sourcebufferholder &srcbuf, js::mutablehandlevalue rval); bool js::evaluate(
jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, const char16_t *chars, size_t length, js::muta...
...blehandlevalue rval); bool js::evaluate(
jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, const char *bytes, size_t length, js::mutablehandlevalue rval); bool js::evaluate(
jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, const char *filename, js::mutablehandlevalue rval); name type description cx
jscontext * the context in which to run the script.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JSAutoByteString
syntax jsautobytestring str; jsautobytestring(
jscontext *cx, jsstring *str); name type description cx
jscontext * the context in which to add the root.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
... char *encodelatin1(
jscontext *cx, jsstring *str) call js_encodestring and take ownership of the returned string, and return the string.
... char *encodeutf8(
jscontext *cx, js::handlestring str) call js_encodestringtoutf8 and take ownership of the returned string, and return the string.
JS_BeginRequest
syntax void js_beginrequest(
jscontext *cx); void js_endrequest(
jscontext *cx); name type description cx
jscontext * the context in which the calling thread intends to call jsapi functions.
... description when your multithreaded application wants to use a
jscontext, it must use js_beginrequest and js_endrequest to bracket maximal non-blocking hunks of native code that call the jsapi.
...in this reference, the cx parameter of such functions is documented with the phrase “requires request”, like this: name type description cx
jscontext * the context to use.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DefineElement
syntax /* added in spidermonkey 38 (jsapi 32) */ bool js_defineelement(
jscontext *cx, js::handleobject obj, uint32_t index, js::handlevalue value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineelement(
jscontext *cx, js::handleobject obj, uint32_t index, js::handleobject value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineelement(
jscontext *cx, js::handleobject obj, uint32_t index, js::handlestring value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineelement(
jscontext...
... *cx, js::handleobject obj, uint32_t index, int32_t value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineelement(
jscontext *cx, js::handleobject obj, uint32_t index, uint32_t value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_defineelement(
jscontext *cx, js::handleobject obj, uint32_t index, double value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); /* obsolete since jsapi 32 */ js_defineelement(
jscontext *cx, jsobject *obj, uint32_t index, jsval value, jspropertyop getter, jsstrictpropertyop setter, unsigned attrs); na...
...me type description cx
jscontext * the context in which to create the new property.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_EnterLocalRootScope
syntax jsbool js_enterlocalrootscope(
jscontext *cx); name type description cx
jscontext * pointer to the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
...calling js_enterlocalrootscope and js_leavelocalrootscope around the body of the native hook protects each object, double, and string created using the same
jscontext from gc.
... for example: jsbool my_getproperty(
jscontext *cx, jsobject *obj, jsval id, jsval *vp) { jsbool ok; if (!js_enterlocalrootscope(cx)) return js_false; // this function doesn't need to bother rooting any new objects, // strings, or doubles it creates using cx.
JS_SetFunctionCallback
syntax void js_setfunctioncallback(
jscontext *cx, jsfunctioncallback fcb); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
...ggers should probably use js_setcallhook in preference to this function, because it is invoked when the javascript stack is guaranteed to be in a consistent state (and therefore it is valid to inspect and modify local variables, generate stack traces, and set breakpoints.) callback syntax typedef void (* jsfunctioncallback)(const jsfunction *fun,const jsscript *scr, const
jscontext *cx, int entering); name type description fun const jsfunction * the javascript function being invoked or exited.
... cx
jscontext * the javascript context in which the script is being run.
nsIAppShellService
); void doprofilestartup(in nsicmdlineservice acmdlineservice, in boolean caninteract); obsolete since gecko 1.8 void ensure1window(in nsicmdlineservice acmdlineservice); obsolete since gecko 1.8 void enterlastwindowclosingsurvivalarea(); obsolete since gecko 1.8 void exitlastwindowclosingsurvivalarea(); obsolete since gecko 1.8 void gethiddenwindowand
jscontext(out nsidomwindow ahiddendomwindow, out
jscontext a
jscontext); native code only!
... native code only!gethiddenwindowand
jscontext return the (singleton) application hidden window as an nsidomwindow, and, the corresponding javascript context pointer.
... void gethiddenwindowand
jscontext( out nsidomwindow ahiddendomwindow, out
jscontext a
jscontext ); parameters ahiddendomwindow the hidden window queryinterface'd to type nsidomwindow.
... a
jscontext the corresponding javascript context.
Exact Stack Rooting
bool hello(
jscontext *cx, handleobject foo) { return hello(cx, foo); } .....
... void otherfunction(
jscontext *cx) { ...
... bool returnfoo(
jscontext *cx, mutablehandlestring out) { out.set(js_newstringcopyz(cx, "foo")); return bool(out); } size_t getlengthfoo(
jscontext *cx) { rootedstring s(cx); if (returnfoo(cx, &s)) return js_getstringlength(s); return size_t(-1); } all methods in the js-api that return gcpointers have been changed to this out-param style.
Invariants
most
jscontext pointers must point to live contexts, but jstitle::ownercx may point to one that has been destroyed!
...that is, they take a parameter cx of type
jscontext *, and require that cx is in a request on the current thread.
... "are we in a request on cx?", where cx is any variable of type
jscontext *, is a static yes for most lines of code where such a variable exists.
SpiderMonkey Internals
all state associated with an interpreter instance is passed through formal parameters to the interpreter entry point; most implicit state is collected in a type named
jscontext.
... therefore, almost all functions in spidermonkey, api or not, take a
jscontext pointer as their first argument.
...the
jscontext constructor and destructor are factored out into jscntxt.cpp for minimal linking when the compiler part of js is split from the interpreter part into a separate program.
JS::Add*Root
syntax bool js::addvalueroot(
jscontext *cx, js::heap<js::value> *vp); bool js::addstringroot(
jscontext *cx, js::heap<jsstring *> *rp); bool js::addobjectroot(
jscontext *cx, js::heap<jsobject *> *rp); bool js::addnamedvalueroot(
jscontext *cx, js::heap<js::value> *vp, const char *name); bool js::addnamedvaluerootrt(jsruntime *rt, js::heap<js::value> *vp, const char *name); bool js::addn...
...amedstringroot(
jscontext *cx, js::heap<jsstring *> *rp, const char *name); bool js::addnamedobjectroot(
jscontext *cx, js::heap<jsobject *> *rp, const char *name); bool js::addnamedscriptroot(
jscontext *cx, js::heap<jsscript *> *rp, const char *name); name type description cx
jscontext * the context in which to add the new root.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::Call
syntax bool js::call(
jscontext *cx, js::handleobject thisobj, js::handlefunction fun, const js::handlevaluearray &args, js::mutablehandlevalue rval); bool js::call(
jscontext *cx, js::handleobject thisobj, const char *name, const js::handlevaluearray& args, js::mutablehandlevalue rval); bool js::call(
jscontext *cx, js::handleobject thisobj, js::handlevalue fun, const js::handlevaluearray& args, js::mutablehandlevalue rval); bool js::call(
jscontext *cx, js::handlevalue thisv, js::handlevalue fun, const js::handlevaluearray& args, js::mutablehandlevalue rval); bool js::call(
jscontext *cx, js::handlevalue thisv, js::handleobject funobj, const js::handleva...
...luearray& args, js::mutablehandlevalue rval); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::CallArgs
(3nd argument of jsnative) methods methods of js::callargs method description bool requireatleast(
jscontext *cx, const char *fnname, unsigned required) returns true if there are at least required arguments passed in.
... js::value computethis(
jscontext *cx) const returns the this value if this is an object, otherwise calls js_computethis and returns it.
...the principal way to create a callargs is like so, using js::callargsfromvp: static bool functionreturningargctimesarg0(
jscontext *cx, unsigned argc, js::value *vp) { js::callargs args = js::callargsfromvp(argc, vp); // guard against no arguments or a non-numeric arg0.
JS::CompileFunction
syntax bool js::compilefunction(
jscontext *cx, js::autoobjectvector &scopechain, const js::readonlycompileoptions &options, const char *name, unsigned nargs, const char *const *argnames, const char16_t *chars, size_t length, js::mutablehandlefunction fun); bool js::compilefunction(
jscontext *cx, js::autoobjectvector &scopechain, const js::readonlycompileoptions &options, const char *name, unsigned nargs, const char *const *argnames, js::sourcebufferholder &srcbuf, js::mutablehandlefunction fun); bool js::compilefunction(
jscontext *cx, js::autoobjectvector &scop...
...echain, const js::readonlycompileoptions &options, const char *name, unsigned nargs, const char *const *argnames, const char *bytes, size_t length, js::mutablehandlefunction fun); name type description cx
jscontext * the context in which to compile the function.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::Remove*Root
syntax void removevalueroot(
jscontext *cx, js::heap<js::value> *vp); void removestringroot(
jscontext *cx, js::heap<jsstring *> *rp); void removeobjectroot(
jscontext *cx, js::heap<jsobject *> *rp); void removescriptroot(
jscontext *cx, js::heap<jsscript *> *rp); void removevaluerootrt(jsruntime *rt, js::heap<js::value> *vp); void removestringrootrt(jsruntime *rt, js::heap<jsstring *> *rp); void removeobjectrootrt(jsruntime *rt, j...
...s::heap<jsobject *> *rp); void removescriptrootrt(jsruntime *rt, js::heap<jsscript *> *rp); name type description cx
jscontext * the context from which to remove the root.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JSAutoCompartment
syntax jsautocompartment(
jscontext *cx, jsobject *target); jsautocompartment(
jscontext *cx, jsscript *target); name type description cx
jscontext * the context on which a cross-compartment call is needed.
... description every
jscontext has a current compartment.
...jsautocompartment guarantees that by automatically entering the given compartment and leaving it upon getting out of scope: void foo(
jscontext *cx, jobject *obj) { // in some compartment 'c' { jsautocompartment ac(cx, obj); // constructor enters // in the compartment of 'obj' } // destructor leaves // back in compartment 'c' } see also mxr id search for jsautocompartment bug 860050 bug 833817 bug 786068 ...
JSFreeOp
this article covers features introduced in spidermonkey 17 structure used during finalization instead of
jscontext.
... description various finalization api takes not
jscontext * but rather either jsfreeop structure or its library-private counterpart freeop.
... these structures wrap parameters that are passed to the finalizers removing most of explicit dependencies on
jscontext in the finalization code.
JSPrincipals
obsolete since jsapi 13 getprincipalarray void * (*)(
jscontext *, jsprincipals *) pointer to the function that returns an array of principal definitions.
... obsolete since jsapi 12 globalprivilegesenabled jsbool (*)(
jscontext *, jsprincipals *) flag indicating whether principals are enabled globally.
... obsolete since jsapi 12 destroy void (*)(
jscontext *, jsprincipals *) pointer to the function that decrements the reference count and possibly frees the principals if they are no longer in use.
JS_Add*Root
syntax jsbool js_addvalueroot(
jscontext *cx, jsval *vp); jsbool js_addstringroot(
jscontext *cx, jsstring **spp); jsbool js_addobjectroot(
jscontext *cx, jsobject **opp); jsbool js_addgcthingroot(
jscontext *cx, void **rp); jsbool js_addnamedvalueroot(
jscontext *cx, jsval *vp, const char *name); jsbool js_addnamedstringroot(
jscontext *cx, jsstring **spp, const char *name); jsbool js_addnamedobjectroot(
jscontext *cx, jsobject **opp, const...
... char *name); jsbool js_addnamedgcthingroot(
jscontext *cx, void **rp, const char *name); name type description cx
jscontext * the context in which to add the new root.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CallFunction
syntax /* added in spidermonkey 31 */ bool js_callfunction(
jscontext *cx, js::handleobject obj, js::handlefunction fun, const js::handlevaluearray& args, js::mutablehandlevalue rval); bool js_callfunctionname(
jscontext *cx, js::handleobject obj, const char *name, const js::handlevaluearray& args, js::mutablehandlevalue rval); bool js_callfunctionvalue(
jscontext *cx, js::handleobject obj, js::handlevalue fval, const js::handlevaluearray& args, js::mutablehandlevalue rval); /* obsolete since jsapi 30 */ bool js_callfunction(
jscontext *cx, jsobject *obj, jsfunction *fun, unsigned argc, jsval *argv, jsval *rval); bool js_callfunctionname(
jscontext *cx, jsobject *obj, const cha...
...r *name, unsigned argc, jsval *argv, jsval *rval); bool js_callfunctionvalue(
jscontext *cx, jsobject *obj, jsval fval, unsigned argc, jsval *argv, jsval *rval); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CompileFunctionForPrincipals
syntax jsfunction * js_compilefunctionforprincipals(
jscontext *cx, jsobject *obj, jsprincipals *principals, const char *name, unsigned int nargs, const char **argnames, const char *body, size_t length, const char *filename, unsigned int lineno); jsfunction * js_compileucfunctionforprincipals(
jscontext *cx, jsobject *obj, jsprincipals *principals, const char *name, unsigned int nargs, const char **argnames, const jschar *body, size_t length, const char *filename, unsigned int lineno); name type description cx...
...
jscontext * the context in which to compile the function.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CompileScript
syntax // added in spidermonkey 45 bool js_compilescript(
jscontext *cx, const char *ascii, size_t length, const js::compileoptions &options, js::mutablehandlescript script); bool js_compileucscript(
jscontext *cx, const char16_t *chars, size_t length, const js::compileoptions &options, js::mutablehandlescript script); // obsolete since jsapi 39 bool js_compilescript(
jscontext *cx, js::handleobject obj, const char *ascii, size_t length, const js::compileoptions &options, js::mutablehandlescript script); bool js_compileucscript(
jscontext *cx, js::handleobject obj, const char16_t *char...
...s, size_t length, const js::compileoptions &options, js::mutablehandlescript script); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CompileScriptForPrincipals
syntax jsscript * js_compilescriptforprincipals(
jscontext *cx, jsobject *obj, jsprincipals *principals, const char *src, size_t length, const char *filename, unsigned int lineno); jsscript * js_compileucscriptforprincipals(
jscontext *cx, jsobject *obj, jsprincipals *principals, const jschar *src, size_t length, const char *filename, unsigned int lineno); jsobject * js_compilescriptforprincipalsversion(
jscontext *cx, jsobject *obj, jsprincipals *principals, const char *src, size_t length, const char *filename, unsigned int lineno, jsversion v...
...ersion); // obsoleted since jsapi 19 jsobject * js_compileucscriptforprincipalsversion(
jscontext *cx, jsobject *obj, jsprincipals *principals, const jschar *src, size_t length, const char *filename, unsigned int lineno, jsversion version); // obsoleted since jsapi 19 name type description cx
jscontext * the context in which to compile the script.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DefineFunctions
syntax bool js_definefunctions(
jscontext *cx, js::handle<jsobject*> obj, const jsfunctionspec *fs, propertydefinitionbehavior behavior = defineallproperties); in spidermonkey versions prior to spidermonkey 24, fs was not const.
... name type description cx
jscontext * the context in which to define functions.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_EvaluateScriptForPrincipals
syntax jsbool js_evaluatescriptforprincipals(
jscontext *cx, jsobject *obj, jsprincipals *principals, const char *src, unsigned int length, const char *filename, unsigned int lineno, jsval *rval); jsbool js_evaluatescriptucforprincipals(
jscontext *cx, jsobject *obj, jsprincipals *principals, const jschar *src, unsigned int length, const char *filename, unsigned int lineno, jsval *rval); jsbool js_evaluatescriptforprincipalsversion(
jscontext *cx, jsobject *obj, jsprincipals *principals, const char *bytes, unsigned int length, const char...
... *filename, unsigned int lineno, jsval *rval, jsversion version); jsbool js_evaluateucscriptforprincipalsversion(
jscontext *cx, jsobject *obj, jsprincipals *principals, const jschar *chars, unsigned int length, const char *filename, unsigned int lineno, jsval *rval, jsversion version); name type description cx
jscontext * the context in which to run the script.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ExecuteScript
syntax bool js_executescript(
jscontext *cx, js::handlescript script, js::mutablehandlevalue rval); // added in spidermonkey 45 bool js_executescript(
jscontext *cx, js::handlescript script); // added in spidermonkey 45 bool js_executescript(
jscontext *cx, js::autoobjectvector &scopechain, js::handlescript script, js::mutablehandlevalue rval); // added in spidermonkey 36 bool js_executescript(
jscontext *cx, js::autoobjectvector &scopechain, js::handlescript script); // added in spidermonkey 36 bool js_executescript(
jscontext *cx, js::handleobject obj, js::handlescript script, js::mutablehandlevalue rval); // obsolete since jsapi 39 bool js_executescript(
jscontext *cx, js::handleobject obj, js::han...
...dlescript script); // obsolete since jsapi 39 bool js::cloneandexecutescript(
jscontext *cx, js::handle<jsscript*> script); // added in spidermonkey 45 bool js::cloneandexecutescript(
jscontext *cx, js::handle<jsobject*> obj, js::handle<jsscript*> script); // added in spidermonkey 31, obsoleted since jsapi 39 name type description cx
jscontext * the context in which to execute the script.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetContextPrivate
access a
jscontext field for application-specific data.
... syntax void * js_getcontextprivate(
jscontext *cx); void js_setcontextprivate(
jscontext *cx, void *data); void * js_getsecondcontextprivate(
jscontext *cx); // added in spidermonkey 17 void js_setsecondcontextprivate(
jscontext *cx, void *data); // added in spidermonkey 17 name type description cx
jscontext * any context.
... description each
jscontext has two fields of type void * which the application may use for any purpose.
JS_GetGCParameter
syntax uint32_t js_getgcparameter(jsruntime *rt, jsgcparamkey key); void js_setgcparameter(jsruntime *rt, jsgcparamkey key, uint32_t value); uint32_t js_getgcparameterforthread(
jscontext *cx, jsgcparamkey key); // added in spidermonkeysidebar 17 void js_setgcparameterforthread(
jscontext *cx, jsgcparamkey key, uint32_t value); // added in spidermonkeysidebar 17 name type description rt jsruntime * the runtime to configure.
... cx
jscontext * the context to configure.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetLocaleCallbacks
syntax jslocalecallbacks * js_getlocalecallbacks(jsruntime *rt); void js_setlocalecallbacks(jsruntime *rt, jslocalecallbacks *callbacks); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
... callback functions struct jslocalecallbacks { jslocaletouppercase localetouppercase; jslocaletolowercase localetolowercase; jslocalecompare localecompare; // not used #if expose_intl_api jslocaletounicode localetounicode; }; typedef bool (* jslocaletouppercase)(
jscontext *cx, js::handlestring src, js::mutablehandlevalue rval); typedef bool (* jslocaletolowercase)(
jscontext *cx, js::handlestring src, js::mutablehandlevalue rval); typedef bool (* jslocalecompare)(
jscontext *cx, js::handlestring src1, js::handlestring src2, js::mutablehandlevalue rval); typedef bool (* jslocaletounicode)(
jscontext *cx, const char *src, js::mutablehandlevalue rval); ...
JS_GetPendingException
get the current pending exception for a given
jscontext.
... syntax bool js_getpendingexception(
jscontext *cx, js::mutablehandlevalue vp); name type description cx
jscontext * pointer to the js context in which the exception was thrown.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetPropertyAttrsGetterAndSetter
syntax jsbool js_getpropertyattrsgetterandsetter(
jscontext *cx, jsobject *obj, const char *name, unsigned int *attrsp, jsbool *foundp, jspropertyop *getterp, jspropertyop *setterp); jsbool js_getucpropertyattrsgetterandsetter(
jscontext *cx, jsobject *obj, const jschar *name, size_t namelen, unsigned int *attrsp, jsbool *foundp, jspropertyop *getterp, jspropertyop *setterp); jsbool js_getpropertyattrsgetterandsetterbyid(
jscontext *cx, jsobject *obj, jsid id, unsigned int *attrsp, jsbool *foundp, jspropertyop *getterp, ...
...jspropertyop *setterp); // added in spidermonkey 1.8.1 name type description cx
jscontext * the context in which to perform the property lookup.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_IsConstructing_PossiblyWithGivenThisObject
syntax static jsbool js_isconstructing_possiblywithgiventhisobject(
jscontext *cx, const jsval *vp, jsobject **maybethis); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
... jsbool foo_native(
jscontext *cx, unsigned int argc, jsval *vp) { jsobject *maybethis; if (js_isconstructing_possiblywithgiventhisobject(cx, vp, &maybethis)) { // native called as a constructor if (maybethis) // native called as a constructor with maybethis as 'this' } else { // native called as function, maybethis is still uninitialized } } note: a spidermonkey embedding does not need to use this q...
JS_LeaveLocalRootScopeWithResult
syntax void js_leavelocalrootscopewithresult(
jscontext *cx, jsval rval); name type description cx
jscontext * pointer to the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
...otherwise, the value is stored in an internal per-
jscontext slot.
JS_LookupProperty
syntax bool js_lookupproperty(
jscontext *cx, js::handleobject obj, const char *name, js::mutablehandlevalue vp); bool js_lookupucproperty(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, js::mutablehandlevalue vp); bool js_lookuppropertybyid(
jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandlevalue vp); // added in spidermonkey 1.8.1 bool js_lookupelement(
jscontext *cx, js::handleobject obj, uint32_t index, js::mutablehandlevalue vp);...
... // ---- obsolete since spidermonkey 31 ---- bool js_lookuppropertywithflags(
jscontext *cx, js::handleobject obj, const char *name, unsigned flags, js::mutablehandlevalue vp); bool js_lookuppropertywithflagsbyid(
jscontext *cx, js::handleobject obj, js::handleid id, unsigned flags, js::mutablehandleobject objp, js::mutablehandlevalue vp); // added in spidermonkey 1.8.1 name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewFunction
syntax // added in spidermonkey 45 jsfunction * js_newfunction(
jscontext *cx, jsnative call, unsigned nargs, unsigned flags, const char *name); // obsolete since jsapi 44 jsfunction * js_newfunctionbyid(
jscontext *cx, jsnative call, unsigned nargs, unsigned flags, js::handle<jsid> id); // obsolete since jsapi 39 jsfunction * js_newfunction(
jscontext *cx, jsnative call, unsigned nargs, unsigned flags, js::handle<jsobject*> parent, const char *name); jsfunction * js_newfunctionbyid(
jscontext *cx, jsnative call, unsigned nargs, unsigned flags, js::handle<jsobject*> parent, js::handle<jsid> id); // added in spidermonkey 17 name type ...
... description cx
jscontext * the context in which to create the new function.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ReportErrorNumber
syntax void js_reporterrornumber(
jscontext *cx, jserrorcallback errorcallback, void *userref, const unsigned errornumber, ...); void js_reporterrornumberuc(
jscontext *cx, jserrorcallback errorcallback, void *userref, const unsigned errornumber, ...); bool js_reporterrorflagsandnumber(
jscontext *cx, unsigned flags, jserrorcallback errorcallback, void *userref, const unsigned errornumber, ...); bool js_reporterrorflagsandnumberuc(
jscontext *cx, unsigned flags, jserrorcallback errorcallback, void *userref, const unsigned errornumber, ...); void js_reporterrornumberucarr...
...ay(
jscontext *cx, jserrorcallback errorcallback, void *userref, const unsigned errornumber, const char16_t **args); // added in spidermonkey 19 name type description cx
jscontext * the context in which to report the error.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ReportPendingException
forward the current pending exception in a given
jscontext to the current jserrorreporter callback.
... syntax bool js_reportpendingexception(
jscontext *cx); name type description cx
jscontext * the context in which the exception was thrown.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SetElement
syntax /* added in spidermonkey 31 */ bool js_setelement(
jscontext *cx, js::handleobject obj, uint32_t index, js::handlevalue v); bool js_setelement(
jscontext *cx, js::handleobject obj, uint32_t index, js::handleobject v); bool js_setelement(
jscontext *cx, js::handleobject obj, uint32_t index, js::handlestring v); bool js_setelement(
jscontext *cx, js::handleobject obj, uint32_t index, int32_t v); bool js_setelement(
jscontext *cx, js::handleobject obj, uint32_t index, uint32_t v); bool js_setelement(
jscontext *cx, js::handleobject obj, uint32_t index, double v); /* obsolete since jsapi 29 */ bool js_setelement(
jscontext *cx, js::handleobject obj,...
... uint32_t index, js::mutablehandlevalue vp); name type description cx
jscontext * the context in which to set the element.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SetOptions
enables and disables options on a
jscontext, replacing all previously set options.
... syntax uint32 js_setoptions(
jscontext *cx, uint32 options); name type description cx
jscontext * a context on which to set options.
...the application must ensure that the global object survives as long as the
jscontext.
JS_SetPendingException
syntax void js_setpendingexception(
jscontext *cx, js::handlevalue v); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
...each
jscontext's pending-exception field is a gc root.
NPN_SetValue - Archive of obsolete content
owbool: sets windowed/windowless mode for plugin display; true=windowed, false=windowless nppvplugintransparentbool: sets transparent mode for display of a plugin; true=transparent, false=opaque nppvjavaclass nppvpluginwindowsize nppvplugintimerinterval nppvpluginscriptableinstance nppvpluginscriptableiid nppvjavascriptpushcallerbool: specifies whether you are pushing or popping the
jscontext off the stack nppvpluginkeeplibraryinmemory: tells browser that the plugin dll should live longer than usual nppvpluginneedsxembed nppvpluginscriptablenpobject nppvformvalue nppvplugindrawingmodel value the value of the specified variable to be set.
... nppvjavascriptpushcallerbool sets whether you are pushing or popping the appropriate
jscontext off the stack (see the two-way scriptability article on the mozilla plugins project page for more details).
Adding a new event
when you need to check if the caller content or chrome, you can use implicit
jscontext attribute in dom/bindings/bindings.conf.
... then, the method can have a pointer of
jscontext in its argument.
JS::AutoIdArray
syntax autoidarray(
jscontext *cx, jsidarray *ida); name type description cx
jscontext * the context in which to add the root.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::CloneFunctionObject
syntax jsobject * js::clonefunctionobject(
jscontext *cx, js::handleobject funobj); jsobject * js::clonefunctionobject(
jscontext *cx, js::handleobject funobj, js::autoobjectvector &scopechain); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::CompileOffThread
syntax bool js::cancompileoffthread(
jscontext *cx, const js::readonlycompileoptions &options, size_t length); bool js::compileoffthread(
jscontext *cx, const js::readonlycompileoptions &options, const char16_t *chars, size_t length, js::offthreadcompilecallback callback, void *callbackdata); jsscript * js::finishoffthreadscript(
jscontext *maybecx, jsruntime *rt, void *token); typedef void (*js::offthreadcompilecallback)(void *token, void *callbackdata); name type description cx / maybe
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::Construct
syntax bool js::construct(
jscontext *cx, js::handlevalue fun, const js::handlevaluearray& args, js::mutablehandlevalue rval); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::CreateError
syntax // added in spidermonkey 45 bool js::createerror(
jscontext *cx, jsexntype type, handleobject stack, handlestring filename, uint32_t linenumber, uint32_t columnnumber, jserrorreport *report, handlestring message, mutablehandlevalue rval); // obsolete since jsapi 39 bool js::createerror(
jscontext *cx, jsexntype type, handlestring stack, handlestring filename, uint32_t linenumber, uint32_t columnnumber, jserrorreport *report, handlestring message, mutablehandlevalue rval); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::CurrentGlobalOrNull
syntax jsobject * js::currentglobalornull(
jscontext *cx); name type description cx
jscontext * the context for which to return the global object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::GetFirstArgumentAsTypeHint
syntax bool js::getfirstargumentastypehint(
jscontext* cx, callargs args, jstype *result); name type description cx
jscontext * the context in which to define functions.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::GetSelfHostedFunction
syntax jsfunction* js::getselfhostedfunction(
jscontext* cx, const char* selfhostedname, js::handle<jsid> id, unsigned nargs); name type description cx
jscontext* the context from which to get the function.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::NewFunctionFromSpec
syntax jsfunction* js::newfunctionfromspec(
jscontext* cx, const jsfunctionspec* fs, handleid id); name type description cx
jscontext * the context in which to define functions.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::OrdinaryToPrimitive
syntax bool js::ordinarytoprimitive(
jscontext *cx, js::handleobject obj, jstype type, js::mutablehandlevalue vp); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::PropertySpecNameToPermanentId
syntax bool js::propertyspecnametopermanentid(
jscontext *cx, const char *name, jsid *idp); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::ProtoKeyToId
syntax void js::protokeytoid(
jscontext *cx, jsprotokey key, js::mutablehandleid idp); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::Rooted
syntax js::rooted<t> var(cx); js::rooted<t> var(cx, initial); js::rooted<t> var(rt); js::rooted<t> var(rt, initial); name type description cx
jscontext * the context in which to add the root.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::ToInt32
syntax bool js::toint32(
jscontext *cx, js::handlevalue v, int32_t *out); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::ToInt64
syntax bool js::toint64(
jscontext *cx, js::handlevalue v, int64_t *out); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::ToNumber
syntax bool js::tonumber(
jscontext *cx, js::handlevalue v, double *out); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::ToPrimitive
syntax bool js::toprimitive(
jscontext *cx, js::handleobject obj, jstype hint, js::mutablehandlevalue vp); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::ToString
syntax #include "js/conversions.h" // as of spidermonkey 38; previously in jsapi.h jsstring* js::tostring(
jscontext *cx, js::handlevalue v) name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::ToUint16
syntax bool js::touint16(
jscontext *cx, js::handlevalue v, uint16_t *out); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::ToUint32
syntax bool js::touint32(
jscontext *cx, js::handlevalue v, int32_t *out); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS::ToUint64
syntax bool js::touint64(
jscontext *cx, js::handlevalue v, uint64_t *out); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JSClass
the javascript engine never touches the private data; it is for the application's use only.) void printer_finalize(
jscontext *cx, jsobject *obj) { myprinter *p = (myprinter *) js_getprivate(cx, obj); delete p; } static jsclass printer_class = { "printer", jsclass_has_private, null, null, null, null, null, null, null, printer_finalize }; /* spidermonkey 31 or older * static jsclass printer_class = { * "printer", * jsclass_has_private, * js_propertystub, js_propertystub, js_prope...
...rtystub, js_strictpropertystub, * js_enumeratestub, js_resolvestub, js_convertstub, printer_finalize, * jsclass_no_optional_members * }; */ bool printer_construct(
jscontext *cx, unsigned argc, jsval *vp) { js::callargs args = js::callargsfromvp(argc, vp); jsobject *obj = js_newobjectforconstructor(cx, &printer_class, args); /* spidermonkey 31 or older * jsobject *obj = js_newobjectforconstructor(cx, &printer_class, vp); */ if (!obj) return false; myprinter *p = new myprinter; if (p == null) { js_reportoutofmemory(cx); return false; } js_setprivate(cx, obj, p); args.rval().setobject(*obj); /* spidermonkey 31 or older * js_set_rval(cx, vp, object_to_jsval(obj)); */ return true; } { js_initclass(c...
JSID_IS_STRING
syntax bool jsid_is_string(jsid id); jsstring * jsid_to_string(jsid id); jsid interned_string_to_jsid(
jscontext *cx, jsstring *str); // added in spidermonkey 38 jsflatstring * jsid_to_flat_string(jsid id); // added in spidermonkey 17 name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_AddArgumentFormatter
syntax jsbool js_addargumentformatter(
jscontext *cx, const char *format, jsargumentformatter formatter); void js_removeargumentformatter(
jscontext *cx, const char *format); name type description cx
jscontext * the context in which to install the formatter.
...callback syntax jsbool (*jsargumentformatter)(
jscontext *cx, const char *format, jsbool fromjs, jsval **vpp, va_list *app); name type description cx
jscontext * the context in which the conversion is being performed.
JS_AliasElement
syntax jsbool js_aliaselement(
jscontext *cx, jsobject *obj, const char *name, jsint alias); name type description cx
jscontext * the context in which to create the alias.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_AliasProperty
syntax jsbool js_aliasproperty(
jscontext *cx, jsobject *obj, const char *name, const char *alias); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_AlreadyHasOwnProperty
syntax boo js_alreadyhasownproperty(
jscontext *cx, js::handleobject obj, const char *name, bool *foundp); boo js_alreadyhasownucproperty(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, bool *foundp); boo js_alreadyhasownpropertybyid(
jscontext *cx, js::handleobject obj, js::handleid id, bool *foundp); // added in spidermonkey 1.8.1 boo js_alreadyhasownelement(
jscontext *cx, js::handleobject obj, uint32_t index, bool *foundp); name type description cx
jscontext * pointer to a js context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_BindCallable
syntax jsobject* js_bindcallable(
jscontext *cx, js::handle<jsobject*> callable, js::handle<jsobject*> newthis); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_BufferIsCompilableUnit
syntax bool js_bufferiscompilableunit(
jscontext *cx, js::handle<jsobject*> obj, const char *utf8, size_t length); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CheckAccess
syntax jsbool js_checkaccess(
jscontext *cx, jsobject *obj, jsid id, jsaccessmode mode, jsval *vp, unsigned int *attrsp); name type description cx
jscontext * the context in which to perform the access check.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ClearDateCaches
syntax void js_cleardatecaches(
jscontext *cx); name type description cx
jscontext * pointer to a javascript context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ClearNonGlobalObject
syntax void js_clearnonglobalobject(
jscontext *cx, jsobject *obj); name type description cx
jscontext * the context in which to clear the object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ClearPendingException
syntax void js_clearpendingexception(
jscontext *cx); name type description cx
jscontext * the context in which the exception was thrown.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ClearRegExpStatics
syntax bool js_clearregexpstatics(
jscontext *cx, handleobject obj); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ClearScope
syntax void js_clearscope(
jscontext *cx, jsobject *obj); name type description cx
jscontext * the context in which to clear the object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CloneFunctionObject
syntax jsobject * js_clonefunctionobject(
jscontext *cx, jsobject *funobj, jsobject *parent); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CompileFileHandleForPrincipals
syntax jsobject * js_compilefilehandleforprincipals(
jscontext *cx, jsobject *obj, const char *filename, file *fh, jsprincipals *principals); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CompileFileHandleForPrincipalsVersion
syntax jsobject * js_compilefilehandleforprincipalsversion(
jscontext *cx, jsobject *obj, const char *filename, file *fh, jsprincipals *principals, jsversion version); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CompileFunction
syntax jsfunction * js_compilefunction(
jscontext *cx, jsobject *obj, const char *name, unsigned int nargs, const char **argnames, const char *body, size_t length, const char *filename, unsigned int lineno); jsfunction * js_compileucfunction(
jscontext *cx, jsobject *obj, const char *name, unsigned int nargs, const char **argnames, const jschar *body, size_t length, const char *filename, unsigned int lineno); name type description cx
jscontext * the context in which to compile the function.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CompileUCFunctionForPrincipalsVersion
syntax jsfunction * js_compileucfunctionforprincipalsversion(
jscontext *cx, jsobject *obj, jsprincipals *principals, const char *name, unsigned int nargs, const char **argnames, const jschar *chars, size_t length, const char *filename, unsigned int lineno, jsversion version); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CompileUTF8File
syntax jsobject * js_compileutf8file(
jscontext *cx, jsobject *obj, const char *filename); name type description cx
jscontext * the context in which to compile the script.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_CompileUTF8FileHandle
syntax jsobject * js_compileutf8filehandle(
jscontext *cx, jsobject *obj, const char *filename, file *file); jsobject * js_compileutf8filehandleforprincipals(
jscontext *cx, jsobject *obj, const char *filename, file *file, jsprincipals *principals); name type description cx
jscontext * the context in which to compile the script.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ConstructObject
syntax jsobject * js_constructobject(
jscontext *cx, jsclass *clasp, jsobject *proto, jsobject *parent); jsobject * js_constructobjectwitharguments(
jscontext *cx, jsclass *clasp, jsobject *proto, jsobject *parent, unsigned int argc, jsval *argv); name type description cx
jscontext * the context in which to create the new object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ConvertArguments
syntax bool js_convertarguments(
jscontext *cx, const js::callargs &args, const char *format, ...); // added in spidermonkey 31 bool js_convertarguments(
jscontext *cx, unsigned argc, jsval *argv, const char *format, ...); // obsolete since jsapi 30 name type description cx
jscontext * the context in which to perform any necessary conversions.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ConvertArgumentsVA
syntax bool js_convertargumentsva(
jscontext *cx, const js::callargs &args, const char *format, va_list ap); bool js_convertargumentsva(
jscontext *cx, unsigned argc, jsval *argv, const char *format, va_list ap); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ConvertValue
syntax bool js_convertvalue(
jscontext *cx, js::handlevalue v, jstype type, js::mutablehandlevalue vp); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DecompileFunction
syntax jsstring * js_decompilefunction(
jscontext *cx, js::handle<jsfunction*> fun); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DecompileFunctionBody
syntax jsstring * js_decompilefunctionbody(
jscontext *cx, js::handle<jsfunction*> fun, unsigned indent); name type description cx
jscontext * the context in which to decompile the function.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DecompileScript
syntax jsstring * js_decompilescript(
jscontext *cx, js::handle<jsscript*> script); name type description cx
jscontext * the context to use to decompile the script.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DecompileScriptObject
syntax jsstring * js_decompilescriptobject(
jscontext *cx, jsobject *scriptobj, const char *name, unsigned int indent); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DeepFreezeObject
syntax bool js_deepfreezeobject(
jscontext *cx, js::handle<jsobject*> obj); name type description cx jsruntime * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DefaultValue
syntax bool js_defaultvalue(
jscontext *cx, js::handle<jsobject*> obj, jstype hint, js::mutablehandle<js::value> vp); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DefineConstDoubles
syntax bool js_defineconstdoubles(
jscontext *cx, js::handleobject obj, const jsconstdoublespec *cds); bool js_defineconstintegers(
jscontext *cx, js::handleobject obj, const jsconstintegerspec *cis); // added in spidermonkey 38 name type description cx
jscontext * the context in which to define the new properties.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DefineFunction
syntax jsfunction * js_definefunction(
jscontext *cx, js::handle<jsobject*> obj, const char *name, jsnative call, unsigned nargs, unsigned attrs); jsfunction * js_defineucfunction(
jscontext *cx, js::handle<jsobject*> obj, const char16_t *name, size_t namelen, jsnative call, unsigned nargs, unsigned attrs); jsfunction * js_definefunctionbyid(
jscontext *cx, js::handle<jsobject*> obj, js::handle<jsid> id, jsnative call, unsigned nargs, unsigned attrs); // added in spidermonkey 17 name type description cx
jscontext * the context in which to define the function.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DefineObject
syntax jsobject * js_defineobject(
jscontext *cx, js::handleobject obj, const char *name, const jsclass *clasp = nullptr, unsigned attrs = 0); name type description cx
jscontext * the context in which to create the new object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DefineOwnProperty
syntax bool js_defineownproperty(
jscontext *cx, js::handleobject obj, js::handleid id, js::handlevalue descriptor, bool *bp); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DefineProperties
syntax bool js_defineproperties(
jscontext *cx, js::handleobject obj, const jspropertyspec *ps); name type description cx
jscontext * the context in which to define the properties.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DefinePropertyWithTinyId
syntax jsbool js_definepropertywithtinyid(
jscontext *cx, jsobject *obj, const char *name, int8 tinyid, jsval value, jspropertyop getter, jspropertyop setter, unsigned int attrs); jsbool js_defineucpropertywithtinyid(
jscontext *cx, jsobject *obj, const jschar *name, size_t namelen, int8 tinyid, jsval value, jspropertyop getter, jspropertyop setter, unsigned int attrs); name type description cx
jscontext * the context in which to define the property.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DeleteElement
syntax bool js_deleteelement(
jscontext *cx, js::handleobject obj, uint32_t index); // added in spidermonkey 45 bool js_deleteelement(
jscontext *cx, js::handleobject obj, uint32_t index, js::objectopresult &result); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DeleteElement2
renamed to js_deleteelement in jsapi 39 syntax bool js_deleteelement2(
jscontext *cx, js::handleobject obj, uint32_t index, bool *succeeded); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DeleteProperty
syntax bool js_deleteproperty(
jscontext *cx, js::handleobject obj, const char *name); bool js_deletepropertybyid(
jscontext *cx, js::handleobject obj, jsid id); // added in spidermonkey 1.8.1 // added in spidermonkey 45 bool js_deleteproperty(
jscontext *cx, js::handleobject obj, const char *name, js::objectopresult &result); bool js_deletepropertybyid(
jscontext *cx, js::handleobject obj, js::handleid id, js::objectopresult &result); bool js_deleteucproperty(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, js::objectopresult &result); name type description cx
jscontext * pointer to a js context from which to derive runtime inform...
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DeleteProperty2
syntax bool js_deleteproperty2(
jscontext *cx, js::handleobject obj, const char *name, bool *succeeded); bool js_deleteucproperty2(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, bool *succeeded); bool js_deletepropertybyid2(
jscontext *cx, js::handleobject obj, js::handleid id, bool *succeeded); // added in spidermonkey 1.8.1 name type description cx
jscontext * pointer to a js context from which to d...
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DestroyContext
destroy a
jscontext.
... syntax void js_destroycontext(
jscontext *cx); void js_destroycontextnogc(
jscontext *cx); void js_destroycontextmaybegc(
jscontext *cx); // obsolete since jsapi 14 name type description cx
jscontext * the context to destroy.
JS_DestroyScript
syntax void js_destroyscript(
jscontext *cx, jsscript *script); name type description cx
jscontext * the context in which to destroy the script.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DropExceptionState
syntax void js_dropexceptionstate(
jscontext *cx, jsexceptionstate *state); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_DumpHeap
syntax bool js_dumpheap(jsruntime *rt, file *fp, void* startthing, jsgctracekind kind, void *thingtofind, size_t maxdepth, void *thingtoignore); name type description cx
jscontext * pointer to a js context.
... every
jscontext is permanently associated with a jsruntime; each jsruntime contains a gc heap.
JS_EncodeString
syntax char * js_encodestring(
jscontext *cx, jsstring *str); char * js_encodestringtoutf8(
jscontext *cx, js::handlestring str); // added in spidermonkey 24 name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext..
JS_EncodeStringToBuffer
syntax size_t js_encodestringtobuffer(
jscontext *cx, jsstring *str, char *buffer, size_t length); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_EnterCompartment
syntax jscompartment * js_entercompartment(
jscontext *cx, jsobject *target); name type description cx
jscontext * the context on which a cross-compartment call is needed.
... description every
jscontext has a current compartment.
JS_EnterCrossCompartmentCall
syntax jscrosscompartmentcall * js_entercrosscompartmentcall(
jscontext *cx, jsobject *target); name type description cx
jscontext * the context on which a cross-compartment call is needed.
... description every
jscontext has a current compartment.
JS_Enumerate
syntax jsidarray * js_enumerate(
jscontext *cx, js::handleobject obj); name type description cx
jscontext * the context in which to enumerate object properties.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_EnumerateStandardClasses
syntax bool js_enumeratestandardclasses(
jscontext *cx, js::handleobject obj); name type description cx
jscontext * pointer to the executable script context for which to initialize js function and object classes.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_EvaluateScript
syntax jsbool js_evaluatescript(
jscontext *cx, jsobject *obj, const char *src, unsigned int length, const char *filename, unsigned int lineno, jsval *rval); jsbool js_evaluateucscript(
jscontext *cx, jsobject *obj, const jschar *src, unsigned int length, const char *filename, unsigned int lineno, jsval *rval); name type description cx
jscontext * the context in which to run the script.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ExecuteRegExp
syntax bool js_executeregexp(
jscontext *cx, js::handleobject obj, js::handleobject reobj, char16_t *chars, size_t length, size_t *indexp, bool test, js::mutablehandlevalue rval); bool js_executeregexpnostatics(
jscontext *cx, js::handleobject reobj, char16_t *chars, size_t length, size_t *indexp, bool test, js::mutablehandlevalue rval); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ExecuteScriptPart
syntax typedef enum jsexecpart { jsexec_prolog, jsexec_main } jsexecpart; jsbool js_executescriptpart(
jscontext *cx, jsobject *obj, jsscript *script, jsexecpart part, jsval *rval); name type description cx
jscontext * the context in which to execute the script.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ExecuteScriptVersion
syntax jsbool js_executescriptversion(
jscontext *cx, jsobject *obj, jsobject *scriptobj, jsval *rval, jsversion version); name type description cx
jscontext * the context in which to execute the script.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_FlattenString
syntax jsflatstring * js_flattenstring(
jscontext *cx, jsstring *str); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_FlushCaches
syntax void js_flushcaches(
jscontext *cx); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ForgetLocalRoot
syntax void js_forgetlocalroot(
jscontext *cx, void *thing); name type description cx
jscontext * pointer to the context in which the caller is running.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ForwardGetPropertyTo
syntax bool js_forwardgetpropertyto(
jscontext *cx, js::handleobject obj, js::handleid id, js::handleobject onbehalfof, js::mutablehandlevalue vp); bool js_forwardgetelementto(
jscontext *cx, js::handleobject obj, uint32_t index, js::handleobject onbehalfof, js::mutablehandlevalue vp); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_FreezeObject
syntax bool js_freezeobject(
jscontext *cx, js::handle<jsobject*> obj); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GC
syntax void js_gc(
jscontext *cx); // added in spidermonkey 52 void js_gc(jsruntime *rt); // obsolete since jsapi 50 void js_gc(
jscontext *cx); // obsolete since jsapi 14 name type description cx
jscontext * the context to for which to perform garbage collection.
... see also mxr id search for js_gc js_maybegc bug 737364 -- changed to jsruntime bug 1283855 -- changed to
jscontext ...
JS_GET_CLASS
syntax #ifdef js_threadsafe #define js_get_class(cx,obj) js_getclass(cx, obj) #else #define js_get_class(cx,obj) js_getclass(obj) #endif parameter type description cx
jscontext * any context associated with the runtime in which obj exists.
... note: in spidermonkey versions prior to spidermonkey 1.8.8, js_getclass took both a
jscontext* and a jsobject* as arguments in thread-safe builds, and in non-thread-safe builds it took only a jsobject*.
JS_GetArrayLength
syntax bool js_getarraylength(
jscontext *cx, js::handle<jsobject*> obj, uint32_t *lengthp); name type description cx
jscontext * the context in which to look up the array's length.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetArrayPrototype
syntax jsobject * js_getarrayprototype(
jscontext *cx, js::handleobject forobj); name type description cx
jscontext * pointer to a javascript context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetClass
syntax const jsclass * js_getclass(jsobject *obj); name type description cx
jscontext * any context associated with the runtime in which obj exists.
... in spidermonkey versions prior to spidermonkey 1.8.8, js_getclass took both a
jscontext* and a jsobject* as arguments in thread-safe builds, and in non-thread-safe builds it took only a jsobject*.
JS_GetClassObject
syntax bool js_getclassobject(
jscontext *cx, jsprotokey key, js::mutablehandle<jsobject*> objp); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetClassPrototype
syntax bool js_getclassprototype(
jscontext *cx, jsprotokey key, js::mutablehandle<jsobject*> objp); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetConstructor
syntax jsobject * js_getconstructor(
jscontext *cx, js::handle<jsobject*> proto); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetElement
syntax bool js_getelement(
jscontext *cx, js::handleobject obj, uint32_t index, js::mutablehandlevalue vp); name type description cx
jscontext * the context in which to perform the property lookup.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetEmptyStringValue
syntax // added in spidermonkey 42 js::value js_getemptystringvalue(
jscontext *cx); // obsolete since spidermonkey 42 jsval js_getemptystringvalue(
jscontext *cx); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetExternalStringClosure
syntax void * js_getexternalstringclosure(
jscontext *cx, jsstring *str); name type description cx
jscontext * the context from which to retrieve the closure for a string.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetFunctionCallback
syntax jsfunctioncallback js_getfunctioncallback(
jscontext *cx); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetFunctionPrototype
syntax jsobject * js_getfunctionprototype(
jscontext *cx, js::handleobject forobj); name type description cx
jscontext * pointer to a javascript context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetFunctionScript
syntax jsscript * js_getfunctionscript(
jscontext *cx, js::handlefunction fun); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetGlobalForCompartmentOrNull
syntax jsobject * js_getglobalforcompartmentornull(
jscontext *cx, jscompartment *c); name type description cx
jscontext * the context for which to return the global object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetGlobalForObject
syntax jsobject * js_getglobalforobject(
jscontext *cx, jsobject *obj); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetGlobalForScopeChain
syntax jsobject * js_getglobalforscopechain(
jscontext *cx); name type description cx
jscontext * the context for which to return the global object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetGlobalObject
(in javascript, global variables are stored as properties of the global object.) syntax jsobject * js_getglobalobject(
jscontext *cx); name type description cx
jscontext * the context from which to retrieve the global object.
...js_getglobalobject retrieves the global object for a specified
jscontext *, cx.
JS_GetLatin1FlatStringChars
syntax const js::latin1char * js_getlatin1flatstringchars(const js::autocheckcannotgc &nogc, jsflatstring *str); const char16_t * js_gettwobyteflatstringchars(const js::autocheckcannotgc &nogc, jsflatstring *str); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext..
JS_GetLatin1InternedStringChars
syntax const js::latin1char * js_getlatin1internedstringchars(const js::autocheckcannotgc &nogc, jsstring *str); const char16_t * js_gettwobyteinternedstringchars(const js::autocheckcannotgc &nogc, jsstring *str); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext..
JS_GetLatin1StringCharsAndLength
syntax const js::latin1char * js_getlatin1stringcharsandlength(
jscontext *cx, const js::autocheckcannotgc &nogc, jsstring *str, size_t *length); const char16_t * js_gettwobytestringcharsandlength(
jscontext *cx, const js::autocheckcannotgc &nogc, jsstring *str, size_t *length); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext..
JS_GetObjectPrototype
syntax jsobject * js_getobjectprototype(
jscontext *cx, js::handleobject forobj); name type description cx
jscontext * pointer to a javascript context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetOptions
get the currently enabled
jscontext options.
... syntax uint32 js_getoptions(
jscontext *cx); name type description cx
jscontext * the context from which to read options.
JS_GetOwnPropertyDescriptor
syntax bool js_getownpropertydescriptor(
jscontext *cx, js::handleobject obj, const char *name, js::mutablehandle<jspropertydescriptor> desc); bool js_getownpropertydescriptorbyid(
jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandle<jspropertydescriptor> desc); bool js_getownucpropertydescriptor(
jscontext *cx, js::handleobject obj, const char16_t *name, js::mutablehandle desc); // added in spidermonkey 45 name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetParentRuntime
syntax jsruntime * js_getparentruntime(
jscontext *cx); name type description cx
jscontext * the context to query.
... description js_getparentruntime retrieves a pointer to the parent jsruntime of the runtime for a specified
jscontext.
JS_GetProperty
syntax bool js_getproperty(
jscontext *cx, js::handleobject obj, const char *name, js::mutablehandlevalue vp); bool js_getucproperty(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, js::mutablehandlevalue vp); bool js_getpropertybyid(
jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandlevalue vp); // added in spidermonkey 1.8.1 name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetPropertyAttributes
syntax jsbool js_getpropertyattributes(
jscontext *cx, jsobject *obj, const char *name, unsigned int *attrsp, jsbool *foundp); jsbool js_getucpropertyattributes(
jscontext *cx, jsobject *obj, const jschar *name, size_t namelen, unsigned int *attrsp, jsbool *foundp); name type description cx
jscontext * the context in which to look up property attributes.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetPropertyDefault
syntax bool js_getpropertydefault(
jscontext *cx, jsobject *obj, const char *name, jsval def, js::mutablehandle<js::value> vp); bool js_getpropertybyiddefault(
jscontext *cx, jsobject *obj, jsid id, jsval def, js::mutablehandle<js::value> vp); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetPropertyDescriptor
syntax bool js_getpropertydescriptor(
jscontext *cx, js::handleobject obj, const char *name, js::mutablehandle<jspropertydescriptor> desc); // added in spidermonkey 31 bool js_getpropertydescriptorbyid(
jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandle<jspropertydescriptor> desc); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetPrototype
syntax bool js_getprototype(
jscontext *cx, js::handleobject obj, js::mutablehandleobject protop); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetRuntime
syntax jsruntime * js_getruntime(
jscontext *cx); name type description cx
jscontext * the context to query.
... description js_getruntime retrieves a pointer to the jsruntime with which a specified
jscontext, cx, is associated.
JS_GetStringCharAt
syntax bool js_getstringcharat(
jscontext *cx, jsstring *str, size_t index, char16_t *res); char16_t js_getflatstringcharat(jsflatstring *str, size_t index); name type description cx
jscontext * the context in which to create the new string.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetStringCharsAndLength
syntax const jschar * js_getstringcharsandlength(
jscontext *cx, jsstring *str, size_t *length); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_GetStringEncodingLength
syntax size_t js_getstringencodinglength(
jscontext *cx, jsstring *str); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext..
JS_GetVersion
syntax jsversion js_getversion(
jscontext *cx); name type description cx
jscontext * the context to query.
... description js_getversion returns the javascript version currently used by the given
jscontext, cx.
JS_HasArrayLength
syntax jsbool js_hasarraylength(
jscontext *cx, jsobject *obj, jsuint *lengthp); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_HasElement
syntax bool js_haselement(
jscontext *cx, js::handleobject obj, uint32_t index, bool *foundp); name type description cx
jscontext * the context in which to perform the property lookup.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_HasInstance
syntax bool js_hasinstance(
jscontext *cx, js::handle<jsobject*> obj, js::handle<js::value> v, bool *bp); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_HasOwnProperty
syntax bool js_hasownproperty(
jscontext* cx, handleobject obj, const char* name, bool* foundp) bool js_hasownpropertybyid(
jscontext* cx, handleobject obj, handleid id, bool* foundp) name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_HasProperty
syntax bool js_hasproperty(
jscontext *cx, js::handleobject obj, const char *name, bool *foundp); bool js_hasucproperty(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, bool *vp); bool js_haspropertybyid(
jscontext *cx, js::handleobject obj, js::handleid id, bool *foundp); // added in spidermonkey 1.8.1 name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_IdToProtoKey
syntax jsprotokey js_idtoprotokey(
jscontext *cx, js::handleid id); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_IdToValue
syntax bool js_idtovalue(
jscontext *cx, jsid id, js::mutablehandle<js::value> vp); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_InitCTypesClass
syntax jsbool js_initctypesclass(
jscontext *cx, jsobject *global); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_InitClass
syntax jsobject * js_initclass(
jscontext *cx, js::handleobject obj, js::handleobject parent_proto, const jsclass *clasp, jsnative constructor, unsigned nargs, const jspropertyspec *ps, const jsfunctionspec *fs, const jspropertyspec *static_ps, const jsfunctionspec *static_fs); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_InitStandardClasses
syntax bool js_initstandardclasses(
jscontext *cx, js::handle<jsobject*> obj); name type description cx
jscontext * pointer to the executable script context for which to initialize js function and object classes.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_InstanceOf
syntax bool js_instanceof(
jscontext *cx, js::handle<jsobject*> obj, const jsclass *clasp, js::callargs *args); // added in spidermonkey 38 bool js_instanceof(
jscontext *cx, js::handle<jsobject*> obj, const jsclass *clasp, jsval *argv); // obsolete since jsapi 32 name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_InternJSString
syntax jsstring * js_internjsstring(
jscontext *cx, js::handlestring str); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_InternString
syntax jsstring * js_internstring(
jscontext *cx, const char *s); jsstring * js_internstringn(
jscontext *cx, const char *s, size_t length); jsstring * js_internucstring(
jscontext *cx, const char16_t *s); jsstring * js_internucstringn(
jscontext *cx, const char16_t *s, size_t length); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_IsExtensible
syntax bool js_isextensible(
jscontext *cx, js::handleobject obj, bool *extensible); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_IsIdentifier
syntax bool js_isidentifier(
jscontext *cx, js::handlestring str, bool *isidentifier); bool js_isidentifier(const char16_t *chars, size_t length); // added in spidermonkey 38 name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_IsRunning
syntax bool js_isrunning(
jscontext *cx); name type description cx
jscontext * the context to query.
... description js_isrunning determines if a script or function is currently executing in a specified
jscontext, cx.
JS_LeaveCompartment
syntax void js_leavecompartment(
jscontext *cx, jscompartment *oldcompartment); name type description cx
jscontext * the context in which to leave the compartment.
... description every
jscontext has a current compartment.
JS_LeaveLocalRootScope
syntax void js_leavelocalrootscope(
jscontext *cx); name type description cx
jscontext * pointer to the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_LinkConstructorAndPrototype
syntax bool js_linkconstructorandprototype(
jscontext *cx, js::handle<jsobject*> ctor, js::handle<jsobject*> proto); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_LockGCThing
syntax jsbool js_lockgcthing(
jscontext *cx, void *thing); // obsolete since jsapi 21 jsbool js_unlockgcthing(
jscontext *cx, void *thing); // obsolete since jsapi 21 jsbool js_lockgcthingrt(jsruntime *rt, void *thing); jsbool js_unlockgcthingrt(jsruntime *rt, void *thing); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_LookupElement
syntax bool js_lookupelement(
jscontext *cx, js::handleobject obj, uint32_t index, js::mutablehandlevalue vp); name type description cx
jscontext * the context in which to look up the property.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_LooselyEqual
syntax bool js_looselyequal(
jscontext *cx, js::handle<js::value> v1, js::handle<js::value> v2, bool *equal); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_MakeStringImmutable
syntax jsbool js_makestringimmutable(
jscontext *cx, jsstring *str); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_New
syntax jsobject * js_new(
jscontext *cx, js::handleobject ctor, const js::handlevaluearray& args); // added in jsapi 32 jsobject * js_new(
jscontext *cx, jsobject *ctor, unsigned argc, jsval *argv); // obsolete since jsapi 32 name type description cx
jscontext * the context in which to create the new object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewArrayObject
syntax jsobject * js_newarrayobject(
jscontext *cx, const js::handlevaluearray& contents); // added in spidermonkey 31 jsobject * js_newarrayobject(
jscontext *cx, size_t length); // added in spidermonkey 31 jsobject * js_newarrayobject(
jscontext *cx, int length, jsval *vector); // obsolete since jsapi 30 name type description cx
jscontext * the context in which to create the new array.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewCompartmentAndGlobalObject
syntax jsobject * js_newcompartmentandglobalobject(
jscontext *cx, jsclass *clasp, jsprincipals *principals); name type description cx
jscontext * the context in which to create the new global object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewDateObject
syntax jsobject * js_newdateobject(
jscontext *cx, int year, int mon, int mday, int hour, int min, int sec); name type description cx
jscontext * the context in which to create the new date object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewDateObjectMsec
syntax jsobject * js_newdateobjectmsec(
jscontext *cx, double msec); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewDependentString
syntax jsstring * js_newdependentstring(
jscontext *cx, js::handlestring str, size_t start, size_t length); name type description cx
jscontext * the context in which to create the new string.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewDouble
syntax jsdouble * js_newdouble(
jscontext *cx, jsdouble d); name type description cx
jscontext * the context in which to create the new number.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewDoubleValue
create a floating-point jsval syntax jsbool js_newdoublevalue(
jscontext *cx, jsdouble d, jsval *rval); name type description cx
jscontext * the context in which to create the new number.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewExternalString
syntax jsstring * js_newexternalstring(
jscontext *cx, const char16_t *chars, size_t length, const jsstringfinalizer *fin); jsstring * js_newexternalstringwithclosure(
jscontext *cx, jschar *chars, size_t length, int type, void *closure); // obsolete since jsapi 13 name type description cx
jscontext * the context in which to create the new string.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewGlobalObject
syntax jsobject * js_newglobalobject(
jscontext *cx, const jsclass *clasp, jsprincipals *principals, js::onnewglobalhookoption hookoption, const js::compartmentoptions &options = js::compartmentoptions()); name type description cx
jscontext * the context in which to create the new global object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewNumberValue
syntax jsbool js_newnumbervalue(
jscontext *cx, jsdouble d, jsval *rval); name type description cx
jscontext * the context in which to create the new number.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewObject
syntax // added in spidermonkey 45 jsobject * js_newobject(
jscontext *cx, const jsclass *clasp); bool js_newobjectwithgivenproto(
jscontext *cx, const jsclass *clasp, js::handle<jsobject*> proto); // obsolete since spidermonkey 38 jsobject * js_newobject(
jscontext *cx, const jsclass *clasp, js::handle<jsobject*> proto, js::handle<jsobject*> parent); jsobject * js_newobjectwithgivenproto(
jscontext *cx, const jsclass *clasp, js::handle<jsobject*> proto, js::handle<jsobject*> parent); // added in spidermonkey 1.8 name type description cx
jscontext * the context in which to create the new object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewObjectForConstructor
syntax jsobject * js_newobjectforconstructor(
jscontext *cx, const jsclass *clasp, const js::callargs& args); // added in jsapi 32 jsobject * js_newobjectforconstructor(
jscontext *cx, jsclass *clasp, const jsval *vp); // added in jsapi 14, obsolete since jsapi 32 jsobject * js_newobjectforconstructor(
jscontext *cx, const jsval *vp); // obsolete since jsapi 14 name type description cx
jscontext * the context in which to create the new object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewPlainObject
syntax jsobject * js_newplainobject(
jscontext *cx); name type description cx
jscontext * the context in which to create the new object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewPropertyIterator
syntax jsobject * js_newpropertyiterator(
jscontext *cx, js::handle<jsobject*> obj); name type description cx
jscontext * the js context in which to enumerate properties.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewRegExpObject
syntax jsobject * js_newregexpobject(
jscontext *cx, js::handleobject obj, const char *bytes, size_t length, unsigned flags); jsobject * js_newucregexpobject(
jscontext *cx, js::handleobject obj, const char16_t *chars, size_t length, unsigned flags); jsobject * js_newregexpobjectnostatics(
jscontext *cx, char *bytes, size_t length, unsigned flags); jsobject * js_newucregexpobjectnostatics(
jscontext *cx, char16_t *chars, size_t length, unsigned flags); name type description cx
jscontext * the context in which to create the new object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewScriptObject
syntax jsobject * js_newscriptobject(
jscontext *cx, jsscript *script); name type description cx
jscontext * the context in which to create the new script object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewUCString
syntax jsstring * js_newucstring(
jscontext *cx, char16_t *chars, size_t length); jsstring * js_newstring(
jscontext *cx, char *buf, size_t length); // obsolete since jsapi 1.8.5 name type description cx
jscontext * the context in which to create the new string.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewStringCopyN
syntax jsstring * js_newstringcopyn(
jscontext *cx, const char *s, size_t n); jsstring * js_newucstringcopyn(
jscontext *cx, const char16_t *s, size_t n); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NewStringCopyZ
syntax jsstring * js_newstringcopyz(
jscontext *cx, const char *s); jsstring * js_newucstringcopyz(
jscontext *cx, const char16_t *s); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_NextProperty
syntax bool js_nextproperty(
jscontext *cx, js::handleobject iterobj, js::mutablehandleid idp); name type description cx
jscontext * the js context in which to enumerate properties.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ObjectIsDate
syntax bool js_objectisdate(
jscontext *cx, js::handleobject obj); name type description cx
jscontext * pointer to a javascript context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ParseJSON
syntax jsbool js_parsejson(
jscontext *cx, const jschar *chars, uint32 len, jsval *vp); jsbool js_parsejsonwithreviver(
jscontext *cx, const jschar *chars, uint32 len, jsval reviver, jsval *vp); name type description cx
jscontext * pointer to a js context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_PopArguments
syntax void js_poparguments(
jscontext *cx, void *mark); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_PreventExtensions
syntax // added in spidermonkey 45 bool js_preventextensions(
jscontext *cx, js::handleobject obj, js::objectopresult &result); // obsolete since jsapi 39 bool js_preventextensions(
jscontext *cx, js::handleobject obj, bool *succeeded); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_PropertyStub
syntax bool js_propertystub(
jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandlevalue vp); bool js_strictpropertystub(
jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandlevalue vp, js::objectopresult &result); // added in spidermonkey 45 bool js_strictpropertystub(
jscontext *cx, js::handleobject obj, js::handleid id, bool strict, js::mutablehandlevalue vp); // obsolete since jsapi 39 bool js_resolvestub(
jscontext *cx, js::handleobject obj, js::handleid id, bool *resolvedp); // obsolete since jsapi 37 bool js_deletepropertystub(
jscontext *cx, js::handleobject obj, js::handleid id, bool *succeeded);...
... // obsolete since jsapi 37 bool js_enumeratestub(
jscontext *cx, js::handleobject obj); // obsolete since jsapi 37 bool js_convertstub(
jscontext *cx, js::handleobject obj, jstype type, js::mutablehandlevalue vp); // obsolete since jsapi 37 void js_finalizestub(
jscontext *cx, jsobject *obj); // obsolete since jsapi 14 description the stub functions are not designed to be called directly by a jsapi application.
JS_PushArguments
syntax jsval * js_pusharguments(
jscontext *cx, void **markp, const char *format, ...); jsval * js_pushargumentsva(
jscontext *cx, void **markp, const char *format, va_list ap); name type description cx
jscontext * the context in which to perform any necessary conversions.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_PutEscapedString
syntax size_t js_putescapedstring(
jscontext *cx, char *buffer, size_t size, jsstring *str, char quote); size_t js_putescapedflatstring(char *buffer, size_t size, jsflatstring *str, char quote); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_Remove*Root
syntax jsbool js_removevalueroot(
jscontext *cx, jsval *vp); jsbool js_removestringroot(
jscontext *cx, jsstring **spp); jsbool js_removeobjectroot(
jscontext *cx, jsobject **opp); jsbool js_removegcthingroot(
jscontext *cx, void **rp); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ReportError
syntax void js_reporterror(
jscontext *cx, const char *format, ...); bool js_reportwarning(
jscontext *cx, const char *format, ...); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ResolveStandardClass
syntax bool js_resolvestandardclass(
jscontext *cx, js::handleobject obj, js::handleid id, bool *resolved); name type description cx
jscontext * pointer to the executable script context for which to initialize js function and object classes.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_RestoreExceptionState
syntax void js_restoreexceptionstate(
jscontext *cx, jsexceptionstate *state); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SameValue
the samevalue algorithm is equivalent to the following javascript: function samevalue(v1, v2) { if (v1 === 0 && v2 === 0) return 1 / v1 === 1 / v2; if (v1 !== v1 && v2 !== v2) return true; return v1 === v2; } syntax // added in spidermonkey 45 bool js_samevalue(
jscontext *cx, js::handle<js::value> v1, js::handle<js::value> v2, bool *same); // obsolete since jsapi 39 bool js_samevalue(
jscontext *cx, jsval v1, jsval v2, bool *same); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SaveExceptionState
syntax jsexceptionstate * js_saveexceptionstate(
jscontext *cx); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SetAllNonReservedSlotsToUndefined
syntax void js_setallnonreservedslotstoundefined(
jscontext *cx, jsobject *objarg); name type description cx
jscontext * the context in which to clear the object.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SetArrayLength
syntax bool js_setarraylength(
jscontext *cx, js::handle<jsobject*> obj, uint32_t length); name type description cx
jscontext * the context in which to change the length of the array.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SetBranchCallback
syntax jsbranchcallback js_setbranchcallback(
jscontext *cx, jsbranchcallback cb); name type description cx
jscontext * the context to hook.
... callback syntax jsbool (*jsbranchcallback)(
jscontext *cx, jsscript *script); name type description cx
jscontext * pointer to a
jscontext which the callback may use to call into jsapi functions.
JS_SetErrorReporter
callback syntax typedef void (* jserrorreporter)(
jscontext *cx, const char *message, jserrorreport *report); name type description cx
jscontext * the context in which the error happened.
...example code with error handling omitted: class myrequest { public: void execute() { auto rt = js_newruntime(memlimit); js_setruntimeprivate(rt, this); js_seterrorreporter(rt, &myrequest::dispatcherror); // execute js } void onerror(const std::string& error) { // handle error } static void dispatcherror(
jscontext* ctx, const char* message, jserrorreport* report) { auto rt = js_getruntime(ctx); auto rt_userdata = js_getruntimeprivate(rt); if (rt_userdata) { auto req = static_cast<myrequest*>(rt_userdata); req->onerror(message); } } }; see also mxr id search for js_geterrorreporter mxr id search for js_seterrorreporte...
JS_SetGCCallback
syntax void js_setgccallback(jsruntime *rt, jsgccallback cb, void *data); jsgccallback js_setgccallback(
jscontext *cx, jsgccallback cb); // obsolete since jsapi 13 jsgccallback js_setgccallbackrt(jsruntime *rt, jsgccallback cb); // obsolete since jsapi 13 name type description cx
jscontext * (for the old js_setgccallback) any
jscontext.
... callback syntax typedef enum jsgcstatus { jsgc_begin, jsgc_end, jsgc_mark_end, // obsolete since jsapi 13 jsgc_finalize_end // obsolete since jsapi 13 } jsgcstatus; typedef void (* jsgccallback)(jsruntime *rt, jsgcstatus status, void *data); name type description cx
jscontext * the context in which garbage collection is happening.
JS_SetGlobalObject
syntax void js_setglobalobject(
jscontext *cx, jsobject *obj); name type description cx
jscontext * the context to configure.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SetOperationCallback
syntax void js_setoperationcallback(
jscontext *cx, jsoperationcallback callback); jsoperationcallback js_getoperationcallback(
jscontext *cx); void js_triggeroperationcallback(jsruntime *rt); name type description cx
jscontext * a context.
... callback syntax jsbool (*jsoperationcallback)(
jscontext *cx); name type description cx
jscontext * pointer to a
jscontext in which this callback was installed.
JS_SetParent
syntax bool js_setparent(
jscontext *cx, js::handleobject obj, js::handleobject parent); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SetProperty
syntax bool js_setproperty(
jscontext *cx, js::handleobject obj, const char *name, js::handlevalue v); bool js_setucproperty(
jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, js::handlevalue v); bool js_setpropertybyid(
jscontext *cx, js::handleobject obj, js::handleid id, js::handlevalue v); // added in spidermonkey 1.8.1 name type description cx
jscontext * pointer to a js context from which to derive runtime information.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SetPropertyAttributes
syntax jsbool js_setpropertyattributes(
jscontext *cx, jsobject *obj, const char *name, unsigned int attrs, jsbool *foundp); jsbool js_setucpropertyattributes(
jscontext *cx, jsobject *obj, const jschar *name, size_t namelen, unsigned int attrs, jsbool *foundp); name type description cx
jscontext * the context in which to set the property attributes.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SetPrototype
syntax bool js_setprototype(
jscontext *cx, js::handleobject obj, js::handleobject proto); name type description cx
jscontext * the context in which to set the object's prototype.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SetRegExpInput
syntax bool js_setregexpinput(
jscontext *cx, js::handleobject obj, js::handlestring input, bool multiline); name type description cx
jscontext * the context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_SetScriptStackQuota
syntax void js_setscriptstackquota(
jscontext *cx, size_t quota); name type description cx
jscontext * the context to configure.
...either immediately after js_newcontext or from the
jscontext_new context callback.
JS_SetThreadStackLimit
syntax void js_setthreadstacklimit(
jscontext *cx, jsuword limitaddr) name type description cx
jscontext * the context to configure.
...in a js_threadsafe build, after passing a
jscontext from one thread to another, call js_setthreadstacklimit(cx, 0) after calling js_setcontextthread.
JS_SetVersion
configure a
jscontext to use a specific version of the javascript language.
... syntax jsversion js_setversion(
jscontext *cx, jsversion version); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
JS_ShutDown
syntax void js_shutdown(void); description destroys all free-standing resources allocated by spidermonkey, not associated with any jsruntime,
jscontext, or other structure.
... this method should be called after all other jsapi data has been properly cleaned up: every jsruntime created with js_newruntime must have been destroyed with js_destroyruntime, every
jscontext created with js_newcontext must have been destroyed with js_destroycontext, and so on.
JS_StrictlyEqual
syntax // added in spidermonkey 45 bool js_strictlyequal(
jscontext *cx, js::handle<js::value> v1, js::handle<js::value> v2, bool *equal); // obsolete since jsapi 39 bool js_strictlyequal(
jscontext *cx, jsval v1, jsval v2, bool *equal); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_StringEqualsAscii
syntax bool js_stringequalsascii(
jscontext *cx, jsstring *str, const char *asciibytes, bool *match); bool js_flatstringequalsascii(jsflatstring *str, const char *asciibytes); name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ToggleOptions
toggle specified options on a
jscontext.
... syntax uint32 js_toggleoptions(
jscontext *cx, uint32 options); name type description cx
jscontext * a context on which to modify options.
JS_TypeOfValue
syntax jstype js_typeofvalue(
jscontext *cx, js::handle<js::value> v); name type description cx
jscontext * the context in which to perform the type check.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ValueToBoolean
syntax jsbool js_valuetoboolean(
jscontext *cx, jsval v, jsbool *bp); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ValueToECMAInt32
syntax jsbool js_valuetoecmaint32(
jscontext *cx, jsval v, int32 *ip); jsbool js_valuetoecmauint32(
jscontext *cx, jsval v, uint32 *ip); jsbool js_valuetouint16(
jscontext *cx, jsval v, uint16 *ip); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ValueToFunction
syntax jsfunction * js_valuetofunction(
jscontext *cx, js::handlevalue v); jsfunction * js_valuetoconstructor(
jscontext *cx, js::handlevalue v); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ValueToId
syntax bool js_valuetoid(
jscontext *cx, js::handlevalue v, js::mutablehandleid idp); bool js_stringtoid(
jscontext *cx, js::handlestring s, js::mutablehandleid idp); // added in spidermonkey 38 bool js_indextoid(
jscontext *cx, uint32_t index, js::mutablehandleid idp); // added in spidermonkey 17 bool js_charstoid(
jscontext* cx, js::twobytechars chars, js::mutablehandleid idp); // added in spidermonkey 24 void js::protokeytoid(
jscontext *cx, jsprotokey key, js::mutablehandleid idp); // added in spidermonkey 38 name type description cx
jscontext * a context.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ValueToInt32
syntax jsbool js_valuetoint32(
jscontext *cx, jsval v, int32 *ip); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ValueToNumber
syntax jsbool js_valuetonumber(
jscontext *cx, jsval v, jsdouble *dp); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ValueToObject
syntax bool js_valuetoobject(
jscontext *cx, js::handlevalue v, js::mutablehandleobject objp); name type description cx
jscontext * the context in which to convert the value.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ValueToSource
syntax jsstring * js_valuetosource(
jscontext *cx, js::handle<js::value> v); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_ValueToString
syntax jsstring * js_valuetostring(
jscontext *cx, jsval v); name type description cx
jscontext * the context in which to perform the conversion.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JS_YieldRequest
syntax void js_yieldrequest(
jscontext *cx); name type description cx
jscontext * the
jscontext that is currently in a request on the calling thread.
...in a js_threadsafe build, the caller must be in a request on this
jscontext.
JSAPI reference
runtimes and contexts js_init added in spidermonkey 31 js_shutdown struct jsruntime js_newruntimeobsolete since jsapi 52 js_destroyruntime js_getruntimeprivate js_setruntimeprivate js_setnativestackquota added in spidermonkey 17 js_contextiteratorobsolete since jsapi 52 js_finish obsolete since jsapi 19 struct
jscontext js_newcontext js_destroycontext js_destroycontextnogc js_setcontextcallback enum
jscontextop js_getruntime js_getparentruntime added in spidermonkey 31 js_getobjectruntime added in spidermonkey 17 js_getcontextprivate js_setcontextprivate js_getsecondcontextprivate added in spidermonkey 17 js_setsecondcontextprivate added in spidermonkey 17 js_setinterruptcallback ...
...allback types: js::largeallocationfailurecallback - used by js::setlargeallocationfailurecallback added in spidermonkey 31 js::offthreadcompilecallback - used by js::compileoffthread added in spidermonkey 26 js::setoutofmemorycallback - used by js::outofmemorycallback added in spidermonkey 31 jscompartmentnamecallback - used by js_setcompartmentnamecallback added in spidermonkey 17
jscontextcallback - used by js_setcontextcallback jsdestroycompartmentcallback - used by js_setdestroycompartmentcallback added in spidermonkey 17 jsenumeratediagnosticmemorycallback - used by js_enumeratediagnosticmemoryregions added in spidermonkey 17 jserrorcallback - used by js_reporterrornumber and friends jserrorreporter - used by js_seterrorreporter jsgccallback - used by js_setgcca...
SpiderMonkey 45
future direction
jscontext and jsruntime are merging.
... (
jscontext will be the only thing visible from within the api, there will be just one per runtime, and inheriting from jsruntime.) spidermonkey embedders should be aware that mozilla has no plans to keep the jsapi stable for embedders.
Using RAII classes in Mozilla
in the common case, using these macros involves these three additions to a class: class moz_raii nsautoscriptblocker { public: explicit nsautoscriptblocker(
jscontext *cx moz_guard_object_notifier_param) { // note: no ',' before macro moz_guard_object_notifier_init; nscontentutils::addscriptblocker(cx); } ~nsautoscriptblocker() { nscontentutils::removescriptblocker(); } private: moz_decl_use_guard_object_notifier }; moz_guard_object_notifier_param is added to the end of the constructor's parameter list.
...in this case, the implementation must use the moz_guard_object_notifier_param_in_impl macro to add to the implementation: nsautoscriptblocker::nsautoscriptblocker(
jscontext *cx moz_guard_object_notifier_param_in_impl) { moz_guard_object_notifier_init; nscontentutils::addscriptblocker(cx); } or, if it is the only parameter: nsautoscriptblocker::nsautoscriptblocker(moz_guard_object_notifier_only_param_in_impl) { moz_guard_object_notifier_init; nscontentutils::addscriptblocker(); } finally, if an raii class that uses these macros has derived classes,...
IJSDebugger
method overview [implicit_
jscontext] void addclass(); methods addclass() defines the global debugger constructor.
... [implicit_
jscontext] void addclass(); parameters none.
nsIDispatchSupport
inherits from: nsisupports last changed in gecko 1.7 method overview void comvariant2jsval(in comvariantptr comvar, out jsval val); unsigned long gethostingflags(in string acontext); boolean isclassmarkedsafeforscripting(in nscidref cid, out boolean classexists); boolean isclasssafetohost(in
jscontextptr cx, in nscidref cid, in boolean capscheck, out boolean classexists); boolean isobjectsafeforscripting(in voidptr theobject, in nsiidref id); void jsval2comvariant(in jsval var, out comvariant comvar); methods comvariant2jsval() converts a com variant to a jsval.
...boolean isclasssafetohost( in
jscontextptr cx, in nscidref cid, in boolean capscheck, out boolean classexists ); parameters cx cid capscheck classexists returns containing pr_false if the class is not registered.
nsIPrincipal
boolean equals(in nsiprincipal other); jsprincipals getjsprincipals(in
jscontext cx); native code only!
...jsprincipals getjsprincipals( in
jscontext cx ); parameters cx missing description return value missing description getpreferences() returns the security preferences associated with this principal.
nsISmsService
to create an instance, use: var smsservice = components.classes["@mozilla.org/sms/smsservice;1"] .createinstance(components.interfaces.nsismsservice); method overview [implicit_
jscontext] nsidommozsmsmessage createsmsmessage(in long id, in domstring delivery, in domstring sender, in domstring receiver, in domstring body, in jsval timestamp, in bool read ); unsigned short getnumberofmessagesfortext(in domstring text); boolean hassupport(); void send(in domstring number, in domstring message, in long requestid, [optional] in unsigned long long processid);...
... methods createsmsmessage() [implicit_
jscontext] nsidommozsmsmessage createsmsmessage( in long id, in domstring delivery, in domstring sender, in domstring receiver, in domstring body, in jsval timestamp, in bool read ); parameters id a number representing the id of the message.
nsIXPCException
void stowjsval(in xpcex
jscontextptr cx, in xpcexjsval val); native code only!
...return value native code only!stowjsval void stowjsval( in xpcex
jscontextptr cx, in xpcexjsval val ); parameters cx val remarks components.exception is a javascript constructor to create nsixpcexception objects.
JS::PerfMeasurement
jsobject* js::registerperfmeasurement(
jscontext* cx, jsobject* global) you shouldn't need to use this function, but we mention it for completeness.
Functions
(
jscontext::display caches the enclosing function's stack frame.) if that function is also algol-like, its child can read locals and variables from the next enclosing function, and so on.
Tracing JIT
each spidermonkey
jscontext holds a trace monitor of type jstracemonitor.
JS::AutoVectorRooter
syntax js::autovectorrooter(
jscontext* cx); methods method description size_t length() const returns the length of the array.
JS::Handle
syntax bool somefunction(
jscontext *cx, js::handle<t> var) { ...
JS::MutableHandle
syntax bool somefunction(
jscontext *cx, js::mutablehandle<t> outparam) { ...
JS::SetOutOfMemoryCallback
added in spidermonkey 38 callback syntax typedef void (* outofmemorycallback)(
jscontext *cx, void *data); name type description data void * data parameter passed to js::setoutofmemorycallback.
JSCheckAccessOp
(it is also the type of the callback set by js_setcheckobjectaccesscallback.) syntax typedef jsbool (* jscheckaccessop)(
jscontext *cx, jsobject *obj, jsval id, jsaccessmode mode, jsval *vp); name type description cx
jscontext * the js context in which the property access attempt is occurring.
JSConvertOp
syntax typedef bool (* jsconvertop)(
jscontext *cx, js::handleobject obj, jstype type, js::mutablehandlevalue vp); name type description cx
jscontext * the context in which the convert is taking place.
JSDeletePropertyOp
syntax typedef bool (* jsdeletepropertyop)(
jscontext *cx, js::handleobject obj, js::handleid id, bool *succeeded); name type description cx
jscontext * the context in which the property access is taking place.
JSEnumerateOp
syntax typedef bool (* jsenumerateop)(
jscontext *cx, js::handleobject obj); name type description cx
jscontext * pointer to the js context in which the enumeration is taking place.
JSExtendedClass.outerObject
callback syntax typedef jsobject * (*jsobjectop)(
jscontext *cx, jsobject *obj); name type description cx
jscontext * a context.
JSExtendedClass.wrappedObject
syntax typedef jsobject * (*jsobjectop)(
jscontext *cx, jsobject *obj); name type description cx
jscontext * the context in which the object is being unwrapped.
JSFastNative
syntax typedef jsbool (*jsfastnative)(
jscontext *cx, unsigned int argc, jsval *vp); name type description cx
jscontext * the context in which the fast native is being called.
JSFinalizeOp
syntax typedef void (* jsfinalizeop)(jsfreeop *fop, jsobject *obj); name type description cx
jscontext * the js context in which garbage collection is taking place.
JSGetObjectOps
jsgetobjectops is the type for jsclass.getobjectops callback syntax typedef jsobjectops * (* jsgetobjectops)(
jscontext *cx, jsclass *clasp); name type description cx
jscontext * the js context in which the new object is being created.
JSHasInstanceOp
syntax typedef bool (* jshasinstanceop)(
jscontext *cx, js::handleobject obj, js::mutablehandlevalue vp, bool *bp); name type description cx
jscontext * the js context in which the type check is occurring.
JSIteratorOp
syntax typedef jsobject * (*jsiteratorop)(
jscontext *cx, jsobject *obj, jsbool keysonly); name type description cx
jscontext * pointer to the js context in which the iterator creation should take place.
JSMarkOp
syntax typedef uint32 (* jsmarkop)(
jscontext *cx, jsobject *obj, void *arg); name type description cx
jscontext * the js context in which the mark phase of garbage collection is occurring.
JSNative
syntax typedef bool (* jsnative)(
jscontext *cx, unsigned argc, js::value *vp); name type description cx
jscontext * the context in which the native function is being called.
JSNewEnumerateOp
syntax typedef bool (* jsnewenumerateop)(
jscontext *cx, js::handleobject obj, js::autoidvector &properties); // added in spidermonkeysidebar 38 typedef bool (* jsnewenumerateop)(
jscontext *cx, js::handleobject obj, jsiterateop enum_op, js::mutablehandlevalue statep, js::mutablehandleid idp); // obsolete since jsapi 37 name type description cx
jscontext * the context in which the enumeration is taking place.
JSNewResolveOp
syntax typedef bool (* jsnewresolveop)(
jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandleobject objp); name type description cx
jscontext * pointer to the js context in which the property access is taking place.
JSObjectOp
typedef jsobject * (*jsobjectop)(
jscontext *cx, jsobject *obj); the callbacks of this type are: jsextendedclass.outerobject jsextendedclass.innerobject jsextendedclass.wrappedobject jsobjectops.thisobject ...
JSObjectOps.defaultValue
syntax typedef jsbool (*jsconvertop)(
jscontext *cx, jsobject *obj, jstype type, jsval *vp); name type description cx
jscontext * pointer to the js context in which the conversion is needed.
JSObjectOps.defineProperty
syntax jsbool (*jsdefinepropop)(
jscontext *cx, jsobject *obj, jsid id, jsval value, jspropertyop getter, jspropertyop setter, unsigned int attrs); name type description cx
jscontext * pointer to the js context in which the property is being defined.
JSObjectOps.destroyObjectMap
syntax typedef void (*jsobjectmapop)(
jscontext *cx, jsobjectmap *map); name type description cx
jscontext * pointer to the js context in which garbage collection is happening.
JSObjectOps.dropProperty
syntax typedef void (*jspropertyrefop)(
jscontext *cx, jsobject *obj, jsproperty *prop); name type description cx
jscontext * a context that was the cx argument to an earlier call to jsobjectops.lookupproperty that found a property.
JSObjectOps.getAttributes
syntax typedef jsbool (*jsattributesop)(
jscontext *cx, jsobject *obj, jsid id, jsproperty *prop, unsigned int *attrsp); name type description cx
jscontext * pointer to the js context in which the property access is happening.
JSObjectOps.getProperty
syntax typedef jsbool (*jspropertyidop)(
jscontext *cx, jsobject *obj, jsid id, jsval *vp); name type description cx
jscontext * pointer to the js context in which the property access is happening.
JSObjectOps.getRequiredSlot
syntax typedef jsval (*jsgetrequiredslotop)(
jscontext *cx, jsobject *obj, uint32 slot); typedef jsbool (*jssetrequiredslotop)(
jscontext *cx, jsobject *obj, uint32 slot, jsval v); name type description cx
jscontext * the js context in which we access the slot.
JSObjectOps.lookupProperty
syntax typedef jsbool (*jslookuppropop)(
jscontext *cx, jsobject *obj, jsid id, jsobject **objp, jsproperty **propp); name type description cx
jscontext * pointer to the js context in which the property lookup is happening.
JSObjectOps.newObjectMap
syntax typedef jsobjectmap * (*jsnewobjectmapop)(
jscontext *cx, jsrefcount nrefs, jsobjectops *ops, jsclass *clasp, jsobject *obj); name type description cx
jscontext * pointer to the js context in which the new object is being created.
JSObjectOps.setProto
syntax typedef jsbool (*jssetobjectslotop)(
jscontext *cx, jsobject *obj, uint32 slot, jsobject *pobj); name type description cx
jscontext * pointer to the js context in which the object's prototype or parent is being modified.
JSObjectPrincipalsFinder
callback syntax typedef jsprincipals * (* jsobjectprincipalsfinder)(
jscontext *cx, jsobject *obj); name type description cx
jscontext * the context in which to find principals.
JSPRINCIPALS_HOLD
syntax jsprincipals_hold(cx, principals) jsprincipals_drop(cx, principals) name type description cx
jscontext * a context.
JSPropertyOp
syntax typedef bool (* jspropertyop)(
jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandlevalue vp); typedef bool (* jsstrictpropertyop)(
jscontext *cx, js::handleobject obj, js::handleid id, bool strict, js::mutablehandlevalue vp); // added in spidermonkey 1.9.3 name type description cx
jscontext * the context in which the property access is taking place.
JSReserveSlotsOp
syntax typedef uint32 (* jsreserveslotsop)(
jscontext *cx, jsobject *obj); name type description cx
jscontext * the js context in which the new object is being created.
JSResolveOp
syntax typedef bool (* jsresolveop)(
jscontext *cx, js::handleobject obj, js::handleid id, bool *resolvedp); // added in jsapi 36 typedef bool (* jsresolveop)(
jscontext *cx, js::handleobject obj, js::handleid id); // obsolete since jsapi 36 name type description cx
jscontext * pointer to the js context in which the property access is taking place.
JSSecurityCallbacks.contentSecurityPolicyAllows
(it is also the type of the callback set by js_setcheckobjectaccesscallback.) syntax typedef jsbool (*jscspevalchecker)(
jscontext *cx); name type description cx
jscontext * the js context in which the property access attempt is occurring.
JS_AddExternalStringFinalizer
callback syntax typedef void (*jsstringfinalizeop)(
jscontext *cx, jsstring *str); name type description cx
jscontext * pointer to a
jscontext which the finalizer may use for certain very limited operations (not documented).
JS_CheckForInterrupt
syntax bool js_checkforinterrupt(
jscontext* cx); name type description cx </code>
jscontext *<code> the context.
JS_ClearNewbornRoots
syntax void js_clearnewbornroots(
jscontext *cx); name type description cx
jscontext * the context to clear.
JS_CompareStrings
syntax bool js_comparestrings(
jscontext *cx, jsstring *str1, jsstring *str2, int32_t *result); name type description cx
jscontext * the context to which both strings must belong.
JS_ConcatStrings
syntax jsstring * js_concatstrings(
jscontext *cx, js::handlestring left, js::handlestring right); name type description cx
jscontext * the context in which both the strings have been created.
JS_DestroyIdArray
syntax void js_destroyidarray(
jscontext *cx, jsidarray *ida); name type description cx
jscontext * a context.
JS_EncodeCharacters
syntax jsbool js_encodecharacters(
jscontext *cx, const jschar *src, size_t srclen, char *dst, size_t *dstlen); name type description cx
jscontext * a context.
JS_EnumerateResolvedStandardClasses
syntax jsidarray * js_enumerateresolvedstandardclasses(
jscontext *cx, jsobject *obj, jsidarray *ida); name type description description js_enumerateresolvedstandardclasses enumerates any already-resolved standard class ids into ida, or into a new jsidarray if ida is null.
JS_ErrorFromException
syntax jserrorreport * js_errorfromexception(
jscontext *cx, js::handleobject obj); name type description cx
jscontext * pointer to a js context whose errors should be reported via your function.
JS_GetContextThread
syntax int js_getcontextthread(
jscontext *cx); name type description cx
jscontext * the context to examine.
JS_GetErrorPrototype
syntax jsobject * js_geterrorprototype(
jscontext *cx); name type description cx
jscontext * pointer to a js context whose errors should be reported via your function.
JS_GetInstancePrivate
syntax void * js_getinstanceprivate(
jscontext *cx, js::handle<jsobject*> obj, const jsclass *clasp, js::callargs *args); // added in jsapi 32 void * js_getinstanceprivate(
jscontext *cx, js::handle<jsobject*> obj, const jsclass *clasp, jsval *argv); // obsolete since jsapi 32 name type description cx
jscontext * a context.
JS_GetNaNValue
syntax // added in spidermonkey 42 js::value js_getnanvalue(
jscontext *cx); // obsolete since spidermonkey 42 jsval js_getnanvalue(
jscontext *cx); name type description cx
jscontext * a context.
JS_GetPositiveInfinityValue
syntax // added in spidermonkey 42 js::value js_getpositiveinfinityvalue(
jscontext *cx); js::value js_getnegativeinfinityvalue(
jscontext *cx); // obsolete since spidermonkey 42 jsval js_getpositiveinfinityvalue(
jscontext *cx); jsval js_getnegativeinfinityvalue(
jscontext *cx); name type description cx
jscontext * a context.
JS_GetRegExpFlags
syntax unsigned js_getregexpflags(
jscontext *cx, handleobject obj) name type description cx
jscontext * a context.
JS_GetRegExpSource
syntax jsstring * js_getregexpsource(
jscontext *cx, js::handleobject obj); name type description cx
jscontext * a context.
JS_GetScopeChain
syntax jsobject * js_getscopechain(
jscontext *cx); name type description cx
jscontext * the context to query.
JS_GetSecurityCallbacks
syntax /* added in spidermonkey 17 */ void js_setsecuritycallbacks(jsruntime *rt, const jssecuritycallbacks *callbacks); const jssecuritycallbacks * js_getsecuritycallbacks(jsruntime *rt); /* obsolete since jsapi 13 */ jssecuritycallbacks * js_setcontextsecuritycallbacks(
jscontext *cx, jssecuritycallbacks *callbacks); jssecuritycallbacks * js_getruntimesecuritycallbacks(jsruntime *rt); jssecuritycallbacks * js_setruntimesecuritycallbacks(jsruntime *rt, jssecuritycallbacks *callbacks); name type description rt jsruntime * a runtime to get/set the security callbacks.
JS_GetStringBytes
syntax char * js_getstringbytes(jsstring *str); const char * js_getstringbytesz(
jscontext *cx, jsstring *str); // added in jsapi 1.8.2 name type description cx
jscontext * (js_getstringbytesz and js_encodestring only) a context.
JS_GetStringChars
syntax jschar * js_getstringchars(jsstring *str); // obsolete since jsapi 1.8.5 const jschar * js_getstringcharsz(
jscontext *cx, jsstring *str); // added in spidermonkey 1.8.2, obsolete since jsapi 33 name type description cx
jscontext * (in js_getstringcharsz only) a context.
JS_GetTypeName
syntax const char * js_gettypename(
jscontext *cx, jstype type); name type description cx
jscontext * pointer to a js context from which to derive runtime information.
JS_IdArrayGet
syntax jsid js_idarrayget(
jscontext *cx, jsidarray *ida, unsigned index) name type description cx
jscontext * a context.
JS_IdArrayLength
syntax int js_idarraylength(
jscontext *cx, jsidarray *ida); name type description cx
jscontext * a context.
JS_IsArrayObject
syntax bool js_isarrayobject(
jscontext *cx, js::handlevalue value, bool *isarray); bool js_isarrayobject(
jscontext *cx, js::handleobject obj, bool *isarray); // obsolete since jsapi 44 bool js_isarrayobject(
jscontext *cx, js::handlevalue value); bool js_isarrayobject(
jscontext *cx, js::handleobject obj); name type description cx
jscontext * a context.
JS_IsAssigning
syntax jsbool js_isassigning(
jscontext *cx); name type description description js_isassigning returns true if a script is executing and its current bytecode is a set (assignment) operation, even if there are native (no script) stack frames between the script and the caller to js_isassigning.
JS_IsConstructing
syntax jsbool js_isconstructing(
jscontext *cx, jsval *vp); name type description cx
jscontext * the cx parameter passed to the jsnative.
JS_IsExceptionPending
syntax bool js_isexceptionpending(
jscontext *cx); name type description cx
jscontext * pointer to a js context to check for pending exceptions.
JS_updateMallocCounter
syntax void js_updatemalloccounter(
jscontext *cx, size_t nbytes); name type description cx
jscontext * pointer to a js context to decrement the malloc counter.
SpiderMonkey 1.8.8
removal of
jscontext* parameters to many methods the js_getclass method now takes only a jsobject*, where previously it also required a
jscontext* in threadsafe builds.
SpiderMonkey 17
removal of
jscontext* parameters to many methods the js_getclass method now takes only a jsobject*, where previously it also required a
jscontext* in threadsafe builds.
Split object
but there is a special case when js_getscopechain is called on a
jscontext in which no code is currently running.
Secure Development Guidelines
0xffffffff; printf(“foo: 0x%08x\r\n”, foo); foo++; printf(“foo: 0x%08x\r\n”, foo); } integer overflows/underflows example of an integer underflow int main() { unsigned int foo = 0; printf(“foo: 0x%08x\r\n”, foo); foo--; printf(“foo: 0x%08x\r\n”, foo); } integer overflows/underflows real-life example (bug 303213) jsbool js_str_escape(
jscontext *cx, jsobject *obj, unsigned int argc, jsval *argv, jsval *rval){ ...
XPCOM hashtable guide
a few examples: a hashtable that maps utf-8 origin names to a dom window - nsinterfacehashtable<nscstringhashkey, nsidomwindow> a hashtable that maps 32 bit integers to floats - nsdatahashtable<nsuint32hashkey, float> a hashtable that maps nsisupports pointers to reference counted cacheentrys - nsrefptrhashtable<nsisupportshashkey, cacheentry> a hashtable that maps
jscontext pointers to a contextinfo struct - nsclasshashtable<nsptrhashkey<
jscontext>, contextinfo> a hashset of strings - nsthashtable<nsstringhashkey> hashtable api the hashtable classes all expose the same basic api.
inIDOMUtils
implemented by: @mozilla.org/inspector/dom-utils;1 as a service: var inidomutils = components.classes["@mozilla.org/inspector/dom-utils;1"] .getservice(components.interfaces.inidomutils); method overview void addpseudoclasslock(in nsidomelement aelement, in domstring apseudoclass); void clearpseudoclasslocks(in nsidomelement aelement); [implicit_
jscontext] jsval colornametorgb(in domstring acolorname); nsiarray getbindingurls(in nsidomelement aelement); nsidomnodelist getchildrenfornode(in nsidomnode anode, in boolean ashowinganonymouscontent); unsigned long long getcontentstate(in nsidomelement aelement); void getcsspropertynames([optional] in unsigned long aflags, [optional] out unsigned long acount, [retval,...
nsIDOMHTMLAudioElement
last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) inherits from: nsidomhtmlmediaelement method overview unsigned long long mozcurrentsampleoffset(); void mozsetup(in pruint32 channels, in pruint32 rate); [implicit_
jscontext] unsigned long mozwriteaudio(in jsval data); methods mozcurrentsampleoffset() non-standard this feature is non-standard and is not on a standards track.
Debugger.Memory - Firefox Developer Tools
“alloc_trigger” “debug_gc” “compartment_revived” “reset” “out_of_nursery” “evict_nursery” “full_store_buffer” “shared_memory_limit” “periodic_full_gc” “incremental_too_slow” “dom_window_utils” “component_utils” “mem_pressure” “cc_waiting” “cc_forced” “load_end” “page_hide” “ns
jscontext_destroy” “set_new_document” “set_doc_shell” “dom_utils” “dom_ipc” “dom_worker” “inter_slice_gc” “refresh_frame” “full_gc_timer” “shutdown_cc” “user_inactive” nonincrementalreason if spidermonkey’s collector determined it could not incrementally collect garbage, and had to do a full gc all at once, this is a sho...