Hook up request and show for typing candidates in WK1
[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 <WebCore/VisibleSelection.h>
33 #import <wtf/Forward.h>
34 #import <wtf/RetainPtr.h>
35 #import <wtf/Vector.h>
36 #import <wtf/WeakPtr.h>
37 #import <wtf/text/StringView.h>
38
39 #if PLATFORM(IOS)
40 #import <WebCore/WAKAppKitStubs.h>
41 #endif
42
43 @class WebView;
44 @class WebEditorUndoTarget;
45
46 class WebEditorClient : public WebCore::EditorClient, public WebCore::TextCheckerClient {
47 public:
48     WebEditorClient(WebView *);
49     virtual ~WebEditorClient();
50
51     void didCheckSucceed(int sequence, NSArray *results);
52
53 private:
54     virtual void pageDestroyed() override;
55
56     virtual bool isGrammarCheckingEnabled() override;
57     virtual void toggleGrammarChecking() override;
58     virtual bool isContinuousSpellCheckingEnabled() override;
59     virtual void toggleContinuousSpellChecking() override;
60     virtual int spellCheckerDocumentTag() override;
61
62     virtual bool smartInsertDeleteEnabled() override;
63     virtual bool isSelectTrailingWhitespaceEnabled() override;
64
65     virtual bool shouldDeleteRange(WebCore::Range*) override;
66
67     virtual bool shouldBeginEditing(WebCore::Range*) override;
68     virtual bool shouldEndEditing(WebCore::Range*) override;
69     virtual bool shouldInsertNode(WebCore::Node*, WebCore::Range*, WebCore::EditorInsertAction) override;
70     virtual bool shouldInsertText(const String&, WebCore::Range*, WebCore::EditorInsertAction) override;
71     virtual bool shouldChangeSelectedRange(WebCore::Range* fromRange, WebCore::Range* toRange, WebCore::EAffinity, bool stillSelecting) override;
72
73     virtual bool shouldApplyStyle(WebCore::StyleProperties*, WebCore::Range*) override;
74     virtual void didApplyStyle() override;
75
76     virtual bool shouldMoveRangeAfterDelete(WebCore::Range*, WebCore::Range* rangeToBeReplaced) override;
77
78     virtual void didBeginEditing() override;
79     virtual void didEndEditing() override;
80     virtual void willWriteSelectionToPasteboard(WebCore::Range*) override;
81     virtual void didWriteSelectionToPasteboard() override;
82     virtual void getClientPasteboardDataForRange(WebCore::Range*, Vector<String>& pasteboardTypes, Vector<RefPtr<WebCore::SharedBuffer>>& pasteboardData) override;
83
84     virtual NSString *userVisibleString(NSURL *) override;
85     virtual WebCore::DocumentFragment* documentFragmentFromAttributedString(NSAttributedString *, Vector< RefPtr<WebCore::ArchiveResource>>&) override;
86     virtual void setInsertionPasteboard(const String&) override;
87     virtual NSURL *canonicalizeURL(NSURL *) override;
88     virtual NSURL *canonicalizeURLString(NSString *) override;
89     
90 #if USE(APPKIT)
91     virtual void uppercaseWord() override;
92     virtual void lowercaseWord() override;
93     virtual void capitalizeWord() override;
94 #endif
95
96 #if USE(AUTOMATIC_TEXT_REPLACEMENT)
97     virtual void showSubstitutionsPanel(bool show) override;
98     virtual bool substitutionsPanelIsShowing() override;
99     virtual void toggleSmartInsertDelete() override;
100     virtual bool isAutomaticQuoteSubstitutionEnabled() override;
101     virtual void toggleAutomaticQuoteSubstitution() override;
102     virtual bool isAutomaticLinkDetectionEnabled() override;
103     virtual void toggleAutomaticLinkDetection() override;
104     virtual bool isAutomaticDashSubstitutionEnabled() override;
105     virtual void toggleAutomaticDashSubstitution() override;
106     virtual bool isAutomaticTextReplacementEnabled() override;
107     virtual void toggleAutomaticTextReplacement() override;
108     virtual bool isAutomaticSpellingCorrectionEnabled() override;
109     virtual void toggleAutomaticSpellingCorrection() override;
110 #endif
111
112     virtual TextCheckerClient* textChecker() override { return this; }
113
114     virtual void respondToChangedContents() override;
115     virtual void respondToChangedSelection(WebCore::Frame*) override;
116     virtual void didChangeSelectionAndUpdateLayout() override { }
117     virtual void discardedComposition(WebCore::Frame*) override;
118
119     virtual void registerUndoStep(PassRefPtr<WebCore::UndoStep>) override;
120     virtual void registerRedoStep(PassRefPtr<WebCore::UndoStep>) override;
121     virtual void clearUndoRedoOperations() override;
122
123     virtual bool canCopyCut(WebCore::Frame*, bool defaultValue) const override;
124     virtual bool canPaste(WebCore::Frame*, bool defaultValue) const override;
125     virtual bool canUndo() const override;
126     virtual bool canRedo() const override;
127     
128     virtual void undo() override;
129     virtual void redo() override;
130     
131     virtual void handleKeyboardEvent(WebCore::KeyboardEvent*) override;
132     virtual void handleInputMethodKeydown(WebCore::KeyboardEvent*) override;
133
134     virtual void textFieldDidBeginEditing(WebCore::Element*) override;
135     virtual void textFieldDidEndEditing(WebCore::Element*) override;
136     virtual void textDidChangeInTextField(WebCore::Element*) override;
137     virtual bool doTextFieldCommandFromEvent(WebCore::Element*, WebCore::KeyboardEvent*) override;
138     virtual void textWillBeDeletedInTextField(WebCore::Element*) override;
139     virtual void textDidChangeInTextArea(WebCore::Element*) override;
140     virtual void overflowScrollPositionChanged() override { };
141
142 #if PLATFORM(IOS)
143     virtual void startDelayingAndCoalescingContentChangeNotifications() override;
144     virtual void stopDelayingAndCoalescingContentChangeNotifications() override;
145     virtual void writeDataToPasteboard(NSDictionary*) override;
146     virtual NSArray* supportedPasteboardTypesForCurrentSelection() override;
147     virtual NSArray* readDataFromPasteboard(NSString* type, int index) override;
148     virtual bool hasRichlyEditableSelection() override;
149     virtual int getPasteboardItemsCount() override;
150     virtual WebCore::DocumentFragment* documentFragmentFromDelegate(int index) override;
151     virtual bool performsTwoStepPaste(WebCore::DocumentFragment*) override;
152     virtual int pasteboardChangeCount() override;
153 #endif
154     
155     virtual bool shouldEraseMarkersAfterChangeSelection(WebCore::TextCheckingType) const override;
156     virtual void ignoreWordInSpellDocument(const String&) override;
157     virtual void learnWord(const String&) override;
158     virtual void checkSpellingOfString(StringView, int* misspellingLocation, int* misspellingLength) override;
159     virtual String getAutoCorrectSuggestionForMisspelledWord(const String&) override;
160     virtual void checkGrammarOfString(StringView, Vector<WebCore::GrammarDetail>&, int* badGrammarLocation, int* badGrammarLength) override;
161     virtual Vector<WebCore::TextCheckingResult> checkTextOfParagraph(StringView, WebCore::TextCheckingTypeMask checkingTypes) override;
162     virtual void updateSpellingUIWithGrammarString(const String&, const WebCore::GrammarDetail&) override;
163     virtual void updateSpellingUIWithMisspelledWord(const String&) override;
164     virtual void showSpellingUI(bool show) override;
165     virtual bool spellingUIIsShowing() override;
166     virtual void getGuessesForWord(const String& word, const String& context, Vector<String>& guesses) override;
167
168     virtual void willSetInputMethodState() override;
169     virtual void setInputMethodState(bool enabled) override;
170     virtual void requestCheckingOfString(PassRefPtr<WebCore::TextCheckingRequest>) override;
171
172 #if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101200
173     virtual void requestCandidatesForSelection(const WebCore::VisibleSelection&) override;
174     void handleRequestedCandidates(NSInteger, NSArray<NSTextCheckingResult *> *);
175     void handleAcceptedCandidate(NSTextCheckingResult *);
176 #endif
177
178     void registerUndoOrRedoStep(PassRefPtr<WebCore::UndoStep>, bool isRedo);
179
180     WebView *m_webView;
181     RetainPtr<WebEditorUndoTarget> m_undoTarget;
182     bool m_haveUndoRedoOperations;
183     RefPtr<WebCore::TextCheckingRequest> m_textCheckingRequest;
184 #if PLATFORM(IOS)
185     bool m_delayingContentChangeNotifications;
186     bool m_hasDelayedContentChangeNotification;
187 #endif
188
189     WebCore::VisibleSelection m_lastSelectionForRequestedCandidates;
190
191     WeakPtrFactory<WebEditorClient> m_weakPtrFactory;
192 };
193
194 #if PLATFORM(COCOA)
195 inline NSSelectionAffinity kit(WebCore::EAffinity affinity)
196 {
197     switch (affinity) {
198         case WebCore::EAffinity::UPSTREAM:
199             return NSSelectionAffinityUpstream;
200         case WebCore::EAffinity::DOWNSTREAM:
201             return NSSelectionAffinityDownstream;
202     }
203     ASSERT_NOT_REACHED();
204     return NSSelectionAffinityUpstream;
205 }
206
207 inline WebCore::EAffinity core(NSSelectionAffinity affinity)
208 {
209     switch (affinity) {
210     case NSSelectionAffinityUpstream:
211         return WebCore::EAffinity::UPSTREAM;
212     case NSSelectionAffinityDownstream:
213         return WebCore::EAffinity::DOWNSTREAM;
214     }
215     ASSERT_NOT_REACHED();
216     return WebCore::EAffinity::UPSTREAM;
217 }
218 #endif
219
220 #if PLATFORM(IOS)
221
222 inline bool WebEditorClient::isGrammarCheckingEnabled()
223 {
224     return false;
225 }
226
227 inline void WebEditorClient::toggleGrammarChecking()
228 {
229 }
230
231 inline void WebEditorClient::toggleContinuousSpellChecking()
232 {
233 }
234
235 inline int WebEditorClient::spellCheckerDocumentTag()
236 {
237     return 0;
238 }
239
240 inline bool WebEditorClient::shouldEraseMarkersAfterChangeSelection(WebCore::TextCheckingType) const
241 {
242     return true;
243 }
244
245 inline void WebEditorClient::ignoreWordInSpellDocument(const String&)
246 {
247 }
248
249 inline void WebEditorClient::learnWord(const String&)
250 {
251 }
252
253 inline void WebEditorClient::checkSpellingOfString(StringView, int* misspellingLocation, int* misspellingLength)
254 {
255 }
256
257 inline String WebEditorClient::getAutoCorrectSuggestionForMisspelledWord(const String&)
258 {
259     return "";
260 }
261
262 inline void WebEditorClient::checkGrammarOfString(StringView, Vector<WebCore::GrammarDetail>&, int* badGrammarLocation, int* badGrammarLength)
263 {
264 }
265
266 inline void WebEditorClient::updateSpellingUIWithGrammarString(const String&, const WebCore::GrammarDetail&)
267 {
268 }
269
270 inline void WebEditorClient::updateSpellingUIWithMisspelledWord(const String&)
271 {
272 }
273
274 inline void WebEditorClient::showSpellingUI(bool show)
275 {
276 }
277
278 inline bool WebEditorClient::spellingUIIsShowing()
279 {
280     return false;
281 }
282
283 inline void WebEditorClient::getGuessesForWord(const String&, const String&, Vector<String>&)
284 {
285 }
286
287 #endif