fune/editor/libeditor/ReplaceTextTransaction.h
Masayuki Nakano 1abcb1c46b Bug 1764866 - Add "mozilla/EditorForwards.h" r=m_kato
Headers in editor module has a lot of forward declarations for avoiding the
include hell and has a lot of helper template classes.

Forward declarations of template classes is really messy and I'd want to
avoid the duplication because it blocks changing template class.  Therefore,
centralizing forward declarations makes the headers cleaner and maintaining
template classes easier.  Therefore, this patch adds a new header file which
has only forward declarations and some aliases.

It'd be better to define `enum class`es in it like `EventForwards.h` for
reducing the dependencies between headers, but currently this does not do it
for making the new file simpler as far as possible.

Removing `EditActionListener.h` is because it's unused.

Removing `AutoTopLevelEditSubActionNotifier` is because it's renamed to
`AutoEditSubActionNotifier`.
https://hg.mozilla.org/mozilla-central/rev/6de55c5b5f8d5f92389d0d244d2bced1f979ade9

Differential Revision: https://phabricator.services.mozilla.com/D143817
2022-04-20 14:46:16 +00:00

87 lines
2.9 KiB
C++

/* -*- 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 ReplaceTextTransaction_h
#define ReplaceTextTransaction_h
#include "EditorBase.h"
#include "EditorDOMPoint.h"
#include "EditorForwards.h"
#include "EditTransactionBase.h"
#include "mozilla/Attributes.h"
#include "mozilla/Maybe.h"
#include "mozilla/RefPtr.h"
#include "mozilla/dom/Text.h"
#include "nsDebug.h"
#include "nsString.h"
namespace mozilla {
class ReplaceTextTransaction final : public EditTransactionBase {
private:
ReplaceTextTransaction(EditorBase& aEditorBase,
const nsAString& aStringToInsert, dom::Text& aTextNode,
uint32_t aStartOffset, uint32_t aLength)
: mEditorBase(&aEditorBase),
mTextNode(&aTextNode),
mStringToInsert(aStringToInsert),
mOffset(aStartOffset) {
if (aLength) {
IgnoredErrorResult ignoredError;
mTextNode->SubstringData(mOffset, aLength, mStringToBeReplaced,
ignoredError);
NS_WARNING_ASSERTION(
!ignoredError.Failed(),
"Failed to initialize ReplaceTextTransaction::mStringToBeReplaced, "
"but ignored");
}
}
virtual ~ReplaceTextTransaction() = default;
public:
static already_AddRefed<ReplaceTextTransaction> Create(
EditorBase& aEditorBase, const nsAString& aStringToInsert,
dom::Text& aTextNode, uint32_t aStartOffset, uint32_t aLength) {
MOZ_ASSERT(aLength > 0, "Use InsertTextTransaction instead");
MOZ_ASSERT(!aStringToInsert.IsEmpty(), "Use DeleteTextTransaction instead");
MOZ_ASSERT(aTextNode.Length() >= aStartOffset);
MOZ_ASSERT(aTextNode.Length() >= aStartOffset + aLength);
RefPtr<ReplaceTextTransaction> transaction = new ReplaceTextTransaction(
aEditorBase, aStringToInsert, aTextNode, aStartOffset, aLength);
return transaction.forget();
}
ReplaceTextTransaction() = delete;
ReplaceTextTransaction(const ReplaceTextTransaction&) = delete;
ReplaceTextTransaction& operator=(const ReplaceTextTransaction&) = delete;
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ReplaceTextTransaction,
EditTransactionBase)
NS_DECL_EDITTRANSACTIONBASE
NS_DECL_EDITTRANSACTIONBASE_GETASMETHODS_OVERRIDE(ReplaceTextTransaction)
MOZ_CAN_RUN_SCRIPT NS_IMETHOD RedoTransaction() final;
friend std::ostream& operator<<(std::ostream& aStream,
const ReplaceTextTransaction& aTransaction);
private:
RefPtr<EditorBase> mEditorBase;
RefPtr<dom::Text> mTextNode;
nsString mStringToInsert;
nsString mStringToBeReplaced;
uint32_t mOffset;
};
} // namespace mozilla
#endif // #ifndef ReplaceTextTransaction_