Added a comment, cleaned whitespace
[idzebra-moved-to-github.git] / rset / rsbool.c
index d77d259..aa6e280 100644 (file)
-/*
- * Copyright (C) 1994-1995, Index Data I/S 
- * All rights reserved.
- * Sebastian Hammer, Adam Dickmeiss
- *
- * $Log: rsbool.c,v $
- * Revision 1.8  1995-10-12 12:41:55  adam
- * Private info (buf) moved from struct rset_control to struct rset.
- * Bug fixes in relevance.
- *
- * Revision 1.7  1995/10/10  14:00:03  adam
- * Function rset_open changed its wflag parameter to general flags.
- *
- * Revision 1.6  1995/10/06  14:38:05  adam
- * New result set method: r_score.
- * Local no (sysno) and score is transferred to retrieveCtrl.
- *
- * Revision 1.5  1995/09/08  14:52:41  adam
- * Work on relevance feedback.
- *
- * Revision 1.4  1995/09/08  08:54:04  adam
- * More efficient and operation.
- *
- * Revision 1.3  1995/09/07  13:58:43  adam
- * New parameter: result-set file descriptor (RSFD) to support multiple
- * positions within the same result-set.
- * Boolean operators: and, or, not implemented.
- *
- * Revision 1.2  1995/09/06  16:11:55  adam
- * More work on boolean sets.
- *
- * Revision 1.1  1995/09/06  13:27:15  adam
- * New set type: bool. Not finished yet.
- *
- */
+/* $Id: rsbool.c,v 1.24 2004-01-30 11:43:41 heikki Exp $
+   Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003
+   Index Data Aps
+
+This file is part of the Zebra server.
+
+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
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with Zebra; see the file LICENSE.zebra.  If not, write to the
+Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA.
+*/
+
+
 
 #include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
 #include <assert.h>
 
 #include <rsbool.h>
-#include <alexutil.h>
+#include <zebrautl.h>
+
+#include <../index/index.h> /* for log_keydump. Debugging only */
+
 
-static void *r_create(const struct rset_control *sel, void *parms);
+static void *r_create(RSET ct, const struct rset_control *sel, void *parms);
 static RSFD r_open (RSET ct, int flag);
 static void r_close (RSFD rfd);
 static void r_delete (RSET ct);
 static void r_rewind (RSFD rfd);
+static int r_forward(RSET ct, RSFD rfd, void *buf, int *term_index,
+                     int (*cmpfunc)(const void *p1, const void *p2),
+                     const void *untilbuf);
 static int r_count (RSET ct);
-static int r_read_and (RSFD rfd, void *buf);
-static int r_read_or (RSFD rfd, void *buf);
-static int r_read_not (RSFD rfd, void *buf);
+static int r_read_and (RSFD rfd, void *buf, int *term_index);
+static int r_read_or (RSFD rfd, void *buf, int *term_index);
+static int r_read_not (RSFD rfd, void *buf, int *term_index);
 static int r_write (RSFD rfd, const void *buf);
-static int r_score (RSFD rfd, int *score);
 
-static const rset_control control_and = 
+static const struct rset_control control_and = 
 {
-    "AND set type",
+    "and",
     r_create,
     r_open,
     r_close,
     r_delete,
     r_rewind,
+    r_forward, /*rset_default_forward,*/
     r_count,
     r_read_and,
     r_write,
-    r_score
 };
 
-static const rset_control control_or = 
+static const struct rset_control control_or = 
 {
-    "OR set type",
+    "or",
     r_create,
     r_open,
     r_close,
     r_delete,
     r_rewind,
+#if 1
+    r_forward, 
+#else
+    rset_default_forward,
+#endif
     r_count,
     r_read_or,
     r_write,
-    r_score
 };
 
-static const rset_control control_not = 
+static const struct rset_control control_not = 
 {
-    "NOT set type",
+    "not",
     r_create,
     r_open,
     r_close,
     r_delete,
     r_rewind,
+    r_forward, 
     r_count,
     r_read_not,
     r_write,
-    r_score
 };
 
 
-const rset_control *rset_kind_and = &control_and;
-const rset_control *rset_kind_or = &control_or;
-const rset_control *rset_kind_not = &control_not;
+const struct rset_control *rset_kind_and = &control_and;
+const struct rset_control *rset_kind_or = &control_or;
+const struct rset_control *rset_kind_not = &control_not;
 
 struct rset_bool_info {
     int key_size;
     RSET rset_l;
     RSET rset_r;
+    int term_index_s;
     int (*cmp)(const void *p1, const void *p2);
     struct rset_bool_rfd *rfd_list;
 };
@@ -112,29 +112,46 @@ struct rset_bool_rfd {
     RSFD rfd_r;
     int  more_l;
     int  more_r;
+    int term_index_l;
+    int term_index_r;
     void *buf_l;
     void *buf_r;
+    int tail;
     struct rset_bool_rfd *next;
     struct rset_bool_info *info;
 };    
 
-static void *r_create (const struct rset_control *sel, void *parms)
+static void *r_create (RSET ct, const struct rset_control *sel, void *parms)
 {
-    rset_bool_parms *bool_parms = parms;
+    rset_bool_parms *bool_parms = (rset_bool_parms *) parms;
     struct rset_bool_info *info;
 
-    info = xmalloc (sizeof(struct rset_bool_info));
+    info = (struct rset_bool_info *) xmalloc (sizeof(*info));
     info->key_size = bool_parms->key_size;
     info->rset_l = bool_parms->rset_l;
     info->rset_r = bool_parms->rset_r;
+    if (rset_is_volatile(info->rset_l) || rset_is_volatile(info->rset_r))
+        ct->flags |= RSET_FLAG_VOLATILE;
     info->cmp = bool_parms->cmp;
     info->rfd_list = NULL;
+    
+    info->term_index_s = info->rset_l->no_rset_terms;
+    ct->no_rset_terms =
+       info->rset_l->no_rset_terms + info->rset_r->no_rset_terms;
+    ct->rset_terms = (RSET_TERM *)
+       xmalloc (sizeof (*ct->rset_terms) * ct->no_rset_terms);
+
+    memcpy (ct->rset_terms, info->rset_l->rset_terms,
+           info->rset_l->no_rset_terms * sizeof(*ct->rset_terms));
+    memcpy (ct->rset_terms + info->rset_l->no_rset_terms,
+           info->rset_r->rset_terms,
+           info->rset_r->no_rset_terms * sizeof(*ct->rset_terms));
     return info;
 }
 
 static RSFD r_open (RSET ct, int flag)
 {
-    struct rset_bool_info *info = ct->buf;
+    struct rset_bool_info *info = (struct rset_bool_info *) ct->buf;
     struct rset_bool_rfd *rfd;
 
     if (flag & RSETF_WRITE)
@@ -142,18 +159,20 @@ static RSFD r_open (RSET ct, int flag)
        logf (LOG_FATAL, "bool set type is read-only");
        return NULL;
     }
-    flag = 0;
-    rfd = xmalloc (sizeof(*rfd));
+    rfd = (struct rset_bool_rfd *) xmalloc (sizeof(*rfd));
     rfd->next = info->rfd_list;
     info->rfd_list = rfd;
+    rfd->info = info;
 
     rfd->buf_l = xmalloc (info->key_size);
     rfd->buf_r = xmalloc (info->key_size);
-    rfd->rfd_l = rset_open (info->rset_l, flag);
-    rfd->rfd_r = rset_open (info->rset_r, flag);
-    rfd->more_l = rset_read (info->rset_l, rfd->rfd_l, rfd->buf_l);
-    rfd->more_r = rset_read (info->rset_r, rfd->rfd_r, rfd->buf_r);
-    rfd->info = info;
+    rfd->rfd_l = rset_open (info->rset_l, RSETF_READ);
+    rfd->rfd_r = rset_open (info->rset_r, RSETF_READ);
+    rfd->more_l = rset_read (info->rset_l, rfd->rfd_l, rfd->buf_l,
+                            &rfd->term_index_l);
+    rfd->more_r = rset_read (info->rset_r, rfd->rfd_r, rfd->buf_r,
+                            &rfd->term_index_r);
+    rfd->tail = 0;
     return rfd;
 }
 
@@ -170,7 +189,7 @@ static void r_close (RSFD rfd)
             rset_close (info->rset_l, (*rfdp)->rfd_l);
             rset_close (info->rset_r, (*rfdp)->rfd_r);
             *rfdp = (*rfdp)->next;
-            free (rfd);
+            xfree (rfd);
             return;
         }
     logf (LOG_FATAL, "r_close but no rfd match!");
@@ -179,22 +198,59 @@ static void r_close (RSFD rfd)
 
 static void r_delete (RSET ct)
 {
-    struct rset_bool_info *info = ct->buf;
+    struct rset_bool_info *info = (struct rset_bool_info *) ct->buf;
 
     assert (info->rfd_list == NULL);
+    xfree (ct->rset_terms);
+    rset_delete (info->rset_l);
+    rset_delete (info->rset_r);
     xfree (info);
 }
 
 static void r_rewind (RSFD rfd)
 {
     struct rset_bool_info *info = ((struct rset_bool_rfd*)rfd)->info;
-    struct rset_bool_rfd *p = rfd;
+    struct rset_bool_rfd *p = (struct rset_bool_rfd *) rfd;
 
     logf (LOG_DEBUG, "rsbool_rewind");
     rset_rewind (info->rset_l, p->rfd_l);
     rset_rewind (info->rset_r, p->rfd_r);
-    p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
-    p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
+    p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l, &p->term_index_l);
+    p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r, &p->term_index_r);
+}
+
+static int r_forward(RSET ct, RSFD rfd, void *buf, int *term_index,
+                     int (*cmpfunc)(const void *p1, const void *p2),
+                     const void *untilbuf)
+{
+    struct rset_bool_info *info = ((struct rset_bool_rfd*)rfd)->info;
+    struct rset_bool_rfd *p = (struct rset_bool_rfd *) rfd;
+    int cmp=0;
+
+    logf (LOG_DEBUG, "rsbool_forward '%s' (ct=%p rfd=%p m=%d,%d)",
+                      ct->control->desc, ct, rfd, p->more_l, p->more_r);
+    if ( p->more_l)
+        p->more_l = rset_forward(info->rset_l, p->rfd_l, p->buf_l,
+                        &p->term_index_l, info->cmp, untilbuf);
+    if ( p->more_r)
+        p->more_r = rset_forward(info->rset_r, p->rfd_r, p->buf_r,
+                        &p->term_index_r, info->cmp, untilbuf);
+    if (p->more_l && p->more_r)
+           cmp = (*info->cmp)(p->buf_l, p->buf_r);
+       else if (p->more_l)
+           cmp = -2;
+       else
+           cmp = 2;
+    if ( (cmp<0) && (p->more_l) )
+    {
+        memcpy (buf, p->buf_l, info->key_size);
+           *term_index = p->term_index_l;
+    } else if ( (cmp>0) && (p->more_r) )
+    {
+        memcpy (buf, p->buf_r, info->key_size);
+           *term_index = p->term_index_r + info->term_index_s;
+    }
+    return ( p->more_l || p->more_r);
 }
 
 static int r_count (RSET ct)
@@ -202,46 +258,175 @@ static int r_count (RSET ct)
     return 0;
 }
 
-static int r_read_and (RSFD rfd, void *buf)
+
+/*
+    1,1         1,3
+    1,9         2,1
+    1,11        3,1
+    2,9
+
+  1,1     1,1
+  1,3     1,3
+          1,9
+          1,11
+  2,1     2,1
+          2,9
+          3,1
+*/
+
+static int r_read_and (RSFD rfd, void *buf, int *term_index)
 {
-    struct rset_bool_rfd *p = rfd;
+    struct rset_bool_rfd *p = (struct rset_bool_rfd *) rfd;
     struct rset_bool_info *info = p->info;
 
-    while (p->more_l && p->more_r)
+    while (p->more_l || p->more_r)
     {
         int cmp;
 
-        cmp = (*info->cmp)(p->buf_l, p->buf_r);
+        if (p->more_l && p->more_r)
+            cmp = (*info->cmp)(p->buf_l, p->buf_r);
+        else if (p->more_l)
+            cmp = -2;
+        else
+            cmp = 2;
+        logf (LOG_DEBUG, "r_read_and looping: m=%d/%d c=%d t=%d",
+                        p->more_l, p->more_r, cmp, p->tail);
+        key_logdump(LOG_DEBUG,p->buf_l);
+        key_logdump(LOG_DEBUG,p->buf_r);
         if (!cmp)
         {
             memcpy (buf, p->buf_l, info->key_size);
-            p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
-            p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
-            return 1;
+               *term_index = p->term_index_l;
+            p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l,
+                                  &p->term_index_l);
+            p->tail = 1;
         }
         else if (cmp == 1)
         {
             memcpy (buf, p->buf_r, info->key_size);
-            p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
+               *term_index = p->term_index_r + info->term_index_s;
+            p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r,
+                                  &p->term_index_r);
+            p->tail = 1;
+            logf (LOG_DEBUG, "r_read_and returning A m=%d/%d c=%d",
+                    p->more_l, p->more_r, cmp);
+            key_logdump(LOG_DEBUG,buf);
             return 1;
         }
         else if (cmp == -1)
         {
             memcpy (buf, p->buf_l, info->key_size);
-            p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
+               *term_index = p->term_index_l;
+            p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l,
+                                  &p->term_index_l);
+            p->tail = 1;
+            logf (LOG_DEBUG, "r_read_and returning B m=%d/%d c=%d",
+                    p->more_l, p->more_r, cmp);
+            key_logdump(LOG_DEBUG,buf);
             return 1;
         }
         else if (cmp > 1)
-            p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
+        {
+#define OLDCODE 0
+#if OLDCODE
+            memcpy (buf, p->buf_r, info->key_size);
+            *term_index = p->term_index_r + info->term_index_s;
+            
+            p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r,
+                                   &p->term_index_r);
+            if (p->tail)
+            {
+                if (!p->more_r || (*info->cmp)(p->buf_r, buf) > 1)
+                    p->tail = 0;
+                logf (LOG_DEBUG, "r_read_and returning C m=%d/%d c=%d",
+                        p->more_l, p->more_r, cmp);
+                key_logdump(LOG_DEBUG,buf);
+                return 1;
+            }
+#else
+            
+            if (p->tail)
+            {
+                logf (LOG_DEBUG, "r_read_and returning R tail m=%d/%d c=%d",
+                        p->more_l, p->more_r, cmp);
+                memcpy (buf, p->buf_r, info->key_size);
+                *term_index = p->term_index_r + info->term_index_s;
+                p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r,
+                                   &p->term_index_r);
+                if (!p->more_r || (*info->cmp)(p->buf_r, buf) > 1)
+                    p->tail = 0;
+                logf (LOG_DEBUG, "r_read_and returning D m=%d/%d c=%d",
+                        p->more_l, p->more_r, cmp);
+                key_logdump(LOG_DEBUG,buf);
+                return 1;
+            } else
+            {
+                logf (LOG_DEBUG, "r_read_and about to forward R m=%d/%d c=%d",
+                        p->more_l, p->more_r, cmp);
+                if (p->more_r && p->more_l)
+                    p->more_r = rset_forward( 
+                                    info->rset_r, p->rfd_r, 
+                                    p->buf_r, &p->term_index_r, 
+                                    (info->cmp), p->buf_l);
+                else 
+                    return 0; /* no point in reading further */
+            }
+#endif
+        }
         else
-            p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
+        {
+#if OLDCODE
+             memcpy (buf, p->buf_l, info->key_size);
+             *term_index = p->term_index_l;
+             p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l,
+                                    &p->term_index_l);
+             if (p->tail)
+             {
+                 if (!p->more_l || (*info->cmp)(p->buf_l, buf) > 1)
+                     p->tail = 0;
+                 logf (LOG_DEBUG, "r_read_and returning E m=%d/%d c=%d",
+                        p->more_l, p->more_r, cmp);
+                 key_logdump(LOG_DEBUG,buf);
+                 return 1;
+             }
+#else
+            if (p->tail)
+            {
+                logf (LOG_DEBUG, "r_read_and returning L tail m=%d/%d c=%d",
+                        p->more_l, p->more_r, cmp);
+                memcpy (buf, p->buf_l, info->key_size);
+                   *term_index = p->term_index_l;
+                p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l,
+                                  &p->term_index_l);
+                if (!p->more_l || (*info->cmp)(p->buf_l, buf) > 1)
+                    p->tail = 0;
+                 logf (LOG_DEBUG, "r_read_and returning F m=%d/%d c=%d",
+                        p->more_l, p->more_r, cmp);
+                 key_logdump(LOG_DEBUG,buf);
+                return 1;
+            }
+            else
+            {
+                logf (LOG_DEBUG, "r_read_and about to forward L m=%d/%d c=%d",
+                        p->more_l, p->more_r, cmp);
+                if (p->more_r && p->more_l)
+                    p->more_l = rset_forward( 
+                    /* p->more_l = rset_default_forward( */
+                                    info->rset_l, p->rfd_l, 
+                                    p->buf_l, &p->term_index_l, 
+                                    (info->cmp), p->buf_r);
+                else 
+                    return 0; /* no point in reading further */
+            }
+#endif
+        }
     }
     return 0;
 }
 
-static int r_read_or (RSFD rfd, void *buf)
+static int r_read_or (RSFD rfd, void *buf, int *term_index)
 {
-    struct rset_bool_rfd *p = rfd;
+    struct rset_bool_rfd *p = (struct rset_bool_rfd *) rfd;
     struct rset_bool_info *info = p->info;
 
     while (p->more_l || p->more_r)
@@ -257,29 +442,45 @@ static int r_read_or (RSFD rfd, void *buf)
         if (!cmp)
         {
             memcpy (buf, p->buf_l, info->key_size);
-            p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
-            p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
+               *term_index = p->term_index_l;
+            p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l,
+                                  &p->term_index_l);
+            p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r,
+                                  &p->term_index_r);
+            logf (LOG_DEBUG, "r_read_or returning A m=%d/%d c=%d",
+                    p->more_l, p->more_r, cmp);
+            key_logdump(LOG_DEBUG,buf);
             return 1;
         }
         else if (cmp > 0)
         {
             memcpy (buf, p->buf_r, info->key_size);
-            p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
+               *term_index = p->term_index_r + info->term_index_s;
+            p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r,
+                                  &p->term_index_r);
+            logf (LOG_DEBUG, "r_read_or returning B m=%d/%d c=%d",
+                    p->more_l, p->more_r, cmp);
+            key_logdump(LOG_DEBUG,buf);
             return 1;
         }
         else
         {
             memcpy (buf, p->buf_l, info->key_size);
-            p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
+               *term_index = p->term_index_l;
+            p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l,
+                                  &p->term_index_l);
+            logf (LOG_DEBUG, "r_read_or returning C m=%d/%d c=%d",
+                    p->more_l, p->more_r, cmp);
+            key_logdump(LOG_DEBUG,buf);
             return 1;
         }
     }
     return 0;
 }
 
-static int r_read_not (RSFD rfd, void *buf)
+static int r_read_not (RSFD rfd, void *buf, int *term_index)
 {
-    struct rset_bool_rfd *p = rfd;
+    struct rset_bool_rfd *p = (struct rset_bool_rfd *) rfd;
     struct rset_bool_info *info = p->info;
 
     while (p->more_l || p->more_r)
@@ -295,24 +496,36 @@ static int r_read_not (RSFD rfd, void *buf)
         if (cmp < -1)
         {
             memcpy (buf, p->buf_l, info->key_size);
-            p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
+               *term_index = p->term_index_l;
+            p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l,
+                                  &p->term_index_l);
             return 1;
         }
         else if (cmp > 1)
-            p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
+#if 0
+            p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r,
+                                  &p->term_index_r);
+#else
+            p->more_r = rset_forward( 
+                            info->rset_r, p->rfd_r, 
+                            p->buf_r, &p->term_index_r, 
+                            (info->cmp), p->buf_l);
+#endif
         else
         {
             memcpy (buf, p->buf_l, info->key_size);
             do
             {
-                p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
+                p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l,
+                                      &p->term_index_l);
                 if (!p->more_l)
                     break;
                 cmp = (*info->cmp)(p->buf_l, buf);
             } while (cmp >= -1 && cmp <= 1);
             do
             {
-                p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
+                p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r,
+                                      &p->term_index_r);
                 if (!p->more_r)
                     break;
                 cmp = (*info->cmp)(p->buf_r, buf);
@@ -329,9 +542,3 @@ static int r_write (RSFD rfd, const void *buf)
     return -1;
 }
 
-static int r_score (RSFD rfd, int *score)
-{
-    *score = -1;
-    return -1;
-}
-