---

filebuffer.hpp

Go to the documentation of this file.

#if !defined(_FILEBUFFER_HPP)
#define _FILEBUFFER_HPP
//============================================================================= 
//
// XDFLengine library
//
//----------------------------------------------------------------------------- 
//  FILEBUFFER.HPP
//----------------------------------------------------------------------------- 
//_____________________________________________________________________________
//
//  Copyright (C) 2003 Guillaume Baurand. All Rights Reserved.
//
//  This file is part of the XDFLengine project.
//
//  The XDFLengine is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,
//  USA.
//
//  For more information, 
//      contact  : guillaume@baurand.net 
//      or visit : http://xdflengine.sourceforge.net
//
//============================================================================= 

#   include "config/commonincs.hpp"
#   include "flow/xmlstreambuffer.hpp"

BEGIN_XDFLENGINE_NS

    static const char*      gs_pszFileBufferTmpDir;         

//============================================================================= 
//  CLASS FILEBUFFER
//----------------------------------------------------------------------------- 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
class XDFLENGINE_EXPORT FileBuffer: public XMLStreamBuffer 
{

    private: //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        FILE*           m_pOut;                         
        char            m_cFN[FILEBUFFER_MAXNAMESIZE];  
        char            m_cMode[5];                     
        bool            m_bOwnFile;                     
        bool            m_bOpened;                      
        int             m_intSize;                      
        bool            m_boolReadOnly;                 
        unsigned int    m_uiBufferSize;
        unsigned int    m_commitwritten;

    public: //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        //_____________________________________________________________________
        //  Settmpdir
        //---------------------------------------------------------------------
        //_____________________________________________________________________     
        static void setTmpDir( const char* p_pszTmpDir) ;

    // CONSTRUCTOR AND DESTRUCTOR

        //_____________________________________________________________________
        //  FILEBUFFER
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        FileBuffer  ( const char* p_cFileName=0, bool p_boolReadOnly = false, unsigned int p_uiBufferSize=0);
        
        //_____________________________________________________________________
        //  ~FILEBUFFER
        //---------------------------------------------------------------------
        //_____________________________________________________________________         
        ~FileBuffer ();

    // XMLSTREAMPROVIDER

        //_____________________________________________________________________
        //  OPERATOR >>
        //---------------------------------------------------------------------         
        XMLStreamProvider & operator>>  ( XMLStreamConsumer& p_pStreamConsumer);

    // XMLSTREAMCONSUMER

        //_____________________________________________________________________
        //  WRITEDATA
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        void writeData( const char* p_pszData, unsigned int p_uiDataLen);

        //_____________________________________________________________________
        //  COMMITSTREAM
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        bool commitStream(bool fFinal = false);

    // FILEBUFFER

        //_____________________________________________________________________
        //  FLUSH 
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        void flush ();

    private: //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        //_____________________________________________________________________
        //  OPENFILE
        //---------------------------------------------------------------------
        //_____________________________________________________________________         
        void openfile();

        //_____________________________________________________________________
        //  CLOSEFILE
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        void closefile();

        //_____________________________________________________________________
        //  SETMODE
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        void setMode ( const char* p_cMode);

        //_____________________________________________________________________
        //  DELFILE
        //---------------------------------------------------------------------
        //_____________________________________________________________________ 
        void delFile();
    
};
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//=============================================================================

END_XDFLENGINE_NS

#endif

---