1/*
2 * Copyright (C) 2005, 2006, 2007, 2008 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 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 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#ifndef TypingCommand_h
27#define TypingCommand_h
28
29#include "TextInsertionBaseCommand.h"
30
31namespace WebCore {
32
33class TypingCommand : public TextInsertionBaseCommand {
34public:
35    enum ETypingCommand {
36        DeleteSelection,
37        DeleteKey,
38        ForwardDeleteKey,
39        InsertText,
40        InsertLineBreak,
41        InsertParagraphSeparator,
42        InsertParagraphSeparatorInQuotedContent
43    };
44
45    enum TextCompositionType {
46        TextCompositionNone,
47        TextCompositionUpdate,
48        TextCompositionConfirm
49    };
50
51    enum Option {
52        SelectInsertedText = 1 << 0,
53        KillRing = 1 << 1,
54        RetainAutocorrectionIndicator = 1 << 2,
55        PreventSpellChecking = 1 << 3,
56        SmartDelete = 1 << 4
57    };
58    typedef unsigned Options;
59
60    static void deleteSelection(Document&, Options = 0);
61    static void deleteKeyPressed(Document&, Options = 0, TextGranularity = CharacterGranularity);
62    static void forwardDeleteKeyPressed(Document&, Options = 0, TextGranularity = CharacterGranularity);
63    static void insertText(Document&, const String&, Options, TextCompositionType = TextCompositionNone);
64    static void insertText(Document&, const String&, const VisibleSelection&, Options, TextCompositionType = TextCompositionNone);
65    static void insertLineBreak(Document&, Options);
66    static void insertParagraphSeparator(Document&, Options);
67    static void insertParagraphSeparatorInQuotedContent(Document&);
68    static void closeTyping(Frame*);
69#if PLATFORM(IOS)
70    static void ensureLastEditCommandHasCurrentSelectionIfOpenForMoreTyping(Frame*, const VisibleSelection&);
71#endif
72
73    void insertText(const String &text, bool selectInsertedText);
74    void insertTextRunWithoutNewlines(const String &text, bool selectInsertedText);
75    void insertLineBreak();
76    void insertParagraphSeparatorInQuotedContent();
77    void insertParagraphSeparator();
78    void deleteKeyPressed(TextGranularity, bool killRing);
79    void forwardDeleteKeyPressed(TextGranularity, bool killRing);
80    void deleteSelection(bool smartDelete);
81    void setCompositionType(TextCompositionType type) { m_compositionType = type; }
82
83#if PLATFORM(IOS)
84    void setEndingSelectionOnLastInsertCommand(const VisibleSelection& selection);
85#endif
86
87private:
88    static PassRefPtr<TypingCommand> create(Document& document, ETypingCommand command, const String& text = "", Options options = 0, TextGranularity granularity = CharacterGranularity)
89    {
90        return adoptRef(new TypingCommand(document, command, text, options, granularity, TextCompositionNone));
91    }
92
93    static PassRefPtr<TypingCommand> create(Document& document, ETypingCommand command, const String& text, Options options, TextCompositionType compositionType)
94    {
95        return adoptRef(new TypingCommand(document, command, text, options, CharacterGranularity, compositionType));
96    }
97
98    TypingCommand(Document&, ETypingCommand, const String& text, Options, TextGranularity, TextCompositionType);
99
100    bool smartDelete() const { return m_smartDelete; }
101    void setSmartDelete(bool smartDelete) { m_smartDelete = smartDelete; }
102    bool isOpenForMoreTyping() const { return m_openForMoreTyping; }
103    void closeTyping() { m_openForMoreTyping = false; }
104
105    static PassRefPtr<TypingCommand> lastTypingCommandIfStillOpenForTyping(Frame*);
106
107    virtual void doApply();
108    virtual EditAction editingAction() const;
109    virtual bool isTypingCommand() const;
110    virtual bool preservesTypingStyle() const { return m_preservesTypingStyle; }
111    virtual bool shouldRetainAutocorrectionIndicator() const
112    {
113        ASSERT(isTopLevelCommand());
114        return m_shouldRetainAutocorrectionIndicator;
115    }
116    virtual void setShouldRetainAutocorrectionIndicator(bool retain) { m_shouldRetainAutocorrectionIndicator = retain; }
117    virtual bool shouldStopCaretBlinking() const { return true; }
118    void setShouldPreventSpellChecking(bool prevent) { m_shouldPreventSpellChecking = prevent; }
119
120    static void updateSelectionIfDifferentFromCurrentSelection(TypingCommand*, Frame*);
121
122    void updatePreservesTypingStyle(ETypingCommand);
123    void markMisspellingsAfterTyping(ETypingCommand);
124    void typingAddedToOpenCommand(ETypingCommand);
125    bool makeEditableRootEmpty();
126
127    ETypingCommand m_commandType;
128    String m_textToInsert;
129    bool m_openForMoreTyping;
130    bool m_selectInsertedText;
131    bool m_smartDelete;
132    TextGranularity m_granularity;
133    TextCompositionType m_compositionType;
134    bool m_killRing;
135    bool m_preservesTypingStyle;
136
137    // Undoing a series of backward deletes will restore a selection around all of the
138    // characters that were deleted, but only if the typing command being undone
139    // was opened with a backward delete.
140    bool m_openedByBackwardDelete;
141
142    bool m_shouldRetainAutocorrectionIndicator;
143    bool m_shouldPreventSpellChecking;
144};
145
146} // namespace WebCore
147
148#endif // TypingCommand_h
149