include/recctrl.h

   1 /*
   2  * Copyright (C) 1994-1998, Index Data
   3  * All rights reserved.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: recctrl.h,v $
   7  * Revision 1.31  1999-09-07 07:19:21  adam
   8  * Work on character mapping. Implemented replace rules.
   9  *
  10  * Revision 1.30  1999/05/21 12:00:17  adam
  11  * Better diagnostics for extraction process.
  12  *
  13  * Revision 1.29  1999/05/20 12:57:18  adam
  14  * Implemented TCL filter. Updated recctrl system.
  15  *
  16  * Revision 1.28  1999/03/02 16:15:42  quinn
  17  * Added "tagsysno" and "tagrank" directives to zebra.cfg.
  18  *
  19  * Revision 1.27  1998/10/16 08:14:28  adam
  20  * Updated record control system.
  21  *
  22  * Revision 1.26  1998/05/20 10:12:12  adam
  23  * Implemented automatic EXPLAIN database maintenance.
  24  * Modified Zebra to work with ASN.1 compiled version of YAZ.
  25  *
  26  * Revision 1.25  1998/03/11 11:19:04  adam
  27  * Changed the way sequence numbers are generated.
  28  *
  29  * Revision 1.24  1998/03/05 08:38:46  adam
  30  * New member recordSize in recRetrieveCtrl.
  31  *
  32  * Revision 1.23  1998/02/10 12:03:05  adam
  33  * Implemented Sort.
  34  *
  35  * Revision 1.22  1997/10/27 14:33:04  adam
  36  * Moved towards generic character mapping depending on "structure"
  37  * field in abstract syntax file. Fixed a few memory leaks. Fixed
  38  * bug with negative integers when doing searches with relational
  39  * operators.
  40  *
  41  * Revision 1.21  1997/09/18 08:59:19  adam
  42  * Extra generic handle for the character mapping routines.
  43  *
  44  * Revision 1.20  1997/09/17 12:19:10  adam
  45  * Zebra version corresponds to YAZ version 1.4.
  46  * Changed Zebra server so that it doesn't depend on global common_resource.
  47  *
  48  * Revision 1.19  1997/09/05 15:30:02  adam
  49  * Changed prototype for chr_map_input - added const.
  50  * Added support for C++, headers uses extern "C" for public definitions.
  51  *
  52  * Revision 1.18  1997/09/04 13:56:15  adam
  53  * Added new filter grs.marc.<syntax> where <syntax> refers to
  54  * abstract syntax. New method tellf in extract/retrieve control
  55  * block.
  56  *
  57  * Revision 1.17  1997/04/30 08:56:04  quinn
  58  * null
  59  *
  60  * Revision 1.16  1996/10/11  10:56:25  adam
  61  * New module recctrl. Used to manage records (extract/retrieval).
  62  * All record types are accessed by means of definitions in recctrl.h.
  63  *
  64  * Revision 1.15  1996/06/06 12:08:16  quinn
  65  * Added showRecord Group entry
  66  *
  67  * Revision 1.14  1996/05/09  07:28:49  quinn
  68  * Work towards phrases and multiple registers
  69  *
  70  * Revision 1.13  1996/05/01  13:44:05  adam
  71  * Added seek function to the recExtractCtrl and recRetrieveCtrl control
  72  * structures. Added end-of-file indicator function and start offset to
  73  * recExtractCtrl.
  74  *
  75  * Revision 1.12  1996/01/17  15:01:25  adam
  76  * Prototype changed for reader functions in extract/retrieve. File
  77  *  is identified by 'void *' instead of 'int'.
  78  *
  79  * Revision 1.11  1995/12/04  14:20:54  adam
  80  * Extra arg to recType_byName.
  81  *
  82  * Revision 1.10  1995/10/16  14:03:06  quinn
  83  * Changes to support element set names and espec1
  84  *
  85  * Revision 1.9  1995/10/06  14:37:53  adam
  86  * New result set method: r_score.
  87  * Local no (sysno) and score is transferred to retrieveCtrl.
  88  *
  89  * Revision 1.8  1995/10/02  15:43:35  adam
  90  * Extract uses file descriptors instead of FILE pointers.
  91  *
  92  * Revision 1.7  1995/10/02  15:18:09  adam
  93  * Minor changes.
  94  *
  95  * Revision 1.6  1995/10/02  15:05:26  quinn
  96  * Added a few fields.
  97  *
  98  * Revision 1.5  1995/10/02  14:55:52  quinn
  99  * *** empty log message ***
 100  *
 101  * Revision 1.4  1995/09/27  16:17:29  adam
 102  * More work on retrieve.
 103  *
 104  * Revision 1.3  1995/09/27  12:21:25  adam
 105  * New function: recType_byName.
 106  *
 107  * Revision 1.2  1995/09/15  14:45:03  adam
 108  * Retrieve control.
 109  *
 110  * Revision 1.1  1995/09/14  07:48:13  adam
 111  * Record control management.
 112  *
 113  */
 114
 115 #ifndef RECCTRL_H
 116 #define RECCTRL_H
 117
 118 #include <proto.h>
 119 #include <oid.h>
 120 #include <odr.h>
 121 #include <data1.h>
 122 #include <zebramap.h>
 123
 124 #ifdef __cplusplus
 125 extern "C" {
 126 #endif
 127
 128 /* single word entity */
 129 typedef struct {
 130     int  attrSet;
 131     int  attrUse;
 132     unsigned reg_type;
 133     char *string;
 134     int  length;
 135     int  *seqnos;
 136     ZebraMaps zebra_maps;
 137     struct recExtractCtrl *extractCtrl;
 138 } RecWord;
 139
 140 /* Extract record control */
 141 struct recExtractCtrl {
 142     void      *fh;                    /* File handle and read function     */
 143     int       (*readf)(void *fh, char *buf, size_t count);
 144     off_t     (*seekf)(void *fh, off_t offset);  /* seek function          */
 145     off_t     (*tellf)(void *fh);                /* tell function          */
 146     void      (*endf)(void *fh, off_t offset);   /* end of record position */
 147     off_t     offset;                            /* start offset           */
 148     char      *subType;
 149     void      (*init)(struct recExtractCtrl *p, RecWord *w);
 150     void      *clientData;
 151     void      (*tokenAdd)(RecWord *w);
 152     ZebraMaps zebra_maps;
 153     int       flagShowRecords;
 154     int       seqno[256];
 155     void      (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
 156     data1_handle dh;
 157 };
 158
 159 /* Retrieve record control */
 160 struct recRetrieveCtrl {
 161     /* Input parameters ... */
 162     Res       res;                    /* Resource pool                     */
 163     ODR       odr;                    /* ODR used to create response       */
 164     void     *fh;                     /* File descriptor and read function */
 165     int       (*readf)(void *fh, char *buf, size_t count);
 166     off_t     (*seekf)(void *fh, off_t offset);
 167     off_t     (*tellf)(void *fh);
 168     oid_value input_format;           /* Preferred record syntax           */
 169     Z_RecordComposition *comp;        /* formatting instructions           */
 170     int       localno;                /* local id of record                */
 171     int       score;                  /* score 0-1000 or -1 if none        */
 172     int       recordSize;             /* size of record in bytes */
 173     char      *subType;
 174     data1_handle dh;
 175
 176     /* response */
 177     oid_value  output_format;
 178     void       *rec_buf;
 179     size_t     rec_len;
 180     int        diagnostic;
 181     char *message;
 182 };
 183
 184 typedef struct recType *RecType;
 185
 186 struct recType
 187 {
 188     char *name;                           /* Name of record type */
 189     void *(*init)(RecType recType);       /* Init function - called once */
 190     void (*destroy)(void *clientData);    /* Destroy function */
 191     int  (*extract)(void *clientData,
 192                     struct recExtractCtrl *ctrl);   /* Extract proc */
 193     int  (*retrieve)(void *clientData,
 194                      struct recRetrieveCtrl *ctrl); /* Retrieve proc */
 195 };
 196
 197 #define RECCTRL_EXTRACT_OK    0
 198 #define RECCTRL_EXTRACT_EOF   1
 199 #define RECCTRL_EXTRACT_ERROR 2
 200
 201 typedef struct recTypes *RecTypes;
 202
 203 RecTypes recTypes_init (data1_handle dh);
 204 void recTypes_destroy (RecTypes recTypes);
 205 void recTypes_default_handlers (RecTypes recTypes);
 206
 207 RecType recType_byName (RecTypes rts, const char *name, char *subType,
 208                         void **clientDataP);
 209
 210 int grs_extract_tree(struct recExtractCtrl *p, data1_node *n);
 211
 212 #ifdef __cplusplus
 213 }
 214 #endif
 215
 216 #endif