|
111
|
1 ------------------------------------------------------------------------------
|
|
|
2 -- --
|
|
|
3 -- GNAT COMPILER COMPONENTS --
|
|
|
4 -- --
|
|
|
5 -- E R R _ V A R S --
|
|
|
6 -- --
|
|
|
7 -- S p e c --
|
|
|
8 -- --
|
|
131
|
9 -- Copyright (C) 1992-2018, Free Software Foundation, Inc. --
|
|
111
|
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 -- All of these variables are set when needed, so they do not need to be
|
|
|
36 -- initialized. However, there is code that saves and restores existing
|
|
|
37 -- values, which may malfunction in -gnatVa mode if the variable has never
|
|
|
38 -- been initialized, so we initialize some variables to avoid exceptions
|
|
|
39 -- from invalid values in such cases.
|
|
|
40
|
|
|
41 -- Note on error counts (Serious_Errors_Detected, Total_Errors_Detected,
|
|
|
42 -- Warnings_Detected, Warning_Info_Messages, Report_Info_Messages). These
|
|
|
43 -- counts might more logically appear in this unit, but we place them
|
|
|
44 -- instead in atree.ads, because of licensing issues. We need to be able
|
|
|
45 -- to access these counts from units that have the more general licensing
|
|
|
46 -- conditions.
|
|
|
47
|
|
|
48 ----------------------------------
|
|
|
49 -- Error Message Mode Variables --
|
|
|
50 ----------------------------------
|
|
|
51
|
|
|
52 -- These variables control special error message modes. The initialized
|
|
|
53 -- values below give the normal default behavior, but they can be reset
|
|
|
54 -- by the caller to get different behavior as noted in the comments. These
|
|
|
55 -- variables are not reset by calls to the error message routines, so the
|
|
|
56 -- caller is responsible for resetting the default behavior after use.
|
|
|
57
|
|
|
58 Error_Msg_Qual_Level : Nat := 0;
|
|
|
59 -- Number of levels of qualification required for type name (see the
|
|
|
60 -- description of the } insertion character. Note that this value does
|
|
|
61 -- not get reset by any Error_Msg call, so the caller is responsible
|
|
|
62 -- for resetting it.
|
|
|
63
|
|
|
64 Warn_On_Instance : Boolean := False;
|
|
|
65 -- Normally if a warning is generated in a generic template from the
|
|
|
66 -- analysis of the template, then the warning really belongs in the
|
|
|
67 -- template, and the default value of False for this Boolean achieves
|
|
|
68 -- that effect. If Warn_On_Instance is set True, then the warnings are
|
|
|
69 -- generated on the instantiation (referring to the template) rather
|
|
|
70 -- than on the template itself.
|
|
|
71
|
|
|
72 Raise_Exception_On_Error : Nat := 0;
|
|
|
73 -- If this value is non-zero, then any attempt to generate an error
|
|
|
74 -- message raises the exception Error_Msg_Exception, and the error
|
|
|
75 -- message is not output. This is used for defending against junk
|
|
|
76 -- resulting from illegalities, and also for substitution of more
|
|
|
77 -- appropriate error messages from higher semantic levels. It is
|
|
|
78 -- a counter so that the increment/decrement protocol nests neatly.
|
|
|
79 -- Initialized for -gnatVa use, see comment above.
|
|
|
80
|
|
|
81 Error_Msg_Exception : exception;
|
|
|
82 -- Exception raised if Raise_Exception_On_Error is true
|
|
|
83
|
|
|
84 Current_Error_Source_File : Source_File_Index := No_Source_File;
|
|
|
85 -- Id of current messages. Used to post file name when unit changes. This
|
|
|
86 -- is initialized to Main_Source_File at the start of a compilation, which
|
|
|
87 -- means that no file names will be output unless there are errors in units
|
|
|
88 -- other than the main unit. However, if the main unit has a pragma
|
|
|
89 -- Source_Reference line, then this is initialized to No_Source_File,
|
|
|
90 -- to force an initial reference to the real source file name.
|
|
|
91
|
|
|
92 Warning_Doc_Switch : Boolean := False;
|
|
|
93 -- If this is set True, then the ??/?x?/?x? sequences in error messages
|
|
|
94 -- are active (see errout.ads for details). If this switch is False, then
|
|
|
95 -- these sequences are ignored (i.e. simply equivalent to a single ?). The
|
|
|
96 -- -gnatw.d switch sets this flag True, -gnatw.D sets this flag False.
|
|
|
97
|
|
|
98 ----------------------------------------
|
|
|
99 -- Error Message Insertion Parameters --
|
|
|
100 ----------------------------------------
|
|
|
101
|
|
|
102 -- The error message routines work with strings that contain insertion
|
|
|
103 -- sequences that result in the insertion of variable data. The following
|
|
|
104 -- variables contain the required data. The procedure is to set one or more
|
|
|
105 -- of the following global variables to appropriate values before making a
|
|
|
106 -- call to one of the error message routines with a string containing the
|
|
|
107 -- insertion character to get the value inserted in an appropriate format.
|
|
|
108
|
|
|
109 Error_Msg_Col : Column_Number;
|
|
|
110 -- Column for @ insertion character in message
|
|
|
111
|
|
|
112 Error_Msg_Uint_1 : Uint;
|
|
|
113 Error_Msg_Uint_2 : Uint;
|
|
|
114 -- Uint values for ^ insertion characters in message
|
|
|
115
|
|
|
116 Error_Msg_Sloc : Source_Ptr;
|
|
|
117 -- Source location for # insertion character in message
|
|
|
118
|
|
|
119 Error_Msg_Name_1 : Name_Id;
|
|
|
120 Error_Msg_Name_2 : Name_Id;
|
|
|
121 Error_Msg_Name_3 : Name_Id;
|
|
|
122 -- Name_Id values for % insertion characters in message
|
|
|
123
|
|
|
124 Error_Msg_File_1 : File_Name_Type;
|
|
|
125 Error_Msg_File_2 : File_Name_Type;
|
|
|
126 Error_Msg_File_3 : File_Name_Type;
|
|
|
127 -- File_Name_Type values for { insertion characters in message
|
|
|
128
|
|
|
129 Error_Msg_Unit_1 : Unit_Name_Type;
|
|
|
130 Error_Msg_Unit_2 : Unit_Name_Type;
|
|
|
131 -- Unit_Name_Type values for $ insertion characters in message
|
|
|
132
|
|
|
133 Error_Msg_Node_1 : Node_Id;
|
|
|
134 Error_Msg_Node_2 : Node_Id;
|
|
|
135 -- Node_Id values for & insertion characters in message
|
|
|
136
|
|
|
137 Error_Msg_Warn : Boolean;
|
|
|
138 -- Used if current message contains a < insertion character to indicate
|
|
|
139 -- if the current message is a warning message. Must be set appropriately
|
|
|
140 -- before any call to Error_Msg_xxx with a < insertion character present.
|
|
|
141 -- Setting is irrelevant if no < insertion character is present. Note
|
|
|
142 -- that it is not necessary to reset this after using it, since the proper
|
|
|
143 -- procedure is always to set it before issuing such a message. Note that
|
|
|
144 -- the warning documentation tag is always [enabled by default] in the
|
|
|
145 -- case where this flag is True.
|
|
|
146
|
|
|
147 Error_Msg_String : String (1 .. 4096);
|
|
|
148 Error_Msg_Strlen : Natural;
|
|
|
149 -- Used if current message contains a ~ insertion character to indicate
|
|
|
150 -- insertion of the string Error_Msg_String (1 .. Error_Msg_Strlen).
|
|
|
151
|
|
|
152 end Err_Vars;
|
