src/third_party/WebKit/Source/core/inspector/InspectorBaseAgent.h

   1 /*
   2  * Copyright (C) 2011 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef InspectorBaseAgent_h
  32 #define InspectorBaseAgent_h
  33
  34 #include "InspectorBackendDispatcher.h"
  35 #include "wtf/Forward.h"
  36 #include "wtf/Vector.h"
  37 #include "wtf/text/WTFString.h"
  38
  39 namespace WebCore {
  40
  41 class InspectorFrontend;
  42 class InspectorCompositeState;
  43 class InspectorState;
  44 class InstrumentingAgents;
  45
  46 class InspectorAgent {
  47 public:
  48     explicit InspectorAgent(const String&);
  49     virtual ~InspectorAgent();
  50
  51     virtual void init() { }
  52     virtual void setFrontend(InspectorFrontend*) { }
  53     virtual void clearFrontend() { }
  54     virtual void restore() { }
  55     virtual void registerInDispatcher(InspectorBackendDispatcher*) = 0;
  56     virtual void discardAgent() { }
  57     virtual void didCommitLoadForMainFrame() { }
  58
  59     String name() { return m_name; }
  60     void appended(InstrumentingAgents*, InspectorState*);
  61
  62 protected:
  63     InstrumentingAgents* m_instrumentingAgents;
  64     InspectorState* m_state;
  65
  66 private:
  67     String m_name;
  68 };
  69
  70 class InspectorAgentRegistry {
  71 public:
  72     InspectorAgentRegistry(InstrumentingAgents*, InspectorCompositeState*);
  73     void append(PassOwnPtr<InspectorAgent>);
  74
  75     void setFrontend(InspectorFrontend*);
  76     void clearFrontend();
  77     void restore();
  78     void registerInDispatcher(InspectorBackendDispatcher*);
  79     void discardAgents();
  80
  81 private:
  82     InstrumentingAgents* m_instrumentingAgents;
  83     InspectorCompositeState* m_inspectorState;
  84     Vector<OwnPtr<InspectorAgent> > m_agents;
  85 };
  86
  87 template<typename T>
  88 class InspectorBaseAgent : public InspectorAgent {
  89 public:
  90     virtual ~InspectorBaseAgent() { }
  91
  92     virtual void registerInDispatcher(InspectorBackendDispatcher* dispatcher) OVERRIDE FINAL
  93     {
  94         dispatcher->registerAgent(static_cast<T*>(this));
  95     }
  96
  97 protected:
  98     InspectorBaseAgent(const String& name) : InspectorAgent(name)
  99     {
 100     }
 101 };
 102
 103 } // namespace WebCore
 104
 105 #endif // !defined(InspectorBaseAgent_h)