gcc/ada/comperr.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                              C O M P E R R                               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2006, Free Software Foundation, Inc.         --
  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 2,  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.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- GNAT was originally developed  by the GNAT team at  New York University. --
  23 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  24 --                                                                          --
  25 ------------------------------------------------------------------------------
  26
  27 --  This package contains the routine called when a fatal internal compiler
  28 --  error is detected. Calls to this routines cause termination of the
  29 --  current compilation with appropriate error output.
  30
  31 package Comperr is
  32
  33    procedure Compiler_Abort
  34      (X            : String;
  35       Code         : Integer := 0;
  36       Fallback_Loc : String := "");
  37    --  Signals an internal compiler error. Never returns control. Depending on
  38    --  processing may end up raising Unrecoverable_Error, or exiting directly.
  39    --  The message output is a "bug box" containing the first string passed as
  40    --  an argument. The Sloc field of the node in Current_Error_Node is used to
  41    --  provide the location where the error should be signalled. If this Sloc
  42    --  value is set to No_Location or any of the other special location values,
  43    --  then the Fallback_Loc argument string is used instead. The message text
  44    --  includes the node id, and the code parameter if it is positive.
  45    --
  46    --  Note that this is only used at the outer level (to handle constraint
  47    --  errors or assert errors etc.) In the normal logic of the compiler we
  48    --  always use pragma Assert to check for errors, and if necessary an
  49    --  explicit abort is achieved by pragma Assert (False). Code is positive
  50    --  for a gigi abort (giving the gigi abort code), zero for a front
  51    --  end exception (with possible message stored in TSD.Current_Excep,
  52    --  and negative (an unused value) for a GCC abort.
  53
  54    ------------------------------
  55    -- Use of gnat_bug.box File --
  56    ------------------------------
  57
  58    --  When comperr generates the "bug box". The first two lines contain
  59    --  information on the version number, type of abort, and source location.
  60
  61    --  Normally the remaining text is one of three possible forms
  62    --  depending on Gnatvsn.Gnat_Version_Type (FSF, Public, GNATPRO).
  63    --  See body of this package for the exact text used.
  64
  65    --  In addition, an alternative mechanism exists for easily substituting
  66    --  different text for this message. Compiler_Abort checks for the
  67    --  existence of the file "gnat_bug.box" in the current source path.
  68    --  Most typically this file, if present, will be in the directory
  69    --  containing the run-time sources.
  70
  71    --  If this file is present, then it is a plain ASCII file, whose contents
  72    --  replace the remaining text. The lines in this file should be seventy-two
  73    --  characters or less to avoid misformatting the right boundary of the box.
  74    --  Note that the file does not contain the vertical bar characters or any
  75    --  leading spaces in lines.
  76
  77 end Comperr;