2 * Copyright (c) 1995, the EUROPAGATE consortium (see below).
4 * The EUROPAGATE consortium members are:
6 * University College Dublin
7 * Danmarks Teknologiske Videnscenter
8 * An Chomhairle Leabharlanna
9 * Consejo Superior de Investigaciones Cientificas
11 * Permission to use, copy, modify, distribute, and sell this software and
12 * its documentation, in whole or in part, for any purpose, is hereby granted,
15 * 1. This copyright and permission notice appear in all copies of the
16 * software and its documentation. Notices of copyright or attribution
17 * which appear at the beginning of any file must remain unchanged.
19 * 2. The names of EUROPAGATE or the project partners may not be used to
20 * endorse or promote products derived from this software without specific
21 * prior written permission.
23 * 3. Users of this software (implementors and gateway operators) agree to
24 * inform the EUROPAGATE consortium of their use of the software. This
25 * information will be used to evaluate the EUROPAGATE project and the
26 * software, and to plan further developments. The consortium may use
27 * the information in later publications.
29 * 4. Users of this software agree to make their best efforts, when
30 * documenting their use of the software, to acknowledge the EUROPAGATE
31 * consortium, and the role played by the software in their work.
33 * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
34 * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
35 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
36 * IN NO EVENT SHALL THE EUROPAGATE CONSORTIUM OR ITS MEMBERS BE LIABLE
37 * FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF
38 * ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
39 * OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND
40 * ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
41 * USE OR PERFORMANCE OF THIS SOFTWARE.
48 * $Id: ccl.h,v 1.12 2002-06-06 13:02:01 adam Exp $
52 * Revision 1.10 1996/01/08 08:41:22 adam
55 * Revision 1.9 1995/07/20 08:15:16 adam
56 * Bug fix: Token value for comma and OR were the same!
58 * Revision 1.8 1995/07/11 12:28:34 adam
59 * New function: ccl_token_simple (split into simple tokens) and
60 * ccl_token_del (delete tokens).
62 * Revision 1.7 1995/05/16 09:39:38 adam
65 * Revision 1.6 1995/05/11 14:04:03 adam
66 * Changes in the reading of qualifier(s). New function: ccl_qual_fitem.
67 * New variable ccl_case_sensitive, which controls whether reserved
68 * words and field names are case sensitive or not.
70 * Revision 1.5 1995/02/23 08:32:11 adam
73 * Revision 1.3 1995/02/16 13:20:10 adam
76 * Revision 1.2 1995/02/15 17:43:08 adam
77 * Minor changes to the ccl interface. Bug fix in iso2709 module.
79 * Revision 1.1 1995/02/14 19:55:21 adam
80 * Header files ccl.h/cclp.h are gone! They have been merged an
81 * moved to ../include/ccl.h.
88 #include <yaz/yconfig.h>
90 #include <yaz/xmalloc.h>
94 /* CCL error numbers */
96 #define CCL_ERR_TERM_EXPECTED 1
97 #define CCL_ERR_RP_EXPECTED 2
98 #define CCL_ERR_SETNAME_EXPECTED 3
99 #define CCL_ERR_OP_EXPECTED 4
100 #define CCL_ERR_BAD_RP 5
101 #define CCL_ERR_UNKNOWN_QUAL 6
102 #define CCL_ERR_DOUBLE_QUAL 7
103 #define CCL_ERR_EQ_EXPECTED 8
104 #define CCL_ERR_BAD_RELATION 9
105 #define CCL_ERR_TRUNC_NOT_LEFT 10
106 #define CCL_ERR_TRUNC_NOT_BOTH 11
107 #define CCL_ERR_TRUNC_NOT_RIGHT 12
109 /* attribute pair (type, value) */
110 struct ccl_rpn_attr {
111 struct ccl_rpn_attr *next;
117 #define CCL_RPN_AND 1
119 #define CCL_RPN_NOT 3
120 #define CCL_RPN_TERM 4
121 #define CCL_RPN_SET 5
122 #define CCL_RPN_PROX 6
124 /* RPN tree structure */
125 struct ccl_rpn_node {
128 struct ccl_rpn_node *p[2];
131 struct ccl_rpn_attr *attr_list;
137 typedef struct ccl_qualifiers *CCL_bibset;
144 1-6 relation (<, <=, =, >=, >, <>)
150 3 any position in field
153 0 word/phrase auto select
160 100 date (un-normalized)
161 101 name (normalized)
162 102 name (un-normalized)
167 #define CCL_BIB1_USE 1
168 #define CCL_BIB1_REL 2
169 #define CCL_BIB1_POS 3
170 #define CCL_BIB1_STR 4
171 #define CCL_BIB1_TRU 5
172 #define CCL_BIB1_COM 6
174 #define CCL_BIB1_STR_WP (-1)
175 #define CCL_BIB1_STR_AND_LIST (-2)
176 #define CCL_BIB1_STR_OR_LIST (-3)
177 #define CCL_BIB1_REL_ORDER (-1)
179 #define CCL_BIB1_TRU_CAN_LEFT (-1)
180 #define CCL_BIB1_TRU_CAN_RIGHT (-2)
181 #define CCL_BIB1_TRU_CAN_BOTH (-3)
182 #define CCL_BIB1_TRU_CAN_NONE (-4)
184 #define CCL_TOK_EOL 0
185 #define CCL_TOK_TERM 1
186 #define CCL_TOK_REL 2
188 #define CCL_TOK_PROX 4
191 #define CCL_TOK_COMMA 7
192 #define CCL_TOK_AND 8
194 #define CCL_TOK_NOT 10
195 #define CCL_TOK_SET 11
202 struct ccl_token *next;
203 struct ccl_token *prev;
207 struct ccl_qualifier {
210 struct ccl_qualifier **sub;
211 struct ccl_rpn_attr *attr_list;
212 struct ccl_qualifier *next;
216 /* current lookahead token */
217 struct ccl_token *look_token;
219 /* holds error code if error occur (and approx position of error) */
221 const char *error_pos;
230 int ccl_case_sensitive;
233 typedef struct ccl_parser *CCL_parser;
235 /* Generate tokens from command string - obeys all CCL opererators */
236 YAZ_EXPORT struct ccl_token *ccl_parser_tokenize (CCL_parser cclp,
237 const char *command);
238 YAZ_EXPORT struct ccl_token *ccl_tokenize (const char *command);
240 /* Generate tokens from command string - oebeys only simple tokens and
242 YAZ_EXPORT struct ccl_token *ccl_token_simple (const char *command);
244 /* Delete token list */
245 YAZ_EXPORT void ccl_token_del (struct ccl_token *list);
247 /* Parse CCL Find command - NULL-terminated string */
248 YAZ_EXPORT struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset,
249 const char *str, int *error, int *pos);
251 /* Parse CCL Find command - Tokens read by ccl_tokenize */
252 YAZ_EXPORT struct ccl_rpn_node *ccl_find (CCL_bibset abibset, struct ccl_token *list,
253 int *error, const char **pos);
255 /* Parse CCL Find command */
256 YAZ_EXPORT struct ccl_rpn_node *ccl_parser_find (CCL_parser cclp, struct ccl_token *list);
258 /* Set various OPs */
259 YAZ_EXPORT void ccl_parser_set_op_and (CCL_parser p, const char *op);
260 YAZ_EXPORT void ccl_parser_set_op_or (CCL_parser p, const char *op);
261 YAZ_EXPORT void ccl_parser_set_op_not (CCL_parser p, const char *op);
262 YAZ_EXPORT void ccl_parser_set_op_set (CCL_parser p, const char *op);
264 YAZ_EXPORT void ccl_parser_set_case (CCL_parser p, int case_sensitivity_flag);
266 /* Return english-readable error message */
267 YAZ_EXPORT const char *ccl_err_msg (int ccl_errno);
269 /* Delete RPN tree returned by ccl_find */
270 YAZ_EXPORT void ccl_rpn_delete (struct ccl_rpn_node *rpn);
272 /* Dump RPN tree in readable format to fd_out */
273 YAZ_EXPORT void ccl_pr_tree (struct ccl_rpn_node *rpn, FILE *fd_out);
275 /* Add CCL qualifier */
276 YAZ_EXPORT void ccl_qual_add (CCL_bibset b, const char *name, int no,
279 YAZ_EXPORT void ccl_qual_add_set (CCL_bibset b, const char *name, int no,
280 int *attr, char **attsets);
282 YAZ_EXPORT void ccl_qual_add_special (CCL_bibset bibset,
283 const char *n, const char *v);
285 YAZ_EXPORT void ccl_qual_add_combi (CCL_bibset b, const char *n,
288 /* Read CCL qualifier list spec from file inf */
289 YAZ_EXPORT void ccl_qual_file (CCL_bibset bibset, FILE *inf);
291 /* Read CCL qualifier list spec from file inf */
292 YAZ_EXPORT int ccl_qual_fname (CCL_bibset bibset, const char *fname);
294 /* Add CCL qualifier by using single-line spec */
295 YAZ_EXPORT void ccl_qual_fitem (CCL_bibset bibset, const char *cp,
296 const char *qual_name);
298 /* Make CCL qualifier set */
299 YAZ_EXPORT CCL_bibset ccl_qual_mk (void);
301 /* Delete CCL qualifier set */
302 YAZ_EXPORT void ccl_qual_rm (CCL_bibset *b);
304 /* Char-to-upper function */
305 extern int (*ccl_toupper)(int c);
307 /* String utilities */
308 YAZ_EXPORT int ccl_stricmp (const char *s1, const char *s2);
309 YAZ_EXPORT int ccl_memicmp (const char *s1, const char *s2, size_t n);
311 /* Search for qualifier 'name' in set 'b'. */
312 YAZ_EXPORT struct ccl_rpn_attr *ccl_qual_search (CCL_parser cclp,
317 /* Create CCL parser */
318 YAZ_EXPORT CCL_parser ccl_parser_create (void);
320 /* Destroy CCL parser */
321 YAZ_EXPORT void ccl_parser_destroy (CCL_parser p);
323 YAZ_EXPORT char *ccl_strdup (const char *str);
325 YAZ_EXPORT const char *ccl_qual_search_special (CCL_bibset b,
329 #define ccl_assert(x) ;