util/X86LINUX64/man/man3/Tcl_DiscardResult.3

   1 '\"
   2 '\" Copyright (c) 1997 by Sun Microsystems, Inc.
   3 '\" Contributions from Don Porter, NIST, 2004. (not subject to US copyright)
   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 .TH Tcl_SaveResult 3 8.1 Tcl "Tcl Library Procedures"
   9 .\" The -*- nroff -*- definitions below are for supplemental macros used
  10 .\" in Tcl/Tk 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 ?manpage?
  54 .\"     Start of list of standard options for a Tk widget. The manpage
  55 .\"     argument defines where to look up the standard options; if
  56 .\"     omitted, defaults to "options". The options follow on successive
  57 .\"     lines, in three columns separated 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 .\" .QW arg1 ?arg2?
  72 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  73 .\"
  74 .\" .PQ arg1 ?arg2?
  75 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  76 .\"     (for trailing punctuation) and then a closing parenthesis.
  77 .\"
  78 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  79 .if t .wh -1.3i ^B
  80 .nr ^l \n(.l
  81 .ad b
  82 .\"     # Start an argument description
  83 .de AP
  84 .ie !"\\$4"" .TP \\$4
  85 .el \{\
  86 .   ie !"\\$2"" .TP \\n()Cu
  87 .   el          .TP 15
  88 .\}
  89 .ta \\n()Au \\n()Bu
  90 .ie !"\\$3"" \{\
  91 \&\\$1 \\fI\\$2\\fP (\\$3)
  92 .\".b
  93 .\}
  94 .el \{\
  95 .br
  96 .ie !"\\$2"" \{\
  97 \&\\$1  \\fI\\$2\\fP
  98 .\}
  99 .el \{\
 100 \&\\fI\\$1\\fP
 101 .\}
 102 .\}
 103 ..
 104 .\"     # define tabbing values for .AP
 105 .de AS
 106 .nr )A 10n
 107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 108 .nr )B \\n()Au+15n
 109 .\"
 110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 112 ..
 113 .AS Tcl_Interp Tcl_CreateInterp in/out
 114 .\"     # BS - start boxed text
 115 .\"     # ^y = starting y location
 116 .\"     # ^b = 1
 117 .de BS
 118 .br
 119 .mk ^y
 120 .nr ^b 1u
 121 .if n .nf
 122 .if n .ti 0
 123 .if n \l'\\n(.lu\(ul'
 124 .if n .fi
 125 ..
 126 .\"     # BE - end boxed text (draw box now)
 127 .de BE
 128 .nf
 129 .ti 0
 130 .mk ^t
 131 .ie n \l'\\n(^lu\(ul'
 132 .el \{\
 133 .\"     Draw four-sided box normally, but don't draw top of
 134 .\"     box if the box started on an earlier page.
 135 .ie !\\n(^b-1 \{\
 136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 137 .\}
 138 .el \}\
 139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 140 .\}
 141 .\}
 142 .fi
 143 .br
 144 .nr ^b 0
 145 ..
 146 .\"     # VS - start vertical sidebar
 147 .\"     # ^Y = starting y location
 148 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 149 .de VS
 150 .if !"\\$2"" .br
 151 .mk ^Y
 152 .ie n 'mc \s12\(br\s0
 153 .el .nr ^v 1u
 154 ..
 155 .\"     # VE - end of vertical sidebar
 156 .de VE
 157 .ie n 'mc
 158 .el \{\
 159 .ev 2
 160 .nf
 161 .ti 0
 162 .mk ^t
 163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 164 .sp -1
 165 .fi
 166 .ev
 167 .\}
 168 .nr ^v 0
 169 ..
 170 .\"     # Special macro to handle page bottom:  finish off current
 171 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 172 .\"     # page bottom macro.
 173 .de ^B
 174 .ev 2
 175 'ti 0
 176 'nf
 177 .mk ^t
 178 .if \\n(^b \{\
 179 .\"     Draw three-sided box if this is the box's first page,
 180 .\"     draw two sides but no top otherwise.
 181 .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
 182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 183 .\}
 184 .if \\n(^v \{\
 185 .nr ^x \\n(^tu+1v-\\n(^Yu
 186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 187 .\}
 188 .bp
 189 'fi
 190 .ev
 191 .if \\n(^b \{\
 192 .mk ^y
 193 .nr ^b 2
 194 .\}
 195 .if \\n(^v \{\
 196 .mk ^Y
 197 .\}
 198 ..
 199 .\"     # DS - begin display
 200 .de DS
 201 .RS
 202 .nf
 203 .sp
 204 ..
 205 .\"     # DE - end display
 206 .de DE
 207 .fi
 208 .RE
 209 .sp
 210 ..
 211 .\"     # SO - start of list of standard options
 212 .de SO
 213 'ie '\\$1'' .ds So \\fBoptions\\fR
 214 'el .ds So \\fB\\$1\\fR
 215 .SH "STANDARD OPTIONS"
 216 .LP
 217 .nf
 218 .ta 5.5c 11c
 219 .ft B
 220 ..
 221 .\"     # SE - end of list of standard options
 222 .de SE
 223 .fi
 224 .ft R
 225 .LP
 226 See the \\*(So manual entry for details on the standard options.
 227 ..
 228 .\"     # OP - start of full description for a single option
 229 .de OP
 230 .LP
 231 .nf
 232 .ta 4c
 233 Command-Line Name:      \\fB\\$1\\fR
 234 Database Name:  \\fB\\$2\\fR
 235 Database Class: \\fB\\$3\\fR
 236 .fi
 237 .IP
 238 ..
 239 .\"     # CS - begin code excerpt
 240 .de CS
 241 .RS
 242 .nf
 243 .ta .25i .5i .75i 1i
 244 ..
 245 .\"     # CE - end code excerpt
 246 .de CE
 247 .fi
 248 .RE
 249 ..
 250 .\"     # UL - underline word
 251 .de UL
 252 \\$1\l'|0\(ul'\\$2
 253 ..
 254 .\"     # QW - apply quotation marks to word
 255 .de QW
 256 .ie '\\*(lq'"' ``\\$1''\\$2
 257 .\"" fix emacs highlighting
 258 .el \\*(lq\\$1\\*(rq\\$2
 259 ..
 260 .\"     # PQ - apply parens and quotation marks to word
 261 .de PQ
 262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 263 .\"" fix emacs highlighting
 264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 265 ..
 266 .\"     # QR - quoted range
 267 .de QR
 268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 269 .\"" fix emacs highlighting
 270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 271 ..
 272 .\"     # MT - "empty" string
 273 .de MT
 274 .QW ""
 275 ..
 276 .BS
 277 .SH NAME
 278 Tcl_SaveInterpState, Tcl_RestoreInterpState, Tcl_DiscardInterpState, Tcl_SaveResult, Tcl_RestoreResult, Tcl_DiscardResult \- save and restore an interpreter's state
 279 .SH SYNOPSIS
 280 .nf
 281 \fB#include <tcl.h>\fR
 282 .sp
 283 Tcl_InterpState
 284 \fBTcl_SaveInterpState\fR(\fIinterp, status\fR)
 285 .sp
 286 int
 287 \fBTcl_RestoreInterpState\fR(\fIinterp, state\fR)
 288 .sp
 289 \fBTcl_DiscardInterpState\fR(\fIstate\fR)
 290 .sp
 291 \fBTcl_SaveResult\fR(\fIinterp, savedPtr\fR)
 292 .sp
 293 \fBTcl_RestoreResult\fR(\fIinterp, savedPtr\fR)
 294 .sp
 295 \fBTcl_DiscardResult\fR(\fIsavedPtr\fR)
 296 .SH ARGUMENTS
 297 .AS Tcl_InterpState savedPtr
 298 .AP Tcl_Interp *interp in
 299 Interpreter for which state should be saved.
 300 .AP int status in
 301 Return code value to save as part of interpreter state.
 302 .AP Tcl_InterpState state in
 303 Saved state token to be restored or discarded.
 304 .AP Tcl_SavedResult *savedPtr in
 305 Pointer to location where interpreter result should be saved or restored.
 306 .BE
 307 .SH DESCRIPTION
 308 .PP
 309 These routines allows a C procedure to take a snapshot of the current
 310 state of an interpreter so that it can be restored after a call
 311 to \fBTcl_Eval\fR or some other routine that modifies the interpreter
 312 state.  There are two triplets of routines meant to work together.
 313 .PP
 314 The first triplet stores the snapshot of interpreter state in
 315 an opaque token returned by \fBTcl_SaveInterpState\fR.  That token
 316 value may then be passed back to one of \fBTcl_RestoreInterpState\fR
 317 or \fBTcl_DiscardInterpState\fR, depending on whether the interp
 318 state is to be restored.  So long as one of the latter two routines
 319 is called, Tcl will take care of memory management.
 320 .PP
 321 The second triplet stores the snapshot of only the interpreter
 322 result (not its complete state) in memory allocated by the caller.
 323 These routines are passed a pointer to a \fBTcl_SavedResult\fR structure
 324 that is used to store enough information to restore the interpreter result.
 325 This structure can be allocated on the stack of the calling
 326 procedure.  These routines do not save the state of any error
 327 information in the interpreter (e.g. the \fB\-errorcode\fR or
 328 \fB\-errorinfo\fR return options, when an error is in progress).
 329 .PP
 330 Because the routines \fBTcl_SaveInterpState\fR,
 331 \fBTcl_RestoreInterpState\fR, and \fBTcl_DiscardInterpState\fR perform
 332 a superset of the functions provided by the other routines,
 333 any new code should only make use of the more powerful routines.
 334 The older, weaker routines \fBTcl_SaveResult\fR, \fBTcl_RestoreResult\fR,
 335 and \fBTcl_DiscardResult\fR continue to exist only for the sake
 336 of existing programs that may already be using them.
 337 .PP
 338 \fBTcl_SaveInterpState\fR takes a snapshot of those portions of
 339 interpreter state that make up the full result of script evaluation.
 340 This include the interpreter result, the return code (passed in
 341 as the \fIstatus\fR argument, and any return options, including
 342 \fB\-errorinfo\fR and \fB\-errorcode\fR when an error is in progress.
 343 This snapshot is returned as an opaque token of type \fBTcl_InterpState\fR.
 344 The call to \fBTcl_SaveInterpState\fR does not itself change the
 345 state of the interpreter.  Unlike \fBTcl_SaveResult\fR, it does
 346 not reset the interpreter.
 347 .PP
 348 \fBTcl_RestoreInterpState\fR accepts a \fBTcl_InterpState\fR token
 349 previously returned by \fBTcl_SaveInterpState\fR and restores the
 350 state of the interp to the state held in that snapshot.  The return
 351 value of \fBTcl_RestoreInterpState\fR is the status value originally
 352 passed to \fBTcl_SaveInterpState\fR when the snapshot token was
 353 created.
 354 .PP
 355 \fBTcl_DiscardInterpState\fR is called to release a \fBTcl_InterpState\fR
 356 token previously returned by \fBTcl_SaveInterpState\fR when that
 357 snapshot is not to be restored to an interp.
 358 .PP
 359 The \fBTcl_InterpState\fR token returned by \fBTcl_SaveInterpState\fR
 360 must eventually be passed to either \fBTcl_RestoreInterpState\fR
 361 or \fBTcl_DiscardInterpState\fR to avoid a memory leak.  Once
 362 the \fBTcl_InterpState\fR token is passed to one of them, the
 363 token is no longer valid and should not be used anymore.
 364 .PP
 365 \fBTcl_SaveResult\fR moves the string and value results
 366 of \fIinterp\fR into the location specified by \fIstatePtr\fR.
 367 \fBTcl_SaveResult\fR clears the result for \fIinterp\fR and
 368 leaves the result in its normal empty initialized state.
 369 .PP
 370 \fBTcl_RestoreResult\fR moves the string and value results from
 371 \fIstatePtr\fR back into \fIinterp\fR.  Any result or error that was
 372 already in the interpreter will be cleared.  The \fIstatePtr\fR is left
 373 in an uninitialized state and cannot be used until another call to
 374 \fBTcl_SaveResult\fR.
 375 .PP
 376 \fBTcl_DiscardResult\fR releases the saved interpreter state
 377 stored at \fBstatePtr\fR.  The state structure is left in an
 378 uninitialized state and cannot be used until another call to
 379 \fBTcl_SaveResult\fR.
 380 .PP
 381 Once \fBTcl_SaveResult\fR is called to save the interpreter
 382 result, either \fBTcl_RestoreResult\fR or
 383 \fBTcl_DiscardResult\fR must be called to properly clean up the
 384 memory associated with the saved state.
 385 .SH KEYWORDS
 386 result, state, interp