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.
49 * Revision 1.7 2000-11-01 14:47:00 adam
50 * Added CCL support for WIN32.
52 * Revision 1.6 2000/10/17 19:50:28 adam
53 * Implemented and-list and or-list for CCL module.
55 * Revision 1.5 2000/05/02 17:19:58 adam
56 * Removed MINUS token.
58 * Revision 1.4 2000/03/14 09:06:11 adam
59 * Added POSIX threads support for frontend server.
61 * Revision 1.3 2000/02/08 10:39:53 adam
62 * Added a few functions to set name of operands, etc.
64 * Revision 1.2 2000/01/31 13:15:21 adam
65 * Removed uses of assert(3). Cleanup of ODR. CCL parser update so
66 * that some characters are not surrounded by spaces in resulting term.
69 * Revision 1.1 1999/11/30 13:47:11 adam
70 * Improved installation. Moved header files to include/yaz.
72 * Revision 1.9 1998/02/11 11:53:33 adam
73 * Changed code so that it compiles as C++.
75 * Revision 1.8 1997/09/29 09:01:19 adam
76 * Changed CCL parser to be thread safe. New type, CCL-parser, declared
77 * and a create/destructor ccl_parser_create/ccl_parser_destroy has been
80 * Revision 1.7 1997/09/01 08:49:47 adam
81 * New windows NT/95 port using MSV5.0. To export DLL functions the
82 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
84 * Revision 1.6 1997/05/14 06:53:37 adam
87 * Revision 1.5 1997/04/30 08:52:08 quinn
90 * Revision 1.4 1996/10/11 15:02:26 adam
91 * CCL parser from Europagate Email gateway 1.0.
93 * Revision 1.10 1996/01/08 08:41:22 adam
96 * Revision 1.9 1995/07/20 08:15:16 adam
97 * Bug fix: Token value for comma and OR were the same!
99 * Revision 1.8 1995/07/11 12:28:34 adam
100 * New function: ccl_token_simple (split into simple tokens) and
101 * ccl_token_del (delete tokens).
103 * Revision 1.7 1995/05/16 09:39:38 adam
106 * Revision 1.6 1995/05/11 14:04:03 adam
107 * Changes in the reading of qualifier(s). New function: ccl_qual_fitem.
108 * New variable ccl_case_sensitive, which controls whether reserved
109 * words and field names are case sensitive or not.
111 * Revision 1.5 1995/02/23 08:32:11 adam
114 * Revision 1.3 1995/02/16 13:20:10 adam
117 * Revision 1.2 1995/02/15 17:43:08 adam
118 * Minor changes to the ccl interface. Bug fix in iso2709 module.
120 * Revision 1.1 1995/02/14 19:55:21 adam
121 * Header files ccl.h/cclp.h are gone! They have been merged an
122 * moved to ../include/ccl.h.
129 #include <yaz/yconfig.h>
134 /* CCL error numbers */
136 #define CCL_ERR_TERM_EXPECTED 1
137 #define CCL_ERR_RP_EXPECTED 2
138 #define CCL_ERR_SETNAME_EXPECTED 3
139 #define CCL_ERR_OP_EXPECTED 4
140 #define CCL_ERR_BAD_RP 5
141 #define CCL_ERR_UNKNOWN_QUAL 6
142 #define CCL_ERR_DOUBLE_QUAL 7
143 #define CCL_ERR_EQ_EXPECTED 8
144 #define CCL_ERR_BAD_RELATION 9
145 #define CCL_ERR_TRUNC_NOT_LEFT 10
146 #define CCL_ERR_TRUNC_NOT_BOTH 11
147 #define CCL_ERR_TRUNC_NOT_RIGHT 12
149 /* attribute pair (type, value) */
150 struct ccl_rpn_attr {
151 struct ccl_rpn_attr *next;
156 #define CCL_RPN_AND 1
158 #define CCL_RPN_NOT 3
159 #define CCL_RPN_TERM 4
160 #define CCL_RPN_SET 5
161 #define CCL_RPN_PROX 6
163 /* RPN tree structure */
164 struct ccl_rpn_node {
167 struct ccl_rpn_node *p[2];
170 struct ccl_rpn_attr *attr_list;
176 typedef struct ccl_qualifiers *CCL_bibset;
183 1-6 relation (<, <=, =, >=, >, <>)
189 3 any position in field
192 0 word/phrase auto select
199 100 date (un-normalized)
200 101 name (normalized)
201 102 name (un-normalized)
206 #define CCL_BIB1_USE 1
207 #define CCL_BIB1_REL 2
208 #define CCL_BIB1_POS 3
209 #define CCL_BIB1_STR 4
210 #define CCL_BIB1_TRU 5
211 #define CCL_BIB1_COM 6
213 #define CCL_BIB1_STR_WP (-1)
214 #define CCL_BIB1_STR_AND_LIST (-2)
215 #define CCL_BIB1_STR_OR_LIST (-3)
216 #define CCL_BIB1_REL_ORDER (-1)
218 #define CCL_BIB1_TRU_CAN_LEFT (-1)
219 #define CCL_BIB1_TRU_CAN_RIGHT (-2)
220 #define CCL_BIB1_TRU_CAN_BOTH (-3)
221 #define CCL_BIB1_TRU_CAN_NONE (-4)
223 #define CCL_TOK_EOL 0
224 #define CCL_TOK_TERM 1
225 #define CCL_TOK_REL 2
227 #define CCL_TOK_PROX 4
230 #define CCL_TOK_COMMA 7
231 #define CCL_TOK_AND 8
233 #define CCL_TOK_NOT 10
234 #define CCL_TOK_SET 11
241 struct ccl_token *next;
242 struct ccl_token *prev;
246 struct ccl_qualifier {
248 struct ccl_rpn_attr *attr_list;
249 struct ccl_qualifier *next;
253 /* current lookahead token */
254 struct ccl_token *look_token;
256 /* holds error code if error occur (and approx position of error) */
258 const char *error_pos;
267 int ccl_case_sensitive;
270 typedef struct ccl_parser *CCL_parser;
272 /* Generate tokens from command string - obeys all CCL opererators */
273 YAZ_EXPORT struct ccl_token *ccl_parser_tokenize (CCL_parser cclp,
274 const char *command);
275 YAZ_EXPORT struct ccl_token *ccl_tokenize (const char *command);
277 /* Generate tokens from command string - oebeys only simple tokens and
279 YAZ_EXPORT struct ccl_token *ccl_token_simple (const char *command);
281 /* Delete token list */
282 YAZ_EXPORT void ccl_token_del (struct ccl_token *list);
284 /* Parse CCL Find command - NULL-terminated string */
285 YAZ_EXPORT struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset,
286 const char *str, int *error, int *pos);
288 /* Parse CCL Find command - Tokens read by ccl_tokenize */
289 YAZ_EXPORT struct ccl_rpn_node *ccl_find (CCL_bibset abibset, struct ccl_token *list,
290 int *error, const char **pos);
292 /* Parse CCL Find command */
293 YAZ_EXPORT struct ccl_rpn_node *ccl_parser_find (CCL_parser cclp, struct ccl_token *list);
295 /* Set various OPs */
296 YAZ_EXPORT void ccl_parser_set_op_and (CCL_parser p, const char *op);
297 YAZ_EXPORT void ccl_parser_set_op_or (CCL_parser p, const char *op);
298 YAZ_EXPORT void ccl_parser_set_op_not (CCL_parser p, const char *op);
299 YAZ_EXPORT void ccl_parser_set_op_set (CCL_parser p, const char *op);
301 YAZ_EXPORT void ccl_parser_set_case (CCL_parser p, int case_sensitivity_flag);
303 /* Return english-readable error message */
304 YAZ_EXPORT const char *ccl_err_msg (int ccl_errno);
306 /* Delete RPN tree returned by ccl_find */
307 YAZ_EXPORT void ccl_rpn_delete (struct ccl_rpn_node *rpn);
309 /* Dump RPN tree in readable format to fd_out */
310 YAZ_EXPORT void ccl_pr_tree (struct ccl_rpn_node *rpn, FILE *fd_out);
312 /* Add CCL qualifier */
313 YAZ_EXPORT void ccl_qual_add (CCL_bibset b, const char *name, int no, int *attr);
315 /* Read CCL qualifier list spec from file inf */
316 YAZ_EXPORT void ccl_qual_file (CCL_bibset bibset, FILE *inf);
318 /* Add CCL qualifier by using single-line spec */
319 YAZ_EXPORT void ccl_qual_fitem (CCL_bibset bibset, const char *cp, const char *qual_name);
321 /* Make CCL qualifier set */
322 YAZ_EXPORT CCL_bibset ccl_qual_mk (void);
324 /* Delete CCL qualifier set */
325 YAZ_EXPORT void ccl_qual_rm (CCL_bibset *b);
327 /* Char-to-upper function */
328 extern int (*ccl_toupper)(int c);
330 /* String utilities */
331 YAZ_EXPORT int ccl_stricmp (const char *s1, const char *s2);
332 YAZ_EXPORT int ccl_memicmp (const char *s1, const char *s2, size_t n);
334 /* Search for qualifier 'name' in set 'b'. */
335 YAZ_EXPORT struct ccl_rpn_attr *ccl_qual_search (CCL_parser cclp, const char *name,
338 /* Create CCL parser */
339 YAZ_EXPORT CCL_parser ccl_parser_create (void);
341 /* Destroy CCL parser */
342 YAZ_EXPORT void ccl_parser_destroy (CCL_parser p);
346 #define ccl_assert(x) ;