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