X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fidzebra%2Frecctrl.h;h=ac5f448739b3f6a131f74d76f81cc3f77df44d25;hb=21f90a8618faec6bee8d125c12088b74db8eb8b9;hp=c202d8d05744e3e9fefec65029a169f31be2e73a;hpb=c66753469d139c4233a3572edf4b15b0497e0f28;p=idzebra-moved-to-github.git

diff --git a/include/idzebra/recctrl.h b/include/idzebra/recctrl.h
index c202d8d..ac5f448 100644
--- a/include/idzebra/recctrl.h
+++ b/include/idzebra/recctrl.h
@@ -1,5 +1,5 @@
-/* $Id: recctrl.h,v 1.27 2006-08-15 14:28:33 adam Exp $
-   Copyright (C) 1995-2006
+/* $Id: recctrl.h,v 1.32 2007-03-14 11:48:31 adam Exp $
+   Copyright (C) 1995-2007
    Index Data ApS
 
 This file is part of the Zebra server.
@@ -48,26 +48,53 @@ 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;
     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);
+};
+
+enum zebra_recctrl_action_t {
+    action_insert = 1,
+    action_replace,
+    action_delete,
+    action_update  /* insert or replace as needed */
+};
+
+/** \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);
@@ -84,13 +111,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      */
@@ -130,6 +154,7 @@ struct recType
 #define RECCTRL_EXTRACT_EOF   1
 #define RECCTRL_EXTRACT_ERROR_GENERIC 2
 #define RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER 3
+#define RECCTRL_EXTRACT_SKIP  4
 
 typedef struct recTypeClass *RecTypeClass;
 typedef struct recTypes *RecTypes;
@@ -165,9 +190,6 @@ YAZ_EXPORT
 RecType recType_byName(RecTypes rts, Res res, const char *name,
 		       void **clientDataP);
 
-
-#define KEY_SEGMENT_SIZE 1024
-
 YAZ_END_CDECL
 
 #endif