673b68271b87fc36f6190c913f283c2805866497
[WebKit-https.git] / Source / WebCore / editing / SpellingCorrectionCommand.cpp
1 /*
2  * Copyright (C) 2011 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "SpellingCorrectionCommand.h"
28
29 #include "AlternativeTextController.h"
30 #include "Document.h"
31 #include "DocumentFragment.h"
32 #include "Frame.h"
33 #include "InsertTextCommand.h"
34 #include "SetSelectionCommand.h"
35 #include "TextIterator.h"
36 #include "markup.h"
37
38 namespace WebCore {
39
40 #if USE(AUTOCORRECTION_PANEL)
41 // On Mac OS X, we use this command to keep track of user undoing a correction for the first time.
42 // This information is needed by spell checking service to update user specific data.
43 class SpellingCorrectionRecordUndoCommand : public SimpleEditCommand {
44 public:
45     static PassRefPtr<SpellingCorrectionRecordUndoCommand> create(Document* document, const String& corrected, const String& correction)
46     {
47         return adoptRef(new SpellingCorrectionRecordUndoCommand(document, corrected, correction));
48     }
49 private:
50     SpellingCorrectionRecordUndoCommand(Document* document, const String& corrected, const String& correction)
51         : SimpleEditCommand(document)
52         , m_corrected(corrected)
53         , m_correction(correction)
54         , m_hasBeenUndone(false)
55     {
56     }
57
58     virtual void doApply() OVERRIDE
59     {
60     }
61
62     virtual void doUnapply() OVERRIDE
63     {
64         if (!m_hasBeenUndone) {
65             document()->frame()->editor()->unappliedSpellCorrection(startingSelection(), m_corrected, m_correction);
66             m_hasBeenUndone = true;
67         }
68         
69     }
70
71 #ifndef NDEBUG
72     virtual void getNodesInCommand(HashSet<Node*>&) OVERRIDE
73     {
74     }
75 #endif
76
77     String m_corrected;
78     String m_correction;
79     bool m_hasBeenUndone;
80 };
81 #endif
82
83 SpellingCorrectionCommand::SpellingCorrectionCommand(PassRefPtr<Range> rangeToBeCorrected, const String& correction)
84     : CompositeEditCommand(rangeToBeCorrected->startContainer()->document())
85     , m_rangeToBeCorrected(rangeToBeCorrected)
86     , m_selectionToBeCorrected(m_rangeToBeCorrected.get())
87     , m_correction(correction)
88 {
89 }
90
91 void SpellingCorrectionCommand::doApply()
92 {
93     m_corrected = plainText(m_rangeToBeCorrected.get());
94     if (!m_corrected.length())
95         return;
96
97     if (!document()->frame()->selection()->shouldChangeSelection(m_selectionToBeCorrected))
98         return;
99
100     applyCommandToComposite(SetSelectionCommand::create(m_selectionToBeCorrected, FrameSelection::SpellCorrectionTriggered | FrameSelection::CloseTyping | FrameSelection::ClearTypingStyle));
101 #if USE(AUTOCORRECTION_PANEL)
102     applyCommandToComposite(SpellingCorrectionRecordUndoCommand::create(document(), m_corrected, m_correction));
103 #endif
104     applyCommandToComposite(InsertTextCommand::create(document(), m_correction));
105 }
106
107 bool SpellingCorrectionCommand::shouldRetainAutocorrectionIndicator() const
108 {
109     return true;
110 }
111
112 } // namespace WebCore