gecko/dom/bindings/CallbackFunction.h
Boris Zbarsky c71174d98b Bug 822470 part 1. Factor out the code that callback functions and callback interfaces will be able to share into a CallbackObject class. r=peterv
--HG--
rename : dom/bindings/CallbackFunction.cpp => dom/bindings/CallbackObject.cpp
rename : dom/bindings/CallbackFunction.h => dom/bindings/CallbackObject.h
2013-01-28 08:34:29 -05:00

64 lines
1.9 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* 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 function types in C++.
*
* This class implements common functionality like lifetime
* management, initialization with the callable, and setup of the call
* environment. Subclasses corresponding to particular callback
* function types should provide a Call() method that actually does
* the call.
*/
#ifndef mozilla_dom_CallbackFunction_h
#define mozilla_dom_CallbackFunction_h
#include "mozilla/dom/CallbackObject.h"
namespace mozilla {
namespace dom {
class CallbackFunction : public CallbackObject
{
public:
/**
* Create a CallbackFunction. aCallable is the callable we're wrapping.
* aOwner is the object that will be receiving this CallbackFunction as a
* method argument, if any. We need this so we can store our callable in the
* same compartment as our owner. If *aInited is set to false, an exception
* has been thrown.
*/
CallbackFunction(JSContext* cx, JSObject* aOwner, JSObject* aCallable,
bool* aInited)
: CallbackObject(cx, aOwner, aCallable, aInited)
{
MOZ_ASSERT(JS_ObjectIsCallable(cx, aCallable));
}
JSObject* Callable() const
{
return Callback();
}
bool HasGrayCallable() const
{
// Play it safe in case this gets called after unlink.
return mCallback && xpc_IsGrayGCThing(mCallback);
}
protected:
explicit CallbackFunction(CallbackFunction* aCallbackFunction)
: CallbackObject(aCallbackFunction)
{
}
};
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_CallbackFunction_h