mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-10 03:45:46 +00:00
ddaf859c55
This also introduces JS::GetObjectRealmOrNull, which returns an object's realm, or null if the object is a cross-compartment wrapper. In the new order, wrappers can't have realms, since they must be shared across all realms in a compartment. We're introducing this new function early (even though it's *currently* possible to assign a realm to wrappers) in order to see in advance if the possibility of returning null will cause problems. (It looks like it won't.) --HG-- extra : rebase_source : e55ebbbc4edf2a18ce267198928246592060e339 extra : source : d6bfce1187aa13dbfab03f9566ff7b05b6705e70
137 lines
4.3 KiB
C++
137 lines
4.3 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
* vim: set ts=8 sts=4 et sw=4 tw=99:
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
/*
|
|
* Ways to get various per-Realm objects. All the getters declared in this
|
|
* header operate on the Realm corresponding to the current compartment on the
|
|
* JSContext.
|
|
*/
|
|
|
|
#ifndef js_Realm_h
|
|
#define js_Realm_h
|
|
|
|
#include "jspubtd.h"
|
|
#include "js/GCPolicyAPI.h"
|
|
#include "js/TypeDecls.h" // forward-declaration of JS::Realm
|
|
|
|
namespace js {
|
|
namespace gc {
|
|
JS_PUBLIC_API(void) TraceRealm(JSTracer* trc, JS::Realm* realm, const char* name);
|
|
JS_PUBLIC_API(bool) RealmNeedsSweep(JS::Realm* realm);
|
|
}
|
|
}
|
|
|
|
namespace JS {
|
|
|
|
// Each Realm holds a strong reference to its GlobalObject, and vice versa.
|
|
template <>
|
|
struct GCPolicy<Realm*>
|
|
{
|
|
static Realm* initial() { return nullptr; }
|
|
static void trace(JSTracer* trc, Realm** vp, const char* name) {
|
|
if (*vp)
|
|
::js::gc::TraceRealm(trc, *vp, name);
|
|
}
|
|
static bool needsSweep(Realm** vp) {
|
|
return *vp && ::js::gc::RealmNeedsSweep(*vp);
|
|
}
|
|
};
|
|
|
|
// Get the current realm, if any. The ECMAScript spec calls this "the current
|
|
// Realm Record".
|
|
extern JS_PUBLIC_API(Realm*)
|
|
GetCurrentRealmOrNull(JSContext* cx);
|
|
|
|
// Return the compartment that contains a given realm.
|
|
inline JSCompartment*
|
|
GetCompartmentForRealm(Realm* realm) {
|
|
// Implementation note: For now, realms are a fiction; we treat realms and
|
|
// compartments as being one-to-one, but they are actually identical.
|
|
return reinterpret_cast<JSCompartment*>(realm);
|
|
}
|
|
|
|
// Return the realm in a given compartment.
|
|
//
|
|
// Deprecated. There is currently exactly one realm per compartment, but this
|
|
// will change.
|
|
inline Realm*
|
|
GetRealmForCompartment(JSCompartment* compartment) {
|
|
return reinterpret_cast<Realm*>(compartment);
|
|
}
|
|
|
|
// Return an object's realm. All objects except cross-compartment wrappers are
|
|
// created in a particular realm, which never changes. Returns null if obj is
|
|
// a cross-compartment wrapper.
|
|
extern JS_PUBLIC_API(Realm*)
|
|
GetObjectRealmOrNull(JSObject* obj);
|
|
|
|
// Get the value of the "private data" internal field of the given Realm.
|
|
// This field is initially null and is set using SetRealmPrivate.
|
|
// It's a pointer to embeddding-specific data that SpiderMonkey never uses.
|
|
extern JS_PUBLIC_API(void*)
|
|
GetRealmPrivate(Realm* realm);
|
|
|
|
// Set the "private data" internal field of the given Realm.
|
|
extern JS_PUBLIC_API(void)
|
|
SetRealmPrivate(Realm* realm, void* data);
|
|
|
|
typedef void
|
|
(* DestroyRealmCallback)(JSFreeOp* fop, Realm* realm);
|
|
|
|
// Set the callback SpiderMonkey calls just before garbage-collecting a realm.
|
|
// Embeddings can use this callback to free private data associated with the
|
|
// realm via SetRealmPrivate.
|
|
//
|
|
// By the time this is called, the global object for the realm has already been
|
|
// collected.
|
|
extern JS_PUBLIC_API(void)
|
|
SetDestroyRealmCallback(JSContext* cx, DestroyRealmCallback callback);
|
|
|
|
typedef void
|
|
(* RealmNameCallback)(JSContext* cx, Handle<Realm*> realm, char* buf, size_t bufsize);
|
|
|
|
// Set the callback SpiderMonkey calls to get the name of a realm, for
|
|
// diagnostic output.
|
|
extern JS_PUBLIC_API(void)
|
|
SetRealmNameCallback(JSContext* cx, RealmNameCallback callback);
|
|
|
|
// Get the global object for the given realm. Returns null only if `realm` is
|
|
// in the atoms compartment.
|
|
extern JS_PUBLIC_API(JSObject*)
|
|
GetRealmGlobalOrNull(Handle<Realm*> realm);
|
|
|
|
extern JS_PUBLIC_API(JSObject*)
|
|
GetRealmObjectPrototype(JSContext* cx);
|
|
|
|
extern JS_PUBLIC_API(JSObject*)
|
|
GetRealmFunctionPrototype(JSContext* cx);
|
|
|
|
extern JS_PUBLIC_API(JSObject*)
|
|
GetRealmArrayPrototype(JSContext* cx);
|
|
|
|
extern JS_PUBLIC_API(JSObject*)
|
|
GetRealmErrorPrototype(JSContext* cx);
|
|
|
|
extern JS_PUBLIC_API(JSObject*)
|
|
GetRealmIteratorPrototype(JSContext* cx);
|
|
|
|
/**
|
|
* Change the JS language version for the current Realm. This is discouraged,
|
|
* but necessary to support the `version()` builtin function in the js and xpc
|
|
* shells.
|
|
*
|
|
* It would be nice to put this in jsfriendapi, but the linkage requirements
|
|
* of the shells make that impossible.
|
|
*/
|
|
JS_PUBLIC_API(void)
|
|
SetVersionForCurrentRealm(JSContext* cx, JSVersion version);
|
|
|
|
} // namespace JS
|
|
|
|
#endif // js_Realm_h
|
|
|
|
|