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