Fix documentation of of chr's equivalent directive ZEB-672

[idzebra-moved-to-github.git] / rset / rset.c

diff --git a/rset/rset.c b/rset/rset.c
index 68a41ee..f64ff45 100644 (file)
--- a/rset/rset.c
+++ b/rset/rset.c
@@ -1,5 +1,5 @@
 /* This file is part of the Zebra server.
 /* This file is part of the Zebra server.

-   Copyright (C) 1994-2009 Index Data
+   Copyright (C) Index Data

 
 Zebra is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
 
 Zebra is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free

@@ -17,6 +17,9 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 */
 
 
 */
 

+#if HAVE_CONFIG_H
+#include <config.h>
+#endif

 #include <stdio.h>
 #include <string.h>
 #include <idzebra/util.h>
 #include <stdio.h>
 #include <string.h>
 #include <idzebra/util.h>

@@ -31,31 +34,31 @@ static int log_level_initialized = 0;
 /**
    \brief Common constuctor for RFDs
    \param rs Result set handle.
 /**
    \brief Common constuctor for RFDs
    \param rs Result set handle.

-   
-   Creates an rfd. Either allocates a new one, in which case the priv 
-   pointer is null, and will have to be filled in, or picks up one 
+
+   Creates an rfd. Either allocates a new one, in which case the priv
+   pointer is null, and will have to be filled in, or picks up one

    from the freelist, in which case the priv is already allocated,
    from the freelist, in which case the priv is already allocated,

-   and presumably everything that hangs from it as well 
+   and presumably everything that hangs from it as well

 */
 RSFD rfd_create_base(RSET rs)
 {
     RSFD rnew = rs->free_list;
 
 */
 RSFD rfd_create_base(RSET rs)
 {
     RSFD rnew = rs->free_list;
 

-    if (rnew) 
+    if (rnew)

     {
         rs->free_list = rnew->next;
         assert(rnew->rset==rs);
     {
         rs->free_list = rnew->next;
         assert(rnew->rset==rs);

-        yaz_log(log_level, "rfd_create_base (fl): rfd=%p rs=%p fl=%p priv=%p", 
-               rnew, rs, rs->free_list, rnew->priv); 
-    } 
+        yaz_log(log_level, "rfd_create_base (fl): rfd=%p rs=%p fl=%p priv=%p",
+               rnew, rs, rs->free_list, rnew->priv);
+    }

     else
     {
         rnew = nmem_malloc(rs->nmem, sizeof(*rnew));
        rnew->counted_buf = nmem_malloc(rs->nmem, rs->keycontrol->key_size);
        rnew->priv = 0;
         rnew->rset = rs;
     else
     {
         rnew = nmem_malloc(rs->nmem, sizeof(*rnew));
        rnew->counted_buf = nmem_malloc(rs->nmem, rs->keycontrol->key_size);
        rnew->priv = 0;
         rnew->rset = rs;

-        yaz_log(log_level, "rfd_create_base (new): rfd=%p rs=%p fl=%p priv=%p", 
-               rnew, rs, rs->free_list, rnew->priv); 
+        yaz_log(log_level, "rfd_create_base (new): rfd=%p rs=%p fl=%p priv=%p",
+               rnew, rs, rs->free_list, rnew->priv);

     }
     rnew->next = rs->use_list;
     rs->use_list = rnew;
     }
     rnew->next = rs->use_list;
     rs->use_list = rnew;

@@ -67,9 +70,9 @@ static void rset_close_int(RSET rs, RSFD rfd)
 {
     RSFD *pfd;
     (*rs->control->f_close)(rfd);
 {
     RSFD *pfd;
     (*rs->control->f_close)(rfd);

-    
+

     yaz_log(log_level, "rfd_delete_base: rfd=%p rs=%p priv=%p fl=%p",
     yaz_log(log_level, "rfd_delete_base: rfd=%p rs=%p priv=%p fl=%p",

-            rfd, rs, rfd->priv, rs->free_list); 
+            rfd, rs, rfd->priv, rs->free_list);

     for (pfd = &rs->use_list; *pfd; pfd = &(*pfd)->next)
        if (*pfd == rfd)
        {
     for (pfd = &rs->use_list; *pfd; pfd = &(*pfd)->next)
        if (*pfd == rfd)
        {

@@ -104,7 +107,7 @@ void rset_close(RSFD rfd)
        while (rfd->counted_items <= rs->hits_limit
              && rset_default_read(rfd, buf, &termid))
            ;
        while (rfd->counted_items <= rs->hits_limit
              && rset_default_read(rfd, buf, &termid))
            ;

-       
+

        rs->hits_count = rfd->counted_items;
        yaz_log(log_level, "rset_close rset=%p hits_count=" ZINT_FORMAT
                " hits_limit=" ZINT_FORMAT,
        rs->hits_count = rfd->counted_items;
        yaz_log(log_level, "rset_close rset=%p hits_count=" ZINT_FORMAT
                " hits_limit=" ZINT_FORMAT,

@@ -114,7 +117,7 @@ void rset_close(RSFD rfd)
        {
            double cur, tot;
            zint est;
        {
            double cur, tot;
            zint est;

-           rset_pos(rfd, &cur, &tot); 
+           rset_pos(rfd, &cur, &tot);

            if (tot > 0) {
                int i;
                double ratio = cur/tot;
            if (tot > 0) {
                int i;
                double ratio = cur/tot;

@@ -136,7 +139,7 @@ void rset_close(RSFD rfd)
                rs->hits_approx = 1;
            }
        }
                rs->hits_approx = 1;
            }
        }

-       yaz_log(log_level, "rset_close(%s) p=%p count=" ZINT_FORMAT, 
+       yaz_log(log_level, "rset_close(%s) p=%p count=" ZINT_FORMAT,

                 rs->control->desc, rs,
                rs->hits_count);
     }
                 rs->control->desc, rs,
                rs->hits_count);
     }

@@ -152,28 +155,28 @@ void rset_close(RSFD rfd)
    \param term Information about term for it (NULL for none).
    \param no_children number of child rsets (0 for none)
    \param children child rsets (NULL for none).
    \param term Information about term for it (NULL for none).
    \param no_children number of child rsets (0 for none)
    \param children child rsets (NULL for none).

-   
-   Creates an rfd. Either allocates a new one, in which case the priv 
-   pointer is null, and will have to be filled in, or picks up one 
+
+   Creates an rfd. Either allocates a new one, in which case the priv
+   pointer is null, and will have to be filled in, or picks up one

    from the freelist, in which case the priv is already allocated,
    from the freelist, in which case the priv is already allocated,

-   and presumably everything that hangs from it as well 
+   and presumably everything that hangs from it as well

 */
 */

-RSET rset_create_base(const struct rset_control *sel, 
+RSET rset_create_base(const struct rset_control *sel,

                       NMEM nmem, struct rset_key_control *kcontrol,
                       int scope, TERMID term,
                      int no_children, RSET *children)
 {
     RSET rset;
     assert(nmem);
                       NMEM nmem, struct rset_key_control *kcontrol,
                       int scope, TERMID term,
                      int no_children, RSET *children)
 {
     RSET rset;
     assert(nmem);

-    if (!log_level_initialized) 
+    if (!log_level_initialized)

     {
         log_level = yaz_log_module_level("rset");
         log_level_initialized = 1;
     }
 
     rset = (RSET) nmem_malloc(nmem, sizeof(*rset));
     {
         log_level = yaz_log_module_level("rset");
         log_level_initialized = 1;
     }
 
     rset = (RSET) nmem_malloc(nmem, sizeof(*rset));

-    yaz_log(log_level, "rs_create(%s) rs=%p (nm=%p)", sel->desc, rset, nmem); 
-    yaz_log(log_level, " ref_id=%s", 
+    yaz_log(log_level, "rs_create(%s) rs=%p (nm=%p)", sel->desc, rset, nmem);
+    yaz_log(log_level, " ref_id=%s",

            (term && term->ref_id ? term->ref_id : "null"));
     rset->nmem = nmem;
     rset->control = sel;
            (term && term->ref_id ? term->ref_id : "null"));
     rset->nmem = nmem;
     rset->control = sel;

@@ -208,7 +211,7 @@ RSET rset_create_base(const struct rset_control *sel,
 /**
    \brief Destructor RSETs
    \param rs Handle for result set.
 /**
    \brief Destructor RSETs
    \param rs Handle for result set.

-   
+

    Destroys a result set and all its children.
    The f_delete method of control is called for the result set.
 */
    Destroys a result set and all its children.
    The f_delete method of control is called for the result set.
 */

@@ -216,7 +219,7 @@ void rset_delete(RSET rs)
 {
     (rs->refcount)--;
     yaz_log(log_level, "rs_delete(%s), rs=%p, refcount=%d",
 {
     (rs->refcount)--;
     yaz_log(log_level, "rs_delete(%s), rs=%p, refcount=%d",

-            rs->control->desc, rs, rs->refcount); 
+            rs->control->desc, rs, rs->refcount);

     if (!rs->refcount)
     {
        int i;
     if (!rs->refcount)
     {
        int i;

@@ -233,7 +236,7 @@ void rset_delete(RSET rs)
 /**
    \brief Test for last use of RFD
    \param rfd RFD handle.
 /**
    \brief Test for last use of RFD
    \param rfd RFD handle.

-   
+

    Returns 1 if this RFD is the last reference to it; 0 otherwise.
 */
 int rfd_is_last(RSFD rfd)
    Returns 1 if this RFD is the last reference to it; 0 otherwise.
 */
 int rfd_is_last(RSFD rfd)

@@ -246,18 +249,18 @@ int rfd_is_last(RSFD rfd)
 /**
    \brief Duplicate an RSET
    \param rs Handle for result set.
 /**
    \brief Duplicate an RSET
    \param rs Handle for result set.

-   
+

    Duplicates a result set by incrementing the reference count to it.
 */
 RSET rset_dup (RSET rs)
 {
     (rs->refcount)++;
     yaz_log(log_level, "rs_dup(%s), rs=%p, refcount=%d",
    Duplicates a result set by incrementing the reference count to it.
 */
 RSET rset_dup (RSET rs)
 {
     (rs->refcount)++;
     yaz_log(log_level, "rs_dup(%s), rs=%p, refcount=%d",

-            rs->control->desc, rs, rs->refcount); 
+            rs->control->desc, rs, rs->refcount);

     return rs;
 }
 
     return rs;
 }
 

-/** 
+/**

     \brief Estimates hit count for result set.
     \param rs Result Set.
 
     \brief Estimates hit count for result set.
     \param rs Result Set.
 

@@ -340,13 +343,11 @@ TERMID rset_term_create(const char *name, int length, const char *flags,
                        zint hits_limit, const char *ref_id)
 
 {
                        zint hits_limit, const char *ref_id)
 
 {

-    TERMID t;
-    yaz_log (log_level, "term_create '%s' %d f=%s type=%d nmem=%p",
-            name, length, flags, type, nmem);
-    t= (TERMID) nmem_malloc(nmem, sizeof(*t));
+    TERMID t = (TERMID) nmem_malloc(nmem, sizeof(*t));
+

     if (!name)
     if (!name)

-        t->name = NULL;
-    else if (length == -1)
+        name = "";
+    if (length == -1)

         t->name = nmem_strdup(nmem, name);
     else
        t->name = nmem_strdupn(nmem, name, length);
         t->name = nmem_strdup(nmem, name);
     else
        t->name = nmem_strdupn(nmem, name, length);

@@ -378,7 +379,7 @@ int rset_default_read(RSFD rfd, void *buf, TERMID *term)
             got_scope = rset->scope+1;
         else
             got_scope = rset->keycontrol->cmp(buf, rfd->counted_buf);
             got_scope = rset->scope+1;
         else
             got_scope = rset->keycontrol->cmp(buf, rfd->counted_buf);

-       
+

 #if 0
         key_logdump_txt(YLOG_LOG, buf, "rset_default_read");
         yaz_log(YLOG_LOG, "rset_scope=%d got_scope=%d", rset->scope, got_scope);
 #if 0
         key_logdump_txt(YLOG_LOG, buf, "rset_default_read");
         yaz_log(YLOG_LOG, "rset_scope=%d got_scope=%d", rset->scope, got_scope);

@@ -404,7 +405,7 @@ int rset_default_forward(RSFD rfd, void *buf, TERMID *term,
        assert (rset->control->f_forward != rset_default_forward);
        return rset->control->f_forward(rfd, buf, term, untilbuf);
     }
        assert (rset->control->f_forward != rset_default_forward);
        return rset->control->f_forward(rfd, buf, term, untilbuf);
     }

-    
+

     while ((more = rset_read(rfd, buf, term)) > 0)
     {
        if ((rfd->rset->keycontrol->cmp)(untilbuf, buf) < rset->scope)
     while ((more = rset_read(rfd, buf, term)) > 0)
     {
        if ((rfd->rset->keycontrol->cmp)(untilbuf, buf) < rset->scope)

@@ -413,7 +414,7 @@ int rset_default_forward(RSFD rfd, void *buf, TERMID *term,
     if (log_level)
        yaz_log(log_level, "rset_default_forward exiting rfd=%p scope=%d m=%d c=%d",
                rfd, rset->scope, more, rset->scope);
     if (log_level)
        yaz_log(log_level, "rset_default_forward exiting rfd=%p scope=%d m=%d c=%d",
                rfd, rset->scope, more, rset->scope);

-    
+

     return more;
 }
 
     return more;
 }
 

@@ -427,6 +428,12 @@ void rset_visit(RSET rset, int level)
        rset_visit(rset->children[i], level+1);
 }
 
        rset_visit(rset->children[i], level+1);
 }
 

+int rset_no_write(RSFD rfd, const void *buf)
+{
+    yaz_log(YLOG_FATAL, "%s set type is read-only", rfd->rset->control->desc);
+    return -1;
+}
+

 /*
  * Local variables:
  * c-basic-offset: 4
 /*
  * Local variables:
  * c-basic-offset: 4