1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
3 /* This Source Code Form is subject to the terms of the Mozilla Public
4  * License, v. 2.0. If a copy of the MPL was not distributed with this
5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6 
7 /**
8  * A common base class for representing WebIDL callback function types in C++.
9  *
10  * This class implements common functionality like lifetime
11  * management, initialization with the callable, and setup of the call
12  * environment.  Subclasses corresponding to particular callback
13  * function types should provide a Call() method that actually does
14  * the call.
15  */
16 
17 #ifndef mozilla_dom_CallbackFunction_h
18 #define mozilla_dom_CallbackFunction_h
19 
20 #include "mozilla/dom/CallbackObject.h"
21 
22 namespace mozilla {
23 namespace dom {
24 
25 class CallbackFunction : public CallbackObject {
26  public:
27   // See CallbackObject for an explanation of the arguments.
CallbackFunction(JSContext * aCx,JS::Handle<JSObject * > aCallable,nsIGlobalObject * aIncumbentGlobal)28   explicit CallbackFunction(JSContext* aCx, JS::Handle<JSObject*> aCallable,
29                             nsIGlobalObject* aIncumbentGlobal)
30       : CallbackObject(aCx, aCallable, aIncumbentGlobal) {}
31 
32   // See CallbackObject for an explanation of the arguments.
CallbackFunction(JS::Handle<JSObject * > aCallable,JS::Handle<JSObject * > aAsyncStack,nsIGlobalObject * aIncumbentGlobal)33   explicit CallbackFunction(JS::Handle<JSObject*> aCallable,
34                             JS::Handle<JSObject*> aAsyncStack,
35                             nsIGlobalObject* aIncumbentGlobal)
36       : CallbackObject(aCallable, aAsyncStack, aIncumbentGlobal) {}
37 
CallableOrNull()38   JS::Handle<JSObject*> CallableOrNull() const { return CallbackOrNull(); }
39 
CallablePreserveColor()40   JS::Handle<JSObject*> CallablePreserveColor() const {
41     return CallbackPreserveColor();
42   }
43 
HasGrayCallable()44   bool HasGrayCallable() const {
45     // Play it safe in case this gets called after unlink.
46     return mCallback && JS::ObjectIsMarkedGray(mCallback);
47   }
48 
49  protected:
CallbackFunction(CallbackFunction * aCallbackFunction)50   explicit CallbackFunction(CallbackFunction* aCallbackFunction)
51       : CallbackObject(aCallbackFunction) {}
52 
53   // See CallbackObject for an explanation of the arguments.
CallbackFunction(JS::Handle<JSObject * > aCallable,const FastCallbackConstructor &)54   CallbackFunction(JS::Handle<JSObject*> aCallable,
55                    const FastCallbackConstructor&)
56       : CallbackObject(aCallable, FastCallbackConstructor()) {}
57 };
58 
59 }  // namespace dom
60 }  // namespace mozilla
61 
62 #endif  // mozilla_dom_CallbackFunction_h
63