OSDN Git Service

PR c++/40373
[pf3gnuchains/gcc-fork.git] / gcc / ada / sem_warn.adb
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                             S E M _ W A R N                              --
6 --                                                                          --
7 --                                 B o d y                                  --
8 --                                                                          --
9 --          Copyright (C) 1999-2009, 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 with Atree;    use Atree;
27 with Debug;    use Debug;
28 with Einfo;    use Einfo;
29 with Errout;   use Errout;
30 with Exp_Code; use Exp_Code;
31 with Fname;    use Fname;
32 with Lib;      use Lib;
33 with Namet;    use Namet;
34 with Nlists;   use Nlists;
35 with Opt;      use Opt;
36 with Rtsfind;  use Rtsfind;
37 with Sem;      use Sem;
38 with Sem_Ch8;  use Sem_Ch8;
39 with Sem_Aux;  use Sem_Aux;
40 with Sem_Eval; use Sem_Eval;
41 with Sem_Util; use Sem_Util;
42 with Sinfo;    use Sinfo;
43 with Sinput;   use Sinput;
44 with Snames;   use Snames;
45 with Stand;    use Stand;
46 with Stringt;  use Stringt;
47 with Uintp;    use Uintp;
48
49 package body Sem_Warn is
50
51    --  The following table collects Id's of entities that are potentially
52    --  unreferenced. See Check_Unset_Reference for further details.
53    --  ??? Check_Unset_Reference has zero information about this table.
54
55    package Unreferenced_Entities is new Table.Table (
56      Table_Component_Type => Entity_Id,
57      Table_Index_Type     => Nat,
58      Table_Low_Bound      => 1,
59      Table_Initial        => Alloc.Unreferenced_Entities_Initial,
60      Table_Increment      => Alloc.Unreferenced_Entities_Increment,
61      Table_Name           => "Unreferenced_Entities");
62
63    --  The following table collects potential warnings for IN OUT parameters
64    --  that are referenced but not modified. These warnings are processed when
65    --  the front end calls the procedure Output_Non_Modified_In_Out_Warnings.
66    --  The reason that we defer output of these messages is that we want to
67    --  detect the case where the relevant procedure is used as a generic actual
68    --  in an instantiation, since we suppress the warnings in this case. The
69    --  flag Used_As_Generic_Actual will be set in this case, but only at the
70    --  point of usage. Similarly, we suppress the message if the address of the
71    --  procedure is taken, where the flag Address_Taken may be set later.
72
73    package In_Out_Warnings is new Table.Table (
74      Table_Component_Type => Entity_Id,
75      Table_Index_Type     => Nat,
76      Table_Low_Bound      => 1,
77      Table_Initial        => Alloc.In_Out_Warnings_Initial,
78      Table_Increment      => Alloc.In_Out_Warnings_Increment,
79      Table_Name           => "In_Out_Warnings");
80
81    --------------------------------------------------------
82    -- Handling of Warnings Off, Unmodified, Unreferenced --
83    --------------------------------------------------------
84
85    --  The functions Has_Warnings_Off, Has_Unmodified, Has_Unreferenced must
86    --  generally be used instead of Warnings_Off, Has_Pragma_Unmodified and
87    --  Has_Pragma_Unreferenced, as noted in the specs in Einfo.
88
89    --  In order to avoid losing warnings in -gnatw.w (warn on unnecessary
90    --  warnings off pragma) mode, i.e. to avoid false negatives, the code
91    --  must follow some important rules.
92
93    --  Call these functions as late as possible, after completing all other
94    --  tests, just before the warnings is given. For example, don't write:
95
96    --     if not Has_Warnings_Off (E)
97    --       and then some-other-predicate-on-E then ..
98
99    --  Instead the following is preferred
100
101    --     if some-other-predicate-on-E
102    --       and then Has_Warnings_Off (E)
103
104    --  This way if some-other-predicate is false, we avoid a false indication
105    --  that a Warnings (Off,E) pragma was useful in preventing a warning.
106
107    --  The second rule is that if both Has_Unmodified and Has_Warnings_Off, or
108    --  Has_Unreferenced and Has_Warnings_Off are called, make sure that the
109    --  call to Has_Unmodified/Has_Unreferenced comes first, this way we record
110    --  that the Warnings (Off) could have been Unreferenced or Unmodified. In
111    --  fact Has_Unmodified/Has_Unreferenced includes a test for Warnings Off,
112    --  and so a subsequent test is not needed anyway (though it is harmless).
113
114    -----------------------
115    -- Local Subprograms --
116    -----------------------
117
118    function Generic_Package_Spec_Entity (E : Entity_Id) return Boolean;
119    --  This returns true if the entity E is declared within a generic package.
120    --  The point of this is to detect variables which are not assigned within
121    --  the generic, but might be assigned outside the package for any given
122    --  instance. These are cases where we leave the warnings to be posted for
123    --  the instance, when we will know more.
124
125    function Goto_Spec_Entity (E : Entity_Id) return Entity_Id;
126    --  If E is a parameter entity for a subprogram body, then this function
127    --  returns the corresponding spec entity, if not, E is returned unchanged.
128
129    function Has_Pragma_Unmodified_Check_Spec (E : Entity_Id) return Boolean;
130    --  Tests Has_Pragma_Unmodified flag for entity E. If E is not a formal,
131    --  this is simply the setting of the flag Has_Pragma_Unmodified. If E is
132    --  a body formal, the setting of the flag in the corresponding spec is
133    --  also checked (and True returned if either flag is True).
134
135    function Has_Pragma_Unreferenced_Check_Spec (E : Entity_Id) return Boolean;
136    --  Tests Has_Pragma_Unreferenced flag for entity E. If E is not a formal,
137    --  this is simply the setting of the flag Has_Pragma_Unreferenced. If E is
138    --  a body formal, the setting of the flag in the corresponding spec is
139    --  also checked (and True returned if either flag is True).
140
141    function Never_Set_In_Source_Check_Spec (E : Entity_Id) return Boolean;
142    --  Tests Never_Set_In_Source status for entity E. If E is not a formal,
143    --  this is simply the setting of the flag Never_Set_In_Source. If E is
144    --  a body formal, the setting of the flag in the corresponding spec is
145    --  also checked (and False returned if either flag is False).
146
147    function Operand_Has_Warnings_Suppressed (N : Node_Id) return Boolean;
148    --  This function traverses the expression tree represented by the node N
149    --  and determines if any sub-operand is a reference to an entity for which
150    --  the Warnings_Off flag is set. True is returned if such an entity is
151    --  encountered, and False otherwise.
152
153    function Referenced_Check_Spec (E : Entity_Id) return Boolean;
154    --  Tests Referenced status for entity E. If E is not a formal, this is
155    --  simply the setting of the flag Referenced. If E is a body formal, the
156    --  setting of the flag in the corresponding spec is also checked (and True
157    --  returned if either flag is True).
158
159    function Referenced_As_LHS_Check_Spec (E : Entity_Id) return Boolean;
160    --  Tests Referenced_As_LHS status for entity E. If E is not a formal, this
161    --  is simply the setting of the flag Referenced_As_LHS. If E is a body
162    --  formal, the setting of the flag in the corresponding spec is also
163    --  checked (and True returned if either flag is True).
164
165    function Referenced_As_Out_Parameter_Check_Spec
166      (E : Entity_Id) return Boolean;
167    --  Tests Referenced_As_Out_Parameter status for entity E. If E is not a
168    --  formal, this is simply the setting of Referenced_As_Out_Parameter. If E
169    --  is a body formal, the setting of the flag in the corresponding spec is
170    --  also checked (and True returned if either flag is True).
171
172    procedure Warn_On_Unreferenced_Entity
173      (Spec_E : Entity_Id;
174       Body_E : Entity_Id := Empty);
175    --  Output warnings for unreferenced entity E. For the case of an entry
176    --  formal, Body_E is the corresponding body entity for a particular
177    --  accept statement, and the message is posted on Body_E. In all other
178    --  cases, Body_E is ignored and must be Empty.
179
180    function Warnings_Off_Check_Spec (E : Entity_Id) return Boolean;
181    --  Returns True if Warnings_Off is set for the entity E or (in the case
182    --  where there is a Spec_Entity), Warnings_Off is set for the Spec_Entity.
183
184    --------------------------
185    -- Check_Code_Statement --
186    --------------------------
187
188    procedure Check_Code_Statement (N : Node_Id) is
189    begin
190       --  If volatile, nothing to worry about
191
192       if Is_Asm_Volatile (N) then
193          return;
194       end if;
195
196       --  Warn if no input or no output
197
198       Setup_Asm_Inputs (N);
199
200       if No (Asm_Input_Value) then
201          Error_Msg_F
202            ("?code statement with no inputs should usually be Volatile!", N);
203          return;
204       end if;
205
206       Setup_Asm_Outputs (N);
207
208       if No (Asm_Output_Variable) then
209          Error_Msg_F
210            ("?code statement with no outputs should usually be Volatile!", N);
211          return;
212       end if;
213
214       --  Check multiple code statements in a row
215
216       if Is_List_Member (N)
217         and then Present (Prev (N))
218         and then Nkind (Prev (N)) = N_Code_Statement
219       then
220          Error_Msg_F
221            ("?code statements in sequence should usually be Volatile!", N);
222          Error_Msg_F
223            ("\?(suggest using template with multiple instructions)!", N);
224       end if;
225    end Check_Code_Statement;
226
227    ---------------------------------
228    -- Check_Infinite_Loop_Warning --
229    ---------------------------------
230
231    --  The case we look for is a while loop which tests a local variable, where
232    --  there is no obvious direct or possible indirect update of the variable
233    --  within the body of the loop.
234
235    procedure Check_Infinite_Loop_Warning (Loop_Statement : Node_Id) is
236       Iter : constant Node_Id := Iteration_Scheme (Loop_Statement);
237
238       Ref : Node_Id := Empty;
239       --  Reference in iteration scheme to variable that might not be modified
240       --  in loop, indicating a possible infinite loop.
241
242       Var : Entity_Id := Empty;
243       --  Corresponding entity (entity of Ref)
244
245       Function_Call_Found : Boolean := False;
246       --  True if Find_Var found a function call in the condition
247
248       procedure Find_Var (N : Node_Id);
249       --  Inspect condition to see if it depends on a single entity reference.
250       --  If so, Ref is set to point to the reference node, and Var is set to
251       --  the referenced Entity.
252
253       function Has_Indirection (T : Entity_Id) return Boolean;
254       --  If the controlling variable is an access type, or is a record type
255       --  with access components, assume that it is changed indirectly and
256       --  suppress the warning. As a concession to low-level programming, in
257       --  particular within Declib, we also suppress warnings on a record
258       --  type that contains components of type Address or Short_Address.
259
260       function Is_Suspicious_Function_Name (E : Entity_Id) return Boolean;
261       --  Given an entity name, see if the name appears to have something to
262       --  do with I/O or network stuff, and if so, return True. Used to kill
263       --  some false positives on a heuristic basis that such functions will
264       --  likely have some strange side effect dependencies. A rather funny
265       --  kludge, but warning messages are in the heuristics business.
266
267       function Test_Ref (N : Node_Id) return Traverse_Result;
268       --  Test for reference to variable in question. Returns Abandon if
269       --  matching reference found.
270
271       function Find_Ref is new Traverse_Func (Test_Ref);
272       --  Function to traverse body of procedure. Returns Abandon if matching
273       --  reference found.
274
275       --------------
276       -- Find_Var --
277       --------------
278
279       procedure Find_Var (N : Node_Id) is
280       begin
281          --  Condition is a direct variable reference
282
283          if Is_Entity_Name (N) then
284             Ref := N;
285             Var := Entity (Ref);
286
287          --  Case of condition is a comparison with compile time known value
288
289          elsif Nkind (N) in N_Op_Compare then
290             if Compile_Time_Known_Value (Right_Opnd (N)) then
291                Find_Var (Left_Opnd (N));
292
293             elsif Compile_Time_Known_Value (Left_Opnd (N)) then
294                Find_Var (Right_Opnd (N));
295
296             --  Ignore any other comparison
297
298             else
299                return;
300             end if;
301
302          --  If condition is a negation, check its operand
303
304          elsif Nkind (N) = N_Op_Not then
305             Find_Var (Right_Opnd (N));
306
307          --  Case of condition is function call
308
309          elsif Nkind (N) = N_Function_Call then
310
311             Function_Call_Found := True;
312
313             --  Forget it if function name is not entity, who knows what
314             --  we might be calling?
315
316             if not Is_Entity_Name (Name (N)) then
317                return;
318
319             --  Forget it if function name is suspicious. A strange test
320             --  but warning generation is in the heuristics business!
321
322             elsif Is_Suspicious_Function_Name (Entity (Name (N))) then
323                return;
324
325             --  Forget it if warnings are suppressed on function entity
326
327             elsif Has_Warnings_Off (Entity (Name (N))) then
328                return;
329             end if;
330
331             --  OK, see if we have one argument
332
333             declare
334                PA : constant List_Id := Parameter_Associations (N);
335
336             begin
337                --  One argument, so check the argument
338
339                if Present (PA)
340                  and then List_Length (PA) = 1
341                then
342                   if Nkind (First (PA)) = N_Parameter_Association then
343                      Find_Var (Explicit_Actual_Parameter (First (PA)));
344                   else
345                      Find_Var (First (PA));
346                   end if;
347
348                --  Not one argument
349
350                else
351                   return;
352                end if;
353             end;
354
355          --  Any other kind of node is not something we warn for
356
357          else
358             return;
359          end if;
360       end Find_Var;
361
362       ---------------------
363       -- Has_Indirection --
364       ---------------------
365
366       function Has_Indirection (T : Entity_Id) return Boolean is
367          Comp : Entity_Id;
368          Rec  : Entity_Id;
369
370       begin
371          if Is_Access_Type (T) then
372             return True;
373
374          elsif Is_Private_Type (T)
375            and then Present (Full_View (T))
376            and then Is_Access_Type (Full_View (T))
377          then
378             return True;
379
380          elsif Is_Record_Type (T) then
381             Rec := T;
382
383          elsif Is_Private_Type (T)
384            and then Present (Full_View (T))
385            and then Is_Record_Type (Full_View (T))
386          then
387             Rec := Full_View (T);
388          else
389             return False;
390          end if;
391
392          Comp := First_Component (Rec);
393          while Present (Comp) loop
394             if Is_Access_Type (Etype (Comp))
395               or else Is_Descendent_Of_Address (Etype (Comp))
396             then
397                return True;
398             end if;
399
400             Next_Component (Comp);
401          end loop;
402
403          return False;
404       end Has_Indirection;
405
406       ---------------------------------
407       -- Is_Suspicious_Function_Name --
408       ---------------------------------
409
410       function Is_Suspicious_Function_Name (E : Entity_Id) return Boolean is
411          S : Entity_Id;
412
413          function Substring_Present (S : String) return Boolean;
414          --  Returns True if name buffer has given string delimited by non-
415          --  alphabetic characters or by end of string. S is lower case.
416
417          -----------------------
418          -- Substring_Present --
419          -----------------------
420
421          function Substring_Present (S : String) return Boolean is
422             Len : constant Natural := S'Length;
423
424          begin
425             for J in 1 .. Name_Len - (Len - 1) loop
426                if Name_Buffer (J .. J + (Len - 1)) = S
427                  and then
428                    (J = 1
429                      or else Name_Buffer (J - 1) not in 'a' .. 'z')
430                  and then
431                    (J + Len > Name_Len
432                      or else Name_Buffer (J + Len) not in 'a' .. 'z')
433                then
434                   return True;
435                end if;
436             end loop;
437
438             return False;
439          end Substring_Present;
440
441       --  Start of processing for Is_Suspicious_Function_Name
442
443       begin
444          S := E;
445          while Present (S) and then S /= Standard_Standard loop
446             Get_Name_String (Chars (S));
447
448             if Substring_Present ("io")
449               or else Substring_Present ("file")
450               or else Substring_Present ("network")
451             then
452                return True;
453             else
454                S := Scope (S);
455             end if;
456          end loop;
457
458          return False;
459       end Is_Suspicious_Function_Name;
460
461       --------------
462       -- Test_Ref --
463       --------------
464
465       function Test_Ref (N : Node_Id) return Traverse_Result is
466       begin
467          --  Waste of time to look at iteration scheme
468
469          if N = Iter then
470             return Skip;
471
472          --  Direct reference to variable in question
473
474          elsif Is_Entity_Name (N)
475            and then Present (Entity (N))
476            and then Entity (N) = Var
477          then
478             --  If this is an Lvalue, then definitely abandon, since
479             --  this could be a direct modification of the variable.
480
481             if May_Be_Lvalue (N) then
482                return Abandon;
483             end if;
484
485             --  If we appear in the context of a procedure call, then also
486             --  abandon, since there may be issues of non-visible side
487             --  effects going on in the call.
488
489             declare
490                P : Node_Id;
491
492             begin
493                P := N;
494                loop
495                   P := Parent (P);
496                   exit when P = Loop_Statement;
497
498                   --  Abandon if at procedure call, or something strange is
499                   --  going on (perhaps a node with no parent that should
500                   --  have one but does not?) As always, for a warning we
501                   --  prefer to just abandon the warning than get into the
502                   --  business of complaining about the tree structure here!
503
504                   if No (P) or else Nkind (P) = N_Procedure_Call_Statement then
505                      return Abandon;
506                   end if;
507                end loop;
508             end;
509
510             --  Reference to variable renaming variable in question
511
512          elsif Is_Entity_Name (N)
513            and then Present (Entity (N))
514            and then Ekind (Entity (N)) = E_Variable
515            and then Present (Renamed_Object (Entity (N)))
516            and then Is_Entity_Name (Renamed_Object (Entity (N)))
517            and then Entity (Renamed_Object (Entity (N))) = Var
518            and then May_Be_Lvalue (N)
519          then
520             return Abandon;
521
522             --  Call to subprogram
523
524          elsif Nkind (N) = N_Procedure_Call_Statement
525            or else Nkind (N) = N_Function_Call
526          then
527             --  If subprogram is within the scope of the entity we are dealing
528             --  with as the loop variable, then it could modify this parameter,
529             --  so we abandon in this case. In the case of a subprogram that is
530             --  not an entity we also abandon. The check for no entity being
531             --  present is a defense against previous errors.
532
533             if not Is_Entity_Name (Name (N))
534               or else No (Entity (Name (N)))
535               or else Scope_Within (Entity (Name (N)), Scope (Var))
536             then
537                return Abandon;
538             end if;
539          end if;
540
541          --  All OK, continue scan
542
543          return OK;
544       end Test_Ref;
545
546    --  Start of processing for Check_Infinite_Loop_Warning
547
548    begin
549       --  We need a while iteration with no condition actions. Condition
550       --  actions just make things too complicated to get the warning right.
551
552       if No (Iter)
553         or else No (Condition (Iter))
554         or else Present (Condition_Actions (Iter))
555         or else Debug_Flag_Dot_W
556       then
557          return;
558       end if;
559
560       --  Initial conditions met, see if condition is of right form
561
562       Find_Var (Condition (Iter));
563
564       --  Nothing to do if local variable from source not found. If it's a
565       --  renaming, it is probably renaming something too complicated to deal
566       --  with here.
567
568       if No (Var)
569         or else Ekind (Var) /= E_Variable
570         or else Is_Library_Level_Entity (Var)
571         or else not Comes_From_Source (Var)
572         or else Nkind (Parent (Var)) = N_Object_Renaming_Declaration
573       then
574          return;
575
576       --  Nothing to do if there is some indirection involved (assume that the
577       --  designated variable might be modified in some way we don't see).
578       --  However, if no function call was found, then we don't care about
579       --  indirections, because the condition must be something like "while X
580       --  /= null loop", so we don't care if X.all is modified in the loop.
581
582       elsif Function_Call_Found and then Has_Indirection (Etype (Var)) then
583          return;
584
585       --  Same sort of thing for volatile variable, might be modified by
586       --  some other task or by the operating system in some way.
587
588       elsif Is_Volatile (Var) then
589          return;
590       end if;
591
592       --  Filter out case of original statement sequence starting with delay.
593       --  We assume this is a multi-tasking program and that the condition
594       --  is affected by other threads (some kind of busy wait).
595
596       declare
597          Fstm : constant Node_Id :=
598                   Original_Node (First (Statements (Loop_Statement)));
599       begin
600          if Nkind (Fstm) = N_Delay_Relative_Statement
601            or else Nkind (Fstm) = N_Delay_Until_Statement
602          then
603             return;
604          end if;
605       end;
606
607       --  We have a variable reference of the right form, now we scan the loop
608       --  body to see if it looks like it might not be modified
609
610       if Find_Ref (Loop_Statement) = OK then
611          Error_Msg_NE
612            ("?variable& is not modified in loop body!", Ref, Var);
613          Error_Msg_N
614            ("\?possible infinite loop!", Ref);
615       end if;
616    end Check_Infinite_Loop_Warning;
617
618    ----------------------------
619    -- Check_Low_Bound_Tested --
620    ----------------------------
621
622    procedure Check_Low_Bound_Tested (Expr : Node_Id) is
623    begin
624       if Comes_From_Source (Expr) then
625          declare
626             L : constant Node_Id := Left_Opnd (Expr);
627             R : constant Node_Id := Right_Opnd (Expr);
628          begin
629             if Nkind (L) = N_Attribute_Reference
630               and then Attribute_Name (L) = Name_First
631               and then Is_Entity_Name (Prefix (L))
632               and then Is_Formal (Entity (Prefix (L)))
633             then
634                Set_Low_Bound_Tested (Entity (Prefix (L)));
635             end if;
636
637             if Nkind (R) = N_Attribute_Reference
638               and then Attribute_Name (R) = Name_First
639               and then Is_Entity_Name (Prefix (R))
640               and then Is_Formal (Entity (Prefix (R)))
641             then
642                Set_Low_Bound_Tested (Entity (Prefix (R)));
643             end if;
644          end;
645       end if;
646    end Check_Low_Bound_Tested;
647
648    ----------------------
649    -- Check_References --
650    ----------------------
651
652    procedure Check_References (E : Entity_Id; Anod : Node_Id := Empty) is
653       E1  : Entity_Id;
654       E1T : Entity_Id;
655       UR  : Node_Id;
656
657       function Body_Formal
658         (E                : Entity_Id;
659          Accept_Statement : Node_Id) return Entity_Id;
660       --  For an entry formal entity from an entry declaration, find the
661       --  corresponding body formal from the given accept statement.
662
663       function Missing_Subunits return Boolean;
664       --  We suppress warnings when there are missing subunits, because this
665       --  may generate too many false positives: entities in a parent may only
666       --  be referenced in one of the subunits. We make an exception for
667       --  subunits that contain no other stubs.
668
669       procedure Output_Reference_Error (M : String);
670       --  Used to output an error message. Deals with posting the error on the
671       --  body formal in the accept case.
672
673       function Publicly_Referenceable (Ent : Entity_Id) return Boolean;
674       --  This is true if the entity in question is potentially referenceable
675       --  from another unit. This is true for entities in packages that are at
676       --  the library level.
677
678       function Warnings_Off_E1 return Boolean;
679       --  Return True if Warnings_Off is set for E1, or for its Etype (E1T),
680       --  or for the base type of E1T.
681
682       -----------------
683       -- Body_Formal --
684       -----------------
685
686       function Body_Formal
687         (E                : Entity_Id;
688          Accept_Statement : Node_Id) return Entity_Id
689       is
690          Body_Param : Node_Id;
691          Body_E     : Entity_Id;
692
693       begin
694          --  Loop to find matching parameter in accept statement
695
696          Body_Param := First (Parameter_Specifications (Accept_Statement));
697          while Present (Body_Param) loop
698             Body_E := Defining_Identifier (Body_Param);
699
700             if Chars (Body_E) = Chars (E) then
701                return Body_E;
702             end if;
703
704             Next (Body_Param);
705          end loop;
706
707          --  Should never fall through, should always find a match
708
709          raise Program_Error;
710       end Body_Formal;
711
712       ----------------------
713       -- Missing_Subunits --
714       ----------------------
715
716       function Missing_Subunits return Boolean is
717          D : Node_Id;
718
719       begin
720          if not Unloaded_Subunits then
721
722             --  Normal compilation, all subunits are present
723
724             return False;
725
726          elsif E /= Main_Unit_Entity then
727
728             --  No warnings on a stub that is not the main unit
729
730             return True;
731
732          elsif Nkind (Unit_Declaration_Node (E)) in N_Proper_Body then
733             D := First (Declarations (Unit_Declaration_Node (E)));
734             while Present (D) loop
735
736                --  No warnings if the proper body contains nested stubs
737
738                if Nkind (D) in N_Body_Stub then
739                   return True;
740                end if;
741
742                Next (D);
743             end loop;
744
745             return False;
746
747          else
748             --  Missing stubs elsewhere
749
750             return True;
751          end if;
752       end Missing_Subunits;
753
754       ----------------------------
755       -- Output_Reference_Error --
756       ----------------------------
757
758       procedure Output_Reference_Error (M : String) is
759       begin
760          --  Never issue messages for internal names
761
762          if Is_Internal_Name (Chars (E1)) then
763             return;
764          end if;
765
766          --  Don't output message for IN OUT formal unless we have the warning
767          --  flag specifically set. It is a bit odd to distinguish IN OUT
768          --  formals from other cases. This distinction is historical in
769          --  nature. Warnings for IN OUT formals were added fairly late.
770
771          if Ekind (E1) = E_In_Out_Parameter
772            and then not Check_Unreferenced_Formals
773          then
774             return;
775          end if;
776
777          --  Other than accept case, post error on defining identifier
778
779          if No (Anod) then
780             Error_Msg_N (M, E1);
781
782          --  Accept case, find body formal to post the message
783
784          else
785             Error_Msg_NE (M, Body_Formal (E1, Accept_Statement => Anod), E1);
786
787          end if;
788       end Output_Reference_Error;
789
790       ----------------------------
791       -- Publicly_Referenceable --
792       ----------------------------
793
794       function Publicly_Referenceable (Ent : Entity_Id) return Boolean is
795          P    : Node_Id;
796          Prev : Node_Id;
797
798       begin
799          --  A formal parameter is never referenceable outside the body of its
800          --  subprogram or entry.
801
802          if Is_Formal (Ent) then
803             return False;
804          end if;
805
806          --  Examine parents to look for a library level package spec. But if
807          --  we find a body or block or other similar construct along the way,
808          --  we cannot be referenced.
809
810          Prev := Ent;
811          P    := Parent (Ent);
812          loop
813             case Nkind (P) is
814
815                --  If we get to top of tree, then publicly referenceable
816
817                when N_Empty =>
818                   return True;
819
820                --  If we reach a generic package declaration, then always
821                --  consider this referenceable, since any instantiation will
822                --  have access to the entities in the generic package. Note
823                --  that the package itself may not be instantiated, but then
824                --  we will get a warning for the package entity.
825
826                --  Note that generic formal parameters are themselves not
827                --  publicly referenceable in an instance, and warnings on them
828                --  are useful.
829
830                when N_Generic_Package_Declaration =>
831                   return
832                     not Is_List_Member (Prev)
833                       or else List_Containing (Prev)
834                         /= Generic_Formal_Declarations (P);
835
836                --  Similarly, the generic formals of a generic subprogram are
837                --  not accessible.
838
839                when N_Generic_Subprogram_Declaration  =>
840                   if Is_List_Member (Prev)
841                     and then List_Containing (Prev) =
842                                Generic_Formal_Declarations (P)
843                   then
844                      return False;
845                   else
846                      P := Parent (P);
847                   end if;
848
849                --  If we reach a subprogram body, entity is not referenceable
850                --  unless it is the defining entity of the body. This will
851                --  happen, e.g. when a function is an attribute renaming that
852                --  is rewritten as a body.
853
854                when N_Subprogram_Body  =>
855                   if Ent /= Defining_Entity (P) then
856                      return False;
857                   else
858                      P := Parent (P);
859                   end if;
860
861                --  If we reach any other body, definitely not referenceable
862
863                when N_Package_Body    |
864                     N_Task_Body       |
865                     N_Entry_Body      |
866                     N_Protected_Body  |
867                     N_Block_Statement |
868                     N_Subunit         =>
869                   return False;
870
871                --  For all other cases, keep looking up tree
872
873                when others =>
874                   Prev := P;
875                   P    := Parent (P);
876             end case;
877          end loop;
878       end Publicly_Referenceable;
879
880       ---------------------
881       -- Warnings_Off_E1 --
882       ---------------------
883
884       function Warnings_Off_E1 return Boolean is
885       begin
886          return Has_Warnings_Off (E1T)
887            or else Has_Warnings_Off (Base_Type (E1T))
888            or else Warnings_Off_Check_Spec (E1);
889       end Warnings_Off_E1;
890
891    --  Start of processing for Check_References
892
893    begin
894       --  No messages if warnings are suppressed, or if we have detected any
895       --  real errors so far (this last check avoids junk messages resulting
896       --  from errors, e.g. a subunit that is not loaded).
897
898       if Warning_Mode = Suppress
899         or else Serious_Errors_Detected /= 0
900       then
901          return;
902       end if;
903
904       --  We also skip the messages if any subunits were not loaded (see
905       --  comment in Sem_Ch10 to understand how this is set, and why it is
906       --  necessary to suppress the warnings in this case).
907
908       if Missing_Subunits then
909          return;
910       end if;
911
912       --  Otherwise loop through entities, looking for suspicious stuff
913
914       E1 := First_Entity (E);
915       while Present (E1) loop
916          E1T := Etype (E1);
917
918          --  We are only interested in source entities. We also don't issue
919          --  warnings within instances, since the proper place for such
920          --  warnings is on the template when it is compiled.
921
922          if Comes_From_Source (E1)
923            and then Instantiation_Location (Sloc (E1)) = No_Location
924          then
925             --  We are interested in variables and out/in-out parameters, but
926             --  we exclude protected types, too complicated to worry about.
927
928             if Ekind (E1) = E_Variable
929                  or else
930                 ((Ekind (E1) = E_Out_Parameter
931                     or else Ekind (E1) = E_In_Out_Parameter)
932                   and then not Is_Protected_Type (Current_Scope))
933             then
934                --  Case of an unassigned variable
935
936                --  First gather any Unset_Reference indication for E1. In the
937                --  case of a parameter, it is the Spec_Entity that is relevant.
938
939                if Ekind (E1) = E_Out_Parameter
940                  and then Present (Spec_Entity (E1))
941                then
942                   UR := Unset_Reference (Spec_Entity (E1));
943                else
944                   UR := Unset_Reference (E1);
945                end if;
946
947                --  Special processing for access types
948
949                if Present (UR)
950                  and then Is_Access_Type (E1T)
951                then
952                   --  For access types, the only time we made a UR entry was
953                   --  for a dereference, and so we post the appropriate warning
954                   --  here (note that the dereference may not be explicit in
955                   --  the source, for example in the case of a dispatching call
956                   --  with an anonymous access controlling formal, or of an
957                   --  assignment of a pointer involving discriminant check on
958                   --  the designated object).
959
960                   if not Warnings_Off_E1 then
961                      Error_Msg_NE ("?& may be null!", UR, E1);
962                   end if;
963
964                   goto Continue;
965
966                --  Case of variable that could be a constant. Note that we
967                --  never signal such messages for generic package entities,
968                --  since a given instance could have modifications outside
969                --  the package.
970
971                elsif Warn_On_Constant
972                  and then (Ekind (E1) = E_Variable
973                              and then Has_Initial_Value (E1))
974                  and then Never_Set_In_Source_Check_Spec (E1)
975                  and then not Address_Taken (E1)
976                  and then not Generic_Package_Spec_Entity (E1)
977                then
978                   --  A special case, if this variable is volatile and not
979                   --  imported, it is not helpful to tell the programmer
980                   --  to mark the variable as constant, since this would be
981                   --  illegal by virtue of RM C.6(13).
982
983                   if (Is_Volatile (E1) or else Has_Volatile_Components (E1))
984                     and then not Is_Imported (E1)
985                   then
986                      Error_Msg_N
987                        ("?& is not modified, volatile has no effect!", E1);
988
989                   --  Another special case, Exception_Occurrence, this catches
990                   --  the case of exception choice (and a bit more too, but not
991                   --  worth doing more investigation here).
992
993                   elsif Is_RTE (E1T, RE_Exception_Occurrence) then
994                      null;
995
996                   --  Here we give the warning if referenced and no pragma
997                   --  Unreferenced or Unmodified is present.
998
999                   else
1000                      --  Variable case
1001
1002                      if Ekind (E1) = E_Variable then
1003                         if Referenced_Check_Spec (E1)
1004                           and then not Has_Pragma_Unreferenced_Check_Spec (E1)
1005                           and then not Has_Pragma_Unmodified_Check_Spec (E1)
1006                         then
1007                            if not Warnings_Off_E1 then
1008                               Error_Msg_N -- CODEFIX
1009                                 ("?& is not modified, "
1010                                  & "could be declared constant!",
1011                                  E1);
1012                            end if;
1013                         end if;
1014                      end if;
1015                   end if;
1016
1017                --  Other cases of a variable or parameter never set in source
1018
1019                elsif Never_Set_In_Source_Check_Spec (E1)
1020
1021                   --  No warning if warning for this case turned off
1022
1023                   and then Warn_On_No_Value_Assigned
1024
1025                   --  No warning if address taken somewhere
1026
1027                   and then not Address_Taken (E1)
1028
1029                   --  No warning if explicit initial value
1030
1031                   and then not Has_Initial_Value (E1)
1032
1033                   --  No warning for generic package spec entities, since we
1034                   --  might set them in a child unit or something like that
1035
1036                   and then not Generic_Package_Spec_Entity (E1)
1037
1038                   --  No warning if fully initialized type, except that for
1039                   --  this purpose we do not consider access types to qualify
1040                   --  as fully initialized types (relying on an access type
1041                   --  variable being null when it is never set is a bit odd!)
1042
1043                   --  Also we generate warning for an out parameter that is
1044                   --  never referenced, since again it seems odd to rely on
1045                   --  default initialization to set an out parameter value.
1046
1047                  and then (Is_Access_Type (E1T)
1048                             or else Ekind (E1) = E_Out_Parameter
1049                             or else not Is_Fully_Initialized_Type (E1T))
1050                then
1051                   --  Do not output complaint about never being assigned a
1052                   --  value if a pragma Unmodified applies to the variable
1053                   --  we are examining, or if it is a parameter, if there is
1054                   --  a pragma Unreferenced for the corresponding spec, or
1055                   --  if the type is marked as having unreferenced objects.
1056                   --  The last is a little peculiar, but better too few than
1057                   --  too many warnings in this situation.
1058
1059                   if Has_Pragma_Unreferenced_Objects (E1T)
1060                     or else Has_Pragma_Unmodified_Check_Spec (E1)
1061                   then
1062                      null;
1063
1064                   --  IN OUT parameter case where parameter is referenced. We
1065                   --  separate this out, since this is the case where we delay
1066                   --  output of the warning until more information is available
1067                   --  (about use in an instantiation or address being taken).
1068
1069                   elsif Ekind (E1) = E_In_Out_Parameter
1070                     and then Referenced_Check_Spec (E1)
1071                   then
1072                      --  Suppress warning if private type, and the procedure
1073                      --  has a separate declaration in a different unit. This
1074                      --  is the case where the client of a package sees only
1075                      --  the private type, and it may be quite reasonable
1076                      --  for the logical view to be IN OUT, even if the
1077                      --  implementation ends up using access types or some
1078                      --  other method to achieve the local effect of a
1079                      --  modification. On the other hand if the spec and body
1080                      --  are in the same unit, we are in the package body and
1081                      --  there we have less excuse for a junk IN OUT parameter.
1082
1083                      if Has_Private_Declaration (E1T)
1084                        and then Present (Spec_Entity (E1))
1085                        and then not In_Same_Source_Unit (E1, Spec_Entity (E1))
1086                      then
1087                         null;
1088
1089                      --  Suppress warning for any parameter of a dispatching
1090                      --  operation, since it is quite reasonable to have an
1091                      --  operation that is overridden, and for some subclasses
1092                      --  needs the formal to be IN OUT and for others happens
1093                      --  not to assign it.
1094
1095                      elsif Is_Dispatching_Operation
1096                              (Scope (Goto_Spec_Entity (E1)))
1097                      then
1098                         null;
1099
1100                      --  Suppress warning if composite type contains any access
1101                      --  component, since the logical effect of modifying a
1102                      --  parameter may be achieved by modifying a referenced
1103                      --  object.
1104
1105                      elsif Is_Composite_Type (E1T)
1106                        and then Has_Access_Values (E1T)
1107                      then
1108                         null;
1109
1110                      --  OK, looks like warning for an IN OUT parameter that
1111                      --  could be IN makes sense, but we delay the output of
1112                      --  the warning, pending possibly finding out later on
1113                      --  that the associated subprogram is used as a generic
1114                      --  actual, or its address/access is taken. In these two
1115                      --  cases, we suppress the warning because the context may
1116                      --  force use of IN OUT, even if in this particular case
1117                      --  the formal is not modified.
1118
1119                      else
1120                         In_Out_Warnings.Append (E1);
1121                      end if;
1122
1123                   --  Other cases of formals
1124
1125                   elsif Is_Formal (E1) then
1126                      if not Is_Trivial_Subprogram (Scope (E1)) then
1127                         if Referenced_Check_Spec (E1) then
1128                            if not Has_Pragma_Unmodified_Check_Spec (E1)
1129                              and then not Warnings_Off_E1
1130                            then
1131                               Output_Reference_Error
1132                                 ("?formal parameter& is read but "
1133                                  & "never assigned!");
1134                            end if;
1135
1136                         elsif not Has_Pragma_Unreferenced_Check_Spec (E1)
1137                           and then not Warnings_Off_E1
1138                         then
1139                            Output_Reference_Error
1140                              ("?formal parameter& is not referenced!");
1141                         end if;
1142                      end if;
1143
1144                   --  Case of variable
1145
1146                   else
1147                      if Referenced (E1) then
1148                         if not Has_Unmodified (E1)
1149                           and then not Warnings_Off_E1
1150                         then
1151                            Output_Reference_Error
1152                              ("?variable& is read but never assigned!");
1153                         end if;
1154
1155                      elsif not Has_Unreferenced (E1)
1156                        and then not Warnings_Off_E1
1157                      then
1158                         Output_Reference_Error -- CODEFIX
1159                           ("?variable& is never read and never assigned!");
1160                      end if;
1161
1162                      --  Deal with special case where this variable is hidden
1163                      --  by a loop variable.
1164
1165                      if Ekind (E1) = E_Variable
1166                        and then Present (Hiding_Loop_Variable (E1))
1167                        and then not Warnings_Off_E1
1168                      then
1169                         Error_Msg_N
1170                           ("?for loop implicitly declares loop variable!",
1171                            Hiding_Loop_Variable (E1));
1172
1173                         Error_Msg_Sloc := Sloc (E1);
1174                         Error_Msg_N
1175                           ("\?declaration hides & declared#!",
1176                            Hiding_Loop_Variable (E1));
1177                      end if;
1178                   end if;
1179
1180                   goto Continue;
1181                end if;
1182
1183                --  Check for unset reference
1184
1185                if Warn_On_No_Value_Assigned and then Present (UR) then
1186
1187                   --  For other than access type, go back to original node to
1188                   --  deal with case where original unset reference has been
1189                   --  rewritten during expansion.
1190
1191                   --  In some cases, the original node may be a type conversion
1192                   --  or qualification, and in this case we want the object
1193                   --  entity inside.
1194
1195                   UR := Original_Node (UR);
1196                   while Nkind (UR) = N_Type_Conversion
1197                     or else Nkind (UR) = N_Qualified_Expression
1198                   loop
1199                      UR := Expression (UR);
1200                   end loop;
1201
1202                   --  Here we issue the warning, all checks completed
1203
1204                   --  If we have a return statement, this was a case of an OUT
1205                   --  parameter not being set at the time of the return. (Note:
1206                   --  it can't be N_Extended_Return_Statement, because those
1207                   --  are only for functions, and functions do not allow OUT
1208                   --  parameters.)
1209
1210                   if not Is_Trivial_Subprogram (Scope (E1)) then
1211                      if Nkind (UR) = N_Simple_Return_Statement
1212                        and then not Has_Pragma_Unmodified_Check_Spec (E1)
1213                      then
1214                         if not Warnings_Off_E1 then
1215                            Error_Msg_NE
1216                              ("?OUT parameter& not set before return", UR, E1);
1217                         end if;
1218
1219                         --  If the unset reference is a selected component
1220                         --  prefix from source, mention the component as well.
1221                         --  If the selected component comes from expansion, all
1222                         --  we know is that the entity is not fully initialized
1223                         --  at the point of the reference. Locate a random
1224                         --  uninitialized component to get a better message.
1225
1226                      elsif Nkind (Parent (UR)) = N_Selected_Component then
1227                         Error_Msg_Node_2 := Selector_Name (Parent (UR));
1228
1229                         if not Comes_From_Source (Parent (UR)) then
1230                            declare
1231                               Comp : Entity_Id;
1232
1233                            begin
1234                               Comp := First_Entity (E1T);
1235                               while Present (Comp) loop
1236                                  if Ekind (Comp) = E_Component
1237                                    and then Nkind (Parent (Comp)) =
1238                                    N_Component_Declaration
1239                                    and then No (Expression (Parent (Comp)))
1240                                  then
1241                                     Error_Msg_Node_2 := Comp;
1242                                     exit;
1243                                  end if;
1244
1245                                  Next_Entity (Comp);
1246                               end loop;
1247                            end;
1248                         end if;
1249
1250                         --  Issue proper warning. This is a case of referencing
1251                         --  a variable before it has been explicitly assigned.
1252                         --  For access types, UR was only set for dereferences,
1253                         --  so the issue is that the value may be null.
1254
1255                         if not Is_Trivial_Subprogram (Scope (E1)) then
1256                            if not Warnings_Off_E1 then
1257                               if Is_Access_Type (Etype (Parent (UR))) then
1258                                  Error_Msg_N ("?`&.&` may be null!", UR);
1259                               else
1260                                  Error_Msg_N
1261                                    ("?`&.&` may be referenced before "
1262                                     & "it has a value!", UR);
1263                               end if;
1264                            end if;
1265                         end if;
1266
1267                         --  All other cases of unset reference active
1268
1269                      elsif not Warnings_Off_E1 then
1270                         Error_Msg_N
1271                           ("?& may be referenced before it has a value!",
1272                            UR);
1273                      end if;
1274                   end if;
1275
1276                   goto Continue;
1277                end if;
1278             end if;
1279
1280             --  Then check for unreferenced entities. Note that we are only
1281             --  interested in entities whose Referenced flag is not set.
1282
1283             if not Referenced_Check_Spec (E1)
1284
1285                --  If Referenced_As_LHS is set, then that's still interesting
1286                --  (potential "assigned but never read" case), but not if we
1287                --  have pragma Unreferenced, which cancels this warning.
1288
1289               and then (not Referenced_As_LHS_Check_Spec (E1)
1290                           or else not Has_Unreferenced (E1))
1291
1292                --  Check that warnings on unreferenced entities are enabled
1293
1294               and then
1295                 ((Check_Unreferenced and then not Is_Formal (E1))
1296
1297                      --  Case of warning on unreferenced formal
1298
1299                      or else
1300                       (Check_Unreferenced_Formals and then Is_Formal (E1))
1301
1302                      --  Case of warning on unread variables modified by an
1303                      --  assignment, or an OUT parameter if it is the only one.
1304
1305                      or else
1306                        (Warn_On_Modified_Unread
1307                           and then Referenced_As_LHS_Check_Spec (E1))
1308
1309                      --  Case of warning on any unread OUT parameter (note
1310                      --  such indications are only set if the appropriate
1311                      --  warning options were set, so no need to recheck here.
1312
1313                      or else
1314                        Referenced_As_Out_Parameter_Check_Spec (E1))
1315
1316                --  Labels, and enumeration literals, and exceptions. The
1317                --  warnings are also placed on local packages that cannot be
1318                --  referenced from elsewhere, including those declared within a
1319                --  package body.
1320
1321                and then (Is_Object (E1)
1322                            or else
1323                          Is_Type (E1)
1324                            or else
1325                          Ekind (E1) = E_Label
1326                            or else
1327                          Ekind (E1) = E_Exception
1328                            or else
1329                          Ekind (E1) = E_Named_Integer
1330                            or else
1331                          Ekind (E1) = E_Named_Real
1332                            or else
1333                          Is_Overloadable (E1)
1334
1335                            --  Package case, if the main unit is a package spec
1336                            --  or generic package spec, then there may be a
1337                            --  corresponding body that references this package
1338                            --  in some other file. Otherwise we can be sure
1339                            --  that there is no other reference.
1340
1341                            or else
1342                              (Ekind (E1) = E_Package
1343                                 and then
1344                                   not Is_Package_Or_Generic_Package
1345                                         (Cunit_Entity (Current_Sem_Unit))))
1346
1347                --  Exclude instantiations, since there is no reason why every
1348                --  entity in an instantiation should be referenced.
1349
1350                and then Instantiation_Location (Sloc (E1)) = No_Location
1351
1352                --  Exclude formal parameters from bodies if the corresponding
1353                --  spec entity has been referenced in the case where there is
1354                --  a separate spec.
1355
1356                and then not (Is_Formal (E1)
1357                                and then
1358                              Ekind (Scope (E1)) = E_Subprogram_Body
1359                                and then
1360                              Present (Spec_Entity (E1))
1361                                and then
1362                              Referenced (Spec_Entity (E1)))
1363
1364                --  Consider private type referenced if full view is referenced.
1365                --  If there is not full view, this is a generic type on which
1366                --  warnings are also useful.
1367
1368                and then
1369                  not (Is_Private_Type (E1)
1370                    and then
1371                      Present (Full_View (E1))
1372                        and then Referenced (Full_View (E1)))
1373
1374                --  Don't worry about full view, only about private type
1375
1376                and then not Has_Private_Declaration (E1)
1377
1378                --  Eliminate dispatching operations from consideration, we
1379                --  cannot tell if these are referenced or not in any easy
1380                --  manner (note this also catches Adjust/Finalize/Initialize).
1381
1382                and then not Is_Dispatching_Operation (E1)
1383
1384                --  Check entity that can be publicly referenced (we do not give
1385                --  messages for such entities, since there could be other
1386                --  units, not involved in this compilation, that contain
1387                --  relevant references.
1388
1389                and then not Publicly_Referenceable (E1)
1390
1391                --  Class wide types are marked as source entities, but they are
1392                --  not really source entities, and are always created, so we do
1393                --  not care if they are not referenced.
1394
1395                and then Ekind (E1) /= E_Class_Wide_Type
1396
1397                --  Objects other than parameters of task types are allowed to
1398                --  be non-referenced, since they start up tasks!
1399
1400                and then ((Ekind (E1) /= E_Variable
1401                              and then Ekind (E1) /= E_Constant
1402                              and then Ekind (E1) /= E_Component)
1403                            or else not Is_Task_Type (E1T))
1404
1405                --  For subunits, only place warnings on the main unit itself,
1406                --  since parent units are not completely compiled.
1407
1408                and then (Nkind (Unit (Cunit (Main_Unit))) /= N_Subunit
1409                            or else
1410                          Get_Source_Unit (E1) = Main_Unit)
1411
1412                --  No warning on a return object, because these are often
1413                --  created with a single expression and an implicit return.
1414                --  If the object is a variable there will be a warning
1415                --  indicating that it could be declared constant.
1416
1417                and then not
1418                  (Ekind (E1) = E_Constant and then Is_Return_Object (E1))
1419             then
1420                --  Suppress warnings in internal units if not in -gnatg mode
1421                --  (these would be junk warnings for an applications program,
1422                --  since they refer to problems in internal units).
1423
1424                if GNAT_Mode
1425                  or else not
1426                    Is_Internal_File_Name
1427                      (Unit_File_Name (Get_Source_Unit (E1)))
1428                then
1429                   --  We do not immediately flag the error. This is because we
1430                   --  have not expanded generic bodies yet, and they may have
1431                   --  the missing reference. So instead we park the entity on a
1432                   --  list, for later processing. However for the case of an
1433                   --  accept statement we want to output messages now, since
1434                   --  we know we already have all information at hand, and we
1435                   --  also want to have separate warnings for each accept
1436                   --  statement for the same entry.
1437
1438                   if Present (Anod) then
1439                      pragma Assert (Is_Formal (E1));
1440
1441                      --  The unreferenced entity is E1, but post the warning
1442                      --  on the body entity for this accept statement.
1443
1444                      if not Warnings_Off_E1 then
1445                         Warn_On_Unreferenced_Entity
1446                           (E1, Body_Formal (E1, Accept_Statement => Anod));
1447                      end if;
1448
1449                   elsif not Warnings_Off_E1 then
1450                      Unreferenced_Entities.Append (E1);
1451                   end if;
1452                end if;
1453
1454             --  Generic units are referenced in the generic body, but if they
1455             --  are not public and never instantiated we want to force a
1456             --  warning on them. We treat them as redundant constructs to
1457             --  minimize noise.
1458
1459             elsif Is_Generic_Subprogram (E1)
1460               and then not Is_Instantiated (E1)
1461               and then not Publicly_Referenceable (E1)
1462               and then Instantiation_Depth (Sloc (E1)) = 0
1463               and then Warn_On_Redundant_Constructs
1464             then
1465                if not Warnings_Off_E1 then
1466                   Unreferenced_Entities.Append (E1);
1467
1468                --  Force warning on entity
1469
1470                   Set_Referenced (E1, False);
1471                end if;
1472             end if;
1473          end if;
1474
1475          --  Recurse into nested package or block. Do not recurse into a formal
1476          --  package, because the corresponding body is not analyzed.
1477
1478          <<Continue>>
1479             if (Is_Package_Or_Generic_Package (E1)
1480                   and then Nkind (Parent (E1)) = N_Package_Specification
1481                   and then
1482                     Nkind (Original_Node (Unit_Declaration_Node (E1)))
1483                       /= N_Formal_Package_Declaration)
1484
1485               or else Ekind (E1) = E_Block
1486             then
1487                Check_References (E1);
1488             end if;
1489
1490             Next_Entity (E1);
1491       end loop;
1492    end Check_References;
1493
1494    ---------------------------
1495    -- Check_Unset_Reference --
1496    ---------------------------
1497
1498    procedure Check_Unset_Reference (N : Node_Id) is
1499       Typ : constant Entity_Id := Etype (N);
1500
1501       function Is_OK_Fully_Initialized return Boolean;
1502       --  This function returns true if the given node N is fully initialized
1503       --  so that the reference is safe as far as this routine is concerned.
1504       --  Safe generally means that the type of N is a fully initialized type.
1505       --  The one special case is that for access types, which are always fully
1506       --  initialized, we don't consider a dereference OK since it will surely
1507       --  be dereferencing a null value, which won't do.
1508
1509       function Prefix_Has_Dereference (Pref : Node_Id) return Boolean;
1510       --  Used to test indexed or selected component or slice to see if the
1511       --  evaluation of the prefix depends on a dereference, and if so, returns
1512       --  True, in which case we always check the prefix, even if we know that
1513       --  the referenced component is initialized. Pref is the prefix to test.
1514
1515       -----------------------------
1516       -- Is_OK_Fully_Initialized --
1517       -----------------------------
1518
1519       function Is_OK_Fully_Initialized return Boolean is
1520       begin
1521          if Is_Access_Type (Typ) and then Is_Dereferenced (N) then
1522             return False;
1523          else
1524             return Is_Fully_Initialized_Type (Typ);
1525          end if;
1526       end Is_OK_Fully_Initialized;
1527
1528       ----------------------------
1529       -- Prefix_Has_Dereference --
1530       ----------------------------
1531
1532       function Prefix_Has_Dereference (Pref : Node_Id) return Boolean is
1533       begin
1534          --  If prefix is of an access type, it certainly needs a dereference
1535
1536          if Is_Access_Type (Etype (Pref)) then
1537             return True;
1538
1539          --  If prefix is explicit dereference, that's a dereference for sure
1540
1541          elsif Nkind (Pref) = N_Explicit_Dereference then
1542             return True;
1543
1544             --  If prefix is itself a component reference or slice check prefix
1545
1546          elsif Nkind (Pref) = N_Slice
1547            or else Nkind (Pref) = N_Indexed_Component
1548            or else Nkind (Pref) = N_Selected_Component
1549          then
1550             return Prefix_Has_Dereference (Prefix (Pref));
1551
1552          --  All other cases do not involve a dereference
1553
1554          else
1555             return False;
1556          end if;
1557       end Prefix_Has_Dereference;
1558
1559    --  Start of processing for Check_Unset_Reference
1560
1561    begin
1562       --  Nothing to do if warnings suppressed
1563
1564       if Warning_Mode = Suppress then
1565          return;
1566       end if;
1567
1568       --  Ignore reference unless it comes from source. Almost always if we
1569       --  have a reference from generated code, it is bogus (e.g. calls to init
1570       --  procs to set default discriminant values).
1571
1572       if not Comes_From_Source (N) then
1573          return;
1574       end if;
1575
1576       --  Otherwise see what kind of node we have. If the entity already has an
1577       --  unset reference, it is not necessarily the earliest in the text,
1578       --  because resolution of the prefix of selected components is completed
1579       --  before the resolution of the selected component itself. As a result,
1580       --  given (R /= null and then R.X > 0), the occurrences of R are examined
1581       --  in right-to-left order. If there is already an unset reference, we
1582       --  check whether N is earlier before proceeding.
1583
1584       case Nkind (N) is
1585
1586          --  For identifier or expanded name, examine the entity involved
1587
1588          when N_Identifier | N_Expanded_Name =>
1589             declare
1590                E : constant Entity_Id := Entity (N);
1591
1592             begin
1593                if (Ekind (E) = E_Variable
1594                      or else
1595                    Ekind (E) = E_Out_Parameter)
1596                  and then Never_Set_In_Source_Check_Spec (E)
1597                  and then not Has_Initial_Value (E)
1598                  and then (No (Unset_Reference (E))
1599                             or else
1600                               Earlier_In_Extended_Unit
1601                                 (Sloc (N),  Sloc (Unset_Reference (E))))
1602                  and then not Has_Pragma_Unmodified_Check_Spec (E)
1603                  and then not Warnings_Off_Check_Spec (E)
1604                then
1605                   --  We may have an unset reference. The first test is whether
1606                   --  this is an access to a discriminant of a record or a
1607                   --  component with default initialization. Both of these
1608                   --  cases can be ignored, since the actual object that is
1609                   --  referenced is definitely initialized. Note that this
1610                   --  covers the case of reading discriminants of an OUT
1611                   --  parameter, which is OK even in Ada 83.
1612
1613                   --  Note that we are only interested in a direct reference to
1614                   --  a record component here. If the reference is through an
1615                   --  access type, then the access object is being referenced,
1616                   --  not the record, and still deserves an unset reference.
1617
1618                   if Nkind (Parent (N)) = N_Selected_Component
1619                     and not Is_Access_Type (Typ)
1620                   then
1621                      declare
1622                         ES : constant Entity_Id :=
1623                                Entity (Selector_Name (Parent (N)));
1624                      begin
1625                         if Ekind (ES) = E_Discriminant
1626                           or else
1627                             (Present (Declaration_Node (ES))
1628                                and then
1629                              Present (Expression (Declaration_Node (ES))))
1630                         then
1631                            return;
1632                         end if;
1633                      end;
1634                   end if;
1635
1636                   --  Exclude fully initialized types
1637
1638                   if Is_OK_Fully_Initialized then
1639                      return;
1640                   end if;
1641
1642                   --  Here we have a potential unset reference. But before we
1643                   --  get worried about it, we have to make sure that the
1644                   --  entity declaration is in the same procedure as the
1645                   --  reference, since if they are in separate procedures, then
1646                   --  we have no idea about sequential execution.
1647
1648                   --  The tests in the loop below catch all such cases, but do
1649                   --  allow the reference to appear in a loop, block, or
1650                   --  package spec that is nested within the declaring scope.
1651                   --  As always, it is possible to construct cases where the
1652                   --  warning is wrong, that is why it is a warning!
1653
1654                   Potential_Unset_Reference : declare
1655                      SR : Entity_Id;
1656                      SE : constant Entity_Id := Scope (E);
1657
1658                      function Within_Postcondition return Boolean;
1659                      --  Returns True iff N is within a Precondition
1660
1661                      --------------------------
1662                      -- Within_Postcondition --
1663                      --------------------------
1664
1665                      function Within_Postcondition return Boolean is
1666                         Nod : Node_Id;
1667
1668                      begin
1669                         Nod := Parent (N);
1670                         while Present (Nod) loop
1671                            if Nkind (Nod) = N_Pragma
1672                              and then Pragma_Name (Nod) = Name_Postcondition
1673                            then
1674                               return True;
1675                            end if;
1676
1677                            Nod := Parent (Nod);
1678                         end loop;
1679
1680                         return False;
1681                      end Within_Postcondition;
1682
1683                   --  Start of processing for Potential_Unset_Reference
1684
1685                   begin
1686                      SR := Current_Scope;
1687                      while SR /= SE loop
1688                         if SR = Standard_Standard
1689                           or else Is_Subprogram (SR)
1690                           or else Is_Concurrent_Body (SR)
1691                           or else Is_Concurrent_Type (SR)
1692                         then
1693                            return;
1694                         end if;
1695
1696                         SR := Scope (SR);
1697                      end loop;
1698
1699                      --  Case of reference has an access type. This is a
1700                      --  special case since access types are always set to null
1701                      --  so cannot be truly uninitialized, but we still want to
1702                      --  warn about cases of obvious null dereference.
1703
1704                      if Is_Access_Type (Typ) then
1705                         Access_Type_Case : declare
1706                            P : Node_Id;
1707
1708                            function Process
1709                              (N : Node_Id) return Traverse_Result;
1710                            --  Process function for instantiation of Traverse
1711                            --  below. Checks if N contains reference to E other
1712                            --  than a dereference.
1713
1714                            function Ref_In (Nod : Node_Id) return Boolean;
1715                            --  Determines whether Nod contains a reference to
1716                            --  the entity E that is not a dereference.
1717
1718                            -------------
1719                            -- Process --
1720                            -------------
1721
1722                            function Process
1723                              (N : Node_Id) return Traverse_Result
1724                            is
1725                            begin
1726                               if Is_Entity_Name (N)
1727                                 and then Entity (N) = E
1728                                 and then not Is_Dereferenced (N)
1729                               then
1730                                  return Abandon;
1731                               else
1732                                  return OK;
1733                               end if;
1734                            end Process;
1735
1736                            ------------
1737                            -- Ref_In --
1738                            ------------
1739
1740                            function Ref_In (Nod : Node_Id) return Boolean is
1741                               function Traverse is new Traverse_Func (Process);
1742                            begin
1743                               return Traverse (Nod) = Abandon;
1744                            end Ref_In;
1745
1746                         --  Start of processing for Access_Type_Case
1747
1748                         begin
1749                            --  Don't bother if we are inside an instance, since
1750                            --  the compilation of the generic template is where
1751                            --  the warning should be issued.
1752
1753                            if In_Instance then
1754                               return;
1755                            end if;
1756
1757                            --  Don't bother if this is not the main unit. If we
1758                            --  try to give this warning for with'ed units, we
1759                            --  get some false positives, since we do not record
1760                            --  references in other units.
1761
1762                            if not In_Extended_Main_Source_Unit (E)
1763                                 or else
1764                               not In_Extended_Main_Source_Unit (N)
1765                            then
1766                               return;
1767                            end if;
1768
1769                            --  We are only interested in dereferences
1770
1771                            if not Is_Dereferenced (N) then
1772                               return;
1773                            end if;
1774
1775                            --  One more check, don't bother with references
1776                            --  that are inside conditional statements or WHILE
1777                            --  loops if the condition references the entity in
1778                            --  question. This avoids most false positives.
1779
1780                            P := Parent (N);
1781                            loop
1782                               P := Parent (P);
1783                               exit when No (P);
1784
1785                               if (Nkind (P) = N_If_Statement
1786                                      or else
1787                                    Nkind (P) = N_Elsif_Part)
1788                                  and then Ref_In (Condition (P))
1789                               then
1790                                  return;
1791
1792                               elsif Nkind (P) = N_Loop_Statement
1793                                 and then Present (Iteration_Scheme (P))
1794                                 and then
1795                                   Ref_In (Condition (Iteration_Scheme (P)))
1796                               then
1797                                  return;
1798                               end if;
1799                            end loop;
1800                         end Access_Type_Case;
1801                      end if;
1802
1803                      --  One more check, don't bother if we are within a
1804                      --  postcondition pragma, since the expression occurs
1805                      --  in a place unrelated to the actual test.
1806
1807                      if not Within_Postcondition then
1808
1809                         --  Here we definitely have a case for giving a warning
1810                         --  for a reference to an unset value. But we don't
1811                         --  give the warning now. Instead set Unset_Reference
1812                         --  in the identifier involved. The reason for this is
1813                         --  that if we find the variable is never ever assigned
1814                         --  a value then that warning is more important and
1815                         --  there is no point in giving the reference warning.
1816
1817                         --  If this is an identifier, set the field directly
1818
1819                         if Nkind (N) = N_Identifier then
1820                            Set_Unset_Reference (E, N);
1821
1822                         --  Otherwise it is an expanded name, so set the field
1823                         --  of the actual identifier for the reference.
1824
1825                         else
1826                            Set_Unset_Reference (E, Selector_Name (N));
1827                         end if;
1828                      end if;
1829                   end Potential_Unset_Reference;
1830                end if;
1831             end;
1832
1833          --  Indexed component or slice
1834
1835          when N_Indexed_Component | N_Slice =>
1836
1837             --  If prefix does not involve dereferencing an access type, then
1838             --  we know we are OK if the component type is fully initialized,
1839             --  since the component will have been set as part of the default
1840             --  initialization.
1841
1842             if not Prefix_Has_Dereference (Prefix (N))
1843               and then Is_OK_Fully_Initialized
1844             then
1845                return;
1846
1847             --  Look at prefix in access type case, or if the component is not
1848             --  fully initialized.
1849
1850             else
1851                Check_Unset_Reference (Prefix (N));
1852             end if;
1853
1854          --  Record component
1855
1856          when N_Selected_Component =>
1857             declare
1858                Pref : constant Node_Id   := Prefix (N);
1859                Ent  : constant Entity_Id := Entity (Selector_Name (N));
1860
1861             begin
1862                --  If prefix involves dereferencing an access type, always
1863                --  check the prefix, since the issue then is whether this
1864                --  access value is null.
1865
1866                if Prefix_Has_Dereference (Pref) then
1867                   null;
1868
1869                --  Always go to prefix if no selector entity is set. Can this
1870                --  happen in the normal case? Not clear, but it definitely can
1871                --  happen in error cases.
1872
1873                elsif No (Ent) then
1874                   null;
1875
1876                --  For a record component, check some cases where we have
1877                --  reasonable cause to consider that the component is known to
1878                --  be or probably is initialized. In this case, we don't care
1879                --  if the prefix itself was explicitly initialized.
1880
1881                --  Discriminants are always considered initialized
1882
1883                elsif Ekind (Ent) = E_Discriminant then
1884                   return;
1885
1886                --  An explicitly initialized component is certainly initialized
1887
1888                elsif Nkind (Parent (Ent)) = N_Component_Declaration
1889                  and then Present (Expression (Parent (Ent)))
1890                then
1891                   return;
1892
1893                --  A fully initialized component is initialized
1894
1895                elsif Is_OK_Fully_Initialized then
1896                   return;
1897                end if;
1898
1899                --  If none of those cases apply, check the record type prefix
1900
1901                Check_Unset_Reference (Pref);
1902             end;
1903
1904          --  For type conversions or qualifications examine the expression
1905
1906          when N_Type_Conversion | N_Qualified_Expression =>
1907             Check_Unset_Reference (Expression (N));
1908
1909          --  For explicit dereference, always check prefix, which will generate
1910          --  an unset reference (since this is a case of dereferencing null).
1911
1912          when N_Explicit_Dereference =>
1913             Check_Unset_Reference (Prefix (N));
1914
1915          --  All other cases are not cases of an unset reference
1916
1917          when others =>
1918             null;
1919
1920       end case;
1921    end Check_Unset_Reference;
1922
1923    ------------------------
1924    -- Check_Unused_Withs --
1925    ------------------------
1926
1927    procedure Check_Unused_Withs (Spec_Unit : Unit_Number_Type := No_Unit) is
1928       Cnode : Node_Id;
1929       Item  : Node_Id;
1930       Lunit : Node_Id;
1931       Ent   : Entity_Id;
1932
1933       Munite : constant Entity_Id := Cunit_Entity (Main_Unit);
1934       --  This is needed for checking the special renaming case
1935
1936       procedure Check_One_Unit (Unit : Unit_Number_Type);
1937       --  Subsidiary procedure, performs checks for specified unit
1938
1939       --------------------
1940       -- Check_One_Unit --
1941       --------------------
1942
1943       procedure Check_One_Unit (Unit : Unit_Number_Type) is
1944          Is_Visible_Renaming : Boolean := False;
1945          Pack                : Entity_Id;
1946
1947          procedure Check_Inner_Package (Pack : Entity_Id);
1948          --  Pack is a package local to a unit in a with_clause. Both the unit
1949          --  and Pack are referenced. If none of the entities in Pack are
1950          --  referenced, then the only occurrence of Pack is in a USE clause
1951          --  or a pragma, and a warning is worthwhile as well.
1952
1953          function Check_System_Aux return Boolean;
1954          --  Before giving a warning on a with_clause for System, check wheter
1955          --  a system extension is present.
1956
1957          function Find_Package_Renaming
1958            (P : Entity_Id;
1959             L : Entity_Id) return Entity_Id;
1960          --  The only reference to a context unit may be in a renaming
1961          --  declaration. If this renaming declares a visible entity, do not
1962          --  warn that the context clause could be moved to the body, because
1963          --  the renaming may be intended to re-export the unit.
1964
1965          function Has_Visible_Entities (P : Entity_Id) return Boolean;
1966          --  This function determines if a package has any visible entities.
1967          --  True is returned if there is at least one declared visible entity,
1968          --  otherwise False is returned (e.g. case of only pragmas present).
1969
1970          -------------------------
1971          -- Check_Inner_Package --
1972          -------------------------
1973
1974          procedure Check_Inner_Package (Pack : Entity_Id) is
1975             E  : Entity_Id;
1976             Un : constant Node_Id := Sinfo.Unit (Cnode);
1977
1978             function Check_Use_Clause (N : Node_Id) return Traverse_Result;
1979             --  If N is a use_clause for Pack, emit warning
1980
1981             procedure Check_Use_Clauses is new
1982               Traverse_Proc (Check_Use_Clause);
1983
1984             ----------------------
1985             -- Check_Use_Clause --
1986             ----------------------
1987
1988             function Check_Use_Clause (N : Node_Id) return Traverse_Result is
1989                Nam  : Node_Id;
1990
1991             begin
1992                if Nkind (N) = N_Use_Package_Clause then
1993                   Nam := First (Names (N));
1994                   while Present (Nam) loop
1995                      if Entity (Nam) = Pack then
1996                         Error_Msg_Qual_Level := 1;
1997                         Error_Msg_NE
1998                           ("?no entities of package& are referenced!",
1999                              Nam, Pack);
2000                         Error_Msg_Qual_Level := 0;
2001                      end if;
2002
2003                      Next (Nam);
2004                   end loop;
2005                end if;
2006
2007                return OK;
2008             end Check_Use_Clause;
2009
2010          --  Start of processing for Check_Inner_Package
2011
2012          begin
2013             E := First_Entity (Pack);
2014             while Present (E) loop
2015                if Referenced_Check_Spec (E) then
2016                   return;
2017                end if;
2018
2019                Next_Entity (E);
2020             end loop;
2021
2022             --  No entities of the package are referenced. Check whether the
2023             --  reference to the package itself is a use clause, and if so
2024             --  place a warning on it.
2025
2026             Check_Use_Clauses (Un);
2027          end Check_Inner_Package;
2028
2029          ----------------------
2030          -- Check_System_Aux --
2031          ----------------------
2032
2033          function Check_System_Aux return Boolean is
2034             Ent : Entity_Id;
2035
2036          begin
2037             if Chars (Lunit) = Name_System
2038                and then Scope (Lunit) = Standard_Standard
2039                and then Present_System_Aux
2040             then
2041                Ent := First_Entity (System_Aux_Id);
2042                while Present (Ent) loop
2043                   if Referenced_Check_Spec (Ent) then
2044                      return True;
2045                   end if;
2046
2047                   Next_Entity (Ent);
2048                end loop;
2049             end if;
2050
2051             return False;
2052          end Check_System_Aux;
2053
2054          ---------------------------
2055          -- Find_Package_Renaming --
2056          ---------------------------
2057
2058          function Find_Package_Renaming
2059            (P : Entity_Id;
2060             L : Entity_Id) return Entity_Id
2061          is
2062             E1 : Entity_Id;
2063             R  : Entity_Id;
2064
2065          begin
2066             Is_Visible_Renaming := False;
2067
2068             E1 := First_Entity (P);
2069             while Present (E1) loop
2070                if Ekind (E1) = E_Package
2071                   and then Renamed_Object (E1) = L
2072                then
2073                   Is_Visible_Renaming := not Is_Hidden (E1);
2074                   return E1;
2075
2076                elsif Ekind (E1) = E_Package
2077                  and then No (Renamed_Object (E1))
2078                  and then not Is_Generic_Instance (E1)
2079                then
2080                   R := Find_Package_Renaming (E1, L);
2081
2082                   if Present (R) then
2083                      Is_Visible_Renaming := not Is_Hidden (R);
2084                      return R;
2085                   end if;
2086                end if;
2087
2088                Next_Entity (E1);
2089             end loop;
2090
2091             return Empty;
2092          end Find_Package_Renaming;
2093
2094          --------------------------
2095          -- Has_Visible_Entities --
2096          --------------------------
2097
2098          function Has_Visible_Entities (P : Entity_Id) return Boolean is
2099             E : Entity_Id;
2100
2101          begin
2102             --  If unit in context is not a package, it is a subprogram that
2103             --  is not called or a generic unit that is not instantiated
2104             --  in the current unit, and warning is appropriate.
2105
2106             if Ekind (P) /= E_Package then
2107                return True;
2108             end if;
2109
2110             --  If unit comes from a limited_with clause, look for declaration
2111             --  of shadow entities.
2112
2113             if Present (Limited_View (P)) then
2114                E := First_Entity (Limited_View (P));
2115             else
2116                E := First_Entity (P);
2117             end if;
2118
2119             while Present (E)
2120               and then E /= First_Private_Entity (P)
2121             loop
2122                if Comes_From_Source (E)
2123                  or else Present (Limited_View (P))
2124                then
2125                   return True;
2126                end if;
2127
2128                Next_Entity (E);
2129             end loop;
2130
2131             return False;
2132          end Has_Visible_Entities;
2133
2134       --  Start of processing for Check_One_Unit
2135
2136       begin
2137          Cnode := Cunit (Unit);
2138
2139          --  Only do check in units that are part of the extended main unit.
2140          --  This is actually a necessary restriction, because in the case of
2141          --  subprogram acting as its own specification, there can be with's in
2142          --  subunits that we will not see.
2143
2144          if not In_Extended_Main_Source_Unit (Cnode) then
2145             return;
2146
2147          --  In configurable run time mode, we remove the bodies of non-inlined
2148          --  subprograms, which may lead to spurious warnings, which are
2149          --  clearly undesirable.
2150
2151          elsif Configurable_Run_Time_Mode
2152            and then Is_Predefined_File_Name (Unit_File_Name (Unit))
2153          then
2154             return;
2155          end if;
2156
2157          --  Loop through context items in this unit
2158
2159          Item := First (Context_Items (Cnode));
2160          while Present (Item) loop
2161             if Nkind (Item) = N_With_Clause
2162                and then not Implicit_With (Item)
2163                and then In_Extended_Main_Source_Unit (Item)
2164             then
2165                Lunit := Entity (Name (Item));
2166
2167                --  Check if this unit is referenced (skip the check if this
2168                --  is explicitly marked by a pragma Unreferenced).
2169
2170                if not Referenced (Lunit)
2171                  and then not Has_Unreferenced (Lunit)
2172                then
2173                   --  Suppress warnings in internal units if not in -gnatg mode
2174                   --  (these would be junk warnings for an application program,
2175                   --  since they refer to problems in internal units).
2176
2177                   if GNAT_Mode
2178                     or else not Is_Internal_File_Name (Unit_File_Name (Unit))
2179                   then
2180                      --  Here we definitely have a non-referenced unit. If it
2181                      --  is the special call for a spec unit, then just set the
2182                      --  flag to be read later.
2183
2184                      if Unit = Spec_Unit then
2185                         Set_Unreferenced_In_Spec (Item);
2186
2187                      --  Otherwise simple unreferenced message, but skip this
2188                      --  if no visible entities, because that is most likely a
2189                      --  case where warning would be false positive (e.g. a
2190                      --  package with only a linker options pragma and nothing
2191                      --  else or a pragma elaborate with a body library task).
2192
2193                      elsif Has_Visible_Entities (Entity (Name (Item))) then
2194                         Error_Msg_N
2195                           ("?unit& is not referenced!", Name (Item));
2196                      end if;
2197                   end if;
2198
2199                --  If main unit is a renaming of this unit, then we consider
2200                --  the with to be OK (obviously it is needed in this case!)
2201                --  This may be transitive: the unit in the with_clause may
2202                --  itself be a renaming, in which case both it and the main
2203                --  unit rename the same ultimate package.
2204
2205                elsif Present (Renamed_Entity (Munite))
2206                   and then
2207                     (Renamed_Entity (Munite) = Lunit
2208                       or else Renamed_Entity (Munite) = Renamed_Entity (Lunit))
2209                then
2210                   null;
2211
2212                --  If this unit is referenced, and it is a package, we do
2213                --  another test, to see if any of the entities in the package
2214                --  are referenced. If none of the entities are referenced, we
2215                --  still post a warning. This occurs if the only use of the
2216                --  package is in a use clause, or in a package renaming
2217                --  declaration. This check is skipped for packages that are
2218                --  renamed in a spec, since the entities in such a package are
2219                --  visible to clients via the renaming.
2220
2221                elsif Ekind (Lunit) = E_Package
2222                  and then not Renamed_In_Spec (Lunit)
2223                then
2224                   --  If Is_Instantiated is set, it means that the package is
2225                   --  implicitly instantiated (this is the case of parent
2226                   --  instance or an actual for a generic package formal), and
2227                   --  this counts as a reference.
2228
2229                   if Is_Instantiated (Lunit) then
2230                      null;
2231
2232                   --  If no entities in package, and there is a pragma
2233                   --  Elaborate_Body present, then assume that this with is
2234                   --  done for purposes of this elaboration.
2235
2236                   elsif No (First_Entity (Lunit))
2237                     and then Has_Pragma_Elaborate_Body (Lunit)
2238                   then
2239                      null;
2240
2241                   --  Otherwise see if any entities have been referenced
2242
2243                   else
2244                      if Limited_Present (Item) then
2245                         Ent := First_Entity (Limited_View (Lunit));
2246                      else
2247                         Ent := First_Entity (Lunit);
2248                      end if;
2249
2250                      loop
2251                         --  No more entities, and we did not find one that was
2252                         --  referenced. Means we have a definite case of a with
2253                         --  none of whose entities was referenced.
2254
2255                         if No (Ent) then
2256
2257                            --  If in spec, just set the flag
2258
2259                            if Unit = Spec_Unit then
2260                               Set_No_Entities_Ref_In_Spec (Item);
2261
2262                            elsif Check_System_Aux then
2263                               null;
2264
2265                            --  Else give the warning
2266
2267                            else
2268                               if not
2269                                 Has_Unreferenced (Entity (Name (Item)))
2270                               then
2271                                  Error_Msg_N
2272                                    ("?no entities of & are referenced!",
2273                                     Name (Item));
2274                               end if;
2275
2276                               --  Look for renamings of this package, and flag
2277                               --  them as well. If the original package has
2278                               --  warnings off, we suppress the warning on the
2279                               --  renaming as well.
2280
2281                               Pack := Find_Package_Renaming (Munite, Lunit);
2282
2283                               if Present (Pack)
2284                                 and then not Has_Warnings_Off (Lunit)
2285                                 and then not Has_Unreferenced (Pack)
2286                               then
2287                                  Error_Msg_NE
2288                                    ("?no entities of & are referenced!",
2289                                      Unit_Declaration_Node (Pack),
2290                                      Pack);
2291                               end if;
2292                            end if;
2293
2294                            exit;
2295
2296                         --  Case of entity being referenced. The reference may
2297                         --  come from a limited_with_clause, in which case the
2298                         --  limited view of the entity carries the flag.
2299
2300                         elsif Referenced_Check_Spec (Ent)
2301                           or else Referenced_As_LHS_Check_Spec (Ent)
2302                           or else Referenced_As_Out_Parameter_Check_Spec (Ent)
2303                           or else
2304                             (From_With_Type (Ent)
2305                               and then Is_Incomplete_Type (Ent)
2306                               and then Present (Non_Limited_View (Ent))
2307                               and then Referenced (Non_Limited_View (Ent)))
2308                         then
2309                            --  This means that the with is indeed fine, in that
2310                            --  it is definitely needed somewhere, and we can
2311                            --  quit worrying about this one...
2312
2313                            --  Except for one little detail: if either of the
2314                            --  flags was set during spec processing, this is
2315                            --  where we complain that the with could be moved
2316                            --  from the spec. If the spec contains a visible
2317                            --  renaming of the package, inhibit warning to move
2318                            --  with_clause to body.
2319
2320                            if Ekind (Munite) = E_Package_Body then
2321                               Pack :=
2322                                 Find_Package_Renaming
2323                                   (Spec_Entity (Munite), Lunit);
2324                            end if;
2325
2326                            if Unreferenced_In_Spec (Item) then
2327                               Error_Msg_N
2328                                 ("?unit& is not referenced in spec!",
2329                                  Name (Item));
2330
2331                            elsif No_Entities_Ref_In_Spec (Item) then
2332                               Error_Msg_N
2333                                 ("?no entities of & are referenced in spec!",
2334                                  Name (Item));
2335
2336                            else
2337                               if Ekind (Ent) = E_Package then
2338                                  Check_Inner_Package (Ent);
2339                               end if;
2340
2341                               exit;
2342                            end if;
2343
2344                            if not Is_Visible_Renaming then
2345                               Error_Msg_N -- CODEFIX
2346                                 ("\?with clause might be moved to body!",
2347                                  Name (Item));
2348                            end if;
2349
2350                            exit;
2351
2352                         --  Move to next entity to continue search
2353
2354                         else
2355                            Next_Entity (Ent);
2356                         end if;
2357                      end loop;
2358                   end if;
2359
2360                --  For a generic package, the only interesting kind of
2361                --  reference is an instantiation, since entities cannot be
2362                --  referenced directly.
2363
2364                elsif Is_Generic_Unit (Lunit) then
2365
2366                   --  Unit was never instantiated, set flag for case of spec
2367                   --  call, or give warning for normal call.
2368
2369                   if not Is_Instantiated (Lunit) then
2370                      if Unit = Spec_Unit then
2371                         Set_Unreferenced_In_Spec (Item);
2372                      else
2373                         Error_Msg_N -- CODEFIX
2374                           ("?unit& is never instantiated!", Name (Item));
2375                      end if;
2376
2377                   --  If unit was indeed instantiated, make sure that flag is
2378                   --  not set showing it was uninstantiated in the spec, and if
2379                   --  so, give warning.
2380
2381                   elsif Unreferenced_In_Spec (Item) then
2382                      Error_Msg_N
2383                        ("?unit& is not instantiated in spec!", Name (Item));
2384                      Error_Msg_N -- CODEFIX
2385                        ("\?with clause can be moved to body!", Name (Item));
2386                   end if;
2387                end if;
2388             end if;
2389
2390             Next (Item);
2391          end loop;
2392       end Check_One_Unit;
2393
2394    --  Start of processing for Check_Unused_Withs
2395
2396    begin
2397       if not Opt.Check_Withs
2398         or else Operating_Mode = Check_Syntax
2399       then
2400          return;
2401       end if;
2402
2403       --  Flag any unused with clauses, but skip this step if we are compiling
2404       --  a subunit on its own, since we do not have enough information to
2405       --  determine whether with's are used. We will get the relevant warnings
2406       --  when we compile the parent. This is the normal style of GNAT
2407       --  compilation in any case.
2408
2409       if Nkind (Unit (Cunit (Main_Unit))) = N_Subunit then
2410          return;
2411       end if;
2412
2413       --  Process specified units
2414
2415       if Spec_Unit = No_Unit then
2416
2417          --  For main call, check all units
2418
2419          for Unit in Main_Unit .. Last_Unit loop
2420             Check_One_Unit (Unit);
2421          end loop;
2422
2423       else
2424          --  For call for spec, check only the spec
2425
2426          Check_One_Unit (Spec_Unit);
2427       end if;
2428    end Check_Unused_Withs;
2429
2430    ---------------------------------
2431    -- Generic_Package_Spec_Entity --
2432    ---------------------------------
2433
2434    function Generic_Package_Spec_Entity (E : Entity_Id) return Boolean is
2435       S : Entity_Id;
2436
2437    begin
2438       if Is_Package_Body_Entity (E) then
2439          return False;
2440
2441       else
2442          S := Scope (E);
2443          loop
2444             if S = Standard_Standard then
2445                return False;
2446
2447             elsif Ekind (S) = E_Generic_Package then
2448                return True;
2449
2450             elsif Ekind (S) = E_Package then
2451                S := Scope (S);
2452
2453             else
2454                return False;
2455             end if;
2456          end loop;
2457       end if;
2458    end Generic_Package_Spec_Entity;
2459
2460    ----------------------
2461    -- Goto_Spec_Entity --
2462    ----------------------
2463
2464    function Goto_Spec_Entity (E : Entity_Id) return Entity_Id is
2465    begin
2466       if Is_Formal (E)
2467         and then Present (Spec_Entity (E))
2468       then
2469          return Spec_Entity (E);
2470       else
2471          return E;
2472       end if;
2473    end Goto_Spec_Entity;
2474
2475    --------------------------------------
2476    -- Has_Pragma_Unmodified_Check_Spec --
2477    --------------------------------------
2478
2479    function Has_Pragma_Unmodified_Check_Spec
2480      (E : Entity_Id) return Boolean
2481    is
2482    begin
2483       if Is_Formal (E) and then Present (Spec_Entity (E)) then
2484
2485          --  Note: use of OR instead of OR ELSE here is deliberate, we want
2486          --  to mess with Unmodified flags on both body and spec entities.
2487
2488          return Has_Unmodified (E)
2489                   or
2490                 Has_Unmodified (Spec_Entity (E));
2491
2492       else
2493          return Has_Unmodified (E);
2494       end if;
2495    end Has_Pragma_Unmodified_Check_Spec;
2496
2497    ----------------------------------------
2498    -- Has_Pragma_Unreferenced_Check_Spec --
2499    ----------------------------------------
2500
2501    function Has_Pragma_Unreferenced_Check_Spec
2502      (E : Entity_Id) return Boolean
2503    is
2504    begin
2505       if Is_Formal (E) and then Present (Spec_Entity (E)) then
2506
2507          --  Note: use of OR here instead of OR ELSE is deliberate, we want
2508          --  to mess with flags on both entities.
2509
2510          return Has_Unreferenced (E)
2511                   or
2512                 Has_Unreferenced (Spec_Entity (E));
2513
2514       else
2515          return Has_Unreferenced (E);
2516       end if;
2517    end Has_Pragma_Unreferenced_Check_Spec;
2518
2519    ----------------
2520    -- Initialize --
2521    ----------------
2522
2523    procedure Initialize is
2524    begin
2525       Warnings_Off_Pragmas.Init;
2526       Unreferenced_Entities.Init;
2527       In_Out_Warnings.Init;
2528    end Initialize;
2529
2530    ------------------------------------
2531    -- Never_Set_In_Source_Check_Spec --
2532    ------------------------------------
2533
2534    function Never_Set_In_Source_Check_Spec (E : Entity_Id) return Boolean is
2535    begin
2536       if Is_Formal (E) and then Present (Spec_Entity (E)) then
2537          return Never_Set_In_Source (E)
2538                   and then
2539                 Never_Set_In_Source (Spec_Entity (E));
2540       else
2541          return Never_Set_In_Source (E);
2542       end if;
2543    end Never_Set_In_Source_Check_Spec;
2544
2545    -------------------------------------
2546    -- Operand_Has_Warnings_Suppressed --
2547    -------------------------------------
2548
2549    function Operand_Has_Warnings_Suppressed (N : Node_Id) return Boolean is
2550
2551       function Check_For_Warnings (N : Node_Id) return Traverse_Result;
2552       --  Function used to check one node to see if it is or was originally
2553       --  a reference to an entity for which Warnings are off. If so, Abandon
2554       --  is returned, otherwise OK_Orig is returned to continue the traversal
2555       --  of the original expression.
2556
2557       function Traverse is new Traverse_Func (Check_For_Warnings);
2558       --  Function used to traverse tree looking for warnings
2559
2560       ------------------------
2561       -- Check_For_Warnings --
2562       ------------------------
2563
2564       function Check_For_Warnings (N : Node_Id) return Traverse_Result is
2565          R : constant Node_Id := Original_Node (N);
2566
2567       begin
2568          if Nkind (R) in N_Has_Entity
2569            and then Present (Entity (R))
2570            and then Has_Warnings_Off (Entity (R))
2571          then
2572             return Abandon;
2573          else
2574             return OK_Orig;
2575          end if;
2576       end Check_For_Warnings;
2577
2578    --  Start of processing for Operand_Has_Warnings_Suppressed
2579
2580    begin
2581       return Traverse (N) = Abandon;
2582
2583    --  If any exception occurs, then something has gone wrong, and this is
2584    --  only a minor aesthetic issue anyway, so just say we did not find what
2585    --  we are looking for, rather than blow up.
2586
2587    exception
2588       when others =>
2589          return False;
2590    end Operand_Has_Warnings_Suppressed;
2591
2592    -----------------------------------------
2593    -- Output_Non_Modified_In_Out_Warnings --
2594    -----------------------------------------
2595
2596    procedure Output_Non_Modifed_In_Out_Warnings is
2597
2598       function No_Warn_On_In_Out (E : Entity_Id) return Boolean;
2599       --  Given a formal parameter entity E, determines if there is a reason to
2600       --  suppress IN OUT warnings (not modified, could be IN) for formals of
2601       --  the subprogram. We suppress these warnings if Warnings Off is set, or
2602       --  if we have seen the address of the subprogram being taken, or if the
2603       --  subprogram is used as a generic actual (in the latter cases the
2604       --  context may force use of IN OUT, even if the parameter is not
2605       --  modifies for this particular case.
2606
2607       -----------------------
2608       -- No_Warn_On_In_Out --
2609       -----------------------
2610
2611       function No_Warn_On_In_Out (E : Entity_Id) return Boolean is
2612          S  : constant Entity_Id := Scope (E);
2613          SE : constant Entity_Id := Spec_Entity (E);
2614
2615       begin
2616          --  Do not warn if address is taken, since funny business may be going
2617          --  on in treating the parameter indirectly as IN OUT.
2618
2619          if Address_Taken (S)
2620            or else (Present (SE) and then Address_Taken (Scope (SE)))
2621          then
2622             return True;
2623
2624          --  Do not warn if used as a generic actual, since the generic may be
2625          --  what is forcing the use of an "unnecessary" IN OUT.
2626
2627          elsif Used_As_Generic_Actual (S)
2628            or else (Present (SE) and then Used_As_Generic_Actual (Scope (SE)))
2629          then
2630             return True;
2631
2632          --  Else test warnings off
2633
2634          elsif Warnings_Off_Check_Spec (S) then
2635             return True;
2636
2637          --  All tests for suppressing warning failed
2638
2639          else
2640             return False;
2641          end if;
2642       end No_Warn_On_In_Out;
2643
2644    --  Start of processing for Output_Non_Modified_In_Out_Warnings
2645
2646    begin
2647       --  Loop through entities for which a warning may be needed
2648
2649       for J in In_Out_Warnings.First .. In_Out_Warnings.Last loop
2650          declare
2651             E1 : constant Entity_Id := In_Out_Warnings.Table (J);
2652
2653          begin
2654             --  Suppress warning in specific cases (see details in comments for
2655             --  No_Warn_On_In_Out), or if there is a pragma Unmodified.
2656
2657             if Has_Pragma_Unmodified_Check_Spec (E1)
2658               or else No_Warn_On_In_Out (E1)
2659             then
2660                null;
2661
2662             --  Here we generate the warning
2663
2664             else
2665                --  If -gnatwc is set then output message that we could be IN
2666
2667                if not Is_Trivial_Subprogram (Scope (E1)) then
2668                   if Warn_On_Constant then
2669                      Error_Msg_N
2670                        ("?formal parameter & is not modified!", E1);
2671                      Error_Msg_N
2672                        ("\?mode could be IN instead of `IN OUT`!", E1);
2673
2674                      --  We do not generate warnings for IN OUT parameters
2675                      --  unless we have at least -gnatwu. This is deliberately
2676                      --  inconsistent with the treatment of variables, but
2677                      --  otherwise we get too many unexpected warnings in
2678                      --  default mode.
2679
2680                   elsif Check_Unreferenced then
2681                      Error_Msg_N ("?formal parameter& is read but "
2682                                   & "never assigned!", E1);
2683                   end if;
2684                end if;
2685
2686                --  Kill any other warnings on this entity, since this is the
2687                --  one that should dominate any other unreferenced warning.
2688
2689                Set_Warnings_Off (E1);
2690             end if;
2691          end;
2692       end loop;
2693    end Output_Non_Modifed_In_Out_Warnings;
2694
2695    ----------------------------------------
2696    -- Output_Obsolescent_Entity_Warnings --
2697    ----------------------------------------
2698
2699    procedure Output_Obsolescent_Entity_Warnings (N : Node_Id; E : Entity_Id) is
2700       P : constant Node_Id := Parent (N);
2701       S : Entity_Id;
2702
2703    begin
2704       S := Current_Scope;
2705
2706       --  Do not output message if we are the scope of standard. This means
2707       --  we have a reference from a context clause from when it is originally
2708       --  processed, and that's too early to tell whether it is an obsolescent
2709       --  unit doing the with'ing. In Sem_Ch10.Analyze_Compilation_Unit we make
2710       --  sure that we have a later call when the scope is available. This test
2711       --  also eliminates all messages for use clauses, which is fine (we do
2712       --  not want messages for use clauses, since they are always redundant
2713       --  with respect to the associated with clause).
2714
2715       if S = Standard_Standard then
2716          return;
2717       end if;
2718
2719       --  Do not output message if we are in scope of an obsolescent package
2720       --  or subprogram.
2721
2722       loop
2723          if Is_Obsolescent (S) then
2724             return;
2725          end if;
2726
2727          S := Scope (S);
2728          exit when S = Standard_Standard;
2729       end loop;
2730
2731       --  Here we will output the message
2732
2733       Error_Msg_Sloc := Sloc (E);
2734
2735       --  Case of with clause
2736
2737       if Nkind (P) = N_With_Clause then
2738          if Ekind (E) = E_Package then
2739             Error_Msg_NE
2740               ("?with of obsolescent package& declared#", N, E);
2741          elsif Ekind (E) = E_Procedure then
2742             Error_Msg_NE
2743               ("?with of obsolescent procedure& declared#", N, E);
2744          else
2745             Error_Msg_NE
2746               ("?with of obsolescent function& declared#", N, E);
2747          end if;
2748
2749       --  If we do not have a with clause, then ignore any reference to an
2750       --  obsolescent package name. We only want to give the one warning of
2751       --  withing the package, not one each time it is used to qualify.
2752
2753       elsif Ekind (E) = E_Package then
2754          return;
2755
2756       --  Procedure call statement
2757
2758       elsif Nkind (P) = N_Procedure_Call_Statement then
2759          Error_Msg_NE
2760            ("?call to obsolescent procedure& declared#", N, E);
2761
2762       --  Function call
2763
2764       elsif Nkind (P) = N_Function_Call then
2765          Error_Msg_NE
2766            ("?call to obsolescent function& declared#", N, E);
2767
2768       --  Reference to obsolescent type
2769
2770       elsif Is_Type (E) then
2771          Error_Msg_NE
2772            ("?reference to obsolescent type& declared#", N, E);
2773
2774       --  Reference to obsolescent component
2775
2776       elsif Ekind (E) = E_Component
2777         or else Ekind (E) = E_Discriminant
2778       then
2779          Error_Msg_NE
2780            ("?reference to obsolescent component& declared#", N, E);
2781
2782       --  Reference to obsolescent variable
2783
2784       elsif Ekind (E) = E_Variable then
2785          Error_Msg_NE
2786            ("?reference to obsolescent variable& declared#", N, E);
2787
2788       --  Reference to obsolescent constant
2789
2790       elsif Ekind (E) = E_Constant
2791         or else Ekind (E) in Named_Kind
2792       then
2793          Error_Msg_NE
2794            ("?reference to obsolescent constant& declared#", N, E);
2795
2796       --  Reference to obsolescent enumeration literal
2797
2798       elsif Ekind (E) = E_Enumeration_Literal then
2799          Error_Msg_NE
2800            ("?reference to obsolescent enumeration literal& declared#", N, E);
2801
2802       --  Generic message for any other case we missed
2803
2804       else
2805          Error_Msg_NE
2806            ("?reference to obsolescent entity& declared#", N, E);
2807       end if;
2808
2809       --  Output additional warning if present
2810
2811       for J in Obsolescent_Warnings.First .. Obsolescent_Warnings.Last loop
2812          if Obsolescent_Warnings.Table (J).Ent = E then
2813             String_To_Name_Buffer (Obsolescent_Warnings.Table (J).Msg);
2814             Error_Msg_Strlen := Name_Len;
2815             Error_Msg_String (1 .. Name_Len) := Name_Buffer (1 .. Name_Len);
2816             Error_Msg_N ("\\?~", N);
2817             exit;
2818          end if;
2819       end loop;
2820    end Output_Obsolescent_Entity_Warnings;
2821
2822    ----------------------------------
2823    -- Output_Unreferenced_Messages --
2824    ----------------------------------
2825
2826    procedure Output_Unreferenced_Messages is
2827    begin
2828       for J in Unreferenced_Entities.First ..
2829                Unreferenced_Entities.Last
2830       loop
2831          Warn_On_Unreferenced_Entity (Unreferenced_Entities.Table (J));
2832       end loop;
2833    end Output_Unreferenced_Messages;
2834
2835    -----------------------------------------
2836    -- Output_Unused_Warnings_Off_Warnings --
2837    -----------------------------------------
2838
2839    procedure Output_Unused_Warnings_Off_Warnings is
2840    begin
2841       for J in Warnings_Off_Pragmas.First .. Warnings_Off_Pragmas.Last loop
2842          declare
2843             Wentry : Warnings_Off_Entry renames Warnings_Off_Pragmas.Table (J);
2844             N      : Node_Id renames Wentry.N;
2845             E      : Node_Id renames Wentry.E;
2846
2847          begin
2848             --  Turn off Warnings_Off, or we won't get the warning!
2849
2850             Set_Warnings_Off (E, False);
2851
2852             --  Nothing to do if pragma was used to suppress a general warning
2853
2854             if Warnings_Off_Used (E) then
2855                null;
2856
2857             --  If pragma was used both in unmodified and unreferenced contexts
2858             --  then that's as good as the general case, no warning.
2859
2860             elsif Warnings_Off_Used_Unmodified (E)
2861                     and
2862                   Warnings_Off_Used_Unreferenced (E)
2863             then
2864                null;
2865
2866             --  Used only in context where Unmodified would have worked
2867
2868             elsif Warnings_Off_Used_Unmodified (E) then
2869                Error_Msg_NE
2870                  ("?could use Unmodified instead of "
2871                   & "Warnings Off for &", Pragma_Identifier (N), E);
2872
2873             --  Used only in context where Unreferenced would have worked
2874
2875             elsif Warnings_Off_Used_Unreferenced (E) then
2876                Error_Msg_NE
2877                  ("?could use Unreferenced instead of "
2878                   & "Warnings Off for &", Pragma_Identifier (N), E);
2879
2880             --  Not used at all
2881
2882             else
2883                Error_Msg_NE
2884                  ("?pragma Warnings Off for & unused, "
2885                   & "could be omitted", N, E);
2886             end if;
2887          end;
2888       end loop;
2889    end Output_Unused_Warnings_Off_Warnings;
2890
2891    ---------------------------
2892    -- Referenced_Check_Spec --
2893    ---------------------------
2894
2895    function Referenced_Check_Spec (E : Entity_Id) return Boolean is
2896    begin
2897       if Is_Formal (E) and then Present (Spec_Entity (E)) then
2898          return Referenced (E) or else Referenced (Spec_Entity (E));
2899       else
2900          return Referenced (E);
2901       end if;
2902    end Referenced_Check_Spec;
2903
2904    ----------------------------------
2905    -- Referenced_As_LHS_Check_Spec --
2906    ----------------------------------
2907
2908    function Referenced_As_LHS_Check_Spec (E : Entity_Id) return Boolean is
2909    begin
2910       if Is_Formal (E) and then Present (Spec_Entity (E)) then
2911          return Referenced_As_LHS (E)
2912            or else Referenced_As_LHS (Spec_Entity (E));
2913       else
2914          return Referenced_As_LHS (E);
2915       end if;
2916    end Referenced_As_LHS_Check_Spec;
2917
2918    --------------------------------------------
2919    -- Referenced_As_Out_Parameter_Check_Spec --
2920    --------------------------------------------
2921
2922    function Referenced_As_Out_Parameter_Check_Spec
2923      (E : Entity_Id) return Boolean
2924    is
2925    begin
2926       if Is_Formal (E) and then Present (Spec_Entity (E)) then
2927          return Referenced_As_Out_Parameter (E)
2928            or else Referenced_As_Out_Parameter (Spec_Entity (E));
2929       else
2930          return Referenced_As_Out_Parameter (E);
2931       end if;
2932    end Referenced_As_Out_Parameter_Check_Spec;
2933
2934    ----------------------------
2935    -- Set_Dot_Warning_Switch --
2936    ----------------------------
2937
2938    function Set_Dot_Warning_Switch (C : Character) return Boolean is
2939    begin
2940       case C is
2941          when 'a' =>
2942             Warn_On_Assertion_Failure           := True;
2943
2944          when 'A' =>
2945             Warn_On_Assertion_Failure           := False;
2946
2947          when 'b' =>
2948             Warn_On_Biased_Representation       := True;
2949
2950          when 'B' =>
2951             Warn_On_Biased_Representation       := False;
2952
2953          when 'c' =>
2954             Warn_On_Unrepped_Components         := True;
2955
2956          when 'C' =>
2957             Warn_On_Unrepped_Components         := False;
2958
2959          when 'e' =>
2960             Address_Clause_Overlay_Warnings     := True;
2961             Check_Unreferenced                  := True;
2962             Check_Unreferenced_Formals          := True;
2963             Check_Withs                         := True;
2964             Constant_Condition_Warnings         := True;
2965             Elab_Warnings                       := True;
2966             Implementation_Unit_Warnings        := True;
2967             Ineffective_Inline_Warnings         := True;
2968             Warn_On_Ada_2005_Compatibility      := True;
2969             Warn_On_All_Unread_Out_Parameters   := True;
2970             Warn_On_Assertion_Failure           := True;
2971             Warn_On_Assumed_Low_Bound           := True;
2972             Warn_On_Bad_Fixed_Value             := True;
2973             Warn_On_Biased_Representation       := True;
2974             Warn_On_Constant                    := True;
2975             Warn_On_Deleted_Code                := True;
2976             Warn_On_Dereference                 := True;
2977             Warn_On_Export_Import               := True;
2978             Warn_On_Hiding                      := True;
2979             Warn_On_Modified_Unread             := True;
2980             Warn_On_No_Value_Assigned           := True;
2981             Warn_On_Non_Local_Exception         := True;
2982             Warn_On_Object_Renames_Function     := True;
2983             Warn_On_Obsolescent_Feature         := True;
2984             Warn_On_Questionable_Missing_Parens := True;
2985             Warn_On_Redundant_Constructs        := True;
2986             Warn_On_Unchecked_Conversion        := True;
2987             Warn_On_Unrecognized_Pragma         := True;
2988             Warn_On_Unrepped_Components         := True;
2989             Warn_On_Warnings_Off                := True;
2990
2991          when 'o' =>
2992             Warn_On_All_Unread_Out_Parameters   := True;
2993
2994          when 'O' =>
2995             Warn_On_All_Unread_Out_Parameters   := False;
2996
2997          when 'p' =>
2998             Warn_On_Parameter_Order             := True;
2999
3000          when 'P' =>
3001             Warn_On_Parameter_Order             := False;
3002
3003          when 'r' =>
3004             Warn_On_Object_Renames_Function     := True;
3005
3006          when 'R' =>
3007             Warn_On_Object_Renames_Function     := False;
3008
3009          when 'w' =>
3010             Warn_On_Warnings_Off                := True;
3011
3012          when 'W' =>
3013             Warn_On_Warnings_Off                := False;
3014
3015          when 'x' =>
3016             Warn_On_Non_Local_Exception         := True;
3017
3018          when 'X' =>
3019             Warn_On_Non_Local_Exception         := False;
3020             No_Warn_On_Non_Local_Exception      := True;
3021
3022          when others =>
3023             return False;
3024       end case;
3025
3026       return True;
3027    end Set_Dot_Warning_Switch;
3028
3029    ------------------------
3030    -- Set_Warning_Switch --
3031    ------------------------
3032
3033    function Set_Warning_Switch (C : Character) return Boolean is
3034    begin
3035       case C is
3036          when 'a' =>
3037             Check_Unreferenced                  := True;
3038             Check_Unreferenced_Formals          := True;
3039             Check_Withs                         := True;
3040             Constant_Condition_Warnings         := True;
3041             Implementation_Unit_Warnings        := True;
3042             Ineffective_Inline_Warnings         := True;
3043             Warn_On_Ada_2005_Compatibility      := True;
3044             Warn_On_Assertion_Failure           := True;
3045             Warn_On_Assumed_Low_Bound           := True;
3046             Warn_On_Bad_Fixed_Value             := True;
3047             Warn_On_Biased_Representation       := True;
3048             Warn_On_Constant                    := True;
3049             Warn_On_Export_Import               := True;
3050             Warn_On_Modified_Unread             := True;
3051             Warn_On_No_Value_Assigned           := True;
3052             Warn_On_Non_Local_Exception         := True;
3053             Warn_On_Object_Renames_Function     := True;
3054             Warn_On_Obsolescent_Feature         := True;
3055             Warn_On_Parameter_Order             := True;
3056             Warn_On_Questionable_Missing_Parens := True;
3057             Warn_On_Redundant_Constructs        := True;
3058             Warn_On_Unchecked_Conversion        := True;
3059             Warn_On_Unrecognized_Pragma         := True;
3060             Warn_On_Unrepped_Components         := True;
3061
3062          when 'A' =>
3063             Check_Unreferenced                  := False;
3064             Check_Unreferenced_Formals          := False;
3065             Check_Withs                         := False;
3066             Constant_Condition_Warnings         := False;
3067             Elab_Warnings                       := False;
3068             Implementation_Unit_Warnings        := False;
3069             Ineffective_Inline_Warnings         := False;
3070             Warn_On_Ada_2005_Compatibility      := False;
3071             Warn_On_Assertion_Failure           := False;
3072             Warn_On_Assumed_Low_Bound           := False;
3073             Warn_On_Bad_Fixed_Value             := False;
3074             Warn_On_Biased_Representation       := False;
3075             Warn_On_Constant                    := False;
3076             Warn_On_Deleted_Code                := False;
3077             Warn_On_Dereference                 := False;
3078             Warn_On_Export_Import               := False;
3079             Warn_On_Hiding                      := False;
3080             Warn_On_Modified_Unread             := False;
3081             Warn_On_No_Value_Assigned           := False;
3082             Warn_On_Non_Local_Exception         := False;
3083             Warn_On_Obsolescent_Feature         := False;
3084             Warn_On_All_Unread_Out_Parameters   := False;
3085             Warn_On_Parameter_Order             := False;
3086             Warn_On_Questionable_Missing_Parens := False;
3087             Warn_On_Redundant_Constructs        := False;
3088             Warn_On_Object_Renames_Function     := False;
3089             Warn_On_Unchecked_Conversion        := False;
3090             Warn_On_Unrecognized_Pragma         := False;
3091             Warn_On_Unrepped_Components         := False;
3092             Warn_On_Warnings_Off                := False;
3093
3094             No_Warn_On_Non_Local_Exception      := True;
3095
3096          when 'b' =>
3097             Warn_On_Bad_Fixed_Value             := True;
3098
3099          when 'B' =>
3100             Warn_On_Bad_Fixed_Value             := False;
3101
3102          when 'c' =>
3103             Constant_Condition_Warnings         := True;
3104
3105          when 'C' =>
3106             Constant_Condition_Warnings         := False;
3107
3108          when 'd' =>
3109             Warn_On_Dereference                 := True;
3110
3111          when 'D' =>
3112             Warn_On_Dereference                 := False;
3113
3114          when 'e' =>
3115             Warning_Mode                        := Treat_As_Error;
3116
3117          when 'f' =>
3118             Check_Unreferenced_Formals          := True;
3119
3120          when 'F' =>
3121             Check_Unreferenced_Formals          := False;
3122
3123          when 'g' =>
3124             Warn_On_Unrecognized_Pragma         := True;
3125
3126          when 'G' =>
3127             Warn_On_Unrecognized_Pragma         := False;
3128
3129          when 'h' =>
3130             Warn_On_Hiding                      := True;
3131
3132          when 'H' =>
3133             Warn_On_Hiding                      := False;
3134
3135          when 'i' =>
3136             Implementation_Unit_Warnings        := True;
3137
3138          when 'I' =>
3139             Implementation_Unit_Warnings        := False;
3140
3141          when 'j' =>
3142             Warn_On_Obsolescent_Feature         := True;
3143
3144          when 'J' =>
3145             Warn_On_Obsolescent_Feature         := False;
3146
3147          when 'k' =>
3148             Warn_On_Constant                    := True;
3149
3150          when 'K' =>
3151             Warn_On_Constant                    := False;
3152
3153          when 'l' =>
3154             Elab_Warnings                       := True;
3155
3156          when 'L' =>
3157             Elab_Warnings                       := False;
3158
3159          when 'm' =>
3160             Warn_On_Modified_Unread             := True;
3161
3162          when 'M' =>
3163             Warn_On_Modified_Unread             := False;
3164
3165          when 'n' =>
3166             Warning_Mode                        := Normal;
3167
3168          when 'o' =>
3169             Address_Clause_Overlay_Warnings     := True;
3170
3171          when 'O' =>
3172             Address_Clause_Overlay_Warnings     := False;
3173
3174          when 'p' =>
3175             Ineffective_Inline_Warnings         := True;
3176
3177          when 'P' =>
3178             Ineffective_Inline_Warnings         := False;
3179
3180          when 'q' =>
3181             Warn_On_Questionable_Missing_Parens := True;
3182
3183          when 'Q' =>
3184             Warn_On_Questionable_Missing_Parens := False;
3185
3186          when 'r' =>
3187             Warn_On_Redundant_Constructs        := True;
3188
3189          when 'R' =>
3190             Warn_On_Redundant_Constructs        := False;
3191
3192          when 's' =>
3193             Warning_Mode                        := Suppress;
3194
3195          when 't' =>
3196             Warn_On_Deleted_Code                := True;
3197
3198          when 'T' =>
3199             Warn_On_Deleted_Code                := False;
3200
3201          when 'u' =>
3202             Check_Unreferenced                  := True;
3203             Check_Withs                         := True;
3204             Check_Unreferenced_Formals          := True;
3205
3206          when 'U' =>
3207             Check_Unreferenced                  := False;
3208             Check_Withs                         := False;
3209             Check_Unreferenced_Formals          := False;
3210
3211          when 'v' =>
3212             Warn_On_No_Value_Assigned           := True;
3213
3214          when 'V' =>
3215             Warn_On_No_Value_Assigned           := False;
3216
3217          when 'w' =>
3218             Warn_On_Assumed_Low_Bound           := True;
3219
3220          when 'W' =>
3221             Warn_On_Assumed_Low_Bound           := False;
3222
3223          when 'x' =>
3224             Warn_On_Export_Import               := True;
3225
3226          when 'X' =>
3227             Warn_On_Export_Import               := False;
3228
3229          when 'y' =>
3230             Warn_On_Ada_2005_Compatibility      := True;
3231
3232          when 'Y' =>
3233             Warn_On_Ada_2005_Compatibility      := False;
3234
3235          when 'z' =>
3236             Warn_On_Unchecked_Conversion        := True;
3237
3238          when 'Z' =>
3239             Warn_On_Unchecked_Conversion        := False;
3240
3241          when others =>
3242             return False;
3243       end case;
3244
3245       return True;
3246    end Set_Warning_Switch;
3247
3248    -----------------------------
3249    -- Warn_On_Known_Condition --
3250    -----------------------------
3251
3252    procedure Warn_On_Known_Condition (C : Node_Id) is
3253       P : Node_Id;
3254
3255       procedure Track (N : Node_Id; Loc : Node_Id);
3256       --  Adds continuation warning(s) pointing to reason (assignment or test)
3257       --  for the operand of the conditional having a known value (or at least
3258       --  enough is known about the value to issue the warning). N is the node
3259       --  which is judged to have a known value. Loc is the warning location.
3260
3261       -----------
3262       -- Track --
3263       -----------
3264
3265       procedure Track (N : Node_Id; Loc : Node_Id) is
3266          Nod : constant Node_Id := Original_Node (N);
3267
3268       begin
3269          if Nkind (Nod) in N_Op_Compare then
3270             Track (Left_Opnd (Nod), Loc);
3271             Track (Right_Opnd (Nod), Loc);
3272
3273          elsif Is_Entity_Name (Nod)
3274            and then Is_Object (Entity (Nod))
3275          then
3276             declare
3277                CV : constant Node_Id := Current_Value (Entity (Nod));
3278
3279             begin
3280                if Present (CV) then
3281                   Error_Msg_Sloc := Sloc (CV);
3282
3283                   if Nkind (CV) not in N_Subexpr then
3284                      Error_Msg_N ("\\?(see test #)", Loc);
3285
3286                   elsif Nkind (Parent (CV)) =
3287                           N_Case_Statement_Alternative
3288                   then
3289                      Error_Msg_N ("\\?(see case alternative #)", Loc);
3290
3291                   else
3292                      Error_Msg_N ("\\?(see assignment #)", Loc);
3293                   end if;
3294                end if;
3295             end;
3296          end if;
3297       end Track;
3298
3299    --  Start of processing for Warn_On_Known_Condition
3300
3301    begin
3302       --   Argument replacement in an inlined body can make conditions static.
3303       --   Do not emit warnings in this case.
3304
3305       if In_Inlined_Body then
3306          return;
3307       end if;
3308
3309       if Constant_Condition_Warnings
3310         and then Nkind (C) = N_Identifier
3311         and then
3312           (Entity (C) = Standard_False or else Entity (C) = Standard_True)
3313         and then Comes_From_Source (Original_Node (C))
3314         and then not In_Instance
3315       then
3316          --  See if this is in a statement or a declaration
3317
3318          P := Parent (C);
3319          loop
3320             --  If tree is not attached, do not issue warning (this is very
3321             --  peculiar, and probably arises from some other error condition)
3322
3323             if No (P) then
3324                return;
3325
3326             --  If we are in a declaration, then no warning, since in practice
3327             --  conditionals in declarations are used for intended tests which
3328             --  may be known at compile time, e.g. things like
3329
3330             --    x : constant Integer := 2 + (Word'Size = 32);
3331
3332             --  And a warning is annoying in such cases
3333
3334             elsif Nkind (P) in N_Declaration
3335                     or else
3336                   Nkind (P) in N_Later_Decl_Item
3337             then
3338                return;
3339
3340             --  Don't warn in assert or check pragma, since presumably tests in
3341             --  such a context are very definitely intended, and might well be
3342             --  known at compile time. Note that we have to test the original
3343             --  node, since assert pragmas get rewritten at analysis time.
3344
3345             elsif Nkind (Original_Node (P)) = N_Pragma
3346               and then (Pragma_Name (Original_Node (P)) = Name_Assert
3347                           or else
3348                         Pragma_Name (Original_Node (P)) = Name_Check)
3349             then
3350                return;
3351             end if;
3352
3353             exit when Is_Statement (P);
3354             P := Parent (P);
3355          end loop;
3356
3357          --  Here we issue the warning unless some sub-operand has warnings
3358          --  set off, in which case we suppress the warning for the node. If
3359          --  the original expression is an inequality, it has been expanded
3360          --  into a negation, and the value of the original expression is the
3361          --  negation of the equality. If the expression is an entity that
3362          --  appears within a negation, it is clearer to flag the negation
3363          --  itself, and report on its constant value.
3364
3365          if not Operand_Has_Warnings_Suppressed (C) then
3366             declare
3367                True_Branch : Boolean := Entity (C) = Standard_True;
3368                Cond        : Node_Id := C;
3369
3370             begin
3371                if Present (Parent (C))
3372                  and then Nkind (Parent (C)) = N_Op_Not
3373                then
3374                   True_Branch := not True_Branch;
3375                   Cond        := Parent (C);
3376                end if;
3377
3378                if True_Branch then
3379                   if Is_Entity_Name (Original_Node (C))
3380                     and then Nkind (Cond) /= N_Op_Not
3381                   then
3382                      Error_Msg_NE
3383                        ("object & is always True?", Cond, Original_Node (C));
3384                      Track (Original_Node (C), Cond);
3385
3386                   else
3387                      Error_Msg_N ("condition is always True?", Cond);
3388                      Track (Cond, Cond);
3389                   end if;
3390
3391                else
3392                   Error_Msg_N ("condition is always False?", Cond);
3393                   Track (Cond, Cond);
3394                end if;
3395             end;
3396          end if;
3397       end if;
3398    end Warn_On_Known_Condition;
3399
3400    ---------------------------------------
3401    -- Warn_On_Modified_As_Out_Parameter --
3402    ---------------------------------------
3403
3404    function Warn_On_Modified_As_Out_Parameter (E : Entity_Id) return Boolean is
3405    begin
3406       return
3407         (Warn_On_Modified_Unread and then Is_Only_Out_Parameter (E))
3408            or else Warn_On_All_Unread_Out_Parameters;
3409    end Warn_On_Modified_As_Out_Parameter;
3410
3411    ------------------------------
3412    -- Warn_On_Suspicious_Index --
3413    ------------------------------
3414
3415    procedure Warn_On_Suspicious_Index (Name : Entity_Id; X : Node_Id) is
3416
3417       Low_Bound : Uint;
3418       --  Set to lower bound for a suspicious type
3419
3420       Ent : Entity_Id;
3421       --  Entity for array reference
3422
3423       Typ : Entity_Id;
3424       --  Array type
3425
3426       function Is_Suspicious_Type (Typ : Entity_Id) return Boolean;
3427       --  Tests to see if Typ is a type for which we may have a suspicious
3428       --  index, namely an unconstrained array type, whose lower bound is
3429       --  either zero or one. If so, True is returned, and Low_Bound is set
3430       --  to this lower bound. If not, False is returned, and Low_Bound is
3431       --  undefined on return.
3432       --
3433       --  For now, we limit this to standard string types, so any other
3434       --  unconstrained types return False. We may change our minds on this
3435       --  later on, but strings seem the most important case.
3436
3437       procedure Test_Suspicious_Index;
3438       --  Test if index is of suspicious type and if so, generate warning
3439
3440       ------------------------
3441       -- Is_Suspicious_Type --
3442       ------------------------
3443
3444       function Is_Suspicious_Type (Typ : Entity_Id) return Boolean is
3445          LB : Node_Id;
3446
3447       begin
3448          if Is_Array_Type (Typ)
3449            and then not Is_Constrained (Typ)
3450            and then Number_Dimensions (Typ) = 1
3451            and then (Root_Type (Typ) = Standard_String
3452                        or else
3453                      Root_Type (Typ) = Standard_Wide_String
3454                        or else
3455                      Root_Type (Typ) = Standard_Wide_Wide_String)
3456            and then not Has_Warnings_Off (Typ)
3457          then
3458             LB := Type_Low_Bound (Etype (First_Index (Typ)));
3459
3460             if Compile_Time_Known_Value (LB) then
3461                Low_Bound := Expr_Value (LB);
3462                return Low_Bound = Uint_0 or else Low_Bound = Uint_1;
3463             end if;
3464          end if;
3465
3466          return False;
3467       end Is_Suspicious_Type;
3468
3469       ---------------------------
3470       -- Test_Suspicious_Index --
3471       ---------------------------
3472
3473       procedure Test_Suspicious_Index is
3474
3475          function Length_Reference (N : Node_Id) return Boolean;
3476          --  Check if node N is of the form Name'Length
3477
3478          procedure Warn1;
3479          --  Generate first warning line
3480
3481          ----------------------
3482          -- Length_Reference --
3483          ----------------------
3484
3485          function Length_Reference (N : Node_Id) return Boolean is
3486             R : constant Node_Id := Original_Node (N);
3487          begin
3488             return
3489               Nkind (R) = N_Attribute_Reference
3490                and then Attribute_Name (R) = Name_Length
3491                and then Is_Entity_Name (Prefix (R))
3492                and then Entity (Prefix (R)) = Ent;
3493          end Length_Reference;
3494
3495          -----------
3496          -- Warn1 --
3497          -----------
3498
3499          procedure Warn1 is
3500          begin
3501             Error_Msg_Uint_1 := Low_Bound;
3502             Error_Msg_FE ("?index for& may assume lower bound of^", X, Ent);
3503          end Warn1;
3504
3505       --  Start of processing for Test_Suspicious_Index
3506
3507       begin
3508          --  Nothing to do if subscript does not come from source (we don't
3509          --  want to give garbage warnings on compiler expanded code, e.g. the
3510          --  loops generated for slice assignments. Such junk warnings would
3511          --  be placed on source constructs with no subscript in sight!)
3512
3513          if not Comes_From_Source (Original_Node (X)) then
3514             return;
3515          end if;
3516
3517          --  Case where subscript is a constant integer
3518
3519          if Nkind (X) = N_Integer_Literal then
3520             Warn1;
3521
3522             --  Case where original form of subscript is an integer literal
3523
3524             if Nkind (Original_Node (X)) = N_Integer_Literal then
3525                if Intval (X) = Low_Bound then
3526                   Error_Msg_FE
3527                     ("\suggested replacement: `&''First`", X, Ent);
3528                else
3529                   Error_Msg_Uint_1 := Intval (X) - Low_Bound;
3530                   Error_Msg_FE
3531                     ("\suggested replacement: `&''First + ^`", X, Ent);
3532
3533                end if;
3534
3535             --  Case where original form of subscript is more complex
3536
3537             else
3538                --  Build string X'First - 1 + expression where the expression
3539                --  is the original subscript. If the expression starts with "1
3540                --  + ", then the "- 1 + 1" is elided.
3541
3542                Error_Msg_String (1 .. 13) := "'First - 1 + ";
3543                Error_Msg_Strlen := 13;
3544
3545                declare
3546                   Sref : Source_Ptr := Sloc (First_Node (Original_Node (X)));
3547                   Tref : constant Source_Buffer_Ptr :=
3548                            Source_Text (Get_Source_File_Index (Sref));
3549                   --  Tref (Sref) is used to scan the subscript
3550
3551                   Pctr : Natural;
3552                   --  Parentheses counter when scanning subscript
3553
3554                begin
3555                   --  Tref (Sref) points to start of subscript
3556
3557                   --  Elide - 1 if subscript starts with 1 +
3558
3559                   if Tref (Sref .. Sref + 2) = "1 +" then
3560                      Error_Msg_Strlen := Error_Msg_Strlen - 6;
3561                      Sref := Sref + 2;
3562
3563                   elsif Tref (Sref .. Sref + 1) = "1+" then
3564                      Error_Msg_Strlen := Error_Msg_Strlen - 6;
3565                      Sref := Sref + 1;
3566                   end if;
3567
3568                   --  Now we will copy the subscript to the string buffer
3569
3570                   Pctr := 0;
3571                   loop
3572                      --  Count parens, exit if terminating right paren. Note
3573                      --  check to ignore paren appearing as character literal.
3574
3575                      if Tref (Sref + 1) = '''
3576                           and then
3577                         Tref (Sref - 1) = '''
3578                      then
3579                         null;
3580                      else
3581                         if Tref (Sref) = '(' then
3582                            Pctr := Pctr + 1;
3583                         elsif Tref (Sref) = ')' then
3584                            exit when Pctr = 0;
3585                            Pctr := Pctr - 1;
3586                         end if;
3587                      end if;
3588
3589                      --  Done if terminating double dot (slice case)
3590
3591                      exit when Pctr = 0
3592                        and then (Tref (Sref .. Sref + 1) = ".."
3593                                   or else
3594                                  Tref (Sref .. Sref + 2) = " ..");
3595
3596                      --  Quit if we have hit EOF character, something wrong
3597
3598                      if Tref (Sref) = EOF then
3599                         return;
3600                      end if;
3601
3602                      --  String literals are too much of a pain to handle
3603
3604                      if Tref (Sref) = '"' or else Tref (Sref) = '%' then
3605                         return;
3606                      end if;
3607
3608                      --  If we have a 'Range reference, then this is a case
3609                      --  where we cannot easily give a replacement. Don't try!
3610
3611                      if Tref (Sref .. Sref + 4) = "range"
3612                        and then Tref (Sref - 1) < 'A'
3613                        and then Tref (Sref + 5) < 'A'
3614                      then
3615                         return;
3616                      end if;
3617
3618                      --  Else store next character
3619
3620                      Error_Msg_Strlen := Error_Msg_Strlen + 1;
3621                      Error_Msg_String (Error_Msg_Strlen) := Tref (Sref);
3622                      Sref := Sref + 1;
3623
3624                      --  If we get more than 40 characters then the expression
3625                      --  is too long to copy, or something has gone wrong. In
3626                      --  either case, just skip the attempt at a suggested fix.
3627
3628                      if Error_Msg_Strlen > 40 then
3629                         return;
3630                      end if;
3631                   end loop;
3632                end;
3633
3634                --  Replacement subscript is now in string buffer
3635
3636                Error_Msg_FE
3637                  ("\suggested replacement: `&~`", Original_Node (X), Ent);
3638             end if;
3639
3640          --  Case where subscript is of the form X'Length
3641
3642          elsif Length_Reference (X) then
3643             Warn1;
3644             Error_Msg_Node_2 := Ent;
3645             Error_Msg_FE
3646               ("\suggest replacement of `&''Length` by `&''Last`",
3647                X, Ent);
3648
3649          --  Case where subscript is of the form X'Length - expression
3650
3651          elsif Nkind (X) = N_Op_Subtract
3652            and then Length_Reference (Left_Opnd (X))
3653          then
3654             Warn1;
3655             Error_Msg_Node_2 := Ent;
3656             Error_Msg_FE
3657               ("\suggest replacement of `&''Length` by `&''Last`",
3658                Left_Opnd (X), Ent);
3659          end if;
3660       end Test_Suspicious_Index;
3661
3662    --  Start of processing for Warn_On_Suspicious_Index
3663
3664    begin
3665       --  Only process if warnings activated
3666
3667       if Warn_On_Assumed_Low_Bound then
3668
3669          --  Test if array is simple entity name
3670
3671          if Is_Entity_Name (Name) then
3672
3673             --  Test if array is parameter of unconstrained string type
3674
3675             Ent := Entity (Name);
3676             Typ := Etype (Ent);
3677
3678             if Is_Formal (Ent)
3679               and then Is_Suspicious_Type (Typ)
3680               and then not Low_Bound_Tested (Ent)
3681             then
3682                Test_Suspicious_Index;
3683             end if;
3684          end if;
3685       end if;
3686    end Warn_On_Suspicious_Index;
3687
3688    --------------------------------------
3689    -- Warn_On_Unassigned_Out_Parameter --
3690    --------------------------------------
3691
3692    procedure Warn_On_Unassigned_Out_Parameter
3693      (Return_Node : Node_Id;
3694       Scope_Id    : Entity_Id)
3695    is
3696       Form  : Entity_Id;
3697       Form2 : Entity_Id;
3698
3699    begin
3700       --  Ignore if procedure or return statement does not come from source
3701
3702       if not Comes_From_Source (Scope_Id)
3703         or else not Comes_From_Source (Return_Node)
3704       then
3705          return;
3706       end if;
3707
3708       --  Loop through formals
3709
3710       Form := First_Formal (Scope_Id);
3711       while Present (Form) loop
3712
3713          --  We are only interested in OUT parameters that come from source
3714          --  and are never set in the source, and furthermore only in scalars
3715          --  since non-scalars generate too many false positives.
3716
3717          if Ekind (Form) = E_Out_Parameter
3718            and then Never_Set_In_Source_Check_Spec (Form)
3719            and then Is_Scalar_Type (Etype (Form))
3720            and then not Present (Unset_Reference (Form))
3721          then
3722             --  Before we issue the warning, an add ad hoc defence against the
3723             --  most common case of false positives with this warning which is
3724             --  the case where there is a Boolean OUT parameter that has been
3725             --  set, and whose meaning is "ignore the values of the other
3726             --  parameters". We can't of course reliably tell this case at
3727             --  compile time, but the following test kills a lot of false
3728             --  positives, without generating a significant number of false
3729             --  negatives (missed real warnings).
3730
3731             Form2 := First_Formal (Scope_Id);
3732             while Present (Form2) loop
3733                if Ekind (Form2) = E_Out_Parameter
3734                  and then Root_Type (Etype (Form2)) = Standard_Boolean
3735                  and then not Never_Set_In_Source_Check_Spec (Form2)
3736                then
3737                   return;
3738                end if;
3739
3740                Next_Formal (Form2);
3741             end loop;
3742
3743             --  Here all conditions are met, record possible unset reference
3744
3745             Set_Unset_Reference (Form, Return_Node);
3746          end if;
3747
3748          Next_Formal (Form);
3749       end loop;
3750    end Warn_On_Unassigned_Out_Parameter;
3751
3752    ---------------------------------
3753    -- Warn_On_Unreferenced_Entity --
3754    ---------------------------------
3755
3756    procedure Warn_On_Unreferenced_Entity
3757      (Spec_E : Entity_Id;
3758       Body_E : Entity_Id := Empty)
3759    is
3760       E : Entity_Id := Spec_E;
3761
3762    begin
3763       if not Referenced_Check_Spec (E)
3764         and then not Has_Pragma_Unreferenced_Check_Spec (E)
3765         and then not Warnings_Off_Check_Spec (E)
3766       then
3767          case Ekind (E) is
3768             when E_Variable =>
3769
3770                --  Case of variable that is assigned but not read. We suppress
3771                --  the message if the variable is volatile, has an address
3772                --  clause, is aliased, or is a renaming, or is imported.
3773
3774                if Referenced_As_LHS_Check_Spec (E)
3775                  and then No (Address_Clause (E))
3776                  and then not Is_Volatile (E)
3777                then
3778                   if Warn_On_Modified_Unread
3779                     and then not Is_Imported (E)
3780                     and then not Is_Return_Object (E)
3781                     and then not Is_Aliased (E)
3782                     and then No (Renamed_Object (E))
3783                   then
3784                      if not Has_Pragma_Unmodified_Check_Spec (E) then
3785                         Error_Msg_N -- CODEFIX
3786                           ("?variable & is assigned but never read!", E);
3787                      end if;
3788
3789                      Set_Last_Assignment (E, Empty);
3790                   end if;
3791
3792                --  Normal case of neither assigned nor read (exclude variables
3793                --  referenced as out parameters, since we already generated
3794                --  appropriate warnings at the call point in this case).
3795
3796                elsif not Referenced_As_Out_Parameter (E) then
3797
3798                   --  We suppress the message for types for which a valid
3799                   --  pragma Unreferenced_Objects has been given, otherwise
3800                   --  we go ahead and give the message.
3801
3802                   if not Has_Pragma_Unreferenced_Objects (Etype (E)) then
3803
3804                      --  Distinguish renamed case in message
3805
3806                      if Present (Renamed_Object (E))
3807                        and then Comes_From_Source (Renamed_Object (E))
3808                      then
3809                         Error_Msg_N
3810                           ("?renamed variable & is not referenced!", E);
3811                      else
3812                         Error_Msg_N
3813                           ("?variable & is not referenced!", E);
3814                      end if;
3815                   end if;
3816                end if;
3817
3818             when E_Constant =>
3819                if Present (Renamed_Object (E))
3820                  and then Comes_From_Source (Renamed_Object (E))
3821                then
3822                   Error_Msg_N
3823                     ("?renamed constant & is not referenced!", E);
3824                else
3825                   Error_Msg_N ("?constant & is not referenced!", E);
3826                end if;
3827
3828             when E_In_Parameter     |
3829                  E_In_Out_Parameter =>
3830
3831                --  Do not emit message for formals of a renaming, because
3832                --  they are never referenced explicitly.
3833
3834                if Nkind (Original_Node (Unit_Declaration_Node (Scope (E))))
3835                  /= N_Subprogram_Renaming_Declaration
3836                then
3837                   --  Suppress this message for an IN OUT parameter of a
3838                   --  non-scalar type, since it is normal to have only an
3839                   --  assignment in such a case.
3840
3841                   if Ekind (E) = E_In_Parameter
3842                     or else not Referenced_As_LHS_Check_Spec (E)
3843                     or else Is_Scalar_Type (E)
3844                   then
3845                      if Present (Body_E) then
3846                         E := Body_E;
3847                      end if;
3848
3849                      if not Is_Trivial_Subprogram (Scope (E)) then
3850                         Error_Msg_NE
3851                           ("?formal parameter & is not referenced!",
3852                            E, Spec_E);
3853                      end if;
3854                   end if;
3855                end if;
3856
3857             when E_Out_Parameter    =>
3858                null;
3859
3860             when E_Named_Integer    |
3861                  E_Named_Real       =>
3862                Error_Msg_N ("?named number & is not referenced!", E);
3863
3864             when E_Enumeration_Literal =>
3865                Error_Msg_N ("?literal & is not referenced!", E);
3866
3867             when E_Function         =>
3868                Error_Msg_N ("?function & is not referenced!", E);
3869
3870             when E_Procedure         =>
3871                Error_Msg_N ("?procedure & is not referenced!", E);
3872
3873             when E_Generic_Procedure =>
3874                Error_Msg_N -- CODEFIX
3875                  ("?generic procedure & is never instantiated!", E);
3876
3877             when E_Generic_Function  =>
3878                Error_Msg_N -- CODEFIX
3879                  ("?generic function & is never instantiated!", E);
3880
3881             when Type_Kind          =>
3882                Error_Msg_N ("?type & is not referenced!", E);
3883
3884             when others =>
3885                Error_Msg_N ("?& is not referenced!", E);
3886          end case;
3887
3888          --  Kill warnings on the entity on which the message has been posted
3889
3890          Set_Warnings_Off (E);
3891       end if;
3892    end Warn_On_Unreferenced_Entity;
3893
3894    --------------------------------
3895    -- Warn_On_Useless_Assignment --
3896    --------------------------------
3897
3898    procedure Warn_On_Useless_Assignment
3899      (Ent : Entity_Id;
3900       N   : Node_Id := Empty)
3901    is
3902       P    : Node_Id;
3903       X    : Node_Id;
3904
3905       function Check_Ref (N : Node_Id) return Traverse_Result;
3906       --  Used to instantiate Traverse_Func. Returns Abandon if a reference to
3907       --  the entity in question is found.
3908
3909       function Test_No_Refs is new Traverse_Func (Check_Ref);
3910
3911       ---------------
3912       -- Check_Ref --
3913       ---------------
3914
3915       function Check_Ref (N : Node_Id) return Traverse_Result is
3916       begin
3917          --  Check reference to our identifier. We use name equality here
3918          --  because the exception handlers have not yet been analyzed. This
3919          --  is not quite right, but it really does not matter that we fail
3920          --  to output the warning in some obscure cases of name clashes.
3921
3922          if Nkind (N) = N_Identifier
3923            and then Chars (N) = Chars (Ent)
3924          then
3925             return Abandon;
3926          else
3927             return OK;
3928          end if;
3929       end Check_Ref;
3930
3931    --  Start of processing for Warn_On_Useless_Assignment
3932
3933    begin
3934       --  Check if this is a case we want to warn on, a scalar or access
3935       --  variable with the last assignment field set, with warnings enabled,
3936       --  and which is not imported or exported. We also check that it is OK
3937       --  to capture the value. We are not going to capture any value, but
3938       --  the warning message depends on the same kind of conditions.
3939
3940       if Is_Assignable (Ent)
3941         and then not Is_Return_Object (Ent)
3942         and then Present (Last_Assignment (Ent))
3943         and then not Is_Imported (Ent)
3944         and then not Is_Exported (Ent)
3945         and then Safe_To_Capture_Value (N, Ent)
3946         and then not Has_Pragma_Unreferenced_Check_Spec (Ent)
3947       then
3948          --  Before we issue the message, check covering exception handlers.
3949          --  Search up tree for enclosing statement sequences and handlers.
3950
3951          P := Parent (Last_Assignment (Ent));
3952          while Present (P) loop
3953
3954             --  Something is really wrong if we don't find a handled statement
3955             --  sequence, so just suppress the warning.
3956
3957             if No (P) then
3958                Set_Last_Assignment (Ent, Empty);
3959                return;
3960
3961             --  When we hit a package/subprogram body, issue warning and exit
3962
3963             elsif Nkind (P) = N_Subprogram_Body
3964               or else Nkind (P) = N_Package_Body
3965             then
3966                --  Case of assigned value never referenced
3967
3968                if No (N) then
3969
3970                   --  Don't give this for OUT and IN OUT formals, since
3971                   --  clearly caller may reference the assigned value. Also
3972                   --  never give such warnings for internal variables.
3973
3974                   if Ekind (Ent) = E_Variable
3975                     and then not Is_Internal_Name (Chars (Ent))
3976                   then
3977                      if Referenced_As_Out_Parameter (Ent) then
3978                         Error_Msg_NE
3979                           ("?& modified by call, but value never referenced",
3980                            Last_Assignment (Ent), Ent);
3981                      else
3982                         Error_Msg_NE
3983                           ("?useless assignment to&, value never referenced!",
3984                            Last_Assignment (Ent), Ent);
3985                      end if;
3986                   end if;
3987
3988                --  Case of assigned value overwritten
3989
3990                else
3991                   Error_Msg_Sloc := Sloc (N);
3992
3993                   if Referenced_As_Out_Parameter (Ent) then
3994                      Error_Msg_NE
3995                        ("?& modified by call, but value overwritten #!",
3996                         Last_Assignment (Ent), Ent);
3997                   else
3998                      Error_Msg_NE
3999                        ("?useless assignment to&, value overwritten #!",
4000                         Last_Assignment (Ent), Ent);
4001                   end if;
4002                end if;
4003
4004                --  Clear last assignment indication and we are done
4005
4006                Set_Last_Assignment (Ent, Empty);
4007                return;
4008
4009             --  Enclosing handled sequence of statements
4010
4011             elsif Nkind (P) = N_Handled_Sequence_Of_Statements then
4012
4013                --  Check exception handlers present
4014
4015                if Present (Exception_Handlers (P)) then
4016
4017                   --  If we are not at the top level, we regard an inner
4018                   --  exception handler as a decisive indicator that we should
4019                   --  not generate the warning, since the variable in question
4020                   --  may be accessed after an exception in the outer block.
4021
4022                   if Nkind (Parent (P)) /= N_Subprogram_Body
4023                     and then Nkind (Parent (P)) /= N_Package_Body
4024                   then
4025                      Set_Last_Assignment (Ent, Empty);
4026                      return;
4027
4028                      --  Otherwise we are at the outer level. An exception
4029                      --  handler is significant only if it references the
4030                      --  variable in question, or if the entity in question
4031                      --  is an OUT or IN OUT parameter, which which case
4032                      --  the caller can reference it after the exception
4033                      --  hanlder completes
4034
4035                   else
4036                      if Is_Formal (Ent) then
4037                         Set_Last_Assignment (Ent, Empty);
4038                         return;
4039
4040                      else
4041                         X := First (Exception_Handlers (P));
4042                         while Present (X) loop
4043                            if Test_No_Refs (X) = Abandon then
4044                               Set_Last_Assignment (Ent, Empty);
4045                               return;
4046                            end if;
4047
4048                            X := Next (X);
4049                         end loop;
4050                      end if;
4051                   end if;
4052                end if;
4053             end if;
4054
4055             P := Parent (P);
4056          end loop;
4057       end if;
4058    end Warn_On_Useless_Assignment;
4059
4060    ---------------------------------
4061    -- Warn_On_Useless_Assignments --
4062    ---------------------------------
4063
4064    procedure Warn_On_Useless_Assignments (E : Entity_Id) is
4065       Ent : Entity_Id;
4066    begin
4067       if Warn_On_Modified_Unread
4068         and then In_Extended_Main_Source_Unit (E)
4069       then
4070          Ent := First_Entity (E);
4071          while Present (Ent) loop
4072             Warn_On_Useless_Assignment (Ent);
4073             Next_Entity (Ent);
4074          end loop;
4075       end if;
4076    end Warn_On_Useless_Assignments;
4077
4078    -----------------------------
4079    -- Warnings_Off_Check_Spec --
4080    -----------------------------
4081
4082    function Warnings_Off_Check_Spec (E : Entity_Id) return Boolean is
4083    begin
4084       if Is_Formal (E) and then Present (Spec_Entity (E)) then
4085
4086          --  Note: use of OR here instead of OR ELSE is deliberate, we want
4087          --  to mess with flags on both entities.
4088
4089          return Has_Warnings_Off (E)
4090                   or
4091                 Has_Warnings_Off (Spec_Entity (E));
4092
4093       else
4094          return Has_Warnings_Off (E);
4095       end if;
4096    end Warnings_Off_Check_Spec;
4097
4098 end Sem_Warn;