755991b9ecebf612174a01b34fc4a6eb8cb5bbef
[WebKit-https.git] / Source / WebCore / editing / ReplaceSelectionCommand.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 ReplaceSelectionCommand_h
27 #define ReplaceSelectionCommand_h
28
29 #include "CompositeEditCommand.h"
30 #include "NodeTraversal.h"
31
32 namespace WebCore {
33
34 class DocumentFragment;
35 class ReplacementFragment;
36
37 class ReplaceSelectionCommand : public CompositeEditCommand {
38 public:
39     enum CommandOption {
40         SelectReplacement = 1 << 0,
41         SmartReplace = 1 << 1,
42         MatchStyle = 1 << 2,
43         PreventNesting = 1 << 3,
44         MovingParagraph = 1 << 4,
45         SanitizeFragment = 1 << 5,
46         IgnoreMailBlockquote = 1 << 6,
47     };
48
49     typedef unsigned CommandOptions;
50
51     static PassRefPtr<ReplaceSelectionCommand> create(Document& document, PassRefPtr<DocumentFragment> fragment, CommandOptions options, EditAction action = EditActionPaste)
52     {
53         return adoptRef(new ReplaceSelectionCommand(document, fragment, options, action));
54     }
55
56 private:
57     ReplaceSelectionCommand(Document&, PassRefPtr<DocumentFragment>, CommandOptions, EditAction);
58
59     virtual void doApply();
60     virtual EditAction editingAction() const;
61     
62     class InsertedNodes {
63     public:
64         void respondToNodeInsertion(Node*);
65         void willRemoveNodePreservingChildren(Node*);
66         void willRemoveNode(Node*);
67         void didReplaceNode(Node*, Node* newNode);
68
69         Node* firstNodeInserted() const { return m_firstNodeInserted.get(); }
70         Node* lastLeafInserted() const { return m_lastNodeInserted->lastDescendant(); }
71         Node* pastLastLeaf() const { return m_lastNodeInserted ? NodeTraversal::next(lastLeafInserted()) : 0; }
72
73     private:
74         RefPtr<Node> m_firstNodeInserted;
75         RefPtr<Node> m_lastNodeInserted;
76     };
77
78     Node* insertAsListItems(PassRefPtr<HTMLElement> listElement, Node* insertionNode, const Position&, InsertedNodes&);
79
80     void updateNodesInserted(Node*);
81     bool shouldRemoveEndBR(Node*, const VisiblePosition&);
82     
83     bool shouldMergeStart(bool, bool, bool);
84     bool shouldMergeEnd(bool selectionEndWasEndOfParagraph);
85     bool shouldMerge(const VisiblePosition&, const VisiblePosition&);
86     
87     void mergeEndIfNeeded();
88     
89     void removeUnrenderedTextNodesAtEnds(InsertedNodes&);
90     
91     void removeRedundantStylesAndKeepStyleSpanInline(InsertedNodes&);
92     void makeInsertedContentRoundTrippableWithHTMLTreeBuilder(const InsertedNodes&);
93     void moveNodeOutOfAncestor(PassRefPtr<Node>, PassRefPtr<Node> ancestor);
94     void handleStyleSpans(InsertedNodes&);
95     void handlePasteAsQuotationNode();
96     
97     VisiblePosition positionAtStartOfInsertedContent() const;
98     VisiblePosition positionAtEndOfInsertedContent() const;
99
100     bool shouldPerformSmartReplace() const;
101     void addSpacesForSmartReplace();
102     void completeHTMLReplacement(const Position& lastPositionToSelect);
103     void mergeTextNodesAroundPosition(Position&, Position& positionOnlyToBeUpdated);
104
105     bool performTrivialReplace(const ReplacementFragment&);
106
107     Position m_startOfInsertedContent;
108     Position m_endOfInsertedContent;
109     RefPtr<EditingStyle> m_insertionStyle;
110     bool m_selectReplacement;
111     bool m_smartReplace;
112     bool m_matchStyle;
113     RefPtr<DocumentFragment> m_documentFragment;
114     bool m_preventNesting;
115     bool m_movingParagraph;
116     EditAction m_editAction;
117     bool m_sanitizeFragment;
118     bool m_shouldMergeEnd;
119     bool m_ignoreMailBlockquote;
120 };
121
122 } // namespace WebCore
123
124 #endif // ReplaceSelectionCommand_h