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