Back to index

lightning-sunbird  0.9+nobinonly
nsMsgSearchSession.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) 2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsMsgSearchSession_h___
00039 #define nsMsgSearchSession_h___
00040 
00041 #include "nscore.h"
00042 #include "nsMsgSearchCore.h"
00043 #include "nsIMsgSearchSession.h"
00044 #include "nsIUrlListener.h"
00045 #include "nsIMsgWindow.h"
00046 #include "nsITimer.h"
00047 #include "nsMsgSearchArray.h"
00048 #include "nsISupportsArray.h"
00049 #include "nsCOMArray.h"
00050 #include "nsWeakReference.h"
00051 
00052 class nsMsgSearchAdapter;
00053 class nsMsgSearchBoolExpression;
00054 
00055 class nsMsgSearchSession : public nsIMsgSearchSession, public nsIUrlListener, public nsSupportsWeakReference
00056 {
00057 public:
00058   NS_DECL_ISUPPORTS
00059   NS_DECL_NSIMSGSEARCHSESSION
00060   NS_DECL_NSIURLLISTENER
00061 
00062   nsMsgSearchSession();
00063   virtual ~nsMsgSearchSession();
00064 
00065 protected:
00066 
00067   nsCOMPtr <nsIMsgWindow> m_window;
00068 
00069   nsresult Initialize();
00070   nsresult StartTimer();
00071   nsresult TimeSlice (PRBool *aDone);
00072   nsMsgSearchScopeTerm *GetRunningScope();
00073   void               StopRunning();
00074   nsresult BeginSearching();
00075   nsresult DoNextSearch();
00076   nsresult BuildUrlQueue ();
00077   nsresult AddUrl(const char *url);
00078   nsresult SearchWOUrls ();
00079   nsresult GetNextUrl();
00080   nsresult NotifyListenersDone(nsresult status);
00081   void EnableFolderNotifications(PRBool aEnable);
00082   void ReleaseFolderDBRef();
00083 
00084   nsMsgSearchScopeTermArray m_scopeList;
00085   nsCOMPtr <nsISupportsArray> m_termList;
00086   nsCOMPtr <nsISupportsArray> m_listenerList;
00087 
00088   nsMsgResultArray m_resultList;
00089 
00090   void DestroyTermList ();
00091   void DestroyScopeList ();
00092   void DestroyResultList ();
00093 
00094   static void TimerCallback(nsITimer *aTimer, void *aClosure);
00095   // support for searching multiple scopes in serial
00096   nsresult TimeSliceSerial (PRBool *aDone);
00097   nsresult TimeSliceParallel ();
00098 
00099   nsMsgSearchAttribValue m_sortAttribute;
00100   PRInt32 m_idxRunningScope;
00101   nsMsgSearchType m_searchType;
00102   PRBool m_handlingError;
00103   PRInt32 m_urlQueueIndex;
00104   nsCStringArray m_urlQueue;
00105   nsCOMPtr <nsITimer> m_backgroundTimer;
00106   PRBool m_searchPaused;
00107   nsMsgSearchBoolExpression *m_expressionTree;
00108 };
00109 
00110 #endif