// Copyright (C) 2011 Milo Yip
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// 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 AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#ifndef RAPIDJSON_MEMORYSTREAM_H_
#define RAPIDJSON_MEMORYSTREAM_H_

#include "rapidjson.h"

namespace rapidjson {

//! Represents an in-memory input byte stream.
/*!
    This class is mainly for being wrapped by EncodedInputStream or AutoUTFInputStream.

    It is similar to FileReadBuffer but the source is an in-memory buffer instead of a file.

    Differences between MemoryStream and StringStream:
    1. StringStream has encoding but MemoryStream is a byte stream.
    2. MemoryStream needs size of the source buffer and the buffer don't need to be null terminated. StringStream assume null-terminated string as source.
    3. MemoryStream supports Peek4() for encoding detection. StringStream is specified with an encoding so it should not have Peek4().
    \note implements Stream concept
*/
	struct MemoryStream {
		typedef char Ch; // byte

		MemoryStream(const Ch *src, size_t size) : src_(src), begin_(src), end_(src + size), size_(size) {}

		Ch Peek() const { return *src_; }

		Ch Take() { return (src_ == end_) ? '\0' : *src_++; }

		size_t Tell() const { return static_cast<size_t>(src_ - begin_); }

		Ch *PutBegin() {
			RAPIDJSON_ASSERT(false);
			return 0;
		}

		void Put(Ch) { RAPIDJSON_ASSERT(false); }

		void Flush() { RAPIDJSON_ASSERT(false); }

		size_t PutEnd(Ch *) {
			RAPIDJSON_ASSERT(false);
			return 0;
		}

		// For encoding detection only.
		const Ch *Peek4() const {
			return Tell() + 4 <= size_ ? src_ : 0;
		}

		const Ch *src_;     //!< Current read position.
		const Ch *begin_;   //!< Original head of the string.
		const Ch *end_;     //!< End of stream.
		size_t size_;       //!< Size of the stream.
	};

} // namespace rapidjson

#endif // RAPIDJSON_MEMORYBUFFER_H_
