Common stream reader interface for record filters (struct ZebraRecStream).

[idzebra-moved-to-github.git] / include / idzebra / recctrl.h

diff --git a/include/idzebra/recctrl.h b/include/idzebra/recctrl.h
index 6b4bb9e..4a8f384 100644 (file)
--- a/include/idzebra/recctrl.h
+++ b/include/idzebra/recctrl.h
@@ -1,4 +1,4 @@
-/* $Id: recctrl.h,v 1.22 2006-06-07 10:50:08 adam Exp $
+/* $Id: recctrl.h,v 1.29 2006-08-22 13:39:25 adam Exp $
    Copyright (C) 1995-2006
    Index Data ApS
 
@@ -15,9 +15,9 @@ 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.
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
 */
 
 #ifndef IDZEBRA_RECCTRL_H
@@ -30,7 +30,6 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #include <idzebra/res.h>
 #include <idzebra/data1.h>
 #include <idzebra/snippet.h>
-#include <idzebra/zebramap.h>
 
 YAZ_BEGIN_CDECL
 
@@ -49,32 +48,50 @@ YAZ_BEGIN_CDECL
 /* 1015 */
 #define ZEBRA_XPATH_ATTR_CDATA      "_XPATH_ATTR_CDATA"
 
-/* single word entity */
+/** Indexing token */
 typedef struct {
+    /** index type ('w', 'p', .. */
     unsigned index_type;
+    /** index name, e.g. "title" */
     const char *index_name;
+    /** token char data */
     const char *term_buf;
+    /** length of term_buf */
     int  term_len;
+    /** sequence number */
     zint seqno;
+    /** segment number */
+    zint segment;
+    /** record ID */
     zint record_id;
+    /** section ID */
     zint section_id;
-    ZebraMaps zebra_maps;
     struct recExtractCtrl *extractCtrl;
 } RecWord;
 
-/* Extract record control */
+/** \brief record reader stream */
+struct ZebraRecStream {
+    /** client data */
+    void      *fh;    
+    /** \brief read function */
+    int       (*readf)(struct ZebraRecStream *s, char *buf, size_t count);
+    /** \brief seek function */
+    off_t     (*seekf)(struct ZebraRecStream *s, off_t offset);
+    /** \brief tell function */
+    off_t     (*tellf)(struct ZebraRecStream *s);              
+    /** \brief set and get of record position */
+    off_t     (*endf)(struct ZebraRecStream *s, off_t *offset);   
+    /** \brief close and destroy stream */
+    void      (*destroy)(struct ZebraRecStream *s);
+};
+
+/** \brief record extract for indexing */
 struct recExtractCtrl {
-    void      *fh;                    /* File handle and read function     */
-    int       (*readf)(void *fh, char *buf, size_t count);
-    off_t     (*seekf)(void *fh, off_t offset);  /* seek function          */
-    off_t     (*tellf)(void *fh);                /* tell function          */
-    void      (*endf)(void *fh, off_t offset);   /* end of record position */
-    off_t     offset;                            /* start offset           */
+    struct ZebraRecStream *stream;
     void      (*init)(struct recExtractCtrl *p, RecWord *w);
     void      *clientData;
     void      (*tokenAdd)(RecWord *w);
     void      (*setStoreData)(struct recExtractCtrl *p, void *buf, size_t size);
-    ZebraMaps zebra_maps;
     int       first_record;
     int       flagShowRecords;
     int       seqno[256];
@@ -87,13 +104,10 @@ struct recExtractCtrl {
 
 /* Retrieve record control */
 struct recRetrieveCtrl {
+    struct ZebraRecStream *stream;
     /* Input parameters ... */
     Res       res;                   /* Resource pool                     */
     ODR       odr;                    /* ODR used to create response       */
-    void     *fh;                     /* File descriptor and read function */
-    int       (*readf)(void *fh, char *buf, size_t count);
-    off_t     (*seekf)(void *fh, off_t offset);
-    off_t     (*tellf)(void *fh);
     oid_value input_format;           /* Preferred record syntax           */
     Z_RecordComposition *comp;        /* formatting instructions           */
     char      *encoding;              /* preferred character encoding      */
@@ -168,7 +182,6 @@ YAZ_EXPORT
 RecType recType_byName(RecTypes rts, Res res, const char *name,
                       void **clientDataP);
 
-
 YAZ_END_CDECL
 
 #endif