util/X86LINUX64/man/man3/Tcl_QueryTimeProc.3

   1 '\"
   2 '\" Copyright (c) 2001 by Kevin B. Kenny <kennykb@acm.org>.
   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 .TH Tcl_GetTime 3 8.4 Tcl "Tcl Library Procedures"
   8 .\" The -*- nroff -*- definitions below are for supplemental macros used
   9 .\" in Tcl/Tk manual entries.
  10 .\"
  11 .\" .AP type name in/out ?indent?
  12 .\"     Start paragraph describing an argument to a library procedure.
  13 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  14 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  15 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  16 .\"     needed;  use .AS below instead)
  17 .\"
  18 .\" .AS ?type? ?name?
  19 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  20 .\"     name are examples of largest possible arguments that will be passed
  21 .\"     to .AP later.  If args are omitted, default tab stops are used.
  22 .\"
  23 .\" .BS
  24 .\"     Start box enclosure.  From here until next .BE, everything will be
  25 .\"     enclosed in one large box.
  26 .\"
  27 .\" .BE
  28 .\"     End of box enclosure.
  29 .\"
  30 .\" .CS
  31 .\"     Begin code excerpt.
  32 .\"
  33 .\" .CE
  34 .\"     End code excerpt.
  35 .\"
  36 .\" .VS ?version? ?br?
  37 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  38 .\"     of man pages.  The first argument is ignored and used for recording
  39 .\"     the version when the .VS was added, so that the sidebars can be
  40 .\"     found and removed when they reach a certain age.  If another argument
  41 .\"     is present, then a line break is forced before starting the sidebar.
  42 .\"
  43 .\" .VE
  44 .\"     End of vertical sidebar.
  45 .\"
  46 .\" .DS
  47 .\"     Begin an indented unfilled display.
  48 .\"
  49 .\" .DE
  50 .\"     End of indented unfilled display.
  51 .\"
  52 .\" .SO ?manpage?
  53 .\"     Start of list of standard options for a Tk widget. The manpage
  54 .\"     argument defines where to look up the standard options; if
  55 .\"     omitted, defaults to "options". The options follow on successive
  56 .\"     lines, in three columns separated 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 .\" .QW arg1 ?arg2?
  71 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  72 .\"
  73 .\" .PQ arg1 ?arg2?
  74 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  75 .\"     (for trailing punctuation) and then a closing parenthesis.
  76 .\"
  77 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  78 .if t .wh -1.3i ^B
  79 .nr ^l \n(.l
  80 .ad b
  81 .\"     # Start an argument description
  82 .de AP
  83 .ie !"\\$4"" .TP \\$4
  84 .el \{\
  85 .   ie !"\\$2"" .TP \\n()Cu
  86 .   el          .TP 15
  87 .\}
  88 .ta \\n()Au \\n()Bu
  89 .ie !"\\$3"" \{\
  90 \&\\$1 \\fI\\$2\\fP (\\$3)
  91 .\".b
  92 .\}
  93 .el \{\
  94 .br
  95 .ie !"\\$2"" \{\
  96 \&\\$1  \\fI\\$2\\fP
  97 .\}
  98 .el \{\
  99 \&\\fI\\$1\\fP
 100 .\}
 101 .\}
 102 ..
 103 .\"     # define tabbing values for .AP
 104 .de AS
 105 .nr )A 10n
 106 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 107 .nr )B \\n()Au+15n
 108 .\"
 109 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 110 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 111 ..
 112 .AS Tcl_Interp Tcl_CreateInterp in/out
 113 .\"     # BS - start boxed text
 114 .\"     # ^y = starting y location
 115 .\"     # ^b = 1
 116 .de BS
 117 .br
 118 .mk ^y
 119 .nr ^b 1u
 120 .if n .nf
 121 .if n .ti 0
 122 .if n \l'\\n(.lu\(ul'
 123 .if n .fi
 124 ..
 125 .\"     # BE - end boxed text (draw box now)
 126 .de BE
 127 .nf
 128 .ti 0
 129 .mk ^t
 130 .ie n \l'\\n(^lu\(ul'
 131 .el \{\
 132 .\"     Draw four-sided box normally, but don't draw top of
 133 .\"     box if the box started on an earlier page.
 134 .ie !\\n(^b-1 \{\
 135 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 136 .\}
 137 .el \}\
 138 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 139 .\}
 140 .\}
 141 .fi
 142 .br
 143 .nr ^b 0
 144 ..
 145 .\"     # VS - start vertical sidebar
 146 .\"     # ^Y = starting y location
 147 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 148 .de VS
 149 .if !"\\$2"" .br
 150 .mk ^Y
 151 .ie n 'mc \s12\(br\s0
 152 .el .nr ^v 1u
 153 ..
 154 .\"     # VE - end of vertical sidebar
 155 .de VE
 156 .ie n 'mc
 157 .el \{\
 158 .ev 2
 159 .nf
 160 .ti 0
 161 .mk ^t
 162 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 163 .sp -1
 164 .fi
 165 .ev
 166 .\}
 167 .nr ^v 0
 168 ..
 169 .\"     # Special macro to handle page bottom:  finish off current
 170 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 171 .\"     # page bottom macro.
 172 .de ^B
 173 .ev 2
 174 'ti 0
 175 'nf
 176 .mk ^t
 177 .if \\n(^b \{\
 178 .\"     Draw three-sided box if this is the box's first page,
 179 .\"     draw two sides but no top otherwise.
 180 .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
 181 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 182 .\}
 183 .if \\n(^v \{\
 184 .nr ^x \\n(^tu+1v-\\n(^Yu
 185 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 186 .\}
 187 .bp
 188 'fi
 189 .ev
 190 .if \\n(^b \{\
 191 .mk ^y
 192 .nr ^b 2
 193 .\}
 194 .if \\n(^v \{\
 195 .mk ^Y
 196 .\}
 197 ..
 198 .\"     # DS - begin display
 199 .de DS
 200 .RS
 201 .nf
 202 .sp
 203 ..
 204 .\"     # DE - end display
 205 .de DE
 206 .fi
 207 .RE
 208 .sp
 209 ..
 210 .\"     # SO - start of list of standard options
 211 .de SO
 212 'ie '\\$1'' .ds So \\fBoptions\\fR
 213 'el .ds So \\fB\\$1\\fR
 214 .SH "STANDARD OPTIONS"
 215 .LP
 216 .nf
 217 .ta 5.5c 11c
 218 .ft B
 219 ..
 220 .\"     # SE - end of list of standard options
 221 .de SE
 222 .fi
 223 .ft R
 224 .LP
 225 See the \\*(So manual entry for details on the standard options.
 226 ..
 227 .\"     # OP - start of full description for a single option
 228 .de OP
 229 .LP
 230 .nf
 231 .ta 4c
 232 Command-Line Name:      \\fB\\$1\\fR
 233 Database Name:  \\fB\\$2\\fR
 234 Database Class: \\fB\\$3\\fR
 235 .fi
 236 .IP
 237 ..
 238 .\"     # CS - begin code excerpt
 239 .de CS
 240 .RS
 241 .nf
 242 .ta .25i .5i .75i 1i
 243 ..
 244 .\"     # CE - end code excerpt
 245 .de CE
 246 .fi
 247 .RE
 248 ..
 249 .\"     # UL - underline word
 250 .de UL
 251 \\$1\l'|0\(ul'\\$2
 252 ..
 253 .\"     # QW - apply quotation marks to word
 254 .de QW
 255 .ie '\\*(lq'"' ``\\$1''\\$2
 256 .\"" fix emacs highlighting
 257 .el \\*(lq\\$1\\*(rq\\$2
 258 ..
 259 .\"     # PQ - apply parens and quotation marks to word
 260 .de PQ
 261 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 262 .\"" fix emacs highlighting
 263 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 264 ..
 265 .\"     # QR - quoted range
 266 .de QR
 267 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 268 .\"" fix emacs highlighting
 269 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 270 ..
 271 .\"     # MT - "empty" string
 272 .de MT
 273 .QW ""
 274 ..
 275 .BS
 276 .SH NAME
 277 Tcl_GetTime, Tcl_SetTimeProc, Tcl_QueryTimeProc \- get date and time
 278 .SH SYNOPSIS
 279 .nf
 280 \fB#include <tcl.h>\fR
 281 .sp
 282 \fBTcl_GetTime\fR(\fItimePtr\fR)
 283 .sp
 284 \fBTcl_SetTimeProc\fR(\fIgetProc, scaleProc, clientData\fR)
 285 .sp
 286 \fBTcl_QueryTimeProc\fR(\fIgetProcPtr, scaleProcPtr, clientDataPtr\fR)
 287 .SH ARGUMENTS
 288 .AS Tcl_GetTimeProc *getProc in
 289 .AP Tcl_Time *timePtr out
 290 Points to memory in which to store the date and time information.
 291 .AP Tcl_GetTimeProc getProc in
 292 Pointer to handler function replacing \fBTcl_GetTime\fR's access to the OS.
 293 .AP Tcl_ScaleTimeProc scaleProc in
 294 Pointer to handler function for the conversion of time delays in the
 295 virtual domain to real-time.
 296 .AP ClientData clientData in
 297 Value passed through to the two handler functions.
 298 .AP Tcl_GetTimeProc *getProcPtr out
 299 Pointer to place the currently registered get handler function into.
 300 .AP Tcl_ScaleTimeProc *scaleProcPtr out
 301 Pointer to place the currently registered scale handler function into.
 302 .AP ClientData *clientDataPtr out
 303 Pointer to place the currently registered pass-through value into.
 304 .BE
 305 .SH DESCRIPTION
 306 .PP
 307 The \fBTcl_GetTime\fR function retrieves the current time as a
 308 \fITcl_Time\fR structure in memory the caller provides.  This
 309 structure has the following definition:
 310 .PP
 311 .CS
 312 typedef struct Tcl_Time {
 313     long \fIsec\fR;
 314     long \fIusec\fR;
 315 } \fBTcl_Time\fR;
 316 .CE
 317 .PP
 318 On return, the \fIsec\fR member of the structure is filled in with the
 319 number of seconds that have elapsed since the \fIepoch:\fR the epoch
 320 is the point in time of 00:00 UTC, 1 January 1970.  This number does
 321 \fInot\fR count leap seconds \- an interval of one day advances it by
 322 86400 seconds regardless of whether a leap second has been inserted.
 323 .PP
 324 The \fIusec\fR member of the structure is filled in with the number of
 325 microseconds that have elapsed since the start of the second
 326 designated by \fIsec\fR.  The Tcl library makes every effort to keep
 327 this number as precise as possible, subject to the limitations of the
 328 computer system.  On multiprocessor variants of Windows, this number
 329 may be limited to the 10- or 20-ms granularity of the system clock.
 330 (On single-processor Windows systems, the \fIusec\fR field is derived
 331 from a performance counter and is highly precise.)
 332 .SS "VIRTUALIZED TIME"
 333 .PP
 334 The \fBTcl_SetTimeProc\fR function registers two related handler functions
 335 with the core. The first handler function is a replacement for
 336 \fBTcl_GetTime\fR, or rather the OS access made by
 337 \fBTcl_GetTime\fR. The other handler function is used by the Tcl
 338 notifier to convert wait/block times from the virtual domain into real
 339 time.
 340 .PP
 341 The \fBTcl_QueryTimeProc\fR function returns the currently registered
 342 handler functions. If no external handlers were set then this will
 343 return the standard handlers accessing and processing the native time
 344 of the OS. The arguments to the function are allowed to be NULL; and
 345 any argument which is NULL is ignored and not set.
 346 .PP
 347 The signatures of the handler functions are as follows:
 348 .PP
 349 .CS
 350 typedef void \fBTcl_GetTimeProc\fR(
 351         Tcl_Time *\fItimebuf\fR,
 352         ClientData \fIclientData\fR);
 353 typedef void \fBTcl_ScaleTimeProc\fR(
 354         Tcl_Time *\fItimebuf\fR,
 355         ClientData \fIclientData\fR);
 356 .CE
 357 .PP
 358 The \fItimebuf\fR fields contain the time to manipulate, and the
 359 \fIclientData\fR fields contain a pointer supplied at the time the handler
 360 functions were registered.
 361 .PP
 362 Any handler pair specified has to return data which is consistent between
 363 them. In other words, setting one handler of the pair to something assuming a
 364 10-times slowdown, and the other handler of the pair to something assuming a
 365 two-times slowdown is wrong and not allowed.
 366 .PP
 367 The set handler functions are allowed to run the delivered time backwards,
 368 however this should be avoided. We have to allow it as the native time can run
 369 backwards as the user can fiddle with the system time one way or other. Note
 370 that the insertion of the hooks will not change the behavior of the Tcl core
 371 with regard to this situation, i.e. the existing behavior is retained.
 372 .SH "SEE ALSO"
 373 clock(n)
 374 .SH KEYWORDS
 375 date, time