TCStream.h

Go to the documentation of this file.

//*******************************************************************************
//
// *******   ***   ***               *
//    *     *     *                  *
//    *    *      *                *****
//    *    *       ***  *   *   **   *    **    ***
//    *    *          *  * *   *     *   ****  * * *
//    *     *         *   *      *   * * *     * * *
//    *      ***   ***    *     **   **   **   *   *
//                        *
//*******************************************************************************
// see http://sourceforge.net/projects/tcsystem/ for details.
// Copyright (C) 2003 - 2008 Thomas Goessler. All Rights Reserved. 
//*******************************************************************************
//
// TCSystem is the legal property of its developers.
// Please refer to the COPYRIGHT file distributed with this source distribution.
// 
// This library is free software; you can redistribute it and/or             
// modify it under the terms of the GNU Lesser General Public                
// License as published by the Free Software Foundation; either              
// version 2.1 of the License, or (at your option) any later version.        
//                                                                           
// This library 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         
// Lesser General Public License for more details.                           
//                                                                           
// You should have received a copy of the GNU Lesser General Public          
// License along with this library; if not, write to the Free Software       
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
//*******************************************************************************
//  $Id: TCStream.h 870 2008-07-21 14:15:33Z the_____tiger $
//*******************************************************************************
#ifndef _TCSTREAM_H_
#define _TCSTREAM_H_

#include "TCNonCopyable.h"
#include "TCSharedPtr.h"

#include <string>

namespace TC
{
   class Stream: protected NonCopyAble
   {
   public:
      enum StreamErrorFlags
      {
         error_none,
         error_streamopen,
         error_streamclose,
         error_streamdirection,
         error_last
      };

      enum StreamDirection
      {
         stream_dead,
         stream_read,
         stream_write,
         stream_readwrite
      };

   public:
      virtual ~Stream() {}

      virtual sint32 GetStatus() const = 0;
      virtual void ResetStatus() = 0;
      virtual bool Error() const = 0;
      virtual bool IsOk() const = 0;

      virtual void EnableDisplayErrorMessages(bool displ) = 0;

      enum StreamPosition
      {
         POSITION_SET,
         POSITION_CURRENT,
         POSITION_END,
      };
      virtual bool SetPosition(uint32, StreamPosition pos) = 0;
      virtual uint32 GetPosition() const = 0;

      virtual uint32 ReadBytes (uint32 nBytes, void *bytes) = 0;
      virtual uint32 WriteBytes(uint32 nBytes, const void *bytes) = 0;

      virtual uint32 Read(sint16 &val) = 0;
      virtual uint32 Read(uint16 &val) = 0;
      virtual uint32 Read(sint32 &val) = 0;
      virtual uint32 Read(uint32 &val) = 0;
      virtual uint32 Read(sint64 &val) = 0;
      virtual uint32 Read(uint64 &val) = 0;
      virtual uint32 Read(float &val) = 0;
      virtual uint32 Read(double &val) = 0;
      virtual uint32 Read(char *val) = 0;
      virtual uint32 Read(std::string& val) = 0;
      virtual uint32 Read(char &val) = 0;
      virtual uint32 Read(uchar &val) = 0;


      virtual uint32 Write(sint16 val) = 0;
      virtual uint32 Write(uint16 val) = 0;
      virtual uint32 Write(sint32 val) = 0;
      virtual uint32 Write(uint32 val) = 0;
      virtual uint32 Write(sint64 val) = 0;
      virtual uint32 Write(uint64 val) = 0;
      virtual uint32 Write(float val) = 0;
      virtual uint32 Write(double val) = 0;
      virtual uint32 Write(const char *val) = 0;
      virtual uint32 Write(const std::string& val) = 0;
      virtual uint32 Write(char val) = 0;
      virtual uint32 Write(uchar val) = 0;

      virtual uint32 WriteEndOfLine() = 0;
      virtual uint32 WriteSpace() = 0;

      virtual void Flush() = 0;
      virtual void CloseStream() = 0;
   };

   typedef SharedPtr<Stream> StreamPtr;

   // -----------------------------------------------------------------
   // read operators
   // -----------------------------------------------------------------
   inline StreamPtr operator>>(StreamPtr stream, std::string& val) { stream->Read(val); return stream; }

   inline StreamPtr operator>>(StreamPtr stream, uchar& val) { stream->Read(val); return stream; }
   inline StreamPtr operator>>(StreamPtr stream, char& val)  { stream->Read(val); return stream; }
   inline StreamPtr operator>>(StreamPtr stream, char* val)  { stream->Read(val); return stream; }

   inline StreamPtr operator>>(StreamPtr stream, sint16& val) { stream->Read(val); return stream; }
   inline StreamPtr operator>>(StreamPtr stream, sint32& val) { stream->Read(val); return stream; }
   inline StreamPtr operator>>(StreamPtr stream, sint64& val) { stream->Read(val); return stream; }
   inline StreamPtr operator>>(StreamPtr stream, uint16& val) { stream->Read(val); return stream; }
   inline StreamPtr operator>>(StreamPtr stream, uint32& val) { stream->Read(val); return stream; }
   inline StreamPtr operator>>(StreamPtr stream, uint64& val) { stream->Read(val); return stream; }

   inline StreamPtr operator>>(StreamPtr stream, float& val)  { stream->Read(val); return stream; }
   inline StreamPtr operator>>(StreamPtr stream, double& val) { stream->Read(val); return stream; }

   // -----------------------------------------------------------------
   // write operators
   // -----------------------------------------------------------------
   inline StreamPtr operator<<(StreamPtr stream, StreamPtr (*_Pfn)(StreamPtr)) {return ((*_Pfn)(stream));}

   inline StreamPtr operator<<(StreamPtr stream, const std::string& val) { stream->Write(val.c_str()); return stream; }

   inline StreamPtr operator<<(StreamPtr stream, uchar val)       { stream->Write(val); return stream; }
   inline StreamPtr operator<<(StreamPtr stream, char val)        { stream->Write(val); return stream; }
   inline StreamPtr operator<<(StreamPtr stream, const char* val) { stream->Write(val); return stream; }

   inline StreamPtr operator<<(StreamPtr stream, sint16 val)      { stream->Write(val); return stream; }
   inline StreamPtr operator<<(StreamPtr stream, sint32 val)      { stream->Write(val); return stream; }
   inline StreamPtr operator<<(StreamPtr stream, sint64 val)      { stream->Write(val); return stream; }
   inline StreamPtr operator<<(StreamPtr stream, uint16 val)      { stream->Write(val); return stream; }
   inline StreamPtr operator<<(StreamPtr stream, uint32 val)      { stream->Write(val); return stream; }
   inline StreamPtr operator<<(StreamPtr stream, uint64 val)      { stream->Write(val); return stream; }

   inline StreamPtr operator<<(StreamPtr stream, float val)       { stream->Write(val); return stream; }
   inline StreamPtr operator<<(StreamPtr stream, double val)      { stream->Write(val); return stream; }

   inline StreamPtr flush(StreamPtr stream) { stream->Flush(); return stream; }
   inline StreamPtr endl(StreamPtr stream) { stream->WriteEndOfLine(); return stream; }
   inline StreamPtr space(StreamPtr stream) { stream->WriteSpace(); return stream; }

} // namespace TC

#endif // _TCSTREAM_H_