Better diagnostics for extraction process.

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

diff --git a/include/recctrl.h b/include/recctrl.h
index da9faf8..44d4618 100644 (file)
--- a/include/recctrl.h
+++ b/include/recctrl.h
@@ -1,10 +1,48 @@
 /*
- * Copyright (C) 1994-1997, Index Data I/S 
+ * Copyright (C) 1994-1998, Index Data
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: recctrl.h,v $
- * Revision 1.19  1997-09-05 15:30:02  adam
+ * 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.
+ *
+ * Revision 1.25  1998/03/11 11:19:04  adam
+ * Changed the way sequence numbers are generated.
+ *
+ * Revision 1.24  1998/03/05 08:38:46  adam
+ * New member recordSize in recRetrieveCtrl.
+ *
+ * Revision 1.23  1998/02/10 12:03:05  adam
+ * Implemented Sort.
+ *
+ * Revision 1.22  1997/10/27 14:33:04  adam
+ * Moved towards generic character mapping depending on "structure"
+ * field in abstract syntax file. Fixed a few memory leaks. Fixed
+ * bug with negative integers when doing searches with relational
+ * operators.
+ *
+ * Revision 1.21  1997/09/18 08:59:19  adam
+ * Extra generic handle for the character mapping routines.
+ *
+ * Revision 1.20  1997/09/17 12:19:10  adam
+ * Zebra version corresponds to YAZ version 1.4.
+ * Changed Zebra server so that it doesn't depend on global common_resource.
+ *
+ * Revision 1.19  1997/09/05 15:30:02  adam
  * Changed prototype for chr_map_input - added const.
  * Added support for C++, headers uses extern "C" for public definitions.
  *
@@ -77,34 +115,22 @@
 #include <proto.h>
 #include <oid.h>
 #include <odr.h>
+#include <data1.h>
+#include <zebramap.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-typedef enum {
-    Word_String,
-    Word_Phrase,
-    Word_Numeric
-} RecWordType;
-
 /* single word entity */
 typedef struct {
     int  attrSet;
     int  attrUse;
-    RecWordType which;
-#if 0
-    enum {
-       Word_String,
-       Word_Phrase,
-        Word_Numeric
-    } which;
-#endif
-    union {
-        char *string;
-        int  numeric;
-    } u;
-    int seqno;
+    unsigned reg_type;
+    char *string;
+    int  length;
+    int  *seqnos;
+    ZebraMaps zebra_maps;
 } RecWord;
 
 /* Extract record control */
@@ -116,15 +142,19 @@ struct recExtractCtrl {
     void      (*endf)(void *fh, off_t offset);   /* end of record position */
     off_t     offset;                            /* start offset           */
     char      *subType;
-    void      (*init)(RecWord *p);
-    void      (*add)(const RecWord *p);
-    const char **(*map_chrs_input)(const char **from, int len);
+    void      (*init)(struct recExtractCtrl *p, RecWord *w);
+    void      (*addWord)(RecWord *p);
+    ZebraMaps zebra_maps;
     int       flagShowRecords;
+    int       seqno[256];
+    void      (*addSchema)(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);
@@ -134,7 +164,9 @@ struct recRetrieveCtrl {
     Z_RecordComposition *comp;        /* formatting instructions           */
     int       localno;                /* local id of record                */
     int       score;                  /* score 0-1000 or -1 if none        */
+    int       recordSize;             /* size of record in bytes */
     char      *subType;
+    data1_handle dh;
     
     /* response */
     oid_value  output_format;
@@ -144,15 +176,33 @@ 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 (RecTypes rts, const char *name, char *subType,
+                       void **clientDataP);
 
-RecType recType_byName (const char *name, char *subType);
+int grs_extract_tree(struct recExtractCtrl *p, data1_node *n);
 
 #ifdef __cplusplus
 }