include/recctrl.h

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