Build fix.
[WebKit-https.git] / WebKit / WebView / WebViewPrivate.h
1 /*
2  * Copyright (C) 2005 Apple Computer, 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
32 #if MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_4
33 #define WebNSInteger int
34 #else
35 #define WebNSInteger NSInteger
36 #endif
37
38 @class NSError;
39 @class WebFrame;
40 @class WebPreferences;
41 @class WebCoreSettings;
42
43 @protocol WebFormDelegate;
44
45 typedef void (*WebDidCancelAuthenticationChallengeFunc)(id, SEL, WebView *, id, NSURLAuthenticationChallenge *, WebDataSource *);
46 typedef void (*WebDidReceiveAuthenticationChallengeFunc)(id, SEL, WebView *, id, NSURLAuthenticationChallenge *, WebDataSource *);
47 typedef id (*WebIdentifierForRequestFunc)(id, SEL, WebView *, NSURLRequest *, WebDataSource *);
48 typedef NSURLRequest *(*WebWillSendRequestFunc)(id, SEL, WebView *, id, NSURLRequest *, NSURLResponse *, WebDataSource *);
49 typedef void (*WebDidReceiveResponseFunc)(id, SEL, WebView *, id, NSURLResponse *, WebDataSource *);
50 typedef void (*WebDidReceiveContentLengthFunc)(id, SEL, WebView *, id, WebNSInteger, WebDataSource *);
51 typedef void (*WebDidFinishLoadingFromDataSourceFunc)(id, SEL, WebView *, id, WebDataSource *);
52 typedef void (*WebDidLoadResourceFromMemoryCacheFunc)(id, SEL, WebView *, NSURLRequest *, NSURLResponse *, WebNSInteger, WebDataSource *);
53
54 typedef struct _WebResourceDelegateImplementationCache {
55     uint delegateImplementsDidCancelAuthenticationChallenge:1;
56     uint delegateImplementsDidReceiveAuthenticationChallenge:1;
57     uint delegateImplementsDidReceiveResponse:1;
58     uint delegateImplementsDidReceiveContentLength:1;
59     uint delegateImplementsDidFinishLoadingFromDataSource:1;
60     uint delegateImplementsWillSendRequest:1;
61     uint delegateImplementsIdentifierForRequest:1;
62     uint delegateImplementsDidLoadResourceFromMemoryCache:1;
63
64     WebDidCancelAuthenticationChallengeFunc didCancelAuthenticationChallengeFunc;
65     WebDidReceiveAuthenticationChallengeFunc didReceiveAuthenticationChallengeFunc;
66     WebIdentifierForRequestFunc identifierForRequestFunc;
67     WebWillSendRequestFunc willSendRequestFunc;
68     WebDidReceiveResponseFunc didReceiveResponseFunc;
69     WebDidReceiveContentLengthFunc didReceiveContentLengthFunc;
70     WebDidFinishLoadingFromDataSourceFunc didFinishLoadingFromDataSourceFunc;
71     WebDidLoadResourceFromMemoryCacheFunc didLoadResourceFromMemoryCacheFunc;
72 } WebResourceDelegateImplementationCache;
73
74 extern NSString *_WebCanGoBackKey;
75 extern NSString *_WebCanGoForwardKey;
76 extern NSString *_WebEstimatedProgressKey;
77 extern NSString *_WebIsLoadingKey;
78 extern NSString *_WebMainFrameIconKey;
79 extern NSString *_WebMainFrameTitleKey;
80 extern NSString *_WebMainFrameURLKey;
81 extern NSString *_WebMainFrameDocumentKey;
82
83 // pending public WebElementDictionary keys
84 extern NSString *WebElementTitleKey;             // NSString of the title of the element (used by Safari)
85 extern NSString *WebElementSpellingToolTipKey;   // NSString of a tooltip representing misspelling or bad grammar (used internally)
86
87 typedef enum {
88     WebDashboardBehaviorAlwaysSendMouseEventsToAllWindows,
89     WebDashboardBehaviorAlwaysSendActiveNullEventsToPlugIns,
90     WebDashboardBehaviorAlwaysAcceptsFirstMouse,
91     WebDashboardBehaviorAllowWheelScrolling
92 } WebDashboardBehavior;
93
94 @interface WebController : NSTreeController {
95     IBOutlet WebView *webView;
96 }
97 - (WebView *)webView;
98 - (void)setWebView:(WebView *)newWebView;
99 @end
100
101 @interface WebView (WebViewEditingActionsPendingPublic)
102
103 - (void)outdent:(id)sender;
104
105 @end
106
107 @interface WebView (WebPendingPublic)
108
109 - (void)setMainFrameDocumentReady:(BOOL)mainFrameDocumentReady;
110
111 - (void)setTabKeyCyclesThroughElements:(BOOL)cyclesElements;
112 - (BOOL)tabKeyCyclesThroughElements;
113
114 - (void)scrollDOMRangeToVisible:(DOMRange *)range;
115
116 /*!
117 @method setScriptDebugDelegate:
118 @abstract Set the WebView's WebScriptDebugDelegate delegate.
119 @param delegate The WebScriptDebugDelegate to set as the delegate.
120 */    
121 - (void)setScriptDebugDelegate:(id)delegate;
122
123 /*!
124 @method scriptDebugDelegate
125 @abstract Return the WebView's WebScriptDebugDelegate.
126 @result The WebView's WebScriptDebugDelegate.
127 */    
128 - (id)scriptDebugDelegate;
129
130 - (BOOL)shouldClose;
131
132 /*!
133     @method aeDescByEvaluatingJavaScriptFromString:
134     @param script The text of the JavaScript.
135     @result The result of the script, converted to an NSAppleEventDescriptor, or nil for failure.
136 */
137 - (NSAppleEventDescriptor *)aeDescByEvaluatingJavaScriptFromString:(NSString *)script;
138
139 // Support for displaying multiple text matches.
140 // These methods might end up moving into a protocol, so different document types can specify
141 // whether or not they implement the protocol. For now we'll just deal with HTML.
142 // These methods are still in flux; don't rely on them yet.
143 - (unsigned)markAllMatchesForText:(NSString *)string caseSensitive:(BOOL)caseFlag highlight:(BOOL)highlight limit:(unsigned)limit;
144 - (void)unmarkAllTextMatches;
145 - (NSArray *)rectsForTextMatches;
146
147 @end
148
149 @interface WebView (WebPrivate)
150
151 + (BOOL)_developerExtrasEnabled;
152 + (BOOL)_scriptDebuggerEnabled;
153
154 /*!
155     @method setBackgroundColor:
156     @param backgroundColor Color to use as the default background.
157     @abstract Sets what color the receiver draws under transparent page background colors and images.
158     This color is also used when no page is loaded. A color with alpha should only be used when the receiver is
159     in a non-opaque window, since the color is drawn using NSCompositeCopy.
160 */
161 - (void)setBackgroundColor:(NSColor *)backgroundColor;
162
163 /*!
164     @method backgroundColor
165     @result Returns the background color drawn under transparent page background colors and images.
166     This color is also used when no page is loaded. A color with alpha should only be used when the receiver is
167     in a non-opaque window, since the color is drawn using NSCompositeCopy.
168 */
169 - (NSColor *)backgroundColor;
170
171 /*!
172 Could be worth adding to the API.
173  @method loadItemsFromOtherView:
174  @abstract Loads the view with the contents of the other view, including its backforward list.
175  @param otherView   The WebView from which to copy contents.
176  */
177 - (void)_loadBackForwardListFromOtherView:(WebView *)otherView;
178
179 + (NSArray *)_supportedFileExtensions;
180
181 /*!
182     @method canShowFile:
183     @abstract Checks if the WebKit can show the content of the file at the specified path.
184     @param path The path of the file to check
185     @result YES if the WebKit can show the content of the file at the specified path.
186 */
187 + (BOOL)canShowFile:(NSString *)path;
188
189 /*!
190     @method suggestedFileExtensionForMIMEType:
191     @param MIMEType The MIME type to check.
192     @result The extension based on the MIME type
193 */
194 + (NSString *)suggestedFileExtensionForMIMEType: (NSString *)MIMEType;
195
196 // May well become public
197 - (void)_setFormDelegate:(id<WebFormDelegate>)delegate;
198 - (id<WebFormDelegate>)_formDelegate;
199
200 - (void)_close;
201
202 /*!
203     @method _registerViewClass:representationClass:forURLScheme:
204     @discussion Register classes that implement WebDocumentView and WebDocumentRepresentation respectively.
205     @param viewClass The WebDocumentView class to use to render data for a given MIME type.
206     @param representationClass The WebDocumentRepresentation class to use to represent data of the given MIME type.
207     @param scheme The URL scheme to represent with an object of the given class.
208 */
209 + (void)_registerViewClass:(Class)viewClass representationClass:(Class)representationClass forURLScheme:(NSString *)URLScheme;
210
211 + (void)_unregisterViewClassAndRepresentationClassForMIMEType:(NSString *)MIMEType;
212
213 /*!
214      @method _canHandleRequest:
215      @abstract Performs a "preflight" operation that performs some
216      speculative checks to see if a request can be used to create
217      a WebDocumentView and WebDocumentRepresentation.
218      @discussion The result of this method is valid only as long as no
219      protocols or schemes are registered or unregistered, and as long as
220      the request is not mutated (if the request is mutable). Hence, clients
221      should be prepared to handle failures even if they have performed request
222      preflighting by caling this method.
223      @param request The request to preflight.
224      @result YES if it is likely that a WebDocumentView and WebDocumentRepresentation
225      can be created for the request, NO otherwise.
226 */
227 + (BOOL)_canHandleRequest:(NSURLRequest *)request;
228
229 + (NSString *)_decodeData:(NSData *)data;
230
231 + (void)_setAlwaysUseATSU:(BOOL)f;
232
233 - (NSCachedURLResponse *)_cachedResponseForURL:(NSURL *)URL;
234
235 - (void)_addScrollerDashboardRegions:(NSMutableDictionary *)regions;
236 - (NSDictionary *)_dashboardRegions;
237
238 - (void)_setDashboardBehavior:(WebDashboardBehavior)behavior to:(BOOL)flag;
239 - (void)handleAuthenticationForResource:(id)identifier challenge:(NSURLAuthenticationChallenge *)challenge fromDataSource:(WebDataSource *)dataSource;
240 - (BOOL)_dashboardBehavior:(WebDashboardBehavior)behavior;
241
242 + (void)_setShouldUseFontSmoothing:(BOOL)f;
243 + (BOOL)_shouldUseFontSmoothing;
244
245 + (NSString *)_minimumRequiredSafariBuildNumber;
246
247 /*!
248     @method setAlwaysShowVerticalScroller:
249     @result Forces the vertical scroller to be visible if flag is YES, otherwise
250     if flag is NO the scroller with automatically show and hide as needed.
251  */
252 - (void)setAlwaysShowVerticalScroller:(BOOL)flag;
253
254 /*!
255     @method alwaysShowVerticalScroller
256     @result YES if the vertical scroller is always shown
257  */
258 - (BOOL)alwaysShowVerticalScroller;
259
260 /*!
261     @method setAlwaysShowHorizontalScroller:
262     @result Forces the horizontal scroller to be visible if flag is YES, otherwise
263     if flag is NO the scroller with automatically show and hide as needed.
264  */
265 - (void)setAlwaysShowHorizontalScroller:(BOOL)flag;
266
267 /*!
268     @method alwaysShowHorizontalScroller
269     @result YES if the horizontal scroller is always shown
270  */
271 - (BOOL)alwaysShowHorizontalScroller;
272
273 /*!
274     @method setProhibitsMainFrameScrolling:
275     @abstract Prohibits scrolling in the WebView's main frame.  Used to "lock" a WebView
276     to a specific scroll position.
277   */
278 - (void)setProhibitsMainFrameScrolling:(BOOL)prohibits;
279
280 /*!
281     @method _setAdditionalWebPlugInPaths:
282     @abstract Sets additional plugin search paths for a specific WebView.
283  */
284 - (void)_setAdditionalWebPlugInPaths:(NSArray *)newPaths;
285
286 /*!
287     @method _setInViewSourceMode:
288     @abstract Used to place a WebView into a special source-viewing mode.
289   */
290 - (void)_setInViewSourceMode:(BOOL)flag;
291
292 /*!
293     @method _inViewSourceMode;
294     @abstract Whether or not the WebView is in source-view mode for HTML.
295   */
296 - (BOOL)_inViewSourceMode;
297
298 /*!
299     @method _attachScriptDebuggerToAllFrames
300     @abstract Attaches a script debugger to all frames belonging to the receiver.
301  */
302 - (void)_attachScriptDebuggerToAllFrames;
303
304 /*!
305     @method _detachScriptDebuggerFromAllFrames
306     @abstract Detaches any script debuggers from all frames belonging to the receiver.
307  */
308 - (void)_detachScriptDebuggerFromAllFrames;
309
310 - (BOOL)defersCallbacks; // called by QuickTime plug-in
311 - (void)setDefersCallbacks:(BOOL)defer; // called by QuickTime plug-in
312
313 @end
314
315 @interface WebView (WebViewPrintingPrivate)
316 /*!
317     @method _adjustPrintingMarginsForHeaderAndFooter:
318     @abstract Increase the top and bottom margins for the current print operation to
319     account for the header and footer height. 
320     @discussion Called by <WebDocument> implementors once when a print job begins. If the
321     <WebDocument> implementor implements knowsPageRange:, this should be called from there.
322     Otherwise this should be called from beginDocument. The <WebDocument> implementors need
323     to also call _drawHeaderAndFooter.
324 */
325 - (void)_adjustPrintingMarginsForHeaderAndFooter;
326
327 /*!
328     @method _drawHeaderAndFooter
329     @abstract Gives the WebView's UIDelegate a chance to draw a header and footer on the
330     printed page. 
331     @discussion This should be called by <WebDocument> implementors from an override of
332     drawPageBorderWithSize:.
333 */
334 - (void)_drawHeaderAndFooter;
335 @end
336
337 #if !BUILDING_ON_TIGER
338 @interface WebView (WebViewGrammarChecking)
339
340 // FIXME: These two methods should be merged into WebViewEditing when we're not in API freeze
341 - (BOOL)isGrammarCheckingEnabled;
342 - (void)setGrammarCheckingEnabled:(BOOL)flag;
343
344 // FIXME: This method should be merged into WebIBActions when we're not in API freeze
345 - (void)toggleGrammarChecking:(id)sender;
346 @end
347 #endif
348
349 @interface WebView (WebViewEditingInMail)
350 - (void)_insertNewlineInQuotedContent;
351 - (BOOL)_selectWordBeforeMenuEvent;
352 - (void)_setSelectWordBeforeMenuEvent:(BOOL)flag;
353 - (void)_replaceSelectionWithNode:(DOMNode *)node matchStyle:(BOOL)matchStyle;
354 @end
355
356 @interface _WebSafeForwarder : NSObject
357 {
358     id target; // Non-retained. Don't retain delegates.
359     id defaultTarget;
360     Class templateClass;
361 }
362 - (id)initWithTarget:(id)t defaultTarget:(id)dt templateClass:(Class)aClass;
363 + (id)safeForwarderWithTarget:(id)t defaultTarget:(id)dt templateClass:(Class)aClass;
364 @end
365
366 @interface NSObject (WebFrameLoadDelegatePrivate)
367 - (void)webView:(WebView *)sender didFirstLayoutInFrame:(WebFrame *)frame;
368 // Addresses 4192534.  Private API for now.
369 - (void)webView:(WebView *)sender didHandleOnloadEventsForFrame:(WebFrame *)frame;
370 @end
371
372 #undef WebNSInteger