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