Added CCL facility r=r "range" which is similar to r=o "ordered"
[yaz-moved-to-github.git] / include / yaz / ccl.h
index beca689..7724ace 100644 (file)
 /*
  * CCL - header file
  *
- * $Log: ccl.h,v $
- * Revision 1.10  2001-06-28 12:42:01  adam
- * Added prototype for ccl_qual_add_special.
+ * $Id: ccl.h,v 1.18 2004-09-29 20:37:50 adam Exp $
  *
- * Revision 1.9  2001/03/07 13:24:40  adam
- * Member and_not in Z_Operator is kept for backwards compatibility.
- * Added support for definition of CCL operators in field spec file.
- *
- * Revision 1.8  2000/11/16 09:58:02  adam
- * Implemented local AttributeSet setting for CCL field maps.
- *
- * Revision 1.7  2000/11/01 14:47:00  adam
- * Added CCL support for WIN32.
- *
- * Revision 1.6  2000/10/17 19:50:28  adam
- * Implemented and-list and or-list for CCL module.
- *
- * Revision 1.5  2000/05/02 17:19:58  adam
- * Removed MINUS token.
- *
- * Revision 1.4  2000/03/14 09:06:11  adam
- * Added POSIX threads support for frontend server.
- *
- * Revision 1.3  2000/02/08 10:39:53  adam
- * Added a few functions to set name of operands, etc.
- *
- * Revision 1.2  2000/01/31 13:15:21  adam
- * Removed uses of assert(3). Cleanup of ODR. CCL parser update so
- * that some characters are not surrounded by spaces in resulting term.
- * ILL-code updates.
- *
- * 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.
 
 #include <yaz/yconfig.h>
 #include <stdio.h>
+#include <yaz/xmalloc.h>
+#include <yaz/wrbuf.h>
 
 YAZ_BEGIN_CDECL
     
@@ -161,7 +112,13 @@ struct ccl_rpn_attr {
     struct ccl_rpn_attr *next;
     char *set;
     int type;
-    int value;
+    int kind;
+#define CCL_RPN_ATTR_NUMERIC 1
+#define CCL_RPN_ATTR_STRING 2
+    union {
+       int numeric;
+       char *str;
+    } value;
 };
 
 #define CCL_RPN_AND 1
@@ -175,7 +132,7 @@ struct ccl_rpn_attr {
 struct ccl_rpn_node {
     int kind;
     union {
-       struct ccl_rpn_node *p[2];
+       struct ccl_rpn_node *p[3];
        struct {
            char *term;
            struct ccl_rpn_attr *attr_list;
@@ -225,6 +182,7 @@ 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)
@@ -256,6 +214,8 @@ struct ccl_token {
 /* CCL Qualifier */
 struct ccl_qualifier {
     char *name;
+    int no_sub;
+    struct ccl_qualifier **sub;
     struct ccl_rpn_attr *attr_list;
     struct ccl_qualifier *next;
 };
@@ -292,6 +252,9 @@ YAZ_EXPORT struct ccl_token *ccl_token_simple (const char *command);
 /* Delete token list */
 YAZ_EXPORT void ccl_token_del (struct ccl_token *list);
 
+/* Add single token after node at */
+YAZ_EXPORT struct ccl_token *ccl_token_add (struct ccl_token *at);
+
 /* 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);
@@ -325,9 +288,14 @@ YAZ_EXPORT void ccl_qual_add (CCL_bibset b, const char *name, int no,
                              int *attr);
 
 YAZ_EXPORT void ccl_qual_add_set (CCL_bibset b, const char *name, int no,
-                                 int *attr, char **attsets);
+                                 int *type, int *value, char **svalue,
+                                 char **attsets);
+
+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);
+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);
@@ -335,8 +303,15 @@ 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 by using single-line spec */
-YAZ_EXPORT void ccl_qual_fitem (CCL_bibset bibset, const char *cp, const char *qual_name);
+/* 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);
 
 /* Make CCL qualifier set */
 YAZ_EXPORT CCL_bibset ccl_qual_mk (void);
@@ -352,8 +327,10 @@ 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);
 
 /* 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);
+YAZ_EXPORT struct ccl_rpn_attr *ccl_qual_search (CCL_parser cclp,
+                                                 const char *name,
+                                                 size_t len,
+                                                 int seq);
 
 /* Create CCL parser */
 YAZ_EXPORT CCL_parser ccl_parser_create (void);
@@ -366,6 +343,8 @@ YAZ_EXPORT char *ccl_strdup (const char *str);
 YAZ_EXPORT const char *ccl_qual_search_special (CCL_bibset b,
                                                const char *name);
 
+YAZ_EXPORT void ccl_pquery (WRBUF w, struct ccl_rpn_node *p);
+
 #ifndef ccl_assert
 #define ccl_assert(x) ;
 #endif