Class that creates a list which can keep item/value pairs, which you can walk. More...

Inheritance diagram for GSList:

Public Types
enum	SorterType { SORT_BY_VALUE, SORT_BY_ITEM }
	Type of sorter. More...

Public Member Functions
void	AddItem (SQInteger item, SQInteger value)
	Add a single item to the list. More...

void	RemoveItem (SQInteger item)
	Remove a single item from the list. More...

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

bool	HasItem (SQInteger item)
	Check if an item is in the list. More...

SQInteger	Begin ()
	Go to the beginning of the list and return the item. More...

SQInteger	Next ()
	Go to the next item in the list and return the item. More...

bool	IsEmpty ()
	Check if a list is empty. More...

bool	IsEnd ()
	Check if there is a element left. More...

SQInteger	Count ()
	Returns the amount of items in the list. More...

SQInteger	GetValue (SQInteger item)
	Get the value that belongs to this item. More...

bool	SetValue (SQInteger item, SQInteger value)
	Set a value of an item directly. More...

void	Sort (SorterType sorter, bool ascending)
	Sort this list by the given sorter and direction. More...

void	AddList (GSList *list)
	Add one list to another one. More...

void	SwapList (GSList *list)
	Swap the contents of two lists. More...

void	RemoveAboveValue (SQInteger value)
	Removes all items with a higher value than 'value'. More...

void	RemoveBelowValue (SQInteger value)
	Removes all items with a lower value than 'value'. More...

void	RemoveBetweenValue (SQInteger start, SQInteger end)
	Removes all items with a value above start and below end. More...

void	RemoveValue (SQInteger value)
	Remove all items with this value. More...

void	RemoveTop (SQInteger count)
	Remove the first count items. More...

void	RemoveBottom (SQInteger count)
	Remove the last count items. More...

void	RemoveList (GSList *list)
	Remove everything that is in the given list from this list (same item index that is). More...

void	KeepAboveValue (SQInteger value)
	Keep all items with a higher value than 'value'. More...

void	KeepBelowValue (SQInteger value)
	Keep all items with a lower value than 'value'. More...

void	KeepBetweenValue (SQInteger start, SQInteger end)
	Keep all items with a value above start and below end. More...

void	KeepValue (SQInteger value)
	Keep all items with this value. More...

void	KeepTop (SQInteger count)
	Keep the first count items, i.e. More...

void	KeepBottom (SQInteger count)
	Keep the last count items, i.e. More...

void	KeepList (GSList *list)
	Keeps everything that is in the given list from this list (same item index that is). More...

void	Valuate (void *valuator_function, int params,...)
	Give all items a value defined by the valuator you give. More...

Static Public Attributes
static const bool	SORT_ASCENDING = true
	Sort ascending.

static const bool	SORT_DESCENDING = false
	Sort descending.

Detailed Description

Class that creates a list which can keep item/value pairs, which you can walk.

Member Enumeration Documentation

◆ SorterType

enum GSList::SorterType

Type of sorter.

Enumerator
SORT_BY_VALUE	Sort the list based on the value of the item.
SORT_BY_ITEM	Sort the list based on the item itself.

Member Function Documentation

◆ AddItem()

void GSList::AddItem	(	SQInteger	item,
		SQInteger	value
	)

Add a single item to the list.

Parameters

item	the item to add. Should be unique, otherwise it is ignored.
value	the value to assign.

◆ AddList()

void GSList::AddList ( GSList * list )

Add one list to another one.

Parameters

list	The list that will be added to the caller.

Postcondition: The list to be added ('list') stays unmodified.

Note: All added items keep their value as it was in 'list'.; If the item already exists inside the caller, the value of the list that is added is set on the item.

◆ Begin()

SQInteger GSList::Begin ( )

Go to the beginning of the list and return the item.

To get the value use list.GetValue(list.Begin()).

Returns: the first item.

Note: returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list.

◆ Count()

SQInteger GSList::Count ( )

Returns the amount of items in the list.

Returns: amount of items in the list.

◆ GetValue()

SQInteger GSList::GetValue ( SQInteger item )

Get the value that belongs to this item.

Parameters

item	the item to get the value from

Returns: the value that belongs to this item.

◆ HasItem()

bool GSList::HasItem ( SQInteger item )

Check if an item is in the list.

Parameters

item	the item to check for.

Returns: true if the item is in the list.

◆ IsEmpty()

bool GSList::IsEmpty ( )

Check if a list is empty.

Returns: true if the list is empty.

◆ IsEnd()

bool GSList::IsEnd ( )

Check if there is a element left.

In other words, if this is false, the last call to Begin() or Next() returned a valid item.

Returns: true if the current item is beyond end-of-list.

◆ KeepAboveValue()

void GSList::KeepAboveValue ( SQInteger value )

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

Parameters

value the value above which all items are kept.

◆ KeepBelowValue()

void GSList::KeepBelowValue ( SQInteger value )

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

Parameters

value the value below which all items are kept.

◆ KeepBetweenValue()

void GSList::KeepBetweenValue	(	SQInteger	start,
		SQInteger	end
	)

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

Parameters

start	the lower bound of the to be kept values (exclusive).
end	the upper bound of the to be kept values (exclusive).

◆ KeepBottom()

void GSList::KeepBottom ( SQInteger count )

Keep the last count items, i.e.

remove everything except the last count items.

Parameters

count the amount of items to keep.

◆ KeepList()

void GSList::KeepList ( GSList * list )

Keeps everything that is in the given list from this list (same item index that is).

Parameters

list	the list of items to keep.

Precondition: list != null

◆ KeepTop()

void GSList::KeepTop ( SQInteger count )

Keep the first count items, i.e.

remove everything except the first count items.

Parameters

count the amount of items to keep.

◆ KeepValue()

void GSList::KeepValue ( SQInteger value )

Keep all items with this value.

Parameters

value the value to keep.

◆ Next()

SQInteger GSList::Next ( )

Go to the next item in the list and return the item.

To get the value use list.GetValue(list.Next()).

Returns: the next item.

Note: returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list.

◆ RemoveAboveValue()

void GSList::RemoveAboveValue ( SQInteger value )

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

Parameters

value the value above which all items are removed.

◆ RemoveBelowValue()

void GSList::RemoveBelowValue ( SQInteger value )

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

Parameters

value the value below which all items are removed.

◆ RemoveBetweenValue()

void GSList::RemoveBetweenValue	(	SQInteger	start,
		SQInteger	end
	)

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

Parameters

start	the lower bound of the to be removed values (exclusive).
end	the upper bound of the to be removed values (exclusive).

◆ RemoveBottom()

void GSList::RemoveBottom ( SQInteger count )

Remove the last count items.

Parameters

count the amount of items to remove.

◆ RemoveItem()

void GSList::RemoveItem ( SQInteger item )

Remove a single item from the list.

Parameters

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

◆ RemoveList()

void GSList::RemoveList ( GSList * list )

Remove everything that is in the given list from this list (same item index that is).

Parameters

list	the list of items to remove.

Precondition: list != null

◆ RemoveTop()

void GSList::RemoveTop ( SQInteger count )

Remove the first count items.

Parameters

count the amount of items to remove.

◆ RemoveValue()

void GSList::RemoveValue ( SQInteger value )

Remove all items with this value.

Parameters

value the value to remove.

◆ SetValue()

bool GSList::SetValue	(	SQInteger	item,
		SQInteger	value
	)

Set a value of an item directly.

Parameters

item	the item to set the value for.
value	the value to give to the item

Returns: true if we could set the item to value, false otherwise.

Note: Changing values of items while looping through a list might cause entries to be skipped. Be very careful with such operations.

◆ Sort()

void GSList::Sort	(	SorterType	sorter,
		bool	ascending
	)

Sort this list by the given sorter and direction.

Parameters

sorter	the type of sorter to use
ascending	if true, lowest value is on top, else at bottom.

Note: the current item stays at the same place.

See also: SORT_ASCENDING SORT_DESCENDING

◆ SwapList()

void GSList::SwapList ( GSList * list )

Swap the contents of two lists.

Parameters

list	The list that will be swapped with.

◆ Valuate()

void GSList::Valuate	(	void *	valuator_function,
		int	params,
			...
	)

Give all items a value defined by the valuator you give.

Parameters

valuator_function	The function which will be doing the valuation.
params	The params to give to the valuators (minus the first param, which is always the index-value we are valuating).

Note: You may not add, remove or change (setting the value of) items while valuating. You may also not (re)sort while valuating.; You can write your own valuators and use them. Just remember that the first parameter should be the index-value, and it should return an integer.; Example: list.Valuate(GSBridge.GetPrice, 5); list.Valuate(GSBridge.GetMaxLength); function MyVal(bridge_id, myparam) { return myparam * bridge_id; // This is silly } list.Valuate(MyVal, 12);

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ SorterType

Member Function Documentation

◆ AddItem()

◆ AddList()

◆ Begin()

◆ Count()

◆ GetValue()

◆ HasItem()

◆ IsEmpty()

◆ IsEnd()

◆ KeepAboveValue()

◆ KeepBelowValue()

◆ KeepBetweenValue()

◆ KeepBottom()

◆ KeepList()

◆ KeepTop()

◆ KeepValue()

◆ Next()

◆ RemoveAboveValue()

◆ RemoveBelowValue()

◆ RemoveBetweenValue()

◆ RemoveBottom()

◆ RemoveItem()

◆ RemoveList()

◆ RemoveTop()

◆ RemoveValue()

◆ SetValue()

◆ Sort()

◆ SwapList()

◆ Valuate()