- Se doxygenan comentarios.

[z.facultad/75.06/emufs.git] / emufs / tipo1.h

diff --git a/emufs/tipo1.h b/emufs/tipo1.h
index efd68c97060905e70715e7f0ec9bd230778ad6d1..ec74926df35815ff0f588c295407fd8b3c6149b6 100644 (file)
--- a/emufs/tipo1.h
+++ b/emufs/tipo1.h
@@ -40,31 +40,37 @@
 
 #include "emufs.h"
 
-int emufs_tipo1_inicializar(EMUFS*);
+/** Inicializa un EMUFS para poder ser utilizado como un archivo tipo1.
+ *
+ * \param efs Estructura a inicializar.
+ * \return Código de error o EMUFS_OK si no hubo error.
+ */
+int emufs_tipo1_inicializar(EMUFS* efs);
 
-/** Lee el registro \param id_reg y lo almacena en \param ptr */
-int emufs_tipo1_leer_registro(EMUFS *emu, EMUFS_REG_ID id_reg, void *ptr,
-               EMUFS_REG_SIZE tam_reg);
+/** Lee el registro \c reg_id y devolviendo su contenido. */
+void* emufs_tipo1_leer_registro(EMUFS*, CLAVE, EMUFS_REG_SIZE*, int*);
 
-/** Lee el bloque \param num_bloque y lo almacena en \param ptr */
-int emufs_tipo1_leer_bloque(EMUFS *emu, EMUFS_BLOCK_ID num_bloque, void *ptr);
+/** Graba un registro en el archivo. */
+EMUFS_REG_ID emufs_tipo1_grabar_registro(EMUFS*, void*, EMUFS_REG_SIZE, int*);
 
-/** Graba el registro apuntado por \param ptr en el archivo */
-EMUFS_REG_ID emufs_tipo1_grabar_registro(EMUFS* emu, void* ptr, EMUFS_REG_SIZE);
+/** Borra un registro de del archivo. */
+int emufs_tipo1_borrar_registro(EMUFS*, CLAVE);
 
-/** Graba el bloque apuntado por \param ptr en el archivo */
-int emufs_tipo1_grabar_bloque(EMUFS *emu, void *ptr, EMUFS_BLOCK_ID num_bloque);
+/** Método para modificar un registro. */
+EMUFS_REG_ID emufs_tipo1_modificar_registro(EMUFS *emu, EMUFS_REG_ID, void*, EMUFS_REG_SIZE, int*);
 
-EMUFS_REG_ID emufs_tipo1_get_id(EMUFS *emu);
+/** Método para leer un registro con todo su bloque asociado. */
+void* emufs_tipo1_leer_registro_raw(EMUFS *emu, EMUFS_REG_ID id, EMUFS_REG_SIZE *size, int *pos);
 
-int emufs_tipo1_buscar_registro(EMUFS *emu, EMUFS_REG_ID id_reg);
+/** Obtiene estádisticas del archivo */
+EMUFS_Estadisticas emufs_tipo1_leer_estadisticas(EMUFS*);
 
-int emufs_tipo1_borrar_registro(EMUFS *emu, EMUFS_REG_ID id_reg,
-               EMUFS_REG_SIZE tam_reg);
+/** Método para compactar el archivo reorganizándolo físicamente */
+void emufs_tipo1_compactar(EMUFS*);
 
-/*
-int emufs_tipo1_buscar_lugar(EMUFS *emu, EMUFS_REG_SIZE tam_reg,
-               EMUFS_FREE *free_space);
-*/
+/** Lee un bloque y su contexto, en bruto (con cabeceras). */
+void emufs_tipo1_leer_bloque_raw(EMUFS *efs, EMUFS_BLOCK_ID id, char **actual,
+               char **anterior, char **siguiente, EMUFS_BLOCK_SIZE *size1,
+               EMUFS_BLOCK_SIZE *size2, EMUFS_BLOCK_SIZE *size3);
 
 #endif /* _EMUFS_TIPO1_H_ */