/* 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/>.
 */

/*
 * shared storage for strings
 */

#ifndef INCLUDED_STRING_POOL
#define INCLUDED_STRING_POOL

#include "lib/adts.h"	// DynHashTbl
#include "pool.h"

class StringPool
{
public:
	StringPool(size_t maxSize);
	~StringPool();

	/**
	 * allocate a copy of the string.
	 *
	 * @return a unique pointer for the string (addresses are equal iff
	 * the string contents match). can return 0, but would raise a
	 * warning first.
	 **/
	const char* UniqueCopy(const char* string);

	bool Contains(const char* string) const;

	const char* RandomString() const;

private:
	// rationale: we want an O(1) Contains() so that redundant UniqueCopy
	// calls are cheap. that requires allocating from one contiguous arena,
	// which is also more memory-efficient than the heap (no headers).
	Pool m_pool;

	typedef DynHashTbl<const char*, const char*> Map;
	Map m_map;
};

#endif	// #ifndef INCLUDED_STRING_POOL