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
37namespace WebKit {
38class WebDevToolsAgentClient;
39class WebDevToolsMessageTransport;
40class WebFrame;
41class WebString;
42class WebURLRequest;
43class WebURLResponse;
44class WebView;
45struct WebDevToolsMessageData;
46struct WebPoint;
47struct WebMemoryUsageInfo;
48struct WebURLError;
49
50class WebDevToolsAgent {
51public:
52    virtual ~WebDevToolsAgent() {}
53
54    // Returns WebKit WebInspector protocol version.
55    WEBKIT_EXPORT static WebString inspectorProtocolVersion();
56
57    // Returns true if and only if the given protocol version is supported by the WebKit Web Inspector.
58    WEBKIT_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() = 0;
73    virtual void didCancelFrame() = 0;
74    virtual void willComposite() = 0;
75    virtual void didComposite() = 0;
76
77    // Exposed for TestRunner.
78    virtual void evaluateInWebInspector(long callId, const WebString& script) = 0;
79
80    class MessageDescriptor {
81    public:
82        virtual ~MessageDescriptor() { }
83        virtual WebDevToolsAgent* agent() = 0;
84        virtual WebString message() = 0;
85    };
86    // Asynchronously request debugger to pause immediately and run the command.
87    WEBKIT_EXPORT static void interruptAndDispatch(MessageDescriptor*);
88    WEBKIT_EXPORT static bool shouldInterruptForMessage(const WebString&);
89    WEBKIT_EXPORT static void processPendingMessages();
90
91};
92
93} // namespace WebKit
94
95#endif
96