-/*
- * Copyright (c) 1995, the EUROPAGATE consortium (see below).
- *
- * The EUROPAGATE consortium members are:
- *
- * University College Dublin
- * Danmarks Teknologiske Videnscenter
- * An Chomhairle Leabharlanna
- * Consejo Superior de Investigaciones Cientificas
- *
- * Permission to use, copy, modify, distribute, and sell this software and
- * its documentation, in whole or in part, for any purpose, is hereby granted,
- * provided that:
- *
- * 1. This copyright and permission notice appear in all copies of the
- * software and its documentation. Notices of copyright or attribution
- * which appear at the beginning of any file must remain unchanged.
- *
- * 2. The names of EUROPAGATE or the project partners may not be used to
- * endorse or promote products derived from this software without specific
- * prior written permission.
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 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:
*
- * 3. Users of this software (implementors and gateway operators) agree to
- * inform the EUROPAGATE consortium of their use of the software. This
- * information will be used to evaluate the EUROPAGATE project and the
- * software, and to plan further developments. The consortium may use
- * the information in later publications.
- *
- * 4. Users of this software agree to make their best efforts, when
- * documenting their use of the software, to acknowledge the EUROPAGATE
- * consortium, and the role played by the software in their work.
- *
- * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
- * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
- * IN NO EVENT SHALL THE EUROPAGATE CONSORTIUM OR ITS MEMBERS BE LIABLE
- * FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF
- * ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
- * OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND
- * ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
- * USE OR PERFORMANCE OF THIS SOFTWARE.
+ * * 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.
*/
+/** \file ccl.h
+ \brief Header with public definitions for CCL.
+*/
+
/*
* CCL - header file
*
- * $Log: ccl.h,v $
- * Revision 1.1 1999-11-30 13:47:11 adam
- * Improved installation. Moved header files to include/yaz.
- *
- * Revision 1.9 1998/02/11 11:53:33 adam
- * Changed code so that it compiles as C++.
- *
- * Revision 1.8 1997/09/29 09:01:19 adam
- * Changed CCL parser to be thread safe. New type, CCL-parser, declared
- * and a create/destructor ccl_parser_create/ccl_parser_destroy has been
- * added.
*
- * Revision 1.7 1997/09/01 08:49:47 adam
- * New windows NT/95 port using MSV5.0. To export DLL functions the
- * YAZ_EXPORT modifier was added. Defined in yconfig.h.
- *
- * Revision 1.6 1997/05/14 06:53:37 adam
- * C++ support.
- *
- * Revision 1.5 1997/04/30 08:52:08 quinn
- * Null
- *
- * Revision 1.4 1996/10/11 15:02:26 adam
- * CCL parser from Europagate Email gateway 1.0.
+ * Old Europagate Log:
*
* Revision 1.10 1996/01/08 08:41:22 adam
* Minor changes.
#ifndef CCL_H
#define CCL_H
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* CCL error numbers */
+#include <yaz/yconfig.h>
+#include <stdio.h>
+#include <yaz/xmalloc.h>
+#include <yaz/wrbuf.h>
+
+YAZ_BEGIN_CDECL
+
#define CCL_ERR_OK 0
#define CCL_ERR_TERM_EXPECTED 1
#define CCL_ERR_RP_EXPECTED 2
#define CCL_ERR_TRUNC_NOT_LEFT 10
#define CCL_ERR_TRUNC_NOT_BOTH 11
#define CCL_ERR_TRUNC_NOT_RIGHT 12
-
-/* attribute pair (type, value) */
+#define CCL_ERR_TRUNC_NOT_EMBED 13
+#define CCL_ERR_TRUNC_NOT_SINGLE 14
+
+/** \brief attribute node (type, value) pair as used in RPN */
struct ccl_rpn_attr {
+ /** \brief next attribute */
struct ccl_rpn_attr *next;
+ /** \brief attribute set */
+ char *set;
+ /** \brief attribute type, Bib-1: 1=use, 2=relation, 3=position, etc */
int type;
- int value;
+ /** \brief attribute value type (numeric or string) */
+ int kind;
+#define CCL_RPN_ATTR_NUMERIC 1
+#define CCL_RPN_ATTR_STRING 2
+ union {
+ /** \brief numeric attribute value */
+ int numeric;
+ /** \brief string attribute value */
+ char *str;
+ } value;
};
-#define CCL_RPN_AND 1
-#define CCL_RPN_OR 2
-#define CCL_RPN_NOT 3
-#define CCL_RPN_TERM 4
-#define CCL_RPN_SET 5
-#define CCL_RPN_PROX 6
+/** \brief node type or RPN tree generated by the CCL parser */
+enum ccl_rpn_kind {
+ CCL_RPN_AND,
+ CCL_RPN_OR,
+ CCL_RPN_NOT,
+ CCL_RPN_TERM,
+ CCL_RPN_SET,
+ CCL_RPN_PROX
+};
-/* RPN tree structure */
+/** \brief RPN tree structure node */
struct ccl_rpn_node {
- int kind;
+ /** \brief node type, one of CCL_RPN_AND, CCL_RPN_OR, etc */
+ enum ccl_rpn_kind kind;
union {
- struct ccl_rpn_node *p[2];
- struct {
- char *term;
- struct ccl_rpn_attr *attr_list;
- } t;
- char *setname;
+ /** \brief Boolean including proximity 0=left, 1=right, 2=prox parms */
+ struct ccl_rpn_node *p[3];
+ /** \brief Attributes + Term */
+ struct {
+ char *term;
+ char *qual;
+ struct ccl_rpn_attr *attr_list;
+ } t;
+ /** Result set */
+ char *setname;
} u;
};
+/** \brief CCL bibset, AKA profile */
typedef struct ccl_qualifiers *CCL_bibset;
-/* use (1)
+/** \brief CCL parser */
+typedef struct ccl_parser *CCL_parser;
+
+/**
+ \brief parse CCL find string using CCL profile return RPN tree
+
+ Parses a CCL Find command in a simple C string. Returns CCL parse
+ tree node describing RPN if parsing is successful. If parsing is
+ unsuccesful, NULL is returned and error and pos is set accordingly.
+*/
+YAZ_EXPORT
+struct ccl_rpn_node *ccl_find_str(CCL_bibset bibset,
+ const char *str, int *error, int *pos);
+
+
+/**
+ \brief parse CCL find string with parser and return RPN tree
+
+ Parses a CCL Find command in a simple C string. Returns CCL parse
+ tree node describing RPN if parsing is successful. If parsing is
+ unsuccesful, NULL is returned and error and pos is set accordingly.
+*/
+YAZ_EXPORT
+struct ccl_rpn_node *ccl_parser_find_str(CCL_parser cclp, const char *str);
+
+/** Set case sensitivity for parser */
+YAZ_EXPORT
+void ccl_parser_set_case(CCL_parser p, int case_sensitivity_flag);
+
+/** Return english-readable error message for CCL parser error number */
+YAZ_EXPORT
+const char *ccl_err_msg(int ccl_errno);
+
+/** Delete RPN tree returned by ccl_find */
+YAZ_EXPORT
+void ccl_rpn_delete(struct ccl_rpn_node *rpn);
+
+/** Dump RPN tree in readable format to fd_out */
+YAZ_EXPORT
+void ccl_pr_tree(struct ccl_rpn_node *rpn, FILE *fd_out);
+
+/** Add qualifier and supply attribute pairs for it */
+YAZ_EXPORT
+void ccl_qual_add(CCL_bibset b, const char *name, int no, int *attr);
+
+/** Add qualifier and supply attributes pairs+attribute set for it */
+YAZ_EXPORT
+void ccl_qual_add_set(CCL_bibset b, const char *name, int no,
+ int *type, int *value, char **svalue, char **attsets);
+
+/** Add special qualifier */
+YAZ_EXPORT
+void ccl_qual_add_special(CCL_bibset bibset, const char *n, const char *cp);
+
+/** Add combo qualifier */
+YAZ_EXPORT
+void ccl_qual_add_combi(CCL_bibset b, const char *n, const char **names);
+
+/** Read CCL qualifier list spec from file inf */
+YAZ_EXPORT
+void ccl_qual_file(CCL_bibset bibset, FILE *inf);
+
+/** Read CCL qualifier list spec from file inf */
+YAZ_EXPORT
+int ccl_qual_fname(CCL_bibset bibset, const char *fname);
+
+/** Add CCL qualifier as buf spec(multiple lines). */
+YAZ_EXPORT
+void ccl_qual_buf(CCL_bibset bibset, const char *buf);
+
+/** Add CCL qualifier as line spec. Note: line is _modified_ */
+YAZ_EXPORT
+void ccl_qual_line(CCL_bibset bibset, char *line);
+
+/* Add CCL qualifier by using qual_name + value pair */
+YAZ_EXPORT
+void ccl_qual_fitem(CCL_bibset bibset, const char *value,
+ const char *qual_name);
+YAZ_EXPORT
+int ccl_qual_fitem2(CCL_bibset bibset, const char *value,
+ const char *qual_name, const char **addinfo);
+
+/** Make CCL qualifier set */
+YAZ_EXPORT
+CCL_bibset ccl_qual_mk(void);
+
+/** Make CCL qualifier set from an existing one (duplicate it) */
+YAZ_EXPORT
+CCL_bibset ccl_qual_dup(CCL_bibset b);
+
+/** Delete CCL qualifier set */
+YAZ_EXPORT
+void ccl_qual_rm(CCL_bibset *b);
+
+/** Char-to-upper function */
+extern int(*ccl_toupper)(int c);
+
+/** CCL version of ccl_stricmp */
+YAZ_EXPORT
+int ccl_stricmp(const char *s1, const char *s2);
+
+/** CCL version of ccl_memicmp */
+YAZ_EXPORT
+int ccl_memicmp(const char *s1, const char *s2, size_t n);
+
+/** Create CCL parser */
+YAZ_EXPORT
+CCL_parser ccl_parser_create(CCL_bibset bibset);
+
+/** Destroy CCL parser */
+YAZ_EXPORT
+void ccl_parser_destroy(CCL_parser p);
+
+/** Search for special qualifier */
+YAZ_EXPORT
+const char **ccl_qual_search_special(CCL_bibset b, const char *name);
+/** Pretty-print CCL RPN node tree to WRBUF */
+YAZ_EXPORT
+void ccl_pquery(WRBUF w, struct ccl_rpn_node *p);
+
+YAZ_EXPORT
+int ccl_parser_get_error(CCL_parser cclp, int *pos);
+
+YAZ_EXPORT
+struct ccl_rpn_node *ccl_rpn_node_create(enum ccl_rpn_kind kind);
+
+YAZ_EXPORT
+void ccl_add_attr_numeric(struct ccl_rpn_node *p, const char *set,
+ int type, int value);
+
+YAZ_EXPORT
+void ccl_add_attr_string(struct ccl_rpn_node *p, const char *set,
+ int type, char *value);
+
+YAZ_EXPORT
+int ccl_search_stop(CCL_bibset bibset, const char *qname,
+ const char *src_str, size_t src_len);
+
+
+/** \brief stop words handle (pimpl) */
+typedef struct ccl_stop_words *ccl_stop_words_t;
+
+/** \brief creates stop words handle */
+YAZ_EXPORT
+ccl_stop_words_t ccl_stop_words_create(void);
+
+/** \brief destroys stop words handle */
+YAZ_EXPORT
+void ccl_stop_words_destroy(ccl_stop_words_t csw);
+
+/** \brief removes stop words from RPN tree */
+YAZ_EXPORT
+int ccl_stop_words_tree(ccl_stop_words_t csw,
+ CCL_bibset bibset, struct ccl_rpn_node **t);
+
+/** \brief returns information about removed "stop" words */
+YAZ_EXPORT
+int ccl_stop_words_info(ccl_stop_words_t csw, int idx,
+ const char **qualname, const char **term);
+
+YAZ_EXPORT
+struct ccl_rpn_attr *ccl_parser_qual_search(CCL_parser cclp, const char *name,
+ size_t name_len);
+
+
+#ifndef ccl_assert
+#define ccl_assert(x) ;
+#endif
+
+
+/** \brief common attributes
+
+ use (1)
relation (2)
-1 none
3 key
4 year
5 date (normalized)
- 6 word list
+ 6 word list
100 date (un-normalized)
101 name (normalized)
102 name (un-normalized)
- truncation (5)
+ truncation (5)
completeness (6)
*/
#define CCL_BIB1_COM 6
#define CCL_BIB1_STR_WP (-1)
+#define CCL_BIB1_STR_AND_LIST (-2)
+#define CCL_BIB1_STR_OR_LIST (-3)
+#define CCL_BIB1_STR_AUTO_GROUP (-4)
#define CCL_BIB1_REL_ORDER (-1)
+#define CCL_BIB1_REL_PORDER (-2)
+#define CCL_BIB1_REL_OMIT_EQUALS (-3)
#define CCL_BIB1_TRU_CAN_LEFT (-1)
#define CCL_BIB1_TRU_CAN_RIGHT (-2)
#define CCL_BIB1_TRU_CAN_BOTH (-3)
#define CCL_BIB1_TRU_CAN_NONE (-4)
+#define CCL_BIB1_TRU_CAN_REGEX (-5)
+#define CCL_BIB1_TRU_CAN_Z3958 (-6)
-#define CCL_TOK_EOL 0
-#define CCL_TOK_TERM 1
-#define CCL_TOK_REL 2
-#define CCL_TOK_EQ 3
-#define CCL_TOK_PROX 4
-#define CCL_TOK_LP 5
-#define CCL_TOK_RP 6
-#define CCL_TOK_COMMA 7
-#define CCL_TOK_AND 8
-#define CCL_TOK_OR 9
-#define CCL_TOK_NOT 10
-#define CCL_TOK_MINUS 11
-#define CCL_TOK_SET 12
-
-/* CCL token */
-struct ccl_token {
- char kind;
- size_t len;
- const char *name;
- struct ccl_token *next;
- struct ccl_token *prev;
-};
-/* CCL Qualifier */
-struct ccl_qualifier {
- char *name;
- struct ccl_rpn_attr *attr_list;
- struct ccl_qualifier *next;
-};
+YAZ_END_CDECL
-struct ccl_parser {
-/* current lookahead token */
- struct ccl_token *look_token;
-
-/* holds error code if error occur (and approx position of error) */
- int error_code;
- const char *error_pos;
-
-/* current bibset */
- CCL_bibset bibset;
-
- char *ccl_token_and;
- char *ccl_token_or;
- char *ccl_token_not;
- char *ccl_token_set;
- int ccl_case_sensitive;
-};
-
-typedef struct ccl_parser *CCL_parser;
-
-/* Generate tokens from command string - obeys all CCL opererators */
-struct ccl_token *ccl_parser_tokenize (CCL_parser cclp,
- const char *command);
-struct ccl_token *ccl_tokenize (const char *command);
-
-/* Generate tokens from command string - oebeys only simple tokens and
- quoted strings */
-struct ccl_token *ccl_token_simple (const char *command);
-
-/* Delete token list */
-void ccl_token_del (struct ccl_token *list);
-
-/* Parse CCL Find command - NULL-terminated string */
-struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset,
- const char *str, int *error, int *pos);
-
-/* Parse CCL Find command - Tokens read by ccl_tokenize */
-struct ccl_rpn_node *ccl_find (CCL_bibset abibset, struct ccl_token *list,
- int *error, const char **pos);
-
-/* Return english-readable error message */
-const char *ccl_err_msg (int ccl_errno);
-
-/* Delete RPN tree returned by ccl_find */
-void ccl_rpn_delete (struct ccl_rpn_node *rpn);
-
-/* Dump RPN tree in readable format to fd_out */
-void ccl_pr_tree (struct ccl_rpn_node *rpn, FILE *fd_out);
-
-/* Add CCL qualifier */
-void ccl_qual_add (CCL_bibset b, const char *name, int no, int *attr);
-
-/* Read CCL qualifier list spec from file inf */
-void ccl_qual_file (CCL_bibset bibset, FILE *inf);
-
-/* Add CCL qualifier by using single-line spec */
-void ccl_qual_fitem (CCL_bibset bibset, const char *cp, const char *qual_name);
-
-/* Make CCL qualifier set */
-CCL_bibset ccl_qual_mk (void);
-
-/* Delete CCL qualifier set */
-void ccl_qual_rm (CCL_bibset *b);
-
-/* Char-to-upper function */
-extern int (*ccl_toupper)(int c);
-
-/* String utilities */
-int ccl_stricmp (const char *s1, const char *s2);
-int ccl_memicmp (const char *s1, const char *s2, size_t n);
-
-/* Search for qualifier 'name' in set 'b'. */
-struct ccl_rpn_attr *ccl_qual_search (CCL_parser cclp, const char *name,
- size_t len);
-
-/* Create CCL parser */
-CCL_parser ccl_parser_create (void);
-
-/* Destroy CCL parser */
-void ccl_parser_destroy (CCL_parser p);
-
-#ifdef __cplusplus
-}
#endif
-#endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
projects / yaz-moved-to-github.git / blobdiff