46fd70958868686e7ed2c5ffbf9cd0a3a9892fbd
[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     virtual void didApplyStyle() override;
73
74     virtual bool shouldMoveRangeAfterDelete(WebCore::Range*, WebCore::Range* rangeToBeReplaced) override;
75
76     virtual void didBeginEditing() override;
77     virtual void didEndEditing() override;
78     virtual void willWriteSelectionToPasteboard(WebCore::Range*) override;
79     virtual void didWriteSelectionToPasteboard() override;
80     virtual void getClientPasteboardDataForRange(WebCore::Range*, Vector<String>& pasteboardTypes, Vector<RefPtr<WebCore::SharedBuffer>>& pasteboardData) override;
81
82     virtual NSString *userVisibleString(NSURL *) override;
83     virtual WebCore::DocumentFragment* documentFragmentFromAttributedString(NSAttributedString *, Vector< RefPtr<WebCore::ArchiveResource>>&) override;
84     virtual void setInsertionPasteboard(const String&) override;
85     virtual NSURL *canonicalizeURL(NSURL *) override;
86     virtual NSURL *canonicalizeURLString(NSString *) override;
87     
88 #if USE(APPKIT)
89     virtual void uppercaseWord() override;
90     virtual void lowercaseWord() override;
91     virtual void capitalizeWord() override;
92 #endif
93
94 #if USE(AUTOMATIC_TEXT_REPLACEMENT)
95     virtual void showSubstitutionsPanel(bool show) override;
96     virtual bool substitutionsPanelIsShowing() override;
97     virtual void toggleSmartInsertDelete() override;
98     virtual bool isAutomaticQuoteSubstitutionEnabled() override;
99     virtual void toggleAutomaticQuoteSubstitution() override;
100     virtual bool isAutomaticLinkDetectionEnabled() override;
101     virtual void toggleAutomaticLinkDetection() override;
102     virtual bool isAutomaticDashSubstitutionEnabled() override;
103     virtual void toggleAutomaticDashSubstitution() override;
104     virtual bool isAutomaticTextReplacementEnabled() override;
105     virtual void toggleAutomaticTextReplacement() override;
106     virtual bool isAutomaticSpellingCorrectionEnabled() override;
107     virtual void toggleAutomaticSpellingCorrection() override;
108 #endif
109
110     virtual TextCheckerClient* textChecker() override { return this; }
111
112     virtual void respondToChangedContents() override;
113     virtual void respondToChangedSelection(WebCore::Frame*) override;
114     virtual void didChangeSelectionAndUpdateLayout() override { }
115     virtual void discardedComposition(WebCore::Frame*) override;
116
117     virtual void registerUndoStep(PassRefPtr<WebCore::UndoStep>) override;
118     virtual void registerRedoStep(PassRefPtr<WebCore::UndoStep>) override;
119     virtual void clearUndoRedoOperations() override;
120
121     virtual bool canCopyCut(WebCore::Frame*, bool defaultValue) const override;
122     virtual bool canPaste(WebCore::Frame*, bool defaultValue) const override;
123     virtual bool canUndo() const override;
124     virtual bool canRedo() const override;
125     
126     virtual void undo() override;
127     virtual void redo() override;
128     
129     virtual void handleKeyboardEvent(WebCore::KeyboardEvent*) override;
130     virtual void handleInputMethodKeydown(WebCore::KeyboardEvent*) override;
131
132     virtual void textFieldDidBeginEditing(WebCore::Element*) override;
133     virtual void textFieldDidEndEditing(WebCore::Element*) override;
134     virtual void textDidChangeInTextField(WebCore::Element*) override;
135     virtual bool doTextFieldCommandFromEvent(WebCore::Element*, WebCore::KeyboardEvent*) override;
136     virtual void textWillBeDeletedInTextField(WebCore::Element*) override;
137     virtual void textDidChangeInTextArea(WebCore::Element*) override;
138     virtual void overflowScrollPositionChanged() override { };
139
140 #if PLATFORM(IOS)
141     virtual void startDelayingAndCoalescingContentChangeNotifications() override;
142     virtual void stopDelayingAndCoalescingContentChangeNotifications() override;
143     virtual void writeDataToPasteboard(NSDictionary*) override;
144     virtual NSArray* supportedPasteboardTypesForCurrentSelection() override;
145     virtual NSArray* readDataFromPasteboard(NSString* type, int index) override;
146     virtual bool hasRichlyEditableSelection() override;
147     virtual int getPasteboardItemsCount() override;
148     virtual WebCore::DocumentFragment* documentFragmentFromDelegate(int index) override;
149     virtual bool performsTwoStepPaste(WebCore::DocumentFragment*) override;
150     virtual int pasteboardChangeCount() override;
151 #endif
152     
153     virtual bool shouldEraseMarkersAfterChangeSelection(WebCore::TextCheckingType) const override;
154     virtual void ignoreWordInSpellDocument(const String&) override;
155     virtual void learnWord(const String&) override;
156     virtual void checkSpellingOfString(StringView, int* misspellingLocation, int* misspellingLength) override;
157     virtual String getAutoCorrectSuggestionForMisspelledWord(const String&) override;
158     virtual void checkGrammarOfString(StringView, Vector<WebCore::GrammarDetail>&, int* badGrammarLocation, int* badGrammarLength) override;
159     virtual Vector<WebCore::TextCheckingResult> checkTextOfParagraph(StringView, WebCore::TextCheckingTypeMask checkingTypes) override;
160     virtual void updateSpellingUIWithGrammarString(const String&, const WebCore::GrammarDetail&) override;
161     virtual void updateSpellingUIWithMisspelledWord(const String&) override;
162     virtual void showSpellingUI(bool show) override;
163     virtual bool spellingUIIsShowing() override;
164     virtual void getGuessesForWord(const String& word, const String& context, Vector<String>& guesses) override;
165
166     virtual void willSetInputMethodState() override;
167     virtual void setInputMethodState(bool enabled) override;
168     virtual void requestCheckingOfString(PassRefPtr<WebCore::TextCheckingRequest>) override;
169
170     void registerUndoOrRedoStep(PassRefPtr<WebCore::UndoStep>, bool isRedo);
171
172     WebView *m_webView;
173     RetainPtr<WebEditorUndoTarget> m_undoTarget;
174     bool m_haveUndoRedoOperations;
175     RefPtr<WebCore::TextCheckingRequest> m_textCheckingRequest;
176 #if PLATFORM(IOS)
177     bool m_delayingContentChangeNotifications;
178     bool m_hasDelayedContentChangeNotification;
179 #endif
180 };
181
182 #if PLATFORM(COCOA)
183 inline NSSelectionAffinity kit(WebCore::EAffinity affinity)
184 {
185     switch (affinity) {
186         case WebCore::EAffinity::UPSTREAM:
187             return NSSelectionAffinityUpstream;
188         case WebCore::EAffinity::DOWNSTREAM:
189             return NSSelectionAffinityDownstream;
190     }
191     ASSERT_NOT_REACHED();
192     return NSSelectionAffinityUpstream;
193 }
194
195 inline WebCore::EAffinity core(NSSelectionAffinity affinity)
196 {
197     switch (affinity) {
198     case NSSelectionAffinityUpstream:
199         return WebCore::EAffinity::UPSTREAM;
200     case NSSelectionAffinityDownstream:
201         return WebCore::EAffinity::DOWNSTREAM;
202     }
203     ASSERT_NOT_REACHED();
204     return WebCore::EAffinity::UPSTREAM;
205 }
206 #endif
207
208 #if PLATFORM(IOS)
209
210 inline bool WebEditorClient::isGrammarCheckingEnabled()
211 {
212     return false;
213 }
214
215 inline void WebEditorClient::toggleGrammarChecking()
216 {
217 }
218
219 inline void WebEditorClient::toggleContinuousSpellChecking()
220 {
221 }
222
223 inline int WebEditorClient::spellCheckerDocumentTag()
224 {
225     return 0;
226 }
227
228 inline bool WebEditorClient::shouldEraseMarkersAfterChangeSelection(WebCore::TextCheckingType) const
229 {
230     return true;
231 }
232
233 inline void WebEditorClient::ignoreWordInSpellDocument(const String&)
234 {
235 }
236
237 inline void WebEditorClient::learnWord(const String&)
238 {
239 }
240
241 inline void WebEditorClient::checkSpellingOfString(StringView, int* misspellingLocation, int* misspellingLength)
242 {
243 }
244
245 inline String WebEditorClient::getAutoCorrectSuggestionForMisspelledWord(const String&)
246 {
247     return "";
248 }
249
250 inline void WebEditorClient::checkGrammarOfString(StringView, Vector<WebCore::GrammarDetail>&, int* badGrammarLocation, int* badGrammarLength)
251 {
252 }
253
254 inline void WebEditorClient::updateSpellingUIWithGrammarString(const String&, const WebCore::GrammarDetail&)
255 {
256 }
257
258 inline void WebEditorClient::updateSpellingUIWithMisspelledWord(const String&)
259 {
260 }
261
262 inline void WebEditorClient::showSpellingUI(bool show)
263 {
264 }
265
266 inline bool WebEditorClient::spellingUIIsShowing()
267 {
268     return false;
269 }
270
271 inline void WebEditorClient::getGuessesForWord(const String&, const String&, Vector<String>&)
272 {
273 }
274
275 #endif