gcc/ada/err_vars.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                             E R R _ V A R S                              --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2023, 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 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.  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 COPYING3.  If not, go to --
  19 -- http://www.gnu.org/licenses for a complete copy of the license.          --
  20 --                                                                          --
  21 -- GNAT was originally developed  by the GNAT team at  New York University. --
  22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  23 --                                                                          --
  24 ------------------------------------------------------------------------------
  25
  26 --  This package contains variables common to error reporting packages
  27 --  including Errout and Prj.Err.
  28
  29 with Namet; use Namet;
  30 with Types; use Types;
  31 with Uintp; use Uintp;
  32
  33 package Err_Vars is
  34
  35    --  Note on error counts (Serious_Errors_Detected, Total_Errors_Detected,
  36    --  Warnings_Detected, Warning_Info_Messages, Report_Info_Messages). These
  37    --  counts might more logically appear in this unit, but we place them
  38    --  instead in atree.ads, because of licensing issues. We need to be able
  39    --  to access these counts from units that have the more general licensing
  40    --  conditions.
  41
  42    ----------------------------------
  43    -- Error Message Mode Variables --
  44    ----------------------------------
  45
  46    --  These variables control special error message modes. The initialized
  47    --  values below give the normal default behavior, but they can be reset
  48    --  by the caller to get different behavior as noted in the comments. These
  49    --  variables are not reset by calls to the error message routines, so the
  50    --  caller is responsible for resetting the default behavior after use.
  51
  52    Error_Msg_Qual_Level : Nat := 0;
  53    --  Number of levels of qualification required for type name (see the
  54    --  description of the } insertion character. Note that this value does
  55    --  not get reset by any Error_Msg call, so the caller is responsible
  56    --  for resetting it.
  57
  58    Raise_Exception_On_Error : Nat := 0;
  59    --  If this value is non-zero, then any attempt to generate an error
  60    --  message raises the exception Error_Msg_Exception, and the error
  61    --  message is not output. This is used for defending against junk
  62    --  resulting from illegalities, and also for substitution of more
  63    --  appropriate error messages from higher semantic levels. It is
  64    --  a counter so that the increment/decrement protocol nests neatly.
  65
  66    Error_Msg_Exception : exception;
  67    --  Exception raised if Raise_Exception_On_Error is true
  68
  69    Current_Error_Source_File : Source_File_Index := No_Source_File;
  70    --  Id of current messages. Used to post file name when unit changes. This
  71    --  is initialized to Main_Source_File at the start of a compilation, which
  72    --  means that no file names will be output unless there are errors in units
  73    --  other than the main unit. However, if the main unit has a pragma
  74    --  Source_Reference line, then this is initialized to No_Source_File,
  75    --  to force an initial reference to the real source file name.
  76
  77    ----------------------------------------
  78    -- Error Message Insertion Parameters --
  79    ----------------------------------------
  80
  81    --  The error message routines work with strings that contain insertion
  82    --  sequences that result in the insertion of variable data. The following
  83    --  variables contain the required data. The procedure is to set one or more
  84    --  of the following global variables to appropriate values before making a
  85    --  call to one of the error message routines with a string containing the
  86    --  insertion character to get the value inserted in an appropriate format.
  87    --
  88    --  Some of these are initialized below, because they are read before being
  89    --  set by clients.
  90    --
  91    --  Would it be desirable to use arrays (with element renamings) here
  92    --  instead of individual variables, at least for the Error_Msg_Name_N and
  93    --  Error_Msg_Node_N ??? This would allow simplifying existing code in some
  94    --  cases (see errout.adb).
  95
  96    Error_Msg_Col : Column_Number;
  97    --  Column for @ insertion character in message
  98
  99    Error_Msg_Uint_1 : Uint;
 100    Error_Msg_Uint_2 : Uint := No_Uint;
 101    --  Uint values for ^ insertion characters in message
 102
 103    Error_Msg_Code_Digits : constant := 4;
 104    Error_Msg_Code : Nat range 0 .. 10 ** Error_Msg_Code_Digits - 1;
 105    --  Nat value for [] insertion sequence in message, where a value of zero
 106    --  indicates the absence of an error code.
 107
 108    --  WARNING: There is a matching C declaration of these variables in fe.h
 109
 110    Error_Msg_Sloc : Source_Ptr;
 111    --  Source location for # insertion character in message
 112
 113    Error_Msg_Name_1 : Name_Id;
 114    Error_Msg_Name_2 : Name_Id := No_Name;
 115    Error_Msg_Name_3 : Name_Id := No_Name;
 116    Error_Msg_Name_4 : Name_Id := No_Name;
 117    Error_Msg_Name_5 : Name_Id := No_Name;
 118    Error_Msg_Name_6 : Name_Id := No_Name;
 119    --  Name_Id values for % insertion characters in message
 120
 121    Error_Msg_File_1 : File_Name_Type;
 122    Error_Msg_File_2 : File_Name_Type := No_File;
 123    Error_Msg_File_3 : File_Name_Type := No_File;
 124    --  File_Name_Type values for { insertion characters in message
 125
 126    Error_Msg_Unit_1 : Unit_Name_Type;
 127    Error_Msg_Unit_2 : Unit_Name_Type := No_Unit_Name;
 128    --  Unit_Name_Type values for $ insertion characters in message
 129
 130    Error_Msg_Node_1 : Node_Id;
 131    Error_Msg_Node_2 : Node_Id := Empty;
 132    Error_Msg_Node_3 : Node_Id := Empty;
 133    Error_Msg_Node_4 : Node_Id := Empty;
 134    Error_Msg_Node_5 : Node_Id := Empty;
 135    Error_Msg_Node_6 : Node_Id := Empty;
 136    --  Node_Id values for & insertion characters in message
 137
 138    Error_Msg_Warn : Boolean;
 139    --  Used if current message contains a < insertion character to indicate
 140    --  if the current message is a warning message. Must be set appropriately
 141    --  before any call to Error_Msg_xxx with a < insertion character present.
 142    --  Setting is irrelevant if no < insertion character is present. Note
 143    --  that it is not necessary to reset this after using it, since the proper
 144    --  procedure is always to set it before issuing such a message. Note that
 145    --  the warning documentation tag is always [enabled by default] in the
 146    --  case where this flag is True.
 147
 148    Error_Msg_String : String (1 .. 4096);
 149    Error_Msg_Strlen : Natural;
 150    --  Used if current message contains a ~ insertion character to indicate
 151    --  insertion of the string Error_Msg_String (1 .. Error_Msg_Strlen).
 152
 153 end Err_Vars;