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