File: time.tm

package info (click to toggle)
slang2 2.3.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 11,488 kB
  • sloc: ansic: 101,756; sh: 3,435; makefile: 1,046; pascal: 440
file content (240 lines) | stat: -rw-r--r-- 8,215 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
\function{ctime}
\synopsis{Convert a calendar time to a string}
\usage{String_Type ctime(Long_Type secs)}
\description
  This function returns a string representation of the time as given
  by \exmp{secs} seconds since 00:00:00 UTC, Jan 1, 1970.
\seealso{time, strftime, _time, localtime, gmtime}
\done

\function{gmtime}
\synopsis{Break down a time in seconds to the GMT timezone}
\usage{Struct_Type gmtime (Long_Type secs)}
\description
  The \ifun{gmtime} function is exactly like \ifun{localtime} except
  that the values in the structure it returns are with respect to GMT
  instead of the local timezone.  See the documentation for
  \ifun{localtime} for more information.
\notes
  On systems that do not support the \ifun{gmtime} C library function,
  this function is the same as \ifun{localtime}.
\seealso{localtime, _time, mktime}
\done

\function{localtime}
\synopsis{Break down a time in seconds to the local timezone}
\usage{Struct_Type localtime (Long_Type secs)}
\description
  The \ifun{localtime} function takes a parameter \exmp{secs}
  representing the number of seconds since 00:00:00, January 1 1970
  UTC and returns a structure containing information about \exmp{secs}
  in the local timezone.  The structure contains the following
  \dtype{Int_Type} fields:

  \var{tm_sec} The number of seconds after the minute, normally
     in the range 0 to 59, but can be up to 61 to allow for
     leap seconds.

  \var{tm_min} The number of minutes after the hour, in the
     range 0 to 59.

  \var{tm_hour} The number of hours past midnight, in the range
     0 to 23.

  \var{tm_mday} The day of the month, in the range 1 to 31.

  \var{tm_mon} The number of months since January, in the range
     0 to 11.

  \var{tm_year} The number of years since 1900.

  \var{tm_wday} The number of days since Sunday, in the range 0
     to 6.

  \var{tm_yday} The number of days since January 1, in the
     range 0 to 365.

  \var{tm_isdst} A flag that indicates whether daylight saving
     time is in effect at the time described.  The value is
     positive if daylight saving time is in effect, zero if it
     is not, and negative if the information is not available.
\seealso{gmtime, _time, ctime, mktime}
\done

\function{mktime}
\synopsis{Convert a time-structure to seconds}
\usage{secs = mktime (Struct_Type tm)}
\description
  The \ifun{mktime} function is essentially the inverse of the
  \ifun{localtime} function.  See the documentation for that function
  for more details.
\seealso{localtime, gmtime, _time}
\done

\function{strftime}
\synopsis{Format a date and time string}
\usage{str = strftime (String_Type format [,Struct_Type tm])}
\description
  The \ifun{strftime} creates a date and time string according to a
  specified format.  If called with a single argument, the current
  local time will be used as the reference time.  If called with two
  arguments, the second argument specifies the reference time, and
  must be a structure with the same fields as the structure returned
  by the \ifun{localtime} function.

  The format string may be composed of one or more of the following
  format descriptors:
#v+
       %A      full weekday name (Monday)
       %a      abbreviated weekday name (Mon)
       %B      full month name (January)
       %b      abbreviated month name (Jan)
       %c      standard date and time representation
       %d      day-of-month (01-31)
       %H      hour (24 hour clock) (00-23)
       %I      hour (12 hour clock) (01-12)
       %j      day-of-year (001-366)
       %M      minute (00-59)
       %m      month (01-12)
       %p      local equivalent of AM or PM
       %S      second (00-59)
       %U      week-of-year, first day Sunday (00-53)
       %W      week-of-year, first day Monday (00-53)
       %w      weekday (0-6, Sunday is 0)
       %X      standard time representation
       %x      standard date representation
       %Y      year with century
       %y      year without century (00-99)
       %Z      timezone name
       %%      percent sign
#v-
 as well as any others provided by the C library.  The actual values
 represented by the format descriptors are locale-dependent.
\example
#v+
    message (strftime ("Today is %A, day %j of the year"));
    tm = localtime (0);
    message (strftime ("Unix time 0 was on a %A", tm));
#v-
\seealso{localtime, time}
\done

\function{_tic}
\synopsis{Reset the CPU timer}
\usage{_tic ()}
\description
  The \ifun{_tic} function resets the internal CPU timer.  The
 \ifun{_toc} may be used to read this timer.  See the documentation
 for the \ifun{_toc} function for more information.
\seealso{_toc, times, tic, toc}
\done

\function{tic}
\synopsis{Reset the interval timer}
\usage{void tic ()}
\description
  The \ifun{tic} function resets the internal interval timer.  The
 \ifun{toc} may be used to read the interval timer.
\example
  The tic/toc functions may be used to measure execution times.  For
 example, at the \slsh prompt, they may be used to measure the speed
 of a loop:
#v+
   slsh> tic; loop (500000); toc;
   0.06558
#v-
\notes
  On Unix, this timer makes use of the C library \cfun{gettimeofday}
  function.
\seealso{toc, _toc, _tic, times}
\done

\function{_time}
\synopsis{Get the current calendar time in seconds}
\usage{Long_Type _time ()}
\description
  The \ifun{_time} function returns the number of elapsed seconds since
  00:00:00 UTC, January 1, 1970.  A number of functions (\ifun{ctime},
  \ifun{gmtime}, \ifun{localtime}, etc.) are able to convert such a
  value to other representations.
\notes
  This function is a wrapper around the C library \exmp{time}
  function, and as such, probably does not account for leap seconds.
\seealso{_ftime, ctime, time, localtime, gmtime}
\done

\function{_ftime}
\synopsis{Get the current calendar time in seconds}
\usage{Double_Type _ftime ( [Double_Type opt_epoch] )}
\description
  The \ifun{_ftime} function returns the number seconds since the Unix
  epoch, 00:00:00 UTC, January 1, 1970 as a double precision number.
  If the optional argument \exmp{opt_epoch} is passed, the function
  will return a value relative to that epoch, which is defined as the
  number of seconds since the Unix epoch.
\seealso{_time, ctime, time, localtime, gmtime}
\done

\function{time}
\synopsis{Return the current date and time as a string}
\usage{String_Type time ()}
\description
  This function returns the current time as a string of the form:
#v+
    Sun Apr 21 13:34:17 1996
#v-
\seealso{strftime, ctime, message, substr}
\done

\function{timegm}
\synopsis{Convert a time structure for the GMT timezone to seconds}
\usage{Long_Type secs = timegm(Struct_Type tm)}
\description
  \ifun{timegm} is the inverse of the \ifun{gmtime} function.
\seealso{gmtime, mktime, localtime}
\done

\function{times}
\synopsis{Get process times}
\usage{Struct_Type times ()}
\description
  The \ifun{times} function returns a structure containing the
  following fields:
#v+
    tms_utime     (user time)
    tms_stime     (system time)
    tms_cutime    (user time of child processes)
    tms_cstime    (system time of child processes)
#v-
\notes
  Not all systems support this function.
\seealso{_tic, _toc, _time}
\done

\function{_toc}
\synopsis{Get the elapsed CPU time for the current process}
\usage{Double_Type _toc ()}
\description
  The \ifun{_toc} function returns the elapsed CPU time in seconds since
  the last call to \ifun{_tic}.  The CPU time is the amount of time the
  CPU spent running the code of the current process.
\notes
  This function may not be available on all systems.

  The implementation of this function is based upon the \ifun{times}
  system call.  The precision of the clock is system dependent and may
  not be very accurate for small time intervals.  For this reason, the
  tic/toc functions may be more useful for small time-intervals.
\seealso{_tic, tic, toc, times, _time}
\done

\function{toc}
\synopsis{Read the interval timer}
\usage{Double_Type toc ()}
\description
  The \ifun{toc} function returns the elapsed time in seconds since
  the last call to \ifun{tic}.  See the documentation for the
 \ifun{tic} function for more information.
\seealso{tic, _tic, _toc, times, _time}
\done