Enable -Wcast-qual for WebInspectorUI, WebKitLegacy, WebKit projects
[WebKit-https.git] / Source / WebKitLegacy / mac / WebView / WebFrameInternal.h
1 /*
2  * Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 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 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 // This header contains WebFrame declarations that can be used anywhere in WebKit, but are neither SPI nor API.
30
31 #import "WebFramePrivate.h"
32 #import "WebPreferencesPrivate.h"
33 #import <WebCore/EditAction.h>
34 #import <WebCore/FrameLoaderTypes.h>
35 #import <WebCore/FrameSelection.h>
36 #import <WebCore/Position.h>
37 #import <WebCore/Settings.h>
38
39 @class DOMCSSStyleDeclaration;
40 @class DOMDocumentFragment;
41 @class DOMElement;
42 @class DOMNode;
43 @class DOMRange;
44 @class WebFrameView;
45 @class WebHistoryItem;
46
47 class WebScriptDebugger;
48
49 namespace WebCore {
50     class CSSStyleDeclaration;
51     class Document;
52     class DocumentLoader;
53     class Element;
54     class Frame;
55     class Frame;
56     class HistoryItem;
57     class HTMLElement;
58     class HTMLFrameOwnerElement;
59     class Node;
60     class Page;
61     class Range;
62 }
63
64 typedef WebCore::HistoryItem WebCoreHistoryItem;
65
66 enum class WebRangeIsRelativeTo : uint8_t {
67     EditableRoot,
68     Paragraph,
69 };
70
71 WebCore::Frame* core(WebFrame *);
72 WebFrame *kit(WebCore::Frame *);
73
74 WebCore::Page* core(WebView *);
75 WebView *kit(WebCore::Page*);
76
77 WebCore::EditableLinkBehavior core(WebKitEditableLinkBehavior);
78 WebCore::TextDirectionSubmenuInclusionBehavior core(WebTextDirectionSubmenuInclusionBehavior);
79
80 #if defined(__cplusplus) && PLATFORM(IOS)
81 Vector<Vector<String>> vectorForDictationPhrasesArray(NSArray *);
82 #endif
83
84 WebView *getWebView(WebFrame *webFrame);
85
86 @interface WebFramePrivate : NSObject {
87 @public
88     WebCore::Frame* coreFrame;
89     WebFrameView *webFrameView;
90     std::unique_ptr<WebScriptDebugger> scriptDebugger;
91     id internalLoadDelegate;
92     BOOL shouldCreateRenderers;
93     BOOL includedInWebKitStatistics;
94     RetainPtr<NSString> url;
95     RetainPtr<NSString> provisionalURL;
96 #if PLATFORM(IOS)
97     BOOL isCommitting;
98 #endif
99 }
100 @end
101
102 @protocol WebCoreRenderTreeCopier <NSObject>
103 - (NSObject *)nodeWithName:(NSString *)name position:(NSPoint)position rect:(NSRect)rect view:(NSView *)view children:(NSArray *)children;
104 @end
105
106 @interface WebFrame (WebInternal)
107
108 + (void)_createMainFrameWithPage:(WebCore::Page*)page frameName:(const WTF::String&)name frameView:(WebFrameView *)frameView;
109 + (Ref<WebCore::Frame>)_createSubframeWithOwnerElement:(WebCore::HTMLFrameOwnerElement*)ownerElement frameName:(const WTF::String&)name frameView:(WebFrameView *)frameView;
110 - (id)_initWithWebFrameView:(WebFrameView *)webFrameView webView:(WebView *)webView;
111
112 - (void)_clearCoreFrame;
113
114 - (BOOL)_isIncludedInWebKitStatistics;
115
116 - (void)_updateBackgroundAndUpdatesWhileOffscreen;
117 - (void)_setInternalLoadDelegate:(id)internalLoadDelegate;
118 - (id)_internalLoadDelegate;
119 - (void)_unmarkAllBadGrammar;
120 - (void)_unmarkAllMisspellings;
121
122 - (BOOL)_hasSelection;
123 - (void)_clearSelection;
124 - (WebFrame *)_findFrameWithSelection;
125 - (void)_clearSelectionInOtherFrames;
126
127 - (void)_attachScriptDebugger;
128 - (void)_detachScriptDebugger;
129
130 // dataSource reports null for the initial empty document's data source; this is needed
131 // to preserve compatibility with Mail and Safari among others. But internal to WebKit,
132 // we need to be able to get the initial data source as well, so the _dataSource method
133 // should be used instead.
134 - (WebDataSource *)_dataSource;
135
136 #if PLATFORM(IOS)
137 + (void)_createMainFrameWithSimpleHTMLDocumentWithPage:(WebCore::Page*)page frameView:(WebFrameView *)frameView style:(NSString *)style;
138
139 - (BOOL)_isCommitting;
140 - (void)_setIsCommitting:(BOOL)value;
141 #endif
142
143 - (BOOL)_needsLayout;
144 - (void)_drawRect:(NSRect)rect contentsOnly:(BOOL)contentsOnly;
145 - (BOOL)_getVisibleRect:(NSRect*)rect;
146
147 - (NSString *)_stringByEvaluatingJavaScriptFromString:(NSString *)string;
148 - (NSString *)_stringByEvaluatingJavaScriptFromString:(NSString *)string forceUserGesture:(BOOL)forceUserGesture;
149
150 - (NSString *)_selectedString;
151 - (NSString *)_stringForRange:(DOMRange *)range;
152
153 - (DOMRange *)_convertNSRangeToDOMRange:(NSRange)range;
154 - (NSRange)_convertDOMRangeToNSRange:(DOMRange *)range;
155
156 - (NSRect)_caretRectAtPosition:(const WebCore::Position&)pos affinity:(NSSelectionAffinity)affinity;
157 - (NSRect)_firstRectForDOMRange:(DOMRange *)range;
158 - (void)_scrollDOMRangeToVisible:(DOMRange *)range;
159 #if PLATFORM(IOS)
160 - (void)_scrollDOMRangeToVisible:(DOMRange *)range withInset:(CGFloat)inset;
161 #endif
162
163 #if !PLATFORM(IOS)
164 - (DOMRange *)_rangeByAlteringCurrentSelection:(WebCore::FrameSelection::EAlteration)alteration direction:(WebCore::SelectionDirection)direction granularity:(WebCore::TextGranularity)granularity;
165 #endif
166 - (NSRange)_convertToNSRange:(WebCore::Range*)range;
167 - (RefPtr<WebCore::Range>)_convertToDOMRange:(NSRange)nsrange;
168 - (RefPtr<WebCore::Range>)_convertToDOMRange:(NSRange)nsrange rangeIsRelativeTo:(WebRangeIsRelativeTo)rangeIsRelativeTo;
169
170 - (DOMDocumentFragment *)_documentFragmentWithMarkupString:(NSString *)markupString baseURLString:(NSString *)baseURLString;
171 - (DOMDocumentFragment *)_documentFragmentWithNodesAsParagraphs:(NSArray *)nodes;
172
173 - (void)_replaceSelectionWithNode:(DOMNode *)node selectReplacement:(BOOL)selectReplacement smartReplace:(BOOL)smartReplace matchStyle:(BOOL)matchStyle;
174
175 - (void)_insertParagraphSeparatorInQuotedContent;
176
177 - (DOMRange *)_characterRangeAtPoint:(NSPoint)point;
178
179 - (DOMCSSStyleDeclaration *)_typingStyle;
180 - (void)_setTypingStyle:(DOMCSSStyleDeclaration *)style withUndoAction:(WebCore::EditAction)undoAction;
181
182 #if ENABLE(DRAG_SUPPORT) && PLATFORM(MAC)
183 - (void)_dragSourceEndedAt:(NSPoint)windowLoc operation:(NSDragOperation)operation;
184 #endif
185
186 - (BOOL)_canProvideDocumentSource;
187 - (BOOL)_canSaveAsWebArchive;
188
189 - (void)_commitData:(NSData *)data;
190
191 @end
192
193 @interface NSObject (WebInternalFrameLoadDelegate)
194 - (void)webFrame:(WebFrame *)webFrame didFinishLoadWithError:(NSError *)error;
195 @end