archives.hpp

浏览该文件的文档.

#ifndef __ARCHIVES_HPP__
#define __ARCHIVES_HPP__
//
// archives 提供一些文档的读写功能
//

namespace winux
{

class WINUX_DLL Configure
{
private:
    String _configFile;
    StringStringMap _rawParams; 

    static int _FindConfigRef( String const & str, int offset, int * length, String * name );
    String _expandVarNoStripSlashes( String const & name, StringArray * chains ) const;

    //返回加载的配置变量个数
    int _load( String const & configFile, StringStringMap * rawParams, StringArray * loadFileChains );
public:
    static String const ConfigVarsSlashChars;

    Configure();

    Configure( String const & configFile );

    int load( String const & configFile );

    bool has( String const & name ) const { return _rawParams.find(name) != _rawParams.end(); }

    String get( String const & name, bool stripslashes = false, bool expand = false ) const;

    String operator [] ( String const & name ) const;

    String operator () ( String const & name ) const;

    void setRaw( String const & name, String const & value );

    void set( String const & name, String const & value );

    bool del( String const & name );

    void clear();

    StringStringMap const & getAll() const { return _rawParams; }
};

class WINUX_DLL ConfigureSettings
{
public:
    ConfigureSettings( String const & settingsFile = "" );
    ~ConfigureSettings();
    ConfigureSettings( ConfigureSettings const & other );
    ConfigureSettings( ConfigureSettings && other );
    ConfigureSettings & operator = ( ConfigureSettings const & other );
    ConfigureSettings & operator = ( ConfigureSettings && other );

    size_t load( String const & settingsFile );

    Mixed & update( String const & multiname, String const & updateExprStr = "" );

    Mixed & execRef( String const & exprStr ) const;
    Mixed execVal( String const & exprStr, Mixed const & defval = Mixed() ) const;

    Mixed const & operator [] ( String const & name ) const;
    Mixed & operator [] ( String const & name );

    bool has( String const & name ) const;

    Mixed const & get( String const & name ) const;

    ConfigureSettings & set( String const & name, Mixed const & value );

    Mixed const & val() const;
    Mixed & val();

    Mixed const & expr() const;
    Mixed & expr();

private:

    size_t _load( String const & settingsFile, winux::Mixed * collAsVal, winux::Mixed * collAsExpr, StringArray * loadFileChains );

    MembersWrapper<struct ConfigureSettings_Data> _self;
};

class WINUX_DLL CsvWriter
{
public:
    CsvWriter( IFile * outputFile );

    void write( Mixed const & records, Mixed const & columnHeaders = Mixed() );
    void writeRecord( Mixed const & record );

private:
    IFile * _outputFile;
};


class WINUX_DLL CsvReader
{
public:
    CsvReader( IFile * inputFile, bool hasColumnHeaders = false );
    CsvReader( String const & content, bool hasColumnHeaders = false );

    Mixed const & operator [] ( int iRow ) const { return _records[iRow]; }
    Mixed const & operator () ( int iRow, String const & name ) const { return _records[iRow][ _columns[name] ]; }
    size_t getCount() const { return _records.getCount(); }

    Mixed & getRecords() { return _records; }
    Mixed & getColumnHeaders() { return _columns; }
    void read( String const & content, bool hasColumnHeaders = false );

private:
    Mixed _columns; // 第一行列名代表的索引
    Mixed _records;

    void _readRecord( String const & str, int & i, Mixed & record );

    void _readString( String const & str, int & i, String & valStr );
};


class WINUX_DLL TextArchive
{
public:
    enum FileEncoding
    {
        MultiByte,
        Utf8,
        Utf8Bom,
        Utf16Le,
        Utf16Be,
        Utf16 = Utf16Be,
        Utf32Le,
        Utf32Be,
        Utf32 = Utf32Be

    };

    TextArchive( FileEncoding fileEncoding = MultiByte, winux::AnsiString const & contentEncoding = "", winux::AnsiString const & mbsEncoding = "" ) : _fileEncoding(fileEncoding), _contentEncoding(contentEncoding), _mbsEncoding(mbsEncoding)
    {
    }

    void setFileEncoding( FileEncoding fileEncoding )
    {
        this->_fileEncoding = fileEncoding;
    }

    FileEncoding const & getFileEncoding() const
    {
        return this->_fileEncoding;
    }

    void setContentEncoding( winux::AnsiString const & contentEncoding )
    {
        this->_contentEncoding = contentEncoding;
    }

    winux::AnsiString const & getContentEncoding() const
    {
        return this->_contentEncoding;
    }

    void setMultiByteEncoding( winux::AnsiString const & mbsEncoding )
    {
        this->_mbsEncoding = mbsEncoding;
    }

    winux::AnsiString const & getMultiByteEncoding() const
    {
        return this->_mbsEncoding;
    }

    void load( winux::String const & filePath, bool isConvert, winux::AnsiString const & targetEncoding = "", winux::AnsiString const & mbsEncoding = "" )
    {
        this->load( winux::FileGetContentsEx( filePath, false ), isConvert, targetEncoding, mbsEncoding );
    }

    void load( winux::IFile * f, bool isConvert, winux::AnsiString const & targetEncoding = "", winux::AnsiString const & mbsEncoding = "" )
    {
        size_t n;
        void * buf = f->buffer(&n);
        this->load( winux::Buffer( buf, n, true ), isConvert, targetEncoding, mbsEncoding );
    }

    void load( winux::Buffer const & content, bool isConvert, winux::AnsiString const & targetEncoding = "", winux::AnsiString const & mbsEncoding = "" )
    {
        this->setMultiByteEncoding(mbsEncoding);

        size_t i = 0;
        this->_recognizeEncode( content, &i );
        this->_processContent( winux::Buffer( content.getBuf<winux::byte>() + i, content.getSize() - i, true ), isConvert, targetEncoding );
    }

    template < typename _ChTy >
    void write( winux::XString<_ChTy> const & content )
    {
        this->write( winux::Buffer( (void *)content.c_str(), content.length() * sizeof(_ChTy), true ) );
    }

    template < typename _ChTy >
    void write( winux::XString<_ChTy> const & content, winux::AnsiString const & encoding )
    {
        this->write( winux::Buffer( (void *)content.c_str(), content.length() * sizeof(_ChTy), true ), encoding );
    }

    void write( winux::Buffer const & content )
    {
        this->_pureContent.append(content);
    }

    void write( winux::Buffer const & content, winux::AnsiString const & encoding )
    {
        this->setContentEncoding(encoding);
        this->_pureContent.append(content);
    }

    void save( winux::GrowBuffer * output )
    {
        this->save( output, this->_fileEncoding );
    }

    void save( winux::IFile * f )
    {
        this->save( f, this->_fileEncoding );
    }

    void save( winux::String const & filePath )
    {
        this->save( filePath, this->_fileEncoding );
    }

    void save( winux::GrowBuffer * output, FileEncoding fileEncoding )
    {
        this->saveEx( this->_pureContent, this->_contentEncoding, output, fileEncoding );
    }

    void save( winux::IFile * f, FileEncoding fileEncoding )
    {
        this->saveEx( this->_pureContent, this->_contentEncoding, f, fileEncoding );
    }

    void save( winux::String const & filePath, FileEncoding fileEncoding )
    {
        this->saveEx( this->_pureContent, this->_contentEncoding, filePath, fileEncoding );
    }

    void saveEx( winux::Buffer const & content, winux::AnsiString const & encoding, winux::GrowBuffer * output, FileEncoding fileEncoding );

    void saveEx( winux::Buffer const & content, winux::AnsiString const & encoding, winux::IFile * f, FileEncoding fileEncoding )
    {
        winux::GrowBuffer buf;
        this->saveEx( content, encoding, &buf, fileEncoding );
        f->write(buf);
    }

    void saveEx( winux::Buffer const & content, winux::AnsiString const & encoding, winux::String const & filePath, FileEncoding fileEncoding )
    {
        winux::File file( filePath, "wb" );
        this->saveEx( content, encoding, &file, fileEncoding );
    }

    template < typename _ChTy >
    winux::XString<_ChTy> toString() const
    {
        return this->_pureContent.toString<_ChTy>();
    }

    void clear()
    {
        this->_pureContent.free();
    }

private:
    // 处理内容成pure content
    void _processContent( winux::Buffer const & content, bool isConvert, winux::AnsiString const & encoding = "" );
    // 识别BOM文件编码，*pI返回跳过BOM真正文本开始的位置
    void _recognizeEncode( winux::Buffer const & content, size_t * pI );

    FileEncoding _fileEncoding; // 文件编码
    winux::GrowBuffer _pureContent; // 纯内容
    mutable winux::AnsiString _contentEncoding; // 内容编码
    mutable winux::AnsiString _mbsEncoding; // 多字节编码，当文件编码是MultiByte时，此成员指定是哪个多字节编码
};

} // namespace winux

#endif // __ARCHIVES_HPP__