WebKit:
[WebKit-https.git] / WebCore / kwq / WebCoreBridge.h
1 /*
2  * Copyright (C) 2004 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  * 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 COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #import <Foundation/Foundation.h>
27
28 #import <WebCore/WebCoreKeyboardAccess.h>
29
30 #import <JavaVM/jni.h>
31
32 #ifdef __cplusplus
33
34 class KWQKHTMLPart;
35 class KHTMLView;
36 class RenderArena;
37
38 namespace khtml {
39     class RenderPart;
40     class RenderObject;
41 }
42
43 typedef khtml::RenderPart KHTMLRenderPart;
44
45 #else
46
47 @class KWQKHTMLPart;
48 @class KHTMLView;
49 @class KHTMLRenderPart;
50 @class RenderArena;
51
52 #endif
53
54 @class DOMCSSStyleDeclaration;
55 @class DOMDocument;
56 @class DOMElement;
57 @class DOMHTMLElement;
58 @class DOMNode;
59 @class DOMRange;
60 @class WebCoreSettings;
61 @class WebScriptObject;
62
63 @protocol WebCoreDOMTreeCopier;
64 @protocol WebCoreRenderTreeCopier;
65 @protocol WebCoreResourceHandle;
66 @protocol WebCoreResourceLoader;
67 @protocol WebCoreFileButton;
68 @protocol WebCoreFileButtonDelegate;
69
70 extern NSString *WebCoreElementDOMNodeKey;
71 extern NSString *WebCoreElementFrameKey;
72 extern NSString *WebCoreElementImageAltStringKey;
73 extern NSString *WebCoreElementImageKey;
74 extern NSString *WebCoreElementImageRectKey;
75 extern NSString *WebCoreElementImageURLKey;
76 extern NSString *WebCoreElementIsSelectedKey;
77 extern NSString *WebCoreElementLinkURLKey;
78 extern NSString *WebCoreElementLinkTargetFrameKey;
79 extern NSString *WebCoreElementLinkLabelKey;
80 extern NSString *WebCoreElementLinkTitleKey;
81 extern NSString *WebCoreElementTitleKey;
82
83 extern NSString *WebCorePageCacheStateKey;
84
85 typedef enum {
86     WebCoreDeviceScreen,
87     WebCoreDevicePrinter
88 } WebCoreDeviceType;
89
90 typedef enum { 
91     WebSelectByMoving, 
92     WebSelectByExtending 
93 } WebSelectionAlteration;
94
95 typedef enum { 
96     WebSelectForward, 
97     WebSelectBackward, 
98     WebSelectRight, 
99     WebSelectLeft, 
100     WebSelectUp, 
101     WebSelectDown,
102 } WebSelectionDirection;
103
104 typedef enum { 
105     WebSelectByCharacter, 
106     WebSelectByWord, 
107     WebSelectByLine 
108 } WebSelectionGranularity;
109
110
111 // WebCoreBridge objects are used by WebCore to abstract away operations that need
112 // to be implemented by library clients, for example WebKit. The objects are also
113 // used in the opposite direction, for simple access to WebCore functions without dealing
114 // directly with the KHTML C++ classes.
115
116 // A WebCoreBridge creates and holds a reference to a KHTMLPart.
117
118 // The WebCoreBridge interface contains methods for use by the non-WebCore side of the bridge.
119
120 @interface WebCoreBridge : NSObject
121 {
122     KWQKHTMLPart *_part;
123     KHTMLRenderPart *_renderPart;
124     RenderArena *_renderPartArena;
125     BOOL _drawSelectionOnly;
126     BOOL _shouldCreateRenderers;
127 }
128
129 + (WebCoreBridge *)bridgeForDOMDocument:(DOMDocument *)document;
130
131 - (void)initializeSettings:(WebCoreSettings *)settings;
132
133 - (void)setRenderPart:(KHTMLRenderPart *)renderPart;
134 - (KHTMLRenderPart *)renderPart;
135
136 - (void)setName:(NSString *)name;
137 - (NSString *)name;
138
139 - (KWQKHTMLPart *)part;
140
141 - (void)setParent:(WebCoreBridge *)parent;
142
143 - (void)provisionalLoadStarted;
144
145 - (void)openURL:(NSURL *)URL reload:(BOOL)reload
146     contentType:(NSString *)contentType refresh:(NSString *)refresh lastModified:(NSDate *)lastModified
147     pageCache:(NSDictionary *)pageCache;
148 - (void)setEncoding:(NSString *)encoding userChosen:(BOOL)userChosen;
149 - (void)addData:(NSData *)data;
150 - (void)closeURL;
151
152 - (void)didNotOpenURL:(NSURL *)URL;
153
154 - (void)saveDocumentState;
155 - (void)restoreDocumentState;
156
157 - (BOOL)canCachePage;
158 - (BOOL)saveDocumentToPageCache;
159
160 - (void)end;
161
162 - (NSURL *)URL;
163 - (NSString *)referrer;
164
165 - (void)installInFrame:(NSView *)view;
166 - (void)removeFromFrame;
167
168 - (void)scrollToAnchor:(NSString *)anchor;
169 - (void)scrollToAnchorWithURL:(NSURL *)URL;
170
171 - (void)createKHTMLViewWithNSView:(NSView *)view marginWidth:(int)mw marginHeight:(int)mh;
172
173 - (BOOL)isFrameSet;
174
175 - (void)reapplyStylesForDeviceType:(WebCoreDeviceType)deviceType;
176 - (void)forceLayoutAdjustingViewSize:(BOOL)adjustSizeFlag;
177 - (void)forceLayoutWithMinimumPageWidth:(float)minPageWidth maximumPageWidth:(float)maxPageWidth adjustingViewSize:(BOOL)adjustSizeFlag;
178 - (void)sendResizeEvent;
179 - (void)sendScrollEvent;
180 - (BOOL)needsLayout;
181 - (void)setNeedsLayout;
182 - (void)drawRect:(NSRect)rect;
183 - (void)adjustPageHeightNew:(float *)newBottom top:(float)oldTop bottom:(float)oldBottom limit:(float)bottomLimit;
184 - (NSArray*)computePageRectsWithPrintWidthScaleFactor:(float)printWidthScaleFactor printHeight:(float)printHeight;
185
186 - (void)setUsesInactiveTextBackgroundColor:(BOOL)uses;
187 - (BOOL)usesInactiveTextBackgroundColor;
188
189 - (void)setShowsFirstResponder:(BOOL)flag;
190
191 - (void)mouseDown:(NSEvent *)event;
192 - (void)mouseUp:(NSEvent *)event;
193 - (void)mouseMoved:(NSEvent *)event;
194 - (void)mouseDragged:(NSEvent *)event;
195
196 - (BOOL)sendContextMenuEvent:(NSEvent *)event; // return YES if event is eaten by WebCore
197
198 - (NSView *)nextKeyView;
199 - (NSView *)previousKeyView;
200
201 - (NSView *)nextKeyViewInsideWebFrameViews;
202 - (NSView *)previousKeyViewInsideWebFrameViews;
203
204 - (NSObject *)copyDOMTree:(id <WebCoreDOMTreeCopier>)copier;
205 - (NSObject *)copyRenderTree:(id <WebCoreRenderTreeCopier>)copier;
206 - (NSString *)renderTreeAsExternalRepresentation;
207
208 - (NSDictionary *)elementAtPoint:(NSPoint)point;
209 - (NSURL *)URLWithRelativeString:(NSString *)string;
210
211 - (DOMElement *)elementWithName:(NSString *)name inForm:(DOMElement *)form;
212 - (DOMElement *)elementForView:(NSView *)view;
213 - (BOOL)elementDoesAutoComplete:(DOMElement *)element;
214 - (BOOL)elementIsPassword:(DOMElement *)element;
215 - (DOMElement *)formForElement:(DOMElement *)element;
216 - (DOMElement *)currentForm;
217 - (NSArray *)controlsInForm:(DOMElement *)form;
218 - (NSString *)searchForLabels:(NSArray *)labels beforeElement:(DOMElement *)element;
219 - (NSString *)matchLabels:(NSArray *)labels againstElement:(DOMElement *)element;
220
221 - (BOOL)searchFor:(NSString *)string direction:(BOOL)forward caseSensitive:(BOOL)caseFlag wrap:(BOOL)wrapFlag;
222 - (void)jumpToSelection;
223
224 - (void)setTextSizeMultiplier:(float)multiplier;
225
226 - (CFStringEncoding)textEncoding;
227
228 - (NSString *)stringByEvaluatingJavaScriptFromString:(NSString *)string;
229
230 - (DOMDocument *)DOMDocument;
231 - (DOMHTMLElement *)frameElement;
232
233 - (void)setSelectionFrom:(DOMNode *)start startOffset:(int)startOffset to:(DOMNode *)end endOffset:(int) endOffset;
234
235 - (BOOL)isSelectionEditable;
236 - (BOOL)moveCaretToPoint:(NSPoint)point;
237
238 - (BOOL)haveSelection;
239
240 - (NSAttributedString *)selectedAttributedString;
241 - (NSString *)selectedString;
242
243 - (NSString *)markupStringFromNode:(DOMNode *)node nodes:(NSArray **)nodes;
244 - (NSString *)markupStringFromRange:(DOMRange *)range nodes:(NSArray **)nodes;
245
246 - (void)selectAll;
247 - (void)deselectAll;
248 - (void)deselectText;
249
250 - (NSRect)selectionRect;
251 - (NSRect)visibleSelectionRect;
252 - (NSImage *)selectionImage;
253
254 - (DOMNode *)selectionStart;
255 - (int)selectionStartOffset;
256 - (DOMNode *)selectionEnd;
257 - (int)selectionEndOffset;
258 - (void)setSelectedDOMRange:(DOMRange *)range affinity:(NSSelectionAffinity)selectionAffinity;
259 - (DOMRange *)selectedDOMRange;
260 - (NSSelectionAffinity)selectionAffinity;
261
262 - (NSAttributedString *)attributedStringFrom:(DOMNode *)startNode startOffset:(int)startOffset to:(DOMNode *)endNode endOffset:(int)endOffset;
263 - (NSFont *)renderedFontForNode:(DOMNode *)node;
264
265 + (NSString *)stringWithData:(NSData *)data textEncoding:(CFStringEncoding)textEncoding;
266 + (NSString *)stringWithData:(NSData *)data textEncodingName:(NSString *)textEncodingName;
267
268 - (BOOL)interceptKeyEvent:(NSEvent *)event toView:(NSView *)view;
269
270 - (void)setShouldCreateRenderers:(BOOL)f;
271 - (BOOL)shouldCreateRenderers;
272
273 - (int)numPendingOrLoadingRequests;
274
275 - (void)setDrawsBackground:(BOOL)drawsBackround;
276
277 - (NSColor *)bodyBackgroundColor;
278 - (NSColor *)selectionColor;
279
280 - (void)adjustViewSize;
281
282 + (void)updateAllViews;
283
284 - (id)accessibilityTree;
285
286 - (void)undoEditing:(id)arg;
287 - (void)redoEditing:(id)arg;
288 - (DOMRange *)rangeByAlteringCurrentSelection:(WebSelectionAlteration)alteration direction:(WebSelectionDirection)direction granularity:(WebSelectionGranularity)granularity;
289 - (void)alterCurrentSelection:(WebSelectionAlteration)alteration direction:(WebSelectionDirection)direction granularity:(WebSelectionGranularity)granularity;
290 - (void)replaceSelectionWithText:(NSString *)text;
291 - (void)replaceSelectionWithNode:(DOMNode *)node;
292 - (void)replaceSelectionWithMarkupString:(NSString *)markupString baseURLString:(NSString *)baseURLString;
293 - (void)replaceSelectionWithNewline;
294 - (void)deleteSelection;
295 - (void)deleteKeyPressed;
296 - (void)applyStyle:(DOMCSSStyleDeclaration *)style;
297 - (void)ensureCaretVisible;
298
299 - (WebScriptObject *)windowScriptObject;
300 - (void)bindObject:(id)object withName:(NSString *)name;
301
302 @end
303
304 // The WebCoreBridge protocol contains methods for use by the WebCore side of the bridge.
305
306 @protocol WebCoreBridge
307
308 - (NSArray *)childFrames; // WebCoreBridge objects
309 - (WebCoreBridge *)mainFrame;
310 - (WebCoreBridge *)findFrameNamed:(NSString *)name;
311 /* Creates a name for an frame unnamed in the HTML.  It should produce repeatable results for loads of the same frameset. */
312 - (NSString *)generateFrameName;
313 - (void)frameDetached;
314 - (NSView *)documentView;
315
316 - (void)loadURL:(NSURL *)URL referrer:(NSString *)referrer reload:(BOOL)reload onLoadEvent:(BOOL)onLoad target:(NSString *)target triggeringEvent:(NSEvent *)event form:(DOMElement *)form formValues:(NSDictionary *)values;
317 - (void)postWithURL:(NSURL *)URL referrer:(NSString *)referrer target:(NSString *)target data:(NSData *)data contentType:(NSString *)contentType triggeringEvent:(NSEvent *)event form:(DOMElement *)form formValues:(NSDictionary *)values;
318
319 - (WebCoreBridge *)createWindowWithURL:(NSURL *)URL frameName:(NSString *)name;
320 - (void)showWindow;
321
322 - (NSString *)userAgentForURL:(NSURL *)URL;
323
324 - (void)setTitle:(NSString *)title;
325 - (void)setStatusText:(NSString *)status;
326
327 - (void)setIconURL:(NSURL *)URL;
328 - (void)setIconURL:(NSURL *)URL withType:(NSString *)string;
329
330 - (WebCoreBridge *)createChildFrameNamed:(NSString *)frameName withURL:(NSURL *)URL
331     renderPart:(KHTMLRenderPart *)renderPart
332     allowsScrolling:(BOOL)allowsScrolling marginWidth:(int)width marginHeight:(int)height;
333
334 - (BOOL)areToolbarsVisible;
335 - (void)setToolbarsVisible:(BOOL)visible;
336 - (BOOL)isStatusBarVisible;
337 - (void)setStatusBarVisible:(BOOL)visible;
338 - (BOOL)areScrollbarsVisible;
339 - (void)setScrollbarsVisible:(BOOL)visible;
340 - (NSWindow *)window;
341 - (void)setWindowFrame:(NSRect)frame;
342 - (NSRect)windowFrame;
343 - (void)setWindowContentRect:(NSRect)frame;
344 - (NSRect)windowContentRect;
345
346 - (void)setWindowIsResizable:(BOOL)resizable;
347 - (BOOL)windowIsResizable;
348
349 - (NSResponder *)firstResponder;
350 - (void)makeFirstResponder:(NSResponder *)view;
351
352 - (void)closeWindowSoon;
353
354 - (void)runJavaScriptAlertPanelWithMessage:(NSString *)message;
355 - (BOOL)runJavaScriptConfirmPanelWithMessage:(NSString *)message;
356 - (BOOL)runJavaScriptTextInputPanelWithPrompt:(NSString *)prompt defaultText:(NSString *)defaultText returningText:(NSString **)result;
357
358 - (id <WebCoreResourceHandle>)startLoadingResource:(id <WebCoreResourceLoader>)loader withURL:(NSURL *)URL customHeaders:(NSDictionary *)customHeaders;
359 - (id <WebCoreResourceHandle>)startLoadingResource:(id <WebCoreResourceLoader>)loader withURL:(NSURL *)URL customHeaders:(NSDictionary *)customHeaders postData:(NSData *)data;
360 - (void)objectLoadedFromCacheWithURL:(NSURL *)URL response:(id)response size:(unsigned)bytes;
361
362 - (NSData *)syncLoadResourceWithURL:(NSURL *)URL customHeaders:(NSDictionary *)requestHeaders postData:(NSData *)postData finalURL:(NSURL **)finalNSURL responseHeaders:(NSDictionary **)responseHeaderDict statusCode:(int *)statusCode;
363
364 - (BOOL)isReloading;
365 - (time_t)expiresTimeForResponse:(NSURLResponse *)response;
366
367 - (void)reportClientRedirectToURL:(NSURL *)URL delay:(NSTimeInterval)seconds fireDate:(NSDate *)date lockHistory:(BOOL)lockHistory isJavaScriptFormAction:(BOOL)isJavaScriptFormAction;
368 - (void)reportClientRedirectCancelled:(BOOL)cancelWithLoadInProgress;
369
370 - (void)focusWindow;
371 - (void)unfocusWindow;
372
373 - (NSView *)nextKeyViewOutsideWebFrameViews;
374 - (NSView *)previousKeyViewOutsideWebFrameViews;
375
376 - (BOOL)defersLoading;
377 - (void)setDefersLoading:(BOOL)loading;
378 - (void)saveDocumentState:(NSArray *)documentState;
379 - (NSArray *)documentState;
380
381 - (void)setNeedsReapplyStyles;
382
383 // OK to be an NSString rather than an NSURL.
384 // This URL is only used for coloring visited links.
385 - (NSString *)requestedURLString;
386 - (NSString *)incomingReferrer;
387
388 - (NSView *)viewForPluginWithURL:(NSURL *)URL
389                       attributes:(NSArray *)attributesArray
390                          baseURL:(NSURL *)baseURL
391                         MIMEType:(NSString *)MIMEType;
392 - (NSView *)viewForJavaAppletWithFrame:(NSRect)frame
393                             attributes:(NSDictionary *)attributes
394                                baseURL:(NSURL *)baseURL;
395
396 - (BOOL)saveDocumentToPageCache:(id)documentInfo;
397
398 - (int)getObjectCacheSize;
399
400 - (BOOL)frameRequiredForMIMEType:(NSString*)MIMEType URL:(NSURL *)URL;
401
402 - (void)loadEmptyDocumentSynchronously;
403
404 - (NSString *)MIMETypeForPath:(NSString *)path;
405
406 - (void)handleMouseDragged:(NSEvent *)event;
407 - (void)handleAutoscrollForMouseDragged:(NSEvent *)event;
408 - (BOOL)mayStartDragWithMouseDragged:(NSEvent *)event;
409
410 - (int)historyLength;
411 - (void)goBackOrForward:(int)distance;
412
413 - (void)controlTextDidBeginEditing:(NSNotification *)obj;
414 - (void)controlTextDidEndEditing:(NSNotification *)obj;
415 - (void)controlTextDidChange:(NSNotification *)obj;
416
417 - (BOOL)control:(NSControl *)control textShouldBeginEditing:(NSText *)fieldEditor;
418 - (BOOL)control:(NSControl *)control textShouldEndEditing:(NSText *)fieldEditor;
419 - (BOOL)control:(NSControl *)control didFailToFormatString:(NSString *)string errorDescription:(NSString *)error;
420 - (void)control:(NSControl *)control didFailToValidatePartialString:(NSString *)string errorDescription:(NSString *)error;
421 - (BOOL)control:(NSControl *)control isValidObject:(id)obj;
422 - (BOOL)control:(NSControl *)control textView:(NSTextView *)textView doCommandBySelector:(SEL)commandSelector;
423
424 - (NSView <WebCoreFileButton> *)fileButtonWithDelegate:(id <WebCoreFileButtonDelegate>)delegate;
425
426 - (void)setHasBorder:(BOOL)hasBorder;
427
428 - (WebCoreKeyboardUIMode)keyboardUIMode;
429
430 - (void)didSetName:(NSString *)name;
431
432 - (NSFileWrapper *)fileWrapperForURL:(NSURL *)URL;
433
434 - (void)print;
435
436 - (jobject)pollForAppletInView:(NSView *)view;
437
438 - (void)registerCommandForUndo:(id)arg;
439 - (void)registerCommandForRedo:(id)arg;
440 - (void)clearUndoRedoOperations;
441 - (void)issueUndoCommand;
442 - (void)issueRedoCommand;
443 - (void)issueCutCommand;
444 - (void)issueCopyCommand;
445 - (void)issuePasteCommand;
446 - (void)postDidChangeSelectionNotification;
447 - (void)postDidChangeNotification;
448
449 - (void)editingKeyDown:(NSEvent *)event;
450
451 - (void)setIsSelected:(BOOL)isSelected forView:(NSView *)view;
452
453 - (NSString *)overrideMediaType;
454
455 - (void)windowObjectCleared;
456
457 @end
458
459 // This interface definition allows those who hold a WebCoreBridge * to call all the methods
460 // in the WebCoreBridge protocol without requiring the base implementation to supply the methods.
461 // This idiom is appropriate because WebCoreBridge is an abstract class.
462
463 @interface WebCoreBridge (SubclassResponsibility) <WebCoreBridge>
464 @end
465
466 @protocol WebCoreDOMTreeCopier <NSObject>
467 - (NSObject *)nodeWithName:(NSString *)name value:(NSString *)value source:(NSString *)source children:(NSArray *)children;
468 @end
469
470 @protocol WebCoreRenderTreeCopier <NSObject>
471 - (NSObject *)nodeWithName:(NSString *)name position:(NSPoint)p rect:(NSRect)rect view:(NSView *)view children:(NSArray *)children;
472 @end
473
474 @protocol WebCoreFileButton <NSObject>
475 - (void)setFilename:(NSString *)filename;
476 - (void)performClick;
477 - (NSString *)filename;
478 - (float)baseline;
479 - (void)setVisualFrame:(NSRect)rect;
480 - (NSRect)visualFrame;
481 - (NSSize)bestVisualFrameSizeForCharacterCount:(int)count;
482 @end
483
484 @protocol WebCoreFileButtonDelegate <NSObject>
485 - (void)filenameChanged:(NSString *)filename;
486 - (void)focusChanged:(BOOL)nowHasFocus;
487 - (void)clicked;
488 @end