include/recctrl.h

   1 /*
   2  * Copyright (C) 1994-1996, Index Data I/S
   3  * All rights reserved.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: recctrl.h,v $
   7  * Revision 1.16  1996-10-11 10:56:25  adam
   8  * New module recctrl. Used to manage records (extract/retrieval).
   9  * All record types are accessed by means of definitions in recctrl.h.
  10  *
  11  * Revision 1.15  1996/06/06 12:08:16  quinn
  12  * Added showRecord Group entry
  13  *
  14  * Revision 1.14  1996/05/09  07:28:49  quinn
  15  * Work towards phrases and multiple registers
  16  *
  17  * Revision 1.13  1996/05/01  13:44:05  adam
  18  * Added seek function to the recExtractCtrl and recRetrieveCtrl control
  19  * structures. Added end-of-file indicator function and start offset to
  20  * recExtractCtrl.
  21  *
  22  * Revision 1.12  1996/01/17  15:01:25  adam
  23  * Prototype changed for reader functions in extract/retrieve. File
  24  *  is identified by 'void *' instead of 'int'.
  25  *
  26  * Revision 1.11  1995/12/04  14:20:54  adam
  27  * Extra arg to recType_byName.
  28  *
  29  * Revision 1.10  1995/10/16  14:03:06  quinn
  30  * Changes to support element set names and espec1
  31  *
  32  * Revision 1.9  1995/10/06  14:37:53  adam
  33  * New result set method: r_score.
  34  * Local no (sysno) and score is transferred to retrieveCtrl.
  35  *
  36  * Revision 1.8  1995/10/02  15:43:35  adam
  37  * Extract uses file descriptors instead of FILE pointers.
  38  *
  39  * Revision 1.7  1995/10/02  15:18:09  adam
  40  * Minor changes.
  41  *
  42  * Revision 1.6  1995/10/02  15:05:26  quinn
  43  * Added a few fields.
  44  *
  45  * Revision 1.5  1995/10/02  14:55:52  quinn
  46  * *** empty log message ***
  47  *
  48  * Revision 1.4  1995/09/27  16:17:29  adam
  49  * More work on retrieve.
  50  *
  51  * Revision 1.3  1995/09/27  12:21:25  adam
  52  * New function: recType_byName.
  53  *
  54  * Revision 1.2  1995/09/15  14:45:03  adam
  55  * Retrieve control.
  56  *
  57  * Revision 1.1  1995/09/14  07:48:13  adam
  58  * Record control management.
  59  *
  60  */
  61
  62 #ifndef RECCTRL_H
  63 #define RECCTRL_H
  64
  65 #include <proto.h>
  66 #include <oid.h>
  67 #include <odr.h>
  68
  69 /* single word entity */
  70 typedef struct {
  71     int  attrSet;
  72     int  attrUse;
  73     enum {
  74         Word_String,
  75         Word_Phrase,
  76         Word_Numeric
  77     } which;
  78     union {
  79         char *string;
  80         int  numeric;
  81     } u;
  82     int seqno;
  83 } RecWord;
  84
  85 /* Extract record control */
  86 struct recExtractCtrl {
  87     void      *fh;                    /* File handle and read function     */
  88     int       (*readf)(void *fh, char *buf, size_t count);
  89     off_t     (*seekf)(void *fh, off_t offset);  /* seek function          */
  90     void      (*endf)(void *fh, off_t offset);   /* end of record position */
  91     off_t     offset;                            /* start offset           */
  92     char      *subType;
  93     void      (*init)(RecWord *p);
  94     void      (*add)(const RecWord *p);
  95     char **(*map_chrs_input)(char **from, int len);
  96     int       flagShowRecords;
  97 };
  98
  99 /* Retrieve record control */
 100 struct recRetrieveCtrl {
 101     /* Input parameters ... */
 102     ODR       odr;                    /* ODR used to create response       */
 103     void     *fh;                     /* File descriptor and read function */
 104     int       (*readf)(void *fh, char *buf, size_t count);
 105     off_t     (*seekf)(void *fh, off_t offset);
 106     oid_value input_format;           /* Preferred record syntax           */
 107     Z_RecordComposition *comp;        /* formatting instructions           */
 108     int       localno;                /* local id of record                */
 109     int       score;                  /* score 0-1000 or -1 if none        */
 110     char      *subType;
 111
 112     /* response */
 113     oid_value  output_format;
 114     void       *rec_buf;
 115     size_t     rec_len;
 116     int        diagnostic;
 117     char *message;
 118 };
 119
 120 typedef struct recType
 121 {
 122     char *name;                       /* Name of record type */
 123     void (*init)(void);               /* Init function - called once       */
 124     int  (*extract)(struct recExtractCtrl *ctrl);     /* Extract proc      */
 125     int  (*retrieve)(struct recRetrieveCtrl *ctrl);   /* Retrieve proc     */
 126 } *RecType;
 127
 128 RecType recType_byName (const char *name, char *subType);
 129
 130 #endif