1 /* $Id: recctrl.h,v 1.27 2006-08-15 14:28:33 adam Exp $
2 Copyright (C) 1995-2006
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 this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 #ifndef IDZEBRA_RECCTRL_H
24 #define IDZEBRA_RECCTRL_H
26 #include <sys/types.h>
27 #include <yaz/proto.h>
30 #include <idzebra/res.h>
31 #include <idzebra/data1.h>
32 #include <idzebra/snippet.h>
37 #define ZEBRA_XPATH_ELM_BEGIN "_XPATH_BEGIN"
40 #define ZEBRA_XPATH_ELM_END "_XPATH_END"
43 #define ZEBRA_XPATH_CDATA "_XPATH_CDATA"
46 #define ZEBRA_XPATH_ATTR_NAME "_XPATH_ATTR_NAME"
49 #define ZEBRA_XPATH_ATTR_CDATA "_XPATH_ATTR_CDATA"
51 /* single word entity */
54 const char *index_name;
60 struct recExtractCtrl *extractCtrl;
63 /* Extract record control */
64 struct recExtractCtrl {
65 void *fh; /* File handle and read function */
66 int (*readf)(void *fh, char *buf, size_t count);
67 off_t (*seekf)(void *fh, off_t offset); /* seek function */
68 off_t (*tellf)(void *fh); /* tell function */
69 void (*endf)(void *fh, off_t offset); /* end of record position */
70 off_t offset; /* start offset */
71 void (*init)(struct recExtractCtrl *p, RecWord *w);
73 void (*tokenAdd)(RecWord *w);
74 void (*setStoreData)(struct recExtractCtrl *p, void *buf, size_t size);
78 char match_criteria[256];
80 void (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
85 /* Retrieve record control */
86 struct recRetrieveCtrl {
87 /* Input parameters ... */
88 Res res; /* Resource pool */
89 ODR odr; /* ODR used to create response */
90 void *fh; /* File descriptor and read function */
91 int (*readf)(void *fh, char *buf, size_t count);
92 off_t (*seekf)(void *fh, off_t offset);
93 off_t (*tellf)(void *fh);
94 oid_value input_format; /* Preferred record syntax */
95 Z_RecordComposition *comp; /* formatting instructions */
96 char *encoding; /* preferred character encoding */
97 zint localno; /* local id of record */
98 int score; /* score 0-1000 or -1 if none */
99 zint staticrank; /* static rank >= 0, 0 if none */
100 int recordSize; /* size of record in bytes */
101 char *fname; /* name of file (or NULL if internal) */
103 zebra_snippets *hit_snippet;
104 zebra_snippets *doc_snippet;
107 oid_value output_format;
114 typedef struct recType *RecType;
119 char *name; /* Name of record type */
120 void *(*init)(Res res, RecType recType); /* Init function - called once */
121 ZEBRA_RES (*config)(void *clientData, Res res, const char *args); /* Config */
122 void (*destroy)(void *clientData); /* Destroy function */
123 int (*extract)(void *clientData,
124 struct recExtractCtrl *ctrl); /* Extract proc */
125 int (*retrieve)(void *clientData,
126 struct recRetrieveCtrl *ctrl); /* Retrieve proc */
129 #define RECCTRL_EXTRACT_OK 0
130 #define RECCTRL_EXTRACT_EOF 1
131 #define RECCTRL_EXTRACT_ERROR_GENERIC 2
132 #define RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER 3
134 typedef struct recTypeClass *RecTypeClass;
135 typedef struct recTypes *RecTypes;
138 RecTypeClass recTypeClass_create (Res res, NMEM nmem);
141 void recTypeClass_load_modules(RecTypeClass *rts, NMEM nmem,
142 const char *module_path);
145 RecTypeClass recTypeClass_add_modules(Res res, NMEM nmem,
146 const char *module_path);
149 void recTypeClass_destroy(RecTypeClass rtc);
152 void recTypeClass_info(RecTypeClass rtc, void *cd,
153 void (*cb)(void *cd, const char *s));
156 RecTypes recTypes_init(RecTypeClass rtc, data1_handle dh);
159 void recTypes_destroy(RecTypes recTypes);
162 void recTypes_default_handlers(RecTypes recTypes, Res res);
165 RecType recType_byName(RecTypes rts, Res res, const char *name,
169 #define KEY_SEGMENT_SIZE 1024
177 * indent-tabs-mode: nil
179 * vim: shiftwidth=4 tabstop=8 expandtab