TempFileStream.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 
*     * Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of 
*       Vintela, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees may be used to 
*       endorse or promote products derived from this software without 
*       specific prior written permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/


#ifndef BLOCXX_TEMPFILESTREAM_HPP_INCLUDE_GUARD_
#define BLOCXX_TEMPFILESTREAM_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/Types.hpp"
#include "blocxx/String.hpp"
#include "blocxx/AutoPtr.hpp"
#include "blocxx/CommonFwd.hpp"
#include "blocxx/File.hpp"

#if defined(BLOCXX_HAVE_STREAMBUF)
#include <streambuf>
#elif defined(BLOCXX_HAVE_STREAMBUF_H)
#include <streambuf.h>
#endif

#if defined(BLOCXX_HAVE_ISTREAM) && defined(BLOCXX_HAVE_OSTREAM)
#include <istream>
#include <ostream>
#else
#include <iostream>
#endif

namespace BLOCXX_NAMESPACE
{

class BLOCXX_COMMON_API TempFileBuffer : public std::streambuf
{
public:
   enum EKeepFileFlag
   {
      E_DONT_KEEP_FILE,
      E_KEEP_FILE
   };

   TempFileBuffer(size_t bufSize, EKeepFileFlag keepflg=E_DONT_KEEP_FILE);
   TempFileBuffer(const String& dir, size_t bufSize, EKeepFileFlag keepflg=E_DONT_KEEP_FILE);
   ~TempFileBuffer();
   std::streamsize getSize();
   void rewind();
   void reset();
   String releaseFileAndReset();
   bool usingTempFile() const;
protected:
   // for input
   int underflow();
   // for output
   std::streamsize xsputn(const char* s, std::streamsize n);
   virtual int overflow(int c);
   //virtual int sync();
   void initBuffers();
   void initGetBuffer();
   void initPutBuffer();
   int buffer_to_device(const char* c, int n);
   int buffer_from_device(char* c, int n);
private:
   size_t m_bufSize;
   char* m_buffer;
   File m_tempFile;
   std::streamsize m_readPos;
   std::streamsize m_writePos;
   bool m_isEOF;
   String m_dir;
   EKeepFileFlag m_keepFlag;
   String m_filePath;

   int buffer_in();
   int buffer_out();
   // prohibit copying and assigning
   TempFileBuffer(const TempFileBuffer& arg);
   TempFileBuffer& operator=(const TempFileBuffer& arg);
};


class BLOCXX_COMMON_API TempFileStream : public std::iostream
{
public:
   TempFileStream(size_t bufSize = 4096, TempFileBuffer::EKeepFileFlag keepflg=TempFileBuffer::E_DONT_KEEP_FILE);
   TempFileStream(const String& dir, size_t bufSize = 4096,
      TempFileBuffer::EKeepFileFlag keepflg=TempFileBuffer::E_DONT_KEEP_FILE);
   std::streamsize getSize() { return m_buffer->getSize(); }
   void rewind();
   void reset();
   String releaseFileAndReset();
   bool usingTempFile() const;
private:

#ifdef BLOCXX_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   AutoPtr<TempFileBuffer> m_buffer;

#ifdef BLOCXX_WIN32
#pragma warning (pop)
#endif

   // disallow copying and assigning
   TempFileStream(const TempFileStream&);
   TempFileStream& operator=(const TempFileStream&);
};

} // end namespace BLOCXX_NAMESPACE

#endif