src/Utils/DirFileEnum.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2005 - 2006 - Jon Foster
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 #pragma once
  19
  20 /**
  21  * \ingroup Utils
  22  * Enumerates over a directory tree, non-recursively.
  23  * Advantages over CFileFind:
  24  * 1) Return values are not broken.  An error return from
  25  *    CFileFind::FindNext() indicates that the *next*
  26  *    call to CFileFind::FindNext() will fail.
  27  *    A failure from CSimpleFileFind means *that* call
  28  *    failed, which is what I'd expect.
  29  * 2) Error handling.  If you use CFileFind, you are
  30  *    required to call ::GetLastError() yourself, there
  31  *    is no abstraction.
  32  * 3) Support for ignoring the "." and ".." directories
  33  *    automatically.
  34  * 4) No dynamic memory allocation.
  35  */
  36 class CSimpleFileFind {
  37 private:
  38    /**
  39     * Windows FindFirstFile() handle.
  40     */
  41    HANDLE m_hFindFile;
  42
  43    /**
  44     * Windows error code - if all is well, ERROR_SUCCESS.
  45     * At end of directory, ERROR_NO_MORE_FILES.
  46     */
  47    DWORD m_dError;
  48
  49    /**
  50     * Flag indicating that FindNextFile() has not yet been
  51     * called.
  52     */
  53    BOOL m_bFirst;
  54
  55 protected:
  56    /**
  57     * The prefix for files in this directory.
  58     * Ends with a "\", unless it's a drive letter only
  59     * ("C:" is different from "C:\", and "C:filename" is
  60     * legal anyway.)
  61     */
  62    CString m_sPathPrefix;
  63
  64    /**
  65     * The file data returned by FindFirstFile()/FindNextFile().
  66     */
  67    WIN32_FIND_DATA m_FindFileData;
  68
  69 public:
  70
  71    /**
  72     * Constructor.
  73     *
  74     * \param sPath    The path to search in.
  75     * \param sPattern The filename pattern - default all files.
  76     */
  77    CSimpleFileFind(const CString &sPath, LPCTSTR pPattern = _T("*.*"));
  78    ~CSimpleFileFind();
  79
  80    /**
  81     * Advance to the next file.
  82     * Note that the state of this object is undefined until
  83     * this method is called the first time.
  84     *
  85     * \return TRUE if a file was found, FALSE on error or
  86     * end-of-directory (use IsError() and IsPastEnd() to
  87     * disambiguate).
  88     */
  89    BOOL FindNextFile();
  90
  91    /**
  92     * Advance to the next file, ignoring the "." and ".."
  93     * pseudo-directories (if seen).
  94     *
  95     * Behaves like FindNextFile(), apart from ignoring "."
  96     * and "..".
  97     *
  98     * \return TRUE if a file was found, FALSE on error or
  99     * end-of-directory.
 100     */
 101    BOOL FindNextFileNoDots();
 102
 103    /**
 104     * Advance to the next file, ignoring all directories.
 105     *
 106     * Behaves like FindNextFile(), apart from ignoring
 107     * directories.
 108     *
 109     * \return TRUE if a file was found, FALSE on error or
 110     * end-of-directory.
 111     */
 112    BOOL FindNextFileNoDirectories();
 113
 114    /**
 115     * Get the Windows error code.
 116     * Only useful when IsError() returns true.
 117     *
 118     * \return Windows error code.
 119     */
 120    inline DWORD GetError() const
 121    {
 122       return m_dError;
 123    }
 124
 125    /**
 126     * Check if the current file data is valid.
 127     * (I.e. there has not been an error and we are not past
 128     * the end of the directory).
 129     *
 130     * \return TRUE iff the current file data is valid.
 131     */
 132    inline BOOL IsValid() const
 133    {
 134       return (m_dError == ERROR_SUCCESS);
 135    }
 136
 137    /**
 138     * Check if we have passed the end of the directory.
 139     *
 140     * \return TRUE iff we have passed the end of the directory.
 141     */
 142    inline BOOL IsPastEnd() const
 143    {
 144       return (m_dError == ERROR_NO_MORE_FILES);
 145    }
 146
 147    /**
 148     * Check if there has been an unexpected error - i.e.
 149     * any error other than passing the end of the directory.
 150     *
 151     * \return TRUE iff there has been an unexpected error.
 152     */
 153    inline BOOL IsError() const
 154    {
 155       return (m_dError != ERROR_SUCCESS)
 156           && (m_dError != ERROR_NO_MORE_FILES);
 157    }
 158
 159    /**
 160     * Check if the current file is a directory.
 161     *
 162     * \return TRUE iff the current file is a directory.
 163     */
 164    inline bool IsDirectory() const
 165    {
 166       return !!(m_FindFileData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY);
 167    }
 168
 169    /**
 170     * Get the current file name (excluding the path).
 171     *
 172     * \return the current file name.
 173     */
 174    inline CString GetFileName() const
 175    {
 176       return m_FindFileData.cFileName;
 177    }
 178
 179    /*
 180     * Get the current file name, including the path.
 181     *
 182     * \return the current file path.
 183     */
 184    inline CString GetFilePath() const
 185    {
 186       return m_sPathPrefix + m_FindFileData.cFileName;
 187    }
 188
 189    /**
 190     * Check if the current file is the "." or ".."
 191     * pseudo-directory.
 192     *
 193     * \return TRUE iff the current file is the "." or ".."
 194     * pseudo-directory.
 195     */
 196    inline BOOL IsDots() const
 197    {
 198       return IsDirectory()
 199           && m_FindFileData.cFileName[0] == _T('.')
 200           && ( (m_FindFileData.cFileName[1] == 0)
 201             || (m_FindFileData.cFileName[1] == _T('.')
 202              && m_FindFileData.cFileName[2] == 0) );
 203    }
 204 };
 205
 206 /**
 207  * \ingroup Utils
 208  * Enumerates over a directory tree, recursively.
 209  *
 210  * \par requirements
 211  * win95 or later
 212  * winNT4 or later
 213  * MFC
 214  *
 215  * \version 1.0
 216  * first version
 217  *
 218  * \date 18-Feb-2004
 219  *
 220  * \author Jon Foster
 221  *
 222  * \par license
 223  * This code is GPL'd.
 224  */
 225 class CDirFileEnum
 226 {
 227 private:
 228
 229    class CDirStackEntry : public CSimpleFileFind {
 230    public:
 231       CDirStackEntry(CDirStackEntry * seNext, const CString& sDirName);
 232       ~CDirStackEntry();
 233
 234       CDirStackEntry * m_seNext;
 235    };
 236
 237    CDirStackEntry * m_seStack;
 238    BOOL m_bIsNew;
 239
 240    inline void PopStack();
 241    inline void PushStack(const CString& sDirName);
 242
 243 public:
 244    /**
 245     * Iterate through the specified directory and all subdirectories.
 246     * It does not matter whether or not the specified directory ends
 247     * with a slash.  Both relative and absolute paths are allowed,
 248     * the results of this iterator will be consistent with the style
 249     * passed to this constructor.
 250     *
 251     * @param dirName The directory to search in.
 252     */
 253         CDirFileEnum(const CString& dirName);
 254
 255    /**
 256     * Destructor.  Frees all resources.
 257     */
 258    ~CDirFileEnum();
 259
 260    /**
 261     * Get the next file from this iterator.
 262     *
 263     * \param  result On successful return, holds the full path to the found
 264     *                file. (If this function returns FALSE, the value of
 265     *                result is unspecified).
 266         * \param  pbIsDirectory Pointer to a bool variable which will hold
 267         *                TRUE if the \c result path is a directory, FALSE
 268         *                                if it's a file. Pass NULL if you don't need that information.
 269     * \return TRUE iff a file was found, false at end of the iteration.
 270     */
 271    BOOL NextFile(CString &result, bool* pbIsDirectory);
 272 };
 273