Home | History | Annotate | Download | only in web 
      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 #include "../platform/WebVector.h"
     36 
     37 namespace blink {
     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     virtual ~WebDevToolsAgent() {}
     53 
     54     // Returns WebKit WebInspector protocol version.
     55     BLINK_EXPORT static WebString inspectorProtocolVersion();
     56 
     57     // Returns true if and only if the given protocol version is supported by the WebKit Web Inspector.
     58     BLINK_EXPORT static bool supportsInspectorProtocolVersion(const WebString& version);
     59 
     60     virtual void attach() = 0;
     61     virtual void reattach(const WebString& savedState) = 0;
     62     virtual void detach() = 0;
     63 
     64     virtual void didNavigate() = 0;
     65 
     66     virtual void dispatchOnInspectorBackend(const WebString& message) = 0;
     67 
     68     virtual void inspectElementAt(const WebPoint&) = 0;
     69     virtual void setProcessId(long) = 0;
     70     virtual void setLayerTreeId(int) = 0;
     71 
     72     virtual void didBeginFrame(int frameId = 0) = 0;
     73     virtual void didCancelFrame() = 0;
     74     virtual void willComposite() = 0;
     75     virtual void didComposite() = 0;
     76 
     77     // FIXME: remove it once the client side stops firing these.
     78     virtual void processGPUEvent(double timestamp, int phase, bool foreign) = 0;
     79 
     80     class GPUEvent {
     81     public:
     82         GPUEvent(double timestamp, int phase, bool foreign, size_t usedGPUMemoryBytes) :
     83             timestamp(timestamp),
     84             phase(phase),
     85             foreign(foreign),
     86             usedGPUMemoryBytes(usedGPUMemoryBytes) { }
     87         double timestamp;
     88         int phase;
     89         bool foreign;
     90         size_t usedGPUMemoryBytes;
     91     };
     92     virtual void processGPUEvent(const GPUEvent&) = 0;
     93 
     94     // Exposed for TestRunner.
     95     virtual void evaluateInWebInspector(long callId, const WebString& script) = 0;
     96 
     97     class MessageDescriptor {
     98     public:
     99         virtual ~MessageDescriptor() { }
    100         virtual WebDevToolsAgent* agent() = 0;
    101         virtual WebString message() = 0;
    102     };
    103     // Asynchronously request debugger to pause immediately and run the command.
    104     BLINK_EXPORT static void interruptAndDispatch(MessageDescriptor*);
    105     BLINK_EXPORT static bool shouldInterruptForMessage(const WebString&);
    106     BLINK_EXPORT static void processPendingMessages();
    107 
    108 };
    109 
    110 } // namespace blink
    111 
    112 #endif
    113