document parameter (Doxygen warning)
[yaz-moved-to-github.git] / src / pquery.c
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2013 Index Data
3  * See the file LICENSE for details.
4  */
5 /**
6  * \file pquery.c
7  * \brief Implements PQF parsing
8  */
9 #if HAVE_CONFIG_H
10 #include <config.h>
11 #endif
12
13 #include <stdio.h>
14 #include <string.h>
15 #include <stdlib.h>
16
17 #include <yaz/proto.h>
18 #include <yaz/oid_db.h>
19 #include <yaz/pquery.h>
20
21 struct yaz_pqf_parser {
22     const char *query_buf;
23     const char *query_ptr;
24     const char *lex_buf;
25     size_t lex_len;
26     int query_look;
27     char *left_sep;
28     char *right_sep;
29     int escape_char;
30     int term_type;
31     int external_type;
32     int error;
33 };
34
35 static Z_RPNStructure *rpn_structure(struct yaz_pqf_parser *li, ODR o,
36                                      int num_attr, int max_attr,
37                                      Odr_int *attr_list, char **attr_clist,
38                                      Odr_oid **attr_set);
39
40 static Odr_oid *query_oid_getvalbyname(struct yaz_pqf_parser *li, ODR o)
41 {
42     char buf[32];
43
44     if (li->lex_len >= sizeof(buf)-1)
45         return 0;
46     memcpy(buf, li->lex_buf, li->lex_len);
47     buf[li->lex_len] = '\0';
48     return yaz_string_to_oid_odr(yaz_oid_std(), CLASS_ATTSET, buf, o);
49 }
50
51 static int compare_term(struct yaz_pqf_parser *li, const char *src,
52                         size_t off)
53 {
54     size_t len=strlen(src);
55
56     if (li->lex_len == len+off && !memcmp(li->lex_buf+off, src, len-off))
57         return 1;
58     return 0;
59 }
60
61 static int query_token(struct yaz_pqf_parser *li)
62 {
63     int sep_char = ' ';
64     const char *sep_match;
65     const char **qptr = &li->query_ptr;
66
67     while (**qptr == ' ')
68         (*qptr)++;
69     if (**qptr == '\0')
70         return 0;
71     li->lex_len = 0;
72     if ((sep_match = strchr(li->left_sep, **qptr)))
73     {
74         sep_char = li->right_sep[sep_match - li->left_sep];
75         ++(*qptr);
76     }
77     li->lex_buf = *qptr;
78
79     if (**qptr == li->escape_char && yaz_isdigit((*qptr)[1]))
80     {
81         ++(li->lex_len);
82         ++(*qptr);
83         return 'l';
84     }
85     while (**qptr && **qptr != sep_char)
86     {
87         if (**qptr == '\\' && (*qptr)[1])
88         {
89             ++(li->lex_len);
90             ++(*qptr);
91         }
92         ++(li->lex_len);
93         ++(*qptr);
94     }
95     if (**qptr)
96         ++(*qptr);
97     if (sep_char == ' ' &&
98         li->lex_len >= 1 && li->lex_buf[0] == li->escape_char)
99     {
100         if (compare_term(li, "and", 1))
101             return 'a';
102         if (compare_term(li, "or", 1))
103             return 'o';
104         if (compare_term(li, "not", 1))
105             return 'n';
106         if (compare_term(li, "attr", 1))
107             return 'l';
108         if (compare_term(li, "set", 1))
109             return 's';
110         if (compare_term(li, "attrset", 1))
111             return 'r';
112         if (compare_term(li, "prox", 1))
113             return 'p';
114         if (compare_term(li, "term", 1))
115             return 'y';
116     }
117     return 't';
118 }
119
120 static int lex(struct yaz_pqf_parser *li)
121 {
122     return li->query_look = query_token(li);
123 }
124
125 static int escape_string(char *out_buf, const char *in, int len)
126 {
127
128     char *out = out_buf;
129     while (--len >= 0)
130         if (*in == '\\' && len > 0)
131         {
132             --len;
133             switch (*++in)
134             {
135             case 't':
136                 *out++ = '\t';
137                 break;
138             case 'n':
139                 *out++ = '\n';
140                 break;
141             case 'r':
142                 *out++ = '\r';
143                 break;
144             case 'f':
145                 *out++ = '\f';
146                 break;
147             case 'x':
148                 if (len > 1)
149                 {
150                     char s[4];
151                     int n = 0;
152                     s[0] = *++in;
153                     s[1] = *++in;
154                     s[2] = '\0';
155                     len = len - 2;
156                     sscanf(s, "%x", &n);
157                     *out++ = n;
158                 }
159                 break;
160             case '0':
161             case '1':
162             case '2':
163             case '3':
164                 if (len > 1)
165                 {
166                     char s[4];
167                     int n = 0;
168                     s[0] = *in;
169                     s[1] = *++in;
170                     s[2] = *++in;
171                     s[3] = '\0';
172                     len = len - 2;
173                     sscanf(s, "%o", &n);
174                     *out++ = n;
175                 }
176                 break;
177             default:
178                 *out++ = *in;
179                 break;
180             }
181             in++;
182         }
183         else
184             *out++ = *in++;
185     return out - out_buf;
186 }
187
188 static int p_query_parse_attr(struct yaz_pqf_parser *li, ODR o,
189                               int num_attr, Odr_int *attr_list,
190                               char **attr_clist, Odr_oid **attr_set)
191 {
192     const char *cp;
193     size_t i;
194
195     if (!(cp = strchr(li->lex_buf, '=')) ||
196         (size_t) (cp-li->lex_buf) > li->lex_len)
197     {
198         attr_set[num_attr] = query_oid_getvalbyname(li, o);
199         if (attr_set[num_attr] == 0)
200         {
201             li->error = YAZ_PQF_ERROR_ATTSET;
202             return 0;
203         }
204         if (!lex(li))
205         {
206             li->error = YAZ_PQF_ERROR_MISSING;
207             return 0;
208         }
209         if (!(cp = strchr(li->lex_buf, '=')))
210         {
211             li->error = YAZ_PQF_ERROR_BADATTR;
212             return 0;
213         }
214     }
215     else
216     {
217         if (num_attr > 0)
218             attr_set[num_attr] = attr_set[num_attr-1];
219         else
220             attr_set[num_attr] = 0;
221     }
222     if (*li->lex_buf < '0' || *li->lex_buf > '9')
223     {
224         li->error = YAZ_PQF_ERROR_BAD_INTEGER;
225         return 0;
226     }
227     attr_list[2*num_attr] = odr_atoi(li->lex_buf);
228     cp++;
229
230     /* inspect value .. and make it a integer if it appears to be */
231     for (i = cp - li->lex_buf; i < li->lex_len; i++)
232         if (li->lex_buf[i] < '0' || li->lex_buf[i] > '9')
233         {
234             int len = li->lex_len - (cp - li->lex_buf);
235             attr_list[2*num_attr+1] = 0;
236             attr_clist[num_attr] = (char *) odr_malloc(o, len+1);
237             len = escape_string(attr_clist[num_attr], cp, len);
238             attr_clist[num_attr][len] = '\0';
239             return 1;
240         }
241     attr_list[2*num_attr+1] = odr_atoi(cp);
242     attr_clist[num_attr] = 0;
243     return 1;
244 }
245
246 static Z_AttributeList *get_attributeList(ODR o,
247                                           int num_attr, Odr_int *attr_list,
248                                           char **attr_clist, Odr_oid **attr_set)
249 {
250     int i, k = 0;
251     Odr_int *attr_tmp;
252     Z_AttributeElement **elements;
253     Z_AttributeList *attributes= (Z_AttributeList *)
254         odr_malloc(o, sizeof(*attributes));
255     attributes->num_attributes = num_attr;
256     if (!num_attr)
257     {
258         attributes->attributes = (Z_AttributeElement**)odr_nullval();
259         return attributes;
260     }
261     elements = (Z_AttributeElement**)
262         odr_malloc(o, num_attr * sizeof(*elements));
263
264     attr_tmp = (Odr_int *)odr_malloc(o, num_attr * 2 * sizeof(*attr_tmp));
265     memcpy(attr_tmp, attr_list, num_attr * 2 * sizeof(*attr_tmp));
266     for (i = num_attr; --i >= 0; )
267     {
268         int j;
269         for (j = i+1; j<num_attr; j++)
270             if (attr_tmp[2*j] == attr_tmp[2*i])
271                 break;
272         if (j < num_attr)
273             continue;
274         elements[k] =
275             (Z_AttributeElement*)odr_malloc(o,sizeof(**elements));
276         elements[k]->attributeType = &attr_tmp[2*i];
277         elements[k]->attributeSet = attr_set[i];
278
279         if (attr_clist[i])
280         {
281             elements[k]->which = Z_AttributeValue_complex;
282             elements[k]->value.complex = (Z_ComplexAttribute *)
283                 odr_malloc(o, sizeof(Z_ComplexAttribute));
284             elements[k]->value.complex->num_list = 1;
285             elements[k]->value.complex->list =
286                 (Z_StringOrNumeric **)
287                 odr_malloc(o, 1 * sizeof(Z_StringOrNumeric *));
288             elements[k]->value.complex->list[0] =
289                 (Z_StringOrNumeric *)
290                 odr_malloc(o, sizeof(Z_StringOrNumeric));
291             elements[k]->value.complex->list[0]->which =
292                 Z_StringOrNumeric_string;
293             elements[k]->value.complex->list[0]->u.string =
294                 attr_clist[i];
295             elements[k]->value.complex->semanticAction = 0;
296             elements[k]->value.complex->num_semanticAction = 0;
297         }
298         else
299         {
300             elements[k]->which = Z_AttributeValue_numeric;
301             elements[k]->value.numeric = &attr_tmp[2*i+1];
302         }
303         k++;
304     }
305     attributes->num_attributes = k;
306     attributes->attributes = elements;
307     return attributes;
308 }
309
310 Z_Term *z_Term_create(ODR o, int term_type, const char *buf, size_t len)
311 {
312     Z_Term *term = (Z_Term *)odr_malloc(o, sizeof(*term));
313     Odr_oct *term_octet = (Odr_oct *)odr_malloc(o, sizeof(*term_octet));
314     term_octet->buf = (unsigned char *)odr_malloc(o, 1 + len);
315     memcpy(term_octet->buf, buf, len);
316     term_octet->size = term_octet->len = len;
317     term_octet->buf[term_octet->size] = 0;  /* null terminate */
318
319     switch (term_type)
320     {
321     case Z_Term_general:
322         term->which = Z_Term_general;
323         term->u.general = term_octet;
324         break;
325     case Z_Term_characterString:
326         term->which = Z_Term_characterString;
327         term->u.characterString = (char*) term_octet->buf;
328         /* null terminated above */
329         break;
330     case Z_Term_numeric:
331         term->which = Z_Term_numeric;
332         term->u.numeric = odr_intdup(o, odr_atoi((const char*) term_octet->buf));
333         break;
334     case Z_Term_null:
335         term->which = Z_Term_null;
336         term->u.null = odr_nullval();
337         break;
338     case Z_Term_external:
339         term->which = Z_Term_external;
340         term->u.external = 0;
341         break;
342     default:
343         term->which = Z_Term_null;
344         term->u.null = odr_nullval();
345         break;
346     }
347     return term;
348 }
349
350 static Z_AttributesPlusTerm *rpn_term_attributes(
351     struct yaz_pqf_parser *li, ODR o, Z_AttributeList *attributes)
352 {
353     char *es_str = odr_malloc(o, li->lex_len+1);
354     int es_len = escape_string(es_str, li->lex_buf, li->lex_len);
355     Z_Term *term = z_Term_create(o, li->term_type, es_str, es_len);
356     Z_AttributesPlusTerm *zapt = (Z_AttributesPlusTerm *)
357         odr_malloc(o, sizeof(*zapt));
358
359     zapt->term = term;
360     zapt->attributes = attributes;
361     return zapt;
362 }
363
364 static Z_AttributesPlusTerm *rpn_term(struct yaz_pqf_parser *li, ODR o,
365                                       int num_attr, Odr_int *attr_list,
366                                       char **attr_clist, Odr_oid **attr_set)
367 {
368     return rpn_term_attributes(li, o, get_attributeList(o, num_attr, attr_list, attr_clist, attr_set));
369 }
370
371 static Z_Operand *rpn_simple(struct yaz_pqf_parser *li, ODR o,
372                              int num_attr, Odr_int *attr_list,
373                              char **attr_clist,
374                              Odr_oid **attr_set)
375 {
376     Z_Operand *zo;
377
378     zo = (Z_Operand *)odr_malloc(o, sizeof(*zo));
379     switch (li->query_look)
380     {
381     case 't':
382         zo->which = Z_Operand_APT;
383         if (!(zo->u.attributesPlusTerm =
384               rpn_term(li, o, num_attr, attr_list, attr_clist, attr_set)))
385             return 0;
386         lex(li);
387         break;
388     case 's':
389         lex(li);
390         if (!li->query_look)
391         {
392             li->error = YAZ_PQF_ERROR_MISSING;
393             return 0;
394         }
395         zo->which = Z_Operand_resultSetId;
396         zo->u.resultSetId = (char *)odr_malloc(o, li->lex_len+1);
397         memcpy(zo->u.resultSetId, li->lex_buf, li->lex_len);
398         zo->u.resultSetId[li->lex_len] = '\0';
399         lex(li);
400         break;
401     default:
402         /* we're only called if one of the above types are seens so
403            this shouldn't happen */
404         li->error = YAZ_PQF_ERROR_INTERNAL;
405         return 0;
406     }
407     return zo;
408 }
409
410 static Z_ProximityOperator *rpn_proximity(struct yaz_pqf_parser *li, ODR o)
411 {
412     Z_ProximityOperator *p = (Z_ProximityOperator *)odr_malloc(o, sizeof(*p));
413
414     if (!lex(li))
415     {
416         li->error = YAZ_PQF_ERROR_MISSING;
417         return NULL;
418     }
419     if (*li->lex_buf == '1')
420         p->exclusion = odr_booldup(o, 1);
421     else if (*li->lex_buf == '0')
422         p->exclusion = odr_booldup(o, 0);
423     else if (*li->lex_buf == 'v' || *li->lex_buf == 'n')
424         p->exclusion = NULL;
425     else
426     {
427         li->error = YAZ_PQF_ERROR_PROXIMITY;
428         return NULL;
429     }
430
431     if (!lex(li))
432     {
433         li->error = YAZ_PQF_ERROR_MISSING;
434         return NULL;
435     }
436     if (*li->lex_buf >= '0' && *li->lex_buf <= '9')
437         p->distance = odr_intdup(o, odr_atoi(li->lex_buf));
438     else
439     {
440         li->error = YAZ_PQF_ERROR_BAD_INTEGER;
441         return NULL;
442     }
443
444     if (!lex(li))
445     {
446         li->error = YAZ_PQF_ERROR_MISSING;
447         return NULL;
448     }
449     if (*li->lex_buf == '1')
450         p->ordered = odr_booldup(o, 1);
451     else if (*li->lex_buf == '0')
452         p->ordered = odr_booldup(o, 0);
453     else
454     {
455         li->error = YAZ_PQF_ERROR_PROXIMITY;
456         return NULL;
457     }
458
459     if (!lex (li))
460     {
461         li->error = YAZ_PQF_ERROR_MISSING;
462         return NULL;
463     }
464     if (*li->lex_buf >= '0' && *li->lex_buf <= '9')
465         p->relationType = odr_intdup(o, odr_atoi(li->lex_buf));
466     else
467     {
468         li->error = YAZ_PQF_ERROR_BAD_INTEGER;
469         return NULL;
470     }
471
472     if (!lex(li))
473     {
474         li->error = YAZ_PQF_ERROR_MISSING;
475         return NULL;
476     }
477     if (*li->lex_buf == 'k')
478         p->which = Z_ProximityOperator_known;
479     else if (*li->lex_buf == 'p')
480         p->which = Z_ProximityOperator_private;
481     else
482         p->which = atoi(li->lex_buf);
483
484     if (p->which != Z_ProximityOperator_known
485         && p->which != Z_ProximityOperator_private)
486     {
487         li->error = YAZ_PQF_ERROR_PROXIMITY;
488         return NULL;
489     }
490
491     if (!lex(li))
492     {
493         li->error = YAZ_PQF_ERROR_MISSING;
494         return NULL;
495     }
496     if (*li->lex_buf >= '0' && *li->lex_buf <= '9')
497         p->u.known = odr_intdup(o, odr_atoi(li->lex_buf));
498     else
499     {
500         li->error = YAZ_PQF_ERROR_BAD_INTEGER;
501         return NULL;
502     }
503     return p;
504 }
505
506 static Z_Complex *rpn_complex(struct yaz_pqf_parser *li, ODR o,
507                               int num_attr, int max_attr,
508                               Odr_int *attr_list, char **attr_clist,
509                               Odr_oid **attr_set)
510 {
511     Z_Complex *zc;
512     Z_Operator *zo;
513
514     zc = (Z_Complex *)odr_malloc(o, sizeof(*zc));
515     zo = (Z_Operator *)odr_malloc(o, sizeof(*zo));
516     zc->roperator = zo;
517     switch (li->query_look)
518     {
519     case 'a':
520         zo->which = Z_Operator_and;
521         zo->u.op_and = odr_nullval();
522         break;
523     case 'o':
524         zo->which = Z_Operator_or;
525         zo->u.op_or = odr_nullval();
526         break;
527     case 'n':
528         zo->which = Z_Operator_and_not;
529         zo->u.and_not = odr_nullval();
530         break;
531     case 'p':
532         zo->which = Z_Operator_prox;
533         zo->u.prox = rpn_proximity(li, o);
534         if (!zo->u.prox)
535             return NULL;
536         break;
537     default:
538         /* we're only called if one of the above types are seens so
539            this shouldn't happen */
540         li->error = YAZ_PQF_ERROR_INTERNAL;
541         return NULL;
542     }
543     lex(li);
544     if (!(zc->s1 =
545           rpn_structure(li, o, num_attr, max_attr, attr_list,
546                         attr_clist, attr_set)))
547         return NULL;
548     if (!(zc->s2 =
549           rpn_structure(li, o, num_attr, max_attr, attr_list,
550                         attr_clist, attr_set)))
551         return NULL;
552     return zc;
553 }
554
555 static void rpn_term_type(struct yaz_pqf_parser *li)
556 {
557     if (!li->query_look)
558         return ;
559     if (compare_term(li, "general", 0))
560         li->term_type = Z_Term_general;
561     else if (compare_term(li, "numeric", 0))
562         li->term_type = Z_Term_numeric;
563     else if (compare_term(li, "string", 0))
564         li->term_type = Z_Term_characterString;
565     else if (compare_term(li, "oid", 0))
566         li->term_type = Z_Term_oid;
567     else if (compare_term(li, "datetime", 0))
568         li->term_type = Z_Term_dateTime;
569     else if (compare_term(li, "null", 0))
570         li->term_type = Z_Term_null;
571 #if 0
572     else if (compare_term(li, "range", 0))
573     {
574         /* prepare for external: range search .. */
575         li->term_type = Z_Term_external;
576         li->external_type = VAL_MULTISRCH2;
577     }
578 #endif
579     lex(li);
580 }
581
582 static Z_RPNStructure *rpn_structure(struct yaz_pqf_parser *li, ODR o,
583                                      int num_attr, int max_attr,
584                                      Odr_int *attr_list,
585                                      char **attr_clist,
586                                      Odr_oid **attr_set)
587 {
588     Z_RPNStructure *sz;
589
590     sz = (Z_RPNStructure *)odr_malloc(o, sizeof(*sz));
591     switch (li->query_look)
592     {
593     case 'a':
594     case 'o':
595     case 'n':
596     case 'p':
597         sz->which = Z_RPNStructure_complex;
598         if (!(sz->u.complex =
599               rpn_complex(li, o, num_attr, max_attr, attr_list,
600                           attr_clist, attr_set)))
601             return NULL;
602         break;
603     case 't':
604     case 's':
605         sz->which = Z_RPNStructure_simple;
606         if (!(sz->u.simple =
607               rpn_simple(li, o, num_attr, attr_list,
608                          attr_clist, attr_set)))
609             return NULL;
610         break;
611     case 'l':
612         lex(li);
613         if (!li->query_look)
614         {
615             li->error = YAZ_PQF_ERROR_MISSING;
616             return 0;
617         }
618         if (num_attr >= max_attr)
619         {
620             li->error = YAZ_PQF_ERROR_TOOMANY;
621             return 0;
622         }
623         if (!p_query_parse_attr(li, o, num_attr, attr_list,
624                                 attr_clist, attr_set))
625             return 0;
626         num_attr++;
627         lex(li);
628         return
629             rpn_structure(li, o, num_attr, max_attr, attr_list,
630                           attr_clist,  attr_set);
631     case 'y':
632         lex(li);
633         rpn_term_type(li);
634         return
635             rpn_structure(li, o, num_attr, max_attr, attr_list,
636                           attr_clist, attr_set);
637     case 0:                /* operator/operand expected! */
638         li->error = YAZ_PQF_ERROR_MISSING;
639         return 0;
640     }
641     return sz;
642 }
643
644 static Z_RPNQuery *p_query_rpn_mk(ODR o, struct yaz_pqf_parser *li)
645 {
646     Z_RPNQuery *zq;
647     Odr_int attr_array[1024];
648     char *attr_clist[512];
649     Odr_oid *attr_set[512];
650     Odr_oid *top_set = 0;
651
652     zq = (Z_RPNQuery *)odr_malloc(o, sizeof(*zq));
653     lex(li);
654     if (li->query_look == 'r')
655     {
656         lex(li);
657         top_set = query_oid_getvalbyname(li, o);
658         if (!top_set)
659         {
660             li->error = YAZ_PQF_ERROR_ATTSET;
661             return NULL;
662         }
663         lex(li);
664     }
665     if (!top_set)
666     {
667         top_set = odr_oiddup(o, yaz_oid_attset_bib_1);
668     }
669
670     zq->attributeSetId = top_set;
671
672     if (!zq->attributeSetId)
673     {
674         li->error = YAZ_PQF_ERROR_ATTSET;
675         return 0;
676     }
677
678     if (!(zq->RPNStructure = rpn_structure(li, o, 0, 512,
679                                            attr_array, attr_clist, attr_set)))
680         return 0;
681     if (li->query_look)
682     {
683         li->error = YAZ_PQF_ERROR_EXTRA;
684         return 0;
685     }
686     return zq;
687 }
688
689 static void pqf_parser_begin(struct yaz_pqf_parser *li, const char *buf)
690 {
691     li->query_buf = li->query_ptr = buf;
692     li->lex_buf = 0;
693 }
694
695 Z_RPNQuery *p_query_rpn(ODR o, const char *qbuf)
696 {
697     struct yaz_pqf_parser li;
698
699     li.error = 0;
700     li.left_sep = "{\"";
701     li.right_sep = "}\"";
702     li.escape_char = '@';
703     li.term_type = Z_Term_general;
704
705     pqf_parser_begin(&li, qbuf);
706     return p_query_rpn_mk(o, &li);
707 }
708
709 static Z_AttributeList *p_query_scan_attributes_mk(struct yaz_pqf_parser *li,
710                                              ODR o,
711                                              Odr_oid **attributeSetP)
712 {
713     Odr_int attr_list[1024];
714     char *attr_clist[512];
715     Odr_oid *attr_set[512];
716     int num_attr = 0;
717     int max_attr = 512;
718     Odr_oid *top_set = 0;
719
720     lex(li);
721     if (li->query_look == 'r')
722     {
723         lex(li);
724         top_set = query_oid_getvalbyname(li, o);
725         if (!top_set)
726         {
727             li->error = YAZ_PQF_ERROR_ATTSET;
728             return NULL;
729         }
730         lex(li);
731     }
732     if (!top_set)
733     {
734         top_set = odr_oiddup(o, yaz_oid_attset_bib_1);
735     }
736     *attributeSetP = top_set;
737
738     while (1)
739     {
740         if (li->query_look == 'l')
741         {
742             lex(li);
743             if (!li->query_look)
744             {
745                 li->error = YAZ_PQF_ERROR_MISSING;
746                 return 0;
747             }
748             if (num_attr >= max_attr)
749             {
750                 li->error = YAZ_PQF_ERROR_TOOMANY;
751                 return 0;
752             }
753             if (!p_query_parse_attr(li, o, num_attr, attr_list,
754                                     attr_clist, attr_set))
755                 return 0;
756             num_attr++;
757             lex(li);
758         }
759         else if (li->query_look == 'y')
760         {
761             lex(li);
762             rpn_term_type(li);
763         }
764         else
765             break;
766     }
767     return get_attributeList(o, num_attr, attr_list, attr_clist, attr_set);
768 }
769
770 static Z_AttributesPlusTerm *p_query_scan_mk(struct yaz_pqf_parser *li,
771                                              ODR o,
772                                              Odr_oid **attributeSetP)
773 {
774     Z_AttributeList *attr_list = p_query_scan_attributes_mk(li, o, attributeSetP);
775     Z_AttributesPlusTerm *apt;
776
777     if (!li->query_look)
778     {
779         li->error = YAZ_PQF_ERROR_MISSING;
780         return 0;
781     }
782     apt = rpn_term_attributes(li, o, attr_list);
783
784     lex(li);
785
786     if (li->query_look != 0)
787     {
788         li->error = YAZ_PQF_ERROR_EXTRA;
789         return 0;
790     }
791     return apt;
792 }
793
794 YAZ_PQF_Parser yaz_pqf_create(void)
795 {
796     YAZ_PQF_Parser p = (YAZ_PQF_Parser) xmalloc(sizeof(*p));
797
798     p->error = 0;
799     p->left_sep = "{\"";
800     p->right_sep = "}\"";
801     p->escape_char = '@';
802     p->term_type = Z_Term_general;
803
804     return p;
805 }
806
807 void yaz_pqf_destroy(YAZ_PQF_Parser p)
808 {
809     xfree(p);
810 }
811
812 Z_RPNQuery *yaz_pqf_parse(YAZ_PQF_Parser p, ODR o, const char *qbuf)
813 {
814     if (!p)
815         return 0;
816     pqf_parser_begin(p, qbuf);
817     return p_query_rpn_mk(o, p);
818 }
819
820 Z_AttributesPlusTerm *yaz_pqf_scan(YAZ_PQF_Parser p, ODR o,
821                                    Odr_oid **attributeSetP,
822                                    const char *qbuf)
823 {
824     if (!p)
825         return 0;
826     pqf_parser_begin(p, qbuf);
827     return p_query_scan_mk(p, o, attributeSetP);
828 }
829
830 Z_AttributeList *yaz_pqf_scan_attribute_list(YAZ_PQF_Parser p, ODR o,
831                                              Odr_oid **attributeSetP,
832                                              const char *qbuf)
833 {
834     if (!p)
835         return 0;
836     pqf_parser_begin(p, qbuf);
837     return p_query_scan_attributes_mk(p, o, attributeSetP);
838 }
839
840 static Z_FacetField* parse_facet(ODR odr, const char *facet)
841 {
842     YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
843     struct yaz_pqf_parser *li = pqf_parser;
844     Odr_oid *attributeSetId;
845     Z_FacetField *facet_field = 0;
846     Z_AttributeList *attribute_list;
847
848     pqf_parser_begin(pqf_parser, facet);
849     attribute_list = p_query_scan_attributes_mk(li, odr, &attributeSetId);
850     if (attribute_list)
851     {
852         facet_field = (Z_FacetField *) odr_malloc(odr, sizeof(*facet_field));
853         facet_field->attributes = attribute_list;
854         facet_field->num_terms = 0;
855         facet_field->terms = odr_malloc(odr, 10 * sizeof(*facet_field->terms));
856         while (li->query_look == 't')
857         {
858             if (facet_field->num_terms < 10)
859             {
860                 char *es_str = odr_malloc(odr, li->lex_len+1);
861                 int es_len = escape_string(es_str, li->lex_buf, li->lex_len);
862                 Z_Term *term = z_Term_create(odr, li->term_type, es_str, es_len);
863
864                 facet_field->terms[facet_field->num_terms] =
865                     (Z_FacetTerm *) odr_malloc(odr, sizeof(Z_FacetTerm));
866                 facet_field->terms[facet_field->num_terms]->term = term;
867                 facet_field->terms[facet_field->num_terms]->count =
868                     odr_intdup(odr, 0);
869                 facet_field->num_terms++;
870             }
871             lex(li);
872         }
873     }
874     yaz_pqf_destroy(pqf_parser);
875     return facet_field;
876 }
877
878 Z_FacetList *yaz_pqf_parse_facet_list(ODR o, const char *qbuf)
879 {
880     char **darray;
881     int num;
882
883     nmem_strsplit(odr_getmem(o), ",", qbuf, &darray, &num);
884     if (num > 0)
885     {
886         int i;
887         Z_FacetList *fl = (Z_FacetList*) odr_malloc(o, sizeof(*fl));
888         fl->num = num;
889         fl->elements = (Z_FacetField **)
890             odr_malloc(o, num * sizeof(*fl->elements));
891         for (i = 0; i < num; i++)
892         {
893             fl->elements[i] = parse_facet(o, darray[i]);
894             if (!fl->elements[i])
895                 return 0;
896         }
897         return fl;
898     }
899     else
900         return 0;
901 }
902
903 int yaz_pqf_error(YAZ_PQF_Parser p, const char **msg, size_t *off)
904 {
905     switch (p->error)
906     {
907     case YAZ_PQF_ERROR_NONE:
908         *msg = "no error"; break;
909     case YAZ_PQF_ERROR_EXTRA:
910         *msg = "extra token"; break;
911     case YAZ_PQF_ERROR_MISSING:
912         *msg = "missing token"; break;
913     case YAZ_PQF_ERROR_ATTSET:
914         *msg = "unknown attribute set"; break;
915     case YAZ_PQF_ERROR_TOOMANY:
916         *msg = "too many attributes"; break;
917     case YAZ_PQF_ERROR_BADATTR:
918         *msg = "bad attribute specification"; break;
919     case YAZ_PQF_ERROR_INTERNAL:
920         *msg = "internal error"; break;
921     case YAZ_PQF_ERROR_PROXIMITY:
922         *msg = "proximity error"; break;
923     case YAZ_PQF_ERROR_BAD_INTEGER:
924         *msg = "bad integer"; break;
925     default:
926         *msg = "unknown error"; break;
927     }
928     *off = p->query_ptr - p->query_buf;
929     return p->error;
930 }
931 /*
932  * Local variables:
933  * c-basic-offset: 4
934  * c-file-style: "Stroustrup"
935  * indent-tabs-mode: nil
936  * End:
937  * vim: shiftwidth=4 tabstop=8 expandtab
938  */
939