include/yaz/cql.h

   1 /* $Id: cql.h,v 1.8 2004-10-02 13:41:14 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 struct cql_node {
  86     int which;
  87     union {
  88         struct {
  89             char *index;
  90             char *index_uri;
  91             char *term;
  92             char *relation;
  93             char *relation_uri;
  94             struct cql_node *modifiers;
  95         } st;
  96         struct {
  97             char *value;
  98             struct cql_node *left;
  99             struct cql_node *right;
 100             struct cql_node *modifiers;
 101         } boolean;
 102     } u;
 103 };
 104
 105 struct cql_properties;
 106
 107 struct cql_buf_write_info {
 108     int max;
 109     int off;
 110     char *buf;
 111 };
 112
 113 YAZ_EXPORT
 114 void cql_buf_write_handler (const char *b, void *client_data);
 115
 116 YAZ_EXPORT
 117 void cql_node_print(struct cql_node *cn);
 118 YAZ_EXPORT
 119 struct cql_node *cql_node_mk_sc(const char *index,
 120                                 const char *relation,
 121                                 const char *term);
 122
 123
 124 YAZ_EXPORT
 125 struct cql_node *cql_apply_prefix(struct cql_node *cn,
 126                                   const char *relation,
 127                                   const char *term);
 128 YAZ_EXPORT
 129 struct cql_node *cql_node_mk_boolean(const char *op);
 130 YAZ_EXPORT
 131 void cql_node_destroy(struct cql_node *cn);
 132 YAZ_EXPORT
 133 struct cql_node *cql_node_dup (struct cql_node *cp);
 134 YAZ_EXPORT
 135 struct cql_node *cql_parser_result(CQL_parser cp);
 136
 137 YAZ_EXPORT
 138 void cql_to_xml(struct cql_node *cn,
 139                 void (*pr)(const char *buf, void *client_data),
 140                 void *client_data);
 141 YAZ_EXPORT
 142 void cql_to_xml_stdio(struct cql_node *cn, FILE *f);
 143 YAZ_EXPORT
 144 int cql_to_xml_buf(struct cql_node *cn, char *out, int max);
 145
 146 YAZ_EXPORT
 147 struct cql_node *cql_node_mk_proxargs(const char *relation,
 148                                       const char *distance,
 149                                       const char *unit,
 150                                       const char *ordering);
 151
 152
 153 YAZ_EXPORT
 154 void cql_fputs(const char *buf, void *client_data);
 155
 156 typedef struct cql_transform_t_ *cql_transform_t;
 157
 158 YAZ_EXPORT
 159 cql_transform_t cql_transform_open_FILE (FILE *f);
 160 YAZ_EXPORT
 161 cql_transform_t cql_transform_open_fname(const char *fname);
 162 YAZ_EXPORT
 163 void cql_transform_close(cql_transform_t ct);
 164
 165 YAZ_EXPORT
 166 void cql_transform_pr(cql_transform_t ct,
 167                       struct cql_node *cn,
 168                       void (*pr)(const char *buf, void *client_data),
 169                       void *client_data);
 170
 171 YAZ_EXPORT
 172 int cql_transform_FILE(cql_transform_t ct,
 173                        struct cql_node *cn, FILE *f);
 174
 175 YAZ_EXPORT
 176 int cql_transform_buf(cql_transform_t ct,
 177                       struct cql_node *cn, char *out, int max);
 178 YAZ_EXPORT
 179 int cql_transform_error(cql_transform_t ct, const char **addinfo);
 180
 181 YAZ_EXPORT
 182 const char *cql_strerror(int code);
 183
 184 YAZ_EXPORT
 185 const char *cql_uri();
 186
 187 YAZ_END_CDECL
 188
 189 #endif
 190 /* CQL_H_INCLUDED */