WebCore:
[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     void setActivationEventNumber(int num) { _activationEventNumber = num; }
235
236     bool eventMayStartDrag(NSEvent *);
237     void dragSourceMovedTo(const QPoint &loc);
238     void dragSourceEndedAt(const QPoint &loc, NSDragOperation operation);
239
240     bool mayCut();
241     bool mayCopy();
242     bool mayPaste();
243     bool tryCut();
244     bool tryCopy();
245     bool tryPaste();
246     
247     bool sendContextMenuEvent(NSEvent *);
248
249     void clearTimers();
250     static void clearTimers(KHTMLView *);
251     
252     bool passSubframeEventToSubframe(DOM::NodeImpl::MouseEvent &);
253     
254     void redirectionTimerStartedOrStopped();
255     
256     static const QPtrList<KWQKHTMLPart> &instances() { return mutableInstances(); }
257
258     void clearRecordedFormValues();
259     void recordFormValue(const QString &name, const QString &value, DOM::HTMLFormElementImpl *element);
260     DOM::HTMLFormElementImpl *currentForm() const;
261
262     NSString *searchForLabelsAboveCell(QRegExp *regExp, DOM::HTMLTableCellElementImpl *cell);
263     NSString *searchForLabelsBeforeElement(NSArray *labels, DOM::ElementImpl *element);
264     NSString *matchLabelsAgainstElement(NSArray *labels, DOM::ElementImpl *element);
265
266     bool findString(NSString *str, bool forward, bool caseFlag, bool wrapFlag);
267
268     void setSettings(KHTMLSettings *);
269
270     KWQWindowWidget *topLevelWidget();
271     
272     QString overrideMediaType();
273     
274     void setMediaType(const QString &);
275
276     void setUsesInactiveTextBackgroundColor(bool u) { _usesInactiveTextBackgroundColor = u; }
277     bool usesInactiveTextBackgroundColor() const { return _usesInactiveTextBackgroundColor; }
278
279     void setShowsFirstResponder(bool flag);
280     bool showsFirstResponder() const { return _showsFirstResponder; }
281     
282     // Convenience, to avoid repeating the code to dig down to get this.
283     QChar backslashAsCurrencySymbol() const;
284
285     NSColor *bodyBackgroundColor() const;
286     
287     WebCoreKeyboardUIMode keyboardUIMode() const;
288
289     void setName(const QString &name);
290
291     void didTellBridgeAboutLoad(const QString &urlString);
292     bool haveToldBridgeAboutLoad(const QString &urlString);
293
294     KJS::Bindings::Instance *getEmbedInstanceForView (NSView *aView);
295     KJS::Bindings::Instance *getAppletInstanceForView (NSView *aView);
296     void addPluginRootObject(const KJS::Bindings::RootObject *root);
297     void cleanupPluginRootObjects();
298     
299     void registerCommandForUndo(const khtml::EditCommand &);
300     void registerCommandForRedo(const khtml::EditCommand &);
301     void clearUndoRedoOperations();
302     void issueUndoCommand();
303     void issueRedoCommand();
304     void issueCutCommand();
305     void issueCopyCommand();
306     void issuePasteCommand();
307     void respondToChangedSelection();
308     void respondToChangedContents();
309     bool isContentEditable() const;
310     bool shouldBeginEditing(const DOM::Range &) const;
311     bool shouldEndEditing(const DOM::Range &) const;
312
313     KJS::Bindings::RootObject *bindingRootObject();
314     
315     WebScriptObject *windowScriptObject();
316     NPObject *KWQKHTMLPart::windowScriptNPObject();
317     
318     void partClearedInBegin();
319     
320     // Implementation of CSS property -khtml-user-drag == auto
321     bool shouldDragAutoNode(DOM::NodeImpl*, int x, int y) const;
322
323 private:
324     virtual void khtmlMousePressEvent(khtml::MousePressEvent *);
325     virtual void khtmlMouseDoubleClickEvent(khtml::MouseDoubleClickEvent *);
326     virtual void khtmlMouseMoveEvent(khtml::MouseMoveEvent *);
327     virtual void khtmlMouseReleaseEvent(khtml::MouseReleaseEvent *);
328     
329     bool passWidgetMouseDownEventToWidget(khtml::MouseEvent *);
330     bool passWidgetMouseDownEventToWidget(khtml::RenderWidget *);
331     bool passWidgetMouseDownEventToWidget(QWidget *);
332     
333     void setPolicyBaseURL(const DOM::DOMString &);
334     
335     NSView *mouseDownViewIfStillGood();
336
337     QString generateFrameName();
338
339     NSView *nextKeyViewInFrame(DOM::NodeImpl *startingPoint, KWQSelectionDirection);
340     static DOM::NodeImpl *nodeForWidget(const QWidget *);
341     static KWQKHTMLPart *partForNode(DOM::NodeImpl *);
342     static NSView *documentViewForNode(DOM::NodeImpl *);
343     
344     bool dragHysteresisExceeded(float dragLocationX, float dragLocationY) const;
345     bool dispatchCPPEvent(int eventId, KWQClipboard::AccessPolicy policy);
346     bool dispatchDragSrcEvent(int eventId, const QPoint &loc) const;
347
348     NSImage *imageFromRect(NSRect rect) const;
349
350     void freeClipboard();
351
352     WebCoreBridge *_bridge;
353     
354     KWQSignal _started;
355     KWQSignal _completed;
356     KWQSignal _completedWithBool;
357     
358     NSView *_mouseDownView;
359     bool _mouseDownWasInSubframe;
360     bool _sendingEventToSubview;
361     bool _mouseDownMayStartDrag;
362     bool _mouseDownMayStartSelect;
363     // in our window's coords
364     int _mouseDownWinX, _mouseDownWinY;
365     // in our view's coords
366     int _mouseDownX, _mouseDownY;
367     float _mouseDownTimestamp;
368     int _activationEventNumber;
369     
370     static NSEvent *_currentEvent;
371     static NSResponder *_firstResponderAtMouseDownTime;
372
373     KURL _submittedFormURL;
374
375     NSMutableDictionary *_formValuesAboutToBeSubmitted;
376     ObjCDOMElement *_formAboutToBeSubmitted;
377
378     static QPtrList<KWQKHTMLPart> &mutableInstances();
379
380     KWQWindowWidget *_windowWidget;
381
382     bool _usesInactiveTextBackgroundColor;
383     bool _showsFirstResponder;
384     mutable bool _drawSelectionOnly;
385     bool _haveUndoRedoOperations;
386     
387     QDict<char> urlsBridgeKnowsAbout;
388
389     friend class KHTMLPart;
390
391     KJS::Bindings::RootObject *_bindingRoot;  // The root object used for objects
392                                             // bound outside the context of a plugin.
393     QPtrList<KJS::Bindings::RootObject> rootObjects;
394     WebScriptObject *_windowScriptObject;
395     NPObject *_windowScriptNPObject;
396     
397     DOM::Node _dragSrc;     // element that may be a drag source, for the current mouse gesture
398     bool _dragSrcIsLink;
399     bool _dragSrcIsImage;
400     bool _dragSrcInSelection;
401     bool _dragSrcMayBeDHTML, _dragSrcMayBeUA;   // Are DHTML and/or the UserAgent allowed to drag out?
402     bool _dragSrcIsDHTML;
403     KWQClipboard *_dragClipboard;   // used on only the source side of dragging
404     
405     mutable DOM::Node _elementToDraw;
406 };
407
408 inline KWQKHTMLPart *KWQ(KHTMLPart *part) { return static_cast<KWQKHTMLPart *>(part); }
409 inline const KWQKHTMLPart *KWQ(const KHTMLPart *part) { return static_cast<const KWQKHTMLPart *>(part); }
410
411 #endif