8aed3334892351d172fd5ad48e13c4854a87cb2e
[WebKit-https.git] / WebCore / kwq / KWQKHTMLPart.h
1 /*
2  * Copyright (C) 2003 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 #ifndef KWQKHTMLPart_H
27 #define KWQKHTMLPart_H
28
29 #include "khtml_part.h"
30
31 #include "dom_nodeimpl.h"
32 #include "html_formimpl.h"
33 #include "html_tableimpl.h"
34
35 #import "WebCoreKeyboardAccess.h"
36
37 #include <CoreFoundation/CoreFoundation.h>
38
39 #include <JavaVM/jni.h>
40 #include <JavaScriptCore/jni_jsobject.h>
41 #include <JavaScriptCore/npruntime.h>
42 #include <JavaScriptCore/NP_jsobject.h>
43 #include <JavaScriptCore/runtime.h>
44
45 #include "KWQDict.h"
46 #include "KWQClipboard.h"
47
48 class KHTMLPartPrivate;
49 class KWQClipboard;
50 class KWQWindowWidget;
51
52 namespace khtml {
53     class RenderObject;
54 }
55
56 namespace KJS {
57     class SavedProperties;
58     class SavedBuiltins;
59     class ScheduledAction;
60 }
61
62 #ifdef __OBJC__
63
64 // Avoid clashes with KJS::DOMElement in KHTML code.
65 @class DOMElement;
66 typedef DOMElement ObjCDOMElement;
67
68 @class KWQPageState;
69 @class NSArray;
70 @class NSAttributedString;
71 @class NSColor;
72 @class NSEvent;
73 @class NSFileWrapper;
74 @class NSFont;
75 @class NSImage;
76 @class NSMutableDictionary;
77 @class NSResponder;
78 @class NSString;
79 @class NSView;
80 @class WebCoreBridge;
81 @class WebScriptObject;
82
83 #else
84
85 // Avoid clashes with KJS::DOMElement in KHTML code.
86 class ObjCDOMElement;
87
88 class KWQPageState;
89 class NSArray;
90 class NSAttributedString;
91 class NSColor;
92 class NSEvent;
93 class NSFileWrapper;
94 class NSFont;
95 class NSImage;
96 class NSMutableDictionary;
97 class NSResponder;
98 class NSString;
99 class NSView;
100 class WebCoreBridge;
101 class WebScriptObject;
102
103 #endif
104
105 enum KWQSelectionDirection {
106     KWQSelectingNext,
107     KWQSelectingPrevious
108 };
109
110 class KWQKHTMLPart : public KHTMLPart
111 {
112 public:
113     KWQKHTMLPart();
114     ~KWQKHTMLPart();
115     
116     void clear();
117
118     void setBridge(WebCoreBridge *p);
119     WebCoreBridge *bridge() const { return _bridge; }
120     void setView(KHTMLView *view);
121     KHTMLView *view() const;
122
123     void provisionalLoadStarted();
124
125     virtual bool openURL(const KURL &);
126     virtual bool closeURL();
127     void didNotOpenURL(const KURL &);
128     
129     void openURLRequest(const KURL &, const KParts::URLArgs &);
130     void submitForm(const KURL &, const KParts::URLArgs &);
131
132     void scheduleHistoryNavigation( int steps );
133     
134     void scrollToAnchor(const KURL &);
135     void jumpToSelection();
136     
137     void setEncoding(const QString &encoding, bool userChosen);
138     void addData(const char *bytes, int length);
139
140     void setTitle(const DOM::DOMString &);
141     void setStatusBarText(const QString &status);
142
143     void urlSelected(const KURL &url, int button, int state, const KParts::URLArgs &args);
144     bool requestObject(khtml::RenderPart *frame, const QString &url, const QString &serviceType, const QStringList &args);
145     KParts::ReadOnlyPart *createPart(const khtml::ChildFrame &child, const KURL &url, const QString &mimeType);
146
147     void scheduleClose();
148
149     void unfocusWindow();
150
151     QMap<int, KJS::ScheduledAction*> *pauseActions(const void *key);
152     void resumeActions(QMap<int, KJS::ScheduledAction*> *actions, const void *key);
153     
154     bool canCachePage();
155     void saveWindowProperties(KJS::SavedProperties *windowProperties);
156     void saveLocationProperties(KJS::SavedProperties *locationProperties);
157     void restoreWindowProperties(KJS::SavedProperties *windowProperties);
158     void restoreLocationProperties(KJS::SavedProperties *locationProperties);
159     void saveInterpreterBuiltins(KJS::SavedBuiltins &interpreterBuiltins);
160     void restoreInterpreterBuiltins(const KJS::SavedBuiltins &interpreterBuiltins);
161
162     void openURLFromPageCache(KWQPageState *state);
163
164     void saveDocumentState();
165     void restoreDocumentState();
166     
167     bool isFrameSet() const;
168
169     void updatePolicyBaseURL();
170
171     NSView *nextKeyView(DOM::NodeImpl *startingPoint, KWQSelectionDirection);
172     NSView *nextKeyViewInFrameHierarchy(DOM::NodeImpl *startingPoint, KWQSelectionDirection);
173     static NSView *nextKeyViewForWidget(QWidget *startingPoint, KWQSelectionDirection);
174     static bool currentEventIsKeyboardOptionTab();
175     static bool handleKeyboardOptionTabInView(NSView *view);
176     
177     virtual bool tabsToLinks() const;
178     virtual bool tabsToAllControls() const;
179     
180     static bool currentEventIsMouseDownInWidget(QWidget *candidate);
181     
182     static void setDocumentFocus(QWidget *);
183     static void clearDocumentFocus(QWidget *);
184     
185     void runJavaScriptAlert(const QString &message);
186     bool runJavaScriptConfirm(const QString &message);
187     bool runJavaScriptPrompt(const QString &message, const QString &defaultValue, QString &result);
188     void KWQKHTMLPart::addMessageToConsole(const QString &message,  unsigned int lineNumber, const QString &sourceID);
189     using KHTMLPart::xmlDocImpl;
190     khtml::RenderObject *renderer();
191     void forceLayout();
192     void forceLayoutWithPageWidthRange(float minPageWidth, float maxPageWidth);
193     void sendResizeEvent();
194     void sendScrollEvent();
195     void paint(QPainter *, const QRect &);
196
197     void adjustPageHeight(float *newBottom, float oldTop, float oldBottom, float bottomLimit);
198
199     void createEmptyDocument();
200
201     static WebCoreBridge *bridgeForWidget(const QWidget *);
202     static KWQKHTMLPart *partForWidget(const QWidget *);
203     
204     QString requestedURLString() const;
205     QString incomingReferrer() const;
206     QString userAgent() const;
207
208     QString mimeTypeForFileName(const QString &) const;
209     
210     DOM::NodeImpl *selectionStart() const;
211     int selectionStartOffset() const;
212     DOM::NodeImpl *selectionEnd() const;
213     int selectionEndOffset() const;
214
215     QRect selectionRect() const;
216     NSRect visibleSelectionRect() const;
217     NSImage *selectionImage() const;
218     NSImage *snapshotDragImage(DOM::Node node, NSRect *imageRect, NSRect *elementRect) const;
219
220     NSFont *fontForCurrentPosition() const;
221
222     NSFileWrapper *fileWrapperForElement(DOM::ElementImpl *);
223     NSAttributedString *attributedString(DOM::NodeImpl *startNode, int startOffset, DOM::NodeImpl *endNode, int endOffset);
224
225     void addMetaData(const QString &key, const QString &value);
226
227     void mouseDown(NSEvent *);
228     void mouseDragged(NSEvent *);
229     void mouseUp(NSEvent *);
230     void sendFakeEventsAfterWidgetTracking(NSEvent *initiatingEvent);
231     void mouseMoved(NSEvent *);
232     bool keyEvent(NSEvent *);
233     bool lastEventIsMouseUp();
234
235     void dragSourceMovedTo(const QPoint &loc);
236     void dragSourceEndedAt(const QPoint &loc, NSDragOperation operation);
237
238     bool mayCut();
239     bool mayCopy();
240     bool mayPaste();
241     bool tryCut();
242     bool tryCopy();
243     bool tryPaste();
244     
245     bool sendContextMenuEvent(NSEvent *);
246
247     void clearTimers();
248     static void clearTimers(KHTMLView *);
249     
250     bool passSubframeEventToSubframe(DOM::NodeImpl::MouseEvent &);
251     
252     void redirectionTimerStartedOrStopped();
253     
254     static const QPtrList<KWQKHTMLPart> &instances() { return mutableInstances(); }
255
256     void clearRecordedFormValues();
257     void recordFormValue(const QString &name, const QString &value, DOM::HTMLFormElementImpl *element);
258     DOM::HTMLFormElementImpl *currentForm() const;
259
260     NSString *searchForLabelsAboveCell(QRegExp *regExp, DOM::HTMLTableCellElementImpl *cell);
261     NSString *searchForLabelsBeforeElement(NSArray *labels, DOM::ElementImpl *element);
262     NSString *matchLabelsAgainstElement(NSArray *labels, DOM::ElementImpl *element);
263
264     bool findString(NSString *str, bool forward, bool caseFlag, bool wrapFlag);
265
266     void setSettings(KHTMLSettings *);
267
268     KWQWindowWidget *topLevelWidget();
269     
270     QString overrideMediaType();
271     
272     void setMediaType(const QString &);
273
274     void setUsesInactiveTextBackgroundColor(bool u) { _usesInactiveTextBackgroundColor = u; }
275     bool usesInactiveTextBackgroundColor() const { return _usesInactiveTextBackgroundColor; }
276
277     void setShowsFirstResponder(bool flag);
278     bool showsFirstResponder() const { return _showsFirstResponder; }
279     
280     // Convenience, to avoid repeating the code to dig down to get this.
281     QChar backslashAsCurrencySymbol() const;
282
283     NSColor *bodyBackgroundColor() const;
284     
285     WebCoreKeyboardUIMode keyboardUIMode() const;
286
287     void setName(const QString &name);
288
289     void didTellBridgeAboutLoad(const QString &urlString);
290     bool haveToldBridgeAboutLoad(const QString &urlString);
291
292     KJS::Bindings::Instance *getEmbedInstanceForView (NSView *aView);
293     KJS::Bindings::Instance *getAppletInstanceForView (NSView *aView);
294     void addPluginRootObject(const KJS::Bindings::RootObject *root);
295     void cleanupPluginRootObjects();
296     
297     void registerCommandForUndo(const khtml::EditCommand &);
298     void registerCommandForRedo(const khtml::EditCommand &);
299     void clearUndoRedoOperations();
300     bool interceptEditingKeyEvent();
301     void issueUndoCommand();
302     void issueRedoCommand();
303     void issueCutCommand();
304     void issueCopyCommand();
305     void issuePasteCommand();
306     void respondToChangedSelection();
307     void respondToChangedContents();
308     bool isContentEditable() const;
309     bool shouldBeginEditing(const DOM::Range &) const;
310     bool shouldEndEditing(const DOM::Range &) const;
311
312     KJS::Bindings::RootObject *bindingRootObject();
313     
314     WebScriptObject *windowScriptObject();
315     NPObject *KWQKHTMLPart::windowScriptNPObject();
316     
317     void partClearedInBegin();
318     
319     // Implementation of CSS property -khtml-user-drag == auto
320     bool shouldDragAutoNode(DOM::NodeImpl*) const;
321
322 private:
323     virtual void khtmlMousePressEvent(khtml::MousePressEvent *);
324     virtual void khtmlMouseDoubleClickEvent(khtml::MouseDoubleClickEvent *);
325     virtual void khtmlMouseMoveEvent(khtml::MouseMoveEvent *);
326     virtual void khtmlMouseReleaseEvent(khtml::MouseReleaseEvent *);
327     
328     bool passWidgetMouseDownEventToWidget(khtml::MouseEvent *);
329     bool passWidgetMouseDownEventToWidget(khtml::RenderWidget *);
330     bool passWidgetMouseDownEventToWidget(QWidget *);
331     
332     void setPolicyBaseURL(const DOM::DOMString &);
333     
334     NSView *mouseDownViewIfStillGood();
335
336     QString generateFrameName();
337
338     NSView *nextKeyViewInFrame(DOM::NodeImpl *startingPoint, KWQSelectionDirection);
339     static DOM::NodeImpl *nodeForWidget(const QWidget *);
340     static KWQKHTMLPart *partForNode(DOM::NodeImpl *);
341     static NSView *documentViewForNode(DOM::NodeImpl *);
342     
343     bool dragHysteresisExceeded(float dragLocationX, float dragLocationY) const;
344     bool dispatchCPPEvent(int eventId, KWQClipboard::AccessPolicy policy);
345     bool dispatchDragSrcEvent(int eventId, const QPoint &loc) const;
346
347     NSImage *imageFromRect(NSRect rect) const;
348
349     void freeClipboard();
350
351     WebCoreBridge *_bridge;
352     
353     KWQSignal _started;
354     KWQSignal _completed;
355     KWQSignal _completedWithBool;
356     
357     NSView *_mouseDownView;
358     bool _mouseDownWasInSubframe;
359     bool _sendingEventToSubview;
360     bool _mouseDownMayStartDrag;
361     bool _mouseDownMayStartSelect;
362     // in our window's coords
363     int _mouseDownWinX, _mouseDownWinY;
364     // in our view's coords
365     int _mouseDownX, _mouseDownY;
366     
367     static NSEvent *_currentEvent;
368     static NSResponder *_firstResponderAtMouseDownTime;
369
370     KURL _submittedFormURL;
371
372     NSMutableDictionary *_formValuesAboutToBeSubmitted;
373     ObjCDOMElement *_formAboutToBeSubmitted;
374
375     static QPtrList<KWQKHTMLPart> &mutableInstances();
376
377     KWQWindowWidget *_windowWidget;
378
379     bool _usesInactiveTextBackgroundColor;
380     bool _showsFirstResponder;
381     mutable bool _drawSelectionOnly;
382     bool _haveUndoRedoOperations;
383     
384     QDict<char> urlsBridgeKnowsAbout;
385
386     friend class KHTMLPart;
387
388     KJS::Bindings::RootObject *_bindingRoot;  // The root object used for objects
389                                             // bound outside the context of a plugin.
390     QPtrList<KJS::Bindings::RootObject> rootObjects;
391     WebScriptObject *_windowScriptObject;
392     NPObject *_windowScriptNPObject;
393     
394     DOM::Node _dragSrc;     // element that may be a drag source, for the current mouse gesture
395     bool _dragSrcIsLink;
396     bool _dragSrcIsImage;
397     bool _dragSrcInSelection;
398     bool _dragSrcMayBeDHTML, _dragSrcMayBeUA;   // Are DHTML and/or the UserAgent allowed to drag out?
399     bool _dragSrcIsDHTML;
400     KWQClipboard *_dragClipboard;   // used on only the source side of dragging
401     
402     mutable DOM::Node _elementToDraw;
403 };
404
405 inline KWQKHTMLPart *KWQ(KHTMLPart *part) { return static_cast<KWQKHTMLPart *>(part); }
406 inline const KWQKHTMLPart *KWQ(const KHTMLPart *part) { return static_cast<const KWQKHTMLPart *>(part); }
407
408 #endif