New element, max_blocks_mem, that control how many blocks of max size
[idzebra-moved-to-github.git] / include / recctrl.h
index 45ae761..adc12c4 100644 (file)
@@ -1,10 +1,29 @@
 /*
- * Copyright (C) 1994-1995, Index Data I/S 
+ * Copyright (C) 1994-1996, Index Data I/S 
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: recctrl.h,v $
- * Revision 1.11  1995-12-04 14:20:54  adam
+ * Revision 1.16  1996-10-11 10:56:25  adam
+ * New module recctrl. Used to manage records (extract/retrieval).
+ * All record types are accessed by means of definitions in recctrl.h.
+ *
+ * Revision 1.15  1996/06/06 12:08:16  quinn
+ * Added showRecord Group entry
+ *
+ * Revision 1.14  1996/05/09  07:28:49  quinn
+ * Work towards phrases and multiple registers
+ *
+ * Revision 1.13  1996/05/01  13:44:05  adam
+ * Added seek function to the recExtractCtrl and recRetrieveCtrl control
+ * structures. Added end-of-file indicator function and start offset to
+ * recExtractCtrl.
+ *
+ * Revision 1.12  1996/01/17  15:01:25  adam
+ * Prototype changed for reader functions in extract/retrieve. File
+ *  is identified by 'void *' instead of 'int'.
+ *
+ * Revision 1.11  1995/12/04  14:20:54  adam
  * Extra arg to recType_byName.
  *
  * Revision 1.10  1995/10/16  14:03:06  quinn
@@ -53,6 +72,7 @@ typedef struct {
     int  attrUse;
     enum {
        Word_String,
+       Word_Phrase,
         Word_Numeric
     } which;
     union {
@@ -64,23 +84,29 @@ typedef struct {
 
 /* Extract record control */
 struct recExtractCtrl {
-    int       fd;                     /* File descriptor and read function */
-    int       (*readf)(int fd, char *buf, size_t count);
+    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          */
+    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);
+    char **(*map_chrs_input)(char **from, int len);
+    int       flagShowRecords;
 };
 
 /* Retrieve record control */
 struct recRetrieveCtrl {
     /* Input parameters ... */
-    ODR       odr;                    /* ODR used to create response */
-    int       fd;                     /* File descriptor and read function */
-    int       (*readf)(int fd, char *buf, size_t count);
-    oid_value input_format;           /* Preferred record syntax */
-    Z_RecordComposition *comp;         /* formatting instructions */
-    int       localno;                /* local id of record */
-    int       score;                  /* score 0-1000 or -1 if none */
+    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);
+    oid_value input_format;           /* Preferred record syntax           */
+    Z_RecordComposition *comp;        /* formatting instructions           */
+    int       localno;                /* local id of record                */
+    int       score;                  /* score 0-1000 or -1 if none        */
     char      *subType;
     
     /* response */
@@ -93,10 +119,10 @@ struct recRetrieveCtrl {
 
 typedef 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 */
+    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;
 
 RecType recType_byName (const char *name, char *subType);