Source/WebCore/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/Vector.h>
  36 #include <wtf/text/WTFString.h>
  37
  38 namespace WebCore {
  39
  40 class InspectorFrontend;
  41 class InspectorState;
  42 class InstrumentingAgents;
  43
  44 class InspectorBaseAgentInterface {
  45 public:
  46     explicit InspectorBaseAgentInterface(const String& name);
  47     virtual ~InspectorBaseAgentInterface();
  48
  49     virtual void setFrontend(InspectorFrontend*) { }
  50     virtual void clearFrontend() { }
  51     virtual void restore() { }
  52     virtual void registerInDispatcher(InspectorBackendDispatcher*) = 0;
  53     virtual void getAgentCapabilities(InspectorArray*) { };
  54
  55     String name() { return m_name; }
  56 private:
  57     String m_name;
  58 };
  59
  60 template<typename T>
  61 class InspectorBaseAgent : public InspectorBaseAgentInterface {
  62 public:
  63     virtual ~InspectorBaseAgent() { }
  64
  65     virtual void registerInDispatcher(InspectorBackendDispatcher* dispatcher)
  66     {
  67         dispatcher->registerAgent(static_cast<T*>(this));
  68     }
  69
  70 protected:
  71     InspectorBaseAgent(const String& name, InstrumentingAgents* instrumentingAgents, InspectorState* inspectorState)
  72         : InspectorBaseAgentInterface(name)
  73         , m_instrumentingAgents(instrumentingAgents)
  74         , m_state(inspectorState)
  75     {
  76     }
  77
  78     InstrumentingAgents* m_instrumentingAgents;
  79     InspectorState* m_state;
  80 };
  81
  82 } // namespace WebCore
  83
  84 #endif // !defined(InspectorBaseAgent_h)