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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/* -*- 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/. */
#include "PlaceholderTransaction.h"
#include <utility>
#include "CompositionTransaction.h"
#include "mozilla/EditorBase.h"
#include "mozilla/dom/Selection.h"
#include "nsGkAtoms.h"
#include "nsQueryObject.h"
namespace mozilla {
using namespace dom;
PlaceholderTransaction::PlaceholderTransaction(
EditorBase& aEditorBase, nsStaticAtom& aName,
Maybe<SelectionState>&& aSelState)
: mEditorBase(&aEditorBase),
mCompositionTransaction(nullptr),
mStartSel(*std::move(aSelState)),
mAbsorb(true),
mCommitted(false) {
mName = &aName;
}
NS_IMPL_CYCLE_COLLECTION_CLASS(PlaceholderTransaction)
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN_INHERITED(PlaceholderTransaction,
EditAggregateTransaction)
NS_IMPL_CYCLE_COLLECTION_UNLINK(mEditorBase);
NS_IMPL_CYCLE_COLLECTION_UNLINK(mStartSel);
NS_IMPL_CYCLE_COLLECTION_UNLINK(mEndSel);
NS_IMPL_CYCLE_COLLECTION_UNLINK_END
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(PlaceholderTransaction,
EditAggregateTransaction)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mEditorBase);
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mStartSel);
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mEndSel);
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(PlaceholderTransaction)
NS_INTERFACE_MAP_END_INHERITING(EditAggregateTransaction)
NS_IMPL_ADDREF_INHERITED(PlaceholderTransaction, EditAggregateTransaction)
NS_IMPL_RELEASE_INHERITED(PlaceholderTransaction, EditAggregateTransaction)
NS_IMETHODIMP PlaceholderTransaction::DoTransaction() { return NS_OK; }
NS_IMETHODIMP PlaceholderTransaction::UndoTransaction() {
if (NS_WARN_IF(!mEditorBase)) {
return NS_ERROR_NOT_INITIALIZED;
}
// Undo transactions.
nsresult rv = EditAggregateTransaction::UndoTransaction();
if (NS_FAILED(rv)) {
NS_WARNING("EditAggregateTransaction::UndoTransaction() failed");
return rv;
}
// now restore selection
RefPtr<Selection> selection = mEditorBase->GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
rv = mStartSel.RestoreSelection(*selection);
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv),
"SelectionState::RestoreSelection() failed");
return rv;
}
NS_IMETHODIMP PlaceholderTransaction::RedoTransaction() {
if (NS_WARN_IF(!mEditorBase)) {
return NS_ERROR_NOT_INITIALIZED;
}
// Redo transactions.
nsresult rv = EditAggregateTransaction::RedoTransaction();
if (NS_FAILED(rv)) {
NS_WARNING("EditAggregateTransaction::RedoTransaction() failed");
return rv;
}
// now restore selection
RefPtr<Selection> selection = mEditorBase->GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
rv = mEndSel.RestoreSelection(*selection);
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv),
"SelectionState::RestoreSelection() failed");
return rv;
}
NS_IMETHODIMP PlaceholderTransaction::Merge(nsITransaction* aOtherTransaction,
bool* aDidMerge) {
if (NS_WARN_IF(!aDidMerge) || NS_WARN_IF(!aOtherTransaction)) {
return NS_ERROR_INVALID_ARG;
}
// set out param default value
*aDidMerge = false;
if (mForwardingTransaction) {
MOZ_ASSERT_UNREACHABLE(
"tried to merge into a placeholder that was in "
"forwarding mode!");
return NS_ERROR_FAILURE;
}
RefPtr<EditTransactionBase> otherTransactionBase =
aOtherTransaction->GetAsEditTransactionBase();
if (!otherTransactionBase) {
return NS_OK;
}
// We are absorbing all transactions if mAbsorb is lit.
if (mAbsorb) {
if (CompositionTransaction* otherCompositionTransaction =
otherTransactionBase->GetAsCompositionTransaction()) {
// special handling for CompositionTransaction's: they need to merge with
// any previous CompositionTransaction in this placeholder, if possible.
if (!mCompositionTransaction) {
// this is the first IME txn in the placeholder
mCompositionTransaction = otherCompositionTransaction;
DebugOnly<nsresult> rvIgnored =
AppendChild(otherCompositionTransaction);
NS_WARNING_ASSERTION(
NS_SUCCEEDED(rvIgnored),
"EditAggregateTransaction::AppendChild() failed, but ignored");
} else {
bool didMerge;
mCompositionTransaction->Merge(otherCompositionTransaction, &didMerge);
if (!didMerge) {
// it wouldn't merge. Earlier IME txn is already committed and will
// not absorb further IME txns. So just stack this one after it
// and remember it as a candidate for further merges.
mCompositionTransaction = otherCompositionTransaction;
DebugOnly<nsresult> rvIgnored =
AppendChild(otherCompositionTransaction);
NS_WARNING_ASSERTION(
NS_SUCCEEDED(rvIgnored),
"EditAggregateTransaction::AppendChild() failed, but ignored");
}
}
} else {
PlaceholderTransaction* otherPlaceholderTransaction =
otherTransactionBase->GetAsPlaceholderTransaction();
if (!otherPlaceholderTransaction) {
// See bug 171243: just drop incoming placeholders on the floor.
// Their children will be swallowed by this preexisting one.
DebugOnly<nsresult> rvIgnored = AppendChild(otherTransactionBase);
NS_WARNING_ASSERTION(
NS_SUCCEEDED(rvIgnored),
"EditAggregateTransaction::AppendChild() failed, but ignored");
}
}
*aDidMerge = true;
// RememberEndingSelection();
// efficiency hack: no need to remember selection here, as we haven't yet
// finished the initial batch and we know we will be told when the batch
// ends. we can remeber the selection then.
return NS_OK;
}
// merge typing or IME or deletion transactions if the selection matches
if (mCommitted ||
(mName != nsGkAtoms::TypingTxnName && mName != nsGkAtoms::IMETxnName &&
mName != nsGkAtoms::DeleteTxnName)) {
return NS_OK;
}
PlaceholderTransaction* otherPlaceholderTransaction =
otherTransactionBase->GetAsPlaceholderTransaction();
if (!otherPlaceholderTransaction) {
return NS_OK;
}
RefPtr<nsAtom> otherTransactionName;
DebugOnly<nsresult> rvIgnored = otherPlaceholderTransaction->GetName(
getter_AddRefs(otherTransactionName));
NS_WARNING_ASSERTION(NS_SUCCEEDED(rvIgnored),
"PlaceholderTransaction::GetName() failed, but ignored");
if (!otherTransactionName || otherTransactionName == nsGkAtoms::_empty ||
otherTransactionName != mName) {
return NS_OK;
}
// check if start selection of next placeholder matches
// end selection of this placeholder
if (!otherPlaceholderTransaction->StartSelectionEquals(mEndSel)) {
return NS_OK;
}
mAbsorb = true; // we need to start absorbing again
otherPlaceholderTransaction->ForwardEndBatchTo(*this);
// AppendChild(editTransactionBase);
// see bug 171243: we don't need to merge placeholders
// into placeholders. We just reactivate merging in the
// pre-existing placeholder and drop the new one on the floor. The
// EndPlaceHolderBatch() call on the new placeholder will be
// forwarded to this older one.
rvIgnored = RememberEndingSelection();
NS_WARNING_ASSERTION(
NS_SUCCEEDED(rvIgnored),
"PlaceholderTransaction::RememberEndingSelection() failed, but "
"ignored");
*aDidMerge = true;
return NS_OK;
}
bool PlaceholderTransaction::StartSelectionEquals(
SelectionState& aSelectionState) {
// determine if starting selection matches the given selection state.
// note that we only care about collapsed selections.
return mStartSel.IsCollapsed() && aSelectionState.IsCollapsed() &&
mStartSel.Equals(aSelectionState);
}
nsresult PlaceholderTransaction::EndPlaceHolderBatch() {
mAbsorb = false;
if (mForwardingTransaction) {
if (mForwardingTransaction) {
DebugOnly<nsresult> rvIgnored =
mForwardingTransaction->EndPlaceHolderBatch();
NS_WARNING_ASSERTION(
NS_SUCCEEDED(rvIgnored),
"PlaceholderTransaction::EndPlaceHolderBatch() failed, but ignored");
}
}
// remember our selection state.
nsresult rv = RememberEndingSelection();
NS_WARNING_ASSERTION(
NS_SUCCEEDED(rv),
"PlaceholderTransaction::RememberEndingSelection() failed");
return rv;
}
nsresult PlaceholderTransaction::RememberEndingSelection() {
if (NS_WARN_IF(!mEditorBase)) {
return NS_ERROR_NOT_INITIALIZED;
}
RefPtr<Selection> selection = mEditorBase->GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
mEndSel.SaveSelection(*selection);
return NS_OK;
}
} // namespace mozilla
|
