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