* Autores: Nicolás Dimov <sagardua@uolsinectis.com.ar>
*----------------------------------------------------------------------------
*
- * $Id: command.cpp 220 2003-11-19 23:10:40Z luca $
+ * $Id$
*
*/
*
*/
-#ifndef _PARAM_CTE_H_
-#define _PARAM_CTE_H_
+#ifndef _EMUFS_TIPO3_H_
+#define _EMUFS_TIPO3_H_
-#include "emufs.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
+#include "emufs.h"
+#include "did.h"
+#include "idx.h"
+#include "fsc.h"
-typedef struct block_free_t {
- int block;
- int free_space;
-} BLOCK_FREE_T;
-
-typedef struct block_reg_t {
- int block;
- long int id_reg;
-} BLOCK_REG_T;
+/** Devuelve un puntero con la memoria reservada que contiene al registro solicitado
+ * por el segundo parámetro \c ID, y almacena en \c reg_size el tamaño del
+ * registro leido, que en este caso no es necesario pues es constante y es conocicdo de antemano.
+ * Para realizar esta acción, busca en el archivo .idx el bloque al cual pertenece el registro.
+ * \param emu Esructura para manejar los archivos.
+ * \param ID Id del registro a leer.
+ * \param reg_size tamaño del registro.
+ * \param err Codigo de error devuelto en caso de falla.
+ */
+void* emufs_tipo3_leer_registro(EMUFS *emu, EMUFS_REG_ID ID, EMUFS_REG_SIZE* reg_size, int* err);
-int leer_registro(EMUFS *, int , void *, unsigned long);
+/** Devuelve un puntero con la memoria reservada que contiene el bloque solicitado por
+ * el segundo parámetro \c num_bloque. Como la numeración de los bloques es virtual,
+ * el acceso al archivo para levantar un bloque es directo, es decir, se posiciona directamente
+ * en en número de bloque multiplicado por el tamaño del mismo, salteando antes el encabezado del archivo.
+ * \param emu Esructura para manejar los archivos.
+ * \param block_id Numero del bloque a leer.
+ * \param err Codigo de error devuelto en caso de falla.
+ */
+void* emufs_tipo3_leer_bloque(EMUFS *emu, EMUFS_BLOCK_ID block_id, int *err);
-int leer_bloque(EMUFS *, int , void *);
+/** Graba un registro en un bloque donde haya espacio suficiente, y si no
+ * crea un nuevo bloque y lo agrega al final del archivo.
+ * El registro a grabar es apuntado por el segundo parámetro \param ptr
+ * y el tamaño viene indicado en \c tam.
+ * Luego de realizar la grabación, actualiza los archivos índice con los
+ * valores correspondientes.
+ * \param emu Esructura para manejar los archivos.
+ * \param ptr Cadena de datos que contiene el registro a grabar.
+ * \param err Codigo de error devuelto en caso de falla.
+ */
+EMUFS_REG_ID emufs_tipo3_grabar_registro(EMUFS *emu, void *ptr, EMUFS_REG_SIZE, int *err);
-int grabar_registro(EMUFS *, void *, unsigned long );
+/** Graba el bloque apuntado por \c ptr en el archivo
+ * \param emu Esructura para manejar los archivos.
+ * \param ptr Cadena de datos que contiene el bloque a grabar.
+ * \param block_id Numero del bloque a leer.
+ */
+int emufs_tipo3_grabar_bloque(EMUFS *emu, void *ptr, EMUFS_BLOCK_ID num_bloque);
-int existe_registro(EMUFS *, int);
+/** Borra el registro \c id_reg del archivo de datos, y actualiza los archivos
+ * de índice para mantener la coherencia en las próximas modificaciones.
+ * \param emu Esructura para manejar los archivos.
+ * \param id_reg Id del registro a borrar.
+ */
+int emufs_tipo3_borrar_registro(EMUFS *emu, EMUFS_REG_ID id_reg);
-int buscar_registro(EMUFS *, int);
+/** Método para modificar un registro
+ * \param emu Esructura para manejar los archivos.
+ * \param reg_id Id del registro que se quiere modificar.
+ * \param ptr Cadena de datos que contiene el nuevo registro.
+ * \param err Codigo de error devuelto en caso de falla.
+ */
+EMUFS_REG_ID emufs_tipo3_modificar_registro(EMUFS *emu, EMUFS_REG_ID reg_id, void *ptr, EMUFS_REG_SIZE, int*err);
-int buscar_lugar(EMUFS *, unsigned long , int *);
+/** Completa una estructura del tipo EMUFS_Estadisticas con las estadísticas del
+ * archivo de datos, espacio libre total, cantidad de registros, cantidad de bloques,
+ * tamaño del archivo en bytes, relaciones entre tamaños y espacios libres, etc.
+ * \param emu Esructura para manejar los archivos.
+ */
+EMUFS_Estadisticas emufs_tipo3_leer_estadisticas(EMUFS *emu);
-int get_id(EMUFS *);
+/** Lee un registro con su informacion de control
+ * \param emu Esructura para manejar los archivos.
+ * \param ID Id del registro a leer.
+ * \param reg_size Tamaño del registro.
+ * \param err Codigo de error devuelto en caso de falla.
+ */
+void* emufs_tipo3_leer_registro_raw(EMUFS *emu, EMUFS_REG_ID reg_id, EMUFS_REG_SIZE *reg_size, int *err);
-int grabar_bloque(EMUFS *, void *, int);
+/** Elimina los espacios libres que hay en el archivo
+ * \param emu Esructura para manejar los archivos.
+ */
+void emufs_tipo3_compactar(EMUFS *emu);
-int borrar_registro(EMUFS*, int, int);
+/** Lee un bloque, el anterior y el siguiente
+ * \param emu Esructura para manejar los archivos.
+ * \param block_id Id del bloque a leer.
+ * \param actual Cadena de datos que almacena el bloque indicado por \c block_id.
+ * \param anterior Cadena de datos que almacena el bloque anterior al \c actual.
+ * \param siguiente Cadena de datos que almacena el bloque siguiente al \c actual.
+ * \param size1 Tamaño del bloque actual.
+ * \param size2 Tamaño del bloque anterior.
+ * \param size3 Tamaño del bloque siguiente.
+ */
+void emufs_tipo3_leer_bloque_raw(EMUFS *emu, EMUFS_BLOCK_ID block_id, char **actual, char **anterior, char **siguiente, EMUFS_BLOCK_SIZE *size1, EMUFS_BLOCK_SIZE *size2, EMUFS_BLOCK_SIZE *size3);
-#endif /* _PARAM_CTE_H_ */
+#endif /* _EMUFS_TIPO3_H_ */