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

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1993 The Regents of the University of California.
  3. '" Copyright (c) 1994-1996 Sun Microsystems, Inc.
  4. '" Copyright (c) 2000 Scriptics Corporation.
  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: regsub.n,v 1.9.2.1 2004/10/27 14:23:58 dkf Exp $
  10. '" 
  11. .so man.macros
  12. .TH regsub n 8.3 Tcl "Tcl Built-In Commands"
  13. .BS
  14. '" Note:  do not modify the .SH NAME line immediately below!
  15. .SH NAME
  16. regsub - Perform substitutions based on regular expression pattern matching
  17. .SH SYNOPSIS
  18. .VS 8.4
  19. fBregsub fR?fIswitchesfR? fIexp string subSpec fR?fIvarNamefR?
  20. .VE 8.4
  21. .BE
  22. .SH DESCRIPTION
  23. .PP
  24. This command matches the regular expression fIexpfR against
  25. fIstringfR,
  26. .VS 8.4
  27. and either copies fIstringfR to the variable whose name is
  28. given by fIvarNamefR or returns fIstringfR if fIvarNamefR is not
  29. present.
  30. .VE 8.4
  31. (Regular expression matching is described in the fBre_syntaxfR
  32. reference page.)
  33. If there is a match, then while copying fIstringfR to fIvarNamefR
  34. .VS 8.4
  35. (or to the result of this command if fIvarNamefR is not present)
  36. .VE 8.4
  37. the portion of fIstringfR that
  38. matched fIexpfR is replaced with fIsubSpecfR.
  39. If fIsubSpecfR contains a ``&'' or ``e0'', then it is replaced
  40. in the substitution with the portion of fIstringfR that
  41. matched fIexpfR.
  42. If fIsubSpecfR contains a ``efInfR'', where fInfR is a digit
  43. between 1 and 9, then it is replaced in the substitution with
  44. the portion of fIstringfR that matched the fInfR-th
  45. parenthesized subexpression of fIexpfR.
  46. Additional backslashes may be used in fIsubSpecfR to prevent special
  47. interpretation of ``&'' or ``e0'' or ``efInfR'' or
  48. backslash.
  49. The use of backslashes in fIsubSpecfR tends to interact badly
  50. with the Tcl parser's use of backslashes, so it's generally
  51. safest to enclose fIsubSpecfR in braces if it includes
  52. backslashes.
  53. .LP
  54. If the initial arguments to fBregsubfR start with fB-fR then
  55. they are treated as switches.  The following switches are
  56. currently supported:
  57. .TP 10
  58. fB-allfR
  59. All ranges in fIstringfR that match fIexpfR are found and
  60. substitution is performed for each of these ranges.
  61. Without this switch only the first
  62. matching range is found and substituted.
  63. If fB-allfR is specified, then ``&'' and ``efInfR''
  64. sequences are handled for each substitution using the information
  65. from the corresponding match.
  66. .TP 15
  67. fB-expandedfR
  68. Enables use of the expanded regular expression syntax where
  69. whitespace and comments are ignored.  This is the same as specifying
  70. the fB(?x)fR embedded option (see the fBre_syntaxfR manual page).
  71. .TP 15
  72. fB-linefR
  73. Enables newline-sensitive matching.  By default, newline is a
  74. completely ordinary character with no special meaning.  With this
  75. flag, `[^' bracket expressions and `.' never match newline, `^'
  76. matches an empty string after any newline in addition to its normal
  77. function, and `$' matches an empty string before any newline in
  78. addition to its normal function.  This flag is equivalent to
  79. specifying both fB-linestopfR and fB-lineanchorfR, or the
  80. fB(?n)fR embedded option (see the fBre_syntaxfR manual page).
  81. .TP 15
  82. fB-linestopfR
  83. Changes the behavior of `[^' bracket expressions and `.' so that they
  84. stop at newlines.  This is the same as specifying the fB(?p)fR
  85. embedded option (see the fBre_syntaxfR manual page).
  86. .TP 15
  87. fB-lineanchorfR
  88. Changes the behavior of `^' and `$' (the ``anchors'') so they match the
  89. beginning and end of a line respectively.  This is the same as
  90. specifying the fB(?w)fR embedded option (see the fBre_syntaxfR
  91. manual page).
  92. .TP 10
  93. fB-nocasefR
  94. Upper-case characters in fIstringfR will be converted to lower-case
  95. before matching against fIexpfR;  however, substitutions specified
  96. by fIsubSpecfR use the original unconverted form of fIstringfR.
  97. .TP 10
  98. fB-startfR fIindexfR
  99. Specifies a character index offset into the string to start
  100. matching the regular expression at.  When using this switch, `^'
  101. will not match the beginning of the line, and \A will still
  102. match the start of the string at fIindexfR.
  103. fIindexfR will be constrained to the bounds of the input string.
  104. .TP 10
  105. fB-|-fR
  106. Marks the end of switches.  The argument following this one will
  107. be treated as fIexpfR even if it starts with a fB-fR.
  108. .PP
  109. .VS 8.4
  110. If fIvarNamefR is supplied, the command returns a count of the
  111. number of matching ranges that were found and replaced, otherwise the
  112. string after replacement is returned.
  113. .VE 8.4
  114. See the manual entry for fBregexpfR for details on the interpretation
  115. of regular expressions.
  116. .SH EXAMPLES
  117. Replace (in the string in variable fIstringfR) every instance of
  118. fBfoofR which is a word by itself with fBbarfR:
  119. .CS
  120. fBregsubfR -all {e<fooe>} $string bar string
  121. .CE
  122. .PP
  123. Insert double-quotes around the first instance of the word
  124. fBinterestingfR, however it is capitalised.
  125. .CS
  126. fBregsubfR -nocase {e<interestinge>} $string {"&"} string
  127. .CE
  128. .PP
  129. Convert all non-ASCII and Tcl-significant characters into eu escape
  130. sequences by using fBregsubfR and fBsubstfR in combination:
  131. .CS
  132. # This RE is just a character class for everything "bad"
  133. set RE {[][{}e$eseu0100-euffff]}
  134. # We will substitute with a fragment of Tcl script in brackets
  135. set substitution {[format eeeeu%04x [scan "ee&" %c]]}
  136. # Now we apply the substitution to get a subst-string that
  137. # will perform the computational parts of the conversion.
  138. set quoted [subst [fBregsubfR -all $RE $string $substitution]]
  139. .CE
  140. .SH "SEE ALSO"
  141. regexp(n), re_syntax(n), subst(n)
  142. .SH KEYWORDS
  143. match, pattern, regular expression, substitute