1 /* $Id: recctrl.h,v 1.10 2005-04-28 08:20:39 adam Exp $
2 Copyright (C) 1995-2005
5 This file is part of the Zebra server.
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
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
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
26 #include <sys/types.h>
27 #include <yaz/proto.h>
30 #include <idzebra/res.h>
31 #include <idzebra/data1.h>
32 #include <idzebra/zebramap.h>
36 /* single word entity */
48 struct recExtractCtrl *extractCtrl;
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);
61 void (*tokenAdd)(RecWord *w);
62 void (*setStoreData)(struct recExtractCtrl *p, void *buf, size_t size);
67 char match_criteria[256];
68 void (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
73 /* Retrieve record control */
74 struct recRetrieveCtrl {
75 /* Input parameters ... */
76 Res res; /* Resource pool */
77 ODR odr; /* ODR used to create response */
78 void *fh; /* File descriptor and read function */
79 int (*readf)(void *fh, char *buf, size_t count);
80 off_t (*seekf)(void *fh, off_t offset);
81 off_t (*tellf)(void *fh);
82 oid_value input_format; /* Preferred record syntax */
83 Z_RecordComposition *comp; /* formatting instructions */
84 char *encoding; /* preferred character encoding */
85 zint localno; /* local id of record */
86 int score; /* score 0-1000 or -1 if none */
87 int recordSize; /* size of record in bytes */
88 char *fname; /* name of file (or NULL if internal) */
92 oid_value output_format;
99 typedef struct recType *RecType;
104 char *name; /* Name of record type */
105 void *(*init)(Res res, RecType recType); /* Init function - called once */
106 void (*config)(void *clientData, Res res, const char *args); /* Config */
107 void (*destroy)(void *clientData); /* Destroy function */
108 int (*extract)(void *clientData,
109 struct recExtractCtrl *ctrl); /* Extract proc */
110 int (*retrieve)(void *clientData,
111 struct recRetrieveCtrl *ctrl); /* Retrieve proc */
114 #define RECCTRL_EXTRACT_OK 0
115 #define RECCTRL_EXTRACT_EOF 1
116 #define RECCTRL_EXTRACT_ERROR_GENERIC 2
117 #define RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER 3
119 typedef struct recTypeClass *RecTypeClass;
120 typedef struct recTypes *RecTypes;
123 RecTypeClass recTypeClass_create (Res res, NMEM nmem);
126 void recTypeClass_destroy(RecTypeClass rtc);
129 void recTypeClass_info(RecTypeClass rtc, void *cd,
130 void (*cb)(void *cd, const char *s));
133 RecTypes recTypes_init(RecTypeClass rtc, data1_handle dh);
136 void recTypes_destroy(RecTypes recTypes);
139 void recTypes_default_handlers(RecTypes recTypes, Res res);
142 RecType recType_byName(RecTypes rts, Res res, const char *name,