WinCairo build fails to link.
[WebKit-https.git] / Source / WebKit / chromium / public / WebDevToolsAgent.h
1 /*
2  * Copyright (C) 2009 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 WebDevToolsAgent_h
32 #define WebDevToolsAgent_h
33
34 #include "../../../Platform/chromium/public/WebCommon.h"
35 #include "../../../Platform/chromium/public/WebVector.h"
36
37 namespace WebKit {
38 class WebDevToolsAgentClient;
39 class WebDevToolsMessageTransport;
40 class WebFrame;
41 class WebString;
42 class WebURLRequest;
43 class WebURLResponse;
44 class WebView;
45 struct WebDevToolsMessageData;
46 struct WebPoint;
47 struct WebMemoryUsageInfo;
48 struct WebURLError;
49
50 class WebDevToolsAgent {
51 public:
52     // Hint for the browser on the data it should prepare for message patching.
53     enum BrowserDataHint {
54         BrowserDataHintNone,
55         BrowserDataHintScreenshot,
56     };
57
58     virtual ~WebDevToolsAgent() {}
59
60     // Returns WebKit WebInspector protocol version.
61     WEBKIT_EXPORT static WebString inspectorProtocolVersion();
62
63     // Returns true if and only if the given protocol version is supported by the WebKit Web Inspector.
64     WEBKIT_EXPORT static bool supportsInspectorProtocolVersion(const WebString& version);
65
66     virtual void attach() = 0;
67     virtual void reattach(const WebString& savedState) = 0;
68     virtual void detach() = 0;
69
70     virtual void didNavigate() = 0;
71
72     virtual void dispatchOnInspectorBackend(const WebString& message) = 0;
73
74     virtual void inspectElementAt(const WebPoint&) = 0;
75     virtual void setProcessId(long) = 0;
76
77     virtual void didBeginFrame() = 0;
78     virtual void didCancelFrame() = 0;
79     virtual void willComposite() = 0;
80     virtual void didComposite() = 0;
81     
82     // Exposed for TestRunner.
83     virtual void evaluateInWebInspector(long callId, const WebString& script) = 0;
84
85     virtual WebVector<WebMemoryUsageInfo> processMemoryDistribution() const = 0;
86
87     class MessageDescriptor {
88     public:
89         virtual ~MessageDescriptor() { }
90         virtual WebDevToolsAgent* agent() = 0;
91         virtual WebString message() = 0;
92     };
93     // Asynchronously request debugger to pause immediately and run the command.
94     WEBKIT_EXPORT static void interruptAndDispatch(MessageDescriptor*);
95     WEBKIT_EXPORT static bool shouldInterruptForMessage(const WebString&);
96     WEBKIT_EXPORT static void processPendingMessages();
97
98     // Returns an Inspector.detached event that can be dispatched on the front-end by the embedder.
99     WEBKIT_EXPORT static WebString inspectorDetachedEvent(const WebString& reason);
100
101     // Returns a Worker.disconnectedFromWorker event that can be dispatched on the front-end
102     // in order to let it know that it has disconnected from the agent.
103     WEBKIT_EXPORT static WebString workerDisconnectedFromWorkerEvent();
104
105     // Determines whether given message response should be patch with the data calculatd in browser.
106     // Returns the hint on the data browser should prepare for patching.
107     WEBKIT_EXPORT static BrowserDataHint shouldPatchWithBrowserData(const char* message, size_t messageLength);
108
109     // Patches message response with the data calculated in browser.
110     WEBKIT_EXPORT static WebString patchWithBrowserData(const WebString& message, BrowserDataHint, const WebString& hintData);
111 };
112
113 } // namespace WebKit
114
115 #endif