FileInfo.h

Go to the documentation of this file.

//! @file FileInfo.h
//! @brief Contains many convenient functions for handling files, paths and give a way to add some custom format support
//!
//////////////////////////////////////////////////////////////////////
 
#if !defined(AFX_FILEINFO_H__12CD9483_C809_11D3_A382_9415BA0D2432__INCLUDED_)
#define AFX_FILEINFO_H__12CD9483_C809_11D3_A382_9415BA0D2432__INCLUDED_
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
#include "xfileoperation.h"
#include "CustomData.h"
 
BEGIN_MOOTOOLS_NAMESPACE
 
class CFileExt;
 
typedef enum IoPluginMode
{
    IO_INIT_PLUGIN, // Allow to add the extension handled by the plugin. data can be cast to IOInitPluginInfo
    IO_GET_PARSER, // Ask the plugin for a given parser send the file class.  data can be cast to IOGetParserInfo
} IoPluginMode;
 
// The exported function for io plugin
typedef bool (*InitIOPluginFunc)(IoPluginMode mode, void *data);
 
#define UNKNOWN_CLASS 0
#define TGA_FILE MAKE_CUSTOM_ID('T', 'G', 'A', ' ')
#define Z_FILE MAKE_CUSTOM_ID('Z', 'F', 'I', 'L')
#define BMP_FILE MAKE_CUSTOM_ID('B', 'M', 'P', ' ')
#define JPEG_FILE MAKE_CUSTOM_ID('J', 'P', 'E', 'G')
#define GIF_FILE MAKE_CUSTOM_ID('G', 'I', 'F', ' ')
#define PNG_FILE MAKE_CUSTOM_ID('P', 'N', 'G', ' ')
#define TIFF_FILE MAKE_CUSTOM_ID('T', 'I', 'F', 'F')
#define ZPIC_FILE MAKE_CUSTOM_ID('Z', 'P', 'I', 'C')
#define PIC_FILE MAKE_CUSTOM_ID('P', 'I', 'C', ' ')
#define RLA_FILE MAKE_CUSTOM_ID('R', 'L', 'A', ' ')
#define IFF_FILE MAKE_CUSTOM_ID('I', 'F', 'F', ' ')
//#define PHOTOSHOP_FILE MAKE_CUSTOM_ID('P', 'H', 'O', 'T')
#define GIF_FILE MAKE_CUSTOM_ID('G', 'I', 'F', ' ')
#define ICON_FILE MAKE_CUSTOM_ID('I', 'C', 'O', 'N')
#define CURSOR_FILE MAKE_CUSTOM_ID('C', 'U', 'R', 'S')
#define HDR_FILE MAKE_CUSTOM_ID('H', 'D', 'R', ' ')
#define FOLDER_CLASS MAKE_CUSTOM_ID('F', 'L', 'D', 'R') // This class refers to a directory
 
#define AMAPI_3D_FILE MAKE_CUSTOM_ID('A', 'M', 'A', 'P')
#define CINEMA4D_3D_FILE MAKE_CUSTOM_ID('C', 'N', '4', 'D')
#define COLLADA_3D_FILE MAKE_CUSTOM_ID('D', 'A', 'E', ' ')
#define DIRECTX_3D_FILE MAKE_CUSTOM_ID('D', 'R', 'T', 'X')
#define DXF_3D_FILE MAKE_CUSTOM_ID('D', 'X', 'F', '4')
#define DXF_FBX_3D_FILE MAKE_CUSTOM_ID('D', 'X', 'F', 'B')
#define INTERNALFORMAT_3D_FILE MAKE_CUSTOM_ID('3', 'D', 'I', 'F')
#define KMZ_3D_FILE MAKE_CUSTOM_ID('K', 'M', 'Z', 'I')
#define LIGHTWAVE_3D_FILE MAKE_CUSTOM_ID('L', 'I', 'G', 'T')
#define LIGHTWAVE_3D_SCENE_FILE MAKE_CUSTOM_ID('L', 'I', 'G', 'S')
#define LXO_3D_FILE MAKE_CUSTOM_ID('L', 'X', 'O', 'I')
#define MAYAASCII_3D_FILE MAKE_CUSTOM_ID('M', 'Y', 'A', 'S')
#define MAYA_3D_FILE MAKE_CUSTOM_ID('M', 'A', 'Y', 'A')
#define SKETCHUP_3D_FILE MAKE_CUSTOM_ID('S', 'K', 'E', 'T')
#define JT_3D_FILE MAKE_CUSTOM_ID('J', 'T', 'K', 'F')
#define KERNELIO_3D_FILE MAKE_CUSTOM_ID('C', 'T', 'K', 'I')
#define STL_3D_FILE MAKE_CUSTOM_ID('S', 'T', 'L', ' ')
#define STUDIO_MAX_3D_FILE MAKE_CUSTOM_ID('3', 'M', 'A', 'X')
#define STUDIO_3D_FILE MAKE_CUSTOM_ID('3', 'D', 'S', 'T')
#define TRUESPACE_3D_FILE MAKE_CUSTOM_ID('T', 'R', 'U', 'E')
#define VRML_3D_FILE MAKE_CUSTOM_ID('V', 'R', 'M', 'L')
#define VRML97_3D_FILE MAKE_CUSTOM_ID('V', 'R', '9', '7')
#define PLY_3D_FILE MAKE_CUSTOM_ID('P', 'L', 'Y', 'Y')
#define WAVEFRONT_3D_FILE MAKE_CUSTOM_ID('W', 'A', 'V', 'F')
#define XSI_3D_FILE MAKE_CUSTOM_ID('X', 'S', 'I', ' ')
#define FBX_3D_FILE MAKE_CUSTOM_ID('F', 'B', 'X', ' ')
#define ALEMBIC_3D_FILE MAKE_CUSTOM_ID('A', 'B', 'C', 'F')
#define MR_3D_FILE MAKE_CUSTOM_ID('P', 'C', 'M', 'R')
#define GLTF_3D_FILE MAKE_CUSTOM_ID('G', 'L', 'T', 'F')
#define BLENDER_3D_FILE MAKE_CUSTOM_ID('B', 'L', 'E', 'N')
 
#define WAV_AUDIO_FILE MAKE_CUSTOM_ID('A', 'I', 'W', 'V')
#define WINMEDIA_AUDIO_FILE MAKE_CUSTOM_ID('A', 'I', 'W', 'M')
#define MAC_AUDIO_FILE MAKE_CUSTOM_ID('A', 'I', 'M', 'C')
#define UNIX_AUDIO_FILE MAKE_CUSTOM_ID('A', 'I', 'U', 'X')
#define MPEG_AUDIO_FILE MAKE_CUSTOM_ID('A', 'I', 'M', 'G')
#define MIDI_FILE MAKE_CUSTOM_ID('M', 'I', 'D', 'I')
#define FLASH_FILE MAKE_CUSTOM_ID('F', 'L', 'A', 'S')
#define HTMLS_FILE MAKE_CUSTOM_ID('I', 'H', 'T', 'M') // Add a S to avoid multiple definition
#define RAWS_FILE MAKE_CUSTOM_ID('R', 'A', 'W', 'S')
#define MOV_FILE MAKE_CUSTOM_ID('M', 'O', 'V', ' ')
#define ZIP_FILE MAKE_CUSTOM_ID('Z', 'I', 'P', ' ')
#define RAR_FILE MAKE_CUSTOM_ID('R', 'A', 'R', ' ')
#define TAR_FILE MAKE_CUSTOM_ID('T', 'A', 'R', ' ')
#define ZIP7_FILE MAKE_CUSTOM_ID('Z', 'I', 'P', '7')
#define GZ_FILE MAKE_CUSTOM_ID('G', 'Z', ' ', ' ')
#define STEGANO_FILE MAKE_CUSTOM_ID('S', 'T', 'E', 'G')
#define PPM_FILE MAKE_CUSTOM_ID('P', 'P', 'M', ' ')
#define AVI_FILE MAKE_CUSTOM_ID('A', 'V', 'I', ' ')
#define MPEG4_FILE MAKE_CUSTOM_ID('M', 'P', 'G', '4') // Not supported but considered as image file
#define FLV_FILE MAKE_CUSTOM_ID('F', 'L', 'V', ' ') // Not supported but considered as image file
#define WMV_FILE MAKE_CUSTOM_ID('W', 'M', 'V', ' ') // Not supported but considered as image file
#define ALL_FILE_CLASS MAKE_CUSTOM_ID('A', 'L', 'L', 'F')
 
#define PLUGIN_PARSER MAKE_CUSTOM_ID('P', 'L', 'G', 'P')
#define MOOTOOLS_PARSER MAKE_CUSTOM_ID('M', 'O', 'O', 'T')
#define CALLBACK_PARSER MAKE_CUSTOM_ID('C', 'A', 'L', 'K')
#define MAGICK_PARSER MAKE_CUSTOM_ID('M', 'A', 'G', 'I')
#define UNKNOWN_PARSER MAKE_CUSTOM_ID('U', 'N', 'K', 'N') // can be used to add file readed/saved using another method than plugin or internal parsers.
 
// File type : import/export possibility, type of the file
// PRIVATE_FILE can be read but are not proposed to the user
// (they are read with an other file type)
 
//! @name File format properties and kind of file
//! @anchor FILEPROP
//! @brief Macros that define properties for a given extension
//! @{
#define UNKNOWN_PROPERTIES 0x00
#define IMPORT_FILE 0x01
#define EXPORT_FILE 0x02
#define PRIVATE_IMPORT_FILE 0x04
#define PRIVATE_EXPORT_FILE 0x08
#define COMMON_EXTENSION_FILE 0x10
#define LOAD_HAS_DIALOG 0x20
#define LOAD_NEED_DIALOG 0x40
#define SAVE_HAS_DIALOG 0x80
#define SAVE_NEED_DIALOG 0x100
#define FORCE_DISPLAY_FILE 0x200 // a flag use to display an extension (CCustomFileDialog)
#define ONE_SHOT_FORMAT 0x400 // the format is read or saved completely in a single time (ie, an animation can't be saved frame by frame)
#define MAIN_FORMAT_PARSER 0x800 // if multiple parser exist, this specified which should be the first to use
 
#define KIND_OF_FILE            0xFFFFF000
#define UNKNOWN_KIND_OF_FILE    0x00
#define BITMAP_FILE             0x00001000
#define ANIMATED_BITMAP_FILE    0x00002000 // It have animation (must be combinated with BITMAP_FILE)
#define OBJECT_FILE             0x00004000
#define SOUND_FILE              0x00008000
#define VIDEO_FILE              0x00010000
#define WWW_FILE                0x00020000
#define COMPRESSED_FILE         0x00040000
#define GENERAL_FILE            0x00080000
#define FOLDER_FILE             0x00100000
#define LAST_KIND_OF FOLDER_FILE // Note the last KIND OF FILE => can be used for anything else
 
#define ALL_KIND_OF_FILES (KIND_OF_FILE)
#define MULTIMEDIA_FILES (BITMAP_FILE|ANIMATED_BITMAP_FILE|OBJECT_FILE|SOUND_FILE|VIDEO_FILE)
 
//! @}
 
//! @class CFileNameSpec
//! 
//! @brief A given extension may match several formats.
//! In case of conflict CFileNameSpec is a way to indicate that a given file name matches a specified file class.\n
//! CFileNameSpec(filename) simply construct a filename without specifying which is its class.\n
//! In that case, the SDK will choose the appropriate parser based an the extension.\n
//! If loading fails, a try will be done using the next available parser, and so on.
class DLL_TOOLSFUNCTION CFileNameSpec
{
protected:
    CXString filename;
    unsigned int fileclass;
    // This allow to know if the user define the class itself, or if a default class has been selected.
    // If default class selected, several parser will be tested to read the file if several parser exists for the same ext
    mutable bool defaultClassSelected;
 
public:
    CFileNameSpec();
    CFileNameSpec(const CXString& filename, unsigned int fileclass = UNKNOWN_CLASS);
    CFileNameSpec(LPCTSTR filename, unsigned int fileclass = UNKNOWN_CLASS);
    bool IsSameFile(const CFileNameSpec& spec) const;
    bool IsDefaultParserChoice() const { return defaultClassSelected; }
    operator LPCTSTR() const;
    operator const CXString&() const;
    void operator=(const CXString& filename);
    unsigned int GetClass() const;
    void SetClass(unsigned int newclass);
    const CXString& GetFileName() const;
};
 
//! @class CFileExt
//! @brief CFileExt is the class that allows to add a custom file parser for supporting a new file format.
//! You have to give a specific class identifier, provide the format extensions, the read/write capabilities of the parser...
class DLL_TOOLSFUNCTION CFileExt
{
public:
    CXString description;
    CXString ext;
    unsigned int fileclass; //!< A tag created with MAKE_CUSTOM_ID
    unsigned int properties; //!< flags that tells about the type and the content of the file  Cf. @ref FILEPROP
    //! Specify what is the loader of the file: MOOTOOLS_PARSER, PLUGIN_PARSER, CALLBACK_PARSER or something else (ie. ImageMagick).\n
    //! MOOTOOLS_PARSER is internal. The only allowed value are:\n
    //! PLUGIN_PARSER when extension registered from a DLL. Such dll have .moox extension and contains an exported function bool Init3DParser(IoPluginMode mode, void *data) that declares extension handled by the plugin. When loaded, such the SDK call IO_INIT_PLUGIN to get information of the handled extensions. Then this function will be called with IoPluginMode = IO_GET_PARSER each time the extension (associated to the file class you define) is asked to be read/write.\n
    //! CALLBACK_PARSER, when you add extension using a callback function. You have to call fileRegisterFile and set iocallback to a function that have the following type: bool Your_Callback(IoPluginMode mode, void *data). This function will be called with IoPluginMode = IO_GET_PARSER each time the extension (associated to the file class you define) is asked to be read/write.\n
    unsigned int loader;
    unsigned int saver; //!< Inform about the file saver: MOOTOOLS_PARSER, PLUGIN_PARSER, CALLBACK_PARSER or something else (ie. ImageMagick).
    InitIOPluginFunc iocallback; //!< The function which allows to create parser
 
    CFileExt()
    {
        Init();
    }
 
    void Init()
    {
        description.Empty();
        ext.Empty();
        fileclass = UNKNOWN_CLASS;
        properties = UNKNOWN_PROPERTIES;
        loader = UNKNOWN_PARSER;
        saver = UNKNOWN_PARSER;
        iocallback = NULL;
    }
 
    CXString GetDescription() const { return CXString(description); }
    CXString GetExtension() const { return CXString(ext); }
    unsigned int GetClass() const { return fileclass; }
    unsigned int GetProperties() const { return (properties); } // Must return the whole value (many calls made try on both kindof and additional properties
    unsigned int GetKindOf() const { return (properties & KIND_OF_FILE); }
    unsigned int GetLoader() const { return loader; }
    unsigned int GetSaver() const { return saver; }
};
 
typedef enum DirCompare
{
    DIFFERENT_DIRECTORY = 0,
    SAME_DIRECTORY,
    DIR1_IN_DIR2_DIRECTORY,
    DIR2_IN_DIR1_DIRECTORY,
} DirCompare;
 
typedef enum FileValidateNameMode
{
    FILEVALIDATE_DEFAULT = 0,
    FILEVALIDATE_FILENAME = 0x01, // Checking that name part of the provided filepath contains valid characters
    FILEVALIDATE_DIRECTORY = 0x02, // Checking that directory part of the provided filepath contains valid characters, and refers to a valid disk
    FILEVALIDATE_PATH = FILEVALIDATE_FILENAME|FILEVALIDATE_DIRECTORY, // Checking the directory part of the provided filepath
    FILEVALIDATE_CAN_BE_RELATIVE = 0x04, // Allow the directory part to be relative
    FILEVALIDATE_ALLOW_EMPTY_NAME = 0x08, // Allow an empty name
    FILEVALIDATE_FILENAME_ONLY = 0x10, // the provided path must only be a filename with path part (include FILEVALIDATE_FILENAME)
    FILEVALIDATE_QUIET = 0x20, // Don't display a message
} FileValidateNameMode;
 
typedef enum FileCheckAccessFlag
{
    FILE_CHECK_READ = 0x01,
    FILE_CHECK_WRITE = 0x02,
    FILE_CHECK_SHARED_READ = 0x04,
    FILE_CHECK_SHARED_WRITE = 0x08,
    FILE_CHECK_CREATE = 0x10,
    FILE_CHECK_SHARED_CREATE = FILE_CHECK_CREATE|FILE_CHECK_SHARED_READ|FILE_CHECK_SHARED_WRITE,
} FileCheckAccessFlag;
 
//! @enum FILENAME_TYPE
//! Allows to define what kind of file a filename is.
typedef enum FILENAME_TYPE
{
    FILENAME_UNKNOWN = 0,
    FILENAME_IS_A_FILE,
    FILENAME_IS_A_DIRECTORY,
    FILENAME_IS_A_NETWORK_FILE,
    FILENAME_IS_IN_ZIP,
    FILENAME_IS_AN_URL,
} FILENAME_TYPE;
 
void fileRegisterFiles(); //!< Automatically call to make all recognized by being registered and recognized.
void fileUnregisterFiles();
 
#define IOTIMEOUT_ALWAYS_USE (0x80000000) // Make the timeout being used whatever the file
#define IOTIMEOUT_DEFAULT 750 // A default timeout value
#define IOTIMEOUT_OCCURED ((unsigned int)-1)
 
DLL_TOOLSFUNCTION void fileRegisterFile(CFileExt& fileinfo);
DLL_TOOLSFUNCTION void fileUnregisterFile(unsigned int fileClass, unsigned int flags);
DLL_TOOLSFUNCTION CFileExt *fileGetRegisteredFiles(unsigned int& size, unsigned int filter = 0);
DLL_TOOLSFUNCTION void fileFreeRegisteredFiles(CFileExt *files, unsigned int size);
 
DLL_TOOLSFUNCTION CXString fileCompactPath(const CXString& path, int charNbr = 15);
DLL_TOOLSFUNCTION bool fileIsPathRelative(const CXString& mainpath);
DLL_TOOLSFUNCTION CXString fileMakeRelativePath(const CXString& mainpath, const CXString& relpath, bool noSlashAndDotAtBeginning = false, FILENAME_TYPE type = FILENAME_UNKNOWN); //!< noSlashAndDotAtBeginning = false will return .\folder\filename.ext, noSlashAndDotAtBeginning = true will return folder\filename.ext
DLL_TOOLSFUNCTION CXString fileMakeAbsolutePath(const CXString& mainpath, const CXString& relpath, bool slashTerminate = false); //!< if relpath is relative, it returns an absolute path using mainpath. If relpath is not relative or if creating absolute path fails, it return relpath. if slashTerminate set, a slash is added, which implies that the return result is used as a directory
DLL_TOOLSFUNCTION bool fileMakePathShortest(CXString& path); //!< Converts C:\abc\..\abc\file.txt to C:\abc\file.txt if possible or uneeded, path is not changed if conversion fails (C:/../file.txt)
DLL_TOOLSFUNCTION CXString fileGetCurrentDirectory();
DLL_TOOLSFUNCTION bool filePushCurrentDirectory(const CXString& newpath, unsigned int *timeOut = NULL); //!< return true if directory change is a success. Whatever the results, filePopCurrentDirectory must always be called.
DLL_TOOLSFUNCTION bool filePopCurrentDirectory(); //!< pop the latest push current directory
DLL_TOOLSFUNCTION bool fileDirectoryExists(const CXString& filename, unsigned int* timeOut = NULL);
DLL_TOOLSFUNCTION bool fileExists(const CXString& filename, unsigned int *timeOut = NULL); //!< Accessing file can take time. specify timeOut if critical (ie access through network). If timeout reach, the function return false. 
DLL_TOOLSFUNCTION bool fileCheckAccess(const CXString& filename, unsigned int flags);
DLL_TOOLSFUNCTION bool fileGetCreationDate(const CXString& filename, CXTime& time);
DLL_TOOLSFUNCTION bool fileSetCreationDate(const CXString& filename, const CXTime& time);
DLL_TOOLSFUNCTION bool fileGetLastWriteDate(const CXString& filename, CXTime& time);
DLL_TOOLSFUNCTION bool fileSetLastWriteDate(const CXString& filename, const CXTime& time);
DLL_TOOLSFUNCTION fileuint fileGetSize(const CXString& filename);
DLL_TOOLSFUNCTION bool fileConvertSlash(CXString& dir); //!< Make slash OS compatible
DLL_TOOLSFUNCTION void fileRemoveDuplicatedSlash(CXString& path);
DLL_TOOLSFUNCTION void fileSlashTerminate(CXString& dir);
DLL_TOOLSFUNCTION bool fileIsSlashTerminated(const CXString& path);
DLL_TOOLSFUNCTION void fileRemoveSlashTermination(CXString& filenameWithoutExt);
DLL_TOOLSFUNCTION void fileRemoveInvalidChar(CXString& path, char spaceReplace = ' '); //!< Remove any invalid character for a filename <>:"/\|?* and eventually replaces space without something else
DLL_TOOLSFUNCTION bool fileGetCInfo(const CXString& filename, unsigned int& checksum1, unsigned int& checksum2, bool alert = FALSE);
DLL_TOOLSFUNCTION bool fileIsDirectory(const CXString& filename, bool checkIfExists = FALSE, unsigned int* timeOut = NULL);
DLL_TOOLSFUNCTION bool fileIsValidFileName(const CXString& filename, unsigned int checkMode);
DLL_TOOLSFUNCTION DirCompare fileCompareDirectory(CXString dir1, CXString dir2);
DLL_TOOLSFUNCTION bool fileIsSameFile(const CXString& file1, const CXString& file2);
DLL_TOOLSFUNCTION bool fileIsSameDir(const CXString& file1, const CXString& file2);
DLL_TOOLSFUNCTION bool filePathContainMatchingFile(const CXString& path, const CXString& pattern, xFileFindInfo *info = NULL, unsigned int* timeOut = NULL); //!< Fast check if matchin file exist in path
DLL_TOOLSFUNCTION bool fileMatchWilcards(const CXString& reffilename, const CHashTable<CXString>& hashMap);
DLL_TOOLSFUNCTION bool fileMatchWilcards(const CXString& filename, const CXString& pattern, bool caseSensitive);
DLL_TOOLSFUNCTION CXString fileCutName(const CXString& filename, int maxNameSize = -1); //!< name couldn't be lower than 8 characters (without extension).
DLL_TOOLSFUNCTION CXString fileRemoveNameDigitEnding(const CXString& filename, int& value); //!< Remove the final name digit if any. Return the digit value or -1 if no digit is present
DLL_TOOLSFUNCTION CXString fileNextNumberedName(const CXString& filename, bool parenthesisFormat = true, int namesize = -1); //!< Given a filename, it returns the next numbered filename without checking if the file exists or not. It example.jpg will return example1.jpg
DLL_TOOLSFUNCTION CXString fileCreateUniqueName(const CXString& filename, bool parenthesisFormat = true, int namesize = -1); //!< the name is truncated if namesize > 0
DLL_TOOLSFUNCTION CXString fileCreateTmpName(const CXString& filename, bool allowUnicode = true);
DLL_TOOLSFUNCTION bool fileIsUNCPath(const CXString& filename);
DLL_TOOLSFUNCTION CXString fileGetRoot(const CXString& filename);
DLL_TOOLSFUNCTION CXString fileGetTopDirectory(const CXString& filename, bool slashTerminate = false);
DLL_TOOLSFUNCTION CXString fileStripPath(const CXString& filename, bool removeExtension = false);
DLL_TOOLSFUNCTION CXString fileStripName(const CXString& filename);
DLL_TOOLSFUNCTION CXString fileStripPathAndExtension(const CXString& filename);
DLL_TOOLSFUNCTION CXString fileRemoveExtension(const CXString& filename);
DLL_TOOLSFUNCTION CXString fileGetExtension(const CXString& filename);
DLL_TOOLSFUNCTION bool fileGetParentDirectory(CXString& path); //!< Retrieve the parent directory of the provided directory (C:\\tmp1\\tmp2\\ return C:\\tmp1). If the path target a file, returns the parent directory of the file directory (C:\\tmp1\\tmp2\\file.txt return C:\\tmp1\\‍)
DLL_TOOLSFUNCTION CXString fileCleanExtensionList(const CXString& extlist, bool extByDefault = TRUE, CHashTable<CXString> *hashMap = NULL);
DLL_TOOLSFUNCTION int fileGetHashFromExtensionList(CXString& extlist, CHashTable<CXString>& hash, bool extByDefault = TRUE);
DLL_TOOLSFUNCTION bool fileGetExtensionInfo(unsigned int type, CFileExt& fileinfo);
DLL_TOOLSFUNCTION int fileGetExtensionArray(unsigned int fileclass, CXStringArray& array, bool addAsterisk = FALSE);
DLL_TOOLSFUNCTION CXString fileGetMainExtension(unsigned int fileclass);
DLL_TOOLSFUNCTION CXString fileGetMainExtension(const CXString& ext);
DLL_TOOLSFUNCTION int fileGetExtensionArrayByProperty(unsigned int fileproperty, CXStringArray& array, bool addAsterisk = FALSE, bool onlyMain = FALSE);
DLL_TOOLSFUNCTION bool fileGetFileExt(const CXString& extension, CFileExt& info);
DLL_TOOLSFUNCTION unsigned int fileFindParser(const CXString& filename, unsigned int properties);
DLL_TOOLSFUNCTION unsigned int fileGetProperties(const CXString& filename);
DLL_TOOLSFUNCTION unsigned int fileGetClass(const CXString& filename);
DLL_TOOLSFUNCTION unsigned int fileGetKindOf(const CXString& filename);
DLL_TOOLSFUNCTION unsigned int fileGetProperties(unsigned int fileclass);
DLL_TOOLSFUNCTION unsigned int fileGetKindOf(unsigned int fileclass);
DLL_TOOLSFUNCTION unsigned int fileGetLoader(const CXString& filename);
DLL_TOOLSFUNCTION unsigned int fileGetSaver(const CXString& filename);
 
// Simple file operation
DLL_TOOLSFUNCTION bool fileDelete(const CXString& filename);
DLL_TOOLSFUNCTION bool fileCopy(const CXString& srcfile, const CXString& newfile, bool dontOverwrite = true);
DLL_TOOLSFUNCTION bool fileRename(const CXString& srcfile, const CXString& dstfile);
DLL_TOOLSFUNCTION bool fileCreateDirectory(const CXString& dir, bool recurseCreate);
DLL_TOOLSFUNCTION bool fileRemoveDirectory(const CXString& dir, bool recurse, bool evenIfNotEmpty, CXStringArray *excludeExt = NULL);
DLL_TOOLSFUNCTION int fileGetFileCount(const CXString& dir, bool recurse);
DLL_TOOLSFUNCTION CXString fileCreateTmpFolder(const CXString& foldername, bool createFolder = true);
 
#ifndef MOOTOOLS_NO_UI
DLL_TOOLSFUNCTION CXString fileCompactPath(const CXString& path, CXWnd *pWnd, int width = 0);
DLL_TOOLSFUNCTION bool fileAskForReplace(const CXString& filename);
#endif
 
#if !defined(MOOTOOLS_CRUNCHERSDK) && !defined(MRSDK_USE)
DLL_TOOLSFUNCTION bool fileIsShortcut(const CXString& filename);
DLL_TOOLSFUNCTION unsigned int fileGetDriveType(const CXString& filename);
DLL_TOOLSFUNCTION bool fileIsOnNetworkDrive(const CXString& filename);
DLL_TOOLSFUNCTION bool fileIsExecutable(const CXString& filename);
DLL_TOOLSFUNCTION bool fileConvertToUNCPath(const CXString& path, CXString& uncPath);
#endif
 
#ifdef __WINDOWS__
typedef enum IoTimeOut
{
    IOTIMEOUT_CREATE,                   // timeOutData is an opaque pointer that should be passed when call START/STOP/DELETE
    IOTIMEOUT_CREATE_AND_ALWAYS_USE,    // timeOutData is an opaque pointer that should be passed when call START/STOP/DELETE
    IOTIMEOUT_START,
    IOTIMEOUT_STOP,
    IOTIMEOUT_DELETE,
} IoTimeOut;
 
DLL_TOOLSFUNCTION bool fileTimeOut(IoTimeOut operation, void *&timeOutData, const CXString *path = NULL, unsigned int timeOutDelay = IOTIMEOUT_DEFAULT);
#endif
 
//! @class CFileInfo
//! @brief A convenient class to get some information giving a specific file name through a CFileNameSpec object
class DLL_TOOLSFUNCTION CFileInfo  
{
protected:
    CXString filename;  // original file name (lower case)
    CXString sfilename;  // cased sensitive original file name
    CXString name;      // short file name
    CXString path;      // path only
    CXString query;     // url parameters
    CXString extension; // extension only
    CXString root;      // root if exists (\\COMPUTER1, C:\\‍)
    CXString targetPath; // shortcut path
 
    unsigned int loader;
    unsigned int saver;
    unsigned int fileclass;
    unsigned int properties;
    InitIOPluginFunc iocallback;
    
protected:
    typedef enum _FileInfoFlags
    {
        FILEINFO_NONE = 0x00,
        FILEINFO_IS_DIRECTORY = 0x01,
        FILEINFO_IS_UNC_FILE = 0x02,
        FILEINFO_IS_SHORTCUT = 0x04,
        FILEINFO_IS_URL = 0x08,
 
        // Initialization flags
        FILEINFO_DIRECTORY_CHECKED = 0x1000,
        FILEINFO_UNC_FILE_CHECKED = 0x2000,
        FILEINFO_SHORTCUT_CHECKED = 0x4000,
        FILEINFO_IGNORE_CURRENT_DIRECTORY = 0x8000,
        FILEINFO_TRY_OTHER_PARSER = 0x10000, // The user does not specify a specific class and there is several parser for the extension
 
        // Others
        FILEINFO_MULTI_PARSER_EXT = 0x100000, // The different parsers exist for the extension
    } FileInfoFlags;
 
    unsigned int currentParser;
    unsigned int flags;
    int reverseDot, reverseSlash, reverseQuestionMark;
    int length;
 
    void ExtractQuery();
    void ExtractRoot();
    void ExtractName();
    void ExtractPath();
    void ExtractExtension();
 
public:
    CFileInfo();
    virtual ~CFileInfo();
 
//  void Init(const CXString& filename, FILENAME_TYPE type = FILENAME_UNKNOWN); // Retrieve info about a file
    void Init(const CFileNameSpec& filepec, FILENAME_TYPE type = FILENAME_UNKNOWN); //!< Retrieve info about a file giving a CFileNameSpec. If known type can be provided to resolve some name ambiguities (if path is relative for example)
 
    CXString GetCompleteName() const;   //!< Return filename (path included)
    CXString GetName() const;   //!< Return filename (without path)
    CXString GetPath() const;   //!< Return path
    CXString GetRoot() const;   //!< Return root
    CXString GetExtension() const;  //!< Return extension
    CXString GetNameWithoutExt() const; //!< Return filename (without path and extension)
    CXString GetPathWithoutRoot() const; //!< Return path without root
    CXString GetQuery(bool includeQuestionMark = true) const; //!< Return query if path is an url. includeQuestionMark keeps the ? unless no query is specified 
    unsigned int GetParserNbr() const; //!< Return the parser number for the extension
 
    bool CanTryAnotherParser() const;
    void TryNextParser();
    unsigned int GetLoader() const; //!< Return loader of file
    unsigned int GetSaver() const; //!< Return saver of file
    unsigned int GetProperties() const; //!< Return type of file
    unsigned int GetKindOf() const; //!< Return kind of file
    unsigned int GetClass() const; //!< Return type file class
    InitIOPluginFunc GetInitIoCallback(); //!< Return the parser initializer function if parser is added at runtime. It can be located in a plugin (moox extension that export or define as a callback
 
#if !defined(MOOTOOLS_CRUNCHERSDK) && !defined(MRSDK_USE)
    bool IsShortcut(); //!< Is the file a shortcut?
    CXString ResolveShortcut(); //!< Resolve file shortcut
#endif
 
    bool IsFile() const; //!< Is the filename a file?
    bool IsURL() const; //!< Is the filename an URL? Note: An URL can also be a directory or a file.
    bool IsDirectory() const; //!< Is the filename a directory?
    bool IsUNCPath(); //!< Is the file on network?
    CXString GetTopDirectory() const;   //!< Return the directory name which contain the file
    CXString GetParentDirectory() const;    //!< Return the parent directory path
    int GetDigitInfo(CXString& dstname, CXString& digitstring, bool addWildcard = false, bool endDigitOnly = false) const; //!< Return the digit value of the file, the name without digit, and the digit string. If several digit exists, first look at the end of the string, then the beginning. begaddWildcard = true, then * replace the digit. endDigitOnly, only care digit which are at the end of the string (not the beginning, if some exists)
    static int GetDigit(const CXString& filename); //!< Return the digit value of the file, the name without digit, and the digit string
 
    bool IsSameFile(const CXString& filename) const;
    bool IsSameDir(const CXString& cmpfilename) const;
 
#ifdef _DEBUG
    void Dump();
#endif
};
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(AFX_FILEINFO_H__12CD9483_C809_11D3_A382_9415BA0D2432__INCLUDED_)