src/cclfind.c

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