more on undowork -- adding base nsMsgTxn class for base undo object

mailnews/base/util/MANIFEST

@@ -29,4 +29,5 @@ nsNewsSummarySpec.h
 nsMsgUtils.h
 nsMessage.h
 nsMsgProtocol.h
+nsMsgTxn.h
 

mailnews/base/util/Makefile.in

@@ -39,6 +39,7 @@ EXPORTS = \
 	nsMsgUtils.h \
 	nsMessage.h \
 	nsMsgProtocol.h \
+	nsMsgTxn.h \
 	$(NULL)
 
 CPPSRCS = \
@@ -55,6 +56,7 @@ CPPSRCS = \
 	nsMsgUtils.cpp \
 	nsMessage.cpp \
 	nsMsgProtocol.cpp \
+	nsMsgTxn.cpp \
 	$(NULL)
 
 EXTRA_DSO_LDOPTS =	\

mailnews/base/util/makefile.win

@@ -37,6 +37,7 @@ EXPORTS=                \
 	nsMsgUtils.h \
 	nsMessage.h \
 	nsMsgProtocol.h \
+	nsMsgTxn.h \
 	$(NULL)
 
 ################################################################################
@@ -66,6 +67,7 @@ CPP_OBJS=                               \
 	.\$(OBJDIR)\nsMsgUtils.obj			\
 	.\$(OBJDIR)\nsMessage.obj			\
 	.\$(OBJDIR)\nsMsgProtocol.obj		\
+	.\$(OBJDIR)\nsMsgTxn.obj			\
 	$(NULL)
 
 LLIBS=								\

mailnews/base/util/nsMsgTxn.cpp

@@ -0,0 +1,99 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998, 1999 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsMsgTxn.h"
+static NS_DEFINE_IID(kISupportsIID, NS_ISUPPORTS_IID);
+static NS_DEFINE_IID(kITransactionIID, NS_ITRANSACTION_IID);
+
+NS_IMPL_ADDREF(nsMsgTxn)
+NS_IMPL_RELEASE(nsMsgTxn)
+
+// note that aEditor is not refcounted
+nsMsgTxn::nsMsgTxn()
+{
+  NS_INIT_REFCNT();
+}
+
+nsMsgTxn::~nsMsgTxn()
+{
+}
+
+NS_IMETHODIMP nsMsgTxn::Do(void)
+{
+  return NS_OK;
+}
+
+NS_IMETHODIMP nsMsgTxn::GetIsTransient(PRBool *aIsTransient)
+{
+  if (nsnull!=aIsTransient)
+    *aIsTransient = PR_FALSE;
+  else
+	  return NS_ERROR_NULL_POINTER;
+  return NS_OK;
+}
+
+NS_IMETHODIMP nsMsgTxn::Merge(PRBool *aDidMerge, nsITransaction *aTransaction)
+{
+  return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP nsMsgTxn::Write(nsIOutputStream *aOutputStream)
+{
+  return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP nsMsgTxn::GetUndoString(nsString *aString)
+{
+  if (nsnull!=aString)
+    *aString="Undo";
+  else
+	  return NS_ERROR_NULL_POINTER;
+  return NS_OK;
+}
+
+NS_IMETHODIMP nsMsgTxn::GetRedoString(nsString *aString)
+{
+  if (nsnull!=aString)
+    *aString="Redo";
+  else
+	  return NS_ERROR_NULL_POINTER;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMsgTxn::QueryInterface(REFNSIID aIID, void** aInstancePtr)
+{
+  if (NULL == aInstancePtr) {
+    return NS_ERROR_NULL_POINTER;
+  }
+  if (aIID.Equals(kISupportsIID)) {
+    *aInstancePtr = (void*)(nsISupports*)this;
+    NS_ADDREF_THIS();
+    return NS_OK;
+  }
+  if (aIID.Equals(kITransactionIID)) {
+    *aInstancePtr = (void*)(nsITransaction*)this;
+    NS_ADDREF_THIS();
+    return NS_OK;
+  }
+  *aInstancePtr = 0;
+  return NS_NOINTERFACE;
+}
+
+
+

mailnews/base/util/nsMsgTxn.h

@@ -0,0 +1,57 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998, 1999 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsMsgTxn_h__
+#define nsMsgTxn_h__
+
+#include "nsITransaction.h"
+#include "msgCore.h"
+
+#define NS_MESSAGETRANSACTION_IID \
+{ /* da621b30-1efc-11d3-abe4-00805f8ac968 */ \
+    0xda621b30, 0x1efc, 0x11d3, \
+	{ 0xab, 0xe4, 0x00, 0x80, 0x5f, 0x8a, 0xc9, 0x68 } }
+/**
+ * base class for all message undo/redo transactions.
+ */
+class NS_MSG_BASE nsMsgTxn : public nsITransaction
+{
+    NS_DECL_ISUPPORTS 
+
+    nsMsgTxn();
+    virtual ~nsMsgTxn();
+
+    NS_IMETHOD Do(void);
+    
+    NS_IMETHOD Undo(void) = 0;
+    
+    NS_IMETHOD Redo(void) = 0;
+    
+    NS_IMETHOD GetIsTransient(PRBool *aIsTransient);
+
+    NS_IMETHOD Merge(PRBool *aDidMerge, nsITransaction *aTransaction);
+
+    NS_IMETHOD Write(nsIOutputStream *aOutputStream);
+
+    NS_IMETHOD GetUndoString(nsString *aString);
+
+    NS_IMETHOD GetRedoString(nsString *aString);
+
+};
+
+#endif