memwritestream.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

/* Based on ScummVM (<http://scummvm.org>) code, which is released
 * under the terms of version 2 or later of the GNU General Public
 * License.
 *
 * The original copyright note in ScummVM reads as follows:
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef COMMON_MEMWRITESTREAM_H
#define COMMON_MEMWRITESTREAM_H

#include <boost/noncopyable.hpp>

#include "src/common/types.h"
#include "src/common/disposableptr.h"
#include "src/common/writestream.h"

namespace Common {

class MemoryWriteStream : boost::noncopyable, public SeekableWriteStream {
public:
    MemoryWriteStream(byte *buf, size_t len) : _ptr(buf), _bufSize(len), _pos(0) { }
    ~MemoryWriteStream() { }

    template<size_t N>
    MemoryWriteStream(byte (&array)[N]) : _ptr(array), _bufSize(N), _pos(0) { }

    size_t write(const void *dataPtr, size_t dataSize);

    size_t pos() const;
    size_t size() const;

    size_t seek(ptrdiff_t offset, Origin whence = kOriginBegin);

private:
    byte *_ptr;

    const size_t _bufSize;
    size_t _pos;
};

class MemoryWriteStreamDynamic : boost::noncopyable, public SeekableWriteStream {
public:
    MemoryWriteStreamDynamic(bool disposeMemory = false, size_t capacity = 0);
    ~MemoryWriteStreamDynamic();

    void reserve(size_t s);

    size_t write(const void *dataPtr, size_t dataSize);

    void setDisposable(bool disposeMemory);
    void dispose();

    size_t pos() const;
    size_t size() const;

    size_t seek(ptrdiff_t offset, Origin whence = kOriginBegin);

    byte *getData();

private:
    DisposableArray<byte> _data;

    byte *_ptr;

    size_t _capacity;
    size_t _size;

    void ensureCapacity(size_t newLen);
};

} // End of namespace Common

#endif // COMMON_MEMWRITESTREAM_H