Web Inspector: introduce InspectorFrontendAPI for actions initiated from the applicat...
[WebKit-https.git] / Source / WebCore / inspector / InspectorFrontendClientLocal.h
1 /*
2  * Copyright (C) 2010 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 InspectorFrontendClientLocal_h
32 #define InspectorFrontendClientLocal_h
33
34 #include "InspectorFrontendClient.h"
35 #include "PlatformString.h"
36 #include "ScriptState.h"
37 #include <wtf/Forward.h>
38 #include <wtf/Noncopyable.h>
39
40 namespace WebCore {
41
42 class InspectorController;
43 class InspectorBackendDispatchTask;
44 class InspectorFrontendHost;
45 class Page;
46
47 class InspectorFrontendClientLocal : public InspectorFrontendClient {
48     WTF_MAKE_NONCOPYABLE(InspectorFrontendClientLocal); WTF_MAKE_FAST_ALLOCATED;
49 public:
50     class Settings {
51     public:
52         Settings() { }
53         virtual ~Settings() { }
54         virtual String getProperty(const String& name);
55         virtual void setProperty(const String& name, const String& value);
56     };
57
58     InspectorFrontendClientLocal(InspectorController*, Page*, PassOwnPtr<Settings>);
59     virtual ~InspectorFrontendClientLocal();
60     
61     virtual void windowObjectCleared();
62     virtual void frontendLoaded();
63
64     virtual void moveWindowBy(float x, float y);
65
66     virtual void requestAttachWindow();
67     virtual void requestDetachWindow();
68     virtual void changeAttachedWindowHeight(unsigned);
69     virtual void saveAs(const String&, const String&) { }
70
71     virtual void attachWindow() = 0;
72     virtual void detachWindow() = 0;
73
74     virtual void sendMessageToBackend(const String& message);
75
76     bool canAttachWindow();
77
78     static unsigned constrainedAttachedWindowHeight(unsigned preferredHeight, unsigned totalWindowHeight);
79
80     // Direct Frontend API
81     bool isDebuggingEnabled();
82     void setDebuggingEnabled(bool);
83
84     bool isTimelineProfilingEnabled();
85     void setTimelineProfilingEnabled(bool);
86
87     bool isProfilingJavaScript();
88     void startProfilingJavaScript();
89     void stopProfilingJavaScript();
90
91     void showConsole();
92
93 protected:
94     virtual void setAttachedWindowHeight(unsigned) = 0;
95     void setAttachedWindow(bool);
96     void restoreAttachedWindowHeight();
97
98 private:
99     bool evaluateAsBoolean(const String& expression);
100     void evaluateOnLoad(const String& expression);
101
102     friend class FrontendMenuProvider;
103     InspectorController* m_inspectorController;
104     Page* m_frontendPage;
105     ScriptState* m_frontendScriptState;
106     // TODO(yurys): this ref shouldn't be needed.
107     RefPtr<InspectorFrontendHost> m_frontendHost;
108     OwnPtr<InspectorFrontendClientLocal::Settings> m_settings;
109     bool m_frontendLoaded;
110     String m_evaluateOnLoad;
111     OwnPtr<InspectorBackendDispatchTask> m_dispatchTask;
112 };
113
114 } // namespace WebCore
115
116 #endif