Back to index

lightning-sunbird  0.9+nobinonly
nsMsgFilterList.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Seth Spitzer <sspitzer@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef _nsMsgFilterList_H_
00040 #define _nsMsgFilterList_H_
00041 
00042 #include "nscore.h"
00043 #include "nsIMsgFolder.h"
00044 #include "nsIMsgFilterList.h"
00045 #include "nsCOMPtr.h"
00046 #include "nsISupportsArray.h"
00047 #include "nsIFileSpec.h"
00048 #include "nsIOutputStream.h"
00049 
00050 const PRInt16 kFileVersion = 8;
00051 const PRInt16 k60Beta1Version = 7;
00052 const PRInt16 k45Version = 6;
00053 
00054 
00056 // The Msg Filter List is an interface designed to make accessing filter lists
00057 // easier. Clients typically open a filter list and either enumerate the filters,
00058 // or add new filters, or change the order around...
00059 //
00061 
00062 class nsIMsgFilter;
00063 class nsMsgFilter;
00064 
00065 class nsMsgFilterList : public nsIMsgFilterList
00066 {
00067 public:
00068   NS_DECL_ISUPPORTS
00069   NS_DECL_NSIMSGFILTERLIST
00070 
00071   nsMsgFilterList();
00072   virtual ~nsMsgFilterList();
00073 
00074   nsresult Close();
00075   nsresult LoadTextFilters(nsIOFileStream *aStream);
00076 
00077   PRBool m_temporaryList;
00078 
00079 protected:
00080   // type-safe accessor when you really have to have an nsMsgFilter
00081   nsresult GetMsgFilterAt(PRUint32 filterIndex, nsMsgFilter **filter);
00082 #ifdef DEBUG
00083   void Dump();
00084 #endif
00085 protected:
00086   nsresult ComputeArbitraryHeaders();
00087   nsresult SaveTextFilters(nsIOFileStream *aStream);
00088   // file streaming methods
00089   char ReadChar(nsIOFileStream *aStream);
00090   char SkipWhitespace(nsIOFileStream *aStream);
00091   PRBool StrToBool(nsCString &str);
00092   char LoadAttrib(nsMsgFilterFileAttribValue &attrib, nsIOFileStream *aStream);
00093   const char *GetStringForAttrib(nsMsgFilterFileAttribValue attrib);
00094   nsresult LoadValue(nsCString &value, nsIOFileStream *aStream);
00095   PRInt16 m_fileVersion;
00096   PRPackedBool m_loggingEnabled;
00097   PRPackedBool m_startWritingToBuffer; //tells us when to start writing one whole filter to m_unparsedBuffer
00098   nsCOMPtr <nsIMsgFolder> m_folder;
00099   nsMsgFilter *m_curFilter; // filter we're filing in or out(?)
00100   const char *m_filterFileName;
00101   nsCOMPtr<nsISupportsArray> m_filters;
00102   nsCString m_arbitraryHeaders;
00103   nsCOMPtr<nsIFileSpec> m_defaultFile;
00104   nsCString m_unparsedFilterBuffer; //holds one entire filter unparsed 
00105 
00106 private:
00107   nsresult TruncateLog();
00108   nsresult GetLogFileSpec(nsIFileSpec **aFileSpec);
00109   nsCOMPtr<nsIOutputStream> m_logStream;
00110 };
00111 
00112 #endif
00113 
00114 
00115