+# General purpose code for being a tray applet
+
+package require Tclx
+package require tktray
#----- general machinery -----
#
# tk::tktray widget is called .i
#
-# Inner window:
-# Caller that needs access to inner window should define
-# proc innerwindow {} { ... }
-# and run
-# innerwindow
-# This will create
-# .i.i.b frame to contain container
-# .i.i.b.c actual container
+# Tooltip:
+#
+# Caller may call
+# applet::setup-tooltip ON-VISIBLE ON-INVISIBLE
+# to make applet have a tooltip.
+#
+# ON-VISIBLE and ON-INVISIBLE will be globally eval'd
+# when the tooltip becomes visible and invisible.
+#
+# Caller should call
+# applet::tooltip-set TEXT-MAYBE-MULTILINE
+# whenever they like.
#
-# Button presses
-# Caller should provide
-# proc pressed {b x y} { ... }
-# which should examine b and do something appropriate.
-#
-
-proc manyset {list args} {
- foreach val $list var $args {
- upvar 1 $var my
- set my $val
- }
-}
-
-
-package require Tclx
-package require tktray
+# Button presses
+#
+# Caller may bind .i.i <ButtonPress-$b>
+#
+# Alternatively caller may call applet::setup-button-menu $b
+# which will generate a menu .m$b which the user can configure
+# and which will automatically be posted and unposted etc.
+# In this case the caller should arrange that all of their
+# menus, when an item is selected, call
+# applet::msel
+#
+# Icon:
+#
+# Caller should call:
+# applet::setimage IMAGE
+# as necessary.
+#
+# Alternatively of icon, it may provide other arrangements for
+# using the provided subwindow. Such a caller should call
+# applet::setup-subwindow ON-DESTROYING ON-READY
+# Then the main code will call ON-DESTROYING just before
+# destroying the inner window and recreating it, and
+# [concat ON-READY [list ORIENTATION]]
+# just after. The inner window to use is called .i.i.b.
+#
+# This uses variables, in the applet namespace,
+# w h border_colour border_width deforient
+# These should be set before setup-subwindow is called and not
+# modified thereafter.
+#
+# The user of the subwindow machinery may call
+# applet::subwindow-need-recreate
+# if for any reason the inner window should be destroyed and recreated.
+#
+# Alternatively, it may request that a subprocess be spawned
+# repeatedly with the xid of a suitable window.
+# applet::setup-subproc GET-CMDLINE
+# Then the main code will call [concat GET_CMDLINE [list XID ORIENTATION]]
+# to get the command line to run.
+#
+# This also uses the same variables as setup-subwindow.
wm withdraw .
tktray::icon .i -class example
.i configure -docked 1
-set posted 0
+fconfigure stdout -buffering none
+fconfigure stderr -buffering none
-foreach b {1 3} {
+
+namespace eval applet {
+
+# used by both menus and tooltips
+variable posted 0
+
+#----- menus -----
+
+proc setup-button-menu {b} {
+ bind .i.i <ButtonPress> { applet::menubuttonpressed %b %X %Y }
menu .m$b -tearoff 0
}
proc menubuttonpressed {b x y} {
- global posted
- tooltip_cancel
+ variable posted
+ tooltip-cancel
if {$posted == $b} {
- puts "unpost $posted toggle"
+ debug::debug "unpost $posted toggle"
.m$posted unpost
set posted 0
} elseif {[winfo exists .m$b]} {
if {$posted} {
.m$posted unpost
- puts "unpost $posted other"
+ debug::debug "unpost $posted other"
}
- puts "post $b"
+ debug::debug "post $b"
set posted $b
.m$b post $x $y
}
}
proc msel {} {
- global posted
+ variable posted
set posted 0
}
-proc innerwindow-resetup-required {why} {
- global innerwindow_after
-puts "IW-EVENT $why"
- if {[info exists innerwindow_after]} return
- set innerwindow_after [after idle innerwindow-resetup]
-}
+#----- tooltips -----
-proc innerwindow-resetup {} {
- global innerwindow_after
- unset innerwindow_after
-
-puts RESETUP
-
- innerwindow-destroying
-
- catch { destroy .i.i.c }
- if {![winfo exists .i.i]} return
- destroy [frame .i.i.make-exist]
- catch { destroy .i.i.b.c }
- catch { destroy .i.i.b }
- frame .i.i.b
- pack .i.i.b -fill both -side left -expand 1
- frame .i.i.b.c -container 1 -background orange
- pack .i.i.b.c -fill both -side left -expand 1
- bind .i.i <ButtonPress> { pressed %b %X %Y }
-#
- global inner_lastw inner_lasth
- #set w [winfo width .i.i]
-# set w [winfo width .i.i]
-# set h [winfo height .i.i]
-
-# if {$w != $inner_lastw || $h != $inner_lasth} {
-# set inner_lastw $w
-# set inner_lasth $h
-# innerwindow-ph-dummy configure -width $w -height 2
- innerwindow-ready
-# }
-}
+variable tooltip_on_vis {}
+variable tooltip_on_invis {}
-proc setupinnerwindow {w} {
- global inner_lastw inner_lasth
- set inner_lastw -2
- set inner_lasth -2
-
- image create photo innerwindow-ph-dummy -width $w -height 2
- .i configure -image innerwindow-ph-dummy
-
- destroy [frame .i.make-exist]
- destroy [frame .i.i.make-exist]
- bind .i <<IconConfigure>> { innerwindow-resetup-required IconConfigure }
-}
-
-bind .i <ButtonPress> { pressed %b %X %Y }
-
-proc tooltip_starttimer {state x y} {
- global tooltip_after posted tooltip_inwindow
- if {$state || $posted || !$tooltip_inwindow} { tooltip_cancel; return }
+proc tooltip-starttimer {state x y} {
+ variable tooltip_after
+ variable posted
+ variable tooltip_inwindow
+ if {$state || $posted || !$tooltip_inwindow} { tooltip-cancel; return }
catch { after cancel $tooltip_after }
- set tooltip_after [after 500 tooltip_show $x $y]
+ set tooltip_after [after 500 applet::tooltip-show $x $y]
}
-proc tooltip_cancel {} {
- global tooltip_after
+proc tooltip-cancel {} {
+ variable tooltip_after
+ variable tooltip_on_invis
catch { after cancel $tooltip_after }
catch { unset $tooltip_after }
wm withdraw .tt
+ uplevel #0 $tooltip_on_invis
}
set tooltip_inwindow 0
-proc tooltip_enter {state x y} {
- global tooltip_inwindow
+proc tooltip-enter {state x y} {
+ variable tooltip_inwindow
set tooltip_inwindow 1
- tooltip_starttimer $state $x $y
+ tooltip-starttimer $state $x $y
}
-proc tooltip_leave {} {
- global tooltip_inwindow
+proc tooltip-leave {} {
+ variable tooltip_inwindow
set tooltip_inwindow 0
- tooltip_cancel
+ tooltip-cancel
}
-proc setuptooltip {} {
- bind .i <Enter> { tooltip_enter %s %X %Y }
- bind .i <Leave> { tooltip_leave }
- bind .i <ButtonRelease> { tooltip_cancel; tooltip_starttimer %s %X %Y }
- bind .i <Motion> { tooltip_starttimer %s %X %Y }
+proc setup-tooltip {on_vis on_invis} {
+ foreach v {vis invis} {
+ variable tooltip_on_$v [set on_$v]
+ }
+ bind .i <Enter> { applet::tooltip-enter %s %X %Y }
+ bind .i <Leave> { applet::tooltip-leave }
+ bind .i <ButtonRelease> {
+ applet::tooltip-cancel
+ applet::tooltip-starttimer %s %X %Y
+ }
+ bind .i <Motion> { applet::tooltip-starttimer %s %X %Y }
toplevel .tt -background black
wm withdraw .tt
wm overrideredirect .tt 1
label .tt.t -justify left -background {#EEE1B3}
pack .tt.t -padx 1 -pady 1
- settooltip {}
+ tooltip-set {}
}
-proc settooltip {s} {
+proc tooltip-set {s} {
.tt.t configure -text $s
}
-proc tooltip_show {x y} {
+proc tooltip-show {x y} {
+ variable tooltip_on_vis
incr x 9
incr y 9
wm geometry .tt +$x+$y
wm deiconify .tt
+ raise .tt
+ uplevel #0 $tooltip_on_vis
}
+#----- simple images -----
+
proc setimage {image} {
.i configure -image $image
}
-proc fork-then {ondeath inchild} {
- global children errorCode errorInfo
- foreach f {stdout stderr} {
- if {[catch { flush $f } emsg]} {
- catch { bgerror $emsg }
- }
+#----- subwindow -----
+
+variable subwindow_on_destroying
+variable subwindow_on_ready
+
+variable w 50
+variable h 50
+variable deforient horizontal
+variable border_colour darkblue
+variable border_width 1
+variable tray_width X
+variable tray_height X
+variable orientation vertical
+
+proc subwindow-need-recreate {evtype why} {
+ variable orientation
+ variable innerwindow_after
+ variable tray_width
+ variable tray_height
+ debug::debug "IW-EVENT $evtype $why [winfo reqwidth .i] [winfo reqheight .i] [winfo width .i] [winfo height .i] $orientation"
+ switch -exact $orientation {
+ horizontal { set szv height }
+ vertical { set szv width }
+ unknown { return }
+ }
+ set new_sz [winfo req$szv .i]
+ if {![string compare $new_sz [set tray_$szv]]} {
+ return
}
- set pid [fork]
- if {!$pid} {
- if {[catch {
- uplevel 1 $inchild
- } emsg]} {
- puts stderr "CHILD ERROR $emsg\n$errorCode\n$errorInfo\n"
+ set tray_$szv $new_sz
+# switch -exact -- $evtype 35 { return }
+ if {[info exists innerwindow_after]} return
+ set innerwindow_after [after idle applet::innerwindow-resetup]
+}
+
+proc innerwindow-resetup {} {
+ variable innerwindow_after
+ variable subwindow_on_destroying
+ variable subwindow_on_ready
+ variable border_colour
+ variable border_width
+ variable deforient
+ variable orientation
+ unset innerwindow_after
+
+ debug::debug RESETUP
+
+ if {![winfo exists .i.i]} return
+ destroy [frame .i.i.make-exist]
+
+ uplevel #0 $subwindow_on_destroying
+ catch { destroy .i.i.b }
+
+ set orientation [.i orientation]
+ debug::debug "orientation $orientation"
+ if {![string compare $orientation unknown]} {
+ set orientation $deforient
+ }
+ .i configure -image applet::innerwindow-ph-$orientation
+
+ frame .i.i.b -background $border_colour -bd $border_width
+ pack .i.i.b -fill both -side left -expand 1
+
+ uplevel #0 $subwindow_on_ready [list $orientation]
+}
+
+proc setup-subwindow {on_destroying on_ready} {
+ variable w
+ variable h
+
+ foreach v {on_destroying on_ready} {
+ variable subwindow_$v [set $v]
+ }
+
+ image create photo applet::innerwindow-ph-horizontal -width $w -height 2
+ image create photo applet::innerwindow-ph-vertical -width 2 -height $h
+ .i configure -image applet::innerwindow-ph-horizontal
+
+ destroy [frame .i.make-exist]
+ destroy [frame .i.i.make-exist]
+ bind .i <<IconConfigure>> {
+ applet::subwindow-need-recreate %T "%T i=%i k=%K N=%N R=%R S=%S k=%k m=%m d=%d s=%s a=%a b=%b c=%c f=%f w,h=%w,%h o=%o p=%p t=%t x,y=%x,%y B=%B D=%D E=%E P=%P W=%W X,Y=%X,%Y"
+ }
+}
+
+#----- subprocess -----
+
+variable subproc none
+variable ratelimit {}
+
+proc setup-subproc {get_cmdline} {
+ variable subproc_get_cmdline $get_cmdline
+ setup-subwindow applet::subproc-destroying applet::subproc-ready
+}
+
+proc subproc-destroying {} {
+ variable subproc
+ debug::debug "DESTROYING $subproc"
+
+ catch { destroy .i.i.b.c }
+
+ switch -exact $subproc {
+ none { }
+ old { }
+ default { kill $subproc; set subproc old }
+ }
+}
+
+proc subproc-ready {orientation} {
+ variable subproc
+ variable subproc_orientation $orientation
+ debug::debug "READY $subproc"
+
+ frame .i.i.b.c -container 1 -background orange
+ pack .i.i.b.c -fill both -side left -expand 1
+
+ switch -exact $subproc {
+ none {
+ run-child
+ }
+ old {
+ # wait for it to die
}
- kill KILL [id process]
+ default {
+ error "unexpected state $subproc"
+ }
+ }
+ debug::debug "READY-done $subproc"
+}
+
+proc run-child {} {
+ variable subproc
+ variable ratelimit
+ variable subproc_get_cmdline
+ variable subproc_orientation
+
+ set id [winfo id .i.i.b.c]
+ set cmd [uplevel #0 $subproc_get_cmdline [list $id $subproc_orientation]]
+
+ debug::debug "RUN-CHILD $subproc"
+ set now [clock seconds]
+ lappend ratelimit $now
+ while {[lindex $ratelimit 0] < {$now - 10}} {
+ set ratelimit [lrange $ratelimit 1 end]
+ }
+ if {[llength $ratelimit] > 10} {
+ puts stderr "crashing repeatedly, quitting $ratelimit"
+ exit 127
}
- set children($pid) $ondeath
- return $pid
-}
-
-proc chld-handler {} {
- global children
- while 1 {
- if {[catch { set got [wait -nohang] }]} break
- if {![llength $got]} break
- manyset $got pid how how2
- if {[info exists children($pid)]} {
- set l $children($pid)
- unset children($pid)
- if {[catch {
- uplevel #0 [concat [list $l] $how $how2]
- } emsg]} {
- catch { bgerror $emsg }
- }
+
+ set subproc none
+ set subproc [subproc::fork applet::child-died {
+ execl [lindex $cmd 0] [lrange $cmd 1 end]
+ }]
+ debug::debug "FORKED $subproc"
+}
+
+proc child-died {how how2} {
+ debug::debug "DIED $how $how2"
+ variable subproc
+ switch -exact $subproc {
+ old {
+ set subproc none
+ run-child
}
- }
+ default {
+ set subproc none
+ subwindow-need-recreate child-died child-died
+ }
+ }
}
-signal -restart trap CHLD { after idle chld-handler }
+}
~ian / chiark-tcl-applet.git / blobdiff