include/recctrl.h

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