Logo Search packages:      
Sourcecode: poco version File versions

StreamConverter.h

//
// StreamConverter.h
//
// $Id: //poco/1.3/Foundation/include/Poco/StreamConverter.h#1 $
//
// Library: Foundation
// Package: Text
// Module:  StreamConverter
//
// Definition of the StreamConverter class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
// 
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//


#ifndef Foundation_StreamConverter_INCLUDED
#define Foundation_StreamConverter_INCLUDED


#include "Poco/Foundation.h"
#include "Poco/TextEncoding.h"
#include "Poco/UnbufferedStreamBuf.h"
#include <istream>
#include <ostream>


namespace Poco {


00053 class Foundation_API StreamConverterBuf: public UnbufferedStreamBuf
      /// A StreamConverter converts streams from one encoding (inEncoding)
      /// into another (outEncoding).
      /// If a character cannot be represented in outEncoding, defaultChar
      /// is used instead.
      /// If a byte sequence is not valid in inEncoding, defaultChar is used
      /// instead and the encoding error count is incremented.
{
public:
      StreamConverterBuf(std::istream& istr, const TextEncoding& inEncoding, const TextEncoding& outEncoding, int defaultChar = '?');
            /// Creates the StreamConverterBuf and connects it
            /// to the given input stream.

      StreamConverterBuf(std::ostream& ostr, const TextEncoding& inEncoding, const TextEncoding& outEncoding, int defaultChar = '?');
            /// Creates the StreamConverterBuf and connects it
            /// to the given output stream.

      ~StreamConverterBuf();
            /// Destroys the StreamConverterBuf.

      int errors() const;
            /// Returns the number of encoding errors encountered.

protected:
      int readFromDevice();
      int writeToDevice(char c);

private:
      std::istream*       _pIstr;
      std::ostream*       _pOstr;
      const TextEncoding& _inEncoding;
      const TextEncoding& _outEncoding;
      int                 _defaultChar;
      unsigned char       _buffer[TextEncoding::MAX_SEQUENCE_LENGTH];
      int                 _sequenceLength;
      int                 _pos;
      int                 _errors;
};


00093 class Foundation_API StreamConverterIOS: public virtual std::ios
      /// The base class for InputStreamConverter and OutputStreamConverter.
      ///
      /// This class is needed to ensure the correct initialization
      /// order of the stream buffer and base classes.
{
public:
      StreamConverterIOS(std::istream& istr, const TextEncoding& inEncoding, const TextEncoding& outEncoding, int defaultChar = '?');
      StreamConverterIOS(std::ostream& ostr, const TextEncoding& inEncoding, const TextEncoding& outEncoding, int defaultChar = '?');
      ~StreamConverterIOS();
      StreamConverterBuf* rdbuf();
      int errors() const;

protected:
      StreamConverterBuf _buf;
};


00111 class Foundation_API InputStreamConverter: public StreamConverterIOS, public std::istream
      /// This stream converts all characters read from the
      /// underlying istream from one character encoding into another.
      /// If a character cannot be represented in outEncoding, defaultChar
      /// is used instead.
      /// If a byte sequence read from the underlying stream is not valid in inEncoding, 
      /// defaultChar is used instead and the encoding error count is incremented.
{
public:
      InputStreamConverter(std::istream& istr, const TextEncoding& inEncoding, const TextEncoding& outEncoding, int defaultChar = '?');
            /// Creates the InputStreamConverter and connects it
            /// to the given input stream.

      ~InputStreamConverter();
            /// Destroys the stream.
};


00129 class Foundation_API OutputStreamConverter: public StreamConverterIOS, public std::ostream
      /// This stream converts all characters written to the
      /// underlying ostream from one character encoding into another.
      /// If a character cannot be represented in outEncoding, defaultChar
      /// is used instead.
      /// If a byte sequence written to the stream is not valid in inEncoding, 
      /// defaultChar is used instead and the encoding error count is incremented.
{
public:
      OutputStreamConverter(std::ostream& ostr, const TextEncoding& inEncoding, const TextEncoding& outEncoding, int defaultChar = '?');
            /// Creates the OutputStreamConverter and connects it
            /// to the given input stream.

      ~OutputStreamConverter();
            /// Destroys the CountingOutputStream.
};


} // namespace Poco


#endif // Foundation_StreamConverter_INCLUDED

Generated by  Doxygen 1.6.0   Back to index