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