asi esta bien?

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

diff --git a/emufs/tipo3.h b/emufs/tipo3.h
index 4d05c87a0c5a32ac71ad012a0bc245e9b855bc7d..12ed7321bd00190d37d10d337f9315c0e3f1cb35 100644 (file)
--- a/emufs/tipo3.h
+++ b/emufs/tipo3.h
@@ -22,7 +22,7 @@
  * Autores: Nicolás Dimov <sagardua@uolsinectis.com.ar>
  *----------------------------------------------------------------------------
  *
- * $Id: command.cpp 220 2003-11-19 23:10:40Z luca $
+ * $Id$
  *
  */
 
@@ -35,8 +35,8 @@
  *
  */
 
-#ifndef _PARAM_CTE_H_
-#define _PARAM_CTE_H_
+#ifndef _EMUFS_TIPO3_H_
+#define _EMUFS_TIPO3_H_
 
 #include <stdio.h>
 #include <stdlib.h>
@@ -45,35 +45,54 @@
 #include "emufs.h"
 #include "did.h"
 #include "idx.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;
-
-int emufs_tipo3_leer_registro(EMUFS *, int , void *, unsigned long);
-
-int emufs_tipo3_leer_bloque(EMUFS *, int , void *);
-
-int emufs_tipo3_grabar_registro(EMUFS *, void *, unsigned long );
-
-int emufs_tipo3_grabar_bloque(EMUFS *, void *, int);
-
-int emufs_tipo3_get_id(EMUFS *);
-
-int emufs_tipo3_existe_registro(EMUFS *, int);
-
-int emufs_tipo3_buscar_registro(EMUFS *, int);
-
-int emufs_tipo3_buscar_lugar(EMUFS *, unsigned long , int *);
-
-int emufs_tipo3_borrar_registro(EMUFS*, int, int);
-
-
-#endif /* _PARAM_CTE_H_ */
+#include "fsc.h"
+
+/** 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.
+  */
+void* emufs_tipo3_leer_registro(EMUFS *emu, EMUFS_REG_ID ID, EMUFS_REG_SIZE* reg_size, int* err);
+
+/** 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.
+  */
+void* emufs_tipo3_leer_bloque(EMUFS*, EMUFS_BLOCK_ID, int*);
+
+/** 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.
+  */
+EMUFS_REG_ID emufs_tipo3_grabar_registro(EMUFS *emu, void *ptr, EMUFS_REG_SIZE, int*);
+
+/** Graba el bloque apuntado por \c ptr en el archivo */
+int emufs_tipo3_grabar_bloque(EMUFS *emu, void *ptr, EMUFS_BLOCK_ID num_bloque);
+
+/** 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.
+  */
+int emufs_tipo3_borrar_registro(EMUFS *emu, EMUFS_REG_ID id_reg);
+
+/** Método para modificar un registro */
+EMUFS_REG_ID emufs_tipo3_modificar_registro(EMUFS *emu, EMUFS_REG_ID, void*, EMUFS_REG_SIZE, 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.
+  */
+EMUFS_Estadisticas emufs_tipo3_leer_estadisticas(EMUFS *);
+
+/** Lee un registro con su informacion de control */
+void* emufs_tipo3_leer_registro_raw(struct _emu_fs_t*, EMUFS_REG_ID, EMUFS_REG_SIZE*, int *);
+
+/** Elimina los espacios libres que hay en el archivo */
+void emufs_tipo3_compactar(EMUFS *emu);
+
+void emufs_tipo3_leer_bloque_raw(EMUFS *efs, EMUFS_BLOCK_ID id, char **actual, char **anterior, char **siguiente, EMUFS_BLOCK_SIZE *size1, EMUFS_BLOCK_SIZE *size2, EMUFS_BLOCK_SIZE *size3);
+
+#endif /* _EMUFS_TIPO3_H_ */