BufferStream.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_BUFFERSTREAM_H__
#define _MIRA_BUFFERSTREAM_H__

#include <iostream>
#include <vector>

#include <platform/Platform.h>
#include <utils/Buffer.h>

namespace mira {


namespace Private {

class MIRA_BASE_EXPORT BufferStreamBuf : public std::streambuf
{
public:

    // STL conform typedefs
    typedef Buffer<char> container_type;
    typedef container_type::value_type char_type;

public:

    BufferStreamBuf(container_type& buffer);

protected:
    // implements std::streambuf

    virtual int overflow( int c = EOF);
    virtual std::streampos seekoff ( std::streamoff off,
            std::ios_base::seekdir way, std::ios_base::openmode which);
    virtual std::streampos seekpos ( std::streampos pos,
            std::ios_base::openmode which);

private:

    container_type& mBuffer;

    void grow();
};


class MIRA_BASE_EXPORT BufferStreamBase
{
public:
    typedef BufferStreamBuf::container_type container_type;
public:
    BufferStreamBase(container_type& buffer) : mBuffer(buffer) {}
protected:
    BufferStreamBuf mBuffer;
};

}


class BufferStream : public Private::BufferStreamBase, public std::iostream
{
public:

    // STL conform typedefs
    typedef Buffer<char> container_type;
    typedef container_type::value_type char_type;

public:
    BufferStream(Buffer<char>& buffer) :
        BufferStreamBase(buffer), std::iostream(&mBuffer) {}

};


}

#endif