un poco mas de B+

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

diff --git a/emufs/idx.h b/emufs/idx.h
index e183892253c319cd2614b4d28be116d33a2b42a2..4d40895ca49d31abfea5c489ea6905f48ed0e619 100644 (file)
--- a/emufs/idx.h
+++ b/emufs/idx.h
@@ -1,8 +1,99 @@
-#ifndef _IDX_H
-#define _IDX_H
+/* 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:  jue abr  8 18:11:46 ART 2004
+ * Autores: Nicolás Dimov <sagardua@uolsinectis.com.ar>
+ *          Leandro Lucarella <llucare@fi.uba.ar>
+ *----------------------------------------------------------------------------
+ *
+ * $Id$
+ *
+ */
+
+/** \file
+ *
+ * Manejo de archivos de índice de registros.
+ * 
+ * Interfaz del manejo de archivos de índice de registros.
+ *
+ */
+
+#ifndef _EMUFS_IDX_H
+#define _EMUFS_IDX_H
+
 #include <string.h>
+#include <unistd.h>
 #include "emufs.h"
 
-int emufs_idx_buscar_mayor_id(EMUFS *);
+#define EMUFS_IDX_EXT ".idx"
+
+/** Estructura que define el archivo .idx
+  *\param id_reg ID del registro.
+  *\param location Numero de bloque.
+  */
+typedef struct emufs_idx_t {
+       EMUFS_REG_ID id_reg;
+       EMUFS_BLOCK_ID location;
+} EMUFS_IDX;
+
+
+/** Abre el archivo */
+FILE* emufs_idx_abrir(EMUFS*, const char*);
+
+/** Crea el archivo vacio */
+int emufs_idx_crear(EMUFS*);
+
+/** Devuelve el mayor id libre para un nuevo registro  */
+EMUFS_REG_ID emufs_idx_buscar_mayor_id_libre(EMUFS*, int*);
+
+/** Busca el bloque al que pertenece el id \c reg_id */
+EMUFS_BLOCK_ID emufs_idx_buscar_registro(EMUFS*, EMUFS_REG_ID reg_id);
+
+/** Agrega un nuevo registro EMUFS_IDX al archivo .idx si no existe
+  * el id \c reg_id, si existe coloca en el campo location el valor 
+  * indicado en \c block_id
+  */
+int emufs_idx_agregar(EMUFS*, EMUFS_BLOCK_ID block_id, EMUFS_REG_ID reg_id);
+
+/** Coloca el valor -1 en el campo location, del registro que contenga el 
+  * id \c reg_id, para indicar que ese id no existe */
+int emufs_idx_borrar(EMUFS*, EMUFS_REG_ID reg_id);
+
+/** Retorna un array con los Ids validos del archivo IDX
+ *
+ *  EL ARRAY DEBE SER LIBERADO!
+ *  \param emu EMUFS
+ *  \param cant Puntero donde guardar la cantidad de items
+ */
+EMUFS_REG_ID *emufs_idx_get(EMUFS *emu, EMUFS_REG_ID *cant);
+
+/** Devuelve un nuevo id valido para un nuevo registro */
+EMUFS_REG_ID emufs_idx_get_new_id(EMUFS*, int*);
+
+/** Retorna 0 si \c ID existe */
+int emufs_idx_existe_id(EMUFS *emu, int ID);
+
+/** Acutaliza el valor de \c bloque segun \c ID */
+int emufs_idx_actualizar(EMUFS *emu, int ID, EMUFS_BLOCK_ID bloque);
+
+/** Obtiene el tamaño del archivo de índice. */
+long emufs_idx_get_file_size(EMUFS*, int*);
 
-#endif /* _IDX_H */
+#endif /* _EMUFS_IDX_H */