Projet Informatique Théorique 2016
Instructions et Documentation
fifo.h
1 /*
2  * Ce fichier fait partie d'un projet de programmation donné en Licence 3
3  * à l'Université de Bordeaux.
4  *
5  * Copyright (C) 2014 Adrien Boussicault
6  *
7  * This Library is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This Library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this Library. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 
22 #ifndef __FIFO_H__
23 #define __FIFO_H__
24 
25 #include <stdint.h>
26 
27 /*
28  * Définit le type d'une file first-in first-out contenant des entiers ou
29  * des pointerus vers des stucture plus complexes.
30  * La file n'est pas responsable de la mémoire des éléments qui y sont
31  * entreposés.
32  */
33 typedef struct Fifo Fifo;
34 
35 /*
36  * Créer une file vide
37  */
38 Fifo* creer_fifo();
39 
40 /*
41  * Supprimme la mémoire associée à la file.
42  * La mamoir associée aux élément de la file ne sont pas supprimé.
43  */
44 void liberer_fifo( Fifo* fifo );
45 
46 /*
47  * Renvoie vrai si la file ne contient pas d'élement.
48  */
49 int est_vide( Fifo* fifo );
50 
51 /*
52  * Ajoute un élément au dessus de la pile.
53  */
54 void ajouter_fifo( Fifo* fifo, intptr_t element );
55 
56 /*
57  * Retire un élément du dessus de la pile et le renvoie.
58  */
59 intptr_t retirer_fifo( Fifo* fifo );
60 
61 /*
62  * Renvoie l'élement qui se trouve au dessus de la pile. L'élément n'est pas
63  * retiré de la pile.
64  */
65 intptr_t obtenir_fifo( Fifo* fifo );
66 
67 #endif
Definition: fifo.c:32