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/PassOwnPtr.h>
37#include <wtf/Vector.h>
38#include <wtf/text/WTFString.h>
39
40namespace WebCore {
41
42class InspectorFrontend;
43class InspectorCompositeState;
44class InspectorState;
45class InstrumentingAgents;
46
47class InspectorBaseAgentInterface {
48public:
49    InspectorBaseAgentInterface(const String&, InstrumentingAgents*, InspectorCompositeState*);
50    virtual ~InspectorBaseAgentInterface();
51
52    virtual void setFrontend(InspectorFrontend*) { }
53    virtual void clearFrontend() { }
54    virtual void restore() { }
55    virtual void registerInDispatcher(InspectorBackendDispatcher*) = 0;
56    virtual void discardAgent() { }
57
58    String name() { return m_name; }
59
60protected:
61    InstrumentingAgents* m_instrumentingAgents;
62    InspectorState* m_state;
63
64private:
65    String m_name;
66};
67
68class InspectorAgentRegistry {
69public:
70    void append(PassOwnPtr<InspectorBaseAgentInterface>);
71
72    void setFrontend(InspectorFrontend*);
73    void clearFrontend();
74    void restore();
75    void registerInDispatcher(InspectorBackendDispatcher*);
76    void discardAgents();
77
78private:
79    Vector<OwnPtr<InspectorBaseAgentInterface> > m_agents;
80};
81
82template<typename T>
83class InspectorBaseAgent : public InspectorBaseAgentInterface {
84public:
85    virtual ~InspectorBaseAgent() { }
86
87    virtual void registerInDispatcher(InspectorBackendDispatcher* dispatcher)
88    {
89        dispatcher->registerAgent(static_cast<T*>(this));
90    }
91
92protected:
93    InspectorBaseAgent(const String& name, InstrumentingAgents* instrumentingAgents, InspectorCompositeState* inspectorState)
94        : InspectorBaseAgentInterface(name, instrumentingAgents, inspectorState)
95    {
96    }
97};
98
99} // namespace WebCore
100
101#endif // !defined(InspectorBaseAgent_h)
102