Implementation of the [tk busy] command on non-OSX.

Adapted from [Patch 1997907]

2 files changed, 434 insertions, 16 deletions

diff --git a/tests/busy.test b/tests/busy.test
new file mode 100644
index 0000000..a35fb60
--- /dev/null
+++ b/tests/busy.test
@@ -0,0 +1,424 @@
+# Tests for the tk busy command.
+#
+# This file contains a collection of tests for one or more of the Tk built-in
+# commands. Sourcing this file runs the tests and generates output for errors.
+# No output means no errors were found.
+#
+# Copyright (c) 1998-2000 by Jos Decoster. All rights reserved.
+#
+# RCS: @(#) $Id: busy.test,v 1.1 2008/10/18 14:22:22 dkf Exp $
+
+package require tcltest 2.1
+tcltest::configure {*}$argv
+tcltest::loadTestedCommands
+namespace import -force tcltest::test
+
+# There's currently no way to test the actual grab effect, per se, in an
+# automated test. Therefore, this test suite only covers the interface to the
+# grab command (ie, error messages, etc.)
+
+test busy-1.1 {Tk_BusyObjCmd} -returnCodes error -body {
+    tk busy
+} -result {wrong # args: should be "tk busy options ?arg arg ...?"}
+
+test busy-2.1 {tk busy hold} -returnCodes error -body {
+    tk busy hold
+} -result {wrong # args: should be "tk busy hold window ?option value ...?"}
+test busy-2.2 {tk busy hold root window} -body {
+    tk busy hold .
+    update
+} -cleanup {
+    tk busy forget .
+} -result {}
+test busy-2.3 {tk busy hold root window with shortcut} -body {
+    tk busy .
+    update
+} -cleanup {
+    tk busy forget .
+} -result {}
+test busy-2.4 {tk busy hold nested window} -setup {
+    pack [frame .f]
+} -body {
+    tk busy hold .f
+    update
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {}
+test busy-2.5 {tk busy hold nested window with shortcut} -setup {
+    pack [frame .f]
+} -body {
+    tk busy .f
+    update
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {}
+test busy-2.6 {tk busy hold toplevel window} -setup {
+    toplevel .f
+} -body {
+    tk busy hold .f
+    update
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {}
+test busy-2.7 {tk busy hold toplevel window with shortcut} -setup {
+    toplevel .f
+} -body {
+    tk busy .f
+    update
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {}
+test busy-2.8 {tk busy hold non existing window} -body {
+    tk busy hold .f
+    update
+} -returnCodes error -result {bad window path name ".f"}
+test busy-2.9 {tk busy hold (shortcut) non existing window} -body {
+    tk busy .f
+    update
+} -returnCodes {error} -result {bad window path name ".f"}
+test busy-2.10 {tk busy hold root window with cursor} -body {
+    tk busy hold . -cursor arrow
+    update
+} -cleanup {
+    tk busy forget .
+} -result {}
+test busy-2.11 {tk busy hold (shortcut) root window, cursor} -body {
+    tk busy . -cursor arrow
+    update
+} -cleanup {
+    tk busy forget .
+} -result {}
+test busy-2.12 {tk busy hold root window, invalid cursor} -body {
+    tk busy hold . -cursor nonExistingCursor
+    update
+} -constraints tempNotMac -returnCodes error -cleanup {
+    tk busy forget .
+} -result {bad cursor spec "nonExistingCursor"}
+test busy-2.13 {tk busy hold (shortcut) root window, invalid cursor} -body {
+    tk busy . -cursor nonExistingCursor
+    update
+} -constraints tempNotMac -returnCodes error -cleanup {
+    tk busy forget .
+} -result {bad cursor spec "nonExistingCursor"}
+test busy-2.14 {tk busy hold root window, invalid option} -body {
+    tk busy hold . -invalidOption 1
+    update
+} -constraints tempNotMac -returnCodes error -cleanup {
+    tk busy forget .
+} -result {unknown option "-invalidOption"}
+test busy-2.15 {tk busy hold (shortcut) root window, invalid option} -body {
+    tk busy . -invalidOption 1
+    update
+} -constraints tempNotMac -returnCodes error -cleanup {
+    tk busy forget .
+} -result {unknown option "-invalidOption"}
+
+test busy-3.1 {tk busy cget no window} -returnCodes error -body {
+    tk busy cget
+} -result {wrong # args: should be "tk busy cget window option"}
+test busy-3.2 {tk busy cget no option} -returnCodes error -body {
+    tk busy cget
+} -result {wrong # args: should be "tk busy cget window option"}
+test busy-3.3 {tk busy cget invalid window} -returnCodes error -body {
+    tk busy cget .f -cursor
+} -result {bad window path name ".f"}
+test busy-3.4 {tk busy cget non-busy window} -setup {
+    pack [frame .f]
+} -body {
+    tk busy cget .f -cursor
+} -cleanup {
+    destroy .f
+} -returnCodes error -result {can't find busy window ".f"}
+test busy-3.5 {tk busy cget invalid option} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+} -body {
+    tk busy cget .f -invalidOption
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -returnCodes error -result {unknown option "-invalidOption"}
+test busy-3.6unix {tk busy cget unix} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+} -body {
+    tk busy cget .f -cursor
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {watch} -constraints unix
+test busy-3.6win {tk busy cget win} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+} -body {
+    tk busy cget .f -cursor
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {wait} -constraints win
+test busy-3.7 {tk busy cget unix} -setup {
+    pack [frame .f]
+    tk busy hold .f -cursor hand1
+    update
+} -body {
+    tk busy cget .f -cursor
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {hand1} -constraints tempNotMac
+
+test busy-4.1 {tk busy configure no window} -returnCodes error -body {
+    tk busy configure
+} -result {wrong # args: should be "tk busy configure window ?option? ?value ...?"}
+test busy-4.2 {tk busy configure invalid window} -body {
+    tk busy configure .f
+} -returnCodes error -result {bad window path name ".f"}
+test busy-4.3 {tk busy configure non-busy window} -setup {
+    pack [frame .f]
+} -body {
+    tk busy configure .f
+} -cleanup {
+    destroy .f
+} -returnCodes error -result {can't find busy window ".f"}
+test busy-4.4 {tk busy configure} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+} -body {
+    tk busy configure .f
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {{-cursor cursor Cursor watch watch}}
+test busy-4.5 {tk busy configure} -setup {
+    pack [frame .f]
+    tk busy hold .f -cursor hand2
+    update
+} -body {
+    tk busy configure .f
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {{-cursor cursor Cursor watch hand2}} -constraints tempNotMac
+test busy-4.6 {tk busy configure invalid option} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+} -body {
+    tk busy configure .f -invalidOption
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -returnCodes error -result {unknown option "-invalidOption"}
+test busy-4.7 {tk busy configure valid option} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+} -body {
+    tk busy configure .f -cursor
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {-cursor cursor Cursor watch watch}
+test busy-4.8 {tk busy configure valid option} -setup {
+    pack [frame .f]
+    tk busy hold .f -cursor circle
+    update
+} -body {
+    tk busy configure .f -cursor
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {-cursor cursor Cursor watch circle} -constraints tempNotMac
+test busy-4.9 {tk busy configure valid option with value} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+} -body {
+    tk busy configure .f -cursor pencil
+    tk busy cget .f -cursor
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {pencil} -constraints tempNotMac
+test busy-4.10 {tk busy configure valid option with invalid value} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+} -body {
+    tk busy configure .f -cursor nonExistingCursor
+} -constraints tempNotMac -returnCodes error -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {bad cursor spec "nonExistingCursor"}
+
+test busy-5.1 {tk busy forget} -returnCodes error -body {
+    tk busy forget
+} -result {wrong # args: should be "tk busy forget window"}
+test busy-5.2 {tk busy forget non existing window} -body {
+    tk busy forget .f
+} -returnCodes error -result {bad window path name ".f"}
+test busy-5.3 {tk busy forget non busy window} -setup {
+    pack [frame .f]
+} -body {
+    tk busy forget .f
+} -cleanup {
+    destroy .f
+} -returnCodes error -result {can't find busy window ".f"}
+test busy-5.4 {tk busy forget window} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+} -body {
+    set r [tk busy status .f]
+    tk busy forget .f
+    lappend r [tk busy status .f]
+} -cleanup {
+    destroy .f
+} -result {1 0}
+
+test busy-6.1 {tk busy status} -returnCodes error -body {
+    tk busy status
+} -result {wrong # args: should be "tk busy status window"}
+test busy-6.2 {tk busy status non existing window} -body {
+    tk busy status .f
+} -result {0}
+test busy-6.3 {tk busy status non busy window} -setup {
+    pack [frame .f]
+} -body {
+    tk busy status .f
+} -cleanup {
+    destroy .f
+} -result {0}
+test busy-6.4 {tk busy status busy window} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+} -body {
+    tk busy status .f
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {1}
+test busy-6.5 {tk busy status forgotten busy window} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+    tk busy forget .f
+} -body {
+    tk busy status .f
+} -cleanup {
+    destroy .f
+} -result {0}
+
+test busy-7.1 {tk busy current no busy} -body {
+    tk busy current
+} -result {}
+test busy-7.2 {tk busy current 1 busy} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+} -body {
+    tk busy current
+} -cleanup {
+    tk busy forget .f
+    destroy .f
+} -result {.f}
+test busy-7.3 {tk busy current 2 busy} -setup {
+    pack [frame .f1]
+    pack [frame .f2]
+    tk busy hold .f1
+    tk busy hold .f2
+    update
+} -body {
+    lsort [tk busy current]
+} -cleanup {
+    tk busy forget .f1
+    tk busy forget .f2
+    destroy .f1 .f2
+} -result {.f1 .f2}
+test busy-7.4 {tk busy current 2 busy with matching filter} -setup {
+    pack [frame .f1]
+    pack [frame .f2]
+    tk busy hold .f1
+    tk busy hold .f2
+    update
+} -body {
+    lsort [tk busy current *2*]
+} -cleanup {
+    tk busy forget .f1
+    tk busy forget .f2
+    destroy .f1 .f2
+} -result {.f2}
+test busy-7.5 {tk busy current 2 busy with non matching filter} -setup {
+    pack [frame .f1]
+    pack [frame .f2]
+    tk busy hold .f1
+    tk busy hold .f2
+    update
+} -body {
+    lsort [tk busy current *3*]
+} -cleanup {
+    tk busy forget .f1
+    tk busy forget .f2
+    destroy .f1 .f2
+} -result {}
+test busy-7.6 {tk busy current 1 busy after forget} -setup {
+    pack [frame .f]
+    tk busy hold .f
+    update
+    tk busy forget .f
+} -body {
+    tk busy current
+} -cleanup {
+    destroy .f
+} -result {}
+test busy-7.7 {tk busy current 2 busy after forget} -setup {
+    pack [frame .f1]
+    pack [frame .f2]
+    tk busy hold .f1
+    tk busy hold .f2
+    update
+    tk busy forget .f1
+} -body {
+    lsort [tk busy current]
+} -cleanup {
+    tk busy forget .f2
+    destroy .f1 .f2
+} -result {.f2}
+test busy-7.8 {tk busy current 2 busy with matching filter after forget} -setup {
+    pack [frame .f1]
+    pack [frame .f2]
+    tk busy hold .f1
+    tk busy hold .f2
+    update
+    tk busy forget .f1
+} -body {
+    lsort [tk busy current *2*]
+} -cleanup {
+    tk busy forget .f2
+    destroy .f1 .f2
+} -result {.f2}
+test busy-7.9 {tk busy current 2 busy with non matching filter after forget} -setup {
+    pack [frame .f1]
+    pack [frame .f2]
+    tk busy hold .f1
+    tk busy hold .f2
+    update
+    tk busy forget .f1
+} -body {
+    lsort [tk busy current *3*]
+} -cleanup {
+    tk busy forget .f2
+    destroy .f1 .f2
+} -result {}
+
+::tcltest::cleanupTests
+return
diff --git a/tests/tk.test b/tests/tk.test
index 0527be0..3ebefe0 100644
--- a/tests/tk.test
+++ b/tests/tk.test
@@ -5,7 +5,7 @@
 # Copyright (c) 1998-1999 by Scriptics Corporation.
 # Copyright (c) 2002 ActiveState Corporation.
 #
-# RCS: @(#) $Id: tk.test,v 1.15 2008/08/16 23:52:34 aniap Exp $
+# RCS: @(#) $Id: tk.test,v 1.16 2008/10/18 14:22:22 dkf Exp $
 
 package require tcltest 2.2
 eval tcltest::configure $argv
@@ -17,8 +17,7 @@ test tk-1.1 {tk command: general} -body {
 } -returnCodes error -result {wrong # args: should be "tk option ?arg?"}
 test tk-1.2 {tk command: general} -body {
     tk xyz
-} -returnCodes error -result {bad option "xyz": must be appname, caret, scaling, useinputmethods, windowingsystem, or inactive}
-
+} -returnCodes error -result {bad option "xyz": must be appname, busy, caret, inactive, scaling, useinputmethods, or windowingsystem}
 
 # Value stored to restore default settings after 2.* tests
 set appname [tk appname]
@@ -37,7 +36,6 @@ test tk-2.4 {tk command: appname} -body {
 } -result [tk appname]
 tk appname $appname
 
-
 # Value stored to restore default settings after 3.* tests
 set scaling [tk scaling]
 test tk-3.1 {tk command: scaling} -body {
@@ -72,7 +70,7 @@ test tk-3.8 {tk command: scaling: negative} -body {
 test tk-3.9 {tk command: scaling: too big} -body {
     tk scaling 1000000
     expr {[tk scaling] < 10000}
-} -result {1}    
+} -result {1}
 test tk-3.10 {tk command: scaling: widthmm} -body {
     tk scaling 1.25
     expr {int((25.4*[winfo screenwidth .])/(72*1.25) + 0.5) \
@@ -85,7 +83,6 @@ test tk-3.11 {tk command: scaling: heightmm} -body {
 } -result {0}
 tk scaling $scaling
 
-
 # Value stored to restore default settings after 4.* tests
 set useim [tk useinputmethods]
 test tk-4.1 {tk command: useinputmethods} -body {
@@ -109,24 +106,22 @@ test tk-4.5 {tk command: useinputmethods: set new} -body {
     tk useinputmethods -displayof . xyz
 } -returnCodes error -result {expected boolean value but got "xyz"}
 test tk-4.6 {tk command: useinputmethods: set new} -body {
-    # This isn't really a test, but more of a check...
-    # The answer is what was given, because we may be on a Unix
-    # system that doesn't have the XIM stuff
+    # This isn't really a test, but more of a check... The answer is what was
+    # given, because we may be on a Unix system that doesn't have the XIM
+    # stuff
     if {[tk useinputmethods 1] == 0} {
-	    puts "this wish doesn't have XIM (X Input Methods) support"
+	puts "this wish doesn't have XIM (X Input Methods) support"
     }
-
     return $useim
 } -result $useim
 test tk-4.7 {tk command: useinputmethods: set new} -constraints win -body {
-    # Mac and Windows don't have X Input Methods, so this should
-    # always return 0
+    # Mac and Windows don't have X Input Methods, so this should always return
+    # 0
     tk useinputmethods 1
 } -cleanup {
     tk useinputmethods $useim
 } -result 0
 
-
 test tk-5.1 {tk caret} -body {
     tk caret
 } -returnCodes error -result {wrong # args: should be "tk caret window ?-x x? ?-y y? ?-height height?"}
@@ -146,7 +141,6 @@ test tk-5.6 {tk caret} -body {
     tk caret . -x 20 -y 25 -h 30; tk caret . -hei
 } -result {30}
 
-
 # tk inactive
 test tk-6.1 {tk inactive} -body {
     string is integer [tk inactive]
@@ -168,7 +162,6 @@ test tk-6.5 {tk inactive} -body {
     expr {$i == -1 || ( $i > 90 && $i < 200 )}
 } -result 1
 
-
 test tk-7.1 {tk inactive in a safe interpreter} -body {
 # tk inactive in safe interpreters
     safe::interpCreate foo
@@ -186,6 +179,7 @@ test tk-7.2 {tk inactive reset in a safe interpreter} -body {
     ::safe::interpDelete foo
 } -returnCodes 1 -result {resetting the user inactivity timer is not allowed in a safe interpreter}
 
+# tests of [tk busy] in busy.test
 
 # cleanup
 cleanupTests