]> git.llucax.com Git - z.facultad/75.42/calculadora.git/blobdiff - dllist.h
Se cambia el inicializador para que sea más parecido a un constructor y se actualiza...
[z.facultad/75.42/calculadora.git] / dllist.h
index 432e742a804dd573a5b1d63f801e6c7f0c470de5..80aff11ded80a55ac2f64c6891354c138f118e18 100644 (file)
--- a/dllist.h
+++ b/dllist.h
@@ -40,9 +40,10 @@ struct DLNodeStruct {
 /**
  * Lista doblemente enlazada.
  *
- * \see DLList_init(), DLList_empty(), DLList_begin(), DLList_end(),
- *      DLList_have_more(), DLList_current(), DLList_next(), DLList_prev(),
- *      DLList_unshift(), DLList_push(), DLList_shift(), DLList_pop()
+ * \see DLList_new(), DLList_delete(), DLList_empty(), DLList_begin(),
+ *      DLList_end(), DLList_have_more(), DLList_current(), DLList_next(),
+ *      DLList_prev(), DLList_unshift(), DLList_push(), DLList_shift(),
+ *      DLList_pop()
  */
 typedef struct {
     /** Puntero al primer nodo. */
@@ -54,13 +55,20 @@ typedef struct {
 } DLList;
 
 /**
- * Inicializa la DLList.
+ * Crea una nueva lista.
  *
- * \param   list DLList a inicializar.
+ * \return  Puntero a la nueva DLList o NULL si no hay más memoria.
+ */
+DLList* DLList_new(void);
+
+/**
+ * Libera la memoria ocupada por una lista.
  *
- * \return  \ref TRUE si se inicializó bien, \ref FALSE si hay error.
+ * \param   list DLList a liberar.
+ *
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente.
  */
-bool DLList_init(DLList* list);
+void DLList_delete(DLList* list);
 
 /**
  * Indica si la DLList está vacía.
@@ -68,7 +76,7 @@ bool DLList_init(DLList* list);
  * \param   list DLList a verificar.
  *
  * \return  \ref TRUE si está vacía, \ref FALSE si no.
- * \pre     La DLList debe estar \ref DLList_init "inicializada".
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente.
  */
 bool DLList_empty(DLList* list);
 
@@ -91,7 +99,7 @@ bool DLList_empty(DLList* list);
  *
  * \return  Primer elemento o NULL si está vacía.
  * \see     DLList_have_more(), DLList_next(), DLList_end(), DLList_prev()
- * \pre     La DLList debe estar \ref DLList_init "inicializada".
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente.
  */
 void* DLList_begin(DLList* list);
 
@@ -114,7 +122,7 @@ void* DLList_begin(DLList* list);
  *
  * \return  Último elemento o NULL si está vacía.
  * \see     DLList_have_more(), DLList_prev(), DLList_begin(), DLList_next()
- * \pre     La DLList debe estar \ref DLList_init "inicializada".
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente.
  */
 void* DLList_end(DLList* list);
 
@@ -125,7 +133,7 @@ void* DLList_end(DLList* list);
  *
  * \return  \ref TRUE si se puede obtener otro elemento, \ref FALSE si no.
  * \see     DLList_begin(), DLList_end(), DLList_prev(), DLList_next()
- * \pre     La DLList debe estar \ref DLList_init "inicializada".
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente.
  */
 bool DLList_have_more(DLList* list);
 
@@ -136,7 +144,7 @@ bool DLList_have_more(DLList* list);
  *
  * \return  Elemento actual o NULL si se terminó de recorrer o está vacía.
  * \see     DLList_prev(), DLList_next(), DLList_have_more()
- * \pre     La DLList debe estar \ref DLList_init "inicializada".
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente.
  */
 void* DLList_current(DLList* list);
 
@@ -147,7 +155,7 @@ void* DLList_current(DLList* list);
  *
  * \return  Siguiente elemento o NULL si es el último.
  * \see     DLList_begin(), DLList_have_more(), DLList_current(), DLList_prev()
- * \pre     La DLList debe estar \ref DLList_init "inicializada".
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente.
  */
 void* DLList_next(DLList* list);
 
@@ -158,7 +166,7 @@ void* DLList_next(DLList* list);
  *
  * \return  Elemento anterior o NULL si es el primero.
  * \see     DLList_begin(), DLList_have_more(), DLList_current(), DLList_next()
- * \pre     La DLList debe estar \ref DLList_init "inicializada".
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente.
  */
 void* DLList_prev(DLList* list);
 
@@ -170,7 +178,7 @@ void* DLList_prev(DLList* list);
  *
  * \return  \ref TRUE si se agregó, \ref FALSE si no hay más memoria.
  * \see     DLList_push(), DLList_pop(), DLList_unshift()
- * \pre     La DLList debe estar \ref DLList_init "inicializada".
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente.
  * \post    El puntero interno de la DLList apunta al nuevo elemento.
  */
 bool DLList_unshift(DLList* list, void* data);
@@ -183,7 +191,7 @@ bool DLList_unshift(DLList* list, void* data);
  *
  * \return  \ref TRUE si se agregó, \ref FALSE si no hay más memoria.
  * \see     DLList_pop(), DLList_shift(), DLList_unshift()
- * \pre     La DLList debe estar \ref DLList_init "inicializada".
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente.
  * \post    El puntero interno de la DLList apunta al nuevo elemento.
  */
 bool DLList_push(DLList* list, void* data);
@@ -191,13 +199,23 @@ bool DLList_push(DLList* list, void* data);
 /**
  * Saca el primer elemento de la DLList.
  * Elimina el primer elemento de la DLList devolviendo su contenido.
+ * Ejemplo:
+ * \code
+ * DLList* l;
+ * char*   data;
+ * ...
+ * while (!DLList_empty(l)) {
+ *      data = DLList_shift(l);
+ *      printf("El elemento actual es '%s'.\\n", data);
+ * }
+ * \endcode
  *
  * \param   list DLList de la cual sacar el elemento.
  *
  * \return  Primer elemento de la DLList.
- * \see     DLList_push(), DLList_shift(), DLList_unshift()
- * \pre     La DLList debe estar \ref DLList_init "inicializada" y no
- *          \ref DLList_empty "vacía".
+ * \see     DLList_empty(), DLList_pop()
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente y no
+ *          debe estar \ref DLList_empty "vacía.
  * \post    El puntero interno de la DLList apunta primer elemento.
  */
 void* DLList_shift(DLList* list);
@@ -205,13 +223,23 @@ void* DLList_shift(DLList* list);
 /**
  * Saca el último elemento de la DLList.
  * Elimina el último elemento de la DLList devolviendo su contenido.
+ * Ejemplo:
+ * \code
+ * DLList* l;
+ * char*   data;
+ * ...
+ * while (!DLList_empty(l)) {
+ *      data = DLList_pop(l);
+ *      printf("El elemento actual es '%s'.\\n", data);
+ * }
+ * \endcode
  *
  * \param   list DLList de la cual sacar el elemento.
  *
- * \return  último elemento de la DLList.
- * \see     DLList_push(), DLList_shift(), DLList_unshift()
- * \pre     La DLList debe estar \ref DLList_init "inicializada" y no
- *          \ref DLList_empty "vacía".
+ * \return  Último elemento de la DLList.
+ * \see     DLList_empty(), DLList_shift()
+ * \pre     La DLList debe estar \ref DLList_new "creada" correctamente y no
+ *          debe estar \ref DLList_empty "vacía.
  * \post    El puntero interno de la DLList apunta último elemento.
  */
 void* DLList_pop(DLList* list);