anki-3d-engine/include/anki/util/StringList.h

// Copyright (C) 2009-2015, Panagiotis Christopoulos Charitos.
// All rights reserved.
// Code licensed under the BSD License.
// http://www.anki3d.org/LICENSE

#ifndef ANKI_UTIL_STRING_LIST_H
#define ANKI_UTIL_STRING_LIST_H

#include "anki/util/String.h"
#include "anki/util/List.h"
#include <algorithm>

namespace anki {

// Forward
template<typename TAlloc>
class StringListBase;

/// @addtogroup util_private
/// @{

template<typename TAlloc>
using StringListBaseScopeDestroyer = 
	ScopeDestroyer<StringListBase<TAlloc>, TAlloc>;

/// @}

/// @addtogroup util_containers
/// @{

/// A simple convenience class for string lists
template<typename TAlloc>
class StringListBase: public List<StringBase<TAlloc>>
{
public:
	using Self = StringListBase; ///< Self type
	using Char = char; ///< Char type
	using Allocator = TAlloc;
	using String = StringBase<Allocator>; ///< String type
	using Base = List<String>; ///< Base

	using ScopeDestroyer = StringListBaseScopeDestroyer<Allocator>;

	/// Sort method for sortAll().
	enum class Sort
	{
		ASCENDING,
		DESCENDING
	};

	// Use the base constructors
	using Base::Base;

	void destroy(Allocator alloc);

	/// Join all the elements into a single big string using a the
	/// seperator @a separator
	ANKI_USE_RESULT Error join(
		Allocator alloc, const CString& separator, String& out) const;

	/// Returns the index position of the last occurrence of @a value in
	/// the list
	/// @return -1 of not found
	I getIndexOf(const CString& value) const;

	/// Sort the string list
	void sortAll(const Sort method = Sort::ASCENDING);

	/// Push at the end of the list a formated string
	template<typename... TArgs>
	ANKI_USE_RESULT Error pushBackSprintf(
		Allocator alloc, const TArgs&... args);

	/// Split a string using a separator (@a separator) and return these
	/// strings in a string list
	ANKI_USE_RESULT Error splitString(
		Allocator alloc, const CString& s, const Char separator);
};

/// A common string list allocated in heap.
using StringList = StringListBase<HeapAllocator<char>>;

/// @}

} // end namespace anki

#include "anki/util/StringList.inl.h"

#endif