1/*
2 * Copyright (C) 2010, 2014, 2015 Apple 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
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#include "APIObject.h"
29#include "Connection.h"
30#include "MessageReceiver.h"
31#include <wtf/Noncopyable.h>
32#include <wtf/text/WTFString.h>
33
34namespace WebKit {
35
36class WebPage;
37
38class WebInspector : public API::ObjectImpl<API::Object::Type::BundleInspector>, private IPC::Connection::Client {
39public:
40 static Ref<WebInspector> create(WebPage*);
41
42 WebPage* page() const { return m_page; }
43
44 void updateDockingAvailability();
45
46 // Implemented in generated WebInspectorMessageReceiver.cpp
47 void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
48
49 // IPC::Connection::Client
50 void didClose(IPC::Connection&) override { close(); }
51 void didReceiveInvalidMessage(IPC::Connection&, IPC::StringReference, IPC::StringReference) override { close(); }
52
53 void show();
54 void close();
55
56 void openInNewTab(const String& urlString);
57
58 void canAttachWindow(bool& result);
59
60 void showConsole();
61 void showResources();
62 void showTimelines();
63
64 void showMainResourceForFrame(uint64_t frameIdentifier);
65
66 void setAttached(bool attached) { m_attached = attached; }
67
68 void evaluateScriptForTest(const String& script);
69
70 void startPageProfiling();
71 void stopPageProfiling();
72
73 void startElementSelection();
74 void stopElementSelection();
75 void elementSelectionChanged(bool);
76
77 void setFrontendConnection(IPC::Attachment);
78
79 void disconnectFromPage() { close(); }
80
81private:
82 friend class WebInspectorClient;
83
84 explicit WebInspector(WebPage*);
85 virtual ~WebInspector();
86
87 bool canAttachWindow();
88
89 // Called from WebInspectorClient
90 void openLocalInspectorFrontend(bool underTest);
91 void closeFrontendConnection();
92
93 void bringToFront();
94
95 void whenFrontendConnectionEstablished(Function<void()>&&);
96
97 WebPage* m_page;
98
99 RefPtr<IPC::Connection> m_frontendConnection;
100 Vector<Function<void()>> m_frontendConnectionActions;
101
102 bool m_attached { false };
103 bool m_previousCanAttach { false };
104};
105
106} // namespace WebKit
107