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