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 "SpellingCorrectionController.h"
30#include "DocumentFragment.h"
31#include "Frame.h"
32#include "ReplaceSelectionCommand.h"
33#include "SetSelectionCommand.h"
34#include "TextIterator.h"
35#include "markup.h"
36
37namespace WebCore {
38
39#if SUPPORT_AUTOCORRECTION_PANEL
40// On Mac OS X, we use this command to keep track of user undoing a correction for the first time.
41// This information is needed by spell checking service to update user specific data.
42class SpellingCorrectionRecordUndoCommand : public SimpleEditCommand {
43public:
44    static PassRefPtr<SpellingCorrectionRecordUndoCommand> create(Document* document, const String& corrected, const String& correction)
45    {
46        return adoptRef(new SpellingCorrectionRecordUndoCommand(document, corrected, correction));
47    }
48private:
49    SpellingCorrectionRecordUndoCommand(Document* document, const String& corrected, const String& correction)
50        : SimpleEditCommand(document)
51        , m_corrected(corrected)
52        , m_correction(correction)
53        , m_hasBeenUndone(false)
54    {
55    }
56
57    virtual void doApply()
58    {
59    }
60
61    virtual void doUnapply()
62    {
63        if (!m_hasBeenUndone) {
64            document()->frame()->editor()->unappliedSpellCorrection(startingSelection(), m_corrected, m_correction);
65            m_hasBeenUndone = true;
66        }
67
68    }
69
70    String m_corrected;
71    String m_correction;
72    bool m_hasBeenUndone;
73};
74#endif
75
76SpellingCorrectionCommand::SpellingCorrectionCommand(PassRefPtr<Range> rangeToBeCorrected, const String& correction)
77    : CompositeEditCommand(rangeToBeCorrected->startContainer()->document())
78    , m_rangeToBeCorrected(rangeToBeCorrected)
79    , m_selectionToBeCorrected(m_rangeToBeCorrected.get())
80    , m_correction(correction)
81{
82}
83
84void SpellingCorrectionCommand::doApply()
85{
86    m_corrected = plainText(m_rangeToBeCorrected.get());
87    if (!m_corrected.length())
88        return;
89
90    if (!document()->frame()->selection()->shouldChangeSelection(m_selectionToBeCorrected))
91        return;
92
93    RefPtr<DocumentFragment> fragment = createFragmentFromText(m_rangeToBeCorrected.get(), m_correction);
94    if (!fragment)
95        return;
96
97    applyCommandToComposite(SetSelectionCommand::create(m_selectionToBeCorrected, SelectionController::SpellCorrectionTriggered | SelectionController::CloseTyping | SelectionController::ClearTypingStyle));
98#if SUPPORT_AUTOCORRECTION_PANEL
99    applyCommandToComposite(SpellingCorrectionRecordUndoCommand::create(document(), m_corrected, m_correction));
100#endif
101    applyCommandToComposite(ReplaceSelectionCommand::create(document(), fragment, ReplaceSelectionCommand::MatchStyle | ReplaceSelectionCommand::PreventNesting, EditActionPaste));
102}
103
104bool SpellingCorrectionCommand::shouldRetainAutocorrectionIndicator() const
105{
106    return true;
107}
108
109} // namespace WebCore
110