HP/util/HP/man/man3/Tcl_NewLongObj.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.2 1998/09/14 18:39:49 stanton 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.3 1999/04/16 00:46:35 stanton 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 4c 8c 12c
 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_SetIntObj, Tcl_SetLongObj, Tcl_GetIntFromObj, Tcl_GetLongFromObj \- manipulate Tcl objects as 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 \fBTcl_SetIntObj\fR(\fIobjPtr, intValue\fR)
 260 .sp
 261 \fBTcl_SetLongObj\fR(\fIobjPtr, longValue\fR)
 262 .sp
 263 int
 264 \fBTcl_GetIntFromObj\fR(\fIinterp, objPtr, intPtr\fR)
 265 .sp
 266 int
 267 \fBTcl_GetLongFromObj\fR(\fIinterp, objPtr, longPtr\fR)
 268 .SH ARGUMENTS
 269 .AS Tcl_Interp *interp
 270 .AP int intValue in
 271 Integer value used to initialize or set an integer object.
 272 .AP long longValue in
 273 Long integer value used to initialize or set an integer object.
 274 .AP Tcl_Obj *objPtr in/out
 275 For \fBTcl_SetIntObj\fR and \fBTcl_SetLongObj\fR,
 276 this points to the object to be converted to integer type.
 277 For \fBTcl_GetIntFromObj\fR and \fBTcl_GetLongFromObj\fR,
 278 this refers to the object
 279 from which to get an integer or long integer value;
 280 if \fIobjPtr\fR does not already point to an integer object,
 281 an attempt will be made to convert it to one.
 282 .AP Tcl_Interp *interp in/out
 283 If an error occurs during conversion,
 284 an error message is left in the interpreter's result object
 285 unless \fIinterp\fR is NULL.
 286 .AP int *intPtr out
 287 Points to place to store the integer value
 288 obtained by \fBTcl_GetIntFromObj\fR from \fIobjPtr\fR.
 289 .AP long *longPtr out
 290 Points to place to store the long integer value
 291 obtained by \fBTcl_GetLongFromObj\fR from \fIobjPtr\fR.
 292 .BE
 293
 294 .SH DESCRIPTION
 295 .PP
 296 These procedures are used to create, modify, and read
 297 integer Tcl objects from C code.
 298 \fBTcl_NewIntObj\fR, \fBTcl_NewLongObj\fR,
 299 \fBTcl_SetIntObj\fR, and \fBTcl_SetLongObj\fR
 300 create a new object of integer type
 301 or modify an existing object to have integer type.
 302 \fBTcl_NewIntObj\fR and \fBTcl_SetIntObj\fR set the object to have the
 303 integer value given by \fIintValue\fR,
 304 while \fBTcl_NewLongObj\fR and \fBTcl_SetLongObj\fR
 305 set the object to have the
 306 long integer value given by \fIlongValue\fR.
 307 \fBTcl_NewIntObj\fR and \fBTcl_NewLongObj\fR
 308 return a pointer to a newly created object with reference count zero.
 309 These procedures set the object's type to be integer
 310 and assign the integer value to the object's internal representation
 311 \fIlongValue\fR member.
 312 \fBTcl_SetIntObj\fR and \fBTcl_SetLongObj\fR
 313 invalidate any old string representation and,
 314 if the object is not already an integer object,
 315 free any old internal representation.
 316 .PP
 317 \fBTcl_GetIntFromObj\fR and \fBTcl_GetLongFromObj\fR
 318 attempt to return an integer value from the Tcl object \fIobjPtr\fR.
 319 If the object is not already an integer object,
 320 they will attempt to convert it to one.
 321 If an error occurs during conversion, they return \fBTCL_ERROR\fR
 322 and leave an error message in the interpreter's result object
 323 unless \fIinterp\fR is NULL.
 324 Also, if the long integer held in the object's internal representation
 325 \fIlongValue\fR member can not be represented in a (non-long) integer,
 326 \fBTcl_GetIntFromObj\fR returns \fBTCL_ERROR\fR
 327 and leaves an error message in the interpreter's result object
 328 unless \fIinterp\fR is NULL.
 329 Otherwise, both procedures return \fBTCL_OK\fR and
 330 store the integer or the long integer value
 331 in the address given by \fIintPtr\fR and \fIlongPtr\fR respectively.
 332 If the object is not already an integer object,
 333 the conversion will free any old internal representation.
 334
 335 .SH "SEE ALSO"
 336 Tcl_NewObj, Tcl_DecrRefCount, Tcl_IncrRefCount, Tcl_GetObjResult
 337
 338 .SH KEYWORDS
 339 integer, integer object, integer type, internal representation, object, object type, string representation