home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tcl2-73c.zip / tcl7.3 / doc / case.n < prev    next >
Text File  |  1993-06-17  |  3KB  |  73 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/case.n,v 1.3 93/06/17 11:29:59 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS case tcl 7.0
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. case \- Evaluate one of several scripts, depending on a given value
  29. .SH SYNOPSIS
  30. \fBcase\fI string \fR?\fBin\fR? \fIpatList body \fR?\fIpatList body \fR...?
  31. .br
  32. \fBcase\fI string \fR?\fBin\fR? {\fIpatList body \fR?\fIpatList body \fR...?}
  33. .BE
  34.  
  35. .SH DESCRIPTION
  36. .PP
  37. \fINote: the \fBcase\fI command is obsolete and is supported only
  38. for backward compatibility.  At some point in the future it may be
  39. removed entirely.  You should use the \fBswitch\fI command instead.\fR
  40. .PP
  41. The \fBcase\fR command matches \fIstring\fR against each of
  42. the \fIpatList\fR arguments in order.
  43. Each \fIpatList\fR argument is a list of one or
  44. more patterns.  If any of these patterns matches \fIstring\fR then
  45. \fBcase\fR evaluates the following \fIbody\fR argument
  46. by passing it recursively to the Tcl interpreter and returns the result
  47. of that evaluation.
  48. Each \fIpatList\fR argument consists of a single
  49. pattern or list of patterns.  Each pattern may contain any of the wild-cards
  50. described under \fBstring match\fR.  If a \fIpatList\fR
  51. argument is \fBdefault\fR, the corresponding body will be evaluated
  52. if no \fIpatList\fR matches \fIstring\fR.  If no \fIpatList\fR argument
  53. matches \fIstring\fR and no default is given, then the \fBcase\fR
  54. command returns an empty string.
  55. .PP
  56. Two syntaxes are provided for the \fIpatList\fR and \fIbody\fR arguments.
  57. The first uses a separate argument for each of the patterns and commands;
  58. this form is convenient if substitutions are desired on some of the
  59. patterns or commands.
  60. The second form places all of the patterns and commands together into
  61. a single argument; the argument must have proper list structure, with
  62. the elements of the list being the patterns and commands.
  63. The second form makes it easy to construct multi-line case commands,
  64. since the braces around the whole list make it unnecessary to include a
  65. backslash at the end of each line.
  66. Since the \fIpatList\fR arguments are in braces in the second form,
  67. no command or variable substitutions are performed on them;  this makes
  68. the behavior of the second form different than the first form in some
  69. cases.
  70.  
  71. .SH KEYWORDS
  72. case, match, regular expression
  73.