StdioFileEx.h

Go to the documentation of this file.

//! @file StdioFileEx.h
//! @brief CStdioFileEx is an advanced class for reading / writing text file.
//! 
// Version 1.1 23 August 2003. Incorporated fixes from Dennis Jeryd.
// Version 1.3 19 February 2005. Incorporated fixes from Howard J Oh and some of my own.
// Version 1.4 26 February 2005. Fixed stupid screw-up in code from 1.3.
// Version 1.5 18 November 2005. - Incorporated fixes from Andy Goodwin.
// - Allows code page to be specified for reading/writing
// - Properly calculates multibyte buffer size instead of
// assuming lstrlen(s).
// - Should handle UTF8 properly.
//
// Copyright David Pritchard 2003-2005. davidpritchard@ctv.es
//
// You can use this class freely, but please keep my ego happy 
// by leaving this comment in place.
//
//////////////////////////////////////////////////////////////////////
 
#if !defined(AFX_STDIOFILEEX_H__41AFE3CA_25E0_482F_8B00_C40775BCDB81__INCLUDED_)
#define AFX_STDIOFILEEX_H__41AFE3CA_25E0_482F_8B00_C40775BCDB81__INCLUDED_
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
BEGIN_MOOTOOLS_NAMESPACE
 
#ifndef CStdioFileEx
 
#define nUNICODE_BOM ((unsigned short)(0xFEFF)) // Unicode "byte order mark" which goes at start of file
#define sNEWLINE _T("\r\n") // New line characters
#define sDEFAULT_UNICODE_FILLER_CHAR "#" // Filler char used when no conversion from Unicode to local code page is possible
 
////////////////////////////////////////////////////////////////////////////////////////////////
//! @class CStdioFileEx
//! @brief CStdioFileEx reads or write unicode or ansi / utf8 string and convert them to CXString using string conversion if needed.
//! @details
//!
class DLL_TOOLSFUNCTION CStdioFileEx : public CXStdioFile
{
    DECLARE_DYNAMIC_XOBJECT(CStdioFileEx)
 
    public:
     CStdioFileEx(bool allowException = true);
     CStdioFileEx(LPCTSTR lpszFileName, unsigned int nOpenFlags);
 
     virtual ~CStdioFileEx();
    
     //! It implements a secured version of fscanf on OS that support it: FcanS(_T("%s", SCANS_TEXT_PARAM(buf, _countof(buf)), SCANS_LAST_PARAM);
     //! * uses SCANS_TEXT_PARAM for each %s param
     //! * terminates the list by NULL (SCANS_LAST_PARAM)
     //! * the function returned the number of argument scanned
     virtual int FScanfS(const LPCTSTR format, ...);
 
     virtual bool Open(LPCTSTR lpszFileName, unsigned int nOpenFlags, CXFileException* pError = NULL ); //!< nOpenFlags is a combination of CXFile::OpenFlags
     virtual bool ReadString(CXString& rString); //!< Read a CXString whatever if the file is encoded in unicode or utf8
     virtual fileuint Seek(longint lOff, CXFile::SeekPosition nFrom);
 
     virtual void WriteString( LPCTSTR lpsz ); //!< Write a CXString. The string is converted accordingly is the file is opened using modeWriteUnicode
     inline bool IsFileUnicodeText() const { return IsStringEncodingUnicode(stringEncoding); }
     inline bool IsFileUTF8() const { return (stringEncoding == xStringUtf8); }
     fileuint GetCharCount();
     void SkipLines(unsigned int lines, unsigned int nFrom);
 
     //! @enum OpenFlags
     //! @brief Additional flags to CXFile::OpenFlags
     enum OpenFlags
     {
         modeWriteUnicode = specificFlags, //!< equivalent to CXFile::typeUnicode
     };
 
     void SetCodePage(xStringEncoding codPage); //!< A code page could be provided on Windows
 
 
     static xStringEncoding GetFileEncoding(const CXString& sFilePath, bool& asBoom);    //!< Returns the file encoding and check if there is a boom marker
 
    protected:
        void Init();
        void SkipBoom();
 
         unsigned int ProcessFlags(const CXString& sFilePath, unsigned int& nOpenFlags);
         bool CheckCarriageReturn();
 
         bool skipBoom, asBoom;
         xStringEncoding stringEncoding;
         unsigned int fileFlags;
 
         bool specialCarriage;
         int specialCarriageTokenPos;
         CXStringA aString;
         CXStringW wString;
         CXString specialCarriageLine; // only used when specialCarriage is set
 
         //int unicodeStringSize, charStringSize; 
         //wchar_t *unicodeString;
         //char *charString;
 
         //wchar_t *AllocUnicodeString(int size);
         //char *AllocCharString(int size);
};
 
#endif // CStdioFileEx
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(AFX_STDIOFILEEX_H__41AFE3CA_25E0_482F_8B00_C40775BCDB81__INCLUDED_)