Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / man / man3 / Tcl_GetIndexFromObj.3
CommitLineData
920dae64
AT
1'\"
2'\" Copyright (c) 1997 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: GetIndex.3,v 1.10.2.1 2003/07/18 15:20:51 dgp Exp $
8'\"
9'\" The definitions below are for supplemental macros used in Tcl/Tk
10'\" manual entries.
11'\"
12'\" .AP type name in/out ?indent?
13'\" Start paragraph describing an argument to a library procedure.
14'\" type is type of argument (int, etc.), in/out is either "in", "out",
15'\" or "in/out" to describe whether procedure reads or modifies arg,
16'\" and indent is equivalent to second arg of .IP (shouldn't ever be
17'\" needed; use .AS below instead)
18'\"
19'\" .AS ?type? ?name?
20'\" Give maximum sizes of arguments for setting tab stops. Type and
21'\" name are examples of largest possible arguments that will be passed
22'\" to .AP later. If args are omitted, default tab stops are used.
23'\"
24'\" .BS
25'\" Start box enclosure. From here until next .BE, everything will be
26'\" enclosed in one large box.
27'\"
28'\" .BE
29'\" End of box enclosure.
30'\"
31'\" .CS
32'\" Begin code excerpt.
33'\"
34'\" .CE
35'\" End code excerpt.
36'\"
37'\" .VS ?version? ?br?
38'\" Begin vertical sidebar, for use in marking newly-changed parts
39'\" of man pages. The first argument is ignored and used for recording
40'\" the version when the .VS was added, so that the sidebars can be
41'\" found and removed when they reach a certain age. If another argument
42'\" is present, then a line break is forced before starting the sidebar.
43'\"
44'\" .VE
45'\" End of vertical sidebar.
46'\"
47'\" .DS
48'\" Begin an indented unfilled display.
49'\"
50'\" .DE
51'\" End of indented unfilled display.
52'\"
53'\" .SO
54'\" Start of list of standard options for a Tk widget. The
55'\" options follow on successive lines, in four columns separated
56'\" by tabs.
57'\"
58'\" .SE
59'\" End of list of standard options for a Tk widget.
60'\"
61'\" .OP cmdName dbName dbClass
62'\" Start of description of a specific option. cmdName gives the
63'\" option's name as specified in the class command, dbName gives
64'\" the option's name in the option database, and dbClass gives
65'\" the option's class in the option database.
66'\"
67'\" .UL arg1 arg2
68'\" Print arg1 underlined, then print arg2 normally.
69'\"
70'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
71'\"
72'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
73.if t .wh -1.3i ^B
74.nr ^l \n(.l
75.ad b
76'\" # Start an argument description
77.de AP
78.ie !"\\$4"" .TP \\$4
79.el \{\
80. ie !"\\$2"" .TP \\n()Cu
81. el .TP 15
82.\}
83.ta \\n()Au \\n()Bu
84.ie !"\\$3"" \{\
85\&\\$1 \\fI\\$2\\fP (\\$3)
86.\".b
87.\}
88.el \{\
89.br
90.ie !"\\$2"" \{\
91\&\\$1 \\fI\\$2\\fP
92.\}
93.el \{\
94\&\\fI\\$1\\fP
95.\}
96.\}
97..
98'\" # define tabbing values for .AP
99.de AS
100.nr )A 10n
101.if !"\\$1"" .nr )A \\w'\\$1'u+3n
102.nr )B \\n()Au+15n
103.\"
104.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
105.nr )C \\n()Bu+\\w'(in/out)'u+2n
106..
107.AS Tcl_Interp Tcl_CreateInterp in/out
108'\" # BS - start boxed text
109'\" # ^y = starting y location
110'\" # ^b = 1
111.de BS
112.br
113.mk ^y
114.nr ^b 1u
115.if n .nf
116.if n .ti 0
117.if n \l'\\n(.lu\(ul'
118.if n .fi
119..
120'\" # BE - end boxed text (draw box now)
121.de BE
122.nf
123.ti 0
124.mk ^t
125.ie n \l'\\n(^lu\(ul'
126.el \{\
127.\" Draw four-sided box normally, but don't draw top of
128.\" box if the box started on an earlier page.
129.ie !\\n(^b-1 \{\
130\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
131.\}
132.el \}\
133\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134.\}
135.\}
136.fi
137.br
138.nr ^b 0
139..
140'\" # VS - start vertical sidebar
141'\" # ^Y = starting y location
142'\" # ^v = 1 (for troff; for nroff this doesn't matter)
143.de VS
144.if !"\\$2"" .br
145.mk ^Y
146.ie n 'mc \s12\(br\s0
147.el .nr ^v 1u
148..
149'\" # VE - end of vertical sidebar
150.de VE
151.ie n 'mc
152.el \{\
153.ev 2
154.nf
155.ti 0
156.mk ^t
157\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
158.sp -1
159.fi
160.ev
161.\}
162.nr ^v 0
163..
164'\" # Special macro to handle page bottom: finish off current
165'\" # box/sidebar if in box/sidebar mode, then invoked standard
166'\" # page bottom macro.
167.de ^B
168.ev 2
169'ti 0
170'nf
171.mk ^t
172.if \\n(^b \{\
173.\" Draw three-sided box if this is the box's first page,
174.\" draw two sides but no top otherwise.
175.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
176.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177.\}
178.if \\n(^v \{\
179.nr ^x \\n(^tu+1v-\\n(^Yu
180\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
181.\}
182.bp
183'fi
184.ev
185.if \\n(^b \{\
186.mk ^y
187.nr ^b 2
188.\}
189.if \\n(^v \{\
190.mk ^Y
191.\}
192..
193'\" # DS - begin display
194.de DS
195.RS
196.nf
197.sp
198..
199'\" # DE - end display
200.de DE
201.fi
202.RE
203.sp
204..
205'\" # SO - start of list of standard options
206.de SO
207.SH "STANDARD OPTIONS"
208.LP
209.nf
210.ta 5.5c 11c
211.ft B
212..
213'\" # SE - end of list of standard options
214.de SE
215.fi
216.ft R
217.LP
218See the \\fBoptions\\fR manual entry for details on the standard options.
219..
220'\" # OP - start of full description for a single option
221.de OP
222.LP
223.nf
224.ta 4c
225Command-Line Name: \\fB\\$1\\fR
226Database Name: \\fB\\$2\\fR
227Database Class: \\fB\\$3\\fR
228.fi
229.IP
230..
231'\" # CS - begin code excerpt
232.de CS
233.RS
234.nf
235.ta .25i .5i .75i 1i
236..
237'\" # CE - end code excerpt
238.de CE
239.fi
240.RE
241..
242.de UL
243\\$1\l'|0\(ul'\\$2
244..
245.TH Tcl_GetIndexFromObj 3 8.1 Tcl "Tcl Library Procedures"
246.BS
247.SH NAME
248Tcl_GetIndexFromObj, Tcl_GetIndexFromObjStruct \- lookup string in table of keywords
249.SH SYNOPSIS
250.nf
251\fB#include <tcl.h>\fR
252.sp
253int
254\fBTcl_GetIndexFromObj\fR(\fIinterp, objPtr, tablePtr, msg, flags,
255indexPtr\fR)
256.VS
257.sp
258int
259\fBTcl_GetIndexFromObjStruct\fR(\fIinterp, objPtr, structTablePtr, offset,
260msg, flags, indexPtr\fR)
261.VE
262.SH ARGUMENTS
263.AS "CONST char" **tablePtr
264.AP Tcl_Interp *interp in
265Interpreter to use for error reporting; if NULL, then no message is
266provided on errors.
267.AP Tcl_Obj *objPtr in/out
268The string value of this object is used to search through \fItablePtr\fR.
269The internal representation is modified to hold the index of the matching
270table entry.
271.AP "CONST char" **tablePtr in
272An array of null-terminated strings. The end of the array is marked
273by a NULL string pointer.
274.AP "CONST VOID" *structTablePtr in
275An array of arbitrary type, typically some \fBstruct\fP type.
276The first member of the structure must be a null-terminated string.
277The size of the structure is given by \fIoffset\fP.
278.VS
279.AP int offset in
280The offset to add to structTablePtr to get to the next entry.
281The end of the array is marked by a NULL string pointer.
282.VE
283.AP "CONST char" *msg in
284Null-terminated string describing what is being looked up, such as
285\fBoption\fR. This string is included in error messages.
286.AP int flags in
287OR-ed combination of bits providing additional information for
288operation. The only bit that is currently defined is \fBTCL_EXACT\fR.
289.AP int *indexPtr out
290The index of the string in \fItablePtr\fR that matches the value of
291\fIobjPtr\fR is returned here.
292.BE
293
294.SH DESCRIPTION
295.PP
296This procedure provides an efficient way for looking up keywords,
297switch names, option names, and similar things where the value of
298an object must be one of a predefined set of values.
299\fIObjPtr\fR is compared against each of
300the strings in \fItablePtr\fR to find a match. A match occurs if
301\fIobjPtr\fR's string value is identical to one of the strings in
302\fItablePtr\fR, or if it is a unique abbreviation
303for exactly one of the strings in \fItablePtr\fR and the
304\fBTCL_EXACT\fR flag was not specified; in either case
305the index of the matching entry is stored at \fI*indexPtr\fR
306and TCL_OK is returned.
307.PP
308If there is no matching entry,
309TCL_ERROR is returned and an error message is left in \fIinterp\fR's
310result if \fIinterp\fR isn't NULL. \fIMsg\fR is included in the
311error message to indicate what was being looked up. For example,
312if \fImsg\fR is \fBoption\fR the error message will have a form like
313\fBbad option "firt": must be first, second, or third\fR.
314.PP
315If \fBTcl_GetIndexFromObj\fR completes successfully it modifies the
316internal representation of \fIobjPtr\fR to hold the address of
317the table and the index of the matching entry. If \fBTcl_GetIndexFromObj\fR
318is invoked again with the same \fIobjPtr\fR and \fItablePtr\fR
319arguments (e.g. during a reinvocation of a Tcl command), it returns
320the matching index immediately without having to redo the lookup
321operation. Note: \fBTcl_GetIndexFromObj\fR assumes that the entries
322in \fItablePtr\fR are static: they must not change between
323invocations. If the value of \fIobjPtr\fR is the empty string,
324\fBTcl_GetIndexFromObj\fR will treat it as a non-matching value
325and return TCL_ERROR.
326.VS
327.PP
328\fBTcl_GetIndexFromObjStruct\fR works just like
329\fBTcl_GetIndexFromObj\fR, except that instead of treating
330\fItablePtr\fR as an array of string pointers, it treats it as the
331first in a series of string ptrs that are spaced apart by \fIoffset\fR
332bytes. This is particularly useful when processing things like
333\fBTk_ConfigurationSpec\fR, whose string keys are in the same place in
334each of several array elements.
335.VE
336
337.SH "SEE ALSO"
338Tcl_WrongNumArgs
339
340.SH KEYWORDS
341index, object, table lookup