OSDN Git Service

* gcc.dg/attr-weakref-1.c: Add exit (0) to avoid spurious
[pf3gnuchains/gcc-fork.git] / gcc / ada / errout.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                               E R R O U T                                --
6 --                                                                          --
7 --                                 S p e c                                  --
8 --                                                                          --
9 --          Copyright (C) 1992-2005 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 2,  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 COPYING.  If not, write --
19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
20 -- Boston, MA 02110-1301, USA.                                              --
21 --                                                                          --
22 -- GNAT was originally developed  by the GNAT team at  New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
24 --                                                                          --
25 ------------------------------------------------------------------------------
26
27 --  This package contains the routines to output error messages. They are
28 --  basically system independent, however in some environments, e.g. when the
29 --  parser is embedded into an editor, it may be appropriate to replace the
30 --  implementation of this package.
31
32 with Err_Vars;
33 with Erroutc;
34 with Table;
35 with Types; use Types;
36 with Uintp; use Uintp;
37
38 with System;
39
40 package Errout is
41
42    Serious_Errors_Detected : Nat renames Err_Vars.Serious_Errors_Detected;
43    --  This is a count of errors that are serious enough to stop expansion,
44    --  and hence to prevent generation of an object file even if the switch
45    --  -gnatQ is set.
46
47    Total_Errors_Detected : Nat renames Err_Vars.Total_Errors_Detected;
48    --  Number of errors detected so far. Includes count of serious errors and
49    --  non-serious errors, so this value is always greater than or equal to
50    --  the Serious_Errors_Detected value.
51
52    Warnings_Detected : Nat renames Err_Vars.Warnings_Detected;
53    --  Number of warnings detected
54
55    Configurable_Run_Time_Violations : Nat := 0;
56    --  Count of configurable run time violations so far. This is used to
57    --  suppress certain cascaded error messages when we know that we may not
58    --  have fully expanded some items, due to high integrity violations (i.e.
59    --  the use of constructs not permitted by the library in use, or improper
60    --  constructs in No_Run_Time mode).
61
62    type Compiler_State_Type is (Parsing, Analyzing);
63    Compiler_State : Compiler_State_Type;
64    --  Indicates current state of compilation. This is put in the Errout spec
65    --  because it affects the action of the error message handling. In
66    --  particular, an attempt is made by Errout to suppress cascaded error
67    --  messages in Parsing mode, but not in the other modes.
68
69    Current_Error_Source_File : Source_File_Index
70      renames Err_Vars.Current_Error_Source_File;
71    --  Id of current messages. Used to post file name when unit changes. This
72    --  is initialized to Main_Source_File at the start of a compilation, which
73    --  means that no file names will be output unless there are errors in
74    --  units other than the main unit. However, if the main unit has a pragma
75    --  Source_Reference line, then this is initialized to No_Source_File, to
76    --  force an initial reference to the real source file name.
77
78    Raise_Exception_On_Error : Nat renames Err_Vars.Raise_Exception_On_Error;
79    --  If this value is non-zero, then any attempt to generate an error
80    --  message raises the exception Error_Msg_Exception, and the error message
81    --  is not output. This is used for defending against junk resulting from
82    --  illegalities, and also for substitution of more appropriate error
83    --  messages from higher semantic levels. It is a counter so that the
84    --  increment/decrement protocol nests neatly.
85
86    Error_Msg_Exception : exception renames Err_Vars.Error_Msg_Exception;
87    --  Exception raised if Raise_Exception_On_Error is true
88
89    -----------------------------------
90    -- Suppression of Error Messages --
91    -----------------------------------
92
93    --  In an effort to reduce the impact of redundant error messages, the
94    --  error output routines in this package normally suppress certain
95    --  classes of messages as follows:
96
97    --    1.  Identical messages placed at the same point in the text. Such
98    --        duplicate error message result for example from rescanning
99    --        sections of the text that contain lexical errors. Only one of
100    --        such a set of duplicate messages is output, and the rest are
101    --        suppressed.
102
103    --    2.  If more than one parser message is generated for a single source
104    --        line, then only the first message is output, the remaining
105    --        messages on the same line are suppressed.
106
107    --    3.  If a message is posted on a node for which a message has been
108    --        previously posted, then only the first message is retained. The
109    --        Error_Posted flag is used to detect such multiple postings. Note
110    --        that this only applies to semantic messages, since otherwise
111    --        for parser messages, this would be a special case of case 2.
112
113    --    4.  If a message is posted on a node whose Etype or Entity
114    --        fields reference entities on which an error message has
115    --        already been placed, as indicated by the Error_Posted flag
116    --        being set on these entities, then the message is suppressed.
117
118    --    5.  If a message attempts to insert an Error node, or a direct
119    --        reference to the Any_Type node, then the message is suppressed.
120
121    --  This normal suppression action may be overridden in cases 2-5 (but not
122    --  in case 1) by setting All_Errors mode, or by setting the special
123    --  unconditional message insertion character (!) at the end of the message
124    --  text as described below.
125
126    ---------------------------------------------------------
127    -- Error Message Text and Message Insertion Characters --
128    ---------------------------------------------------------
129
130    --  Error message text strings are composed of lower case letters, digits
131    --  and the special characters space, comma, period, colon and semicolon,
132    --  apostrophe and parentheses. Special insertion characters can also
133    --  appear which cause the error message circuit to modify the given
134    --  string as follows:
135
136    --    Insertion character % (Percent: insert name from Names table)
137    --      The character % is replaced by the text for the name specified by
138    --      the Name_Id value stored in Error_Msg_Name_1. A blank precedes the
139    --      name if it is preceded by a non-blank character other than left
140    --      parenthesis. The name is enclosed in quotes unless manual quotation
141    --      mode is set. If the Name_Id is set to No_Name, then no insertion
142    --      occurs; if the Name_Id is set to Error_Name, then the string
143    --      <error> is inserted. A second and third % may appear in a single
144    --      message, similarly replaced by the names which are specified by the
145    --      Name_Id values stored in Error_Msg_Name_2 and Error_Msg_Name_3. The
146    --      names are decoded and cased according to the current identifier
147    --      casing mode.
148
149    --    Insertion character $ (Dollar: insert unit name from Names table)
150    --      The character $ is treated similarly to %, except that the name is
151    --      obtained from the Unit_Name_Type value in Error_Msg_Unit_1 and
152    --      Error_Msg_Unit_2, as provided by Get_Unit_Name_String in package
153    --      Uname. Note that this name includes the postfix (spec) or (body)
154    --      strings. If this postfix is not required, use the normal %
155    --      insertion for the unit name.
156
157    --    Insertion character { (Left brace: insert literally from names table)
158    --      The character { is treated similarly to %, except that the name is
159    --      output literally as stored in the names table without adjusting the
160    --      casing. This can be used for file names and in other situations
161    --      where the name string is to be output unchanged.
162
163    --    Insertion character * (Asterisk, insert reserved word name)
164    --      The insertion character * is treated exactly like % except that the
165    --      resulting name is cased according to the default conventions for
166    --      reserved words (see package Scans).
167
168    --    Insertion character & (Ampersand: insert name from node)
169    --      The insertion character & is treated similarly to %, except that
170    --      the name is taken from the Chars field of the given node, and may
171    --      refer to a child unit name, or a selected component. The casing is,
172    --      if possible, taken from the original source reference, which is
173    --      obtained from the Sloc field of the given node or nodes. If no Sloc
174    --      is available (happens e.g. for nodes in package Standard), then the
175    --      default case (see Scans spec) is used. The nodes to be used are
176    --      stored in Error_Msg_Node_1, Error_Msg_Node_2. No insertion occurs
177    --      for the Empty node, and the Error node results in the insertion of
178    --      the characters <error>. In addition, if the special global variable
179    --      Error_Msg_Qual_Level is non-zero, then the reference will include
180    --      up to the given number of levels of qualification, using the scope
181    --      chain.
182
183    --    Insertion character # (Pound: insert line number reference)
184    --      The character # is replaced by the string indicating the source
185    --      position stored in Error_Msg_Sloc. There are three cases:
186    --
187    --        for package Standard:           in package Standard
188    --        for locations in current file:  at line nnn:ccc
189    --        for locations in other files:   at filename:nnn:ccc
190    --
191    --      By convention, the # insertion character is only used at the end of
192    --      an error message, so the above strings only appear as the last
193    --      characters of an error message.
194
195    --    Insertion character } (Right brace: insert type reference)
196    --      The character } is replaced by a string describing the type
197    --      referenced by the entity whose Id is stored in Error_Msg_Node_1.
198    --      the string gives the name or description of the type, and also
199    --      where appropriate the location of its declaration. Special cases
200    --      like "some integer type" are handled appropriately. Only one } is
201    --      allowed in a message, since there is not enough room for two (the
202    --      insertion can be quite long, including a file name) In addition, if
203    --      the special global variable Error_Msg_Qual_Level is non-zero, then
204    --      the reference will include up to the given number of levels of
205    --      qualification, using the scope chain.
206
207    --    Insertion character @ (At: insert column number reference)
208    --      The character @ is replaced by null if the RM_Column_Check mode is
209    --      off (False). If the switch is on (True), then @ is replaced by the
210    --      text string " in column nnn" where nnn is the decimal
211    --      representation of the column number stored in Error_Msg_Col plus
212    --      one (the plus one is because the number is stored 0-origin and
213    --      displayed 1-origin).
214
215    --    Insertion character ^ (Carret: insert integer value)
216    --      The character ^ is replaced by the decimal conversion of the Uint
217    --      value stored in Error_Msg_Uint_1, with a possible leading minus.
218    --      A second ^ may occur in the message, in which case it is replaced
219    --      by the decimal conversion of the Uint value in Error_Msg_Uint_2.
220
221    --    Insertion character > (Right bracket, run time name)
222    --      The character > is replaced by a string of the form (name) if
223    --      Targparm scanned out a Run_Time_Name (see package Targparm for
224    --      details). The name is enclosed in parentheses and output in mixed
225    --      case mode (upper case after any space in the name). If no run time
226    --      name is defined, this insertion character has no effect.
227
228    --    Insertion character ! (Exclamation: unconditional message)
229    --      The character ! appearing as the last character of a message makes
230    --      the message unconditional which means that it is output even if it
231    --      would normally be suppressed. See section above for a description
232    --      of the cases in which messages are normally suppressed.
233
234    --    Insertion character ? (Question: warning message)
235    --      The character ? appearing anywhere in a message makes the message
236    --      a warning instead of a normal error message, and the text of the
237    --      message will be preceded by "Warning:" instead of "Error:" The
238    --      handling of warnings if further controlled by the Warning_Mode
239    --      option (-w switch), see package Opt for further details, and also
240    --      by the current setting from pragma Warnings. This pragma applies
241    --      only to warnings issued from the semantic phase (not the parser),
242    --      but currently all relevant warnings are posted by the semantic
243    --      phase anyway. Messages starting with (style) are also treated as
244    --      warning messages.
245
246    --    Insertion character < (Less Than: conditional warning message)
247    --      The character < appearing anywhere in a message is used for a
248    --      conditional error message. If Error_Msg_Warn is True, then the
249    --      effect is the same as ? described above. If Error_Msg_Warn is
250    --      False, then there is no effect.
251
252    --    Insertion character A-Z (Upper case letter: Ada reserved word)
253    --      If two or more upper case letters appear in the message, they are
254    --      taken as an Ada reserved word, and are converted to the default
255    --      case for reserved words (see Scans package spec). Surrounding
256    --      quotes are added unless manual quotation mode is currently set.
257
258    --    Insertion character ` (Backquote: set manual quotation mode)
259    --      The backquote character always appears in pairs. Each backquote of
260    --      the pair is replaced by a double quote character. In addition, Any
261    --      reserved keywords, or name insertions between these backquotes are
262    --      not surrounded by the usual automatic double quotes. See the
263    --      section below on manual quotation mode for further details.
264
265    --    Insertion character ' (Quote: literal character)
266    --      Precedes a character which is placed literally into the message.
267    --      Used to insert characters into messages that are one of the
268    --      insertion characters defined here. Also useful in inserting
269    --      sequences of upper case letters (e.g. RM) which are not to be
270    --      treated as keywords.
271
272    --    Insertion character \ (Backslash: continuation message)
273    --      Indicates that the message is a continuation of a message
274    --      previously posted. This is used to ensure that such groups of
275    --      messages are treated as a unit. The \ character must be the first
276    --      character of the message text.
277
278    --    Insertion character | (vertical bar, non-serious error)
279    --      By default, error messages (other than warning messages) are
280    --      considered to be fatal error messages which prevent expansion or
281    --      generation of code in the presence of the -gnatQ switch. If the
282    --      insertion character | appears, the message is considered to be
283    --      non-serious, and does not cause Serious_Errors_Detected to be
284    --      incremented (so expansion is not prevented by such a msg).
285
286    ----------------------------------------
287    -- Specialization of Messages for VMS --
288    ----------------------------------------
289
290    --  Some messages mention gcc-style switch names. When using an OpenVMS
291    --  host, such switch names must be converted to their corresponding VMS
292    --  qualifer. The following table controls this translation. In each case
293    --  the original message must contain the string "-xxx switch", where xxx
294    --  is the Gname? entry from below, and this string will be replaced by
295    --  "/yyy qualifier", where yyy is the corresponding Vname? entry.
296
297    Gname1 : aliased constant String := "fno-strict-aliasing";
298    Vname1 : aliased constant String := "OPTIMIZE=NO_STRICT_ALIASING";
299
300    Gname2 : aliased constant String := "gnatX";
301    Vname2 : aliased constant String := "EXTENSIONS_ALLOWED";
302
303    Gname3 : aliased constant String := "gnatW";
304    Vname3 : aliased constant String := "WIDE_CHARACTER_ENCODING";
305
306    Gname4 : aliased constant String := "gnatf";
307    Vname4 : aliased constant String := "REPORT_ERRORS=FULL";
308
309    Gname5 : aliased constant String := "gnat05";
310    Vname5 : aliased constant String := "05";
311
312    type Cstring_Ptr is access constant String;
313
314    Gnames : array (Nat range <>) of Cstring_Ptr :=
315               (Gname1'Access,
316                Gname2'Access,
317                Gname3'Access,
318                Gname4'Access,
319                Gname5'Access);
320
321    Vnames : array (Nat range <>) of Cstring_Ptr :=
322               (Vname1'Access,
323                Vname2'Access,
324                Vname3'Access,
325                Vname4'Access,
326                Vname5'Access);
327
328    -----------------------------------------------------
329    -- Global Values Used for Error Message Insertions --
330    -----------------------------------------------------
331
332    --  The following global variables are essentially additional parameters
333    --  passed to the error message routine for insertion sequences described
334    --  above. The reason these are passed globally is that the insertion
335    --  mechanism is essentially an untyped one in which the appropriate
336    --  variables are set dependingon the specific insertion characters used.
337
338    Error_Msg_Col : Column_Number renames Err_Vars.Error_Msg_Col;
339    --  Column for @ insertion character in message
340
341    Error_Msg_Uint_1 : Uint renames Err_Vars.Error_Msg_Uint_1;
342    Error_Msg_Uint_2 : Uint renames Err_Vars.Error_Msg_Uint_2;
343    --  Uint values for ^ insertion characters in message
344
345    Error_Msg_Sloc : Source_Ptr renames Err_Vars.Error_Msg_Sloc;
346    --  Source location for # insertion character in message
347
348    Error_Msg_Name_1 : Name_Id renames Err_Vars.Error_Msg_Name_1;
349    Error_Msg_Name_2 : Name_Id renames Err_Vars.Error_Msg_Name_2;
350    Error_Msg_Name_3 : Name_Id renames Err_Vars.Error_Msg_Name_3;
351    --  Name_Id values for % insertion characters in message
352
353    Error_Msg_Unit_1 : Name_Id renames Err_Vars.Error_Msg_Unit_1;
354    Error_Msg_Unit_2 : Name_Id renames Err_Vars.Error_Msg_Unit_2;
355    --  Name_Id values for $ insertion characters in message
356
357    Error_Msg_Node_1 : Node_Id renames Err_Vars.Error_Msg_Node_1;
358    Error_Msg_Node_2 : Node_Id renames Err_Vars.Error_Msg_Node_2;
359    --  Node_Id values for & insertion characters in message
360
361    Error_Msg_Qual_Level : Int renames Err_Vars.Error_Msg_Qual_Level;
362    --  Number of levels of qualification required for type name (see the
363    --  description of the } insertion character. Note that this value does
364    --  note get reset by any Error_Msg call, so the caller is responsible
365    --  for resetting it.
366
367    Error_Msg_Warn : Boolean renames Err_Vars.Error_Msg_Warn;
368    --  Used if current message contains a < insertion character to indicate
369    --  if the current message is a warning message.
370
371    -----------------------------------------------------
372    -- Format of Messages and Manual Quotation Control --
373    -----------------------------------------------------
374
375    --  Messages are generally all in lower case, except for inserted names
376    --  and appear in one of the following three forms:
377
378    --    error: text
379    --    warning: text
380
381    --  The prefixes error and warning are supplied automatically (depending
382    --  on the use of the ? insertion character), and the call to the error
383    --  message routine supplies the text. The "error: " prefix is omitted
384    --  in brief error message formats.
385
386    --  Reserved Ada keywords in the message are in the default keyword case
387    --  (determined from the given source program), surrounded by quotation
388    --  marks. This is achieved by spelling the reserved word in upper case
389    --  letters, which is recognized as a request for insertion of quotation
390    --  marks by the error text processor. Thus for example:
391
392    --    Error_Msg_AP ("IS expected");
393
394    --  would result in the output of one of the following:
395
396    --    error: "is" expected
397    --    error: "IS" expected
398    --    error: "Is" expected
399
400    --  the choice between these being made by looking at the casing convention
401    --  used for keywords (actually the first compilation unit keyword) in the
402    --  source file.
403
404    --  In the case of names, the default mode for the error text processor
405    --  is to surround the name by quotation marks automatically. The case
406    --  used for the identifier names is taken from the source program where
407    --  possible, and otherwise is the default casing convention taken from
408    --  the source file usage.
409
410    --  In some cases, better control over the placement of quote marks is
411    --  required. This is achieved using manual quotation mode. In this mode,
412    --  one or more insertion sequences is surrounded by backquote characters.
413    --  The backquote characters are output as double quote marks, and normal
414    --  automatic insertion of quotes is suppressed between the double quotes.
415    --  For example:
416
417    --    Error_Msg_AP ("`END &;` expected");
418
419    --  generates a message like
420
421    --    error: "end Open_Scope;" expected
422
423    --  where the node specifying the name Open_Scope has been stored in
424    --  Error_Msg_Node_1 prior to the call. The great majority of error
425    --  messages operates in normal quotation mode.
426
427    --  Note: the normal automatic insertion of spaces before insertion
428    --  sequences (such as those that come from & and %) is suppressed in
429    --  manual quotation mode, so blanks, if needed as in the above example,
430    --  must be explicitly present.
431
432    ----------------------------
433    -- Message ID Definitions --
434    ----------------------------
435
436    subtype Error_Msg_Id is Erroutc.Error_Msg_Id;
437    function "=" (Left, Right : Error_Msg_Id) return Boolean
438      renames Erroutc."=";
439    --  A type used to represent specific error messages. Used by the clients
440    --  of this package only in the context of the Get_Error_Id and
441    --  Change_Error_Text subprograms.
442
443    No_Error_Msg : constant Error_Msg_Id := Erroutc.No_Error_Msg;
444    --  A constant which is different from any value returned by Get_Error_Id.
445    --  Typically used by a client to indicate absense of a saved Id value.
446
447    function Get_Msg_Id return Error_Msg_Id renames Erroutc.Get_Msg_Id;
448    --  Returns the Id of the message most recently posted using one of the
449    --  Error_Msg routines.
450
451    function Get_Location (E : Error_Msg_Id) return Source_Ptr
452      renames Erroutc.Get_Location;
453    --  Returns the flag location of the error message with the given id E
454
455    ------------------------
456    -- List Pragmas Table --
457    ------------------------
458
459    --  When a pragma Page or pragma List is encountered by the parser, an
460    --  entry is made in the following table. This table is then used to
461    --  control the full listing if one is being generated. Note that the
462    --  reason we do the processing in the parser is so that we get proper
463    --  listing control even in syntax check only mode.
464
465    type List_Pragma_Type is (List_On, List_Off, Page);
466
467    type List_Pragma_Record is record
468       Ptyp : List_Pragma_Type;
469       Ploc : Source_Ptr;
470    end record;
471
472    --  Note: Ploc points to the terminating semicolon in the List_Off and Page
473    --  cases, and to the pragma keyword for List_On. In the case of a pragma
474    --  List_Off, a List_On entry is also made in the table, pointing to the
475    --  pragma keyword. This ensures that, as required, a List (Off) pragma is
476    --  listed even in list off mode.
477
478    package List_Pragmas is new Table.Table (
479      Table_Component_Type => List_Pragma_Record,
480      Table_Index_Type     => Int,
481      Table_Low_Bound      => 1,
482      Table_Initial        => 50,
483      Table_Increment      => 200,
484      Table_Name           => "List_Pragmas");
485
486    ---------------------------
487    -- Ignore_Errors Feature --
488    ---------------------------
489
490    --  In certain cases, notably for optional subunits, the compiler operates
491    --  in a mode where errors are to be ignored, and the whole unit is to be
492    --  considered as not present. To implement this we provide the following
493    --  flag to enable special handling, where error messages are suppressed,
494    --  but the Fatal_Error flag will still be set in the normal manner.
495
496    Ignore_Errors_Enable : Nat := 0;
497    --  Triggering switch. If non-zero, then ignore errors mode is activated.
498    --  This is a counter to allow convenient nesting of enable/disable.
499
500    ------------------------------
501    -- Error Output Subprograms --
502    ------------------------------
503
504    procedure Initialize;
505    --  Initializes for output of error messages. Must be called for each
506    --  source file before using any of the other routines in the package.
507
508    procedure Finalize;
509    --  Finalize processing of error messages for one file and output message
510    --  indicating the number of detected errors.
511
512    procedure Error_Msg (Msg : String; Flag_Location : Source_Ptr);
513    --  Output a message at specified location. Can be called from the parser
514    --  or the semantic analyzer.
515
516    procedure Error_Msg_S (Msg : String);
517    --  Output a message at current scan pointer location. This routine can be
518    --  called only from the parser, since it references Scan_Ptr.
519
520    procedure Error_Msg_AP (Msg : String);
521    --  Output a message just after the previous token. This routine can be
522    --  called only from the parser, since it references Prev_Token_Ptr.
523
524    procedure Error_Msg_BC (Msg : String);
525    --  Output a message just before the current token. Note that the important
526    --  difference between this and the previous routine is that the BC case
527    --  posts a flag on the current line, whereas AP can post a flag at the
528    --  end of the preceding line. This routine can be called only from the
529    --  parser, since it references Token_Ptr.
530
531    procedure Error_Msg_SC (Msg : String);
532    --  Output a message at the start of the current token, unless we are at
533    --  the end of file, in which case we always output the message after the
534    --  last real token in the file. This routine can be called only from the
535    --  parser, since it references Token_Ptr.
536
537    procedure Error_Msg_SP (Msg : String);
538    --  Output a message at the start of the previous token. This routine can
539    --  be called only from the parser, since it references Prev_Token_Ptr.
540
541    procedure Error_Msg_N (Msg : String; N : Node_Or_Entity_Id);
542    --  Output a message at the Sloc of the given node. This routine can be
543    --  called from the parser or the semantic analyzer, although the call from
544    --  the latter is much more common (and is the most usual way of generating
545    --  error messages from the analyzer). The message text may contain a
546    --  single & insertion, which will reference the given node. The message is
547    --  suppressed if the node N already has a message posted, or if it is a
548    --  warning and warnings and N is an entity node for which warnings are
549    --  suppressed.
550
551    procedure Error_Msg_F (Msg : String; N : Node_Id);
552    --  Similar to Error_Msg_N except that the message is placed on the
553    --  first node of the construct N (First_Node (N)).
554
555    procedure Error_Msg_NE
556      (Msg : String;
557       N   : Node_Or_Entity_Id;
558       E   : Node_Or_Entity_Id);
559    --  Output a message at the Sloc of the given node N, with an insertion of
560    --  the name from the given entity node E. This is used by the semantic
561    --  routines, where this is a common error message situation. The Msg text
562    --  will contain a & or } as usual to mark the insertion point. This
563    --  routine can be called from the parser or the analyzer.
564
565    procedure Error_Msg_FE
566      (Msg : String;
567       N   : Node_Id;
568       E   : Node_Or_Entity_Id);
569    --  Same as Error_Msg_NE, except that the message is placed on the first
570    --  node of the construct N (First_Node (N)).
571
572    procedure Error_Msg_NEL
573      (Msg           : String;
574       N             : Node_Or_Entity_Id;
575       E             : Node_Or_Entity_Id;
576       Flag_Location : Source_Ptr);
577    --  Exactly the same as Error_Msg_NE, except that the flag is placed at
578    --  the specified Flag_Location instead of at Sloc (N).
579
580    procedure Error_Msg_NW
581      (Eflag : Boolean;
582       Msg   : String;
583       N     : Node_Or_Entity_Id);
584    --  This routine is used for posting a message conditionally. The message
585    --  is posted (with the same effect as Error_Msg_N (Msg, N) if and only
586    --  if Eflag is True and if the node N is within the main extended source
587    --  unit and comes from source. Typically this is a warning mode flag.
588
589    procedure Change_Error_Text (Error_Id : Error_Msg_Id; New_Msg : String);
590    --  The error message text of the message identified by Id is replaced by
591    --  the given text. This text may contain insertion characters in the
592    --  usual manner, and need not be the same length as the original text.
593
594    function First_Node (C : Node_Id) return Node_Id;
595    --  Given a construct C, finds the first node in the construct, i.e. the
596    --  one with the lowest Sloc value. This is useful in placing error msgs.
597
598    function First_Sloc (N : Node_Id) return Source_Ptr;
599    --  Given the node for an expression, return a source pointer value that
600    --  points to the start of the first token in the expression. In the case
601    --  where the expression is parenthesized, an attempt is made to include
602    --  the parentheses (i.e. to return the location of the initial paren).
603
604    procedure Purge_Messages (From : Source_Ptr; To : Source_Ptr)
605      renames Erroutc.Purge_Messages;
606    --  All error messages whose location is in the range From .. To (not
607    --  including the end points) will be deleted from the error listing.
608
609    procedure Remove_Warning_Messages (N : Node_Id);
610    --  Remove any warning messages corresponding to the Sloc of N or any
611    --  of its descendent nodes. No effect if no such warnings.
612
613    procedure Remove_Warning_Messages (L : List_Id);
614    --  Remove warnings on all elements of a list
615
616    procedure Set_Ignore_Errors (To : Boolean);
617    --  Following a call to this procedure with To=True, all error calls are
618    --  ignored. A call with To=False restores the default treatment in which
619    --  error calls are treated as usual (and as described in this spec).
620
621    procedure Set_Warnings_Mode_Off (Loc : Source_Ptr)
622      renames Erroutc.Set_Warnings_Mode_Off;
623    --  Called in response to a pragma Warnings (Off) to record the source
624    --  location from which warnings are to be turned off.
625
626    procedure Set_Warnings_Mode_On (Loc : Source_Ptr)
627      renames Erroutc.Set_Warnings_Mode_On;
628    --  Called in response to a pragma Warnings (On) to record the source
629    --  location from which warnings are to be turned back on.
630
631    function Compilation_Errors return Boolean
632      renames Erroutc.Compilation_Errors;
633    --  Returns true if errors have been detected, or warnings in -gnatwe
634    --  (treat warnings as errors) mode.
635
636    procedure Error_Msg_CRT (Feature : String; N : Node_Id);
637    --  Posts a non-fatal message on node N saying that the feature identified
638    --  by the Feature argument is not supported in either configurable
639    --  run-time mode or no run-time mode (as appropriate). In the former case,
640    --  the name of the library is output if available.
641
642    procedure dmsg (Id : Error_Msg_Id) renames Erroutc.dmsg;
643    --  Debugging routine to dump an error message
644
645    ------------------------------------
646    -- Utility Interface for Back End --
647    ------------------------------------
648
649    --  The following subprograms can be used by the back end for the purposes
650    --  of concocting error messages that are not output via Errout, e.g. the
651    --  messages generated by the gcc back end.
652
653    procedure Set_Identifier_Casing
654      (Identifier_Name : System.Address;
655       File_Name       : System.Address);
656    --  The identifier is a null terminated string that represents the name of
657    --  an identifier appearing in the source program. File_Name is a null
658    --  terminated string giving the corresponding file name for the identifier
659    --  as obtained from the front end by the use of Full_Debug_Name to the
660    --  source file referenced by the corresponding source location value. On
661    --  return, the name is in Name_Buffer, null terminated with Name_Len set.
662    --  This name is the identifier name as passed, cased according to the
663    --  default identifier casing for the given file.
664
665 end Errout;