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 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 #ifndef TypingCommand_h
27 #define TypingCommand_h
28 
29 #include "CompositeEditCommand.h"
30 
31 namespace WebCore {
32 
33 class TypingCommand : public CompositeEditCommand {
34 public:
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 bool isOpenForMoreTypingCommand(const EditCommand*);
69     static void closeTyping(EditCommand*);
70 
isOpenForMoreTyping()71     bool isOpenForMoreTyping() const { return m_openForMoreTyping; }
closeTyping()72     void closeTyping() { m_openForMoreTyping = false; }
73 
74     void insertText(const String &text, bool selectInsertedText);
75     void insertTextRunWithoutNewlines(const String &text, bool selectInsertedText);
76     void insertLineBreak();
77     void insertParagraphSeparatorInQuotedContent();
78     void insertParagraphSeparator();
79     void deleteKeyPressed(TextGranularity, bool killRing);
80     void forwardDeleteKeyPressed(TextGranularity, bool killRing);
81     void deleteSelection(bool smartDelete);
setCompositionType(TextCompositionType type)82     void setCompositionType(TextCompositionType type) { m_compositionType = type; }
83 
84 private:
85     static PassRefPtr<TypingCommand> create(Document* document, ETypingCommand command, const String& text = "", Options options = 0, TextGranularity granularity = CharacterGranularity)
86     {
87         return adoptRef(new TypingCommand(document, command, text, options, granularity, TextCompositionNone));
88     }
89 
create(Document * document,ETypingCommand command,const String & text,Options options,TextCompositionType compositionType)90     static PassRefPtr<TypingCommand> create(Document* document, ETypingCommand command, const String& text, Options options, TextCompositionType compositionType)
91     {
92         return adoptRef(new TypingCommand(document, command, text, options, CharacterGranularity, compositionType));
93     }
94 
95     TypingCommand(Document*, ETypingCommand, const String& text, Options, TextGranularity, TextCompositionType);
96 
smartDelete()97     bool smartDelete() const { return m_smartDelete; }
setSmartDelete(bool smartDelete)98     void setSmartDelete(bool smartDelete) { m_smartDelete = smartDelete; }
99 
100     virtual void doApply();
101     virtual EditAction editingAction() const;
102     virtual bool isTypingCommand() const;
preservesTypingStyle()103     virtual bool preservesTypingStyle() const { return m_preservesTypingStyle; }
shouldRetainAutocorrectionIndicator()104     virtual bool shouldRetainAutocorrectionIndicator() const { return m_shouldRetainAutocorrectionIndicator; }
setShouldRetainAutocorrectionIndicator(bool retain)105     virtual void setShouldRetainAutocorrectionIndicator(bool retain) { m_shouldRetainAutocorrectionIndicator = retain; }
setShouldPreventSpellChecking(bool prevent)106     void setShouldPreventSpellChecking(bool prevent) { m_shouldPreventSpellChecking = prevent; }
107 
108     static void updateSelectionIfDifferentFromCurrentSelection(TypingCommand*, Frame*);
109 
110     void updatePreservesTypingStyle(ETypingCommand);
111     void markMisspellingsAfterTyping(ETypingCommand);
112     void typingAddedToOpenCommand(ETypingCommand);
113     bool makeEditableRootEmpty();
114 
115     ETypingCommand m_commandType;
116     String m_textToInsert;
117     bool m_openForMoreTyping;
118     bool m_selectInsertedText;
119     bool m_smartDelete;
120     TextGranularity m_granularity;
121     TextCompositionType m_compositionType;
122     bool m_killRing;
123     bool m_preservesTypingStyle;
124 
125     // Undoing a series of backward deletes will restore a selection around all of the
126     // characters that were deleted, but only if the typing command being undone
127     // was opened with a backward delete.
128     bool m_openedByBackwardDelete;
129 
130     bool m_shouldRetainAutocorrectionIndicator;
131     bool m_shouldPreventSpellChecking;
132 };
133 
134 } // namespace WebCore
135 
136 #endif // TypingCommand_h
137