include/idzebra/recctrl.h

   1 /* $Id: recctrl.h,v 1.9 2005-03-31 12:42:06 adam Exp $
   2    Copyright (C) 1995-2005
   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 #ifndef RECCTRL_H
  24 #define RECCTRL_H
  25
  26 #include <sys/types.h>
  27 #include <yaz/proto.h>
  28 #include <yaz/oid.h>
  29 #include <yaz/odr.h>
  30 #include <idzebra/res.h>
  31 #include <idzebra/data1.h>
  32 #include <idzebra/zebramap.h>
  33
  34 YAZ_BEGIN_CDECL
  35
  36 /* single word entity */
  37 typedef struct {
  38     int  attrSet;
  39     int  attrUse;
  40     unsigned reg_type;
  41     char *attrStr;
  42     char *term_buf;
  43     int  term_len;
  44     zint seqno;
  45     zint record_id;
  46     zint section_id;
  47     ZebraMaps zebra_maps;
  48     struct recExtractCtrl *extractCtrl;
  49 } RecWord;
  50
  51 /* Extract record control */
  52 struct recExtractCtrl {
  53     void      *fh;                    /* File handle and read function     */
  54     int       (*readf)(void *fh, char *buf, size_t count);
  55     off_t     (*seekf)(void *fh, off_t offset);  /* seek function          */
  56     off_t     (*tellf)(void *fh);                /* tell function          */
  57     void      (*endf)(void *fh, off_t offset);   /* end of record position */
  58     off_t     offset;                            /* start offset           */
  59     void      (*init)(struct recExtractCtrl *p, RecWord *w);
  60     void      *clientData;
  61     void      (*tokenAdd)(RecWord *w);
  62     ZebraMaps zebra_maps;
  63     int       flagShowRecords;
  64     int       seqno[256];
  65     char      match_criteria[256];
  66     void      (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
  67     data1_handle dh;
  68     void      *handle;
  69 };
  70
  71 /* Retrieve record control */
  72 struct recRetrieveCtrl {
  73     /* Input parameters ... */
  74     Res       res;                    /* Resource pool                     */
  75     ODR       odr;                    /* ODR used to create response       */
  76     void     *fh;                     /* File descriptor and read function */
  77     int       (*readf)(void *fh, char *buf, size_t count);
  78     off_t     (*seekf)(void *fh, off_t offset);
  79     off_t     (*tellf)(void *fh);
  80     oid_value input_format;           /* Preferred record syntax           */
  81     Z_RecordComposition *comp;        /* formatting instructions           */
  82     char      *encoding;              /* preferred character encoding      */
  83     zint      localno;                /* local id of record                */
  84     int       score;                  /* score 0-1000 or -1 if none        */
  85     int       recordSize;             /* size of record in bytes */
  86     char      *fname;                 /* name of file (or NULL if internal) */
  87     data1_handle dh;
  88
  89     /* response */
  90     oid_value  output_format;
  91     void       *rec_buf;
  92     int        rec_len;
  93     int        diagnostic;
  94     char       *addinfo;
  95 };
  96
  97 typedef struct recType *RecType;
  98
  99 struct recType
 100 {
 101     int version;
 102     char *name;                           /* Name of record type */
 103     void *(*init)(Res res, RecType recType);  /* Init function - called once */
 104     void (*config)(void *clientData, Res res, const char *args); /* Config */
 105     void (*destroy)(void *clientData);    /* Destroy function */
 106     int  (*extract)(void *clientData,
 107                     struct recExtractCtrl *ctrl);   /* Extract proc */
 108     int  (*retrieve)(void *clientData,
 109                      struct recRetrieveCtrl *ctrl); /* Retrieve proc */
 110 };
 111
 112 #define RECCTRL_EXTRACT_OK    0
 113 #define RECCTRL_EXTRACT_EOF   1
 114 #define RECCTRL_EXTRACT_ERROR_GENERIC 2
 115 #define RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER 3
 116
 117 typedef struct recTypeClass *RecTypeClass;
 118 typedef struct recTypes *RecTypes;
 119
 120 YAZ_EXPORT
 121 RecTypeClass recTypeClass_create (Res res, NMEM nmem);
 122
 123 YAZ_EXPORT
 124 void recTypeClass_destroy(RecTypeClass rtc);
 125
 126 YAZ_EXPORT
 127 void recTypeClass_info(RecTypeClass rtc, void *cd,
 128                        void (*cb)(void *cd, const char *s));
 129
 130 YAZ_EXPORT
 131 RecTypes recTypes_init(RecTypeClass rtc, data1_handle dh);
 132
 133 YAZ_EXPORT
 134 void recTypes_destroy(RecTypes recTypes);
 135
 136 YAZ_EXPORT
 137 void recTypes_default_handlers(RecTypes recTypes, Res res);
 138
 139 YAZ_EXPORT
 140 RecType recType_byName(RecTypes rts, Res res, const char *name,
 141                        void **clientDataP);
 142
 143
 144 YAZ_END_CDECL
 145
 146 #endif