[Mac] REGRESSION: Auto substitution strips new lines
[WebKit-https.git] / Source / WebCore / editing / CompositeEditCommand.h
1 /*
2  * Copyright (C) 2005, 2006, 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 CompositeEditCommand_h
27 #define CompositeEditCommand_h
28
29 #include "EditCommand.h"
30 #include "CSSPropertyNames.h"
31 #include "UndoStep.h"
32 #include <wtf/Vector.h>
33
34 namespace WebCore {
35
36 class EditingStyle;
37 class HTMLElement;
38 class StyledElement;
39 class Text;
40
41 class EditCommandComposition : public UndoStep {
42 public:
43     static PassRefPtr<EditCommandComposition> create(Document*, const VisibleSelection&, const VisibleSelection&, EditAction);
44
45     virtual void unapply() OVERRIDE;
46     virtual void reapply() OVERRIDE;
47     EditAction editingAction() const OVERRIDE { return m_editAction; }
48     void append(SimpleEditCommand*);
49     bool wasCreateLinkCommand() const { return m_editAction == EditActionCreateLink; }
50
51     const VisibleSelection& startingSelection() const { return m_startingSelection; }
52     const VisibleSelection& endingSelection() const { return m_endingSelection; }
53     void setStartingSelection(const VisibleSelection&);
54     void setEndingSelection(const VisibleSelection&);
55     Element* startingRootEditableElement() const { return m_startingRootEditableElement.get(); }
56     Element* endingRootEditableElement() const { return m_endingRootEditableElement.get(); }
57
58 #ifndef NDEBUG
59     virtual void getNodesInCommand(HashSet<Node*>&);
60 #endif
61
62 private:
63     EditCommandComposition(Document*, const VisibleSelection& startingSelection, const VisibleSelection& endingSelection, EditAction);
64
65     RefPtr<Document> m_document;
66     VisibleSelection m_startingSelection;
67     VisibleSelection m_endingSelection;
68     Vector<RefPtr<SimpleEditCommand> > m_commands;
69     RefPtr<Element> m_startingRootEditableElement;
70     RefPtr<Element> m_endingRootEditableElement;
71     EditAction m_editAction;
72 };
73
74 class CompositeEditCommand : public EditCommand {
75 public:
76     virtual ~CompositeEditCommand();
77
78     void apply();
79     bool isFirstCommand(EditCommand* command) { return !m_commands.isEmpty() && m_commands.first() == command; }
80     EditCommandComposition* composition() { return m_composition.get(); }
81     EditCommandComposition* ensureComposition();
82
83     virtual bool isCreateLinkCommand() const;
84     virtual bool isTypingCommand() const;
85     virtual bool callsAppliedEditingInDoApply() const;
86     virtual bool isDictationCommand() const { return false; }
87     virtual bool preservesTypingStyle() const;
88     virtual bool shouldRetainAutocorrectionIndicator() const;
89     virtual void setShouldRetainAutocorrectionIndicator(bool);
90     virtual bool shouldStopCaretBlinking() const { return false; }
91
92 protected:
93     explicit CompositeEditCommand(Document*);
94
95     //
96     // sugary-sweet convenience functions to help create and apply edit commands in composite commands
97     //
98     void appendNode(PassRefPtr<Node>, PassRefPtr<ContainerNode> parent);
99     void applyCommandToComposite(PassRefPtr<EditCommand>);
100     void applyCommandToComposite(PassRefPtr<CompositeEditCommand>, const VisibleSelection&);
101     void applyStyle(const EditingStyle*, EditAction = EditActionChangeAttributes);
102     void applyStyle(const EditingStyle*, const Position& start, const Position& end, EditAction = EditActionChangeAttributes);
103     void applyStyledElement(PassRefPtr<Element>);
104     void removeStyledElement(PassRefPtr<Element>);
105     void deleteSelection(bool smartDelete = false, bool mergeBlocksAfterDelete = true, bool replace = false, bool expandForSpecialElements = true, bool sanitizeMarkup = true);
106     void deleteSelection(const VisibleSelection&, bool smartDelete = false, bool mergeBlocksAfterDelete = true, bool replace = false, bool expandForSpecialElements = true, bool sanitizeMarkup = true);
107     virtual void deleteTextFromNode(PassRefPtr<Text>, unsigned offset, unsigned count);
108     bool isRemovableBlock(const Node*);
109     void insertNodeAfter(PassRefPtr<Node>, PassRefPtr<Node> refChild);
110     void insertNodeAt(PassRefPtr<Node>, const Position&);
111     void insertNodeAtTabSpanPosition(PassRefPtr<Node>, const Position&);
112     void insertNodeBefore(PassRefPtr<Node>, PassRefPtr<Node> refChild, ShouldAssumeContentIsAlwaysEditable = DoNotAssumeContentIsAlwaysEditable);
113     void insertParagraphSeparator(bool useDefaultParagraphElement = false, bool pasteBlockqutoeIntoUnquotedArea = false);
114     void insertLineBreak();
115     void insertTextIntoNode(PassRefPtr<Text>, unsigned offset, const String& text);
116     void mergeIdenticalElements(PassRefPtr<Element>, PassRefPtr<Element>);
117     void rebalanceWhitespace();
118     void rebalanceWhitespaceAt(const Position&);
119     void rebalanceWhitespaceOnTextSubstring(PassRefPtr<Text>, int startOffset, int endOffset);
120     void prepareWhitespaceAtPositionForSplit(Position&);
121     bool canRebalance(const Position&) const;
122     bool shouldRebalanceLeadingWhitespaceFor(const String&) const;
123     void removeCSSProperty(PassRefPtr<StyledElement>, CSSPropertyID);
124     void removeNodeAttribute(PassRefPtr<Element>, const QualifiedName& attribute);
125     void removeChildrenInRange(PassRefPtr<Node>, unsigned from, unsigned to);
126     virtual void removeNode(PassRefPtr<Node>, ShouldAssumeContentIsAlwaysEditable = DoNotAssumeContentIsAlwaysEditable);
127     HTMLElement* replaceElementWithSpanPreservingChildrenAndAttributes(PassRefPtr<HTMLElement>);
128     void removeNodePreservingChildren(PassRefPtr<Node>, ShouldAssumeContentIsAlwaysEditable = DoNotAssumeContentIsAlwaysEditable);
129     void removeNodeAndPruneAncestors(PassRefPtr<Node>);
130     void moveRemainingSiblingsToNewParent(Node*, Node* pastLastNodeToMove, PassRefPtr<Element> prpNewParent);
131     void updatePositionForNodeRemovalPreservingChildren(Position&, Node*);
132     void prune(PassRefPtr<Node>);
133     void replaceTextInNode(PassRefPtr<Text>, unsigned offset, unsigned count, const String& replacementText);
134     Position replaceSelectedTextInNode(const String&);
135     void replaceTextInNodePreservingMarkers(PassRefPtr<Text>, unsigned offset, unsigned count, const String& replacementText);
136     Position positionOutsideTabSpan(const Position&);
137     void setNodeAttribute(PassRefPtr<Element>, const QualifiedName& attribute, const AtomicString& value);
138     void splitElement(PassRefPtr<Element>, PassRefPtr<Node> atChild);
139     void splitTextNode(PassRefPtr<Text>, unsigned offset);
140     void splitTextNodeContainingElement(PassRefPtr<Text>, unsigned offset);
141     void wrapContentsInDummySpan(PassRefPtr<Element>);
142
143     void deleteInsignificantText(PassRefPtr<Text>, unsigned start, unsigned end);
144     void deleteInsignificantText(const Position& start, const Position& end);
145     void deleteInsignificantTextDownstream(const Position&);
146
147     PassRefPtr<Node> appendBlockPlaceholder(PassRefPtr<Element>);
148     PassRefPtr<Node> insertBlockPlaceholder(const Position&);
149     PassRefPtr<Node> addBlockPlaceholderIfNeeded(Element*);
150     void removePlaceholderAt(const Position&);
151
152     PassRefPtr<Node> insertNewDefaultParagraphElementAt(const Position&);
153
154     PassRefPtr<Node> moveParagraphContentsToNewBlockIfNecessary(const Position&);
155     
156     void pushAnchorElementDown(Node*);
157     
158     void moveParagraph(const VisiblePosition&, const VisiblePosition&, const VisiblePosition&, bool preserveSelection = false, bool preserveStyle = true);
159     void moveParagraphs(const VisiblePosition&, const VisiblePosition&, const VisiblePosition&, bool preserveSelection = false, bool preserveStyle = true);
160     void moveParagraphWithClones(const VisiblePosition& startOfParagraphToMove, const VisiblePosition& endOfParagraphToMove, Element* blockElement, Node* outerNode);
161     void cloneParagraphUnderNewElement(Position& start, Position& end, Node* outerNode, Element* blockElement);
162     void cleanupAfterDeletion(VisiblePosition destination = VisiblePosition());
163     
164     bool breakOutOfEmptyListItem();
165     bool breakOutOfEmptyMailBlockquotedParagraph();
166     
167     Position positionAvoidingSpecialElementBoundary(const Position&);
168     
169     PassRefPtr<Node> splitTreeToNode(Node*, Node*, bool splitAncestor = false);
170
171     Vector<RefPtr<EditCommand> > m_commands;
172
173 private:
174     bool isCompositeEditCommand() const OVERRIDE { return true; }
175
176     RefPtr<EditCommandComposition> m_composition;
177 };
178     
179 void applyCommand(PassRefPtr<CompositeEditCommand>);
180
181 inline CompositeEditCommand* toCompositeEditCommand(EditCommand* command)
182 {
183     ASSERT(command);
184     ASSERT(command->isCompositeEditCommand());
185     return static_cast<CompositeEditCommand*>(command);
186 }
187
188 } // namespace WebCore
189
190 #endif // CompositeEditCommand_h