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