emufs/indices.h

   1
   2 #ifndef _INDICES_H_
   3 #define _INDICES_H_
   4
   5 #include <stdlib.h>
   6 #include <string.h>
   7
   8 #include "common.h"
   9
  10 #define STRUCT_OFFSET(x, y) ((int)(&(x->y))-(int)(x))
  11
  12 typedef struct _emu_fs_t EMUFS;
  13
  14 /** Dato guardado junto con la clave */
  15 typedef struct _reg_def_ {
  16         long id;
  17         long bloque;
  18 } INDICE_DATO;
  19
  20 /** Tipos de Indices conocidos */
  21 typedef enum {
  22         IND_B, /**< Utilizacion de Arboles B */
  23         IND_B_ASC, /**< Utilizacion de Arboles B* */
  24         IND_B_PLUS
  25 } INDICE_TIPO;
  26
  27 typedef enum {
  28         IND_PRIMARIO,
  29         IND_SELECCION,
  30         IND_EXAHUSTIVO
  31 } INDICE_FUNCION;
  32
  33 /** Tipos de datos soportados para las claves */
  34 typedef enum {
  35         IDX_FLOAT,
  36         IDX_INT,
  37         IDX_STRING
  38 } INDICE_TIPO_DATO;
  39
  40 /** Clave de indice
  41  *
  42  *  Si el tipo de clave es IDX_STRING se utiliza
  43  *  i_clave y representa el ID en un EMUFS Tipo2
  44  *  sin indices donde esta el texto de la clave
  45  */
  46 typedef union _data_ {
  47         float f_clave;
  48         int i_clave;
  49 } CLAVE;
  50
  51 /** Manejo de Indices independiente */
  52 typedef struct _indices_h_ {
  53         INDICE_TIPO tipo;             /**< Tipo de indice */
  54         INDICE_TIPO_DATO tipo_dato;   /**< Tipo de dato a manejar */
  55         INDICE_FUNCION funcion;       /**< Funcion del indice */
  56         int offset;                   /**< Offset desde el inicio del dato hasta el lugar donde esta la clave */
  57         unsigned int tam_bloque;      /**< Tamaño del bloque (nodo). Deber set multiplo de 512! */
  58
  59         /** Agrega la clave k de posicion location en el
  60          * indice de forma ordenada
  61          */
  62         int (*agregar_entrada)(struct _indices_h_ *idx, CLAVE k, INDICE_DATO dato);
  63         /** Borra del indice la clave k */
  64         int (*borrar_entrada)(struct _indices_h_ *idx, CLAVE k);
  65         /** Determina si existe la clave k retornando su posicion o -1
  66          * en caso fallido
  67          */
  68         INDICE_DATO (*existe_entrada)(struct _indices_h_ *idx, CLAVE k);
  69
  70         INDICE_DATO *(*buscar_entradas)(struct _indices_h_ *idx, CLAVE k, int *cant);
  71
  72         char *nombre;   /**< Nombre único de busqueda del indice */
  73         char *filename; /**< nombre del archivo de indice */
  74
  75         EMUFS *emu_string; /**< EMUFS Tipo2 donde se guardan las claves de tipo string */
  76
  77         /** EMUFS Donde se guardan INDICE_DATO de multiples claves con repeticion
  78          *
  79          *  La forma de guardar es la siguiente :
  80          *  \code
  81          *  +------+---------//---------+
  82          *  | CANT |    DATA \\         |
  83          *  +------+---------//---------+
  84          *  \endcode
  85          *
  86          *  Donde CANT es un entero (int) y DATA es un array
  87          *  de INDICE_DATO que apunta al archivo de datos
  88          *  pripiamente dicho
  89          */
  90         EMUFS *emu_mult;
  91         struct _indices_h_ *sig; /**< Siguiente indice */
  92 } INDICE;
  93
  94 /** Crea un nuevo indice
  95  *
  96  *  \param emu EMUFS a quien pertenece
  97  *  \param nombre Nombre del indice
  98  *  \param tipo Tipo de indice
  99  *  \param tipo_dato Tipo de dato de la clave
 100  *  \param offset Desplazamiento de la clave dentro del dato
 101  *  \param tam_bloque Tamaño del bloque (nodo) del arbol
 102  */
 103 INDICE *emufs_indice_crear(EMUFS *emu, char *nombre, INDICE_FUNCION funcion, INDICE_TIPO tipo, INDICE_TIPO_DATO tipo_dato, unsigned int offset, unsigned tam_bloque);
 104
 105 /** Destruye un indice
 106  *
 107  *  \todo hacer/revisar
 108  */
 109 void emufs_indice_destruir(EMUFS *emu, INDICE *i);
 110
 111 /** Agrega una clave en los indices
 112  *
 113  *  Agrega la clave en todos los indice, dependiendo de su tipo
 114  *  de dato, tipo de arboo, offset, etc
 115  *
 116  *  \param primer Primer indice a agregar
 117  *  \param data Array de datos desde donde tomar las claves
 118  *  \param ubicacion Dato a guardar asociado a la clave
 119  */
 120 void emufs_indice_agregar(INDICE *primero, char *data, INDICE_DATO dato);
 121
 122 INDICE_DATO emufs_indice_buscar(INDICE *primero, char *data);
 123
 124 CLAVE emufs_indice_generar_clave(INDICE *idx, char *data);
 125 CLAVE emufs_indice_generar_clave_desde_valor(INDICE *idx, char *data);
 126 /** Compara 2 claves de la forma c1 < c2 */
 127 int emufs_indice_es_menor(INDICE *idx, CLAVE c1, CLAVE c2);
 128
 129 /** Compara 2 claves de la forma c1 == c2 */
 130 int emufs_indice_es_igual(INDICE *idx, CLAVE c1, CLAVE c2);
 131 #endif