bf3516e81e
In modern C++, static constexpr member variables are automatically inline (aka weak) so the template trick is not needed. This also avoid duplication and reduces the amount of parsed code. No impact on generated binary (actually: smaller debuginfo, close to identical binary). Differential Revision: https://phabricator.services.mozilla.com/D247825
121 lines
4.1 KiB
C++
121 lines
4.1 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 InsertTextTransaction_h
|
|
#define InsertTextTransaction_h
|
|
|
|
#include "EditTransactionBase.h" // base class
|
|
|
|
#include "EditorDOMPoint.h"
|
|
#include "EditorForwards.h"
|
|
|
|
#include "mozilla/dom/Text.h"
|
|
#include "nsCycleCollectionParticipant.h" // various macros
|
|
#include "nsID.h" // NS_INLINE_DECL_STATIC_IID
|
|
#include "nsISupportsImpl.h" // NS_DECL_ISUPPORTS_INHERITED
|
|
#include "nsString.h" // nsString members
|
|
#include "nscore.h" // NS_IMETHOD, nsAString
|
|
|
|
namespace mozilla {
|
|
|
|
/**
|
|
* A transaction that inserts text into a content node.
|
|
*/
|
|
class InsertTextTransaction : public EditTransactionBase {
|
|
protected:
|
|
InsertTextTransaction(EditorBase& aEditorBase,
|
|
const nsAString& aStringToInsert,
|
|
const EditorDOMPointInText& aPointToInsert);
|
|
|
|
public:
|
|
/**
|
|
* Creates new InsertTextTransaction instance. This never returns nullptr.
|
|
*
|
|
* @param aEditorBase The editor which manages the transaction.
|
|
* @param aPointToInsert The insertion point.
|
|
* @param aStringToInsert The new string to insert.
|
|
*/
|
|
static already_AddRefed<InsertTextTransaction> Create(
|
|
EditorBase& aEditorBase, const nsAString& aStringToInsert,
|
|
const EditorDOMPointInText& aPointToInsert);
|
|
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(InsertTextTransaction,
|
|
EditTransactionBase)
|
|
|
|
NS_DECL_EDITTRANSACTIONBASE
|
|
NS_DECL_EDITTRANSACTIONBASE_GETASMETHODS_OVERRIDE(InsertTextTransaction)
|
|
|
|
MOZ_CAN_RUN_SCRIPT NS_IMETHOD RedoTransaction() override;
|
|
NS_IMETHOD Merge(nsITransaction* aOtherTransaction, bool* aDidMerge) override;
|
|
|
|
/**
|
|
* Return the string data associated with this transaction.
|
|
*/
|
|
const nsString& GetData() const { return mStringToInsert; }
|
|
|
|
/**
|
|
* Return the `Text` node to insert text (or delete text from).
|
|
*/
|
|
dom::Text* GetTextNode() const;
|
|
|
|
template <typename EditorDOMPointType>
|
|
EditorDOMPointType SuggestPointToPutCaret() const {
|
|
dom::Text* const textNode = GetTextNode();
|
|
if (NS_WARN_IF(!textNode)) {
|
|
return EditorDOMPointType();
|
|
}
|
|
return EditorDOMPointType(textNode, mOffset + mStringToInsert.Length());
|
|
}
|
|
|
|
friend std::ostream& operator<<(std::ostream& aStream,
|
|
const InsertTextTransaction& aTransaction);
|
|
|
|
protected:
|
|
virtual ~InsertTextTransaction() = default;
|
|
|
|
// Return true if aOtherTransaction immediately follows this transaction.
|
|
bool IsSequentialInsert(InsertTextTransaction& aOtherTransaction) const;
|
|
|
|
// The editor, which we'll need to get the selection.
|
|
RefPtr<EditorBase> mEditorBase;
|
|
// The text to insert into mTextNode at mOffset.
|
|
nsString mStringToInsert;
|
|
// The offset into mTextNode where the insertion is to take place.
|
|
uint32_t mOffset;
|
|
};
|
|
|
|
/**
|
|
* Private class for InsertTextTransaction when it needs to handle a transaction
|
|
* of `HTMLEditor`.
|
|
*/
|
|
class InsertTextIntoTextNodeTransaction final : public InsertTextTransaction {
|
|
public:
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(InsertTextIntoTextNodeTransaction,
|
|
InsertTextTransaction)
|
|
|
|
friend std::ostream& operator<<(
|
|
std::ostream& aStream,
|
|
const InsertTextIntoTextNodeTransaction& aTransaction);
|
|
|
|
private:
|
|
NS_DECL_EDITTRANSACTIONBASE_GETASMETHODS_OVERRIDE(
|
|
InsertTextIntoTextNodeTransaction)
|
|
|
|
InsertTextIntoTextNodeTransaction(EditorBase& aEditorBase,
|
|
const nsAString& aStringToInsert,
|
|
const EditorDOMPointInText& aPointToInsert);
|
|
virtual ~InsertTextIntoTextNodeTransaction() = default;
|
|
|
|
RefPtr<dom::Text> mTextNode;
|
|
|
|
friend class InsertTextTransaction;
|
|
};
|
|
|
|
} // namespace mozilla
|
|
|
|
#endif // #ifndef InsertTextTransaction_h
|