* doc/GetInt.3: Convert argument "string" to "str" to agree with code.

        Also clarified a few details on int and double formats.
        * generic/tclGet.c:     Radical code simplification.  Converted most
        Tcl_GetFoo() routines into wrappers around Tcl_GetFooFromObj().
        Reduces code duplication, and the resulting potential for inconsistency.

1 files changed, 23 insertions, 21 deletions

diff --git a/doc/GetInt.3 b/doc/GetInt.3
index bd1475e..573a596 100644
--- a/doc/GetInt.3
+++ b/doc/GetInt.3
@@ -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: GetInt.3,v 1.7 2004/10/07 15:15:38 dkf Exp $
+'\" RCS: @(#) $Id: GetInt.3,v 1.8 2005/04/21 14:23:48 dgp Exp $
 '\" 
 .so man.macros
 .TH Tcl_GetInt 3 "" Tcl "Tcl Library Procedures"
@@ -17,62 +17,64 @@ Tcl_GetInt, Tcl_GetDouble, Tcl_GetBoolean \- convert from string to integer, dou
 \fB#include <tcl.h>\fR
 .sp
 int
-\fBTcl_GetInt\fR(\fIinterp, string, intPtr\fR)
+\fBTcl_GetInt\fR(\fIinterp, str, intPtr\fR)
 .sp
 int
-\fBTcl_GetDouble\fR(\fIinterp, string, doublePtr\fR)
+\fBTcl_GetDouble\fR(\fIinterp, str, doublePtr\fR)
 .sp
 int
-\fBTcl_GetBoolean\fR(\fIinterp, string, boolPtr\fR)
+\fBTcl_GetBoolean\fR(\fIinterp, str, boolPtr\fR)
 .SH ARGUMENTS
 .AS Tcl_Interp *doublePtr out
 .AP Tcl_Interp *interp in
 Interpreter to use for error reporting.
-.AP "const char" *string in
+.AP "const char" *str in
 Textual value to be converted.
 .AP int *intPtr out
-Points to place to store integer value converted from \fIstring\fR.
+Points to place to store integer value converted from \fIstr\fR.
 .AP double *doublePtr out
 Points to place to store double-precision floating-point
-value converted from \fIstring\fR.
+value converted from \fIstr\fR.
 .AP int *boolPtr out
-Points to place to store boolean value (0 or 1) converted from \fIstring\fR.
+Points to place to store boolean value (0 or 1) converted from \fIstr\fR.
 .BE
 
 .SH DESCRIPTION
 .PP
 These procedures convert from strings to integers or double-precision
 floating-point values or booleans (represented as 0- or 1-valued
-integers).  Each of the procedures takes a \fIstring\fR argument,
+integers).  Each of the procedures takes a \fIstr\fR argument,
 converts it to an internal form of a particular type, and stores
 the converted value at the location indicated by the procedure's
 third argument.  If all goes well, each of the procedures returns
-\fBTCL_OK\fR.  If \fIstring\fR doesn't have the proper syntax for the
+\fBTCL_OK\fR.  If \fIstr\fR doesn't have the proper syntax for the
 desired type then \fBTCL_ERROR\fR is returned, an error message is left
 in the interpreter's result, and nothing is stored at *\fIintPtr\fR
 or *\fIdoublePtr\fR or *\fIboolPtr\fR.
 .PP
-\fBTcl_GetInt\fR expects \fIstring\fR to consist of a collection
+\fBTcl_GetInt\fR expects \fIstr\fR to consist of a collection
 of integer digits, optionally signed and optionally preceded by
-white space.  If the first two characters of \fIstring\fR are ``0x''
-then \fIstring\fR is expected to be in hexadecimal form;  otherwise,
-if the first character of \fIstring\fR is ``0'' then \fIstring\fR
-is expected to be in octal form;  otherwise, \fIstring\fR is
+white space.  If the first two characters of \fIstr\fR
+after the optional white space and sign are ``0x''
+then \fIstr\fR is expected to be in hexadecimal form;  otherwise,
+if the first such character is ``0'' then \fIstr\fR
+is expected to be in octal form;  otherwise, \fIstr\fR is
 expected to be in decimal form.
 .PP
-\fBTcl_GetDouble\fR expects \fIstring\fR to consist of a floating-point
+\fBTcl_GetDouble\fR expects \fIstr\fR to consist of a floating-point
 number, which is:  white space;  a sign; a sequence of digits;  a
-decimal point;  a sequence of digits;  the letter ``e'';  and a
-signed decimal exponent.  Any of the fields may be omitted, except that
+decimal point;  a sequence of digits;  the letter ``e'';  a
+signed decimal exponent ; and more white space.
+Any of the fields may be omitted, except that
 the digits either before or after the decimal point must be present
 and if the ``e'' is present then it must be followed by the
 exponent number.
 .PP
-\fBTcl_GetBoolean\fR expects \fIstring\fR to specify a boolean
-value.  If \fIstring\fR is any of \fB0\fR, \fBfalse\fR,
+\fBTcl_GetBoolean\fR expects \fIstr\fR to specify a boolean
+value.  If \fIstr\fR is any of \fB0\fR, \fBfalse\fR,
 \fBno\fR, or \fBoff\fR, then \fBTcl_GetBoolean\fR stores a zero
 value at \fI*boolPtr\fR.
-If \fIstring\fR is any of \fB1\fR, \fBtrue\fR, \fByes\fR, or \fBon\fR,
+If \fIstr\fR is any of \fB1\fR, \fBtrue\fR, \fByes\fR, or \fBon\fR,
 then 1 is stored at \fI*boolPtr\fR.
 Any of these values may be abbreviated, and upper-case spellings
 are also acceptable.