filesys.hpp

浏览该文件的文档.

#ifndef __FILESYS_HPP__
#define __FILESYS_HPP__
//
// filesys 文件系统相关的功能
//

#if defined(_MSC_VER) || defined(WIN32)

#else
//#include <dirent.h> // opendir(), readdir()
#include <glob.h>   // glob()
#endif

namespace winux
{
// 特殊平台变量 -------------------------------------------------------------
String const DirSep_WIN = $T("\\"); 
String const LineSep_WIN = $T("\r\n"); 
String const PathEnvSep_WIN = $T(";"); 
String const DirSep_UNIX = $T("/"); 
String const LineSep_UNIX = $T("\n"); 
String const PathEnvSep_UNIX = $T(":"); 
String const DirSep_DARWIN = $T("/"); 
String const LineSep_DARWIN = $T("\r"); 
String const PathEnvSep_DARWIN = $T(":"); 

#if defined(OS_WIN)
String const DirSep = $T("\\"); 
String const LineSep = $T("\r\n"); 
String const PathEnvSep = $T(";"); 
#elif defined(OS_DARWIN)
String const DirSep = $T("/"); 
String const LineSep = $T("\r"); 
String const PathEnvSep = $T(":"); 
#else
String const DirSep = $T("/"); 
String const LineSep = $T("\n"); 
String const PathEnvSep = $T(":"); 
#endif

WINUX_FUNC_DECL(String) GetExecutablePath( void );

WINUX_FUNC_DECL(String) FilePath( String const & fullPath, String * fileName = NULL );

WINUX_FUNC_DECL(String) FileTitle( String const & fileName, String * extName = NULL );

WINUX_FUNC_DECL(bool) IsAbsPath( String const & path );

WINUX_FUNC_DECL(String) NormalizePath( String const & path );

WINUX_FUNC_DECL(String) RealPath( String const & path );

WINUX_FUNC_DECL(String) RealPathEx( String const & path, String const & workDirAbsPath );

WINUX_FUNC_DECL(String) GetCurrentDir( void );

WINUX_FUNC_DECL(bool) SetCurrentDir( String const & path );

WINUX_FUNC_DECL(bool) IsDir( String const & path );

WINUX_FUNC_DECL(bool) DetectPath( String const & path, bool * isDir = NULL );

WINUX_FUNC_DECL(uint64) FileSize( String const & filename );

WINUX_FUNC_DECL(bool) FileTime( String const & filename, time_t * ctime, time_t * mtime, time_t * atime );
WINUX_FUNC_DECL(time_t) FileCTime( String const & filename );
WINUX_FUNC_DECL(time_t) FileMTime( String const & filename );
WINUX_FUNC_DECL(time_t) FileATime( String const & filename );

WINUX_FUNC_DECL(bool) FileTouch( String const & filename, time_t time = (time_t)-1, time_t atime = (time_t)-1 );

WINUX_FUNC_DECL(String) PathWithSep( String const & path );
WINUX_FUNC_DECL(String) PathNoSep( String const & path );
WINUX_FUNC_DECL(String &) PathWithSep( String * path );
WINUX_FUNC_DECL(String &) PathNoSep( String * path );

WINUX_FUNC_DECL(String) CombinePath( String const & dirPath, String const & fileName );

WINUX_FUNC_DECL(void) FolderData( String const & path, StringArray * fileArr, StringArray * subFolderArr, int sortType = 0 );

WINUX_FUNC_DECL(size_t) EnumFiles( String const & path, Mixed const & ext, StringArray * arrFiles, bool isRecursive = false );

WINUX_FUNC_DECL(bool) UnlinkFile( String const & filePath );

WINUX_FUNC_DECL(bool) RemoveDir( String const & dirPath );

WINUX_FUNC_DECL(bool) RemovePath( String const & path );

WINUX_FUNC_DECL(bool) RenamePath( String const & oldPath, String const & newPath );

WINUX_FUNC_DECL(size_t) CommonDelete( String const & path );

WINUX_FUNC_DECL(bool) MakeDirExists( String const & path, int mode = 0755 );


enum FileEncoding
{
    feUnspec,       
    feMultiByte,    
    feUtf8,         
    feUtf8Bom,      
    feUtf16Le,      
    feUtf16Be,      
    feUtf16 = feUtf16Be,    
    feUtf32Le,      
    feUtf32Be,      
    feUtf32 = feUtf32Be     
};

WINUX_FUNC_DECL(FileEncoding) RecognizeFileEncoding( winux::Buffer const & content, size_t * pIndex, size_t limitSize = -1 );

template < typename _ChTy >
XString<_ChTy> NewlineFromFile( _ChTy const * content, size_t len, bool b );
template <>
WINUX_FUNC_DECL(XString<char>) NewlineFromFile( char const * content, size_t len, bool b );
template <>
WINUX_FUNC_DECL(XString<wchar>) NewlineFromFile( wchar const * content, size_t len, bool b );
template <>
WINUX_FUNC_DECL(XString<char16>) NewlineFromFile( char16 const * content, size_t len, bool b );
template <>
WINUX_FUNC_DECL(XString<char32>) NewlineFromFile( char32 const * content, size_t len, bool b );

template < typename _ChTy >
XString<_ChTy> NewlineToFile( _ChTy const * content, size_t len, bool b );
template <>
WINUX_FUNC_DECL(XString<char>) NewlineToFile( char const * content, size_t len, bool b );
template <>
WINUX_FUNC_DECL(XString<wchar>) NewlineToFile( wchar const * content, size_t len, bool b );
template <>
WINUX_FUNC_DECL(XString<char16>) NewlineToFile( char16 const * content, size_t len, bool b );
template <>
WINUX_FUNC_DECL(XString<char32>) NewlineToFile( char32 const * content, size_t len, bool b );

WINUX_FUNC_DECL(String) FileGetString( String const & filename, FileEncoding encoding = feMultiByte );

WINUX_FUNC_DECL(AnsiString) FileGetContents( String const & filename, bool textMode = true );

WINUX_FUNC_DECL(Buffer) FileGetContentsEx( String const & filename, bool textMode );

WINUX_FUNC_DECL(bool) FilePutString( String const & filename, String const & content, FileEncoding encoding = feMultiByte );

WINUX_FUNC_DECL(bool) FilePutContents( String const & filename, AnsiString const & content, bool textMode = true );

WINUX_FUNC_DECL(bool) FilePutContentsEx( String const & filename, Buffer const & content, bool textMode );

WINUX_FUNC_DECL(String) BackupFile( String const & filePath, String const & bakDir = $T(""), String const & fmt = $T("%f_v%v%E") );


class FileSysError : public Error
{
public:
    enum
    {
        fseNone, 
        fseNotImplemented, 
        fseNotFound, 
        fsePermissionDenied, 
        fseInvalidArgument, 
    };
    FileSysError( int errType, AnsiString const & s ) throw() : Error( errType, s ) { }
};

class WINUX_DLL DirIterator
{
public:
    DirIterator( String const & path, String const & pattern = $T("*") );
    ~DirIterator();
    String const & getPath() const { return _path; }
    String const & getName() const { return _name; }
    String getFullPath() const;
    String getRealPath() const;
    bool isDir() const;
    bool next();

private:
    String _path;
    String _name;
#if defined(_MSC_VER) || defined(WIN32)
    WIN32_FIND_DATA _wfd;
    SimpleHandle<HANDLE> _findFile;
    bool _first;
#else
    #if defined(__USE_LARGEFILE64)
    glob64_t _findFile;
    #else
    glob_t _findFile;
    #endif
    size_t _curr;
#endif

    DISABLE_OBJECT_COPY(DirIterator)
};

enum SeekType
{
    seekSet = 0, 
    seekCur = 1, 
    seekEnd = 2  
};

interface WINUX_DLL IFile
{
    virtual ~IFile() { }

    virtual bool open( String const & filename, String const & mode );
    virtual bool close();
    virtual size_t read( void * buf, size_t size );
    Buffer read( size_t size );
    template < typename _PodType >
    bool readType( _PodType * data, size_t size = sizeof(_PodType) )
    {
        return this->read( data, size ) == size;
    }
    template < typename _PodType >
    _PodType readType( size_t size = sizeof(_PodType) )
    {
        _PodType data;
        this->readType( &data, size );
        return data;
    }
    virtual size_t write( void const * data, size_t size );
    size_t write( Buffer const & buf );
    template < typename _PodType >
    bool writeType( _PodType const & data, size_t size = sizeof(_PodType) )
    {
        return this->write( &data, size ) == size;
    }
    virtual bool rewind();
    virtual bool seek( offset_t offset, SeekType origin = seekSet );
    virtual size_t tell();
    virtual String getLine();
    virtual int puts( String const & str );
    virtual bool eof();
    virtual size_t size();
    virtual Buffer buffer( bool isPeek = true );
    String entire( FileEncoding encoding = feMultiByte, bool convertNewline = false );
};

class WINUX_DLL MemoryFile : public IFile
{
public:
    MemoryFile();
    MemoryFile( void const * data, size_t size, bool isPeek = false );
    MemoryFile( Buffer const & buf, bool isPeek = false );
    MemoryFile( AnsiString const & content, bool isPeek = false );

    virtual bool open( String const & content, String const & mode = Literal<String::value_type>::nulStr ) override;
    virtual bool close() override;
    virtual size_t read( void * buf, size_t size ) override;
    virtual size_t write( void const * data, size_t size ) override;
    virtual bool rewind() override;
    virtual bool seek( offset_t offset, SeekType origin = seekSet ) override;
    virtual size_t tell() override;
    virtual String getLine() override;
    virtual int puts( String const & str ) override;
    virtual bool eof() override;
    virtual size_t size() override;
    virtual Buffer buffer( bool isPeek = true ) override;

    using IFile::read;
    using IFile::write;

protected:
    GrowBuffer _buf;
    winux::byte * _p;

    DISABLE_OBJECT_COPY(MemoryFile)
};

class WINUX_DLL File : public IFile
{
public:
    File();
    File( String const & filename, String const & mode );
    virtual ~File();

    virtual bool open( String const & filename, String const & mode ) override;
    virtual bool close() override;
    virtual size_t read( void * buf, size_t size ) override;
    virtual size_t write( void const * data, size_t size ) override;
    virtual bool rewind() override;
    virtual bool seek( offset_t offset, SeekType origin = seekSet ) override;
    virtual size_t tell() override;
    virtual String getLine() override;
    virtual bool eof() override;
    virtual size_t size() override;
    virtual Buffer buffer( bool isPeek = true ) override;

    using IFile::read;
    using IFile::write;

    FILE * get() const { return _fp; }

    int getFd() const;

    #if defined(OS_WIN)

    HANDLE getOsHandle() const;
    #else

    int getOsHandle() const;
    #endif

    operator bool() const { return _fp != NULL; }

protected:
    FILE * _fp; 

    DISABLE_OBJECT_COPY(File)
};

class WINUX_DLL BlockOutFile : public File
{
public:
    BlockOutFile( String const & filename, bool isTextMode = true, size_t blockSize = 1048576 );

    bool nextBlock();
    virtual size_t write( void const * data, size_t size ) override;
    using File::write;

protected:
    String _dirname;   
    String _basename;  
    String _filetitle; 
    String _extname;   
    long _fileno;      

    bool _isTextMode;  
    size_t _blockSize; 
    size_t _writtenSize; 

    DISABLE_OBJECT_COPY(BlockOutFile)
};

class WINUX_DLL BlockInFile : public File
{
public:
    BlockInFile( String const & filename, bool isTextMode = true );

    bool nextBlock();
    virtual String getLine() override;
    virtual bool eof() override;

protected:
    String _dirname;   
    String _basename;  
    String _filetitle; 
    String _extname;   
    long _index;       

    bool _isTextMode;  
    StringArray _blockFiles; 

    DISABLE_OBJECT_COPY(BlockInFile)
};

} // namespace winux

#endif //__FILESYS_HPP__