FileDir.h

Go to the documentation of this file.

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Project: uLib - User mode utility library.
// Module: Hierarchial file directory listings using DLinkList.
// Author: Copyright (c) Love Nystrom.
// License: NNOSL (BSD descendant, see NNOSL.txt in the base directory).
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#ifndef __FileDir_h_incl__
#define __FileDir_h_incl__

#include <uLib/Common.h>
#include <uLib/ListFunc.h>
#include <uLib/MemFunc.h>

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------


CSTR LongestCommonPath( CSTR PathName1, CSTR PathName2 );

#ifdef __cplusplus // The rest of this module is C++

class FileEntry;    // Forward declarations needed here because..
class DirEntry;     // ..doxygen miscompiled the doc with the class/struct..
struct ScanDirCtx;  // ..specifier directly in the pointer declarations.

typedef FileEntry*  PFileEntry;  
typedef DirEntry*   PDirEntry;   
typedef ScanDirCtx* PScanDirCtx; 


typedef bool (__stdcall *PFnDirAddAction)( PDirEntry pDir, LPWIN32_FIND_DATA pFD, PScanDirCtx pCtx );
typedef bool (__stdcall *PFnFileAddAction)( PFileEntry pFile, LPWIN32_FIND_DATA pFD, PScanDirCtx pCtx );


typedef bool (__stdcall *PFnDirAction)( PDirEntry pDir, PScanDirCtx pCtx );
typedef bool (__stdcall *PFnFileAction)( PFileEntry pFile, PScanDirCtx pCtx );


typedef bool (__stdcall *PFnAbortScan)( PDirEntry pDir, PScanDirCtx pCtx );


#if !defined(__DOXYGEN__)

extern PFileEntry (__stdcall *NewFileEntry)( LPWIN32_FIND_DATA pfd, PDirEntry pDir, PScanDirCtx pCtx );
extern PDirEntry (__stdcall *NewDirEntry)( LPWIN32_FIND_DATA pfd, PDirEntry pDir, PScanDirCtx pCtx );

#else // doxygen can't seem to parse the plain function pointers, so subst with mock-ups...
  extern PFileEntry __stdcall NewFileEntry( LPWIN32_FIND_DATA pfd, PDirEntry pDir, PScanDirCtx pCtx ); 
  extern PDirEntry __stdcall NewDirEntry( LPWIN32_FIND_DATA pfd, PDirEntry pDir, PScanDirCtx pCtx ); 
#endif


PFileEntry __stdcall __new_FileEntry( LPWIN32_FIND_DATA pfd, PDirEntry pDir, PScanDirCtx pCtx );
PDirEntry __stdcall __new_DirEntry( LPWIN32_FIND_DATA pfd, PDirEntry pDir, PScanDirCtx pCtx );

//==---------------------------------------------------------------------------

#ifndef USE_FILE_ENTRY_SIZEATTR
#define USE_FILE_ENTRY_SIZEATTR  1  // Define as 0 if not needed (to save RAM).
#endif
#define FILEDIR_NEWALLOC  0  // Use custom new/delete for File/DirEntry

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

#pragma pack( push, 4 )
class FileEntry : public LIST_ENTRY { // x86: 24(44)B + vtbl*, x64: 48(68)B + vtbl*
public:
    CSTR        Name;   
    CSTR        Ext;    
  #if USE_FILE_ENTRY_SIZEATTR // Optional std data (20B)...
    UINT64      Size;   
    DWORD       Attr;   
    FILETIME    Time;   
  #endif

    PDirEntry   pDir;   
    PVOID       pData;  

    // Action callbacks.. Default is NULL.


    static PFnFileAddAction AddAction;  


    static PFnFileAction    DelAction;

    // Constructor/Destructor..

    FileEntry( LPWIN32_FIND_DATA pFd, PDirEntry Dir, PScanDirCtx pCtx = NULL ); 
    FileEntry( CSTR Name, PDirEntry Dir, PScanDirCtx pCtx = NULL ); 

    //+ N.B: The destructor must be virtual to allow polymorphism via NewFileEntry().
    //+ This also means you can't equate (this) and (&Flink), and this is not POD.

    virtual ~FileEntry(); 


    CSTR Rename( CSTR newName );


    UINT GetPathName( TSTR Buffer, UINT BufLen );


    bool GetFindData( LPWIN32_FIND_DATA pData );


    bool RemoveFromParent();


    static bool __stdcall _delete( PLIST_ENTRY Entry, void* pData );

    #if _DEBUG 
    static bool __stdcall _dump( PLIST_ENTRY Entry, void* pData );
    #endif

    #if FILEDIR_NEWALLOC
    void* operator new( size_t nBytes ) { return mem_Alloc( nBytes ); }
    void  operator delete( void* pBlk ) { mem_Free( pBlk ); }
    #endif
protected:
    void _init( CSTR name, PDirEntry dir ); // [internal]
};
#pragma pack( pop )

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

#pragma pack( push, 2 )
struct ScanDirCtx // Treat as opaque (unless you're an expert).
{
    // Control data. Treat as R/O.
    
    UINT NestDepth, MaxNest; 
    WORD Flags;              
    WORD _rsv;               //-- DWord align CurrentDir.
    TCHAR CurrentDir[ MAX_PATH ]; 
    TSTR  PathEnd;           

    // Application data

    PVOID UserData;          

    
    PDLinkList ErrorDirs;    // Disposed by the d'tor.
    
    ScanDirCtx( UINT Depth = 0 ); 
    ~ScanDirCtx();
};
#pragma pack( pop )
#ifdef __DOXYGEN__
typedef struct ScanDirCtx ScanDirCtx; // Agh.. Recursive re-definition :(
#endif

extern ScanDirCtx _defScanCtx; 

#define SCF_FILES   0x0001  
#define SCF_DIRS    0x0002  
#ifndef __DOXYGEN__ // NYI (postponed, complicated ramifications)
#define SCF_SPLIT   0x0004  // TODO: [uLib:FileDir.h] Split composite basedir entries.
#endif

#define MAX_DIRECTORY_DEPTH 256 

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

#pragma pack( push, 4 )
class DirEntry : public LIST_ENTRY { // x86: 28(32)B + vtbl*, x64: 56(60)B + vtbl*
public:

    CSTR        Name;   
  #if USE_FILE_ENTRY_SIZEATTR
    DWORD       Attr;   
  #endif
    PDLinkList  SubDir; 
    PDLinkList  Files;  

    PDirEntry   pParent; 
    PVOID       pData;   

    // Action callbacks., Default is NULL.


    static PFnDirAddAction AddAction;


    static PFnDirAction    DelAction;
    

    static PFnAbortScan    Abort;

    
    static PDirEntry ScanDir(
        CSTR BaseDir,            
        UINT Depth = 0,          
        PDirEntry Parent = NULL, 
        PUINT pCount = NULL,     
        PScanDirCtx pCtx = NULL  
        );

    // Constructor/Destructor..

    DirEntry( LPWIN32_FIND_DATA pFd, PDirEntry pParent = NULL, PScanDirCtx pCtx = NULL ); 
    DirEntry( CSTR name, PDirEntry pParent = NULL, PScanDirCtx pCtx = NULL ); 


    virtual ~DirEntry();


    PDirEntry AddSubDir( CSTR pzDir, PScanDirCtx pCtx );


    PFileEntry AddFile( LPWIN32_FIND_DATA pFd, PScanDirCtx pCtx );


    bool RemoveFromParent();


    UINT GetFullPath( TSTR Buff, UINT BufLen );


    CSTR GetName();


    UINT GetBranchCount();


    UINT GetFileCount();


    UINT64 GetSizeOfFiles();


    UINT64 GetSizeOfBranch();

    
    UINT Scan( PScanDirCtx pCtx ); // The actual scanner.


    static bool __stdcall _delete( PLIST_ENTRY Entry, void* pData );

    #if _DEBUG 
    static bool __stdcall _dump( PLIST_ENTRY Entry, void* pData );
    #endif

    #if FILEDIR_NEWALLOC
    void* operator new( size_t nBytes ) { return mem_Alloc( nBytes ); }
    void  operator delete( void* pBlk ) { mem_Free( pBlk ); }
    #endif

protected:
    void _init( CSTR name, PDirEntry parent );
    static PDirEntry _splitPath( CSTR BaseDir, PDirEntry Parent, PScanDirCtx pCtx );
};
#pragma pack( pop )

#endif//def __cplusplus
#endif//ndef __FileDir_h_incl__
// EOF