* Agrego leer_registro_raw en EMUFS y para tipo3

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

diff --git a/emufs/emufs.h b/emufs/emufs.h
index 7cc89e034f5021ac021a866367c0f6ddbf82f2fe..6ba63b38aa97caaa3de41fa339aa6f600d1c5eac 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
  *----------------------------------------------------------------------------
  *----------------------------------------------------------------------------
  *                                  emufs
  *----------------------------------------------------------------------------


@@ -24,7 +24,7 @@
  *          Leandro Lucarella <llucare@fi.uba.ar>
  *----------------------------------------------------------------------------
  *
  *          Leandro Lucarella <llucare@fi.uba.ar>
  *----------------------------------------------------------------------------
  *

- * $Id: command.cpp 220 2003-11-19 23:10:40Z luca $
+ * $Id$

  *
  */
 
  *
  */
 


@@ -43,12 +43,55 @@
 #include <stdlib.h>
 #include <stdio.h>
 
 #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 */
+

 /** 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. */
 /** 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;
+
+/** Tipo de tamaño de registro. */
+typedef unsigned long EMUFS_REG_SIZE;
+
+/** Tipo de identificador de bloque. */
+typedef unsigned long EMUFS_BLOCK_ID;
+
+/** Tipo de tamaño de bloque. */
+typedef unsigned long EMUFS_BLOCK_SIZE;
+
+/** Tipo de espacio libre. */
+typedef unsigned long EMUFS_FREE;
+
+/** Tipo de offset. */
+typedef unsigned long EMUFS_OFFSET;
+
+/** Constante para indicar el valor especial de un ID inválido.
+ *
+ *  El uso típico es para indicar que no se encontró el ID en una búsqueda.
+ */
+#define EMUFS_NOT_FOUND -1ul
+
+/** Estadisticas de archivo */
+typedef struct _emufs_est_t {
+       unsigned long tam_archivo;
+       unsigned long tam_archivo_bytes;
+       unsigned long info_control;
+       EMUFS_FREE media_fs;
+       EMUFS_FREE total_fs;
+       EMUFS_FREE max_fs;
+       EMUFS_FREE min_fs;
+       int cant_bloques;
+} EMUFS_Estadisticas;

 
 /** Tipo Abstracto para menajo de archivos.
  *
 
 /** Tipo Abstracto para menajo de archivos.
  *


@@ -69,38 +112,48 @@ typedef enum {
  *  para llamar al método correspondiente a cada tipo de archivo.
  */
 typedef struct _emu_fs_t {
  *  para llamar al método correspondiente a cada tipo de archivo.
  */
 typedef struct _emu_fs_t {

-       EMUFS_TYPE tipo;
-       unsigned long tam_bloque; /**< Tamaño de bloque. 0 Si no tiene bloques */
-       int (*leer_bloque)(struct _emu_fs_t *, int, void *); /**< Método para leer un bloque */
-       int (*leer_registro)(struct _emu_fs_t *, int, void *, unsigned long); /**< Método para leer un registro */
-       int (*grabar_registro)(struct _emu_fs_t *, void *, unsigned long ); /**< Método para grabar un registro */
-       int (*borrar_registro)(struct _emu_fs_t *, int, int); /**< Método para borrar un registro */
+       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_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_Estadisticas (*leer_estadisticas)(struct _emu_fs_t *);

        char *nombre; /**< Nombre del archivo */
 } EMUFS;
 
        char *nombre; /**< Nombre del archivo */
 } EMUFS;
 

+/** Crea un archivo auxiliar. */
+int emufs_crear_archivo_auxiliar(const char*, const char*);
+

 /** Crea un nuevo archivo EMUFS.
  *
 /** Crea un nuevo archivo EMUFS.
  *

- *  Un archivo EMUFS está compuesto por 4 archivos a nivel del sistema operativo.
- *  Un archivo principal con extensión .dat y 3 archivos auxiliares para manejo interno.
+ *  Un archivo EMUFS está compuesto por 4 archivos a nivel del SO.
+ *  Un archivo principal con extensión .dat y 3 archivos auxiliares para
+ *  manejo interno.

  *
  *

- *  El parámetro filename que recive esta función en el nombre virtual que se utilizará, ya
- *  que las extensiones serán puestas automáticamente for EMUFS.
+ *  El parámetro filename que recive esta función en el nombre virtual que se
+ *  utilizará, ya que las extensiones serán puestas automáticamente for EMUFS.

  *
  *  Un ejemplo:
  *  \code
  *  EMUFS *fp  emufs_crear("archivo", T3, 100, 100);
  *  \endcode
  *
  *
  *  Un ejemplo:
  *  \code
  *  EMUFS *fp  emufs_crear("archivo", T3, 100, 100);
  *  \endcode
  *

- *  En el ejemplo anterior se tiene que nuestro filesystem virtual se llamará archivo.
+ *  En el ejemplo anterior se tiene que nuestro filesystem virtual se llamará
+ *  archivo.

  *
  *

- *  Los últimos 2 parámetros serán ignorados si el tipo de archivo no utiliza dicho parámetro.
+ *  Los últimos 2 parámetros serán ignorados si el tipo de archivo no utiliza
+ *  dicho parámetro.

  *
  *  \param filename Nombre del archivo virtual.
  *  \param tipo Tipo de archivo.
  *  \param tam_bloque Tamaño del bloque.
  *  \param tam_reg Tamaño del registro.
  */
  *
  *  \param filename Nombre del archivo virtual.
  *  \param tipo Tipo de archivo.
  *  \param tam_bloque Tamaño del bloque.
  *  \param tam_reg Tamaño del registro.
  */

-EMUFS *emufs_crear(const char *filename, char tipo, unsigned int tam_bloque, unsigned int 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.
  *
 
 /** Abre un archivo EMUFS.
  *