include/recctrl.h

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