Implement UndoManager's item() method
[WebKit-https.git] / Source / WebCore / editing / UndoManager.h
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 #ifndef UndoManager_h
32 #define UndoManager_h
33
34 #if ENABLE(UNDO_MANAGER)
35
36 #include "ActiveDOMObject.h"
37 #include "DOMTransaction.h"
38 #include "Document.h"
39 #include "ExceptionCodePlaceholder.h"
40 #include "UndoStep.h"
41 #include <wtf/OwnPtr.h>
42 #include <wtf/PassOwnPtr.h>
43 #include <wtf/PassRefPtr.h>
44 #include <wtf/RefCounted.h>
45 #include <wtf/RefPtr.h>
46 #include <wtf/Vector.h>
47
48 namespace WebCore {
49
50 typedef Vector<RefPtr<UndoStep> > UndoManagerEntry;
51 typedef Vector<OwnPtr<UndoManagerEntry> > UndoManagerStack;
52
53 class UndoManager : public RefCounted<UndoManager>, public ActiveDOMObject {
54 public:
55     static PassRefPtr<UndoManager> create(Document*);
56     void disconnect();
57     virtual void stop() OVERRIDE;
58     virtual ~UndoManager();
59
60     void transact(PassRefPtr<DOMTransaction>, bool merge, ExceptionCode&);
61
62     void undo(ExceptionCode& = ASSERT_NO_EXCEPTION);
63     void redo(ExceptionCode& = ASSERT_NO_EXCEPTION);
64
65     UndoManagerEntry item(unsigned index) const;
66
67     unsigned length() const { return m_undoStack.size() + m_redoStack.size(); }
68     unsigned position() const { return m_redoStack.size(); }
69
70     void clearUndo(ExceptionCode&);
71     void clearRedo(ExceptionCode&);
72     
73     bool canUndo() const { return !m_undoStack.isEmpty(); }
74     bool canRedo() const { return !m_redoStack.isEmpty(); }
75     
76     void registerUndoStep(PassRefPtr<UndoStep>);
77     void registerRedoStep(PassRefPtr<UndoStep>);
78     
79     Document* document() const { return m_document; }
80     Node* ownerNode() const { return m_document; }
81
82     static void setRecordingDOMTransaction(DOMTransaction* transaction) { s_recordingDOMTransaction = transaction; }
83     static bool isRecordingAutomaticTransaction(Node*);
84     static void addTransactionStep(PassRefPtr<DOMTransactionStep>);
85
86 private:
87     explicit UndoManager(Document*);
88     
89     Document* m_document;
90     UndoManagerStack m_undoStack;
91     UndoManagerStack m_redoStack;
92     bool m_isInProgress;
93     OwnPtr<UndoManagerEntry> m_inProgressEntry;
94
95     static DOMTransaction* s_recordingDOMTransaction;
96 };
97     
98 }
99     
100 #endif
101
102 #endif