blob: 9e442370eb585a52b8de51e84485eed1a83b046d [file] [log] [blame]
-- --
-- --
-- C O M P E R R --
-- --
-- S p e c --
-- --
-- Copyright (C) 1992-2021, Free Software Foundation, Inc. --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- ware Foundation; either version 3, or (at your option) any later ver- --
-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
-- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
-- for more details. You should have received a copy of the GNU General --
-- Public License distributed with GNAT; see file COPYING3. If not, go to --
-- for a complete copy of the license. --
-- --
-- GNAT was originally developed by the GNAT team at New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
-- This package contains the routine called when a fatal internal compiler
-- error is detected. Calls to this routines cause termination of the
-- current compilation with appropriate error output.
package Comperr is
procedure Compiler_Abort
(X : String;
Fallback_Loc : String := "";
From_GCC : Boolean := False);
pragma No_Return (Compiler_Abort);
-- Signals an internal compiler error. Never returns control. Depending on
-- processing may end up raising Unrecoverable_Error, or exiting directly.
-- The message output is a "bug box" containing the first string passed as
-- an argument. The Sloc field of the node in Current_Error_Node is used to
-- provide the location where the error should be signalled. If this Sloc
-- value is set to No_Location or any of the other special location values,
-- then the Fallback_Loc argument string is used instead. The message text
-- includes the node id, and the code parameter if it is positive.
-- Note that this is only used at the outer level (to handle constraint
-- errors or assert errors etc.) In the normal logic of the compiler we
-- always use pragma Assert to check for errors, and if necessary an
-- explicit abort is achieved by pragma Assert (False). From_GCC is true
-- for a GCC abort and false for a front end exception (with a possible
-- message stored in TSD.Current_Excep).
-- WARNING: There is a matching C declaration of this subprogram in fe.h
procedure Delete_SCIL_Files;
-- Delete SCIL files associated with the main unit
-- Use of File --
-- When comperr generates the "bug box". The first two lines contain
-- information on the version number, type of abort, and source location.
-- Normally the remaining text is one of three possible forms
-- depending on Gnatvsn.Gnat_Version_Type (FSF, Public, GNATPRO).
-- See body of this package for the exact text used.
-- In addition, an alternative mechanism exists for easily substituting
-- different text for this message. Compiler_Abort checks for the
-- existence of the file "" in the current source path.
-- Most typically this file, if present, will be in the directory
-- containing the run-time sources.
-- If this file is present, then it is a plain ASCII file, whose contents
-- replace the remaining text. The lines in this file should be seventy-two
-- characters or less to avoid misformatting the right boundary of the box.
-- Note that the file does not contain the vertical bar characters or any
-- leading spaces in lines.
end Comperr;