2 '\" Copyright (c) 1989-1993 The Regents of the University of California.
3 '\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 '\" RCS: @(#) $Id: ExprLong.3,v 1.6 2002/08/05 03:24:39 dgp Exp $
10 '\" The definitions below are for supplemental macros used in Tcl/Tk
13 '\" .AP type name in/out ?indent?
14 '\" Start paragraph describing an argument to a library procedure.
15 '\" type is type of argument (int, etc.), in/out is either "in", "out",
16 '\" or "in/out" to describe whether procedure reads or modifies arg,
17 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
18 '\" needed; use .AS below instead)
21 '\" Give maximum sizes of arguments for setting tab stops. Type and
22 '\" name are examples of largest possible arguments that will be passed
23 '\" to .AP later. If args are omitted, default tab stops are used.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed in one large box.
30 '\" End of box enclosure.
33 '\" Begin code excerpt.
38 '\" .VS ?version? ?br?
39 '\" Begin vertical sidebar, for use in marking newly-changed parts
40 '\" of man pages. The first argument is ignored and used for recording
41 '\" the version when the .VS was added, so that the sidebars can be
42 '\" found and removed when they reach a certain age. If another argument
43 '\" is present, then a line break is forced before starting the sidebar.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display.
52 '\" End of indented unfilled display.
55 '\" Start of list of standard options for a Tk widget. The
56 '\" options follow on successive lines, in four columns separated
60 '\" End of list of standard options for a Tk widget.
62 '\" .OP cmdName dbName dbClass
63 '\" Start of description of a specific option. cmdName gives the
64 '\" option's name as specified in the class command, dbName gives
65 '\" the option's name in the option database, and dbClass gives
66 '\" the option's class in the option database.
69 '\" Print arg1 underlined, then print arg2 normally.
71 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2"" .TP \\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\(ul'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box if the box started on an earlier page.
131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
165 '\" # Special macro to handle page bottom: finish off current
166 '\" # box/sidebar if in box/sidebar mode, then invoked standard
167 '\" # page bottom macro.
174 .\" Draw three-sided box if this is the box's first page,
175 .\" draw two sides but no top otherwise.
176 .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
177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
180 .nr ^x \\n(^tu+1v-\\n(^Yu
181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH Tcl_ExprLong 3 7.0 Tcl "Tcl Library Procedures"
249 Tcl_ExprLong, Tcl_ExprDouble, Tcl_ExprBoolean, Tcl_ExprString \- evaluate an expression
252 \fB#include <tcl.h>\fR
255 \fBTcl_ExprLong\fR(\fIinterp, string, longPtr\fR)
258 \fBTcl_ExprDouble\fR(\fIinterp, string, doublePtr\fR)
261 \fBTcl_ExprBoolean\fR(\fIinterp, string, booleanPtr\fR)
264 \fBTcl_ExprString\fR(\fIinterp, string\fR)
266 .AS Tcl_Interp *booleanPtr
267 .AP Tcl_Interp *interp in
268 Interpreter in whose context to evaluate \fIstring\fR or \fIobjPtr\fR.
270 .AP "CONST char" *string in
272 Expression to be evaluated.
273 .AP long *longPtr out
274 Pointer to location in which to store the integer value of the
276 .AP int *doublePtr out
277 Pointer to location in which to store the floating-point value of the
279 .AP int *booleanPtr out
280 Pointer to location in which to store the 0/1 boolean value of the
286 These four procedures all evaluate the expression
287 given by the \fIstring\fR argument
288 and return the result in one of four different forms.
289 The expression can have any of the forms accepted by the \fBexpr\fR command.
290 Note that these procedures have been largely replaced by the
291 object-based procedures \fBTcl_ExprLongObj\fR, \fBTcl_ExprDoubleObj\fR,
292 \fBTcl_ExprBooleanObj\fR, and \fBTcl_ExprObj\fR.
293 Those object-based procedures evaluate an expression held in a Tcl object
295 The object argument can retain an internal representation
296 that is more efficient to execute.
298 The \fIinterp\fR argument refers to an interpreter used to
299 evaluate the expression (e.g. for variables and nested Tcl
300 commands) and to return error information.
302 For all of these procedures the return value is a standard
303 Tcl result: \fBTCL_OK\fR means the expression was successfully
304 evaluated, and \fBTCL_ERROR\fR means that an error occurred while
305 evaluating the expression.
306 If \fBTCL_ERROR\fR is returned then
307 the interpreter's result will hold a message describing the error.
308 If an error occurs while executing a Tcl command embedded in
309 the expression then that error will be returned.
311 If the expression is successfully evaluated, then its value is
312 returned in one of four forms, depending on which procedure
314 \fBTcl_ExprLong\fR stores an integer value at \fI*longPtr\fR.
315 If the expression's actual value is a floating-point number,
316 then it is truncated to an integer.
317 If the expression's actual value is a non-numeric string then
318 an error is returned.
320 \fBTcl_ExprDouble\fR stores a floating-point value at \fI*doublePtr\fR.
321 If the expression's actual value is an integer, it is converted to
323 If the expression's actual value is a non-numeric string then
324 an error is returned.
326 \fBTcl_ExprBoolean\fR stores a 0/1 integer value at \fI*booleanPtr\fR.
327 If the expression's actual value is an integer or floating-point
328 number, then they store 0 at \fI*booleanPtr\fR if
329 the value was zero and 1 otherwise.
330 If the expression's actual value is a non-numeric string then
331 it must be one of the values accepted by \fBTcl_GetBoolean\fR
332 such as ``yes'' or ``no'', or else an error occurs.
334 \fBTcl_ExprString\fR returns the value of the expression as a
335 string stored in the interpreter's result.
336 If the expression's actual value is an integer
337 then \fBTcl_ExprString\fR converts it to a string using \fBsprintf\fR
338 with a ``%d'' converter.
339 If the expression's actual value is a floating-point
340 number, then \fBTcl_ExprString\fR calls \fBTcl_PrintDouble\fR
341 to convert it to a string.
344 Tcl_ExprLongObj, Tcl_ExprDoubleObj, Tcl_ExprBooleanObj, Tcl_ExprObj
347 boolean, double, evaluate, expression, integer, object, string