Expanded tabs in all source files. Added vim/emacs local variables
[yaz-moved-to-github.git] / include / yaz / pquery.h
1 /*
2  * Copyright (C) 1995-2005, Index Data ApS
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and
5  * its documentation, in whole or in part, for any purpose, is hereby granted,
6  * provided that:
7  *
8  * 1. This copyright and permission notice appear in all copies of the
9  * software and its documentation. Notices of copyright or attribution
10  * which appear at the beginning of any file must remain unchanged.
11  *
12  * 2. The name of Index Data or the individual authors may not be used to
13  * endorse or promote products derived from this software without specific
14  * prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24  * OF THIS SOFTWARE.
25  *
26  * $Id: pquery.h,v 1.7 2005-06-25 15:46:03 adam Exp $
27  */
28 /**
29  * \file pquery.h
30  * \brief Header for PQF parsing
31  */
32
33 #ifndef PQUERY_H
34 #define PQUERY_H
35
36 #include <yaz/yconfig.h>
37 #include <yaz/proto.h>
38
39 YAZ_BEGIN_CDECL
40
41 typedef struct yaz_pqf_parser *YAZ_PQF_Parser;
42
43 YAZ_EXPORT Z_RPNQuery *p_query_rpn (ODR o, oid_proto proto, const char *qbuf);
44
45 YAZ_EXPORT Z_AttributesPlusTerm *p_query_scan (ODR o, oid_proto proto,
46            Odr_oid **attributeSetP, const char *qbuf);
47 YAZ_EXPORT int p_query_attset (const char *arg);
48
49 YAZ_EXPORT YAZ_PQF_Parser yaz_pqf_create (void);
50 YAZ_EXPORT Z_RPNQuery *yaz_pqf_parse (YAZ_PQF_Parser p, ODR o,
51                                       const char *qbuf);
52 YAZ_EXPORT Z_AttributesPlusTerm *yaz_pqf_scan (YAZ_PQF_Parser p, ODR o,
53                                                Odr_oid **attributeSetId,
54                                                const char *qbuf);
55 YAZ_EXPORT void yaz_pqf_destroy (YAZ_PQF_Parser p);
56
57 YAZ_EXPORT int yaz_pqf_error (YAZ_PQF_Parser p, const char **msg, size_t *off);
58
59
60 /* no error */
61 #define YAZ_PQF_ERROR_NONE     0
62
63 /* extra token (end of query expected) */
64 #define YAZ_PQF_ERROR_EXTRA    1
65
66 /* missing token (at least one token expected) */
67 #define YAZ_PQF_ERROR_MISSING  2
68
69 /* bad attribute set (for @attr and @attrset) */
70 #define YAZ_PQF_ERROR_ATTSET   3
71
72 /* too many items (limit reached - too many attributes, etc) */
73 #define YAZ_PQF_ERROR_TOOMANY  4
74
75 /* bad format of attribute (missing =) */
76 #define YAZ_PQF_ERROR_BADATTR  5
77
78 /* internal failure */
79 #define YAZ_PQF_ERROR_INTERNAL 6
80
81 YAZ_END_CDECL
82
83 #endif
84 /*
85  * Local variables:
86  * c-basic-offset: 4
87  * indent-tabs-mode: nil
88  * End:
89  * vim: shiftwidth=4 tabstop=8 expandtab
90  */
91