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