gecko-dev/editor/libeditor/DeleteContentTransactionBase.h
Masayuki Nakano 2c93600238 Bug 1797247 - part 1: Add delete transaction classes to use build time type checks r=m_kato
First, `EditorBase::CreateTransactionForDeleteSelection` returns an instance of
`EditAggregateTransaction`. It's a base class of `PlaceholderTransaction` and
`DeleteRangeTransaction` but it's also a concrete class.  However, it's too
generic.  Therefore, this patch creates `DeleteMultipleRangesTransaction` which
is a simple sub-class of it, and makes `EditAggregateTransaction` be an abstract
class.  Then, add `AddChild` methods to each concrete class to restrict the
type of child transactions.

Next, `DeleteRangeTransaction` contains only `DeleteNodeTransaction` and
`DeleteTextTransaction`.  Therefore, once they have a common base class,
we can check the type easier.  Therefore, this patch also adds
`DeleteContentTransactionBase` and
`EditorBase::CreateTransactionForCollapsedRange` becomes clearer what it
returns.

With these changes, `DeleteRangeTransaction` obviously contains only
`DeleteContentTransactionBase`, `DeleteMultipleRangesTransaction` contains only
`DeleteRangeTransaction`, `DeleteNodeTransaction` and `DeleteTextTransaction`.
And they are guaranteed at build time (at least from outside the classes).
***
fix

Differential Revision: https://phabricator.services.mozilla.com/D169038
2023-02-15 22:17:17 +00:00

47 lines
1.3 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 DeleteContentTransactionBase_h
#define DeleteContentTransactionBase_h
#include "EditTransactionBase.h"
#include "EditorForwards.h"
#include "mozilla/RefPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsISupportsImpl.h"
namespace mozilla {
/**
* An abstract transaction that removes text or node.
*/
class DeleteContentTransactionBase : public EditTransactionBase {
public:
/**
* Return a point to put caret if the transaction instance has an idea.
*/
virtual EditorDOMPoint SuggestPointToPutCaret() const = 0;
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(DeleteContentTransactionBase,
EditTransactionBase)
NS_DECL_EDITTRANSACTIONBASE_GETASMETHODS_OVERRIDE(
DeleteContentTransactionBase)
protected:
explicit DeleteContentTransactionBase(EditorBase& aEditorBase);
~DeleteContentTransactionBase() = default;
RefPtr<EditorBase> mEditorBase;
};
} // namespace mozilla
#endif // #ifndef DeleteContentTransactionBase_h