CELLLINUX64/util/CELLLINUX64/man/man3/IntObj.3

   1 '\"
   2 '\" Copyright (c) 1996-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: IntObj.3,v 1.3 2002/02/15 14:28:47 dkf 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
 218 See 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
 225 Command-Line Name:      \\fB\\$1\\fR
 226 Database Name:  \\fB\\$2\\fR
 227 Database 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_IntObj 3 8.0 Tcl "Tcl Library Procedures"
 246 .BS
 247 .SH NAME
 248 Tcl_NewIntObj, Tcl_NewLongObj, Tcl_NewWideIntObj, Tcl_SetIntObj, Tcl_SetLongObj, Tcl_SetWideIntObj, Tcl_GetIntFromObj, Tcl_GetLongFromObj, Tcl_GetWideIntFromObj \- manipulate Tcl objects as integers and wide integers
 249 .SH SYNOPSIS
 250 .nf
 251 \fB#include <tcl.h>\fR
 252 .sp
 253 Tcl_Obj *
 254 \fBTcl_NewIntObj\fR(\fIintValue\fR)
 255 .sp
 256 Tcl_Obj *
 257 \fBTcl_NewLongObj\fR(\fIlongValue\fR)
 258 .sp
 259 .VS 8.4
 260 Tcl_Obj *
 261 \fBTcl_NewWideIntObj\fR(\fIwideValue\fR)
 262 .VE 8.4
 263 .sp
 264 \fBTcl_SetIntObj\fR(\fIobjPtr, intValue\fR)
 265 .sp
 266 \fBTcl_SetLongObj\fR(\fIobjPtr, longValue\fR)
 267 .sp
 268 .VS 8.4
 269 \fBTcl_SetWideIntObj\fR(\fIobjPtr, wideValue\fR)
 270 .VE 8.4
 271 .sp
 272 int
 273 \fBTcl_GetIntFromObj\fR(\fIinterp, objPtr, intPtr\fR)
 274 .sp
 275 int
 276 \fBTcl_GetLongFromObj\fR(\fIinterp, objPtr, longPtr\fR)
 277 .sp
 278 .VS 8.4
 279 int
 280 \fBTcl_GetWideIntFromObj\fR(\fIinterp, objPtr, widePtr\fR)
 281 .VE 8.4
 282 .SH ARGUMENTS
 283 .AS Tcl_WideInt *interp
 284 .AP int intValue in
 285 Integer value used to initialize or set an integer object.
 286 .AP long longValue in
 287 Long integer value used to initialize or set an integer object.
 288 .AP Tcl_WideInt wideValue in
 289 .VS 8.4
 290 Wide integer value (minimum 64-bits wide where supported by the
 291 compiler) used to initialize or set a wide integer object.
 292 .VE 8.4
 293 .AP Tcl_Obj *objPtr in/out
 294 For \fBTcl_SetIntObj\fR, \fBTcl_SetLongObj\fR, and
 295 .VS 8.4
 296 \fBTcl_SetWideIntObj\fR, this points to the object to be converted to
 297 integer type.  For \fBTcl_GetIntFromObj\fR, \fBTcl_GetLongFromObj\fR,
 298 and \fBTcl_GetWideIntFromObj\fR, this refers to the object from which
 299 to get an integer or long integer value; if \fIobjPtr\fR does not
 300 already point to an integer object (or a wide integer object in the
 301 case of \fBTcl_SetWideIntObj\fR and \fBTcl_GetWideIntFromObj\fR,) an
 302 .VE 8.4
 303 attempt will be made to convert it to one.
 304 .AP Tcl_Interp *interp in/out
 305 If an error occurs during conversion,
 306 an error message is left in the interpreter's result object
 307 unless \fIinterp\fR is NULL.
 308 .AP int *intPtr out
 309 Points to place to store the integer value
 310 obtained by \fBTcl_GetIntFromObj\fR from \fIobjPtr\fR.
 311 .AP long *longPtr out
 312 Points to place to store the long integer value
 313 obtained by \fBTcl_GetLongFromObj\fR from \fIobjPtr\fR.
 314 .AP Tcl_WideInt *widePtr out
 315 .VS 8.4
 316 Points to place to store the wide integer value
 317 obtained by \fBTcl_GetWideIntFromObj\fR from \fIobjPtr\fR.
 318 .VE 8.4
 319 .BE
 320
 321 .SH DESCRIPTION
 322 .PP
 323 These procedures are used to create, modify, and read
 324 integer and wide integer Tcl objects from C code.
 325 \fBTcl_NewIntObj\fR, \fBTcl_NewLongObj\fR,
 326 \fBTcl_SetIntObj\fR, and \fBTcl_SetLongObj\fR
 327 create a new object of integer type
 328 or modify an existing object to have integer type,
 329 .VS 8.4
 330 and \fBTcl_NewWideIntObj\fR and \fBTcl_SetWideIntObj\fR create a new
 331 object of wide integer type or modify an existing object to have wide
 332 integer type.
 333 .VE 8.4
 334 \fBTcl_NewIntObj\fR and \fBTcl_SetIntObj\fR set the object to have the
 335 integer value given by \fIintValue\fR,
 336 \fBTcl_NewLongObj\fR and \fBTcl_SetLongObj\fR
 337 set the object to have the
 338 long integer value given by \fIlongValue\fR,
 339 .VS 8.4
 340 and \fBTcl_NewWideIntObj\fR and \fBTcl_SetWideIntObj\fR set the object
 341 to have the wide integer value given by \fIwideValue\fR.
 342 \fBTcl_NewIntObj\fR, \fBTcl_NewLongObj\fR and \fBTcl_NewWideIntObj\fR
 343 return a pointer to a newly created object with reference count zero.
 344 These procedures set the object's type to be integer
 345 and assign the integer value to the object's internal representation
 346 \fIlongValue\fR or \fIwideValue\fR member (as appropriate).
 347 \fBTcl_SetIntObj\fR, \fBTcl_SetLongObj\fR
 348 and \fBTcl_SetWideIntObj\fR
 349 .VE 8.4
 350 invalidate any old string representation and,
 351 if the object is not already an integer object,
 352 free any old internal representation.
 353 .PP
 354 \fBTcl_GetIntFromObj\fR and \fBTcl_GetLongFromObj\fR
 355 attempt to return an integer value from the Tcl object \fIobjPtr\fR,
 356 .VS 8.4
 357 and \fBTcl_GetWideIntFromObj\fR attempts to return a wide integer
 358 value from the Tcl object \fIobjPtr\fR.
 359 If the object is not already an integer object,
 360 or a wide integer object in the case of \fBTcl_GetWideIntFromObj\fR
 361 .VE 8.4
 362 they will attempt to convert it to one.
 363 If an error occurs during conversion, they return \fBTCL_ERROR\fR
 364 and leave an error message in the interpreter's result object
 365 unless \fIinterp\fR is NULL.
 366 Also, if the long integer held in the object's internal representation
 367 \fIlongValue\fR member can not be represented in a (non-long) integer,
 368 \fBTcl_GetIntFromObj\fR returns \fBTCL_ERROR\fR
 369 and leaves an error message in the interpreter's result object
 370 unless \fIinterp\fR is NULL.
 371 Otherwise, all three procedures return \fBTCL_OK\fR and
 372 store the integer, long integer value
 373 .VS 8.4
 374 or wide integer in the address given by \fIintPtr\fR, \fIlongPtr\fR
 375 and \fIwidePtr\fR
 376 .VE 8.4
 377 respectively.  If the object is not already an integer or wide integer
 378 object, the conversion will free any old internal representation.
 379
 380 .SH "SEE ALSO"
 381 Tcl_NewObj, Tcl_DecrRefCount, Tcl_IncrRefCount, Tcl_GetObjResult
 382
 383 .SH KEYWORDS
 384 integer, integer object, integer type, internal representation, object, object type, string representation