/*
* IR toolkit for tcl/tk
- * (c) Index Data 1995
+ * (c) Index Data 1995-2002
+ * See the file LICENSE for details.
* Sebastian Hammer, Adam Dickmeiss
*
* $Log: ir-tclp.h,v $
- * Revision 1.1 1995-05-23 15:34:49 adam
+ * Revision 1.41 2005-03-10 14:05:08 adam
+ * Define USE_NON_CONST to avoid bad warnings for const for Tcl 8.4
+ * or later.
+ *
+ * Revision 1.40 2002/03/20 14:48:54 adam
+ * implemented USR.1 SearchResult-1
+ *
+ * Revision 1.39 1999/11/30 14:05:58 adam
+ * Updated for new location of YAZ headers.
+ *
+ * Revision 1.38 1999/03/22 06:51:34 adam
+ * Implemented sort.
+ *
+ * Revision 1.37 1998/04/02 14:31:08 adam
+ * This version works with compiled ASN.1 code.
+ *
+ * Revision 1.36 1997/11/19 11:22:09 adam
+ * Object identifiers can be accessed in GRS-1 records.
+ *
+ * Revision 1.35 1997/09/09 10:19:54 adam
+ * New MSV5.0 port with fewer warnings.
+ *
+ * Revision 1.34 1996/08/16 15:07:47 adam
+ * First work on Explain.
+ *
+ * Revision 1.33 1996/07/03 13:31:13 adam
+ * The xmalloc/xfree functions from YAZ are used to manage memory.
+ *
+ * Revision 1.32 1996/03/20 13:54:05 adam
+ * The Tcl_File structure is only manipulated in the Tk-event interface
+ * in tkinit.c.
+ *
+ * Revision 1.31 1996/03/05 09:21:19 adam
+ * Bug fix: memory used by GRS records wasn't freed.
+ * Rewrote some of the error handling code - the connection is always
+ * closed before failback is called.
+ * If failback is defined the send APDU methods (init, search, ...) will
+ * return OK but invoke failback (as is the case if the write operation
+ * fails).
+ * Bug fix: ref_count in assoc object could grow if fraction of PDU was
+ * read.
+ *
+ * Revision 1.30 1996/02/29 15:30:23 adam
+ * Export of IrTcl functionality to extensions.
+ *
+ * Revision 1.29 1996/02/26 18:38:33 adam
+ * Work on export of set methods.
+ *
+ * Revision 1.28 1996/02/23 17:31:41 adam
+ * More functions made available to the wais tcl extension.
+ *
+ * Revision 1.27 1996/02/23 13:41:41 adam
+ * Work on public access to simple ir class system.
+ *
+ * Revision 1.26 1996/02/21 10:16:20 adam
+ * Simplified select handling. Only one function ir_tcl_select_set has
+ * to be externally defined.
+ *
+ * Revision 1.25 1996/02/05 17:58:04 adam
+ * Ported ir-tcl to use the beta releases of tcl7.5/tk4.1.
+ *
+ * Revision 1.24 1996/01/29 11:35:27 adam
+ * Bug fix: cs_type member renamed to comstackType to avoid conflict with
+ * cs_type macro defined by YAZ.
+ *
+ * Revision 1.23 1996/01/19 16:22:40 adam
+ * New method: apduDump - returns information about last incoming APDU.
+ *
+ * Revision 1.22 1996/01/10 09:18:44 adam
+ * PDU specific callbacks implemented: initRespnse, searchResponse,
+ * presentResponse and scanResponse.
+ * Bug fix in the command line shell (tclmain.c) - discovered on OSF/1.
+ *
+ * Revision 1.21 1996/01/04 16:12:14 adam
+ * Setting PDUType renamed to eventType.
+ *
+ * Revision 1.20 1996/01/04 11:05:23 adam
+ * New setting: PDUType - returns type of last PDU returned from the target.
+ * Fixed a bug in configure/Makefile.
+ *
+ * Revision 1.19 1995/11/13 09:55:46 adam
+ * Multiple records at a position in a result-set with differnt
+ * element specs.
+ *
+ * Revision 1.18 1995/10/18 16:42:44 adam
+ * New settings: smallSetElementSetNames and mediumSetElementSetNames.
+ *
+ * Revision 1.17 1995/10/16 17:00:56 adam
+ * New setting: elementSetNames.
+ * Various client improvements. Medium presentation format looks better.
+ *
+ * Revision 1.16 1995/09/20 11:37:01 adam
+ * Configure searches for tk4.1 and tk7.5.
+ * Work on GRS.
+ *
+ * Revision 1.15 1995/08/29 15:30:15 adam
+ * Work on GRS records.
+ *
+ * Revision 1.14 1995/08/04 11:32:40 adam
+ * More work on output queue. Memory related routines moved
+ * to mem.c
+ *
+ * Revision 1.13 1995/08/03 13:23:00 adam
+ * Request queue.
+ *
+ * Revision 1.12 1995/07/28 10:28:38 adam
+ * First work on request queue.
+ *
+ * Revision 1.11 1995/06/20 08:07:35 adam
+ * New setting: failInfo.
+ * Working on better cancel mechanism.
+ *
+ * Revision 1.10 1995/06/16 12:28:20 adam
+ * Implemented preferredRecordSyntax.
+ * Minor changes in diagnostic handling.
+ * Record list deleted when connection closes.
+ *
+ * Revision 1.9 1995/06/14 15:08:01 adam
+ * Bug fix in cascade-target-list. Uses yaz-version.h.
+ *
+ * Revision 1.8 1995/06/14 13:37:18 adam
+ * Setting recordType implemented.
+ * Setting implementationVersion implemented.
+ * Settings implementationId / implementationName edited.
+ *
+ * Revision 1.7 1995/06/01 07:31:28 adam
+ * Rename of many typedefs -> IrTcl_...
+ *
+ * Revision 1.6 1995/05/31 08:36:40 adam
+ * Bug fix in client.tcl: didn't save options on clientrc.tcl.
+ * New method: referenceId. More work on scan.
+ *
+ * Revision 1.5 1995/05/29 08:44:25 adam
+ * Work on delete of objects.
+ *
+ * Revision 1.4 1995/05/26 11:44:10 adam
+ * Bugs fixed. More work on MARC utilities and queries. Test
+ * client is up-to-date again.
+ *
+ * Revision 1.3 1995/05/26 08:54:17 adam
+ * New MARC utilities. Uses prefix query.
+ *
+ * Revision 1.2 1995/05/24 14:10:23 adam
+ * Work on idAuthentication, protocolVersion and options.
+ *
+ * Revision 1.1 1995/05/23 15:34:49 adam
* Many new settings, userInformationField, smallSetUpperBound, etc.
* A number of settings are inherited when ir-set is executed.
* This version is incompatible with the graphical test client (client.tcl).
#ifndef IR_TCLP_H
#define IR_TCLP_H
+/* to avoid Tcl8.4 or newer to use const */
+#define USE_NON_CONST
#include <tcl.h>
-#include <yaz-ccl.h>
-#include <iso2709.h>
-#include <comstack.h>
-#include <tcpip.h>
+#include <yaz/log.h>
+#include <yaz/pquery.h>
+#if CCL2RPN
+#include <yaz/yaz-ccl.h>
+#endif
+
+#include <yaz/comstack.h>
+#include <yaz/tcpip.h>
#if MOSI
-#include <xmosi.h>
+#include <yas/xmosi.h>
#endif
-#include <odr.h>
-#include <proto.h>
-#include <oid.h>
-#include <diagbib1.h>
+#include <yaz/yaz-version.h>
+#include <yaz/odr.h>
+#include <yaz/proto.h>
+#include <yaz/oid.h>
+#include <yaz/diagbib1.h>
+#include <yaz/xmalloc.h>
#include "ir-tcl.h"
typedef struct {
+ char *name;
+ int (*method) (void *obj, Tcl_Interp *interp, int argc, char **argv);
+ char *desc;
+} IrTcl_Method;
+
+typedef struct {
+ void *obj;
+ IrTcl_Method *tab;
+} IrTcl_Methods;
+
+typedef struct {
char **databaseNames;
int num_databaseNames;
-
char *queryType;
+ enum oid_value *preferredRecordSyntax;
int replaceIndicator;
+ char *referenceId;
+
+ char *elementSetNames;
+ char *smallSetElementSetNames;
+ char *mediumSetElementSetNames;
int smallSetUpperBound;
int largeSetLowerBound;
int mediumSetPresentNumber;
-} IRSetCObj;
+} IrTcl_SetCObj;
typedef struct {
- char *cs_type;
- char *protocol_type;
- int connectFlag;
+ int ref_count;
+
+ char *comstackType;
+ int protocol_type;
+ int failInfo;
COMSTACK cs_link;
+ int state;
+
int preferredMessageSize;
int maximumRecordSize;
Odr_bitmask options;
Odr_bitmask protocolVersion;
- char *idAuthentication;
+
+ char *idAuthenticationOpen;
+ char *idAuthenticationGroupId;
+ char *idAuthenticationUserId;
+ char *idAuthenticationPassword;
+
char *implementationName;
char *implementationId;
+ char *implementationVersion;
int initResult;
char *targetImplementationName;
char *targetImplementationId;
char *userInformationField;
char *hostname;
+ char *eventType;
- char *buf_out;
- int len_out;
char *buf_in;
int len_in;
- char *sbuf;
- int slen;
ODR odr_in;
ODR odr_out;
ODR odr_pr;
Tcl_Interp *interp;
char *callback;
char *failback;
+ char *initResponse;
+ int apduLen;
+ int apduOffset;
+
+#if CCL2RPN
CCL_bibset bibset;
- oident bib1;
+#endif
+ struct IrTcl_Request_ *request_queue;
+
+ IrTcl_SetCObj set_inher;
+
+} IrTcl_Obj;
+
+typedef struct IrTcl_Request_ {
+ struct IrTcl_Request_ *next;
+
+ char *object_name;
+
+ char *buf_out;
+ int len_out;
+
+ char *callback;
+} IrTcl_Request;
+
+typedef struct {
+ int condition;
+ char *addinfo;
+} IrTcl_Diagnostic;
- struct IRSetObj_ *set_child;
- struct IRScanObj_ *scan_child;
+struct GRS_Record_entry {
+ int tagType;
+ int tagWhich;
+ union {
+ int num;
+ char *str;
+ } tagVal;
+ int dataWhich;
+ union {
+ struct IrTcl_GRS_Record_ *sub;
+ char *str;
+ struct {
+ size_t len;
+ char *buf;
+ } octets;
+ int num;
+ int bool;
+ Odr_oid *oid;
+ } tagData;
+};
- IRSetCObj set_inher;
-} IRObj;
+typedef struct IrTcl_GRS_Record_ {
+ int noTags;
+ struct GRS_Record_entry *entries;
+} IrTcl_GRS_Record;
-typedef struct IRRecordList_ {
+typedef struct IrTcl_RecordList_ {
int no;
+ char *elements;
int which;
union {
struct {
- Iso2709Rec rec;
- } marc;
+ char *buf;
+ size_t size;
+ union {
+ IrTcl_GRS_Record *grs1;
+ } u;
+ int type;
+#if 0
+ enum oid_value type;
+#endif
+ } dbrec;
struct {
- int condition;
- char *addinfo;
- } diag;
+ int num;
+ IrTcl_Diagnostic *list;
+ } surrogateDiagnostics;
} u;
- struct IRRecordList_ *next;
-} IRRecordList;
+ struct IrTcl_RecordList_ *next;
+} IrTcl_RecordList;
-typedef struct IRSetObj_ {
- IRObj *parent;
+typedef struct IrTcl_SetObj_ {
+ IrTcl_Obj *parent;
int searchStatus;
+ int presentStatus;
+ int sortStatus;
int resultCount;
+ int nextResultSetPosition;
int start;
int number;
int numberOfRecordsReturned;
char *setName;
+ char *recordElements;
int recordFlag;
int which;
- int condition;
- char *addinfo;
- IRRecordList *record_list;
- IRSetCObj set_inher;
-} IRSetObj;
+ int nonSurrogateDiagnosticNum;
+ char *searchResponse;
+ char *presentResponse;
+ char *sortResponse;
+ IrTcl_Diagnostic *nonSurrogateDiagnosticList;
+ IrTcl_RecordList *record_list;
+ IrTcl_SetCObj set_inher;
+ int searchResult_num;
+ char **searchResult_terms;
+ int *searchResult_count;
+} IrTcl_SetObj;
-typedef struct IRScanEntry_ {
+typedef struct IrTcl_ScanEntry_ {
int which;
union {
struct {
int globalOccurrences;
} term;
struct {
- int condition;
- char *addinfo;
+ IrTcl_Diagnostic *list;
+ int num;
} diag;
} u;
-} IRScanEntry;
-
-typedef struct IRScanDiag_ {
- int dummy;
-} IRScanDiag;
+} IrTcl_ScanEntry;
-typedef struct IRScanObj_ {
- IRObj *parent;
+typedef struct IrTcl_ScanObj_ {
+ IrTcl_Obj *parent;
int stepSize;
int numberOfTermsRequested;
int preferredPositionInResponse;
int positionOfTerm;
int entries_flag;
+#if 0
int which;
+#endif
int num_entries;
int num_diagRecs;
- IRScanEntry *entries;
- IRScanDiag *nonSurrogateDiagnostics;
-} IRScanObj;
+ char *scanResponse;
+ IrTcl_ScanEntry *entries;
+ IrTcl_Diagnostic *nonSurrogateDiagnosticList;
+ int nonSurrogateDiagnosticNum;
+} IrTcl_ScanObj;
+
+struct ir_named_entry {
+ char *name;
+ int pos;
+};
+
+int ir_tcl_get_marc (Tcl_Interp *interp, const char *buf,
+ int argc, char **argv);
+int ir_tcl_send_APDU (Tcl_Interp *interp, IrTcl_Obj *p, Z_APDU *apdu,
+ const char *msg, const char *object_name);
+int ir_tcl_send_q (IrTcl_Obj *p, IrTcl_Request *rq, const char *msg);
+void ir_tcl_del_q (IrTcl_Obj *p);
+int ir_tcl_strdup (Tcl_Interp *interp, char** p, const char *s);
+int ir_tcl_strdel (Tcl_Interp *interp, char **p);
+
+char *ir_tcl_fread_marc (FILE *inf, size_t *size);
+void ir_tcl_grs_mk (Z_GenericRecord *r, IrTcl_GRS_Record **grs_record);
+void ir_tcl_grs_del (IrTcl_GRS_Record **grs_record);
+int ir_tcl_get_grs (Tcl_Interp *interp, IrTcl_GRS_Record *grs_record,
+ int argc, char **argv);
+
+int ir_tcl_get_explain (Tcl_Interp *interp, Z_ExplainRecord *rec,
+ int argc, char **argv);
+
+int ir_tcl_method (Tcl_Interp *interp, int argc, char **argv,
+ IrTcl_Methods *tab, int *ret);
+int ir_tcl_get_set_int (int *val, Tcl_Interp *interp, int argc, char **argv);
+
+typedef struct {
+ const char *name;
+ int (*ir_init) (ClientData clientData, Tcl_Interp *interp,
+ int argc, char **argv, ClientData *subData,
+ ClientData parentData);
+ int (*ir_method) (ClientData clientData, Tcl_Interp *interp,
+ int argc, char **argv);
+ void (*ir_delete)(ClientData clientData);
+} IrTcl_Class;
+
+extern IrTcl_Class ir_obj_class;
+extern IrTcl_Class ir_set_obj_class;
+
+void ir_select_add (int fd, void *obj);
+void ir_select_add_write (int fd, void *obj);
+void ir_select_remove (int fd, void *obj);
+void ir_select_remove_write (int fd, void *obj);
+
+int ir_tcl_eval (Tcl_Interp *interp, const char *command);
+void ir_tcl_disconnect (IrTcl_Obj *p);
+
+#define IR_TCL_FAIL_CONNECT 1
+#define IR_TCL_FAIL_READ 2
+#define IR_TCL_FAIL_WRITE 3
+#define IR_TCL_FAIL_IN_APDU 4
+#define IR_TCL_FAIL_UNKNOWN_APDU 5
+#define IR_TCL_R_Idle 0
+#define IR_TCL_R_Writing 1
+#define IR_TCL_R_Waiting 2
+#define IR_TCL_R_Reading 3
+#define IR_TCL_R_Connecting 4
#endif
projects / ir-tcl-moved-to-github.git / blobdiff