chiark / gitweb /
where-vessels: UI for rounding down sizes
[ypp-sc-tools.main.git] / yarrg / where-vessels
1 #!/usr/bin/wish
2 # show your vessels on a map
3
4 # This is part of ypp-sc-tools, a set of third-party tools for assisting
5 # players of Yohoho Puzzle Pirates.
6 #
7 # Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
21 #
22 # Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
23 # are used without permission.  This program is not endorsed or
24 # sponsored by Three Rings.
25
26
27
28 source yarrglib.tcl
29 source panner.tcl
30 package require http
31
32 #---------- general utilities ----------
33
34 set debug 0
35 proc debug {m} {
36     global debug
37     if {$debug} { puts "DEBUG $m" }
38 }
39
40 proc badusage {m} {
41     puts stderr "where-vessels: bad usage: $m"
42     exit 1
43 }
44
45 proc glset {n val} {
46     upvar #0 $n var
47     set var $val
48 }
49
50 #---------- expecting certain errors ----------
51
52 proc errexpect-setline {lno line} {
53     glset errexpect_lno $lno
54     glset errexpect_line $line
55 }
56
57 proc errexpect-error {m} {
58     global errexpect_line errexpect_lno
59     error $m "$errexpect_line\n" [list YARRG-ERREXPECT $errexpect_lno]
60 }
61
62 proc errexpect-arrayget {arrayvar key} {
63     upvar 1 $arrayvar av
64     upvar 1 ${arrayvar}($key) v
65     if {[info exists v]} { return $v }
66     errexpect-error "undefined $key"
67 }
68
69 proc errexpect-arrayget-boolean {arrayvar key} {
70     switch -exact [uplevel 1 [list errexpect-arrayget $arrayvar $key]] {
71         true    { return 1 }
72         false   { return 0 }
73         default { errexpect-error "unexpected $key" }
74     }
75 }
76
77 proc errexpect-catch {code} {
78     global errorInfo errorCode
79     set rc [catch {
80         uplevel 1 $code
81     } rv]
82     debug "ERREXPECT CATCH |$rc|$rv|$errorCode|$errorInfo|"
83     if {$rc==1 && ![string compare YARRG-ERREXPECT [lindex $errorCode 0]]} {
84         return [list 1 $rv [lindex $errorCode 1] $errorInfo]
85     } elseif {$rc==0} {
86         return [list 0 $rv]
87     } else {
88         return -code $rc -errorinfo $errorInfo -errorcode $errorCode $rv
89     }
90 }
91
92 #---------- argument parsing ----------
93
94 proc nextarg {} {
95     global ai argv
96     if {$ai >= [llength $argv]} {
97         badusage "option [lindex $argv [expr {$ai-1}]] needs a value"
98     }
99     set v [lindex $argv $ai]
100     incr ai
101     return $v
102 }
103
104 set notes_loc vessel-notes
105 set scraper {./yppedia-ocean-scraper --chart}
106 set info_cache _vessel-info-cache
107 set info_source rsync.yarrg.chiark.net::yarrg/vessel-info
108
109 proc parseargs {} {
110     global ai argv
111     global debug scraper
112     set ai 0
113
114     while {[regexp {^\-} [set arg [lindex $argv $ai]]]} {
115         incr ai
116         switch -exact -- $arg {
117             -- { break }
118             --pirate { glset pirate [string totitle [nextarg]] }
119             --ocean { glset ocean [string totitle [nextarg]] }
120             --clipboard-file { load-clipboard-file [nextarg] }
121             --local-html-dir { lappend scraper --local-html-dir=[nextarg] }
122             --notes { glset notes_loc [nextarg] }
123             --vessel-info-source { glset info_source [nextarg] }
124             --debug { incr debug }
125             default { badusage "unknown option $arg" }
126         }
127     }
128     set argv [lrange $argv $ai end]
129     if {[llength $argv]} { badusage "non-option args not allowed" }
130 }
131
132 proc argdefaults {} {
133     global ocean notes_loc pirate scraper
134     if {![info exists ocean] || ![info exists pirate]} {
135         set cmd {./yarrg --find-window-only --quiet}
136         if {[info exists ocean]} { lappend cmd --ocean $ocean }
137         if {[info exists pirate]} { lappend cmd --pirate $pirate }
138         manyset [split [eval exec $cmd] " "] ocean pirate
139         if {![llength $ocean] || ![llength $pirate]} {
140             error "$ocean $pirate ?"
141         }
142     }
143     lappend scraper $ocean
144 }
145
146
147 #---------- loading and parsing the vessel notes ----------
148
149 proc load-notes {} {
150     global notes_loc notes_data
151     if {[regexp {^\w+\:} $notes_loc]} {
152         update
153         debug "FETCHING NOTES $notes_loc"
154         set req [::http::geturl $notes_loc]
155         switch -glob [::http::status $req].[::http::ncode $req] {
156             ok.200 { }
157             ok.* { error "retrieving vessel-notes: [::http::code $req]" }
158             * { error "Retrieving vessel-notes: [::http::error $req]" }
159         }
160         set newdata [::http::data $req]
161         ::http::cleanup $req
162     } else {
163         debug "READING NOTES $notes_loc"
164         set vn [open $notes_loc]
165         set newdata [read $vn]
166         close $vn
167     }
168     set notes_data $newdata
169 }
170
171 proc parse-notes {} {
172     global notes_data notes
173     catch { unset notes }
174
175     set lno 0
176     foreach l [split $notes_data "\n"] {
177         incr lno
178         errexpect-setline $lno $l
179         set l [string trim $l]
180         if {![string length $l]} continue
181         if {[regexp {^\#} $l]} continue
182         if {![regexp -expanded \
183                   {^ (\d+) (?: \s+([^=]*?) )? \s* =
184                       (?: \s* (\S+)
185                        (?: \s+ (\S+) )?)? $} \
186                   $l dummy vid vname owner note]} {
187               errexpect-error "badly formatted"
188         }
189         set vname [string trim $vname]
190         if {[info exists notes($vid)]} {
191             errexpect-error "duplicate vesselid $vid"
192         }
193         set notes($vid) [list $lno $vname $owner $note]
194     }
195 }
196
197 proc note-info {lno vid name island description} {
198     global note_infos
199     lappend note_infos [list $lno $vid $name $island $description]
200 }
201
202 proc display-note-infos {} {
203     global note_infos note_missings notes
204
205     set nmissing [llength $note_missings]
206     debug "display-note-infos $nmissing [array size notes]"
207
208     if {[llength $note_infos]} {
209         set tiny "[llength $note_infos] warning(s)"
210     } elseif {$nmissing && [array size notes]} {
211         set tiny "$nmissing missing"
212     } else {
213         return
214     }
215
216     set infodata {}
217
218     foreach info $note_infos {
219         manyset $info lno vid name island description
220         append infodata "vessel"
221         append infodata " $vid"
222         if {[string length $name]} { append infodata " $name" }
223         if {[string length $island]} { append infodata " ($island)" }
224         append infodata ": " $description "\n"
225     }
226
227     if {$nmissing} {
228         if {[string length $infodata]} { append infodata "\n" }
229         append infodata "$nmissing vessel(s) not mentioned in notes:\n"
230         set last_island {}
231         foreach info [lsort $note_missings] {
232             manyset $info island name vid
233             if {[string compare $island $last_island]} {
234                 append infodata "# $island:\n"
235                 set last_island $island
236             }
237             append infodata [format "%-9d %-29s =\n" $vid $name]
238         }
239     }
240
241     parser-control-failed-core .cp.ctrl.notes notes \
242         white blue 0 \
243         $tiny \
244         "[llength $note_infos] warning(s);\
245          $nmissing vessel(s) missing" \
246         "Full description of warnings and missing vessels:" \
247         $infodata
248 }
249
250 #---------- vessel properties ----------
251
252 proc info-cache-update {} {
253     global info_source info_cache
254     file mkdir $info_cache
255     exec sh -c "cp -u icons/* $info_cache/."
256
257     if {[string length $info_source]} {
258         set cmdl [list \
259                   rsync -udLKtOzm \
260                   --exclude=*~ --exclude=*.bak --exclude=.* --exclude=*.tmp \
261                   $info_source/ $info_cache 2>@ stderr]
262         debug "INFO-CACHE $cmdl"
263         eval exec $cmdl
264     }
265
266     set f [open $info_cache/vessel-info]
267     glset vessel_class_data [read $f]
268     close $f
269 }
270
271 proc vesselclasses-init {} {
272     global vc_game2code vc_code2abbrev vc_code2full vc_codes
273
274     global vessel_class_data
275     manyset $vessel_class_data classinfos subclassinfos
276
277     set vc_codes {}
278     foreach {game code abbrev full} $classinfos {
279         if {![regexp {^[a-z][a-z]$} $code code]} { error "bad code" }
280         if {![regexp {^[a-z][a-z]$} $abbrev abbrev]} { error "bad abbrev" }
281         lappend vc_codes $code
282         set vc_game2code($game) $code
283         set vc_code2abbrev($code) $abbrev
284         set vc_code2full($code) $full
285         load-icon $abbrev
286     }
287
288     global vsc_code2report
289     global vsc_game2code
290     set vsc_game2code(null) {}
291     set vsc_code2report() Ordinary
292     set vsc_code2report(!) "(Special/L.E.)"
293     foreach {game code full} $subclassinfos {
294         if {![regexp {^[A-Z]$} $code code]} { error "bad code" }
295         set vsc_game2code($game) $code
296         set vsc_code2report($code) $full
297     }
298
299     load-icon atsea
300     set owners {ours dot query}
301     foreach b $owners { load-icon $b }
302     foreach a {battle borrow dot} {
303         load-icon $a
304         foreach b $owners { load-icon-combine $a $b }
305     }
306 }
307
308 proc load-icon {icon} {
309     global info_cache
310     image create bitmap icon/$icon -file $info_cache/$icon.xbm
311 }
312
313 proc load-icon-combine {args} {
314     global info_cache
315     set cmd {}
316     set delim "pnmcat -lr "
317     foreach icon $args {
318         append cmd $delim " <(xbmtopbm $info_cache/$icon.xbm)"
319         set delim " <(pbmmake -white 1 1)"
320     }
321     append cmd " | pbmtoxbm"
322     debug "load-icon-combine $cmd"
323     image create bitmap icon/[join $args +] -data [exec bash -c $cmd]
324 }
325
326 proc code-lockown2icon {lockown} {
327     manyset [split $lockown ""] lock notown
328     set l "
329          [lindex {battle borrow dot} $lock]
330          [lindex {ours dot query {} {} dot} $notown]
331     "
332     if {[llength $l]} { return icon/[join $l +] } { return {} }
333 }
334
335 proc canvas-horiz-stack {xvar xoff y bind type args} {
336     upvar 1 $xvar x
337     upvar 1 canvas canvas
338     set id [eval $canvas create $type [expr {$x+$xoff}] $y $args]
339     set bbox [$canvas bbox $id]
340 #   debug "CANVAS-HORIZ-STACK $type $x $xoff $id $bbox [list $args]"
341     set x [lindex $bbox 2]
342     $canvas bind $id <ButtonPress> $bind
343     return $id
344 }
345
346 proc code2canvas {code canvas x yvar qty qtylen bind} {
347     global vc_code2abbrev
348     upvar 1 $yvar y
349
350     manyset [split $code _] inport class subclass lockown xabbrev
351
352     set stackx $x
353     incr stackx 2
354     set imy [expr {$y+2}]
355
356     if {!$inport} { incr qtylen -1 }
357     if {$qtylen<=0} { set qtylen {} }
358     set qty [format "%${qtylen}s" $qty]
359
360     set qtyid [canvas-horiz-stack stackx 0 $y $bind \
361                    text -anchor nw -font fixed -text $qty]
362
363     if {!$inport} {
364         canvas-horiz-stack stackx 0 $imy $bind \
365             image -anchor nw -image icon/atsea
366         incr stackx
367     }
368     
369     upvar #0 vc_code2abbrev($class) vcabb
370     if {![info exists vcabb]} {
371         set vcabb vc-$class
372         image create bitmap icon/$vcabb -data \
373             [exec pbmtext -builtin fixed $class | pnminvert | pnmcrop >t.pnm]
374     }
375     canvas-horiz-stack stackx -1 $imy $bind \
376             image -anchor nw -image icon/$vcabb
377
378     if {[string length $subclass]} {
379         canvas-horiz-stack stackx 0 $y $bind \
380             text -anchor nw -font fixed -text \
381             $subclass
382     }
383
384     incr stackx
385     set lockownicon [code-lockown2icon $lockown]
386     if {[string length $lockownicon]} {
387         canvas-horiz-stack stackx 0 $imy $bind \
388             image -anchor nw -image $lockownicon
389         incr stackx
390     }
391     
392     if {[string length $xabbrev]} {
393         canvas-horiz-stack stackx 0 $y $bind \
394             text -anchor nw -font fixed -text \
395             $xabbrev
396     }
397     
398     set bbox [$canvas bbox $qtyid]
399     set ny [lindex $bbox 3]
400     set bid [$canvas create rectangle \
401                  $x $y $stackx $ny \
402                  -fill white]
403
404     set y $ny
405     $canvas lower $bid $qtyid
406
407     $canvas bind $bid <ButtonPress> $bind
408 }
409
410 proc show-report-decode {code} {
411     global vc_code2full
412
413     manyset [split $code _] inport classcode subclass lockown xabbrev
414     manyset [split $lockown ""] lock notown
415     
416     report-set inport [lindex {{At Sea} {In port}} $inport]
417     report-set class $vc_code2full($classcode)
418
419     global smash_subclass
420     if {$smash_subclass >= 2} {
421         report-set subclass "(Any subclass)"
422     } elseif {[
423                upvar #0 vsc_code2report($subclass) subclass_report
424                info exists subclass_report
425               ]} {
426         report-set subclass $subclass_report
427     } else {
428         report-set subclass "Subclass \"$subclass\""
429     }
430
431     report-set lock [lindex {
432         {Battle ready} {Unlocked} {Locked}
433         {(All lock states)} {(Not battle ready)}
434     } $lock]
435
436     switch -exact $notown {
437         0 { report-set own "Yours" }
438         1 { report-set own "Other pirate's" }
439         2 { report-set own "Owner unknown" }
440         3 { report-set own "(All ownerships)" }
441         4 - 5 { report-set own "(Yours/unknown)" }
442         default { report-set own "?? $notown" }
443     }
444
445     if {[string length $xabbrev]} {
446         report-set xabbrev "Notes flags: $xabbrev"
447     } else {
448         report-set xabbrev "No flags in notes"
449     }
450 }
451
452 #---------- common to smashing and filtering ----------
453
454 proc make-control {parent ctrl label ekind} {
455     debug "MAKE-CONTROL [list $parent $ctrl $label $ekind]"
456     label $parent.lab_$ctrl -text $label -justify left
457     $ekind $parent.$ctrl
458     manyset [grid size $parent] dummy row
459     incr row
460     grid configure $parent.lab_$ctrl -row $row -column 0 -sticky nw -pady 4
461     grid configure $parent.$ctrl -row $row -column 1 -sticky w -pady 3
462     return $parent.$ctrl
463 }
464
465 proc begin-control-grid {cw count rows inrow} {
466     if {!$inrow} { set inrow [expr {($count + $rows) / $rows}] }
467     upvar #0 control_grid_properties($cw) props
468     set props [list $rows $inrow]
469     return $cw
470 }
471
472 proc make-control-grid-entry {cw kind ix ekind args} {
473     upvar #0 control_grid_properties($cw) props
474     manyset $props rows inrow
475
476     set ew $cw.$ix
477
478     debug "MAKE-CONTROL-GRID-ENTRY $cw $kind $ix $ekind $rows $inrow $ew"
479
480     eval [list $ekind $ew] $args
481
482     switch -exact $kind {
483         ix {
484             grid configure $ew -sticky sw \
485                 -row [expr {$ix / $inrow}] \
486                 -column [expr {$ix % $inrow}]
487         }
488         final {
489             grid configure $ew -sticky se \
490                 -row [expr {$rows-1}] \
491                 -column [expr {$inrow-1}]
492         }
493         default {
494             error "$kind ?"
495         }
496     }
497     return $ew
498 }
499
500 proc control-tickbox-flip {varsvn values} {
501     upvar #0 $varsvn vars
502     foreach val $values {
503         set vars($val) [expr {!$vars($val)}]
504     }
505     redraw-needed c.-tickbox-flip $varsvn $values
506 }
507
508 proc populate-control-grid-tickboxes {cw rows inrow varsvn values
509                                     label_kind valvn default_get label_get} {
510     debug "POPULATE-CONTROL-GRID-TICKBOXES $cw $rows $inrow $varsvn\
511              [list $values] $label_kind $valvn"
512
513     upvar #0 $varsvn vars
514     upvar 1 $valvn val
515     set count [llength $values]
516
517     begin-control-grid $cw $count $rows $inrow
518
519     for {set ix 0} {$ix < $count} {incr ix} {
520         set val [lindex $values $ix]
521         set vars($val) [uplevel 1 $default_get]
522         set ew [make-control-grid-entry $cw ix $ix checkbutton \
523                     -variable ${varsvn}($val) \
524                     -font fixed \
525                     -command [list redraw-needed c.-g.-tickbox $cw $val]]
526         $ew configure -$label_kind [uplevel 1 $label_get]
527         switch -exact $label_kind {
528             image { $ew configure -height 16 }
529         }
530     }
531     [make-control-grid-entry $cw final invert button] \
532         configure \
533         -text flip -command [list control-tickbox-flip $varsvn $values] \
534         -padx 0 -pady 0
535 }
536
537 #---------- smashing ----------
538
539 set smash_subclass 0
540 set smash_owner 0
541
542 proc smash-code {code} {
543     manyset [split $code _] inport class subclass lockown xabbrev
544
545     global smash_subclass
546     if {$smash_subclass > 1} {
547         set subclass {}
548     } elseif {$smash_subclass && [string length $subclass]} {
549         set subclass !
550     }
551
552     global smash_owner
553     switch $smash_owner {
554         0 { }
555         1 { regsub {[12]$} $lockown 5 lockown }
556         2 {
557             if {[regexp {^0.} $lockown]} {
558                 # battle ready / all lock states
559                 set lockown 03
560             } elseif {[regexp {^.0} $lockown]} {
561                 # not battle ready / yours
562                 set lockown 40
563             } else {
564                 # state (not battle ready) / not known to be yours
565                 regsub {.$} $lockown 4 lockown
566             }
567         }
568         3 { regsub {.$} $lockown {3} lockown }
569         4 { set lockown 33 }
570     }
571
572     return [join [list $inport $class $subclass $lockown $xabbrev] _]
573 }
574
575 proc make-smasher {sma label ekind} {
576     return [make-control .smash $sma $label $ekind]
577 }
578
579 proc make-radio-smasher {sma label variable descs rows inrow} {
580     set w [make-smasher $sma $label frame]
581     begin-control-grid $w [llength $descs] $rows $inrow
582     for {set i 0} {$i < [llength $descs]} {incr i} {
583         make-control-grid-entry $w ix $i \
584             radiobutton \
585             -variable $variable -value $i -command redraw-needed \
586             -text [lindex $descs $i]
587     }
588 }
589
590 proc make-smashers {} {
591     make-radio-smasher subclass Subclass smash_subclass \
592         {Show Normal/LE Hide} 1 0
593
594     make-radio-smasher owner Owner smash_owner \
595         {Show Yours? {For you} Lock Hide} 2 3
596
597     global vc_codes vc_code2abbrev
598
599     set cw [make-smasher size "Size\nround down" frame]
600     populate-control-grid-tickboxes $cw 2 0 smash_size $vc_codes \
601         image val { expr 0 } { expr {"icon/$vc_code2abbrev($val)"} }
602 }
603
604 #---------- filtering ----------
605
606 set filters {}
607
608 proc filter-values/size {} { global vc_codes; return $vc_codes }
609 proc filter-icon/size {code} {
610     upvar #0 vc_code2abbrev($code) abb
611     return icon/$abb
612 }
613 proc filter-default/size {code} { return 1 }
614 proc filter-says-yes/size {codel} {
615     set sizecode [lindex $codel 1]
616     upvar #0 filter_size($sizecode) yes
617     return $yes
618 }
619
620 proc filter-values/lockown {} {
621     foreach lv {0 1 2} {
622         foreach ov {0 1 2} {
623             lappend vals "$lv$ov"
624         }
625     }
626     return $vals
627 }
628 proc filter-icon/lockown {lockown} { return [code-lockown2icon $lockown] }
629 proc filter-default/lockown {lockown} {
630     return [regexp {^[01]|^2[^1]} $lockown]
631 }
632 proc filter-says-yes/lockown {codel} {
633     set lockown [lindex $codel 3]
634     upvar #0 filter_lockown($lockown) yes
635     debug "FILTER-SAYS-YES/LOCKOWN $codel $lockown $yes"
636     return $yes
637 }
638
639 proc filter-validate/xabbre {re} {
640     if {[catch {
641         regexp -- $re {}
642     } emsg]} {
643         regsub {^.*:\s*} $emsg {} emsg
644         regsub {^.*(.{30})$} $emsg {\1} emsg
645         return $emsg
646     }
647     return {}
648 }
649 proc filter-says-yes/xabbre {codel} {
650     global filter_xabbre
651     set xabbrev [lindex $codel 4]
652     return [regexp -- $filter_xabbre $xabbrev]
653 }
654
655 proc make-tickbox-filter {fil label rows inrow} {
656     set values [filter-values/$fil]
657
658     if {![catch { info args filter-icon/$fil }]} {
659         set label_get { filter-icon/$fil $val }
660         set label_kind image
661     } else {
662         set label_get { filter-map/$fil $val }
663         set label_kind text
664     }
665
666     set fw [make-filter $fil $label frame]
667
668     populate-control-grid-tickboxes $fw $rows $inrow filter_$fil $values \
669          $label_kind val { filter-default/$fil $val } $label_get
670 }
671
672 proc entry-filter-changed {fw fil n1 n2 op} {
673     global errorInfo
674     upvar #0 filter_$fil realvar
675     upvar #0 filterentered_$fil entryvar
676     global def_background
677     debug "entry-filter-changed $fw $fil $entryvar"
678     if {[catch {
679         set error [filter-validate/$fil $entryvar]
680         if {[string length $error]} {
681             $fw.error configure -text $error -foreground white -background red
682         } else {
683             $fw.error configure -text { } -background $def_background
684             set realvar $entryvar
685             redraw-needed
686         }
687     } emsg]} {
688         puts stderr "FILTER CHECK ERROR $emsg $errorInfo"
689     }
690 }
691
692 proc make-entry-filter {fil label def} {
693     global filterentered_$fil
694     upvar #0 filter_$fil realvar
695     set realvar $def
696     set fw [make-filter $fil $label frame]
697     entry $fw.entry -textvariable filterentered_$fil
698     label $fw.error
699     glset def_background [$fw.error cget -background]
700     trace add variable filterentered_$fil write \
701         [list entry-filter-changed $fw $fil]
702     pack $fw.entry $fw.error -side top -anchor w
703 }
704
705 proc make-filter {fil label ekind} {
706     global filters
707     lappend filters $fil
708     return [make-control .filter $fil $label $ekind]
709 }
710
711 proc make-filters {} {
712     make-tickbox-filter size Size 2 0
713     make-tickbox-filter lockown "Lock/\nowner" 2 6
714     make-entry-filter xabbre "Flags\n regexp" {}
715 }
716
717 proc filterstyle-changed {n1 n2 op} {
718     global filterstyle
719     debug "filterstyle-changed $filterstyle"
720     redraw-needed
721 }
722
723 proc filters-say-yes {code} {
724     global filters filterstyle
725     set codel [split $code _]
726     set lockown [lindex $codel 3]
727     switch -exact $filterstyle {
728         0 { return 1 }
729         1 { return [filter-default/lockown $lockown] }
730         2 { return [regexp {^.0} $lockown] }
731         3 { }
732         default { error $filterstyle }
733     }
734     
735     foreach fil $filters {
736         if {![filter-says-yes/$fil $codel]} {
737             debug "FILTERS-SAY-YES $code NO $fil"
738             return 0
739         }
740     }
741     debug "FILTERS-SAY-YES $code YES $filters"
742     return 1
743 }
744     
745 #---------- loading and parsing the clipboard (vessel locations) ----------
746
747 proc vessel {vin} {
748     global pirate notes_used note_missings newnotes
749     upvar 1 $vin vi
750
751     set codel {}
752     lappend codel [errexpect-arrayget-boolean vi inPort]
753
754     set gameclass [errexpect-arrayget vi vesselClass]
755     upvar #0 vc_game2code($gameclass) class
756     if {![info exists class]} {
757         set class "($gameclass)"
758         upvar #0 vc_code2abbrev($class) vcabb
759         set vcabb vc-$class
760         set data [exec pbmtext -builtin fixed " $gameclass " \
761                  | pnminvert | pnmcrop | pbmtoxbm]
762         debug "INVENTED ICON $vcabb $data"
763         image create bitmap icon/$vcabb -data $data
764             
765         global vc_code2full
766         set vc_code2full($class) "Type \"$gameclass\""
767     }
768     lappend codel $class
769
770     set gamesubclass [errexpect-arrayget vi vesselSubclass]
771     upvar #0 vsc_game2code($gamesubclass) subclass
772     if {[info exists subclass]} {
773         lappend codel $subclass
774     } else {
775         lappend codel ($gamesubclass)
776     }
777
778     switch -exact [errexpect-arrayget vi isLocked]/[ \
779                    errexpect-arrayget vi isBattleReady] {
780         true/false      { set lock 2 }
781         false/false     { set lock 1 }
782         false/true      { set lock 0 }
783         default         { errexpect-error "unexpected isLocked/isBattleReady" }
784     }
785
786     set vid [errexpect-arrayget vi vesselId]
787     upvar #0 notes($vid) note
788     set realname [errexpect-arrayget vi vesselName]
789     set island [errexpect-arrayget vi islandName]
790
791     set owner {}
792     set xabbrev {}
793     if {[info exists note]} {
794         manyset $note lno notename owner xabbrev
795         if {[string compare -nocase $realname $notename]} {
796             note-info $lno $vid $realname $island \
797                 "notes say name is $notename"
798         }
799         if {[string length $owner]} {
800             if {![string compare $owner $pirate]} {
801                 set notown 0
802             } else {
803                 set notown 1
804             }
805         } else {
806             set notown 2
807         }
808         append abbrev $xabbrev
809         set notes_used($vid) 1
810
811     } else {
812         set notown 2
813         lappend note_missings [list $island $realname $vid]
814     }
815
816     lappend codel "$lock$notown" $xabbrev
817     lappend newnotes [list $vid $realname $owner $xabbrev]
818     set kk "$island [join $codel _]"
819     upvar #0 found($kk) k
820     lappend k [list $vid $realname $owner]
821  
822     debug "CODED $kk $vid $realname"
823 }
824
825 set clipboard {}
826 proc parse-clipboard {} {
827     global clipboard found notes notes_used newnotes
828
829     catch { unset found }
830     catch { unset notes_used }
831     glset note_infos {}
832     glset note_missings {}
833
834     set newnotes {}
835     
836     set itemre { (\w+) = ([^=]*) }
837     set manyitemre "^\\\[ $itemre ( (?: ,\\ $itemre)* ) \\]\$"
838     debug $manyitemre
839
840     set lno 0
841     foreach l [split $clipboard "\n"] {
842         incr lno
843         errexpect-setline $lno $l
844         if {![string length $l]} continue
845         catch { unset vi }
846         while 1 {
847                 if {![regexp -expanded $manyitemre $l dummy \
848                         thiskey thisval rhs]} {
849                     errexpect-error "badly formatted"
850                 }
851                 set vi($thiskey) $thisval
852                 if {![string length $rhs]} break
853                 regsub {^, } $rhs {} rhs
854                 set l "\[$rhs\]"
855         }
856         vessel vi
857     }
858
859     if {[llength $newnotes]} {
860         foreach vid [lsort [array names notes]] {
861             if {![info exists notes_used($vid)]} {
862                 manyset $notes($vid) lno notename
863                 note-info $lno $vid $notename {} \
864                     "vessel in notes no longer found"
865             }
866         }
867     }
868 }
869
870 proc load-clipboard-file {fn} {
871     set f [open $fn]
872     glset clipboard [read $f]
873     close $f
874 }
875
876
877 #---------- loading and parsing the chart ----------
878
879 proc load-chart {} {
880     global chart scraper
881     debug "FETCHING CHART"
882     set chart [eval exec $scraper [list | perl -we {
883         use strict;
884         use CommodsScrape;
885         use IO::File;
886         use IO::Handle;
887         yppedia_chart_parse(\*STDIN, (new IO::File ">/dev/null"),
888                 sub { sprintf "%d %d", @_; },
889                 sub { printf "archlabel %d %d %s\n", @_; },
890                 sub { printf "island %s {%s} %s\n", @_; },
891                 sub { printf "league %s %s %s.\n", @_; },
892                 sub { printf STDERR "warning: %s: incomprehensible: %s", @_; }
893                         );
894         STDOUT->error and die $!;
895     }]]
896 }
897
898
899 set scale 16
900
901 proc coord {c} {
902         global scale
903         return [expr {$c * $scale}]
904 }
905
906 proc chart-got/archlabel {args} { }
907 proc chart-got/island {x y isle sizecol} {
908         debug "ISLE $x $y $isle $sizecol"
909         global canvas isleloc
910         set isleloc($isle) [list $x $y]
911         set sz 5
912 #       $canvas create oval \
913 #               [expr {[coord $x] - $sz}] [expr {[coord $y] - $sz}] \
914 #               [expr {[coord $x] + $sz}] [expr {[coord $y] + $sz}] \
915 #               -fill blue
916         set colour "#888"
917         if {[string match *_col $sizecol]} { set colour black }
918         $canvas create text [coord $x] [coord $y] \
919                 -text $isle -anchor s -fill $colour
920 }
921 proc chart-got/league {x1 y1 x2 y2 kind} {
922 #       debug "LEAGUE $x1 $y1 $x2 $y2 $kind"
923         global canvas
924         set l [$canvas create line \
925                 [coord $x1] [coord $y1] \
926                 [coord $x2] [coord $y2]]
927         if {![string compare $kind .]} {
928                 $canvas itemconfigure $l -dash .
929         }
930 }
931
932 proc debug-filter-array {array} {
933     upvar #0 $array a
934     set m " FILTER $array"
935     foreach k [lsort [array names a]] {
936         append m " $k=$a($k)"
937     }
938     debug $m
939 }
940
941 proc redraw-needed {args} {
942     global redraw_after
943     debug "REDRAW NEEDED $args"
944     if {[info exists redraw_after]} return
945
946     global filterstyle
947     debug " FILTER style $filterstyle"
948     debug-filter-array filter_size
949     debug-filter-array filter_lockown
950     global filter_xabbre
951     debug " FILTER xabbre $filter_xabbre"
952
953     set redraw_after [after 250 draw]
954 }
955
956 proc draw {} {
957     global chart found isleloc canvas redraw_after islandnames smfound
958
959     catch { after cancel $redraw_after }
960     catch { unset redraw_after }
961     
962     $canvas delete all
963
964     foreach l [split $chart "\n"] {
965 #       debug "CHART-GOT $l"
966         set proc [lindex $l 0]
967         eval chart-got/$proc [lrange $l 1 end]
968     }
969
970     catch { unset smfound }
971     foreach key [lsort [array names found]] {
972         regexp {^(.*) (\S+)$} $key dummy islandname code
973
974         if {![filters-say-yes $code]} continue
975
976         set smcode [smash-code $code]
977         debug "smashed $code => $smcode"
978         set smkey "$islandname $smcode"
979         foreach vessel $found($key) { lappend smfound($smkey) $vessel }
980     }
981
982     set islandnames {}
983     set lastislandname {}
984     foreach smkey [lsort [array names smfound]] {
985         set c [llength $smfound($smkey)]
986         regexp {^(.*) (\S+)$} $smkey dummy islandname code
987         debug "SHOWING [list $smkey $c $islandname $code l=$lastislandname]"
988
989         if {[string compare $lastislandname $islandname]} {
990                 manyset $isleloc($islandname) x y
991                 set x [coord $x]
992                 set y [coord $y]
993                 set lastislandname $islandname
994                 lappend islandnames $islandname
995 #               debug "START Y $y"
996         }
997
998         if {$c > 1} { set qty [format %d $c] } else { set qty {} }
999         code2canvas $code $canvas $x y $qty 2 \
1000             [list show-report $islandname $code]
1001 #       debug "NEW Y $y"
1002     }
1003
1004     panner::updatecanvas-bbox .cp.ctrl.pan
1005
1006     islandnames-update
1007 }
1008
1009
1010 #---------- parser error reporting ----------
1011
1012 proc parser-control-create {w base invokebuttontext etl_title} {
1013     frame $w
1014     button $w.do -text $invokebuttontext -command invoke_$base -pady 3
1015
1016     frame $w.resframe -width 120 -height 32
1017     button $w.resframe.res -text {} -anchor nw \
1018         -padx 1 -pady 1 -borderwidth 0 -justify left
1019     glset deffont_$base [$w.resframe.res cget -font]
1020     place $w.resframe.res -relx 0.5 -y 0 -anchor n
1021
1022     pack $w.do -side top
1023     pack $w.resframe -side top -expand y -fill both
1024
1025     set eb .err_$base
1026     toplevel $eb
1027     wm withdraw $eb
1028     wm title $eb "where-vessels - $etl_title"
1029     wm protocol $eb WM_DELETE_WINDOW [list wm withdraw $eb]
1030
1031     label $eb.title -text $etl_title
1032     pack $eb.title -side top
1033
1034     button $eb.close -text Close -command [list wm withdraw $eb]
1035     pack $eb.close -side bottom
1036
1037     frame $eb.emsg -bd 2 -relief groove
1038     label $eb.emsg.lab -anchor nw -text "Error:"
1039     text $eb.emsg.text -height 1
1040     pack $eb.emsg.text -side bottom -fill x
1041     pack $eb.emsg.lab -side left
1042
1043     pack $eb.emsg -side top -pady 2 -fill x
1044
1045     frame $eb.text -bd 2 -relief groove
1046     pack $eb.text -side bottom -pady 2 -fill both -expand y
1047     
1048     label $eb.text.lab -anchor nw
1049
1050     text $eb.text.text -width 85 \
1051         -xscrollcommand [list $eb.text.xscroll set] \
1052         -yscrollcommand [list $eb.text.yscroll set]
1053     $eb.text.text tag configure error \
1054         -background red -foreground white
1055
1056     scrollbar $eb.text.xscroll -orient horizontal \
1057         -command [list $eb.text.text xview]
1058     scrollbar $eb.text.yscroll -orient vertical \
1059         -command [list $eb.text.text yview]
1060
1061     grid configure $eb.text.lab -row 0 -column 0 -sticky w -columnspan 2
1062     grid configure $eb.text.text -row 1 -column 0 -sticky news
1063     grid configure $eb.text.yscroll -sticky ns -row 1 -column 1
1064     grid configure $eb.text.xscroll -sticky ew -row 2 -column 0
1065     grid rowconfigure $eb.text 0 -weight 0
1066     grid rowconfigure $eb.text 1 -weight 1
1067     grid rowconfigure $eb.text 2 -weight 0
1068     grid columnconfigure $eb.text 0 -weight 1
1069     grid columnconfigure $eb.text 1 -weight 0
1070 }
1071
1072 proc parser-control-ok-core {w base background show} {
1073     debug "parser-control-ok-core $w $base $background $show"
1074     upvar #0 deffont_$base deffont
1075     $w.resframe.res configure \
1076         -background $background -disabledforeground black -font $deffont \
1077         -state disabled -command {} \
1078         -text $show
1079 }    
1080 proc parser-control-ok {w base show} {
1081     parser-control-ok-core $w $base green $show
1082 }
1083 proc parser-control-none {w base show} {
1084     parser-control-ok-core $w $base blue $show
1085 }
1086 proc parser-control-failed-core {w base foreground background smallfont
1087                                  tiny summary fulldesc fulldata} {
1088     debug "parser-control-failed-core $w $base $summary $fulldesc"
1089     upvar #0 deffont_$base deffont
1090     set eb .err_$base
1091
1092     $eb.emsg.text delete 0.0 end
1093     $eb.emsg.text insert end $summary
1094
1095     $eb.text.lab configure -text $fulldesc
1096     $eb.text.text delete 0.0 end
1097     $eb.text.text insert end $fulldata
1098
1099     regsub -all {.{18}} $tiny "&\n" ewrap
1100
1101     if {$smallfont} {
1102         set font fixed
1103     } else {
1104         set font $deffont
1105     }
1106
1107     $w.resframe.res configure \
1108         -background $background -foreground $foreground -font $font \
1109         -state normal -command [list wm deiconify $eb] \
1110         -text $ewrap
1111 }
1112     
1113 proc parser-control-failed-expected {w base emsg lno ei fulldesc newdata} {
1114     set eb .err_$base
1115
1116     set line [lindex [split $ei "\n"] 0]
1117     debug "parser-control-failed-expected: $w $base: $lno: $emsg\n $line"
1118
1119     parser-control-failed-core $w $base \
1120         white red 1 \
1121         "err: [string trim $emsg]: \"$line\"" \
1122         "at line $lno: $emsg" \
1123         $fulldesc $newdata
1124
1125     $eb.text.text tag add error $lno.0 $lno.end
1126     $eb.text.text see $lno.0    
1127 }
1128 proc parser-control-failed-unexpected {w base emsg ei} {
1129     global errorInfo
1130     parser-control-failed-core $w $base \
1131         black yellow 1 \
1132         $emsg $emsg "Details and stack trace:" $ei
1133 }
1134
1135 proc reparse {base varname old fulldesc okshow noneshow parse ok} {
1136     upvar #0 $varname var
1137     manyset [errexpect-catch {
1138         uplevel 1 $parse
1139         if {[string length [string trim $var]]} {
1140             parser-control-ok .cp.ctrl.$base $base $okshow
1141         } else {
1142             parser-control-none .cp.ctrl.$base $base $noneshow
1143         }
1144     }] failed emsg lno ei
1145     if {$failed} {
1146         parser-control-failed-expected .cp.ctrl.$base $base \
1147             $emsg $lno $ei $fulldesc $var
1148         set var $old
1149         uplevel 1 $parse
1150     } else {
1151         uplevel 1 $ok
1152     }
1153 }
1154
1155 #---------- island names selection etc. ----------
1156
1157 proc islandnames-update {} {
1158     global islandnames
1159     .islands.count configure -text [format "ships at %d island(s)" \
1160                                         [llength $islandnames]]
1161 }
1162
1163 proc islandnames-select {} {
1164     .islands.clip configure -relief sunken -state disabled
1165     selection own -command islandnames-deselect .islands.clip
1166 }
1167 proc islandnames-deselect {} {
1168     .islands.clip configure -relief raised -state normal
1169 }
1170
1171 proc islandnames-handler {offset maxchars} {
1172     global islandnames
1173     return [string range [join $islandnames ", "] \
1174                 $offset [expr {$offset+$maxchars-1}]]
1175 }
1176
1177 #---------- main user interface ----------
1178
1179 proc widgets-setup {} {
1180     global canvas debug pirate ocean filterstyle
1181
1182     wm geometry . 1200x800
1183     wm title . "where-vessels - $pirate on the $ocean ocean"
1184
1185     #----- map -----
1186
1187     frame .f -border 1 -relief groove
1188     set canvas .f.c
1189     canvas $canvas
1190     pack $canvas -expand 1 -fill both
1191     pack .f -expand 1 -fill both -side left
1192
1193     #----- control panels and filter -----
1194
1195     frame .cp
1196     frame .smash -relief groove -bd 2 -padx 1
1197     frame .filter -relief groove -bd 2 -padx 1
1198     frame .islands -pady 2
1199     pack .cp .filter .islands .smash -side top
1200
1201     label .smash.title -text {Display/combine details}
1202     grid .smash.title -row 0 -column 0 -columnspan 2
1203
1204     set filterstyle 1
1205     trace add variable filterstyle write filterstyle-changed
1206
1207     frame .filter.title
1208     label .filter.title.title -text Show
1209     pack .filter.title.title -side left
1210     for {set fing 0} {$fing < 4} {incr fing} {
1211         radiobutton .filter.title.f$fing \
1212             -variable filterstyle -value $fing \
1213             -text [lindex {All Useable Mine These:} $fing]
1214         pack .filter.title.f$fing -side left
1215     }
1216
1217     grid configure .filter.title -row 0 -column 0 -columnspan 2
1218
1219     #----- control panel -----
1220
1221     frame .cp.ctrl
1222     pack .cp.ctrl -side left -anchor n
1223
1224     debug "BBOX [$canvas bbox all]"
1225
1226     panner::canvas-scroll-bbox .f.c
1227     panner::create .cp.ctrl.pan .f.c 120 120 $debug
1228
1229     pack .cp.ctrl.pan -side top -pady 0 -padx 5
1230     frame .cp.ctrl.zoom
1231     pack .cp.ctrl.zoom -side top
1232
1233     button .cp.ctrl.zoom.out -text - -font {Courier 16} -command {zoom /2} -pady 0
1234     button .cp.ctrl.zoom.in  -text + -font {Courier 16} -command {zoom *2} -pady 0
1235     pack .cp.ctrl.zoom.out .cp.ctrl.zoom.in -side left
1236
1237     parser-control-create .cp.ctrl.acquire \
1238         acquire Acquire \
1239         "Clipboard parsing error" \
1240         
1241     pack .cp.ctrl.acquire -side top -pady 2
1242
1243     parser-control-create .cp.ctrl.notes \
1244         notes "Reload notes" \
1245         "Vessel notes loading report" \
1246         
1247     pack .cp.ctrl.notes -side top -pady 2
1248
1249     #----- island name count and copy -----
1250
1251     label .islands.count
1252     button .islands.clip -text "copy island names" -pady 2 -padx 2 \
1253          -command islandnames-select
1254     selection handle .islands.clip islandnames-handler
1255     pack .islands.count .islands.clip -side left
1256
1257     #----- decoding etc. report -----
1258
1259     frame .cp.report
1260     pack .cp.report -side left -anchor n
1261
1262     label .cp.report.island -text { }
1263
1264     canvas .cp.report.abbrev -width 1 -height 15
1265
1266     frame .cp.report.code
1267     label .cp.report.code.lab -text Code:
1268     glset report_code { }
1269     entry .cp.report.code.code -state readonly \
1270         -textvariable report_code -width 15
1271     pack .cp.report.code.lab .cp.report.code.code -side left
1272     frame .cp.report.details -bd 2 -relief groove -padx 2 -pady 2
1273
1274     listbox .cp.report.list -height 5
1275
1276     pack .cp.report.island .cp.report.abbrev .cp.report.details \
1277         .cp.report.list -side top
1278     #pack .cp.report.code -side top
1279     pack configure .cp.report.details -fill x
1280
1281     foreach sw {inport class subclass lock own xabbrev} {
1282         label .cp.report.details.$sw -text { }
1283         pack .cp.report.details.$sw -side top -anchor w
1284     }
1285 }
1286
1287 proc report-set {sw val} { .cp.report.details.$sw configure -text $val }
1288
1289 proc show-report {islandname code} {
1290     .cp.report.island configure -text $islandname
1291
1292     .cp.report.abbrev delete all
1293     set y 2
1294     code2canvas $code .cp.report.abbrev 5 y {} 0 {}
1295     manyset [.cp.report.abbrev bbox all] minx dummy maxx dummy
1296     .cp.report.abbrev configure -width [expr {$maxx-$minx+4}]
1297
1298     glset report_code $code
1299     show-report-decode $code
1300
1301     set kk "$islandname $code"
1302     upvar #0 smfound($kk) k
1303
1304     .cp.report.list delete 0 end
1305
1306     foreach entry $k {
1307         manyset $entry vid name owner
1308         lappend owned($owner) $name
1309     }
1310
1311     foreach owner [lsort [array names owned]] {
1312         if {[string length $owner]} {
1313             set owndesc "$owner's"
1314         } else {
1315             set owndesc "Owner unknown"
1316         }
1317         .cp.report.list insert end "$owndesc:"
1318         foreach name $owned($owner) {
1319             .cp.report.list insert end " $name"
1320         }
1321     }
1322 }
1323
1324 proc zoom {extail} {
1325     global scale canvas
1326     set nscale [expr "\$scale $extail"]
1327     debug "ZOOM $scale $nscale"
1328     if {$nscale < 1 || $nscale > 200} return
1329     set scale $nscale
1330     draw
1331 }
1332
1333 proc invoke_acquire {} {
1334     global clipboard errorInfo
1335     set old $clipboard
1336
1337     if {[catch {
1338         set clipboard [clipboard get]
1339     } emsg]} {
1340         parser-control-failed-unexpected .cp.ctrl.acquire acquire \
1341             $emsg "fetching clipboard:\n\n$errorInfo"
1342         return
1343     }
1344
1345     reparse acquire \
1346         clipboard $old "Clipboard contents:" { acquired ok } { no vessels } {
1347             parse-clipboard
1348         } {
1349             display-note-infos
1350         }
1351     draw
1352 }
1353
1354 proc invoke_notes {} {
1355     global notes_data errorInfo notes_loc
1356     set old $notes_data
1357     
1358     if {[catch {
1359         load-notes
1360     } emsg]} {
1361         parser-control-failed-unexpected .cp.ctrl.notes notes \
1362             $emsg "loading $notes_loc:\n\n$errorInfo"
1363         return
1364     }
1365
1366     reparse notes \
1367         notes_data $old "Vessel notes:" "loaded ok" { no notes } {
1368             parse-notes
1369             parse-clipboard
1370         } {
1371             display-note-infos
1372         }
1373     draw
1374 }
1375
1376 #---------- main program ----------
1377
1378 parseargs
1379 argdefaults
1380 httpclientsetup where-vessels
1381 info-cache-update
1382 vesselclasses-init
1383 load-chart
1384 widgets-setup
1385 make-filters
1386 make-smashers
1387
1388 set notes_data {}
1389 if {[catch { parse-clipboard } emsg]} {
1390     puts stderr "$emsg\n$errorInfo"
1391     exit 1
1392 }
1393 after idle invoke_notes
1394
1395 draw
1396
1397 if {$debug} {
1398     package require Tclx
1399     commandloop -async \
1400         -prompt1 { return "where-vessels% " } \
1401         -prompt2 { return "> " }
1402 }
1403
1404 # rsync -r --exclude=\*~ yarrg/icons/. ijackson@chiark.greenend.org.uk:/home/ftp/users/ijackson/yarrg/vessel-info/.