summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2022-11-21 23:58:15 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2022-11-21 23:58:15 (GMT)
commit62077a6bd15376a91a4390646dc5c28448aa367e (patch)
treeba795acd3cf49f1f7fac05e4de275557f5f21841 /doc
parentc1e4942181ef1b8b60b89bfe5983b410080cd477 (diff)
parent2f3087ea8f42ed192da6b35b4cd230cb74f0fd6a (diff)
downloadtcl-62077a6bd15376a91a4390646dc5c28448aa367e.zip
tcl-62077a6bd15376a91a4390646dc5c28448aa367e.tar.gz
tcl-62077a6bd15376a91a4390646dc5c28448aa367e.tar.bz2
Rebase to 8.7
Diffstat (limited to 'doc')
-rw-r--r--doc/IntObj.338
1 files changed, 27 insertions, 11 deletions
diff --git a/doc/IntObj.3 b/doc/IntObj.3
index 18d867e..5e6a04a 100644
--- a/doc/IntObj.3
+++ b/doc/IntObj.3
@@ -8,7 +8,7 @@
.so man.macros
.BS
.SH NAME
-Tcl_NewIntObj, Tcl_NewLongObj, Tcl_NewWideIntObj, Tcl_SetIntObj, Tcl_SetLongObj, Tcl_SetWideIntObj, Tcl_GetIntFromObj, Tcl_GetIntForIndex, Tcl_GetLongFromObj, Tcl_GetWideIntFromObj, Tcl_GetWideUIntFromObj, Tcl_NewBignumObj, Tcl_SetBignumObj, Tcl_GetBignumFromObj, Tcl_TakeBignumFromObj \- manipulate Tcl values as integers
+Tcl_NewIntObj, Tcl_NewLongObj, Tcl_NewWideIntObj, Tcl_NewWideUIntObj, Tcl_NewIndexObj, Tcl_SetIntObj, Tcl_SetLongObj, Tcl_SetWideIntObj, Tcl_SetWideUIntObj, Tcl_SetIndexObj, Tcl_GetIntFromObj, Tcl_GetIntForIndex, Tcl_GetLongFromObj, Tcl_GetWideIntFromObj, Tcl_GetWideUIntFromObj, Tcl_NewBignumObj, Tcl_SetBignumObj, Tcl_GetBignumFromObj, Tcl_TakeBignumFromObj \- manipulate Tcl values as integers
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
@@ -22,12 +22,22 @@ Tcl_Obj *
Tcl_Obj *
\fBTcl_NewWideIntObj\fR(\fIwideValue\fR)
.sp
+Tcl_Obj *
+\fBTcl_NewWideUIntObj\fR(\fIuwideValue\fR)
+.sp
+Tcl_Obj *
+\fBTcl_NewIndexObj\fR(\fIindexValue\fR)
+.sp
\fBTcl_SetIntObj\fR(\fIobjPtr, intValue\fR)
.sp
\fBTcl_SetLongObj\fR(\fIobjPtr, longValue\fR)
.sp
\fBTcl_SetWideIntObj\fR(\fIobjPtr, wideValue\fR)
.sp
+\fBTcl_SetWideUIntObj\fR(\fIobjPtr, uwideValue\fR)
+.sp
+\fBTcl_SetIndexObj\fR(\fIobjPtr, indexValue\fR)
+.sp
int
\fBTcl_GetIntFromObj\fR(\fIinterp, objPtr, intPtr\fR)
.sp
@@ -69,8 +79,14 @@ Integer value used to initialize or set a Tcl value.
Long integer value used to initialize or set a Tcl value.
.AP Tcl_WideInt wideValue in
Wide integer value used to initialize or set a Tcl value.
+.AP Tcl_WideUInt uwideValue in
+Unsigned wide integer value used to initialize or set a Tcl value.
+.AP Tcl_Size indexValue in
+\fTcl_Size\f value used to initialize or set a Tcl value.
+In Tcl 8.x, \fTcl_Size\f is actually the same as int.
.AP Tcl_Obj *objPtr in/out
For \fBTcl_SetIntObj\fR, \fBTcl_SetLongObj\fR, \fBTcl_SetWideIntObj\fR,
+\fBTcl_SetWideUIntObj\fR, \fBTcl_SetIndexObj\fR,
and \fBTcl_SetBignumObj\fR, this points to the value in which to store an
integral value. For \fBTcl_GetIntFromObj\fR, \fBTcl_GetLongFromObj\fR,
\fBTcl_GetWideIntFromObj\fR, \fBTcl_GetBignumFromObj\fR, and
@@ -112,18 +128,18 @@ The \fBmp_int\fR type is a multiple-precision integer type defined
by the LibTomMath multiple-precision integer library.
.PP
The \fBTcl_NewIntObj\fR, \fBTcl_NewLongObj\fR, \fBTcl_NewWideIntObj\fR,
-and \fBTcl_NewBignumObj\fR routines each create and return a new
-Tcl value initialized to the integral value of the argument. The
-returned Tcl value is unshared.
+\fBTcl_NewWideUIntObj\fR, \fBTcl_NewIndexObj\fR, and \fBTcl_NewBignumObj\fR
+routines each create and return a new Tcl value initialized to the
+integral value of the argument. The returned Tcl value is unshared.
.PP
The \fBTcl_SetIntObj\fR, \fBTcl_SetLongObj\fR, \fBTcl_SetWideIntObj\fR,
-and \fBTcl_SetBignumObj\fR routines each set the value of an existing
-Tcl value pointed to by \fIobjPtr\fR to the integral value provided
-by the other argument. The \fIobjPtr\fR argument must point to an
-unshared Tcl value. Any attempt to set the value of a shared Tcl value
-violates Tcl's copy-on-write policy. Any existing string representation
-or internal representation in the unshared Tcl value will be freed
-as a consequence of setting the new value.
+\fBTcl_SetWideUIntObj\fR, \fBTcl_SetIndexObj\fR, and \fBTcl_SetBignumObj\fR
+routines each set the value of an existing Tcl value pointed to by \fIobjPtr\fR
+to the integral value provided by the other argument. The \fIobjPtr\fR
+argument must point to an unshared Tcl value. Any attempt to set the
+value of a shared Tcl value violates Tcl's copy-on-write policy. Any
+existing string representation or internal representation in the unshared
+Tcl value will be freed as a consequence of setting the new value.
.PP
The \fBTcl_GetIntForIndex\fR routine attempts to retrieve an index
value from the Tcl value \fIobjPtr\fR. If the attempt succeeds,