blob: a40f805384769c61ee19192ac5a26cc1da80b01c [file] [log] [blame]
------------------------------------------------------------------------------
-- --
-- GNAT COMPILER COMPONENTS --
-- --
-- B I N D 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 --
-- 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 the routines to output error messages for the binder
-- and also the routines for handling fatal error conditions in the binder.
with Namet; use Namet;
with Types; use Types;
package Binderr is
Errors_Detected : Nat;
-- Number of errors detected so far
Warnings_Detected : Nat;
-- Number of warnings detected
Info_Prefix_Suppress : Boolean := False;
-- If set to True, the normal "info: " header before messages generated
-- by Error_Msg_Info will be omitted.
---------------------------------------------------------
-- Error Message Text and Message Insertion Characters --
---------------------------------------------------------
-- Error message text strings are composed of letters, digits and the
-- special characters space, comma, period, colon and semicolon,
-- apostrophe and parentheses. Special insertion characters can also
-- appear which cause the error message circuit to modify the given
-- string as follows:
-- Insertion character { (Left brace: insert file name from Names table)
-- The character { is replaced by the text for the file name specified
-- by the File_Name_Type value stored in Error_Msg_File_1. The name is
-- always enclosed in quotes. A second { may appear in a single message
-- in which case it is similarly replaced by the name which is
-- specified by the File_Name_Type value stored in Error_Msg_File_2.
-- Insertion character $ (Dollar: insert unit name from Names table)
-- The character $ is replaced by the text for the unit name specified
-- by the Name_Id value stored in Error_Msg_Unit_1. The name is always
-- enclosed in quotes. A second $ may appear in a single message in
-- which case it is similarly replaced by the name which is specified
-- by the Name_Id value stored in Error_Msg_Unit_2.
-- Insertion character # (Pound: insert non-negative number in decimal)
-- The character # is replaced by the contents of Error_Msg_Nat_1
-- converted into an unsigned decimal string. A second # may appear
-- in a single message, in which case it is similarly replaced by
-- the value stored in Error_Msg_Nat_2.
-- Insertion character ? (Question mark: warning message)
-- The character ?, which must be the first character in the message
-- string, signals a warning message instead of an error message.
-----------------------------------------------------
-- Global Values Used for Error Message Insertions --
-----------------------------------------------------
-- The following global variables are essentially additional parameters
-- passed to the error message routine for insertion sequences described
-- above. The reason these are passed globally is that the insertion
-- mechanism is essentially an untyped one in which the appropriate
-- variables are set depending on the specific insertion characters used.
Error_Msg_Name_1 : Name_Id;
-- Name_Id value for % insertion characters in message
Error_Msg_File_1 : File_Name_Type;
Error_Msg_File_2 : File_Name_Type;
-- Name_Id values for { insertion characters in message
Error_Msg_Unit_1 : Unit_Name_Type;
Error_Msg_Unit_2 : Unit_Name_Type;
-- Name_Id values for $ insertion characters in message
Error_Msg_Nat_1 : Nat;
Error_Msg_Nat_2 : Nat;
-- Integer values for # insertion characters in message
------------------------------
-- Error Output Subprograms --
------------------------------
procedure Error_Msg (Msg : String);
-- Output specified error message to standard error or standard output
-- as governed by the brief and verbose switches, and update error
-- counts appropriately.
procedure Error_Msg_Info (Msg : String);
-- Output information line. Indentical in effect to Error_Msg, except
-- that the prefix is info: instead of error: and the error count is
-- not incremented. The prefix may be suppressed by setting the global
-- variable Info_Prefix_Suppress to True.
procedure Error_Msg_Output (Msg : String; Info : Boolean);
-- Output given message, with insertions, to current message output file.
-- The second argument is True for an info message, false for a normal
-- warning or error message. Normally this is not called directly, but
-- rather only by Error_Msg or Error_Msg_Info. It is called directly
-- when the caller must control whether the output goes to stderr or
-- stdout (Error_Msg_Output always goes to the current output file).
procedure Finalize_Binderr;
-- Finalize error output for one file
procedure Initialize_Binderr;
-- Initialize error output for one file
end Binderr;