Replace NPObject usage in ppapi with gin

content/renderer/pepper/host_var_tracker.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CONTENT_RENDERER_PEPPER_HOST_VAR_TRACKER_H_
 #define CONTENT_RENDERER_PEPPER_HOST_VAR_TRACKER_H_
 
 #include <map>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/containers/hash_tables.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/linked_ptr.h"
 #include "base/memory/ref_counted.h"
 #include "content/common/content_export.h"
 #include "ppapi/c/pp_instance.h"
 #include "ppapi/shared_impl/host_resource.h"
 #include "ppapi/shared_impl/resource_tracker.h"
 #include "ppapi/shared_impl/var_tracker.h"
 #include "v8/include/v8.h"
 
-typedef struct NPObject NPObject;
-
 namespace ppapi {
 class ArrayBufferVar;
-class NPObjectVar;
 class V8ObjectVar;
 class Var;
 }
 
 namespace content {
 
-// Adds NPObject var tracking to the standard PPAPI VarTracker for use in the
-// renderer.
 class HostVarTracker : public ppapi::VarTracker {
  public:
   HostVarTracker();
   virtual ~HostVarTracker();
 
-  // Tracks all live NPObjectVar. This is so we can map between instance +
-  // NPObject and get the NPObjectVar corresponding to it. This Add/Remove
-  // function is called by the NPObjectVar when it is created and
-  // destroyed.
-  void AddNPObjectVar(ppapi::NPObjectVar* object_var);
-  void RemoveNPObjectVar(ppapi::NPObjectVar* object_var);
-
-  // Looks up a previously registered NPObjectVar for the given NPObject and
-  // instance. Returns NULL if there is no NPObjectVar corresponding to the
-  // given NPObject for the given instance. See AddNPObjectVar above.
-  ppapi::NPObjectVar* NPObjectVarForNPObject(PP_Instance instance,
-                                             NPObject* np_object);
-
-  // Returns the number of NPObjectVar's associated with the given instance.
-  // Returns 0 if the instance isn't known.
-  CONTENT_EXPORT int GetLiveNPObjectVarsForInstance(PP_Instance instance) const;
-
   // Tracks all live V8ObjectVar. This is so we can map between instance +
   // V8Object and get the V8ObjectVar corresponding to it. This Add/Remove
   // function is called by the V8ObjectVar when it is created and destroyed.
-  void AddV8ObjectVar(ppapi::V8ObjectVar* object_var) { NOTIMPLEMENTED(); }
-  void RemoveV8ObjectVar(ppapi::V8ObjectVar* object_var) { NOTIMPLEMENTED(); }
+  void AddV8ObjectVar(ppapi::V8ObjectVar* object_var);
+  void RemoveV8ObjectVar(ppapi::V8ObjectVar* object_var);
   // Creates or retrieves a V8ObjectVar.
   PP_Var V8ObjectVarForV8Object(PP_Instance instance,
-                                v8::Handle<v8::Object> object) {
-    NOTIMPLEMENTED();
-    return PP_MakeUndefined();
-  }
+                                v8::Handle<v8::Object> object);
+  // Returns the number of V8ObjectVars associated with the given instance.
+  // Returns 0 if the instance isn't known.

[dmichael (off chromium), 2014/08/20 23:09:16]

not sure if it matters, but that means you can't tell whether the instance is
known and has zero vars, or is unknown.

You could use -1 or something.

[raymes, 2014/08/22 08:28:39]

It's just used for tests so it's not important. I updated the name though to
reflect the fact that it's only for tests.

+  CONTENT_EXPORT int GetLiveV8ObjectVarsForInstance(PP_Instance instance);
 
   // VarTracker public implementation.
   virtual PP_Var MakeResourcePPVarFromMessage(
       PP_Instance instance,
       const IPC::Message& creation_message,
       int pending_renderer_id,
       int pending_browser_id) OVERRIDE;
   virtual ppapi::ResourceVar* MakeResourceVar(PP_Resource pp_resource) OVERRIDE;
-  virtual void DidDeleteInstance(PP_Instance instance) OVERRIDE;
+  virtual void DidDeleteInstance(PP_Instance pp_instance) OVERRIDE;
 
   virtual int TrackSharedMemoryHandle(PP_Instance instance,
                                       base::SharedMemoryHandle file,
                                       uint32 size_in_bytes) OVERRIDE;
   virtual bool StopTrackingSharedMemoryHandle(int id,
                                               PP_Instance instance,
                                               base::SharedMemoryHandle* handle,
                                               uint32* size_in_bytes) OVERRIDE;
 
  private:
   // VarTracker private implementation.
   virtual ppapi::ArrayBufferVar* CreateArrayBuffer(uint32 size_in_bytes)
       OVERRIDE;
   virtual ppapi::ArrayBufferVar* CreateShmArrayBuffer(
       uint32 size_in_bytes,
       base::SharedMemoryHandle handle) OVERRIDE;
 
   // Clear the reference count of the given object and remove it from
   // live_vars_.
-  void ForceReleaseNPObject(ppapi::NPObjectVar* object_var);
+  void ForceReleaseV8Object(ppapi::V8ObjectVar* object_var);
 
-  typedef std::map<NPObject*, ppapi::NPObjectVar*> NPObjectToNPObjectVarMap;
+  // A non-unique, ordered key for a V8ObjectVar. Contains the hash of the v8
+  // and the instance it is associated with.
+  struct V8ObjectVarKey {
+    explicit V8ObjectVarKey(ppapi::V8ObjectVar* object_var);
+    V8ObjectVarKey(PP_Instance i, v8::Handle<v8::Object> object);
+    ~V8ObjectVarKey();
 
-  // Lists all known NPObjects, first indexed by the corresponding instance,
-  // then by the NPObject*. This allows us to look up an NPObjectVar given
-  // these two pieces of information.
-  //
-  // The instance map is lazily managed, so we'll add the
-  // NPObjectToNPObjectVarMap lazily when the first NPObject var is created,
-  // and delete it when it's empty.
-  typedef std::map<PP_Instance, linked_ptr<NPObjectToNPObjectVarMap> >
-      InstanceMap;
-  InstanceMap instance_map_;
+    bool operator<(const V8ObjectVarKey& other) const;
+    bool operator==(const V8ObjectVarKey& other) const;

[dmichael (off chromium), 2014/08/20 23:09:16]

You don't need operator== for map or set. They rely on operator< exclusively...
!(a < b) && !(b < a) implies b == a.

Also, an optional suggestion/fyi: It's also fair game to only define a less-than
comparator for V8ObjectVar* and pass that when you instantiate a std::multiset,
rather than defining a separate Key type. There's a chance it will make the
usage simpler, but I haven't looked far enough to tell.

[raymes, 2014/08/22 08:28:40]

Ahh I forgot that.
I tried doing something like this, but at least when I tried the code didn't
come out nicer. It meant that I had to construct a dummy V8ObjectVar to do some
of the lookups (e.g. in V8ObjectVarForV8Object)  and V8ObjectVars are tracked by
the var tracker, so it meant having to mess with that code. So I'd rather stick
with this :)

+
+    PP_Instance instance;
+    int hash;
+  };
+  typedef std::multimap<V8ObjectVarKey, ppapi::V8ObjectVar*> ObjectMap;
+
+  // Returns an iterator into |object_map| which points to V8Object which
+  // is associated with the given instance and object.
+  ObjectMap::iterator GetForV8Object(PP_Instance instance,
+                                     v8::Handle<v8::Object> object);
+
+
+  // A multimap of V8ObjectVarKey -> ObjectMap.
+  ObjectMap object_map_;
 
   // Tracks all shared memory handles used for transmitting array buffers.
   struct SharedMemoryMapEntry {
     PP_Instance instance;
     base::SharedMemoryHandle handle;
     uint32 size_in_bytes;
   };
   typedef std::map<int, SharedMemoryMapEntry> SharedMemoryMap;
   SharedMemoryMap shared_memory_map_;
   uint32_t last_shared_memory_map_id_;
 
   DISALLOW_COPY_AND_ASSIGN(HostVarTracker);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_RENDERER_PEPPER_HOST_VAR_TRACKER_H_