editor/txmgr/TransactionManager.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 mozilla_TransactionManager_h
   7 #define mozilla_TransactionManager_h
   8
   9 #include "mozilla/EditorForwards.h"
  10 #include "mozilla/TransactionStack.h"
  11
  12 #include "nsCOMArray.h"
  13 #include "nsCOMPtr.h"
  14 #include "nsCycleCollectionParticipant.h"
  15 #include "nsISupportsImpl.h"
  16 #include "nsITransactionManager.h"
  17 #include "nsWeakReference.h"
  18 #include "nscore.h"
  19
  20 class nsITransaction;
  21
  22 namespace mozilla {
  23
  24 class TransactionManager final : public nsITransactionManager,
  25                                  public nsSupportsWeakReference {
  26  public:
  27   explicit TransactionManager(int32_t aMaxTransactionCount = -1);
  28
  29   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  30   NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(TransactionManager,
  31                                            nsITransactionManager)
  32
  33   NS_DECL_NSITRANSACTIONMANAGER
  34
  35   already_AddRefed<nsITransaction> PeekUndoStack();
  36   already_AddRefed<nsITransaction> PeekRedoStack();
  37
  38   MOZ_CAN_RUN_SCRIPT nsresult Undo();
  39   MOZ_CAN_RUN_SCRIPT nsresult Redo();
  40
  41   size_t NumberOfUndoItems() const { return mUndoStack.GetSize(); }
  42   size_t NumberOfRedoItems() const { return mRedoStack.GetSize(); }
  43
  44   int32_t NumberOfMaximumTransactions() const { return mMaxTransactionCount; }
  45
  46   bool EnableUndoRedo(int32_t aMaxTransactionCount = -1);
  47   bool DisableUndoRedo() { return EnableUndoRedo(0); }
  48   bool ClearUndoRedo() {
  49     if (NS_WARN_IF(!mDoStack.IsEmpty())) {
  50       return false;
  51     }
  52     mUndoStack.Clear();
  53     mRedoStack.Clear();
  54     return true;
  55   }
  56
  57   void Attach(HTMLEditor& aHTMLEditor);
  58   void Detach(const HTMLEditor& aHTMLEditor);
  59
  60   MOZ_CAN_RUN_SCRIPT void DidDoNotify(nsITransaction& aTransaction,
  61                                       nsresult aDoResult);
  62   MOZ_CAN_RUN_SCRIPT void DidUndoNotify(nsITransaction& aTransaction,
  63                                         nsresult aUndoResult);
  64   MOZ_CAN_RUN_SCRIPT void DidRedoNotify(nsITransaction& aTransaction,
  65                                         nsresult aRedoResult);
  66
  67   /**
  68    * Exposing non-virtual methods of nsITransactionManager methods.
  69    */
  70   MOZ_CAN_RUN_SCRIPT nsresult BeginBatchInternal(nsISupports* aData);
  71   nsresult EndBatchInternal(bool aAllowEmpty);
  72
  73  private:
  74   virtual ~TransactionManager() = default;
  75
  76   MOZ_CAN_RUN_SCRIPT nsresult BeginTransaction(nsITransaction* aTransaction,
  77                                                nsISupports* aData);
  78   nsresult EndTransaction(bool aAllowEmpty);
  79
  80   int32_t mMaxTransactionCount;
  81   TransactionStack mDoStack;
  82   TransactionStack mUndoStack;
  83   TransactionStack mRedoStack;
  84   RefPtr<HTMLEditor> mHTMLEditor;
  85 };
  86
  87 }  // namespace mozilla
  88
  89 mozilla::TransactionManager* nsITransactionManager::AsTransactionManager() {
  90   return static_cast<mozilla::TransactionManager*>(this);
  91 }
  92
  93 #endif  // #ifndef mozilla_TransactionManager_h