XStdioFile.h

Go to the documentation of this file.

//! @file XStdioFile.h
//! @brief CXStdioFile is the base class for reading text file
//! 
//////////////////////////////////////////////////////////////////////
 
#if !defined(CXSTDIOFILE_INCLUDE_H)
#define CXSTDIOFILE_INCLUDE_H
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
#include "XFile.h"
 
BEGIN_MOOTOOLS_NAMESPACE
 
    ////////////////////////////////////////////////////////////////////////////////////////////////
    //! @class CXStdioFile
    //! @brief CXStdioFile reads or write strings from the file.
    //! @details The string read or write depends on the operating system (unicode on windows, ansi / utf8 on linux and macos).
    //! It is recommended to use CXStdioFileEx which is the advanced version that support unicode / ansi file as well as a simple ReadString method.\n
    //!
    class DLL_TOOLSFUNCTION CXStdioFile : public CXFile
    {
        DECLARE_DYNAMIC_XOBJECT(CXStdioFile)
 
    public:
        // Constructors
        CXStdioFile(bool allowException = true);
        CXStdioFile(FILE* pOpenStream, bool allowException = true);
        CXStdioFile(LPCTSTR lpszFileName, unsigned int nOpenFlags); //!< nOpenFlags is a combination of CXFile::OpenFlags
 
        // Operations
        // reading and writing strings
        virtual void WriteString(LPCTSTR lpsz);
        virtual LPTSTR ReadString(LPTSTR lpsz, unsigned int nMax);
        virtual bool ReadString(CXString& rString);
 
        // Implementation
    public:
        virtual ~CXStdioFile();
 
#ifdef _DEBUG
        void Dump() const;
#endif
 
        virtual fileuint GetPosition() const;
        virtual fileuint GetLength() const;
        virtual bool Open(LPCTSTR lpszFileName, unsigned int nOpenFlags, CXFileException* pError = NULL);  //!< nOpenFlags is a combination of CXFile::OpenFlags
 
        virtual unsigned int Read(void* buffer, unsigned int maxByteToRead);
        virtual void Write(const void* buffer, unsigned int byteToWrite);
        virtual fileuint Seek(longint lOff, CXFile::SeekPosition nFrom);
        virtual void Abort();
        virtual void Flush();
        virtual void Close();
 
        FILE *GetStream() { return fileStream; }
 
    protected:
        // Attributes
        FILE *fileStream;    // stdio FILE
 
        void *buffer;
        unsigned int bufferSize; // Number of TCHAR allocated
 
        bool ReadStringA(CXStringA& rString); // Used by CStdioFileEx which check unicode mode
        bool ReadStringW(CXStringW& rString); // Used by CStdioFileEx which check unicode mode
 
        void ThrowErrno(CXFileException::FileExceptionType exceptionType) const;
 
    private:
        void Init(FILE* openStream);
    };
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(CXSTDIOFILE_INCLUDE_H)