buffer.hpp

Go to the documentation of this file.

#pragma once
/*
**  Copyright (C) 2012 Aldebaran Robotics
**  See COPYING for the license
*/

#ifndef _QI_BUFFER_HPP_
# define _QI_BUFFER_HPP_

# include <qi/api.hpp>
# include <qi/types.hpp>
# include <boost/shared_ptr.hpp>
# include <vector>
# include <cstddef>

#ifdef _MSC_VER
#  pragma warning( push )
#  pragma warning( disable: 4251 )
#endif

namespace qi
{
  class BufferPrivate;

  class QI_API Buffer
  {
  public:
    Buffer();

    Buffer(const Buffer& buffer);
    Buffer& operator = (const Buffer& buffer);

    Buffer(Buffer&& buffer);

    Buffer& operator = (Buffer&& buffer);

    bool write(const void *data, size_t size);

    size_t addSubBuffer(const Buffer& buffer);
    bool   hasSubBuffer(size_t offset) const;
    const  Buffer& subBuffer(size_t offset) const;


    size_t size() const;

    size_t totalSize() const;

    const std::vector<std::pair<size_t, Buffer> >& subBuffers() const;

    void* reserve(size_t size);
    void  clear();


    void* data();
    const void* data() const;

    const void* read(size_t offset = 0, size_t length = 0) const;

    size_t read(void* buffer, size_t offset = 0, size_t length = 0) const;

  private:
    friend class BufferReader;
    // CS4251
    boost::shared_ptr<BufferPrivate> _p;
  };

  class QI_API BufferReader
  {
  public:
    explicit BufferReader(const Buffer& buf);
    ~BufferReader();

    size_t read(void *data, size_t length);


    void  *read(size_t offset);
    bool   seek(size_t offset);
    void  *peek(size_t offset) const;


    bool hasSubBuffer() const;
    const Buffer& subBuffer();
    size_t position() const;

  private:
    Buffer _buffer;
    size_t _cursor;
    size_t _subCursor; // position in sub-buffers
  };

  namespace detail {
    QI_API void printBuffer(std::ostream& stream, const Buffer& buffer);
  }

}

#ifdef _MSC_VER
#  pragma warning( pop )
#endif

#endif  // _QI_BUFFER_HPP_