X-Git-Url: http://git.indexdata.com/?p=ir-tcl-moved-to-github.git;a=blobdiff_plain;f=client.tcl;h=4865ecb415a1b61600e0eb82c497b4eab8aa9f95;hp=d4a10f4bf34d4c7950b1d7a6a9aa71f06a59f827;hb=HEAD;hpb=71da3253847dfb239e28a7bb760d259ff3611ee7 diff --git a/client.tcl b/client.tcl index d4a10f4..4865ecb 100644 --- a/client.tcl +++ b/client.tcl @@ -1,10 +1,91 @@ # IR toolkit for tcl/tk -# (c) Index Data 1995 +# (c) Index Data 1995-2001 # See the file LICENSE for details. # Sebastian Hammer, Adam Dickmeiss # # $Log: client.tcl,v $ -# Revision 1.85 1996-01-19 16:22:36 adam +# Revision 1.111 2001-12-03 18:52:06 adam +# Configure no longer searches for Tk. Removed references to SR. +# +# Revision 1.110 2000/10/11 12:26:47 adam +# Using yaz.m4 for aclocal.m4. +# +# Revision 1.109 1999/12/12 00:25:59 adam +# Updated list of preconfigure targets. +# +# Revision 1.108 1999/11/30 14:05:58 adam +# Updated for new location of YAZ headers. +# +# Revision 1.107 1999/02/11 11:30:08 adam +# Updated for WIN32. +# +# Revision 1.106 1998/06/10 13:22:47 adam +# Minor changes. +# +# Revision 1.105 1998/06/10 13:00:45 adam +# Added ir-version command. +# +# Revision 1.104 1998/02/12 13:32:41 adam +# Updated configuration system. +# +# Revision 1.103 1998/01/30 13:30:50 adam +# Name of target database is irtdb.tcl instead of clientrc.tcl. +# +# Revision 1.102 1997/11/19 13:19:54 adam +# Font fix. +# +# Revision 1.101 1997/11/19 11:20:56 adam +# New target profile format - associative arrrays instead of LONG lists. +# +# Revision 1.100 1997/09/09 10:19:50 adam +# New MSV5.0 port with fewer warnings. +# +# Revision 1.99 1997/04/13 19:00:37 adam +# Added support for Tcl8.0/Tk8.0. +# New command ir-log-init to setup yaz logging facilities. +# +# Revision 1.98 1996/11/14 17:11:04 adam +# Added Explain documentaion. +# +# Revision 1.97 1996/09/13 10:54:22 adam +# Started work on Explain in client. +# +# Revision 1.96 1996/08/09 15:30:18 adam +# Procedure destroyGW modified to handle multiple calls - probably an +# error introduced by tk4.1 patch level 1. +# +# Revision 1.95 1996/07/26 09:15:08 adam +# IrTcl version 1.2 patch level 1. +# +# Revision 1.94 1996/07/25 15:55:34 adam +# IrTcl version 1.2 release. +# +# Revision 1.93 1996/06/28 08:43:54 adam +# Moved towards version 1.2. +# +# 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 @@ -296,6 +377,8 @@ # # + +# Procedure tk4 is defined - returns 0 if tk 3.6 - returns 1 otherwise if {$tk_version == "3.6"} { proc tk4 {} { return 0 @@ -306,13 +389,37 @@ if {$tk_version == "3.6"} { } } +# The following procedures deals with menu entries. The interface +# changed from Tk 3.6 to 4.X + +# Procedure irmenu +if {[tk4]} { + proc irmenu {w} { + menu $w -tearoff off + } +} else { + proc irmenu {w} { + menu $w + } +} + +# 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 +# incr n $w entryconfigure $n -state normal } proc configure-disable-e {w n} { - incr n +# incr n $w entryconfigure $n -state disabled } set noFocus [list -takefocus 0] @@ -326,6 +433,14 @@ if {[tk4]} { set noFocus {} } +# Define dummy clock function if it is not there. +if {[catch {clock seconds}]} { + proc clock {args} { + return {} + } +} +# 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 @@ -336,10 +451,18 @@ if {![tk4]} { 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" @@ -347,11 +470,38 @@ if {! [file readable ${libdir}/bitmaps/book2]} { exit 1 } +# Initialize a lot of globals. set hotTargets {} set hotInfo {} set busy 0 -set profile(Default) {{} {} {210} {} 50000 30000 tcpip {} 1 {} {} Z39 1 2 0 0 4} +set profile(Default,description) {} +set profile(Default,host) {} +set profile(Default,port) 210 +set profile(Default,authentication) {} +set profile(Default,maximumRecordSize) 50000 +set profile(Default,preferredMessageSize) 30000 +set profile(Default,comstack) tcpip +set profile(Default,namedResultSets) 1 +set profile(Default,queryRPN) 1 +set profile(Default,queryCCL) 0 +set profile(Default,protocol) Z39 +set profile(Default,windowNumber) 1 +set profile(Default,largeSetLowerBound) 2 +set profile(Default,smallSetUpperBound) 0 +set profile(Default,mediumSetPresentNumber) 0 +set profile(Default,presentChunk) 4 +set profile(Default,timeDefine) {} +set profile(Default,timeLastInit) {} +set profile(Default,timeLastExplain) {} +set profile(Default,targetInfoName) {} +set profile(Default,recentNews) {} +set profile(Default,maxResultSets) {} +set profile(Default,maxResultSize) {} +set profile(Default,maxTerms) {} +set profile(Default,multipleDatabases) 0 +set profile(Default,welcomeMessage) {} + set hostid Default set settingsChanged 0 set setNo 0 @@ -368,48 +518,118 @@ set debugMode 0 set queryTypes {Simple} set queryButtons { { {I 0} {I 1} {I 2} } } -set queryInfo { { {Title {1=4 4=1}} {Author {1=1}} \ - {Subject {1=21}} {Any {1=1016}} } } +set queryInfo {{{Title {1=4}} {Author {1=1003}} \ + {Subject {1=21}} {Any {1=1016}} {Abstract {1=62}}}} wm minsize . 0 0 set setOffset 0 set setMax 0 -proc tkerror err { - set w .tkerrorw +if {[lindex [split $tk_version .] 0] < 5} { + set font(bb,normal) -Adobe-Helvetica-Medium-R-Normal-*-240-* + set font(bb,bold) -Adobe-Helvetica-Bold-R-Normal-*-240-* + set font(b,normal) -Adobe-Helvetica-Medium-R-Normal-*-180-* + set font(b,bold) -Adobe-Helvetica-Bold-R-Normal-*-180-* + set font(n,normal) -Adobe-Helvetica-Medium-R-Normal-*-120-* + set font(n,bold) -Adobe-Helvetica-Bold-R-Normal-*-120-* + set font(s,bold) -Adobe-Helvetica-Bold-R-Normal-*-100-* + set font(ss,bold) -Adobe-Helvetica-Bold-R-Normal-*-80-* +} else { + set font(bb,normal) {Helvetica 24} + set font(bb,bold) {Helvetica 24 bold} + set font(b,normal) {Helvetica 24} + set font(b,bold) {Helvetica 18 bold} + set font(n,normal) {Helvetica 12} + set font(n,bold) {Helvetica 12 bold} + set font(s,bold) {Helvetica 10 bold} + set font(ss,bold) {Helvetica 8 bold} +} - if {[winfo exists $w]} { - destroy $w +# Procedure tkerror {err} +# err error message +# Override the Tk error handler function. +if {1} { + proc tkerror err { + global font + set w .tkerrorw + + if {[winfo exists $w]} { + destroy $w + } + toplevel $w + wm title $w "Error" + + place-force $w . + top-down-window $w + + label $w.top.b -bitmap error + message $w.top.t -aspect 300 -text "Error: $err" \ + -font $font(b,bold) + pack $w.top.b $w.top.t -side left -padx 10 -pady 10 + + bottom-buttons $w [list {Close} [list destroy $w]] 1 } - toplevel $w - wm title $w "Error" - - place-force $w . - top-down-window $w +} +# Read tag set file (if present) +if {[file readable "${libdir}/tagsets.tcl"]} { + source "${libdir}/tagsets.tcl" +} - label $w.top.b -bitmap error - message $w.top.t -aspect 300 -text "Error: $err" \ - -font -Adobe-Helvetica-Bold-R-Normal-*-180-* - pack $w.top.b $w.top.t -side left -padx 10 -pady 10 +# Read the global target configuration file. +if {[file readable "${libdir}/irtdb.tcl"]} { + source "${libdir}/irtdb.tcl" +} +# Read the local target configuration file. +if {[file readable "irtdb.tcl"]} { + source "irtdb.tcl" +} - bottom-buttons $w [list {Close} [list destroy $w]] 1 +# Read the user configuration file. +if {[file readable "~/.clientrc.tcl"]} { + source "~/.clientrc.tcl" } -if {[file readable "clientrc.tcl"]} { - source "clientrc.tcl" -} else { - if {[file readable "${libdir}/clientrc.tcl"]} { - source "${libdir}/clientrc.tcl" +# Convert old format to new format... +foreach target [array names profile] { + set timedef [clock seconds] + if {[string first , $target] == -1} { + if {![info exists profile($target,port)]} { + foreach n [array names profile Default,*] { + set profile($target,[string range $n 8 end]) $profile($n) + } + set profile($target,description) [lindex $profile($target) 0] + set profile($target,host) [lindex $profile($target) 1] + set profile($target,port) [lindex $profile($target) 2] + set profile($target,authentication) [lindex $profile($target) 3] + set profile($target,maximumRecordSize) \ + [lindex $profile($target) 4] + set profile($target,preferredMessageSize) \ + [lindex $profile($target) 5] + set profile($target,comstack) [lindex $profile($target) 6] + set profile($target,databases) [lindex $profile($target) 7] + set profile($target,timeDefine) $timedef + set profile($target,windowNumber) 1 + } + unset profile($target) } } -if {[file readable "~/.clientrc.tcl"]} { - source "~/.clientrc.tcl" +# Assign unique ID's to each target's window number +set wno 1 +foreach n [array names profile *,windowNumber] { + set profile($n) $wno + incr wno } +set profile(Default,windowNumber) $wno +# 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 @@ -428,6 +648,9 @@ proc read-formats {} { 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 @@ -435,6 +658,9 @@ proc set-wrap {m} { .data.record configure -wrap $m } +# Procedure dputs {m} +# m string to be printed +# puts utility for debugging. proc dputs {m} { global debugMode if {$debugMode} { @@ -442,6 +668,8 @@ proc dputs {m} { } } +# Procedure apduDump {} +# Logs BER dump of last APDU in window if debugMode is true. proc apduDump {} { global debugMode @@ -463,9 +691,9 @@ proc apduDump {} { top-down-window $w - text $w.top.t -width 60 -height 12 -wrap word -relief flat \ - -borderwidth 0 \ - -yscrollcommand [list $w.top.s set] + text $w.top.t -font fixed -width 60 -height 12 -wrap word \ + -relief flat -borderwidth 0 \ + -yscrollcommand [list $w.top.s set] -background grey85 scrollbar $w.top.s -command [list $w.top.t yview] pack $w.top.s -side right -fill y @@ -482,11 +710,11 @@ proc apduDump {} { } - +# 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 - global busy + global displayFormat setNo busy set displayFormat $f if {$setNo == 0} { @@ -499,24 +727,15 @@ proc set-display-format {f} { 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> {} - bind $w {} - bind $w {} - bind $w {} - bind $w {} - bind $w {} - bind $w <2> {} - bind $w {} - bind $w {} - bind $w {} - bind $w {} - bind $w {} - bind $w {} - bind $w {} - bind $w {} + global TextBinding + foreach e [bind Text] { + set TextBinding($e) [bind Text $e] + bind Text $e {} + } set w Listbox bind $w {} bind $w {} @@ -524,6 +743,20 @@ proc initBindings {} { set w Entry } +# Procedure TextEditable +# Apply "standard" events to a text widget. It should be editable now. +proc TextEditable {w} { + global TextBinding + + foreach e [array names TextBinding] { + bind $w $e $TextBinding($e) + } +} + +# 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 @@ -532,24 +765,53 @@ proc post-menu {wbutton wmenu} { } +# 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] + + set p1 [string first + $g] + set p2 [string last + $g] + + set x [expr 40+[string range $g [expr $p1 +1] [expr $p2 -1]]] + set y [expr 60+[string range $g [expr $p2 +1] end]] + wm geometry $window +${x}+${y} +} + +# 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] + catch {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 toplevel $w if {[info exists windowGeometry($w)]} { set g $windowGeometry($w) - if {$g != ""} { + if {[string length $g]} { wm geometry $w $g } } bind $w [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 @@ -558,6 +820,22 @@ proc top-down-window {w} { pack $w.bot -fill both } +# 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+20+20 +} else { + wm geometry . $g +} + +# 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 @@ -574,6 +852,15 @@ proc top-down-ok-cancel {w ok-action g} { } } +# 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] @@ -598,10 +885,14 @@ proc bottom-buttons {w buttonList g} { } } +# 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 +# busy when this procedure exists. proc cancel-operation {} { - global cancelFlag - global busy - global delayRequest + global cancelFlag busy delayRequest if {$busy} { set cancelFlag 1 @@ -610,23 +901,30 @@ proc cancel-operation {} { } } +# 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 - - if {$target == ""} { - .bot.a.target configure -text "" + if {![string length $target]} { + .bot.a.target configure -text {} return } - if {$base == ""} { + if {![string length $base]} { .bot.a.target configure -text "$target" } else { .bot.a.target configure -text "$target - $base" } } +# 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 + global busy libdir if {$busy != 0} { incr v1 @@ -646,13 +944,17 @@ proc show-logo {v1} { } } } - + +# 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 - global setOffset - global setMax - global setNo + global busy scanEnable + global setOffset setMax setNo .bot.a.status configure -text "$status" if {$b == 1} { @@ -668,6 +970,8 @@ proc show-status {status b sb} { .mid.search configure -state normal if {$scanEnable} { .mid.scan configure -state normal + } else { + configure-disable-e .top.service.m 3 } if {$setNo == 0} { configure-disable-e .top.service.m 1 @@ -696,10 +1000,19 @@ proc show-status {status b sb} { } } +# 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 @@ -711,6 +1024,8 @@ proc insertWithTags {w text args} { } } +# Procedure popup-license +# Displays LICENSE information. proc popup-license {} { global libdir set w .popup-licence @@ -723,7 +1038,7 @@ proc popup-license {} { 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 @@ -740,9 +1055,12 @@ proc popup-license {} { 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 + global hostid font toplevel $w @@ -756,8 +1074,7 @@ proc about-target {} { pack $w.top.a $w.top.p -side top -fill x label $w.top.a.about -text "About" - label $w.top.a.irtcl -text $hostid \ - -font -Adobe-Helvetica-Bold-R-Normal-*-240-* + label $w.top.a.irtcl -text $hostid -font $font(bb,bold) pack $w.top.a.about $w.top.a.irtcl -side top set i [z39 targetImplementationName] @@ -774,6 +1091,9 @@ proc about-target {} { 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 @@ -788,10 +1108,11 @@ proc about-origin-logo {n} { 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 - global tk_version + global libdir font tk_version if {[winfo exists $w]} { destroy $w @@ -807,31 +1128,31 @@ proc about-origin {} { pack $w.top.a $w.top.p -side top -fill x - label $w.top.a.irtcl -text "IrTcl" \ - -font -Adobe-Helvetica-Bold-R-Normal-*-240-* + label $w.top.a.irtcl -text "IrTcl" -font $font(bb,bold) label $w.top.a.logo -bitmap @${libdir}/bitmaps/book1 pack $w.top.a.irtcl $w.top.a.logo -side left -expand yes - set i unknown - catch {set i [z39 implementationName]} - label $w.top.p.in -text "Implementation name: $i" - catch {set i [z39 implementationId]} - label $w.top.p.ii -text "Implementation id: $i" - catch {set i [z39 implementationVersion]} - label $w.top.p.iv -text "Implementation version: $i" - set i $tk_version - label $w.top.p.tk -text "Tk version: $i" + label $w.top.p.irtcl -text "IrTcl version: [lindex [ir-version] 0]" + label $w.top.p.yaz -text "Yaz version: [lindex [ir-version] 1]" - pack $w.top.p.in $w.top.p.ii $w.top.p.iv $w.top.p.tk -side top -anchor nw + label $w.top.p.tk -text "Tk version: $tk_version" + + pack $w.top.p.irtcl $w.top.p.yaz $w.top.p.tk -side top -anchor nw about-origin-logo 1 bottom-buttons $w [list {Close} [list destroy $w] \ {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 + global font displayFormats popupMarcdf if {[z39.$sno type $no] != "DB"} { return @@ -855,8 +1176,9 @@ proc popup-marc {sno no b df} { 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] -background grey85 scrollbar $w.top.s -command [list $w.top.record yview] global monoFlag @@ -868,18 +1190,14 @@ proc popup-marc {sno no b df} { $w.top.record tag configure marc-id -foreground black } $w.top.record tag configure marc-data -foreground black - $w.top.record tag configure marc-head \ - -font -Adobe-Times-Medium-R-Normal-*-180-* \ + $w.top.record tag configure marc-head -font $font(n,bold) \ -background black -foreground white - $w.top.record tag configure marc-pref \ - -font -Adobe-Times-Medium-R-Normal-*-180-* \ + $w.top.record tag configure marc-pref -font $font(n,normal) \ -foreground blue - $w.top.record tag configure marc-text \ - -font -Adobe-Times-Medium-R-Normal-*-180-* \ + $w.top.record tag configure marc-text -font $font(n,normal) \ -foreground black - $w.top.record tag configure marc-it \ - -font -Adobe-Times-Medium-I-Normal-*-180-* \ + $w.top.record tag configure marc-it -font $font(n,normal) \ -foreground black pack $w.top.s -side right -fill y @@ -892,7 +1210,7 @@ proc popup-marc {sno no b df} { {Duplicate} {}] 0 menubutton $w.bot.formats -text "Format" -menu $w.bot.formats.m \ -relief raised - menu $w.bot.formats.m + irmenu $w.bot.formats.m pack $w.bot.formats -expand yes -ipadx 2 -ipady 2 \ -padx 3 -pady 3 -side left } else { @@ -930,6 +1248,12 @@ proc popup-marc {sno no b df} { $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 @@ -946,6 +1270,10 @@ proc update-target-hotlist {target base} { 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 @@ -960,12 +1288,16 @@ proc delete-target-hotlist {target} { 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 if {$olen > 0} { if {[tk4]} { - .top.target.m delete 7 [expr 7+$olen] + .top.target.m delete 6 [expr 6+$olen] } else { .top.target.m delete 6 [expr 6+$olen] } @@ -974,7 +1306,7 @@ proc set-target-hotlist {olen} { foreach e $hotTargets { set target [lindex $e 0] set base [lindex $e 1] - if {$base == ""} { + if {![string length $base]} { .top.target.m add command -label "$i $target" -command \ [list reopen-target $target {}] } else { @@ -988,36 +1320,50 @@ proc set-target-hotlist {olen} { } } +# 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 set target [.target-define.top.target.entry get] - if {$target == ""} { + if {![string length $target]} { return } - foreach n [array names profile] { - if {$n == $target} { + foreach n [array names profile *,host] { + if {![string compare $n ${target},host]} { destroy .target-define protocol-setup $n return } } - set seq [lindex $profile(Default) 12] - dputs "seq=${seq}" - dputs $profile(Default) - set profile($target) $profile(Default) - set profile(Default) [lreplace $profile(Default) 12 12 [incr seq]] - + foreach n [array names profile Default,*] { + set profile($target,[string range $n 8 end]) $profile($n) + + } + incr profile(Default,windowNumber) + protocol-setup $target 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 @@ -1031,65 +1377,68 @@ proc fail-response {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 + init-request $target $base } +# 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 global presentChunk z39 disconnect - z39 comstack [lindex $profile($target) 6] - z39 protocol [lindex $profile($target) 11] - z39 idAuthentication [lindex $profile($target) 3] - z39 maximumRecordSize [lindex $profile($target) 4] - z39 preferredMessageSize [lindex $profile($target) 5] - dputs "maximumRecordSize=" - dputs [z39 maximumRecordSize] - dputs "preferredMessageSize=" - dputs [z39 preferredMessageSize] + z39 comstack $profile($target,comstack) + z39 protocol $profile($target,protocol) + eval z39 idAuthentication $profile($target,authentication) + z39 maximumRecordSize $profile($target,maximumRecordSize) + z39 preferredMessageSize $profile($target,preferredMessageSize) + dputs "maximumRecordSize=[z39 maximumRecordSize]" + dputs "preferredMessageSize=[z39 preferredMessageSize]" show-status Connecting 1 0 - if {$base == ""} { - z39 databaseNames [lindex [lindex $profile($target) 7] 0] - } else { - z39 databaseNames $base - } - set x [lindex $profile($target) 13] - if {$x == ""} { + set x $profile($target,largeSetLowerBound) + if {![string length $x]} { set x 2 } z39 largeSetLowerBound $x - - set x [lindex $profile($target) 14] - if {$x == ""} { + + set x $profile($target,smallSetUpperBound) + if {![string length $x]} { set x 0 } z39 smallSetUpperBound $x - - set x [lindex $profile($target) 15] - if {$x == ""} { + + set x $profile($target,mediumSetPresentNumber) + if {![string length $x]} { set x 0 } z39 mediumSetPresentNumber $x - set presentChunk [lindex $profile($target) 16] - if {$presentChunk == ""} { + set presentChunk $profile($target,presentChunk) + if {![string length $presentChunk]} { set presentChunk 4 } z39 failback [list fail-response $target] z39 callback [list connect-response $target $base] + show-target $target $base update idletasks set err [catch { - z39 connect [lindex $profile($target) 1]:[lindex $profile($target) 2] + z39 connect $profile($target,host):$profile($target,port) } errorMessage] if {$err} { + set hostid Default tkerror $errorMessage show-status "Not connected" 0 {} + show-target {} {} return } set hostid $target @@ -1098,6 +1447,8 @@ proc open-target {target base} { configure-enable-e .top.target.m 2 } +# Procedure close-target +# Shuts down the connection with current target. proc close-target {} { global hostid global cancelFlag @@ -1117,7 +1468,7 @@ proc close-target {} { configure-disable-e .top.target.m 1 configure-disable-e .top.target.m 2 if {[tk4]} { - .top.rset.m delete 2 last + .top.rset.m delete 1 last } else { .top.rset.m delete 1 last } @@ -1125,6 +1476,9 @@ proc close-target {} { 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 @@ -1147,6 +1501,9 @@ proc load-set-action {} { 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 @@ -1165,14 +1522,17 @@ proc load-set {} { focus $oldFocus } -proc init-request {} { +# Procedure init-request +# Sends an initialize request to the target. This procedure is called +# when a connect has been established. +proc init-request {target base} { global cancelFlag if {$cancelFlag} { close-target return } - z39 callback {init-response} + z39 callback [list init-response $target $base] show-status Initializing 1 {} set err [catch {z39 init} errorMessage] if {$err} { @@ -1181,31 +1541,92 @@ proc init-request {} { } } -proc init-response {} { - global cancelFlag - global scanEnable +# 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 {target base} { + global cancelFlag profile scanEnable settingsChanged - dputs {init-reponse} + dputs {init-response} apduDump if {$cancelFlag} { close-target return } if {![z39 initResult]} { - show-status Ready 0 1 set u [z39 userInformationField] close-target tkerror "Connection rejected by target: $u" } else { - if {[lsearch [z39 options] scan] >= 0} { - set scanEnable 1 - } else { - set scanEnable 0 - } - show-status Ready 0 1 + z39 failback [list explain-crash $target $base] + explain-check $target [list ready-response $base] } } +# Procedure explain-crash +# Handles target that dies during explain. +proc explain-crash {target base} { + global profile settingsChanged + + set profile($target,timeLastInit) [clock seconds] + set profile($target,timeLastExplain) {} + set settingsChanged 1 + + show-message {} + open-target $target $base +} + +# Procedure explain-check +# Stub function to check explain. May be overwritten later. +proc explain-check {target response} { + eval $response [list $target] +} + +# Procedure ready-response +# Called after a target has been initialized and, possibly, explained +proc ready-response {base target} { + global profile settingsChanged scanEnable + + z39 failback [list fail-response $target] + if {[string length $base]} { + set profile($target,timeLastInit) [clock seconds] + set settingsChanged 1 + + z39 databaseNames $base + cascade-dblist $target $base + show-target $target $base + } + if {[lsearch [z39 options] scan] >= 0} { + set scanEnable 1 + } else { + set scanEnable 0 + } + .data.record delete 1.0 end + set desc [string trim $profile($target,description)] + if {[string length $desc]} { + .data.record insert end "$desc\n\n" + } else { + .data.record insert end "$target\n\n" + } + set data [string trim $profile($target,welcomeMessage)] + if {[string length $data]} { + .data.record insert end "Welcome Message:\n$data\n\n" + } + set data [string trim $profile($target,recentNews)] + if {[string length $data]} { + .data.record insert end "News:\n$data\n" + } + show-message {} + show-status Ready 0 1 +} + +# 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 @@ -1218,8 +1639,8 @@ proc search-request {bflag} { global elementSetNames set target $hostid - - if {[z39 connect] == ""} { + + if {![string length [z39 connect]]} { return } dputs "search-request" @@ -1237,34 +1658,33 @@ proc search-request {bflag} { set delayRequest {} set query [index-query] - if {$query==""} { + if {![string length $query]} { return } incr setNoLast set setNo $setNoLast ir-set z39.$setNo z39 - - if {[lindex $profile($target) 10] == 1} { + + if {$profile($target,namedResultSets)} { z39.$setNo setName $setNo dputs "setName=${setNo}" } else { - z39.$setNo setName Default - dputs "setName=Default" - } - if {[lindex $profile($target) 8] == 1} { - z39.$setNo queryType rpn + z39.$setNo setName default + dputs "setName=default" } - if {[lindex $profile($target) 9] == 1} { - z39.$setNo queryType ccl + if {$profile($target,queryRPN)} { + z39.$setNo queryType rpn + } elseif {$profile($target,queryCCL)} { + z39.$setNo queryType ccl } dputs Setting dputs $recordSyntax - if {$recordSyntax == "None" } { + if {![string compare $recordSyntax None]} { z39.$setNo preferredRecordSyntax {} } else { z39.$setNo preferredRecordSyntax $recordSyntax } - if {$elementSetNames == "None" } { + if {![string compare $elementSetNames None]} { z39.$setNo elementSetNames {} z39.$setNo smallSetElementSetNames {} z39.$setNo mediumSetElementSetNames {} @@ -1278,6 +1698,11 @@ proc search-request {bflag} { 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] @@ -1286,6 +1711,9 @@ proc scan-copy {y entry} { .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 @@ -1355,6 +1783,11 @@ proc scan-request {} { 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 @@ -1372,7 +1805,7 @@ proc scan-term-h {attr} { z39.scan numberOfTermsRequested 5 z39.scan preferredPositionInResponse 1 dputs "${attr} \{${scanTerm}\}" - if {$scanTerm == ""} { + if {![string length $scanTerm]} { z39.scan scan "${attr} 0" } else { z39.scan scan "${attr} \{${scanTerm}\}" @@ -1380,6 +1813,16 @@ proc scan-term-h {attr} { 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 @@ -1414,7 +1857,7 @@ proc scan-response {attr start toget} { z39.scan preferredPositionInResponse 1 set scanTerm $nScanTerm dputs "${attr} \{${scanTerm}\}" - if {$scanTerm == ""} { + if {![string length $scanTerm]} { z39.scan scan "${attr} 0" } else { z39.scan scan "${attr} \{${scanTerm}\}" @@ -1490,6 +1933,11 @@ proc scan-response {attr start toget} { 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 @@ -1521,6 +1969,11 @@ proc scan-down {attr} { $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 @@ -1550,6 +2003,13 @@ proc scan-up {attr} { $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 50 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 @@ -1575,7 +2035,7 @@ proc search-response {} { set setMax [z39.$setNo resultCount] show-status Ready 0 1 set status [z39.$setNo responseStatus] - if {[lindex $status 0] == "NSD"} { + if {![string compare [lindex $status 0] NSD]} { z39.$setNo nextResultSetPosition 0 set code [lindex $status 1] set msg [lindex $status 2] @@ -1591,9 +2051,9 @@ proc search-response {} { 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] - if {$setMax > 20} { - set setMax 20 + -command [list recall-set $setNo] + if {$setMax > 50} { + set setMax 50 } set no [z39.$setNo numberOfRecordsReturned] dputs "Returned $no records, setOffset $setOffset" @@ -1613,6 +2073,13 @@ proc search-response {} { } } +# 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 @@ -1644,7 +2111,7 @@ proc present-more {number} { show-status Ready 0 1 return } - if {$number == ""} { + if {![string length $number]} { set setMax $max } else { incr setMax $number @@ -1653,7 +2120,7 @@ proc present-more {number} { } } z39 callback {present-response} - + set toGet [expr $setMax - $setOffset + 1] if {$toGet <= 0} { return @@ -1665,10 +2132,25 @@ proc present-more {number} { 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 + .data.record delete 1.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 @@ -1682,9 +2164,8 @@ proc add-title-lines {setno no offset} { set setno $setNo } if {$offset == 1} { - .bot.a.set configure -text $setno - .data.record delete 0.0 end + .data.record delete 1.0 end } set ffunc [lindex $displayFormats $displayFormat] dputs "ffunc=$ffunc" @@ -1692,7 +2173,7 @@ proc add-title-lines {setno no offset} { for {set i 0} {$i < $no} {incr i} { set o [expr $i + $offset] set type [z39.$setno type $o] - if {$type == ""} { + if {![string length $type]} { dputs "no more at $o" break } @@ -1710,6 +2191,10 @@ proc add-title-lines {setno no offset} { } } +# 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 @@ -1733,7 +2218,7 @@ proc present-response {} { return } set status [z39.$setNo responseStatus] - if {[lindex $status 0] == "NSD"} { + if {![string compare [lindex $status 0] NSD]} { show-status Ready 0 1 set code [lindex $status 1] set msg [lindex $status 2] @@ -1753,6 +2238,9 @@ proc present-response {} { } } +# 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} { @@ -1762,6 +2250,9 @@ proc left-cursor {w} { 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 @@ -1769,6 +2260,12 @@ proc right-cursor {w} { $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 , , , +# and . proc bind-fields {list returnAction escapeAction} { set max [expr [llength $list]-1] for {set i 0} {$i < $max} {incr i} { @@ -1793,6 +2290,12 @@ proc bind-fields {list returnAction escapeAction} { 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 @@ -1809,6 +2312,8 @@ proc entry-fields {parent list tlist returnAction escapeAction} { 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 @@ -1824,69 +2329,65 @@ proc define-target-dialog {} { 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 + global profile settingsChanged set a [alert "Are you sure you want to delete the target \ definition $target ?"] if {$a} { destroy $w - unset profile($target) + foreach n [array names profile $target,*] { + unset profile($n) + } set settingsChanged 1 cascade-target-list delete-target-hotlist $target } } +# 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 $profileS contains most of the +# information the user may modify. proc protocol-setup-action {target w} { - global profile - global settingsChanged - global targetS + global profile settingsChanged profileS set dataBases {} set settingsChanged 1 + + puts "protocol-setup-action" + set timedef $profile($target,timeDefine) + if {![string length $timedef]} { + set timedef [clock seconds] + } + set profileS($target,timeDefine) $timedef + + foreach n [array names profile $target,*] { + set profile($n) $profileS($n) + unset profileS($n) + } + set len [$w.top.databases.list size] + catch {unset profile($target,databases)} for {set i 0} {$i < $len} {incr i} { - lappend dataBases [$w.top.databases.list get $i] - } - set wno [lindex $profile($target) 12] - - set profile($target) [list [$w.top.description.entry get] \ - [$w.top.host.entry get] \ - [$w.top.port.entry get] \ - [$w.top.idAuthentication.entry get] \ - $targetS($target,MRS) \ - $targetS($target,PMS) \ - $targetS($target,csType) \ - $dataBases \ - $targetS($target,RPN) \ - $targetS($target,CCL) \ - $targetS($target,ResultSets) \ - $targetS($target,protocolType) \ - $wno \ - $targetS($target,LSLB) \ - $targetS($target,SSUB) \ - $targetS($target,MSPN) \ - $targetS($target,presentChunk) ] + lappend profile($target,databases) [$w.top.databases.list get $i] + } cascade-target-list delete-target-hotlist $target - dputs $profile($target) destroy $w } -proc place-force {window parent} { - set g [wm geometry $parent] - - set p1 [string first + $g] - set p2 [string last + $g] - - set x [expr 40+[string range $g [expr $p1 +1] [expr $p2 -1]]] - set y [expr 60+[string range $g [expr $p2 +1] end]] - 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 @@ -1895,6 +2396,10 @@ proc add-database-action {target w} { 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 @@ -1918,6 +2423,12 @@ proc add-database {target wp} { 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 @@ -1935,9 +2446,13 @@ proc delete-database {target w} { } } +# Procedure protocol-setup {target} +# target target to be defined +# Makes a dialog in which the user may modify/view a target definition +# (profile). The $profileS - array holds the initial definition of the +# target. proc protocol-setup {target} { - global profile - global targetS + global profile profileS set bno 0 while {[winfo exists .setup-$bno]} { @@ -1951,16 +2466,18 @@ proc protocol-setup {target} { top-down-window $w - if {$target == ""} { + if {![string length $target]} { set target Default } - dputs target - dputs $profile($target) + foreach n [array names profile $target,*] { + set profileS($n) $profile($n) + } frame $w.top.description frame $w.top.host frame $w.top.port frame $w.top.idAuthentication + frame $w.top.cs-type -relief ridge -border 2 frame $w.top.protocol -relief ridge -border 2 frame $w.top.query -relief ridge -border 2 @@ -1979,24 +2496,15 @@ proc protocol-setup {target} { bind $w.top.$sub.entry [list add-database $target $w] bind $w.top.$sub.entry [list delete-database $target $w] } - $w.top.description.entry insert 0 [lindex $profile($target) 0] - $w.top.host.entry insert 0 [lindex $profile($target) 1] - $w.top.port.entry insert 0 [lindex $profile($target) 2] - $w.top.idAuthentication.entry insert 0 [lindex $profile($target) 3] - set targetS($target,csType) [lindex $profile($target) 6] - set targetS($target,RPN) [lindex $profile($target) 8] - set targetS($target,CCL) [lindex $profile($target) 9] - set targetS($target,ResultSets) [lindex $profile($target) 10] - set targetS($target,protocolType) [lindex $profile($target) 11] - if {$targetS($target,protocolType) == ""} { - set targetS($target,protocolType) Z39 - } - set targetS($target,LSLB) [lindex $profile($target) 13] - set targetS($target,SSUB) [lindex $profile($target) 14] - set targetS($target,MSPN) [lindex $profile($target) 15] - set targetS($target,presentChunk) [lindex $profile($target) 16] - set targetS($target,MRS) [lindex $profile($target) 4] - set targetS($target,PMS) [lindex $profile($target) 5] + $w.top.description.entry configure -textvariable \ + profileS($target,description) + $w.top.host.entry configure -textvariable \ + profileS($target,host) + $w.top.port.entry configure -textvariable \ + profileS($target,port) + $w.top.idAuthentication.entry configure -textvariable \ + profileS($target,authentication) + # Databases .... pack $w.top.databases -side left -pady 2 -padx 2 -expand yes -fill both @@ -2023,18 +2531,19 @@ proc protocol-setup {target} { -padx 2 -pady 2 $w.top.databases.scroll config -command "$w.top.databases.list yview" - foreach b [lindex $profile($target) 7] { - $w.top.databases.list insert end $b + if {[info exists profile($target,databases)]} { + foreach b $profile($target,databases) { + $w.top.databases.list insert end $b + } } - # Transport ... pack $w.top.cs-type -pady 2 -padx 2 -side top -fill x label $w.top.cs-type.label -text "Transport" radiobutton $w.top.cs-type.tcpip -text "TCP/IP" -anchor w \ - -variable targetS($target,csType) -value tcpip + -variable profileS($target,comstack) -value tcpip radiobutton $w.top.cs-type.mosi -text "MOSI" -anchor w\ - -variable targetS($target,csType) -value mosi + -variable profileS($target,comstack) -value mosi pack $w.top.cs-type.label $w.top.cs-type.tcpip $w.top.cs-type.mosi \ -padx 2 -side top -fill x @@ -2044,9 +2553,9 @@ proc protocol-setup {target} { label $w.top.protocol.label -text "Protocol" radiobutton $w.top.protocol.z39v2 -text "Z39.50" -anchor w \ - -variable targetS($target,protocolType) -value Z39 + -variable profileS($target,protocol) -value Z39 radiobutton $w.top.protocol.sr -text "SR" -anchor w \ - -variable targetS($target,protocolType) -value SR + -variable profileS($target,protocol) -value SR pack $w.top.protocol.label $w.top.protocol.z39v2 $w.top.protocol.sr \ -padx 2 -side top -fill x @@ -2056,11 +2565,11 @@ proc protocol-setup {target} { label $w.top.query.label -text "Query support" checkbutton $w.top.query.c1 -text "RPN query" -anchor w \ - -variable targetS($target,RPN) + -variable profileS($target,queryRPN) checkbutton $w.top.query.c2 -text "CCL query" -anchor w \ - -variable targetS($target,CCL) + -variable profileS($target,queryCCL) checkbutton $w.top.query.c3 -text "Result sets" -anchor w \ - -variable targetS($target,ResultSets) + -variable profileS($target,namedResultSets) pack $w.top.query.label -side top pack $w.top.query.c1 $w.top.query.c2 $w.top.query.c3 \ @@ -2073,10 +2582,14 @@ proc protocol-setup {target} { {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 + global profileS set w .advanced-setup-$b @@ -2086,7 +2599,7 @@ proc advanced-setup {target b} { top-down-window $w - if {$target == ""} { + if {![string length $target]} { set target Default } dputs target @@ -2111,32 +2624,46 @@ proc advanced-setup {target b} { {Maximum Record Size:} {Preferred Message Size:}} \ [list advanced-setup-action $target $b] [list destroy $w] - $w.top.largeSetLowerBound.entry insert 0 $targetS($target,LSLB) - $w.top.smallSetUpperBound.entry insert 0 $targetS($target,SSUB) - $w.top.mediumSetPresentNumber.entry insert 0 $targetS($target,MSPN) - $w.top.presentChunk.entry insert 0 $targetS($target,presentChunk) - $w.top.maximumRecordSize.entry insert 0 $targetS($target,MRS) - $w.top.preferredMessageSize.entry insert 0 $targetS($target,PMS) + $w.top.largeSetLowerBound.entry configure -textvariable \ + profileS($target,largeSetLowerBound) + $w.top.smallSetUpperBound.entry configure -textvariable \ + profileS($target,smallSetUpperBound) + $w.top.mediumSetPresentNumber.entry configure -textvariable \ + profileS($target,mediumSetPresentNumber) + $w.top.presentChunk.entry configure -textvariable \ + profileS($target,presentChunk) + $w.top.maximumRecordSize.entry configure -textvariable \ + profileS($target,maximumRecordSize) + $w.top.preferredMessageSize.entry configure -textvariable \ + profileS($target,preferredMessageSize) bottom-buttons $w [list {Ok} [list advanced-setup-action $target $b] \ {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 $profileS - array. proc advanced-setup-action {target b} { set w .advanced-setup-$b - global targetS + global profileS - set targetS($target,LSLB) [$w.top.largeSetLowerBound.entry get] - set targetS($target,SSUB) [$w.top.smallSetUpperBound.entry get] - set targetS($target,MSPN) [$w.top.mediumSetPresentNumber.entry get] - set targetS($target,presentChunk) [$w.top.presentChunk.entry get] - set targetS($target,MRS) [$w.top.maximumRecordSize.entry get] - set targetS($target,PMS) [$w.top.preferredMessageSize.entry get] + set profileS($target,LSLB) [$w.top.largeSetLowerBound.entry get] + set profileS($target,SSUB) [$w.top.smallSetUpperBound.entry get] + set profileS($target,MSPN) [$w.top.mediumSetPresentNumber.entry get] + set profileS($target,presentChunk) [$w.top.presentChunk.entry get] + set profileS($target,MRS) [$w.top.maximumRecordSize.entry get] + set profileS($target,PMS) [$w.top.preferredMessageSize.entry get] dputs "advanced-setup-action" 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 {} @@ -2149,6 +2676,8 @@ proc database-select-action {} { 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 @@ -2176,13 +2705,38 @@ proc database-select {} { -padx 2 -pady 2 $w.top.databases.scroll config -command "$w.top.databases.list yview" - foreach b [lindex $profile($hostid) 7] { + foreach b $profile($hostid,databases) { $w.top.databases.list insert end $b } top-down-ok-cancel $w {database-select-action} 1 focus $oldFocus } +# Procedure cascase-dblist-select +proc cascade-dblist-select {target db} { + show-target $target $db + z39 databaseNames $db +} + +# Procedure cascade-dblist +# Makes the Service/database list with proper databases for the target +proc cascade-dblist {target base} { + global profile + + set w .top.service.m.dblist + $w delete 0 200 + if {[info exists profile($target,databases)]} { + foreach db $profile($target,databases) { + $w add command -label $db \ + -command [list cascade-dblist-select $target $db] + } + } +} + +# 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 @@ -2190,30 +2744,49 @@ proc cascade-target-list {} { destroy $sub } .top.target.m.clist delete 0 last - foreach n [lsort [array names profile]] { - if {$n != "Default"} { - set nl [lindex $profile($n) 12] - if {[llength [lindex $profile($n) 7]] > 1} { - .top.target.m.clist add cascade -label $n \ - -menu .top.target.m.clist.$nl - menu .top.target.m.clist.$nl - foreach b [lindex $profile($n) 7] { - .top.target.m.clist.$nl add command -label $b \ - -command [list reopen-target $n $b] - } - } else { - .top.target.m.clist add command -label $n \ - -command [list reopen-target $n {}] - } - } + foreach nn [lsort [array names profile *,host]] { + if {[string length $profile($nn)]} { + set ll [expr [string length $nn] - 6] + set n [string range $nn 0 $ll] + + set nl $profile($n,windowNumber) + if {[info exists profile($n,databases)]} { + set ndb [llength $profile($n,databases)] + } else { + set ndb 0 + } + if {$ndb > 1} { + .top.target.m.clist add cascade -label $n \ + -menu .top.target.m.clist.$nl + irmenu .top.target.m.clist.$nl + foreach b $profile($n,databases) { + .top.target.m.clist.$nl add command -label $b \ + -command [list reopen-target $n $b] + } + } elseif {$ndb == 1} { + .top.target.m.clist add command -label $n -command \ + [list reopen-target $n [lindex $profile($n,databases) 0]] + } else { + .top.target.m.clist add command -label $n -command \ + [list reopen-target $n {}] + } + } } .top.target.m.slist delete 0 last - foreach n [lsort [array names profile]] { + foreach nn [lsort [array names profile *,host]] { + set ll [expr [string length $nn] - 6] + set n [string range $nn 0 $ll] + .top.target.m.slist add command -label $n \ -command [list protocol-setup $n] } } +# 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 @@ -2226,6 +2799,9 @@ proc query-select {i} { 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 @@ -2241,6 +2817,9 @@ proc query-new-action {} { 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 @@ -2258,6 +2837,9 @@ proc 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 @@ -2273,6 +2855,10 @@ proc query-delete-action {queryNo} { 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 @@ -2291,6 +2877,8 @@ query type $n ?" -aspect 300 {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 @@ -2316,6 +2904,11 @@ proc cascade-query-list {} { } } +# 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 @@ -2332,24 +2925,30 @@ proc save-geometry {} { return } if {$hostid != "Default"} { - puts $f "set hostid \{$hostid\}" + puts $f "set hostid [list $hostid]" set b [z39 databaseNames] - puts $f "set hostbase $b" + puts $f "set hostbase [list $b]" } - puts $f "set hotTargets \{ $hotTargets \}" + puts $f "set hotTargets [list $hotTargets]" puts $f "set textWrap $textWrap" puts $f "set displayFormat $displayFormat" puts $f "set popupMarcdf $popupMarcdf" puts $f "set recordSyntax $recordSyntax" puts $f "set elementSetNames $elementSetNames" foreach n [array names windowGeometry] { - puts -nonewline $f "set \{windowGeometry($n)\} \{" - puts -nonewline $f $windowGeometry($n) - puts $f "\}" + dputs "set [list windowGeometry($n)] " + dputs [list $windowGeometry($n)] + + puts -nonewline $f "set [list windowGeometry($n)] " + puts $f [list $windowGeometry($n)] } close $f } +# Procedure save-settings +# This procedure saves the per-host related settings irtdb.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 @@ -2357,43 +2956,35 @@ proc save-settings {} { global queryTypes global queryButtons global queryInfo - - if {![file writable "${libdir}/clientrc.tcl"]} { - set a [alert "Cannot open ${libdir}/clientrc.tcl for writing. Do you \ - wish to save clientrc.tcl in the current directory instead?"] - if {! $a} { - return - } - set f [open "clientrc.tcl" w] + + if {[file writable "${libdir}/irtdb.tcl"]} { + set f [open "${libdir}/irtdb.tcl" w] } else { - set f [open "${libdir}/clientrc.tcl" w] + set f [open "irtdb.tcl" w] } puts $f "# Setup file" - foreach n [array names profile] { - puts -nonewline $f "set \{profile($n)\} \{" - puts -nonewline $f $profile($n) - puts $f "\}" + foreach n [lsort [array names profile]] { + puts $f "set [list profile($n)] [list $profile($n)]" } - puts -nonewline $f "set queryTypes \{" - puts -nonewline $f $queryTypes - puts $f "\}" + puts $f "set queryTypes [list $queryTypes]" - puts -nonewline $f "set queryButtons \{" - puts -nonewline $f $queryButtons - puts $f "\}" + puts $f "set queryButtons [list $queryButtons]" - puts -nonewline $f "set queryInfo \{" - puts -nonewline $f $queryInfo - puts $f "\}" + puts $f "set queryInfo [list $queryInfo]" close $f 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 - global alertAnswer + global alertAnswer font toplevel $w set oldFocus [focus] @@ -2401,8 +2992,7 @@ proc alert {ask} { top-down-window $w label $w.top.warning -bitmap warning - message $w.top.message -text $ask -aspect 300 \ - -font -Adobe-Times-Medium-R-Normal-*-180-* + message $w.top.message -text $ask -aspect 300 -font $font(b,normal) pack $w.top.warning $w.top.message -side left -pady 5 -padx 10 -expand yes @@ -2412,30 +3002,48 @@ proc alert {ask} { 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 exists the application proc exit-action {} { global settingsChanged if {$settingsChanged} { - set a [alert "you haven't saved your settings. Do you wish to save?"] - if {$a} { - save-settings - } + save-settings } save-geometry 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] @@ -2443,7 +3051,10 @@ proc listbuttonx {button no names handle user} { } else { menubutton $button -text [lindex [lindex $names $no] 0] \ -width 10 -menu ${button}.m -relief raised -border 1 - menu ${button}.m + irmenu ${button}.m + if {[tk4]} { + ${button}.m configure -tearoff off + } } set i 0 foreach name $names { @@ -2454,16 +3065,31 @@ proc listbuttonx {button no names handle user} { } } +# 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 + irmenu ${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 @@ -2471,6 +3097,13 @@ proc listbuttonv-action {button var names i} { $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 @@ -2490,13 +3123,19 @@ proc listbuttonv {button var names} { } menubutton $button -text $n -menu ${button}.m \ -relief raised -border 1 - menu ${button}.m + irmenu ${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 @@ -2513,6 +3152,9 @@ proc query-add-index-action {queryNo} { #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 @@ -2527,6 +3169,9 @@ proc query-add-line {queryNo} { #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 @@ -2542,6 +3187,9 @@ proc query-del-line {queryNo} { 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 @@ -2559,6 +3207,11 @@ proc query-add-index {queryNo} { 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 @@ -2582,6 +3235,12 @@ proc query-setup-action {queryNo} { 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 @@ -2591,6 +3250,12 @@ proc activate-e-index {value no i} { 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 @@ -2599,6 +3264,12 @@ proc activate-index {value no i} { 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\ @@ -2619,6 +3290,12 @@ proc update-attr {} { {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 @@ -2720,6 +3397,7 @@ proc use-attr {init} { {Host item} 1033 {Content type} 1034 {Anywhere} 1035 + {Author-Title-Subject} 1036 } set w .index-setup global useTmpValue @@ -2756,6 +3434,12 @@ proc use-attr {init} { } } +# 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] @@ -2795,6 +3479,12 @@ proc index-setup-action {oldAttr queryNo indexNo} { 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 @@ -2917,12 +3607,16 @@ proc index-setup {attr queryNo indexNo} { } +# 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 set i [lindex [$w.top.index.list curselection] 0] - if {$i == ""} { + if {![string length $i]} { return } set attr [lindex $queryInfoTmp $i] @@ -2930,13 +3624,17 @@ proc query-edit-index {queryNo} { 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 set w .query-setup set i [lindex [$w.top.index.list curselection] 0] - if {$i == ""} { + if {![string length $i]} { return } set queryInfoTmp [lreplace $queryInfoTmp $i $i] @@ -2944,6 +3642,9 @@ proc query-delete-index {queryNo} { $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 @@ -3016,6 +3717,8 @@ proc query-setup {queryNo} { Cancel [list destroy $w]] 0 } +# Procedure index-clear +# Handler that clears the search entry fields. proc index-clear {} { global queryButtonsFind @@ -3025,7 +3728,18 @@ proc index-clear {} { 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 @@ -3102,6 +3816,12 @@ proc index-query {} { return $qs } +# Procedure index-focus-in {w i} +# w index frame +# i index number +# This procedure handles 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 @@ -3111,6 +3831,14 @@ proc index-focus-in {w i} { 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 { @@ -3127,8 +3855,10 @@ proc index-lines {w realOp buttonInfo queryInfo handle} { if {! [winfo exists $w.$i.e]} { entry $w.$i.e -width 32 -relief sunken -border 1 bind $w.$i.e [list index-focus-in $w $i] - bind $w.$i.e [list $w.$i configure \ - -background white] + if {![tk4]} { + bind $w.$i.e [list $w.$i configure \ + -background white] + } pack $w.$i.l -side left pack $w.$i.e -side left -fill x -expand yes pack $w.$i -side top -fill x -padx 2 -pady 2 @@ -3169,6 +3899,12 @@ proc index-lines {w realOp buttonInfo queryInfo handle} { } } +# 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 { @@ -3203,15 +3939,10 @@ proc search-fields {w buttondefs} { $w.0 configure -background red } -if {[info exists windowGeometry(.)]} { - set g $windowGeometry(.) - if {$g != ""} { - 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 @@ -3221,73 +3952,84 @@ pack .top .lines .mid -side top -fill x pack .data -side top -fill both -expand yes pack .bot -fill x -menubutton .top.file -text "File" -menu .top.file.m -menu .top.file.m -.top.file.m add command -label "Save settings" -command {save-settings} +# Init: Definition of File menu. +menubutton .top.file -text File -menu .top.file.m +irmenu .top.file.m +.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} - -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.file.m add command -label Exit -command {exit-action} + +# Init: Definition of Target menu. +menubutton .top.target -text Target -menu .top.target.m +irmenu .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 separator set-target-hotlist 0 configure-disable-e .top.target.m 1 configure-disable-e .top.target.m 2 -menu .top.target.m.clist -menu .top.target.m.slist +irmenu .top.target.m.clist +irmenu .top.target.m.slist cascade-target-list -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 -menu .top.service.m.present -.top.service.m.present add command -label "10 More" \ - -command [list present-more 10] -.top.service.m.present add command -label "All" \ +# Init: Definition of Service menu. +menubutton .top.service -text Service -menu .top.service.m +irmenu .top.service.m +.top.service.m add cascade -label Database -menu .top.service.m.dblist +.top.service.m add cascade -label Present -menu .top.service.m.present +irmenu .top.service.m.present +.top.service.m.present add command -label {50 More} \ + -command [list present-more 50] +.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.m add command -label Explain -command \ + {explain-refresh $hostid {ready-response {}} } .top.service configure -state disabled -menubutton .top.rset -text "Set" -menu .top.rset.m -menu .top.rset.m -.top.rset.m add command -label "Load" -command {load-set} +irmenu .top.service.m.dblist + +# Init: Definition of Set menu. +menubutton .top.rset -text Set -menu .top.rset.m +irmenu .top.rset.m +.top.rset.m add command -label Load -command {load-set} .top.rset.m add separator -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 radiobutton -label "Debug" -variable debugMode -value 1 - -menu .top.options.m.query -.top.options.m.query add cascade -label "Select" \ +# Init: Definition of the Options menu. +menubutton .top.options -text Options -menu .top.options.m +irmenu .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 radiobutton -label Debug -variable debugMode -value 1 + +# Init: Definition of the Options|Query menu. +irmenu .top.options.m.query +.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.clist -menu .top.options.m.query.dlist +irmenu .top.options.m.query.slist +irmenu .top.options.m.query.clist +irmenu .top.options.m.query.dlist cascade-query-list -menu .top.options.m.formats +# Init: Definition of the Options|Formats menu. +irmenu .top.options.m.formats set i 0 foreach f $displayFormats { .top.options.m.formats add radiobutton -label $f -value $i \ @@ -3295,81 +4037,90 @@ foreach f $displayFormats { incr i } -menu .top.options.m.wrap -.top.options.m.wrap add radiobutton -label "Character" \ +# Init: Definition of the Options|Wrap menu. +irmenu .top.options.m.wrap +.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} -menu .top.options.m.syntax -.top.options.m.syntax add radiobutton -label "None" \ +# Init: Definition of the Options|Syntax menu. +irmenu .top.options.m.syntax +.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 -menu .top.options.m.elements -.top.options.m.elements add radiobutton -label "Unspecified" \ +# Init: Definition of the Options|Elements menu. +irmenu .top.options.m.elements +.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 +irmenu .top.help.m -.top.help.m add command -label "Help on help" \ - -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} \ -state disabled button .mid.scan -text Scan \ -command scan-request -state disabled -button .mid.present -text {Present} -command [list present-more 10] \ +button .mid.present -text {Present} -command [list present-more 50] \ -state disabled button .mid.clear -text Clear -command index-clear 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 \ - -yscrollcommand [list .data.scroll set] -wrap $textWrap +# 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 -background grey85 scrollbar .data.scroll -command [list .data.record yview] if {[tk4]} { .data.record configure -takefocus 0 .data.scroll configure -takefocus 0 } + pack .data.scroll -side right -fill y 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 @@ -3378,29 +4129,27 @@ if {! $monoFlag} { .data.record tag configure marc-id -foreground black } .data.record tag configure marc-data -foreground black -.data.record tag configure marc-head \ - -font -Adobe-Times-Bold-R-Normal-*-140-* \ +.data.record tag configure marc-head -font $font(n,normal) \ -foreground brown -relief raised -borderwidth 1 .data.record tag configure marc-small-head -foreground brown .data.record tag configure marc-pref \ - -font -Adobe-Times-Medium-R-Normal-*-140-* \ - -foreground blue + -font $font(n,normal) -foreground blue .data.record tag configure marc-text \ - -font -Adobe-Times-Medium-R-Normal-*-140-* \ - -foreground black + -font $font(n,normal) -foreground black .data.record tag configure marc-it \ - -font -Adobe-Times-Medium-I-Normal-*-140-* \ - -foreground black + -font $font(n,normal) -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 -message .bot.a.target -text "" -aspect 1000 -border 1 +message .bot.a.target -text {} -aspect 2000 -border 1 label .bot.a.status -text "Not connected" -width 15 -relief \ sunken -anchor w -border 1 @@ -3413,18 +4162,40 @@ pack .bot.a.target -side top -anchor nw -padx 2 -pady 2 pack .bot.a.status .bot.a.set .bot.a.message \ -side left -padx 2 -pady 2 -ipadx 1 -ipady 1 -if {[catch {ir z39}]} { +# Init: Determine if the IrTcl extension is already there. If +# not, then dynamically load the IrTcl extension. +set logLevel all +if {[catch {ir-version}]} { set e [info sharedlibextension] - puts -nonewline "Loading irtcl$e ..." - load irtcl$e irtcl - ir z39 - puts "ok" + catch {load ${libdir}/irtcl$e irtcl} + if {[catch {ir-version}]} { + load irtcl$e irtcl + } +} + +if $debugMode { + ir-log-init all {} irtcl.log +} else { + ir-log-init none {} {} } -#z39 logLevel all -if {$hostid != "Default"} { - catch {open-target $hostid $hostbase} +# Create Z Assocation +ir z39 + +if {[file exists ${libdir}/explain.tcl]} { + source ${libdir}/explain.tcl } -show-logo 1 +if {[file exists ${libdir}/setup.tcl]} { + source ${libdir}/setup.tcl +} +after 10 activateMainWindow + +proc activateMainWindow {} { + global hostid hostbase + if {[string compare $hostid Default]} { + catch {open-target $hostid $hostbase} + } + show-logo 1 +}