Referência ao ficheiro src/vapiLists.h

Functions to handle lists of stuff. Mais...

#include "vapiTypes.h"

Diagrama de dependências de inclusão para vapiLists.h:

Este grafo mostra quais são os ficheiros que incluem directamente ou indirectamente este ficheiro:

Ir para o código fonte deste ficheiro.

Estruturas de Dados
struct	_vListItem
Definições de tipos
typedef void *	vFreeFunction (vpointer)
	function do free an listitem's data. This is used when we want to delete an item from the list and the data stored also. Specifying this, we can free the data and delete the item in one step.
typedef vListItem *	vList
	Defines a List.
typedef _vListItem	vListItem
	definition of a list item.
Funções
void	v_list_append (vList *List, vpointer Data)
	adds an item to the end of the list.
int	v_list_count_elements (vList *List)
	count how many elements the list has.
void	v_list_delete_item (vList *List, vFreeFunction FreeFunction, int Delete)
	deletes the item
void	v_list_free (vList *List, vFreeFunction FreeFunction)
	Frees the entire list. This is called when we want a list to fre totally freed.
vpointer	v_list_get (vList *List, int Item)
	gets the data for the item in that position in the list.
void	v_list_insert (vList *List, vpointer data, int position)
	Insert an element on the list, in the desired position.
void	v_list_move (vList *List, int source, int destination)
	moves an item from one source to a destination
vList *	v_list_new ()
	creates an empty list

---

Descrição detalhada

Functions to handle lists of stuff.

Definido no ficheiro vapiLists.h.

---

Documentação dos tipos

void * vFreeFunction

function do free an listitem's data. This is used when we want to delete an item from the list and the data stored also. Specifying this, we can free the data and delete the item in one step.

Definido na linha 33 do ficheiro vapiLists.h.

vList

Defines a List.

Definido na linha 26 do ficheiro vapiLists.h.

vListItem

definition of a list item.

---

Documentação das funções

void v_list_append	(	vList *	List,
		vpointer	data
	)

adds an item to the end of the list.

Parâmetros:

	List	The list to append the item
	Data	The data to store in the item.

Definido na linha 14 do ficheiro vapiLists.c.

Referências List e v_list_append().

Referenciado por v_bypass_append(), v_list_append(), vapiGroupListAddItem(), vapiGtkMacroItemMoveDown(), vapiGtkMacroItemMoveToBottom(), vapiIOListAddIO(), vapiIOListConfiguredAdd(), vapiMacroAddItem(), vapiMacroListAddItem() e vapiOperationListAddItem().

{

        if (*List == NULL)
        {
                *List = malloc (sizeof (vListItem));
                (*List)->data = data;
                (**List).Next = NULL;
        }
        else
        {

                v_list_append ((vList *) & (**List).Next, data);
        }

}

Grafo de chamadas desta função:

Here is the caller graph for this function:

int v_list_count_elements

(

vList *

List

)

count how many elements the list has.

Retorna:

the number of elements of the list.

Definido na linha 46 do ficheiro vapiLists.c.

Referências List e v_list_count_elements_aux().

Referenciado por v_bypass_reload(), v_bypass_search(), v_list_free(), v_list_insert(), v_stopby_set(), vapiGroupListCountElements(), vapiGtkMacroTable(), vapiGtkMacroTableAux(), vapiGtkWindowIOAddInitIOList(), vapiGtkWindowIOAddPopulateGroup(), vapiGtkWindowIOConfiguredList(), vapiIOConfiguredToXML(), vapiIOListAddGroup(), vapiIOListAddIO(), vapiIOListCount(), vapiIOListSelect(), vapiIOListSelectN(), vapiMacroCountElements(), vapiMacroGetMacroIndex(), vapiMacroListCountElements(), vapiOperationListCountElements() e vIOCheckList().

{
        if ((*List) == NULL)
        {
                return 0;
        }
        return v_list_count_elements_aux (List, 0);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void v_list_delete_item	(	vList *	List,
		vFreeFunction	FreeFunction,
		int	Delete
	)

deletes the item

Parâmetros:

	Delete	the number of the item to delete in the list.
	FreeFunction	the functions that frees the data. If NULL is passed, the data is not freed.

Definido na linha 120 do ficheiro vapiLists.c.

Referências List e v_list_delete_item_aux().

Referenciado por v_list_free(), v_list_move(), vapiGtkMacroItemMoveDown(), vapiGtkMacroItemMoveToBottom(), vapiGtkMacroItemMoveToTop(), vapiGtkMacroItemMoveUp(), vapiIOConfiguredDelete(), vapiMacroDeleteItem() e vapiMacroListDeleteItem().

{
        v_list_delete_item_aux (List, NULL, FreeFunction, Delete, 0);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void v_list_free	(	vList *	List,
		vFreeFunction	FreeFunction
	)

Frees the entire list. This is called when we want a list to fre totally freed.

Parâmetros:

FreeFunction

the functions that frees the data. If NULL is passed, the data is not freed.

Definido na linha 212 do ficheiro vapiLists.c.

Referências List, v_list_count_elements() e v_list_delete_item().

Referenciado por v_bypass_clean() e vapiMacroDelete().

{
        int Count, i;

        Count = v_list_count_elements (List);

        /*
         * Caso existam items, eliminá-los.
         */
        if (Count > 0)
        {
                for (i = Count; i > 0; i--)
                {

                        v_list_delete_item (List, FreeFunction, (i - 1));

                }
        }
        free(List);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

vpointer v_list_get	(	vList *	List,
		int	Item
	)

gets the data for the item in that position in the list.

Parâmetros:

Item

the number of the item

Retorna:

The pointer for the data

Aviso:

The returned pointer should not be freed.

Definido na linha 152 do ficheiro vapiLists.c.

Referências List e v_list_get_aux().

Referenciado por v_bypass_search(), v_input_NULL_boolean(), v_input_str_int(), v_list_move(), v_stopby_set(), vapiGroupListSelectGroup(), vapiGroupListSelectItem(), vapiGtkMacroItemMoveDown(), vapiGtkMacroItemMoveToBottom(), vapiGtkMacroItemMoveToTop(), vapiGtkMacroItemMoveUp(), vapiGtkWindowIOAdd_Add(), vapiGtkWindowIOAddInitIOList(), vapiGtkWindowIOAddPopulateGroup(), vapiGtkWindowIOAddSelectIO(), vapiGtkWindowIOAddShowDescription(), vapiGtkWindowIOConfiguredList(), vapiGtkWindowIOConfiguredSaveChanges(), vapiGtkWindowIOConfiguredSelect(), vapiIOConfiguredToXML(), vapiIOListAddGroup(), vapiIOListSelect(), vapiIOListSelectN(), vapiIOPropertySetChar(), vapiIOPropertySetInt(), vapiMacroGetMacroIndex(), vapiMacroListSelectItem(), vapiMacroSelectItem(), vapiOperationListSelectItem() e vapiOperationListSelectOperation().

{
        return (v_list_get_aux (List, Item, 0));
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void v_list_insert	(	vList *	List,
		vpointer	data,
		int	position
	)

Insert an element on the list, in the desired position.

Parâmetros:

position

the item will be add in the position

Definido na linha 192 do ficheiro vapiLists.c.

Referências List, v_list_count_elements() e v_list_insert_aux().

Referenciado por v_list_move(), vapiGtkMacroItemMoveDown(), vapiGtkMacroItemMoveToTop(), vapiGtkMacroItemMoveUp() e vapiMacroAddItemPositioned().

{
        int ListSize;
        
        ListSize = v_list_count_elements(List);
        /*
         * Verificação da posição dentros dos limites da lista.
         */
        if (position <0 || position >=ListSize)
        {
                return;
        }
        /*
         * O que se pretende é ir à posição anterior e 
         *  adicionar o Operation seguinte. 
         */
        v_list_insert_aux ((vList *) & (**List).Next, List, data, position, 0);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void v_list_move	(	vList *	List,
		int	source,
		int	destination
	)

moves an item from one source to a destination

Parâmetros:

	source	the source position
	destination	the destination position

Definido na linha 233 do ficheiro vapiLists.c.

Referências List, v_list_delete_item(), v_list_get() e v_list_insert().

{
        vpointer * Item;
        Item = v_list_get(List, source);
        
        v_list_delete_item (List, NULL, source);
        
        if (source < destination)
        {
                destination--;
        }
        
        v_list_insert(List, Item, destination);
        
}

Grafo de chamadas desta função:

vList* v_list_new

(

)

creates an empty list

Definido na linha 6 do ficheiro vapiLists.c.

Referências List.

Referenciado por v_bypass_init(), vapiGroupListNew(), vapiIOListConfiguredNew(), vapiIOListNew(), vapiMacroListNew() e vapiOperationListNew().

{
        vList *List = malloc (sizeof (vList));
        *List = NULL;
        return List;
}

Here is the caller graph for this function:

---