Elaborate TIP #481 implementation: Make clear that Tcl_GetUnicodeFromObj and Tcl_GetStringFromObj panic if lengthPtr points to an int and length > INT_MAX.

Also if sizeof(int) == sizeof(size_t), prefer the size_t variant of the functions

1 files changed, 5 insertions, 2 deletions

diff --git a/doc/StringObj.3 b/doc/StringObj.3
index c9bdd4a..2526a01 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -188,7 +188,9 @@ Even in the limited situations where writing to this pointer is
 acceptable, one should take care to respect the copy-on-write
 semantics required by \fBTcl_Obj\fR's, with appropriate calls
 to \fBTcl_IsShared\fR and \fBTcl_DuplicateObj\fR prior to any
-in-place modification of the string representation.
+in-place modification of the string representation. If \fIlengthPtr\fR
+points to an \fBint\fR variable, and the string has more than 2^31 bytes,
+a panic will result.
 The procedure \fBTcl_GetString\fR is used in the common case
 where the caller does not need the length of the string
 representation.
@@ -200,7 +202,8 @@ value as a Unicode string.  This is given by the returned pointer and
 byte pointer is owned by the value manager and should not be modified by
 the caller.  The procedure \fBTcl_GetUnicode\fR is used in the common case
 where the caller does not need the length of the unicode string
-representation.
+representation. If \fIlengthPtr\fR points to an \fBint\fR variable,
+and the string has more than 2^31 unicode characters, a panic will result. 
 .PP
 \fBTcl_GetUniChar\fR returns the \fIindex\fR'th character in the
 value's Unicode representation. If the index is out of range or