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

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1998 Sun Microsystems, Inc.
  3. '"
  4. '" See the file "license.terms" for information on usage and redistribution
  5. '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  6. '" 
  7. '" RCS: @(#) $Id: regexp.n,v 1.12.2.1 2004/10/27 14:23:57 dkf Exp $
  8. '" 
  9. .so man.macros
  10. .TH regexp n 8.3 Tcl "Tcl Built-In Commands"
  11. .BS
  12. '" Note:  do not modify the .SH NAME line immediately below!
  13. .SH NAME
  14. regexp - Match a regular expression against a string
  15. .SH SYNOPSIS
  16. fBregexp fR?fIswitchesfR? fIexp string fR?fImatchVarfR? ?fIsubMatchVar subMatchVar ...fR?
  17. .BE
  18. .SH DESCRIPTION
  19. .PP
  20. Determines whether the regular expression fIexpfR matches part or
  21. all of fIstringfR and returns 1 if it does, 0 if it doesn't, unless
  22. fB-inlinefR is specified (see below).
  23. (Regular expression matching is described in the fBre_syntaxfR
  24. reference page.)
  25. .LP
  26. If additional arguments are specified after fIstringfR then they
  27. are treated as the names of variables in which to return
  28. information about which part(s) of fIstringfR matched fIexpfR.
  29. fIMatchVarfR will be set to the range of fIstringfR that
  30. matched all of fIexpfR.  The first fIsubMatchVarfR will contain
  31. the characters in fIstringfR that matched the leftmost parenthesized
  32. subexpression within fIexpfR, the next fIsubMatchVarfR will
  33. contain the characters that matched the next parenthesized
  34. subexpression to the right in fIexpfR, and so on.
  35. .PP
  36. If the initial arguments to fBregexpfR start with fB-fR then
  37. they are treated as switches.  The following switches are
  38. currently supported:
  39. .TP 15
  40. fB-aboutfR
  41. Instead of attempting to match the regular expression, returns a list
  42. containing information about the regular expression.  The first
  43. element of the list is a subexpression count.  The second element is a
  44. list of property names that describe various attributes of the regular
  45. expression. This switch is primarily intended for debugging purposes.
  46. .TP 15
  47. fB-expandedfR
  48. Enables use of the expanded regular expression syntax where
  49. whitespace and comments are ignored.  This is the same as specifying
  50. the fB(?x)fR embedded option (see the fBre_syntaxfR manual page).
  51. .TP 15
  52. fB-indicesfR
  53. Changes what is stored in the fIsubMatchVarfRs. 
  54. Instead of storing the matching characters from fIstringfR,
  55. each variable
  56. will contain a list of two decimal strings giving the indices
  57. in fIstringfR of the first and last characters in the matching
  58. range of characters.
  59. .TP 15
  60. fB-linefR
  61. Enables newline-sensitive matching.  By default, newline is a
  62. completely ordinary character with no special meaning.  With this
  63. flag, `[^' bracket expressions and `.' never match newline, `^'
  64. matches an empty string after any newline in addition to its normal
  65. function, and `$' matches an empty string before any newline in
  66. addition to its normal function.  This flag is equivalent to
  67. specifying both fB-linestopfR and fB-lineanchorfR, or the
  68. fB(?n)fR embedded option (see the fBre_syntaxfR manual page).
  69. .TP 15
  70. fB-linestopfR
  71. Changes the behavior of `[^' bracket expressions and `.' so that they
  72. stop at newlines.  This is the same as specifying the fB(?p)fR
  73. embedded option (see the fBre_syntaxfR manual page).
  74. .TP 15
  75. fB-lineanchorfR
  76. Changes the behavior of `^' and `$' (the ``anchors'') so they match the
  77. beginning and end of a line respectively.  This is the same as
  78. specifying the fB(?w)fR embedded option (see the fBre_syntaxfR
  79. manual page).
  80. .TP 15
  81. fB-nocasefR
  82. Causes upper-case characters in fIstringfR to be treated as
  83. lower case during the matching process.
  84. .VS 8.3
  85. .TP 15
  86. fB-allfR
  87. Causes the regular expression to be matched as many times as possible
  88. in the string, returning the total number of matches found.  If this
  89. is specified with match variables, they will contain information for
  90. the last match only.
  91. .TP 15
  92. fB-inlinefR
  93. Causes the command to return, as a list, the data that would otherwise
  94. be placed in match variables.  When using fB-inlinefR,
  95. match variables may not be specified.  If used with fB-allfR, the
  96. list will be concatenated at each iteration, such that a flat list is
  97. always returned.  For each match iteration, the command will append the
  98. overall match data, plus one element for each subexpression in the
  99. regular expression.  Examples are:
  100. .CS
  101.     regexp -inline -- {\w(\w)} " inlined "
  102.  => {in n}
  103.     regexp -all -inline -- {\w(\w)} " inlined "
  104.  => {in n li i ne e}
  105. .CE
  106. .TP 15
  107. fB-startfR fIindexfR
  108. Specifies a character index offset into the string to start
  109. matching the regular expression at.  When using this switch, `^'
  110. will not match the beginning of the line, and \A will still
  111. match the start of the string at fIindexfR.  If fB-indicesfR
  112. is specified, the indices will be indexed starting from the
  113. absolute beginning of the input string.
  114. fIindexfR will be constrained to the bounds of the input string.
  115. .VE 8.3
  116. .TP 15
  117. fB-|-fR
  118. Marks the end of switches.  The argument following this one will
  119. be treated as fIexpfR even if it starts with a fB-fR.
  120. .PP
  121. If there are more fIsubMatchVarfR's than parenthesized
  122. subexpressions within fIexpfR, or if a particular subexpression
  123. in fIexpfR doesn't match the string (e.g. because it was in a
  124. portion of the expression that wasn't matched), then the corresponding
  125. fIsubMatchVarfR will be set to ``fB-1 -1fR'' if fB-indicesfR
  126. has been specified or to an empty string otherwise.
  127. .SH EXAMPLES
  128. Find the first occurrence of a word starting with fBfoofR in a
  129. string that is not actually an instance of fBfoobarfR, and get the
  130. letters following it up to the end of the word into a variable:
  131. .CS
  132. fBregexpfR {\<foo(?!bar\>)(\w*)} $string -> restOfWord
  133. .CE
  134. Note that the whole matched substring has been placed in the variable
  135. fB->fR which is a name chosen to look nice given that we are not
  136. actually interested in its contents.
  137. .PP
  138. Find the index of the word fBbadgerfR (in any case) within a string
  139. and store that in the variable fBlocationfR:
  140. .CS
  141. fBregexpfR -indices {(?i)\<badger\>} $string location
  142. .CE
  143. .PP
  144. Count the number of octal digits in a string:
  145. .CS
  146. fBregexpfR -all {[0-7]} $string
  147. .CE
  148. .PP
  149. List all words (consisting of all sequences of non-whitespace
  150. characters) in a string:
  151. .CS
  152. fBregexpfR -all -inline {\S+} $string
  153. .CE
  154. .SH "SEE ALSO"
  155. re_syntax(n), regsub(n)
  156. .SH KEYWORDS
  157. match, regular expression, string