editor/libeditor/InsertTextTransaction.h

   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 #ifndef InsertTextTransaction_h
   7 #define InsertTextTransaction_h
   8
   9 #include "EditTransactionBase.h"  // base class
  10
  11 #include "EditorDOMPoint.h"
  12 #include "EditorForwards.h"
  13
  14 #include "nsCycleCollectionParticipant.h"  // various macros
  15 #include "nsID.h"                          // NS_DECLARE_STATIC_IID_ACCESSOR
  16 #include "nsISupportsImpl.h"               // NS_DECL_ISUPPORTS_INHERITED
  17 #include "nsString.h"                      // nsString members
  18 #include "nscore.h"                        // NS_IMETHOD, nsAString
  19
  20 namespace mozilla {
  21 namespace dom {
  22 class Text;
  23 }  // namespace dom
  24
  25 /**
  26  * A transaction that inserts text into a content node.
  27  */
  28 class InsertTextTransaction final : public EditTransactionBase {
  29  protected:
  30   InsertTextTransaction(EditorBase& aEditorBase,
  31                         const nsAString& aStringToInsert,
  32                         const EditorDOMPointInText& aPointToInsert);
  33
  34  public:
  35   /**
  36    * Creates new InsertTextTransaction instance.  This never returns nullptr.
  37    *
  38    * @param aEditorBase     The editor which manages the transaction.
  39    * @param aPointToInsert  The insertion point.
  40    * @param aStringToInsert The new string to insert.
  41    */
  42   static already_AddRefed<InsertTextTransaction> Create(
  43       EditorBase& aEditorBase, const nsAString& aStringToInsert,
  44       const EditorDOMPointInText& aPointToInsert);
  45
  46   NS_DECL_ISUPPORTS_INHERITED
  47   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(InsertTextTransaction,
  48                                            EditTransactionBase)
  49
  50   NS_DECL_EDITTRANSACTIONBASE
  51   NS_DECL_EDITTRANSACTIONBASE_GETASMETHODS_OVERRIDE(InsertTextTransaction)
  52
  53   MOZ_CAN_RUN_SCRIPT NS_IMETHOD RedoTransaction() override;
  54   NS_IMETHOD Merge(nsITransaction* aOtherTransaction, bool* aDidMerge) override;
  55
  56   /**
  57    * Return the string data associated with this transaction.
  58    */
  59   const nsString& GetData() const { return mStringToInsert; }
  60
  61   template <typename EditorDOMPointType>
  62   EditorDOMPointType SuggestPointToPutCaret() const {
  63     if (NS_WARN_IF(!mTextNode)) {
  64       return EditorDOMPointType();
  65     }
  66     return EditorDOMPointType(mTextNode, mOffset + mStringToInsert.Length());
  67   }
  68
  69   friend std::ostream& operator<<(std::ostream& aStream,
  70                                   const InsertTextTransaction& aTransaction);
  71
  72  private:
  73   virtual ~InsertTextTransaction() = default;
  74
  75   // Return true if aOtherTransaction immediately follows this transaction.
  76   bool IsSequentialInsert(InsertTextTransaction& aOtherTransaction) const;
  77
  78   // The Text node to operate upon.
  79   RefPtr<dom::Text> mTextNode;
  80
  81   // The offset into mTextNode where the insertion is to take place.
  82   uint32_t mOffset;
  83
  84   // The text to insert into mTextNode at mOffset.
  85   nsString mStringToInsert;
  86
  87   // The editor, which we'll need to get the selection.
  88   RefPtr<EditorBase> mEditorBase;
  89 };
  90
  91 }  // namespace mozilla
  92
  93 #endif  // #ifndef InsertTextTransaction_h