emufs/tipo1.h

   1 /* vim: set noexpandtab tabstop=4 shiftwidth=4:
   2  *----------------------------------------------------------------------------
   3  *                                  emufs
   4  *----------------------------------------------------------------------------
   5  * This file is part of emufs.
   6  *
   7  * emufs is free software; you can redistribute it and/or modify it under the
   8  * terms of the GNU General Public License as published by the Free Software
   9  * Foundation; either version 2 of the License, or (at your option) any later
  10  * version.
  11  *
  12  * emufs is distributed in the hope that it will be useful, but WITHOUT ANY
  13  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with emufs; if not, write to the Free Software Foundation, Inc., 59 Temple
  19  * Place, Suite 330, Boston, MA  02111-1307  USA
  20  *----------------------------------------------------------------------------
  21  * Creado:  vie abr  9 16:47:54 ART 2004
  22  * Autores: Leandro Lucarella <llucare@fi.uba.ar>
  23  *----------------------------------------------------------------------------
  24  *
  25  * $Id$
  26  *
  27  */
  28
  29 /** \file
  30  *
  31  * Archivo con bloque de longitud parametrizada, registro de longitud variable.
  32  *
  33  * Interfaz del archivo con bloques de longitud parametrizada y registros de
  34  * longitud variable.
  35  *
  36  */
  37
  38 #ifndef _EMUFS_TIPO1_H_
  39 #define _EMUFS_TIPO1_H_
  40
  41 #include "emufs.h"
  42
  43 /** Inicializa un EMUFS para poder ser utilizado como un archivo tipo1.
  44  *
  45  * \param efs Estructura a inicializar.
  46  * \return Código de error o EMUFS_OK si no hubo error.
  47  */
  48 int emufs_tipo1_inicializar(EMUFS* efs);
  49
  50 /** Lee el registro \c reg_id y devolviendo su contenido. */
  51 void* emufs_tipo1_leer_registro(EMUFS*, EMUFS_REG_ID, EMUFS_REG_SIZE*, int*);
  52
  53 /** Graba un registro en el archivo. */
  54 EMUFS_REG_ID emufs_tipo1_grabar_registro(EMUFS*, void*, EMUFS_REG_SIZE, int*);
  55
  56 /** Borra un registro de del archivo. */
  57 int emufs_tipo1_borrar_registro(EMUFS*, EMUFS_REG_ID);
  58
  59 /** Método para modificar un registro. */
  60 EMUFS_REG_ID emufs_tipo1_modificar_registro(EMUFS *emu, EMUFS_REG_ID, void*, EMUFS_REG_SIZE, int*);
  61
  62 /** Método para leer un registro con todo su bloque asociado. */
  63 void* emufs_tipo1_leer_registro_raw(EMUFS *emu, EMUFS_REG_ID id, EMUFS_REG_SIZE *size, int *pos);
  64
  65 /** Obtiene estádisticas del archivo */
  66 EMUFS_Estadisticas emufs_tipo1_leer_estadisticas(EMUFS*);
  67
  68 /** Método para compactar el archivo reorganizándolo físicamente */
  69 void emufs_tipo1_compactar(EMUFS*);
  70
  71 /** Lee un bloque y su contexto, en bruto (con cabeceras). */
  72 void emufs_tipo1_leer_bloque_raw(EMUFS *efs, EMUFS_BLOCK_ID id, char **actual,
  73                 char **anterior, char **siguiente, EMUFS_BLOCK_SIZE *size1,
  74                 EMUFS_BLOCK_SIZE *size2, EMUFS_BLOCK_SIZE *size3);
  75
  76 #endif /* _EMUFS_TIPO1_H_ */