diff options
author | initial.commit <initial.commit@0039d316-1c4b-4281-b951-d872f2087c98> | 2008-07-27 00:20:51 +0000 |
---|---|---|
committer | initial.commit <initial.commit@0039d316-1c4b-4281-b951-d872f2087c98> | 2008-07-27 00:20:51 +0000 |
commit | f5b16fed647e941aa66933178da85db2860d639b (patch) | |
tree | f00e9856c04aad3b558a140955e7674add33f051 /webkit/activex_shim/dispatch_object.h | |
parent | 920c091ac3ee15079194c82ae8a7a18215f3f23c (diff) | |
download | chromium_src-f5b16fed647e941aa66933178da85db2860d639b.zip chromium_src-f5b16fed647e941aa66933178da85db2860d639b.tar.gz chromium_src-f5b16fed647e941aa66933178da85db2860d639b.tar.bz2 |
Add webkit to the repository.
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@18 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'webkit/activex_shim/dispatch_object.h')
-rw-r--r-- | webkit/activex_shim/dispatch_object.h | 149 |
1 files changed, 149 insertions, 0 deletions
diff --git a/webkit/activex_shim/dispatch_object.h b/webkit/activex_shim/dispatch_object.h new file mode 100644 index 0000000..f342448 --- /dev/null +++ b/webkit/activex_shim/dispatch_object.h @@ -0,0 +1,149 @@ +// Copyright 2008, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +#ifndef WEBKIT_ACTIVEX_SHIM_DISPATCH_OBJECT_H__ +#define WEBKIT_ACTIVEX_SHIM_DISPATCH_OBJECT_H__ + +#include <oaidl.h> + +#include <list> + +#include "base/scoped_ptr.h" +#include "webkit/glue/plugins/nphostapi.h" + +namespace activex_shim { + +struct DispatchNPObject; + +// DispatchObject provides service to translate calls on NPObject to the +// underlying IDispatch interface. It is isolated from the ActiveXPlugin, so +// that when we have scripts like: +// wmp.controls.stop(); +// We can create a spawned dispatch object for "controls" -- an IDispatch +// interface returned from property "controls" of the wmp activex control. +class DispatchObject { + public: + DispatchObject(DispatchObject* root); + virtual ~DispatchObject(); + + // This is used when NPP_GetValue is called by browser and asked for + // NPPVpluginScriptableNPObject. + NPObject* GetScriptableNPObject(); + + // Object scripting + NPObject* NPAllocate(NPClass* theClass); + void NPInvalidate(); + bool NPHasMethod(NPIdentifier name); + bool NPHasProperty(NPIdentifier name); + bool NPInvoke(NPIdentifier name, const NPVariant* args, + uint32_t argCount, NPVariant* result); + bool NPInvokeDefault(const NPVariant* args, uint32_t argCount, + NPVariant* result); + bool NPGetProperty(NPIdentifier name, NPVariant* variant); + bool NPSetProperty(NPIdentifier name, const NPVariant* variant); + bool NPRemoveProperty(NPIdentifier propertyName); + + // Called by NPDeallocate so that we can remove our reference. + void OnDeallocateObject(DispatchNPObject* obj); + DispatchObject* root() { return root_== NULL ? this : root_; } + // Only the root object needs to take care of this. + void AddSpawned(DispatchObject* obj); + // If a spawned child is released earlier than the root object, it needs to + // call this function to remove itself from the children list, to avoid + // another destruction when the root object is being destructed. + void RemoveSpawned(DispatchObject* obj); + + protected: + // Only the root object can release spawned dispatch object. The root object + // is coupled with the actual ActiveX control. Thus if the control is dead + // we must also release all Dispatch interfaces from that control. + void ReleaseSpawned(); + // root_ is the owner of this object. If root_ == NULL, then this object + // itself is the root. + DispatchObject* const root_; + + private: + typedef std::list<DispatchObject*> SpawnedChildrenList; + + // Must be overrided by subclass to be functional. + virtual IDispatch* GetDispatch() = 0; + // If this is true, when the related npobject is released, it should delete + // this object as well. + virtual bool NPObjectOwnsMe() = 0; + + // We create only one NPObject per ActiveXPlugin. It may have different life + // span than ActiveXPlugin thus we need a separate object created + // specifically for this purpose. + DispatchNPObject* npobject_; + // A list of spawned children from this root object (if it is). + SpawnedChildrenList spawned_children_; + bool deleting_spawned_children_; +}; + +// The spawned dipatch object contains a reference to an IDispatch interface +// that it owns. Its lifetime is controlled by the lifetime of related +// NPObject, and the root DispatchObject it is spawned from. +class SpawnedDispatchObject : public DispatchObject { + public: + // Constructor will addref to the dispatch interface, and add itself to + // spawned children of root. + SpawnedDispatchObject(IDispatch* dispatch, DispatchObject* root); + ~SpawnedDispatchObject(); + + private: + virtual IDispatch* GetDispatch() { return dispatch_; } + virtual bool NPObjectOwnsMe() { return true; } + + IDispatch* dispatch_; +}; + +// A simple extension of the NPObject. So that we can put additional information +// like who is the underlying DispatchObject with the NPObject. When methods of +// NPObject are requested we can resort to the DispatchObject to handle them. +struct DispatchNPObject : public NPObject { + DispatchObject* dispatch_object; +}; + +// These functions are to support scriptable plugin object. +NPObject* NPAllocate(NPP npp, NPClass* theClass); +void NPDeallocate(NPObject* obj); +void NPInvalidate(NPObject* obj); +bool NPHasMethod(NPObject* obj, NPIdentifier name); +bool NPInvoke(NPObject* obj, NPIdentifier name, const NPVariant* args, + uint32_t argCount, NPVariant* result); +bool NPInvokeDefault(NPObject* obj, const NPVariant* args, uint32_t argCount, + NPVariant* result); +bool NPHasProperty(NPObject* obj, NPIdentifier name); +bool NPGetProperty(NPObject* obj, NPIdentifier name, NPVariant* variant); +bool NPSetProperty(NPObject* obj, NPIdentifier name, const NPVariant* variant); +bool NPRemoveProperty(NPObject* npobj, NPIdentifier propertyName); + +} // namespace activex_shim + +#endif // #ifndef WEBKIT_ACTIVEX_SHIM_DISPATCH_OBJECT_H__ |