Bump year
[yaz-moved-to-github.git] / src / cclfind.c
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2013 Index Data
3  * See the file LICENSE for details.
4  */
5 /**
6  * \file cclfind.c
7  * \brief Implements parsing of a CCL FIND query.
8  *
9  * This source file implements parsing of a CCL Query (ISO8777).
10  * The parser uses predictive parsing, but it does several tokens
11  * of lookahead in the handling of relational operations.. So
12  * it's not really pure.
13  */
14 #if HAVE_CONFIG_H
15 #include <config.h>
16 #endif
17
18 #include <stdlib.h>
19 #include <string.h>
20 #include <assert.h>
21
22 #include "cclp.h"
23
24 /* returns type of current lookahead */
25 #define KIND (cclp->look_token->kind)
26
27 /* move one token forward */
28 #define ADVANCE cclp->look_token = cclp->look_token->next
29
30 /**
31  * qual_val_type: test for existance of attribute type/value pair.
32  * qa:     Attribute array
33  * type:   Type of attribute to search for
34  * value:  Value of attribute to seach for
35  * return: 1 if found; 0 otherwise.
36  */
37 static int qual_val_type(ccl_qualifier_t *qa, int type, int value,
38                          char **attset)
39 {
40     int i;
41
42     if (!qa)
43         return 0;
44     for (i = 0; qa[i]; i++)
45     {
46         struct ccl_rpn_attr *q = ccl_qual_get_attr(qa[i]);
47         while (q)
48         {
49             if (q->type == type && q->kind == CCL_RPN_ATTR_NUMERIC &&
50                 q->value.numeric == value)
51             {
52                 if (attset)
53                     *attset = q->set;
54                 return 1;
55             }
56             q = q->next;
57         }
58     }
59     return 0;
60 }
61
62 /**
63  * strxcat: concatenate strings.
64  * n:      Null-terminated Destination string
65  * src:    Source string to be appended (not null-terminated)
66  * len:    Length of source string.
67  */
68 static void strxcat(char *n, const char *src, int len)
69 {
70     while (*n)
71         n++;
72     while (--len >= 0)
73         *n++ = *src++;
74     *n = '\0';
75 }
76
77 /**
78  * copy_token_name: Return copy of CCL token name
79  * tp:      Pointer to token info.
80  * return:  malloc(3) allocated copy of token name.
81  */
82 static char *copy_token_name(struct ccl_token *tp)
83 {
84     char *str = (char *)xmalloc(tp->len + 1);
85     ccl_assert(str);
86     memcpy(str, tp->name, tp->len);
87     str[tp->len] = '\0';
88     return str;
89 }
90
91 /**
92  * mk_node: Create RPN node.
93  * kind:   Type of node.
94  * return: pointer to allocated node.
95  */
96 struct ccl_rpn_node *ccl_rpn_node_create(enum ccl_rpn_kind kind)
97 {
98     struct ccl_rpn_node *p;
99     p = (struct ccl_rpn_node *)xmalloc(sizeof(*p));
100     ccl_assert(p);
101     p->kind = kind;
102
103     switch(kind)
104     {
105     case CCL_RPN_TERM:
106         p->u.t.attr_list = 0;
107         p->u.t.term = 0;
108         p->u.t.qual = 0;
109         break;
110     default:
111         break;
112     }
113     return p;
114 }
115
116 /**
117  * ccl_rpn_delete: Delete RPN tree.
118  * rpn:   Pointer to tree.
119  */
120 void ccl_rpn_delete(struct ccl_rpn_node *rpn)
121 {
122     struct ccl_rpn_attr *attr, *attr1;
123     if (!rpn)
124         return;
125     switch (rpn->kind)
126     {
127     case CCL_RPN_AND:
128     case CCL_RPN_OR:
129     case CCL_RPN_NOT:
130         ccl_rpn_delete(rpn->u.p[0]);
131         ccl_rpn_delete(rpn->u.p[1]);
132         break;
133     case CCL_RPN_TERM:
134         xfree(rpn->u.t.term);
135         xfree(rpn->u.t.qual);
136         for (attr = rpn->u.t.attr_list; attr; attr = attr1)
137         {
138             attr1 = attr->next;
139             if (attr->kind == CCL_RPN_ATTR_STRING)
140                 xfree(attr->value.str);
141             if (attr->set)
142                 xfree(attr->set);
143             xfree(attr);
144         }
145         break;
146     case CCL_RPN_SET:
147         xfree(rpn->u.setname);
148         break;
149     case CCL_RPN_PROX:
150         ccl_rpn_delete(rpn->u.p[0]);
151         ccl_rpn_delete(rpn->u.p[1]);
152         ccl_rpn_delete(rpn->u.p[2]);
153         break;
154     }
155     xfree(rpn);
156 }
157
158 static struct ccl_rpn_node *find_spec(CCL_parser cclp, ccl_qualifier_t *qa);
159
160 static int is_term_ok(int look, int *list)
161 {
162     for (;*list >= 0; list++)
163         if (look == *list)
164             return 1;
165     return 0;
166 }
167
168 static struct ccl_rpn_node *search_terms(CCL_parser cclp, ccl_qualifier_t *qa);
169
170 static struct ccl_rpn_attr *add_attr_node(struct ccl_rpn_node *p,
171                                            const char *set, int type)
172 {
173     struct ccl_rpn_attr *n;
174
175     n = (struct ccl_rpn_attr *)xmalloc(sizeof(*n));
176     ccl_assert(n);
177     if (set)
178         n->set = xstrdup(set);
179     else
180         n->set = 0;
181     n->type = type;
182     n->next = p->u.t.attr_list;
183     p->u.t.attr_list = n;
184
185     return n;
186 }
187
188 /**
189  * add_attr_numeric: Add attribute (type/value) to RPN term node.
190  * p:     RPN node of type term.
191  * type:  Type of attribute
192  * value: Value of attribute
193  * set: Attribute set name
194  */
195 void ccl_add_attr_numeric(struct ccl_rpn_node *p, const char *set,
196                           int type, int value)
197 {
198     struct ccl_rpn_attr *n;
199
200     n = add_attr_node(p, set, type);
201     n->kind = CCL_RPN_ATTR_NUMERIC;
202     n->value.numeric = value;
203 }
204
205 void ccl_add_attr_string(struct ccl_rpn_node *p, const char *set,
206                          int type, char *value)
207 {
208     struct ccl_rpn_attr *n;
209
210     n = add_attr_node(p, set, type);
211     n->kind = CCL_RPN_ATTR_STRING;
212     n->value.str = xstrdup(value);
213 }
214
215 static size_t cmp_operator(const char **aliases, const char *input)
216 {
217     for (; *aliases; aliases++)
218     {
219         const char *cp = *aliases;
220         size_t i;
221         for (i = 0; *cp && *cp == input[i]; i++, cp++)
222             ;
223         if (*cp == '\0')
224             return i;
225     }
226     return 0;
227 }
228
229
230 #define REGEX_CHARS "^[]{}()|.*+?!$"
231 #define CCL_CHARS "#?\\"
232 static int append_term(CCL_parser cclp, const char *src_str, size_t src_len,
233                        char *dst_term, int *regex_trunc, int *z3958_trunc,
234                        const char **truncation_aliases,
235                        int is_first, int is_last,
236                        int *left_trunc, int *right_trunc)
237 {
238     size_t j;
239     int quote_mode = 0;
240
241     for (j = 0; j < src_len; j++)
242     {
243         size_t op_size;
244         if (j > 0 && src_str[j-1] == '\\')
245         {
246             if (*regex_trunc && strchr(REGEX_CHARS "\\", src_str[j]))
247             {
248                 *regex_trunc = 2;
249                 strcat(dst_term, "\\");
250             }
251             else if (*z3958_trunc && strchr(CCL_CHARS "\\", src_str[j]))
252             {
253                 *z3958_trunc = 2;
254                 strcat(dst_term, "\\");
255             }
256             strxcat(dst_term, src_str + j, 1);
257         }
258         else if (src_str[j] == '"')
259             quote_mode = !quote_mode;
260         else if (!quote_mode &&
261                  (op_size = cmp_operator(truncation_aliases,
262                                          src_str + j))
263             )
264         {
265             j += (op_size - 1);  /* j++ in for loop */
266             if (*regex_trunc)
267             {
268                 strcat(dst_term, ".*");
269                 *regex_trunc = 2; /* regex trunc is really needed */
270             }
271             else if (*z3958_trunc)
272             {
273                 strcat(dst_term, "?");
274                 *z3958_trunc = 2;
275             }
276             else if (is_first && j == 0)
277                 *left_trunc = 1;
278             else if (is_last && j == src_len - 1)
279                 *right_trunc = 1;
280             else
281             {
282                 cclp->error_code = CCL_ERR_TRUNC_NOT_EMBED;
283                 return -1;
284             }
285         }
286         else if (!quote_mode && src_str[j] == '#')
287         {
288             if (*regex_trunc)
289             {
290                 strcat(dst_term, ".");
291                 *regex_trunc = 2; /* regex trunc is really needed */
292             }
293             else if (*z3958_trunc)
294             {
295                 strcat(dst_term, "#");
296                 *z3958_trunc = 2;
297             }
298             else
299             {
300                 cclp->error_code = CCL_ERR_TRUNC_NOT_SINGLE;
301                 return -1;
302             }
303         }
304         else if (src_str[j] != '\\')
305         {
306             if (*regex_trunc && strchr(REGEX_CHARS, src_str[j]))
307             {
308                 *regex_trunc = 2;
309                 strcat(dst_term, "\\");
310             }
311             else if (*z3958_trunc && strchr(CCL_CHARS, src_str[j]))
312             {
313                 *z3958_trunc = 2;
314                 strcat(dst_term, "\\");
315             }
316             strxcat(dst_term, src_str + j, 1);
317         }
318     }
319     return 0;
320 }
321
322 /**
323  * search_term: Parse CCL search term.
324  * cclp:   CCL Parser
325  * qa:     Qualifier attributes already applied.
326  * term_list: tokens we accept as terms in context
327  * multi:  whether we accept "multiple" tokens
328  * return: pointer to node(s); NULL on error.
329  */
330 static struct ccl_rpn_node *search_term_x(CCL_parser cclp,
331                                           ccl_qualifier_t *qa,
332                                           int *term_list, int multi)
333 {
334     struct ccl_rpn_node *p_top = 0;
335     struct ccl_token *lookahead = cclp->look_token;
336     int and_list = 0;
337     int auto_group = 0;
338     int or_list = 0;
339     char *attset;
340     const char **truncation_aliases;
341     const char *t_default[2];
342
343     truncation_aliases =
344         ccl_qual_search_special(cclp->bibset, "truncation");
345     if (!truncation_aliases)
346     {
347         truncation_aliases = t_default;
348         t_default[0] = "?";
349         t_default[1] = 0;
350     }
351
352     if (qual_val_type(qa, CCL_BIB1_STR, CCL_BIB1_STR_AND_LIST, 0))
353         and_list = 1;
354     if (qual_val_type(qa, CCL_BIB1_STR, CCL_BIB1_STR_AUTO_GROUP, 0))
355         auto_group = 1;
356     if (qual_val_type(qa, CCL_BIB1_STR, CCL_BIB1_STR_OR_LIST, 0))
357         or_list = 1;
358     while (1)
359     {
360         struct ccl_rpn_node *p;
361         size_t no, i;
362         int is_phrase = 0;
363         int relation_value = -1;
364         int position_value = -1;
365         int structure_value = -1;
366         int truncation_value = -1;
367         int completeness_value = -1;
368         int len = 0;
369         int left_trunc = 0;
370         int right_trunc = 0;
371         int regex_trunc = 0;
372         int z3958_trunc = 0;
373         size_t max = 200;
374         if (and_list || or_list || !multi)
375             max = 1;
376
377         /* ignore commas when dealing with and-lists .. */
378         if (and_list && lookahead && lookahead->kind == CCL_TOK_COMMA)
379         {
380             lookahead = lookahead->next;
381             ADVANCE;
382             continue;
383         }
384         for (no = 0; no < max && is_term_ok(lookahead->kind, term_list); no++)
385         {
386             int this_is_phrase = 0;
387             for (i = 0; i<lookahead->len; i++)
388                 if (lookahead->name[i] == ' ')
389                     this_is_phrase = 1;
390
391             if (auto_group)
392             {
393                 if (no > 0 && (is_phrase || is_phrase != this_is_phrase))
394                     break;
395                 is_phrase = this_is_phrase;
396             }
397             else if (this_is_phrase || no > 0)
398                 is_phrase = 1;
399             len += 1+lookahead->len+lookahead->ws_prefix_len;
400             lookahead = lookahead->next;
401         }
402
403         if (len == 0)
404             break;      /* no more terms . stop . */
405
406         /* create the term node, but wait a moment before adding the term */
407         p = ccl_rpn_node_create(CCL_RPN_TERM);
408         p->u.t.attr_list = NULL;
409         p->u.t.term = NULL;
410         if (qa && qa[0])
411         {
412             const char *n = ccl_qual_get_name(qa[0]);
413             if (n)
414                 p->u.t.qual = xstrdup(n);
415         }
416
417         /* go through all attributes and add them to the attribute list */
418         for (i=0; qa && qa[i]; i++)
419         {
420             struct ccl_rpn_attr *attr;
421
422             for (attr = ccl_qual_get_attr(qa[i]); attr; attr = attr->next)
423                 switch(attr->kind)
424                 {
425                 case CCL_RPN_ATTR_STRING:
426                     ccl_add_attr_string(p, attr->set, attr->type,
427                                         attr->value.str);
428                     break;
429                 case CCL_RPN_ATTR_NUMERIC:
430                     if (attr->value.numeric > 0)
431                     {   /* deal only with REAL attributes (positive) */
432                         switch (attr->type)
433                         {
434                         case CCL_BIB1_REL:
435                             if (relation_value != -1)
436                                 continue;
437                             relation_value = attr->value.numeric;
438                             break;
439                         case CCL_BIB1_POS:
440                             if (position_value != -1)
441                                 continue;
442                             position_value = attr->value.numeric;
443                             break;
444                         case CCL_BIB1_STR:
445                             if (structure_value != -1)
446                                 continue;
447                             structure_value = attr->value.numeric;
448                             break;
449                         case CCL_BIB1_TRU:
450                             if (truncation_value != -1)
451                                 continue;
452                             truncation_value = attr->value.numeric;
453                             break;
454                         case CCL_BIB1_COM:
455                             if (completeness_value != -1)
456                                 continue;
457                             completeness_value = attr->value.numeric;
458                             break;
459                         }
460                         ccl_add_attr_numeric(p, attr->set, attr->type,
461                                              attr->value.numeric);
462                     }
463                 }
464         }
465         attset = 0;
466         if (structure_value == -1 && (
467                 auto_group ||
468                 qual_val_type(qa, CCL_BIB1_STR, CCL_BIB1_STR_WP, &attset))
469             )
470         {
471             if (!is_phrase)
472                 ccl_add_attr_numeric(p, attset, CCL_BIB1_STR, 2);
473             else
474                 ccl_add_attr_numeric(p, attset, CCL_BIB1_STR, 1);
475         }
476
477         if (qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_REGEX,
478                           &attset))
479         {
480             regex_trunc = 1; /* regex trunc (102) allowed */
481         }
482         else if (qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_Z3958,
483                           &attset))
484         {
485             z3958_trunc = 1; /* Z39.58 trunc (CCL) trunc allowed */
486         }
487
488         /* make the RPN token */
489         p->u.t.term = (char *)xmalloc(len * 2 + 2);
490         ccl_assert(p->u.t.term);
491         p->u.t.term[0] = '\0';
492         for (i = 0; i<no; i++)
493         {
494             const char *src_str = cclp->look_token->name;
495             size_t src_len = cclp->look_token->len;
496
497             if (p->u.t.term[0] && cclp->look_token->ws_prefix_len)
498             {
499                 strxcat(p->u.t.term, cclp->look_token->ws_prefix_buf,
500                         cclp->look_token->ws_prefix_len);
501             }
502             if (append_term(cclp, src_str, src_len, p->u.t.term, &regex_trunc,
503                             &z3958_trunc, truncation_aliases, i == 0, i == no - 1,
504                             &left_trunc, &right_trunc))
505             {
506                 ccl_rpn_delete(p);
507                 return NULL;
508             }
509             ADVANCE;
510         }
511         /* make the top node point to us.. */
512         if (p_top)
513         {
514             struct ccl_rpn_node *tmp;
515
516             if (or_list)
517                 tmp = ccl_rpn_node_create(CCL_RPN_OR);
518             else if (and_list)
519                 tmp = ccl_rpn_node_create(CCL_RPN_AND);
520             else
521                 tmp = ccl_rpn_node_create(CCL_RPN_AND);
522             tmp->u.p[0] = p_top;
523             tmp->u.p[1] = p;
524
525             p_top = tmp;
526         }
527         else
528             p_top = p;
529
530
531         if (left_trunc && right_trunc)
532         {
533             if (!qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_BOTH,
534                                 &attset))
535             {
536                 cclp->error_code = CCL_ERR_TRUNC_NOT_BOTH;
537                 ccl_rpn_delete(p);
538                 return NULL;
539             }
540             ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 3);
541         }
542         else if (right_trunc)
543         {
544             if (!qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_RIGHT,
545                                  &attset))
546             {
547                 cclp->error_code = CCL_ERR_TRUNC_NOT_RIGHT;
548                 ccl_rpn_delete(p);
549                 return NULL;
550             }
551             ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 1);
552         }
553         else if (left_trunc)
554         {
555             if (!qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_LEFT,
556                                 &attset))
557             {
558                 cclp->error_code = CCL_ERR_TRUNC_NOT_LEFT;
559                 ccl_rpn_delete(p);
560                 return NULL;
561             }
562             ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 2);
563         }
564         else if (regex_trunc == 2)
565         {
566             ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 102);
567         }
568         else if (z3958_trunc == 2)
569         {
570             ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 104);
571         }
572         else
573         {
574             if (qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_NONE,
575                                &attset))
576                 ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 100);
577         }
578         if (!multi)
579             break;
580     }
581     if (!p_top)
582         cclp->error_code = CCL_ERR_TERM_EXPECTED;
583     return p_top;
584 }
585
586 static struct ccl_rpn_node *search_term(CCL_parser cclp, ccl_qualifier_t *qa)
587 {
588     static int list[] = {CCL_TOK_TERM, CCL_TOK_COMMA, -1};
589     return search_term_x(cclp, qa, list, 0);
590 }
591
592
593 static struct ccl_rpn_node *search_terms2(CCL_parser cclp,
594                                           ccl_qualifier_t *qa)
595 {
596     if (KIND == CCL_TOK_LP)
597     {
598         struct ccl_rpn_node *p;
599         ADVANCE;
600         if (!(p = find_spec(cclp, qa)))
601             return NULL;
602         if (KIND != CCL_TOK_RP)
603         {
604             cclp->error_code = CCL_ERR_RP_EXPECTED;
605             ccl_rpn_delete(p);
606             return NULL;
607         }
608         ADVANCE;
609         return p;
610     }
611     else
612     {
613         static int list[] = {
614             CCL_TOK_TERM, CCL_TOK_COMMA,CCL_TOK_EQ,
615             CCL_TOK_REL, CCL_TOK_SET, -1};
616
617         return search_term_x(cclp, qa, list, 1);
618     }
619 }
620
621
622
623 static
624 struct ccl_rpn_node *qualifiers_order(CCL_parser cclp,
625                                       ccl_qualifier_t *ap, char *attset)
626 {
627     int rel = 0;
628     struct ccl_rpn_node *p;
629
630     if (cclp->look_token->len == 1)
631     {
632         if (cclp->look_token->name[0] == '<')
633             rel = 1;
634         else if (cclp->look_token->name[0] == '=')
635             rel = 3;
636         else if (cclp->look_token->name[0] == '>')
637             rel = 5;
638     }
639     else if (cclp->look_token->len == 2)
640     {
641         if (!memcmp(cclp->look_token->name, "<=", 2))
642             rel = 2;
643         else if (!memcmp(cclp->look_token->name, ">=", 2))
644             rel = 4;
645         else if (!memcmp(cclp->look_token->name, "<>", 2))
646             rel = 6;
647     }
648     if (!rel)
649     {
650         cclp->error_code = CCL_ERR_BAD_RELATION;
651         return NULL;
652     }
653     ADVANCE;  /* skip relation */
654     if (rel == 3 &&
655         qual_val_type(ap, CCL_BIB1_REL, CCL_BIB1_REL_PORDER, 0))
656     {
657         /* allow - inside term and treat it as range _always_ */
658         /* relation is =. Extract "embedded" - to separate terms */
659         if (KIND == CCL_TOK_TERM)
660         {
661             size_t i;
662             for (i = 0; i<cclp->look_token->len; i++)
663             {
664                 if (cclp->look_token->name[i] == '-')
665                     break;
666             }
667
668             if (cclp->look_token->len > 1 && i == 0)
669             {   /*  -xx*/
670                 struct ccl_token *ntoken = ccl_token_add(cclp->look_token);
671
672                 ntoken->kind = CCL_TOK_TERM;
673                 ntoken->name = cclp->look_token->name + 1;
674                 ntoken->len = cclp->look_token->len - 1;
675
676                 cclp->look_token->len = 1;
677                 cclp->look_token->name = "-";
678             }
679             else if (cclp->look_token->len > 1 && i == cclp->look_token->len-1)
680             {   /* xx- */
681                 struct ccl_token *ntoken = ccl_token_add(cclp->look_token);
682
683                 ntoken->kind = CCL_TOK_TERM;
684                 ntoken->name = "-";
685                 ntoken->len = 1;
686
687                 (cclp->look_token->len)--;
688             }
689             else if (cclp->look_token->len > 2 && i < cclp->look_token->len)
690             {   /* xx-yy */
691                 struct ccl_token *ntoken1 = ccl_token_add(cclp->look_token);
692                 struct ccl_token *ntoken2 = ccl_token_add(ntoken1);
693
694                 ntoken1->kind = CCL_TOK_TERM;  /* generate - */
695                 ntoken1->name = "-";
696                 ntoken1->len = 1;
697
698                 ntoken2->kind = CCL_TOK_TERM;  /* generate yy */
699                 ntoken2->name = cclp->look_token->name + (i+1);
700                 ntoken2->len = cclp->look_token->len - (i+1);
701
702                 cclp->look_token->len = i;     /* adjust xx */
703             }
704             else if (i == cclp->look_token->len &&
705                      cclp->look_token->next &&
706                      cclp->look_token->next->kind == CCL_TOK_TERM &&
707                      cclp->look_token->next->len > 1 &&
708                      cclp->look_token->next->name[0] == '-')
709
710             {   /* xx -yy */
711                 /* we _know_ that xx does not have - in it */
712                 struct ccl_token *ntoken = ccl_token_add(cclp->look_token);
713
714                 ntoken->kind = CCL_TOK_TERM;    /* generate - */
715                 ntoken->name = "-";
716                 ntoken->len = 1;
717
718                 (ntoken->next->name)++;        /* adjust yy */
719                 (ntoken->next->len)--;
720             }
721         }
722     }
723
724     if (rel == 3 &&
725         KIND == CCL_TOK_TERM &&
726         cclp->look_token->next && cclp->look_token->next->len == 1 &&
727         cclp->look_token->next->name[0] == '-')
728     {
729         struct ccl_rpn_node *p1;
730         if (!(p1 = search_term(cclp, ap)))
731             return NULL;
732         ADVANCE;                   /* skip '-' */
733         if (KIND == CCL_TOK_TERM)  /* = term - term  ? */
734         {
735             struct ccl_rpn_node *p2;
736
737             if (!(p2 = search_term(cclp, ap)))
738             {
739                 ccl_rpn_delete(p1);
740                 return NULL;
741             }
742             p = ccl_rpn_node_create(CCL_RPN_AND);
743             p->u.p[0] = p1;
744             ccl_add_attr_numeric(p1, attset, CCL_BIB1_REL, 4);
745             p->u.p[1] = p2;
746             ccl_add_attr_numeric(p2, attset, CCL_BIB1_REL, 2);
747             return p;
748         }
749         else                       /* = term -    */
750         {
751             ccl_add_attr_numeric(p1, attset, CCL_BIB1_REL, 4);
752             return p1;
753         }
754     }
755     else if (rel == 3 &&
756              cclp->look_token->len == 1 &&
757              cclp->look_token->name[0] == '-')   /* = - term  ? */
758     {
759         ADVANCE;
760         if (!(p = search_term(cclp, ap)))
761             return NULL;
762         ccl_add_attr_numeric(p, attset, CCL_BIB1_REL, 2);
763         return p;
764     }
765     else
766     {
767         if (!(p = search_terms(cclp, ap)))
768             return NULL;
769         ccl_add_attr_numeric(p, attset, CCL_BIB1_REL, rel);
770         return p;
771     }
772     cclp->error_code = CCL_ERR_TERM_EXPECTED;
773     return NULL;
774 }
775
776 static
777 struct ccl_rpn_node *qualifier_relation(CCL_parser cclp, ccl_qualifier_t *ap)
778 {
779     char *attset;
780
781     if (qual_val_type(ap, CCL_BIB1_REL, CCL_BIB1_REL_ORDER, &attset)
782         || qual_val_type(ap, CCL_BIB1_REL, CCL_BIB1_REL_PORDER, &attset))
783         return qualifiers_order(cclp, ap, attset);
784
785     /* unordered relation */
786     if (KIND != CCL_TOK_EQ)
787     {
788         cclp->error_code = CCL_ERR_EQ_EXPECTED;
789         return NULL;
790     }
791     ADVANCE;
792     return search_terms(cclp, ap);
793 }
794
795 /**
796  * qualifier_list: Parse CCL qualifiers and search terms.
797  * cclp:   CCL Parser
798  * la:     Token pointer to RELATION token.
799  * qa:     Qualifier attributes already applied.
800  * return: pointer to node(s); NULL on error.
801  */
802 static struct ccl_rpn_node *qualifier_list(CCL_parser cclp,
803                                            struct ccl_token *la,
804                                            ccl_qualifier_t *qa)
805 {
806     struct ccl_token *lookahead = cclp->look_token;
807     struct ccl_token *look_start = cclp->look_token;
808     ccl_qualifier_t *ap;
809     struct ccl_rpn_node *node = 0;
810     const char **field_str;
811     int no = 0;
812     int seq = 0;
813     int i;
814     int mode_merge = 1;
815 #if 0
816     if (qa)
817     {
818         cclp->error_code = CCL_ERR_DOUBLE_QUAL;
819         return NULL;
820     }
821 #endif
822     for (lookahead = cclp->look_token; lookahead != la;
823          lookahead=lookahead->next)
824         no++;
825     if (qa)
826         for (i=0; qa[i]; i++)
827             no++;
828     ap = (ccl_qualifier_t *)xmalloc((no ? (no+1) : 2) * sizeof(*ap));
829     ccl_assert(ap);
830
831     field_str = ccl_qual_search_special(cclp->bibset, "field");
832     if (field_str)
833     {
834         if (!strcmp(field_str[0], "or"))
835             mode_merge = 0;
836         else if (!strcmp(field_str[0], "merge"))
837             mode_merge = 1;
838     }
839     if (!mode_merge)
840     {
841         /* consider each field separately and OR */
842         lookahead = look_start;
843         while (lookahead != la)
844         {
845             ap[1] = 0;
846             seq = 0;
847             while ((ap[0] = ccl_qual_search(cclp, lookahead->name,
848                                             lookahead->len, seq)) != 0)
849             {
850                 struct ccl_rpn_node *node_sub;
851                 cclp->look_token = la;
852
853                 node_sub = qualifier_relation(cclp, ap);
854                 if (!node_sub)
855                 {
856                     ccl_rpn_delete(node);
857                     xfree(ap);
858                     return 0;
859                 }
860                 if (node)
861                 {
862                     struct ccl_rpn_node *node_this =
863                         ccl_rpn_node_create(CCL_RPN_OR);
864                     node_this->u.p[0] = node;
865                     node_this->u.p[1] = node_sub;
866                     node = node_this;
867                 }
868                 else
869                     node = node_sub;
870                 seq++;
871             }
872             if (seq == 0)
873             {
874                 cclp->look_token = lookahead;
875                 cclp->error_code = CCL_ERR_UNKNOWN_QUAL;
876                 xfree(ap);
877                 return NULL;
878             }
879             lookahead = lookahead->next;
880             if (lookahead->kind == CCL_TOK_COMMA)
881                 lookahead = lookahead->next;
882         }
883     }
884     else
885     {
886         /* merge attributes from ALL fields - including inherited ones */
887         while (1)
888         {
889             struct ccl_rpn_node *node_sub;
890             int found = 0;
891             lookahead = look_start;
892             for (i = 0; lookahead != la; i++)
893             {
894                 ap[i] = ccl_qual_search(cclp, lookahead->name,
895                                          lookahead->len, seq);
896                 if (ap[i])
897                     found++;
898                 if (!ap[i] && seq > 0)
899                     ap[i] = ccl_qual_search(cclp, lookahead->name,
900                                              lookahead->len, 0);
901                 if (!ap[i])
902                 {
903                     cclp->look_token = lookahead;
904                     cclp->error_code = CCL_ERR_UNKNOWN_QUAL;
905                     xfree(ap);
906                     return NULL;
907                 }
908                 lookahead = lookahead->next;
909                 if (lookahead->kind == CCL_TOK_COMMA)
910                     lookahead = lookahead->next;
911             }
912             if (qa)
913             {
914                 ccl_qualifier_t *qa0 = qa;
915
916                 while (*qa0)
917                     ap[i++] = *qa0++;
918             }
919             ap[i] = NULL;
920
921             if (!found)
922                 break;
923
924             cclp->look_token = lookahead;
925
926             node_sub = qualifier_relation(cclp, ap);
927             if (!node_sub)
928             {
929                 ccl_rpn_delete(node);
930                 break;
931             }
932             if (node)
933             {
934                 struct ccl_rpn_node *node_this =
935                     ccl_rpn_node_create(CCL_RPN_OR);
936                 node_this->u.p[0] = node;
937                 node_this->u.p[1] = node_sub;
938                 node = node_this;
939             }
940             else
941                 node = node_sub;
942             seq++;
943         }
944     }
945     xfree(ap);
946     return node;
947 }
948
949
950 /**
951  * search_terms: Parse CCL search terms - including proximity.
952  * cclp:   CCL Parser
953  * qa:     Qualifier attributes already applied.
954  * return: pointer to node(s); NULL on error.
955  */
956 static struct ccl_rpn_node *search_terms(CCL_parser cclp, ccl_qualifier_t *qa)
957 {
958     static int list[] = {
959         CCL_TOK_TERM, CCL_TOK_COMMA,CCL_TOK_EQ,
960         CCL_TOK_REL, CCL_TOK_SET, -1};
961     struct ccl_rpn_node *p1, *p2, *pn;
962     p1 = search_terms2(cclp, qa);
963     if (!p1)
964         return NULL;
965     while (1)
966     {
967         if (KIND == CCL_TOK_PROX)
968         {
969             struct ccl_rpn_node *p_prox = 0;
970             /* ! word order specified */
971             /* % word order not specified */
972             p_prox = ccl_rpn_node_create(CCL_RPN_TERM);
973             p_prox->u.t.term = (char *) xmalloc(1 + cclp->look_token->len);
974             memcpy(p_prox->u.t.term, cclp->look_token->name,
975                    cclp->look_token->len);
976             p_prox->u.t.term[cclp->look_token->len] = 0;
977             p_prox->u.t.attr_list = 0;
978
979             ADVANCE;
980             p2 = search_terms2(cclp, qa);
981             if (!p2)
982             {
983                 ccl_rpn_delete(p1);
984                 return NULL;
985             }
986             pn = ccl_rpn_node_create(CCL_RPN_PROX);
987             pn->u.p[0] = p1;
988             pn->u.p[1] = p2;
989             pn->u.p[2] = p_prox;
990             p1 = pn;
991         }
992         else if (is_term_ok(KIND, list))
993         {
994             p2 = search_terms2(cclp, qa);
995             if (!p2)
996             {
997                 ccl_rpn_delete(p1);
998                 return NULL;
999             }
1000             pn = ccl_rpn_node_create(CCL_RPN_PROX);
1001             pn->u.p[0] = p1;
1002             pn->u.p[1] = p2;
1003             pn->u.p[2] = 0;
1004             p1 = pn;
1005         }
1006         else
1007             break;
1008     }
1009     return p1;
1010 }
1011
1012 /**
1013  * search_elements: Parse CCL search elements
1014  * cclp:   CCL Parser
1015  * qa:     Qualifier attributes already applied.
1016  * return: pointer to node(s); NULL on error.
1017  */
1018 static struct ccl_rpn_node *search_elements(CCL_parser cclp,
1019                                             ccl_qualifier_t *qa)
1020 {
1021     struct ccl_rpn_node *p1;
1022     struct ccl_token *lookahead;
1023     if (KIND == CCL_TOK_SET)
1024     {
1025         ADVANCE;
1026         if (KIND == CCL_TOK_EQ)
1027             ADVANCE;
1028         if (KIND != CCL_TOK_TERM)
1029         {
1030             cclp->error_code = CCL_ERR_SETNAME_EXPECTED;
1031             return NULL;
1032         }
1033         p1 = ccl_rpn_node_create(CCL_RPN_SET);
1034         p1->u.setname = copy_token_name(cclp->look_token);
1035         ADVANCE;
1036         return p1;
1037     }
1038     lookahead = cclp->look_token;
1039
1040     while (lookahead->kind==CCL_TOK_TERM)
1041     {
1042         lookahead = lookahead->next;
1043         if (lookahead->kind == CCL_TOK_REL || lookahead->kind == CCL_TOK_EQ)
1044             return qualifier_list(cclp, lookahead, qa);
1045         if (lookahead->kind != CCL_TOK_COMMA)
1046             break;
1047         lookahead = lookahead->next;
1048     }
1049     if (qa || lookahead->kind == CCL_TOK_LP)
1050         return search_terms(cclp, qa);
1051     else
1052     {
1053         ccl_qualifier_t qa[2];
1054         struct ccl_rpn_node *node = 0;
1055         int seq;
1056         lookahead = cclp->look_token;
1057
1058         qa[1] = 0;
1059         for(seq = 0; ;seq++)
1060         {
1061             struct ccl_rpn_node *node_sub;
1062             qa[0] = ccl_qual_search(cclp, "term", 4, seq);
1063             if (!qa[0])
1064                 break;
1065
1066             cclp->look_token = lookahead;
1067
1068             node_sub = search_terms(cclp, qa);
1069             if (!node_sub)
1070             {
1071                 ccl_rpn_delete(node);
1072                 return 0;
1073             }
1074             if (node)
1075             {
1076                 struct ccl_rpn_node *node_this =
1077                     ccl_rpn_node_create(CCL_RPN_OR);
1078                 node_this->u.p[0] = node;
1079                 node_this->u.p[1] = node_sub;
1080                 node_this->u.p[2] = 0;
1081                 node = node_this;
1082             }
1083             else
1084                 node = node_sub;
1085         }
1086         if (!node)
1087             node = search_terms(cclp, 0);
1088         return node;
1089     }
1090 }
1091
1092 /**
1093  * find_spec: Parse CCL find specification
1094  * cclp:   CCL Parser
1095  * qa:     Qualifier attributes already applied.
1096  * return: pointer to node(s); NULL on error.
1097  */
1098 static struct ccl_rpn_node *find_spec(CCL_parser cclp, ccl_qualifier_t *qa)
1099 {
1100     struct ccl_rpn_node *p1, *p2, *pn;
1101     if (!(p1 = search_elements(cclp, qa)))
1102         return NULL;
1103     while (1)
1104     {
1105         switch (KIND)
1106         {
1107         case CCL_TOK_AND:
1108             ADVANCE;
1109             p2 = search_elements(cclp, qa);
1110             if (!p2)
1111             {
1112                 ccl_rpn_delete(p1);
1113                 return NULL;
1114             }
1115             pn = ccl_rpn_node_create(CCL_RPN_AND);
1116             pn->u.p[0] = p1;
1117             pn->u.p[1] = p2;
1118             pn->u.p[2] = 0;
1119             p1 = pn;
1120             continue;
1121         case CCL_TOK_OR:
1122             ADVANCE;
1123             p2 = search_elements(cclp, qa);
1124             if (!p2)
1125             {
1126                 ccl_rpn_delete(p1);
1127                 return NULL;
1128             }
1129             pn = ccl_rpn_node_create(CCL_RPN_OR);
1130             pn->u.p[0] = p1;
1131             pn->u.p[1] = p2;
1132             pn->u.p[2] = 0;
1133             p1 = pn;
1134             continue;
1135         case CCL_TOK_NOT:
1136             ADVANCE;
1137             p2 = search_elements(cclp, qa);
1138             if (!p2)
1139             {
1140                 ccl_rpn_delete(p1);
1141                 return NULL;
1142             }
1143             pn = ccl_rpn_node_create(CCL_RPN_NOT);
1144             pn->u.p[0] = p1;
1145             pn->u.p[1] = p2;
1146             pn->u.p[2] = 0;
1147             p1 = pn;
1148             continue;
1149         }
1150         break;
1151     }
1152     return p1;
1153 }
1154
1155 struct ccl_rpn_node *ccl_parser_find_str(CCL_parser cclp, const char *str)
1156 {
1157     struct ccl_rpn_node *p;
1158     struct ccl_token *list = ccl_parser_tokenize(cclp, str);
1159     p = ccl_parser_find_token(cclp, list);
1160     ccl_token_del(list);
1161     return p;
1162 }
1163
1164 struct ccl_rpn_node *ccl_parser_find_token(CCL_parser cclp,
1165                                            struct ccl_token *list)
1166 {
1167     struct ccl_rpn_node *p;
1168
1169     cclp->look_token = list;
1170     p = find_spec(cclp, NULL);
1171     if (p && KIND != CCL_TOK_EOL)
1172     {
1173         if (KIND == CCL_TOK_RP)
1174             cclp->error_code = CCL_ERR_BAD_RP;
1175         else
1176             cclp->error_code = CCL_ERR_OP_EXPECTED;
1177         ccl_rpn_delete(p);
1178         p = NULL;
1179     }
1180     cclp->error_pos = cclp->look_token->name;
1181     if (p)
1182         cclp->error_code = CCL_ERR_OK;
1183     else
1184         cclp->error_code = cclp->error_code;
1185     return p;
1186 }
1187
1188 /**
1189  * ccl_find_str: Parse CCL find - string representation
1190  * bibset:  Bibset to be used for the parsing
1191  * str:     String to be parsed
1192  * error:   Pointer to integer. Holds error no. on completion.
1193  * pos:     Pointer to char position. Holds approximate error position.
1194  * return:  RPN tree on successful completion; NULL otherwise.
1195  */
1196 struct ccl_rpn_node *ccl_find_str(CCL_bibset bibset, const char *str,
1197                                   int *error, int *pos)
1198 {
1199     CCL_parser cclp = ccl_parser_create(bibset);
1200     struct ccl_token *list;
1201     struct ccl_rpn_node *p;
1202
1203     list = ccl_parser_tokenize(cclp, str);
1204     p = ccl_parser_find_token(cclp, list);
1205
1206     *error = cclp->error_code;
1207     if (*error)
1208         *pos = cclp->error_pos - str;
1209     ccl_parser_destroy(cclp);
1210     ccl_token_del(list);
1211     return p;
1212 }
1213
1214 /*
1215  * Local variables:
1216  * c-basic-offset: 4
1217  * c-file-style: "Stroustrup"
1218  * indent-tabs-mode: nil
1219  * End:
1220  * vim: shiftwidth=4 tabstop=8 expandtab
1221  */
1222