SGI/util/SGI/man/man3/Tcl_ExprBoolean.3

   1 '\"
   2 '\" Copyright (c) 1989-1993 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 '\" SCCS: @(#) ExprLong.3 1.26 97/06/26 13:42:47
   9 '\"
  10 '\" The definitions below are for supplemental macros used in Tcl/Tk
  11 '\" manual entries.
  12 '\"
  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)
  19 '\"
  20 '\" .AS ?type? ?name?
  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.
  24 '\"
  25 '\" .BS
  26 '\"     Start box enclosure.  From here until next .BE, everything will be
  27 '\"     enclosed in one large box.
  28 '\"
  29 '\" .BE
  30 '\"     End of box enclosure.
  31 '\"
  32 '\" .CS
  33 '\"     Begin code excerpt.
  34 '\"
  35 '\" .CE
  36 '\"     End code excerpt.
  37 '\"
  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.
  44 '\"
  45 '\" .VE
  46 '\"     End of vertical sidebar.
  47 '\"
  48 '\" .DS
  49 '\"     Begin an indented unfilled display.
  50 '\"
  51 '\" .DE
  52 '\"     End of indented unfilled display.
  53 '\"
  54 '\" .SO
  55 '\"     Start of list of standard options for a Tk widget.  The
  56 '\"     options follow on successive lines, in four columns separated
  57 '\"     by tabs.
  58 '\"
  59 '\" .SE
  60 '\"     End of list of standard options for a Tk widget.
  61 '\"
  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.
  67 '\"
  68 '\" .UL arg1 arg2
  69 '\"     Print arg1 underlined, then print arg2 normally.
  70 '\"
  71 '\" SCCS: @(#) man.macros 1.9 97/08/22 18:50:59
  72 '\"
  73 '\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  74 .if t .wh -1.3i ^B
  75 .nr ^l \n(.l
  76 .ad b
  77 '\"     # Start an argument description
  78 .de AP
  79 .ie !"\\$4"" .TP \\$4
  80 .el \{\
  81 .   ie !"\\$2"" .TP \\n()Cu
  82 .   el          .TP 15
  83 .\}
  84 .ie !"\\$3"" \{\
  85 .ta \\n()Au \\n()Bu
  86 \&\\$1  \\fI\\$2\\fP    (\\$3)
  87 .\".b
  88 .\}
  89 .el \{\
  90 .br
  91 .ie !"\\$2"" \{\
  92 \&\\$1  \\fI\\$2\\fP
  93 .\}
  94 .el \{\
  95 \&\\fI\\$1\\fP
  96 .\}
  97 .\}
  98 ..
  99 '\"     # define tabbing values for .AP
 100 .de AS
 101 .nr )A 10n
 102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 103 .nr )B \\n()Au+15n
 104 .\"
 105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 107 ..
 108 .AS Tcl_Interp Tcl_CreateInterp in/out
 109 '\"     # BS - start boxed text
 110 '\"     # ^y = starting y location
 111 '\"     # ^b = 1
 112 .de BS
 113 .br
 114 .mk ^y
 115 .nr ^b 1u
 116 .if n .nf
 117 .if n .ti 0
 118 .if n \l'\\n(.lu\(ul'
 119 .if n .fi
 120 ..
 121 '\"     # BE - end boxed text (draw box now)
 122 .de BE
 123 .nf
 124 .ti 0
 125 .mk ^t
 126 .ie n \l'\\n(^lu\(ul'
 127 .el \{\
 128 .\"     Draw four-sided box normally, but don't draw top of
 129 .\"     box if the box started on an earlier page.
 130 .ie !\\n(^b-1 \{\
 131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 132 .\}
 133 .el \}\
 134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 135 .\}
 136 .\}
 137 .fi
 138 .br
 139 .nr ^b 0
 140 ..
 141 '\"     # VS - start vertical sidebar
 142 '\"     # ^Y = starting y location
 143 '\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 144 .de VS
 145 .if !"\\$2"" .br
 146 .mk ^Y
 147 .ie n 'mc \s12\(br\s0
 148 .el .nr ^v 1u
 149 ..
 150 '\"     # VE - end of vertical sidebar
 151 .de VE
 152 .ie n 'mc
 153 .el \{\
 154 .ev 2
 155 .nf
 156 .ti 0
 157 .mk ^t
 158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 159 .sp -1
 160 .fi
 161 .ev
 162 .\}
 163 .nr ^v 0
 164 ..
 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.
 168 .de ^B
 169 .ev 2
 170 'ti 0
 171 'nf
 172 .mk ^t
 173 .if \\n(^b \{\
 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
 178 .\}
 179 .if \\n(^v \{\
 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
 182 .\}
 183 .bp
 184 'fi
 185 .ev
 186 .if \\n(^b \{\
 187 .mk ^y
 188 .nr ^b 2
 189 .\}
 190 .if \\n(^v \{\
 191 .mk ^Y
 192 .\}
 193 ..
 194 '\"     # DS - begin display
 195 .de DS
 196 .RS
 197 .nf
 198 .sp
 199 ..
 200 '\"     # DE - end display
 201 .de DE
 202 .fi
 203 .RE
 204 .sp
 205 ..
 206 '\"     # SO - start of list of standard options
 207 .de SO
 208 .SH "STANDARD OPTIONS"
 209 .LP
 210 .nf
 211 .ta 4c 8c 12c
 212 .ft B
 213 ..
 214 '\"     # SE - end of list of standard options
 215 .de SE
 216 .fi
 217 .ft R
 218 .LP
 219 See the \\fBoptions\\fR manual entry for details on the standard options.
 220 ..
 221 '\"     # OP - start of full description for a single option
 222 .de OP
 223 .LP
 224 .nf
 225 .ta 4c
 226 Command-Line Name:      \\fB\\$1\\fR
 227 Database Name:  \\fB\\$2\\fR
 228 Database Class: \\fB\\$3\\fR
 229 .fi
 230 .IP
 231 ..
 232 '\"     # CS - begin code excerpt
 233 .de CS
 234 .RS
 235 .nf
 236 .ta .25i .5i .75i 1i
 237 ..
 238 '\"     # CE - end code excerpt
 239 .de CE
 240 .fi
 241 .RE
 242 ..
 243 .de UL
 244 \\$1\l'|0\(ul'\\$2
 245 ..
 246 .TH Tcl_ExprLong 3 7.0 Tcl "Tcl Library Procedures"
 247 .BS
 248 .SH NAME
 249 Tcl_ExprLong, Tcl_ExprDouble, Tcl_ExprBoolean, Tcl_ExprString \- evaluate an expression
 250 .SH SYNOPSIS
 251 .nf
 252 \fB#include <tcl.h>\fR
 253 .sp
 254 int
 255 \fBTcl_ExprLong\fR(\fIinterp, string, longPtr\fR)
 256 .sp
 257 int
 258 \fBTcl_ExprDouble\fR(\fIinterp, string, doublePtr\fR)
 259 .sp
 260 int
 261 \fBTcl_ExprBoolean\fR(\fIinterp, string, booleanPtr\fR)
 262 .sp
 263 int
 264 \fBTcl_ExprString\fR(\fIinterp, string\fR)
 265 .SH ARGUMENTS
 266 .AS Tcl_Interp *booleanPtr
 267 .AP Tcl_Interp *interp in
 268 Interpreter in whose context to evaluate \fIstring\fR or \fIobjPtr\fR.
 269 .AP char *string in
 270 Expression to be evaluated.  Must be in writable memory (the expression
 271 parser makes temporary modifications to the string during parsing, which
 272 it undoes before returning).
 273 .AP long *longPtr out
 274 Pointer to location in which to store the integer value of the
 275 expression.
 276 .AP int *doublePtr out
 277 Pointer to location in which to store the floating-point value of the
 278 expression.
 279 .AP int *booleanPtr out
 280 Pointer to location in which to store the 0/1 boolean value of the
 281 expression.
 282 .BE
 283
 284 .SH DESCRIPTION
 285 .PP
 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_ExprStringObj\fR.
 293 Those object-based procedures evaluate an expression held in a Tcl object
 294 instead of a string.
 295 The object argument can retain an internal representation
 296 that is more efficient to execute.
 297 .PP
 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.
 301 \fIinterp->result\fR is assumed to be initialized
 302 in the standard fashion when they are invoked.
 303 .PP
 304 For all of these procedures the return value is a standard
 305 Tcl result: \fBTCL_OK\fR means the expression was successfully
 306 evaluated, and \fBTCL_ERROR\fR means that an error occurred while
 307 evaluating the expression.
 308 If \fBTCL_ERROR\fR is returned then
 309 \fIinterp->result\fR will hold a message describing the error.
 310 If an error occurs while executing a Tcl command embedded in
 311 the expression then that error will be returned.
 312 .PP
 313 If the expression is successfully evaluated, then its value is
 314 returned in one of four forms, depending on which procedure
 315 is invoked.
 316 \fBTcl_ExprLong\fR stores an integer value at \fI*longPtr\fR.
 317 If the expression's actual value is a floating-point number,
 318 then it is truncated to an integer.
 319 If the expression's actual value is a non-numeric string then
 320 an error is returned.
 321 .PP
 322 \fBTcl_ExprDouble\fR stores a floating-point value at \fI*doublePtr\fR.
 323 If the expression's actual value is an integer, it is converted to
 324 floating-point.
 325 If the expression's actual value is a non-numeric string then
 326 an error is returned.
 327 .PP
 328 \fBTcl_ExprBoolean\fR stores a 0/1 integer value at \fI*booleanPtr\fR.
 329 If the expression's actual value is an integer or floating-point
 330 number, then they store 0 at \fI*booleanPtr\fR if
 331 the value was zero and 1 otherwise.
 332 If the expression's actual value is a non-numeric string then
 333 it must be one of the values accepted by \fBTcl_GetBoolean\fR
 334 such as ``yes'' or ``no'', or else an error occurs.
 335 .PP
 336 \fBTcl_ExprString\fR returns the value of the expression as a
 337 string stored in \fIinterp->result\fR.
 338 If the expression's actual value is an integer
 339 then \fBTcl_ExprString\fR converts it to a string using \fBsprintf\fR
 340 with a ``%d'' converter.
 341 If the expression's actual value is a floating-point
 342 number, then \fBTcl_ExprString\fR calls \fBTcl_PrintDouble\fR
 343 to convert it to a string.
 344
 345 .SH "SEE ALSO"
 346 Tcl_ExprLongObj, Tcl_ExprDoubleObj, Tcl_ExprBooleanObj, Tcl_ExprObj
 347
 348 .SH KEYWORDS
 349 boolean, double, evaluate, expression, integer, object, string