Part 2 of removing PlatformString.h, remove PlatformString.h
[WebKit-https.git] / Source / WebKit / chromium / src / EditorClientImpl.cpp
1 /*
2  * Copyright (C) 2006, 2007 Apple, Inc.  All rights reserved.
3  * Copyright (C) 2012 Google, Inc.  All rights reserved.
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  * 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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #include "config.h"
28 #include "EditorClientImpl.h"
29
30 #include "Document.h"
31 #include "Editor.h"
32 #include "EventHandler.h"
33 #include "EventNames.h"
34 #include "Frame.h"
35 #include "HTMLInputElement.h"
36 #include "HTMLNames.h"
37 #include "KeyboardCodes.h"
38 #include "KeyboardEvent.h"
39 #include "PlatformKeyboardEvent.h"
40 #include "RenderObject.h"
41 #include "Settings.h"
42 #include "SpellChecker.h"
43 #include "UndoStep.h"
44
45 #include "DOMUtilitiesPrivate.h"
46 #include "WebAutofillClient.h"
47 #include "WebEditingAction.h"
48 #include "WebElement.h"
49 #include "WebFrameClient.h"
50 #include "WebFrameImpl.h"
51 #include "WebInputElement.h"
52 #include "WebInputEventConversion.h"
53 #include "WebKit.h"
54 #include "WebNode.h"
55 #include "WebPermissionClient.h"
56 #include "WebRange.h"
57 #include "WebSpellCheckClient.h"
58 #include "WebTextAffinity.h"
59 #include "WebTextCheckingCompletionImpl.h"
60 #include "WebTextCheckingResult.h"
61 #include "WebViewClient.h"
62 #include "WebViewImpl.h"
63 #include <wtf/text/WTFString.h>
64
65 using namespace WebCore;
66
67 namespace WebKit {
68
69 // Arbitrary depth limit for the undo stack, to keep it from using
70 // unbounded memory.  This is the maximum number of distinct undoable
71 // actions -- unbroken stretches of typed characters are coalesced
72 // into a single action.
73 static const size_t maximumUndoStackDepth = 1000;
74
75 EditorClientImpl::EditorClientImpl(WebViewImpl* webview)
76     : m_webView(webview)
77     , m_inRedo(false)
78     , m_spellCheckThisFieldStatus(SpellCheckAutomatic)
79 {
80 }
81
82 EditorClientImpl::~EditorClientImpl()
83 {
84 }
85
86 void EditorClientImpl::pageDestroyed()
87 {
88     // Our lifetime is bound to the WebViewImpl.
89 }
90
91 void EditorClientImpl::frameWillDetachPage(WebCore::Frame* frame)
92 {
93 }
94
95 bool EditorClientImpl::shouldShowDeleteInterface(HTMLElement* elem)
96 {
97     // Normally, we don't care to show WebCore's deletion UI, so we only enable
98     // it if in testing mode and the test specifically requests it by using this
99     // magic class name.
100     return layoutTestMode()
101            && elem->getAttribute(HTMLNames::classAttr) == "needsDeletionUI";
102 }
103
104 bool EditorClientImpl::smartInsertDeleteEnabled()
105 {
106     if (m_webView->client())
107         return m_webView->client()->isSmartInsertDeleteEnabled();
108     return true;
109 }
110
111 bool EditorClientImpl::isSelectTrailingWhitespaceEnabled()
112 {
113     if (m_webView->client())
114         return m_webView->client()->isSelectTrailingWhitespaceEnabled();
115 #if OS(WINDOWS)
116     return true;
117 #else
118     return false;
119 #endif
120 }
121
122 bool EditorClientImpl::shouldSpellcheckByDefault()
123 {
124     // Spellcheck should be enabled for all editable areas (such as textareas,
125     // contentEditable regions, and designMode docs), except text inputs.
126     const Frame* frame = m_webView->focusedWebCoreFrame();
127     if (!frame)
128         return false;
129     const Editor* editor = frame->editor();
130     if (!editor)
131         return false;
132     if (editor->isSpellCheckingEnabledInFocusedNode())
133         return true;
134     const Document* document = frame->document();
135     if (!document)
136         return false;
137     const Node* node = document->focusedNode();
138     // If |node| is null, we default to allowing spellchecking. This is done in
139     // order to mitigate the issue when the user clicks outside the textbox, as a
140     // result of which |node| becomes null, resulting in all the spell check
141     // markers being deleted. Also, the Frame will decide not to do spellchecking
142     // if the user can't edit - so returning true here will not cause any problems
143     // to the Frame's behavior.
144     if (!node)
145         return true;
146     const RenderObject* renderer = node->renderer();
147     if (!renderer)
148         return false;
149
150     return !renderer->isTextField();
151 }
152
153 bool EditorClientImpl::isContinuousSpellCheckingEnabled()
154 {
155     if (m_spellCheckThisFieldStatus == SpellCheckForcedOff)
156         return false;
157     if (m_spellCheckThisFieldStatus == SpellCheckForcedOn)
158         return true;
159     return shouldSpellcheckByDefault();
160 }
161
162 void EditorClientImpl::toggleContinuousSpellChecking()
163 {
164     if (isContinuousSpellCheckingEnabled())
165         m_spellCheckThisFieldStatus = SpellCheckForcedOff;
166     else
167         m_spellCheckThisFieldStatus = SpellCheckForcedOn;
168 }
169
170 bool EditorClientImpl::isGrammarCheckingEnabled()
171 {
172     const Frame* frame = m_webView->focusedWebCoreFrame();
173     return frame && frame->settings() && (frame->settings()->asynchronousSpellCheckingEnabled() || frame->settings()->unifiedTextCheckerEnabled());
174 }
175
176 void EditorClientImpl::toggleGrammarChecking()
177 {
178     notImplemented();
179 }
180
181 int EditorClientImpl::spellCheckerDocumentTag()
182 {
183     ASSERT_NOT_REACHED();
184     return 0;
185 }
186
187 bool EditorClientImpl::shouldBeginEditing(Range* range)
188 {
189     if (m_webView->client())
190         return m_webView->client()->shouldBeginEditing(WebRange(range));
191     return true;
192 }
193
194 bool EditorClientImpl::shouldEndEditing(Range* range)
195 {
196     if (m_webView->client())
197         return m_webView->client()->shouldEndEditing(WebRange(range));
198     return true;
199 }
200
201 bool EditorClientImpl::shouldInsertNode(Node* node,
202                                         Range* range,
203                                         EditorInsertAction action)
204 {
205     if (m_webView->client()) {
206         return m_webView->client()->shouldInsertNode(WebNode(node),
207                                                      WebRange(range),
208                                                      static_cast<WebEditingAction>(action));
209     }
210     return true;
211 }
212
213 bool EditorClientImpl::shouldInsertText(const String& text,
214                                         Range* range,
215                                         EditorInsertAction action)
216 {
217     if (m_webView->client()) {
218         return m_webView->client()->shouldInsertText(WebString(text),
219                                                      WebRange(range),
220                                                      static_cast<WebEditingAction>(action));
221     }
222     return true;
223 }
224
225
226 bool EditorClientImpl::shouldDeleteRange(Range* range)
227 {
228     if (m_webView->client())
229         return m_webView->client()->shouldDeleteRange(WebRange(range));
230     return true;
231 }
232
233 bool EditorClientImpl::shouldChangeSelectedRange(Range* fromRange,
234                                                  Range* toRange,
235                                                  EAffinity affinity,
236                                                  bool stillSelecting)
237 {
238     if (m_webView->client()) {
239         return m_webView->client()->shouldChangeSelectedRange(WebRange(fromRange),
240                                                               WebRange(toRange),
241                                                               static_cast<WebTextAffinity>(affinity),
242                                                               stillSelecting);
243     }
244     return true;
245 }
246
247 bool EditorClientImpl::shouldApplyStyle(StylePropertySet* style, Range* range)
248 {
249     if (m_webView->client()) {
250         // FIXME: Pass a reference to the CSSStyleDeclaration somehow.
251         return m_webView->client()->shouldApplyStyle(WebString(), WebRange(range));
252     }
253     return true;
254 }
255
256 bool EditorClientImpl::shouldMoveRangeAfterDelete(Range* range,
257                                                   Range* rangeToBeReplaced)
258 {
259     return true;
260 }
261
262 void EditorClientImpl::didBeginEditing()
263 {
264     if (m_webView->client())
265         m_webView->client()->didBeginEditing();
266 }
267
268 void EditorClientImpl::respondToChangedSelection(Frame* frame)
269 {
270     if (m_webView->client()) {
271         if (frame)
272             m_webView->client()->didChangeSelection(!frame->selection()->isRange());
273     }
274 }
275
276 void EditorClientImpl::respondToChangedContents()
277 {
278     if (m_webView->client())
279         m_webView->client()->didChangeContents();
280 }
281
282 void EditorClientImpl::didEndEditing()
283 {
284     if (m_webView->client())
285         m_webView->client()->didEndEditing();
286 }
287
288 void EditorClientImpl::didWriteSelectionToPasteboard()
289 {
290 }
291
292 void EditorClientImpl::didSetSelectionTypesForPasteboard()
293 {
294 }
295
296 void EditorClientImpl::registerUndoStep(PassRefPtr<UndoStep> step)
297 {
298     if (m_undoStack.size() == maximumUndoStackDepth)
299         m_undoStack.removeFirst(); // drop oldest item off the far end
300     if (!m_inRedo)
301         m_redoStack.clear();
302     m_undoStack.append(step);
303 }
304
305 void EditorClientImpl::registerRedoStep(PassRefPtr<UndoStep> step)
306 {
307     m_redoStack.append(step);
308 }
309
310 void EditorClientImpl::clearUndoRedoOperations()
311 {
312     m_undoStack.clear();
313     m_redoStack.clear();
314 }
315
316 bool EditorClientImpl::canCopyCut(Frame* frame, bool defaultValue) const
317 {
318     if (!m_webView->permissionClient())
319         return defaultValue;
320     return m_webView->permissionClient()->allowWriteToClipboard(WebFrameImpl::fromFrame(frame), defaultValue);
321 }
322
323 bool EditorClientImpl::canPaste(Frame* frame, bool defaultValue) const
324 {
325     if (!m_webView->permissionClient())
326         return defaultValue;
327     return m_webView->permissionClient()->allowReadFromClipboard(WebFrameImpl::fromFrame(frame), defaultValue);
328 }
329
330 bool EditorClientImpl::canUndo() const
331 {
332     return !m_undoStack.isEmpty();
333 }
334
335 bool EditorClientImpl::canRedo() const
336 {
337     return !m_redoStack.isEmpty();
338 }
339
340 void EditorClientImpl::undo()
341 {
342     if (canUndo()) {
343         UndoManagerStack::iterator back = --m_undoStack.end();
344         RefPtr<UndoStep> step(*back);
345         m_undoStack.remove(back);
346         step->unapply();
347         // unapply will call us back to push this command onto the redo stack.
348     }
349 }
350
351 void EditorClientImpl::redo()
352 {
353     if (canRedo()) {
354         UndoManagerStack::iterator back = --m_redoStack.end();
355         RefPtr<UndoStep> step(*back);
356         m_redoStack.remove(back);
357
358         ASSERT(!m_inRedo);
359         m_inRedo = true;
360         step->reapply();
361         // reapply will call us back to push this command onto the undo stack.
362         m_inRedo = false;
363     }
364 }
365
366 //
367 // The below code was adapted from the WebKit file webview.cpp
368 //
369
370 static const unsigned CtrlKey = 1 << 0;
371 static const unsigned AltKey = 1 << 1;
372 static const unsigned ShiftKey = 1 << 2;
373 static const unsigned MetaKey = 1 << 3;
374 #if OS(DARWIN)
375 // Aliases for the generic key defintions to make kbd shortcuts definitions more
376 // readable on OS X.
377 static const unsigned OptionKey  = AltKey;
378
379 // Do not use this constant for anything but cursor movement commands. Keys
380 // with cmd set have their |isSystemKey| bit set, so chances are the shortcut
381 // will not be executed. Another, less important, reason is that shortcuts
382 // defined in the renderer do not blink the menu item that they triggered.  See
383 // http://crbug.com/25856 and the bugs linked from there for details.
384 static const unsigned CommandKey = MetaKey;
385 #endif
386
387 // Keys with special meaning. These will be delegated to the editor using
388 // the execCommand() method
389 struct KeyDownEntry {
390     unsigned virtualKey;
391     unsigned modifiers;
392     const char* name;
393 };
394
395 struct KeyPressEntry {
396     unsigned charCode;
397     unsigned modifiers;
398     const char* name;
399 };
400
401 static const KeyDownEntry keyDownEntries[] = {
402     { VKEY_LEFT,   0,                  "MoveLeft"                             },
403     { VKEY_LEFT,   ShiftKey,           "MoveLeftAndModifySelection"           },
404 #if OS(DARWIN)
405     { VKEY_LEFT,   OptionKey,          "MoveWordLeft"                         },
406     { VKEY_LEFT,   OptionKey | ShiftKey,
407         "MoveWordLeftAndModifySelection"                                      },
408 #else
409     { VKEY_LEFT,   CtrlKey,            "MoveWordLeft"                         },
410     { VKEY_LEFT,   CtrlKey | ShiftKey,
411         "MoveWordLeftAndModifySelection"                                      },
412 #endif
413     { VKEY_RIGHT,  0,                  "MoveRight"                            },
414     { VKEY_RIGHT,  ShiftKey,           "MoveRightAndModifySelection"          },
415 #if OS(DARWIN)
416     { VKEY_RIGHT,  OptionKey,          "MoveWordRight"                        },
417     { VKEY_RIGHT,  OptionKey | ShiftKey,
418       "MoveWordRightAndModifySelection"                                       },
419 #else
420     { VKEY_RIGHT,  CtrlKey,            "MoveWordRight"                        },
421     { VKEY_RIGHT,  CtrlKey | ShiftKey,
422       "MoveWordRightAndModifySelection"                                       },
423 #endif
424     { VKEY_UP,     0,                  "MoveUp"                               },
425     { VKEY_UP,     ShiftKey,           "MoveUpAndModifySelection"             },
426     { VKEY_PRIOR,  ShiftKey,           "MovePageUpAndModifySelection"         },
427     { VKEY_DOWN,   0,                  "MoveDown"                             },
428     { VKEY_DOWN,   ShiftKey,           "MoveDownAndModifySelection"           },
429     { VKEY_NEXT,   ShiftKey,           "MovePageDownAndModifySelection"       },
430 #if !OS(DARWIN)
431     { VKEY_PRIOR,  0,                  "MovePageUp"                           },
432     { VKEY_NEXT,   0,                  "MovePageDown"                         },
433 #endif
434     { VKEY_HOME,   0,                  "MoveToBeginningOfLine"                },
435     { VKEY_HOME,   ShiftKey,
436         "MoveToBeginningOfLineAndModifySelection"                             },
437 #if OS(DARWIN)
438     { VKEY_LEFT,   CommandKey,         "MoveToBeginningOfLine"                },
439     { VKEY_LEFT,   CommandKey | ShiftKey,
440       "MoveToBeginningOfLineAndModifySelection"                               },
441     { VKEY_PRIOR,  OptionKey,          "MovePageUp"                           },
442     { VKEY_NEXT,   OptionKey,          "MovePageDown"                         },
443 #endif
444 #if OS(DARWIN)
445     { VKEY_UP,     CommandKey,         "MoveToBeginningOfDocument"            },
446     { VKEY_UP,     CommandKey | ShiftKey,
447         "MoveToBeginningOfDocumentAndModifySelection"                         },
448 #else
449     { VKEY_HOME,   CtrlKey,            "MoveToBeginningOfDocument"            },
450     { VKEY_HOME,   CtrlKey | ShiftKey,
451         "MoveToBeginningOfDocumentAndModifySelection"                         },
452 #endif
453     { VKEY_END,    0,                  "MoveToEndOfLine"                      },
454     { VKEY_END,    ShiftKey,           "MoveToEndOfLineAndModifySelection"    },
455 #if OS(DARWIN)
456     { VKEY_DOWN,   CommandKey,         "MoveToEndOfDocument"                  },
457     { VKEY_DOWN,   CommandKey | ShiftKey,
458         "MoveToEndOfDocumentAndModifySelection"                               },
459 #else
460     { VKEY_END,    CtrlKey,            "MoveToEndOfDocument"                  },
461     { VKEY_END,    CtrlKey | ShiftKey,
462         "MoveToEndOfDocumentAndModifySelection"                               },
463 #endif
464 #if OS(DARWIN)
465     { VKEY_RIGHT,  CommandKey,         "MoveToEndOfLine"                      },
466     { VKEY_RIGHT,  CommandKey | ShiftKey,
467         "MoveToEndOfLineAndModifySelection"                                   },
468 #endif
469     { VKEY_BACK,   0,                  "DeleteBackward"                       },
470     { VKEY_BACK,   ShiftKey,           "DeleteBackward"                       },
471     { VKEY_DELETE, 0,                  "DeleteForward"                        },
472 #if OS(DARWIN)
473     { VKEY_BACK,   OptionKey,          "DeleteWordBackward"                   },
474     { VKEY_DELETE, OptionKey,          "DeleteWordForward"                    },
475 #else
476     { VKEY_BACK,   CtrlKey,            "DeleteWordBackward"                   },
477     { VKEY_DELETE, CtrlKey,            "DeleteWordForward"                    },
478 #endif
479     { 'B',         CtrlKey,            "ToggleBold"                           },
480     { 'I',         CtrlKey,            "ToggleItalic"                         },
481     { 'U',         CtrlKey,            "ToggleUnderline"                      },
482     { VKEY_ESCAPE, 0,                  "Cancel"                               },
483     { VKEY_OEM_PERIOD, CtrlKey,        "Cancel"                               },
484     { VKEY_TAB,    0,                  "InsertTab"                            },
485     { VKEY_TAB,    ShiftKey,           "InsertBacktab"                        },
486     { VKEY_RETURN, 0,                  "InsertNewline"                        },
487     { VKEY_RETURN, CtrlKey,            "InsertNewline"                        },
488     { VKEY_RETURN, AltKey,             "InsertNewline"                        },
489     { VKEY_RETURN, AltKey | ShiftKey,  "InsertNewline"                        },
490     { VKEY_RETURN, ShiftKey,           "InsertLineBreak"                      },
491     { VKEY_INSERT, CtrlKey,            "Copy"                                 },
492     { VKEY_INSERT, ShiftKey,           "Paste"                                },
493     { VKEY_DELETE, ShiftKey,           "Cut"                                  },
494 #if !OS(DARWIN)
495     // On OS X, we pipe these back to the browser, so that it can do menu item
496     // blinking.
497     { 'C',         CtrlKey,            "Copy"                                 },
498     { 'V',         CtrlKey,            "Paste"                                },
499     { 'V',         CtrlKey | ShiftKey, "PasteAndMatchStyle"                   },
500     { 'X',         CtrlKey,            "Cut"                                  },
501     { 'A',         CtrlKey,            "SelectAll"                            },
502     { 'Z',         CtrlKey,            "Undo"                                 },
503     { 'Z',         CtrlKey | ShiftKey, "Redo"                                 },
504     { 'Y',         CtrlKey,            "Redo"                                 },
505 #endif
506 };
507
508 static const KeyPressEntry keyPressEntries[] = {
509     { '\t',   0,                  "InsertTab"                                 },
510     { '\t',   ShiftKey,           "InsertBacktab"                             },
511     { '\r',   0,                  "InsertNewline"                             },
512     { '\r',   CtrlKey,            "InsertNewline"                             },
513     { '\r',   ShiftKey,           "InsertLineBreak"                           },
514     { '\r',   AltKey,             "InsertNewline"                             },
515     { '\r',   AltKey | ShiftKey,  "InsertNewline"                             },
516 };
517
518 const char* EditorClientImpl::interpretKeyEvent(const KeyboardEvent* evt)
519 {
520     const PlatformKeyboardEvent* keyEvent = evt->keyEvent();
521     if (!keyEvent)
522         return "";
523
524     static HashMap<int, const char*>* keyDownCommandsMap = 0;
525     static HashMap<int, const char*>* keyPressCommandsMap = 0;
526
527     if (!keyDownCommandsMap) {
528         keyDownCommandsMap = new HashMap<int, const char*>;
529         keyPressCommandsMap = new HashMap<int, const char*>;
530
531         for (unsigned i = 0; i < arraysize(keyDownEntries); i++) {
532             keyDownCommandsMap->set(keyDownEntries[i].modifiers << 16 | keyDownEntries[i].virtualKey,
533                                     keyDownEntries[i].name);
534         }
535
536         for (unsigned i = 0; i < arraysize(keyPressEntries); i++) {
537             keyPressCommandsMap->set(keyPressEntries[i].modifiers << 16 | keyPressEntries[i].charCode,
538                                      keyPressEntries[i].name);
539         }
540     }
541
542     unsigned modifiers = 0;
543     if (keyEvent->shiftKey())
544         modifiers |= ShiftKey;
545     if (keyEvent->altKey())
546         modifiers |= AltKey;
547     if (keyEvent->ctrlKey())
548         modifiers |= CtrlKey;
549     if (keyEvent->metaKey())
550         modifiers |= MetaKey;
551
552     if (keyEvent->type() == PlatformEvent::RawKeyDown) {
553         int mapKey = modifiers << 16 | evt->keyCode();
554         return mapKey ? keyDownCommandsMap->get(mapKey) : 0;
555     }
556
557     int mapKey = modifiers << 16 | evt->charCode();
558     return mapKey ? keyPressCommandsMap->get(mapKey) : 0;
559 }
560
561 bool EditorClientImpl::handleEditingKeyboardEvent(KeyboardEvent* evt)
562 {
563     const PlatformKeyboardEvent* keyEvent = evt->keyEvent();
564     // do not treat this as text input if it's a system key event
565     if (!keyEvent || keyEvent->isSystemKey())
566         return false;
567
568     Frame* frame = evt->target()->toNode()->document()->frame();
569     if (!frame)
570         return false;
571
572     String commandName = interpretKeyEvent(evt);
573     Editor::Command command = frame->editor()->command(commandName);
574
575     if (keyEvent->type() == PlatformEvent::RawKeyDown) {
576         // WebKit doesn't have enough information about mode to decide how
577         // commands that just insert text if executed via Editor should be treated,
578         // so we leave it upon WebCore to either handle them immediately
579         // (e.g. Tab that changes focus) or let a keypress event be generated
580         // (e.g. Tab that inserts a Tab character, or Enter).
581         if (command.isTextInsertion() || commandName.isEmpty())
582             return false;
583         if (command.execute(evt)) {
584             if (m_webView->client())
585                 m_webView->client()->didExecuteCommand(WebString(commandName));
586             return true;
587         }
588         return false;
589     }
590
591     if (command.execute(evt)) {
592         if (m_webView->client())
593             m_webView->client()->didExecuteCommand(WebString(commandName));
594         return true;
595     }
596
597     // Here we need to filter key events.
598     // On Gtk/Linux, it emits key events with ASCII text and ctrl on for ctrl-<x>.
599     // In Webkit, EditorClient::handleKeyboardEvent in
600     // WebKit/gtk/WebCoreSupport/EditorClientGtk.cpp drop such events.
601     // On Mac, it emits key events with ASCII text and meta on for Command-<x>.
602     // These key events should not emit text insert event.
603     // Alt key would be used to insert alternative character, so we should let
604     // through. Also note that Ctrl-Alt combination equals to AltGr key which is
605     // also used to insert alternative character.
606     // http://code.google.com/p/chromium/issues/detail?id=10846
607     // Windows sets both alt and meta are on when "Alt" key pressed.
608     // http://code.google.com/p/chromium/issues/detail?id=2215
609     // Also, we should not rely on an assumption that keyboards don't
610     // send ASCII characters when pressing a control key on Windows,
611     // which may be configured to do it so by user.
612     // See also http://en.wikipedia.org/wiki/Keyboard_Layout
613     // FIXME(ukai): investigate more detail for various keyboard layout.
614     if (evt->keyEvent()->text().length() == 1) {
615         UChar ch = evt->keyEvent()->text()[0U];
616
617         // Don't insert null or control characters as they can result in
618         // unexpected behaviour
619         if (ch < ' ')
620             return false;
621 #if !OS(WINDOWS)
622         // Don't insert ASCII character if ctrl w/o alt or meta is on.
623         // On Mac, we should ignore events when meta is on (Command-<x>).
624         if (ch < 0x80) {
625             if (evt->keyEvent()->ctrlKey() && !evt->keyEvent()->altKey())
626                 return false;
627 #if OS(DARWIN)
628             if (evt->keyEvent()->metaKey())
629             return false;
630 #endif
631         }
632 #endif
633     }
634
635     if (!frame->editor()->canEdit())
636         return false;
637
638     return frame->editor()->insertText(evt->keyEvent()->text(), evt);
639 }
640
641 void EditorClientImpl::handleKeyboardEvent(KeyboardEvent* evt)
642 {
643     // Give the embedder a chance to handle the keyboard event.
644     if ((m_webView->client()
645          && m_webView->client()->handleCurrentKeyboardEvent())
646         || handleEditingKeyboardEvent(evt))
647         evt->setDefaultHandled();
648 }
649
650 void EditorClientImpl::handleInputMethodKeydown(KeyboardEvent* keyEvent)
651 {
652     // We handle IME within chrome.
653 }
654
655 void EditorClientImpl::textFieldDidBeginEditing(Element* element)
656 {
657 }
658
659 void EditorClientImpl::textFieldDidEndEditing(Element* element)
660 {
661     HTMLInputElement* inputElement = toHTMLInputElement(element);
662     if (m_webView->autofillClient() && inputElement)
663         m_webView->autofillClient()->textFieldDidEndEditing(WebInputElement(inputElement));
664
665     // Notification that focus was lost.  Be careful with this, it's also sent
666     // when the page is being closed.
667
668     // Hide any showing popup.
669     m_webView->hideAutofillPopup();
670 }
671
672 void EditorClientImpl::textDidChangeInTextField(Element* element)
673 {
674     ASSERT(element->hasLocalName(HTMLNames::inputTag));
675     HTMLInputElement* inputElement = static_cast<HTMLInputElement*>(element);
676     if (m_webView->autofillClient())
677         m_webView->autofillClient()->textFieldDidChange(WebInputElement(inputElement));
678 }
679
680 bool EditorClientImpl::doTextFieldCommandFromEvent(Element* element,
681                                                    KeyboardEvent* event)
682 {
683     HTMLInputElement* inputElement = toHTMLInputElement(element);
684     if (m_webView->autofillClient() && inputElement) {
685         m_webView->autofillClient()->textFieldDidReceiveKeyDown(WebInputElement(inputElement),
686                                                                 WebKeyboardEventBuilder(*event));
687     }
688
689     // The Mac code appears to use this method as a hook to implement special
690     // keyboard commands specific to Safari's auto-fill implementation.  We
691     // just return false to allow the default action.
692     return false;
693 }
694
695 void EditorClientImpl::textWillBeDeletedInTextField(Element*)
696 {
697 }
698
699 void EditorClientImpl::textDidChangeInTextArea(Element*)
700 {
701 }
702
703 bool EditorClientImpl::shouldEraseMarkersAfterChangeSelection(TextCheckingType type) const
704 {
705     const Frame* frame = m_webView->focusedWebCoreFrame();
706     return !frame || !frame->settings() || (!frame->settings()->asynchronousSpellCheckingEnabled() && !frame->settings()->unifiedTextCheckerEnabled());
707 }
708
709 void EditorClientImpl::ignoreWordInSpellDocument(const String&)
710 {
711     notImplemented();
712 }
713
714 void EditorClientImpl::learnWord(const String&)
715 {
716     notImplemented();
717 }
718
719 void EditorClientImpl::checkSpellingOfString(const UChar* text, int length,
720                                              int* misspellingLocation,
721                                              int* misspellingLength)
722 {
723     // SpellCheckWord will write (0, 0) into the output vars, which is what our
724     // caller expects if the word is spelled correctly.
725     int spellLocation = -1;
726     int spellLength = 0;
727
728     // Check to see if the provided text is spelled correctly.
729     if (isContinuousSpellCheckingEnabled() && m_webView->spellCheckClient())
730         m_webView->spellCheckClient()->spellCheck(WebString(text, length), spellLocation, spellLength, 0);
731     else {
732         spellLocation = 0;
733         spellLength = 0;
734     }
735
736     // Note: the Mac code checks if the pointers are null before writing to them,
737     // so we do too.
738     if (misspellingLocation)
739         *misspellingLocation = spellLocation;
740     if (misspellingLength)
741         *misspellingLength = spellLength;
742 }
743
744 void EditorClientImpl::requestCheckingOfString(WTF::PassRefPtr<WebCore::TextCheckingRequest> request)
745 {
746     if (m_webView->spellCheckClient()) {
747         String text = request->text();
748         m_webView->spellCheckClient()->requestCheckingOfText(text, new WebTextCheckingCompletionImpl(request));
749     }
750 }
751
752 String EditorClientImpl::getAutoCorrectSuggestionForMisspelledWord(const String& misspelledWord)
753 {
754     if (!(isContinuousSpellCheckingEnabled() && m_webView->client()))
755         return String();
756
757     // Do not autocorrect words with capital letters in it except the
758     // first letter. This will remove cases changing "IMB" to "IBM".
759     for (size_t i = 1; i < misspelledWord.length(); i++) {
760         if (u_isupper(static_cast<UChar32>(misspelledWord[i])))
761             return String();
762     }
763
764     if (m_webView->spellCheckClient())
765         return m_webView->spellCheckClient()->autoCorrectWord(WebString(misspelledWord));
766     return String();
767 }
768
769 void EditorClientImpl::checkGrammarOfString(const UChar* text, int length, WTF::Vector<GrammarDetail>& details, int* badGrammarLocation, int* badGrammarLength)
770 {
771     if (badGrammarLocation)
772         *badGrammarLocation = -1;
773     if (badGrammarLength)
774         *badGrammarLength = 0;
775
776     if (!m_webView->spellCheckClient())
777         return;
778     WebVector<WebTextCheckingResult> webResults;
779     m_webView->spellCheckClient()->checkTextOfParagraph(WebString(text, length), WebTextCheckingTypeGrammar, &webResults);
780     if (!webResults.size())
781         return;
782
783     // Convert a list of WebTextCheckingResults to a list of GrammarDetails. If
784     // the converted vector of GrammarDetails has grammar errors, we set
785     // badGrammarLocation and badGrammarLength to tell WebKit that the input
786     // text has grammar errors.
787     for (size_t i = 0; i < webResults.size(); ++i) {
788         if (webResults[i].type == WebTextCheckingTypeGrammar) {
789             GrammarDetail detail;
790             detail.location = webResults[i].location;
791             detail.length = webResults[i].length;
792             detail.userDescription = webResults[i].replacement;
793             details.append(detail);
794         }
795     }
796     if (!details.size())
797         return;
798     if (badGrammarLocation)
799         *badGrammarLocation = 0;
800     if (badGrammarLength)
801         *badGrammarLength = length;
802 }
803
804 void EditorClientImpl::checkTextOfParagraph(const UChar* text, int length,
805                                             TextCheckingTypeMask mask,
806                                             WTF::Vector<TextCheckingResult>& results)
807 {
808     if (!m_webView->spellCheckClient())
809         return;
810
811     WebTextCheckingTypeMask webMask = static_cast<WebTextCheckingTypeMask>(mask);
812     WebVector<WebTextCheckingResult> webResults;
813     m_webView->spellCheckClient()->checkTextOfParagraph(WebString(text, length), webMask, &webResults);
814
815     results.resize(webResults.size());
816     for (size_t i = 0; i < webResults.size(); ++i)
817         results[i] = webResults[i];
818 }
819
820 void EditorClientImpl::updateSpellingUIWithGrammarString(const String&,
821                                                          const GrammarDetail& detail)
822 {
823     notImplemented();
824 }
825
826 void EditorClientImpl::updateSpellingUIWithMisspelledWord(const String& misspelledWord)
827 {
828     if (m_webView->spellCheckClient())
829         m_webView->spellCheckClient()->updateSpellingUIWithMisspelledWord(WebString(misspelledWord));
830 }
831
832 void EditorClientImpl::showSpellingUI(bool show)
833 {
834     if (m_webView->spellCheckClient())
835         m_webView->spellCheckClient()->showSpellingUI(show);
836 }
837
838 bool EditorClientImpl::spellingUIIsShowing()
839 {
840     if (m_webView->spellCheckClient())
841         return m_webView->spellCheckClient()->isShowingSpellingUI();
842     return false;
843 }
844
845 void EditorClientImpl::getGuessesForWord(const String& word,
846                                          const String& context,
847                                          WTF::Vector<String>& guesses)
848 {
849     notImplemented();
850 }
851
852 void EditorClientImpl::willSetInputMethodState()
853 {
854     if (m_webView->client())
855         m_webView->client()->resetInputMethod();
856 }
857
858 void EditorClientImpl::setInputMethodState(bool)
859 {
860 }
861
862 } // namesace WebKit