cFilePath.h

Go to the documentation of this file.

//
 
#ifndef _INC_cFilePath_H
#define _INC_cFilePath_H
#ifndef NO_PRAGMA_ONCE
#pragma once
#endif
 
#include "cString.h"
#include "FileName.h"
 
namespace Gray
{
        UNITTEST2_PREDEF(cFilePath);
 
        typedef cStringT<FILECHAR_t> cStringF;  
 
        enum FILESYS_TYPE
        {
 
                FILESYS_DEFAULT = 0,    
                FILESYS_FAT,            
                FILESYS_FAT32,          
                FILESYS_NTFS,           
                FILESYS_NFS,            
                FILESYS_QTY,
        };
 
        enum FILECHR_TYPE_
        {
 
                FILECHR_Invalid = 0,    
 
                FILECHR_Device = 0x01,  
                FILECHR_Dirs = 0x02,    
 
                FILECHR_Name = 0x04,    
                FILECHR_Name2 = 0x08,   
                FILECHR_Name3 = 0x10,   
                FILECHR_Ext = 0x20,     
 
                FILECHR_XPath = 0x3E, 
                FILECHR_All = 0x3F,     
 
                FILECHR_Wildcard = 0x40,        
        };
        typedef WORD FILECHR_MASK_t;    
 
        class GRAYCORE_LINK cFilePath : public cStringF
        {
 
        public:
                static const StrLen_t k_MaxLen = _MAX_PATH;     
                static const FILECHAR_t k_DirSep1 = '/';        
                static const FILECHAR_t k_DirSep2 = '\\';       
 
#ifdef _WIN32
                static const FILECHAR_t k_DirSep = '\\';        
#define FILESTR_DirSep          "\\"
#else
                static const FILECHAR_t k_DirSep = '/';         
#define FILESTR_DirSep          "/"
#endif
 
#ifdef _WIN32
                static const FILECHAR_t k_NamePrefix[5];                
#endif
 
        public:
                static inline constexpr bool IsCharDirSep(wchar_t ch) noexcept
                {
                        return ch == k_DirSep1 || ch == k_DirSep2;
                }
                static inline constexpr bool IsCharWildcard(wchar_t ch) noexcept
                {
                        return  ch == '?' || ch == '*';
                }
 
                static FILECHR_TYPE_ GRAYCALL GetFileCharType(wchar_t ch, FILESYS_TYPE eSys = FILESYS_DEFAULT);
                static bool GRAYCALL IsFileNameValid(const FILECHAR_t* pszName, FILECHR_MASK_t uCharMask = FILECHR_All, FILESYS_TYPE eSys = FILESYS_DEFAULT);
                static bool GRAYCALL IsFileNameExt(const FILECHAR_t* pszFileName, const FILECHAR_t* pszExt) noexcept;
                static bool GRAYCALL HasTitleWildcards(const FILECHAR_t* pszPath);
 
                static FILECHAR_t* GRAYCALL GetFileNameExt(const FILECHAR_t* pszName, StrLen_t iLen = k_StrLen_UNK, bool bMultiDot = false);
                static StrLen_t GRAYCALL StripFileExt(FILECHAR_t* pszFile, StrLen_t iLen, bool bMultiDot = false);
                static cStringF GRAYCALL ReplaceFileExt(const FILECHAR_t* pszFilePath, const FILECHAR_t* pszExtNew); // ChangeExtension
                static cStringF GRAYCALL GetNameExtStar(const FILECHAR_t* pszFilePath);
 
                static FILECHAR_t* GRAYCALL GetFileName(const FILECHAR_t* pszPath, StrLen_t iLenPath = k_StrLen_UNK);
                static cStringF GRAYCALL GetFileNameNE(const FILECHAR_t* pszPath, StrLen_t iLenPath = k_StrLen_UNK, bool bMultiDot = false);
 
                static StrLen_t GRAYCALL MakeFileSymbolicName(ATOMCHAR_t* pszOut, const FILECHAR_t* pszPath, const ATOMCHAR_t* pszPrefix = nullptr, ATOMCHAR_t chSub = '_', bool bAllowLeadingNumber = false);
                static cStringA GRAYCALL GetFileSymbolicName(const FILECHAR_t* pszPath, const ATOMCHAR_t* pszPrefix = nullptr, ATOMCHAR_t chSub = '_', bool bAllowLeadingNumber = false);
 
                static StrLen_t GRAYCALL MakeFullPath2(FILECHAR_t* pszFileOut, const FILECHAR_t* pszFileInp, StrLen_t iLenMax, FILECHAR_t chSep = k_DirSep);
                static StrLen_t GRAYCALL MakeFullPath(FILECHAR_t* pszFileOut, const FILECHAR_t* pszFileInp, StrLen_t iLenMax, FILECHAR_t chSep = k_DirSep);
                static cStringF GRAYCALL MakeFullPathX(const FILECHAR_t* pszFileInp, FILECHAR_t chSep = k_DirSep);
 
                static StrLen_t GRAYCALL MakeProperPath(FILECHAR_t* pszFileOut, StrLen_t iLenMax = _MAX_PATH, const FILECHAR_t* pszFileInp = nullptr, FILECHAR_t chSep = k_DirSep);
                static cStringF GRAYCALL MakeProperPathX(const FILECHAR_t* pszFileInp, FILECHAR_t chSep = k_DirSep);
                static StrLen_t GRAYCALL AddFileDirSep(FILECHAR_t* pszOut, StrLen_t iLen = k_StrLen_UNK, FILECHAR_t chSep = k_DirSep);
                static StrLen_t GRAYCALL CombineFilePathA(FILECHAR_t* pszOut, StrLen_t iLenMax, StrLen_t iLen, const FILECHAR_t* pszName, FILECHAR_t chSep = k_DirSep);
                static StrLen_t GRAYCALL CombineFilePath(FILECHAR_t* pszFilePathOut, StrLen_t iLenMax, const FILECHAR_t* pszDir, const FILECHAR_t* pszName, FILECHAR_t chSep = k_DirSep); // .NET Combine
                static cStringF GRAYCALL CombineFilePathX(const FILECHAR_t* pszBase, const FILECHAR_t* pszName, FILECHAR_t chSep = k_DirSep);
                static cStringF _cdecl CombineFilePathF(FILECHAR_t chSep, const FILECHAR_t* pszBase, ...);
 
                static StrLen_t GRAYCALL ExtractDir(FILECHAR_t* pszPath, StrLen_t iLen = k_StrLen_UNK, bool bTrailingSep = true);
                static StrLen_t GRAYCALL ExtractDirCopy(FILECHAR_t* pszDirPath, StrLen_t iLenMax, const FILECHAR_t* pszFilePathSrc, bool bTrailingSep = true);
                static cStringF GRAYCALL GetFileDir(const FILECHAR_t* pszFilePath, bool bTrailingSep = true);
 
                static bool GRAYCALL IsRelativeRoot(const FILECHAR_t* pszFullPath, const FILECHAR_t* pszRootDir, StrLen_t iLen = k_StrLen_UNK);
                static bool GRAYCALL IsRelativePath(const FILECHAR_t* pszFullPath, const FILECHAR_t* pszRelativePath);
                static cStringF GRAYCALL MakeRelativePath(const FILECHAR_t* pszFullPath, const FILECHAR_t* pszRootDir);
 
                static StrLen_t GRAYCALL GetFilePathDeviceLen(const FILECHAR_t* pszNameRoot);
                static bool GRAYCALL IsFileDeviceRemote(const FILECHAR_t* pszPath);
                static bool GRAYCALL IsFilePathRooted(const FILECHAR_t* pszName);       // .NET IsPathRooted
                static bool GRAYCALL IsFilePathRoot(const FILECHAR_t* pszName);
                static bool GRAYCALL IsFilePathTitle(const FILECHAR_t* pszName);
                static bool GRAYCALL HasFilePathRelatives(const FILECHAR_t* pszName, bool bOrDevices = true);
 
                static FILECHAR_t* GRAYCALL SkipRelativePrefix(const FILECHAR_t* pszName);
                static FILECHAR_t* GRAYCALL GetFilePathUpDir2(const FILECHAR_t* pszName, StrLen_t iLen = k_StrLen_UNK, int iQtyDirs = 1);
                static cStringF GRAYCALL GetFilePathUpDir1(const FILECHAR_t* pszName, StrLen_t iLen = k_StrLen_UNK, int iQtyDirs = 1);
                static bool GRAYCALL MakeFilePathUpDir(FILECHAR_t* pszName);
 
                static COMPARE_t GRAYCALL ComparePath(const FILECHAR_t* pszPath1, const FILECHAR_t* pszPath2, StrLen_t iLenMax = _MAX_PATH);
 
#ifdef _WIN32
                static const wchar_t* GRAYCALL MakeFileNameLongW(const FILECHAR_t* pszFilePath);
                static const wchar_t* GRAYCALL GetFileNameLongW(cStringF sFilePath);
                static const wchar_t* GRAYCALL GetFileNameLongW(const FILECHAR_t* pszFileName);
#endif
 
                UNITTEST_FRIEND(cFilePath);
        };
 
};
#endif // _INC_cFilePath_H