X-Git-Url: https://git.llucax.com/z.facultad/75.06/emufs.git/blobdiff_plain/1507459453b2f0c66efc1940350b2d1471f8cb5f..64651dbe1cda5fa52479608384aec8d35414e90f:/emufs/tipo2.h

diff --git a/emufs/tipo2.h b/emufs/tipo2.h
index f36aea2..e663b7d 100644
--- a/emufs/tipo2.h
+++ b/emufs/tipo2.h
@@ -23,11 +23,34 @@
  *----------------------------------------------------------------------------
  */
 
-/***************************************************************/
-/* Implementación del Tipo Archivo 2: Registros Variables, Sin */
-/* Bloques at all.                                             */
-/***************************************************************/
-
+/** \file
+ * Archivo con registros de longitud variable, sin bloques.
+ *
+ * <b>Interfaz del Archivo Tipo 2</b>
+ *
+ * La organizacion interna de un archivo de tipo 2, presenta registros de longitud variable,
+ * los cuales son grabados secuencialmente, o bien en gaps (espacios libres) que se presenten en
+ * el archivo de datos, pero no se encuentran contenidos por bloques.
+ *
+ * <b>Estructura Interna</b>: Un registro de este tipo, en disco, sera grabado de la siguiente forma:
+ *
+ * [ id_reg ][ reg_size ][ ///// reg_data ///// ]
+ * 
+ *
+ * \li EMUFS_REG_ID \c id_reg Id del registro
+ * \li EMUFS_REG_SIZE \c reg_size Size del registro
+ * \li char* \c reg_data Datos concretos del registro
+ *
+ * <b>Archivos Auxiliares:</b>
+  * Tendra tres archivos auxiliares que actuaran de Indice para localizar los registros,
+ * Indice de GAPS o FreeSpace y por ultimo Indice de ID's Libres (al borrarse regs se liberan ids).
+ *
+ * \li \c .FSC -- Indice de Gaps o Espacios Libres en el .DAT
+ * \li \c .IDX -- Indice de Posiciones Relativas u Offsets de los registros en el .DAT
+ * \li \c .DID -- Indice de Id's Libres para reutilizacion
+ *
+ */
+ 
 #ifndef _EMUFS_TIPO2_H_
 #define _EMUFS_TIPO2_H_
 
@@ -37,11 +60,60 @@
 #include <unistd.h>
 #include "emufs.h"
 
-int emufs_tipo2_inicializar(EMUFS*);
-void *emufs_tipo2_leer_registro(EMUFS* , EMUFS_REG_ID , EMUFS_REG_SIZE *, int *);
-EMUFS_REG_ID emufs_tipo2_grabar_registro(EMUFS *, void *, EMUFS_REG_SIZE, int *);
-int emufs_tipo2_borrar_registro(EMUFS*, EMUFS_REG_ID);
-int emufs_tipo2_get_regsize(EMUFS *, EMUFS_OFFSET n_RegPos,EMUFS_REG_SIZE *);
-int emufs_tipo2_dummyfill(EMUFS *, EMUFS_OFFSET n_RegPos,EMUFS_REG_SIZE n_Amount);
+/** Inicializa la estructura <em>EMUFS* efs</em> que recibe, asignando las funciones que permiten
+ * el uso del archivo tipo 2.
+ *
+ * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
+ * \return \b int Indicador de exito de la operacion.
+ */
+int emufs_tipo2_inicializar(EMUFS* efs);
+
+/** Realiza la lectura de un registro en archivos del tipo 2 en base a su \em ID, devolviendo ademas el \em Size del
+ * registro leido.
+ *
+ * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
+ * \param id_reg Id del registro a leer del archivo de datos.
+ * \param reg_size Size del registro leido que es devuelto a la funcion invocante.
+ * \param err Indicador de error en la operacion.
+ * \return \b void* Buffer con el registro leido.
+ */
+void *emufs_tipo2_leer_registro(EMUFS* efs, EMUFS_REG_ID id_reg, EMUFS_REG_SIZE* reg_size, int *err);
+
+/** Realiza la escritura de un registro en archivos del tipo 2 en base a su \em ID, devolviendo ademas el \em Size del
+ * registro leido.
+ *
+ * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
+ * \param ptr Puntero a la region de memoria que contiene el registro a grabar.
+ * \param reg_size Size del registro a grabar en disco.
+  * \param err Indicador de error en la operacion.
+ * \return \b EMUFS_REG_ID Id del registro que fue grabado.
+ */
+EMUFS_REG_ID emufs_tipo2_grabar_registro(EMUFS *efs, void *ptr, EMUFS_REG_SIZE reg_size, int* err);
+
+/** Realiza el borrado de un registro en archivos del tipo 2 en base a su \em ID.
+ *
+ * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
+ * \param id_reg Id del registro que se quiere eliminar.
+ * \return \b int Indicador de exito de la operacion.
+ */
+int emufs_tipo2_borrar_registro(EMUFS *efs, EMUFS_REG_ID id_reg);
+
+/** Devuelve el \em Size de un registro dado, en base a su \em ID.
+ *
+ * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
+ * \param reg_pos Id del registro.
+ * \param reg_size Size del registro que se devuelve a la funcion invocante.
+ * \return \b int Indicador de exito de la operacion.
+ */
+int emufs_tipo2_get_regsize(EMUFS *efs, EMUFS_OFFSET reg_pos, EMUFS_REG_SIZE *reg_size);
+
+/** Realiza un fill con basura de una region dada dentro de un .dat del tipo2.
+ *
+ * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
+ * \param reg_pos Offset donde comenzar el fill con basura.
+ * \param amount Cantidad de bytes a escribir en la region indicada.
+ * \return \b int Indicador de exito de la operacion.
+ */
+int emufs_tipo2_dummyfill(EMUFS *efs, EMUFS_OFFSET reg_pos, EMUFS_REG_SIZE amount);
 
 #endif /* _EMUFS_TIPO2_H_ */