Updated LICENSE and CHANGELOG.

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

diff --git a/include/recctrl.h b/include/recctrl.h
index 4736bd8..c1f4392 100644 (file)
--- a/include/recctrl.h
+++ b/include/recctrl.h
@@ -1,10 +1,28 @@
 /*
- * Copyright (C) 1994-1998, Index Data I/S 
+ * Copyright (C) 1994-1998, Index Data
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: recctrl.h,v $
- * Revision 1.26  1998-05-20 10:12:12  adam
+ * Revision 1.32  1999-11-30 13:48:03  adam
+ * Improved installation. Updated for inclusion of YAZ header files.
+ *
+ * Revision 1.31  1999/09/07 07:19:21  adam
+ * Work on character mapping. Implemented replace rules.
+ *
+ * Revision 1.30  1999/05/21 12:00:17  adam
+ * Better diagnostics for extraction process.
+ *
+ * Revision 1.29  1999/05/20 12:57:18  adam
+ * Implemented TCL filter. Updated recctrl system.
+ *
+ * Revision 1.28  1999/03/02 16:15:42  quinn
+ * Added "tagsysno" and "tagrank" directives to zebra.cfg.
+ *
+ * Revision 1.27  1998/10/16 08:14:28  adam
+ * Updated record control system.
+ *
+ * Revision 1.26  1998/05/20 10:12:12  adam
  * Implemented automatic EXPLAIN database maintenance.
  * Modified Zebra to work with ASN.1 compiled version of YAZ.
  *
@@ -100,10 +118,10 @@
 #ifndef RECCTRL_H
 #define RECCTRL_H
 
-#include <proto.h>
-#include <oid.h>
-#include <odr.h>
-#include <data1.h>
+#include <yaz/proto.h>
+#include <yaz/oid.h>
+#include <yaz/odr.h>
+#include <yaz/data1.h>
 #include <zebramap.h>
 
 #ifdef __cplusplus
@@ -119,6 +137,7 @@ typedef struct {
     int  length;
     int  *seqnos;
     ZebraMaps zebra_maps;
+    struct recExtractCtrl *extractCtrl;
 } RecWord;
 
 /* Extract record control */
@@ -131,17 +150,19 @@ struct recExtractCtrl {
     off_t     offset;                            /* start offset           */
     char      *subType;
     void      (*init)(struct recExtractCtrl *p, RecWord *w);
-    void      (*addWord)(RecWord *p);
+    void      *clientData;
+    void      (*tokenAdd)(RecWord *w);
     ZebraMaps zebra_maps;
     int       flagShowRecords;
     int       seqno[256];
-    void      (*addSchema)(struct recExtractCtrl *p, Odr_oid *oid);
+    void      (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
     data1_handle dh;
 };
 
 /* Retrieve record control */
 struct recRetrieveCtrl {
     /* 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);
@@ -163,15 +184,31 @@ struct recRetrieveCtrl {
     char *message;
 };
 
-typedef struct recType
+typedef struct recType *RecType;
+
+struct recType
 {
-    char *name;                       /* Name of record type */
-    void (*init)(void);               /* Init function - called once       */
-    int  (*extract)(struct recExtractCtrl *ctrl);     /* Extract proc      */
-    int  (*retrieve)(struct recRetrieveCtrl *ctrl);   /* Retrieve proc     */
-} *RecType;
+    char *name;                           /* Name of record type */
+    void *(*init)(RecType recType);       /* Init function - called once */
+    void (*destroy)(void *clientData);    /* Destroy function */
+    int  (*extract)(void *clientData,
+                   struct recExtractCtrl *ctrl);   /* Extract proc */
+    int  (*retrieve)(void *clientData,
+                    struct recRetrieveCtrl *ctrl); /* Retrieve proc */
+};
+
+#define RECCTRL_EXTRACT_OK    0
+#define RECCTRL_EXTRACT_EOF   1
+#define RECCTRL_EXTRACT_ERROR 2
+
+typedef struct recTypes *RecTypes;
+
+RecTypes recTypes_init (data1_handle dh);
+void recTypes_destroy (RecTypes recTypes);
+void recTypes_default_handlers (RecTypes recTypes);
 
-RecType recType_byName (const char *name, char *subType);
+RecType recType_byName (RecTypes rts, const char *name, char *subType,
+                       void **clientDataP);
 
 int grs_extract_tree(struct recExtractCtrl *p, data1_node *n);