Spell fix
[yaz-moved-to-github.git] / include / yaz / cql.h
1 /* $Id: cql.h,v 1.7 2004-03-15 21:39:06 adam Exp $
2    Copyright (C) 2002-2004
3    Index Data Aps
4
5 This file is part of the YAZ toolkit.
6
7 See the file LICENSE.
8 */
9
10 #ifndef CQL_H_INCLUDED
11 #define CQL_H_INCLUDED
12 #include <stdio.h>
13 #include <yaz/yconfig.h>
14
15 YAZ_BEGIN_CDECL
16
17 typedef struct cql_parser *CQL_parser;
18
19 /**
20  * cql_parser_create:
21  *
22  * creates a CQL parser.
23  *
24  * Returns CQL parser or NULL if parser could not be created.
25  */
26 YAZ_EXPORT 
27 CQL_parser cql_parser_create(void);
28
29 /**
30  * cql_parser_destroy:
31  * @cp:  A CQL parser
32  *
33  * Destroy CQL parser. This function does nothing if
34  * NULL pointer is received.
35  */
36 YAZ_EXPORT 
37 void cql_parser_destroy(CQL_parser cp);
38
39 /**
40  * cql_parser_string:
41  * @cp:  A CQL parser.
42  * @str:  A query string to be parsed.
43  *
44  * Parses a CQL query string.
45  *
46  * Returns 0 if parsing was succesful; non-zero (error code) if
47  * unsuccesful.
48  */
49 YAZ_EXPORT 
50 int cql_parser_string(CQL_parser cp, const char *str);
51
52 /**
53  * cql_parser_stream:
54  * @cp:  A CQL parser.
55  * @getbyte:  Handler to read one character (for parsing).
56  * @ungetbyte: Handler to unread one byte (for parsing).
57  * @client_data:  User data associated with getbyte/ungetbyte handlers.
58  *
59  * Parses a CQL query from a user defined stream.
60  *
61  * Returns 0 if parsing was succesful; non-zero (error code) if
62  * unsuccesful.
63  */
64 YAZ_EXPORT 
65 int cql_parser_stream(CQL_parser cp,
66                       int (*getbyte)(void *client_data),
67                       void (*ungetbyte)(int b, void *client_data),
68                       void *client_data);
69
70 /**
71  * cql_parser_stdio:
72  * @cp:  A CQL parser.
73  * @f: FILE handler in read mode.
74  *
75  * Parses a CQL query from a file.
76  *
77  * Returns 0 if parsing was succesful; non-zero (error code) if
78  * unsuccesful.
79  */
80 YAZ_EXPORT
81 int cql_parser_stdio(CQL_parser cp, FILE *f);
82
83 #define CQL_NODE_ST 1
84 #define CQL_NODE_BOOL 2
85 #define CQL_NODE_MOD 3
86 struct cql_node {
87     int which;
88     union {
89         struct {
90             char *index;
91             char *index_uri;
92             char *term;
93             char *relation;
94             char *relation_uri;
95             struct cql_node *modifiers;
96         } st;
97         struct {
98             char *value;
99             struct cql_node *left;
100             struct cql_node *right;
101             struct cql_node *modifiers;
102         } boolean;
103     } u;
104 };
105
106 struct cql_properties;
107
108 struct cql_buf_write_info {
109     int max;
110     int off;
111     char *buf;
112 };
113
114 YAZ_EXPORT
115 void cql_buf_write_handler (const char *b, void *client_data);
116
117 YAZ_EXPORT
118 void cql_node_print(struct cql_node *cn);
119 YAZ_EXPORT
120 struct cql_node *cql_node_mk_sc(const char *index,
121                                 const char *relation,
122                                 const char *term);
123
124
125 YAZ_EXPORT
126 struct cql_node *cql_apply_prefix(struct cql_node *cn,
127                                   const char *relation,
128                                   const char *term);
129 YAZ_EXPORT
130 struct cql_node *cql_node_mk_boolean(const char *op);
131 YAZ_EXPORT
132 void cql_node_destroy(struct cql_node *cn);
133 YAZ_EXPORT
134 struct cql_node *cql_node_dup (struct cql_node *cp);
135 YAZ_EXPORT
136 struct cql_node *cql_parser_result(CQL_parser cp);
137
138 YAZ_EXPORT
139 void cql_to_xml(struct cql_node *cn, 
140                 void (*pr)(const char *buf, void *client_data),
141                 void *client_data);
142 YAZ_EXPORT
143 void cql_to_xml_stdio(struct cql_node *cn, FILE *f);
144 YAZ_EXPORT
145 int cql_to_xml_buf(struct cql_node *cn, char *out, int max);
146
147 YAZ_EXPORT
148 struct cql_node *cql_node_mk_proxargs(const char *relation,
149                                       const char *distance,
150                                       const char *unit,
151                                       const char *ordering);
152
153
154 YAZ_EXPORT
155 void cql_fputs(const char *buf, void *client_data);
156
157 typedef struct cql_transform_t_ *cql_transform_t;
158
159 YAZ_EXPORT
160 cql_transform_t cql_transform_open_FILE (FILE *f);
161 YAZ_EXPORT
162 cql_transform_t cql_transform_open_fname(const char *fname);
163 YAZ_EXPORT
164 void cql_transform_close(cql_transform_t ct);
165
166 YAZ_EXPORT
167 void cql_transform_pr(cql_transform_t ct,
168                       struct cql_node *cn,
169                       void (*pr)(const char *buf, void *client_data),
170                       void *client_data);
171
172 YAZ_EXPORT
173 int cql_transform_FILE(cql_transform_t ct,
174                        struct cql_node *cn, FILE *f);
175
176 YAZ_EXPORT
177 int cql_transform_buf(cql_transform_t ct,
178                       struct cql_node *cn, char *out, int max);
179 YAZ_EXPORT
180 int cql_transform_error(cql_transform_t ct, const char **addinfo);
181
182 YAZ_EXPORT
183 const char *cql_strerror(int code);
184
185 YAZ_EXPORT
186 const char *cql_uri();
187
188 YAZ_END_CDECL
189
190 #endif
191 /* CQL_H_INCLUDED */