/* Copyright (C) 2009 Wildfire Games.
 * This file is part of 0 A.D.
 *
 * 0 A.D. 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.
 *
 * 0 A.D. 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 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
 */

/*

Returned by Translate(), and used to collect variables from the user
before converting into a string.

*/

#ifndef INCLUDED_I18N_STRINGBUFFER
#define INCLUDED_I18N_STRINGBUFFER

#include "Common.h"
#include "TranslatedString.h"
#include "ps/CStr.h"

namespace I18n
{
	class CLocale;
	class BufferVariable;

	template<typename T> BufferVariable* NewBufferVariable(T v);

	class StringBuffer
	{
		friend class CLocale;

	public:
		// Builds and returns the finished string
		operator Str();
		operator CStrW() { return CStrW( (Str)*this ); }

		// Stores the variable inside the StringBuffer,
		// for later conversion into a string
		template<typename T> StringBuffer& operator<< (T v)
		{
			// This BufferVariable is freed by the caching system (yuck)
			Variables.push_back(NewBufferVariable(v));
			return *this;
		}

		// Returns a simple hash of the contents of Variables
		u32 Hash();

	private:
		TranslatedString* String;
			// pointer instead of reference allows assignment.
			// this class is returned by value, so it's nicer for the
			// compiler-generated copy ctor to be used.
		std::vector<BufferVariable*> Variables;
		CLocale* Locale;

		StringBuffer(TranslatedString* str, CLocale* loc)
			: String(str), Locale(loc)
		{
		}
	};

}

#endif // INCLUDED_I18N_STRINGBUFFER