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