cql.h

Go to the documentation of this file.

/* This file is part of the YAZ toolkit.
 * Copyright (C) 1995-2013 Index Data.
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Index Data nor the names of its contributors
 *       may be used to endorse or promote products derived from this
 *       software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef CQL_H_INCLUDED
#define CQL_H_INCLUDED
#include <stdio.h>
#include <yaz/nmem.h>

YAZ_BEGIN_CDECL

typedef struct cql_parser *CQL_parser;

YAZ_EXPORT
CQL_parser cql_parser_create(void);

YAZ_EXPORT
void cql_parser_destroy(CQL_parser cp);

YAZ_EXPORT
int cql_parser_string(CQL_parser cp, const char *str);

YAZ_EXPORT
int cql_parser_stream(CQL_parser cp,
                      int (*getbyte)(void *client_data),
                      void (*ungetbyte)(int b, void *client_data),
                      void *client_data);

YAZ_EXPORT
int cql_parser_stdio(CQL_parser cp, FILE *f);

YAZ_EXPORT
void cql_parser_strict(CQL_parser cp, int mode);

#define CQL_NODE_ST 1

#define CQL_NODE_BOOL 2

#define CQL_NODE_SORT 3

struct cql_node {
    int which;
    union {
        struct {
            char *index;
            char *index_uri;
            char *term;
            char *relation;
            char *relation_uri;
            struct cql_node *modifiers;
            struct cql_node *extra_terms;
        } st;
        struct {
            char *value;
            struct cql_node *left;
            struct cql_node *right;
            struct cql_node *modifiers;
        } boolean;
        struct {
            char *index;
            struct cql_node *next;
            struct cql_node *modifiers;
            struct cql_node *search;
        } sort;
    } u;
};

struct cql_properties;

struct cql_buf_write_info {
    int max;
    int off;
    char *buf;
};

YAZ_EXPORT
void cql_buf_write_handler(const char *b, void *client_data);

YAZ_EXPORT
void cql_node_print(struct cql_node *cn);

YAZ_EXPORT
struct cql_node *cql_node_mk_sc(NMEM nmem, const char *index,
                                const char *relation, const char *term);

YAZ_EXPORT
struct cql_node *cql_apply_prefix(NMEM nmem, struct cql_node *cn,
                                  const char *prefix, const char *uri);

YAZ_EXPORT
struct cql_node *cql_node_mk_boolean(NMEM nmem, const char *op);

YAZ_EXPORT
struct cql_node *cql_node_mk_sort(NMEM nmem, const char *index,
    struct cql_node *modifiers);

YAZ_EXPORT
void cql_node_destroy(struct cql_node *cn);

YAZ_EXPORT
struct cql_node *cql_node_dup (NMEM nmem, struct cql_node *cp);

YAZ_EXPORT
struct cql_node *cql_parser_result(CQL_parser cp);

YAZ_EXPORT
struct cql_node *cql_parser_sort_result(CQL_parser cp);

YAZ_EXPORT
void cql_to_xml(struct cql_node *cn,
                void (*pr)(const char *buf, void *client_data),
                void *client_data);
YAZ_EXPORT
void cql_to_xml_stdio(struct cql_node *cn, FILE *f);

YAZ_EXPORT
int cql_to_xml_buf(struct cql_node *cn, char *out, int max);

YAZ_EXPORT
int cql_to_ccl(struct cql_node *cn,
               void (*pr)(const char *buf, void *client_data),
               void *client_data);

YAZ_EXPORT
void cql_to_ccl_stdio(struct cql_node *cn, FILE *f);

YAZ_EXPORT
int cql_to_ccl_buf(struct cql_node *cn, char *out, int max);

YAZ_EXPORT
void cql_fputs(const char *buf, void *client_data);

typedef struct cql_transform_t_ *cql_transform_t;

YAZ_EXPORT
cql_transform_t cql_transform_create(void);

YAZ_EXPORT
cql_transform_t cql_transform_open_FILE (FILE *f);

YAZ_EXPORT
cql_transform_t cql_transform_open_fname(const char *fname);


YAZ_EXPORT
int cql_transform_define_pattern(cql_transform_t ct, const char *pattern,
                                 const char *value);



YAZ_EXPORT
void cql_transform_close(cql_transform_t ct);

YAZ_EXPORT
int cql_transform(cql_transform_t ct,
                  struct cql_node *cn,
                  void (*pr)(const char *buf, void *client_data),
                  void *client_data);

YAZ_EXPORT
int cql_transform_FILE(cql_transform_t ct,
                       struct cql_node *cn, FILE *f);

YAZ_EXPORT
int cql_transform_buf(cql_transform_t ct,
                      struct cql_node *cn, char *out, int max);

YAZ_EXPORT
int cql_transform_error(cql_transform_t ct, const char **addinfo);

YAZ_EXPORT
void cql_transform_set_error(cql_transform_t ct, int error, const char *addinfo);

YAZ_EXPORT
const char *cql_strerror(int code);

YAZ_EXPORT
const char *cql_uri(void);

YAZ_EXPORT
int cql_strcmp(const char *s1, const char *s2);

YAZ_EXPORT
int cql_strncmp(const char *s1, const char *s2, size_t n);

YAZ_EXPORT
int cql_sortby_to_sortkeys(struct cql_node *cn,
                           void (*pr)(const char *buf, void *client_data),
                           void *client_data);

YAZ_EXPORT
int cql_sortby_to_sortkeys_buf(struct cql_node *cn, char *out, int max);

YAZ_END_CDECL

#endif
/* CQL_H_INCLUDED */
/*
 * Local variables:
 * c-basic-offset: 4
 * c-file-style: "Stroustrup"
 * indent-tabs-mode: nil
 * End:
 * vim: shiftwidth=4 tabstop=8 expandtab
 */