/**
* @doc FILEINFO
* @module FileInfo.h 1.3 - Interface for the CFileInfo and CFileInfoArray classes |
* The classes contained in this file allow to gather recursively file information
* through directories.
*
* <cp> Codeguru & friends
* Coded by Antonio Tejada Lacaci. 1999<nl>
* atejada@espanet.com<nl>
* CRC32 code by Floor A.C. Naaijkens
*
* Updates (aaaa-mm-dd):<nl>
*
* 1999-9-23 ATL: Opensource works! Again, Mr. Szucs (rszucs@cygron.hu) gets another bug:<nl>
* Missing "4-(dwRead & 0x3)" in the same lines as before, when calc'ing the padding mask.
* 1999-9-16 ATL: Corrected bug in GetCRC and GetChecksum as suggested by R�bert Szucs (rszucs@cygron.hu):<nl>
* There was a buffer overflow and checksum and crc for last dword +1 was calc'ed instead
* of the ones for last dword. Instead accessing buffer[dwRead +3...] it ought to access
* buffer[dwRead...] (shame on me! :'().
* 1999-9-2 ATL: Corrected bug in AddFile(CString, LPARAM) as suggested by Nhycoh (Nhycoh44@yahoo.com):<nl>
* There was some weird stuff at CFileInfo::Create(strFilePath) <nl>
* stating strFilePath.GetLength()-nBarPos instead of nBarPos+1
* (I'm quite sure I left my head on my pillow the day I did that %-#).
* 1999-6-27 ATL: Updated GetCRC & GetChecksum to avoid some bug cases<nl>
* 1999-4-7 ATL: Updated source code doc to conform Autoduck 2.0 standard<nl>
* 1999-4-7 ATL: Corrected bug in AddDir as suggested by Zhuang Yuyao (zhuangyy@koal.com):<nl>
* bIncludeDirs wasn't used if bRecurse was false.
*
* Keep this comment if you redistribute this file. And credit where credit's due!
*/
#if !defined(AFX_FILEINFO_H__4C620721_CFC7_11D2_AA42_A54123628E22__INCLUDED_)
#define AFX_FILEINFO_H__4C620721_CFC7_11D2_AA42_A54123628E22__INCLUDED_
#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000
#include <afxtempl.h>
/**
* @class Stores information about a file in a way like <c CFindFile> does
*/
class CFileInfo {
public:
/** @access Public members */
CFileInfo();
/**
* @cmember Copy constructor
* @parm CFileInfo to copy member variables from.
*/
CFileInfo(const CFileInfo& finf);
/**
* @cmember Destructor
*/
~CFileInfo();
/**
* @cmember Initializes CFileInfo member variables.
* @parm Values to init member variables.
* @parm Path of the file the CFileInfo refers to.
* @parmopt User defined parameter.
*/
void Create(const WIN32_FIND_DATA* pwfd, const CString strPath, LPARAM lParam=NULL);
/**
* @cmember Initializes CFileInfo member variables.
* @parm Absolute path for file or directory
* @parmopt User defined parameter.
*/
void Create(const CString strFilePath, LPARAM lParam = NULL);
/**
* @cmember Calcs 32bit checksum of file (i.e. sum of all the DWORDS of the file,
* truncated to 32bit).
* @parmopt Number of maximum bytes read for checksum calculation. This number is
* up-rounded to a multiple of 4 bytes (DWORD). If 0 or bigger than uhFileSize, checksum
* for all the file is calculated.
* @parmopt Force recalculation of checksum (otherwise if checksum has already
* been calculated, it isn't calculated again and previous calculated value is returned).
* @parmopt Flag to allow calling application to abort the calculation of
* checksum (for multithreaded applications).
* @parmopt Pointer to counter of bytes whose checksum has been calculated.
* This value is updated while checksum is being calculated, so calling application
* can view the progress of checksum calc (for multithreaded applications).
* Maximum value for pulCount is uhFileSize.
*/
DWORD GetChecksum(const ULONGLONG uhUpto=0, const BOOL bRecalc = FALSE,
const volatile BOOL* pbAbort=NULL, volatile ULONG* pulCount = NULL);
/**
* @cmember Calcs 32bit CRC of file contents (i.e. CRC of all the DWORDS of the file).
* @parmopt Number of maximum bytes read for CRC calculation. This number is
* up-rounded to a multiple of 4 bytes (DWORD). If 0 or bigger than uhFileSize, CRC
* for all the file is calculated.
* @parmopt Force recalculation of CRC (otherwise if CRC has already
* been calculated, it isn't calculated again and previous calculated value is returned).
* @parmopt pbAbort Flag to allow calling application to abort the calculation of
* CRC (for multithreaded applications).
* @parmopt Pointer to counter of bytes whose CRC has been calculated.
* This value is updated while CRC is being calculated, so calling application
* can view the progress of CRC calc (for multithreaded applications).
* Maximum value for pulCount is uhFileSize.
*/
DWORD GetCRC(const ULONGLONG dhUpto=0, const BOOL bRecalc = FALSE,
const volatile BOOL* pbAbort=NULL, volatile ULONG* pulCount = NULL);
/** @cmember File size in bytes as a DWORD value. */
DWORD GetLength(void) const { return (DWORD) m_uhFileSize; };
/** @cmember File size in bytes as an ULONGLONG value. */
ULONGLONG GetLength64(void) const { return m_uhFileSize; };
/** Get File split info (equivalent to CFindFile members) */
/**
* @cmember Gets the file drive
* @rdesc Returns C: for C:\WINDOWS\WIN.INI
*/
CString GetFileDrive(void) const;
/**
* @cmember Gets the file dir
* @rdesc Returns \WINDOWS\ for C:\WINDOWS\WIN.INI
*/
CString GetFileDir(void) const;
/** @cmember returns WIN for C:\WINDOWS\WIN.INI */
CString GetFileTitle(void) const;
/** @cmember returns INI for C:\WINDOWS\WIN.INI */
CString GetFileExt(void) const;
/** @cmember returns C:\WINDOWS\ for C:\WINDOWS\WIN.INI */
CString GetFileRoot(void) const { return GetFileDrive() + GetFileDir(); };
/** @cmember returns WIN.INI for C:\WINDOWS\WIN.INI */
CString GetFileName(void) const { return GetFileTitle() + GetFileExt(); };
/** @cmember returns C:\WINDOWS\WIN.INI for C:\WINDOWS\WIN.INI */
const CString& GetFilePath(void) const { return m_strFilePath; }
/* Get File times info (equivalent to CFindFile members) */
/** @cmember returns creation time */
const CTime& GetCreationTime(void) const { return m_timCreation; };
/** @cmember returns last access time */
const CTime& GetLastAccessTime(void) const { return m_timLastAccess; };
/** @cmember returns las write time */
const CTime& GetLastWriteTime(void) const { return m_timLastWrite; };
/* Get File attributes info (equivalent to CFindFile members) */
/** @cmember returns file attributes */
DWORD GetAttributes(void) const { return m_dwAttributes; };
/** @cmember returns TRUE if the file is a directory */
BOOL IsDirectory(void) const { return m_dwAttributes & FILE_ATTRIBUTE_DIRECTORY; };
/** @cmember Returns TRUE if the file has archive bit set */
BOOL IsArchived(void) const { return m_dwAttributes & FILE_ATTRIBUTE_ARCHIVE; };
/** @cmember Returns TRUE if the file is read-only */
BOOL IsReadOnly(void) const { return m_dwAttributes & FILE_ATTRIBUTE_READONLY; };
/** @cmember Returns TRUE if the file is compressed */
BOOL IsCompressed(void) const { return m_dwAttributes & FILE_ATTRIBUTE_COMPRESSED; };
/** @cmember Returns TRUE if the file is a system file */
BOOL IsSystem(void) const { return m_dwAttributes & FILE_ATTRIBUTE_SYSTEM; };
/** @cmember Returns TRUE if the file is hidden */
BOOL IsHidden(void) const { return m_dwAttributes & FILE_ATTRIBUTE_HIDDEN; };
/** @cmember Returns TRUE if the file is temporary */
BOOL IsTemporary(void) const { return m_dwAttributes & FILE_ATTRIBUTE_TEMPORARY; };
/** @cmember Returns TRUE if the file is a normal file */
BOOL IsNormal(void) const { return m_dwAttributes == 0; };
LPARAM m_lParam; /** User-defined parameter */
private:
/** @access Private members */
CString m_strFilePath; /** @cmember Full filepath of file (directory+filename) */
DWORD m_dwAttributes; /** @cmember File attributes of file (as returned by FindFile() */
ULONGLONG m_uhFileSize; /** @cmember File of size. (COM states LONGLONG as hyper, so "uh" means
unsigned hyper) */
CTime m_timCreation; /** @cmember Creation time */
CTime m_timLastAccess; /** @cmember Last Access time */
CTime m_timLastWrite; /** @cmember Last write time */
DWORD m_dwChecksum; /** @cmember Checksum calculated for the first m_uhChecksumBytes bytes */
DWORD m_dwCRC; /** @cmember CRC calculated for the first m_uhCRCBytes bytes */
DWORD m_uhCRCBytes; /** @cmember Number of file bytes with CRC calc'ed (4 multiple or filesize ) */
DWORD m_uhChecksumBytes;/** @cmember Number of file bytes with Checksum calc'ed (4 multiple or filesize) */
};
/**
* @class Allows to retrieve <c CFileInfo>s from files/directories in a directory
*/
class CFileInfoArray : public CArray<CFileInfo, CFileInfo&> {
public:
/** @access Public members */
/**
* @cmember Default constructor
*/
CFileInfoArray();
/**
* @cmember,menum Default values for <md CFileInfoArray.lAddParam>
*/
enum {
AP_NOSORT=0, /** @@emem Insert <c CFileInfo>s in a unordered manner */
AP_SORTASCENDING=0, /** @@emem Insert <c CFileInfo>s in a ascending order */
AP_SORTDESCENDING=1, /** @@emem Insert <c CFileInfo>s in a descending number */
AP_SORTBYSIZE=2, /** @@emem AP_SORTBYSIZE | Insert <c CFileInfo>s ordered by uhFileSize (presumes array is
previously ordered by uhFileSize). */
AP_SORTBYNAME=4 /** @@emem AP_SORTBYNAME | Insert <c CFileInfo>s ordered by strFilePath (presumes array is
previously ordered by strFilePath) */
};
/**
* @cmember Adds a file or all contained in a directory to the CFileInfoArray
* Only "static" data for CFileInfo is filled (by default CRC and checksum are NOT
* calculated when inserting CFileInfos).<nl> Returns the number of <c CFileInfo>s added to the array
* @parm Name of the directory, ended in backslash.
* @parm Mask of files to add in case that strDirName is a directory
* @parm Wether to recurse or not subdirectories
* @parmopt Parameter to pass to protected member function AddFileInfo
* @parmopt Wether to add or not CFileInfos for directories
* @parmopt Pointer to a variable to signal abort of directory retrieval
* (multithreaded apps).
* @parmopt pulCount Pointer to a variable incremented each time a CFileInfo is added to the
* array (multithreaded apps).
* @xref <mf CFileInfoArray.AddFile> <mf CFileInfoArray.AddFileInfo> <md CFileInfoArray.AP_NOSORT>
*/
int AddDir(const CString strDirName, const CString strMask, const BOOL bRecurse,
LPARAM lAddParam=AP_NOSORT, const BOOL bIncludeDirs=FALSE,
const volatile BOOL* pbAbort = NULL, volatile ULONG* pulCount = NULL);
/**
* @cmember Adds a single file or directory to the CFileInfoArray. In case of directory, files
* contained in the directory are NOT added to the array.<nl>
* Returns the position in the array where the <c CFileInfo> was added (-1 if <c CFileInfo>
* wasn't added)
* @parm Name of the file or directory to add. NOT ended with backslash.
* @parm Parameter to pass to protected member function AddFileInfo.
* @xref <mf CFileInfoArray.AddDir> <mf CFileInfoArray.AddFileInfo>
*/
int AddFile(const CString strFilePath, LPARAM lAddParam);
protected:
/** @access Protected Members */
/**
* @cmember Called by AddXXXX to add a CFileInfo to the array. Can be overriden to:
* 1. Add only desired CFileInfos (filter)
* 2. Fill user param lParam
* 3. Change sort order/criteria<nl>
* Returns the position in the array where the CFileInfo was added or -1 if the CFileInfo
* wasn't added to the array.
* Default implementation sorts by lAddParam values and adds all CFileInfos
* (no filtering)
* @parm CFileInfo to insert in the array.
* @parm Parameter passed from AddDir function.
* @xref <mf CFileInfoArray.AddDir>
*/
virtual int AddFileInfo(CFileInfo& finf, LPARAM lAddParam);
};
/**
@ex This code adds all files in root directory and its subdirectories (but not directories themselves) to the array and TRACEs them: |
CFileInfoArray fia;
fia.AddDir(
"C:\\", // Directory
"*.*", // Filemask (all files)
TRUE, // Recurse subdirs
fia::AP_SORTBYNAME | fia::AP_SORTASCENDING, // Sort by name and ascending
FALSE // Do not add array entries for directories (only for files)
);
TRACE("Dumping directory contents\n");
for (int i=0;i<fia.GetSize();i++) TRACE(fia[i].GetFilePath()+"\n");
@ex You can also call AddDir multiple times. The example shows files in root directories (but not subdirectories) of C:\\ and D:\\: |
CFileInfoArray fia;
// Note both AddDir use the same sorting order and direction
fia.AddDir("C:\\", "*.*", FALSE, fia::AP_SORTBYNAME | fia::AP_SORTASCENDING, FALSE );
fia.AddDir("D:\\", "*.*", FALSE, fia::AP_SORTBYNAME | fia::AP_SORTASCENDING, FALSE );
TRACE("Dumping directory contents for C:\\ and D:\\ \n");
for (int i=0;i<fia.GetSize();i++) TRACE(fia[i].GetFilePath()+"\n");
@ex Or you can add individual files: |
CFileInfoArray fin;
// Note both AddDir and AddFile must use the same sorting order and direction
fia.AddDir("C:\\WINDOWS\\", "*.*", FALSE, fia::AP_SORTBYNAME | fia::AP_SORTDESCENDING, FALSE );
fia.AddFile("C:\\AUTOEXEC.BAT", fia::AP_SORTBYNAME | fia::SORTDESCENDING);
TRACE("Dumping directory contents for C:\\WINDOWS\\ and file C:\\AUTOEXEC.BAT\n");
for (int i=0;i<fia.GetSize();i++) TRACE(fia[i].GetFilePath()+"\n");
@ex And mix directories with individual files: |
CFileInfoArray fin;
// Note both AddDir and AddFile must use the same sorting order and direction
// Note also the list of filemasks *.EXE and *.COM
fia.AddDir("C:\\WINDOWS\\", "*.EXE;*.COM", FALSE, fia::AP_SORTBYNAME | fia::AP_SORTDESCENDING, FALSE );
fia.AddFile("C:\\AUTOEXEC.BAT", fia::AP_SORTBYNAME | fia::SORTDESCENDING);
// Note no trailing bar for next AddFile (we want to insert an entry for the directory
// itself, not for the files inside the directory)
fia.AddFile("C:\\PROGRAM FILES", fia::AP_SORTBYNAME | fia::SORTDESCENDING);
TRACE("Dumping directory contents for C:\\WINDOWS\\, file C:\\AUTOEXEC.BAT and "
" directory \"C:\\PROGRAM FILES\" \n");
for (int i=0;i<fia.GetSize();i++) TRACE(fia[i].GetFilePath+"\n");
*/
#endif // !defined(AFX_FILEINFO_H__4C620721_CFC7_11D2_AA42_A54123628E22__INCLUDED_)
Submit an article or tip