gcc/ada/4vcalend.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUNTIME COMPONENTS                          --
   4 --                                                                          --
   5 --                         A D A . C A L E N D A R                          --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2002 Free Software Foundation, Inc.          --
  10 --                                                                          --
  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. --
  14 --                                                                          --
  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,  59 Temple Place - Suite 330,  Boston, --
  24 -- MA 02111-1307, USA.                                                      --
  25 --                                                                          --
  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.                                      --
  32 --                                                                          --
  33 -- GNAT was originally developed  by the GNAT team at  New York University. --
  34 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  35 --                                                                          --
  36 ------------------------------------------------------------------------------
  37
  38 --  This is the Alpha/VMS version.
  39
  40 with System.OS_Primitives;
  41 package Ada.Calendar is
  42
  43    package OSP renames System.OS_Primitives;
  44
  45    type Time is private;
  46
  47    --  Declarations representing limits of allowed local time values. Note that
  48    --  these do NOT constrain the possible stored values of time which may well
  49    --  permit a larger range of times (this is explicitly allowed in Ada 95).
  50
  51    subtype Year_Number  is Integer range 1901 .. 2099;
  52    subtype Month_Number is Integer range 1 .. 12;
  53    subtype Day_Number   is Integer range 1 .. 31;
  54
  55    subtype Day_Duration is Duration range 0.0 .. 86_400.0;
  56
  57    function Clock return Time;
  58
  59    function Year    (Date : Time) return Year_Number;
  60    function Month   (Date : Time) return Month_Number;
  61    function Day     (Date : Time) return Day_Number;
  62    function Seconds (Date : Time) return Day_Duration;
  63
  64    procedure Split
  65      (Date    : Time;
  66       Year    : out Year_Number;
  67       Month   : out Month_Number;
  68       Day     : out Day_Number;
  69       Seconds : out Day_Duration);
  70
  71    function Time_Of
  72      (Year    : Year_Number;
  73       Month   : Month_Number;
  74       Day     : Day_Number;
  75       Seconds : Day_Duration := 0.0)
  76       return    Time;
  77
  78    function "+" (Left : Time;     Right : Duration) return Time;
  79    function "+" (Left : Duration; Right : Time)     return Time;
  80    function "-" (Left : Time;     Right : Duration) return Time;
  81    function "-" (Left : Time;     Right : Time)     return Duration;
  82
  83    function "<"  (Left, Right : Time) return Boolean;
  84    function "<=" (Left, Right : Time) return Boolean;
  85    function ">"  (Left, Right : Time) return Boolean;
  86    function ">=" (Left, Right : Time) return Boolean;
  87
  88    Time_Error : exception;
  89
  90 private
  91
  92    pragma Inline (Clock);
  93
  94    pragma Inline (Year);
  95    pragma Inline (Month);
  96    pragma Inline (Day);
  97
  98    pragma Inline ("+");
  99    pragma Inline ("-");
 100
 101    pragma Inline ("<");
 102    pragma Inline ("<=");
 103    pragma Inline (">");
 104    pragma Inline (">=");
 105
 106    --  Time is represented as the number of 100-nanosecond (ns) units offset
 107    --  from the system base date and time, which is 00:00 o'clock,
 108    --  November 17, 1858 (the Smithsonian base date and time for the
 109    --  astronomic calendar).
 110
 111    --  The time value stored is typically a GMT value, as provided in standard
 112    --  Unix environments. If this is the case then Split and Time_Of perform
 113    --  required conversions to and from local times.
 114
 115    type Time is new OSP.OS_Time;
 116
 117    --  Notwithstanding this definition, Time is not quite the same as OS_Time.
 118    --  Relative Time is positive, whereas relative OS_Time is negative,
 119    --  but this declaration makes for easier conversion.
 120
 121 end Ada.Calendar;