7f120bf2767f7b2858799c1645eafc7e46681aa9
[WebKit-https.git] / Source / WebKit / mac / WebCoreSupport / WebEditorClient.h
1 /*
2  * Copyright (C) 2006, 2014 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #import <WebCore/EditorClient.h>
31 #import <WebCore/TextCheckerClient.h>
32 #import <wtf/Forward.h>
33 #import <wtf/RetainPtr.h>
34 #import <wtf/Vector.h>
35 #import <wtf/text/StringView.h>
36
37 #if PLATFORM(IOS)
38 #import <WebCore/WAKAppKitStubs.h>
39 #endif
40
41 @class WebView;
42 @class WebEditorUndoTarget;
43
44 class WebEditorClient : public WebCore::EditorClient, public WebCore::TextCheckerClient {
45 public:
46     WebEditorClient(WebView *);
47     virtual ~WebEditorClient();
48
49     void didCheckSucceed(int sequence, NSArray *results);
50
51 private:
52     virtual void pageDestroyed() override;
53
54     virtual bool isGrammarCheckingEnabled() override;
55     virtual void toggleGrammarChecking() override;
56     virtual bool isContinuousSpellCheckingEnabled() override;
57     virtual void toggleContinuousSpellChecking() override;
58     virtual int spellCheckerDocumentTag() override;
59
60     virtual bool smartInsertDeleteEnabled() override;
61     virtual bool isSelectTrailingWhitespaceEnabled() override;
62
63     virtual bool shouldDeleteRange(WebCore::Range*) override;
64
65     virtual bool shouldBeginEditing(WebCore::Range*) override;
66     virtual bool shouldEndEditing(WebCore::Range*) override;
67     virtual bool shouldInsertNode(WebCore::Node*, WebCore::Range*, WebCore::EditorInsertAction) override;
68     virtual bool shouldInsertText(const String&, WebCore::Range*, WebCore::EditorInsertAction) override;
69     virtual bool shouldChangeSelectedRange(WebCore::Range* fromRange, WebCore::Range* toRange, WebCore::EAffinity, bool stillSelecting) override;
70
71     virtual bool shouldApplyStyle(WebCore::StyleProperties*, WebCore::Range*) override;
72     
73     virtual bool shouldMoveRangeAfterDelete(WebCore::Range*, WebCore::Range* rangeToBeReplaced) override;
74
75     virtual void didBeginEditing() override;
76     virtual void didEndEditing() override;
77     virtual void willWriteSelectionToPasteboard(WebCore::Range*) override;
78     virtual void didWriteSelectionToPasteboard() override;
79     virtual void getClientPasteboardDataForRange(WebCore::Range*, Vector<String>& pasteboardTypes, Vector<RefPtr<WebCore::SharedBuffer>>& pasteboardData) override;
80
81     virtual NSString *userVisibleString(NSURL *) override;
82     virtual WebCore::DocumentFragment* documentFragmentFromAttributedString(NSAttributedString *, Vector< RefPtr<WebCore::ArchiveResource>>&) override;
83     virtual void setInsertionPasteboard(const String&) override;
84     virtual NSURL *canonicalizeURL(NSURL *) override;
85     virtual NSURL *canonicalizeURLString(NSString *) override;
86     
87 #if USE(APPKIT)
88     virtual void uppercaseWord() override;
89     virtual void lowercaseWord() override;
90     virtual void capitalizeWord() override;
91 #endif
92
93 #if USE(AUTOMATIC_TEXT_REPLACEMENT)
94     virtual void showSubstitutionsPanel(bool show) override;
95     virtual bool substitutionsPanelIsShowing() override;
96     virtual void toggleSmartInsertDelete() override;
97     virtual bool isAutomaticQuoteSubstitutionEnabled() override;
98     virtual void toggleAutomaticQuoteSubstitution() override;
99     virtual bool isAutomaticLinkDetectionEnabled() override;
100     virtual void toggleAutomaticLinkDetection() override;
101     virtual bool isAutomaticDashSubstitutionEnabled() override;
102     virtual void toggleAutomaticDashSubstitution() override;
103     virtual bool isAutomaticTextReplacementEnabled() override;
104     virtual void toggleAutomaticTextReplacement() override;
105     virtual bool isAutomaticSpellingCorrectionEnabled() override;
106     virtual void toggleAutomaticSpellingCorrection() override;
107 #endif
108
109 #if ENABLE(DELETION_UI)
110     virtual bool shouldShowDeleteInterface(WebCore::HTMLElement*) override;
111 #endif
112
113     virtual TextCheckerClient* textChecker() override { return this; }
114
115     virtual void respondToChangedContents() override;
116     virtual void respondToChangedSelection(WebCore::Frame*) override;
117
118     virtual void registerUndoStep(PassRefPtr<WebCore::UndoStep>) override;
119     virtual void registerRedoStep(PassRefPtr<WebCore::UndoStep>) override;
120     virtual void clearUndoRedoOperations() override;
121
122     virtual bool canCopyCut(WebCore::Frame*, bool defaultValue) const override;
123     virtual bool canPaste(WebCore::Frame*, bool defaultValue) const override;
124     virtual bool canUndo() const override;
125     virtual bool canRedo() const override;
126     
127     virtual void undo() override;
128     virtual void redo() override;
129     
130     virtual void handleKeyboardEvent(WebCore::KeyboardEvent*) override;
131     virtual void handleInputMethodKeydown(WebCore::KeyboardEvent*) override;
132
133     virtual void textFieldDidBeginEditing(WebCore::Element*) override;
134     virtual void textFieldDidEndEditing(WebCore::Element*) override;
135     virtual void textDidChangeInTextField(WebCore::Element*) override;
136     virtual bool doTextFieldCommandFromEvent(WebCore::Element*, WebCore::KeyboardEvent*) override;
137     virtual void textWillBeDeletedInTextField(WebCore::Element*) override;
138     virtual void textDidChangeInTextArea(WebCore::Element*) override;
139     virtual void overflowScrollPositionChanged() override { };
140
141 #if PLATFORM(IOS)
142     virtual void startDelayingAndCoalescingContentChangeNotifications() override;
143     virtual void stopDelayingAndCoalescingContentChangeNotifications() override;
144     virtual void writeDataToPasteboard(NSDictionary*) override;
145     virtual NSArray* supportedPasteboardTypesForCurrentSelection() override;
146     virtual NSArray* readDataFromPasteboard(NSString* type, int index) override;
147     virtual bool hasRichlyEditableSelection() override;
148     virtual int getPasteboardItemsCount() override;
149     virtual WebCore::DocumentFragment* documentFragmentFromDelegate(int index) override;
150     virtual bool performsTwoStepPaste(WebCore::DocumentFragment*) override;
151     virtual int pasteboardChangeCount() override;
152 #endif
153     
154     virtual bool shouldEraseMarkersAfterChangeSelection(WebCore::TextCheckingType) const override;
155     virtual void ignoreWordInSpellDocument(const String&) override;
156     virtual void learnWord(const String&) override;
157     virtual void checkSpellingOfString(StringView, int* misspellingLocation, int* misspellingLength) override;
158     virtual String getAutoCorrectSuggestionForMisspelledWord(const String&) override;
159     virtual void checkGrammarOfString(StringView, Vector<WebCore::GrammarDetail>&, int* badGrammarLocation, int* badGrammarLength) override;
160     virtual Vector<WebCore::TextCheckingResult> checkTextOfParagraph(StringView, WebCore::TextCheckingTypeMask checkingTypes) override;
161     virtual void updateSpellingUIWithGrammarString(const String&, const WebCore::GrammarDetail&) override;
162     virtual void updateSpellingUIWithMisspelledWord(const String&) override;
163     virtual void showSpellingUI(bool show) override;
164     virtual bool spellingUIIsShowing() override;
165     virtual void getGuessesForWord(const String& word, const String& context, Vector<String>& guesses) override;
166
167     virtual void willSetInputMethodState() override;
168     virtual void setInputMethodState(bool enabled) override;
169     virtual void requestCheckingOfString(PassRefPtr<WebCore::TextCheckingRequest>) override;
170
171     void registerUndoOrRedoStep(PassRefPtr<WebCore::UndoStep>, bool isRedo);
172
173     WebView *m_webView;
174     RetainPtr<WebEditorUndoTarget> m_undoTarget;
175     bool m_haveUndoRedoOperations;
176     RefPtr<WebCore::TextCheckingRequest> m_textCheckingRequest;
177 #if PLATFORM(IOS)
178     bool m_delayingContentChangeNotifications;
179     bool m_hasDelayedContentChangeNotification;
180 #endif
181 };
182
183 #if PLATFORM(COCOA)
184 inline NSSelectionAffinity kit(WebCore::EAffinity affinity)
185 {
186     switch (affinity) {
187         case WebCore::EAffinity::UPSTREAM:
188             return NSSelectionAffinityUpstream;
189         case WebCore::EAffinity::DOWNSTREAM:
190             return NSSelectionAffinityDownstream;
191     }
192     ASSERT_NOT_REACHED();
193     return NSSelectionAffinityUpstream;
194 }
195
196 inline WebCore::EAffinity core(NSSelectionAffinity affinity)
197 {
198     switch (affinity) {
199     case NSSelectionAffinityUpstream:
200         return WebCore::EAffinity::UPSTREAM;
201     case NSSelectionAffinityDownstream:
202         return WebCore::EAffinity::DOWNSTREAM;
203     }
204     ASSERT_NOT_REACHED();
205     return WebCore::EAffinity::UPSTREAM;
206 }
207 #endif
208
209 #if PLATFORM(IOS)
210
211 inline bool WebEditorClient::isGrammarCheckingEnabled()
212 {
213     return false;
214 }
215
216 inline void WebEditorClient::toggleGrammarChecking()
217 {
218 }
219
220 inline void WebEditorClient::toggleContinuousSpellChecking()
221 {
222 }
223
224 inline int WebEditorClient::spellCheckerDocumentTag()
225 {
226     return 0;
227 }
228
229 inline bool WebEditorClient::shouldEraseMarkersAfterChangeSelection(WebCore::TextCheckingType) const
230 {
231     return true;
232 }
233
234 inline void WebEditorClient::ignoreWordInSpellDocument(const String&)
235 {
236 }
237
238 inline void WebEditorClient::learnWord(const String&)
239 {
240 }
241
242 inline void WebEditorClient::checkSpellingOfString(StringView, int* misspellingLocation, int* misspellingLength)
243 {
244 }
245
246 inline String WebEditorClient::getAutoCorrectSuggestionForMisspelledWord(const String&)
247 {
248     return "";
249 }
250
251 inline void WebEditorClient::checkGrammarOfString(StringView, Vector<WebCore::GrammarDetail>&, int* badGrammarLocation, int* badGrammarLength)
252 {
253 }
254
255 inline void WebEditorClient::updateSpellingUIWithGrammarString(const String&, const WebCore::GrammarDetail&)
256 {
257 }
258
259 inline void WebEditorClient::updateSpellingUIWithMisspelledWord(const String&)
260 {
261 }
262
263 inline void WebEditorClient::showSpellingUI(bool show)
264 {
265 }
266
267 inline bool WebEditorClient::spellingUIIsShowing()
268 {
269     return false;
270 }
271
272 inline void WebEditorClient::getGuessesForWord(const String&, const String&, Vector<String>&)
273 {
274 }
275
276 #endif