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.5 1997-04-30 08:52:08 quinn
52 * Revision 1.4 1996/10/11 15:02:26 adam
53 * CCL parser from Europagate Email gateway 1.0.
55 * Revision 1.10 1996/01/08 08:41:22 adam
58 * Revision 1.9 1995/07/20 08:15:16 adam
59 * Bug fix: Token value for comma and OR were the same!
61 * Revision 1.8 1995/07/11 12:28:34 adam
62 * New function: ccl_token_simple (split into simple tokens) and
63 * ccl_token_del (delete tokens).
65 * Revision 1.7 1995/05/16 09:39:38 adam
68 * Revision 1.6 1995/05/11 14:04:03 adam
69 * Changes in the reading of qualifier(s). New function: ccl_qual_fitem.
70 * New variable ccl_case_sensitive, which controls whether reserved
71 * words and field names are case sensitive or not.
73 * Revision 1.5 1995/02/23 08:32:11 adam
76 * Revision 1.3 1995/02/16 13:20:10 adam
79 * Revision 1.2 1995/02/15 17:43:08 adam
80 * Minor changes to the ccl interface. Bug fix in iso2709 module.
82 * Revision 1.1 1995/02/14 19:55:21 adam
83 * Header files ccl.h/cclp.h are gone! They have been merged an
84 * moved to ../include/ccl.h.
91 /* CCL error numbers */
93 #define CCL_ERR_TERM_EXPECTED 1
94 #define CCL_ERR_RP_EXPECTED 2
95 #define CCL_ERR_SETNAME_EXPECTED 3
96 #define CCL_ERR_OP_EXPECTED 4
97 #define CCL_ERR_BAD_RP 5
98 #define CCL_ERR_UNKNOWN_QUAL 6
99 #define CCL_ERR_DOUBLE_QUAL 7
100 #define CCL_ERR_EQ_EXPECTED 8
101 #define CCL_ERR_BAD_RELATION 9
102 #define CCL_ERR_TRUNC_NOT_LEFT 10
103 #define CCL_ERR_TRUNC_NOT_BOTH 11
104 #define CCL_ERR_TRUNC_NOT_RIGHT 12
106 /* attribute pair (type, value) */
107 struct ccl_rpn_attr {
108 struct ccl_rpn_attr *next;
113 /* RPN tree structure */
114 struct ccl_rpn_node {
116 CCL_RPN_AND, CCL_RPN_OR, CCL_RPN_NOT,
122 struct ccl_rpn_node *p[2];
125 struct ccl_rpn_attr *attr_list;
131 typedef struct ccl_qualifiers *CCL_bibset;
138 1-6 relation (<, <=, =, >=, >, <>)
144 3 any position in field
147 0 word/phrase auto select
154 100 date (un-normalized)
155 101 name (normalized)
156 102 name (un-normalized)
161 #define CCL_BIB1_USE 1
162 #define CCL_BIB1_REL 2
163 #define CCL_BIB1_POS 3
164 #define CCL_BIB1_STR 4
165 #define CCL_BIB1_TRU 5
166 #define CCL_BIB1_COM 6
168 #define CCL_BIB1_STR_WP (-1)
169 #define CCL_BIB1_REL_ORDER (-1)
171 #define CCL_BIB1_TRU_CAN_LEFT (-1)
172 #define CCL_BIB1_TRU_CAN_RIGHT (-2)
173 #define CCL_BIB1_TRU_CAN_BOTH (-3)
174 #define CCL_BIB1_TRU_CAN_NONE (-4)
176 #define CCL_TOK_EOL 0
177 #define CCL_TOK_TERM 1
178 #define CCL_TOK_REL 2
180 #define CCL_TOK_PROX 4
183 #define CCL_TOK_COMMA 7
184 #define CCL_TOK_AND 8
186 #define CCL_TOK_NOT 10
187 #define CCL_TOK_MINUS 11
188 #define CCL_TOK_SET 12
195 struct ccl_token *next;
196 struct ccl_token *prev;
200 struct ccl_qualifier {
202 struct ccl_rpn_attr *attr_list;
203 struct ccl_qualifier *next;
206 /* Generate tokens from command string - obeys all CCL opererators */
207 struct ccl_token *ccl_tokenize (const char *command);
209 /* Generate tokens from command string - oebeys only simple tokens and
211 struct ccl_token *ccl_token_simple (const char *command);
213 /* Delete token list */
214 void ccl_token_del (struct ccl_token *list);
216 /* Parse CCL Find command - NULL-terminated string */
217 struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset,
218 const char *str, int *error, int *pos);
220 /* Parse CCL Find command - Tokens read by ccl_tokenize */
221 struct ccl_rpn_node *ccl_find (CCL_bibset abibset, struct ccl_token *list,
222 int *error, const char **pos);
224 /* Return english-readable error message */
225 char *ccl_err_msg (int ccl_errno);
227 /* Delete RPN tree returned by ccl_find */
228 void ccl_rpn_delete (struct ccl_rpn_node *rpn);
230 /* Dump RPN tree in readable format to fd_out */
231 void ccl_pr_tree (struct ccl_rpn_node *rpn, FILE *fd_out);
233 /* Add CCL qualifier */
234 void ccl_qual_add (CCL_bibset b, const char *name, int no, int *attr);
236 /* Read CCL qualifier list spec from file inf */
237 void ccl_qual_file (CCL_bibset bibset, FILE *inf);
239 /* Add CCL qualifier by using single-line spec */
240 void ccl_qual_fitem (CCL_bibset bibset, const char *cp, const char *qual_name);
242 /* Make CCL qualifier set */
243 CCL_bibset ccl_qual_mk (void);
245 /* Delete CCL qualifier set */
246 void ccl_qual_rm (CCL_bibset *b);
248 /* Misc. reserved words */
249 extern const char *ccl_token_and;
250 extern const char *ccl_token_or;
251 extern const char *ccl_token_not;
252 extern const char *ccl_token_set;
254 /* Whether the CCL parser is command sensitive */
255 extern int ccl_case_sensitive;
257 /* Char-to-upper function */
258 extern int (*ccl_toupper)(int c);
260 /* String utilities */
261 int ccl_stricmp (const char *s1, const char *s2);
262 int ccl_memicmp (const char *s1, const char *s2, size_t n);
264 /* Search for qualifier 'name' in set 'b'. */
265 struct ccl_rpn_attr *ccl_qual_search (CCL_bibset b, const char *name, int len);