------------------------------------------------------------------------------ -- -- -- GNAT COMPILER COMPONENTS -- -- -- -- E R R _ V A R S -- -- -- -- S p e c -- -- -- -- Copyright (C) 1992-2024, 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 -- -- http://www.gnu.org/licenses 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 variables common to error reporting packages -- including Errout and Prj.Err. with Namet; use Namet; with Types; use Types; with Uintp; use Uintp; package Err_Vars is -- Note on error counts (Serious_Errors_Detected, Total_Errors_Detected, -- Warnings_Detected, Warning_Info_Messages, Report_Info_Messages). These -- counts might more logically appear in this unit, but we place them -- instead in atree.ads, because of licensing issues. We need to be able -- to access these counts from units that have the more general licensing -- conditions. ---------------------------------- -- Error Message Mode Variables -- ---------------------------------- -- These variables control special error message modes. The initialized -- values below give the normal default behavior, but they can be reset -- by the caller to get different behavior as noted in the comments. These -- variables are not reset by calls to the error message routines, so the -- caller is responsible for resetting the default behavior after use. Error_Msg_Qual_Level : Nat := 0; -- Number of levels of qualification required for type name (see the -- description of the } insertion character. Note that this value does -- not get reset by any Error_Msg call, so the caller is responsible -- for resetting it. Raise_Exception_On_Error : Nat := 0; -- If this value is non-zero, then any attempt to generate an error -- message raises the exception Error_Msg_Exception, and the error -- message is not output. This is used for defending against junk -- resulting from illegalities, and also for substitution of more -- appropriate error messages from higher semantic levels. It is -- a counter so that the increment/decrement protocol nests neatly. Error_Msg_Exception : exception; -- Exception raised if Raise_Exception_On_Error is true Current_Error_Source_File : Source_File_Index := No_Source_File; -- Id of current messages. Used to post file name when unit changes. This -- is initialized to Main_Source_File at the start of a compilation, which -- means that no file names will be output unless there are errors in units -- other than the main unit. However, if the main unit has a pragma -- Source_Reference line, then this is initialized to No_Source_File, -- to force an initial reference to the real source file name. ---------------------------------------- -- Error Message Insertion Parameters -- ---------------------------------------- -- The error message routines work with strings that contain insertion -- sequences that result in the insertion of variable data. The following -- variables contain the required data. The procedure is to set one or more -- of the following global variables to appropriate values before making a -- call to one of the error message routines with a string containing the -- insertion character to get the value inserted in an appropriate format. -- -- Some of these are initialized below, because they are read before being -- set by clients. -- -- Would it be desirable to use arrays (with element renamings) here -- instead of individual variables, at least for the Error_Msg_Name_N and -- Error_Msg_Node_N ??? This would allow simplifying existing code in some -- cases (see errout.adb). Error_Msg_Col : Column_Number; -- Column for @ insertion character in message Error_Msg_Uint_1 : Uint; Error_Msg_Uint_2 : Uint := No_Uint; -- Uint values for ^ insertion characters in message Error_Msg_Code_Digits : constant := 4; Error_Msg_Code : Nat range 0 .. 10 ** Error_Msg_Code_Digits - 1; -- Nat value for [] insertion sequence in message, where a value of zero -- indicates the absence of an error code. -- WARNING: There is a matching C declaration of these variables in fe.h Error_Msg_Sloc : Source_Ptr; -- Source location for # insertion character in message Error_Msg_Name_1 : Name_Id; Error_Msg_Name_2 : Name_Id := No_Name; Error_Msg_Name_3 : Name_Id := No_Name; Error_Msg_Name_4 : Name_Id := No_Name; Error_Msg_Name_5 : Name_Id := No_Name; Error_Msg_Name_6 : Name_Id := No_Name; -- Name_Id values for % insertion characters in message Error_Msg_File_1 : File_Name_Type; Error_Msg_File_2 : File_Name_Type := No_File; Error_Msg_File_3 : File_Name_Type := No_File; -- File_Name_Type values for { insertion characters in message Error_Msg_Unit_1 : Unit_Name_Type; Error_Msg_Unit_2 : Unit_Name_Type := No_Unit_Name; -- Unit_Name_Type values for $ insertion characters in message Error_Msg_Node_1 : Node_Id; Error_Msg_Node_2 : Node_Id := Empty; Error_Msg_Node_3 : Node_Id := Empty; Error_Msg_Node_4 : Node_Id := Empty; Error_Msg_Node_5 : Node_Id := Empty; Error_Msg_Node_6 : Node_Id := Empty; -- Node_Id values for & insertion characters in message Error_Msg_Warn : Boolean; -- Used if current message contains a < insertion character to indicate -- if the current message is a warning message. Must be set appropriately -- before any call to Error_Msg_xxx with a < insertion character present. -- Setting is irrelevant if no < insertion character is present. Note -- that it is not necessary to reset this after using it, since the proper -- procedure is always to set it before issuing such a message. Note that -- the warning documentation tag is always [enabled by default] in the -- case where this flag is True. Error_Msg_String : String (1 .. 4096); Error_Msg_Strlen : Natural; -- Used if current message contains a ~ insertion character to indicate -- insertion of the string Error_Msg_String (1 .. Error_Msg_Strlen). end Err_Vars;