2 * IR toolkit for tcl/tk
4 * See the file LICENSE for details.
5 * Sebastian Hammer, Adam Dickmeiss
8 * Revision 1.31 1996-03-05 09:21:19 adam
9 * Bug fix: memory used by GRS records wasn't freed.
10 * Rewrote some of the error handling code - the connection is always
11 * closed before failback is called.
12 * If failback is defined the send APDU methods (init, search, ...) will
13 * return OK but invoke failback (as is the case if the write operation
15 * Bug fix: ref_count in assoc object could grow if fraction of PDU was
18 * Revision 1.30 1996/02/29 15:30:23 adam
19 * Export of IrTcl functionality to extensions.
21 * Revision 1.29 1996/02/26 18:38:33 adam
22 * Work on export of set methods.
24 * Revision 1.28 1996/02/23 17:31:41 adam
25 * More functions made available to the wais tcl extension.
27 * Revision 1.27 1996/02/23 13:41:41 adam
28 * Work on public access to simple ir class system.
30 * Revision 1.26 1996/02/21 10:16:20 adam
31 * Simplified select handling. Only one function ir_tcl_select_set has
32 * to be externally defined.
34 * Revision 1.25 1996/02/05 17:58:04 adam
35 * Ported ir-tcl to use the beta releases of tcl7.5/tk4.1.
37 * Revision 1.24 1996/01/29 11:35:27 adam
38 * Bug fix: cs_type member renamed to comstackType to avoid conflict with
39 * cs_type macro defined by YAZ.
41 * Revision 1.23 1996/01/19 16:22:40 adam
42 * New method: apduDump - returns information about last incoming APDU.
44 * Revision 1.22 1996/01/10 09:18:44 adam
45 * PDU specific callbacks implemented: initRespnse, searchResponse,
46 * presentResponse and scanResponse.
47 * Bug fix in the command line shell (tclmain.c) - discovered on OSF/1.
49 * Revision 1.21 1996/01/04 16:12:14 adam
50 * Setting PDUType renamed to eventType.
52 * Revision 1.20 1996/01/04 11:05:23 adam
53 * New setting: PDUType - returns type of last PDU returned from the target.
54 * Fixed a bug in configure/Makefile.
56 * Revision 1.19 1995/11/13 09:55:46 adam
57 * Multiple records at a position in a result-set with differnt
60 * Revision 1.18 1995/10/18 16:42:44 adam
61 * New settings: smallSetElementSetNames and mediumSetElementSetNames.
63 * Revision 1.17 1995/10/16 17:00:56 adam
64 * New setting: elementSetNames.
65 * Various client improvements. Medium presentation format looks better.
67 * Revision 1.16 1995/09/20 11:37:01 adam
68 * Configure searches for tk4.1 and tk7.5.
71 * Revision 1.15 1995/08/29 15:30:15 adam
72 * Work on GRS records.
74 * Revision 1.14 1995/08/04 11:32:40 adam
75 * More work on output queue. Memory related routines moved
78 * Revision 1.13 1995/08/03 13:23:00 adam
81 * Revision 1.12 1995/07/28 10:28:38 adam
82 * First work on request queue.
84 * Revision 1.11 1995/06/20 08:07:35 adam
85 * New setting: failInfo.
86 * Working on better cancel mechanism.
88 * Revision 1.10 1995/06/16 12:28:20 adam
89 * Implemented preferredRecordSyntax.
90 * Minor changes in diagnostic handling.
91 * Record list deleted when connection closes.
93 * Revision 1.9 1995/06/14 15:08:01 adam
94 * Bug fix in cascade-target-list. Uses yaz-version.h.
96 * Revision 1.8 1995/06/14 13:37:18 adam
97 * Setting recordType implemented.
98 * Setting implementationVersion implemented.
99 * Settings implementationId / implementationName edited.
101 * Revision 1.7 1995/06/01 07:31:28 adam
102 * Rename of many typedefs -> IrTcl_...
104 * Revision 1.6 1995/05/31 08:36:40 adam
105 * Bug fix in client.tcl: didn't save options on clientrc.tcl.
106 * New method: referenceId. More work on scan.
108 * Revision 1.5 1995/05/29 08:44:25 adam
109 * Work on delete of objects.
111 * Revision 1.4 1995/05/26 11:44:10 adam
112 * Bugs fixed. More work on MARC utilities and queries. Test
113 * client is up-to-date again.
115 * Revision 1.3 1995/05/26 08:54:17 adam
116 * New MARC utilities. Uses prefix query.
118 * Revision 1.2 1995/05/24 14:10:23 adam
119 * Work on idAuthentication, protocolVersion and options.
121 * Revision 1.1 1995/05/23 15:34:49 adam
122 * Many new settings, userInformationField, smallSetUpperBound, etc.
123 * A number of settings are inherited when ir-set is executed.
124 * This version is incompatible with the graphical test client (client.tcl).
139 #include <comstack.h>
146 #include <yaz-version.h>
150 #include <diagbib1.h>
156 int (*method) (void *obj, Tcl_Interp *interp, int argc, char **argv);
166 char **databaseNames;
167 int num_databaseNames;
169 enum oid_value *preferredRecordSyntax;
170 int replaceIndicator;
173 char *elementSetNames;
174 char *smallSetElementSetNames;
175 char *mediumSetElementSetNames;
177 int smallSetUpperBound;
178 int largeSetLowerBound;
179 int mediumSetPresentNumber;
189 #if IRTCL_GENERIC_FILES
195 int preferredMessageSize;
196 int maximumRecordSize;
198 Odr_bitmask protocolVersion;
200 char *idAuthenticationOpen;
201 char *idAuthenticationGroupId;
202 char *idAuthenticationUserId;
203 char *idAuthenticationPassword;
205 char *implementationName;
206 char *implementationId;
207 char *implementationVersion;
209 char *targetImplementationName;
210 char *targetImplementationId;
211 char *targetImplementationVersion;
212 char *userInformationField;
234 struct IrTcl_Request_ *request_queue;
236 IrTcl_SetCObj set_inher;
239 typedef struct IrTcl_Request_ {
240 struct IrTcl_Request_ *next;
255 struct GRS_Record_entry {
264 struct IrTcl_GRS_Record_ *sub;
275 typedef struct IrTcl_GRS_Record_ {
277 struct GRS_Record_entry *entries;
280 typedef struct IrTcl_RecordList_ {
289 IrTcl_GRS_Record *grs1;
295 IrTcl_Diagnostic *list;
296 } surrogateDiagnostics;
298 struct IrTcl_RecordList_ *next;
301 typedef struct IrTcl_SetObj_ {
306 int nextResultSetPosition;
309 int numberOfRecordsReturned;
311 char *recordElements;
314 int nonSurrogateDiagnosticNum;
315 char *searchResponse;
316 char *presentResponse;
317 IrTcl_Diagnostic *nonSurrogateDiagnosticList;
318 IrTcl_RecordList *record_list;
319 IrTcl_SetCObj set_inher;
322 typedef struct IrTcl_ScanEntry_ {
327 int globalOccurrences;
330 IrTcl_Diagnostic *list;
336 typedef struct IrTcl_ScanObj_ {
339 int numberOfTermsRequested;
340 int preferredPositionInResponse;
343 int numberOfEntriesReturned;
353 IrTcl_ScanEntry *entries;
354 IrTcl_Diagnostic *nonSurrogateDiagnosticList;
355 int nonSurrogateDiagnosticNum;
358 struct ir_named_entry {
363 int ir_tcl_get_marc (Tcl_Interp *interp, const char *buf,
364 int argc, char **argv);
365 int ir_tcl_send_APDU (Tcl_Interp *interp, IrTcl_Obj *p, Z_APDU *apdu,
366 const char *msg, const char *object_name);
367 int ir_tcl_send_q (IrTcl_Obj *p, IrTcl_Request *rq, const char *msg);
368 void ir_tcl_del_q (IrTcl_Obj *p);
369 int ir_tcl_strdup (Tcl_Interp *interp, char** p, const char *s);
370 int ir_tcl_strdel (Tcl_Interp *interp, char **p);
372 char *ir_tcl_fread_marc (FILE *inf, size_t *size);
373 void ir_tcl_grs_mk (Z_GenericRecord *r, IrTcl_GRS_Record **grs_record);
374 void ir_tcl_grs_del (IrTcl_GRS_Record **grs_record);
375 int ir_tcl_get_grs (Tcl_Interp *interp, IrTcl_GRS_Record *grs_record,
376 int argc, char **argv);
378 int ir_tcl_method (Tcl_Interp *interp, int argc, char **argv,
379 IrTcl_Methods *tab, int *ret);
380 int ir_tcl_get_set_int (int *val, Tcl_Interp *interp, int argc, char **argv);
384 int (*ir_init) (ClientData clientData, Tcl_Interp *interp,
385 int argc, char **argv, ClientData *subData,
386 ClientData parentData);
387 int (*ir_method) (ClientData clientData, Tcl_Interp *interp,
388 int argc, char **argv);
389 void (*ir_delete)(ClientData clientData);
392 extern IrTcl_Class ir_obj_class;
393 extern IrTcl_Class ir_set_obj_class;
395 void ir_select_add (int fd, void *obj);
396 void ir_select_add_write (int fd, void *obj);
397 void ir_select_remove (int fd, void *obj);
398 void ir_select_remove_write (int fd, void *obj);
400 int ir_tcl_eval (Tcl_Interp *interp, const char *command);
401 void ir_tcl_disconnect (IrTcl_Obj *p);
403 #define IR_TCL_FAIL_CONNECT 1
404 #define IR_TCL_FAIL_READ 2
405 #define IR_TCL_FAIL_WRITE 3
406 #define IR_TCL_FAIL_IN_APDU 4
407 #define IR_TCL_FAIL_UNKNOWN_APDU 5
409 #define IR_TCL_R_Idle 0
410 #define IR_TCL_R_Writing 1
411 #define IR_TCL_R_Waiting 2
412 #define IR_TCL_R_Reading 3
413 #define IR_TCL_R_Connecting 4