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