emufs/emufs.h

   1 #ifndef _EMUFS_H_
   2 #define _EMUFS_H_
   3
   4 #include <stdlib.h>
   5 #include <stdio.h>
   6
   7 /** Tipo de archivo. */
   8 typedef enum {
   9         T1, /**< Archivo de bloque parametrizado y registro variable. */
  10         T2, /**< Archivo sin bloques y registros variables. */
  11         T3  /**< Archivo de bloque parametrizado y registro fijo. */
  12 } EMUFS_TYPE;
  13
  14 /** Tipo Abstracto para menajo de archivos.
  15  *
  16  *  Esta estructura es utilizada para acceder a cualquier tipo de archivo.
  17  *
  18  *  Cuando se requiere abrir o crear un nuevo archivo, esta estrucura contendrá los
  19  *  punteros a los métodos de dicho archivo, por lo que desde el código que utilice
  20  *  esta estructura no deberá ser modificado por cada tipo de archivo.
  21  *
  22  *  Por ejemplo:
  23  *  \code
  24  *    EMUFS *fs = emufs_abrir("archivo");
  25  *    fs->leer_registro(id, ptr, size);
  26  *  \endcode
  27  *
  28  *  Este ejemplo funcionará sin importar de que tipo de archivo se trate, sin
  29  *  la necesidad de que el usuario tenga que hacer una selección previa del tipo
  30  *  para llamar al método correspondiente a cada tipo de archivo.
  31  */
  32 typedef struct _emu_fs_t {
  33         EMUFS_TYPE tipo;
  34         unsigned long tam_bloque; /**< Tamaño de bloque. 0 Si no tiene bloques */
  35         int (*leer_bloque)(struct _emu_fs_t *, int, void *); /**< Método para leer un bloque */
  36         int (*leer_registro)(struct _emu_fs_t *, int, void *, unsigned long); /**< Método para leer un registro */
  37         int (*grabar_registro)(struct _emu_fs_t *, void *, unsigned long ); /**< Método para grabar un registro */
  38         int (*borrar_registro)(struct _emu_fs_t *, int, int); /**< Método para borrar un registro */
  39         char *nombre; /**< Nombre del archivo */
  40 } EMUFS;
  41
  42 /** Crea un nuevo archivo EMUFS.
  43  *
  44  *  Un archivo EMUFS está compuesto por 4 archivos a nivel del sistema operativo.
  45  *  Un archivo principal con extensión .dat y 3 archivos auxiliares para manejo interno.
  46  *
  47  *  El parámetro filename que recive esta función en el nombre virtual que se utilizará, ya
  48  *  que las extensiones serán puestas automáticamente for EMUFS.
  49  *
  50  *  Un ejemplo:
  51  *  \code
  52  *  EMUFS *fp  emufs_crear("archivo", T3, 100, 100);
  53  *  \endcode
  54  *
  55  *  En el ejemplo anterior se tiene que nuestro filesystem virtual se llamará archivo.
  56  *
  57  *  Los últimos 2 parámetros serán ignorados si el tipo de archivo no utiliza dicho parámetro.
  58  *
  59  *  \param filename Nombre del archivo virtual.
  60  *  \param tipo Tipo de archivo.
  61  *  \param tam_bloque Tamaño del bloque.
  62  *  \param tam_reg Tamaño del registro.
  63  */
  64 EMUFS *emufs_crear(const char *filename, char tipo, unsigned int tam_bloque, unsigned int tam_reg);
  65
  66 /** Abre un archivo EMUFS.
  67  *
  68  *  Abre un archivo, determinando de que tipo se trata.
  69  *
  70  *  \param filename Nombre del archivo virtual.
  71  */
  72 EMUFS *emufs_abrir(const char *filename);
  73
  74 /** Libera un archivo virtual */
  75 int emufs_destruir(EMUFS *e);
  76
  77 int ver_archivo_FS(EMUFS *emu);
  78
  79 #endif