include/yaz/pquery.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2008 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27 /* $Id: pquery.h,v 1.11 2007-04-12 13:52:57 adam Exp $ */
  28
  29 /**
  30  * \file pquery.h
  31  * \brief Header for PQF parsing
  32  */
  33
  34 #ifndef PQUERY_H
  35 #define PQUERY_H
  36
  37 #include <yaz/yconfig.h>
  38 #include <yaz/proto.h>
  39
  40 YAZ_BEGIN_CDECL
  41
  42 typedef struct yaz_pqf_parser *YAZ_PQF_Parser;
  43
  44 YAZ_EXPORT Z_RPNQuery *p_query_rpn(ODR o, const char *qbuf);
  45
  46 YAZ_EXPORT Z_AttributesPlusTerm *p_query_scan(ODR o, oid_proto proto,
  47                                               Odr_oid **attributeSetP, const char *qbuf);
  48 YAZ_EXPORT YAZ_PQF_Parser yaz_pqf_create(void);
  49 YAZ_EXPORT Z_RPNQuery *yaz_pqf_parse(YAZ_PQF_Parser p, ODR o,
  50                                      const char *qbuf);
  51 YAZ_EXPORT Z_AttributesPlusTerm *yaz_pqf_scan(YAZ_PQF_Parser p, ODR o,
  52                                               Odr_oid **attributeSetId,
  53                                               const char *qbuf);
  54 YAZ_EXPORT void yaz_pqf_destroy(YAZ_PQF_Parser p);
  55
  56 YAZ_EXPORT int yaz_pqf_error(YAZ_PQF_Parser p, const char **msg, size_t *off);
  57
  58
  59 /* no error */
  60 #define YAZ_PQF_ERROR_NONE     0
  61
  62 /* extra token (end of query expected) */
  63 #define YAZ_PQF_ERROR_EXTRA    1
  64
  65 /* missing token (at least one token expected) */
  66 #define YAZ_PQF_ERROR_MISSING  2
  67
  68 /* bad attribute set (for @attr and @attrset) */
  69 #define YAZ_PQF_ERROR_ATTSET   3
  70
  71 /* too many items (limit reached - too many attributes, etc) */
  72 #define YAZ_PQF_ERROR_TOOMANY  4
  73
  74 /* bad format of attribute (missing =) */
  75 #define YAZ_PQF_ERROR_BADATTR  5
  76
  77 /* internal failure */
  78 #define YAZ_PQF_ERROR_INTERNAL 6
  79
  80 /* bad proximity args */
  81 #define YAZ_PQF_ERROR_PROXIMITY 7
  82
  83 /* bad unsigned integer */
  84 #define YAZ_PQF_ERROR_BAD_INTEGER 8
  85
  86 YAZ_END_CDECL
  87
  88 #endif
  89 /*
  90  * Local variables:
  91  * c-basic-offset: 4
  92  * indent-tabs-mode: nil
  93  * End:
  94  * vim: shiftwidth=4 tabstop=8 expandtab
  95  */
  96