File : g-comver.ads


   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                G N A T . C O M P I L E R _ V E R S I O N                 --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                     Copyright (C) 2002-2010, AdaCore                     --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
  17 --                                                                          --
  18 --                                                                          --
  19 --                                                                          --
  20 --                                                                          --
  21 --                                                                          --
  22 -- You should have received a copy of the GNU General Public License and    --
  23 -- a copy of the GCC Runtime Library Exception along with this program;     --
  24 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  25 -- <http://www.gnu.org/licenses/>.                                          --
  26 --                                                                          --
  27 -- GNAT was originally developed  by the GNAT team at  New York University. --
  28 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  29 --                                                                          --
  30 ------------------------------------------------------------------------------
  31 
  32 --  This package provides a routine for obtaining the version number of the
  33 --  GNAT compiler used to compile the program. It relies on the generated
  34 --  constant in the binder generated package that records this information.
  35 
  36 --  Note: to use this package you must first instantiate it, for example:
  37 
  38 --    package CVer is new GNAT.Compiler_Version;
  39 
  40 --  and then you use the function in the instantiated package (Cver.Version).
  41 --  The reason that this unit is generic is that otherwise the direct attempt
  42 --  to import the necessary variable from the binder file causes trouble when
  43 --  building a shared library, since the symbol is not available.
  44 
  45 --  Note: this unit is only useable if the main program is written in Ada.
  46 --  It cannot be used if the main program is written in foreign language.
  47 
  48 generic
  49 package GNAT.Compiler_Version is
  50    pragma Pure;
  51 
  52    function Version return String;
  53    --  This function returns the version in the form "v.vvx (yyyyddmm)".
  54    --  Here v.vv is the main version number (e.g. 3.16), x is the version
  55    --  designator (e.g. a1 in 3.16a1), and yyyyddmm is the date in ISO form.
  56    --  An example of the returned value would be "3.16w (20021029)". The
  57    --  version is actually that of the binder used to bind the program,
  58    --  which will be the same as the compiler version if a consistent
  59    --  set of tools is used to build the program.
  60 
  61 end GNAT.Compiler_Version;