HP/util/HP/man/man3/Tcl_UpdateLinkedVar.3

   1 '\"
   2 '\" Copyright (c) 1993 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 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 '\" RCS: @(#) $Id: LinkVar.3,v 1.3 2000/04/14 23:01:51 hobbs Exp $
   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 '\" RCS: @(#) $Id: man.macros,v 1.3 1999/04/16 00:46:35 stanton Exp $
  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 .ta \\n()Au \\n()Bu
  85 .ie !"\\$3"" \{\
  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_LinkVar 3 7.5 Tcl "Tcl Library Procedures"
 247 .BS
 248 .SH NAME
 249 Tcl_LinkVar, Tcl_UnlinkVar, Tcl_UpdateLinkedVar \- link Tcl variable to C variable
 250 .SH SYNOPSIS
 251 .nf
 252 \fB#include <tcl.h>\fR
 253 .sp
 254 int
 255 \fBTcl_LinkVar\fR(\fIinterp, varName, addr, type\fR)
 256 .sp
 257 \fBTcl_UnlinkVar\fR(\fIinterp, varName\fR)
 258 .sp
 259 \fBTcl_UpdateLinkedVar\fR(\fIinterp, varName\fR)
 260 .SH ARGUMENTS
 261 .AS Tcl_Interp writable
 262 .AP Tcl_Interp *interp in
 263 Interpreter that contains \fIvarName\fR.
 264 Also used by \fBTcl_LinkVar\fR to return error messages.
 265 .AP char *varName in
 266 Name of global variable.  Must be in writable memory: Tcl may make
 267 temporary modifications to it while parsing the variable name.
 268 .AP char *addr in
 269 Address of C variable that is to be linked to \fIvarName\fR.
 270 .AP int type in
 271 Type of C variable.  Must be one of TCL_LINK_INT, TCL_LINK_DOUBLE,
 272 TCL_LINK_BOOLEAN, or TCL_LINK_STRING, optionally OR'ed with
 273 TCL_LINK_READ_ONLY to make Tcl variable read-only.
 274 .BE
 275
 276 .SH DESCRIPTION
 277 .PP
 278 \fBTcl_LinkVar\fR uses variable traces to keep the Tcl variable
 279 named by \fIvarName\fR in sync with the C variable at the address
 280 given by \fIaddr\fR.
 281 Whenever the Tcl variable is read the value of the C variable will
 282 be returned, and whenever the Tcl variable is written the C
 283 variable will be updated to have the same value.
 284 \fBTcl_LinkVar\fR normally returns TCL_OK;  if an error occurs
 285 while setting up the link (e.g. because \fIvarName\fR is the
 286 name of array) then TCL_ERROR is returned and the interpreter's result
 287 contains an error message.
 288 .PP
 289 The \fItype\fR argument specifies the type of the C variable,
 290 and must have one of the following values, optionally OR'ed with
 291 TCL_LINK_READ_ONLY:
 292 .TP
 293 \fBTCL_LINK_INT\fR
 294 The C variable is of type \fBint\fR.
 295 Any value written into the Tcl variable must have a proper integer
 296 form acceptable to \fBTcl_GetInt\fR;  attempts to write
 297 non-integer values into \fIvarName\fR will be rejected with
 298 Tcl errors.
 299 .TP
 300 \fBTCL_LINK_DOUBLE\fR
 301 The C variable is of type \fBdouble\fR.
 302 Any value written into the Tcl variable must have a proper real
 303 form acceptable to \fBTcl_GetDouble\fR;  attempts to write
 304 non-real values into \fIvarName\fR will be rejected with
 305 Tcl errors.
 306 .TP
 307 \fBTCL_LINK_BOOLEAN\fR
 308 The C variable is of type \fBint\fR.
 309 If its value is zero then it will read from Tcl as ``0'';
 310 otherwise it will read from Tcl as ``1''.
 311 Whenever \fIvarName\fR is
 312 modified, the C variable will be set to a 0 or 1 value.
 313 Any value written into the Tcl variable must have a proper boolean
 314 form acceptable to \fBTcl_GetBoolean\fR;  attempts to write
 315 non-boolean values into \fIvarName\fR will be rejected with
 316 Tcl errors.
 317 .TP
 318 \fBTCL_LINK_STRING\fR
 319 The C variable is of type \fBchar *\fR.
 320 .VS
 321 If its value is not null then it must be a pointer to a string
 322 allocated with \fBTcl_Alloc\fR.
 323 .VE
 324 Whenever the Tcl variable is modified the current C string will be
 325 freed and new memory will be allocated to hold a copy of the variable's
 326 new value.
 327 If the C variable contains a null pointer then the Tcl variable
 328 will read as ``NULL''.
 329 .PP
 330 If the TCL_LINK_READ_ONLY flag is present in \fItype\fR then the
 331 variable will be read-only from Tcl, so that its value can only be
 332 changed by modifying the C variable.
 333 Attempts to write the variable from Tcl will be rejected with errors.
 334 .PP
 335 \fBTcl_UnlinkVar\fR removes the link previously set up for the
 336 variable given by \fIvarName\fR.  If there does not exist a link
 337 for \fIvarName\fR then the procedure has no effect.
 338 .PP
 339 \fBTcl_UpdateLinkedVar\fR may be invoked after the C variable has
 340 changed to force the Tcl variable to be updated immediately.
 341 In many cases this procedure is not needed, since any attempt to
 342 read the Tcl variable will return the latest value of the C variable.
 343 However, if a trace has been set on the Tcl variable (such as a
 344 Tk widget that wishes to display the value of the variable), the
 345 trace will not trigger when the C variable has changed.
 346 \fBTcl_UpdateLinkedVar\fR ensures that any traces on the Tcl
 347 variable are invoked.
 348
 349 .SH KEYWORDS
 350 boolean, integer, link, read-only, real, string, traces, variable