Documented (some) 64-bit-related behaviour changes.

3 files changed, 64 insertions, 22 deletions

diff --git a/doc/expr.n b/doc/expr.n
index 5fb3cee..4a3674f 100644
--- a/doc/expr.n
+++ b/doc/expr.n
@@ -5,7 +5,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: expr.n,v 1.5 2000/09/07 14:27:47 poenitz Exp $
+'\" RCS: @(#) $Id: expr.n,v 1.5.12.1 2001/10/12 12:58:48 dkf Exp $
 '\" 
 .so man.macros
 .TH expr n 8.4 Tcl "Tcl Built-In Commands"
@@ -55,6 +55,13 @@ If no numeric interpretation is possible, then an operand is left
 as a string (and only a limited set of operators may be applied to
 it).
 .PP
+.VS 8.4
+On 32-bit systems, integer values MAX_INT (0x7FFFFFFF) and MIN_INT
+(-0x80000000) will be represented as 32-bit values, and integer values
+outside that range will be represented as 64-bit values (if that is
+possible at all.)
+.VE 8.4
+.PP
 Operands may be specified in any of the following ways:
 .IP [1]
 As an numeric value, either integer or floating-point.
@@ -249,8 +256,12 @@ Computes the length of the hypotenuse of a right-angled triangle
 (\fIx\fR*\fIx\fR+\fIy\fR*\fIy\fR).
 .TP
 \fBint(\fIarg\fB)\fR
-If \fIarg\fR is an integer value, returns \fIarg\fR, otherwise converts
-\fIarg\fR to integer by truncation and returns the converted value.
+.VS 8.4
+If \fIarg\fR is an integer value, returns \fIarg\fR, otherwise
+converts \fIarg\fR to an integer (of the same size as a machine word,
+i.e. 32-bits on 32-bit systems, and 64-bits on 64-bit systems) by
+truncation and returns the converted value.
+.VE 8.4
 .TP
 \fBlog(\fIarg\fB)\fR
 Returns the natural logarithm of \fIarg\fR.  \fIArg\fR must be a
@@ -294,6 +305,12 @@ Returns the tangent of \fIarg\fR, measured in radians.
 .TP
 \fBtanh(\fIarg\fB)\fR
 Returns the hyperbolic tangent of \fIarg\fR.
+.TP
+\fBwide(\fIarg\fB)\fR
+.VS 8.4
+Converts \fIarg\fR to a value at least 64-bits wide (by sign-extension
+if \fIarg\fR is a 32-bit number.)
+.VE 8.4
 .PP
 In addition to these predefined functions, applications may
 define additional functions using \fBTcl_CreateMathFunc\fR().
diff --git a/doc/format.n b/doc/format.n
index 736840e..94542e7 100644
--- a/doc/format.n
+++ b/doc/format.n
@@ -5,7 +5,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: format.n,v 1.5 2000/09/07 14:27:48 poenitz Exp $
+'\" RCS: @(#) $Id: format.n,v 1.5.12.1 2001/10/12 12:58:48 dkf Exp $
 '\" 
 .so man.macros
 .TH format n 8.1 Tcl "Tcl Built-In Commands"
@@ -131,7 +131,10 @@ which must be \fBh\fR or \fBl\fR.
 If it is \fBh\fR it specifies that the numeric value should be
 truncated to a 16-bit value before converting.
 This option is rarely useful.
-The \fBl\fR modifier is ignored.
+.VS 8.4
+If it is \fBl\fR it specifies that the numeric value should be (at
+least) a 64-bit value.
+.VE
 .PP
 The last thing in a conversion specifier is an alphabetic character
 that determines what kind of conversion to perform.
diff --git a/doc/scan.n b/doc/scan.n
index 267f168..e2478aa 100644
--- a/doc/scan.n
+++ b/doc/scan.n
@@ -6,10 +6,10 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: scan.n,v 1.7 2000/12/10 03:27:03 hobbs Exp $
+'\" RCS: @(#) $Id: scan.n,v 1.7.12.1 2001/10/12 12:58:48 dkf Exp $
 '\" 
 .so man.macros
-.TH scan n 8.3 Tcl "Tcl Built-In Commands"
+.TH scan n 8.4 Tcl "Tcl Built-In Commands"
 .BS
 '\" Note:  do not modify the .SH NAME line immediately below!
 .SH NAME
@@ -28,13 +28,11 @@ to be parsed and \fIformat\fR indicates how to parse it, using \fB%\fR
 conversion specifiers as in \fBsscanf\fR.  Each \fIvarName\fR gives the
 name of a variable; when a field is scanned from \fIstring\fR the result is
 converted back into a string and assigned to the corresponding variable.
-.VS 8.3
 If no \fIvarName\fR variables are specified, then \fBscan\fR works in an
 inline manner, returning the data that would otherwise be stored in the
 variables as a list.  In the inline case, an empty string is returned when
 the end of the input string is reached before any conversions have been
 performed.
-.VE 8.3
 
 .SH "DETAILS ON SCANNING"
 .PP
@@ -46,10 +44,13 @@ Otherwise, if it isn't a \fB%\fR character then it
 must match the next character of \fIstring\fR.
 When a \fB%\fR is encountered in \fIformat\fR, it indicates
 the start of a conversion specifier.
+.VS 8.4
 A conversion specifier contains up to four fields after the \fB%\fR:
 a \fB*\fR, which indicates that the converted value is to be discarded 
 instead of assigned to a variable; a XPG3 position specifier; a number
-indicating a maximum field width; and a conversion character.
+indicating a maximum field width; a field size modifier; and a
+conversion character.
+.VE 8.4
 All of these fields are optional except for the conversion character.
 The fields that are present must appear in the order given above.
 .PP
@@ -75,33 +76,56 @@ The following conversion characters are supported:
 \fBd\fR
 The input field must be a decimal integer.
 It is read in and the value is stored in the variable as a decimal string.
+.VS 8.4
+If the \fBl\fR or \fBL\fR field size modifier is given, the scanned
+value will have an internal representation that is at least 64-bits in
+size.
+.VE 8.4
 .TP 10
 \fBo\fR
 The input field must be an octal integer. It is read in and the 
 value is stored in the variable as a decimal string.
 .VS 8.4
+If the \fBl\fR or \fBL\fR field size modifier is given, the scanned
+value will have an internal representation that is at least 64-bits in
+size.
 If the value exceeds MAX_INT (017777777777 on platforms using 32-bit
-integers), it will be truncated to a signed integer.  Hence, 037777777777
-will appear as -1 on a 32-bit machine.
+integers when the \fBl\fR and \fBL\fR modifiers are not given), it
+will be truncated to a signed integer.  Hence, 037777777777 will
+appear as -1 on a 32-bit machine by default.
 .VE 8.4
 .TP 10
 \fBx\fR
 The input field must be a hexadecimal integer. It is read in 
 and the value is stored in the variable as a decimal string.
 .VS 8.4
+If the \fBl\fR or \fBL\fR field size modifier is given, the scanned
+value will have an internal representation that is at least 64-bits in
+size.
 If the value exceeds MAX_INT (0x7FFFFFFF on platforms using 32-bit
-integers), it will be truncated to a signed integer.  Hence, 0xFFFFFFFF
-will appear as -1 on a 32-bit machine.
+integers when the \fBl\fR and \fBL\fR modifiers are not given), it
+will be truncated to a signed integer.  Hence, 0xFFFFFFFF will appear
+as -1 on a 32-bit machine.
 .VE 8.4
 .TP 10
 \fBu\fR
 The input field must be a decimal integer.  The value is stored in the
 variable as an unsigned decimal integer string.
+.VS 8.4
+If the \fBl\fR or \fBL\fR field size modifier is given, the scanned
+value will have an internal representation that is at least 64-bits in
+size.
+.VE 8.4
 .TP 10
 \fBi\fR 
 The input field must be an integer.  The base (i.e. decimal, octal, or
 hexadecimal) is determined in the same fashion as described in
 \fBexpr\fR.  The value is stored in the variable as a decimal string.
+.VS 8.4
+If the \fBl\fR or \fBL\fR field size modifier is given, the scanned
+value will have an internal representation that is at least 64-bits in
+size.
+.VE 8.4
 .TP 10
 \fBc\fR
 A single character is read in and its binary value is stored in 
@@ -177,16 +201,14 @@ converted to a decimal string, which is then assigned to the
 corresponding \fIvarName\fR;
 no field width may be specified for this conversion.
 .IP [3]
-The \fBl\fR, \fBh\fR, and \fBL\fR modifiers are ignored;  integer
-values are always converted as if there were no modifier present
-and real values are always converted as if the \fBl\fR modifier
-were present (i.e. type \fBdouble\fR is used for the internal
-representation).
+.VS 8.4
+The \fBh\fR modifier is always ignored and the \fBl\fR and \fBL\fR
+modifiers are ignored when converting real values (i.e. type
+\fBdouble\fR is used for the internal representation).
+.VE 8.4
 .IP [4]
-.VS 8.3
 If the end of the input string is reached before any conversions have been
-performed and no variables are given, and empty string is returned.
-.VE 8.3
+performed and no variables are given, an empty string is returned.
 
 .SH "SEE ALSO"
 format(n), sscanf(3)