chiark / gitweb /
where-vessels: show vessel names
[ypp-sc-tools.db-live.git] / yarrg / where-vessels
index 32b70f36b990531ea2377fbc021ff239f9babe59..6f4433fa9e7efc7521820ad94f64d5507756c270 100755 (executable)
@@ -66,6 +66,14 @@ proc errexpect-arrayget {arrayvar key} {
     errexpect-error "undefined $key"
 }
 
+proc errexpect-arrayget-boolean {arrayvar key} {
+    switch -exact [uplevel 1 [list errexpect-arrayget $arrayvar $key]] {
+       true    { return 1 }
+       false   { return 0 }
+       default { errexpect-error "unexpected $key" }
+    }
+}
+
 proc errexpect-catch {code} {
     global errorInfo errorCode
     set rc [catch {
@@ -135,16 +143,16 @@ proc argdefaults {} {
 proc load-notes {} {
     global notes_loc notes_data
     if {[regexp {^\w+\:} $notes_loc]} {
-       vwait idletasks
+       update
        debug "FETCHING NOTES $notes_loc"
-       ::http::geturl $notes_loc
-       switch -glob [::http::status].[::http::ncode] {
+       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 newdata [::http::data]
-       ::http::cleanup
+       set newdata [::http::data $req]
+       ::http::cleanup $req
     } else {
        debug "READING NOTES $notes_loc"
        set vn [open $notes_loc]
@@ -157,79 +165,235 @@ proc load-notes {} {
 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 island description} {
+    global note_infos
+    lappend note_infos [list $lno $vid $name $island $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 island description
+       append infodata "vessel"
+       append infodata " $vid"
+       if {[string length $name]} { append infodata " $name" }
+       if {[string length $island]} { append infodata " ($island)" }
+       append infodata ": " $description "\n"
+    }
+
+    if {$nmissing} {
+       if {[string length $infodata]} { append infodata "\n" }
+       append infodata "$nmissing vessel(s) 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] warning(s);\
+         $nmissing vessel(s) missing" \
+       "Full description of warnings and missing vessels:" \
+       $infodata
+}
+
+#---------- vessel properties ----------
+
+proc vesselclasses-init {} {
+    global vc_game2code vc_code2abbrev vc_code2full
+    foreach {game code abbrev full} {
+       smsloop         am      sl      Sloop
+       lgsloop         bm      ct      Cutter
+       dhow            cm      dh      Dhow
+       longship        dm      ls      Longship
+       baghlah         em      bg      Baghlah
+       merchbrig       fm      mb      {Merchant Brig}
+       warbrig         gm      wb      {War Brig}
+       xebec           hm      xe      Xebec
+       warfrig         im      wf      {War Frigate}
+       merchgal        jm      mg      {Merchant Galleon}
+       grandfrig       km      gf      {Grand Frigate}
+    } {
+       set vc_game2code($game) $code
+       set vc_code2abbrev($code) $abbrev
+       set vc_code2full($code) $full
     }
 }
 
+proc code2abbrev {code} {
+    global vc_code2abbrev
+
+    manyset [split $code _] inport class subclass lockown xabbrev
+    manyset [split $lockown ""] lock notown
+
+    set abbrev {}
+    append abbrev [lindex {? {}} $inport]
+    append abbrev $vc_code2abbrev($class)
+    append abbrev $subclass
+    append abbrev [lindex {* + -} $lock]
+    append abbrev [lindex {= - ?} [regsub {\D} $notown 2]]
+    append abbrev $xabbrev
+
+    debug "CODE2ABBREV $code $abbrev"
+    return $abbrev
+}
+
+proc show-report-decode {code} {
+    global vc_code2full
+
+    manyset [split $code _] inport classcode subclass lockown xabbrev
+    manyset [split $lockown ""] lock notown
+    
+    report-set inport [lindex {{At Sea} {In port}} $inport]
+    report-set class $vc_code2full($classcode)
+
+    switch -exact $subclass {
+       {} { report-set subclass {Ordinary} }
+       F { report-set subclass {"Frost class"} }
+       default { report-set subclass "Subclass \"$subclass\"" }
+    }
+
+    report-set lock [lindex {
+       {Battle ready} {Unlocked} {Locked}
+    } $lock]
 
+    switch -exact $notown {
+       0 { report-set own "Yours" }
+       1 { report-set own "Other pirate's" }
+       U { report-set own "Owner not known" }
+       M { report-set own "Missing from notes" }
+       default { report-set own "?? $notown" }
+    }
+
+    if {[string length $xabbrev]} {
+       report-set xabbrev "Notes flags: $xabbrev"
+    } else {
+       report-set xabbrev "No flags in notes"
+    }
+}
+    
 #---------- loading and parsing the clipboard (vessel locations) ----------
 
 proc vessel {vin} {
-    global pirate notes_used
+    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 ?" }
+
+    set codel {}
+    lappend codel [errexpect-arrayget-boolean vi inPort]
+
+    set gameclass [errexpect-arrayget vi vesselClass]
+    upvar #0 vc_game2code($gameclass) class
+    if {![info exists class]} { errexpect-error "unexpected vesselClass"}
+    lappend codel $class
+
+    set subclass [errexpect-arrayget vi vesselSubclass]
+    switch -exact $subclass {
+       null            { lappend codel {} }
+       icy             { lappend codel F }
+       default         { lappend codel ($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* }
+       true/false      { set lock 2 }
+       false/false     { set lock 1 }
+       false/true      { set lock 0 }
        default         { errexpect-error "unexpected isLocked/isBattleReady" }
     }
-    switch -exact [errexpect-arrayget vi inPort] {
-       true            { }
-       false           { append abbrev ? }
-       default         { errexpect-error "unexpected inPort" }
-    }
-    set nk [errexpect-arrayget vi vesselId].[errexpect-arrayget vi vesselName]
-    upvar #0 notes($nk) note
+
+    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 owner xabbrev
-       if {![string compare $owner $pirate]} {
-           append abbrev =
+       manyset $note lno notename owner xabbrev
+       if {[string compare -nocase $realname $notename]} {
+           note-info $lno $vid $realname $island \
+               "notes say name is $notename"
+       }
+       if {[string length $owner]} {
+           if {![string compare $owner $pirate]} {
+               set notown 0
+           } else {
+               set notown 1
+           }
        } else {
-           append abbrev -
+           set notown U
        }
        append abbrev $xabbrev
-       set notes_used($nk) 1
+       set notes_used($vid) 1
+
     } else {
-       debug "UNKNOWN $nk"
+       set notown M
+       lappend note_missings [list $island $realname $vid]
     }
-    set kk "[errexpect-arrayget vi islandName] $abbrev"
-    upvar #0 count($kk) k
-    if {![info exists k]} { set k 0 }
-    incr k
+
+    lappend codel "$lock$notown" $xabbrev
+    lappend newnotes [list $vid $realname $owner $xabbrev]
+    set kk "$island [join $codel _]"
+    upvar #0 found($kk) k
+    lappend k [list $vid $realname]
+    debug "CODED $kk $vid $realname"
 }
 
 set clipboard {}
 proc parse-clipboard {} {
-    global clipboard count notes notes_used
+    global clipboard found notes notes_used newnotes
 
-    catch { unset count }
+    catch { unset found }
     catch { unset notes_used }
+    glset note_infos {}
+    glset note_missings {}
+
+    set newnotes {}
     
     set itemre { (\w+) = ([^=]*) }
     set manyitemre "^\\\[ $itemre ( (?: ,\\ $itemre)* ) \\]\$"
@@ -254,9 +418,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"
+           }
        }
     }
 }
@@ -322,7 +490,7 @@ proc chart-got/league {x1 y1 x2 y2 kind} {
 }
 
 proc draw {} {
-    global chart count isleloc canvas
+    global chart found isleloc canvas
     
     $canvas delete all
 
@@ -333,10 +501,13 @@ proc draw {} {
     }
 
     set lastislandname {}
-    foreach key [lsort [array names count]] {
-       set c $count($key)
+    foreach key [lsort [array names found]] {
+       set c [llength $found($key)]
 #      debug "SHOWING $key $c"
-       regexp {^(.*) (\S+)$} $key dummy islandname abbrev
+       regexp {^(.*) (\S+)$} $key dummy islandname code
+
+       set abbrev [code2abbrev $code]
+       
        if {[string compare $lastislandname $islandname]} {
                manyset $isleloc($islandname) x y
                set x [coord $x]
@@ -357,6 +528,8 @@ proc draw {} {
        set bbox [$canvas bbox $id]
        set bid [eval $canvas create rectangle $bbox -fill white]
        $canvas lower $bid $id
+       $canvas bind $id <ButtonPress> [list show-report $islandname $code]
+       $canvas bind $bid <ButtonPress> [list show-report $islandname $code]
        manyset $bbox dummy dummy dummy y
 #      debug "NEW Y $y"
     }
@@ -365,47 +538,7 @@ proc draw {} {
 }
 
 
-#---------- user interface ----------
-
-proc widgets-setup {} {
-    global canvas debug acquire_deffont
-
-    frame .f -border 1 -relief groove
-    set canvas .f.c
-    canvas $canvas
-    pack $canvas -expand 1 -fill both
-    pack .f -expand 1 -fill both -side left
-
-    frame .ctrl
-    pack .ctrl -side right
-
-    debug "BBOX [$canvas bbox all]"
-
-    panner::canvas-scroll-bbox .f.c
-    panner::create .ctrl.pan .f.c 120 120 $debug
-
-    pack .ctrl.pan -side top -pady 10 -padx 5
-    frame .ctrl.zoom
-    pack .ctrl.zoom -side top
-
-    button .ctrl.zoom.out -text - -font {Courier 16} -command {zoom /2}
-    button .ctrl.zoom.in  -text + -font {Courier 16} -command {zoom *2}
-    pack .ctrl.zoom.out .ctrl.zoom.in -side left
-
-    parser-control-create .ctrl.acquire \
-       acquire Acquire \
-       "Clipboard parsing error" \
-       
-    pack .ctrl.acquire -side top -pady 2
-
-    parser-control-create .ctrl.notes \
-       notes "Reload notes" \
-       "Vessel notes loading error" \
-       
-    pack .ctrl.notes -side top -pady 2
-
-    wm geometry . 1024x480
-}
+#---------- parser error reporting ----------
 
 proc parser-control-create {w base invokebuttontext etl_title} {
     frame $w
@@ -423,7 +556,7 @@ proc parser-control-create {w base invokebuttontext etl_title} {
     set eb .err_$base
     toplevel $eb
     wm withdraw $eb
-    wm title $eb "$etl_title - where-vessels"
+    wm title $eb "where-vessels - $etl_title"
 
     label $eb.title -text $etl_title
     pack $eb.title -side top
@@ -444,7 +577,7 @@ proc parser-control-create {w base invokebuttontext etl_title} {
     
     label $eb.text.lab
 
-    text $eb.text.text \
+    text $eb.text.text -width 85 \
        -xscrollcommand [list $eb.text.xscroll set] \
        -yscrollcommand [list $eb.text.yscroll set]
     $eb.text.text tag configure error \
@@ -475,8 +608,10 @@ proc parser-control-ok {w base show} {
 proc parser-control-none {w base show} {
     parser-control-ok-core $w $base blue $show
 }
-proc parser-control-failed-core {w base tiny summary fulldesc fulldata} {
+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
@@ -487,9 +622,15 @@ proc parser-control-failed-core {w base tiny summary fulldesc fulldata} {
     $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 red -foreground white -font fixed \
+       -background $background -foreground $foreground -font $font \
        -state normal -command [list wm deiconify $eb] \
        -text $ewrap
 }
@@ -501,6 +642,7 @@ proc parser-control-failed-expected {w base emsg lno ei fulldesc newdata} {
     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
@@ -508,20 +650,15 @@ proc parser-control-failed-expected {w base emsg lno ei fulldesc newdata} {
     $eb.text.text tag add error $lno.0 $lno.end
     $eb.text.text see $lno.0   
 }
-
-proc zoom {extail} {
-    global scale canvas
-    set nscale [expr "\$scale $extail"]
-    debug "ZOOM $scale $nscale"
-    if {$nscale < 1 || $nscale > 200} return
-    set scale $nscale
-    draw
+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 fulldesc okshow noneshow set parse} {
+proc reparse {base varname old fulldesc okshow noneshow parse ok} {
     upvar #0 $varname var
-    set old $var
-    uplevel 1 $set
     manyset [errexpect-catch {
        uplevel 1 $parse
        if {[string length [string trim $var]]} {
@@ -535,46 +672,179 @@ proc reparse {base varname fulldesc okshow noneshow set parse} {
            $emsg $lno $ei $fulldesc $var
        set var $old
        uplevel 1 $parse
+    } else {
+       uplevel 1 $ok
     }
 }
 
+#---------- main user interface ----------
+
+proc widgets-setup {} {
+    global canvas debug pirate ocean
+
+    wm geometry . 1024x480
+    wm title . "where-vessels - $pirate on the $ocean ocean"
+
+    #----- map -----
+
+    frame .f -border 1 -relief groove
+    set canvas .f.c
+    canvas $canvas
+    pack $canvas -expand 1 -fill both
+    pack .f -expand 1 -fill both -side left
+
+    #----- control panel -----
+
+    frame .ctrl
+    pack .ctrl -side left -anchor n
+
+    debug "BBOX [$canvas bbox all]"
+
+    panner::canvas-scroll-bbox .f.c
+    panner::create .ctrl.pan .f.c 120 120 $debug
+
+    pack .ctrl.pan -side top -pady 10 -padx 5
+    frame .ctrl.zoom
+    pack .ctrl.zoom -side top
+
+    button .ctrl.zoom.out -text - -font {Courier 16} -command {zoom /2}
+    button .ctrl.zoom.in  -text + -font {Courier 16} -command {zoom *2}
+    pack .ctrl.zoom.out .ctrl.zoom.in -side left
+
+    parser-control-create .ctrl.acquire \
+       acquire Acquire \
+       "Clipboard parsing error" \
+       
+    pack .ctrl.acquire -side top -pady 2
+
+    parser-control-create .ctrl.notes \
+       notes "Reload notes" \
+       "Vessel notes loading report" \
+       
+    pack .ctrl.notes -side top -pady 2
+
+    #----- decoding etc. report -----
+
+    frame .report
+    pack .report -side left -anchor n
+
+    label .report.island -text { }
+
+    frame .report.abbrev -background black
+    glset report_abbrev {         }
+    entry .report.abbrev.abbrev -state readonly \
+       -textvariable report_abbrev \
+       -borderwidth 0 -relief flat -width 0 \
+       -highlightbackground white \
+       -readonlybackground white -foreground black
+    pack .report.abbrev.abbrev -side left -padx 1 -pady 1
+
+    frame .report.code
+    label .report.code.lab -text Code:
+    glset report_code { }
+    entry .report.code.code -state readonly -textvariable report_code -width 15
+    pack .report.code.lab .report.code.code -side left
+    frame .report.details -bd 2 -relief groove -padx 2 -pady 2
+
+    listbox .report.list -height 5
+
+    pack .report.island .report.abbrev .report.details \
+       .report.list .report.code -side top
+    pack configure .report.details -fill x
+
+    foreach sw {inport class subclass lock own xabbrev} {
+       label .report.details.$sw -text { }
+       pack .report.details.$sw -side top -anchor w
+    }
+}
+
+proc report-set {sw val} { .report.details.$sw configure -text $val }
+
+proc show-report {islandname code} {
+    .report.island configure -text $islandname
+    glset report_code $code
+    glset report_abbrev [code2abbrev $code]
+
+    show-report-decode $code
+
+    set kk "$islandname $code"
+    upvar #0 found($kk) k
+
+    .report.list delete 0 end
+
+    foreach entry $k {
+       manyset $entry vid name
+       .report.list insert end $name
+    }
+}
+
+proc zoom {extail} {
+    global scale canvas
+    set nscale [expr "\$scale $extail"]
+    debug "ZOOM $scale $nscale"
+    if {$nscale < 1 || $nscale > 200} return
+    set scale $nscale
+    draw
+}
+
 proc invoke_acquire {} {
-    global clipboard
+    global clipboard errorInfo
+    set old $clipboard
+
+    if {[catch {
+       set clipboard [clipboard get]
+    } emsg]} {
+       parser-control-failed-unexpected .ctrl.acquire acquire \
+           $emsg "fetching clipboard:\n\n$errorInfo"
+       return
+    }
+
     reparse acquire \
-       clipboard "Clipboard contents:" { acquired ok } { no vessels } \
-       { set clipboard [clipboard get] } \
-       { parse-clipboard }
+       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 "Vessel notes:" "notes reloaded" { no notes } \
-       {
-           if {[catch {
-               load-notes
-           } emsg]} {
-               parser-control-failed-core .ctrl.notes notes \
-                   $emsg $emsg "Details and stack trace:" \
-                   "loading $notes_loc:\n\n$errorInfo"
-               return
-           }
-       } \
-       { parse-notes }
+    reparse notes \
+       notes_data $old "Vessel notes:" "loaded ok" { no notes } {
+           parse-notes
+           parse-clipboard
+       } {
+           display-note-infos
+       }
     draw
 }
 
 #---------- main program ----------
 
+vesselclasses-init
+
 parseargs
 argdefaults
 httpclientsetup where-vessels
 load-chart
 widgets-setup
 
-load-notes
-parse-notes
-parse-clipboard
+set notes_data {}
+if {[catch { parse-clipboard } emsg]} {
+    puts stderr "$emsg\n$errorInfo"
+    exit 1
+}
+after idle invoke_notes
 
 draw