• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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:
~WebDevToolsAgent()51     virtual ~WebDevToolsAgent() {}
52 
53     // FIXME: remove once migrated to the one with host_id.
54     virtual void attach() = 0;
55     virtual void reattach(const WebString& savedState) = 0;
56 
57     virtual void attach(const WebString& hostId) = 0;
58     virtual void reattach(const WebString& hostId, const WebString& savedState) = 0;
59     virtual void detach() = 0;
60 
61     virtual void didNavigate() = 0;
62 
63     virtual void dispatchOnInspectorBackend(const WebString& message) = 0;
64 
65     virtual void inspectElementAt(const WebPoint&) = 0;
66     virtual void setProcessId(long) = 0;
67     virtual void setLayerTreeId(int) = 0;
68 
69     virtual void didBeginFrame(int frameId = 0) = 0;
70     virtual void didCancelFrame() = 0;
71     virtual void willComposite() = 0;
72     virtual void didComposite() = 0;
73 
74     class GPUEvent {
75     public:
GPUEvent(double timestamp,int phase,bool foreign,uint64_t usedGPUMemoryBytes)76         GPUEvent(double timestamp, int phase, bool foreign, uint64_t usedGPUMemoryBytes) :
77             timestamp(timestamp),
78             phase(phase),
79             foreign(foreign),
80             usedGPUMemoryBytes(usedGPUMemoryBytes),
81             limitGPUMemoryBytes(0) { }
82         double timestamp;
83         int phase;
84         bool foreign;
85         uint64_t usedGPUMemoryBytes;
86         uint64_t limitGPUMemoryBytes;
87     };
88     virtual void processGPUEvent(const GPUEvent&) = 0;
89 
90     // Exposed for TestRunner.
91     virtual void evaluateInWebInspector(long callId, const WebString& script) = 0;
92 
93     class MessageDescriptor {
94     public:
~MessageDescriptor()95         virtual ~MessageDescriptor() { }
96         virtual WebDevToolsAgent* agent() = 0;
97         virtual WebString message() = 0;
98     };
99     // Asynchronously request debugger to pause immediately and run the command.
100     BLINK_EXPORT static void interruptAndDispatch(MessageDescriptor*);
101     BLINK_EXPORT static bool shouldInterruptForMessage(const WebString&);
102     BLINK_EXPORT static void processPendingMessages();
103 
104 };
105 
106 } // namespace blink
107 
108 #endif
109