2 '\" Copyright (c) 1997 by Sun Microsystems, Inc.
4 '\" See the file "license.terms" for information on usage and redistribution
5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7 '\" RCS: @(#) $Id: ToUpper.3,v 1.2 1999/04/16 00:46:33 stanton Exp $
9 '\" The definitions below are for supplemental macros used in Tcl/Tk
12 '\" .AP type name in/out ?indent?
13 '\" Start paragraph describing an argument to a library procedure.
14 '\" type is type of argument (int, etc.), in/out is either "in", "out",
15 '\" or "in/out" to describe whether procedure reads or modifies arg,
16 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
17 '\" needed; use .AS below instead)
20 '\" Give maximum sizes of arguments for setting tab stops. Type and
21 '\" name are examples of largest possible arguments that will be passed
22 '\" to .AP later. If args are omitted, default tab stops are used.
25 '\" Start box enclosure. From here until next .BE, everything will be
26 '\" enclosed in one large box.
29 '\" End of box enclosure.
32 '\" Begin code excerpt.
37 '\" .VS ?version? ?br?
38 '\" Begin vertical sidebar, for use in marking newly-changed parts
39 '\" of man pages. The first argument is ignored and used for recording
40 '\" the version when the .VS was added, so that the sidebars can be
41 '\" found and removed when they reach a certain age. If another argument
42 '\" is present, then a line break is forced before starting the sidebar.
45 '\" End of vertical sidebar.
48 '\" Begin an indented unfilled display.
51 '\" End of indented unfilled display.
54 '\" Start of list of standard options for a Tk widget. The
55 '\" options follow on successive lines, in four columns separated
59 '\" End of list of standard options for a Tk widget.
61 '\" .OP cmdName dbName dbClass
62 '\" Start of description of a specific option. cmdName gives the
63 '\" option's name as specified in the class command, dbName gives
64 '\" the option's name in the option database, and dbClass gives
65 '\" the option's class in the option database.
68 '\" Print arg1 underlined, then print arg2 normally.
70 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
72 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
76 '\" # Start an argument description
80 . ie !"\\$2"" .TP \\n()Cu
85 \&\\$1 \\fI\\$2\\fP (\\$3)
98 '\" # define tabbing values for .AP
101 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
104 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
105 .nr )C \\n()Bu+\\w'(in/out)'u+2n
107 .AS Tcl_Interp Tcl_CreateInterp in/out
108 '\" # BS - start boxed text
109 '\" # ^y = starting y location
117 .if n \l'\\n(.lu\(ul'
120 '\" # BE - end boxed text (draw box now)
125 .ie n \l'\\n(^lu\(ul'
127 .\" Draw four-sided box normally, but don't draw top of
128 .\" box if the box started on an earlier page.
130 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
133 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
140 '\" # VS - start vertical sidebar
141 '\" # ^Y = starting y location
142 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
146 .ie n 'mc \s12\(br\s0
149 '\" # VE - end of vertical sidebar
157 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
164 '\" # Special macro to handle page bottom: finish off current
165 '\" # box/sidebar if in box/sidebar mode, then invoked standard
166 '\" # page bottom macro.
173 .\" Draw three-sided box if this is the box's first page,
174 .\" draw two sides but no top otherwise.
175 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
176 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
179 .nr ^x \\n(^tu+1v-\\n(^Yu
180 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
193 '\" # DS - begin display
199 '\" # DE - end display
205 '\" # SO - start of list of standard options
207 .SH "STANDARD OPTIONS"
213 '\" # SE - end of list of standard options
218 See the \\fBoptions\\fR manual entry for details on the standard options.
220 '\" # OP - start of full description for a single option
225 Command-Line Name: \\fB\\$1\\fR
226 Database Name: \\fB\\$2\\fR
227 Database Class: \\fB\\$3\\fR
231 '\" # CS - begin code excerpt
237 '\" # CE - end code excerpt
245 .TH Tcl_UtfToUpper 3 "8.1" Tcl "Tcl Library Procedures"
248 Tcl_UniCharToUpper, Tcl_UniCharToLower, Tcl_UniCharToTitle, Tcl_UtfToUpper, Tcl_UtfToLower, Tcl_UtfToTitle \- routines for manipulating the case of Unicode characters and UTF-8 strings.
251 \fB#include <tcl.h>\fR
254 \fBTcl_UniCharToUpper\fR(\fIch\fR)
257 \fBTcl_UniCharToLower\fR(\fIch\fR)
260 \fBTcl_UniCharToTitle\fR(\fIch\fR)
263 \fBTcl_UtfToUpper\fR(\fIstr\fR)
266 \fBTcl_UtfToLower\fR(\fIstr\fR)
269 \fBTcl_UtfToTitle\fR(\fIstr\fR)
273 The Tcl_UniChar to be converted.
275 Pointer to UTF-8 string to be converted in place.
280 The first three routines convert the case of individual Unicode characters:
282 If \fIch\fR represents a lower-case character,
283 \fBTcl_UniCharToUpper\fR returns the corresponding upper-case
284 character. If no upper-case character is defined, it returns the
287 If \fIch\fR represents an upper-case character,
288 \fBTcl_UniCharToLower\fR returns the corresponding lower-case
289 character. If no lower-case character is defined, it returns the
292 If \fIch\fR represents a lower-case character,
293 \fBTcl_UniCharToTitle\fR returns the corresponding title-case
294 character. If no title-case character is defined, it returns the
295 corresponding upper-case character. If no upper-case character is
296 defined, it returns the character unchanged. Title-case is defined
297 for a small number of characters that have a different appearance when
298 they are at the beginning of a capitalized word.
300 The next three routines convert the case of UTF-8 strings in place in
303 \fBTcl_UtfToUpper\fR changes every UTF-8 character in \fIstr\fR to
304 upper-case. Because changing the case of a character may change its
305 size, the byte offset of each character in the resulting string may
306 differ from its original location. \fBTcl_UtfToUpper\fR writes a null
307 byte at the end of the converted string. \fBTcl_UtfToUpper\fR returns
308 the new length of the string in bytes. This new length is guaranteed
309 to be no longer than the original string length.
311 \fBTcl_UtfToLower\fR is the same as \fBTcl_UtfToUpper\fR except it
312 turns each character in the string into its lower-case equivalent.
314 \fBTcl_UtfToTitle\fR is the same as \fBTcl_UtfToUpper\fR except it
315 turns the first character in the string into its title-case equivalent
316 and all following characters into their lower-case equivalents.
320 At this time, the case conversions are only defined for the ISO8859-1
321 characters. Unicode characters above 0x00ff are not modified by these
325 utf, unicode, toupper, tolower, totitle, case