cambio los tipos de EMUFS_FSC y agrego doxycomentarios en tipo3.h

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

diff --git a/emufs/emufs.h b/emufs/emufs.h
index 2469d3b17c2ef389d82a5e9a3d19d5ab0c7011ac..381049dd08f3545fe070670d03a0035bbea01e70 100644 (file)
--- a/emufs/emufs.h
+++ b/emufs/emufs.h
@@ -1,4 +1,4 @@
-/* vim: set noexpandtab tabstop=4 shiftwidth=4:
+/* vim: set noexpandtab tabstop=4 shiftwidth=4 wrap:
  *----------------------------------------------------------------------------
  *                                  emufs
  *----------------------------------------------------------------------------
@@ -42,20 +42,14 @@
 
 #include <stdlib.h>
 #include <stdio.h>
-
-#ifdef DEBUG
-       /** Imprime un mensaje de debug por pantalla. */
-       #define PERR(msg) fprintf(stderr, "%s:%d> %s.\n",__FILE__, __LINE__, msg);
-#else
-       #define PERR(msg) ;
-#endif /* DEBUG */
+#include <limits.h>
 
 /** Tipo de archivo. */
 typedef enum {
        T1, /**< Archivo de bloque parametrizado y registro variable. */
        T2, /**< Archivo sin bloques y registros variables. */
        T3  /**< Archivo de bloque parametrizado y registro fijo. */
-} EMUFS_TYPE;
+} EMUFS_Tipo;
 
 /** Tipo de identificador de registro. */
 typedef unsigned long EMUFS_REG_ID;
@@ -81,10 +75,18 @@ typedef unsigned long EMUFS_OFFSET;
  */
 #define EMUFS_NOT_FOUND -1ul
 
-/** Estadisticas de archivo */
+/** Estadisticas de archivo. */
 typedef struct _emufs_est_t {
-       unsigned long tam_archivo;
-} EMUFS_Estadistidas;
+       unsigned long tam_archivo;/**< Tamaño en bytes del archivo .dat */
+       unsigned long tam_archivos_aux;/**< Tamaño en bytes de los archivos auxiliares sumados */
+       unsigned long tam_info_control_dat;/**< Cantidad de bytes en info de control del .dat */
+       unsigned long media_fs;/**< Media del espacio libre en el archivo de datos */
+       unsigned long total_fs;/**< Cantidad total de espacio libre en el archivo de datos */
+       unsigned long max_fs;/**< Cantidad de maxima libre (gap o fs en bloque) en el archivo de datos */
+       unsigned long min_fs;/**< Cantidad de minima libre (gap o fs en bloque) en el archivo de datos */
+       unsigned long cant_bloques; /**< Cantidad de bloques en el archivo de datos */
+       unsigned long cant_registros; /**< Cantidad de Registros en el archivo */
+} EMUFS_Estadisticas;
 
 /** Tipo Abstracto para menajo de archivos.
  *
@@ -105,15 +107,18 @@ typedef struct _emufs_est_t {
  *  para llamar al método correspondiente a cada tipo de archivo.
  */
 typedef struct _emu_fs_t {
-       EMUFS_TYPE tipo;
+       EMUFS_Tipo tipo;
        EMUFS_BLOCK_SIZE tam_bloque; /**< Tamaño de bloque. 0 Si no tiene bloques */
        EMUFS_REG_SIZE tam_reg; /**< Tamaño de registro. 0 Si son registros variables */        
        void* (*leer_bloque)(struct _emu_fs_t*, EMUFS_BLOCK_ID, int*); /**< Método para leer un bloque */
+       void (*leer_bloque_raw)(struct _emu_fs_t*, EMUFS_BLOCK_ID, char **, char **, char **, EMUFS_BLOCK_SIZE *, EMUFS_BLOCK_SIZE *, EMUFS_BLOCK_SIZE *); /**< Método para leer un bloque, el anterior y el siguiente */
        void* (*leer_registro)(struct _emu_fs_t*, EMUFS_REG_ID, EMUFS_REG_SIZE*, int*); /**< Método para leer un registro */
+       void* (*leer_registro_raw)(struct _emu_fs_t*, EMUFS_REG_ID, EMUFS_REG_SIZE*, int *); /**< Método para leer un registro con todo su bloque asociado */
        EMUFS_REG_ID (*grabar_registro)(struct _emu_fs_t*, void*, EMUFS_REG_SIZE, int*); /**< Método para grabar un registro */
        EMUFS_REG_ID (*modificar_registro)(struct _emu_fs_t*, EMUFS_REG_ID, void*, EMUFS_REG_SIZE, int*); /**< Método para modificar un registro */
        int (*borrar_registro)(struct _emu_fs_t*, EMUFS_REG_ID); /**< Método para borrar un registro */
-       EMUFS_Estadistidas (*leer_estadisticas)(struct _emu_fs_t *);
+       EMUFS_Estadisticas (*leer_estadisticas)(struct _emu_fs_t *); /**< Método para obtener estádisticas sobre el archivo */
+       void (*compactar)(struct _emu_fs_t *); /**< Método para compactar el archivo reorganizándolo físicamente */
        char *nombre; /**< Nombre del archivo */
 } EMUFS;
 
@@ -145,8 +150,7 @@ int emufs_crear_archivo_auxiliar(const char*, const char*);
  *  \param tam_bloque Tamaño del bloque.
  *  \param tam_reg Tamaño del registro.
  */
-EMUFS *emufs_crear(const char *filename, EMUFS_TYPE tipo,
-               EMUFS_BLOCK_SIZE tam_bloque, EMUFS_REG_SIZE tam_reg);
+EMUFS *emufs_crear(const char *filename, EMUFS_Tipo tipo,EMUFS_BLOCK_SIZE tam_bloque, EMUFS_REG_SIZE tam_reg);
 
 /** Abre un archivo EMUFS.
  *
@@ -159,6 +163,10 @@ EMUFS *emufs_abrir(const char *filename);
 /** Libera un archivo virtual */
 int emufs_destruir(EMUFS *e);
 
+/** mustra archivos auxiliares, para debug. */
 int ver_archivo_FS(EMUFS *emu);
 
+/** muestra estadisticas, para debug. */
+int debug_ver_estadisticas(EMUFS *emu);
+
 #endif /* _EMUFS_H_ */