Home | History | Annotate | Download | only in public
      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 WebFrame;
     39 class WebString;
     40 class WebURLRequest;
     41 class WebURLResponse;
     42 class WebView;
     43 struct WebDevToolsMessageData;
     44 struct WebPoint;
     45 struct WebURLError;
     46 
     47 class WebDevToolsAgent {
     48 public:
     49     WEBKIT_API static WebDevToolsAgent* create(WebView*, WebDevToolsAgentClient*);
     50 
     51     virtual ~WebDevToolsAgent() {}
     52 
     53     virtual void attach() = 0;
     54     virtual void detach() = 0;
     55 
     56     virtual void didNavigate() = 0;
     57 
     58     virtual void dispatchMessageFromFrontend(const WebDevToolsMessageData&) = 0;
     59 
     60     virtual void inspectElementAt(const WebPoint&) = 0;
     61 
     62     virtual void setRuntimeFeatureEnabled(const WebString& feature, bool enabled) = 0;
     63 
     64     // Exposed for LayoutTestController.
     65     virtual void evaluateInWebInspector(long callId, const WebString& script) = 0;
     66     virtual void setTimelineProfilingEnabled(bool enabled) = 0;
     67 
     68     // Asynchronously executes debugger command in the render thread.
     69     // |callerIdentifier| will be used for sending response.
     70     WEBKIT_API static void executeDebuggerCommand(
     71         const WebString& command, int callerIdentifier);
     72 
     73     // Asynchronously request debugger to pause immediately.
     74     WEBKIT_API static void debuggerPauseScript();
     75 
     76     WEBKIT_API static bool dispatchMessageFromFrontendOnIOThread(const WebDevToolsMessageData&);
     77 
     78     typedef void (*MessageLoopDispatchHandler)();
     79 
     80     // Installs dispatch handle that is going to be called periodically
     81     // while on a breakpoint.
     82     WEBKIT_API static void setMessageLoopDispatchHandler(MessageLoopDispatchHandler);
     83 
     84     virtual void identifierForInitialRequest(unsigned long resourceId, WebFrame*, const WebURLRequest&) = 0;
     85     virtual void willSendRequest(unsigned long resourceId, const WebURLRequest&) = 0;
     86     virtual void didReceiveData(unsigned long resourceId, int length) = 0;
     87     virtual void didReceiveResponse(unsigned long resourceId, const WebURLResponse&) = 0;
     88     virtual void didFinishLoading(unsigned long resourceId) = 0;
     89     virtual void didFailLoading(unsigned long resourceId, const WebURLError&) = 0;
     90 };
     91 
     92 } // namespace WebKit
     93 
     94 #endif
     95