1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_TransactionManager_h
#define mozilla_TransactionManager_h
#include "mozilla/TransactionStack.h"
#include "nsCOMArray.h"
#include "nsCOMPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsISupportsImpl.h"
#include "nsITransactionManager.h"
#include "nsWeakReference.h"
#include "nscore.h"
class nsITransaction;
class nsITransactionListener;
namespace mozilla {
class TransactionManager final : public nsITransactionManager,
public nsSupportsWeakReference {
public:
explicit TransactionManager(int32_t aMaxTransactionCount = -1);
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(TransactionManager,
nsITransactionManager)
NS_DECL_NSITRANSACTIONMANAGER
already_AddRefed<nsITransaction> PeekUndoStack();
already_AddRefed<nsITransaction> PeekRedoStack();
MOZ_CAN_RUN_SCRIPT nsresult Undo();
MOZ_CAN_RUN_SCRIPT nsresult Redo();
size_t NumberOfUndoItems() const { return mUndoStack.GetSize(); }
size_t NumberOfRedoItems() const { return mRedoStack.GetSize(); }
int32_t NumberOfMaximumTransactions() const { return mMaxTransactionCount; }
bool EnableUndoRedo(int32_t aMaxTransactionCount = -1);
bool DisableUndoRedo() { return EnableUndoRedo(0); }
bool ClearUndoRedo() {
if (NS_WARN_IF(!mDoStack.IsEmpty())) {
return false;
}
mUndoStack.Clear();
mRedoStack.Clear();
return true;
}
bool AddTransactionListener(nsITransactionListener& aListener) {
// XXX Shouldn't we check if aListener has already been in mListeners?
return mListeners.AppendObject(&aListener);
}
bool RemoveTransactionListener(nsITransactionListener& aListener) {
return mListeners.RemoveObject(&aListener);
}
// FYI: We don't need to treat the following methods as `MOZ_CAN_RUN_SCRIPT`
// for now because only ComposerCommandUpdater is the listener and it
// does not do something dangerous synchronously.
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult
WillDoNotify(nsITransaction* aTransaction, bool* aInterrupt);
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult DidDoNotify(nsITransaction* aTransaction,
nsresult aExecuteResult);
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult
WillUndoNotify(nsITransaction* aTransaction, bool* aInterrupt);
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult
DidUndoNotify(nsITransaction* aTransaction, nsresult aUndoResult);
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult
WillRedoNotify(nsITransaction* aTransaction, bool* aInterrupt);
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult
DidRedoNotify(nsITransaction* aTransaction, nsresult aRedoResult);
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult WillBeginBatchNotify(bool* aInterrupt);
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult DidBeginBatchNotify(nsresult aResult);
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult WillEndBatchNotify(bool* aInterrupt);
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult DidEndBatchNotify(nsresult aResult);
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult WillMergeNotify(
nsITransaction* aTop, nsITransaction* aTransaction, bool* aInterrupt);
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult
DidMergeNotify(nsITransaction* aTop, nsITransaction* aTransaction,
bool aDidMerge, nsresult aMergeResult);
/**
* Exposing non-virtual methods of nsITransactionManager methods.
*/
MOZ_CAN_RUN_SCRIPT nsresult BeginBatchInternal(nsISupports* aData);
nsresult EndBatchInternal(bool aAllowEmpty);
private:
virtual ~TransactionManager() = default;
MOZ_CAN_RUN_SCRIPT nsresult BeginTransaction(nsITransaction* aTransaction,
nsISupports* aData);
nsresult EndTransaction(bool aAllowEmpty);
int32_t mMaxTransactionCount;
TransactionStack mDoStack;
TransactionStack mUndoStack;
TransactionStack mRedoStack;
nsCOMArray<nsITransactionListener> mListeners;
};
} // namespace mozilla
mozilla::TransactionManager* nsITransactionManager::AsTransactionManager() {
return static_cast<mozilla::TransactionManager*>(this);
}
#endif // #ifndef mozilla_TransactionManager_h
|
