gcc/ada/a-reatim.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                         A D A . R E A L _ T I M E                        --
   6 --                                                                          --
   7 --                                  S p e c                                 --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2005, 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,  51  Franklin  Street,  Fifth  Floor, --
  24 -- Boston, MA 02110-1301, 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 with System.Task_Primitives.Operations;
  39 pragma Elaborate_All (System.Task_Primitives.Operations);
  40
  41 package Ada.Real_Time is
  42
  43    type Time is private;
  44    Time_First : constant Time;
  45    Time_Last  : constant Time;
  46    Time_Unit  : constant := 10#1.0#E-9;
  47
  48    type Time_Span is private;
  49    Time_Span_First : constant Time_Span;
  50    Time_Span_Last  : constant Time_Span;
  51    Time_Span_Zero  : constant Time_Span;
  52    Time_Span_Unit  : constant Time_Span;
  53
  54    Tick : constant Time_Span;
  55    function Clock return Time;
  56
  57    function "+"  (Left : Time;      Right : Time_Span) return Time;
  58    function "+"  (Left : Time_Span; Right : Time)      return Time;
  59    function "-"  (Left : Time;      Right : Time_Span) return Time;
  60    function "-"  (Left : Time;      Right : Time)      return Time_Span;
  61
  62    function "<"  (Left, Right : Time) return Boolean;
  63    function "<=" (Left, Right : Time) return Boolean;
  64    function ">"  (Left, Right : Time) return Boolean;
  65    function ">=" (Left, Right : Time) return Boolean;
  66
  67    function "+"  (Left, Right : Time_Span)             return Time_Span;
  68    function "-"  (Left, Right : Time_Span)             return Time_Span;
  69    function "-"  (Right : Time_Span)                   return Time_Span;
  70    function "*"  (Left : Time_Span; Right : Integer)   return Time_Span;
  71    function "*"  (Left : Integer;   Right : Time_Span) return Time_Span;
  72    function "/"  (Left, Right : Time_Span)             return Integer;
  73    function "/"  (Left : Time_Span; Right : Integer)   return Time_Span;
  74
  75    function "abs" (Right : Time_Span) return Time_Span;
  76
  77    function "<"  (Left, Right : Time_Span) return Boolean;
  78    function "<=" (Left, Right : Time_Span) return Boolean;
  79    function ">"  (Left, Right : Time_Span) return Boolean;
  80    function ">=" (Left, Right : Time_Span) return Boolean;
  81
  82    function To_Duration  (TS : Time_Span) return Duration;
  83    function To_Time_Span (D : Duration)   return Time_Span;
  84
  85    function Nanoseconds  (NS : Integer) return Time_Span;
  86    function Microseconds (US : Integer) return Time_Span;
  87    function Milliseconds (MS : Integer) return Time_Span;
  88
  89    function Seconds (S : Integer) return Time_Span;
  90    pragma Ada_05 (Seconds);
  91
  92    function Minutes (M : Integer) return Time_Span;
  93    pragma Ada_05 (Minutes);
  94
  95    --  Seconds_Count needs 64 bits, since Time has the full range of
  96    --  Duration. The delta of Duration is 10 ** (-9), so the maximum
  97    --  number of seconds is 2**63/10**9 = 8*10**9 which does not quite
  98    --  fit in 32 bits.
  99
 100    type Seconds_Count is range -2 ** 63 .. 2 ** 63 - 1;
 101
 102    procedure Split (T : Time; SC : out Seconds_Count; TS : out Time_Span);
 103    function Time_Of (SC : Seconds_Count; TS : Time_Span) return Time;
 104
 105 private
 106    type Time is new Duration;
 107
 108    Time_First : constant Time := Time'First;
 109
 110    Time_Last  : constant Time := Time'Last;
 111
 112    type Time_Span is new Duration;
 113
 114    Time_Span_First : constant Time_Span := Time_Span'First;
 115
 116    Time_Span_Last  : constant Time_Span := Time_Span'Last;
 117
 118    Time_Span_Zero  : constant Time_Span := 0.0;
 119
 120    Time_Span_Unit  : constant Time_Span := 10#1.0#E-9;
 121
 122    Tick : constant Time_Span :=
 123             Time_Span (System.Task_Primitives.Operations.RT_Resolution);
 124
 125    --  Time and Time_Span are represented in 64-bit Duration value in
 126    --  in nanoseconds. For example, 1 second and 1 nanosecond is
 127    --  represented as the stored integer 1_000_000_001.
 128
 129    pragma Import (Intrinsic, "<");
 130    pragma Import (Intrinsic, "<=");
 131    pragma Import (Intrinsic, ">");
 132    pragma Import (Intrinsic, ">=");
 133    pragma Import (Intrinsic, "abs");
 134
 135    pragma Inline (Microseconds);
 136    pragma Inline (Milliseconds);
 137    pragma Inline (Nanoseconds);
 138    pragma Inline (Seconds);
 139    pragma Inline (Minutes);
 140
 141 end Ada.Real_Time;