1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME COMPONENTS --
5 -- A D A . C A L E N D A R --
9 -- Copyright (C) 1992-2008, Free Software Foundation, Inc. --
11 -- This specification is derived from the Ada Reference Manual for use with --
12 -- GNAT. The copyright notice above, and the license provisions that follow --
13 -- apply solely to the contents of the part following the private keyword. --
15 -- GNAT is free software; you can redistribute it and/or modify it under --
16 -- terms of the GNU General Public License as published by the Free Soft- --
17 -- ware Foundation; either version 2, or (at your option) any later ver- --
18 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
19 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
20 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
21 -- for more details. You should have received a copy of the GNU General --
22 -- Public License distributed with GNAT; see file COPYING. If not, write --
23 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
24 -- Boston, MA 02110-1301, USA. --
26 -- As a special exception, if other files instantiate generics from this --
27 -- unit, or you link this unit with other files to produce an executable, --
28 -- this unit does not by itself cause the resulting executable to be --
29 -- covered by the GNU General Public License. This exception does not --
30 -- however invalidate any other reasons why the executable file might be --
31 -- covered by the GNU Public License. --
33 -- GNAT was originally developed by the GNAT team at New York University. --
34 -- Extensive contributions were provided by Ada Core Technologies Inc. --
36 ------------------------------------------------------------------------------
38 -- This is the Alpha/VMS version
40 with System
.OS_Primitives
;
42 package Ada
.Calendar
is
44 package OSP
renames System
.OS_Primitives
;
48 -- Declarations representing limits of allowed local time values. Note
49 -- that these do NOT constrain the possible stored values of time which
50 -- may well permit a larger range of times (this is explicitly allowed
53 subtype Year_Number
is Integer range 1901 .. 2399;
54 subtype Month_Number
is Integer range 1 .. 12;
55 subtype Day_Number
is Integer range 1 .. 31;
57 subtype Day_Duration
is Duration range 0.0 .. 86_400
.0
;
59 function Clock
return Time
;
61 function Year
(Date
: Time
) return Year_Number
;
62 function Month
(Date
: Time
) return Month_Number
;
63 function Day
(Date
: Time
) return Day_Number
;
64 function Seconds
(Date
: Time
) return Day_Duration
;
68 Year
: out Year_Number
;
69 Month
: out Month_Number
;
71 Seconds
: out Day_Duration
);
77 Seconds
: Day_Duration
:= 0.0) return Time
;
79 function "+" (Left
: Time
; Right
: Duration) return Time
;
80 function "+" (Left
: Duration; Right
: Time
) return Time
;
81 function "-" (Left
: Time
; Right
: Duration) return Time
;
82 function "-" (Left
: Time
; Right
: Time
) return Duration;
84 function "<" (Left
, Right
: Time
) return Boolean;
85 function "<=" (Left
, Right
: Time
) return Boolean;
86 function ">" (Left
, Right
: Time
) return Boolean;
87 function ">=" (Left
, Right
: Time
) return Boolean;
89 Time_Error
: exception;
92 pragma Inline
(Clock
);
95 pragma Inline
(Month
);
102 pragma Inline
("<=");
104 pragma Inline
(">=");
106 -- Although the units are 100 nanoseconds, for the purpose of better
107 -- readability, this unit will be called "mili".
109 Mili
: constant := 10_000_000
;
110 Mili_F
: constant := 10_000_000
.0
;
111 Milis_In_Day
: constant := 864_000_000_000
;
112 Secs_In_Day
: constant := 86_400
;
114 -- Time is represented as the number of 100-nanosecond (ns) units from the
115 -- system base date and time 1858-11-17 0.0 (the Smithsonian base date and
116 -- time for the astronomic calendar).
118 -- The time value stored is typically a UTC value, as provided in standard
119 -- Unix environments. If this is the case then Split and Time_Of perform
120 -- required conversions to and from local times.
122 -- Notwithstanding this definition, Time is not quite the same as OS_Time.
123 -- Relative Time is positive, whereas relative OS_Time is negative,
124 -- but this declaration makes for easier conversion.
126 type Time
is new OSP
.OS_Time
;
128 Days_In_Month
: constant array (Month_Number
) of Day_Number
:=
129 (31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31);
131 Invalid_Time_Zone_Offset
: Long_Integer;
132 pragma Import
(C
, Invalid_Time_Zone_Offset
, "__gnat_invalid_tzoff");
134 function Is_Leap
(Year
: Year_Number
) return Boolean;
135 -- Determine whether a given year is leap
137 -- The following packages provide a target independent interface to the
138 -- children of Calendar - Arithmetic, Formatting and Time_Zones.
140 -- NOTE: Delays does not need a target independent interface because
141 -- VMS already has a target specific file for that package.
143 ---------------------------
144 -- Arithmetic_Operations --
145 ---------------------------
147 package Arithmetic_Operations
is
149 function Add
(Date
: Time
; Days
: Long_Integer) return Time
;
150 -- Add a certain number of days to a time value
155 Days
: out Long_Integer;
156 Seconds
: out Duration;
157 Leap_Seconds
: out Integer);
158 -- Calculate the difference between two time values in terms of days,
159 -- seconds and leap seconds elapsed. The leap seconds are not included
160 -- in the seconds returned. If Left is greater than Right, the returned
161 -- values are positive, negative otherwise.
163 function Subtract
(Date
: Time
; Days
: Long_Integer) return Time
;
164 -- Subtract a certain number of days from a time value
166 end Arithmetic_Operations
;
168 ---------------------------
169 -- Conversion_Operations --
170 ---------------------------
172 package Conversion_Operations
is
173 function To_Ada_Time
(Unix_Time
: Long_Integer) return Time
;
174 -- Unix to Ada Epoch conversion
183 tm_isdst
: Integer) return Time
;
184 -- Struct tm to Ada Epoch conversion
187 (tv_sec
: Long_Integer;
188 tv_nsec
: Long_Integer) return Duration;
189 -- Struct timespec to Duration conversion
191 procedure To_Struct_Timespec
193 tv_sec
: out Long_Integer;
194 tv_nsec
: out Long_Integer);
195 -- Duration to struct timespec conversion
197 procedure To_Struct_Tm
199 tm_year
: out Integer;
200 tm_mon
: out Integer;
201 tm_day
: out Integer;
202 tm_hour
: out Integer;
203 tm_min
: out Integer;
204 tm_sec
: out Integer);
205 -- Time to struct tm conversion
207 function To_Unix_Time
(Ada_Time
: Time
) return Long_Integer;
208 -- Ada to Unix Epoch conversion
210 end Conversion_Operations
;
212 ---------------------------
213 -- Formatting_Operations --
214 ---------------------------
216 package Formatting_Operations
is
218 function Day_Of_Week
(Date
: Time
) return Integer;
219 -- Determine which day of week Date falls on. The returned values are
220 -- within the range of 0 .. 6 (Monday .. Sunday).
224 Year
: out Year_Number
;
225 Month
: out Month_Number
;
226 Day
: out Day_Number
;
227 Day_Secs
: out Day_Duration
;
229 Minute
: out Integer;
230 Second
: out Integer;
231 Sub_Sec
: out Duration;
232 Leap_Sec
: out Boolean;
234 Time_Zone
: Long_Integer);
235 -- Split a time value into its components. Set Is_Ada_05 to use the
236 -- local time zone (the value in Time_Zone is ignored) when splitting
241 Month
: Month_Number
;
243 Day_Secs
: Day_Duration
;
248 Leap_Sec
: Boolean := False;
249 Use_Day_Secs
: Boolean := False;
250 Is_Ada_05
: Boolean := False;
251 Time_Zone
: Long_Integer := 0) return Time
;
252 -- Given all the components of a date, return the corresponding time
253 -- value. Set Use_Day_Secs to use the value in Day_Secs, otherwise the
254 -- day duration will be calculated from Hour, Minute, Second and Sub_
255 -- Sec. Set Is_Ada_05 to use the local time zone (the value in formal
256 -- Time_Zone is ignored) when building a time value and to verify the
257 -- validity of a requested leap second.
259 end Formatting_Operations
;
261 ---------------------------
262 -- Time_Zones_Operations --
263 ---------------------------
265 package Time_Zones_Operations
is
267 function UTC_Time_Offset
(Date
: Time
) return Long_Integer;
268 -- Return the offset in seconds from UTC
270 end Time_Zones_Operations
;