1a997c921fbc08770ee18d7ed6f700852fd0d834
[WebKit-https.git] / Source / WebCore / editing / EditCommand.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 EditCommand_h
27 #define EditCommand_h
28
29 #include "AXTextStateChangeIntent.h"
30 #include "EditAction.h"
31 #include "VisibleSelection.h"
32
33 #ifndef NDEBUG
34 #include <wtf/HashSet.h>
35 #endif
36
37 namespace WebCore {
38
39 class CompositeEditCommand;
40 class Document;
41 class Element;
42 class Frame;
43
44 class EditCommand : public RefCounted<EditCommand> {
45 public:
46     virtual ~EditCommand();
47
48     void setParent(CompositeEditCommand*);
49
50     EditAction editingAction() const;
51
52     const VisibleSelection& startingSelection() const { return m_startingSelection; }
53     const VisibleSelection& endingSelection() const { return m_endingSelection; }
54
55     virtual bool isInsertTextCommand() const { return false; }    
56     virtual bool isSimpleEditCommand() const { return false; }
57     virtual bool isCompositeEditCommand() const { return false; }
58     virtual bool isEditCommandComposition() const { return false; }
59     bool isTopLevelCommand() const { return !m_parent; }
60
61     virtual void doApply() = 0;
62
63     AXTextEditType applyEditType() const;
64     AXTextEditType unapplyEditType() const;
65
66 protected:
67     explicit EditCommand(Document&, EditAction = EditActionUnspecified);
68     EditCommand(Document&, const VisibleSelection&, const VisibleSelection&);
69
70     Frame& frame();
71     Document& document() { return m_document; }
72     CompositeEditCommand* parent() const { return m_parent; }
73     void setStartingSelection(const VisibleSelection&);
74     WEBCORE_EXPORT void setEndingSelection(const VisibleSelection&);
75
76 private:
77     Ref<Document> m_document;
78     VisibleSelection m_startingSelection;
79     VisibleSelection m_endingSelection;
80     CompositeEditCommand* m_parent;
81     EditAction m_editingAction { EditActionUnspecified };
82 };
83
84 enum ShouldAssumeContentIsAlwaysEditable {
85     AssumeContentIsAlwaysEditable,
86     DoNotAssumeContentIsAlwaysEditable,
87 };
88
89 class SimpleEditCommand : public EditCommand {
90 public:
91     virtual void doUnapply() = 0;
92     virtual void doReapply(); // calls doApply()
93
94 #ifndef NDEBUG
95     virtual void getNodesInCommand(HashSet<Node*>&) = 0;
96 #endif
97
98 protected:
99     explicit SimpleEditCommand(Document&, EditAction = EditActionUnspecified);
100
101 #ifndef NDEBUG
102     void addNodeAndDescendants(Node*, HashSet<Node*>&);
103 #endif
104
105     virtual void notifyAccessibilityForTextChange(Node*, AXTextEditType, const String&, const VisiblePosition&);
106
107 private:
108     virtual bool isSimpleEditCommand() const override { return true; }
109 };
110
111 inline SimpleEditCommand* toSimpleEditCommand(EditCommand* command)
112 {
113     ASSERT(command);
114     ASSERT_WITH_SECURITY_IMPLICATION(command->isSimpleEditCommand());
115     return static_cast<SimpleEditCommand*>(command);
116 }
117
118 } // namespace WebCore
119
120 #endif // EditCommand_h