source: XMLIO_V2/external/src/POCO/Foundation.save/Poco/CountingStream.h @ 80

//
// CountingStream.h
//
// $Id: //poco/1.3/Foundation/include/Poco/CountingStream.h#1 $
//
// Library: Foundation
// Package: Streams
// Module:  CountingStream
//
// Definition of the CountingStreamBuf, CountingInputStream and CountingOutputStream classes.
//
// 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_CountingStream_INCLUDED
#define Foundation_CountingStream_INCLUDED


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


namespace Poco {


class Foundation_API CountingStreamBuf: public UnbufferedStreamBuf
        /// This stream buffer counts all characters and lines
        /// going through it.
{
public:
        CountingStreamBuf();
                /// Creates an unconnected CountingStreamBuf.
        
        CountingStreamBuf(std::istream& istr);
                /// Creates the CountingStreamBuf and connects it
                /// to the given input stream.

        CountingStreamBuf(std::ostream& ostr);
                /// Creates the CountingStreamBuf and connects it
                /// to the given output stream.

        ~CountingStreamBuf();
                /// Destroys the CountingStream.
                
        int chars() const;
                /// Returns the total number of characters.
                
        int lines() const;
                /// Returns the total number of lines.
                
        int pos() const;
                /// Returns the number of characters on the current line.
                
        void reset();
                /// Resets all counters.
                
        void setCurrentLineNumber(int line);
                /// Sets the current line number.
                ///
                /// This is mainly useful when parsing C/C++
                /// preprocessed source code containing #line directives.
                
        int getCurrentLineNumber() const;
                /// Returns the current line number (same as lines()).

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

private:
        std::istream* _pIstr;
        std::ostream* _pOstr;
        int _chars;
        int _lines;
        int _pos;
};


class Foundation_API CountingIOS: public virtual std::ios
        /// The base class for CountingInputStream and CountingOutputStream.
        ///
        /// This class is needed to ensure the correct initialization
        /// order of the stream buffer and base classes.
{
public:
        CountingIOS();
                /// Creates the basic stream and leaves it unconnected.

        CountingIOS(std::istream& istr);
                /// Creates the basic stream and connects it
                /// to the given input stream.

        CountingIOS(std::ostream& ostr);
                /// Creates the basic stream and connects it
                /// to the given output stream.

        ~CountingIOS();
                /// Destroys the stream.

        int chars() const;
                /// Returns the total number of characters.

        int lines() const;
                /// Returns the total number of lines.

        int pos() const;
                /// Returns the number of characters on the current line.

        void reset();
                /// Resets all counters.

        void setCurrentLineNumber(int line);
                /// Sets the current line number.
                ///
                /// This is mainly useful when parsing C/C++
                /// preprocessed source code containing #line directives.
                
        int getCurrentLineNumber() const;
                /// Returns the current line number (same as lines()).

        CountingStreamBuf* rdbuf();
                /// Returns a pointer to the underlying streambuf.

protected:
        CountingStreamBuf _buf;
};


class Foundation_API CountingInputStream: public CountingIOS, public std::istream
        /// This stream counts all characters and lines
        /// going through it. This is useful for lexers and parsers
        /// that need to determine the current position in the stream.
{
public:
        CountingInputStream(std::istream& istr);
                /// Creates the CountingInputStream and connects it
                /// to the given input stream.

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


class Foundation_API CountingOutputStream: public CountingIOS, public std::ostream
        /// This stream counts all characters and lines
        /// going through it.
{
public:
        CountingOutputStream();
                /// Creates an unconnected CountingOutputStream.
        
        CountingOutputStream(std::ostream& ostr);
                /// Creates the CountingOutputStream and connects it
                /// to the given input stream.

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


//
// inlines
//
inline int CountingStreamBuf::chars() const
{
        return _chars;
}


inline int CountingStreamBuf::lines() const
{
        return _lines;
}


inline int CountingStreamBuf::pos() const
{
        return _pos;
}


inline int CountingStreamBuf::getCurrentLineNumber() const
{
        return _lines;
}


inline int CountingIOS::chars() const
{
        return _buf.chars();
}


inline int CountingIOS::lines() const
{
        return _buf.lines();
}


inline int CountingIOS::pos() const
{
        return _buf.pos();
}


inline int CountingIOS::getCurrentLineNumber() const
{
        return _buf.getCurrentLineNumber();
}


} // namespace Poco


#endif // Foundation_CountingStream_INCLUDED