2 * Copyright (C) 2009 Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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
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.
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.
31 #ifndef WebDevToolsAgent_h
32 #define WebDevToolsAgent_h
34 #include "WebCommon.h"
37 class WebDevToolsAgentClient;
38 class WebDevToolsMessageTransport;
44 struct WebDevToolsMessageData;
48 class WebDevToolsAgent {
50 virtual ~WebDevToolsAgent() {}
52 virtual void attach() = 0;
53 virtual void detach() = 0;
54 virtual void frontendLoaded() = 0;
56 virtual void didNavigate() = 0;
58 virtual void dispatchOnInspectorBackend(const WebString& message) = 0;
60 virtual void inspectElementAt(const WebPoint&) = 0;
61 virtual void setRuntimeProperty(const WebString& name, const WebString& value) = 0;
62 virtual void setProcessId(long) = 0;
64 // Exposed for LayoutTestController.
65 virtual void evaluateInWebInspector(long callId, const WebString& script) = 0;
66 virtual void setJavaScriptProfilingEnabled(bool) = 0;
68 // Asynchronously executes debugger command in the render thread.
69 // |callerIdentifier| will be used for sending response.
70 WEBKIT_EXPORT static void executeDebuggerCommand(
71 const WebString& command, int callerIdentifier);
73 // Asynchronously request debugger to pause immediately.
74 WEBKIT_EXPORT static void debuggerPauseScript();
76 class MessageDescriptor {
78 virtual ~MessageDescriptor() { }
79 virtual WebDevToolsAgent* agent() = 0;
80 virtual WebString message() = 0;
82 // Asynchronously request debugger to pause immediately and run the command.
83 WEBKIT_EXPORT static void interruptAndDispatch(MessageDescriptor*);
84 WEBKIT_EXPORT static bool shouldInterruptForMessage(const WebString&);
85 WEBKIT_EXPORT static void processPendingMessages();
87 typedef void (*MessageLoopDispatchHandler)();
89 // Installs dispatch handle that is going to be called periodically
90 // while on a breakpoint.
91 WEBKIT_EXPORT static void setMessageLoopDispatchHandler(MessageLoopDispatchHandler);