CCL: implement s=ag special
[yaz-moved-to-github.git] / src / cclfind.c
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2012 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         /* len now holds the number of characters in the RPN term */
466         /* no holds the number of CCL tokens (1 or more) */
467         
468         if (structure_value == -1 && 
469             qual_val_type(qa, CCL_BIB1_STR, CCL_BIB1_STR_WP, &attset))
470         {   /* no structure attribute met. Apply either structure attribute 
471                WORD or PHRASE depending on number of CCL tokens */
472             if (!is_phrase)
473                 ccl_add_attr_numeric(p, attset, CCL_BIB1_STR, 2);
474             else
475                 ccl_add_attr_numeric(p, attset, CCL_BIB1_STR, 1);
476         }
477
478         if (qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_REGEX,
479                           &attset))
480         {
481             regex_trunc = 1; /* regex trunc (102) allowed */
482         }
483         else if (qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_Z3958,
484                           &attset))
485         {
486             z3958_trunc = 1; /* Z39.58 trunc (CCL) trunc allowed */
487         }
488
489         /* make the RPN token */
490         p->u.t.term = (char *)xmalloc(len * 2 + 2);
491         ccl_assert(p->u.t.term);
492         p->u.t.term[0] = '\0';
493         for (i = 0; i<no; i++)
494         {
495             const char *src_str = cclp->look_token->name;
496             size_t src_len = cclp->look_token->len;
497
498             if (p->u.t.term[0] && cclp->look_token->ws_prefix_len)
499             {
500                 strxcat(p->u.t.term, cclp->look_token->ws_prefix_buf,
501                         cclp->look_token->ws_prefix_len);
502             }
503             if (append_term(cclp, src_str, src_len, p->u.t.term, &regex_trunc,
504                             &z3958_trunc, truncation_aliases, i == 0, i == no - 1,
505                             &left_trunc, &right_trunc))
506             {
507                 ccl_rpn_delete(p);
508                 return NULL;
509             }
510             ADVANCE;
511         }
512         /* make the top node point to us.. */
513         if (p_top)
514         {
515             struct ccl_rpn_node *tmp;
516
517             if (or_list)
518                 tmp = ccl_rpn_node_create(CCL_RPN_OR);
519             else if (and_list)
520                 tmp = ccl_rpn_node_create(CCL_RPN_AND);
521             else
522                 tmp = ccl_rpn_node_create(CCL_RPN_AND);
523             tmp->u.p[0] = p_top;
524             tmp->u.p[1] = p;
525
526             p_top = tmp;
527         }
528         else
529             p_top = p;
530
531
532         if (left_trunc && right_trunc)
533         {
534             if (!qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_BOTH,
535                                 &attset))
536             {
537                 cclp->error_code = CCL_ERR_TRUNC_NOT_BOTH;
538                 ccl_rpn_delete(p);
539                 return NULL;
540             }
541             ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 3);
542         }
543         else if (right_trunc)
544         {
545             if (!qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_RIGHT,
546                                  &attset))
547             {
548                 cclp->error_code = CCL_ERR_TRUNC_NOT_RIGHT;
549                 ccl_rpn_delete(p);
550                 return NULL;
551             }
552             ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 1);
553         }
554         else if (left_trunc)
555         {
556             if (!qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_LEFT,
557                                 &attset))
558             {
559                 cclp->error_code = CCL_ERR_TRUNC_NOT_LEFT;
560                 ccl_rpn_delete(p);
561                 return NULL;
562             }
563             ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 2);
564         }
565         else if (regex_trunc == 2)
566         {
567             ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 102);
568         }
569         else if (z3958_trunc == 2)
570         {
571             ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 104);
572         }
573         else
574         {
575             if (qual_val_type(qa, CCL_BIB1_TRU, CCL_BIB1_TRU_CAN_NONE,
576                                &attset))
577                 ccl_add_attr_numeric(p, attset, CCL_BIB1_TRU, 100);
578         }
579         if (!multi)
580             break;
581     }
582     if (!p_top)
583         cclp->error_code = CCL_ERR_TERM_EXPECTED;
584     return p_top;
585 }
586
587 static struct ccl_rpn_node *search_term(CCL_parser cclp, ccl_qualifier_t *qa)
588 {
589     static int list[] = {CCL_TOK_TERM, CCL_TOK_COMMA, -1};
590     return search_term_x(cclp, qa, list, 0);
591 }
592
593
594 static struct ccl_rpn_node *search_terms2(CCL_parser cclp,
595                                           ccl_qualifier_t *qa)
596 {
597     if (KIND == CCL_TOK_LP)
598     {
599         struct ccl_rpn_node *p;
600         ADVANCE;
601         if (!(p = find_spec(cclp, qa)))
602             return NULL;
603         if (KIND != CCL_TOK_RP)
604         {
605             cclp->error_code = CCL_ERR_RP_EXPECTED;
606             ccl_rpn_delete(p);
607             return NULL;
608         }
609         ADVANCE;
610         return p;
611     }
612     else
613     {
614         static int list[] = {
615             CCL_TOK_TERM, CCL_TOK_COMMA,CCL_TOK_EQ,
616             CCL_TOK_REL, CCL_TOK_SET, -1};
617         
618         return search_term_x(cclp, qa, list, 1);
619     }
620 }
621
622
623
624 static
625 struct ccl_rpn_node *qualifiers_order(CCL_parser cclp,
626                                       ccl_qualifier_t *ap, char *attset)
627 {
628     int rel = 0;
629     struct ccl_rpn_node *p;
630
631     if (cclp->look_token->len == 1)
632     {
633         if (cclp->look_token->name[0] == '<')
634             rel = 1;
635         else if (cclp->look_token->name[0] == '=')
636             rel = 3;
637         else if (cclp->look_token->name[0] == '>')
638             rel = 5;
639     }
640     else if (cclp->look_token->len == 2)
641     {
642         if (!memcmp(cclp->look_token->name, "<=", 2))
643             rel = 2;
644         else if (!memcmp(cclp->look_token->name, ">=", 2))
645             rel = 4;
646         else if (!memcmp(cclp->look_token->name, "<>", 2))
647             rel = 6;
648     }
649     if (!rel)
650     {
651         cclp->error_code = CCL_ERR_BAD_RELATION;
652         return NULL;
653     }
654     ADVANCE;  /* skip relation */
655     if (rel == 3 &&
656         qual_val_type(ap, CCL_BIB1_REL, CCL_BIB1_REL_PORDER, 0))
657     {
658         /* allow - inside term and treat it as range _always_ */
659         /* relation is =. Extract "embedded" - to separate terms */
660         if (KIND == CCL_TOK_TERM)
661         {
662             size_t i;
663             for (i = 0; i<cclp->look_token->len; i++)
664             {
665                 if (cclp->look_token->name[i] == '-')
666                     break;
667             }
668             
669             if (cclp->look_token->len > 1 && i == 0)
670             {   /*  -xx*/
671                 struct ccl_token *ntoken = ccl_token_add(cclp->look_token);
672
673                 ntoken->kind = CCL_TOK_TERM;
674                 ntoken->name = cclp->look_token->name + 1;
675                 ntoken->len = cclp->look_token->len - 1;
676
677                 cclp->look_token->len = 1;
678                 cclp->look_token->name = "-";
679             }
680             else if (cclp->look_token->len > 1 && i == cclp->look_token->len-1)
681             {   /* xx- */
682                 struct ccl_token *ntoken = ccl_token_add(cclp->look_token);
683
684                 ntoken->kind = CCL_TOK_TERM;
685                 ntoken->name = "-";
686                 ntoken->len = 1;
687
688                 (cclp->look_token->len)--;
689             }
690             else if (cclp->look_token->len > 2 && i < cclp->look_token->len)
691             {   /* xx-yy */
692                 struct ccl_token *ntoken1 = ccl_token_add(cclp->look_token);
693                 struct ccl_token *ntoken2 = ccl_token_add(ntoken1);
694
695                 ntoken1->kind = CCL_TOK_TERM;  /* generate - */
696                 ntoken1->name = "-";
697                 ntoken1->len = 1;
698
699                 ntoken2->kind = CCL_TOK_TERM;  /* generate yy */
700                 ntoken2->name = cclp->look_token->name + (i+1);
701                 ntoken2->len = cclp->look_token->len - (i+1);
702
703                 cclp->look_token->len = i;     /* adjust xx */
704             }
705             else if (i == cclp->look_token->len &&
706                      cclp->look_token->next &&
707                      cclp->look_token->next->kind == CCL_TOK_TERM &&
708                      cclp->look_token->next->len > 1 &&
709                      cclp->look_token->next->name[0] == '-')
710                      
711             {   /* xx -yy */
712                 /* we _know_ that xx does not have - in it */
713                 struct ccl_token *ntoken = ccl_token_add(cclp->look_token);
714
715                 ntoken->kind = CCL_TOK_TERM;    /* generate - */
716                 ntoken->name = "-";
717                 ntoken->len = 1;
718
719                 (ntoken->next->name)++;        /* adjust yy */
720                 (ntoken->next->len)--; 
721             }
722         }
723     }
724         
725     if (rel == 3 &&
726         KIND == CCL_TOK_TERM &&
727         cclp->look_token->next && cclp->look_token->next->len == 1 &&
728         cclp->look_token->next->name[0] == '-')
729     {
730         struct ccl_rpn_node *p1;
731         if (!(p1 = search_term(cclp, ap)))
732             return NULL;
733         ADVANCE;                   /* skip '-' */
734         if (KIND == CCL_TOK_TERM)  /* = term - term  ? */
735         {
736             struct ccl_rpn_node *p2;
737             
738             if (!(p2 = search_term(cclp, ap)))
739             {
740                 ccl_rpn_delete(p1);
741                 return NULL;
742             }
743             p = ccl_rpn_node_create(CCL_RPN_AND);
744             p->u.p[0] = p1;
745             ccl_add_attr_numeric(p1, attset, CCL_BIB1_REL, 4);
746             p->u.p[1] = p2;
747             ccl_add_attr_numeric(p2, attset, CCL_BIB1_REL, 2);
748             return p;
749         }
750         else                       /* = term -    */
751         {
752             ccl_add_attr_numeric(p1, attset, CCL_BIB1_REL, 4);
753             return p1;
754         }
755     }
756     else if (rel == 3 &&
757              cclp->look_token->len == 1 &&
758              cclp->look_token->name[0] == '-')   /* = - term  ? */
759     {
760         ADVANCE;
761         if (!(p = search_term(cclp, ap)))
762             return NULL;
763         ccl_add_attr_numeric(p, attset, CCL_BIB1_REL, 2);
764         return p;
765     }
766     else
767     {
768         if (!(p = search_terms(cclp, ap)))
769             return NULL;
770         ccl_add_attr_numeric(p, attset, CCL_BIB1_REL, rel);
771         return p;
772     }
773     cclp->error_code = CCL_ERR_TERM_EXPECTED;
774     return NULL;
775 }
776
777 static
778 struct ccl_rpn_node *qualifier_relation(CCL_parser cclp, ccl_qualifier_t *ap)
779 {
780     char *attset;
781     
782     if (qual_val_type(ap, CCL_BIB1_REL, CCL_BIB1_REL_ORDER, &attset)
783         || qual_val_type(ap, CCL_BIB1_REL, CCL_BIB1_REL_PORDER, &attset))
784         return qualifiers_order(cclp, ap, attset);
785
786     /* unordered relation */
787     if (KIND != CCL_TOK_EQ)
788     {
789         cclp->error_code = CCL_ERR_EQ_EXPECTED;
790         return NULL;
791     }
792     ADVANCE;
793     return search_terms(cclp, ap);
794 }
795
796 /**
797  * qualifier_list: Parse CCL qualifiers and search terms. 
798  * cclp:   CCL Parser
799  * la:     Token pointer to RELATION token.
800  * qa:     Qualifier attributes already applied.
801  * return: pointer to node(s); NULL on error.
802  */
803 static struct ccl_rpn_node *qualifier_list(CCL_parser cclp, 
804                                            struct ccl_token *la,
805                                            ccl_qualifier_t *qa)
806 {
807     struct ccl_token *lookahead = cclp->look_token;
808     struct ccl_token *look_start = cclp->look_token;
809     ccl_qualifier_t *ap;
810     struct ccl_rpn_node *node = 0;
811     const char **field_str;
812     int no = 0;
813     int seq = 0;
814     int i;
815     int mode_merge = 1;
816 #if 0
817     if (qa)
818     {
819         cclp->error_code = CCL_ERR_DOUBLE_QUAL;
820         return NULL;
821     }
822 #endif
823     for (lookahead = cclp->look_token; lookahead != la;
824          lookahead=lookahead->next)
825         no++;
826     if (qa)
827         for (i=0; qa[i]; i++)
828             no++;
829     ap = (ccl_qualifier_t *)xmalloc((no ? (no+1) : 2) * sizeof(*ap));
830     ccl_assert(ap);
831
832     field_str = ccl_qual_search_special(cclp->bibset, "field");
833     if (field_str)
834     {
835         if (!strcmp(field_str[0], "or"))
836             mode_merge = 0;
837         else if (!strcmp(field_str[0], "merge"))
838             mode_merge = 1;
839     }
840     if (!mode_merge)
841     {
842         /* consider each field separately and OR */
843         lookahead = look_start;
844         while (lookahead != la)
845         {
846             ap[1] = 0;
847             seq = 0;
848             while ((ap[0] = ccl_qual_search(cclp, lookahead->name,
849                                             lookahead->len, seq)) != 0)
850             {
851                 struct ccl_rpn_node *node_sub;
852                 cclp->look_token = la;
853                 
854                 node_sub = qualifier_relation(cclp, ap);
855                 if (!node_sub)
856                 {
857                     ccl_rpn_delete(node);
858                     xfree(ap);
859                     return 0;
860                 }
861                 if (node)
862                 {
863                     struct ccl_rpn_node *node_this = 
864                         ccl_rpn_node_create(CCL_RPN_OR);
865                     node_this->u.p[0] = node;
866                     node_this->u.p[1] = node_sub;
867                     node = node_this;
868                 }
869                 else
870                     node = node_sub;
871                 seq++;
872             }
873             if (seq == 0)
874             {
875                 cclp->look_token = lookahead;
876                 cclp->error_code = CCL_ERR_UNKNOWN_QUAL;
877                 xfree(ap);
878                 return NULL;
879             }
880             lookahead = lookahead->next;
881             if (lookahead->kind == CCL_TOK_COMMA)
882                 lookahead = lookahead->next;
883         }
884     }
885     else
886     {
887         /* merge attributes from ALL fields - including inherited ones */
888         while (1)
889         {
890             struct ccl_rpn_node *node_sub;
891             int found = 0;
892             lookahead = look_start;
893             for (i = 0; lookahead != la; i++)
894             {
895                 ap[i] = ccl_qual_search(cclp, lookahead->name,
896                                          lookahead->len, seq);
897                 if (ap[i])
898                     found++;
899                 if (!ap[i] && seq > 0)
900                     ap[i] = ccl_qual_search(cclp, lookahead->name,
901                                              lookahead->len, 0);
902                 if (!ap[i])
903                 {
904                     cclp->look_token = lookahead;
905                     cclp->error_code = CCL_ERR_UNKNOWN_QUAL;
906                     xfree(ap);
907                     return NULL;
908                 }
909                 lookahead = lookahead->next;
910                 if (lookahead->kind == CCL_TOK_COMMA)
911                     lookahead = lookahead->next;
912             }
913             if (qa)
914             {
915                 ccl_qualifier_t *qa0 = qa;
916                 
917                 while (*qa0)
918                     ap[i++] = *qa0++;
919             }
920             ap[i] = NULL;
921             
922             if (!found)
923                 break;
924             
925             cclp->look_token = lookahead;
926             
927             node_sub = qualifier_relation(cclp, ap);
928             if (!node_sub)
929             {
930                 ccl_rpn_delete(node);
931                 break;
932             }
933             if (node)
934             {
935                 struct ccl_rpn_node *node_this = 
936                     ccl_rpn_node_create(CCL_RPN_OR);
937                 node_this->u.p[0] = node;
938                 node_this->u.p[1] = node_sub;
939                 node = node_this;
940             }
941             else
942                 node = node_sub;
943             seq++;
944         }
945     }
946     xfree(ap);
947     return node;
948 }
949
950
951 /**
952  * search_terms: Parse CCL search terms - including proximity.
953  * cclp:   CCL Parser
954  * qa:     Qualifier attributes already applied.
955  * return: pointer to node(s); NULL on error.
956  */
957 static struct ccl_rpn_node *search_terms(CCL_parser cclp, ccl_qualifier_t *qa)
958 {
959     static int list[] = {
960         CCL_TOK_TERM, CCL_TOK_COMMA,CCL_TOK_EQ,
961         CCL_TOK_REL, CCL_TOK_SET, -1};
962     struct ccl_rpn_node *p1, *p2, *pn;
963     p1 = search_terms2(cclp, qa);
964     if (!p1)
965         return NULL;
966     while (1)
967     {
968         if (KIND == CCL_TOK_PROX)
969         {
970             struct ccl_rpn_node *p_prox = 0;
971             /* ! word order specified */
972             /* % word order not specified */
973             p_prox = ccl_rpn_node_create(CCL_RPN_TERM);
974             p_prox->u.t.term = (char *) xmalloc(1 + cclp->look_token->len);
975             memcpy(p_prox->u.t.term, cclp->look_token->name,
976                    cclp->look_token->len);
977             p_prox->u.t.term[cclp->look_token->len] = 0;
978             p_prox->u.t.attr_list = 0;
979
980             ADVANCE;
981             p2 = search_terms2(cclp, qa);
982             if (!p2)
983             {
984                 ccl_rpn_delete(p1);
985                 return NULL;
986             }
987             pn = ccl_rpn_node_create(CCL_RPN_PROX);
988             pn->u.p[0] = p1;
989             pn->u.p[1] = p2;
990             pn->u.p[2] = p_prox;
991             p1 = pn;
992         }
993         else if (is_term_ok(KIND, list))
994         {
995             p2 = search_terms2(cclp, qa);
996             if (!p2)
997             {
998                 ccl_rpn_delete(p1);
999                 return NULL;
1000             }
1001             pn = ccl_rpn_node_create(CCL_RPN_PROX);
1002             pn->u.p[0] = p1;
1003             pn->u.p[1] = p2;
1004             pn->u.p[2] = 0;
1005             p1 = pn;
1006         }
1007         else
1008             break;
1009     }
1010     return p1;
1011 }
1012
1013 /**
1014  * search_elements: Parse CCL search elements
1015  * cclp:   CCL Parser
1016  * qa:     Qualifier attributes already applied.
1017  * return: pointer to node(s); NULL on error.
1018  */
1019 static struct ccl_rpn_node *search_elements(CCL_parser cclp,
1020                                             ccl_qualifier_t *qa)
1021 {
1022     struct ccl_rpn_node *p1;
1023     struct ccl_token *lookahead;
1024     if (KIND == CCL_TOK_SET)
1025     {
1026         ADVANCE;
1027         if (KIND == CCL_TOK_EQ)
1028             ADVANCE;
1029         if (KIND != CCL_TOK_TERM)
1030         {
1031             cclp->error_code = CCL_ERR_SETNAME_EXPECTED;
1032             return NULL;
1033         }
1034         p1 = ccl_rpn_node_create(CCL_RPN_SET);
1035         p1->u.setname = copy_token_name(cclp->look_token);
1036         ADVANCE;
1037         return p1;
1038     }
1039     lookahead = cclp->look_token;
1040
1041     while (lookahead->kind==CCL_TOK_TERM)
1042     {
1043         lookahead = lookahead->next;
1044         if (lookahead->kind == CCL_TOK_REL || lookahead->kind == CCL_TOK_EQ)
1045             return qualifier_list(cclp, lookahead, qa);
1046         if (lookahead->kind != CCL_TOK_COMMA)
1047             break;
1048         lookahead = lookahead->next;
1049     }
1050     if (qa || lookahead->kind == CCL_TOK_LP)
1051         return search_terms(cclp, qa);
1052     else
1053     {
1054         ccl_qualifier_t qa[2];
1055         struct ccl_rpn_node *node = 0;
1056         int seq;
1057         lookahead = cclp->look_token;
1058
1059         qa[1] = 0;
1060         for(seq = 0; ;seq++)
1061         {
1062             struct ccl_rpn_node *node_sub;
1063             qa[0] = ccl_qual_search(cclp, "term", 4, seq);
1064             if (!qa[0])
1065                 break;
1066
1067             cclp->look_token = lookahead;
1068
1069             node_sub = search_terms(cclp, qa);
1070             if (!node_sub)
1071             {
1072                 ccl_rpn_delete(node);
1073                 return 0;
1074             }
1075             if (node)
1076             {
1077                 struct ccl_rpn_node *node_this = 
1078                     ccl_rpn_node_create(CCL_RPN_OR);
1079                 node_this->u.p[0] = node;
1080                 node_this->u.p[1] = node_sub;
1081                 node_this->u.p[2] = 0;
1082                 node = node_this;
1083             }
1084             else
1085                 node = node_sub;
1086         }
1087         if (!node)
1088             node = search_terms(cclp, 0);
1089         return node;
1090     }
1091 }
1092
1093 /**
1094  * find_spec: Parse CCL find specification
1095  * cclp:   CCL Parser
1096  * qa:     Qualifier attributes already applied.
1097  * return: pointer to node(s); NULL on error.
1098  */
1099 static struct ccl_rpn_node *find_spec(CCL_parser cclp, ccl_qualifier_t *qa)
1100 {
1101     struct ccl_rpn_node *p1, *p2, *pn;
1102     if (!(p1 = search_elements(cclp, qa)))
1103         return NULL;
1104     while (1)
1105     {
1106         switch (KIND)
1107         {
1108         case CCL_TOK_AND:
1109             ADVANCE;
1110             p2 = search_elements(cclp, qa);
1111             if (!p2)
1112             {
1113                 ccl_rpn_delete(p1);
1114                 return NULL;
1115             }
1116             pn = ccl_rpn_node_create(CCL_RPN_AND);
1117             pn->u.p[0] = p1;
1118             pn->u.p[1] = p2;
1119             pn->u.p[2] = 0;
1120             p1 = pn;
1121             continue;
1122         case CCL_TOK_OR:
1123             ADVANCE;
1124             p2 = search_elements(cclp, qa);
1125             if (!p2)
1126             {
1127                 ccl_rpn_delete(p1);
1128                 return NULL;
1129             }
1130             pn = ccl_rpn_node_create(CCL_RPN_OR);
1131             pn->u.p[0] = p1;
1132             pn->u.p[1] = p2;
1133             pn->u.p[2] = 0;
1134             p1 = pn;
1135             continue;
1136         case CCL_TOK_NOT:
1137             ADVANCE;
1138             p2 = search_elements(cclp, qa);
1139             if (!p2)
1140             {
1141                 ccl_rpn_delete(p1);
1142                 return NULL;
1143             }
1144             pn = ccl_rpn_node_create(CCL_RPN_NOT);
1145             pn->u.p[0] = p1;
1146             pn->u.p[1] = p2;
1147             pn->u.p[2] = 0;
1148             p1 = pn;
1149             continue;
1150         }
1151         break;
1152     }
1153     return p1;
1154 }
1155
1156 struct ccl_rpn_node *ccl_parser_find_str(CCL_parser cclp, const char *str)
1157 {
1158     struct ccl_rpn_node *p;
1159     struct ccl_token *list = ccl_parser_tokenize(cclp, str);
1160     p = ccl_parser_find_token(cclp, list);
1161     ccl_token_del(list);
1162     return p;
1163 }
1164
1165 struct ccl_rpn_node *ccl_parser_find_token(CCL_parser cclp, 
1166                                            struct ccl_token *list)
1167 {
1168     struct ccl_rpn_node *p;
1169
1170     cclp->look_token = list;
1171     p = find_spec(cclp, NULL);
1172     if (p && KIND != CCL_TOK_EOL)
1173     {
1174         if (KIND == CCL_TOK_RP)
1175             cclp->error_code = CCL_ERR_BAD_RP;
1176         else
1177             cclp->error_code = CCL_ERR_OP_EXPECTED;
1178         ccl_rpn_delete(p);
1179         p = NULL;
1180     }
1181     cclp->error_pos = cclp->look_token->name;
1182     if (p)
1183         cclp->error_code = CCL_ERR_OK;
1184     else
1185         cclp->error_code = cclp->error_code;
1186     return p;
1187 }
1188
1189 /**
1190  * ccl_find_str: Parse CCL find - string representation
1191  * bibset:  Bibset to be used for the parsing
1192  * str:     String to be parsed
1193  * error:   Pointer to integer. Holds error no. on completion.
1194  * pos:     Pointer to char position. Holds approximate error position.
1195  * return:  RPN tree on successful completion; NULL otherwise.
1196  */
1197 struct ccl_rpn_node *ccl_find_str(CCL_bibset bibset, const char *str,
1198                                   int *error, int *pos)
1199 {
1200     CCL_parser cclp = ccl_parser_create(bibset);
1201     struct ccl_token *list;
1202     struct ccl_rpn_node *p;
1203
1204     list = ccl_parser_tokenize(cclp, str);
1205     p = ccl_parser_find_token(cclp, list);
1206
1207     *error = cclp->error_code;
1208     if (*error)
1209         *pos = cclp->error_pos - str;
1210     ccl_parser_destroy(cclp);
1211     ccl_token_del(list);
1212     return p;
1213 }
1214
1215 /*
1216  * Local variables:
1217  * c-basic-offset: 4
1218  * c-file-style: "Stroustrup"
1219  * indent-tabs-mode: nil
1220  * End:
1221  * vim: shiftwidth=4 tabstop=8 expandtab
1222  */
1223