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