src/cql.y

   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 /* bison parser for CQL grammar. */
   6 %{
   7 /**
   8  * \file cql.c
   9  * \brief Implements CQL parser.
  10  *
  11  * This is a YACC parser, but since it must be reentrant, Bison is required.
  12  * The original source file is cql.y.
  13  */
  14 #if HAVE_CONFIG_H
  15 #include <config.h>
  16 #endif
  17 #include <stdio.h>
  18 #include <stdlib.h>
  19 #include <string.h>
  20 #include <yaz/yaz-iconv.h>
  21 #include <yaz/xmalloc.h>
  22 #include <yaz/nmem.h>
  23 #include <yaz/cql.h>
  24
  25     /** Node in the LALR parse tree. */
  26     typedef struct {
  27         /** Inhereted attribute: relation */
  28         struct cql_node *rel;
  29         /** Synthesized attribute: CQL node */
  30         struct cql_node *cql;
  31         /** string buffer with token */
  32         char *buf;
  33         /** length of token */
  34         size_t len;
  35         /** size of buffer (len <= size) */
  36         size_t size;
  37     } token;
  38
  39     struct cql_parser {
  40         int (*getbyte)(void *client_data);
  41         void (*ungetbyte)(int b, void *client_data);
  42         void *client_data;
  43         int last_error;
  44         int last_pos;
  45         struct cql_node *top;
  46         NMEM nmem;
  47     };
  48
  49 #define YYSTYPE token
  50
  51 #define YYPARSE_PARAM parm
  52 #define YYLEX_PARAM parm
  53
  54     int yylex(YYSTYPE *lval, void *vp);
  55     int yyerror(char *s);
  56 %}
  57
  58 %pure_parser
  59 %token PREFIX_NAME SIMPLE_STRING AND OR NOT PROX GE LE NE EXACT SORTBY
  60
  61 %%
  62
  63 top: {
  64     $$.rel = cql_node_mk_sc(((CQL_parser) parm)->nmem,
  65                             "cql.serverChoice", "=", 0);
  66     ((CQL_parser) parm)->top = 0;
  67 } cqlQuery1 sortby {
  68     cql_node_destroy($$.rel);
  69     if ($3.cql)
  70     {
  71         $3.cql->u.sort.search = $2.cql;
  72         ((CQL_parser) parm)->top = $3.cql;
  73     } else {
  74         ((CQL_parser) parm)->top = $2.cql;
  75     }
  76 }
  77 ;
  78
  79 sortby: /* empty */
  80   { $$.cql = 0; }
  81 | SORTBY sortSpec {
  82     $$.cql = $2.cql;
  83  };
  84
  85 sortSpec: sortSpec singleSpec {
  86     $$.cql = $1.cql;
  87     $$.cql->u.sort.next = $2.cql;
  88  }
  89 | singleSpec
  90 {
  91     $$.cql = $1.cql;
  92 };
  93
  94 singleSpec: index modifiers {
  95     $$.cql = cql_node_mk_sort(((CQL_parser) parm)->nmem, $1.buf, $2.cql);
  96  }
  97 ;
  98
  99 cqlQuery1: cqlQuery
 100 | cqlQuery error {
 101     cql_node_destroy($1.cql);
 102     $$.cql = 0;
 103 }
 104 ;
 105
 106 cqlQuery:
 107   scopedClause
 108  |
 109   '>' searchTerm '=' searchTerm {
 110     $$.rel = $0.rel;
 111   } cqlQuery {
 112     $$.cql = cql_apply_prefix(((CQL_parser) parm)->nmem,
 113                               $6.cql, $2.buf, $4.buf);
 114   }
 115 | '>' searchTerm {
 116       $$.rel = $0.rel;
 117   } cqlQuery {
 118     $$.cql = cql_apply_prefix(((CQL_parser) parm)->nmem,
 119                               $4.cql, 0, $2.buf);
 120    }
 121 ;
 122
 123 scopedClause:
 124   searchClause
 125 |
 126   scopedClause boolean modifiers {
 127       $$.rel = $0.rel;
 128   } searchClause {
 129       struct cql_node *cn = cql_node_mk_boolean(((CQL_parser) parm)->nmem,
 130                                                 $2.buf);
 131
 132       cn->u.boolean.modifiers = $3.cql;
 133       cn->u.boolean.left = $1.cql;
 134       cn->u.boolean.right = $5.cql;
 135
 136       $$.cql = cn;
 137   }
 138 ;
 139
 140 searchClause:
 141   '(' {
 142       $$.rel = $0.rel;
 143
 144   } cqlQuery ')' {
 145       $$.cql = $3.cql;
 146   }
 147 |
 148 searchTerm extraTerms {
 149       struct cql_node *st = cql_node_dup(((CQL_parser) parm)->nmem, $0.rel);
 150       st->u.st.extra_terms = $2.cql;
 151       st->u.st.term = nmem_strdup(((CQL_parser)parm)->nmem, $1.buf);
 152       $$.cql = st;
 153   }
 154 |
 155   index relation modifiers {
 156       $$.rel = cql_node_mk_sc(((CQL_parser) parm)->nmem, $1.buf, $2.buf, 0);
 157       $$.rel->u.st.modifiers = $3.cql;
 158   } searchClause {
 159       $$.cql = $5.cql;
 160       cql_node_destroy($4.rel);
 161   }
 162 ;
 163
 164 extraTerms:
 165 SIMPLE_STRING extraTerms {
 166     struct cql_node *st = cql_node_mk_sc(((CQL_parser) parm)->nmem,
 167                                          /* index */ 0, /* rel */ 0, $1.buf);
 168     st->u.st.extra_terms = $2.cql;
 169     $$.cql = st;
 170 }
 171 |
 172 { $$.cql = 0; }
 173 ;
 174
 175
 176 /* unary NOT search SIMPLE_STRING here .. */
 177
 178 boolean:
 179   AND | OR | NOT | PROX ;
 180
 181 modifiers: modifiers '/' searchTerm
 182 {
 183     struct cql_node *mod = cql_node_mk_sc(((CQL_parser)parm)->nmem,
 184                                           $3.buf, 0, 0);
 185
 186     mod->u.st.modifiers = $1.cql;
 187     $$.cql = mod;
 188 }
 189 |
 190 modifiers '/' searchTerm relation_symbol searchTerm
 191 {
 192     struct cql_node *mod = cql_node_mk_sc(((CQL_parser)parm)->nmem,
 193                                           $3.buf, $4.buf, $5.buf);
 194
 195     mod->u.st.modifiers = $1.cql;
 196     $$.cql = mod;
 197 }
 198 |
 199 {
 200     $$.cql = 0;
 201 }
 202 ;
 203
 204 relation: PREFIX_NAME | relation_symbol;
 205
 206 relation_symbol:
 207   '='
 208 | '>'
 209 | '<'
 210 | GE
 211 | LE
 212 | NE
 213 | EXACT
 214 ;
 215
 216 index:
 217   searchTerm;
 218
 219 searchTerm:
 220   SIMPLE_STRING
 221 | PREFIX_NAME
 222 | AND
 223 | OR
 224 | NOT
 225 | PROX
 226 | SORTBY
 227 ;
 228
 229 %%
 230
 231 int yyerror(char *s)
 232 {
 233     return 0;
 234 }
 235
 236 /**
 237  * putb is a utility that puts one character to the string
 238  * in current lexical token. This routine deallocates as
 239  * necessary using NMEM.
 240  */
 241
 242 static void putb(YYSTYPE *lval, CQL_parser cp, int c)
 243 {
 244     if (lval->len+1 >= lval->size)
 245     {
 246         char *nb = (char *)
 247             nmem_malloc(cp->nmem, (lval->size = lval->len * 2 + 20));
 248         memcpy(nb, lval->buf, lval->len);
 249         lval->buf = nb;
 250     }
 251     if (c)
 252         lval->buf[lval->len++] = c;
 253     lval->buf[lval->len] = '\0';
 254 }
 255
 256
 257 /**
 258  * yylex returns next token for Bison to be read. In this
 259  * case one of the CQL terminals are returned.
 260  */
 261 int yylex(YYSTYPE *lval, void *vp)
 262 {
 263     CQL_parser cp = (CQL_parser) vp;
 264     int c;
 265     lval->cql = 0;
 266     lval->rel = 0;
 267     lval->len = 0;
 268     lval->size = 10;
 269     lval->buf = (char *) nmem_malloc(cp->nmem, lval->size);
 270     lval->buf[0] = '\0';
 271     do
 272     {
 273         c = cp->getbyte(cp->client_data);
 274         if (c == 0)
 275             return 0;
 276         if (c == '\n')
 277             return 0;
 278     } while (yaz_isspace(c));
 279     if (strchr("()=></", c))
 280     {
 281         int c1;
 282         putb(lval, cp, c);
 283         if (c == '=')
 284         {
 285             c1 = cp->getbyte(cp->client_data);
 286             if (c1 == '=')
 287             {
 288                 putb(lval, cp, c1);
 289                 return EXACT;
 290             }
 291             else
 292                 cp->ungetbyte(c1, cp->client_data);
 293         }
 294         else if (c == '>')
 295         {
 296             c1 = cp->getbyte(cp->client_data);
 297             if (c1 == '=')
 298             {
 299                 putb(lval, cp, c1);
 300                 return GE;
 301             }
 302             else
 303                 cp->ungetbyte(c1, cp->client_data);
 304         }
 305         else if (c == '<')
 306         {
 307             c1 = cp->getbyte(cp->client_data);
 308             if (c1 == '=')
 309             {
 310                 putb(lval, cp, c1);
 311                 return LE;
 312             }
 313             else if (c1 == '>')
 314             {
 315                 putb(lval, cp, c1);
 316                 return NE;
 317             }
 318             else
 319                 cp->ungetbyte(c1, cp->client_data);
 320         }
 321         return c;
 322     }
 323     if (c == '"')
 324     {
 325         while ((c = cp->getbyte(cp->client_data)) != 0 && c != '"')
 326         {
 327             if (c == '\\')
 328             {
 329                 putb(lval, cp, c);
 330                 c = cp->getbyte(cp->client_data);
 331                 if (!c)
 332                     break;
 333             }
 334             putb(lval, cp, c);
 335         }
 336         putb(lval, cp, 0);
 337         return SIMPLE_STRING;
 338     }
 339     else
 340     {
 341         int relation_like = 0;
 342         while (c != 0 && !strchr(" \n()=<>/", c))
 343         {
 344             if (c == '.')
 345                 relation_like = 1;
 346             if (c == '\\')
 347             {
 348                 putb(lval, cp, c);
 349                 c = cp->getbyte(cp->client_data);
 350                 if (!c)
 351                     break;
 352             }
 353             putb(lval, cp, c);
 354             c = cp->getbyte(cp->client_data);
 355         }
 356         putb(lval, cp, 0);
 357 #if YYDEBUG
 358         printf ("got %s\n", lval->buf);
 359 #endif
 360         if (c != 0)
 361             cp->ungetbyte(c, cp->client_data);
 362         if (!cql_strcmp(lval->buf, "and"))
 363         {
 364             lval->buf = "and";
 365             return AND;
 366         }
 367         if (!cql_strcmp(lval->buf, "or"))
 368         {
 369             lval->buf = "or";
 370             return OR;
 371         }
 372         if (!cql_strcmp(lval->buf, "not"))
 373         {
 374             lval->buf = "not";
 375             return NOT;
 376         }
 377         if (!cql_strcmp(lval->buf, "prox"))
 378         {
 379             lval->buf = "prox";
 380             return PROX;
 381         }
 382         if (!cql_strcmp(lval->buf, "sortby"))
 383         {
 384             lval->buf = "sortby";
 385             return SORTBY;
 386         }
 387         if (!cql_strcmp(lval->buf, "all"))
 388             relation_like = 1;
 389         if (!cql_strcmp(lval->buf, "any"))
 390             relation_like = 1;
 391         if (!cql_strcmp(lval->buf, "adj"))
 392             relation_like = 1;
 393         if (relation_like)
 394             return PREFIX_NAME;
 395     }
 396     return SIMPLE_STRING;
 397 }
 398
 399
 400 int cql_parser_stream(CQL_parser cp,
 401                       int (*getbyte)(void *client_data),
 402                       void (*ungetbyte)(int b, void *client_data),
 403                       void *client_data)
 404 {
 405     nmem_reset(cp->nmem);
 406     cp->getbyte = getbyte;
 407     cp->ungetbyte = ungetbyte;
 408     cp->client_data = client_data;
 409     cql_node_destroy(cp->top);
 410     cql_parse(cp);
 411     if (cp->top)
 412         return 0;
 413     return -1;
 414 }
 415
 416 CQL_parser cql_parser_create(void)
 417 {
 418     CQL_parser cp = (CQL_parser) xmalloc(sizeof(*cp));
 419
 420     cp->top = 0;
 421     cp->getbyte = 0;
 422     cp->ungetbyte = 0;
 423     cp->client_data = 0;
 424     cp->last_error = 0;
 425     cp->last_pos = 0;
 426     cp->nmem = nmem_create();
 427     return cp;
 428 }
 429
 430 void cql_parser_destroy(CQL_parser cp)
 431 {
 432     cql_node_destroy(cp->top);
 433     nmem_destroy(cp->nmem);
 434     xfree (cp);
 435 }
 436
 437 struct cql_node *cql_parser_result(CQL_parser cp)
 438 {
 439     return cp->top;
 440 }
 441
 442 /*
 443  * Local variables:
 444  * c-basic-offset: 4
 445  * c-file-style: "Stroustrup"
 446  * indent-tabs-mode: nil
 447  * End:
 448  * vim: shiftwidth=4 tabstop=8 expandtab
 449  */