| '\" |
| '\" Copyright (c) 1989-1993 The Regents of the University of California. |
| '\" Copyright (c) 1994-1997 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: ExprLong.3,v 1.6 2002/08/05 03:24:39 dgp 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 Tcl_ExprLong 3 7.0 Tcl "Tcl Library Procedures" |
| .BS |
| .SH NAME |
| Tcl_ExprLong, Tcl_ExprDouble, Tcl_ExprBoolean, Tcl_ExprString \- evaluate an expression |
| .SH SYNOPSIS |
| .nf |
| \fB#include <tcl.h>\fR |
| .sp |
| int |
| \fBTcl_ExprLong\fR(\fIinterp, string, longPtr\fR) |
| .sp |
| int |
| \fBTcl_ExprDouble\fR(\fIinterp, string, doublePtr\fR) |
| .sp |
| int |
| \fBTcl_ExprBoolean\fR(\fIinterp, string, booleanPtr\fR) |
| .sp |
| int |
| \fBTcl_ExprString\fR(\fIinterp, string\fR) |
| .SH ARGUMENTS |
| .AS Tcl_Interp *booleanPtr |
| .AP Tcl_Interp *interp in |
| Interpreter in whose context to evaluate \fIstring\fR or \fIobjPtr\fR. |
| .VS 8.4 |
| .AP "CONST char" *string in |
| .VE |
| Expression to be evaluated. |
| .AP long *longPtr out |
| Pointer to location in which to store the integer value of the |
| expression. |
| .AP int *doublePtr out |
| Pointer to location in which to store the floating-point value of the |
| expression. |
| .AP int *booleanPtr out |
| Pointer to location in which to store the 0/1 boolean value of the |
| expression. |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| These four procedures all evaluate the expression |
| given by the \fIstring\fR argument |
| and return the result in one of four different forms. |
| The expression can have any of the forms accepted by the \fBexpr\fR command. |
| Note that these procedures have been largely replaced by the |
| object-based procedures \fBTcl_ExprLongObj\fR, \fBTcl_ExprDoubleObj\fR, |
| \fBTcl_ExprBooleanObj\fR, and \fBTcl_ExprObj\fR. |
| Those object-based procedures evaluate an expression held in a Tcl object |
| instead of a string. |
| The object argument can retain an internal representation |
| that is more efficient to execute. |
| .PP |
| The \fIinterp\fR argument refers to an interpreter used to |
| evaluate the expression (e.g. for variables and nested Tcl |
| commands) and to return error information. |
| .PP |
| For all of these procedures the return value is a standard |
| Tcl result: \fBTCL_OK\fR means the expression was successfully |
| evaluated, and \fBTCL_ERROR\fR means that an error occurred while |
| evaluating the expression. |
| If \fBTCL_ERROR\fR is returned then |
| the interpreter's result will hold a message describing the error. |
| If an error occurs while executing a Tcl command embedded in |
| the expression then that error will be returned. |
| .PP |
| If the expression is successfully evaluated, then its value is |
| returned in one of four forms, depending on which procedure |
| is invoked. |
| \fBTcl_ExprLong\fR stores an integer value at \fI*longPtr\fR. |
| If the expression's actual value is a floating-point number, |
| then it is truncated to an integer. |
| If the expression's actual value is a non-numeric string then |
| an error is returned. |
| .PP |
| \fBTcl_ExprDouble\fR stores a floating-point value at \fI*doublePtr\fR. |
| If the expression's actual value is an integer, it is converted to |
| floating-point. |
| If the expression's actual value is a non-numeric string then |
| an error is returned. |
| .PP |
| \fBTcl_ExprBoolean\fR stores a 0/1 integer value at \fI*booleanPtr\fR. |
| If the expression's actual value is an integer or floating-point |
| number, then they store 0 at \fI*booleanPtr\fR if |
| the value was zero and 1 otherwise. |
| If the expression's actual value is a non-numeric string then |
| it must be one of the values accepted by \fBTcl_GetBoolean\fR |
| such as ``yes'' or ``no'', or else an error occurs. |
| .PP |
| \fBTcl_ExprString\fR returns the value of the expression as a |
| string stored in the interpreter's result. |
| If the expression's actual value is an integer |
| then \fBTcl_ExprString\fR converts it to a string using \fBsprintf\fR |
| with a ``%d'' converter. |
| If the expression's actual value is a floating-point |
| number, then \fBTcl_ExprString\fR calls \fBTcl_PrintDouble\fR |
| to convert it to a string. |
| |
| .SH "SEE ALSO" |
| Tcl_ExprLongObj, Tcl_ExprDoubleObj, Tcl_ExprBooleanObj, Tcl_ExprObj |
| |
| .SH KEYWORDS |
| boolean, double, evaluate, expression, integer, object, string |