gecko/dom/bindings/CallbackInterface.h

60 lines
1.9 KiB
C
Raw Normal View History

/* -*- 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 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 {
namespace dom {
class CallbackInterface : public CallbackObject
{
public:
/**
* Create a CallbackInterface. aCallback is the callback object we're
* wrapping. aOwner is the object that will be receiving this
* CallbackInterface 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.
*/
CallbackInterface(JSContext* cx, JSObject* aOwner, JSObject* aCallback,
bool* aInited)
: CallbackObject(cx, aOwner, aCallback, aInited)
{
}
/*
* Create a CallbackInterface without any sort of interesting games with
* compartments, for cases when you want to just use the existing object
* as-is. This constructor can never fail.
*/
explicit CallbackInterface(JSObject* aCallback)
: CallbackObject(aCallback)
{
}
protected:
bool GetCallableProperty(JSContext* cx, const char* aPropName,
JS::Value* aCallable);
};
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_CallbackFunction_h