chiark / gitweb /
where-vessels bugfixes
[ypp-sc-tools.db-test.git] / yarrg / where-vessels
index ecf1e06..29c3ab7 100755 (executable)
@@ -47,6 +47,40 @@ proc glset {n val} {
     set var $val
 }
 
+#---------- expecting certain errors ----------
+
+proc errexpect-setline {lno line} {
+    glset errexpect_lno $lno
+    glset errexpect_line $line
+}
+
+proc errexpect-error {m} {
+    global errexpect_line errexpect_lno
+    error $m "$errexpect_line\n" [list YARRG-ERREXPECT $errexpect_lno]
+}
+
+proc errexpect-arrayget {arrayvar key} {
+    upvar 1 $arrayvar av
+    upvar 1 ${arrayvar}($key) v
+    if {[info exists v]} { return $v }
+    errexpect-error "undefined $key"
+}
+
+proc errexpect-catch {code} {
+    global errorInfo errorCode
+    set rc [catch {
+       uplevel 1 $code
+    } rv]
+    debug "ERREXPECT CATCH |$rc|$rv|$errorCode|$errorInfo|"
+    if {$rc==1 && ![string compare YARRG-ERREXPECT [lindex $errorCode 0]]} {
+       return [list 1 $rv [lindex $errorCode 1] $errorInfo]
+    } elseif {$rc==0} {
+       return [list 0 $rv]
+    } else {
+       return -code $rc -errorinfo $errorInfo -errorcode $errorCode $rv
+    }
+}
+
 #---------- argument parsing ----------
 
 proc nextarg {} {
@@ -99,107 +133,201 @@ proc argdefaults {} {
 #---------- loading and parsing the vessel notes ----------
 
 proc load-notes {} {
-    global notes_loc notes
-    catch { unset notes }
+    global notes_loc notes_data
     if {[regexp {^\w+\:} $notes_loc]} {
-       vwait idletasks
-       debug "FETCHING NOTES"
-       ::http::geturl $notes_loc
-       switch -glob [::http::status].[::http::ncode] {
+       update
+       debug "FETCHING NOTES $notes_loc"
+       set req [::http::geturl $notes_loc]
+       switch -glob [::http::status $req].[::http::ncode $req] {
            ok.200 { }
-           ok.* { error "retrieving vessel-notes $url: [::http::code]" }
-           * { error "retrieving vessel-notes $url: [::http::error]" }
+           ok.* { error "retrieving vessel-notes: [::http::code $req]" }
+           * { error "Retrieving vessel-notes: [::http::error $req]" }
        }
-       set notes_data [::http::data]
-       ::http::cleanup
+       set newdata [::http::data $req]
+       ::http::cleanup $req
     } else {
+       debug "READING NOTES $notes_loc"
        set vn [open $notes_loc]
-       set notes_data [read $vn]
+       set newdata [read $vn]
        close $vn
     }
+    set notes_data $newdata
+}
+
+proc parse-notes {} {
+    global notes_data notes
+    catch { unset notes }
+
+    set lno 0
     foreach l [split $notes_data "\n"] {
-       regsub -all {\t+} $l "\t" l
-       manyset [split $l "\t"] vname vid owner note
-       set nk $vid.$vname
-       debug "SET NOTE $nk"
-       set notes($nk) [list $owner $note]
+       incr lno
+       errexpect-setline $lno $l
+       set l [string trim $l]
+       if {![string length $l]} continue
+       if {[regexp {^\#} $l]} continue
+       if {![regexp -expanded \
+                 {^ (\d+) (?: \s+([^=]*?) )? \s* =
+                     (?: \s* (\S+)
+                      (?: \s+ (\S+) )?)? $} \
+                 $l dummy vid vname owner note]} {
+             errexpect-error "badly formatted"
+       }
+       set vname [string trim $vname]
+       if {[info exists notes($vid)]} {
+           errexpect-error "duplicate vesselid $vid"
+       }
+       set notes($vid) [list $lno $vname $owner $note]
     }
 }
 
+proc note-info {lno vid name description} {
+    global note_infos
+    lappend note_infos [list $lno $vid $name $description]
+}
+
+proc display-note-infos {} {
+    global note_infos note_missings notes
+
+    set nmissing [llength $note_missings]
+    debug "display-note-infos $nmissing [array size notes]"
+
+    if {[llength $note_infos]} {
+       set tiny "[llength $note_infos] warnings"
+    } elseif {$nmissing && [array size notes]} {
+       set tiny "$nmissing missing"
+    } else {
+       return
+    }
+
+    set infodata {}
+
+    foreach info $note_infos {
+       manyset $info lno vid name description
+       append infodata "vessel"
+       append infodata " $vid"
+       if {[string length $name]} { append infodata " $name" }
+       append infodata ": " $description "\n"
+    }
+
+    if {$nmissing} {
+       append infodata "$nmissing vessels not mentioned in notes:\n"
+       set last_island {}
+       foreach info [lsort $note_missings] {
+           manyset $info island name vid
+           if {[string compare $island $last_island]} {
+               append infodata "# $island:\n"
+               set last_island $island
+           }
+           append infodata [format "%-9d %-29s =\n" $vid $name]
+       }
+    }
+
+    parser-control-failed-core .ctrl.notes notes \
+       white blue 0 \
+       $tiny \
+       "[llength $note_infos] warnings;\
+         $nmissing vessels missing" \
+       "Full description of warnings and missing vessels:" \
+       $infodata
+}
 
 #---------- loading and parsing the clipboard (vessel locations) ----------
 
 proc vessel {vin} {
-       global pirate notes_used
-       upvar 1 $vin vi
-       switch -exact $vi(vesselClass) {
-               smsloop         { set sz 00sl }
-               lgsloop         { set sz 01ct }
-               dhow            { set sz 02dh }
-               longship        { set sz 03ls }
-               baghlah         { set sz 04bg }
-               merchbrig       { set sz 05mb }
-               warbrig         { set sz 06wb }
-               xebec           { set sz 07xe }
-               warfrig         { set sz 08wf }
-               merchgal        { set sz 09mg }
-               grandfrig       { set sz 10gf }
-               default         { error "$vi(vesselClass) ?" }
-       }
-       set abbrev $sz
-       switch -exact $vi(vesselSubclass) {
-               null            { }
-               icy             { append abbrev F }
-               default         { error "$vi(vesselSubclass) ?" }
-       }
-       switch -exact $vi(isLocked)/$vi(isBattleReady) {
-               true/false      { append abbrev 2- }
-               false/false     { append abbrev 1+ }
-               false/true      { append abbrev 0* }
-               default         { error "$vi(isLocked)/$vi(isBattleReady) ?" }
-       }
-       switch -exact $vi(inPort) {
-               true            { }
-               false           { append abbrev ? }
-               default         { error "$vi(inPort) ?" }
+    global pirate notes_used note_missings newnotes
+    upvar 1 $vin vi
+    switch -exact [errexpect-arrayget vi vesselClass] {
+       smsloop         { set sz 00sl }
+       lgsloop         { set sz 01ct }
+       dhow            { set sz 02dh }
+       longship        { set sz 03ls }
+       baghlah         { set sz 04bg }
+       merchbrig       { set sz 05mb }
+       warbrig         { set sz 06wb }
+       xebec           { set sz 07xe }
+       warfrig         { set sz 08wf }
+       merchgal        { set sz 09mg }
+       grandfrig       { set sz 10gf }
+       default         { errexpect-error "unknown class" }
+    }
+    set abbrev $sz
+    switch -exact [errexpect-arrayget vi vesselSubclass] {
+       null            { }
+       icy             { append abbrev F }
+       default         { errexpect-error "unknown subclass ?" }
+    }
+    switch -exact [errexpect-arrayget vi isLocked]/[ \
+                   errexpect-arrayget vi isBattleReady] {
+       true/false      { append abbrev 2- }
+       false/false     { append abbrev 1+ }
+       false/true      { append abbrev 0* }
+       default         { errexpect-error "unexpected isLocked/isBattleReady" }
+    }
+    switch -exact [errexpect-arrayget vi inPort] {
+       true            { }
+       false           { append abbrev ? }
+       default         { errexpect-error "unexpected inPort" }
+    }
+    set vid [errexpect-arrayget vi vesselId]
+    upvar #0 notes($vid) note
+    set realname [errexpect-arrayget vi vesselName]
+    set island [errexpect-arrayget vi islandName]
+
+    set owner {}
+    set xabbrev {}
+    if {[info exists note]} {
+       manyset $note lno notename owner xabbrev
+       if {[string compare -nocase $realname $notename]} {
+           note-info $lno $vid $realname \
+               "notes say name is $notename - perhaps renamed"
        }
-       set nk $vi(vesselId).$vi(vesselName)
-       upvar #0 notes($nk) note
-       if {[info exists note]} {
-           manyset $note owner xabbrev
+       if {[string length $owner]} {
            if {![string compare $owner $pirate]} {
                append abbrev =
            } else {
                append abbrev -
            }
-           append abbrev $xabbrev
-           set notes_used($nk) 1
-       } else {
-           debug "UNKNOWN $nk"
        }
-       set kk "$vi(islandName) $abbrev"
-       upvar #0 count($kk) k
-       if {![info exists k]} { set k 0 }
-       incr k
+       append abbrev $xabbrev
+       set notes_used($vid) 1
+
+    } else {
+       lappend note_missings [list $island $realname $vid]
+    }
+    lappend newnotes [list $vid $realname $owner $xabbrev]
+    
+    set kk "$island $abbrev"
+    upvar #0 count($kk) k
+    if {![info exists k]} { set k 0 }
+    incr k
 }
 
 set clipboard {}
 proc parse-clipboard {} {
-    global clipboard count notes notes_used
+    global clipboard count notes notes_used newnotes
 
     catch { unset count }
     catch { unset notes_used }
+    glset note_infos {}
+    glset note_missings {}
+
+    set newnotes {}
     
     set itemre { (\w+) = ([^=]*) }
     set manyitemre "^\\\[ $itemre ( (?: ,\\ $itemre)* ) \\]\$"
     debug $manyitemre
 
+    set lno 0
     foreach l [split $clipboard "\n"] {
+       incr lno
+       errexpect-setline $lno $l
        if {![string length $l]} continue
        catch { unset vi }
        while 1 {
                if {![regexp -expanded $manyitemre $l dummy \
-                       thiskey thisval rhs]} { error "$l ?" }
+                       thiskey thisval rhs]} {
+                   errexpect-error "badly formatted"
+               }
                set vi($thiskey) $thisval
                if {![string length $rhs]} break
                regsub {^, } $rhs {} rhs
@@ -208,9 +336,13 @@ proc parse-clipboard {} {
        vessel vi
     }
 
-    foreach nk [lsort [array names notes]] {
-       if {![info exists notes_used($nk)]} {
-           debug "IGNORED NOTE $nk"
+    if {[llength $newnotes]} {
+       foreach vid [lsort [array names notes]] {
+           if {![info exists notes_used($vid)]} {
+               manyset $notes($vid) lno notename
+               note-info $lno $vid $notename \
+                   "vessel in notes no longer found"
+           }
        }
     }
 }
@@ -319,10 +451,149 @@ proc draw {} {
 }
 
 
-#---------- user interface ----------
+#---------- parser error reporting ----------
+
+proc parser-control-create {w base invokebuttontext etl_title} {
+    frame $w
+    button $w.do -text $invokebuttontext -command invoke_$base
+
+    frame $w.resframe -width 120 -height 32
+    button $w.resframe.res -text {} -anchor nw \
+       -padx 1 -pady 1 -borderwidth 0 -justify left
+    glset deffont_$base [$w.resframe.res cget -font]
+    place $w.resframe.res -relx 0.5 -y 0 -anchor n
+
+    pack $w.do -side top
+    pack $w.resframe -side top -expand y -fill both
+
+    set eb .err_$base
+    toplevel $eb
+    wm withdraw $eb
+    wm title $eb "where-vessels - $etl_title"
+
+    label $eb.title -text $etl_title
+    pack $eb.title -side top
+
+    button $eb.close -text Close -command [list wm withdraw $eb]
+    pack $eb.close -side bottom
+
+    frame $eb.emsg -bd 2 -relief groove
+    label $eb.emsg.lab -text "Error:"
+    text $eb.emsg.text -height 1
+    pack $eb.emsg.text -side bottom
+    pack $eb.emsg.lab -side left
+
+    pack $eb.emsg -side top -pady 2
+
+    frame $eb.text -bd 2 -relief groove
+    pack $eb.text -side bottom -pady 2
+    
+    label $eb.text.lab
+
+    text $eb.text.text -width 85 \
+       -xscrollcommand [list $eb.text.xscroll set] \
+       -yscrollcommand [list $eb.text.yscroll set]
+    $eb.text.text tag configure error \
+       -background red -foreground white
+
+    scrollbar $eb.text.xscroll -orient horizontal \
+       -command [list $eb.text.text xview]
+    scrollbar $eb.text.yscroll -orient vertical \
+       -command [list $eb.text.text yview]
+
+    grid configure $eb.text.lab -row 0 -column 0 -sticky w
+    grid configure $eb.text.text -row 1 -column 0
+    grid configure $eb.text.yscroll -sticky ns -row 1 -column 1
+    grid configure $eb.text.xscroll -sticky ew -row 2 -column 0
+}
+
+proc parser-control-ok-core {w base background show} {
+    debug "parser-control-ok-core $w $base $background $show"
+    upvar #0 deffont_$base deffont
+    $w.resframe.res configure \
+       -background $background -disabledforeground black -font $deffont \
+       -state disabled -command {} \
+       -text $show
+}    
+proc parser-control-ok {w base show} {
+    parser-control-ok-core $w $base green $show
+}
+proc parser-control-none {w base show} {
+    parser-control-ok-core $w $base blue $show
+}
+proc parser-control-failed-core {w base foreground background smallfont
+                                tiny summary fulldesc fulldata} {
+    debug "parser-control-failed-core $w $base $summary $fulldesc"
+    upvar #0 deffont_$base deffont
+    set eb .err_$base
+
+    $eb.emsg.text delete 0.0 end
+    $eb.emsg.text insert end $summary
+
+    $eb.text.lab configure -text $fulldesc
+    $eb.text.text delete 0.0 end
+    $eb.text.text insert end $fulldata
+
+    regsub -all {.{18}} $tiny "&\n" ewrap
+
+    if {$smallfont} {
+       set font fixed
+    } else {
+       set font $deffont
+    }
+
+    $w.resframe.res configure \
+       -background $background -foreground $foreground -font $font \
+       -state normal -command [list wm deiconify $eb] \
+       -text $ewrap
+}
+    
+proc parser-control-failed-expected {w base emsg lno ei fulldesc newdata} {
+    set eb .err_$base
+
+    set line [lindex [split $ei "\n"] 0]
+    debug "parser-control-failed-expected: $w $base: $lno: $emsg\n $line"
+
+    parser-control-failed-core $w $base \
+       white red 1 \
+       "err: [string trim $emsg]: \"$line\"" \
+       "at line $lno: $emsg" \
+       $fulldesc $newdata
+
+    $eb.text.text tag add error $lno.0 $lno.end
+    $eb.text.text see $lno.0   
+}
+proc parser-control-failed-unexpected {w base emsg ei} {
+    global errorInfo
+    parser-control-failed-core $w $base \
+       black yellow 1 \
+       $emsg $emsg "Details and stack trace:" $ei
+}
+
+proc reparse {base varname old fulldesc okshow noneshow parse ok} {
+    upvar #0 $varname var
+    manyset [errexpect-catch {
+       uplevel 1 $parse
+       if {[string length [string trim $var]]} {
+           parser-control-ok .ctrl.$base $base $okshow
+       } else {
+           parser-control-none .ctrl.$base $base $noneshow
+       }
+    }] failed emsg lno ei
+    if {$failed} {
+       parser-control-failed-expected .ctrl.$base $base \
+           $emsg $lno $ei $fulldesc $var
+       set var $old
+       uplevel 1 $parse
+    } else {
+       uplevel 1 $ok
+    }
+}
+
+#---------- main user interface ----------
 
 proc widgets-setup {} {
-    global canvas debug acqdeffont
+    global canvas debug pirate ocean
 
     frame .f -border 1 -relief groove
     set canvas .f.c
@@ -346,21 +617,20 @@ proc widgets-setup {} {
     button .ctrl.zoom.in  -text + -font {Courier 16} -command {zoom *2}
     pack .ctrl.zoom.out .ctrl.zoom.in -side left
 
-    frame .ctrl.acquire
-    button .ctrl.acquire.do -text Acquire -command acquire
+    parser-control-create .ctrl.acquire \
+       acquire Acquire \
+       "Clipboard parsing error" \
+       
+    pack .ctrl.acquire -side top -pady 2
 
-    frame .ctrl.acquire.resframe -width 120 -height 32
-    button .ctrl.acquire.resframe.res -text {} -anchor nw \
-       -padx 1 -pady 1 -borderwidth 0 -justify left
-    glset acqdeffont [.ctrl.acquire.resframe.res cget -font]
-    place .ctrl.acquire.resframe.res -relx 0.5 -y 0 -anchor n
-    #  -relheight 1.0 -relwidth 1.0
-
-    pack .ctrl.acquire.do -side top
-    pack .ctrl.acquire.resframe -side top -expand y -fill both
-    pack .ctrl.acquire -side top
+    parser-control-create .ctrl.notes \
+       notes "Reload notes" \
+       "Vessel notes loading report" \
+       
+    pack .ctrl.notes -side top -pady 2
 
     wm geometry . 1024x480
+    wm title . "where-vessels - $pirate on the $ocean ocean"
 }
 
 proc zoom {extail} {
@@ -372,38 +642,48 @@ proc zoom {extail} {
     draw
 }
 
-proc acquire_showerror {} {
-    global acqerr
-    tk_messageBox -type ok \
-       -title "where-vessels: clipboard parsing error" \
-       -message $acqerr
-}
-
-proc acquire {} {
-    global clipboard acqdeffont acqerr errorInfo
+proc invoke_acquire {} {
+    global clipboard errorInfo
     set old $clipboard
+
     if {[catch {
        set clipboard [clipboard get]
-       parse-clipboard
-       .ctrl.acquire.resframe.res configure \
-           -background blue -disabledforeground black -font $acqdeffont \
-           -state disabled -command {} \
-           -text " acquired ok "
     } emsg]} {
-       set acqerr "clipboard parsing failed: $emsg"
-       puts stderr $acqerr
-       append acqerr "\n$errorInfo"
-       regsub -all {.{18}} "error: [string trim $emsg]" "&\n" ewrap
-       .ctrl.acquire.resframe.res configure \
-           -background red -foreground white -font fixed \
-           -state normal -command acquire_showerror \
-           -text $ewrap
-       set clipboard $old
-       parse-clipboard
+       parser-control-failed-unexpected .ctrl.acquire acquire \
+           $emsg "fetching clipboard:\n\n$errorInfo"
+       return
     }
+
+    reparse acquire \
+       clipboard $old "Clipboard contents:" { acquired ok } { no vessels } {
+           parse-clipboard
+       } {
+           display-note-infos
+       }
     draw
 }
 
+proc invoke_notes {} {
+    global notes_data errorInfo notes_loc
+    set old $notes_data
+    
+    if {[catch {
+       load-notes
+    } emsg]} {
+       parser-control-failed-unexpected .ctrl.notes notes \
+           $emsg "loading $notes_loc:\n\n$errorInfo"
+       return
+    }
+
+    reparse notes \
+       notes_data $old "Vessel notes:" "loaded ok" { no notes } {
+           parse-notes
+           parse-clipboard
+       } {
+           display-note-infos
+       }
+    draw
+}
 
 #---------- main program ----------
 
@@ -413,7 +693,7 @@ httpclientsetup where-vessels
 load-chart
 widgets-setup
 
-load-notes
-parse-clipboard
+set notes_data {}
+after idle invoke_notes
 
 draw