Clean-up the CCL API. Moved some internal structures from ccl.h to
[yaz-moved-to-github.git] / include / yaz / ccl.h
index d0a2b09..a132f86 100644 (file)
@@ -49,7 +49,7 @@
 /*
  * CCL - header file
  *
- * $Id: ccl.h,v 1.22 2005-04-15 21:47:55 adam Exp $
+ * $Id: ccl.h,v 1.24 2007-04-25 20:52:18 adam Exp $
  *
  * Old Europagate Log:
  *
@@ -124,10 +124,10 @@ struct ccl_rpn_attr {
 #define CCL_RPN_ATTR_NUMERIC 1
 #define CCL_RPN_ATTR_STRING 2
     union {
-       /** numeric attribute value */
-       int numeric;
-       /** string attribute value */
-       char *str;
+        /** numeric attribute value */
+        int numeric;
+        /** string attribute value */
+        char *str;
     } value;
 };
 
@@ -143,15 +143,15 @@ struct ccl_rpn_node {
     /** RPN tree node type */
     int kind;
     union {
-       /** 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;
+        /** 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;
 };
 
@@ -203,117 +203,19 @@ typedef struct ccl_qualifiers *CCL_bibset;
 #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;                 /* length of name below */
-    const char *name;           /* string / name of token */
-    struct ccl_token *next;
-    struct ccl_token *prev;
-    const char *ws_prefix_buf;  /* leading white space buf */
-    size_t ws_prefix_len;       /* leading white space len */
-};
-
-/** CCL Qualifier */
-struct ccl_qualifier {
-    char *name;
-    int no_sub;
-    struct ccl_qualifier **sub;
-    struct ccl_rpn_attr *attr_list;
-    struct ccl_qualifier *next;
-};
-
-/** CCL parser structure */
-struct ccl_parser {
-    /** current lookahead token */
-    struct ccl_token *look_token;
-    
-    /** holds error code if error occur */
-    int error_code;
-    /** if error occurs, this holds position (starting from 0). */
-    const char *error_pos;
-    
-    /** current bibset */
-    CCL_bibset bibset;
-
-    /** names of and operator */
-    char *ccl_token_and;
-    /** names of or operator */
-    char *ccl_token_or;
-    /** names of not operator */
-    char *ccl_token_not;
-    /** names of set operator */
-    char *ccl_token_set;
-    /** 1=CCL parser is case sensitive, 0=case insensitive */
-    int ccl_case_sensitive;
-};
-    
 typedef struct ccl_parser *CCL_parser;
     
 /**
- * Splits CCL command string into individual tokens using
- * a CCL parser.
- */
-YAZ_EXPORT
-struct ccl_token *ccl_parser_tokenize (CCL_parser cclp, const char *command);
-
-/**
- * Splits CCL command string into tokens using temporary parser.
- *
- * Use ccl_parser_tokenize instead and provide a parser - it is
- * more flexible and efficient.
- */
-YAZ_EXPORT
-struct ccl_token *ccl_tokenize (const char *command);
-    
-/** 
- * Deletes token list
- */
-YAZ_EXPORT
-void ccl_token_del (struct ccl_token *list);
-
-/**
- * Add single token after a given onde.
- */
-YAZ_EXPORT
-struct ccl_token *ccl_token_add (struct ccl_token *at);
-
-/**
  * 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);
-
-/**
- * Parses CCL Find command from a list of CCL tokens. Otherwise similar to
- * ccl_find_str.
- */
-YAZ_EXPORT
-struct ccl_rpn_node *ccl_find (CCL_bibset abibset, struct ccl_token *list,
-                               int *error, const char **pos);
+                                   const char *str, int *error, int *pos);
 
-/**
- * Parses a CCL Find command from a list of CCL tokens and given a CCL
- * parser. Otherwise similar to ccl_find_str.
- */
 YAZ_EXPORT
-struct ccl_rpn_node *ccl_parser_find (CCL_parser cclp, struct ccl_token *list);
+struct ccl_rpn_node *ccl_parser_find_str(CCL_parser cclp, const char *str);
 
 /** Set names for AND operator in parser */
 YAZ_EXPORT
@@ -354,7 +256,7 @@ 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);
+                       int *type, int *value, char **svalue, char **attsets);
 
 /** Add special qualifier */
 YAZ_EXPORT
@@ -383,7 +285,7 @@ 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);
+                     const char *qual_name);
 
 /** Make CCL qualifier set */
 YAZ_EXPORT
@@ -407,11 +309,11 @@ 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, int seq);
+                                      size_t len, int seq);
 
 /** Create CCL parser */
 YAZ_EXPORT
-CCL_parser ccl_parser_create (void);
+CCL_parser ccl_parser_create (CCL_bibset bibset);
 
 /** Destroy CCL parser */
 YAZ_EXPORT
@@ -423,12 +325,17 @@ char *ccl_strdup (const char *str);
 
 /** Search for special qualifier */
 YAZ_EXPORT
-const char *ccl_qual_search_special (CCL_bibset b,
-                                               const char *name);
+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) ;
 #endif
@@ -437,3 +344,11 @@ YAZ_END_CDECL
 
 #endif
 
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+