YAZ  5.23.1
solr.h
Go to the documentation of this file.
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) Index Data.
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of Index Data nor the names of its contributors
13  * may be used to endorse or promote products derived from this
14  * software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
32 #ifndef SOLR_H_INCLUDED
33 #define SOLR_H_INCLUDED
34 #include <stdio.h>
35 #include <yaz/nmem.h>
36 
38 
43 
47 YAZ_EXPORT
48 solr_transform_t solr_transform_create(void);
49 
57 YAZ_EXPORT
58 solr_transform_t solr_transform_open_FILE(FILE *f);
59 
64 YAZ_EXPORT
65 solr_transform_t solr_transform_open_fname(const char *fname);
66 
67 
74 YAZ_EXPORT
75 int solr_transform_define_pattern(solr_transform_t ct, const char *pattern,
76  const char *value);
77 
81 YAZ_EXPORT
82 void solr_transform_close(solr_transform_t ct);
83 
89 YAZ_EXPORT
90 int solr_transform_error(solr_transform_t ct, const char **addinfo);
91 
97 YAZ_EXPORT
98 void solr_transform_set_error(solr_transform_t ct, int error, const char *addinfo);
99 
101 
102 #endif
103 /* SOLR_H_INCLUDED */
104 /*
105  * Local variables:
106  * c-basic-offset: 4
107  * c-file-style: "Stroustrup"
108  * indent-tabs-mode: nil
109  * End:
110  * vim: shiftwidth=4 tabstop=8 expandtab
111  */
112 
struct cql_transform_t_ * solr_transform_t
SOLR transform handle. The transform describes how to convert from SOLR to PQF (Type-1 AKA RPN)...
Definition: solr.h:42
int solr_transform_define_pattern(solr_transform_t ct, const char *pattern, const char *value)
defines SOLR transform pattern
Definition: solrtransform.c:35
solr_transform_t solr_transform_open_fname(const char *fname)
creates a SOLR transform handle from a file
Definition: solrtransform.c:30
#define YAZ_END_CDECL
Definition: yconfig.h:57
solr_transform_t solr_transform_create(void)
creates a SOLR transform handle
Definition: solrtransform.c:20
void solr_transform_close(solr_transform_t ct)
destroys a SOLR transform handle
Definition: solrtransform.c:41
solr_transform_t solr_transform_open_FILE(FILE *f)
creates a SOLR transform handle from am opened file handle
Definition: solrtransform.c:25
void solr_transform_set_error(solr_transform_t ct, int error, const char *addinfo)
sets error and addinfo for transform
Definition: solrtransform.c:51
Header for Nibble Memory functions.
int solr_transform_error(solr_transform_t ct, const char **addinfo)
returns additional information for last transform
Definition: solrtransform.c:46
#define YAZ_BEGIN_CDECL
Definition: yconfig.h:56