src/Utils/DirFileEnum.cpp

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2015-2017 - TortoiseGit
   4 // Copyright (C) 2005-2006, 2009-2010 - TortoiseSVN
   5
   6 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License
   8 // as published by the Free Software Foundation; either version 2
   9 // of the License, or (at your option) any later version.
  10
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software Foundation,
  18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 #include "stdafx.h"
  20 #include "DirFileEnum.h"
  21 #include "SysInfo.h"
  22 #include "StringUtils.h"
  23
  24 CSimpleFileFind::CSimpleFileFind(const CString &sPath, LPCTSTR pPattern)
  25         : m_dError(ERROR_SUCCESS)
  26         , m_bFirst(TRUE)
  27         , m_sPathPrefix(sPath)
  28 {
  29         // Add a trailing \ to m_sPathPrefix if it is missing.
  30         // Do not add one to "C:" since "C:" and "C:\" are different.
  31         int len = m_sPathPrefix.GetLength();
  32         if (len != 0)
  33         {
  34                 TCHAR ch = sPath[len-1];
  35                 if (ch != '\\' && (ch != ':' || len != 2))
  36                         m_sPathPrefix += "\\";
  37         }
  38         if (len >= 248 && (CStringUtils::StartsWith(m_sPathPrefix, L"\\\\?\\")))
  39                 m_hFindFile = ::FindFirstFileEx((LPCTSTR)(L"\\\\?\\" + m_sPathPrefix + pPattern), FindExInfoBasic, &m_FindFileData, FindExSearchNameMatch, nullptr, FIND_FIRST_EX_LARGE_FETCH);
  40         else
  41                 m_hFindFile = ::FindFirstFileEx((LPCTSTR)(m_sPathPrefix + pPattern), FindExInfoBasic, &m_FindFileData, FindExSearchNameMatch, nullptr, FIND_FIRST_EX_LARGE_FETCH);
  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 BOOL CSimpleFileFind::FindNextFile()
  54 {
  55         if (m_dError)
  56                 return FALSE;
  57
  58         if (m_bFirst)
  59         {
  60                 m_bFirst = FALSE;
  61                 return TRUE;
  62         }
  63
  64         if (!::FindNextFile(m_hFindFile, &m_FindFileData))
  65         {
  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, const CString& sDirName)
 117         : CSimpleFileFind(sDirName)
 118         , m_seNext(seNext)
 119 {
 120 }
 121
 122 CDirFileEnum::CDirStackEntry::~CDirStackEntry()
 123 {
 124 }
 125
 126 inline void CDirFileEnum::PopStack()
 127 {
 128         CDirStackEntry* seToDelete = m_seStack;
 129         m_seStack = seToDelete->m_seNext;
 130         delete seToDelete;
 131 }
 132
 133 inline void CDirFileEnum::PushStack(const CString& sDirName)
 134 {
 135         m_seStack = new CDirStackEntry(m_seStack,sDirName);
 136 }
 137
 138 CDirFileEnum::CDirFileEnum(const CString& sDirName)
 139         : m_seStack(nullptr)
 140         , m_bIsNew(TRUE)
 141 {
 142         PushStack(sDirName);
 143 }
 144
 145 CDirFileEnum::~CDirFileEnum()
 146 {
 147         while (m_seStack)
 148                 PopStack();
 149 }
 150
 151 BOOL CDirFileEnum::NextFile(CString &sResult, bool* pbIsDirectory, bool bRecurse /* = true */)
 152 {
 153         if (m_bIsNew)
 154         {
 155                 // Special-case first time - haven't found anything yet,
 156                 // so don't do recurse-into-directory check.
 157                 m_bIsNew = FALSE;
 158         }
 159         else if (m_seStack && m_seStack->IsDirectory() && bRecurse)
 160                 PushStack(m_seStack->GetFilePath());
 161
 162         while (m_seStack && !m_seStack->FindNextFileNoDots())
 163         {
 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)
 172                         *pbIsDirectory = m_seStack->IsDirectory();
 173                 return TRUE;
 174         }
 175
 176         return FALSE;
 177 }