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