gecko-dev/editor/libeditor/CreateElementTransaction.h
Masayuki Nakano 537b829474 Bug 1447213 - Change editor methods which take |const EditorRawDOMPoint&| but called with EditorDOMPoint.AsRaw() to template methods r=m_kato
A lot of methods take |const EditorRawDOMPoint&| as their argument.  However,
some of them are called with EditorDOMPoint::AsRaw(). This is not good for
performance because:
1. Needs to create temporary instance of EditorRawDOMPoint.
2. EditorRawDOMPoint::AsRaw() may be used by simple mistake.
3. Such methods may call EditorRawDOMPoint::Offset(), however, it's not copied
   to the original EditorDOMPoint instance.  So, callers may need to compute
   offset again.

So, such methods should be changed to template methods if they are not virtual
method and AsRaw() should be gotten rid of for prevent it looking not expensive.

MozReview-Commit-ID: DAqqW4a2EMS

--HG--
extra : rebase_source : 120b920477fe6e7231271411a00994325acdb842
2018-03-20 14:05:47 +09:00

89 lines
2.6 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 CreateElementTransaction_h
#define CreateElementTransaction_h
#include "mozilla/EditorDOMPoint.h"
#include "mozilla/EditTransactionBase.h"
#include "nsCOMPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsISupportsImpl.h"
class nsAtom;
class nsIContent;
class nsINode;
/**
* A transaction that creates a new node in the content tree.
*/
namespace mozilla {
class EditorBase;
namespace dom {
class Element;
} // namespace dom
class CreateElementTransaction final : public EditTransactionBase
{
protected:
template<typename PT, typename CT>
CreateElementTransaction(EditorBase& aEditorBase,
nsAtom& aTag,
const EditorDOMPointBase<PT, CT>& aPointToInsert);
public:
/**
* Create a transaction for creating a new child node of the container of
* aPointToInsert of type aTag.
*
* @param aEditorBase The editor which manages the transaction.
* @param aTag The tag (P, HR, TABLE, etc.) for the new element.
* @param aPointToInsert The new node will be inserted before the child at
* aPointToInsert. If this refers end of the container
* or after, the new node will be appended to the
* container.
*/
template<typename PT, typename CT>
static already_AddRefed<CreateElementTransaction>
Create(EditorBase& aEditorBase,
nsAtom& aTag,
const EditorDOMPointBase<PT, CT>& aPointToInsert);
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(CreateElementTransaction,
EditTransactionBase)
NS_DECL_EDITTRANSACTIONBASE
NS_IMETHOD RedoTransaction() override;
already_AddRefed<dom::Element> GetNewNode();
protected:
virtual ~CreateElementTransaction();
/**
* InsertNewNode() inserts mNewNode before the child node at mPointToInsert.
*/
void InsertNewNode(ErrorResult& aError);
// The document into which the new node will be inserted.
RefPtr<EditorBase> mEditorBase;
// The tag (mapping to object type) for the new element.
RefPtr<nsAtom> mTag;
// The DOM point we will insert mNewNode.
EditorDOMPoint mPointToInsert;
// The new node to insert.
nsCOMPtr<dom::Element> mNewNode;
};
} // namespace mozilla
#endif // #ifndef CreateElementTransaction_h