Référence du fichier character_stack.h

Pile (FILO) contenant des valeurs de type char Plus de détails...

#include <stdlib.h>
#include "character_list.h"

Aller au code source de ce fichier.

Définitions de type
typedef character_list_t	character_stack_t
	Type de données pour représenter une pile contenant des valeurs de type char

Fonctions
void	character_stack_init (character_stack_t *stack)
	Initialisation d'une nouvelle pile contenant des valeurs de type char
void	character_stack_destroy (character_stack_t *stack)
	Destruction d'une pile.
int	character_stack_size (character_stack_t *stack)
	Accesseur sur la taille d'une pile.
int	character_stack_push (character_stack_t *stack, char data)
	Ajouter un élément de type char sur la pile.
int	character_stack_pop (character_stack_t *stack, char *data)
	Supprime un élément de type char du haut de la pile.
char	character_stack_peek (character_stack_t *stack)
	Récupère la valeur de type char du haut de la pile.

Description détaillée

Pile (FILO) contenant des valeurs de type char

Documentation des définitions de type

character_stack_t

typedef character_list_t character_stack_t

Type de données pour représenter une pile contenant des valeurs de type char

Une pile est une liste chaînée gérée de manière adéquate: insertion en tête et suppression en tête.

Documentation des fonctions

character_stack_destroy()

void character_stack_destroy

(

character_stack_t *

stack

)

Destruction d'une pile.

Utilise la fonction de destruction des listes chaînées pour parcourir la liste et détruire tous les éléments de la pile.

Paramètres

stack

est un pointeur vers la structure de données des piles character_stack_t

character_stack_init()

void character_stack_init

(

character_stack_t *

stack

)

Initialisation d'une nouvelle pile contenant des valeurs de type char

Utilise la fonction d'initalisation des listes chaînée pour mettre à zéro la taille et à NULL les pointeurs vers le premier et le dernier élément de la liste, i.e., de la pile.

Paramètres

stack

est un pointeur vers la structure de données des piles character_stack_t

character_stack_peek()

char character_stack_peek

(

character_stack_t *

stack

)

Récupère la valeur de type char du haut de la pile.

Etant donné un pointeur vers une pile (représentée par une liste chaînée), récupère la valeur de l'élément au dessus de la pile sans le supprimer.

Paramètres

stack

est un pointeur vers la structure de données character_stack_t

Renvoie

une valeur de char de l'élément en haut de la pile.

character_stack_pop()

int character_stack_pop	(	character_stack_t *	stack,
		char *	data )

Supprime un élément de type char du haut de la pile.

Etant donné un pointeur vers une pile (représentée par une liste chaînée), supprime l'élément en haut de la pile (le dernier à avoir été inséré)

Paramètres

stack

est un pointeur vers la structure de données character_stack_t

@pram data un pointeur sur type char qui permet de récupérer la valeur de l'élément supprimer de la pile

Renvoie

un entier indiquant si tout s'est bien passé (0 pour OK, et -1 en cas de problème mémoire)

character_stack_push()

int character_stack_push	(	character_stack_t *	stack,
		char	data )

Ajouter un élément de type char sur la pile.

Etant donné un pointeur vers une pile (représentée par une liste chaînée) et une valeur de type char, ajoute un nouvel élément à la pile (en "haut" de la pile) avec cette valeur

Paramètres

stack

est un pointeur vers la structure de données character_stack_t

@pram data une valeur de type char à ajouter à la pile

Renvoie

un entier indiquant si tout s'est bien passé (0 pour OK, et -1 en cas de problème mémoire)

character_stack_size()

int character_stack_size

(

character_stack_t *

stack

)

Accesseur sur la taille d'une pile.

Etant donné un pointeur vers une pile (représentée par une liste chaînée), retourne la valeur du champ size

Paramètres

stack

est un pointeur vers la structure de données character_stack_t

Renvoie

un entier indiquant la taille de la pile