/*
- * Copyright (C) 1994-1995, Index Data I/S
+ * Copyright (C) 1994-1998, Index Data
* All rights reserved.
* Sebastian Hammer, Adam Dickmeiss
*
* $Log: recctrl.h,v $
- * Revision 1.2 1995-09-15 14:45:03 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.
+ *
+ * Revision 1.18 1997/09/04 13:56:15 adam
+ * Added new filter grs.marc.<syntax> where <syntax> refers to
+ * abstract syntax. New method tellf in extract/retrieve control
+ * block.
+ *
+ * Revision 1.17 1997/04/30 08:56:04 quinn
+ * null
+ *
+ * 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
+ * Changes to support element set names and espec1
+ *
+ * Revision 1.9 1995/10/06 14:37:53 adam
+ * New result set method: r_score.
+ * Local no (sysno) and score is transferred to retrieveCtrl.
+ *
+ * Revision 1.8 1995/10/02 15:43:35 adam
+ * Extract uses file descriptors instead of FILE pointers.
+ *
+ * Revision 1.7 1995/10/02 15:18:09 adam
+ * Minor changes.
+ *
+ * Revision 1.6 1995/10/02 15:05:26 quinn
+ * Added a few fields.
+ *
+ * Revision 1.5 1995/10/02 14:55:52 quinn
+ * *** empty log message ***
+ *
+ * Revision 1.4 1995/09/27 16:17:29 adam
+ * More work on retrieve.
+ *
+ * Revision 1.3 1995/09/27 12:21:25 adam
+ * New function: recType_byName.
+ *
+ * Revision 1.2 1995/09/15 14:45:03 adam
* Retrieve control.
*
* Revision 1.1 1995/09/14 07:48:13 adam
#ifndef RECCTRL_H
#define RECCTRL_H
+#include <proto.h>
#include <oid.h>
#include <odr.h>
+#include <data1.h>
+#include <zebramap.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+/* single word entity */
typedef struct {
int attrSet;
int attrUse;
- enum {
- Word_String,
- Word_Numeric
- } which;
- union {
- char *string;
- int numeric;
- } u;
- int seqno;
+ unsigned reg_type;
+ char *string;
+ int length;
+ int *seqnos;
+ ZebraMaps zebra_maps;
} RecWord;
+/* Extract record control */
struct recExtractCtrl {
- FILE *inf;
- char *subType;
- void (*init)(RecWord *p);
- void (*add)(const RecWord *p);
+ 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 */
+ char *subType;
+ 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 {
- ODR odr;
- int fd;
- int (*readf)(int fd, char *buf, size_t count);
- oid_value input_format;
+ /* 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 */
+ 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;
void *rec_buf;
size_t rec_len;
+ int diagnostic;
+ char *message;
};
-typedef struct recType
+typedef struct recType *RecType;
+
+struct recType
{
- char *name;
- void (*init)(void);
- int (*extract)(struct recExtractCtrl *ctrl);
- int (*retrieve)(struct recRetrieveCtrl *ctrl);
-} *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);
+
+int grs_extract_tree(struct recExtractCtrl *p, data1_node *n);
+
+#ifdef __cplusplus
+}
+#endif
#endif
projects / idzebra-moved-to-github.git / blobdiff