commentaires liste figures

/**

   Cette fonction initialise un maillon d'une liste de figures.

   @param figure est un pointeur vers une figure

   @requires figure != NULL && figure->detruire != NULL && figure->afficher != NULL

   @ensures resultat->figure == figure && resultat->suivant == NULL

   @return un pointeur vers un maillon d'une liste de figures.

*/

maillon_figure_t * creer_maillon(void * figure);

/**

   Libère l'espace mémoire réservé par un maillon et la figure qu'il contient.

   @param m est un pointeur sur un maillon d'une liste de figure.

   @requires m a été crée par creer_maillon

*/

void detruire_maillon(maillon_figure_t * m);

/**

   Cette fonction initialise une liste de figures, vide.

   @ensures liste_taille(resultat) == 0

   @ensures liste_est_vide(resultat) == 1

   @ensures resultat->premier == NULL && resultat->dernier == NULL

   @return un pointeur vers une liste vide.

*/

liste_figure_t * creer_liste();

/**

   Libère l'espace mémoire utilisée par une liste, les maillons et les figures qu'elle contient.

   @param l est un pointeur vers la liste à libérer.

   @requires l a été initialisée avec creer_liste   

*/

void detruire_liste(liste_figure_t * l);

/**

   Vérifie si la liste passée en entrée est vide.

   @param l est un pointeur vers la liste à tester.

   @requires l a été initialisée par creer_liste.

   @ensures si resultat == 1, l->taille == 0 && l->premier == NULL && l->dernier == NULL

   @ensures si resultat == 0, l->taille > 0 && l->premier != NULL && l->dernier != NULL

   @return 1 si la liste est vide, 0 sinon.

 */

int liste_est_vide(liste_figure_t * l);

/**

   Renvoie le nombre de maillon contenu dans la liste.

   @param l est un poitneur vers une liste de figures

   @requires l a été initialisé par creer_liste

   @ensures si resultat == 0, liste_est_vide(l) == 1

   @ensures si resultat == 1, l->dernier == l->premier

   @ensures si resultat > 0, liste_est_vide(l) == 0

   @return le nombre de maillon contenu dans la liste.

*/

int liste_taille(liste_figure_t * l);

   Crée un maillon pour stocker la figure passée en argument et l'insère au début de la liste de figures

   @param l est un pointeur vers une liste de figures

   @param figure est un pointeur vers une figure.

   @requires l a été initialisé avec creer_liste

   @requires figure != NULL && figure->detruire != NULL && figure->afficher != NULL

   @ensures liste_taille(resultat) == liste_taille(l) + 1

   @ensures resultat->premier->figure == figure && resultat->premier->suivant = l->premier

   @ensures si liste_taille((resultat) == 1, resultat->dernier->figure == figure 

   @ensures resultat->dernier->suivant == NULL

 */

void liste_inserer_debut(liste_figure_t * l, void * figure);

   Crée un maillon pour stocker la figure passée en argument et l'insère à la fin de la liste de figures

   @param l est un pointeur vers une liste de figures

   @param figure est un pointeur vers une figure.

   @requires l a été initialisé avec creer_liste

   @requires figure != NULL && figure->detruire != NULL && figure->afficher != NULL

   @ensures liste_taille(resultat) == liste_taille(l) + 1

   @ensures resultat->dernier->figure == figure 

   @ensures si liste_taille((resultat) == 1, resultat->premier->figure == figure && resultat->premier->suivant == NULL

   @ensures resultat->dernier->suivant == NULL

*/

void liste_inserer_fin(liste_figure_t * l, void * figure);

/**

   Extrait un maillon du début d'une liste de figure

   @param l est un pointeur vers une liste de figures.

   @requires l a été initialisé avec liste_creer

   @ensures si liste_est_vide(l) == 1, resultat == NULL

   @ensures si liste_est_vide(l) == 0, liste_taille(resultat) == liste_taille(l) -1

   @ensures si liste_est_vide(l) == 0, resultat->premier == l->premier->suivant

   @ensures si liste_est_vide(l) == 0, resultat == l->premier && resultat->suivant == NULL

   @return un pointeur vers le maillon d'une liste de figures.

*/

maillon_figure_t * liste_extraire_debut(liste_figure_t * l);