X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Fccl.h;h=a132f86f34871d117cc797634f7f0308ff1fdc0e;hb=de80462103c0fc554c8fa40827894f92fa9d8fe6;hp=d0fc3c3859671b0a405c8338c2083763bebf9200;hpb=5655212777a8fe68bf5cc1e563287c0f075a0ae5;p=yaz-moved-to-github.git diff --git a/include/yaz/ccl.h b/include/yaz/ccl.h index d0fc3c3..a132f86 100644 --- a/include/yaz/ccl.h +++ b/include/yaz/ccl.h @@ -42,10 +42,14 @@ * */ +/** \file ccl.h + \brief Header with public definitions for CCL. +*/ + /* * CCL - header file * - * $Id: ccl.h,v 1.16 2004-08-18 10:03:01 adam Exp $ + * $Id: ccl.h,v 1.24 2007-04-25 20:52:18 adam Exp $ * * Old Europagate Log: * @@ -107,17 +111,23 @@ YAZ_BEGIN_CDECL #define CCL_ERR_TRUNC_NOT_BOTH 11 #define CCL_ERR_TRUNC_NOT_RIGHT 12 -/* attribute pair (type, value) */ +/** attribute node (type, value) pair as used in RPN */ struct ccl_rpn_attr { + /** next node */ struct ccl_rpn_attr *next; + /** attribute set */ char *set; + /** attribute type, Bib-1: 1=use, 2=relation, 3=position, .. */ int type; + /** attribute value type (numeric or string) */ int kind; #define CCL_RPN_ATTR_NUMERIC 1 #define CCL_RPN_ATTR_STRING 2 union { - int numeric; - char *str; + /** numeric attribute value */ + int numeric; + /** string attribute value */ + char *str; } value; }; @@ -128,16 +138,20 @@ struct ccl_rpn_attr { #define CCL_RPN_SET 5 #define CCL_RPN_PROX 6 -/* RPN tree structure */ +/** RPN tree structure node */ struct ccl_rpn_node { + /** RPN tree node type */ int kind; union { - struct ccl_rpn_node *p[3]; - struct { - char *term; - struct ccl_rpn_attr *attr_list; - } t; - char *setname; + /** Boolean including proximity 0=left, 2=right, 3=prox parms */ + struct ccl_rpn_node *p[3]; + /** Attributes + Term */ + struct { + char *term; + struct ccl_rpn_attr *attr_list; + } t; + /** Result set */ + char *setname; } u; }; @@ -182,161 +196,145 @@ typedef struct ccl_qualifiers *CCL_bibset; #define CCL_BIB1_STR_AND_LIST (-2) #define CCL_BIB1_STR_OR_LIST (-3) #define CCL_BIB1_REL_ORDER (-1) +#define CCL_BIB1_REL_PORDER (-2) #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_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_SET 11 - -/* 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; - int no_sub; - struct ccl_qualifier **sub; - struct ccl_rpn_attr *attr_list; - struct ccl_qualifier *next; -}; - -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 */ -YAZ_EXPORT struct ccl_token *ccl_parser_tokenize (CCL_parser cclp, - const char *command); -YAZ_EXPORT struct ccl_token *ccl_tokenize (const char *command); - -/* Generate tokens from command string - oebeys only simple tokens and - quoted strings */ -YAZ_EXPORT struct ccl_token *ccl_token_simple (const char *command); +/** + * 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); -/* Delete token list */ -YAZ_EXPORT void ccl_token_del (struct ccl_token *list); +YAZ_EXPORT +struct ccl_rpn_node *ccl_parser_find_str(CCL_parser cclp, const char *str); -/* Parse CCL Find command - NULL-terminated string */ -YAZ_EXPORT struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, - const char *str, int *error, int *pos); +/** Set names for AND operator in parser */ +YAZ_EXPORT +void ccl_parser_set_op_and (CCL_parser p, const char *op); + +/** Set names for OR operator in parser */ +YAZ_EXPORT +void ccl_parser_set_op_or (CCL_parser p, const char *op); -/* Parse CCL Find command - Tokens read by ccl_tokenize */ -YAZ_EXPORT struct ccl_rpn_node *ccl_find (CCL_bibset abibset, struct ccl_token *list, - int *error, const char **pos); +/** Set names for ANDNOT operator in parser */ +YAZ_EXPORT +void ccl_parser_set_op_not (CCL_parser p, const char *op); -/* Parse CCL Find command */ -YAZ_EXPORT struct ccl_rpn_node *ccl_parser_find (CCL_parser cclp, struct ccl_token *list); +/** Set names for ResultSet in parser */ +YAZ_EXPORT +void ccl_parser_set_op_set (CCL_parser p, const char *op); -/* Set various OPs */ -YAZ_EXPORT void ccl_parser_set_op_and (CCL_parser p, const char *op); -YAZ_EXPORT void ccl_parser_set_op_or (CCL_parser p, const char *op); -YAZ_EXPORT void ccl_parser_set_op_not (CCL_parser p, const char *op); -YAZ_EXPORT void ccl_parser_set_op_set (CCL_parser p, const char *op); +/** Set case sensitivity for parser */ +YAZ_EXPORT +void ccl_parser_set_case (CCL_parser p, int case_sensitivity_flag); -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); -/* Return english-readable error message */ -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); -/* 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); -/* 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 CCL qualifier */ -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); -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 *v); -YAZ_EXPORT void ccl_qual_add_special (CCL_bibset bibset, - const char *n, const char *v); +/** Add combo qualifier */ +YAZ_EXPORT +void ccl_qual_add_combi (CCL_bibset b, const char *n, const char *names); -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 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); -/* 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 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 +void ccl_qual_fitem (CCL_bibset bibset, const char *value, + const char *qual_name); -/* Make CCL qualifier set */ -YAZ_EXPORT CCL_bibset ccl_qual_mk (void); +/** Make CCL qualifier set */ +YAZ_EXPORT +CCL_bibset ccl_qual_mk (void); -/* Delete CCL qualifier set */ -YAZ_EXPORT void ccl_qual_rm (CCL_bibset *b); +/** Delete CCL qualifier set */ +YAZ_EXPORT +void ccl_qual_rm (CCL_bibset *b); -/* Char-to-upper function */ +/** Char-to-upper function */ extern int (*ccl_toupper)(int c); -/* String utilities */ -YAZ_EXPORT int ccl_stricmp (const char *s1, const char *s2); -YAZ_EXPORT int ccl_memicmp (const char *s1, const char *s2, size_t n); +/** CCL version of ccl_stricmp */ +YAZ_EXPORT +int ccl_stricmp (const char *s1, const char *s2); -/* Search for qualifier 'name' in set 'b'. */ -YAZ_EXPORT struct ccl_rpn_attr *ccl_qual_search (CCL_parser cclp, - const char *name, - size_t len, - int seq); +/** 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 (void); +/** Search for qualifier 'name' in set 'b'. */ +YAZ_EXPORT +struct ccl_rpn_attr *ccl_qual_search (CCL_parser cclp, const char *name, + size_t len, int seq); -/* Destroy CCL parser */ -YAZ_EXPORT void ccl_parser_destroy (CCL_parser p); +/** Create CCL parser */ +YAZ_EXPORT +CCL_parser ccl_parser_create (CCL_bibset bibset); -YAZ_EXPORT char *ccl_strdup (const char *str); +/** Destroy CCL parser */ +YAZ_EXPORT +void ccl_parser_destroy (CCL_parser p); -YAZ_EXPORT const char *ccl_qual_search_special (CCL_bibset b, - const char *name); +/** String dup utility (ala strdup) */ +YAZ_EXPORT +char *ccl_strdup (const char *str); -YAZ_EXPORT void ccl_pquery (WRBUF w, struct ccl_rpn_node *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 +CCL_bibset ccl_parser_get_bibset(CCL_parser cclp); + +YAZ_EXPORT +int ccl_parser_get_error(CCL_parser cclp, int *pos); #ifndef ccl_assert #define ccl_assert(x) ; @@ -346,3 +344,11 @@ YAZ_END_CDECL #endif +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +