2761ec595d7fd755c88e1ff876b65c211e5eb475
[WebKit-https.git] / Source / WebKit / mac / WebView / WebViewData.h
1 /*
2  * Copyright (C) 2005, 2006, 2007, 2008, 2009, 2012 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 Igalia S.L
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #import "WebTypesInternal.h"
31 #import "WebDelegateImplementationCaching.h"
32 #import <WebCore/AlternativeTextClient.h>
33 #import <WebCore/LayerFlushScheduler.h>
34 #import <WebCore/LayerFlushSchedulerClient.h>
35 #import <WebCore/WebCoreKeyboardUIMode.h>
36 #import <wtf/HashMap.h>
37 #import <wtf/PassOwnPtr.h>
38 #import <wtf/RetainPtr.h>
39 #import <wtf/ThreadingPrimitives.h>
40 #import <wtf/text/WTFString.h>
41
42 #if PLATFORM(IOS)
43 #import "WebCaretChangeListener.h"
44 #endif
45
46 namespace WebCore {
47 class AlternativeTextUIController;
48 class HistoryItem;
49 class Page;
50 class TextIndicatorWindow;
51 }
52
53 @class WebActionMenuController;
54 @class WebInspector;
55 @class WebNodeHighlight;
56 @class WebPluginDatabase;
57 @class WebPreferences;
58 @class WebTextCompletionController;
59 @protocol WebFormDelegate;
60 @protocol WebDeviceOrientationProvider;
61 @protocol WebGeolocationProvider;
62 @protocol WebNotificationProvider;
63 #if ENABLE(VIDEO)
64 @class WebVideoFullscreenController;
65 #endif
66 #if ENABLE(FULLSCREEN_API)
67 @class WebFullScreenController;
68 #endif
69 #if ENABLE(MEDIA_STREAM)
70 @protocol WebUserMediaClient;
71 #endif
72 #if ENABLE(REMOTE_INSPECTOR) && PLATFORM(IOS)
73 @class WebIndicateLayer;
74 #endif
75
76 #if PLATFORM(IOS)
77 @class WAKWindow;
78 @class WebEvent;
79 @class WebFixedPositionContent;
80 #endif
81
82 extern BOOL applicationIsTerminating;
83 extern int pluginDatabaseClientCount;
84
85 class LayerFlushController;
86 class WebViewGroup;
87 class WebSelectionServiceController;
88
89 class WebViewLayerFlushScheduler : public WebCore::LayerFlushScheduler {
90 public:
91     WebViewLayerFlushScheduler(LayerFlushController*);
92     virtual ~WebViewLayerFlushScheduler() { }
93
94 private:
95     virtual void layerFlushCallback() override
96     {
97         RefPtr<LayerFlushController> protector = m_flushController;
98         WebCore::LayerFlushScheduler::layerFlushCallback();
99     }
100     
101     LayerFlushController* m_flushController;
102 };
103
104 class LayerFlushController : public RefCounted<LayerFlushController>, public WebCore::LayerFlushSchedulerClient {
105 public:
106     static PassRefPtr<LayerFlushController> create(WebView* webView)
107     {
108         return adoptRef(new LayerFlushController(webView));
109     }
110     
111     virtual bool flushLayers();
112     
113     void scheduleLayerFlush();
114     void invalidate();
115     
116 private:
117     LayerFlushController(WebView*);
118     
119     WebView* m_webView;
120     WebViewLayerFlushScheduler m_layerFlushScheduler;
121 };
122
123 // FIXME: This should be renamed to WebViewData.
124 @interface WebViewPrivate : NSObject {
125 @public
126     WebCore::Page* page;
127     RefPtr<WebViewGroup> group;
128
129     id UIDelegate;
130     id UIDelegateForwarder;
131     id resourceProgressDelegate;
132     id downloadDelegate;
133     id policyDelegate;
134     id policyDelegateForwarder;
135     id frameLoadDelegate;
136     id frameLoadDelegateForwarder;
137     id <WebFormDelegate> formDelegate;
138     id editingDelegate;
139     id editingDelegateForwarder;
140     id scriptDebugDelegate;
141     id historyDelegate;
142 #if PLATFORM(IOS)
143     id resourceProgressDelegateForwarder;
144     id formDelegateForwarder;
145 #endif
146
147     WebInspector *inspector;
148     WebNodeHighlight *currentNodeHighlight;
149
150 #if PLATFORM(MAC)
151 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 101000
152     WebActionMenuController *actionMenuController;
153 #endif // __MAC_OS_X_VERSION_MIN_REQUIRED >= 101000
154     std::unique_ptr<WebCore::TextIndicatorWindow> textIndicatorWindow;
155 #endif // PLATFORM(MAC)
156
157     BOOL allowsUndo;
158         
159     float zoomMultiplier;
160     BOOL zoomsTextOnly;
161
162     NSString *applicationNameForUserAgent;
163     WTF::String userAgent;
164     BOOL userAgentOverridden;
165     
166     WebPreferences *preferences;
167     BOOL useSiteSpecificSpoofing;
168 #if PLATFORM(IOS)
169     NSURL *userStyleSheetLocation;
170 #endif
171
172     NSWindow *hostWindow;
173
174     int programmaticFocusCount;
175     
176     WebResourceDelegateImplementationCache resourceLoadDelegateImplementations;
177     WebFrameLoadDelegateImplementationCache frameLoadDelegateImplementations;
178     WebScriptDebugDelegateImplementationCache scriptDebugDelegateImplementations;
179     WebHistoryDelegateImplementationCache historyDelegateImplementations;
180
181     void *observationInfo;
182     
183     BOOL closed;
184 #if PLATFORM(IOS)
185     BOOL closing;
186 #endif
187     BOOL shouldCloseWithWindow;
188     BOOL mainFrameDocumentReady;
189     BOOL drawsBackground;
190     BOOL tabKeyCyclesThroughElementsChanged;
191     BOOL becomingFirstResponder;
192     BOOL becomingFirstResponderFromOutside;
193     BOOL usesPageCache;
194
195 #if !PLATFORM(IOS)
196     NSColor *backgroundColor;
197 #else
198     CGColorRef backgroundColor;
199 #endif
200
201     NSString *mediaStyle;
202     
203     BOOL hasSpellCheckerDocumentTag;
204     NSInteger spellCheckerDocumentTag;
205
206 #if ENABLE(DASHBOARD_SUPPORT)
207     BOOL dashboardBehaviorAlwaysSendMouseEventsToAllWindows;
208     BOOL dashboardBehaviorAlwaysSendActiveNullEventsToPlugIns;
209     BOOL dashboardBehaviorAlwaysAcceptsFirstMouse;
210     BOOL dashboardBehaviorAllowWheelScrolling;
211 #endif
212     
213 #if PLATFORM(IOS)
214     BOOL isStopping;
215
216     id UIKitDelegate;
217     id UIKitDelegateForwarder;
218
219     id WebMailDelegate;
220
221     BOOL allowsMessaging;
222     NSMutableSet *_caretChangeListeners;
223     id <WebCaretChangeListener> _caretChangeListener;
224
225     CGSize fixedLayoutSize;
226     BOOL mainViewIsScrollingOrZooming;
227     int32_t didDrawTiles;
228     WTF::Mutex pendingFixedPositionLayoutRectMutex;
229     CGRect pendingFixedPositionLayoutRect;
230 #endif
231
232 #if !PLATFORM(IOS)
233     // WebKit has both a global plug-in database and a separate, per WebView plug-in database. Dashboard uses the per WebView database.
234     WebPluginDatabase *pluginDatabase;
235 #endif
236     
237     HashMap<unsigned long, RetainPtr<id>> identifierMap;
238
239     BOOL _keyboardUIModeAccessed;
240     WebCore::KeyboardUIMode _keyboardUIMode;
241
242     BOOL shouldUpdateWhileOffscreen;
243
244     BOOL includesFlattenedCompositingLayersWhenDrawingToBitmap;
245
246     // When this flag is set, next time a WebHTMLView draws, it needs to temporarily disable screen updates
247     // so that the NSView drawing is visually synchronized with CALayer updates.
248     BOOL needsOneShotDrawingSynchronization;
249     BOOL postsAcceleratedCompositingNotifications;
250     RefPtr<LayerFlushController> layerFlushController;
251
252 #if !PLATFORM(IOS)
253     NSPasteboard *insertionPasteboard;
254 #endif
255             
256     NSSize lastLayoutSize;
257
258 #if ENABLE(VIDEO)
259     WebVideoFullscreenController *fullscreenController;
260 #endif
261     
262 #if ENABLE(FULLSCREEN_API)
263     WebFullScreenController *newFullscreenController;
264 #endif
265
266 #if ENABLE(REMOTE_INSPECTOR)
267 #if PLATFORM(IOS)
268     WebIndicateLayer *indicateLayer;
269 #endif
270 #endif
271
272 #if USE(GLIB)
273     CFRunLoopObserverRef glibRunLoopObserver;
274 #endif
275     id<WebGeolocationProvider> _geolocationProvider;
276     id<WebDeviceOrientationProvider> m_deviceOrientationProvider;
277     id<WebNotificationProvider> _notificationProvider;
278
279 #if ENABLE(MEDIA_STREAM)
280     id<WebUserMediaClient> m_userMediaClient;
281 #endif
282
283 #if ENABLE(SERVICE_CONTROLS)
284     std::unique_ptr<WebSelectionServiceController> _selectionServiceController;
285 #endif
286
287     RefPtr<WebCore::HistoryItem> _globalHistoryItem;
288
289     BOOL interactiveFormValidationEnabled;
290     int validationMessageTimerMagnification;
291
292     float customDeviceScaleFactor;
293 #if PLATFORM(IOS)
294     WebFixedPositionContent* _fixedPositionContent;
295 #endif
296
297 #if USE(DICTATION_ALTERNATIVES)
298     OwnPtr<WebCore::AlternativeTextUIController> m_alternativeTextUIController;
299 #endif
300
301     RetainPtr<NSData> sourceApplicationAuditData;
302
303     BOOL _didPerformFirstNavigation;
304 }
305 @end