| '\" |
| '\" Copyright (c) 1993-1994 The Regents of the University of California. |
| '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
| '\" |
| '\" See the file "license.terms" for information on usage and redistribution |
| '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| '\" |
| '\" RCS: @(#) $Id: array.n,v 1.8 2000/09/07 14:27:45 poenitz 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 array n 8.3 Tcl "Tcl Built-In Commands" |
| .BS |
| '\" Note: do not modify the .SH NAME line immediately below! |
| .SH NAME |
| array \- Manipulate array variables |
| .SH SYNOPSIS |
| \fBarray \fIoption arrayName\fR ?\fIarg arg ...\fR? |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| This command performs one of several operations on the |
| variable given by \fIarrayName\fR. |
| Unless otherwise specified for individual commands below, |
| \fIarrayName\fR must be the name of an existing array variable. |
| The \fIoption\fR argument determines what action is carried |
| out by the command. |
| The legal \fIoptions\fR (which may be abbreviated) are: |
| .TP |
| \fBarray anymore \fIarrayName searchId\fR |
| Returns 1 if there are any more elements left to be processed |
| in an array search, 0 if all elements have already been |
| returned. |
| \fISearchId\fR indicates which search on \fIarrayName\fR to |
| check, and must have been the return value from a previous |
| invocation of \fBarray startsearch\fR. |
| This option is particularly useful if an array has an element |
| with an empty name, since the return value from |
| \fBarray nextelement\fR won't indicate whether the search |
| has been completed. |
| .TP |
| \fBarray donesearch \fIarrayName searchId\fR |
| This command terminates an array search and destroys all the |
| state associated with that search. \fISearchId\fR indicates |
| which search on \fIarrayName\fR to destroy, and must have |
| been the return value from a previous invocation of |
| \fBarray startsearch\fR. Returns an empty string. |
| .TP |
| \fBarray exists \fIarrayName\fR |
| Returns 1 if \fIarrayName\fR is an array variable, 0 if there |
| is no variable by that name or if it is a scalar variable. |
| .TP |
| \fBarray get \fIarrayName\fR ?\fIpattern\fR? |
| Returns a list containing pairs of elements. The first |
| element in each pair is the name of an element in \fIarrayName\fR |
| and the second element of each pair is the value of the |
| array element. The order of the pairs is undefined. |
| If \fIpattern\fR is not specified, then all of the elements of the |
| array are included in the result. |
| If \fIpattern\fR is specified, then only those elements whose names |
| match \fIpattern\fR (using the matching rules of |
| \fBstring match\fR) are included. |
| If \fIarrayName\fR isn't the name of an array variable, or if |
| the array contains no elements, then an empty list is returned. |
| .TP |
| \fBarray names \fIarrayName\fR ?\fImode\fR? ?\fIpattern\fR? |
| Returns a list containing the names of all of the elements in |
| the array that match \fIpattern\fR. \fIMode\fR may be one of |
| \fB-exact\fR, \fB-glob\fR, or \fB-regexp\fR. If specified, \fImode\fR |
| designates which matching rules to use to match \fIpattern\fR against |
| the names of the elements in the array. If not specified, \fImode\fR |
| defaults to \fB-glob\fR. See the documentation for \fBstring match\fR |
| for information on glob style matching, and the documentation for |
| \fBregexp\fR for information on regexp matching. |
| If \fIpattern\fR is omitted then the command returns all of |
| the element names in the array. If there are no (matching) elements |
| in the array, or if \fIarrayName\fR isn't the name of an array |
| variable, then an empty string is returned. |
| .TP |
| \fBarray nextelement \fIarrayName searchId\fR |
| Returns the name of the next element in \fIarrayName\fR, or |
| an empty string if all elements of \fIarrayName\fR have |
| already been returned in this search. The \fIsearchId\fR |
| argument identifies the search, and must have |
| been the return value of an \fBarray startsearch\fR command. |
| Warning: if elements are added to or deleted from the array, |
| then all searches are automatically terminated just as if |
| \fBarray donesearch\fR had been invoked; this will cause |
| \fBarray nextelement\fR operations to fail for those searches. |
| .TP |
| \fBarray set \fIarrayName list\fR |
| Sets the values of one or more elements in \fIarrayName\fR. |
| \fIlist\fR must have a form like that returned by \fBarray get\fR, |
| consisting of an even number of elements. |
| Each odd-numbered element in \fIlist\fR is treated as an element |
| name within \fIarrayName\fR, and the following element in \fIlist\fR |
| is used as a new value for that array element. |
| If the variable \fIarrayName\fR does not already exist |
| and \fIlist\fR is empty, |
| \fIarrayName\fR is created with an empty array value. |
| .TP |
| \fBarray size \fIarrayName\fR |
| Returns a decimal string giving the number of elements in the |
| array. |
| If \fIarrayName\fR isn't the name of an array then 0 is returned. |
| .TP |
| \fBarray startsearch \fIarrayName\fR |
| This command initializes an element-by-element search through the |
| array given by \fIarrayName\fR, such that invocations of the |
| \fBarray nextelement\fR command will return the names of the |
| individual elements in the array. |
| When the search has been completed, the \fBarray donesearch\fR |
| command should be invoked. |
| The return value is a |
| search identifier that must be used in \fBarray nextelement\fR |
| and \fBarray donesearch\fR commands; it allows multiple |
| searches to be underway simultaneously for the same array. |
| .VS 8.4 |
| .TP |
| \fBarray statistics \fIarrayName\fR |
| Returns statistics about the distribution of data within the hashtable |
| that represents the array. This information includes the number of |
| entries in the table, the number of buckets, and the utilization of |
| the buckets. |
| .VE 8.4 |
| .VS 8.3 |
| .TP |
| \fBarray unset \fIarrayName\fR ?\fIpattern\fR? |
| Unsets all of the elements in the array that match \fIpattern\fR (using the |
| matching rules of \fBstring match\fR). If \fIarrayName\fR isn't the name |
| of an array variable or there are no matching elements in the array, no |
| error will be raised. If \fIpattern\fR is omitted and \fIarrayName\fR is |
| an array variable, then the command unsets the entire array. |
| The command always returns an empty string. |
| .VE 8.3 |
| |
| .SH "SEE ALSO" |
| list(n), string(n), variable(n), trace(n) |
| |
| .SH KEYWORDS |
| array, element names, search |