src/third_party/WebKit/public/web/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 #include "../platform/WebVector.h"
  36
  37 namespace blink {
  38 class WebDevToolsAgentClient;
  39 class WebDevToolsMessageTransport;
  40 class WebString;
  41 class WebURLRequest;
  42 class WebURLResponse;
  43 class WebView;
  44 struct WebDevToolsMessageData;
  45 struct WebPoint;
  46 struct WebMemoryUsageInfo;
  47 struct WebURLError;
  48
  49 class WebDevToolsAgent {
  50 public:
  51     virtual ~WebDevToolsAgent() {}
  52
  53     virtual void attach() = 0;
  54     virtual void reattach(const WebString& savedState) = 0;
  55     virtual void detach() = 0;
  56
  57     virtual void didNavigate() = 0;
  58
  59     virtual void dispatchOnInspectorBackend(const WebString& message) = 0;
  60
  61     virtual void inspectElementAt(const WebPoint&) = 0;
  62     virtual void setProcessId(long) = 0;
  63     virtual void setLayerTreeId(int) = 0;
  64
  65     virtual void didBeginFrame(int frameId = 0) = 0;
  66     virtual void didCancelFrame() = 0;
  67     virtual void willComposite() = 0;
  68     virtual void didComposite() = 0;
  69
  70     class GPUEvent {
  71     public:
  72         GPUEvent(double timestamp, int phase, bool foreign, uint64_t usedGPUMemoryBytes) :
  73             timestamp(timestamp),
  74             phase(phase),
  75             foreign(foreign),
  76             usedGPUMemoryBytes(usedGPUMemoryBytes),
  77             limitGPUMemoryBytes(0) { }
  78         double timestamp;
  79         int phase;
  80         bool foreign;
  81         uint64_t usedGPUMemoryBytes;
  82         uint64_t limitGPUMemoryBytes;
  83     };
  84     virtual void processGPUEvent(const GPUEvent&) = 0;
  85
  86     // Exposed for TestRunner.
  87     virtual void evaluateInWebInspector(long callId, const WebString& script) = 0;
  88
  89     class MessageDescriptor {
  90     public:
  91         virtual ~MessageDescriptor() { }
  92         virtual WebDevToolsAgent* agent() = 0;
  93         virtual WebString message() = 0;
  94     };
  95     // Asynchronously request debugger to pause immediately and run the command.
  96     BLINK_EXPORT static void interruptAndDispatch(MessageDescriptor*);
  97     BLINK_EXPORT static bool shouldInterruptForMessage(const WebString&);
  98     BLINK_EXPORT static void processPendingMessages();
  99
 100 };
 101
 102 } // namespace blink
 103
 104 #endif