Remove "virtual" from all lines that have both "virtual" and "override".
[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 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 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 Ref<EditCommandComposition> create(Document&, const VisibleSelection&, const VisibleSelection&, EditAction);
44
45     void unapply() override;
46     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     AXTextEditType unapplyEditType() const;
63
64 private:
65     EditCommandComposition(Document&, const VisibleSelection& startingSelection, const VisibleSelection& endingSelection, EditAction);
66
67     RefPtr<Document> m_document;
68     VisibleSelection m_startingSelection;
69     VisibleSelection m_endingSelection;
70     Vector<RefPtr<SimpleEditCommand>> m_commands;
71     RefPtr<Element> m_startingRootEditableElement;
72     RefPtr<Element> m_endingRootEditableElement;
73     EditAction m_editAction;
74 };
75
76 class CompositeEditCommand : public EditCommand {
77 public:
78     virtual ~CompositeEditCommand();
79
80     void apply();
81     bool isFirstCommand(EditCommand* command) { return !m_commands.isEmpty() && m_commands.first() == command; }
82     EditCommandComposition* composition() { return m_composition.get(); }
83     EditCommandComposition* ensureComposition();
84
85     virtual bool isCreateLinkCommand() const;
86     virtual bool isTypingCommand() const;
87     virtual bool isDictationCommand() const { return false; }
88     virtual bool preservesTypingStyle() const;
89     virtual bool shouldRetainAutocorrectionIndicator() const;
90     virtual void setShouldRetainAutocorrectionIndicator(bool);
91     virtual bool shouldStopCaretBlinking() const { return false; }
92
93 protected:
94     explicit CompositeEditCommand(Document&, EditAction = EditActionUnspecified);
95
96     //
97     // sugary-sweet convenience functions to help create and apply edit commands in composite commands
98     //
99     void appendNode(PassRefPtr<Node>, PassRefPtr<ContainerNode> parent);
100     void applyCommandToComposite(PassRefPtr<EditCommand>);
101     void applyCommandToComposite(PassRefPtr<CompositeEditCommand>, const VisibleSelection&);
102     void applyStyle(const EditingStyle*, EditAction = EditActionChangeAttributes);
103     void applyStyle(const EditingStyle*, const Position& start, const Position& end, EditAction = EditActionChangeAttributes);
104     void applyStyledElement(PassRefPtr<Element>);
105     void removeStyledElement(PassRefPtr<Element>);
106     void deleteSelection(bool smartDelete = false, bool mergeBlocksAfterDelete = true, bool replace = false, bool expandForSpecialElements = true, bool sanitizeMarkup = true);
107     void deleteSelection(const VisibleSelection&, bool smartDelete = false, bool mergeBlocksAfterDelete = true, bool replace = false, bool expandForSpecialElements = true, bool sanitizeMarkup = true);
108     virtual void deleteTextFromNode(PassRefPtr<Text>, unsigned offset, unsigned count);
109     void inputText(const String&, bool selectInsertedText = false);
110     bool isRemovableBlock(const Node*);
111     void insertNodeAfter(PassRefPtr<Node>, PassRefPtr<Node> refChild);
112     void insertNodeAt(PassRefPtr<Node>, const Position&);
113     void insertNodeAtTabSpanPosition(PassRefPtr<Node>, const Position&);
114     void insertNodeBefore(PassRefPtr<Node>, PassRefPtr<Node> refChild, ShouldAssumeContentIsAlwaysEditable = DoNotAssumeContentIsAlwaysEditable);
115     void insertParagraphSeparator(bool useDefaultParagraphElement = false, bool pasteBlockqutoeIntoUnquotedArea = false);
116     void insertLineBreak();
117     void insertTextIntoNode(PassRefPtr<Text>, unsigned offset, const String& text);
118     void mergeIdenticalElements(PassRefPtr<Element>, PassRefPtr<Element>);
119     void rebalanceWhitespace();
120     void rebalanceWhitespaceAt(const Position&);
121     void rebalanceWhitespaceOnTextSubstring(PassRefPtr<Text>, int startOffset, int endOffset);
122     void prepareWhitespaceAtPositionForSplit(Position&);
123     bool canRebalance(const Position&) const;
124     bool shouldRebalanceLeadingWhitespaceFor(const String&) const;
125     void removeCSSProperty(PassRefPtr<StyledElement>, CSSPropertyID);
126     void removeNodeAttribute(PassRefPtr<Element>, const QualifiedName& attribute);
127     void removeChildrenInRange(PassRefPtr<Node>, unsigned from, unsigned to);
128     virtual void removeNode(PassRefPtr<Node>, ShouldAssumeContentIsAlwaysEditable = DoNotAssumeContentIsAlwaysEditable);
129     HTMLElement* replaceElementWithSpanPreservingChildrenAndAttributes(PassRefPtr<HTMLElement>);
130     void removeNodePreservingChildren(PassRefPtr<Node>, ShouldAssumeContentIsAlwaysEditable = DoNotAssumeContentIsAlwaysEditable);
131     void removeNodeAndPruneAncestors(PassRefPtr<Node>);
132     void moveRemainingSiblingsToNewParent(Node*, Node* pastLastNodeToMove, PassRefPtr<Element> prpNewParent);
133     void updatePositionForNodeRemovalPreservingChildren(Position&, Node&);
134     void prune(PassRefPtr<Node>);
135     void replaceTextInNode(PassRefPtr<Text>, unsigned offset, unsigned count, const String& replacementText);
136     Position replaceSelectedTextInNode(const String&);
137     void replaceTextInNodePreservingMarkers(PassRefPtr<Text>, unsigned offset, unsigned count, const String& replacementText);
138     Position positionOutsideTabSpan(const Position&);
139     void setNodeAttribute(PassRefPtr<Element>, const QualifiedName& attribute, const AtomicString& value);
140     void splitElement(PassRefPtr<Element>, PassRefPtr<Node> atChild);
141     void splitTextNode(PassRefPtr<Text>, unsigned offset);
142     void splitTextNodeContainingElement(PassRefPtr<Text>, unsigned offset);
143     void wrapContentsInDummySpan(PassRefPtr<Element>);
144
145     void deleteInsignificantText(PassRefPtr<Text>, unsigned start, unsigned end);
146     void deleteInsignificantText(const Position& start, const Position& end);
147     void deleteInsignificantTextDownstream(const Position&);
148
149     PassRefPtr<Node> appendBlockPlaceholder(PassRefPtr<Element>);
150     PassRefPtr<Node> insertBlockPlaceholder(const Position&);
151     PassRefPtr<Node> addBlockPlaceholderIfNeeded(Element*);
152     void removePlaceholderAt(const Position&);
153
154     PassRefPtr<Node> insertNewDefaultParagraphElementAt(const Position&);
155
156     PassRefPtr<Node> moveParagraphContentsToNewBlockIfNecessary(const Position&);
157     
158     void pushAnchorElementDown(Element&);
159     
160     void moveParagraph(const VisiblePosition&, const VisiblePosition&, const VisiblePosition&, bool preserveSelection = false, bool preserveStyle = true);
161     void moveParagraphs(const VisiblePosition&, const VisiblePosition&, const VisiblePosition&, bool preserveSelection = false, bool preserveStyle = true);
162     void moveParagraphWithClones(const VisiblePosition& startOfParagraphToMove, const VisiblePosition& endOfParagraphToMove, Element* blockElement, Node* outerNode);
163     void cloneParagraphUnderNewElement(const Position& start, const Position& end, Node* outerNode, Element* blockElement);
164     void cleanupAfterDeletion(VisiblePosition destination = VisiblePosition());
165     
166     bool breakOutOfEmptyListItem();
167     bool breakOutOfEmptyMailBlockquotedParagraph();
168     
169     Position positionAvoidingSpecialElementBoundary(const Position&);
170     
171     PassRefPtr<Node> splitTreeToNode(Node*, Node*, bool splitAncestor = false);
172
173     Vector<RefPtr<EditCommand>> m_commands;
174
175 private:
176     bool isCompositeEditCommand() const override { return true; }
177
178     RefPtr<EditCommandComposition> m_composition;
179 };
180     
181 void applyCommand(PassRefPtr<CompositeEditCommand>);
182
183 inline CompositeEditCommand* toCompositeEditCommand(EditCommand* command)
184 {
185     ASSERT(command);
186     ASSERT_WITH_SECURITY_IMPLICATION(command->isCompositeEditCommand());
187     return static_cast<CompositeEditCommand*>(command);
188 }
189
190 } // namespace WebCore
191
192 #endif // CompositeEditCommand_h