d510a4db99a8018d02d2ee059b591241c9cbda32
[WebKit-https.git] / Source / WebCore / inspector / InspectorAgent.h
1 /*
2  * Copyright (C) 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef InspectorAgent_h
31 #define InspectorAgent_h
32
33 #include "InspectorBaseAgent.h"
34 #include "PlatformString.h"
35 #include <wtf/Forward.h>
36 #include <wtf/HashMap.h>
37 #include <wtf/PassOwnPtr.h>
38 #include <wtf/Vector.h>
39
40 namespace WebCore {
41
42 class DOMWrapperWorld;
43 class DocumentLoader;
44 class Frame;
45 class InjectedScriptManager;
46 class InspectorFrontend;
47 class InspectorObject;
48 class InstrumentingAgents;
49 class KURL;
50 class Page;
51
52 typedef String ErrorString;
53
54 class InspectorAgent : public InspectorBaseAgent<InspectorAgent>, public InspectorBackendDispatcher::InspectorCommandHandler {
55     WTF_MAKE_NONCOPYABLE(InspectorAgent);
56 public:
57     static PassOwnPtr<InspectorAgent> create(Page* page, InjectedScriptManager* injectedScriptManager, InstrumentingAgents* instrumentingAgents, InspectorState* state)
58     {
59         return adoptPtr(new InspectorAgent(page, injectedScriptManager, instrumentingAgents, state));
60     }
61
62     virtual ~InspectorAgent();
63
64     bool developerExtrasEnabled() const;
65
66     // Inspector front-end API.
67     void enable(ErrorString*);
68     void disable(ErrorString*);
69
70     KURL inspectedURL() const;
71     KURL inspectedURLWithoutFragment() const;
72
73     InspectorFrontend* frontend() const { return m_frontend; }
74
75     virtual void setFrontend(InspectorFrontend*);
76     virtual void clearFrontend();
77
78     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
79
80     void didCommitLoad();
81     void domContentLoadedEventFired();
82     bool didCommitLoadFired() { return m_didCommitLoadFired; }
83
84     bool hasFrontend() const { return m_frontend; }
85
86     // Generic code called from custom implementations.
87     void evaluateForTestInFrontend(long testCallId, const String& script);
88
89     void setInjectedScriptForOrigin(const String& origin, const String& source);
90
91     void inspect(PassRefPtr<TypeBuilder::Runtime::RemoteObject> objectToInspect, PassRefPtr<InspectorObject> hints);
92
93 private:
94     InspectorAgent(Page*, InjectedScriptManager*, InstrumentingAgents*, InspectorState*);
95
96     void unbindAllResources();
97
98 #if ENABLE(JAVASCRIPT_DEBUGGER)
99     void toggleRecordButton(bool);
100 #endif
101
102     bool isMainResourceLoader(DocumentLoader*, const KURL& requestUrl);
103
104     Page* m_inspectedPage;
105     InspectorFrontend* m_frontend;
106     InjectedScriptManager* m_injectedScriptManager;
107
108     Vector<pair<long, String> > m_pendingEvaluateTestCommands;
109     pair<RefPtr<TypeBuilder::Runtime::RemoteObject>, RefPtr<InspectorObject> > m_pendingInspectData;
110     typedef HashMap<String, String> InjectedScriptForOriginMap;
111     InjectedScriptForOriginMap m_injectedScriptForOrigin;
112     bool m_didCommitLoadFired;
113 };
114
115 } // namespace WebCore
116
117 #endif // !defined(InspectorAgent_h)