2 '\" Copyright (c
) 1993 The Regents of the University of California
.
3 '\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of
this file
, and for a DISCLAIMER OF ALL WARRANTIES
.
8 '\" RCS
: @
(#) $Id: switch.n,v 1.1 2003/12/20 03:31:54 bbbush Exp $
10 '\" The definitions below are
for supplemental macros used
in Tcl
/Tk
13 '\" .AP type name in/out ?indent?
14 '\" Start paragraph describing an argument to a library procedure
.
15 '\" type is type of argument (int, etc.), in/out is either "in", "out",
16 '\" or
"in/out" to describe whether procedure reads or modifies arg
,
17 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
18 '\" needed; use .AS below instead)
21 '\" Give maximum sizes of arguments
for setting tab stops
. Type
and
22 '\" name are examples of largest possible arguments that will be passed
23 '\" to
.AP later
. If args are omitted
, default tab stops are used
.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed
in one large box
.
30 '\" End of box enclosure.
33 '\" Begin code excerpt
.
38 '\" .VS ?version? ?br?
39 '\" Begin vertical sidebar
, for use
in marking newly
-changed parts
40 '\" of man pages. The first argument is ignored and used for recording
41 '\" the version
when the
.VS was added
, so that the sidebars can be
42 '\" found and removed when they reach a certain age. If another argument
43 '\" is present
, then a line break is forced before starting the sidebar
.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display
.
52 '\" End of indented unfilled display.
55 '\" Start of
list of standard options
for a Tk widget
. The
56 '\" options follow on successive lines, in four columns separated
60 '\" End of list of standard options for a Tk widget.
62 '\" .OP cmdName dbName dbClass
63 '\" Start of description of a specific option
. cmdName gives the
64 '\" option's name
as specified
in the
class command
, dbName gives
65 '\" the option's name
in the option database
, and dbClass gives
66 '\" the option's
class in the option database
.
69 '\" Print arg1 underlined, then print arg2 normally.
71 '\" RCS: @(#) $Id: switch.n,v 1.1 2003/12/20 03:31:54 bbbush Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2
"" .TP
\\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1
'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2
'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l
'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\
(ul
'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box
if the box started on an earlier page
.
131 \h
'-1.5n'\L
'|\\n(^yu-1v'\l
'\\n(^lu+3n\(ul'\L
'\\n(^tu+1v-\\n(^yu'\l
'|0u-1.5n\(ul'
134 \h
'-1.5n'\L
'|\\n(^yu-1v'\h
'\\n(^lu+3n'\L
'\\n(^tu+1v-\\n(^yu'\l
'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter
)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
165 '\" # Special macro to handle page bottom: finish off current
166 '\" # box/sidebar if in box/sidebar mode, then invoked standard
167 '\" # page bottom macro.
174 .\" Draw three-sided box if this is the box's first page,
175 .\" draw two sides but no top otherwise.
176 .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
177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
180 .nr ^x \\n(^tu+1v-\\n(^Yu
181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS
"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH switch n 7.0 Tcl "Tcl Built
-In Commands
"
248 '\" Note: do not modify the .SH NAME line immediately below!
250 switch \- Evaluate one of several scripts, depending on a given value
252 \fBswitch \fR?\fIoptions\fR?\fI string pattern body \fR?\fIpattern body \fR...?
254 \fBswitch \fR?\fIoptions\fR?\fI string \fR{\fIpattern body \fR?\fIpattern body \fR...?}
259 The \fBswitch\fR command matches its \fIstring\fR argument against each of
260 the \fIpattern\fR arguments in order.
261 As soon as it finds a \fIpattern\fR that matches \fIstring\fR it
262 evaluates the following \fIbody\fR argument by passing it recursively
263 to the Tcl interpreter and returns the result of that evaluation.
264 If the last \fIpattern\fR argument is \fBdefault\fR then it matches
266 If no \fIpattern\fR argument
267 matches \fIstring\fR and no default is given, then the \fBswitch\fR
268 command returns an empty string.
270 If the initial arguments to \fBswitch\fR start with \fB\-\fR then
271 they are treated as options. The following options are
275 Use exact matching when comparing \fIstring\fR to a pattern. This
279 When matching \fIstring\fR to the patterns, use glob-style matching
280 (i.e. the same as implemented by the \fBstring match\fR command).
283 When matching \fIstring\fR to the patterns, use regular
285 (as described in the \fBre_syntax\fR reference page).
288 Marks the end of options. The argument following this one will
289 be treated as \fIstring\fR even if it starts with a \fB\-\fR.
291 Two syntaxes are provided for the \fIpattern\fR and \fIbody\fR arguments.
292 The first uses a separate argument for each of the patterns and commands;
293 this form is convenient if substitutions are desired on some of the
294 patterns or commands.
295 The second form places all of the patterns and commands together into
296 a single argument; the argument must have proper list structure, with
297 the elements of the list being the patterns and commands.
298 The second form makes it easy to construct multi-line switch commands,
299 since the braces around the whole list make it unnecessary to include a
300 backslash at the end of each line.
301 Since the \fIpattern\fR arguments are in braces in the second form,
302 no command or variable substitutions are performed on them; this makes
303 the behavior of the second form different than the first form in some
306 If a \fIbody\fR is specified as ``\fB\-\fR'' it means that the \fIbody\fR
307 for the next pattern should also be used as the body for this
308 pattern (if the next pattern also has a body of ``\fB\-\fR''
309 then the body after that is used, and so on).
310 This feature makes it possible to share a single \fIbody\fR among
313 Beware of how you place comments in \fBswitch\fR commands. Comments
314 should only be placed \fBinside\fR the execution body of one of the
315 patterns, and not intermingled with the patterns.
317 Below are some examples of \fBswitch\fR commands:
319 \fBswitch\0abc\0a\0\-\0b\0{format 1}\0abc\0{format 2}\0default\0{format 3}\fR
323 \fBswitch\0\-regexp\0aaab {
330 will return \fB1\fR, and
337 # Correct Comment Placement
349 for(n), if(n), regexp(n)
352 switch, match, regular expression