* Mais bonitou ...

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

diff --git a/emufs/emufs.h b/emufs/emufs.h
index 81d62b311d5766d88af36dfdbbfce373fb5df85c..280b72aedf608f2ab16659cc37a9b5b4643e1619 100644 (file)
--- a/emufs/emufs.h
+++ b/emufs/emufs.h
@@ -1,3 +1,42 @@
+/* vim: set noexpandtab tabstop=4 shiftwidth=4:
+ *----------------------------------------------------------------------------
+ *                                  emufs
+ *----------------------------------------------------------------------------
+ * This file is part of emufs.
+ *
+ * emufs is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU General Public License as published by the Free Software
+ * Foundation; either version 2 of the License, or (at your option) any later
+ * version.
+ *
+ * emufs is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with emufs; if not, write to the Free Software Foundation, Inc., 59 Temple
+ * Place, Suite 330, Boston, MA  02111-1307  USA
+ *----------------------------------------------------------------------------
+ * Creado:  mié mar 31 17:26:46 ART 2004
+ * Autores: Nicolás Dimov <sagardua@uolsinectis.com.ar>
+ *          Ricardo Markiewicz <rmarkie@fi.uba.ar>
+ *          Leandro Lucarella <llucare@fi.uba.ar>
+ *----------------------------------------------------------------------------
+ *
+ * $Id$
+ *
+ */
+
+/** \file
+ *
+ * Estructura general de un archivo <em>abstracto</em> de emufs.
+ * 
+ * Interfaz de la estructura abstracta que representa cualquiera de los tipos
+ * de archivo implementados.
+ *
+ */
+
 #ifndef _EMUFS_H_
 #define _EMUFS_H_
 
@@ -11,6 +50,24 @@ typedef enum {
        T3  /**< Archivo de bloque parametrizado y registro fijo. */
 } EMUFS_TYPE;
 
+/** 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;
+
 /** Tipo Abstracto para menajo de archivos.
  *
  *  Esta estructura es utilizada para acceder a cualquier tipo de archivo.
@@ -31,37 +88,45 @@ typedef enum {
  */
 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_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 */        
+       int (*leer_bloque)(struct _emu_fs_t*, EMUFS_BLOCK_ID, void*); /**< Método para leer un bloque */
+       int (*leer_registro)(struct _emu_fs_t*, EMUFS_REG_ID, void *); /**< Método para leer un registro */
+       EMUFS_REG_ID (*grabar_registro)(struct _emu_fs_t*, void*, EMUFS_REG_SIZE); /**< Método para grabar un registro */
+       int (*borrar_registro)(struct _emu_fs_t*, EMUFS_REG_ID); /**< Método para borrar un registro */
        char *nombre; /**< Nombre del archivo */
 } EMUFS;
 
+/** Crea un archivo auxiliar. */
+int emufs_crear_archivo_auxiliar(const char*, const char*);
+
 /** 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
  *
- *  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.
  */
-EMUFS *emufs_crear(const char *filename, char tipo, unsigned int tam_bloque, unsigned int tam_reg);
+EMUFS *emufs_crear(const char *filename, EMUFS_TYPE tipo,
+               EMUFS_BLOCK_SIZE tam_bloque, EMUFS_REG_SIZE tam_reg);
 
 /** Abre un archivo EMUFS.
  *
@@ -76,4 +141,4 @@ int emufs_destruir(EMUFS *e);
 
 int ver_archivo_FS(EMUFS *emu);
 
-#endif
+#endif /* _EMUFS_H_ */