49106fd08bf0033665f053582012c92982e52046
[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 #include "UndoManager.h"
33
34 #if ENABLE(UNDO_MANAGER)
35
36 #include "DOMTransaction.h"
37 #include "Element.h"
38
39 namespace WebCore {
40
41 PassRefPtr<UndoManager> UndoManager::create(ScriptExecutionContext* context, Node* host)
42 {
43     RefPtr<UndoManager> undoManager = adoptRef(new UndoManager(context, host));
44     undoManager->suspendIfNeeded();
45     return undoManager.release();
46 }
47
48 UndoManager::UndoManager(ScriptExecutionContext* context, Node* host)
49     : ActiveDOMObject(context, this)
50     , m_undoScopeHost(host)
51     , m_isInProgress(false)
52 {
53 }
54
55 static void clearStack(UndoManagerStack& stack)
56 {
57     for (size_t i = 0; i < stack.size(); ++i) {
58         const UndoManagerEntry& entry = *stack[i];
59         for (size_t j = 0; j < entry.size(); ++j) {
60             UndoStep* step = entry[j].get();
61             if (step->isDOMTransaction())
62                 static_cast<DOMTransaction*>(step)->setUndoManager(0);
63         }
64     }
65     stack.clear();
66 }
67
68 void UndoManager::disconnect()
69 {
70     m_undoScopeHost = 0;
71     clearStack(m_undoStack);
72     clearStack(m_redoStack);
73 }
74
75 void UndoManager::stop()
76 {
77     disconnect();
78 }
79
80 UndoManager::~UndoManager()
81 {
82     disconnect();
83 }
84
85 static inline PassOwnPtr<UndoManagerEntry> createUndoManagerEntry()
86 {
87     return adoptPtr(new UndoManagerEntry);
88 }
89
90 void UndoManager::transact(PassRefPtr<DOMTransaction> transaction, bool merge, ExceptionCode& ec)
91 {
92     if (m_isInProgress || !isConnected()) {
93         ec = INVALID_ACCESS_ERR;
94         return;
95     }
96     clearRedo(ASSERT_NO_EXCEPTION);
97     transaction->setUndoManager(this);
98
99     m_isInProgress = true;
100     RefPtr<UndoManager> protect(this);
101     transaction->apply();
102     m_isInProgress = false;
103
104     if (!m_undoScopeHost)
105         return;
106     if (!merge || m_undoStack.isEmpty())
107         m_undoStack.append(createUndoManagerEntry());
108     m_undoStack.last()->append(transaction);
109 }
110
111 void UndoManager::undo(ExceptionCode& ec)
112 {
113     if (m_isInProgress || !isConnected()) {
114         ec = INVALID_ACCESS_ERR;
115         return;
116     }
117     if (m_undoStack.isEmpty())
118         return;
119     m_inProgressEntry = createUndoManagerEntry();
120
121     m_isInProgress = true;
122     RefPtr<UndoManager> protect(this);
123     UndoManagerEntry entry = *m_undoStack.last();
124     for (size_t i = entry.size(); i > 0; --i)
125         entry[i - 1]->unapply();
126     m_isInProgress = false;
127
128     if (!m_undoScopeHost) {
129         m_inProgressEntry.clear();
130         return;
131     }
132     m_redoStack.append(m_inProgressEntry.release());
133     m_undoStack.removeLast();
134 }
135
136 void UndoManager::redo(ExceptionCode& ec)
137 {
138     if (m_isInProgress || !isConnected()) {
139         ec = INVALID_ACCESS_ERR;
140         return;
141     }
142     if (m_redoStack.isEmpty())
143         return;
144     m_inProgressEntry = createUndoManagerEntry();
145
146     m_isInProgress = true;
147     RefPtr<UndoManager> protect(this);
148     UndoManagerEntry entry = *m_redoStack.last();
149     for (size_t i = entry.size(); i > 0; --i)
150         entry[i - 1]->reapply();
151     m_isInProgress = false;
152
153     if (!m_undoScopeHost) {
154         m_inProgressEntry.clear();
155         return;
156     }
157     m_undoStack.append(m_inProgressEntry.release());
158     m_redoStack.removeLast();
159 }
160
161 void UndoManager::registerUndoStep(PassRefPtr<UndoStep> step)
162 {
163     if (!m_isInProgress) {
164         OwnPtr<UndoManagerEntry> entry = createUndoManagerEntry();
165         entry->append(step);
166         m_undoStack.append(entry.release());
167
168         clearRedo(ASSERT_NO_EXCEPTION);
169     } else
170         m_inProgressEntry->append(step);
171 }
172
173 void UndoManager::registerRedoStep(PassRefPtr<UndoStep> step)
174 {
175     if (!m_isInProgress) {
176         OwnPtr<UndoManagerEntry> entry = createUndoManagerEntry();
177         entry->append(step);
178         m_redoStack.append(entry.release());
179     } else
180         m_inProgressEntry->append(step);
181 }
182
183 void UndoManager::clearUndo(ExceptionCode& ec)
184 {
185     if (m_isInProgress || !isConnected()) {
186         ec = INVALID_ACCESS_ERR;
187         return;
188     }
189     clearStack(m_undoStack);
190 }
191
192 void UndoManager::clearRedo(ExceptionCode& ec)
193 {
194     if (m_isInProgress || !isConnected()) {
195         ec = INVALID_ACCESS_ERR;
196         return;
197     }
198     clearStack(m_redoStack);
199 }
200
201 bool UndoManager::isConnected()
202 {
203     if (!m_undoScopeHost)
204         return false;
205     if (!m_undoScopeHost->isElementNode())
206         return true;
207     Element* element = toElement(m_undoScopeHost);
208     ASSERT(element->undoScope());
209     if (element->isContentEditable() && !element->isRootEditableElement()) {
210         element->disconnectUndoManager();
211         return false;
212     }
213     return true;
214 }
215
216 }
217
218 #endif