*/

class ScriptListSorter {

protected:

	bool has_no_more_items; ///< Whether we have more items to iterate over.

public:

	/**

	/**

	 * Get the first item of the sorter.

	 */

	/**

	 * Stop iterating a sorter.

	/**

	 * Get the next item of the sorter.

	 */

	/**

	 * See if the sorter has reached the end.

		this->End();

	}

	{

		if (this->list->buckets.empty()) return 0;

		this->has_no_more_items = false;

		this->bucket_list_iter = this->bucket_list->begin();

		this->item_next = *this->bucket_list_iter;

		FindNext();

		return item_current;

	}

		this->item_next = *this->bucket_list_iter;

	}

	{

		if (this->IsEnd()) return 0;

		FindNext();

		return item_current;

	}

		this->End();

	}

	{

		if (this->list->buckets.empty()) return 0;

		this->has_no_more_items = false;

		--this->bucket_list_iter;

		this->item_next = *this->bucket_list_iter;

		FindNext();

		return item_current;

	}

		this->item_next = *this->bucket_list_iter;

	}

	{

		if (this->IsEnd()) return 0;

		FindNext();

		return item_current;

	}

		this->End();

	}

	{

		if (this->list->items.empty()) return 0;

		this->has_no_more_items = false;

		this->item_iter = this->list->items.begin();

		this->item_next = (*this->item_iter).first;

		FindNext();

		return item_current;

	}

		if (this->item_iter != this->list->items.end()) item_next = (*this->item_iter).first;

	}

	{

		if (this->IsEnd()) return 0;

		FindNext();

		return item_current;

	}

		this->End();

	}

	{

		if (this->list->items.empty()) return 0;

		this->has_no_more_items = false;

		--this->item_iter;

		this->item_next = (*this->item_iter).first;

		FindNext();

		return item_current;

	}

		if (this->item_iter != this->list->items.end()) item_next = (*this->item_iter).first;

	}

	{

		if (this->IsEnd()) return 0;

		FindNext();

		return item_current;

	}

	delete this->sorter;

}

{

	return this->items.count(item) == 1;

}

	this->sorter->End();

}

{

	this->modifications++;

	this->SetValue(item, value);

}

{

	this->modifications++;

	if (!this->HasItem(item)) return;

	this->sorter->Remove(item);

	this->buckets[value].erase(item);

	this->items.erase(item);

}

{

	this->initialized = true;

	return this->sorter->Begin();

}

{

	if (this->initialized == false) {

		DEBUG(script, 0, "Next() is invalid as Begin() is never called");

	return (int32)this->items.size();

}

{

	if (!this->HasItem(item)) return 0;

	return this->items[item];

}

{

	this->modifications++;

	if (!this->HasItem(item)) return false;

	if (value_old == value) return true;

	this->sorter->Remove(item);

	list->sorter->Retarget(list);

}

{

	this->modifications++;

	}

}

{

	this->modifications++;

	}

}

{

	this->modifications++;

	}

}

{

	this->modifications++;

	}

}

{

	this->modifications++;

	}

}

{

	this->modifications++;

	}

}

{

	this->modifications++;

	}

}

{

	this->modifications++;

	int modifications;            ///< Number of modification that has been done. To prevent changing data while valuating.

public:

	ScriptListMap items;           ///< The items in the list

	ScriptListBucket buckets;      ///< The items in the list, sorted by value

	 * @param item the item to add. Should be unique, otherwise it is ignored.

	 * @param value the value to assign.

	 */

#else

#endif /* DOXYGEN_API */

	/**

	 * Remove a single item from the list.

	 * @param item the item to remove. If not existing, it is ignored.

	 */

	/**

	 * Clear the list, making Count() returning 0 and IsEmpty() returning true.

	 * @param item the item to check for.

	 * @return true if the item is in the list.

	 */

	/**

	 * Go to the beginning of the list and return the item. To get the value use list.GetValue(list.Begin()).

	 * @return the first item.

	 * @note returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list.

	 */

	/**

	 * Go to the next item in the list and return the item. To get the value use list.GetValue(list.Next()).

	 * @return the next item.

	 * @note returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list.

	 */

	/**

	 * Check if a list is empty.

	 * @param item the item to get the value from

	 * @return the value that belongs to this item.

	 */

	/**

	 * Set a value of an item directly.

	 * @note Changing values of items while looping through a list might cause

	 *  entries to be skipped. Be very careful with such operations.

	 */

	/**

	 * Sort this list by the given sorter and direction.

	 * Removes all items with a higher value than 'value'.

	 * @param value the value above which all items are removed.

	 */

	/**

	 * Removes all items with a lower value than 'value'.

	 * @param value the value below which all items are removed.

	 */

	/**

	 * Removes all items with a value above start and below end.

	 * @param start the lower bound of the to be removed values (exclusive).

	 * @param end   the upper bound of the to be removed values (exclusive).

	 */

	/**

	 * Remove all items with this value.

	 * @param value the value to remove.

	 */

	/**

	 * Remove the first count items.

	 * Keep all items with a higher value than 'value'.

	 * @param value the value above which all items are kept.

	 */

	/**

	 * Keep all items with a lower value than 'value'.

	 * @param value the value below which all items are kept.

	 */

	/**

	 * Keep all items with a value above start and below end.

	 * @param start the lower bound of the to be kept values (exclusive).

	 * @param end   the upper bound of the to be kept values (exclusive).

	 */

	/**

	 * Keep all items with this value.

	 * @param value the value to keep.

	 */

	/**

	 * Keep the first count items, i.e. remove everything except the first count items.