TIP #586 implementation: C String Parsing Support for binary scan

3 files changed, 31 insertions, 4 deletions

diff --git a/doc/binary.n b/doc/binary.n
index 0e8b28e..9b8b106 100644
--- a/doc/binary.n
+++ b/doc/binary.n
@@ -762,6 +762,15 @@ high-to-low order within each byte.  For example,
 will return \fB2\fR with \fB01110\fR stored in \fIvar1\fR and
 \fB1000011100000101\fR stored in \fIvar2\fR.
 .RE
+.IP \fBC\fR 5
+This form is similar to \fBA\fR, except that it scans the data from start
+and terminates at the first null (C string semantics). For example,
+.RS
+.CS
+\fBbinary scan\fR "abc\e000efghi" C* var1
+.CE
+will return \fB1\fR with \fBabc\fR stored in \fIvar1\fR.
+.RE
 .IP \fBH\fR 5
 The data is turned into a string of \fIcount\fR hexadecimal digits in
 high-to-low order represented as a sequence of characters in the set
diff --git a/generic/tclBinary.c b/generic/tclBinary.c
index f53c707..8a3541b 100644
--- a/generic/tclBinary.c
+++ b/generic/tclBinary.c
@@ -1518,7 +1518,8 @@ BinaryScanCmd(
 	}
 	switch (cmd) {
 	case 'a':
-	case 'A': {
+	case 'A':
+	case 'C': {
 	    unsigned char *src;
 
 	    if (arg >= objc) {
@@ -1540,10 +1541,18 @@ BinaryScanCmd(
 	    size = count;
 
 	    /*
-	     * Trim trailing nulls and spaces, if necessary.
+	     * Apply C string semantics or trim trailing
+	     * nulls and spaces, if necessary.
 	     */
 
-	    if (cmd == 'A') {
+	    if (cmd == 'C') {
+		for (i = 0; i < size; i++) {
+		    if (src[i] == '\0') {
+			size = i;
+			break;
+		    }
+		}
+	    } else if (cmd == 'A') {
 		while (size > 0) {
 		    if (src[size - 1] != '\0' && src[size - 1] != ' ') {
 			break;
diff --git a/tests/binary.test b/tests/binary.test
index cf3195f..7433fe8 100644
--- a/tests/binary.test
+++ b/tests/binary.test
@@ -759,7 +759,16 @@ test binary-21.12 {Tcl_BinaryObjCmd: scan} -setup {
 } -body {
     list [binary scan "abc def \x00ghi  " A* arg1] $arg1
 } -result [list 1 "abc def \x00ghi"]
-
+test binary-21.13 {Tcl_BinaryObjCmd: scan} -setup {
+    unset -nocomplain arg1
+} -body {
+    list [binary scan "abc def \x00  " C* arg1] $arg1
+} -result {1 {abc def }}
+test binary-21.12 {Tcl_BinaryObjCmd: scan} -setup {
+    unset -nocomplain arg1
+} -body {
+    list [binary scan "abc def \x00ghi" C* arg1] $arg1
+} -result {1 {abc def }}
 test binary-22.1 {Tcl_BinaryObjCmd: scan} -returnCodes error -body {
     binary scan abc b
 } -result {not enough arguments for all format specifiers}