Implement UndoManager's item() method
[WebKit-https.git] / Source / WebCore / editing / UndoManager.cpp
1 /*
2  * Copyright (C) 2012 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32
33 #if ENABLE(UNDO_MANAGER)
34
35 #include "UndoManager.h"
36
37 #include "ExceptionCode.h"
38
39 namespace WebCore {
40
41 DOMTransaction* UndoManager::s_recordingDOMTransaction = 0;
42
43 PassRefPtr<UndoManager> UndoManager::create(Document* document)
44 {
45     RefPtr<UndoManager> undoManager = adoptRef(new UndoManager(document));
46     undoManager->suspendIfNeeded();
47     return undoManager.release();
48 }
49
50 UndoManager::UndoManager(Document* document)
51     : ActiveDOMObject(document, this)
52     , m_document(document)
53     , m_isInProgress(false)
54 {
55 }
56
57 static void clearStack(UndoManagerStack& stack)
58 {
59     for (size_t i = 0; i < stack.size(); ++i) {
60         const UndoManagerEntry& entry = *stack[i];
61         for (size_t j = 0; j < entry.size(); ++j) {
62             UndoStep* step = entry[j].get();
63             if (step->isDOMTransaction())
64                 static_cast<DOMTransaction*>(step)->setUndoManager(0);
65         }
66     }
67     stack.clear();
68 }
69
70 void UndoManager::disconnect()
71 {
72     m_document = 0;
73     clearStack(m_undoStack);
74     clearStack(m_redoStack);
75 }
76
77 void UndoManager::stop()
78 {
79     disconnect();
80 }
81
82 UndoManager::~UndoManager()
83 {
84     disconnect();
85 }
86
87 static inline PassOwnPtr<UndoManagerEntry> createUndoManagerEntry()
88 {
89     return adoptPtr(new UndoManagerEntry);
90 }
91
92 void UndoManager::transact(PassRefPtr<DOMTransaction> transaction, bool merge, ExceptionCode& ec)
93 {
94     if (m_isInProgress || !m_document) {
95         ec = INVALID_ACCESS_ERR;
96         return;
97     }
98     clearRedo(ASSERT_NO_EXCEPTION);
99     transaction->setUndoManager(this);
100
101     m_isInProgress = true;
102     RefPtr<UndoManager> protect(this);
103     transaction->apply();
104     m_isInProgress = false;
105
106     if (!m_document)
107         return;
108     if (!merge || m_undoStack.isEmpty())
109         m_undoStack.append(createUndoManagerEntry());
110     m_undoStack.last()->append(transaction);
111 }
112
113 void UndoManager::undo(ExceptionCode& ec)
114 {
115     if (m_isInProgress || !m_document) {
116         ec = INVALID_ACCESS_ERR;
117         return;
118     }
119     if (m_undoStack.isEmpty())
120         return;
121     m_inProgressEntry = createUndoManagerEntry();
122
123     m_isInProgress = true;
124     RefPtr<UndoManager> protect(this);
125     UndoManagerEntry entry = *m_undoStack.last();
126     for (size_t i = entry.size(); i > 0; --i)
127         entry[i - 1]->unapply();
128     m_isInProgress = false;
129
130     if (!m_document) {
131         m_inProgressEntry.clear();
132         return;
133     }
134     m_redoStack.append(m_inProgressEntry.release());
135     m_undoStack.removeLast();
136 }
137
138 void UndoManager::redo(ExceptionCode& ec)
139 {
140     if (m_isInProgress || !m_document) {
141         ec = INVALID_ACCESS_ERR;
142         return;
143     }
144     if (m_redoStack.isEmpty())
145         return;
146     m_inProgressEntry = createUndoManagerEntry();
147
148     m_isInProgress = true;
149     RefPtr<UndoManager> protect(this);
150     UndoManagerEntry entry = *m_redoStack.last();
151     for (size_t i = entry.size(); i > 0; --i)
152         entry[i - 1]->reapply();
153     m_isInProgress = false;
154
155     if (!m_document) {
156         m_inProgressEntry.clear();
157         return;
158     }
159     m_undoStack.append(m_inProgressEntry.release());
160     m_redoStack.removeLast();
161 }
162
163 UndoManagerEntry UndoManager::item(unsigned index) const
164 {
165     ASSERT(index < length());
166     if (index < m_redoStack.size()) {
167         UndoManagerEntry entry = *m_redoStack[index];
168         entry.reverse();
169         return entry;
170     }
171     return *m_undoStack[length() - index - 1];
172 }
173
174 void UndoManager::registerUndoStep(PassRefPtr<UndoStep> step)
175 {
176     if (!m_isInProgress) {
177         OwnPtr<UndoManagerEntry> entry = createUndoManagerEntry();
178         entry->append(step);
179         m_undoStack.append(entry.release());
180
181         clearRedo(ASSERT_NO_EXCEPTION);
182     } else
183         m_inProgressEntry->append(step);
184 }
185
186 void UndoManager::registerRedoStep(PassRefPtr<UndoStep> step)
187 {
188     if (!m_isInProgress) {
189         OwnPtr<UndoManagerEntry> entry = createUndoManagerEntry();
190         entry->append(step);
191         m_redoStack.append(entry.release());
192     } else
193         m_inProgressEntry->append(step);
194 }
195
196 void UndoManager::clearUndo(ExceptionCode& ec)
197 {
198     if (m_isInProgress || !m_document) {
199         ec = INVALID_ACCESS_ERR;
200         return;
201     }
202     clearStack(m_undoStack);
203 }
204
205 void UndoManager::clearRedo(ExceptionCode& ec)
206 {
207     if (m_isInProgress || !m_document) {
208         ec = INVALID_ACCESS_ERR;
209         return;
210     }
211     clearStack(m_redoStack);
212 }
213
214 bool UndoManager::isRecordingAutomaticTransaction(Node* node)
215 {
216     // We need to check that transaction still has its undomanager because
217     // transaction can disconnect its undomanager, which will clear the undo/redo stacks.
218     if (!s_recordingDOMTransaction || !s_recordingDOMTransaction->undoManager())
219         return false;
220     Document* document = s_recordingDOMTransaction->undoManager()->document();
221     return document && node->document() == document;
222 }
223
224 void UndoManager::addTransactionStep(PassRefPtr<DOMTransactionStep> step)
225 {
226     ASSERT(s_recordingDOMTransaction);
227     s_recordingDOMTransaction->addTransactionStep(step);
228 }
229
230 }
231
232 #endif