/* 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/RefPtr.h"
#include "mozilla/dom/Text.h"
#include "nsDebug.h"
#include "nsString.h"

namespace mozilla {

class ReplaceTextTransaction : public EditTransactionBase {
 protected:
  ReplaceTextTransaction(EditorBase& aEditorBase,
                         const nsAString& aStringToInsert, dom::Text& aTextNode,
                         uint32_t aStartOffset, uint32_t aLength)
      : mEditorBase(&aEditorBase),
        mStringToInsert(aStringToInsert),
        mOffset(aStartOffset) {
    if (aLength) {
      IgnoredErrorResult ignoredError;
      aTextNode.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);

  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;

  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 ReplaceTextTransaction& aTransaction);

 protected:
  RefPtr<EditorBase> mEditorBase;

  nsString mStringToInsert;
  nsString mStringToBeReplaced;

  uint32_t mOffset;
};

/**
 * Private class for ReplaceTextTransaction when it needs to handle a
 * transaction of `HTMLEditor`.
 */
class ReplaceTextInTextNodeTransaction final : public ReplaceTextTransaction {
 public:
  NS_DECL_ISUPPORTS_INHERITED
  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ReplaceTextInTextNodeTransaction,
                                           ReplaceTextTransaction)

  friend std::ostream& operator<<(
      std::ostream& aStream,
      const ReplaceTextInTextNodeTransaction& aTransaction);

 private:
  ReplaceTextInTextNodeTransaction(EditorBase& aEditorBase,
                                   const nsAString& aStringToInsert,
                                   dom::Text& aTextNode, uint32_t aStartOffset,
                                   uint32_t aLength)
      : ReplaceTextTransaction(aEditorBase, aStringToInsert, aTextNode,
                               aStartOffset, aLength),
        mTextNode(&aTextNode) {
    MOZ_ASSERT(aEditorBase.IsHTMLEditor());
  }

  virtual ~ReplaceTextInTextNodeTransaction() = default;

  NS_DECL_EDITTRANSACTIONBASE_GETASMETHODS_OVERRIDE(
      ReplaceTextInTextNodeTransaction)

  RefPtr<dom::Text> mTextNode;

  friend class ReplaceTextTransaction;
};

}  // namespace mozilla

#endif  // #ifndef ReplaceTextTransaction_