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
|
/* -*- 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 "InsertTextTransaction.h"
#include "ErrorList.h"
#include "mozilla/EditorBase.h" // mEditorBase
#include "mozilla/Logging.h"
#include "mozilla/SelectionState.h" // RangeUpdater
#include "mozilla/TextEditor.h" // TextEditor
#include "mozilla/ToString.h"
#include "mozilla/dom/Selection.h" // Selection local var
#include "mozilla/dom/Text.h" // mTextNode
#include "nsAString.h" // nsAString parameter
#include "nsDebug.h" // for NS_ASSERTION, etc.
#include "nsError.h" // for NS_OK, etc.
#include "nsQueryObject.h" // for do_QueryObject
namespace mozilla {
using namespace dom;
// static
already_AddRefed<InsertTextTransaction> InsertTextTransaction::Create(
EditorBase& aEditorBase, const nsAString& aStringToInsert,
const EditorDOMPointInText& aPointToInsert) {
MOZ_ASSERT(aPointToInsert.IsSetAndValid());
RefPtr<InsertTextTransaction> transaction =
aEditorBase.IsTextEditor()
? new InsertTextTransaction(aEditorBase, aStringToInsert,
aPointToInsert)
: new InsertTextIntoTextNodeTransaction(aEditorBase, aStringToInsert,
aPointToInsert);
return transaction.forget();
}
InsertTextTransaction::InsertTextTransaction(
EditorBase& aEditorBase, const nsAString& aStringToInsert,
const EditorDOMPointInText& aPointToInsert)
: mEditorBase(&aEditorBase),
mStringToInsert(aStringToInsert),
mOffset(aPointToInsert.Offset()) {}
std::ostream& operator<<(std::ostream& aStream,
const InsertTextTransaction& aTransaction) {
const auto* transactionForHTMLEditor =
aTransaction.GetAsInsertTextIntoTextNodeTransaction();
if (transactionForHTMLEditor) {
return aStream << *transactionForHTMLEditor;
}
aStream << "{ mOffset=" << aTransaction.mOffset << ", mStringToInsert=\""
<< NS_ConvertUTF16toUTF8(aTransaction.mStringToInsert).get() << "\""
<< ", mEditorBase=" << aTransaction.mEditorBase.get() << " }";
return aStream;
}
NS_IMPL_CYCLE_COLLECTION_INHERITED(InsertTextTransaction, EditTransactionBase,
mEditorBase)
NS_IMPL_ADDREF_INHERITED(InsertTextTransaction, EditTransactionBase)
NS_IMPL_RELEASE_INHERITED(InsertTextTransaction, EditTransactionBase)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(InsertTextTransaction)
NS_INTERFACE_MAP_END_INHERITING(EditTransactionBase)
Text* InsertTextTransaction::GetTextNode() const {
if (MOZ_UNLIKELY(!mEditorBase)) {
return nullptr;
}
if (TextEditor* const textEditor = mEditorBase->GetAsTextEditor()) {
return textEditor->GetTextNode();
}
MOZ_ASSERT(GetAsInsertTextIntoTextNodeTransaction());
return GetAsInsertTextIntoTextNodeTransaction()->mTextNode;
}
NS_IMETHODIMP InsertTextTransaction::DoTransaction() {
MOZ_LOG(GetLogModule(), LogLevel::Info,
("%p InsertTextTransaction::%s this=%s", this, __FUNCTION__,
ToString(*this).c_str()));
if (NS_WARN_IF(!mEditorBase)) {
return NS_ERROR_NOT_AVAILABLE;
}
const RefPtr<Text> textNode = GetTextNode();
if (NS_WARN_IF(!textNode)) {
return NS_ERROR_NOT_AVAILABLE;
}
const OwningNonNull<EditorBase> editorBase = *mEditorBase;
ErrorResult error;
editorBase->DoInsertText(*textNode, mOffset, mStringToInsert, error);
if (error.Failed()) {
NS_WARNING("EditorBase::DoInsertText() failed");
return error.StealNSResult();
}
editorBase->RangeUpdaterRef().SelAdjInsertText(*textNode, mOffset,
mStringToInsert.Length());
return NS_OK;
}
NS_IMETHODIMP InsertTextTransaction::UndoTransaction() {
MOZ_LOG(GetLogModule(), LogLevel::Info,
("%p InsertTextTransaction::%s this=%s", this, __FUNCTION__,
ToString(*this).c_str()));
if (NS_WARN_IF(!mEditorBase)) {
return NS_ERROR_NOT_INITIALIZED;
}
const RefPtr<Text> textNode = GetTextNode();
if (NS_WARN_IF(!textNode)) {
return NS_ERROR_NOT_AVAILABLE;
}
const OwningNonNull<EditorBase> editorBase = *mEditorBase;
ErrorResult error;
editorBase->DoDeleteText(*textNode, mOffset, mStringToInsert.Length(), error);
NS_WARNING_ASSERTION(!error.Failed(), "EditorBase::DoDeleteText() failed");
return error.StealNSResult();
}
NS_IMETHODIMP InsertTextTransaction::RedoTransaction() {
MOZ_LOG(GetLogModule(), LogLevel::Info,
("%p InsertTextTransaction::%s this=%s", this, __FUNCTION__,
!mEditorBase || mEditorBase->IsTextEditor()
? ToString(*this).c_str()
: ToString(*GetAsInsertTextIntoTextNodeTransaction()).c_str()));
nsresult rv = DoTransaction();
if (NS_FAILED(rv)) {
NS_WARNING("InsertTextTransaction::DoTransaction() failed");
return rv;
}
if (RefPtr<EditorBase> editorBase = mEditorBase) {
nsresult rv = editorBase->CollapseSelectionTo(
SuggestPointToPutCaret<EditorRawDOMPoint>());
if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) {
return NS_ERROR_EDITOR_DESTROYED;
}
NS_WARNING_ASSERTION(
NS_SUCCEEDED(rv),
"EditorBase::CollapseSelectionTo() failed, but ignored");
}
return NS_OK;
}
NS_IMETHODIMP InsertTextTransaction::Merge(nsITransaction* aOtherTransaction,
bool* aDidMerge) {
MOZ_LOG(GetLogModule(), LogLevel::Debug,
("%p InsertTextTransaction::%s(aOtherTransaction=%p) this=%s", this,
__FUNCTION__, aOtherTransaction, ToString(*this).c_str()));
if (NS_WARN_IF(!aOtherTransaction) || NS_WARN_IF(!aDidMerge)) {
return NS_ERROR_INVALID_ARG;
}
// Set out param default value
*aDidMerge = false;
RefPtr<EditTransactionBase> otherTransactionBase =
aOtherTransaction->GetAsEditTransactionBase();
if (!otherTransactionBase) {
MOZ_LOG(
GetLogModule(), LogLevel::Debug,
("%p InsertTextTransaction::%s(aOtherTransaction=%p) returned false",
this, __FUNCTION__, aOtherTransaction));
return NS_OK;
}
// If aTransaction is a InsertTextTransaction, and if the selection hasn't
// changed, then absorb it.
InsertTextTransaction* otherInsertTextTransaction =
otherTransactionBase->GetAsInsertTextTransaction();
if (!otherInsertTextTransaction ||
!IsSequentialInsert(*otherInsertTextTransaction)) {
MOZ_LOG(
GetLogModule(), LogLevel::Debug,
("%p InsertTextTransaction::%s(aOtherTransaction=%p) returned false",
this, __FUNCTION__, aOtherTransaction));
return NS_OK;
}
mStringToInsert += otherInsertTextTransaction->GetData();
*aDidMerge = true;
MOZ_LOG(GetLogModule(), LogLevel::Debug,
("%p InsertTextTransaction::%s(aOtherTransaction=%p) returned true",
this, __FUNCTION__, aOtherTransaction));
return NS_OK;
}
bool InsertTextTransaction::IsSequentialInsert(
InsertTextTransaction& aOtherTransaction) const {
return aOtherTransaction.GetTextNode() == GetTextNode() &&
aOtherTransaction.mOffset == mOffset + mStringToInsert.Length();
}
/******************************************************************************
* mozilla::InsertTextIntoTextNodeTransaction
******************************************************************************/
InsertTextIntoTextNodeTransaction::InsertTextIntoTextNodeTransaction(
EditorBase& aEditorBase, const nsAString& aStringToInsert,
const EditorDOMPointInText& aPointToInsert)
: InsertTextTransaction(aEditorBase, aStringToInsert, aPointToInsert),
mTextNode(aPointToInsert.ContainerAs<Text>()) {
MOZ_ASSERT(aEditorBase.IsHTMLEditor());
}
std::ostream& operator<<(
std::ostream& aStream,
const InsertTextIntoTextNodeTransaction& aTransaction) {
aStream << "{ mTextNode=" << aTransaction.mTextNode.get();
if (aTransaction.mTextNode) {
aStream << " (" << *aTransaction.mTextNode << ")";
}
aStream << ", mOffset=" << aTransaction.mOffset << ", mStringToInsert=\""
<< NS_ConvertUTF16toUTF8(aTransaction.mStringToInsert).get() << "\""
<< ", mEditorBase=" << aTransaction.mEditorBase.get() << " }";
return aStream;
}
NS_IMPL_CYCLE_COLLECTION_INHERITED(InsertTextIntoTextNodeTransaction,
InsertTextTransaction, mTextNode)
NS_IMPL_ADDREF_INHERITED(InsertTextIntoTextNodeTransaction,
InsertTextTransaction)
NS_IMPL_RELEASE_INHERITED(InsertTextIntoTextNodeTransaction,
InsertTextTransaction)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(InsertTextIntoTextNodeTransaction)
NS_INTERFACE_MAP_END_INHERITING(InsertTextTransaction)
} // namespace mozilla
|