editor/libeditor/DeleteNodeTransaction.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "DeleteNodeTransaction.h"
   7
   8 #include "EditorBase.h"
   9 #include "EditorDOMPoint.h"
  10 #include "HTMLEditUtils.h"
  11 #include "SelectionState.h"  // RangeUpdater
  12 #include "TextEditor.h"
  13
  14 #include "mozilla/Logging.h"
  15 #include "mozilla/ToString.h"
  16
  17 #include "nsDebug.h"
  18 #include "nsError.h"
  19 #include "nsAString.h"
  20
  21 namespace mozilla {
  22
  23 // static
  24 already_AddRefed<DeleteNodeTransaction> DeleteNodeTransaction::MaybeCreate(
  25     EditorBase& aEditorBase, nsIContent& aContentToDelete) {
  26   RefPtr<DeleteNodeTransaction> transaction =
  27       new DeleteNodeTransaction(aEditorBase, aContentToDelete);
  28   if (NS_WARN_IF(!transaction->CanDoIt())) {
  29     return nullptr;
  30   }
  31   return transaction.forget();
  32 }
  33
  34 DeleteNodeTransaction::DeleteNodeTransaction(EditorBase& aEditorBase,
  35                                              nsIContent& aContentToDelete)
  36     : DeleteContentTransactionBase(aEditorBase),
  37       mContentToDelete(&aContentToDelete),
  38       mParentNode(aContentToDelete.GetParentNode()) {
  39   MOZ_DIAGNOSTIC_ASSERT_IF(
  40       aEditorBase.IsHTMLEditor(),
  41       HTMLEditUtils::IsRemovableNode(aContentToDelete) ||
  42           // It's okay to delete text node if it's added by `HTMLEditor` since
  43           // remaining it may be noisy for the users.
  44           (aContentToDelete.IsText() &&
  45            aContentToDelete.HasFlag(NS_MAYBE_MODIFIED_FREQUENTLY)));
  46   NS_ASSERTION(
  47       !aEditorBase.IsHTMLEditor() ||
  48           HTMLEditUtils::IsRemovableNode(aContentToDelete),
  49       "Deleting non-editable text node, please write a test for this!!");
  50 }
  51
  52 std::ostream& operator<<(std::ostream& aStream,
  53                          const DeleteNodeTransaction& aTransaction) {
  54   aStream << "{ mContentToDelete=" << aTransaction.mContentToDelete.get();
  55   if (aTransaction.mContentToDelete) {
  56     aStream << " (" << *aTransaction.mContentToDelete << ")";
  57   }
  58   aStream << ", mParentNode=" << aTransaction.mParentNode.get();
  59   if (aTransaction.mParentNode) {
  60     aStream << " (" << *aTransaction.mParentNode << ")";
  61   }
  62   aStream << ", mRefContent=" << aTransaction.mRefContent.get();
  63   if (aTransaction.mRefContent) {
  64     aStream << " (" << *aTransaction.mRefContent << ")";
  65   }
  66   aStream << ", mEditorBase=" << aTransaction.mEditorBase.get() << " }";
  67   return aStream;
  68 }
  69
  70 NS_IMPL_CYCLE_COLLECTION_INHERITED(DeleteNodeTransaction,
  71                                    DeleteContentTransactionBase,
  72                                    mContentToDelete, mParentNode, mRefContent)
  73
  74 NS_IMPL_ADDREF_INHERITED(DeleteNodeTransaction, DeleteContentTransactionBase)
  75 NS_IMPL_RELEASE_INHERITED(DeleteNodeTransaction, DeleteContentTransactionBase)
  76 NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(DeleteNodeTransaction)
  77 NS_INTERFACE_MAP_END_INHERITING(DeleteContentTransactionBase)
  78
  79 bool DeleteNodeTransaction::CanDoIt() const {
  80   if (NS_WARN_IF(!mContentToDelete) || NS_WARN_IF(!mEditorBase) ||
  81       !mParentNode) {
  82     return false;
  83   }
  84   return mEditorBase->IsTextEditor() ||
  85          HTMLEditUtils::IsSimplyEditableNode(*mParentNode);
  86 }
  87
  88 NS_IMETHODIMP DeleteNodeTransaction::DoTransaction() {
  89   MOZ_LOG(GetLogModule(), LogLevel::Info,
  90           ("%p DeleteNodeTransaction::%s this=%s", this, __FUNCTION__,
  91            ToString(*this).c_str()));
  92
  93   if (NS_WARN_IF(!CanDoIt())) {
  94     return NS_OK;
  95   }
  96
  97   MOZ_ASSERT_IF(mEditorBase->IsTextEditor(), !mContentToDelete->IsText());
  98
  99   // Remember which child mContentToDelete was (by remembering which child was
 100   // next).  Note that mRefContent can be nullptr.
 101   mRefContent = mContentToDelete->GetNextSibling();
 102
 103   // give range updater a chance.  SelAdjDeleteNode() needs to be called
 104   // *before* we do the action, unlike some of the other RangeItem update
 105   // methods.
 106   mEditorBase->RangeUpdaterRef().SelAdjDeleteNode(*mContentToDelete);
 107
 108   OwningNonNull<nsINode> parentNode = *mParentNode;
 109   OwningNonNull<nsIContent> contentToDelete = *mContentToDelete;
 110   ErrorResult error;
 111   parentNode->RemoveChild(contentToDelete, error);
 112   NS_WARNING_ASSERTION(!error.Failed(), "nsINode::RemoveChild() failed");
 113   return error.StealNSResult();
 114 }
 115
 116 EditorDOMPoint DeleteNodeTransaction::SuggestPointToPutCaret() const {
 117   return EditorDOMPoint();
 118 }
 119
 120 NS_IMETHODIMP DeleteNodeTransaction::UndoTransaction() {
 121   MOZ_LOG(GetLogModule(), LogLevel::Info,
 122           ("%p DeleteNodeTransaction::%s this=%s", this, __FUNCTION__,
 123            ToString(*this).c_str()));
 124
 125   if (NS_WARN_IF(!CanDoIt())) {
 126     // This is a legal state, the transaction is a no-op.
 127     return NS_OK;
 128   }
 129   ErrorResult error;
 130   OwningNonNull<EditorBase> editorBase = *mEditorBase;
 131   OwningNonNull<nsINode> parentNode = *mParentNode;
 132   OwningNonNull<nsIContent> contentToDelete = *mContentToDelete;
 133   nsCOMPtr<nsIContent> refContent = mRefContent;
 134   // XXX Perhaps, we should check `refContent` is a child of `parentNode`,
 135   //     and if it's not, we should stop undoing or something.
 136   parentNode->InsertBefore(contentToDelete, refContent, error);
 137   // InsertBefore() may call MightThrowJSException() even if there is no error.
 138   // We don't need the flag here.
 139   error.WouldReportJSException();
 140   if (error.Failed()) {
 141     NS_WARNING("nsINode::InsertBefore() failed");
 142     return error.StealNSResult();
 143   }
 144   return NS_OK;
 145 }
 146
 147 NS_IMETHODIMP DeleteNodeTransaction::RedoTransaction() {
 148   MOZ_LOG(GetLogModule(), LogLevel::Info,
 149           ("%p DeleteNodeTransaction::%s this=%s", this, __FUNCTION__,
 150            ToString(*this).c_str()));
 151
 152   if (NS_WARN_IF(!CanDoIt())) {
 153     // This is a legal state, the transaction is a no-op.
 154     return NS_OK;
 155   }
 156
 157   mEditorBase->RangeUpdaterRef().SelAdjDeleteNode(*mContentToDelete);
 158
 159   OwningNonNull<nsINode> parentNode = *mParentNode;
 160   OwningNonNull<nsIContent> contentToDelete = *mContentToDelete;
 161   ErrorResult error;
 162   parentNode->RemoveChild(contentToDelete, error);
 163   NS_WARNING_ASSERTION(!error.Failed(), "nsINode::RemoveChild() failed");
 164   return error.StealNSResult();
 165 }
 166
 167 }  // namespace mozilla