# Sebastian Hammer, Adam Dickmeiss
#
# $Log: client.tcl,v $
-# Revision 1.82 1995-11-02 08:47:56 adam
+# Revision 1.92 1996-03-29 16:04:30 adam
+# Work on GRS-1 presentation.
+#
+# Revision 1.91 1996/03/27 17:00:53 adam
+# Fix: main defined when using Tk3.6; it shouldn't be.
+#
+# Revision 1.90 1996/03/20 13:54:02 adam
+# The Tcl_File structure is only manipulated in the Tk-event interface
+# in tkinit.c.
+#
+# Revision 1.89 1996/03/05 09:16:04 adam
+# Sets tearoff to off on several menus.
+#
+# Revision 1.88 1996/01/23 15:24:09 adam
+# Wrore more comments.
+#
+# Revision 1.87 1996/01/22 17:13:34 adam
+# Wrote comments.
+#
+# Revision 1.86 1996/01/22 09:29:01 adam
+# Wrote comments.
+#
+# Revision 1.85 1996/01/19 16:22:36 adam
+# New method: apduDump - returns information about last incoming APDU.
+#
+# Revision 1.84 1996/01/11 13:12:10 adam
+# Bug fix.
+#
+# Revision 1.83 1995/11/28 17:26:36 adam
+# Removed Carriage return from ir-tcl.c!
+# Removed misc. debug logs.
+#
+# Revision 1.82 1995/11/02 08:47:56 adam
# Text widgets are flat now.
#
# Revision 1.81 1995/10/19 10:34:43 adam
#
#
+# Procedure tk4 is defined - returns 0 if tk 3.6 - returns 1 otherwise
if {$tk_version == "3.6"} {
proc tk4 {} {
return 0
}
}
+# The following two procedures deals with menu entries. The interface
+# changed from Tk 3.6 to 4.X
+
+# Procedure configure-enable-e {w n}
+# w is a menu
+# n menu entry number (0 is first entry)
+# Enables menu entry
+
+# Procedure configure-disable-e {w n}
+# w is a menu
+# n menu entry number (0 is first entry)
+# Disables menu entry
+
if {[tk4]} {
proc configure-enable-e {w n} {
incr n
set noFocus {}
}
+# Set monoFlag to 1 if screen is known not to support colors; otherwise
+# set monoFlag to 0
if {![tk4]} {
if {[tk colormodel .] == "color"} {
set monoFlag 0
set monoFlag 0
}
+# Define libdir to the IrTcl configuration directory.
+# In the line below LIBDIR will be modified during 'make install'.
set libdir LIBDIR
+
+# If the bitmaps sub directory is present with a bitmap we assume
+# the client is run from the source directory in which case we
+# set libdir the current directory.
if {[file readable bitmaps/book2]} {
set libdir .
}
+
+# Make a final check to see if libdir was set ok.
if {! [file readable ${libdir}/bitmaps/book2]} {
puts "Cannot locate system files in ${libdir}. You must either run this"
puts "program from the source directory root of ir-tcl or you must assure"
exit 1
}
+# Initialize a lot of globals.
set hotTargets {}
set hotInfo {}
set busy 0
set recordSyntax None
set elementSetNames None
set delayRequest {}
+set debugMode 0
set queryTypes {Simple}
set queryButtons { { {I 0} {I 1} {I 2} } }
set setOffset 0
set setMax 0
+# Procedure tkerror {err}
+# err error message
+# Override the Tk error handler function.
proc tkerror err {
set w .tkerrorw
bottom-buttons $w [list {Close} [list destroy $w]] 1
}
+# Read tag set file (if present)
+if {[file readable "${libdir}/tagsets.tcl"]} {
+ source "${libdir}/tagsets.tcl"
+}
+
+# Read the global configuration file.
if {[file readable "clientrc.tcl"]} {
source "clientrc.tcl"
-} else {
- if {[file readable "${libdir}/clientrc.tcl"]} {
- source "${libdir}/clientrc.tcl"
- }
+} elseif {[file readable "${libdir}/clientrc.tcl"]} {
+ source "${libdir}/clientrc.tcl"
}
+# Read the user configuration file.
if {[file readable "~/.clientrc.tcl"]} {
source "~/.clientrc.tcl"
}
+# These globals describe the current query type. They are set to the
+# first query type.
set queryButtonsFind [lindex $queryButtons 0]
set queryInfoFind [lindex $queryInfo 0]
+# Procedure read-formats
+# Read all Tcl source files in the subdirectory 'formats'.
+# The name of each source will correspond to a display format.
proc read-formats {} {
global displayFormats
global libdir
- if {[catch {set formats [glob -nocomplain ${libdir}/formats/*.tcl]}]} {
- set formats ./formats/raw.tcl
- }
+
+ set oldDir [pwd]
+ cd ${libdir}/formats
+ set formats [glob {*.[tT][cC][lL]}]
foreach f $formats {
if {[file readable $f]} {
source $f
set l [string length $f]
- set f [string range $f [string length "${libdir}/formats/"] \
- [expr $l - 5]]
+ set f [string tolower [string range $f 0 [expr $l - 5]]]
lappend displayFormats $f
}
}
+ cd $oldDir
}
+# Procedure set-wrap {m}
+# m boolean wrap mode
+# Handler to enable/disable text wrap in the main record window
proc set-wrap {m} {
global textWrap
.data.record configure -wrap $m
}
+# Procedure dputs {m}
+# m string to be printed
+# puts utility for debugging.
proc dputs {m} {
- puts $m
+ global debugMode
+ if {$debugMode} {
+ puts $m
+ }
+}
+
+# Procedure apduDump {}
+# Logs BER dump of last APDU in window if debugMode is true.
+proc apduDump {} {
+ global debugMode
+
+ set w .apdu
+
+ if {$debugMode == 0} return
+ set x [z39 apduInfo]
+
+ set offset [lindex $x 1]
+ set length [lindex $x 0]
+
+ if {![winfo exists $w]} {
+ catch {destroy $w}
+ toplevelG $w
+
+ wm title $w "APDU information"
+
+ wm minsize $w 0 0
+
+ top-down-window $w
+
+ text $w.top.t -font fixed -width 60 -height 12 -wrap word \
+ -relief flat -borderwidth 0 -yscrollcommand [list $w.top.s set]
+ scrollbar $w.top.s -command [list $w.top.t yview]
+
+ pack $w.top.s -side right -fill y
+ pack $w.top.t -expand yes -fill both
+
+ bottom-buttons $w [list {Close} [list destroy $w]] 0
+ }
+ $w.top.t insert end "Length: ${length}\n"
+ if {$offset != -1} {
+ $w.top.t insert end "Offset: ${offset}\n"
+ }
+ $w.top.t insert end [lindex $x 2]
+ $w.top.t insert end "---------------------------------\n"
+
}
+# Procedure set-display-format {f}
+# f display format
+# Reformats main record window to use display format given by f
proc set-display-format {f} {
global displayFormat
global setNo
add-title-lines -1 10000 1
}
+# Procedure initBindings
+# Disables various default bindings for Text and Listbox widgets.
proc initBindings {} {
set w Text
bind $w <1> {}
set w Entry
}
+# Procedure post-menu {wbutton wmenu}
+# wbutton button widget
+# wmenu menu widget
+# Post menu near button. Note: not used.
proc post-menu {wbutton wmenu} {
$wmenu activate none
focus $wmenu
}
+# Procedure destroyGW {w}
+# w top level widget
+# Saves geometry of widget w in windowGeometry array. This
+# Procedure is used to save current geometry of a window before
+# it is destroyed.
+# See also topLevelG.
proc destroyGW {w} {
global windowGeometry
set windowGeometry($w) [wm geometry $w]
}
+
+# Procedure topLevelG
+# w top level widget
+# Makes a new top level widget named w; sets geometry of window if it
+# exists in windowGeometry array. The destroyGW procedure is set
+# to be called when the Destroy event occurs.
proc toplevelG {w} {
global windowGeometry
bind $w <Destroy> [list destroyGW $w]
}
-
+# Procedure top-down-window {w}
+# w window (possibly top level)
+# Makes two frames inside w called top and bot.
proc top-down-window {w} {
frame $w.top -relief raised -border 1
frame $w.bot -relief raised -border 1
pack $w.bot -fill both
}
+# Procedure top-down-ok-cancel {w ok-action g}
+# w top level widget with $w.bot-frame
+# ok-action ok script
+# g grab flag
+# Makes two buttons in the bot frame called Ok and Cancel. The
+# ok-action is executed if Ok is pressed. If Cancel is activated
+# The window is destroyed. If g is true a grab is performed on the
+# window and the procedure waits until the window is destroyed.
proc top-down-ok-cancel {w ok-action g} {
frame $w.bot.left -relief sunken -border 1
pack $w.bot.left -side left -expand yes -ipadx 2 -ipady 2 -padx 1 -pady 1
}
}
+# Procedure bottom-buttons {w buttonList g}
+# w top level widget with $w.bot-frame
+# buttonList button specifications
+# g grab flag
+# Makes a list of buttons in the $w.bot frame. The buttonList is a list
+# of button specifications. Each button specification consists of two
+# items; the first item is button label name; the second item is a script
+# of be executed when that button is executed. A grab is performed if g
+# is true and it waits for the window to be destroyed.
proc bottom-buttons {w buttonList g} {
set i 0
set l [llength $buttonList]
}
}
+# Procedure cancel-operation
+# This handler is invoked when the user wishes to cancel an operation.
+# If the system is currently busy a "Cancel" will be displayed in the
+# status area and the cancelFlag is set to true indicating that future
+# responses from the target should be ignored. The system is no longer
+# when this procedure exists.
proc cancel-operation {} {
global cancelFlag
global busy
}
}
+# Procedure show-target {target base}
+# target name of target
+# base name of database
+# Displays target name and database name in the target status area.
proc show-target {target base} {
global profile
}
}
+# Procedure show-logo {v1}
+# v1 integer level
+# This procedure maintains the book logo in the bottom of the screen.
+# It is invoked only once during initialization of windows, etc., and
+# by itself. The global 'busy' variable determines whether the logo is
+# moving or not.
proc show-logo {v1} {
global busy
global libdir
}
}
}
-
+
+# Procedure show-status {status b sb}
+# status status message string
+# b busy indicator
+# sb search busy indicator
+# Display status information according to 'status' and sets the global
+# busy flag 'busy' to b if b is non-empty. If sb is non-empty it indicates
+# whether service buttons should be enabled or disabled.
proc show-status {status b sb} {
global busy
global scanEnable
}
}
+# Procedure show-message {msg}
+# msg message string
+# Sets message the bottom of the screen to msg.
proc show-message {msg} {
.bot.a.message configure -text "$msg"
}
+# Procedure insertWithTags {w text args}
+# w text widget
+# text string to be inserted
+# args list of tags
+# Inserts text at the insertion point in widget w. The text is tagged
+# with the tags in args.
proc insertWithTags {w text args} {
set start [$w index insert]
$w insert insert $text
}
}
+# Procedure popup-license
+# Displays LICENSE information.
proc popup-license {} {
global libdir
set w .popup-licence
top-down-window $w
text $w.top.t -width 80 -height 10 -wrap word -relief flat -borderwidth 0 \
- -yscrollcommand [list $w.top.s set]
+ -font fixed -yscrollcommand [list $w.top.s set]
scrollbar $w.top.s -command [list $w.top.t yview]
pack $w.top.s -side right -fill y
bottom-buttons $w [list {Close} [list destroy $w]] 1
}
+# Procedure about-target
+# Displays various information about the current target, such
+# as implementation-name, implementation-id, etc.
proc about-target {} {
set w .about-target-w
global hostid
bottom-buttons $w [list {Close} [list destroy $w]] 1
}
+# Procedure about-origin-logo {n}
+# n integer level
+# Displays book logo in the .about-origin-w widget
proc about-origin-logo {n} {
global libdir
set w .about-origin-w
after 140 [list about-origin-logo $n]
}
+# Procedure about-origin
+# Display various information about origin (this client).
proc about-origin {} {
set w .about-origin-w
global libdir
{License} [list popup-license]] 0
}
+# Procedure popup-marc {sno no b df}
+# sno result set number
+# no record position number
+# b popup window number
+# df display format
+# Displays record in set $sno at position $no in window .full-marc$b.
+# The global variable $popupMarcdf holds the current format method.
proc popup-marc {sno no b df} {
global displayFormats
global popupMarcdf
pack $w.top -side top -fill both -expand yes
pack $w.bot -fill both
- text $w.top.record -width 60 -height 5 -wrap word -relief flat -borderwidth 0 \
- -yscrollcommand [list $w.top.s set]
+ text $w.top.record -width 60 -height 5 -wrap word -relief flat \
+ -borderwidth 0 -font fixed -yscrollcommand [list $w.top.s set]
scrollbar $w.top.s -command [list $w.top.record yview]
global monoFlag
$ffunc $sno $no $w.top.record 0
}
+# Procedure update-target-hotlist {target base}
+# target current target name
+# base current database name
+# Updates the global $hotTargets so that $target and $base are
+# moved to the front, i.e. they become the number 1 target/base.
+# The target menu is updated by a call to set-target-hotlist.
proc update-target-hotlist {target base} {
global hotTargets
set-target-hotlist $olen
}
+# Procedure delete-target-hotlist {target}
+# target target to be deleted
+# Updates the global $hotTargets so that $target is removed.
+# The target menu is updated by a call to set-target-hotlist.
proc delete-target-hotlist {target} {
global hotTargets
set-target-hotlist $olen
}
+# Procedure set-target-hotlist {olen}
+# olen number of hot target entries to be deleted from menu
+# Updates the target menu with the targets with the first 8 entries
+# in the $hotTargets global.
proc set-target-hotlist {olen} {
global hotTargets
}
}
+# Procedure reopen-target {target base}
+# target target to be opened
+# base base to be used
+# Closes connection with current target and opens a new connection
+# with $target and database $base.
proc reopen-target {target base} {
close-target
open-target $target $base
update-target-hotlist $target $base
}
+# Procedure define-target-action
+# Prepares the setup of a new target. The name of the target
+# is read from the dialog .target-define dialog (procedure
+# define-target-dialog) and the target definition window is displayed by
+# a call to protocol-setup.
proc define-target-action {} {
global profile
destroy .target-define
}
+# Procedure fail-response {target}
+# target current target
+# Error handler (IrTcl failback) that takes care of serious protocol
+# errors, connection lost, etc.
proc fail-response {target} {
+ global debugMode
+
set c [lindex [z39 failInfo] 0]
set m [lindex [z39 failInfo] 1]
+ if {$c == 4 || $c == 5} {
+ set debugMode 1
+ apduDump
+ }
close-target
tkerror "$m ($c)"
}
+# Procedure connect-response {target base}
+# target current target
+# base current database
+# IrTcl connect response handler.
proc connect-response {target base} {
dputs "connect-response"
show-target $target $base
init-request
}
+# Procedure open-target {target base}
+# target target to be opened
+# base database to be used
+# Opens a new connection with $target/$base.
proc open-target {target base} {
global profile
global hostid
configure-enable-e .top.target.m 2
}
+# Procedure close-target
+# Shuts down the connection with current target.
proc close-target {} {
global hostid
global cancelFlag
configure-enable-e .top.target.m 0
}
+# Procedure load-set-action
+# Loads records from a file. The filename is read from the entry
+# .load-set.filename.entry (see function load-set)
proc load-set-action {} {
global setNoLast
show-status Ready 0 {}
}
+# Procedure load-set
+# Dialog that asks for a filename with records to be loaded
+# into a result set.
proc load-set {} {
set w .load-set
toplevel $w
focus $oldFocus
}
+# Procedure init-request
+# Sends an initialize request to the target. This procedure is called
+# when a connect has been established.
proc init-request {} {
global cancelFlag
}
}
+# Procedure init-response
+# Handles and incoming init-response. The service buttons
+# are enabled. The global $scanEnable indicates whether the target
+# supports scan.
proc init-response {} {
global cancelFlag
global scanEnable
dputs {init-reponse}
+ apduDump
if {$cancelFlag} {
close-target
return
}
}
+# Procedure search-request
+# bflag flag to indicate if this procedure calls itself
+# Performs a search. If $busy is 1, the search-request is performed
+# at a later time (when another response arrives). This procedure
+# sets many search-related Z39-settings. The global $setNo is set
+# to the result set number (z39.$setNo).
proc search-request {bflag} {
global setNo
global setNoLast
show-status Searching 1 0
}
+# Procedure scan-copy {y entry}
+# y y-position of mouse pointer
+# entry a search entry in the top
+# Copies the term in the list nearest $y to the query entry specified
+# by $entry
proc scan-copy {y entry} {
set w .scan-window
set no [$w.top.list nearest $y]
.lines.$entry.e insert 0 [string range [$w.top.list get $no] 8 end]
}
+# Procedure scan-request
+# Performs a scan on term "0" with the current attributes in entry
+# specified by the global $curIndexEntry.
proc scan-request {} {
set w .scan-window
show-status Scanning 1 0
}
+# Procedure scan-term-h {attr}
+# attr attribute specification
+# This procedure is called whenever a key is released in the entry in the
+# scan window (.scan-window). A scan is then initiated with the new contents
+# of the entry as the starting term.
proc scan-term-h {attr} {
global busy
global scanTerm
show-status Scanning 1 0
}
+# Procedure scan-response {attr start toget}
+# attr attribute specification
+# start position of first term in the response
+# toget number of total terms to get
+# This procedure handles all scan-responses. $start specifies the list
+# entry number of the first incoming term. The $toget indicates the total
+# number of terms to be retrieved from the target. The $toget may be
+# negative in which case, scan is performed 'backwards' (- $toget is
+# the total number of terms in this case). This procedure usually calls
+# itself several times in order to get small scan-term-list chunks.
proc scan-response {attr start toget} {
global cancelFlag
global delayRequest
set w .scan-window
dputs "In scan-response"
+ apduDump
set m [z39.scan numberOfEntriesReturned]
dputs $m
dputs attr=$attr
show-status Ready 0 1
}
+# Procedure scan-down {attr}
+# attr attribute specification
+# This procedure is called when the user hits the Down button the scan
+# window. A new scan is initiated with a positive $toget passed to the
+# scan-response handler.
proc scan-down {attr} {
global scanView
global cancelFlag
$w.top.list yview $scanView
}
+# Procedure scan-up {attr}
+# attr attribute specification
+# This procedure is called when the user hits the Up button the scan
+# window. A new scan is initiated with a negative $toget passed to the
+# scan-response handler.
proc scan-up {attr} {
global scanView
global cancelFlag
$w.top.list yview $scanView
}
+# Procedure search-response
+# This procedure handles search-responses. If the search is successful
+# this procedure will try to retrieve a total of 20 records from the target;
+# however not more than $presentChunk records at a time. This procedure
+# affects the following globals:
+# $setOffset current record position offset
+# $setMax total number of records to be retrieved
proc search-response {} {
global setNo
global setOffset
global delayRequest
global presentChunk
-
+ apduDump
dputs "In search-response"
if {$cancelFlag} {
dputs "Handling cancel"
show-status Ready 0 1
set l [format "%-4d %7d" $setNo $setMax]
.top.rset.m add command -label $l \
- -command [list add-title-lines $setNo 10000 1]
+ -command [list recall-set $setNo]
if {$setMax > 20} {
set setMax 20
}
}
}
+# Procedure present-more {number}
+# number number of records to be retrieved
+# This procedure starts a present-request. The $number variable indicates
+# the total number of records to be retrieved. The global $presentChunk
+# specifies the number of records to be retrieved at a time. If $number
+# is the empty string all remaining records in the result set are
+# retrieved.
proc present-more {number} {
global setNo
global setOffset
show-status Retrieving 1 0
}
+# Procedure init-title-lines
+# Utility that cleans the main record window.
proc init-title-lines {} {
.data.record delete 0.0 end
}
+# Procedure recall-set {setno}
+# setno Set number to recall
+proc recall-set {setno} {
+ add-title-lines $setno 10000 1
+}
+
+# Procedure add-title-lines {setno no offset}
+# setno Set number
+# no Number of records
+# offset Starting offset
+# This procedure displays the records $offset .. $offset+$no-1 in result
+# set $setno in the main record window by using the display format in the
+# global $displayFormat
proc add-title-lines {setno no offset} {
global displayFormats
global displayFormat
set setno $setNo
}
if {$offset == 1} {
-
.bot.a.set configure -text $setno
.data.record delete 0.0 end
}
}
}
+# Procedure present-response
+# Present-response handler. The incoming records are displayed and a new
+# present request is performed until all records ($setMax) is returned
+# from the target.
proc present-response {} {
global setNo
global setOffset
global presentChunk
dputs "In present-response"
+ apduDump
set no [z39.$setNo numberOfRecordsReturned]
dputs "Returned $no records, setOffset $setOffset"
add-title-lines $setNo $no $setOffset
}
}
+# Procedure left-cursor {w}
+# w entry widget
+# Tries to move the cursor left in entry window $w
proc left-cursor {w} {
set i [$w index insert]
if {$i > 0} {
dputs left
}
+# Procedure right-cursor {w}
+# w entry widget
+# Tries to move the cursor right in entry window $w
proc right-cursor {w} {
set i [$w index insert]
incr i
$w icursor $i
}
+# Procedure bind-fields {list returnAction escapeAction}
+# list list of entry widgets
+# returnAction return script
+# escapeAction escape script
+# Each widget in list are assigned bindings for <Tab>, <Left>, <Right>,
+# <Return> and <Escape>.
proc bind-fields {list returnAction escapeAction} {
set max [expr [llength $list]-1]
for {set i 0} {$i < $max} {incr i} {
focus [lindex $list 0]
}
+# Procedure entry-fields {parent list tlist returnAction escapeAction}
+# list list of frame widgets
+# tlist list of text to be used as lead of each entry
+# returnAction return script
+# escapeAction escape script
+# Makes label and entry widgets in each widget in $list.
proc entry-fields {parent list tlist returnAction escapeAction} {
set alist {}
set i 0
bind-fields $alist $returnAction $escapeAction
}
+# Procedure define-target-dialog
+# Dialog that asks for new target to be defined.
proc define-target-dialog {} {
set w .target-define
top-down-ok-cancel $w {define-target-action} 1
}
+# Procedure protocol-setup-delete
+# This procedure is invoked when the user tries to delete a target
+# definition. If user is sure, the target definition is deleted.
proc protocol-setup-delete {target w} {
global profile
global settingsChanged
}
}
+# Procedure protocol-setup-action {target w}
+# target target to be defined
+# w target definition toplevel widget
+# This procedure reads all appropriate globals and makes a new/modified
+# profile for the target. The global array $targetS contains most of the
+# information the user may modify.
proc protocol-setup-action {target w} {
global profile
global settingsChanged
destroy $w
}
+# Procedure place-force {window parent}
+# window new top level widget
+# parent parent widget used as base
+# Sets geometry of $window relative to $parent window.
proc place-force {window parent} {
set g [wm geometry $parent]
wm geometry $window +${x}+${y}
}
+# Procedure add-database-action {target w}
+# target target to be defined
+# w top level widget for the target definition
+# Adds the contents of .database-select.top.database.entry to list of
+# databases.
proc add-database-action {target w} {
global profile
destroy .database-select
}
+# Procedure add-database {target wp}
+# target target to be defined
+# wp top level widget for the target definition
+# Makes a dialog in which the user enters new database
proc add-database {target wp} {
global profile
focus $oldFocus
}
+# Procedure delete-database {target w}
+# target target to be defined
+# w top level widget for the target definition
+# Asks the user if he/she really wishes to delete a database and removes
+# the database from the database-list if requested.
proc delete-database {target w} {
global profile
}
}
+# Procedure protocol-setup {target}
+# target target to be defined
+# Makes a dialog in which the user may modify/view a target definition
+# (profile). The $targetS - array holds the initial definition of the
+# target.
proc protocol-setup {target} {
global profile
global targetS
{Cancel} [list destroy $w]] 0
}
-
+# Procedure advanced-setup {target b}
+# target target to be defined
+# b window number of target top level
+# Makes a dialog in which the user may modify/view advanced settings
+# of a target definition (profile).
proc advanced-setup {target b} {
global profile
global targetS
{Cancel} [list destroy $w]] 0
}
+# Procedure advanced-setup-action {target b}
+# target target to be defined
+# b window number of target top level
+# This procedure is called when the user hits Ok in the advanced target
+# setup dialog. The temporary result is stored in the $targetS - array.
proc advanced-setup-action {target b} {
set w .advanced-setup-$b
global targetS
destroy $w
}
+# Procedure database-select-action
+# Called when the user commits a database select change. See procedure
+# database-select.
proc database-select-action {} {
set w .database-select.top
set b {}
destroy .database-select
}
+# Procedure database-select
+# Makes a dialog in which the user may select a database
proc database-select {} {
set w .database-select
global profile
focus $oldFocus
}
+# Procedure cascade-target-list
+# Makes all target/databases available in the Target|Connect
+# menu as well as all targets in the Target|Setup menu.
+# This procedure is called whenever target definitions occur.
proc cascade-target-list {} {
global profile
}
}
+# Procedure query-select {i}
+# i Query type number (integer)
+# This procedure is called when the user selects a Query type. The current
+# query type information given by the globals $queryButtonsFind and
+# $queryInfoFind are affected by this operation.
proc query-select {i} {
global queryButtonsFind
global queryInfoFind
index-lines .lines 1 $queryButtonsFind $queryInfoFind activate-index
}
+# Procedure query-new-action
+# Commits a new query type definition by extending the globals
+# $queryTypes, $queryButtons and $queryInfo.
proc query-new-action {} {
global queryTypes
global queryButtons
cascade-query-list
}
+# Procedure query-new
+# Makes a dialog in which the user is requested to enter the name of a
+# new query type.
proc query-new {} {
set w .query-new
focus $oldFocus
}
+# Procedure query-delete-action {queryNo}
+# queryNo query type number (integer)
+# Procedure that deletes the query type specified by $queryNo.
proc query-delete-action {queryNo} {
global queryTypes
global queryButtons
cascade-query-list
}
+# Procedure query-delete {queryNo}
+# queryNo query type number (integer)
+# Asks if the user really want to delete a given query type; calls
+# query-delete-action if 'yes'.
proc query-delete {queryNo} {
global queryTypes
{Cancel} [list destroy $w]] 1
}
+# Procedure cascade-query-list
+# Updates the enties below Options|Query to list all query types.
proc cascade-query-list {} {
global queryTypes
set w .top.options.m.query
}
}
+# Procedure save-geometry
+# This procedure saves the per-user related settings in ~/.clientrc.tcl.
+# The geometry information stored in the global array $windowGeometry is
+# saved. Also a few other user settings, such as current display format, are
+# saved.
proc save-geometry {} {
global windowGeometry
global hotTargets
return
}
if {$hostid != "Default"} {
- puts $f "set hostid $hostid"
+ puts $f "set hostid \{$hostid\}"
set b [z39 databaseNames]
puts $f "set hostbase $b"
}
close $f
}
+# Procedure save-settings
+# This procedure saves the per-host related settings clientrc.tcl which
+# is normally kept in the directory /usr/local/lib/irtcl.
+# All query types and target defintion profiles are saved.
proc save-settings {} {
global profile
global libdir
set settingsChanged 0
}
+# Procedure alert {ask}
+# ask prompt string
+# Makes a grabbed dialog in which the user is requested to answer
+# "Ok" or "Cancel". This procedure returns 1 if the user hits "Ok"; 0
+# otherwise.
proc alert {ask} {
set w .alert
return $alertAnswer
}
+# Procedure alert-action
+# Called when the user hits "Ok" in the .alert-window.
proc alert-action {} {
global alertAnswer
set alertAnswer 1
destroy .alert
}
+# Procedure exit-action
+# This procedure is called if the user tries to exit without saving the
+# system settings.
proc exit-action {} {
global settingsChanged
exit 0
}
+# Procedure listbuttonaction {w name h user i}
+# w menubutton widget
+# name name information
+# h handler to be invoked
+# user user information to be passed to handler $h
+# i index passed as second argument to handler $h
+# Utility function to emulate a listbutton. Called when the user
+# Modifies the listbutton. See procedure listbuttonx.
proc listbuttonaction {w name h user i} {
$w configure -text [lindex $name 0]
$h [lindex $name 1] $user $i
}
-
+
+# Procedure listbuttonx {button no names handle user}
+# button menubutton widget
+# no initial value index (integer)
+# names list of name entries. The first entry in each name
+# entry is the actual name
+# handle user function to be called when the listbutton changes
+# its value
+# user user argument to the $handle function
+# Makes an extended listbutton.
proc listbuttonx {button no names handle user} {
if {[winfo exists $button]} {
$button configure -text [lindex [lindex $names $no] 0]
menubutton $button -text [lindex [lindex $names $no] 0] \
-width 10 -menu ${button}.m -relief raised -border 1
menu ${button}.m
+ if {[tk4]} {
+ ${button}.m configure -tearoff off
+ }
}
set i 0
foreach name $names {
}
}
+# Procedure listbutton {button no names}
+# button menubutton widget
+# no initial value index (integer)
+# names list of possible values.
+# Makes a listbutton. The functionality is emulated by the use menubutton-
+# and menu widgets.
proc listbutton {button no names} {
menubutton $button -text [lindex $names $no] -width 10 -menu ${button}.m \
-relief raised -border 1
menu ${button}.m
+ if {[tk4]} {
+ ${button}.m configure -tearoff off
+ }
foreach name $names {
${button}.m add command -label $name \
-command [list ${button} configure -text $name]
}
}
+# Procedure listbuttonv-action {button var names i}
+# button menubutton widget
+# var global variable to be affected
+# names list of possible names and values
+# This procedure is called when the user alters a menu created by the
+# listbuttonv procedure. The global variable $var is updated.
proc listbuttonv-action {button var names i} {
global $var
$button configure -text [lindex $names $i]
}
+# Procedure listbuttonv {button var names}
+# button menubutton widget
+# var global variable to be affected
+# names List of name/value pairs, i.e. {n1 v1 n2 v2 ...}.
+# This procedure emulates a listbutton by means of menu/menubutton widgets.
+# The global variable $var is automatically updated and set to one of the
+# values v1, v2, ...
proc listbuttonv {button var names} {
global $var
menubutton $button -text $n -menu ${button}.m \
-relief raised -border 1
menu ${button}.m
+ if {[tk4]} {
+ ${button}.m configure -tearoff off
+ }
for {set i 0} {$i < $l} {incr i 2} {
${button}.m add command -label [lindex $names $i] \
-command [list listbuttonv-action $button $var $names $i]
}
}
+# Procedure query-add-index-action {queryNo}
+# queryNo query type number (integer)
+# Handler that makes a new query index.
proc query-add-index-action {queryNo} {
set w .query-setup
#pack $w.top.lines -side left -pady 6 -padx 6 -fill y
}
+# Procedure query-add-line
+# queryNo query type number (integer)
+# Handler that adds new query line.
proc query-add-line {queryNo} {
set w .query-setup
#pack $w.top.lines -side left -pady 6 -padx 6 -fill y
}
+# Procedure query-del-line
+# queryNo query type number (integer)
+# Handler that removes query line.
proc query-del-line {queryNo} {
set w .query-setup
index-lines $w.top.lines 0 $queryButtonsTmp $queryInfoTmp activate-e-index
}
+# Procedure query-add-index
+# queryNo query type number (integer)
+# Handler that adds new query index.
proc query-add-index {queryNo} {
set w .query-add-index
focus $oldFocus
}
+# Procedure query-setup-action
+# queryNo query type number (integer)
+# Handler that updates the query information database stored in the
+# globals $queryInfo and $queryButtons. This procedure is executed when
+# the user commits the query setup changes by pressing button "Ok".
proc query-setup-action {queryNo} {
global queryButtons
global queryInfo
index-lines .lines 1 $queryButtonsFind $queryInfoFind activate-index
}
+# Procedure activate-e-index {value no i}
+# value menu name
+# no query index number
+# i menu index (integer)
+# Procedure called when listbutton is activated in the query type edit
+# window. The global $queryButtonsTmp is updated in this operation.
proc activate-e-index {value no i} {
global queryButtonsTmp
global queryIndexTmp
set queryIndexTmp $i
}
+# Procedure activate-index {value no i}
+# value menu name
+# no query index number
+# i menu index (integer)
+# Procedure called when listbutton is activated in the main query
+# window. The global $queryButtonsFind is updated in this operation.
proc activate-index {value no i} {
global queryButtonsFind
dputs "queryButtonsFind $queryButtonsFind"
}
+# Procedure update-attr
+# This procedure creates listbuttons for all bib-1 attributes except
+# the use-attribute in the .index-setup window.
+# The globals $relationTmpValue, $positionTmpValue, $structureTmpValue,
+# $truncationTmpValue and $completenessTmpValue are maintainted by the
+# listbuttons.
proc update-attr {} {
set w .index-setup
listbuttonv $w.top.relation.b relationTmpValue\
{Incomplete subfield} 1 {Complete subfield} 2 {Complete field} 3}
}
+# Procedure use-attr {init}
+# init init flag
+# This procedure creates a listbox with several Bib-1 use attributes.
+# If $init is 1 the listbox is created with the attributes. If $init
+# is 0 the current selection of the listbox is read and the global
+# $useTmpValue is set to the current use-value.
proc use-attr {init} {
set attr {
{None} 0
}
}
+# Procedure index-setup-action {oldAttr queryNo indexNo}
+# oldAttr original attributes (?)
+# queryNo query number
+# indexNo index number
+# Commits setup of a query index. The mapping from the index to
+# the Bib-1 attributes are handled by this function.
proc index-setup-action {oldAttr queryNo indexNo} {
set attr [lindex $oldAttr 0]
destroy .index-setup
}
+# Procedure index-setup {attr queryNo indexNo}
+# attr original attributes
+# queryNo query number
+# indexNo index number
+# Makes a window with settings of a given query index which the user
+# may inspect/modify.
proc index-setup {attr queryNo indexNo} {
set w .index-setup
}
+# Procedure query-edit-index {queryNo}
+# queryNo query number
+# Determines if a selection of an index is active. If one is selected
+# the index-setup dialog is started.
proc query-edit-index {queryNo} {
global queryInfoTmp
set w .query-setup
index-setup $attr $queryNo $i
}
+# Procedure query-delete-index {queryNo}
+# queryNo query number
+# Determines if a selection of an index is active. If one is selected
+# the index is deleted.
proc query-delete-index {queryNo} {
global queryInfoTmp
global queryButtonsTmp
$w.top.index.list delete $i
}
+# Procedure query-setup {queryNo}
+# queryNo query number
+# Makes a dialog in which a query type an be customized.
proc query-setup {queryNo} {
set w .query-setup
Cancel [list destroy $w]] 0
}
+# Procedure index-clear
+# Handler that clears the search entry fields.
proc index-clear {} {
global queryButtonsFind
incr i
}
}
-
+
+# Procedure index-query
+# The purpose of this function is to read the user's query and convert
+# it to the prefix query that IrTcl/YAZ uses to represent an RPN query.
+# Each entry in a search fields takes the form
+# [relOp][?]term[?]
+# Here, relOp is an optional relational operator and one of:
+# > < >= <= <>
+# which sets the Bib-1 relation to greater-than, less-than, etc.
+# The ? (question-mark) is also optional. A (?) on left-side indicates
+# left truncation; (?) on right-side indicates right-truncation; (?)
+# on both sides indicates both-left-and-right truncation.
proc index-query {} {
global queryButtonsFind
global queryInfoFind
return $qs
}
+# Procedure index-focus-in {w i}
+# w index frame
+# i index number
+# This procedure handles <FocusIn> events. A red border is drawed
+# around the active search entry field when tk3.6 is used (tk4.X
+# makes a black focus border itself).
proc index-focus-in {w i} {
global curIndexEntry
set curIndexEntry $i
}
+# Procedure index-lines {w readOp buttonInfo queryInfo handle}
+# w search fields entry frame
+# realOp if true, search-request bindings are bound to the entries.
+# buttonInfo query type button information
+# queryInfo query type field information
+# handle handler called a when a 'listbutton' changes its value
+# Makes one or more search areas - with listbuttons on the left
+# and entries on the right.
proc index-lines {w realOp buttonInfo queryInfo handle} {
set i 0
foreach b $buttonInfo {
}
}
+# Procedure search-fields {w buttondefs}
+# w search fields entry frame
+# buttondefs button definitions
+# Makes search entry fields and listbuttons.
+# Note: This procedure is not used elsewhere. The index-lines
+# procedure is used instead.
proc search-fields {w buttondefs} {
set i 0
foreach buttondef $buttondefs {
$w.0 configure -background red
}
-if {[info exists windowGeometry(.)]} {
- set g $windowGeometry(.)
- if {$g != ""} {
- wm geometry . $g
- }
-}
+# Init: The geometry information for the main window is set - either
+# to a default value or to the value in windowGeometry(.)
+if {[catch {set g $windowGeometry(.)}]} {
+ wm geometry . 420x340
+} else {
+ wm geometry . $g
+}
+# Init: Presentation formats are read.
read-formats
+# Init: The main window is defined.
frame .top -border 1 -relief raised
frame .lines -border 1 -relief raised
frame .mid -border 1 -relief raised
pack .data -side top -fill both -expand yes
pack .bot -fill x
-menubutton .top.file -text "File" -menu .top.file.m
+# Init: Definition of File menu.
+menubutton .top.file -text File -menu .top.file.m
menu .top.file.m
-.top.file.m add command -label "Save settings" -command {save-settings}
+.top.file.m add command -label {Save settings} -command {save-settings}
.top.file.m add separator
-.top.file.m add command -label "Exit" -command {exit-action}
+.top.file.m add command -label Exit -command {exit-action}
-menubutton .top.target -text "Target" -menu .top.target.m
+# Init: Definition of Target menu.
+menubutton .top.target -text Target -menu .top.target.m
menu .top.target.m
-.top.target.m add cascade -label "Connect" -menu .top.target.m.clist
-.top.target.m add command -label "Disconnect" -command {close-target}
-.top.target.m add command -label "About" -command {about-target}
-.top.target.m add cascade -label "Setup" -menu .top.target.m.slist
-.top.target.m add command -label "Setup new" -command {define-target-dialog}
+.top.target.m add cascade -label Connect -menu .top.target.m.clist
+.top.target.m add command -label Disconnect -command {close-target}
+.top.target.m add command -label About -command {about-target}
+.top.target.m add cascade -label Setup -menu .top.target.m.slist
+.top.target.m add command -label {Setup new} -command {define-target-dialog}
.top.target.m add separator
set-target-hotlist 0
menu .top.target.m.slist
cascade-target-list
-menubutton .top.service -text "Service" -menu .top.service.m
+# Init: Definition of Service menu.
+menubutton .top.service -text Service -menu .top.service.m
menu .top.service.m
-.top.service.m add command -label "Database" -command {database-select}
-.top.service.m add cascade -label "Present" -menu .top.service.m.present
+.top.service.m add command -label Database -command {database-select}
+.top.service.m add cascade -label Present -menu .top.service.m.present
menu .top.service.m.present
-.top.service.m.present add command -label "10 More" \
+.top.service.m.present add command -label {10 More} \
-command [list present-more 10]
-.top.service.m.present add command -label "All" \
+.top.service.m.present add command -label All \
-command [list present-more {}]
-.top.service.m add command -label "Search" -command {search-request 0}
-.top.service.m add command -label "Scan" -command {scan-request}
+.top.service.m add command -label Search -command {search-request 0}
+.top.service.m add command -label Scan -command {scan-request}
.top.service configure -state disabled
-menubutton .top.rset -text "Set" -menu .top.rset.m
+menubutton .top.rset -text Set -menu .top.rset.m
menu .top.rset.m
-.top.rset.m add command -label "Load" -command {load-set}
+.top.rset.m add command -label Load -command {load-set}
.top.rset.m add separator
-menubutton .top.options -text "Options" -menu .top.options.m
+# Init: Definition of the Options menu.
+menubutton .top.options -text Options -menu .top.options.m
menu .top.options.m
-.top.options.m add cascade -label "Query" -menu .top.options.m.query
-.top.options.m add cascade -label "Format" -menu .top.options.m.formats
-.top.options.m add cascade -label "Wrap" -menu .top.options.m.wrap
-.top.options.m add cascade -label "Syntax" -menu .top.options.m.syntax
-.top.options.m add cascade -label "Elements" -menu .top.options.m.elements
-
+.top.options.m add cascade -label Query -menu .top.options.m.query
+.top.options.m add cascade -label Format -menu .top.options.m.formats
+.top.options.m add cascade -label Wrap -menu .top.options.m.wrap
+.top.options.m add cascade -label Syntax -menu .top.options.m.syntax
+.top.options.m add cascade -label Elements -menu .top.options.m.elements
+.top.options.m add radiobutton -label Debug -variable debugMode -value 1
+
+# Init: Definition of the Options|Query menu.
menu .top.options.m.query
-.top.options.m.query add cascade -label "Select" \
+.top.options.m.query add cascade -label Select \
-menu .top.options.m.query.clist
-.top.options.m.query add cascade -label "Edit" \
+.top.options.m.query add cascade -label Edit \
-menu .top.options.m.query.slist
-.top.options.m.query add command -label "New" \
+.top.options.m.query add command -label New \
-command {query-new}
-.top.options.m.query add cascade -label "Delete" \
+.top.options.m.query add cascade -label Delete \
-menu .top.options.m.query.dlist
menu .top.options.m.query.slist
menu .top.options.m.query.dlist
cascade-query-list
+# Init: Definition of the Options|Formats menu.
menu .top.options.m.formats
set i 0
foreach f $displayFormats {
incr i
}
+# Init: Definition of the Options|Wrap menu.
menu .top.options.m.wrap
-.top.options.m.wrap add radiobutton -label "Character" \
+.top.options.m.wrap add radiobutton -label Character \
-value char -variable textWrap -command {set-wrap char}
-.top.options.m.wrap add radiobutton -label "Word" \
+.top.options.m.wrap add radiobutton -label Word \
-value word -variable textWrap -command {set-wrap word}
-.top.options.m.wrap add radiobutton -label "None" \
+.top.options.m.wrap add radiobutton -label None \
-value none -variable textWrap -command {set-wrap none}
+# Init: Definition of the Options|Syntax menu.
menu .top.options.m.syntax
-.top.options.m.syntax add radiobutton -label "None" \
+.top.options.m.syntax add radiobutton -label None \
-value None -variable recordSyntax
.top.options.m.syntax add separator
-.top.options.m.syntax add radiobutton -label "USMARC" \
+.top.options.m.syntax add radiobutton -label USMARC \
-value USMARC -variable recordSyntax
-.top.options.m.syntax add radiobutton -label "UNIMARC" \
+.top.options.m.syntax add radiobutton -label UNIMARC \
-value UNIMARC -variable recordSyntax
-.top.options.m.syntax add radiobutton -label "UKMARC" \
+.top.options.m.syntax add radiobutton -label UKMARC \
-value UKMARC -variable recordSyntax
-.top.options.m.syntax add radiobutton -label "DANMARC" \
+.top.options.m.syntax add radiobutton -label DANMARC \
-value DANMARC -variable recordSyntax
-.top.options.m.syntax add radiobutton -label "FINMARC" \
+.top.options.m.syntax add radiobutton -label FINMARC \
-value FINMARC -variable recordSyntax
-.top.options.m.syntax add radiobutton -label "NORMARC" \
+.top.options.m.syntax add radiobutton -label NORMARC \
-value NORMARC -variable recordSyntax
-.top.options.m.syntax add radiobutton -label "PICAMARC" \
+.top.options.m.syntax add radiobutton -label PICAMARC \
-value PICAMARC -variable recordSyntax
.top.options.m.syntax add separator
-.top.options.m.syntax add radiobutton -label "SUTRS" \
+.top.options.m.syntax add radiobutton -label SUTRS \
-value SUTRS -variable recordSyntax
.top.options.m.syntax add separator
-.top.options.m.syntax add radiobutton -label "GRS1" \
+.top.options.m.syntax add radiobutton -label GRS1 \
-value GRS1 -variable recordSyntax
+# Init: Definition of the Options|Elements menu.
menu .top.options.m.elements
-.top.options.m.elements add radiobutton -label "Unspecified" \
+.top.options.m.elements add radiobutton -label Unspecified \
-value None -variable elementSetNames
-.top.options.m.elements add radiobutton -label "Full" \
+.top.options.m.elements add radiobutton -label Full \
-value F -variable elementSetNames
-.top.options.m.elements add radiobutton -label "Brief" \
+.top.options.m.elements add radiobutton -label Brief \
-value B -variable elementSetNames
+# Init: Definition of Help menu.
menubutton .top.help -text "Help" -menu .top.help.m
menu .top.help.m
-command {tkerror "Help on help not available. Sorry"}
.top.help.m add command -label "About" -command {about-origin}
+# Init: Pack menu bar items.
pack .top.file .top.target .top.service .top.rset .top.options -side left
pack .top.help -side right
+# Init: Define query area.
index-lines .lines 1 $queryButtonsFind [lindex $queryInfo 0] activate-index
button .mid.search -text Search -command {search-request 0} \
pack .mid.search .mid.scan .mid.present .mid.clear -side left \
-fill y -pady 1
-text .data.record -height 2 -width 20 -wrap none -borderwidth 0 -relief flat \
+# Init: Define record area in main window.
+text .data.record -font fixed -height 2 -width 20 -wrap none -borderwidth 0 -relief flat \
-yscrollcommand [list .data.scroll set] -wrap $textWrap
scrollbar .data.scroll -command [list .data.record yview]
if {[tk4]} {
pack .data.record -expand yes -fill both
initBindings
+# Init: Define standards tags. These are used in the display
+# format procedures.
if {! $monoFlag} {
.data.record tag configure marc-tag -foreground blue
.data.record tag configure marc-id -foreground red
-font -Adobe-Times-Medium-I-Normal-*-140-* \
-foreground black
+# Init: Define logo.
button .bot.logo -bitmap @${libdir}/bitmaps/book1 -command cancel-operation
if {[tk4]} {
.bot.logo configure -takefocus 0
}
+# Init: Define status information fields at the bottom.
frame .bot.a
pack .bot.a -side left -fill x
pack .bot.logo -side right -padx 2 -pady 2 -ipadx 1
pack .bot.a.status .bot.a.set .bot.a.message \
-side left -padx 2 -pady 2 -ipadx 1 -ipady 1
+# Init: Determine if the IrTcl extension is already there. If
+# not, then dynamically load the IrTcl extension.
if {[catch {ir z39}]} {
set e [info sharedlibextension]
puts -nonewline "Loading irtcl$e ..."
ir z39
puts "ok"
}
-z39 logLevel all
+# Init: Uncomment this line if you wan't to enable logging.
+z39 logLevel all {} irtcl.log
+
+# Init: If hostid is a valid target, a new connection will be established
+# immediately.
if {$hostid != "Default"} {
catch {open-target $hostid $hostbase}
}
+# Init: Enable the logo.
show-logo 1
projects / ir-tcl-moved-to-github.git / blobdiff