include/recctrl.h

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