summaryrefslogtreecommitdiffstats
path: root/dom/bindings/CallbackInterface.h
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--dom/bindings/CallbackInterface.h50
1 files changed, 50 insertions, 0 deletions
diff --git a/dom/bindings/CallbackInterface.h b/dom/bindings/CallbackInterface.h
new file mode 100644
index 0000000000..4cb46217c2
--- /dev/null
+++ b/dom/bindings/CallbackInterface.h
@@ -0,0 +1,50 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* 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/. */
+
+/**
+ * A common base class for representing WebIDL callback interface types in C++.
+ *
+ * This class implements common functionality like lifetime management,
+ * initialization with the callback object, and setup of the call environment.
+ * Subclasses corresponding to particular callback interface types should
+ * provide methods that actually do the various necessary calls.
+ */
+
+#ifndef mozilla_dom_CallbackInterface_h
+#define mozilla_dom_CallbackInterface_h
+
+#include "mozilla/dom/CallbackObject.h"
+
+namespace mozilla::dom {
+
+class CallbackInterface : public CallbackObject {
+ public:
+ // See CallbackObject for an explanation of the arguments.
+ explicit CallbackInterface(JSContext* aCx, JS::Handle<JSObject*> aCallback,
+ JS::Handle<JSObject*> aCallbackGlobal,
+ nsIGlobalObject* aIncumbentGlobal)
+ : CallbackObject(aCx, aCallback, aCallbackGlobal, aIncumbentGlobal) {}
+
+ // See CallbackObject for an explanation of the arguments.
+ explicit CallbackInterface(JSObject* aCallback, JSObject* aCallbackGlobal,
+ JSObject* aAsyncStack,
+ nsIGlobalObject* aIncumbentGlobal)
+ : CallbackObject(aCallback, aCallbackGlobal, aAsyncStack,
+ aIncumbentGlobal) {}
+
+ protected:
+ bool GetCallableProperty(BindingCallContext& cx, JS::Handle<jsid> aPropId,
+ JS::MutableHandle<JS::Value> aCallable);
+
+ // See CallbackObject for an explanation of the arguments.
+ CallbackInterface(JSObject* aCallback, JSObject* aCallbackGlobal,
+ const FastCallbackConstructor&)
+ : CallbackObject(aCallback, aCallbackGlobal, FastCallbackConstructor()) {}
+};
+
+} // namespace mozilla::dom
+
+#endif // mozilla_dom_CallbackFunction_h