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