Throttle DOM timers on hidden pages.
[WebKit-https.git] / Source / WebKit / mac / WebView / WebViewPrivate.h
1 /*
2  * Copyright (C) 2005-2012 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import <WebKit/WebView.h>
30 #import <WebKit/WebFramePrivate.h>
31 #import <JavaScriptCore/JSBase.h>
32
33 #if !defined(ENABLE_DASHBOARD_SUPPORT)
34 #define ENABLE_DASHBOARD_SUPPORT 1
35 #endif
36
37 @class NSError;
38 @class WebFrame;
39 @class WebDeviceOrientation;
40 @class WebGeolocationPosition;
41 @class WebInspector;
42 @class WebNotification;
43 @class WebPreferences;
44 @class WebScriptWorld;
45 @class WebSecurityOrigin;
46 @class WebTextIterator;
47
48 @protocol WebDeviceOrientationProvider;
49 @protocol WebFormDelegate;
50
51 extern NSString *_WebCanGoBackKey;
52 extern NSString *_WebCanGoForwardKey;
53 extern NSString *_WebEstimatedProgressKey;
54 extern NSString *_WebIsLoadingKey;
55 extern NSString *_WebMainFrameIconKey;
56 extern NSString *_WebMainFrameTitleKey;
57 extern NSString *_WebMainFrameURLKey;
58 extern NSString *_WebMainFrameDocumentKey;
59
60 // pending public WebElementDictionary keys
61 extern NSString *WebElementTitleKey;             // NSString of the title of the element (used by Safari)
62 extern NSString *WebElementSpellingToolTipKey;   // NSString of a tooltip representing misspelling or bad grammar (used internally)
63 extern NSString *WebElementIsContentEditableKey; // NSNumber indicating whether the inner non-shared node is content editable (used internally)
64 extern NSString *WebElementMediaURLKey;          // NSURL of the media element
65
66 // other WebElementDictionary keys
67 extern NSString *WebElementLinkIsLiveKey;        // NSNumber of BOOL indicating whether the link is live or not
68 extern NSString *WebElementIsInScrollBarKey;
69
70 // One of the subviews of the WebView entered compositing mode.
71 extern NSString *_WebViewDidStartAcceleratedCompositingNotification;
72
73 #if ENABLE_DASHBOARD_SUPPORT
74 typedef enum {
75     WebDashboardBehaviorAlwaysSendMouseEventsToAllWindows,
76     WebDashboardBehaviorAlwaysSendActiveNullEventsToPlugIns,
77     WebDashboardBehaviorAlwaysAcceptsFirstMouse,
78     WebDashboardBehaviorAllowWheelScrolling,
79     WebDashboardBehaviorUseBackwardCompatibilityMode
80 } WebDashboardBehavior;
81 #endif
82
83 typedef enum {
84     WebInjectAtDocumentStart,
85     WebInjectAtDocumentEnd,
86 } WebUserScriptInjectionTime;
87
88 typedef enum {
89     WebInjectInAllFrames,
90     WebInjectInTopFrameOnly
91 } WebUserContentInjectedFrames;
92
93 enum {
94     WebFindOptionsCaseInsensitive = 1 << 0,
95     WebFindOptionsAtWordStarts = 1 << 1,
96     WebFindOptionsTreatMedialCapitalAsWordStart = 1 << 2,
97     WebFindOptionsBackwards = 1 << 3,
98     WebFindOptionsWrapAround = 1 << 4,
99     WebFindOptionsStartInSelection = 1 << 5
100 };
101 typedef NSUInteger WebFindOptions;
102
103 typedef enum {
104     WebPaginationModeUnpaginated,
105     WebPaginationModeLeftToRight,
106     WebPaginationModeRightToLeft,
107     WebPaginationModeTopToBottom,
108     WebPaginationModeBottomToTop,
109 } WebPaginationMode;
110
111 enum {
112     WebDidFirstLayout = 1 << 0,
113     WebDidFirstVisuallyNonEmptyLayout = 1 << 1,
114     WebDidHitRelevantRepaintedObjectsAreaThreshold = 1 << 2
115 };
116 typedef NSUInteger WebLayoutMilestones;
117
118 // This needs to be in sync with WebCore::NotificationClient::Permission
119 typedef enum {
120     WebNotificationPermissionAllowed,
121     WebNotificationPermissionNotAllowed,
122     WebNotificationPermissionDenied
123 } WebNotificationPermission;
124
125 @interface WebController : NSTreeController {
126     IBOutlet WebView *webView;
127 }
128 - (WebView *)webView;
129 - (void)setWebView:(WebView *)newWebView;
130 @end
131
132 @interface WebView (WebViewEditingActionsPendingPublic)
133
134 - (void)outdent:(id)sender;
135
136 @end
137
138 @interface WebView (WebPendingPublic)
139
140 - (void)scheduleInRunLoop:(NSRunLoop *)runLoop forMode:(NSString *)mode;
141 - (void)unscheduleFromRunLoop:(NSRunLoop *)runLoop forMode:(NSString *)mode;
142
143 - (BOOL)findString:(NSString *)string options:(WebFindOptions)options;
144 - (DOMRange *)DOMRangeOfString:(NSString *)string relativeTo:(DOMRange *)previousRange options:(WebFindOptions)options;
145
146 - (void)setMainFrameDocumentReady:(BOOL)mainFrameDocumentReady;
147
148 - (void)setTabKeyCyclesThroughElements:(BOOL)cyclesElements;
149 - (BOOL)tabKeyCyclesThroughElements;
150
151 - (void)scrollDOMRangeToVisible:(DOMRange *)range;
152
153 /*!
154 @method setScriptDebugDelegate:
155 @abstract Set the WebView's WebScriptDebugDelegate delegate.
156 @param delegate The WebScriptDebugDelegate to set as the delegate.
157 */    
158 - (void)setScriptDebugDelegate:(id)delegate;
159
160 /*!
161 @method scriptDebugDelegate
162 @abstract Return the WebView's WebScriptDebugDelegate.
163 @result The WebView's WebScriptDebugDelegate.
164 */    
165 - (id)scriptDebugDelegate;
166
167 /*!
168     @method setHistoryDelegate:
169     @abstract Set the WebView's WebHistoryDelegate delegate.
170     @param delegate The WebHistoryDelegate to set as the delegate.
171 */    
172 - (void)setHistoryDelegate:(id)delegate;
173
174 /*!
175     @method historyDelegate
176     @abstract Return the WebView's WebHistoryDelegate delegate.
177     @result The WebView's WebHistoryDelegate delegate.
178 */    
179 - (id)historyDelegate;
180
181 - (BOOL)shouldClose;
182
183 /*!
184     @method aeDescByEvaluatingJavaScriptFromString:
185     @param script The text of the JavaScript.
186     @result The result of the script, converted to an NSAppleEventDescriptor, or nil for failure.
187 */
188 - (NSAppleEventDescriptor *)aeDescByEvaluatingJavaScriptFromString:(NSString *)script;
189
190 // Support for displaying multiple text matches.
191 // These methods might end up moving into a protocol, so different document types can specify
192 // whether or not they implement the protocol. For now we'll just deal with HTML.
193 // These methods are still in flux; don't rely on them yet.
194 - (BOOL)canMarkAllTextMatches;
195 - (NSUInteger)countMatchesForText:(NSString *)string options:(WebFindOptions)options highlight:(BOOL)highlight limit:(NSUInteger)limit markMatches:(BOOL)markMatches;
196 - (NSUInteger)countMatchesForText:(NSString *)string inDOMRange:(DOMRange *)range options:(WebFindOptions)options highlight:(BOOL)highlight limit:(NSUInteger)limit markMatches:(BOOL)markMatches;
197 - (void)unmarkAllTextMatches;
198 - (NSArray *)rectsForTextMatches;
199
200 // Support for disabling registration with the undo manager. This is equivalent to the methods with the same names on NSTextView.
201 - (BOOL)allowsUndo;
202 - (void)setAllowsUndo:(BOOL)flag;
203
204 /*!
205     @method setPageSizeMultiplier:
206     @abstract Change the zoom factor of the page in views managed by this webView.
207     @param multiplier A fractional percentage value, 1.0 is 100%.
208 */    
209 - (void)setPageSizeMultiplier:(float)multiplier;
210
211 /*!
212     @method pageSizeMultiplier
213     @result The page size multipler.
214 */    
215 - (float)pageSizeMultiplier;
216
217 // Commands for doing page zoom.  Will end up in WebView (WebIBActions) <NSUserInterfaceValidations>
218 - (BOOL)canZoomPageIn;
219 - (IBAction)zoomPageIn:(id)sender;
220 - (BOOL)canZoomPageOut;
221 - (IBAction)zoomPageOut:(id)sender;
222 - (BOOL)canResetPageZoom;
223 - (IBAction)resetPageZoom:(id)sender;
224
225 // Sets a master volume control for all media elements in the WebView. Valid values are 0..1.
226 - (void)setMediaVolume:(float)volume;
227 - (float)mediaVolume;
228
229 // Add visited links
230 - (void)addVisitedLinks:(NSArray *)visitedLinks;
231
232 @end
233
234 @interface WebView (WebPrivate)
235
236 - (WebInspector *)inspector;
237
238 /*!
239     @method setBackgroundColor:
240     @param backgroundColor Color to use as the default background.
241     @abstract Sets what color the receiver draws under transparent page background colors and images.
242     This color is also used when no page is loaded. A color with alpha should only be used when the receiver is
243     in a non-opaque window, since the color is drawn using NSCompositeCopy.
244 */
245 - (void)setBackgroundColor:(NSColor *)backgroundColor;
246
247 /*!
248     @method backgroundColor
249     @result Returns the background color drawn under transparent page background colors and images.
250     This color is also used when no page is loaded. A color with alpha should only be used when the receiver is
251     in a non-opaque window, since the color is drawn using NSCompositeCopy.
252 */
253 - (NSColor *)backgroundColor;
254
255 /*!
256 Could be worth adding to the API.
257  @method _loadBackForwardListFromOtherView:
258  @abstract Loads the view with the contents of the other view, including its backforward list.
259  @param otherView   The WebView from which to copy contents.
260  */
261 - (void)_loadBackForwardListFromOtherView:(WebView *)otherView;
262
263 /*
264  @method _reportException:inContext:
265  @abstract Logs the exception to the Web Inspector. This only needs called for exceptions that
266  occur while using the JavaScriptCore APIs with a context owned by a WebKit.
267  @param exception The exception value to log.
268  @param context   The context the exception occured in.
269 */
270 + (void)_reportException:(JSValueRef)exception inContext:(JSContextRef)context;
271
272 /*!
273  @method _dispatchPendingLoadRequests:
274  @abstract Dispatches any pending load requests that have been scheduled because of recent DOM additions or style changes.
275  @discussion You only need to call this method if you require synchronous notification of loads through the resource load delegate.
276  Otherwise the resource load delegate will be notified about loads during a future run loop iteration.
277  */
278 - (void)_dispatchPendingLoadRequests;
279
280 + (NSArray *)_supportedFileExtensions;
281
282 /*!
283     @method canShowFile:
284     @abstract Checks if the WebKit can show the content of the file at the specified path.
285     @param path The path of the file to check
286     @result YES if the WebKit can show the content of the file at the specified path.
287 */
288 + (BOOL)canShowFile:(NSString *)path;
289
290 /*!
291     @method suggestedFileExtensionForMIMEType:
292     @param MIMEType The MIME type to check.
293     @result The extension based on the MIME type
294 */
295 + (NSString *)suggestedFileExtensionForMIMEType: (NSString *)MIMEType;
296
297 + (NSString *)_standardUserAgentWithApplicationName:(NSString *)applicationName;
298
299 /*!
300     @method canCloseAllWebViews
301     @abstract Checks if all the open WebViews can be closed (by dispatching the beforeUnload event to the pages).
302     @result YES if all the WebViews can be closed.
303 */
304 + (BOOL)canCloseAllWebViews;
305
306 // May well become public
307 - (void)_setFormDelegate:(id<WebFormDelegate>)delegate;
308 - (id<WebFormDelegate>)_formDelegate;
309
310 - (BOOL)_isClosed;
311
312 // _close is now replaced by public method -close. It remains here only for backward compatibility
313 // until callers can be weaned off of it.
314 - (void)_close;
315
316 // Indicates if the WebView is in the midst of a user gesture.
317 - (BOOL)_isProcessingUserGesture;
318
319 // SPI for DumpRenderTree
320 - (void)_updateActiveState;
321
322 /*!
323     @method _registerViewClass:representationClass:forURLScheme:
324     @discussion Register classes that implement WebDocumentView and WebDocumentRepresentation respectively.
325     @param viewClass The WebDocumentView class to use to render data for a given MIME type.
326     @param representationClass The WebDocumentRepresentation class to use to represent data of the given MIME type.
327     @param scheme The URL scheme to represent with an object of the given class.
328 */
329 + (void)_registerViewClass:(Class)viewClass representationClass:(Class)representationClass forURLScheme:(NSString *)URLScheme;
330
331 + (void)_unregisterViewClassAndRepresentationClassForMIMEType:(NSString *)MIMEType;
332
333 /*!
334      @method _canHandleRequest:
335      @abstract Performs a "preflight" operation that performs some
336      speculative checks to see if a request can be used to create
337      a WebDocumentView and WebDocumentRepresentation.
338      @discussion The result of this method is valid only as long as no
339      protocols or schemes are registered or unregistered, and as long as
340      the request is not mutated (if the request is mutable). Hence, clients
341      should be prepared to handle failures even if they have performed request
342      preflighting by caling this method.
343      @param request The request to preflight.
344      @result YES if it is likely that a WebDocumentView and WebDocumentRepresentation
345      can be created for the request, NO otherwise.
346 */
347 + (BOOL)_canHandleRequest:(NSURLRequest *)request;
348
349 + (NSString *)_decodeData:(NSData *)data;
350
351 + (void)_setAlwaysUsesComplexTextCodePath:(BOOL)f;
352 // This is the old name of the above method. Needed for Safari versions that call it.
353 + (void)_setAlwaysUseATSU:(BOOL)f;
354
355 + (void)_setAllowsRoundingHacks:(BOOL)allowsRoundingHacks;
356 + (BOOL)_allowsRoundingHacks;
357
358 - (NSCachedURLResponse *)_cachedResponseForURL:(NSURL *)URL;
359
360 #if ENABLE_DASHBOARD_SUPPORT
361 - (void)_addScrollerDashboardRegions:(NSMutableDictionary *)regions;
362 - (NSDictionary *)_dashboardRegions;
363
364 - (void)_setDashboardBehavior:(WebDashboardBehavior)behavior to:(BOOL)flag;
365 - (BOOL)_dashboardBehavior:(WebDashboardBehavior)behavior;
366 #endif
367
368 + (void)_setShouldUseFontSmoothing:(BOOL)f;
369 + (BOOL)_shouldUseFontSmoothing;
370
371 // These two methods are useful for a test harness that needs a consistent appearance for the focus rings
372 // regardless of OS X version.
373 + (void)_setUsesTestModeFocusRingColor:(BOOL)f;
374 + (BOOL)_usesTestModeFocusRingColor;
375
376 /*!
377     @method setAlwaysShowVerticalScroller:
378     @result Forces the vertical scroller to be visible if flag is YES, otherwise
379     if flag is NO the scroller with automatically show and hide as needed.
380  */
381 - (void)setAlwaysShowVerticalScroller:(BOOL)flag;
382
383 /*!
384     @method alwaysShowVerticalScroller
385     @result YES if the vertical scroller is always shown
386  */
387 - (BOOL)alwaysShowVerticalScroller;
388
389 /*!
390     @method setAlwaysShowHorizontalScroller:
391     @result Forces the horizontal scroller to be visible if flag is YES, otherwise
392     if flag is NO the scroller with automatically show and hide as needed.
393  */
394 - (void)setAlwaysShowHorizontalScroller:(BOOL)flag;
395
396 /*!
397     @method alwaysShowHorizontalScroller
398     @result YES if the horizontal scroller is always shown
399  */
400 - (BOOL)alwaysShowHorizontalScroller;
401
402 /*!
403     @method setProhibitsMainFrameScrolling:
404     @abstract Prohibits scrolling in the WebView's main frame.  Used to "lock" a WebView
405     to a specific scroll position.
406   */
407 - (void)setProhibitsMainFrameScrolling:(BOOL)prohibits;
408
409 /*!
410     @method _setAdditionalWebPlugInPaths:
411     @abstract Sets additional plugin search paths for a specific WebView.
412  */
413 - (void)_setAdditionalWebPlugInPaths:(NSArray *)newPaths;
414
415 /*!
416     @method _setInViewSourceMode:
417     @abstract Used to place a WebView into a special source-viewing mode.
418   */
419 - (void)_setInViewSourceMode:(BOOL)flag;
420
421 /*!
422     @method _inViewSourceMode;
423     @abstract Whether or not the WebView is in source-view mode for HTML.
424   */
425 - (BOOL)_inViewSourceMode;
426
427 /*!
428     @method _attachScriptDebuggerToAllFrames
429     @abstract Attaches a script debugger to all frames belonging to the receiver.
430  */
431 - (void)_attachScriptDebuggerToAllFrames;
432
433 /*!
434     @method _detachScriptDebuggerFromAllFrames
435     @abstract Detaches any script debuggers from all frames belonging to the receiver.
436  */
437 - (void)_detachScriptDebuggerFromAllFrames;
438
439 - (BOOL)defersCallbacks; // called by QuickTime plug-in
440 - (void)setDefersCallbacks:(BOOL)defer; // called by QuickTime plug-in
441
442 - (BOOL)usesPageCache;
443 - (void)setUsesPageCache:(BOOL)usesPageCache;
444
445 - (WebHistoryItem *)_globalHistoryItem;
446
447 /*!
448     @method textIteratorForRect:
449     @param rect The rectangle of the document that we're interested in text from.
450     @result WebTextIterator object, initialized with a range that corresponds to
451     the passed-in rectangle.
452     @abstract This method gives the text for the approximate range of the document
453     corresponding to the rectangle. The range is determined by using hit testing at
454     the top left and bottom right of the rectangle. Because of that, there can be
455     text visible in the rectangle that is not included in the iterator. If you need
456     a guarantee of iterating all text that is visible, then you need to instead make
457     a WebTextIterator with a DOMRange that covers the entire document.
458  */
459 - (WebTextIterator *)textIteratorForRect:(NSRect)rect;
460
461 #if ENABLE_DASHBOARD_SUPPORT
462 // <rdar://problem/5217124> Clients other than Dashboard, don't use this.
463 // As of this writing, Dashboard uses this on Tiger, but not on Leopard or newer.
464 - (void)handleAuthenticationForResource:(id)identifier challenge:(NSURLAuthenticationChallenge *)challenge fromDataSource:(WebDataSource *)dataSource;
465 #endif
466
467 - (void)_clearUndoRedoOperations;
468
469 /* Used to do fast (lower quality) scaling of images so that window resize can be quick. */
470 - (BOOL)_inFastImageScalingMode;
471 - (void)_setUseFastImageScalingMode:(BOOL)flag;
472
473 - (BOOL)_cookieEnabled;
474 - (void)_setCookieEnabled:(BOOL)enable;
475
476 // SPI for DumpRenderTree
477 - (void)_executeCoreCommandByName:(NSString *)name value:(NSString *)value;
478 - (void)_clearMainFrameName;
479
480 - (void)_setCustomHTMLTokenizerTimeDelay:(double)timeDelay;
481 - (void)_setCustomHTMLTokenizerChunkSize:(int)chunkSize;
482
483 - (void)setSelectTrailingWhitespaceEnabled:(BOOL)flag;
484 - (BOOL)isSelectTrailingWhitespaceEnabled;
485
486 - (void)setMemoryCacheDelegateCallsEnabled:(BOOL)suspend;
487 - (BOOL)areMemoryCacheDelegateCallsEnabled;
488
489 - (void)_setJavaScriptURLsAreAllowed:(BOOL)setJavaScriptURLsAreAllowed;
490
491 + (NSCursor *)_pointingHandCursor;
492
493 // SPI for DumpRenderTree
494 - (BOOL)_postsAcceleratedCompositingNotifications;
495 - (void)_setPostsAcceleratedCompositingNotifications:(BOOL)flag;
496 - (BOOL)_isUsingAcceleratedCompositing;
497 - (void)_setBaseCTM:(CGAffineTransform)transform forContext:(CGContextRef)context;
498
499 // For DumpRenderTree
500 - (BOOL)interactiveFormValidationEnabled;
501 - (void)setInteractiveFormValidationEnabled:(BOOL)enabled;
502 - (int)validationMessageTimerMagnification;
503 - (void)setValidationMessageTimerMagnification:(int)newValue;
504
505 // Returns YES if NSView -displayRectIgnoringOpacity:inContext: will produce a faithful representation of the content.
506 - (BOOL)_isSoftwareRenderable;
507 // When drawing into a bitmap context, we normally flatten compositing layers (and distort 3D transforms).
508 // Clients who are able to capture their own copy of the compositing layers need to be able to disable this.
509 - (void)_setIncludesFlattenedCompositingLayersWhenDrawingToBitmap:(BOOL)flag;
510 - (BOOL)_includesFlattenedCompositingLayersWhenDrawingToBitmap;
511
512 - (void)setTracksRepaints:(BOOL)flag;
513 - (BOOL)isTrackingRepaints;
514 - (void)resetTrackedRepaints;
515 - (NSArray*)trackedRepaintRects; // Returned array contains rectValue NSValues.
516
517 // Which pasteboard text is coming from in editing delegate methods such as shouldInsertNode.
518 - (NSPasteboard *)_insertionPasteboard;
519
520 // Whitelists access from an origin (sourceOrigin) to a set of one or more origins described by the parameters:
521 // - destinationProtocol: The protocol to grant access to.
522 // - destinationHost: The host to grant access to.
523 // - allowDestinationSubdomains: If host is a domain, setting this to YES will whitelist host and all its subdomains, recursively.
524 + (void)_addOriginAccessWhitelistEntryWithSourceOrigin:(NSString *)sourceOrigin destinationProtocol:(NSString *)destinationProtocol destinationHost:(NSString *)destinationHost allowDestinationSubdomains:(BOOL)allowDestinationSubdomains;
525 + (void)_removeOriginAccessWhitelistEntryWithSourceOrigin:(NSString *)sourceOrigin destinationProtocol:(NSString *)destinationProtocol destinationHost:(NSString *)destinationHost allowDestinationSubdomains:(BOOL)allowDestinationSubdomains;
526
527 // Removes all white list entries created with _addOriginAccessWhitelistEntryWithSourceOrigin.
528 + (void)_resetOriginAccessWhitelists;
529
530 // FIXME: The following two methods are deprecated in favor of the overloads below that take the WebUserContentInjectedFrames argument. https://bugs.webkit.org/show_bug.cgi?id=41800.
531 + (void)_addUserScriptToGroup:(NSString *)groupName world:(WebScriptWorld *)world source:(NSString *)source url:(NSURL *)url whitelist:(NSArray *)whitelist blacklist:(NSArray *)blacklist injectionTime:(WebUserScriptInjectionTime)injectionTime;
532 + (void)_addUserStyleSheetToGroup:(NSString *)groupName world:(WebScriptWorld *)world source:(NSString *)source url:(NSURL *)url whitelist:(NSArray *)whitelist blacklist:(NSArray *)blacklist;
533
534 + (void)_addUserScriptToGroup:(NSString *)groupName world:(WebScriptWorld *)world source:(NSString *)source url:(NSURL *)url whitelist:(NSArray *)whitelist blacklist:(NSArray *)blacklist injectionTime:(WebUserScriptInjectionTime)injectionTime injectedFrames:(WebUserContentInjectedFrames)injectedFrames;
535 + (void)_addUserStyleSheetToGroup:(NSString *)groupName world:(WebScriptWorld *)world source:(NSString *)source url:(NSURL *)url whitelist:(NSArray *)whitelist blacklist:(NSArray *)blacklist injectedFrames:(WebUserContentInjectedFrames)injectedFrames;
536 + (void)_removeUserScriptFromGroup:(NSString *)groupName world:(WebScriptWorld *)world url:(NSURL *)url;
537 + (void)_removeUserStyleSheetFromGroup:(NSString *)groupName world:(WebScriptWorld *)world url:(NSURL *)url;
538 + (void)_removeUserScriptsFromGroup:(NSString *)groupName world:(WebScriptWorld *)world;
539 + (void)_removeUserStyleSheetsFromGroup:(NSString *)groupName world:(WebScriptWorld *)world;
540 + (void)_removeAllUserContentFromGroup:(NSString *)groupName;
541
542 // SPI for DumpRenderTree
543 + (void)_setLoadResourcesSerially:(BOOL)serialize;
544
545 /*!
546     @method cssAnimationsSuspended
547     @abstract Returns whether or not CSS Animations are suspended.
548     @result YES if CSS Animations are suspended.
549 */
550 - (BOOL)cssAnimationsSuspended;
551
552 /*!
553     @method setCSSAnimationsSuspended
554     @param paused YES to suspend animations, NO to resume animations.
555     @discussion Suspends or resumes all running animations and transitions in the page.
556 */
557 - (void)setCSSAnimationsSuspended:(BOOL)suspended;
558
559 + (void)_setDomainRelaxationForbidden:(BOOL)forbidden forURLScheme:(NSString *)scheme;
560 + (void)_registerURLSchemeAsSecure:(NSString *)scheme;
561 + (void)_registerURLSchemeAsAllowingLocalStorageAccessInPrivateBrowsing:(NSString *)scheme;
562 + (void)_registerURLSchemeAsAllowingDatabaseAccessInPrivateBrowsing:(NSString *)scheme;
563
564 - (void)_scaleWebView:(float)scale atOrigin:(NSPoint)origin;
565 - (float)_viewScaleFactor;
566
567 - (void)_setUseFixedLayout:(BOOL)fixed;
568 - (void)_setFixedLayoutSize:(NSSize)size;
569
570 - (BOOL)_useFixedLayout;
571 - (NSSize)_fixedLayoutSize;
572
573 - (void)_setPaginationMode:(WebPaginationMode)paginationMode;
574 - (WebPaginationMode)_paginationMode;
575
576 - (void)_listenForLayoutMilestones:(WebLayoutMilestones)layoutMilestones;
577 - (WebLayoutMilestones)_layoutMilestones;
578
579 // Whether the column-break-{before,after} properties are respected instead of the
580 // page-break-{before,after} properties.
581 - (void)_setPaginationBehavesLikeColumns:(BOOL)behavesLikeColumns;
582 - (BOOL)_paginationBehavesLikeColumns;
583
584 // Set to 0 to have the page length equal the view length.
585 - (void)_setPageLength:(CGFloat)pageLength;
586 - (CGFloat)_pageLength;
587 - (void)_setGapBetweenPages:(CGFloat)pageGap;
588 - (CGFloat)_gapBetweenPages;
589 - (NSUInteger)_pageCount;
590
591 - (void)_setCustomBackingScaleFactor:(CGFloat)overrideScaleFactor;
592 - (CGFloat)_backingScaleFactor;
593
594 // Deprecated. Use the methods in pending public above instead.
595 - (NSUInteger)markAllMatchesForText:(NSString *)string caseSensitive:(BOOL)caseFlag highlight:(BOOL)highlight limit:(NSUInteger)limit;
596 - (NSUInteger)countMatchesForText:(NSString *)string caseSensitive:(BOOL)caseFlag highlight:(BOOL)highlight limit:(NSUInteger)limit markMatches:(BOOL)markMatches;
597
598 /*!
599  @method searchFor:direction:caseSensitive:wrap:startInSelection:
600  @abstract Searches a document view for a string and highlights the string if it is found.
601  Starts the search from the current selection.  Will search across all frames.
602  @param string The string to search for.
603  @param forward YES to search forward, NO to seach backwards.
604  @param caseFlag YES to for case-sensitive search, NO for case-insensitive search.
605  @param wrapFlag YES to wrap around, NO to avoid wrapping.
606  @param startInSelection YES to begin search in the selected text (useful for incremental searching), NO to begin search after the selected text.
607  @result YES if found, NO if not found.
608  */
609 // Deprecated. Use findString.
610 - (BOOL)searchFor:(NSString *)string direction:(BOOL)forward caseSensitive:(BOOL)caseFlag wrap:(BOOL)wrapFlag startInSelection:(BOOL)startInSelection;
611
612 /*!
613     @method defaultMinimumTimerInterval
614     @discussion Should consider moving this to the public API.
615     @result Returns the default minimum timer interval.
616 */
617 + (double)_defaultMinimumTimerInterval;
618
619 /*!
620     @method setMinimumTimerInterval:
621     @discussion Sets the minimum interval for DOMTimers in this WebView. This method is
622     exposed here in the Mac port rather than through WebPreferences (which generally
623     governs Settings) because this value is something adjusted at run time, not set
624     globally via "defaults write". Should consider adding this to the public API.
625     @param intervalInSeconds The new minimum timer interval, in seconds.
626 */
627 - (void)_setMinimumTimerInterval:(double)intervalInSeconds;
628
629 /*!
630     @method _HTTPPipeliningEnabled
631     @abstract Checks the HTTP pipelining status.
632     @discussion Defaults to NO.
633     @result YES if HTTP pipelining is enabled, NO if not enabled.
634  */
635 + (BOOL)_HTTPPipeliningEnabled;
636
637 /*!
638     @method _setHTTPPipeliningEnabled:
639     @abstract Set the HTTP pipelining status.
640     @discussion Defaults to NO.
641     @param enabled The new HTTP pipelining status.
642  */
643 + (void)_setHTTPPipeliningEnabled:(BOOL)enabled;
644
645 // SPI for DumpRenderTree
646 - (void)_setVisibilityState:(int)visibilityState isInitialState:(BOOL)isInitialState;
647
648 @end
649
650 @interface WebView (WebViewPrintingPrivate)
651 /*!
652     @method _adjustPrintingMarginsForHeaderAndFooter:
653     @abstract Increase the top and bottom margins for the current print operation to
654     account for the header and footer height. 
655     @discussion Called by <WebDocument> implementors once when a print job begins. If the
656     <WebDocument> implementor implements knowsPageRange:, this should be called from there.
657     Otherwise this should be called from beginDocument. The <WebDocument> implementors need
658     to also call _drawHeaderAndFooter.
659 */
660 - (void)_adjustPrintingMarginsForHeaderAndFooter;
661
662 /*!
663     @method _drawHeaderAndFooter
664     @abstract Gives the WebView's UIDelegate a chance to draw a header and footer on the
665     printed page. 
666     @discussion This should be called by <WebDocument> implementors from an override of
667     drawPageBorderWithSize:.
668 */
669 - (void)_drawHeaderAndFooter;
670 @end
671
672 @interface WebView (WebViewGrammarChecking)
673
674 // FIXME: These two methods should be merged into WebViewEditing when we're not in API freeze
675 - (BOOL)isGrammarCheckingEnabled;
676 - (void)setGrammarCheckingEnabled:(BOOL)flag;
677
678 // FIXME: This method should be merged into WebIBActions when we're not in API freeze
679 - (void)toggleGrammarChecking:(id)sender;
680
681 @end
682
683 @interface WebView (WebViewTextChecking)
684
685 - (BOOL)isAutomaticQuoteSubstitutionEnabled;
686 - (BOOL)isAutomaticLinkDetectionEnabled;
687 - (BOOL)isAutomaticDashSubstitutionEnabled;
688 - (BOOL)isAutomaticTextReplacementEnabled;
689 - (BOOL)isAutomaticSpellingCorrectionEnabled;
690 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1060
691 - (void)setAutomaticQuoteSubstitutionEnabled:(BOOL)flag;
692 - (void)toggleAutomaticQuoteSubstitution:(id)sender;
693 - (void)setAutomaticLinkDetectionEnabled:(BOOL)flag;
694 - (void)toggleAutomaticLinkDetection:(id)sender;
695 - (void)setAutomaticDashSubstitutionEnabled:(BOOL)flag;
696 - (void)toggleAutomaticDashSubstitution:(id)sender;
697 - (void)setAutomaticTextReplacementEnabled:(BOOL)flag;
698 - (void)toggleAutomaticTextReplacement:(id)sender;
699 - (void)setAutomaticSpellingCorrectionEnabled:(BOOL)flag;
700 - (void)toggleAutomaticSpellingCorrection:(id)sender;
701 #endif
702 @end
703
704 @interface WebView (WebViewEditingInMail)
705 - (void)_insertNewlineInQuotedContent;
706 - (void)_replaceSelectionWithNode:(DOMNode *)node matchStyle:(BOOL)matchStyle;
707 - (BOOL)_selectionIsCaret;
708 - (BOOL)_selectionIsAll;
709 - (void)_simplifyMarkup:(DOMNode *)startNode endNode:(DOMNode *)endNode;
710
711 @end
712
713 @interface WebView (WebViewDeviceOrientation)
714 - (void)_setDeviceOrientationProvider:(id<WebDeviceOrientationProvider>)deviceOrientationProvider;
715 - (id<WebDeviceOrientationProvider>)_deviceOrientationProvider;
716 @end
717
718 @protocol WebGeolocationProvider <NSObject>
719 - (void)registerWebView:(WebView *)webView;
720 - (void)unregisterWebView:(WebView *)webView;
721 - (WebGeolocationPosition *)lastPosition;
722 @end
723
724 @protocol WebNotificationProvider
725 - (void)registerWebView:(WebView *)webView;
726 - (void)unregisterWebView:(WebView *)webView;
727
728 - (void)showNotification:(WebNotification *)notification fromWebView:(WebView *)webView;
729 - (void)cancelNotification:(WebNotification *)notification;
730 - (void)notificationDestroyed:(WebNotification *)notification;
731 - (void)clearNotifications:(NSArray *)notificationIDs;
732 - (WebNotificationPermission)policyForOrigin:(WebSecurityOrigin *)origin;
733
734 - (void)webView:(WebView *)webView didShowNotification:(uint64_t)notificationID;
735 - (void)webView:(WebView *)webView didClickNotification:(uint64_t)notificationID;
736 - (void)webView:(WebView *)webView didCloseNotifications:(NSArray *)notificationIDs;
737 @end
738
739 @interface WebView (WebViewGeolocation)
740 - (void)_setGeolocationProvider:(id<WebGeolocationProvider>)locationProvider;
741 - (id<WebGeolocationProvider>)_geolocationProvider;
742
743 - (void)_geolocationDidChangePosition:(WebGeolocationPosition *)position;
744 - (void)_geolocationDidFailWithMessage:(NSString *)errorMessage;
745 @end
746
747 @interface WebView (WebViewNotification)
748 - (void)_setNotificationProvider:(id<WebNotificationProvider>)notificationProvider;
749 - (id<WebNotificationProvider>)_notificationProvider;
750
751 - (void)_notificationDidShow:(uint64_t)notificationID;
752 - (void)_notificationDidClick:(uint64_t)notificationID;
753 - (void)_notificationsDidClose:(NSArray *)notificationIDs;
754
755 - (uint64_t)_notificationIDForTesting:(JSValueRef)jsNotification;
756 @end
757
758 @interface WebView (WebViewPrivateStyleInfo)
759 - (JSValueRef)_computedStyleIncludingVisitedInfo:(JSContextRef)context forElement:(JSValueRef)value;
760 @end
761
762 @interface NSObject (WebViewFrameLoadDelegatePrivate)
763 - (void)webView:(WebView *)sender didFirstLayoutInFrame:(WebFrame *)frame;
764
765 // didFinishDocumentLoadForFrame is sent when the document has finished loading, though not necessarily all
766 // of its subresources.
767 // FIXME 5259339: Currently this callback is not sent for (some?) pages loaded entirely from the cache.
768 - (void)webView:(WebView *)sender didFinishDocumentLoadForFrame:(WebFrame *)frame;
769
770 // Addresses 4192534.  SPI for now.
771 - (void)webView:(WebView *)sender didHandleOnloadEventsForFrame:(WebFrame *)frame;
772
773 - (void)webView:(WebView *)sender didFirstVisuallyNonEmptyLayoutInFrame:(WebFrame *)frame;
774
775 - (void)webView:(WebView *)sender didLayout:(WebLayoutMilestones)milestones;
776
777 // For implementing the WebInspector's test harness
778 - (void)webView:(WebView *)webView didClearInspectorWindowObject:(WebScriptObject *)windowObject forFrame:(WebFrame *)frame;
779
780 @end
781
782 @interface NSObject (WebViewResourceLoadDelegatePrivate)
783 // Addresses <rdar://problem/5008925> - SPI for now
784 - (NSCachedURLResponse *)webView:(WebView *)sender resource:(id)identifier willCacheResponse:(NSCachedURLResponse *)response fromDataSource:(WebDataSource *)dataSource;
785 @end
786
787 #ifdef __cplusplus
788 extern "C" {
789 #endif
790
791 // This is a C function to avoid calling +[WebView initialize].
792 void WebInstallMemoryPressureHandler(void);
793
794 #ifdef __cplusplus
795 }
796 #endif