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