michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #ifndef nsTransactionManager_h__
michael@0: #define nsTransactionManager_h__
michael@0: 
michael@0: #include "nsCOMArray.h"
michael@0: #include "nsCOMPtr.h"
michael@0: #include "nsCycleCollectionParticipant.h"
michael@0: #include "nsTransactionStack.h"
michael@0: #include "nsISupportsImpl.h"
michael@0: #include "nsITransactionManager.h"
michael@0: #include "nsTransactionStack.h"
michael@0: #include "nsWeakReference.h"
michael@0: #include "nscore.h"
michael@0: 
michael@0: class nsITransaction;
michael@0: class nsITransactionListener;
michael@0: class nsTransactionItem;
michael@0: 
michael@0: /** implementation of a transaction manager object.
michael@0:  *
michael@0:  */
michael@0: class nsTransactionManager : public nsITransactionManager
michael@0:                            , public nsSupportsWeakReference
michael@0: {
michael@0: private:
michael@0: 
michael@0:   int32_t                mMaxTransactionCount;
michael@0:   nsTransactionStack     mDoStack;
michael@0:   nsTransactionStack     mUndoStack;
michael@0:   nsTransactionStack     mRedoStack;
michael@0:   nsCOMArray<nsITransactionListener> mListeners;
michael@0: 
michael@0: public:
michael@0: 
michael@0:   /** The default constructor.
michael@0:    */
michael@0:   nsTransactionManager(int32_t aMaxTransactionCount=-1);
michael@0: 
michael@0:   /** The default destructor.
michael@0:    */
michael@0:   virtual ~nsTransactionManager();
michael@0: 
michael@0:   /* Macro for AddRef(), Release(), and QueryInterface() */
michael@0:   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
michael@0:   NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(nsTransactionManager,
michael@0:                                            nsITransactionManager)
michael@0: 
michael@0:   /* nsITransactionManager method implementations. */
michael@0:   NS_DECL_NSITRANSACTIONMANAGER
michael@0: 
michael@0:   already_AddRefed<nsITransaction> PeekUndoStack();
michael@0:   already_AddRefed<nsITransaction> PeekRedoStack();
michael@0: 
michael@0:   virtual nsresult WillDoNotify(nsITransaction *aTransaction, bool *aInterrupt);
michael@0:   virtual nsresult DidDoNotify(nsITransaction *aTransaction, nsresult aExecuteResult);
michael@0:   virtual nsresult WillUndoNotify(nsITransaction *aTransaction, bool *aInterrupt);
michael@0:   virtual nsresult DidUndoNotify(nsITransaction *aTransaction, nsresult aUndoResult);
michael@0:   virtual nsresult WillRedoNotify(nsITransaction *aTransaction, bool *aInterrupt);
michael@0:   virtual nsresult DidRedoNotify(nsITransaction *aTransaction, nsresult aRedoResult);
michael@0:   virtual nsresult WillBeginBatchNotify(bool *aInterrupt);
michael@0:   virtual nsresult DidBeginBatchNotify(nsresult aResult);
michael@0:   virtual nsresult WillEndBatchNotify(bool *aInterrupt);
michael@0:   virtual nsresult DidEndBatchNotify(nsresult aResult);
michael@0:   virtual nsresult WillMergeNotify(nsITransaction *aTop,
michael@0:                                    nsITransaction *aTransaction,
michael@0:                                    bool *aInterrupt);
michael@0:   virtual nsresult DidMergeNotify(nsITransaction *aTop,
michael@0:                                   nsITransaction *aTransaction,
michael@0:                                   bool aDidMerge,
michael@0:                                   nsresult aMergeResult);
michael@0: 
michael@0: private:
michael@0: 
michael@0:   /* nsTransactionManager specific private methods. */
michael@0:   virtual nsresult BeginTransaction(nsITransaction *aTransaction,
michael@0:                                     nsISupports *aData);
michael@0:   virtual nsresult EndTransaction(bool aAllowEmpty);
michael@0: };
michael@0: 
michael@0: #endif // nsTransactionManager_h__