include/itextstream.h

   1 /*
   2    Copyright (C) 2001-2006, William Joseph.
   3    All Rights Reserved.
   4
   5    This file is part of GtkRadiant.
   6
   7    GtkRadiant is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    GtkRadiant is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with GtkRadiant; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  */
  21
  22 #if !defined( INCLUDED_ITEXTSTREAM_H )
  23 #define INCLUDED_ITEXTSTREAM_H
  24
  25 /// \file
  26 /// \brief Text-stream interfaces.
  27
  28 #include <cstddef>
  29 #include <util/buffer.h>
  30 #include "generic/static.h"
  31
  32 /// \brief A read-only character-stream.
  33 class TextInputStream
  34 {
  35 public:
  36 /// \brief Attempts to read the next \p length characters from the stream to \p buffer.
  37 /// Returns the number of characters actually stored in \p buffer.
  38 virtual std::size_t read( char* buffer, std::size_t length ) = 0;
  39 };
  40
  41 /// \brief A write-only character-stream.
  42 class TextOutputStream
  43 {
  44 public:
  45 /// \brief Attempts to write \p length characters to the stream from \p buffer.
  46 /// Returns the number of characters actually read from \p buffer.
  47 virtual std::size_t write( const char* buffer, std::size_t length ) = 0;
  48 };
  49
  50 /// \brief Calls the overloaded function ostream_write() to perform text formatting specific to the type being written.
  51 /*! Note that ostream_write() is not globally defined - it must be defined once for each type supported.\n
  52    To support writing a custom type MyClass to any kind of text-output-stream with operator<<:
  53    \code
  54    template<typename TextOutputStreamType>
  55    TextOutputStreamType& ostream_write(TextOutputStreamType& ostream, const MyClass& myClass)
  56    {
  57    return ostream << myClass.getName() << ' ' << myClass.getText();
  58    }
  59    \endcode
  60    Expressing this as a template allows it to be used directly with any concrete text-output-stream type, not just the abstract TextOutputStream\n
  61    \n
  62    This overload writes a single character to any text-output-stream - ostream_write(TextOutputStreamType& ostream, char c).
  63  */
  64 template<typename T>
  65 inline TextOutputStream& operator<<( TextOutputStream& ostream, const T& t ){
  66         return ostream_write( ostream, t );
  67 }
  68
  69 inline TextOutputStream& ostream_write( TextOutputStream& ostream, const u::Buffer& b ){
  70     return ostream << b.c_str();
  71 }
  72
  73 class NullOutputStream : public TextOutputStream
  74 {
  75 public:
  76 std::size_t write( const char*, std::size_t length ){
  77         return length;
  78 }
  79 };
  80
  81 class OutputStreamHolder
  82 {
  83 NullOutputStream m_nullOutputStream;
  84 TextOutputStream* m_outputStream;
  85 public:
  86 OutputStreamHolder()
  87         : m_outputStream( &m_nullOutputStream ){
  88 }
  89 void setOutputStream( TextOutputStream& outputStream ){
  90         m_outputStream = &outputStream;
  91 }
  92 TextOutputStream& getOutputStream(){
  93         return *m_outputStream;
  94 }
  95 };
  96
  97 typedef Static<OutputStreamHolder> GlobalOutputStream;
  98
  99 /// \brief Returns the global output stream. Used to display messages to the user.
 100 inline TextOutputStream& globalOutputStream(){
 101         return GlobalOutputStream::instance().getOutputStream();
 102 }
 103
 104 class ErrorStreamHolder : public OutputStreamHolder {};
 105 typedef Static<ErrorStreamHolder> GlobalErrorStream;
 106
 107 /// \brief Returns the global error stream. Used to display error messages to the user.
 108 inline TextOutputStream& globalErrorStream(){
 109         return GlobalErrorStream::instance().getOutputStream();
 110 }
 111
 112 #endif