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