index/zinfo.h

   1 /* $Id: zinfo.h,v 1.35 2006-06-22 15:07:20 adam Exp $
   2    Copyright (C) 1995-2006
   3    Index Data ApS
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23
  24 #ifndef ZINFO_H
  25 #define ZINFO_H
  26
  27 #include <d1_absyn.h>
  28 #include <idzebra/api.h>
  29 #include "recindex.h"
  30
  31 /* Compare string (ignore case) */
  32 #ifdef WIN32
  33 #define STRCASECMP      stricmp
  34 #else
  35 #define STRCASECMP      strcasecmp
  36 #endif
  37
  38 YAZ_BEGIN_CDECL
  39
  40 typedef enum {
  41     zinfo_index_category_index,
  42     zinfo_index_category_sort,
  43     zinfo_index_category_alwaysmatches,
  44     zinfo_index_category_anchor
  45 } zinfo_index_category_t;
  46
  47 typedef ZEBRA_RES ZebraExplainUpdateFunc(void *handle,
  48                                          Record drec,
  49                                          data1_node *n);
  50
  51 typedef struct zebraExplainInfo *ZebraExplainInfo;
  52 typedef struct zebDatabaseInfo ZebDatabaseInfo;
  53 ZebraExplainInfo zebraExplain_open(Records records, data1_handle dh,
  54                                    Res res,
  55                                    int writeFlag,
  56                                    void *updateHandle,
  57                                    ZebraExplainUpdateFunc *);
  58
  59 void zebraExplain_close (ZebraExplainInfo zei);
  60 int zebraExplain_curDatabase (ZebraExplainInfo zei, const char *database);
  61 int zebraExplain_newDatabase (ZebraExplainInfo zei, const char *database,
  62                               int explain_database);
  63 int zebraExplain_add_attr_su(ZebraExplainInfo zei, int index_type,
  64                              int set, int use);
  65 int zebraExplain_lookup_attr_str(ZebraExplainInfo zei,
  66                                  zinfo_index_category_t cat,
  67                                  int index_type,
  68                                  const char *str);
  69 int zebraExplain_add_attr_str(ZebraExplainInfo zei,
  70                               zinfo_index_category_t cat,
  71                               int index_type,
  72                               const char *str);
  73 void zebraExplain_addSchema (ZebraExplainInfo zei, Odr_oid *oid);
  74 void zebraExplain_recordCountIncrement (ZebraExplainInfo zei, int adjust_num);
  75 void zebraExplain_recordBytesIncrement (ZebraExplainInfo zei, int adjust_num);
  76 zint zebraExplain_runNumberIncrement (ZebraExplainInfo zei, int adjust_num);
  77 void zebraExplain_loadAttsets (data1_handle dh, Res res);
  78 void zebraExplain_flush (ZebraExplainInfo zei, void *updateHandle);
  79
  80 int zebraExplain_lookup_ord (ZebraExplainInfo zei, int ord,
  81                              int *index_type, const char **db,
  82                              const char **string_index);
  83
  84 int zebraExplain_ord_adjust_occurrences(ZebraExplainInfo zei, int ord,
  85                                         int term_delta, int doc_delta);
  86
  87 zint zebraExplain_ord_get_term_occurrences(ZebraExplainInfo zei, int ord);
  88 zint zebraExplain_ord_get_doc_occurrences(ZebraExplainInfo zei, int ord);
  89
  90 int zebraExplain_trav_ord(ZebraExplainInfo zei, void *handle,
  91                           int (*f)(void *handle, int ord));
  92
  93 int zebraExplain_get_database_ord(ZebraExplainInfo zei);
  94 int zebraExplain_removeDatabase(ZebraExplainInfo zei, void *updateHandle);
  95
  96 typedef struct {
  97     int recordSize;
  98     off_t recordOffset;
  99     zint runNumber;
 100     zint staticrank;
 101 } RecordAttr;
 102 RecordAttr *rec_init_attr (ZebraExplainInfo zei, Record rec);
 103
 104 YAZ_END_CDECL
 105
 106 #endif
 107 /*
 108  * Local variables:
 109  * c-basic-offset: 4
 110  * indent-tabs-mode: nil
 111  * End:
 112  * vim: shiftwidth=4 tabstop=8 expandtab
 113  */
 114