src/vfile/vfile.h

   1 /* vim: set noexpandtab tabstop=4 shiftwidth=4 wrap:
   2  *----------------------------------------------------------------------------
   3  *                                  jacu
   4  *----------------------------------------------------------------------------
   5  * This file is part of jacu.
   6  *
   7  * jacu 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  * jacu 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 jacu; if not, write to the Free Software Foundation, Inc., 59 Temple
  19  * Place, Suite 330, Boston, MA  02111-1307  USA
  20  *----------------------------------------------------------------------------
  21  * Creado:  mié jun 16 14:04:55 ART 2004
  22  * Autores: Leandro Lucarella <llucare@fi.uba.ar>
  23  *----------------------------------------------------------------------------
  24  *
  25  * $Id$
  26  *
  27  */
  28
  29 #ifndef _JACU_VFILE_H_
  30 #define _JACU_VFILE_H_
  31
  32 #include <stdio.h>
  33
  34 /** \file
  35  *
  36  * Archivo virtual divisible en volúmenes.
  37  *
  38  * Interfaz de un archivo virtual divisible en volúmenes.
  39  * Provee algunas funciones compatibles con la stdio de ANSI C para utilizar
  40  * de forma transparente archivos virtuales divididos en varios volúmenes.
  41  *
  42  */
  43
  44 /** Mínimo tamaño de un volumen. */
  45 #define VFMINVOLSIZE 4
  46
  47 /** Esquema del nombre a utilizar en los volumenes. */
  48 #define VFNAMETEMPLATE "%s-%d"
  49
  50 /** Modo de uso del archivo virtual. */
  51 typedef enum
  52 {
  53         VFREAD, /**< Modo lectura. */
  54         VFWRITE /**< Modo escritura. */
  55 }
  56 VFMODE;
  57
  58 /**
  59  * Archivo virtual divisible en volúmenes.
  60  */
  61 typedef struct
  62 {
  63         FILE*  fp;      /**< Puntero al archivo actual. */
  64         char*  name;    /**< Nombre base del archivo. */
  65         VFMODE mode;    /**< Modo de uso del archivo. */
  66         long   volsize; /**< Tamaño de cada volumen. */
  67         int    lastvol; /**< 0 hay más volumenes para leer; 1 es el último. */
  68         int    currvol; /**< Volumen utilizado actualmente. */
  69         long   room;    /**< Cantidad de bytes Posición actual del archivo virtual. */
  70 }
  71 VFILE;
  72
  73 /**
  74  * Abre un archivo virtual multivolumen.
  75  *
  76  * \param path Ruta del archivo a abrir.
  77  * \param mode Modo con el cual abrir el archivo. Son iguales a los modos de
  78  *             <tt>fopen()</tt> pero no se pueden usar modos de lectura y
  79  *             escritura simultánea (<tt>r+</tt>, <tt>w+</tt>, <tt>a+</tt>).
  80  * \param size Tamaño de los volúmenes. Si es menor a VFILE_MIN_VOLSIZE bytes
  81  *             no se divide el archivo.
  82  *
  83  * \return Puntero al archivo multivolumen abierto o 0 si no se pudo abrir.
  84  *
  85  */
  86 VFILE* vfopen(const char* path, const char* mode, long size);
  87
  88 /** Cierra un archivo virtual multivolumen. */
  89 int vfclose(VFILE* vfp);
  90
  91 /** Obtiene un caracter de un archivo virtual multivolumen. */
  92 int vfgetc(VFILE* vfp);
  93
  94 /** Pone un caracter en un archivo virtual multivolumen. */
  95 int vfputc(int c, VFILE* vfp);
  96
  97 /** Lee un conjunto de bytes de un archivo virtual multivolumen. */
  98 size_t vfread(void* ptr, size_t size, size_t nmemb, VFILE* vfp);
  99
 100 /** Escribe un conjunto de bytes en un archivo virtual multivolumen. */
 101 size_t vfwrite(const void *ptr, size_t size, size_t nmemb, VFILE* vfp);
 102
 103 /** Indica si es el fin del archivo multivolumen. */
 104 int vfeof(VFILE* vfp);
 105
 106 #endif /* _JACU_VFILE_H_ */
 107