tools/npapi_runtime/npobject_stub.h

   1 /*
   2  * Copyright 2008, Google Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32
  33 // NaCl-NPAPI Interface
  34
  35 #ifndef NATIVE_CLIENT_TOOLS_NPAPI_RUNTIME_NPOBJECT_STUB_H_
  36 #define NATIVE_CLIENT_TOOLS_NPAPI_RUNTIME_NPOBJECT_STUB_H_
  37
  38 #include "native_client/tools/npapi_runtime/nacl_npapi.h"
  39
  40 #include "native_client/tools/npapi_runtime/npcapability.h"
  41 #include "native_client/tools/npapi_runtime/nprpc.h"
  42
  43 namespace nacl {
  44
  45 class NPBridge;
  46 class RpcArg;
  47
  48 // An NPObjectStub wraps an NPObject and converts IMC messages from
  49 // NPObjectProxy to calls to the object.
  50 class NPObjectStub {
  51   // The NPBridge that manages this stub instance.
  52   NPBridge* bridge_;
  53   // The NPObject for which this stub instance is created.
  54   NPObject* object_;
  55
  56  public:
  57   // Creates a new instance of NPObjectStub within the specified bridge for
  58   // the specified local NPObject.
  59   NPObjectStub(NPBridge* bridge, NPObject* object);
  60   ~NPObjectStub();
  61
  62   // Returns true if this stub instance is created for the local NPObject
  63   // represented by the specified capability.
  64   bool IsMatch(const NPCapability& capability) const {
  65     return object_ == capability.object;
  66   }
  67
  68   NPObject* object() const {
  69     return object_;
  70   }
  71
  72   // Dispatches the request message received from the remote NPObjectProxy
  73   // object.
  74   int Dispatch(RpcHeader* request, int len);
  75
  76   // NPClass methods. NPObjectStub forwards these RPC requests received from
  77   // the remote NPObjectProxy object to object_;
  78   bool Invalidate(RpcArg* arg);
  79   bool HasMethod(RpcArg* arg);
  80   bool Invoke(uint32_t arg_count, RpcArg* arg, NPVariant* result);
  81   bool InvokeDefault(uint32_t arg_count, RpcArg* arg, NPVariant* result);
  82   bool HasProperty(RpcArg* arg);
  83   bool GetProperty(RpcArg* arg, NPVariant* result);
  84   bool SetProperty(RpcArg* arg);
  85   bool RemoveProperty(RpcArg* arg);
  86   bool Enumeration(RpcArg* arg);
  87   bool Construct(uint32_t arg_count, RpcArg* arg, NPVariant* result);
  88
  89   // Processes NPN_SetException() request from the remote proxy object.
  90   void SetException(const NPUTF8* message);
  91 };
  92
  93 }  // namespace nacl
  94
  95 #endif  // NATIVE_CLIENT_TOOLS_NPAPI_RUNTIME_NPOBJECT_STUB_H_