BeTextFile.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once


#include    <Bentley\BeFile.h>
#include    <Bentley\RefCounted.h>

BEGIN_BENTLEY_NAMESPACE


enum class TextFileOpenType
    {
    Read   = 0,      
    Write  = 1,      
    Append = 2,      
    };

enum class TextFileEncoding
    {
    CurrentLocale    = 0,      
    Utf8             = 1,      
    Utf16            = 2,      
    };

enum class TextFileOptions
    {
    None             = 0,      
    KeepNewLine      = 0x1,    
    NewLinesToSpace  = 0x5,    
    };

enum class TextFileReadStatus
    {
    Success            = 0,      
    Eof,                         
    BadParameter,                
    };

enum class TextFileWriteStatus
    {
    Success           = 0,      
    Error,                      
    BadParameter,               
    };

typedef RefCountedPtr<struct BeTextFile>  BeTextFilePtr;

/*=================================================================================**/
struct  BeTextFile : public RefCountedBase
    {
    static const UInt32 BUFFER_SIZE = 100;
private:
    WString             m_fileSpec;
    TextFileOpenType    m_openType;
    BeFile*             m_file;
    TextFileEncoding    m_encoding;
    TextFileOptions     m_options;
    mbstate_t           m_mbState;
    UInt32              m_startOfTextData;

    bool                m_reachedEnd;
    bool                m_noData;
    bool                m_atStart;
    byte*               m_currentByte;
    byte*               m_endBuffer;
    byte                m_readBuffer[BUFFER_SIZE+2];  // used only for reading. 2 extra bytes are to make sure we can push a byte or WChar back into the buffer.

    BeFileStatus        ReadBuffer ();
    byte                ByteFromBuffer ();
    UInt16              UInt16FromBuffer ();
    TextFileEncoding    ReadFileEncoding (TextFileOpenType openType, TextFileEncoding proposedEncoding);
    void                ResetToFileStart ();
    void                RestoreByteToBuffer (UInt16 restore);
    void                RestoreUInt16ToBuffer (UInt16 restore);
    void                WriteEncodingBOM ();

protected:
    BENTLEYDLL_EXPORT   BeTextFile();
    BENTLEYDLL_EXPORT   ~BeTextFile();
    BENTLEYDLL_EXPORT   BeFileStatus    OpenFile (WCharCP fullFileSpec, TextFileOpenType openType, TextFileOptions options, TextFileEncoding encoding);

public:
    BENTLEYDLL_EXPORT     static BeTextFilePtr    Open (BeFileStatus& status, WCharCP fullFileSpec, TextFileOpenType openType, TextFileOptions options, TextFileEncoding encoding = TextFileEncoding::CurrentLocale);

    BENTLEYDLL_EXPORT     void                    Close();

    BENTLEYDLL_EXPORT     TextFileReadStatus      GetLine (WStringR textLine);

    BENTLEYDLL_EXPORT     TextFileWriteStatus     PutLine (WCharCP textLine, bool addCarriageReturn);

    BENTLEYDLL_EXPORT     WChar                   GetChar ();

    BENTLEYDLL_EXPORT     TextFileWriteStatus     PrintfTo (bool toStdOutAlso, WCharCP format, ...);


    BENTLEYDLL_EXPORT BeFileStatus    Rewind ();

    BENTLEYDLL_EXPORT BeFileStatus SetPointer (UInt64 position, BeFileSeekOrigin origin);

    BENTLEYDLL_EXPORT BeFileStatus GetPointer (UInt64& position);

    };


END_BENTLEY_NAMESPACE