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 "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: ~WebDevToolsAgent()50 virtual ~WebDevToolsAgent() {} 51 52 virtual void attach() = 0; 53 virtual void detach() = 0; 54 virtual void frontendLoaded() = 0; 55 56 virtual void didNavigate() = 0; 57 58 virtual void dispatchOnInspectorBackend(const WebString& message) = 0; 59 60 virtual void inspectElementAt(const WebPoint&) = 0; 61 virtual void setRuntimeProperty(const WebString& name, const WebString& value) = 0; 62 63 // Exposed for LayoutTestController. 64 virtual void evaluateInWebInspector(long callId, const WebString& script) = 0; 65 virtual void setTimelineProfilingEnabled(bool enabled) = 0; 66 67 // Asynchronously executes debugger command in the render thread. 68 // |callerIdentifier| will be used for sending response. 69 WEBKIT_API static void executeDebuggerCommand( 70 const WebString& command, int callerIdentifier); 71 72 // Asynchronously request debugger to pause immediately. 73 WEBKIT_API static void debuggerPauseScript(); 74 75 class MessageDescriptor { 76 public: ~MessageDescriptor()77 virtual ~MessageDescriptor() { } 78 virtual WebDevToolsAgent* agent() = 0; 79 virtual WebString message() = 0; 80 }; 81 // Asynchronously request debugger to pause immediately and run the command. 82 WEBKIT_API static void interruptAndDispatch(MessageDescriptor*); 83 WEBKIT_API static bool shouldInterruptForMessage(const WebString&); 84 WEBKIT_API static void processPendingMessages(); 85 86 typedef void (*MessageLoopDispatchHandler)(); 87 88 // Installs dispatch handle that is going to be called periodically 89 // while on a breakpoint. 90 WEBKIT_API static void setMessageLoopDispatchHandler(MessageLoopDispatchHandler); 91 }; 92 93 } // namespace WebKit 94 95 #endif 96