Funciones del módulo PdsListString.

Estructuras de datos
struct	PdsListString
	Una estructura tipo PdsListString . Esta estructura genera una doblemente enlazada lista de cadenas te texto. Más...

typedefs
typedef struct PdsListString	PdsListString

Funciones
PdsListString *	pds_list_string_new (void)
	Crea una lista de tipo PdsListString vacia. Más...
int	pds_list_string_push (PdsListString **Lprev, const char *string_data)
	Agrega un elemento a la cima de la lista. Más...
int	pds_list_string_pop (PdsListString **L)
	Quita un elemento de la lista. Si no hay elementos retorna FALSE. Más...
int	pds_list_string_shift (PdsListString **L)
	Quita el elemento inicial;mas antiguo; de la lista, si no hay elementos retorna FALSE. Más...
int	pds_list_string_unshift (PdsListString **Lnext, const char *string_data)
	Agrega un elemento al inicio de la lista. Más...
int	pds_list_string_top (PdsListString **L)
	Busca el elemento final; superior; de la lista. Más...
int	pds_list_string_bottom (PdsListString **L)
	Busca el elemento inicial; inferior; de la lista. Más...
int	pds_list_string_printf (const PdsListString *L)
	Imprime en pantalla los datos de un nodo de tipo puntero PdsListString. Más...
int	pds_list_string_detailed_printf (const PdsListString *L)
	Imprime en pantalla detalladamente los datos de un nodo de tipo puntero PdsListString. Más...
int	pds_list_string_all_printf (const PdsListString *L)
	Imprime en pantalla todos los datos de la lista. Más...
int	pds_list_string_all_detailed_printf (const PdsListString *L)
	Imprime en pantalla todos los datos de la lista detalladamente. Más...
void	pds_list_string_free (PdsListString *L)
	Libera una lista entera de tipo puntero PdsListString. Más...
void	pds_list_string_destroy (PdsListString **L)
	Libera una lista de tipo puntero PdsListString, y limpia el puntero con NULL. Más...
int	pds_list_string_add (PdsListString **Lprev, const char *string_data)
	Agrega un elemento a la cima de la lista. Si la lista no esta en la cima, la lista es llevada a la cima y es dejada luego de agregar en esta posición. Más...
int	pds_list_string_read (PdsListString **Lprev, char **string_data)
	Lee una cadena de texto, en la lista actual y se coloca en el siguiente nodo de la lista, si está ya en el último nodo no se mueve al siguiente nodo. Más...
int	pds_list_string_is_top (const PdsListString *L)
	Retorna TRUE si L apunta el nodo que esta en el top de la lista. Más...
int	pds_list_string_is_bottom (const PdsListString *L)
	Retorna TRUE si L apunta el nodo que esta en el bottom de la lista. Más...
int	pds_list_string_get_length (const PdsListString *L)
	Cuenta la cantidad de nodos de la lista. Es considerada una lista con cero nodos cuando no exiten nodos antes, nodos despues y el valor actual de la lista NULL. Más...
int	pds_list_string_is_empty (const PdsListString *L)
	Indica si la lista está vacía. Más...

Descripción detallada

Estas funciones manipulan una lista con elementos de tipo cadena.
Funciones.

Documentación de los 'typedefs'

PdsListString

typedef struct PdsListString PdsListString

Definición en la línea 67 del archivo pdslstring.h.

Documentación de las funciones

pds_list_string_new()

PdsListString * pds_list_string_new

(

void

)

Crea una lista de tipo PdsListString vacia.

Devuelve

Un puntero a la cadena de tipo PdsListString.

Ejemplos:

testpdslstring.c.

pds_list_string_push()

int pds_list_string_push	(	PdsListString **	Lprev,
		const char *	string_data
	)

Agrega un elemento a la cima de la lista.

Parámetros

[in,out]	Lprev	El nodo de la cima de la lista.
[in]	string_data	La cadena a escrever.

Devuelve

TRUE si todo fue bien o FALSE si no. Si no le das el último nodo da error

Ejemplos:

testpdslstring.c.

pds_list_string_pop()

int pds_list_string_pop

(

PdsListString **

L

)

Quita un elemento de la lista. Si no hay elementos retorna FALSE.

Parámetros

[in,out]

L

El nodo de la cima de la lista.

Devuelve

TRUE si todo fue bien o FALSE si no. Si no le das el último nodo da error

pds_list_string_shift()

int pds_list_string_shift

(

PdsListString **

L

)

Quita el elemento inicial;mas antiguo; de la lista, si no hay elementos retorna FALSE.

Parámetros

[in,out]

L

El primer nodo de la lista.

Devuelve

TRUE si todo fue bien o FALSE si no. Si no le das el primer nodo da error.

pds_list_string_unshift()

int pds_list_string_unshift	(	PdsListString **	Lnext,
		const char *	string_data
	)

Agrega un elemento al inicio de la lista.

Parámetros

[in,out]	Lnext	El primer nodo de la lista.
[in]	string_data	La cadena a escrever.

Devuelve

TRUE si todo fue bien o FALSE si no. Si no le das el primer nodo da error.

pds_list_string_top()

int pds_list_string_top

(

PdsListString **

L

)

Busca el elemento final; superior; de la lista.

Parámetros

[in,out]

L

Un nodo de la lista, en donde se cargará el último nodo.

Devuelve

TRUE si todo fue bien o FALSE si no.

pds_list_string_bottom()

int pds_list_string_bottom

(

PdsListString **

L

)

Busca el elemento inicial; inferior; de la lista.

Parámetros

[in,out]

L

Un nodo de la lista, en donde se cargará el primer nodo.

Devuelve

TRUE si todo fue bien o FALSE si no.

pds_list_string_printf()

int pds_list_string_printf

(

const PdsListString *

L

)

Imprime en pantalla los datos de un nodo de tipo puntero PdsListString.

Parámetros

[in]

L

El nodo a imprimir en pantalla.

Devuelve

TRUE si todo fue bien o FALSE si no.

pds_list_string_detailed_printf()

int pds_list_string_detailed_printf

(

const PdsListString *

L

)

Imprime en pantalla detalladamente los datos de un nodo de tipo puntero PdsListString.

Parámetros

[in]

L

El nodo a imprimir en pantalla.

Devuelve

TRUE si todo fue bien o FALSE si no.

pds_list_string_all_printf()

int pds_list_string_all_printf

(

const PdsListString *

L

)

Imprime en pantalla todos los datos de la lista.

Parámetros

[in]

L

Un nodo de la lista a imprimir en pantalla.

Devuelve

TRUE si todo fue bien o FALSE si no.

Ejemplos:

testpdslstring.c.

pds_list_string_all_detailed_printf()

int pds_list_string_all_detailed_printf

(

const PdsListString *

L

)

Imprime en pantalla todos los datos de la lista detalladamente.

Parámetros

[in]

L

Un nodo de la lista a imprimir en pantalla.

Devuelve

TRUE si todo fue bien o FALSE si no.

pds_list_string_free()

void pds_list_string_free

(

PdsListString *

L

)

Libera una lista entera de tipo puntero PdsListString.

Parámetros

[in,out]

L

La lista a liberar.

Devuelve

No retorna valor.

pds_list_string_destroy()

void pds_list_string_destroy

(

PdsListString **

L

)

Libera una lista de tipo puntero PdsListString, y limpia el puntero con NULL.

Parámetros

[in,out]

L

La lista a liberar y limpiar.

Devuelve

No retorna valor.

pds_list_string_add()

int pds_list_string_add	(	PdsListString **	Lprev,
		const char *	string_data
	)

Agrega un elemento a la cima de la lista. Si la lista no esta en la cima, la lista es llevada a la cima y es dejada luego de agregar en esta posición.

Parámetros

[in,out]	Lprev	Un nodo cualquiera de la lista.
[in]	string_data	La cadena a escrever.

Devuelve

TRUE si todo fue bien o FALSE si no.

pds_list_string_read()

int pds_list_string_read	(	PdsListString **	Lprev,
		char **	string_data
	)

Lee una cadena de texto, en la lista actual y se coloca en el siguiente nodo de la lista, si está ya en el último nodo no se mueve al siguiente nodo.

Parámetros

[in,out]	Lprev	Un nodo cualquiera de la lista.
[out]	string_data	La dirección de la cadena a leer (NO liberar esta dirección de memoria).

Devuelve

TRUE si todo fue bien o FALSE si no.

pds_list_string_is_top()

int pds_list_string_is_top

(

const PdsListString *

L

)

Retorna TRUE si L apunta el nodo que esta en el top de la lista.

Parámetros

[in]

L

Un nodo cualquiera de la lista.

Devuelve

TRUE si L apunta al final de la lista o FALSE si no.

pds_list_string_is_bottom()

int pds_list_string_is_bottom

(

const PdsListString *

L

)

Retorna TRUE si L apunta el nodo que esta en el bottom de la lista.

Parámetros

[in]

L

Un nodo cualquiera de la lista.

Devuelve

TRUE si L apunta al inicio de la lista o FALSE si no.

pds_list_string_get_length()

int pds_list_string_get_length

(

const PdsListString *

L

)

Cuenta la cantidad de nodos de la lista. Es considerada una lista con cero nodos cuando no exiten nodos antes, nodos despues y el valor actual de la lista NULL.

Parámetros

[in]

L

Un nodo cualquiera de la lista a consultar.

Devuelve

Retorna la cantidad de nodos de la lista o un número menor que cero en caso de error.

pds_list_string_is_empty()

int pds_list_string_is_empty

(

const PdsListString *

L

)

Indica si la lista está vacía.

Parámetros

[in]

L

Un nodo cualquiera de la lista a consultar.

Devuelve

Retorna TRUE si L==NULL o si todos los elementos del nodo son nulos.