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