/* This file is part of the YAZ toolkit.
- * Copyright (C) 1995-2012 Index Data.
+ * 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:
*/
/** \file solr.h
- \brief Header with public definitions about SOLR.
+ \brief Header with public definitions about Solr.
*/
#ifndef SOLR_H_INCLUDED
/** \brief creates a SOLR parser.
\returns CCL parser
-
+
Returns SOLR parser or NULL if parser could not be created.
*/
-YAZ_EXPORT
+YAZ_EXPORT
SOLR_parser solr_parser_create(void);
/** \brief destroys a SOLR parser.
This function does nothing if NULL if received.
*/
-YAZ_EXPORT
+YAZ_EXPORT
void solr_parser_destroy(SOLR_parser cp);
/** \brief parses a SOLR query (string)
\retval 0 success
\retval !=0 failure
*/
-YAZ_EXPORT
+YAZ_EXPORT
int solr_parser_string(SOLR_parser cp, const char *str);
/** \brief parses SOLR query (query stream)
\param client_data data to be passed to stream functions
\retval 0 success
\retval !=0 failure
-
+
This function is similar to solr_parser_string but takes a
functions to read each query character from a stream.
-
+
The functions pointers getbytes, ungetbyte are similar to
that known from stdios getc, ungetc.
*/
-YAZ_EXPORT
+YAZ_EXPORT
int solr_parser_stream(SOLR_parser cp,
int (*getbyte)(void *client_data),
void (*ungetbyte)(int b, void *client_data),
\param f file where query is read from
\retval 0 success
\retval !=0 failure
-
+
This function is similar to solr_parser_string but reads from
stdio FILE handle instead.
*/
char *value;
/** left operand */
struct solr_node *left;
- /** right operand */
+ /** right operand */
struct solr_node *right;
/** modifiers (NULL for no list) */
struct solr_node *modifiers;
YAZ_EXPORT
int solr_transform_define_pattern(solr_transform_t ct, const char *pattern,
const char *value);
-
+
/** \brief destroys a SOLR transform handle