Tcl Source Code

View Ticket
Login
Ticket UUID: 2878945
Title: Tcl_ExternalToUtf(...dst, dstLen,...) writes to dst[dstLen]
Type: Bug Created on: 2009-10-14 14:56:01
Submitter: dgp Assigned to: dgp
Subsystem: 10. Objects Severity:
Priority: 5 Medium Last modified: 2009-12-11 17:48:17
Status: Open Closed by:
Resolution: None Closed on:
Version: obsolete: 8.5.7
Description:
The docs of Tcl_ExternalToUtf() are unclear on the
boundaries of the write buffer. They say "... and up
to dstLen converted bytes are stored in dst." which
suggests bytes will be written in dst[0] up
to dst[dstLen-1]. And that appears to be an accurate
description of what the underlying ToUtfProc() does.
However, then Tcl_ExternalToUtf() appends a terminating
NUL character, and if the ToUtfProc has used all dstLen
bytes, T_ETU writes to dst[dstLen].
User Comments:
dgp added on 2009-10-14 22:03:21:
It should also be noted that no bytes (except that
terminating NUL) will be written unless dstLen is
at least TCL_UTF_MAX.

dgp added on 2009-10-15 00:31:01:
Sorry, I missed a line in Tcl_ExternalToUtf().
It decrements dstLen before passing to the
ToUtfProc to account for the byte it needs to
write NUL into.

dgp added on 2009-10-15 00:43:17:
no matter what the value of dstLen, writing
to the byte *dst must work.  That is, don't expect
dstLen==0 to work.

To get at least one actual character in the output
buffer, dstLen must have a minimum value of
TCL_UTF_MAX + 1.

dkf added on 2009-12-11 17:48:17:
Maybe this just needs to be documented.