src/Utils/DirFileEnum.cpp

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2005-2006, 2009-2010 - TortoiseSVN
   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 #include "stdafx.h"
  19 #include "DirFileEnum.h"
  20
  21
  22 CSimpleFileFind::CSimpleFileFind(const CString &sPath, LPCTSTR pPattern) :
  23    m_dError(ERROR_SUCCESS),
  24    m_bFirst(TRUE),
  25    m_sPathPrefix(sPath)
  26 {
  27     // Add a trailing \ to m_sPathPrefix if it is missing.
  28     // Do not add one to "C:" since "C:" and "C:\" are different.
  29     int len = m_sPathPrefix.GetLength();
  30     if (len != 0)
  31     {
  32         TCHAR ch = sPath[len-1];
  33         if (ch != '\\' && (ch != ':' || len != 2))
  34         {
  35             m_sPathPrefix += "\\";
  36         }
  37     }
  38     if ((len >= 248)&&(m_sPathPrefix.Left(4).Compare(_T("\\\\?\\"))))
  39         m_hFindFile = ::FindFirstFile((LPCTSTR)(_T("\\\\?\\") + m_sPathPrefix + pPattern), &m_FindFileData);
  40     else
  41         m_hFindFile = ::FindFirstFile((LPCTSTR)(m_sPathPrefix + pPattern), &m_FindFileData);
  42     if (m_hFindFile == INVALID_HANDLE_VALUE) {
  43         m_dError = ::GetLastError();
  44     }
  45    }
  46
  47 CSimpleFileFind::~CSimpleFileFind()
  48 {
  49    if (m_hFindFile != INVALID_HANDLE_VALUE) {
  50       ::FindClose(m_hFindFile);
  51    }
  52 }
  53
  54 BOOL CSimpleFileFind::FindNextFile()
  55 {
  56    if (m_dError) {
  57       return FALSE;
  58    }
  59
  60    if (m_bFirst) {
  61       m_bFirst = FALSE;
  62       return TRUE;
  63    }
  64
  65    if (!::FindNextFile(m_hFindFile, &m_FindFileData)) {
  66       m_dError = ::GetLastError();
  67       return FALSE;
  68    }
  69
  70    return TRUE;
  71 }
  72
  73 BOOL CSimpleFileFind::FindNextFileNoDots()
  74 {
  75    BOOL result;
  76    do {
  77       result = FindNextFile();
  78    } while (result && IsDots());
  79
  80    return result;
  81 }
  82
  83 BOOL CSimpleFileFind::FindNextFileNoDirectories()
  84 {
  85    BOOL result;
  86    do {
  87       result = FindNextFile();
  88    } while (result && IsDirectory());
  89
  90    return result;
  91 }
  92
  93
  94 /*
  95  * Implementation notes:
  96  *
  97  * This is a depth-first traversal.  Directories are visited before
  98  * their contents.
  99  *
 100  * We keep a stack of directories.  The deepest directory is at the top
 101  * of the stack, the originally-requested directory is at the bottom.
 102  * If we come across a directory, we first return it to the user, then
 103  * recurse into it.  The finder at the bottom of the stack always points
 104  * to the file or directory last returned to the user (except immediately
 105  * after creation, when the finder points to the first valid thing we need
 106  * to return, but we haven't actually returned anything yet - hence the
 107  * m_bIsNew variable).
 108  *
 109  * Errors reading a directory are assumed to be end-of-directory, and
 110  * are otherwise ignored.
 111  *
 112  * The "." and ".." psedo-directories are ignored for obvious reasons.
 113  */
 114
 115
 116 CDirFileEnum::CDirStackEntry::CDirStackEntry(CDirStackEntry * seNext,
 117                                              const CString& sDirName)
 118                                              : CSimpleFileFind(sDirName),
 119                                              m_seNext(seNext)
 120 {
 121 }
 122
 123 CDirFileEnum::CDirStackEntry::~CDirStackEntry()
 124 {
 125 }
 126
 127 inline void CDirFileEnum::PopStack()
 128 {
 129    CDirStackEntry * seToDelete = m_seStack;
 130    m_seStack = seToDelete->m_seNext;
 131    delete seToDelete;
 132 }
 133
 134 inline void CDirFileEnum::PushStack(const CString& sDirName)
 135 {
 136    m_seStack = new CDirStackEntry(m_seStack,sDirName);
 137 }
 138
 139 CDirFileEnum::CDirFileEnum(const CString& sDirName) :
 140    m_seStack(NULL),
 141    m_bIsNew(TRUE)
 142 {
 143    PushStack(sDirName);
 144 }
 145
 146 CDirFileEnum::~CDirFileEnum()
 147 {
 148    while (m_seStack != NULL) {
 149       PopStack();
 150    }
 151 }
 152
 153 BOOL CDirFileEnum::NextFile(CString &sResult, bool* pbIsDirectory, bool bRecurse /* = true */)
 154 {
 155    if (m_bIsNew) {
 156       // Special-case first time - haven't found anything yet,
 157       // so don't do recurse-into-directory check.
 158       m_bIsNew = FALSE;
 159    } else if (m_seStack && m_seStack->IsDirectory() && bRecurse) {
 160       PushStack(m_seStack->GetFilePath());
 161    }
 162
 163    while (m_seStack && !m_seStack->FindNextFileNoDots()) {
 164       // No more files in this directory, try parent.
 165       PopStack();
 166    }
 167
 168    if (m_seStack)
 169    {
 170       sResult = m_seStack->GetFilePath();
 171       if(pbIsDirectory != NULL)
 172       {
 173           *pbIsDirectory = m_seStack->IsDirectory();
 174       }
 175       return TRUE;
 176    } else {
 177       return FALSE;
 178    }
 179 }