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

通讯编程

开发平台:

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) 2001 Kevin B. Kenny.  All rights reserved.
  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: lsearch.n,v 1.13.2.4 2005/01/05 21:53:30 dkf Exp $
  10. '" 
  11. .so man.macros
  12. .TH lsearch n 8.4 Tcl "Tcl Built-In Commands"
  13. .BS
  14. '" Note:  do not modify the .SH NAME line immediately below!
  15. .SH NAME
  16. lsearch - See if a list contains a particular element
  17. .SH SYNOPSIS
  18. fBlsearch fR?fIoptionsfR? fIlist patternfR
  19. .BE
  20. .SH DESCRIPTION
  21. .PP
  22. This command searches the elements of fIlistfR to see if one
  23. of them matches fIpatternfR.  If so, the command returns the index
  24. of the first matching element
  25. .VS 8.4
  26. (unless the options fB-allfR or fB-inlinefR are specified.)
  27. .VE 8.4
  28. If not, the command returns fB-1fR.  The fIoptionfR arguments
  29. indicates how the elements of the list are to be matched against
  30. fIpatternfR and it must have one of the following values:
  31. .TP
  32. fB-allfR
  33. .VS 8.4
  34. Changes the result to be the list of all matching indices (or all
  35. matching values if fB-inlinefR is specified as well.)
  36. .VE 8.4
  37. .TP
  38. fB-asciifR
  39. The list elements are to be examined as Unicode strings (the name is
  40. for backward-compatability reasons.)  This option is only meaningful
  41. when used with fB-exactfR or fB-sortedfR.
  42. .TP
  43. fB-decreasingfR
  44. The list elements are sorted in decreasing order.  This option is only
  45. meaningful when used with fB-sortedfR.
  46. .TP
  47. fB-dictionaryfR
  48. The list elements are to be compared using dictionary-style
  49. comparisons (see fBlsortfR for a fuller description).  This option
  50. is only meaningful when used with fB-exactfR or fB-sortedfR, and
  51. it is only distinguishable from the fB-asciifR option when
  52. the fB-sortedfR option is given, because values are only
  53. dictionary-equal when exactly equal.
  54. .TP
  55. fB-exactfR
  56. The list element must contain exactly the same string as fIpatternfR.
  57. .TP
  58. fB-globfR
  59. fIPatternfR is a glob-style pattern which is matched against each list
  60. element using the same rules as the fBstring matchfR command.
  61. .TP
  62. fB-increasingfR
  63. The list elements are sorted in increasing order.  This option is only
  64. meaningful when used with fB-sortedfR.
  65. .TP
  66. fB-inlinefR
  67. .VS 8.4
  68. The matching value is returned instead of its index (or an empty
  69. string if no value matches.)  If fB-allfR is also specified, then
  70. the result of the command is the list of all values that matched.
  71. .VE 8.4
  72. .TP
  73. fB-integerfR
  74. The list elements are to be compared as integers.  This option is only
  75. meaningful when used with fB-exactfR or fB-sortedfR.
  76. .TP
  77. fB-notfR
  78. .VS 8.4
  79. This negates the sense of the match, returning the index of the first
  80. non-matching value in the list.
  81. .VE 8.4
  82. .TP
  83. fB-realfR
  84. The list elements are to be compared as floating-point values.  This
  85. option is only meaningful when used with fB-exactfR or fB-sortedfR.
  86. .TP
  87. fB-regexpfR
  88. fIPatternfR is treated as a regular expression and matched against
  89. each list element using the rules described in the fBre_syntaxfR
  90. reference page.
  91. .TP
  92. fB-sortedfR
  93. The list elements are in sorted order.  If this option is specified,
  94. fBlsearchfR will use a more efficient searching algorithm to search
  95. fIlistfR.  If no other options are specified, fIlistfR is assumed
  96. to be sorted in increasing order, and to contain ASCII strings.  This
  97. option is mutually exclusive with fB-globfR and fB-regexpfR, and
  98. is treated exactly like fB-exactfR when either fB-allfR, or
  99. fB-notfR is specified.
  100. .TP
  101. fB-startfR fIindexfR
  102. .VS 8.4
  103. The list is searched starting at position fIindexfR.  If fIindexfR
  104. has the value fBendfR, it refers to the last element in the list,
  105. and fBend-fIintegerfR refers to the last element in the list minus
  106. the specified integer offset.
  107. .VE 8.4
  108. .PP
  109. If fIoptionfR is omitted then it defaults to fB-globfR.  If more
  110. than one of fB-exactfR, fB-globfR, fB-regexpfR, and
  111. fB-sortedfR is specified, whichever option is specified last takes
  112. precedence.  If more than one of fB-asciifR, fB-dictionaryfR,
  113. fB-integerfR and fB-realfR is specified, the option specified
  114. last takes precedence.  If more than one of fB-increasingfR and
  115. fB-decreasingfR is specified, the option specified last takes
  116. precedence.
  117. .VS 8.4
  118. .SH EXAMPLES
  119. .CS
  120. fBlsearchfR {a b c d e} c fI=> 2fR
  121. fBlsearchfR -all {a b c a b c} c fI=> 2 5fR
  122. fBlsearchfR -inline {a20 b35 c47} b* fI=> b35fR
  123. fBlsearchfR -inline -not {a20 b35 c47} b* fI=> a20fR
  124. fBlsearchfR -all -inline -not {a20 b35 c47} b* fI=> a20 c47fR
  125. fBlsearchfR -all -not {a20 b35 c47} b* fI=> 0 2fR
  126. fBlsearchfR -start 3 {a b c a b c} c fI=> 5fR
  127. .CE
  128. .VE 8.4
  129. .SH "SEE ALSO"
  130. .VS 8.4
  131. foreach(n), list(n), lappend(n), lindex(n), linsert(n), llength(n), 
  132. lset(n), lsort(n), lrange(n), lreplace(n)
  133. .VE
  134. .SH KEYWORDS
  135. list, match, pattern, regular expression, search, string
  136. '" Local Variables:
  137. '" mode: nroff
  138. '" End: