| '\" |
| '\" Copyright (c) 1993 The Regents of the University of California. |
| '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
| '\" Copyright (c) 2001 Kevin B. Kenny. All rights reserved. |
| '\" |
| '\" See the file "license.terms" for information on usage and redistribution |
| '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| '\" |
| '\" RCS: @(#) $Id: lsearch.n,v 1.13 2002/10/03 13:08:55 dkf Exp $ |
| '\" |
| '\" The definitions below are for supplemental macros used in Tcl/Tk |
| '\" manual entries. |
| '\" |
| '\" .AP type name in/out ?indent? |
| '\" Start paragraph describing an argument to a library procedure. |
| '\" type is type of argument (int, etc.), in/out is either "in", "out", |
| '\" or "in/out" to describe whether procedure reads or modifies arg, |
| '\" and indent is equivalent to second arg of .IP (shouldn't ever be |
| '\" needed; use .AS below instead) |
| '\" |
| '\" .AS ?type? ?name? |
| '\" Give maximum sizes of arguments for setting tab stops. Type and |
| '\" name are examples of largest possible arguments that will be passed |
| '\" to .AP later. If args are omitted, default tab stops are used. |
| '\" |
| '\" .BS |
| '\" Start box enclosure. From here until next .BE, everything will be |
| '\" enclosed in one large box. |
| '\" |
| '\" .BE |
| '\" End of box enclosure. |
| '\" |
| '\" .CS |
| '\" Begin code excerpt. |
| '\" |
| '\" .CE |
| '\" End code excerpt. |
| '\" |
| '\" .VS ?version? ?br? |
| '\" Begin vertical sidebar, for use in marking newly-changed parts |
| '\" of man pages. The first argument is ignored and used for recording |
| '\" the version when the .VS was added, so that the sidebars can be |
| '\" found and removed when they reach a certain age. If another argument |
| '\" is present, then a line break is forced before starting the sidebar. |
| '\" |
| '\" .VE |
| '\" End of vertical sidebar. |
| '\" |
| '\" .DS |
| '\" Begin an indented unfilled display. |
| '\" |
| '\" .DE |
| '\" End of indented unfilled display. |
| '\" |
| '\" .SO |
| '\" Start of list of standard options for a Tk widget. The |
| '\" options follow on successive lines, in four columns separated |
| '\" by tabs. |
| '\" |
| '\" .SE |
| '\" End of list of standard options for a Tk widget. |
| '\" |
| '\" .OP cmdName dbName dbClass |
| '\" Start of description of a specific option. cmdName gives the |
| '\" option's name as specified in the class command, dbName gives |
| '\" the option's name in the option database, and dbClass gives |
| '\" the option's class in the option database. |
| '\" |
| '\" .UL arg1 arg2 |
| '\" Print arg1 underlined, then print arg2 normally. |
| '\" |
| '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ |
| '\" |
| '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
| .if t .wh -1.3i ^B |
| .nr ^l \n(.l |
| .ad b |
| '\" # Start an argument description |
| .de AP |
| .ie !"\\$4"" .TP \\$4 |
| .el \{\ |
| . ie !"\\$2"" .TP \\n()Cu |
| . el .TP 15 |
| .\} |
| .ta \\n()Au \\n()Bu |
| .ie !"\\$3"" \{\ |
| \&\\$1 \\fI\\$2\\fP (\\$3) |
| .\".b |
| .\} |
| .el \{\ |
| .br |
| .ie !"\\$2"" \{\ |
| \&\\$1 \\fI\\$2\\fP |
| .\} |
| .el \{\ |
| \&\\fI\\$1\\fP |
| .\} |
| .\} |
| .. |
| '\" # define tabbing values for .AP |
| .de AS |
| .nr )A 10n |
| .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| .nr )B \\n()Au+15n |
| .\" |
| .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
| .nr )C \\n()Bu+\\w'(in/out)'u+2n |
| .. |
| .AS Tcl_Interp Tcl_CreateInterp in/out |
| '\" # BS - start boxed text |
| '\" # ^y = starting y location |
| '\" # ^b = 1 |
| .de BS |
| .br |
| .mk ^y |
| .nr ^b 1u |
| .if n .nf |
| .if n .ti 0 |
| .if n \l'\\n(.lu\(ul' |
| .if n .fi |
| .. |
| '\" # BE - end boxed text (draw box now) |
| .de BE |
| .nf |
| .ti 0 |
| .mk ^t |
| .ie n \l'\\n(^lu\(ul' |
| .el \{\ |
| .\" Draw four-sided box normally, but don't draw top of |
| .\" box if the box started on an earlier page. |
| .ie !\\n(^b-1 \{\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .el \}\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .\} |
| .fi |
| .br |
| .nr ^b 0 |
| .. |
| '\" # VS - start vertical sidebar |
| '\" # ^Y = starting y location |
| '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| .de VS |
| .if !"\\$2"" .br |
| .mk ^Y |
| .ie n 'mc \s12\(br\s0 |
| .el .nr ^v 1u |
| .. |
| '\" # VE - end of vertical sidebar |
| .de VE |
| .ie n 'mc |
| .el \{\ |
| .ev 2 |
| .nf |
| .ti 0 |
| .mk ^t |
| \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| .sp -1 |
| .fi |
| .ev |
| .\} |
| .nr ^v 0 |
| .. |
| '\" # Special macro to handle page bottom: finish off current |
| '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| '\" # page bottom macro. |
| .de ^B |
| .ev 2 |
| 'ti 0 |
| 'nf |
| .mk ^t |
| .if \\n(^b \{\ |
| .\" Draw three-sided box if this is the box's first page, |
| .\" draw two sides but no top otherwise. |
| .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| .\} |
| .if \\n(^v \{\ |
| .nr ^x \\n(^tu+1v-\\n(^Yu |
| \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| .\} |
| .bp |
| 'fi |
| .ev |
| .if \\n(^b \{\ |
| .mk ^y |
| .nr ^b 2 |
| .\} |
| .if \\n(^v \{\ |
| .mk ^Y |
| .\} |
| .. |
| '\" # DS - begin display |
| .de DS |
| .RS |
| .nf |
| .sp |
| .. |
| '\" # DE - end display |
| .de DE |
| .fi |
| .RE |
| .sp |
| .. |
| '\" # SO - start of list of standard options |
| .de SO |
| .SH "STANDARD OPTIONS" |
| .LP |
| .nf |
| .ta 5.5c 11c |
| .ft B |
| .. |
| '\" # SE - end of list of standard options |
| .de SE |
| .fi |
| .ft R |
| .LP |
| See the \\fBoptions\\fR manual entry for details on the standard options. |
| .. |
| '\" # OP - start of full description for a single option |
| .de OP |
| .LP |
| .nf |
| .ta 4c |
| Command-Line Name: \\fB\\$1\\fR |
| Database Name: \\fB\\$2\\fR |
| Database Class: \\fB\\$3\\fR |
| .fi |
| .IP |
| .. |
| '\" # CS - begin code excerpt |
| .de CS |
| .RS |
| .nf |
| .ta .25i .5i .75i 1i |
| .. |
| '\" # CE - end code excerpt |
| .de CE |
| .fi |
| .RE |
| .. |
| .de UL |
| \\$1\l'|0\(ul'\\$2 |
| .. |
| .TH lsearch n 8.4 Tcl "Tcl Built-In Commands" |
| .BS |
| '\" Note: do not modify the .SH NAME line immediately below! |
| .SH NAME |
| lsearch \- See if a list contains a particular element |
| .SH SYNOPSIS |
| \fBlsearch \fR?\fIoptions\fR? \fIlist pattern\fR |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| This command searches the elements of \fIlist\fR to see if one |
| of them matches \fIpattern\fR. If so, the command returns the index |
| of the first matching element |
| .VS 8.4 |
| (unless the options \fB\-all\fR or \fB\-inline\fR are specified.) |
| .VE 8.4 |
| If not, the command returns \fB\-1\fR. The \fIoption\fR arguments |
| indicates how the elements of the list are to be matched against |
| \fIpattern\fR and it must have one of the following values: |
| .TP |
| \fB\-all\fR |
| .VS 8.4 |
| Changes the result to be the list of all matching indices (or all |
| matching values if \fB\-inline\fR is specified as well.) |
| .VE 8.4 |
| .TP |
| \fB\-ascii\fR |
| The list elements are to be examined as ASCII strings. This option is only |
| meaningful when used with \fB\-exact\fR or \fB\-sorted\fR. |
| .TP |
| \fB\-decreasing\fR |
| The list elements are sorted in decreasing order. This option is only |
| meaningful when used with \fB\-sorted\fR. |
| .TP |
| \fB\-dictionary\fR |
| The list elements are to be compared using dictionary-style |
| comparisons. This option is only meaningful when used with |
| \fB\-exact\fR or \fB\-sorted\fR. |
| .TP |
| \fB\-exact\fR |
| The list element must contain exactly the same string as \fIpattern\fR. |
| .TP |
| \fB\-glob\fR |
| \fIPattern\fR is a glob-style pattern which is matched against each list |
| element using the same rules as the \fBstring match\fR command. |
| .TP |
| \fB\-increasing\fR |
| The list elements are sorted in increasing order. This option is only |
| meaningful when used with \fB\-sorted\fR. |
| .TP |
| \fB\-inline\fR |
| .VS 8.4 |
| The matching value is returned instead of its index (or an empty |
| string if no value matches.) If \fB\-all\fR is also specified, then |
| the result of the command is the list of all values that matched. |
| .VE 8.4 |
| .TP |
| \fB\-integer\fR |
| The list elements are to be compared as integers. This option is only |
| meaningful when used with \fB\-exact\fR or \fB\-sorted\fR. |
| .TP |
| \fB\-not\fR |
| .VS 8.4 |
| This negates the sense of the match, returning the index of the first |
| non-matching value in the list. |
| .VE 8.4 |
| .TP |
| \fB\-real\fR |
| The list elements are to be compared as floating-point values. This |
| option is only meaningful when used with \fB\-exact\fR or \fB\-sorted\fR. |
| .TP |
| \fB\-regexp\fR |
| \fIPattern\fR is treated as a regular expression and matched against |
| each list element using the rules described in the \fBre_syntax\fR |
| reference page. |
| .TP |
| \fB\-sorted\fR |
| The list elements are in sorted order. If this option is specified, |
| \fBlsearch\fR will use a more efficient searching algorithm to search |
| \fIlist\fR. If no other options are specified, \fIlist\fR is assumed |
| to be sorted in increasing order, and to contain ASCII strings. This |
| option is mutually exclusive with \fB\-glob\fR and \fB\-regexp\fR, and |
| is treated exactly like \fB-exact\fR when either \fB\-all\fR, or |
| \fB\-not\fR is specified. |
| .TP |
| \fB\-start\fR \fIindex\fR |
| .VS 8.4 |
| The list is searched starting at position \fIindex\fR. If \fIindex\fR |
| has the value \fBend\fR, it refers to the last element in the list, |
| and \fBend\-\fIinteger\fR refers to the last element in the list minus |
| the specified integer offset. |
| .VE 8.4 |
| .PP |
| If \fIoption\fR is omitted then it defaults to \fB\-glob\fR. If more |
| than one of \fB\-exact\fR, \fB\-glob\fR, \fB\-regexp\fR, and |
| \fB\-sorted\fR is specified, whichever option is specified last takes |
| precedence. If more than one of \fB\-ascii\fR, \fB\-dictionary\fR, |
| \fB\-integer\fR and \fB\-real\fR is specified, the option specified |
| last takes precedence. If more than one of \fB\-increasing\fR and |
| \fB\-decreasing\fR is specified, the option specified last takes |
| precedence. |
| |
| .VS 8.4 |
| .SH EXAMPLES |
| .CS |
| lsearch {a b c d e} c => 2 |
| lsearch -all {a b c a b c} c => 2 5 |
| lsearch -inline {a20 b35 c47} b* => b35 |
| lsearch -inline -not {a20 b35 c47} b* => a20 |
| lsearch -all -inline -not {a20 b35 c47} b* => a20 c47 |
| lsearch -all -not {a20 b35 c47} b* => 0 2 |
| lsearch -start 3 {a b c a b c} c => 5 |
| .CE |
| .VE 8.4 |
| |
| .SH "SEE ALSO" |
| .VS 8.4 |
| foreach(n), list(n), lappend(n), lindex(n), linsert(n), llength(n), |
| lset(n), lsort(n), lrange(n), lreplace(n) |
| .VE |
| |
| .SH KEYWORDS |
| list, match, pattern, regular expression, search, string |