2 '\" Copyright (c) 1997 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: UniCharIsAlpha.3,v 1.2 2001/05/03 23:59:01 hobbs 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_UniCharIsAlpha 3 "8.1" Tcl "Tcl Library Procedures"
248 Tcl_UniCharIsAlnum, Tcl_UniCharIsAlpha, Tcl_UniCharIsControl, Tcl_UniCharIsDigit, Tcl_UniCharIsGraph, Tcl_UniCharIsLower, Tcl_UniCharIsPrint, Tcl_UniCharIsPunct, Tcl_UniCharIsSpace, Tcl_UniCharIsUpper, Tcl_UniCharIsWordChar \- routines for classification of Tcl_UniChar characters
251 \fB#include <tcl.h>\fR
254 \fBTcl_UniCharIsAlnum\fR(\fIch\fR)
257 \fBTcl_UniCharIsAlpha\fR(\fIch\fR)
260 \fBTcl_UniCharIsControl\fR(\fIch\fR)
263 \fBTcl_UniCharIsDigit\fR(\fIch\fR)
266 \fBTcl_UniCharIsGraph\fR(\fIch\fR)
269 \fBTcl_UniCharIsLower\fR(\fIch\fR)
272 \fBTcl_UniCharIsPrint\fR(\fIch\fR)
275 \fBTcl_UniCharIsPunct\fR(\fIch\fR)
278 \fBTcl_UniCharIsSpace\fR(\fIch\fR)
281 \fBTcl_UniCharIsUpper\fR(\fIch\fR)
284 \fBTcl_UniCharIsWordChar\fR(\fIch\fR)
287 The Tcl_UniChar to be examined.
292 All of the routines described examine Tcl_UniChars and return a
293 boolean value. A non-zero return value means that the character does
294 belong to the character class associated with the called routine. The
295 rest of this document just describes the character classes associated
296 with the various routines.
298 Note: A Tcl_UniChar is a Unicode character represented as an unsigned,
301 .SH CHARACTER CLASSES
303 \fBTcl_UniCharIsAlnum\fR tests if the character is an alphanumeric Unicode character.
305 \fBTcl_UniCharIsAlpha\fR tests if the character is an alphabetic Unicode character.
307 \fBTcl_UniCharIsControl\fR tests if the character is a Unicode control character.
309 \fBTcl_UniCharIsDigit\fR tests if the character is a numeric Unicode character.
311 \fBTcl_UniCharIsGraph\fR tests if the character is any Unicode print character except space.
313 \fBTcl_UniCharIsLower\fR tests if the character is a lowercase Unicode character.
315 \fBTcl_UniCharIsPrint\fR tests if the character is a Unicode print character.
317 \fBTcl_UniCharIsPunct\fR tests if the character is a Unicode punctuation character.
319 \fBTcl_UniCharIsSpace\fR tests if the character is a whitespace Unicode character.
321 \fBTcl_UniCharIsUpper\fR tests if the character is an uppercase Unicode character.
323 \fBTcl_UniCharIsWordChar\fR tests if the character is alphanumeric or
324 a connector punctuation mark.
327 unicode, classification