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