Change wording ot YAZ license the 'Revised BSD License'. YAZ has used a

[yaz-moved-to-github.git] / include / yaz / cql.h

diff --git a/include/yaz/cql.h b/include/yaz/cql.h
index 73c242e..33535c7 100644 (file)
--- a/include/yaz/cql.h
+++ b/include/yaz/cql.h
@@ -1,5 +1,33 @@
-/* $Id: cql.h,v 1.9 2004-10-03 22:34:07 adam Exp $
-   Copyright (C) 2002-2004
+/*
+ * Copyright (c) 1995-2006, 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:
+ *
+ *     * 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.
+ */
+/* $Id: cql.h,v 1.15 2006-10-09 21:02:41 adam Exp $ */
+
+/* $Id: cql.h,v 1.15 2006-10-09 21:02:41 adam Exp $
+   Copyright (C) 1995-2005, Index Data ApS
    Index Data Aps
 
 This file is part of the YAZ toolkit.
@@ -14,7 +42,7 @@ See the file LICENSE.
 #ifndef CQL_H_INCLUDED
 #define CQL_H_INCLUDED
 #include <stdio.h>
-#include <yaz/yconfig.h>
+#include <yaz/nmem.h>
 
 YAZ_BEGIN_CDECL
 
@@ -81,30 +109,30 @@ struct cql_node {
     /** node type */
     int which;
     union {
-       /** which == CQL_NODE_ST */
+        /** which == CQL_NODE_ST */
         struct {
-           /** CQL index */
+            /** CQL index */
             char *index;
-           /** CQL index URI or NULL if no URI */
-           char *index_uri;
-           /** Search term */
+            /** CQL index URI or NULL if no URI */
+            char *index_uri;
+            /** Search term */
             char *term;
-           /** relation */
+            /** relation */
             char *relation;
-           /** relation URL or NULL if no relation URI) */
-           char *relation_uri;
-           /** relation modifiers */
+            /** relation URL or NULL if no relation URI) */
+            char *relation_uri;
+            /** relation modifiers */
             struct cql_node *modifiers;
         } st;
-       /** which == CQL_NODE_BOOL */
+        /** which == CQL_NODE_BOOL */
         struct {
             /** operator name "and", "or", ... */
             char *value;
-           /** left operand */
+            /** left operand */
             struct cql_node *left;
-           /** right operand */ 
+            /** right operand */ 
             struct cql_node *right;
-           /** modifiers (NULL for no list) */
+            /** modifiers (NULL for no list) */
             struct cql_node *modifiers;
         } boolean;
     } u;
@@ -141,10 +169,8 @@ void cql_node_print(struct cql_node *cn);
  * This function creates a search clause node (st).
  */
 YAZ_EXPORT
-struct cql_node *cql_node_mk_sc(const char *index,
-                                const char *relation,
-                                const char *term);
-
+struct cql_node *cql_node_mk_sc(NMEM nmem, const char *index,
+                                const char *relation, const char *term);
 
 /**
  * This function applies a prefix+uri to "unresolved" index and relation
@@ -154,15 +180,14 @@ struct cql_node *cql_node_mk_sc(const char *index,
  * is NULL.
  */
 YAZ_EXPORT
-struct cql_node *cql_apply_prefix(struct cql_node *cn,
-                                 const char *prefix,
-                                 const char *uri);
+struct cql_node *cql_apply_prefix(NMEM nmem, struct cql_node *cn,
+                                  const char *prefix, const char *uri);
 
 /**
  * This function creates a boolean node.
  */
 YAZ_EXPORT
-struct cql_node *cql_node_mk_boolean(const char *op);
+struct cql_node *cql_node_mk_boolean(NMEM nmem, const char *op);
 
 /**
  * Destroys a node and its children.
@@ -174,7 +199,7 @@ void cql_node_destroy(struct cql_node *cn);
  * Duplicate a node (returns a copy of supplied node) .
  */
 YAZ_EXPORT
-struct cql_node *cql_node_dup (struct cql_node *cp);
+struct cql_node *cql_node_dup (NMEM nmem, struct cql_node *cp);
 
 /**
  * This function returns the parse tree of the most recently parsed
@@ -282,9 +307,31 @@ const char *cql_strerror(int code);
  * Returns the standard CQL context set URI.
  */
 YAZ_EXPORT
-const char *cql_uri();
+const char *cql_uri(void);
+
+/**
+ * Compares two CQL strings (for relations, operators, etc)
+ * (unfortunately defined as case-insensitive unlike XML etc)
+ */
+YAZ_EXPORT
+int cql_strcmp(const char *s1, const char *s2);
+
+/**
+ * Compares two CQL strings at most n bytes
+ * (unfortunately defined as case-insensitive unlike XML etc)
+ */
+YAZ_EXPORT
+int cql_strncmp(const char *s1, const char *s2, size_t n);
 
 YAZ_END_CDECL
 
 #endif
 /* CQL_H_INCLUDED */
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+