2 * IR toolkit for tcl/tk
4 * See the file LICENSE for details.
5 * Sebastian Hammer, Adam Dickmeiss
8 * Revision 1.35 1997-09-09 10:19:54 adam
9 * New MSV5.0 port with fewer warnings.
11 * Revision 1.34 1996/08/16 15:07:47 adam
12 * First work on Explain.
14 * Revision 1.33 1996/07/03 13:31:13 adam
15 * The xmalloc/xfree functions from YAZ are used to manage memory.
17 * Revision 1.32 1996/03/20 13:54:05 adam
18 * The Tcl_File structure is only manipulated in the Tk-event interface
21 * Revision 1.31 1996/03/05 09:21:19 adam
22 * Bug fix: memory used by GRS records wasn't freed.
23 * Rewrote some of the error handling code - the connection is always
24 * closed before failback is called.
25 * If failback is defined the send APDU methods (init, search, ...) will
26 * return OK but invoke failback (as is the case if the write operation
28 * Bug fix: ref_count in assoc object could grow if fraction of PDU was
31 * Revision 1.30 1996/02/29 15:30:23 adam
32 * Export of IrTcl functionality to extensions.
34 * Revision 1.29 1996/02/26 18:38:33 adam
35 * Work on export of set methods.
37 * Revision 1.28 1996/02/23 17:31:41 adam
38 * More functions made available to the wais tcl extension.
40 * Revision 1.27 1996/02/23 13:41:41 adam
41 * Work on public access to simple ir class system.
43 * Revision 1.26 1996/02/21 10:16:20 adam
44 * Simplified select handling. Only one function ir_tcl_select_set has
45 * to be externally defined.
47 * Revision 1.25 1996/02/05 17:58:04 adam
48 * Ported ir-tcl to use the beta releases of tcl7.5/tk4.1.
50 * Revision 1.24 1996/01/29 11:35:27 adam
51 * Bug fix: cs_type member renamed to comstackType to avoid conflict with
52 * cs_type macro defined by YAZ.
54 * Revision 1.23 1996/01/19 16:22:40 adam
55 * New method: apduDump - returns information about last incoming APDU.
57 * Revision 1.22 1996/01/10 09:18:44 adam
58 * PDU specific callbacks implemented: initRespnse, searchResponse,
59 * presentResponse and scanResponse.
60 * Bug fix in the command line shell (tclmain.c) - discovered on OSF/1.
62 * Revision 1.21 1996/01/04 16:12:14 adam
63 * Setting PDUType renamed to eventType.
65 * Revision 1.20 1996/01/04 11:05:23 adam
66 * New setting: PDUType - returns type of last PDU returned from the target.
67 * Fixed a bug in configure/Makefile.
69 * Revision 1.19 1995/11/13 09:55:46 adam
70 * Multiple records at a position in a result-set with differnt
73 * Revision 1.18 1995/10/18 16:42:44 adam
74 * New settings: smallSetElementSetNames and mediumSetElementSetNames.
76 * Revision 1.17 1995/10/16 17:00:56 adam
77 * New setting: elementSetNames.
78 * Various client improvements. Medium presentation format looks better.
80 * Revision 1.16 1995/09/20 11:37:01 adam
81 * Configure searches for tk4.1 and tk7.5.
84 * Revision 1.15 1995/08/29 15:30:15 adam
85 * Work on GRS records.
87 * Revision 1.14 1995/08/04 11:32:40 adam
88 * More work on output queue. Memory related routines moved
91 * Revision 1.13 1995/08/03 13:23:00 adam
94 * Revision 1.12 1995/07/28 10:28:38 adam
95 * First work on request queue.
97 * Revision 1.11 1995/06/20 08:07:35 adam
98 * New setting: failInfo.
99 * Working on better cancel mechanism.
101 * Revision 1.10 1995/06/16 12:28:20 adam
102 * Implemented preferredRecordSyntax.
103 * Minor changes in diagnostic handling.
104 * Record list deleted when connection closes.
106 * Revision 1.9 1995/06/14 15:08:01 adam
107 * Bug fix in cascade-target-list. Uses yaz-version.h.
109 * Revision 1.8 1995/06/14 13:37:18 adam
110 * Setting recordType implemented.
111 * Setting implementationVersion implemented.
112 * Settings implementationId / implementationName edited.
114 * Revision 1.7 1995/06/01 07:31:28 adam
115 * Rename of many typedefs -> IrTcl_...
117 * Revision 1.6 1995/05/31 08:36:40 adam
118 * Bug fix in client.tcl: didn't save options on clientrc.tcl.
119 * New method: referenceId. More work on scan.
121 * Revision 1.5 1995/05/29 08:44:25 adam
122 * Work on delete of objects.
124 * Revision 1.4 1995/05/26 11:44:10 adam
125 * Bugs fixed. More work on MARC utilities and queries. Test
126 * client is up-to-date again.
128 * Revision 1.3 1995/05/26 08:54:17 adam
129 * New MARC utilities. Uses prefix query.
131 * Revision 1.2 1995/05/24 14:10:23 adam
132 * Work on idAuthentication, protocolVersion and options.
134 * Revision 1.1 1995/05/23 15:34:49 adam
135 * Many new settings, userInformationField, smallSetUpperBound, etc.
136 * A number of settings are inherited when ir-set is executed.
137 * This version is incompatible with the graphical test client (client.tcl).
152 #include <comstack.h>
159 #include <yaz-version.h>
163 #include <diagbib1.h>
170 int (*method) (void *obj, Tcl_Interp *interp, int argc, char **argv);
180 char **databaseNames;
181 int num_databaseNames;
183 enum oid_value *preferredRecordSyntax;
184 int replaceIndicator;
187 char *elementSetNames;
188 char *smallSetElementSetNames;
189 char *mediumSetElementSetNames;
191 int smallSetUpperBound;
192 int largeSetLowerBound;
193 int mediumSetPresentNumber;
206 int preferredMessageSize;
207 int maximumRecordSize;
209 Odr_bitmask protocolVersion;
211 char *idAuthenticationOpen;
212 char *idAuthenticationGroupId;
213 char *idAuthenticationUserId;
214 char *idAuthenticationPassword;
216 char *implementationName;
217 char *implementationId;
218 char *implementationVersion;
220 char *targetImplementationName;
221 char *targetImplementationId;
222 char *targetImplementationVersion;
223 char *userInformationField;
245 struct IrTcl_Request_ *request_queue;
247 IrTcl_SetCObj set_inher;
250 typedef struct IrTcl_Request_ {
251 struct IrTcl_Request_ *next;
266 struct GRS_Record_entry {
275 struct IrTcl_GRS_Record_ *sub;
286 typedef struct IrTcl_GRS_Record_ {
288 struct GRS_Record_entry *entries;
291 typedef struct IrTcl_RecordList_ {
300 IrTcl_GRS_Record *grs1;
309 IrTcl_Diagnostic *list;
310 } surrogateDiagnostics;
312 struct IrTcl_RecordList_ *next;
315 typedef struct IrTcl_SetObj_ {
320 int nextResultSetPosition;
323 int numberOfRecordsReturned;
325 char *recordElements;
328 int nonSurrogateDiagnosticNum;
329 char *searchResponse;
330 char *presentResponse;
331 IrTcl_Diagnostic *nonSurrogateDiagnosticList;
332 IrTcl_RecordList *record_list;
333 IrTcl_SetCObj set_inher;
336 typedef struct IrTcl_ScanEntry_ {
341 int globalOccurrences;
344 IrTcl_Diagnostic *list;
350 typedef struct IrTcl_ScanObj_ {
353 int numberOfTermsRequested;
354 int preferredPositionInResponse;
357 int numberOfEntriesReturned;
367 IrTcl_ScanEntry *entries;
368 IrTcl_Diagnostic *nonSurrogateDiagnosticList;
369 int nonSurrogateDiagnosticNum;
372 struct ir_named_entry {
377 int ir_tcl_get_marc (Tcl_Interp *interp, const char *buf,
378 int argc, char **argv);
379 int ir_tcl_send_APDU (Tcl_Interp *interp, IrTcl_Obj *p, Z_APDU *apdu,
380 const char *msg, const char *object_name);
381 int ir_tcl_send_q (IrTcl_Obj *p, IrTcl_Request *rq, const char *msg);
382 void ir_tcl_del_q (IrTcl_Obj *p);
383 int ir_tcl_strdup (Tcl_Interp *interp, char** p, const char *s);
384 int ir_tcl_strdel (Tcl_Interp *interp, char **p);
386 char *ir_tcl_fread_marc (FILE *inf, size_t *size);
387 void ir_tcl_grs_mk (Z_GenericRecord *r, IrTcl_GRS_Record **grs_record);
388 void ir_tcl_grs_del (IrTcl_GRS_Record **grs_record);
389 int ir_tcl_get_grs (Tcl_Interp *interp, IrTcl_GRS_Record *grs_record,
390 int argc, char **argv);
392 int ir_tcl_get_explain (Tcl_Interp *interp, Z_ExplainRecord *rec,
393 int argc, char **argv);
395 int ir_tcl_method (Tcl_Interp *interp, int argc, char **argv,
396 IrTcl_Methods *tab, int *ret);
397 int ir_tcl_get_set_int (int *val, Tcl_Interp *interp, int argc, char **argv);
401 int (*ir_init) (ClientData clientData, Tcl_Interp *interp,
402 int argc, char **argv, ClientData *subData,
403 ClientData parentData);
404 int (*ir_method) (ClientData clientData, Tcl_Interp *interp,
405 int argc, char **argv);
406 void (*ir_delete)(ClientData clientData);
409 extern IrTcl_Class ir_obj_class;
410 extern IrTcl_Class ir_set_obj_class;
412 void ir_select_add (int fd, void *obj);
413 void ir_select_add_write (int fd, void *obj);
414 void ir_select_remove (int fd, void *obj);
415 void ir_select_remove_write (int fd, void *obj);
417 int ir_tcl_eval (Tcl_Interp *interp, const char *command);
418 void ir_tcl_disconnect (IrTcl_Obj *p);
420 #define IR_TCL_FAIL_CONNECT 1
421 #define IR_TCL_FAIL_READ 2
422 #define IR_TCL_FAIL_WRITE 3
423 #define IR_TCL_FAIL_IN_APDU 4
424 #define IR_TCL_FAIL_UNKNOWN_APDU 5
426 #define IR_TCL_R_Idle 0
427 #define IR_TCL_R_Writing 1
428 #define IR_TCL_R_Waiting 2
429 #define IR_TCL_R_Reading 3
430 #define IR_TCL_R_Connecting 4