通讯编程

开发平台：
Visual C++

format.n：源码内容
							'"
'" Copyright (c) 1993 The Regents of the University of California.
'" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'"
'" 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.7.2.1 2004/10/27 12:52:40 dkf Exp $
'" 
.so man.macros
.TH format n 8.1 Tcl "Tcl Built-In Commands"
.BS
'" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
format - Format a string in the style of sprintf
.SH SYNOPSIS
fBformat fIformatString fR?fIarg arg ...fR?
.BE
.SH INTRODUCTION
.PP
This command generates a formatted string in the same way as the
ANSI C fBsprintffR procedure (it uses fBsprintffR in its
implementation).
fIFormatStringfR indicates how to format the result, using
fB%fR conversion specifiers as in fBsprintffR, and the additional
arguments, if any, provide values to be substituted into the result.
The return value from fBformatfR is the formatted string.
.SH "DETAILS ON FORMATTING"
.PP
The command operates by scanning fIformatStringfR from left to right. 
Each character from the format string is appended to the result
string unless it is a percent sign.
If the character is a fB%fR then it is not copied to the result string.
Instead, the characters following the fB%fR character are treated as
a conversion specifier.
The conversion specifier controls the conversion of the next successive
fIargfR to a particular format and the result is appended to 
the result string in place of the conversion specifier.
If there are multiple conversion specifiers in the format string,
then each one controls the conversion of one additional fIargfR.
The fBformatfR command must be given enough fIargfRs to meet the needs
of all of the conversion specifiers in fIformatStringfR.
.PP
Each conversion specifier may contain up to six different parts:
an XPG3 position specifier,
a set of flags, a minimum field width, a precision, a length modifier,
and a conversion character.
Any of these fields may be omitted except for the conversion character.
The fields that are present must appear in the order given above.
The paragraphs below discuss each of these fields in turn.
.PP
If the fB%fR is followed by a decimal number and a fB$fR, as in
``fB%2$dfR'', then the value to convert is not taken from the
next sequential argument.
Instead, it is taken from the argument indicated by the number,
where 1 corresponds to the first fIargfR.
If the conversion specifier requires multiple arguments because
of fB*fR characters in the specifier then
successive arguments are used, starting with the argument
given by the number.
This follows the XPG3 conventions for positional specifiers.
If there are any positional specifiers in fIformatStringfR
then all of the specifiers must be positional.
.PP
The second portion of a conversion specifier may contain any of the
following flag characters, in any order:
.TP 10
fB-fR
Specifies that the converted argument should be left-justified 
in its field (numbers are normally right-justified with leading 
spaces if needed).
.TP 10
fB+fR
Specifies that a number should always be printed with a sign, 
even if positive.
.TP 10
fIspacefR
Specifies that a space should be added to the beginning of the 
number if the first character isn't a sign.
.TP 10
fB0fR
Specifies that the number should be padded on the left with 
zeroes instead of spaces.
.TP 10
fB#fR
Requests an alternate output form. For fBofR and fBOfR
conversions it guarantees that the first digit is always fB0fR.
For fBxfR or fBXfR conversions, fB0xfR or fB0XfR (respectively)
will be added to the beginning of the result unless it is zero.
For all floating-point conversions (fBefR, fBEfR, fBffR,
fBgfR, and fBGfR) it guarantees that the result always 
has a decimal point.
For fBgfR and fBGfR conversions it specifies that 
trailing zeroes should not be removed.
.PP
The third portion of a conversion specifier is a number giving a
minimum field width for this conversion.
It is typically used to make columns line up in tabular printouts.
If the converted argument contains fewer characters than the
minimum field width then it will be padded so that it is as wide
as the minimum field width.
Padding normally occurs by adding extra spaces on the left of the
converted argument, but the fB0fR and fB-fR flags 
may be used to specify padding with zeroes on the left or with
spaces on the right, respectively.
If the minimum field width is specified as fB*fR rather than
a number, then the next argument to the fBformatfR command
determines the minimum field width; it must be a numeric string.
.PP
The fourth portion of a conversion specifier is a precision,
which consists of a period followed by a number.
The number is used in different ways for different conversions.
For fBefR, fBEfR, and fBffR conversions it specifies the number
of digits to appear to the right of the decimal point.
For fBgfR and fBGfR conversions it specifies the total number
of digits to appear, including those on both sides of the decimal
point (however, trailing zeroes after the decimal point will still
be omitted unless the fB#fR flag has been specified).
For integer conversions, it specifies a minimum number of digits
to print (leading zeroes will be added if necessary).
For fBsfR conversions it specifies the maximum number of characters to be 
printed; if the string is longer than this then the trailing characters will be dropped.
If the precision is specified with fB*fR rather than a number
then the next argument to the fBformatfR command determines the precision;
it must be a numeric string.
.PP
The fifth part of a conversion specifier is a length modifier,
which must be fBhfR or fBlfR.
If it is fBhfR it specifies that the numeric value should be
truncated to a 16-bit value before converting.
This option is rarely useful.
.VS 8.4
If it is fBlfR it specifies that the numeric value should be (at
least) a 64-bit value.  If neither fBhfR nor fBlfR are present,
numeric values are interpreted as being values of the width of the
native machine word, as described by fBtcl_platform(wordSize)fR.
.VE
.PP
The last thing in a conversion specifier is an alphabetic character
that determines what kind of conversion to perform.
The following conversion characters are currently supported:
.TP 10
fBdfR
Convert integer to signed decimal string.
.TP 10
fBufR
Convert integer to unsigned decimal string.
.TP 10
fBifR
Convert integer to signed decimal string;  the integer may either be
in decimal, in octal (with a leading fB0fR) or in hexadecimal
(with a leading fB0xfR).
.TP 10
fBofR
Convert integer to unsigned octal string.
.TP 10
fBxfR or fBXfR
Convert integer to unsigned hexadecimal string, using digits
``0123456789abcdef'' for fBxfR and ``0123456789ABCDEF'' for fBXfR).
.VS
.TP 10
fBcfR
Convert integer to the Unicode character it represents.
.VE
.TP 10
fBsfR
No conversion; just insert string.
.TP 10
fBffR
Convert floating-point number to signed decimal string of 
the form fIxx.yyyfR, where the number of fIyfR's is determined by 
the precision (default: 6).
If the precision is 0 then no decimal point is output.
.TP 10
fBefR or fBefR
Convert floating-point number to scientific notation in the 
form fIx.yyyfBe(+-fIzzfR, where the number of fIyfR's is determined 
by the precision (default: 6).
If the precision is 0 then no decimal point is output.
If the fBEfR form is used then fBEfR is 
printed instead of fBefR.
.TP 10
fBgfR or fBGfR
If the exponent is less than -4 or greater than or equal to the 
precision, then convert floating-point number as for fB%efR or 
fB%EfR.
Otherwise convert as for fB%ffR.
Trailing zeroes and a trailing decimal point are omitted.
.TP 10
fB%fR
No conversion: just insert fB%fR.
.LP
For the numerical conversions the argument being converted must
be an integer or floating-point string; format converts the argument
to binary and then converts it back to a string according to 
the conversion specifier.
.SH "DIFFERENCES FROM ANSI SPRINTF"
.PP
The behavior of the format command is the same as the
ANSI C fBsprintffR procedure except for the following
differences:
.IP [1]
fB%pfR and fB%nfR specifiers are not currently supported.
.IP [2]
For fB%cfR conversions the argument must be a decimal string,
which will then be converted to the corresponding character value.
.IP [3]
The fBlfR modifier
.VS 8.4
is ignored for real values and on 64-bit platforms, which are always
converted as if the fBlfR modifier were present (i.e. the types
fBdoublefR and fBlongfR are used for the internal representation
of real and integer values, respectively).
.VE 8.4
If the fBhfR modifier is specified then integer values are truncated
to fBshortfR before conversion.  Both fBhfR and fBlfR modifiers
are ignored on all other conversions.
.SH EXAMPLES
Convert the output of fBtimefR into seconds to an accuracy of
hundredths of a second:
.CS
set us [lindex [time $someTclCode] 0]
puts [fBformatfR "%.2f seconds to execute" [expr {$us / 1e6}]]
.CE
.PP
Create a packed X11 literal color specification:
.CS
# Each color-component should be in range (0..255)
set color [fBformatfR "#%02x%02x%02x" $r $g $b]
.CE
.PP
Use XPG3 format codes to allow reordering of fields (a technique that
is often used in localized message catalogs; see fBmsgcatfR) without
reordering the data values passed to fBformatfR:
.CS
set fmt1 "Today, %d shares in %s were bought at $%.2f each"
puts [fBformatfR $fmt1 123 "Global BigCorp" 19.37]
set fmt2 "Bought %2\$s equity ($%3$.2f x %1\$d) today"
puts [fBformatfR $fmt2 123 "Global BigCorp" 19.37]
.CE
.PP
Print a small table of powers of three:
.CS
# Set up the column widths
set w1 5
set w2 10
# Make a nice header (with separator) for the table first
set sep +-[string repeat - $w1]-+-[string repeat - $w2]-+
puts $sep
puts [fBformatfR "| %-*s | %-*s |" $w1 "Index" $w2 "Power"]
puts $sep
# Print the contents of the table
set p 1
for {set i 0} {$i<=20} {incr i} {
   puts [fBformatfR "| %*d | %*ld |" $w1 $i $w2 $p]
   set p [expr {wide($p) * 3}]
}
# Finish off by printing the separator again
puts $sep
.CE
.SH "SEE ALSO"
scan(n), sprintf(3), string(n)
.SH KEYWORDS
conversion specifier, format, sprintf, string, substitution

						