Reviewed by Kevin.
[WebKit-https.git] / WebCore / khtml / editing / edit_command.h
1 /*
2  * Copyright (C) 2005 Apple Computer, 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 __edit_command_h__
27 #define __edit_command_h__
28
29 #include "misc/shared.h"
30 #include "edit_actions.h"
31 #include "selection.h"
32
33 namespace DOM {
34     class CSSMutableStyleDeclarationImpl;
35     class DocumentImpl;
36 }
37
38 namespace khtml {
39
40 //------------------------------------------------------------------------------------------
41 // EditCommand
42
43 class EditCommand : public Shared<EditCommand>
44 {
45 public:
46     EditCommand(DOM::DocumentImpl *);
47     virtual ~EditCommand();
48
49     bool isCompositeStep() const { return m_parent != 0; }
50     EditCommand *parent() const { return m_parent; }
51     void setParent(EditCommand *parent) { m_parent = parent; }
52
53     enum ECommandState { NotApplied, Applied };
54     
55     void apply();       
56     void unapply();
57     void reapply();
58
59     virtual void doApply() = 0;
60     virtual void doUnapply() = 0;
61     virtual void doReapply();  // calls doApply()
62
63     virtual EditAction editingAction() const;
64
65     virtual DOM::DocumentImpl * const document() const { return m_document; }
66
67     Selection startingSelection() const { return m_startingSelection; }
68     Selection endingSelection() const { return m_endingSelection; }
69
70     void setEndingSelectionNeedsLayout(bool flag=true) { m_endingSelection.setNeedsLayout(flag); }
71         
72     ECommandState state() const { return m_state; }
73     void setState(ECommandState state) { m_state = state; }
74
75     void setStartingSelection(const Selection &s);
76     void setStartingSelection(const VisiblePosition &p);
77     void setStartingSelection(const DOM::Position &p, EAffinity affinity);
78     void setEndingSelection(const Selection &s);
79     void setEndingSelection(const VisiblePosition &p);
80     void setEndingSelection(const DOM::Position &p, EAffinity affinity);
81
82     DOM::CSSMutableStyleDeclarationImpl *typingStyle() const { return m_typingStyle; };
83     void setTypingStyle(DOM::CSSMutableStyleDeclarationImpl *);
84     
85     DOM::CSSMutableStyleDeclarationImpl *styleAtPosition(const DOM::Position &pos);
86     
87     virtual bool isInsertTextCommand() const;
88     virtual bool isTypingCommand() const;
89     
90 private:
91     void assignTypingStyle(DOM::CSSMutableStyleDeclarationImpl *);
92
93     virtual bool preservesTypingStyle() const;
94
95     DOM::DocumentImpl *m_document;
96     ECommandState m_state;
97     Selection m_startingSelection;
98     Selection m_endingSelection;
99     DOM::CSSMutableStyleDeclarationImpl *m_typingStyle;
100     EditCommand *m_parent;
101 };
102
103 class EditCommandPtr : public SharedPtr<EditCommand>
104 {
105 public:
106     EditCommandPtr();
107     EditCommandPtr(EditCommand *);
108     EditCommandPtr(const EditCommandPtr &);
109     ~EditCommandPtr();
110
111     EditCommandPtr &operator=(const EditCommandPtr &);
112
113     bool isCompositeStep() const;
114
115     void apply() const;
116     void unapply() const;
117     void reapply() const;
118
119     EditAction editingAction() const;
120
121     DOM::DocumentImpl * const document() const;
122
123     Selection startingSelection() const;
124     Selection endingSelection() const;
125
126     void setStartingSelection(const Selection &s) const;
127     void setStartingSelection(const VisiblePosition &p) const;
128     void setStartingSelection(const DOM::Position &p, EAffinity affinity) const;
129     void setEndingSelection(const Selection &s) const;
130     void setEndingSelection(const VisiblePosition &p) const;
131     void setEndingSelection(const DOM::Position &p, EAffinity affinity) const;
132
133     DOM::CSSMutableStyleDeclarationImpl *typingStyle() const;
134     void setTypingStyle(DOM::CSSMutableStyleDeclarationImpl *) const;
135
136     EditCommandPtr parent() const;
137     void setParent(const EditCommandPtr &) const;
138
139     bool isInsertTextCommand() const;
140     bool isInsertLineBreakCommand() const;
141     bool isTypingCommand() const;
142
143     static EditCommandPtr &emptyCommand();
144 };
145
146 } // namespace khtml
147
148 #endif // __edit_command_h__