Back to index

lightning-sunbird  0.9+nobinonly
inFileSearch.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is mozilla.org code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 2001
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Joe Hewitt <hewitt@netscape.com> (original author)
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * 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 __inFileSearch_h__
00039 #define __inFileSearch_h__
00040 
00041 #include "inIFileSearch.h"
00042 
00043 #include "nsString.h"
00044 #include "nsVoidArray.h"
00045 #include "nsISimpleEnumerator.h"
00046 #include "nsCOMArray.h"
00047 #include "inISearchObserver.h"
00048 #include "nsIFile.h"
00049 #include "inSearchLoop.h"
00050 
00051 class inFileSearch : public inIFileSearch
00052 {
00053 public:
00054   NS_DECL_ISUPPORTS
00055   NS_DECL_INISEARCHPROCESS
00056   NS_DECL_INIFILESEARCH
00057 
00058   inFileSearch();
00059   virtual ~inFileSearch();
00060 
00061 protected:
00062   nsCOMPtr<inISearchObserver> mObserver;
00063   nsCOMArray<nsIFile> mResults;
00064   nsCOMArray<nsISimpleEnumerator> mDirStack;
00065   nsCOMPtr<nsIFile> mLastResult;
00066   nsCOMPtr<nsIFile> mSearchPath;
00067   inSearchLoop* mSearchLoop;
00068   nsAutoString* mBasePath;
00069   nsAutoString* mTextCriteria;
00070   PRUnichar** mFilenameCriteria;
00071   PRUint32 mDirsSearched;
00072   PRUint32 mFilenameCriteriaCount;
00073   PRInt32 mResultCount;
00074   PRBool mIsActive;
00075   PRBool mHoldResults;
00076   PRBool mReturnRelativePaths;
00077   PRBool mSearchRecursive;
00078 
00079   // life cycle of search
00080   nsresult InitSearch();
00081   nsresult KillSearch(PRInt16 aResult);
00082   nsresult SearchDirectory(nsIFile* aDir, PRBool aIsSync);
00083   nsresult PrepareResult(nsIFile* aFile, PRBool aIsSync);
00084 
00085   // asynchronous search helpers
00086   nsresult InitSearchLoop();
00087   nsresult InitSubDirectoryStack();
00088   PRBool GetNextSubDirectory(nsIFile** aDir);
00089   nsresult PushSubDirectoryOnStack(nsIFile* aDir);
00090   already_AddRefed<nsIFile> GetNextDirectory(nsISimpleEnumerator* aEnum);
00091 
00092   // pattern matching
00093   PRBool MatchFile(nsIFile* aFile);
00094   static PRBool MatchPattern(PRUnichar* aPattern, PRUnichar* aString);
00095   static PRBool AdvanceWildcard(PRUnichar** aString, PRUnichar* aNextChar);
00096   
00097   // misc
00098   nsresult MakePathRelative(nsAString& aPath);
00099   nsresult CountDirectoryDepth(nsIFile* aDir, PRUint32* aDepth);
00100 
00101 };
00102 
00103 // {D5636476-9F94-47f2-9CE9-69CDD9D7BBCD}
00104 #define IN_FILESEARCH_CID \
00105 { 0xd5636476, 0x9f94, 0x47f2, { 0x9c, 0xe9, 0x69, 0xcd, 0xd9, 0xd7, 0xbb, 0xcd } }
00106 
00107 #endif // __inFileSearch_h__