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 DeleteSelectionCommand_h
27#define DeleteSelectionCommand_h
28
29#include "CompositeEditCommand.h"
30
31namespace WebCore {
32
33class EditingStyle;
34
35class DeleteSelectionCommand : public CompositeEditCommand {
36public:
37    static PassRefPtr<DeleteSelectionCommand> create(Document& document, bool smartDelete = false, bool mergeBlocksAfterDelete = true, bool replace = false, bool expandForSpecialElements = false, bool sanitizeMarkup = true)
38    {
39        return adoptRef(new DeleteSelectionCommand(document, smartDelete, mergeBlocksAfterDelete, replace, expandForSpecialElements, sanitizeMarkup));
40    }
41    static PassRefPtr<DeleteSelectionCommand> create(const VisibleSelection& selection, bool smartDelete = false, bool mergeBlocksAfterDelete = true, bool replace = false, bool expandForSpecialElements = false, bool sanitizeMarkup = true)
42    {
43        return adoptRef(new DeleteSelectionCommand(selection, smartDelete, mergeBlocksAfterDelete, replace, expandForSpecialElements, sanitizeMarkup));
44    }
45
46protected:
47    DeleteSelectionCommand(Document&, bool smartDelete, bool mergeBlocksAfterDelete, bool replace, bool expandForSpecialElements, bool santizeMarkup);
48
49private:
50    DeleteSelectionCommand(const VisibleSelection&, bool smartDelete, bool mergeBlocksAfterDelete, bool replace, bool expandForSpecialElements, bool sanitizeMarkup);
51
52    virtual void doApply();
53    virtual EditAction editingAction() const;
54
55    virtual bool preservesTypingStyle() const;
56
57    void initializeStartEnd(Position&, Position&);
58    void setStartingSelectionOnSmartDelete(const Position&, const Position&);
59    void initializePositionData();
60    void saveTypingStyleState();
61    void insertPlaceholderForAncestorBlockContent();
62    bool handleSpecialCaseBRDelete();
63    void handleGeneralDelete();
64    void fixupWhitespace();
65    void mergeParagraphs();
66    void removePreviouslySelectedEmptyTableRows();
67    void calculateEndingPosition();
68    void calculateTypingStyleAfterDelete();
69    void clearTransientState();
70    void makeStylingElementsDirectChildrenOfEditableRootToPreventStyleLoss();
71    virtual void removeNode(PassRefPtr<Node>, ShouldAssumeContentIsAlwaysEditable = DoNotAssumeContentIsAlwaysEditable);
72    virtual void deleteTextFromNode(PassRefPtr<Text>, unsigned, unsigned);
73    void removeRedundantBlocks();
74
75    // This function provides access to original string after the correction has been deleted.
76    String originalStringForAutocorrectionAtBeginningOfSelection();
77
78    bool m_hasSelectionToDelete;
79    bool m_smartDelete;
80    bool m_mergeBlocksAfterDelete;
81    bool m_needPlaceholder;
82    bool m_replace;
83    bool m_expandForSpecialElements;
84    bool m_pruneStartBlockIfNecessary;
85    bool m_startsAtEmptyLine;
86    bool m_sanitizeMarkup;
87
88    // This data is transient and should be cleared at the end of the doApply function.
89    VisibleSelection m_selectionToDelete;
90    Position m_upstreamStart;
91    Position m_downstreamStart;
92    Position m_upstreamEnd;
93    Position m_downstreamEnd;
94    Position m_endingPosition;
95    Position m_leadingWhitespace;
96    Position m_trailingWhitespace;
97    RefPtr<Node> m_startBlock;
98    RefPtr<Node> m_endBlock;
99    RefPtr<EditingStyle> m_typingStyle;
100    RefPtr<EditingStyle> m_deleteIntoBlockquoteStyle;
101    RefPtr<Node> m_startRoot;
102    RefPtr<Node> m_endRoot;
103    RefPtr<Node> m_startTableRow;
104    RefPtr<Node> m_endTableRow;
105    RefPtr<Node> m_temporaryPlaceholder;
106};
107
108} // namespace WebCore
109
110#endif // DeleteSelectionCommand_h
111