2011-04-25 Pavel Feldman <pfeldman@google.com>
[WebKit-https.git] / Source / WebCore / inspector / InspectorPageAgent.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 InspectorPageAgent_h
32 #define InspectorPageAgent_h
33
34 #if ENABLE(INSPECTOR)
35
36 #include "InspectorFrontend.h"
37 #include "PlatformString.h"
38 #include <wtf/RefCounted.h>
39 #include <wtf/Vector.h>
40
41 namespace WebCore {
42
43 class CachedResource;
44 class DOMWrapperWorld;
45 class DocumentLoader;
46 class Frame;
47 class Frontend;
48 class InjectedScriptManager;
49 class InspectorArray;
50 class InspectorObject;
51 class InstrumentingAgents;
52 class KURL;
53 class Page;
54
55 typedef String ErrorString;
56
57 class InspectorPageAgent {
58     WTF_MAKE_NONCOPYABLE(InspectorPageAgent);
59 public:
60
61     enum ResourceType {
62         DocumentResource,
63         StylesheetResource,
64         ImageResource,
65         FontResource,
66         ScriptResource,
67         XHRResource,
68         WebSocketResource,
69         OtherResource
70     };
71
72     static PassOwnPtr<InspectorPageAgent> create(InstrumentingAgents*, Page*, InjectedScriptManager*);
73
74     static void resourceContent(ErrorString*, Frame*, const KURL&, String* result);
75     static void resourceContentBase64(ErrorString*, Frame*, const KURL&, String* result);
76
77     static PassRefPtr<SharedBuffer> resourceData(Frame*, const KURL&, String* textEncodingName);
78     static CachedResource* cachedResource(Frame*, const KURL&);
79     static String resourceTypeString(ResourceType);
80     static ResourceType cachedResourceType(const CachedResource&);
81     static String cachedResourceTypeString(const CachedResource&);
82
83     // Page API for InspectorFrontend
84     void addScriptToEvaluateOnLoad(ErrorString*, const String& source);
85     void removeAllScriptsToEvaluateOnLoad(ErrorString*);
86     void reload(ErrorString*, const bool* const optionalIgnoreCache);
87     void open(ErrorString*, const String& url, const bool* const inNewWindow);
88     void getCookies(ErrorString*, RefPtr<InspectorArray>* cookies, WTF::String* cookiesString);
89     void deleteCookie(ErrorString*, const String& cookieName, const String& domain);
90     void getResourceTree(ErrorString*, RefPtr<InspectorObject>*);
91     void getResourceContent(ErrorString*, const String& frameId, const String& url, const bool* const base64Encode, String* content);
92
93     // InspectorInstrumentation API
94     void didCommitLoad(const String& url);
95     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
96     void domContentEventFired();
97     void loadEventFired();
98     void frameNavigated(DocumentLoader*);
99     void frameDetached(Frame*);
100
101     // Inspector Controller API
102     void setFrontend(InspectorFrontend*);
103     void clearFrontend();
104     void restore();
105
106     // Cross-agents API
107     Frame* mainFrame();
108     Frame* frameForId(const String& frameId);
109     String frameId(Frame*);
110     String loaderId(DocumentLoader*);
111
112 private:
113     InspectorPageAgent(InstrumentingAgents*, Page*, InjectedScriptManager*);
114
115     PassRefPtr<InspectorObject> buildObjectForFrame(Frame*);
116     PassRefPtr<InspectorObject> buildObjectForFrameTree(Frame*);
117
118     InstrumentingAgents* m_instrumentingAgents;
119     Page* m_page;
120     InjectedScriptManager* m_injectedScriptManager;
121     InspectorFrontend::Page* m_frontend;
122     Vector<String> m_scriptsToEvaluateOnLoad;
123 };
124
125
126 } // namespace WebCore
127
128 #endif // ENABLE(INSPECTOR)
129
130 #endif // !defined(InspectorPagerAgent_h)