Inspector: wrapped inspector agent instances into factory-like wrappers

Source/core/inspector/InspectorBaseAgent.h

 /*
  * Copyright (C) 2011 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
@@ skipping 14 matching lines @@
  * 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 InspectorBaseAgent_h
 #define InspectorBaseAgent_h
 
 #include "InspectorBackendDispatcher.h"
-#include <wtf/Forward.h>
-#include <wtf/Vector.h>
-#include <wtf/text/WTFString.h>
+#include "wtf/Forward.h"
+#include "wtf/PassOwnPtr.h"
+#include "wtf/RefCounted.h"
+#include "wtf/Vector.h"
+#include "wtf/text/WTFString.h"
 
 namespace WebCore {
 
 class InspectorFrontend;
 class InspectorCompositeState;
 class InspectorState;
 class InstrumentingAgents;
 
-class InspectorBaseAgentInterface {
+class InspectorBaseAgent : public RefCounted<InspectorBaseAgent> {
 public:
-    InspectorBaseAgentInterface(const String&, InstrumentingAgents*, InspectorCompositeState*);
-    virtual ~InspectorBaseAgentInterface();
+    InspectorBaseAgent(InstrumentingAgents*, InspectorState*);
+    virtual ~InspectorBaseAgent();
 
     virtual void setFrontend(InspectorFrontend*) { }

[pfeldman, 2013/06/18 15:36:06]

Add a bunch of fixme-s for these and a link to a meta bug.

[Vladislav Kaznacheev, 2013/06/19 12:58:43]

Done.

     virtual void clearFrontend() { }
     virtual void restore() { }
-    virtual void registerInDispatcher(InspectorBackendDispatcher*) = 0;
     virtual void discardAgent() { }
 
-    String name() { return m_name; }
-
     virtual void reportMemoryUsage(MemoryObjectInfo*) const;
 
+protected:
+    InstrumentingAgents* m_instrumentingAgents;
+    InspectorState* m_state;
+};
+
+class InspectorBaseControllerInterface {
+public:
+
+    InspectorBaseControllerInterface(const String& name, InstrumentingAgents*, InspectorCompositeState*);

[pfeldman, 2013/06/18 15:36:06]

Nit: I'd push it even further.

[Vladislav Kaznacheev, 2013/06/19 12:58:43]

We will eventually
On 2013/06/18 15:36:06, pfeldman wrote:

+    ~InspectorBaseControllerInterface();

[pfeldman, 2013/06/18 15:36:06]

virtual ?

[Vladislav Kaznacheev, 2013/06/19 12:58:43]

Done.

+
+    void setAgent(PassRefPtr<InspectorBaseAgent>);
+
+    virtual void setFrontend(InspectorFrontend*);
+    virtual void clearFrontend();
+    virtual void restore();
+    virtual void registerInDispatcher(InspectorBackendDispatcher*) = 0;
+    virtual void discardAgent();

[pfeldman, 2013/06/18 15:36:06]

discardController

[Vladislav Kaznacheev, 2013/06/19 12:58:43]

Renamed to discardDependencies because that is what it does.
On 2013/06/18 15:36:06, pfeldman wrote:

+
+    virtual void reportMemoryUsage(MemoryObjectInfo*) const;
+
 protected:
     InstrumentingAgents* m_instrumentingAgents;
     InspectorState* m_state;
 
+    RefPtr<InspectorBaseAgent> m_agent;
+
 private:
-    String m_name;
+    InspectorFrontend* m_frontend;
 };
 
 class InspectorAgentRegistry {
 public:
-    void append(PassOwnPtr<InspectorBaseAgentInterface>);
+    void append(PassOwnPtr<InspectorBaseControllerInterface>);
 
     void setFrontend(InspectorFrontend*);
     void clearFrontend();
     void restore();
     void registerInDispatcher(InspectorBackendDispatcher*);
     void discardAgents();
 
     virtual void reportMemoryUsage(MemoryObjectInfo*) const;
 
 private:
-    Vector<OwnPtr<InspectorBaseAgentInterface> > m_agents;
+    Vector<OwnPtr<InspectorBaseControllerInterface> > m_controllers;
 };
 
-template<typename T>
-class InspectorBaseAgent : public InspectorBaseAgentInterface {
+template<typename T, typename AGENT>

[pfeldman, 2013/06/18 15:36:06]

Agent

[Vladislav Kaznacheev, 2013/06/19 12:58:43]

Done.

+class InspectorBaseController : public InspectorBaseControllerInterface, public AGENT::Controller {
 public:
-    virtual ~InspectorBaseAgent() { }
-
+    // InspectorBaseControllerInterface implementation
     virtual void registerInDispatcher(InspectorBackendDispatcher* dispatcher)
     {
         dispatcher->registerAgent(static_cast<T*>(this));
     }
 
+    AGENT* getAgent() { return static_cast<AGENT*>(m_agent.get()); }

[pfeldman, 2013/06/18 15:36:06]

agent()

[Vladislav Kaznacheev, 2013/06/19 12:58:43]

Done.

+
+    // AGENT::Controller implementation
+    virtual AGENT* getCommandHandler() { return getAgent(); }

[pfeldman, 2013/06/18 15:36:06]

commandHandler

[Vladislav Kaznacheev, 2013/06/19 12:58:43]

Done.

+
 protected:
-    InspectorBaseAgent(const String& name, InstrumentingAgents* instrumentingAgents, InspectorCompositeState* inspectorState)
-        : InspectorBaseAgentInterface(name, instrumentingAgents, inspectorState)
+    InspectorBaseController(const String& name, InstrumentingAgents* instrumentingAgents, InspectorCompositeState* compositeState)
+        : InspectorBaseControllerInterface(name, instrumentingAgents, compositeState)
     {
     }
 };
 
 } // namespace WebCore
 
 #endif // !defined(InspectorBaseAgent_h)