b9f8d3cfc5efd8113a52ba0a2292ca8e0159eb4c
[idzebra-moved-to-github.git] / include / idzebra / recctrl.h
1 /* $Id: recctrl.h,v 1.1 2004-09-28 10:15:03 adam Exp $
2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
3    Index Data Aps
4
5 This file is part of the Zebra server.
6
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.
21 */
22
23
24
25 #ifndef RECCTRL_H
26 #define RECCTRL_H
27
28 #include <yaz/proto.h>
29 #include <yaz/oid.h>
30 #include <yaz/odr.h>
31 #include <idzebra/res.h>
32 #include <idzebra/data1.h>
33 #include <zebramap.h>
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 /* single word entity */
40 typedef struct {
41     int  attrSet;
42     int  attrUse;
43     unsigned reg_type;
44     char *string;
45     int  length;
46     int  seqno;
47     ZebraMaps zebra_maps;
48     struct recExtractCtrl *extractCtrl;
49 } RecWord;
50
51 /* Extract record control */
52 struct recExtractCtrl {
53     void      *fh;                    /* File handle and read function     */
54     int       (*readf)(void *fh, char *buf, size_t count);
55     off_t     (*seekf)(void *fh, off_t offset);  /* seek function          */
56     off_t     (*tellf)(void *fh);                /* tell function          */
57     void      (*endf)(void *fh, off_t offset);   /* end of record position */
58     off_t     offset;                            /* start offset           */
59     void      (*init)(struct recExtractCtrl *p, RecWord *w);
60     void      *clientData;
61     void      (*tokenAdd)(RecWord *w);
62     ZebraMaps zebra_maps;
63     int       flagShowRecords;
64     int       seqno[256];
65     void      (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
66     data1_handle dh;
67     void      *handle;
68 };
69
70 /* Retrieve record control */
71 struct recRetrieveCtrl {
72     /* Input parameters ... */
73     Res       res;                    /* Resource pool                     */
74     ODR       odr;                    /* ODR used to create response       */
75     void     *fh;                     /* File descriptor and read function */
76     int       (*readf)(void *fh, char *buf, size_t count);
77     off_t     (*seekf)(void *fh, off_t offset);
78     off_t     (*tellf)(void *fh);
79     oid_value input_format;           /* Preferred record syntax           */
80     Z_RecordComposition *comp;        /* formatting instructions           */
81     char      *encoding;              /* preferred character encoding      */
82     zint      localno;                /* local id of record                */
83     int       score;                  /* score 0-1000 or -1 if none        */
84     int       recordSize;             /* size of record in bytes */
85     char      *fname;                 /* name of file (or NULL if internal) */
86     data1_handle dh;
87     
88     /* response */
89     oid_value  output_format;
90     void       *rec_buf;
91     int        rec_len;
92     int        diagnostic;
93     char *message;
94 };
95
96 typedef struct recType *RecType;
97
98 struct recType
99 {
100     char *name;                           /* Name of record type */
101     void *(*init)(Res res, RecType recType);  /* Init function - called once */
102     void (*config)(void *clientData, Res res, const char *args); /* Config */
103     void (*destroy)(void *clientData);    /* Destroy function */
104     int  (*extract)(void *clientData,
105                     struct recExtractCtrl *ctrl);   /* Extract proc */
106     int  (*retrieve)(void *clientData,
107                      struct recRetrieveCtrl *ctrl); /* Retrieve proc */
108 };
109
110 #define RECCTRL_EXTRACT_OK    0
111 #define RECCTRL_EXTRACT_EOF   1
112 #define RECCTRL_EXTRACT_ERROR_GENERIC 2
113 #define RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER 3
114
115 typedef struct recTypeClass *RecTypeClass;
116 typedef struct recTypes *RecTypes;
117
118 RecTypeClass recTypeClass_create (Res res, NMEM nmem);
119 void recTypeClass_destroy(RecTypeClass rtc);
120 void recTypeClass_info(RecTypeClass rtc, void *cd,
121                        void (*cb)(void *cd, const char *s));
122
123 RecTypes recTypes_init(RecTypeClass rtc, data1_handle dh);
124 void recTypes_destroy(RecTypes recTypes);
125 void recTypes_default_handlers(RecTypes recTypes, Res res);
126
127 RecType recType_byName(RecTypes rts, Res res, const char *name,
128                        void **clientDataP);
129
130
131 #ifdef __cplusplus
132 }
133 #endif
134
135 #endif