Web Inspector: Refactor message loop instrumentation.
[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/WebCommon.h"
35
36 namespace WebKit {
37 class WebDevToolsAgentClient;
38 class WebDevToolsMessageTransport;
39 class WebFrame;
40 class WebString;
41 class WebURLRequest;
42 class WebURLResponse;
43 class WebView;
44 struct WebDevToolsMessageData;
45 struct WebPoint;
46 struct WebURLError;
47
48 class WebDevToolsAgent {
49 public:
50     virtual ~WebDevToolsAgent() {}
51
52     // Returns WebKit WebInspector protocol version.
53     WEBKIT_EXPORT static WebString inspectorProtocolVersion();
54
55     // Returns true if and only if the given protocol version is supported by the WebKit Web Inspector.
56     WEBKIT_EXPORT static bool supportsInspectorProtocolVersion(const WebString& version);
57
58     virtual void attach() = 0;
59     virtual void reattach(const WebString& savedState) = 0;
60     virtual void detach() = 0;
61
62     virtual void didNavigate() = 0;
63
64     virtual void dispatchOnInspectorBackend(const WebString& message) = 0;
65
66     virtual void inspectElementAt(const WebPoint&) = 0;
67     virtual void setProcessId(long) = 0;
68
69     // Exposed for LayoutTestController.
70     virtual void evaluateInWebInspector(long callId, const WebString& script) = 0;
71
72     class MessageDescriptor {
73     public:
74         virtual ~MessageDescriptor() { }
75         virtual WebDevToolsAgent* agent() = 0;
76         virtual WebString message() = 0;
77     };
78     // Asynchronously request debugger to pause immediately and run the command.
79     WEBKIT_EXPORT static void interruptAndDispatch(MessageDescriptor*);
80     WEBKIT_EXPORT static bool shouldInterruptForMessage(const WebString&);
81     WEBKIT_EXPORT static void processPendingMessages();
82
83     // Returns a disconnect event that can be dispatched on the front-end
84     // in order to let it know that it has disconnected from the agent.
85     WEBKIT_EXPORT static WebString disconnectEventAsText();
86 };
87
88 } // namespace WebKit
89
90 #endif