Revise the "null data" check: null strings are possible, but empty binary arrays are not

3 files changed, 138 insertions, 121 deletions

diff --git a/ChangeLog b/ChangeLog
index 3f089d5..3995874 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2012-06-08  Jan Nijtmans  <nijtmans@users.sf.net>
+
+	* win/tclWinDde.c:    Revise the "null data" check: null strings are
+	possible, but empty binary arrays are not.
+	* tests/winDde.test:  Add test-case (winDde-9.4) for transferring
+	null-strings with dde. Convert tests to tcltest-2 syntax.
+
 2012-06-06  Donal K. Fellows  <dkf@users.sf.net>
 
 	* generic/tclZlib.c (TclZlibInit): Declare that Tcl is publishing the
diff --git a/tests/winDde.test b/tests/winDde.test
index bc64a24..83f3598 100644
--- a/tests/winDde.test
+++ b/tests/winDde.test
@@ -15,18 +15,16 @@ if {"::tcltest" ni [namespace children]} {
     namespace import -force ::tcltest::*
 }
 
-if {[testConstraint win]} {
-    if [catch {
-	# Is the dde extension already static to this shell?
-	if [catch {load {} Dde; set ::ddelib {}}] {
-	    # try the location given to use on the commandline to tcltest
-	    ::tcltest::loadTestedCommands
-	    load $::ddelib Dde
-	}
-	testConstraint dde 1
-    }] {
-	testConstraint dde 0
+if [catch {
+    # Is the dde extension already static to this shell?
+    if [catch {load {} Dde; set ::ddelib {}}] {
+	# try the location given to use on the commandline to tcltest
+	::tcltest::loadTestedCommands
+	load $::ddelib Dde
     }
+    testConstraint dde 1
+}] {
+    testConstraint dde 0
 }
 
 
@@ -36,7 +34,7 @@ if {[testConstraint win]} {
 
 set scriptName [makeFile {} script1.tcl]
 
-proc createChildProcess { ddeServerName {handler {}}} {
+proc createChildProcess {ddeServerName args} {
     file delete -force $::scriptName
 
     set f [open $::scriptName w+]
@@ -51,7 +49,7 @@ proc createChildProcess { ddeServerName {handler {}}} {
 	    package require tcltest
 	    namespace import -force ::tcltest::*
 	}
-        
+
         # If an error occurs during the tests, this process may end up not
         # being closed down. To deal with this we create a 30s timeout.
         proc ::DoTimeout {} {
@@ -61,16 +59,19 @@ proc createChildProcess { ddeServerName {handler {}}} {
             flush stdout
         }
         set timeout [after 30000 ::DoTimeout]
-        
+
         # Define a restricted handler.
         proc Handler1 {cmd} {
             if {$cmd eq "stop"} {set ::done 1}
-            puts $cmd ; flush stdout 
+            if {$cmd == ""} {
+                set cmd "null data"
+            }
+            puts $cmd ; flush stdout
             return
         }
         proc Handler2 {cmd} {
             if {$cmd eq "stop"} {set ::done 1}
-            puts [uplevel \#0 $cmd] ; flush stdout 
+            puts [uplevel \#0 $cmd] ; flush stdout
             return
         }
         proc Handler3 {prefix cmd} {
@@ -80,11 +81,7 @@ proc createChildProcess { ddeServerName {handler {}}} {
         }
     }
     # set the dde server name to the supplied argument.
-    if {$handler == {}} {
-        puts $f [list dde servername $ddeServerName]
-    } else {
-        puts $f [list dde servername -handler $handler -- $ddeServerName]
-    }        
+    puts $f [list dde servername {*}$args -- $ddeServerName]
     puts $f {
         # run the server and handle final cleanup.
         after 200;# give dde a chance to get going.
@@ -94,12 +91,12 @@ proc createChildProcess { ddeServerName {handler {}}} {
 	# allow enough time for the calling process to
 	# claim all results, to avoid spurious "server did
 	# not respond"
-	after 200 { set reallyDone 1 }
+	after 200 {set reallyDone 1}
 	vwait reallyDone
 	exit
     }
     close $f
-    
+
     # run the child server script.
     set f [open |[list [interpreter] $::scriptName] r]
     fconfigure $f -buffering line
@@ -109,160 +106,160 @@ proc createChildProcess { ddeServerName {handler {}}} {
 
 # -------------------------------------------------------------------------
 
-test winDde-1.1 {Settings the server's topic name} {win dde} {
+test winDde-1.1 {Settings the server's topic name} -constraints dde -body {
     list [dde servername foobar] [dde servername] [dde servername self]
-}  {foobar foobar self}
+} -result {foobar foobar self}
 
-test winDde-2.1 {Checking for other services} {win dde} {
+test winDde-2.1 {Checking for other services} -constraints dde -body {
     expr [llength [dde services {} {}]] >= 0
-} 1
+} -result 1
 test winDde-2.2 {Checking for existence, with service and topic specified} \
-	{win dde} {
+	-constraints dde -body {
     llength [dde services TclEval self]
-} 1
+} -result 1
 test winDde-2.3 {Checking for existence, with only the service specified} \
-	{win dde} {
+	-constraints dde -body {
     expr [llength [dde services TclEval {}]] >= 1
-} 1
+} -result 1
 test winDde-2.4 {Checking for existence, with only the topic specified} \
-	{win dde} {
+	-constraints dde -body {
     expr [llength [dde services {} self]] >= 1
-} 1
+} -result 1
 
 # -------------------------------------------------------------------------
 
-test winDde-3.1 {DDE execute locally} {win dde} {
-    set a ""
-    dde execute TclEval self {set a "foo"}
-    set a
-} foo
-test winDde-3.2 {DDE execute -async locally} {win dde} {
-    set a ""
-    dde execute -async TclEval self {set a "foo"}
+test winDde-3.1 {DDE execute locally} -constraints dde -body {
+    set \xe1 ""
+    dde execute TclEval self [list set \xe1 foo]
+    set \xe1
+} -result foo
+test winDde-3.2 {DDE execute -async locally} -constraints dde -body {
+    set \xe1 ""
+    dde execute -async TclEval self [list set \xe1 foo]
     update
-    set a
-} foo
-test winDde-3.3 {DDE request locally} {win dde} {
+    set \xe1
+} -result foo
+test winDde-3.3 {DDE request locally} -constraints dde -body {
     set a ""
-    dde execute TclEval self {set a "foo"}
+    dde execute TclEval self [list set a foo]
     dde request TclEval self a
-} foo
-test winDde-3.4 {DDE eval locally} {win dde} {
-    set a ""
-    dde eval self set a "foo"
-} foo
-test winDde-3.5 {DDE request locally} {win dde} {
+} -result foo
+test winDde-3.4 {DDE eval locally} -constraints dde -body {
+    set \xe1 ""
+    dde eval self set \xe1 foo
+} -result foo
+test winDde-3.5 {DDE request locally} -constraints dde -body {
     set a ""
-    dde execute TclEval self {set a "foo"}
+    dde execute TclEval self [list set a foo]
     dde request -binary TclEval self a
-} "foo\x00"
+} -result "foo\x00"
 # Set variable a to A with diaeresis (unicode C4) by relying on the fact
 # that utf8 is sent (e.g. "c3 84" on the wire)
-test winDde-3.6 {DDE request utf8} {win dde} {
+test winDde-3.6 {DDE request utf8} -constraints dde -body {
     set a "not set"
     dde execute TclEval self "set a \xc4"
     scan $a %c
-} 196
+} -result 196
 # Set variable a to A with diaeresis (unicode C4) using binary execute
 # and compose utf-8 (e.g. "c3 84" ) manualy
-test winDde-3.7 {DDE request binary} {win dde} {
+test winDde-3.7 {DDE request binary} -constraints dde -body {
     set a "not set"
-    dde execute -binary TclEval self "set a \xc3\x84\x00"
+    dde execute -binary TclEval self [list set a \xc3\x84\x00]
     scan $a %c
-} 196
+} -result 196
 
 # -------------------------------------------------------------------------
 
-test winDde-4.1 {DDE execute remotely} {stdio win dde} {
-    set a ""
-    set name child-4.1
+test winDde-4.1 {DDE execute remotely} -constraints {dde stdio} -body {
+    set \xe1 ""
+    set name ch\xEDld-4.1
     set child [createChildProcess $name]
-    dde execute TclEval $name {set a "foo"}
+    dde execute TclEval $name [list set \xe1 foo]
     dde execute TclEval $name {set done 1}
     update
-    set a
-} ""
-test winDde-4.2 {DDE execute async remotely} {stdio win dde} {
-    set a ""
-    set name child-4.2
+    set \xe1
+} -result ""
+test winDde-4.2 {DDE execute async remotely} -constraints {dde stdio} -body {
+    set \xe1 ""
+    set name ch\xEDld-4.2
     set child [createChildProcess $name]
-    dde execute -async TclEval $name {set a "foo"}
+    dde execute -async TclEval $name [list set \xe1 foo]
     update
     dde execute TclEval $name {set done 1}
     update
-    set a
-} ""
-test winDde-4.3 {DDE request remotely} {stdio win dde} {
+    set \xe1
+} -result ""
+test winDde-4.3 {DDE request remotely} -constraints {dde stdio} -body {
     set a ""
-    set name chile-4.3
+    set name ch\xEDld-4.3
     set child [createChildProcess $name]
-    dde execute TclEval $name {set a "foo"}
+    dde execute TclEval $name [list set a foo]
     set a [dde request TclEval $name a]
     dde execute TclEval $name {set done 1}
     update
     set a
-} foo
-test winDde-4.4 {DDE eval remotely} {stdio win dde} {
+} -result foo
+test winDde-4.4 {DDE eval remotely} -constraints {dde stdio} -body {
     set a ""
-    set name child-4.4
+    set name ch\xEDld-4.4
     set child [createChildProcess $name]
-    set a [dde eval $name set a "foo"]
+    set a [dde eval $name set a foo]
     dde execute TclEval $name {set done 1}
     update
     set a
-} foo
+}  -result foo
 
 # -------------------------------------------------------------------------
 
-test winDde-5.1 {check for bad arguments} -constraints {win dde} -body {
+test winDde-5.1 {check for bad arguments} -constraints dde -body {
     dde execute "" "" "" ""
 } -returnCodes error -result {wrong # args: should be "dde execute ?-async? ?-binary? serviceName topicName value"}
-test winDde-5.2 {check for bad arguments} -constraints {win dde} -body {
-    dde execute "" "" ""
+test winDde-5.2 {check for bad arguments} -constraints dde -body {
+    dde execute -binary "" "" ""
 } -returnCodes error -result {cannot execute null data}
-test winDde-5.3 {check for bad arguments} -constraints {win dde} -body {
+test winDde-5.3 {check for bad arguments} -constraints dde -body {
     dde execute -foo "" "" ""
 } -returnCodes error -result {wrong # args: should be "dde execute ?-async? ?-binary? serviceName topicName value"}
-test winDde-5.4 {DDE eval bad arguments} -constraints {win dde} -body {
+test winDde-5.4 {DDE eval bad arguments} -constraints dde -body {
     dde eval "" "foo"
 } -returnCodes error -result {invalid service name ""}
 
 # -------------------------------------------------------------------------
 
-test winDde-6.1 {DDE servername bad arguments} -constraints {win dde} -body {
+test winDde-6.1 {DDE servername bad arguments} -constraints dde -body {
     dde servername -z -z -z
 } -returnCodes error -result {bad option "-z": must be -force, -handler, or --}
-test winDde-6.2 {DDE servername set name} -constraints {win dde} -body {
+test winDde-6.2 {DDE servername set name} -constraints dde -body {
     dde servername -- winDde-6.2
 } -result {winDde-6.2}
-test winDde-6.3 {DDE servername set exact name} -constraints {win dde} -body {
+test winDde-6.3 {DDE servername set exact name} -constraints dde -body {
     dde servername -force winDde-6.3
 } -result {winDde-6.3}
-test winDde-6.4 {DDE servername set exact name} -constraints {win dde} -body {
+test winDde-6.4 {DDE servername set exact name} -constraints dde -body {
     dde servername -force -- winDde-6.4
 } -result {winDde-6.4}
-test winDde-6.5 {DDE remote servername collision} -constraints {stdio win dde} -setup {
-    set name child-6.5
+test winDde-6.5 {DDE remote servername collision} -constraints {dde stdio} -setup {
+    set name ch\xEDld-6.5
     set child [createChildProcess $name]
 } -body {
     dde servername -- $name
 } -cleanup {
     dde execute TclEval $name {set done 1}
     update
-} -result "child-6.5 #2"
-test winDde-6.6 {DDE remote servername collision force} -constraints {stdio win dde} -setup {
-    set name child-6.6
+} -result "ch\xEDld-6.5 #2"
+test winDde-6.6 {DDE remote servername collision force} -constraints {dde stdio} -setup {
+    set name ch\xEDld-6.6
     set child [createChildProcess $name]
 } -body {
     dde servername -force -- $name
 } -cleanup {
     dde execute TclEval $name {set done 1}
     update
-} -result {child-6.6}
+} -result "ch\xEDld-6.6"
 
 # -------------------------------------------------------------------------
 
-test winDde-7.1 {Load DDE in slave interpreter } -constraints {win dde} -setup {
+test winDde-7.1 {Load DDE in slave interpreter} -constraints dde -setup {
     interp create slave
 } -body {
     slave eval [list load $::ddelib Dde]
@@ -270,7 +267,7 @@ test winDde-7.1 {Load DDE in slave interpreter } -constraints {win dde} -setup {
 } -cleanup {
     interp delete slave
 } -result {dde-interp-7.1}
-test winDde-7.2 {DDE slave cleanup} -constraints {win dde} -setup {
+test winDde-7.2 {DDE slave cleanup} -constraints dde -setup {
     interp create slave
     slave eval [list load $::ddelib Dde]
     slave eval [list dde servername -- dde-interp-7.5]
@@ -283,7 +280,7 @@ test winDde-7.2 {DDE slave cleanup} -constraints {win dde} -setup {
 	set s
     }
 } -result {}
-test winDde-7.3 {DDE present in slave interp} -constraints {win dde} -setup {
+test winDde-7.3 {DDE present in slave interp} -constraints dde -setup {
     interp create slave
     slave eval [list load $::ddelib Dde]
     slave eval [list dde servername -- dde-interp-7.3]
@@ -292,7 +289,7 @@ test winDde-7.3 {DDE present in slave interp} -constraints {win dde} -setup {
 } -cleanup {
     interp delete slave
 } -result {{TclEval dde-interp-7.3}}
-test winDde-7.4 {interp name collision with -force} -constraints {win dde} -setup {
+test winDde-7.4 {interp name collision with -force} -constraints dde -setup {
     interp create slave
     slave eval [list load $::ddelib Dde]
     slave eval [list dde servername -- dde-interp-7.4]
@@ -301,7 +298,7 @@ test winDde-7.4 {interp name collision with -force} -constraints {win dde} -setu
 } -cleanup {
     interp delete slave
 } -result {dde-interp-7.4}
-test winDde-7.5 {interp name collision without -force} -constraints {win dde} -setup {
+test winDde-7.5 {interp name collision without -force} -constraints dde -setup {
     interp create slave
     slave eval [list load $::ddelib Dde]
     slave eval [list dde servername -- dde-interp-7.5]
@@ -313,7 +310,7 @@ test winDde-7.5 {interp name collision without -force} -constraints {win dde} -s
 
 # -------------------------------------------------------------------------
 
-test winDde-8.1 {Safe DDE load} -constraints {win dde} -setup {
+test winDde-8.1 {Safe DDE load} -constraints dde -setup {
     interp create -safe slave
     slave invokehidden load $::ddelib Dde
 } -body {
@@ -321,20 +318,20 @@ test winDde-8.1 {Safe DDE load} -constraints {win dde} -setup {
 } -cleanup {
     interp delete slave
 } -returnCodes error -result {invalid command name "dde"}
-test winDde-8.2 {Safe DDE set servername} -constraints {win dde} -setup {
+test winDde-8.2 {Safe DDE set servername} -constraints dde -setup {
     interp create -safe slave
     slave invokehidden load $::ddelib Dde
 } -body {
     slave invokehidden dde servername slave
 } -cleanup {interp delete slave} -result {slave}
-test winDde-8.3 {Safe DDE check handler required for eval} -constraints {win dde} -setup {
+test winDde-8.3 {Safe DDE check handler required for eval} -constraints dde -setup {
     interp create -safe slave
     slave invokehidden load $::ddelib Dde
     slave invokehidden dde servername slave
 } -body {
     catch {dde eval slave set a 1} msg
 } -cleanup {interp delete slave} -result {1}
-test winDde-8.4 {Safe DDE check that execute is denied} -constraints {win dde} -setup {
+test winDde-8.4 {Safe DDE check that execute is denied} -constraints dde -setup {
     interp create -safe slave
     slave invokehidden load $::ddelib Dde
     slave invokehidden dde servername slave
@@ -343,7 +340,7 @@ test winDde-8.4 {Safe DDE check that execute is denied} -constraints {win dde} -
     dde execute TclEval slave {set a 2}
     slave eval set a
 } -cleanup {interp delete slave} -result 1
-test winDde-8.5 {Safe DDE check that request is denied} -constraints {win dde} -setup {
+test winDde-8.5 {Safe DDE check that request is denied} -constraints dde -setup {
     interp create -safe slave
     slave invokehidden load $::ddelib Dde
     slave invokehidden dde servername slave
@@ -353,14 +350,14 @@ test winDde-8.5 {Safe DDE check that request is denied} -constraints {win dde} -
 } -cleanup {
     interp delete slave
 } -returnCodes error -result {remote server cannot handle this command}
-test winDde-8.6 {Safe DDE assign handler procedure} -constraints {win dde} -setup {
+test winDde-8.6 {Safe DDE assign handler procedure} -constraints dde -setup {
     interp create -safe slave
     slave invokehidden load $::ddelib Dde
     slave eval {proc DDEACCEPT {cmd} {set ::DDECMD $cmd}}
 } -body {
     slave invokehidden dde servername -handler DDEACCEPT slave
 } -cleanup {interp delete slave} -result slave
-test winDde-8.7 {Safe DDE check simple command} -constraints {win dde} -setup {
+test winDde-8.7 {Safe DDE check simple command} -constraints dde -setup {
     interp create -safe slave
     slave invokehidden load $::ddelib Dde
     slave eval {proc DDEACCEPT {cmd} {set ::DDECMD $cmd}}
@@ -368,7 +365,7 @@ test winDde-8.7 {Safe DDE check simple command} -constraints {win dde} -setup {
 } -body {
     dde eval slave set x 1
 } -cleanup {interp delete slave} -result {set x 1}
-test winDde-8.8 {Safe DDE check non-list command} -constraints {win dde} -setup {
+test winDde-8.8 {Safe DDE check non-list command} -constraints dde -setup {
     interp create -safe slave
     slave invokehidden load $::ddelib Dde
     slave eval {proc DDEACCEPT {cmd} {set ::DDECMD $cmd}}
@@ -378,16 +375,16 @@ test winDde-8.8 {Safe DDE check non-list command} -constraints {win dde} -setup
     dde eval slave $s
     string equal [slave eval set DDECMD] $s
 } -cleanup {interp delete slave} -result 1
-test winDde-8.9 {Safe DDE check command evaluation} -constraints {win dde} -setup {
+test winDde-8.9 {Safe DDE check command evaluation} -constraints dde -setup {
     interp create -safe slave
     slave invokehidden load $::ddelib Dde
     slave eval {proc DDEACCEPT {cmd} {set ::DDECMD [uplevel \#0 $cmd]}}
     slave invokehidden dde servername -handler DDEACCEPT slave
 } -body {
-    dde eval slave set x 1
-    slave eval set x
+    dde eval slave set \xe1 1
+    slave eval set \xe1
 } -cleanup {interp delete slave} -result 1
-test winDde-8.10 {Safe DDE check command evaluation (2)} -constraints {win dde} -setup {
+test winDde-8.10 {Safe DDE check command evaluation (2)} -constraints dde -setup {
     interp create -safe slave
     slave invokehidden load $::ddelib Dde
     slave eval {proc DDEACCEPT {cmd} {set ::DDECMD [uplevel \#0 $cmd]}}
@@ -396,7 +393,7 @@ test winDde-8.10 {Safe DDE check command evaluation (2)} -constraints {win dde}
     dde eval slave [list set x 1]
     slave eval set x
 } -cleanup {interp delete slave} -result 1
-test winDde-8.11 {Safe DDE check command evaluation (3)} -constraints {win dde} -setup {
+test winDde-8.11 {Safe DDE check command evaluation (3)} -constraints dde -setup {
     interp create -safe slave
     slave invokehidden load $::ddelib Dde
     slave eval {proc DDEACCEPT {cmd} {set ::DDECMD [uplevel \#0 $cmd]}}
@@ -408,9 +405,9 @@ test winDde-8.11 {Safe DDE check command evaluation (3)} -constraints {win dde}
 
 # -------------------------------------------------------------------------
 
-test winDde-9.1 {External safe DDE check string passing} -constraints {win dde stdio} -setup {
-    set name child-9.1
-    set child [createChildProcess $name Handler1]
+test winDde-9.1 {External safe DDE check string passing} -constraints {dde stdio} -setup {
+    set name ch\xEDld-9.1
+    set child [createChildProcess $name -handler Handler1]
     file copy -force script1.tcl dde-script.tcl
 } -body {
     dde eval $name set x 1
@@ -421,9 +418,9 @@ test winDde-9.1 {External safe DDE check string passing} -constraints {win dde s
     update
     file delete -force -- dde-script.tcl
 } -result {set x 1}
-test winDde-9.2 {External safe DDE check command evaluation} -constraints {win dde stdio} -setup {
-    set name child-9.2
-    set child [createChildProcess $name Handler2]
+test winDde-9.2 {External safe DDE check command evaluation} -constraints {dde stdio} -setup {
+    set name ch\xEDld-9.2
+    set child [createChildProcess $name -handler Handler2]
     file copy -force script1.tcl dde-script.tcl
 } -body {
     dde eval $name set x 1
@@ -434,9 +431,9 @@ test winDde-9.2 {External safe DDE check command evaluation} -constraints {win d
     update
     file delete -force -- dde-script.tcl
 } -result 1
-test winDde-9.3 {External safe DDE check prefixed arguments} -constraints {win dde stdio} -setup {
-    set name child-9.3
-    set child [createChildProcess $name [list Handler3 ARG]]
+test winDde-9.3 {External safe DDE check prefixed arguments} -constraints {dde stdio} -setup {
+    set name ch\xEDld-9.3
+    set child [createChildProcess $name -handler [list Handler3 ARG]]
     file copy -force script1.tcl dde-script.tcl
 } -body {
     dde eval $name set x 1
@@ -447,6 +444,19 @@ test winDde-9.3 {External safe DDE check prefixed arguments} -constraints {win d
     update
     file delete -force -- dde-script.tcl
 } -result {ARG {set x 1}}
+test winDde-9.4 {External safe DDE check null data passing} -constraints {dde stdio} -setup {
+    set name ch\xEDld-9.4
+    set child [createChildProcess $name -handler Handler1]
+    file copy -force script1.tcl dde-script.tcl
+} -body {
+    dde execute TclEval $name ""
+    gets $child line
+    set line
+} -cleanup {
+    dde execute TclEval $name stop
+    update
+    file delete -force -- dde-script.tcl
+} -result {null data}
 
 # -------------------------------------------------------------------------
 
diff --git a/win/tclWinDde.c b/win/tclWinDde.c
index 5f2ef32..e40e114 100644
--- a/win/tclWinDde.c
+++ b/win/tclWinDde.c
@@ -1443,7 +1443,7 @@ DdeObjCmd(
 	    dataLength += 1;
 	}
 
-	if (dataLength <= ((flags & DDE_FLAG_BINARY) ? 0 : (int)sizeof(TCHAR))) {
+	if (dataLength <= 0) {
 	    Tcl_SetObjResult(interp,
 		    Tcl_NewStringObj("cannot execute null data", -1));
 	    Tcl_SetErrorCode(interp, "TCL", "DDE", "NULL", NULL);