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