Need a way to produce leaner markup when pasting a fragment containing verbose markup
[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 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 ReplaceSelectionCommand_h
27 #define ReplaceSelectionCommand_h
28
29 #include "CompositeEditCommand.h"
30
31 namespace WebCore {
32
33 class CSSMutableStyleDeclaration;
34 class DocumentFragment;
35 class EditingStyle;
36 class Node;
37 class ReplacementFragment;
38
39 class ReplaceSelectionCommand : public CompositeEditCommand {
40 public:
41     enum CommandOption {
42         SelectReplacement = 1 << 0,
43         SmartReplace = 1 << 1,
44         MatchStyle = 1 << 2,
45         PreventNesting = 1 << 3,
46         MovingParagraph = 1 << 4,
47         SanitizeFragment = 1 << 5
48     };
49
50     typedef unsigned CommandOptions;
51
52     static PassRefPtr<ReplaceSelectionCommand> create(Document* document, PassRefPtr<DocumentFragment> fragment, CommandOptions options, EditAction action = EditActionPaste)
53     {
54         return adoptRef(new ReplaceSelectionCommand(document, fragment, options, action));
55     }
56
57 private:
58     ReplaceSelectionCommand(Document*, PassRefPtr<DocumentFragment>, CommandOptions, EditAction);
59
60     virtual void doApply();
61     virtual EditAction editingAction() const;
62     
63     class InsertedNodes {
64     public:
65         void respondToNodeInsertion(Node*);
66         void willRemoveNodePreservingChildren(Node*);
67         void willRemoveNode(Node*);
68
69         Node* firstNodeInserted() const { return m_firstNodeInserted.get(); }
70         Node* lastLeafInserted() const { return m_lastNodeInserted->lastDescendant(); }
71         Node* pastLastLeaf() const { return m_firstNodeInserted ? lastLeafInserted()->traverseNextNode() : 0; }
72
73     private:
74         RefPtr<Node> m_firstNodeInserted;
75         RefPtr<Node> m_lastNodeInserted;
76     };
77
78     Node* insertAsListItems(PassRefPtr<Node>, 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 removeRedundantMarkup(InsertedNodes&);
93     void handleStyleSpans(InsertedNodes&);
94     void handlePasteAsQuotationNode();
95     
96     VisiblePosition positionAtStartOfInsertedContent() const;
97     VisiblePosition positionAtEndOfInsertedContent() const;
98
99     bool shouldPerformSmartReplace() const;
100     void addSpacesForSmartReplace();
101     void completeHTMLReplacement(const Position& lastPositionToSelect);
102
103     bool performTrivialReplace(const ReplacementFragment&);
104
105     Position m_startOfInsertedContent;
106     Position m_endOfInsertedContent;
107     RefPtr<EditingStyle> m_insertionStyle;
108     bool m_selectReplacement;
109     bool m_smartReplace;
110     bool m_matchStyle;
111     RefPtr<DocumentFragment> m_documentFragment;
112     bool m_preventNesting;
113     bool m_movingParagraph;
114     EditAction m_editAction;
115     bool m_sanitizeFragment;
116     bool m_shouldMergeEnd;
117 };
118
119 } // namespace WebCore
120
121 #endif // ReplaceSelectionCommand_h