subst.n
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:5k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1994 The Regents of the University of California.
  3. '" Copyright (c) 1994-1996 Sun Microsystems, Inc.
  4. '" Copyright (c) 2001 Donal K. Fellows
  5. '"
  6. '" See the file "license.terms" for information on usage and redistribution
  7. '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  8. '" 
  9. '" RCS: @(#) $Id: subst.n,v 1.5.2.1 2004/10/27 14:23:58 dkf Exp $
  10. '" 
  11. .so man.macros
  12. .TH subst n 7.4 Tcl "Tcl Built-In Commands"
  13. .BS
  14. '" Note:  do not modify the .SH NAME line immediately below!
  15. .SH NAME
  16. subst - Perform backslash, command, and variable substitutions
  17. .SH SYNOPSIS
  18. fBsubst fR?fB-nobackslashesfR? ?fB-nocommandsfR? ?fB-novariablesfR? fIstringfR
  19. .BE
  20. .SH DESCRIPTION
  21. .PP
  22. This command performs variable substitutions, command substitutions,
  23. and backslash substitutions on its fIstringfR argument and
  24. returns the fully-substituted result.
  25. The substitutions are performed in exactly the same way as for
  26. Tcl commands.
  27. As a result, the fIstringfR argument is actually substituted twice,
  28. once by the Tcl parser in the usual fashion for Tcl commands, and
  29. again by the fIsubstfR command.
  30. .PP
  31. If any of the fB-nobackslashesfR, fB-nocommandsfR, or
  32. fB-novariablesfR are specified, then the corresponding substitutions
  33. are not performed.
  34. For example, if fB-nocommandsfR is specified, command substitution
  35. is not performed:  open and close brackets are treated as ordinary characters
  36. with no special interpretation.
  37. .PP
  38. .VS 8.4
  39. Note that the substitution of one kind can include substitution of 
  40. other kinds.  For example, even when the fB-novariablesfR option
  41. is specified, command substitution is performed without restriction.
  42. This means that any variable substitution necessary to complete the
  43. command substitution will still take place.  Likewise, any command
  44. substitution necessary to complete a variable substitution will
  45. take place, even when fB-nocommandsfR is specified.  See the
  46. EXAMPLES below.
  47. .PP
  48. If an error occurs during substitution, then fBsubstfR will return
  49. that error.  If a break exception occurs during command or variable
  50. substitution, the result of the whole substitution will be the
  51. string (as substituted) up to the start of the substitution that
  52. raised the exception.  If a continue exception occurs during the
  53. evaluation of a command or variable substitution, an empty string
  54. will be substituted for that entire command or variable substitution
  55. (as long as it is well-formed Tcl.)  If a return exception occurs,
  56. or any other return code is returned during command or variable
  57. substitution, then the returned value is substituted for that
  58. substitution.  See the EXAMPLES below.  In this way, all exceptional
  59. return codes are ``caught'' by fBsubstfR.  The fBsubstfR command
  60. itself will either return an error, or will complete successfully.
  61. .VE
  62. .SH EXAMPLES
  63. .PP
  64. When it performs its substitutions, fIsubstfR does not give any
  65. special treatment to double quotes or curly braces (except within
  66. command substitutions) so the script
  67. .CS
  68. set a 44
  69. fBsubstfR {xyz {$a}}
  70. .CE
  71. returns ``fBxyz {44}fR'', not ``fBxyz {$a}fR''
  72. .VS 8.4
  73. and the script
  74. .CS
  75. set a "p\} q \{r"
  76. fBsubstfR {xyz {$a}}
  77. .CE
  78. return ``fBxyz {p} q {r}fR'', not ``fBxyz {p\} q \{r}fR''.
  79. .PP
  80. When command substitution is performed, it includes any variable
  81. substitution necessary to evaluate the script.  
  82. .CS
  83. set a 44
  84. fBsubstfR -novariables {$a [format $a]}
  85. .CE
  86. returns ``fB$a 44fR'', not ``fB$a $afR''.  Similarly, when
  87. variable substitution is performed, it includes any command
  88. substitution necessary to retrieve the value of the variable.
  89. .CS
  90. proc b {} {return c}
  91. array set a {c c [b] tricky}
  92. fBsubstfR -nocommands {[b] $a([b])}
  93. .CE
  94. returns ``fB[b] cfR'', not ``fB[b] trickyfR''.
  95. .PP
  96. The continue and break exceptions allow command substitutions to
  97. prevent substitution of the rest of the command substitution and the
  98. rest of fIstringfR respectively, giving script authors more options
  99. when processing text using fIsubstfR.  For example, the script
  100. .CS
  101. fBsubstfR {abc,[break],def}
  102. .CE
  103. returns ``fBabc,fR'', not ``fBabc,,deffR'' and the script
  104. .CS
  105. fBsubstfR {abc,[continue;expr 1+2],def}
  106. .CE
  107. returns ``fBabc,,deffR'', not ``fBabc,3,deffR''.
  108. .PP
  109. Other exceptional return codes substitute the returned value
  110. .CS
  111. fBsubstfR {abc,[return foo;expr 1+2],def}
  112. .CE
  113. returns ``fBabc,foo,deffR'', not ``fBabc,3,deffR'' and
  114. .CS
  115. fBsubstfR {abc,[return -code 10 foo;expr 1+2],def}
  116. .CE
  117. also returns ``fBabc,foo,deffR'', not ``fBabc,3,deffR''.
  118. .VE
  119. .SH "SEE ALSO"
  120. Tcl(n), eval(n), break(n), continue(n)
  121. .SH KEYWORDS
  122. backslash substitution, command substitution, variable substitution