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