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