summaryrefslogtreecommitdiff
path: root/src/third_party/mozjs-60/include/js/Realm.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/third_party/mozjs-60/include/js/Realm.h')
-rw-r--r--src/third_party/mozjs-60/include/js/Realm.h124
1 files changed, 124 insertions, 0 deletions
diff --git a/src/third_party/mozjs-60/include/js/Realm.h b/src/third_party/mozjs-60/include/js/Realm.h
new file mode 100644
index 00000000000..4afc895440e
--- /dev/null
+++ b/src/third_party/mozjs-60/include/js/Realm.h
@@ -0,0 +1,124 @@
+/* -*- 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*> : public NonGCPointerPolicy<Realm*>
+{
+ 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);
+
+} // namespace JS
+
+#endif // js_Realm_h
+
+