2016-10-26 François Dumont <fdumont@gcc.gnu.org>
[official-gcc.git] / gcc / ada / sem_warn.adb
blobd9050959ff2427f1689a27de6b94e9058719622c
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-2016, 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 ------------------------------------------------------------------------------
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 Lib.Xref; use Lib.Xref;
34 with Namet; use Namet;
35 with Nlists; use Nlists;
36 with Opt; use Opt;
37 with Par_SCO; use Par_SCO;
38 with Rtsfind; use Rtsfind;
39 with Sem; use Sem;
40 with Sem_Ch8; use Sem_Ch8;
41 with Sem_Aux; use Sem_Aux;
42 with Sem_Eval; use Sem_Eval;
43 with Sem_Prag; use Sem_Prag;
44 with Sem_Util; use Sem_Util;
45 with Sinfo; use Sinfo;
46 with Sinput; use Sinput;
47 with Snames; use Snames;
48 with Stand; use Stand;
49 with Stringt; use Stringt;
50 with Uintp; use Uintp;
52 package body Sem_Warn is
54 -- The following table collects Id's of entities that are potentially
55 -- unreferenced. See Check_Unset_Reference for further details.
56 -- ??? Check_Unset_Reference has zero information about this table.
58 package Unreferenced_Entities is new Table.Table (
59 Table_Component_Type => Entity_Id,
60 Table_Index_Type => Nat,
61 Table_Low_Bound => 1,
62 Table_Initial => Alloc.Unreferenced_Entities_Initial,
63 Table_Increment => Alloc.Unreferenced_Entities_Increment,
64 Table_Name => "Unreferenced_Entities");
66 -- The following table collects potential warnings for IN OUT parameters
67 -- that are referenced but not modified. These warnings are processed when
68 -- the front end calls the procedure Output_Non_Modified_In_Out_Warnings.
69 -- The reason that we defer output of these messages is that we want to
70 -- detect the case where the relevant procedure is used as a generic actual
71 -- in an instantiation, since we suppress the warnings in this case. The
72 -- flag Used_As_Generic_Actual will be set in this case, but only at the
73 -- point of usage. Similarly, we suppress the message if the address of the
74 -- procedure is taken, where the flag Address_Taken may be set later.
76 package In_Out_Warnings is new Table.Table (
77 Table_Component_Type => Entity_Id,
78 Table_Index_Type => Nat,
79 Table_Low_Bound => 1,
80 Table_Initial => Alloc.In_Out_Warnings_Initial,
81 Table_Increment => Alloc.In_Out_Warnings_Increment,
82 Table_Name => "In_Out_Warnings");
84 --------------------------------------------------------
85 -- Handling of Warnings Off, Unmodified, Unreferenced --
86 --------------------------------------------------------
88 -- The functions Has_Warnings_Off, Has_Unmodified, Has_Unreferenced must
89 -- generally be used instead of Warnings_Off, Has_Pragma_Unmodified and
90 -- Has_Pragma_Unreferenced, as noted in the specs in Einfo.
92 -- In order to avoid losing warnings in -gnatw.w (warn on unnecessary
93 -- warnings off pragma) mode, i.e. to avoid false negatives, the code
94 -- must follow some important rules.
96 -- Call these functions as late as possible, after completing all other
97 -- tests, just before the warnings is given. For example, don't write:
99 -- if not Has_Warnings_Off (E)
100 -- and then some-other-predicate-on-E then ..
102 -- Instead the following is preferred
104 -- if some-other-predicate-on-E
105 -- and then Has_Warnings_Off (E)
107 -- This way if some-other-predicate is false, we avoid a false indication
108 -- that a Warnings (Off, E) pragma was useful in preventing a warning.
110 -- The second rule is that if both Has_Unmodified and Has_Warnings_Off, or
111 -- Has_Unreferenced and Has_Warnings_Off are called, make sure that the
112 -- call to Has_Unmodified/Has_Unreferenced comes first, this way we record
113 -- that the Warnings (Off) could have been Unreferenced or Unmodified. In
114 -- fact Has_Unmodified/Has_Unreferenced includes a test for Warnings Off,
115 -- and so a subsequent test is not needed anyway (though it is harmless).
117 -----------------------
118 -- Local Subprograms --
119 -----------------------
121 function Generic_Package_Spec_Entity (E : Entity_Id) return Boolean;
122 -- This returns true if the entity E is declared within a generic package.
123 -- The point of this is to detect variables which are not assigned within
124 -- the generic, but might be assigned outside the package for any given
125 -- instance. These are cases where we leave the warnings to be posted for
126 -- the instance, when we will know more.
128 function Goto_Spec_Entity (E : Entity_Id) return Entity_Id;
129 -- If E is a parameter entity for a subprogram body, then this function
130 -- returns the corresponding spec entity, if not, E is returned unchanged.
132 function Has_Pragma_Unmodified_Check_Spec (E : Entity_Id) return Boolean;
133 -- Tests Has_Pragma_Unmodified flag for entity E. If E is not a formal,
134 -- this is simply the setting of the flag Has_Pragma_Unmodified. If E is
135 -- a body formal, the setting of the flag in the corresponding spec is
136 -- also checked (and True returned if either flag is True).
138 function Has_Pragma_Unreferenced_Check_Spec (E : Entity_Id) return Boolean;
139 -- Tests Has_Pragma_Unreferenced flag for entity E. If E is not a formal,
140 -- this is simply the setting of the flag Has_Pragma_Unreferenced. If E is
141 -- a body formal, the setting of the flag in the corresponding spec is
142 -- also checked (and True returned if either flag is True).
144 function Never_Set_In_Source_Check_Spec (E : Entity_Id) return Boolean;
145 -- Tests Never_Set_In_Source status for entity E. If E is not a formal,
146 -- this is simply the setting of the flag Never_Set_In_Source. If E is
147 -- a body formal, the setting of the flag in the corresponding spec is
148 -- also checked (and False returned if either flag is False).
150 function Operand_Has_Warnings_Suppressed (N : Node_Id) return Boolean;
151 -- This function traverses the expression tree represented by the node N
152 -- and determines if any sub-operand is a reference to an entity for which
153 -- the Warnings_Off flag is set. True is returned if such an entity is
154 -- encountered, and False otherwise.
156 function Referenced_Check_Spec (E : Entity_Id) return Boolean;
157 -- Tests Referenced status for entity E. If E is not a formal, this is
158 -- simply the setting of the flag Referenced. If E is a body formal, the
159 -- setting of the flag in the corresponding spec is also checked (and True
160 -- returned if either flag is True).
162 function Referenced_As_LHS_Check_Spec (E : Entity_Id) return Boolean;
163 -- Tests Referenced_As_LHS status for entity E. If E is not a formal, this
164 -- is simply the setting of the flag Referenced_As_LHS. If E is a body
165 -- formal, the setting of the flag in the corresponding spec is also
166 -- checked (and True returned if either flag is True).
168 function Referenced_As_Out_Parameter_Check_Spec
169 (E : Entity_Id) return Boolean;
170 -- Tests Referenced_As_Out_Parameter status for entity E. If E is not a
171 -- formal, this is simply the setting of Referenced_As_Out_Parameter. If E
172 -- is a body formal, the setting of the flag in the corresponding spec is
173 -- also checked (and True returned if either flag is True).
175 procedure Warn_On_Unreferenced_Entity
176 (Spec_E : Entity_Id;
177 Body_E : Entity_Id := Empty);
178 -- Output warnings for unreferenced entity E. For the case of an entry
179 -- formal, Body_E is the corresponding body entity for a particular
180 -- accept statement, and the message is posted on Body_E. In all other
181 -- cases, Body_E is ignored and must be Empty.
183 function Warnings_Off_Check_Spec (E : Entity_Id) return Boolean;
184 -- Returns True if Warnings_Off is set for the entity E or (in the case
185 -- where there is a Spec_Entity), Warnings_Off is set for the Spec_Entity.
187 --------------------------
188 -- Check_Code_Statement --
189 --------------------------
191 procedure Check_Code_Statement (N : Node_Id) is
192 begin
193 -- If volatile, nothing to worry about
195 if Is_Asm_Volatile (N) then
196 return;
197 end if;
199 -- Warn if no input or no output
201 Setup_Asm_Inputs (N);
203 if No (Asm_Input_Value) then
204 Error_Msg_F
205 ("??code statement with no inputs should usually be Volatile!", N);
206 return;
207 end if;
209 Setup_Asm_Outputs (N);
211 if No (Asm_Output_Variable) then
212 Error_Msg_F
213 ("??code statement with no outputs should usually be Volatile!", N);
214 return;
215 end if;
216 end Check_Code_Statement;
218 ---------------------------------
219 -- Check_Infinite_Loop_Warning --
220 ---------------------------------
222 -- The case we look for is a while loop which tests a local variable, where
223 -- there is no obvious direct or possible indirect update of the variable
224 -- within the body of the loop.
226 procedure Check_Infinite_Loop_Warning (Loop_Statement : Node_Id) is
227 Expression : Node_Id := Empty;
228 -- Set to WHILE or EXIT WHEN condition to be tested
230 Ref : Node_Id := Empty;
231 -- Reference in Expression to variable that might not be modified
232 -- in loop, indicating a possible infinite loop.
234 Var : Entity_Id := Empty;
235 -- Corresponding entity (entity of Ref)
237 Function_Call_Found : Boolean := False;
238 -- True if Find_Var found a function call in the condition
240 procedure Find_Var (N : Node_Id);
241 -- Inspect condition to see if it depends on a single entity reference.
242 -- If so, Ref is set to point to the reference node, and Var is set to
243 -- the referenced Entity.
245 function Has_Indirection (T : Entity_Id) return Boolean;
246 -- If the controlling variable is an access type, or is a record type
247 -- with access components, assume that it is changed indirectly and
248 -- suppress the warning. As a concession to low-level programming, in
249 -- particular within Declib, we also suppress warnings on a record
250 -- type that contains components of type Address or Short_Address.
252 function Is_Suspicious_Function_Name (E : Entity_Id) return Boolean;
253 -- Given an entity name, see if the name appears to have something to
254 -- do with I/O or network stuff, and if so, return True. Used to kill
255 -- some false positives on a heuristic basis that such functions will
256 -- likely have some strange side effect dependencies. A rather strange
257 -- test, but warning messages are in the heuristics business.
259 function Test_Ref (N : Node_Id) return Traverse_Result;
260 -- Test for reference to variable in question. Returns Abandon if
261 -- matching reference found. Used in instantiation of No_Ref_Found.
263 function No_Ref_Found is new Traverse_Func (Test_Ref);
264 -- Function to traverse body of procedure. Returns Abandon if matching
265 -- reference found.
267 --------------
268 -- Find_Var --
269 --------------
271 procedure Find_Var (N : Node_Id) is
272 begin
273 -- Condition is a direct variable reference
275 if Is_Entity_Name (N) then
276 Ref := N;
277 Var := Entity (Ref);
279 -- Case of condition is a comparison with compile time known value
281 elsif Nkind (N) in N_Op_Compare then
282 if Compile_Time_Known_Value (Right_Opnd (N)) then
283 Find_Var (Left_Opnd (N));
285 elsif Compile_Time_Known_Value (Left_Opnd (N)) then
286 Find_Var (Right_Opnd (N));
288 -- Ignore any other comparison
290 else
291 return;
292 end if;
294 -- If condition is a negation, check its operand
296 elsif Nkind (N) = N_Op_Not then
297 Find_Var (Right_Opnd (N));
299 -- Case of condition is function call
301 elsif Nkind (N) = N_Function_Call then
303 Function_Call_Found := True;
305 -- Forget it if function name is not entity, who knows what
306 -- we might be calling?
308 if not Is_Entity_Name (Name (N)) then
309 return;
311 -- Forget it if function name is suspicious. A strange test
312 -- but warning generation is in the heuristics business.
314 elsif Is_Suspicious_Function_Name (Entity (Name (N))) then
315 return;
317 -- Forget it if function is marked Volatile_Function
319 elsif Is_Volatile_Function (Entity (Name (N))) then
320 return;
322 -- Forget it if warnings are suppressed on function entity
324 elsif Has_Warnings_Off (Entity (Name (N))) then
325 return;
326 end if;
328 -- OK, see if we have one argument
330 declare
331 PA : constant List_Id := Parameter_Associations (N);
333 begin
334 -- One argument, so check the argument
336 if Present (PA) and then List_Length (PA) = 1 then
337 if Nkind (First (PA)) = N_Parameter_Association then
338 Find_Var (Explicit_Actual_Parameter (First (PA)));
339 else
340 Find_Var (First (PA));
341 end if;
343 -- Not one argument
345 else
346 return;
347 end if;
348 end;
350 -- Any other kind of node is not something we warn for
352 else
353 return;
354 end if;
355 end Find_Var;
357 ---------------------
358 -- Has_Indirection --
359 ---------------------
361 function Has_Indirection (T : Entity_Id) return Boolean is
362 Comp : Entity_Id;
363 Rec : Entity_Id;
365 begin
366 if Is_Access_Type (T) then
367 return True;
369 elsif Is_Private_Type (T)
370 and then Present (Full_View (T))
371 and then Is_Access_Type (Full_View (T))
372 then
373 return True;
375 elsif Is_Record_Type (T) then
376 Rec := T;
378 elsif Is_Private_Type (T)
379 and then Present (Full_View (T))
380 and then Is_Record_Type (Full_View (T))
381 then
382 Rec := Full_View (T);
383 else
384 return False;
385 end if;
387 Comp := First_Component (Rec);
388 while Present (Comp) loop
389 if Is_Access_Type (Etype (Comp))
390 or else Is_Descendant_Of_Address (Etype (Comp))
391 then
392 return True;
393 end if;
395 Next_Component (Comp);
396 end loop;
398 return False;
399 end Has_Indirection;
401 ---------------------------------
402 -- Is_Suspicious_Function_Name --
403 ---------------------------------
405 function Is_Suspicious_Function_Name (E : Entity_Id) return Boolean is
406 S : Entity_Id;
408 function Substring_Present (S : String) return Boolean;
409 -- Returns True if name buffer has given string delimited by non-
410 -- alphabetic characters or by end of string. S is lower case.
412 -----------------------
413 -- Substring_Present --
414 -----------------------
416 function Substring_Present (S : String) return Boolean is
417 Len : constant Natural := S'Length;
419 begin
420 for J in 1 .. Name_Len - (Len - 1) loop
421 if Name_Buffer (J .. J + (Len - 1)) = S
422 and then (J = 1 or else Name_Buffer (J - 1) not in 'a' .. 'z')
423 and then
424 (J + Len > Name_Len
425 or else Name_Buffer (J + Len) not in 'a' .. 'z')
426 then
427 return True;
428 end if;
429 end loop;
431 return False;
432 end Substring_Present;
434 -- Start of processing for Is_Suspicious_Function_Name
436 begin
437 S := E;
438 while Present (S) and then S /= Standard_Standard loop
439 Get_Name_String (Chars (S));
441 if Substring_Present ("io")
442 or else Substring_Present ("file")
443 or else Substring_Present ("network")
444 then
445 return True;
446 else
447 S := Scope (S);
448 end if;
449 end loop;
451 return False;
452 end Is_Suspicious_Function_Name;
454 --------------
455 -- Test_Ref --
456 --------------
458 function Test_Ref (N : Node_Id) return Traverse_Result is
459 begin
460 -- Waste of time to look at the expression we are testing
462 if N = Expression then
463 return Skip;
465 -- Direct reference to variable in question
467 elsif Is_Entity_Name (N)
468 and then Present (Entity (N))
469 and then Entity (N) = Var
470 then
471 -- If this is an lvalue, then definitely abandon, since
472 -- this could be a direct modification of the variable.
474 if May_Be_Lvalue (N) then
475 return Abandon;
476 end if;
478 -- If the condition contains a function call, we consider it may
479 -- be modified by side-effects from a procedure call. Otherwise,
480 -- we consider the condition may not be modified, although that
481 -- might happen if Variable is itself a by-reference parameter,
482 -- and the procedure called modifies the global object referred to
483 -- by Variable, but we actually prefer to issue a warning in this
484 -- odd case. Note that the case where the procedure called has
485 -- visibility over Variable is treated in another case below.
487 if Function_Call_Found then
488 declare
489 P : Node_Id;
491 begin
492 P := N;
493 loop
494 P := Parent (P);
495 exit when P = Loop_Statement;
497 -- Abandon if at procedure call, or something strange is
498 -- going on (perhaps a node with no parent that should
499 -- have one but does not?) As always, for a warning we
500 -- prefer to just abandon the warning than get into the
501 -- business of complaining about the tree structure here.
503 if No (P)
504 or else Nkind (P) = N_Procedure_Call_Statement
505 then
506 return Abandon;
507 end if;
508 end loop;
509 end;
510 end if;
512 -- Reference to variable renaming variable in question
514 elsif Is_Entity_Name (N)
515 and then Present (Entity (N))
516 and then Ekind (Entity (N)) = E_Variable
517 and then Present (Renamed_Object (Entity (N)))
518 and then Is_Entity_Name (Renamed_Object (Entity (N)))
519 and then Entity (Renamed_Object (Entity (N))) = Var
520 and then May_Be_Lvalue (N)
521 then
522 return Abandon;
524 -- Call to subprogram
526 elsif Nkind (N) in N_Subprogram_Call then
528 -- If subprogram is within the scope of the entity we are dealing
529 -- with as the loop variable, then it could modify this parameter,
530 -- so we abandon in this case. In the case of a subprogram that is
531 -- not an entity we also abandon. The check for no entity being
532 -- present is a defense against previous errors.
534 if not Is_Entity_Name (Name (N))
535 or else No (Entity (Name (N)))
536 or else Scope_Within (Entity (Name (N)), Scope (Var))
537 then
538 return Abandon;
539 end if;
541 -- If any of the arguments are of type access to subprogram, then
542 -- we may have funny side effects, so no warning in this case.
544 declare
545 Actual : Node_Id;
546 begin
547 Actual := First_Actual (N);
548 while Present (Actual) loop
549 if Is_Access_Subprogram_Type (Etype (Actual)) then
550 return Abandon;
551 else
552 Next_Actual (Actual);
553 end if;
554 end loop;
555 end;
557 -- Declaration of the variable in question
559 elsif Nkind (N) = N_Object_Declaration
560 and then Defining_Identifier (N) = Var
561 then
562 return Abandon;
563 end if;
565 -- All OK, continue scan
567 return OK;
568 end Test_Ref;
570 -- Start of processing for Check_Infinite_Loop_Warning
572 begin
573 -- Skip processing if debug flag gnatd.w is set
575 if Debug_Flag_Dot_W then
576 return;
577 end if;
579 -- Deal with Iteration scheme present
581 declare
582 Iter : constant Node_Id := Iteration_Scheme (Loop_Statement);
584 begin
585 if Present (Iter) then
587 -- While iteration
589 if Present (Condition (Iter)) then
591 -- Skip processing for while iteration with conditions actions,
592 -- since they make it too complicated to get the warning right.
594 if Present (Condition_Actions (Iter)) then
595 return;
596 end if;
598 -- Capture WHILE condition
600 Expression := Condition (Iter);
602 -- For iteration, do not process, since loop will always terminate
604 elsif Present (Loop_Parameter_Specification (Iter)) then
605 return;
606 end if;
607 end if;
608 end;
610 -- Check chain of EXIT statements, we only process loops that have a
611 -- single exit condition (either a single EXIT WHEN statement, or a
612 -- WHILE loop not containing any EXIT WHEN statements).
614 declare
615 Ident : constant Node_Id := Identifier (Loop_Statement);
616 Exit_Stmt : Node_Id;
618 begin
619 -- If we don't have a proper chain set, ignore call entirely. This
620 -- happens because of previous errors.
622 if No (Entity (Ident))
623 or else Ekind (Entity (Ident)) /= E_Loop
624 then
625 Check_Error_Detected;
626 return;
627 end if;
629 -- Otherwise prepare to scan list of EXIT statements
631 Exit_Stmt := First_Exit_Statement (Entity (Ident));
632 while Present (Exit_Stmt) loop
634 -- Check for EXIT WHEN
636 if Present (Condition (Exit_Stmt)) then
638 -- Quit processing if EXIT WHEN in WHILE loop, or more than
639 -- one EXIT WHEN statement present in the loop.
641 if Present (Expression) then
642 return;
644 -- Otherwise capture condition from EXIT WHEN statement
646 else
647 Expression := Condition (Exit_Stmt);
648 end if;
650 -- If an unconditional exit statement is the last statement in the
651 -- loop, assume that no warning is needed, without any attempt at
652 -- checking whether the exit is reachable.
654 elsif Exit_Stmt = Last (Statements (Loop_Statement)) then
655 return;
656 end if;
658 Exit_Stmt := Next_Exit_Statement (Exit_Stmt);
659 end loop;
660 end;
662 -- Return if no condition to test
664 if No (Expression) then
665 return;
666 end if;
668 -- Initial conditions met, see if condition is of right form
670 Find_Var (Expression);
672 -- Nothing to do if local variable from source not found. If it's a
673 -- renaming, it is probably renaming something too complicated to deal
674 -- with here.
676 if No (Var)
677 or else Ekind (Var) /= E_Variable
678 or else Is_Library_Level_Entity (Var)
679 or else not Comes_From_Source (Var)
680 or else Nkind (Parent (Var)) = N_Object_Renaming_Declaration
681 then
682 return;
684 -- Nothing to do if there is some indirection involved (assume that the
685 -- designated variable might be modified in some way we don't see).
686 -- However, if no function call was found, then we don't care about
687 -- indirections, because the condition must be something like "while X
688 -- /= null loop", so we don't care if X.all is modified in the loop.
690 elsif Function_Call_Found and then Has_Indirection (Etype (Var)) then
691 return;
693 -- Same sort of thing for volatile variable, might be modified by
694 -- some other task or by the operating system in some way.
696 elsif Is_Volatile (Var) then
697 return;
698 end if;
700 -- Filter out case of original statement sequence starting with delay.
701 -- We assume this is a multi-tasking program and that the condition
702 -- is affected by other threads (some kind of busy wait).
704 declare
705 Fstm : constant Node_Id :=
706 Original_Node (First (Statements (Loop_Statement)));
707 begin
708 if Nkind (Fstm) = N_Delay_Relative_Statement
709 or else Nkind (Fstm) = N_Delay_Until_Statement
710 then
711 return;
712 end if;
713 end;
715 -- We have a variable reference of the right form, now we scan the loop
716 -- body to see if it looks like it might not be modified
718 if No_Ref_Found (Loop_Statement) = OK then
719 Error_Msg_NE
720 ("??variable& is not modified in loop body!", Ref, Var);
721 Error_Msg_N
722 ("\??possible infinite loop!", Ref);
723 end if;
724 end Check_Infinite_Loop_Warning;
726 ----------------------------
727 -- Check_Low_Bound_Tested --
728 ----------------------------
730 procedure Check_Low_Bound_Tested (Expr : Node_Id) is
731 procedure Check_Low_Bound_Tested_For (Opnd : Node_Id);
732 -- Determine whether operand Opnd denotes attribute 'First whose prefix
733 -- is a formal parameter. If this is the case, mark the entity of the
734 -- prefix as having its low bound tested.
736 --------------------------------
737 -- Check_Low_Bound_Tested_For --
738 --------------------------------
740 procedure Check_Low_Bound_Tested_For (Opnd : Node_Id) is
741 begin
742 if Nkind (Opnd) = N_Attribute_Reference
743 and then Attribute_Name (Opnd) = Name_First
744 and then Is_Entity_Name (Prefix (Opnd))
745 and then Present (Entity (Prefix (Opnd)))
746 and then Is_Formal (Entity (Prefix (Opnd)))
747 then
748 Set_Low_Bound_Tested (Entity (Prefix (Opnd)));
749 end if;
750 end Check_Low_Bound_Tested_For;
752 -- Start of processing for Check_Low_Bound_Tested
754 begin
755 if Comes_From_Source (Expr) then
756 Check_Low_Bound_Tested_For (Left_Opnd (Expr));
757 Check_Low_Bound_Tested_For (Right_Opnd (Expr));
758 end if;
759 end Check_Low_Bound_Tested;
761 ----------------------
762 -- Check_References --
763 ----------------------
765 procedure Check_References (E : Entity_Id; Anod : Node_Id := Empty) is
766 E1 : Entity_Id;
767 E1T : Entity_Id;
768 UR : Node_Id;
770 function Body_Formal
771 (E : Entity_Id;
772 Accept_Statement : Node_Id) return Entity_Id;
773 -- For an entry formal entity from an entry declaration, find the
774 -- corresponding body formal from the given accept statement.
776 procedure May_Need_Initialized_Actual (Ent : Entity_Id);
777 -- If an entity of a generic type has default initialization, then the
778 -- corresponding actual type should be fully initialized, or else there
779 -- will be uninitialized components in the instantiation, that might go
780 -- unreported. This routine marks the type of the uninitialized variable
781 -- appropriately to allow the compiler to emit an appropriate warning
782 -- in the instance. In a sense, the use of a type that requires full
783 -- initialization is a weak part of the generic contract.
785 function Missing_Subunits return Boolean;
786 -- We suppress warnings when there are missing subunits, because this
787 -- may generate too many false positives: entities in a parent may only
788 -- be referenced in one of the subunits. We make an exception for
789 -- subunits that contain no other stubs.
791 procedure Output_Reference_Error (M : String);
792 -- Used to output an error message. Deals with posting the error on the
793 -- body formal in the accept case.
795 function Publicly_Referenceable (Ent : Entity_Id) return Boolean;
796 -- This is true if the entity in question is potentially referenceable
797 -- from another unit. This is true for entities in packages that are at
798 -- the library level.
800 function Warnings_Off_E1 return Boolean;
801 -- Return True if Warnings_Off is set for E1, or for its Etype (E1T),
802 -- or for the base type of E1T.
804 -----------------
805 -- Body_Formal --
806 -----------------
808 function Body_Formal
809 (E : Entity_Id;
810 Accept_Statement : Node_Id) return Entity_Id
812 Body_Param : Node_Id;
813 Body_E : Entity_Id;
815 begin
816 -- Loop to find matching parameter in accept statement
818 Body_Param := First (Parameter_Specifications (Accept_Statement));
819 while Present (Body_Param) loop
820 Body_E := Defining_Identifier (Body_Param);
822 if Chars (Body_E) = Chars (E) then
823 return Body_E;
824 end if;
826 Next (Body_Param);
827 end loop;
829 -- Should never fall through, should always find a match
831 raise Program_Error;
832 end Body_Formal;
834 ---------------------------------
835 -- May_Need_Initialized_Actual --
836 ---------------------------------
838 procedure May_Need_Initialized_Actual (Ent : Entity_Id) is
839 T : constant Entity_Id := Etype (Ent);
840 Par : constant Node_Id := Parent (T);
842 begin
843 if not Is_Generic_Type (T) then
844 null;
846 elsif (Nkind (Par)) = N_Private_Extension_Declaration then
848 -- We only indicate the first such variable in the generic.
850 if No (Uninitialized_Variable (Par)) then
851 Set_Uninitialized_Variable (Par, Ent);
852 end if;
854 elsif (Nkind (Par)) = N_Formal_Type_Declaration
855 and then Nkind (Formal_Type_Definition (Par)) =
856 N_Formal_Private_Type_Definition
857 then
858 if No (Uninitialized_Variable (Formal_Type_Definition (Par))) then
859 Set_Uninitialized_Variable (Formal_Type_Definition (Par), Ent);
860 end if;
861 end if;
862 end May_Need_Initialized_Actual;
864 ----------------------
865 -- Missing_Subunits --
866 ----------------------
868 function Missing_Subunits return Boolean is
869 D : Node_Id;
871 begin
872 if not Unloaded_Subunits then
874 -- Normal compilation, all subunits are present
876 return False;
878 elsif E /= Main_Unit_Entity then
880 -- No warnings on a stub that is not the main unit
882 return True;
884 elsif Nkind (Unit_Declaration_Node (E)) in N_Proper_Body then
885 D := First (Declarations (Unit_Declaration_Node (E)));
886 while Present (D) loop
888 -- No warnings if the proper body contains nested stubs
890 if Nkind (D) in N_Body_Stub then
891 return True;
892 end if;
894 Next (D);
895 end loop;
897 return False;
899 else
900 -- Missing stubs elsewhere
902 return True;
903 end if;
904 end Missing_Subunits;
906 ----------------------------
907 -- Output_Reference_Error --
908 ----------------------------
910 procedure Output_Reference_Error (M : String) is
911 begin
912 -- Never issue messages for internal names or renamings
914 if Is_Internal_Name (Chars (E1))
915 or else Nkind (Parent (E1)) = N_Object_Renaming_Declaration
916 then
917 return;
918 end if;
920 -- Don't output message for IN OUT formal unless we have the warning
921 -- flag specifically set. It is a bit odd to distinguish IN OUT
922 -- formals from other cases. This distinction is historical in
923 -- nature. Warnings for IN OUT formals were added fairly late.
925 if Ekind (E1) = E_In_Out_Parameter
926 and then not Check_Unreferenced_Formals
927 then
928 return;
929 end if;
931 -- Other than accept case, post error on defining identifier
933 if No (Anod) then
934 Error_Msg_N (M, E1);
936 -- Accept case, find body formal to post the message
938 else
939 Error_Msg_NE (M, Body_Formal (E1, Accept_Statement => Anod), E1);
941 end if;
942 end Output_Reference_Error;
944 ----------------------------
945 -- Publicly_Referenceable --
946 ----------------------------
948 function Publicly_Referenceable (Ent : Entity_Id) return Boolean is
949 P : Node_Id;
950 Prev : Node_Id;
952 begin
953 -- A formal parameter is never referenceable outside the body of its
954 -- subprogram or entry.
956 if Is_Formal (Ent) then
957 return False;
958 end if;
960 -- Examine parents to look for a library level package spec. But if
961 -- we find a body or block or other similar construct along the way,
962 -- we cannot be referenced.
964 Prev := Ent;
965 P := Parent (Ent);
966 loop
967 case Nkind (P) is
969 -- If we get to top of tree, then publicly referenceable
971 when N_Empty =>
972 return True;
974 -- If we reach a generic package declaration, then always
975 -- consider this referenceable, since any instantiation will
976 -- have access to the entities in the generic package. Note
977 -- that the package itself may not be instantiated, but then
978 -- we will get a warning for the package entity.
980 -- Note that generic formal parameters are themselves not
981 -- publicly referenceable in an instance, and warnings on them
982 -- are useful.
984 when N_Generic_Package_Declaration =>
985 return
986 not Is_List_Member (Prev)
987 or else List_Containing (Prev) /=
988 Generic_Formal_Declarations (P);
990 -- Similarly, the generic formals of a generic subprogram are
991 -- not accessible.
993 when N_Generic_Subprogram_Declaration =>
994 if Is_List_Member (Prev)
995 and then List_Containing (Prev) =
996 Generic_Formal_Declarations (P)
997 then
998 return False;
999 else
1000 P := Parent (P);
1001 end if;
1003 -- If we reach a subprogram body, entity is not referenceable
1004 -- unless it is the defining entity of the body. This will
1005 -- happen, e.g. when a function is an attribute renaming that
1006 -- is rewritten as a body.
1008 when N_Subprogram_Body =>
1009 if Ent /= Defining_Entity (P) then
1010 return False;
1011 else
1012 P := Parent (P);
1013 end if;
1015 -- If we reach any other body, definitely not referenceable
1017 when N_Package_Body |
1018 N_Task_Body |
1019 N_Entry_Body |
1020 N_Protected_Body |
1021 N_Block_Statement |
1022 N_Subunit =>
1023 return False;
1025 -- For all other cases, keep looking up tree
1027 when others =>
1028 Prev := P;
1029 P := Parent (P);
1030 end case;
1031 end loop;
1032 end Publicly_Referenceable;
1034 ---------------------
1035 -- Warnings_Off_E1 --
1036 ---------------------
1038 function Warnings_Off_E1 return Boolean is
1039 begin
1040 return Has_Warnings_Off (E1T)
1041 or else Has_Warnings_Off (Base_Type (E1T))
1042 or else Warnings_Off_Check_Spec (E1);
1043 end Warnings_Off_E1;
1045 -- Start of processing for Check_References
1047 begin
1048 Process_Deferred_References;
1050 -- No messages if warnings are suppressed, or if we have detected any
1051 -- real errors so far (this last check avoids junk messages resulting
1052 -- from errors, e.g. a subunit that is not loaded).
1054 if Warning_Mode = Suppress or else Serious_Errors_Detected /= 0 then
1055 return;
1056 end if;
1058 -- We also skip the messages if any subunits were not loaded (see
1059 -- comment in Sem_Ch10 to understand how this is set, and why it is
1060 -- necessary to suppress the warnings in this case).
1062 if Missing_Subunits then
1063 return;
1064 end if;
1066 -- Otherwise loop through entities, looking for suspicious stuff
1068 E1 := First_Entity (E);
1069 while Present (E1) loop
1070 E1T := Etype (E1);
1072 -- We are only interested in source entities. We also don't issue
1073 -- warnings within instances, since the proper place for such
1074 -- warnings is on the template when it is compiled, and we don't
1075 -- issue warnings for variables with names like Junk, Discard etc.
1077 if Comes_From_Source (E1)
1078 and then Instantiation_Location (Sloc (E1)) = No_Location
1079 then
1080 -- We are interested in variables and out/in-out parameters, but
1081 -- we exclude protected types, too complicated to worry about.
1083 if Ekind (E1) = E_Variable
1084 or else
1085 (Ekind_In (E1, E_Out_Parameter, E_In_Out_Parameter)
1086 and then not Is_Protected_Type (Current_Scope))
1087 then
1088 -- If the formal has a class-wide type, retrieve its type
1089 -- because checks below depend on its private nature.
1091 if Is_Class_Wide_Type (E1T) then
1092 E1T := Etype (E1T);
1093 end if;
1095 -- Case of an unassigned variable
1097 -- First gather any Unset_Reference indication for E1. In the
1098 -- case of a parameter, it is the Spec_Entity that is relevant.
1100 if Ekind (E1) = E_Out_Parameter
1101 and then Present (Spec_Entity (E1))
1102 then
1103 UR := Unset_Reference (Spec_Entity (E1));
1104 else
1105 UR := Unset_Reference (E1);
1106 end if;
1108 -- Special processing for access types
1110 if Present (UR) and then Is_Access_Type (E1T) then
1112 -- For access types, the only time we made a UR entry was
1113 -- for a dereference, and so we post the appropriate warning
1114 -- here (note that the dereference may not be explicit in
1115 -- the source, for example in the case of a dispatching call
1116 -- with an anonymous access controlling formal, or of an
1117 -- assignment of a pointer involving discriminant check on
1118 -- the designated object).
1120 if not Warnings_Off_E1 then
1121 Error_Msg_NE ("??& may be null!", UR, E1);
1122 end if;
1124 goto Continue;
1126 -- Case of variable that could be a constant. Note that we
1127 -- never signal such messages for generic package entities,
1128 -- since a given instance could have modifications outside
1129 -- the package.
1131 -- Note that we used to check Address_Taken here, but we don't
1132 -- want to do that since it can be set for non-source cases,
1133 -- e.g. the Unrestricted_Access from a valid attribute, and
1134 -- the wanted effect is included in Never_Set_In_Source.
1136 elsif Warn_On_Constant
1137 and then (Ekind (E1) = E_Variable
1138 and then Has_Initial_Value (E1))
1139 and then Never_Set_In_Source_Check_Spec (E1)
1140 and then not Generic_Package_Spec_Entity (E1)
1141 then
1142 -- A special case, if this variable is volatile and not
1143 -- imported, it is not helpful to tell the programmer
1144 -- to mark the variable as constant, since this would be
1145 -- illegal by virtue of RM C.6(13). Instead we suggest
1146 -- using pragma Export (can't be Import because of the
1147 -- initial value).
1149 if (Is_Volatile (E1) or else Has_Volatile_Components (E1))
1150 and then not Is_Imported (E1)
1151 then
1152 Error_Msg_N
1153 ("?k?& is not modified, consider pragma Export for "
1154 & "volatile variable!", E1);
1156 -- Another special case, Exception_Occurrence, this catches
1157 -- the case of exception choice (and a bit more too, but not
1158 -- worth doing more investigation here).
1160 elsif Is_RTE (E1T, RE_Exception_Occurrence) then
1161 null;
1163 -- Here we give the warning if referenced and no pragma
1164 -- Unreferenced or Unmodified is present.
1166 else
1167 -- Variable case
1169 if Ekind (E1) = E_Variable then
1170 if Referenced_Check_Spec (E1)
1171 and then not Has_Pragma_Unreferenced_Check_Spec (E1)
1172 and then not Has_Pragma_Unmodified_Check_Spec (E1)
1173 then
1174 if not Warnings_Off_E1
1175 and then not Has_Junk_Name (E1)
1176 then
1177 Error_Msg_N -- CODEFIX
1178 ("?k?& is not modified, "
1179 & "could be declared constant!",
1180 E1);
1181 end if;
1182 end if;
1183 end if;
1184 end if;
1186 -- Other cases of a variable or parameter never set in source
1188 elsif Never_Set_In_Source_Check_Spec (E1)
1190 -- No warning if warning for this case turned off
1192 and then Warn_On_No_Value_Assigned
1194 -- No warning if address taken somewhere
1196 and then not Address_Taken (E1)
1198 -- No warning if explicit initial value
1200 and then not Has_Initial_Value (E1)
1202 -- No warning for generic package spec entities, since we
1203 -- might set them in a child unit or something like that
1205 and then not Generic_Package_Spec_Entity (E1)
1207 -- No warning if fully initialized type, except that for
1208 -- this purpose we do not consider access types to qualify
1209 -- as fully initialized types (relying on an access type
1210 -- variable being null when it is never set is a bit odd).
1212 -- Also we generate warning for an out parameter that is
1213 -- never referenced, since again it seems odd to rely on
1214 -- default initialization to set an out parameter value.
1216 and then (Is_Access_Type (E1T)
1217 or else Ekind (E1) = E_Out_Parameter
1218 or else not Is_Fully_Initialized_Type (E1T))
1219 then
1220 -- Do not output complaint about never being assigned a
1221 -- value if a pragma Unmodified applies to the variable
1222 -- we are examining, or if it is a parameter, if there is
1223 -- a pragma Unreferenced for the corresponding spec, or
1224 -- if the type is marked as having unreferenced objects.
1225 -- The last is a little peculiar, but better too few than
1226 -- too many warnings in this situation.
1228 if Has_Pragma_Unreferenced_Objects (E1T)
1229 or else Has_Pragma_Unmodified_Check_Spec (E1)
1230 then
1231 null;
1233 -- IN OUT parameter case where parameter is referenced. We
1234 -- separate this out, since this is the case where we delay
1235 -- output of the warning until more information is available
1236 -- (about use in an instantiation or address being taken).
1238 elsif Ekind (E1) = E_In_Out_Parameter
1239 and then Referenced_Check_Spec (E1)
1240 then
1241 -- Suppress warning if private type, and the procedure
1242 -- has a separate declaration in a different unit. This
1243 -- is the case where the client of a package sees only
1244 -- the private type, and it may be quite reasonable
1245 -- for the logical view to be IN OUT, even if the
1246 -- implementation ends up using access types or some
1247 -- other method to achieve the local effect of a
1248 -- modification. On the other hand if the spec and body
1249 -- are in the same unit, we are in the package body and
1250 -- there we have less excuse for a junk IN OUT parameter.
1252 if Has_Private_Declaration (E1T)
1253 and then Present (Spec_Entity (E1))
1254 and then not In_Same_Source_Unit (E1, Spec_Entity (E1))
1255 then
1256 null;
1258 -- Suppress warning for any parameter of a dispatching
1259 -- operation, since it is quite reasonable to have an
1260 -- operation that is overridden, and for some subclasses
1261 -- needs the formal to be IN OUT and for others happens
1262 -- not to assign it.
1264 elsif Is_Dispatching_Operation
1265 (Scope (Goto_Spec_Entity (E1)))
1266 then
1267 null;
1269 -- Suppress warning if composite type contains any access
1270 -- component, since the logical effect of modifying a
1271 -- parameter may be achieved by modifying a referenced
1272 -- object.
1274 elsif Is_Composite_Type (E1T)
1275 and then Has_Access_Values (E1T)
1276 then
1277 null;
1279 -- Suppress warning on formals of an entry body. All
1280 -- references are attached to the formal in the entry
1281 -- declaration, which are marked Is_Entry_Formal.
1283 elsif Ekind (Scope (E1)) = E_Entry
1284 and then not Is_Entry_Formal (E1)
1285 then
1286 null;
1288 -- OK, looks like warning for an IN OUT parameter that
1289 -- could be IN makes sense, but we delay the output of
1290 -- the warning, pending possibly finding out later on
1291 -- that the associated subprogram is used as a generic
1292 -- actual, or its address/access is taken. In these two
1293 -- cases, we suppress the warning because the context may
1294 -- force use of IN OUT, even if in this particular case
1295 -- the formal is not modified.
1297 else
1298 -- Suppress the warnings for a junk name
1300 if not Has_Junk_Name (E1) then
1301 In_Out_Warnings.Append (E1);
1302 end if;
1303 end if;
1305 -- Other cases of formals
1307 elsif Is_Formal (E1) then
1308 if not Is_Trivial_Subprogram (Scope (E1)) then
1309 if Referenced_Check_Spec (E1) then
1310 if not Has_Pragma_Unmodified_Check_Spec (E1)
1311 and then not Warnings_Off_E1
1312 and then not Has_Junk_Name (E1)
1313 then
1314 Output_Reference_Error
1315 ("?f?formal parameter& is read but "
1316 & "never assigned!");
1317 end if;
1319 elsif not Has_Pragma_Unreferenced_Check_Spec (E1)
1320 and then not Warnings_Off_E1
1321 and then not Has_Junk_Name (E1)
1322 then
1323 Output_Reference_Error
1324 ("?f?formal parameter& is not referenced!");
1325 end if;
1326 end if;
1328 -- Case of variable
1330 else
1331 if Referenced (E1) then
1332 if not Has_Unmodified (E1)
1333 and then not Warnings_Off_E1
1334 and then not Has_Junk_Name (E1)
1335 then
1336 Output_Reference_Error
1337 ("?v?variable& is read but never assigned!");
1338 May_Need_Initialized_Actual (E1);
1339 end if;
1341 elsif not Has_Unreferenced (E1)
1342 and then not Warnings_Off_E1
1343 and then not Has_Junk_Name (E1)
1344 then
1345 Output_Reference_Error -- CODEFIX
1346 ("?v?variable& is never read and never assigned!");
1347 end if;
1349 -- Deal with special case where this variable is hidden
1350 -- by a loop variable.
1352 if Ekind (E1) = E_Variable
1353 and then Present (Hiding_Loop_Variable (E1))
1354 and then not Warnings_Off_E1
1355 then
1356 Error_Msg_N
1357 ("?v?for loop implicitly declares loop variable!",
1358 Hiding_Loop_Variable (E1));
1360 Error_Msg_Sloc := Sloc (E1);
1361 Error_Msg_N
1362 ("\?v?declaration hides & declared#!",
1363 Hiding_Loop_Variable (E1));
1364 end if;
1365 end if;
1367 goto Continue;
1368 end if;
1370 -- Check for unset reference
1372 if Warn_On_No_Value_Assigned and then Present (UR) then
1374 -- For other than access type, go back to original node to
1375 -- deal with case where original unset reference has been
1376 -- rewritten during expansion.
1378 -- In some cases, the original node may be a type conversion
1379 -- or qualification, and in this case we want the object
1380 -- entity inside.
1382 UR := Original_Node (UR);
1383 while Nkind (UR) = N_Type_Conversion
1384 or else Nkind (UR) = N_Qualified_Expression
1385 or else Nkind (UR) = N_Expression_With_Actions
1386 loop
1387 UR := Expression (UR);
1388 end loop;
1390 -- Don't issue warning if appearing inside Initial_Condition
1391 -- pragma or aspect, since that expression is not evaluated
1392 -- at the point where it occurs in the source.
1394 if In_Pragma_Expression (UR, Name_Initial_Condition) then
1395 goto Continue;
1396 end if;
1398 -- Here we issue the warning, all checks completed
1400 -- If we have a return statement, this was a case of an OUT
1401 -- parameter not being set at the time of the return. (Note:
1402 -- it can't be N_Extended_Return_Statement, because those
1403 -- are only for functions, and functions do not allow OUT
1404 -- parameters.)
1406 if not Is_Trivial_Subprogram (Scope (E1)) then
1407 if Nkind (UR) = N_Simple_Return_Statement
1408 and then not Has_Pragma_Unmodified_Check_Spec (E1)
1409 then
1410 if not Warnings_Off_E1
1411 and then not Has_Junk_Name (E1)
1412 then
1413 Error_Msg_NE
1414 ("?v?OUT parameter& not set before return",
1415 UR, E1);
1416 end if;
1418 -- If the unset reference is a selected component
1419 -- prefix from source, mention the component as well.
1420 -- If the selected component comes from expansion, all
1421 -- we know is that the entity is not fully initialized
1422 -- at the point of the reference. Locate a random
1423 -- uninitialized component to get a better message.
1425 elsif Nkind (Parent (UR)) = N_Selected_Component then
1426 Error_Msg_Node_2 := Selector_Name (Parent (UR));
1428 if not Comes_From_Source (Parent (UR)) then
1429 declare
1430 Comp : Entity_Id;
1432 begin
1433 Comp := First_Entity (E1T);
1434 while Present (Comp) loop
1435 if Ekind (Comp) = E_Component
1436 and then Nkind (Parent (Comp)) =
1437 N_Component_Declaration
1438 and then No (Expression (Parent (Comp)))
1439 then
1440 Error_Msg_Node_2 := Comp;
1441 exit;
1442 end if;
1444 Next_Entity (Comp);
1445 end loop;
1446 end;
1447 end if;
1449 -- Issue proper warning. This is a case of referencing
1450 -- a variable before it has been explicitly assigned.
1451 -- For access types, UR was only set for dereferences,
1452 -- so the issue is that the value may be null.
1454 if not Is_Trivial_Subprogram (Scope (E1)) then
1455 if not Warnings_Off_E1 then
1456 if Is_Access_Type (Etype (Parent (UR))) then
1457 Error_Msg_N ("??`&.&` may be null!", UR);
1458 else
1459 Error_Msg_N
1460 ("??`&.&` may be referenced before "
1461 & "it has a value!", UR);
1462 end if;
1463 end if;
1464 end if;
1466 -- All other cases of unset reference active
1468 elsif not Warnings_Off_E1 then
1469 Error_Msg_N
1470 ("??& may be referenced before it has a value!", UR);
1471 end if;
1472 end if;
1474 goto Continue;
1476 end if;
1477 end if;
1479 -- Then check for unreferenced entities. Note that we are only
1480 -- interested in entities whose Referenced flag is not set.
1482 if not Referenced_Check_Spec (E1)
1484 -- If Referenced_As_LHS is set, then that's still interesting
1485 -- (potential "assigned but never read" case), but not if we
1486 -- have pragma Unreferenced, which cancels this warning.
1488 and then (not Referenced_As_LHS_Check_Spec (E1)
1489 or else not Has_Unreferenced (E1))
1491 -- Check that warnings on unreferenced entities are enabled
1493 and then
1494 ((Check_Unreferenced and then not Is_Formal (E1))
1496 -- Case of warning on unreferenced formal
1498 or else (Check_Unreferenced_Formals and then Is_Formal (E1))
1500 -- Case of warning on unread variables modified by an
1501 -- assignment, or an OUT parameter if it is the only one.
1503 or else (Warn_On_Modified_Unread
1504 and then Referenced_As_LHS_Check_Spec (E1))
1506 -- Case of warning on any unread OUT parameter (note such
1507 -- indications are only set if the appropriate warning
1508 -- options were set, so no need to recheck here.)
1510 or else Referenced_As_Out_Parameter_Check_Spec (E1))
1512 -- All other entities, including local packages that cannot be
1513 -- referenced from elsewhere, including those declared within a
1514 -- package body.
1516 and then (Is_Object (E1)
1517 or else Is_Type (E1)
1518 or else Ekind (E1) = E_Label
1519 or else Ekind_In (E1, E_Exception,
1520 E_Named_Integer,
1521 E_Named_Real)
1522 or else Is_Overloadable (E1)
1524 -- Package case, if the main unit is a package spec
1525 -- or generic package spec, then there may be a
1526 -- corresponding body that references this package
1527 -- in some other file. Otherwise we can be sure
1528 -- that there is no other reference.
1530 or else
1531 (Ekind (E1) = E_Package
1532 and then
1533 not Is_Package_Or_Generic_Package
1534 (Cunit_Entity (Current_Sem_Unit))))
1536 -- Exclude instantiations, since there is no reason why every
1537 -- entity in an instantiation should be referenced.
1539 and then Instantiation_Location (Sloc (E1)) = No_Location
1541 -- Exclude formal parameters from bodies if the corresponding
1542 -- spec entity has been referenced in the case where there is
1543 -- a separate spec.
1545 and then not (Is_Formal (E1)
1546 and then Ekind (Scope (E1)) = E_Subprogram_Body
1547 and then Present (Spec_Entity (E1))
1548 and then Referenced (Spec_Entity (E1)))
1550 -- Consider private type referenced if full view is referenced.
1551 -- If there is not full view, this is a generic type on which
1552 -- warnings are also useful.
1554 and then
1555 not (Is_Private_Type (E1)
1556 and then Present (Full_View (E1))
1557 and then Referenced (Full_View (E1)))
1559 -- Don't worry about full view, only about private type
1561 and then not Has_Private_Declaration (E1)
1563 -- Eliminate dispatching operations from consideration, we
1564 -- cannot tell if these are referenced or not in any easy
1565 -- manner (note this also catches Adjust/Finalize/Initialize).
1567 and then not Is_Dispatching_Operation (E1)
1569 -- Check entity that can be publicly referenced (we do not give
1570 -- messages for such entities, since there could be other
1571 -- units, not involved in this compilation, that contain
1572 -- relevant references.
1574 and then not Publicly_Referenceable (E1)
1576 -- Class wide types are marked as source entities, but they are
1577 -- not really source entities, and are always created, so we do
1578 -- not care if they are not referenced.
1580 and then Ekind (E1) /= E_Class_Wide_Type
1582 -- Objects other than parameters of task types are allowed to
1583 -- be non-referenced, since they start up tasks.
1585 and then ((Ekind (E1) /= E_Variable
1586 and then Ekind (E1) /= E_Constant
1587 and then Ekind (E1) /= E_Component)
1588 or else not Is_Task_Type (E1T))
1590 -- For subunits, only place warnings on the main unit itself,
1591 -- since parent units are not completely compiled.
1593 and then (Nkind (Unit (Cunit (Main_Unit))) /= N_Subunit
1594 or else Get_Source_Unit (E1) = Main_Unit)
1596 -- No warning on a return object, because these are often
1597 -- created with a single expression and an implicit return.
1598 -- If the object is a variable there will be a warning
1599 -- indicating that it could be declared constant.
1601 and then not
1602 (Ekind (E1) = E_Constant and then Is_Return_Object (E1))
1603 then
1604 -- Suppress warnings in internal units if not in -gnatg mode
1605 -- (these would be junk warnings for an applications program,
1606 -- since they refer to problems in internal units).
1608 if GNAT_Mode
1609 or else not Is_Internal_File_Name
1610 (Unit_File_Name (Get_Source_Unit (E1)))
1611 then
1612 -- We do not immediately flag the error. This is because we
1613 -- have not expanded generic bodies yet, and they may have
1614 -- the missing reference. So instead we park the entity on a
1615 -- list, for later processing. However for the case of an
1616 -- accept statement we want to output messages now, since
1617 -- we know we already have all information at hand, and we
1618 -- also want to have separate warnings for each accept
1619 -- statement for the same entry.
1621 if Present (Anod) then
1622 pragma Assert (Is_Formal (E1));
1624 -- The unreferenced entity is E1, but post the warning
1625 -- on the body entity for this accept statement.
1627 if not Warnings_Off_E1 then
1628 Warn_On_Unreferenced_Entity
1629 (E1, Body_Formal (E1, Accept_Statement => Anod));
1630 end if;
1632 elsif not Warnings_Off_E1
1633 and then not Has_Junk_Name (E1)
1634 then
1635 Unreferenced_Entities.Append (E1);
1636 end if;
1637 end if;
1639 -- Generic units are referenced in the generic body, but if they
1640 -- are not public and never instantiated we want to force a
1641 -- warning on them. We treat them as redundant constructs to
1642 -- minimize noise.
1644 elsif Is_Generic_Subprogram (E1)
1645 and then not Is_Instantiated (E1)
1646 and then not Publicly_Referenceable (E1)
1647 and then Instantiation_Depth (Sloc (E1)) = 0
1648 and then Warn_On_Redundant_Constructs
1649 then
1650 if not Warnings_Off_E1 and then not Has_Junk_Name (E1) then
1651 Unreferenced_Entities.Append (E1);
1653 -- Force warning on entity
1655 Set_Referenced (E1, False);
1656 end if;
1657 end if;
1658 end if;
1660 -- Recurse into nested package or block. Do not recurse into a formal
1661 -- package, because the corresponding body is not analyzed.
1663 <<Continue>>
1664 if (Is_Package_Or_Generic_Package (E1)
1665 and then Nkind (Parent (E1)) = N_Package_Specification
1666 and then
1667 Nkind (Original_Node (Unit_Declaration_Node (E1))) /=
1668 N_Formal_Package_Declaration)
1670 or else Ekind (E1) = E_Block
1671 then
1672 Check_References (E1);
1673 end if;
1675 Next_Entity (E1);
1676 end loop;
1677 end Check_References;
1679 ---------------------------
1680 -- Check_Unset_Reference --
1681 ---------------------------
1683 procedure Check_Unset_Reference (N : Node_Id) is
1684 Typ : constant Entity_Id := Etype (N);
1686 function Is_OK_Fully_Initialized return Boolean;
1687 -- This function returns true if the given node N is fully initialized
1688 -- so that the reference is safe as far as this routine is concerned.
1689 -- Safe generally means that the type of N is a fully initialized type.
1690 -- The one special case is that for access types, which are always fully
1691 -- initialized, we don't consider a dereference OK since it will surely
1692 -- be dereferencing a null value, which won't do.
1694 function Prefix_Has_Dereference (Pref : Node_Id) return Boolean;
1695 -- Used to test indexed or selected component or slice to see if the
1696 -- evaluation of the prefix depends on a dereference, and if so, returns
1697 -- True, in which case we always check the prefix, even if we know that
1698 -- the referenced component is initialized. Pref is the prefix to test.
1700 -----------------------------
1701 -- Is_OK_Fully_Initialized --
1702 -----------------------------
1704 function Is_OK_Fully_Initialized return Boolean is
1705 begin
1706 if Is_Access_Type (Typ) and then Is_Dereferenced (N) then
1707 return False;
1709 -- If a type has Default_Initial_Condition set, or it inherits it,
1710 -- DIC might be specified with a boolean value, meaning that the type
1711 -- is considered to be fully default initialized (SPARK RM 3.1 and
1712 -- SPARK RM 7.3.3). To avoid generating spurious warnings in this
1713 -- case, consider all types with DIC as fully initialized.
1715 elsif Has_Default_Init_Cond (Typ)
1716 or else Has_Inherited_Default_Init_Cond (Typ)
1717 then
1718 return True;
1720 else
1721 return Is_Fully_Initialized_Type (Typ);
1722 end if;
1723 end Is_OK_Fully_Initialized;
1725 ----------------------------
1726 -- Prefix_Has_Dereference --
1727 ----------------------------
1729 function Prefix_Has_Dereference (Pref : Node_Id) return Boolean is
1730 begin
1731 -- If prefix is of an access type, it certainly needs a dereference
1733 if Is_Access_Type (Etype (Pref)) then
1734 return True;
1736 -- If prefix is explicit dereference, that's a dereference for sure
1738 elsif Nkind (Pref) = N_Explicit_Dereference then
1739 return True;
1741 -- If prefix is itself a component reference or slice check prefix
1743 elsif Nkind (Pref) = N_Slice
1744 or else Nkind (Pref) = N_Indexed_Component
1745 or else Nkind (Pref) = N_Selected_Component
1746 then
1747 return Prefix_Has_Dereference (Prefix (Pref));
1749 -- All other cases do not involve a dereference
1751 else
1752 return False;
1753 end if;
1754 end Prefix_Has_Dereference;
1756 -- Start of processing for Check_Unset_Reference
1758 begin
1759 -- Nothing to do if warnings suppressed
1761 if Warning_Mode = Suppress then
1762 return;
1763 end if;
1765 -- Nothing to do for numeric or string literal. Do this test early to
1766 -- save time in a common case (it does not matter that we do not include
1767 -- character literal here, since that will be caught later on in the
1768 -- when others branch of the case statement).
1770 if Nkind (N) in N_Numeric_Or_String_Literal then
1771 return;
1772 end if;
1774 -- Ignore reference unless it comes from source. Almost always if we
1775 -- have a reference from generated code, it is bogus (e.g. calls to init
1776 -- procs to set default discriminant values).
1778 if not Comes_From_Source (N) then
1779 return;
1780 end if;
1782 -- Otherwise see what kind of node we have. If the entity already has an
1783 -- unset reference, it is not necessarily the earliest in the text,
1784 -- because resolution of the prefix of selected components is completed
1785 -- before the resolution of the selected component itself. As a result,
1786 -- given (R /= null and then R.X > 0), the occurrences of R are examined
1787 -- in right-to-left order. If there is already an unset reference, we
1788 -- check whether N is earlier before proceeding.
1790 case Nkind (N) is
1792 -- For identifier or expanded name, examine the entity involved
1794 when N_Identifier | N_Expanded_Name =>
1795 declare
1796 E : constant Entity_Id := Entity (N);
1798 begin
1799 if Ekind_In (E, E_Variable, E_Out_Parameter)
1800 and then Never_Set_In_Source_Check_Spec (E)
1801 and then not Has_Initial_Value (E)
1802 and then (No (Unset_Reference (E))
1803 or else
1804 Earlier_In_Extended_Unit
1805 (Sloc (N), Sloc (Unset_Reference (E))))
1806 and then not Has_Pragma_Unmodified_Check_Spec (E)
1807 and then not Warnings_Off_Check_Spec (E)
1808 and then not Has_Junk_Name (E)
1809 then
1810 -- We may have an unset reference. The first test is whether
1811 -- this is an access to a discriminant of a record or a
1812 -- component with default initialization. Both of these
1813 -- cases can be ignored, since the actual object that is
1814 -- referenced is definitely initialized. Note that this
1815 -- covers the case of reading discriminants of an OUT
1816 -- parameter, which is OK even in Ada 83.
1818 -- Note that we are only interested in a direct reference to
1819 -- a record component here. If the reference is through an
1820 -- access type, then the access object is being referenced,
1821 -- not the record, and still deserves an unset reference.
1823 if Nkind (Parent (N)) = N_Selected_Component
1824 and not Is_Access_Type (Typ)
1825 then
1826 declare
1827 ES : constant Entity_Id :=
1828 Entity (Selector_Name (Parent (N)));
1829 begin
1830 if Ekind (ES) = E_Discriminant
1831 or else
1832 (Present (Declaration_Node (ES))
1833 and then
1834 Present (Expression (Declaration_Node (ES))))
1835 then
1836 return;
1837 end if;
1838 end;
1839 end if;
1841 -- Exclude fully initialized types
1843 if Is_OK_Fully_Initialized then
1844 return;
1845 end if;
1847 -- Here we have a potential unset reference. But before we
1848 -- get worried about it, we have to make sure that the
1849 -- entity declaration is in the same procedure as the
1850 -- reference, since if they are in separate procedures, then
1851 -- we have no idea about sequential execution.
1853 -- The tests in the loop below catch all such cases, but do
1854 -- allow the reference to appear in a loop, block, or
1855 -- package spec that is nested within the declaring scope.
1856 -- As always, it is possible to construct cases where the
1857 -- warning is wrong, that is why it is a warning.
1859 Potential_Unset_Reference : declare
1860 SR : Entity_Id;
1861 SE : constant Entity_Id := Scope (E);
1863 function Within_Postcondition return Boolean;
1864 -- Returns True if N is within a Postcondition, a
1865 -- Refined_Post, an Ensures component in a Test_Case,
1866 -- or a Contract_Cases.
1868 --------------------------
1869 -- Within_Postcondition --
1870 --------------------------
1872 function Within_Postcondition return Boolean is
1873 Nod, P : Node_Id;
1875 begin
1876 Nod := Parent (N);
1877 while Present (Nod) loop
1878 if Nkind (Nod) = N_Pragma
1879 and then Nam_In (Pragma_Name (Nod),
1880 Name_Postcondition,
1881 Name_Refined_Post,
1882 Name_Contract_Cases)
1883 then
1884 return True;
1886 elsif Present (Parent (Nod)) then
1887 P := Parent (Nod);
1889 if Nkind (P) = N_Pragma
1890 and then Pragma_Name (P) = Name_Test_Case
1891 and then Nod = Test_Case_Arg (P, Name_Ensures)
1892 then
1893 return True;
1894 end if;
1895 end if;
1897 Nod := Parent (Nod);
1898 end loop;
1900 return False;
1901 end Within_Postcondition;
1903 -- Start of processing for Potential_Unset_Reference
1905 begin
1906 SR := Current_Scope;
1907 while SR /= SE loop
1908 if SR = Standard_Standard
1909 or else Is_Subprogram (SR)
1910 or else Is_Concurrent_Body (SR)
1911 or else Is_Concurrent_Type (SR)
1912 then
1913 return;
1914 end if;
1916 SR := Scope (SR);
1917 end loop;
1919 -- Case of reference has an access type. This is a
1920 -- special case since access types are always set to null
1921 -- so cannot be truly uninitialized, but we still want to
1922 -- warn about cases of obvious null dereference.
1924 if Is_Access_Type (Typ) then
1925 Access_Type_Case : declare
1926 P : Node_Id;
1928 function Process
1929 (N : Node_Id) return Traverse_Result;
1930 -- Process function for instantiation of Traverse
1931 -- below. Checks if N contains reference to E other
1932 -- than a dereference.
1934 function Ref_In (Nod : Node_Id) return Boolean;
1935 -- Determines whether Nod contains a reference to
1936 -- the entity E that is not a dereference.
1938 -------------
1939 -- Process --
1940 -------------
1942 function Process
1943 (N : Node_Id) return Traverse_Result
1945 begin
1946 if Is_Entity_Name (N)
1947 and then Entity (N) = E
1948 and then not Is_Dereferenced (N)
1949 then
1950 return Abandon;
1951 else
1952 return OK;
1953 end if;
1954 end Process;
1956 ------------
1957 -- Ref_In --
1958 ------------
1960 function Ref_In (Nod : Node_Id) return Boolean is
1961 function Traverse is new Traverse_Func (Process);
1962 begin
1963 return Traverse (Nod) = Abandon;
1964 end Ref_In;
1966 -- Start of processing for Access_Type_Case
1968 begin
1969 -- Don't bother if we are inside an instance, since
1970 -- the compilation of the generic template is where
1971 -- the warning should be issued.
1973 if In_Instance then
1974 return;
1975 end if;
1977 -- Don't bother if this is not the main unit. If we
1978 -- try to give this warning for with'ed units, we
1979 -- get some false positives, since we do not record
1980 -- references in other units.
1982 if not In_Extended_Main_Source_Unit (E)
1983 or else
1984 not In_Extended_Main_Source_Unit (N)
1985 then
1986 return;
1987 end if;
1989 -- We are only interested in dereferences
1991 if not Is_Dereferenced (N) then
1992 return;
1993 end if;
1995 -- One more check, don't bother with references
1996 -- that are inside conditional statements or WHILE
1997 -- loops if the condition references the entity in
1998 -- question. This avoids most false positives.
2000 P := Parent (N);
2001 loop
2002 P := Parent (P);
2003 exit when No (P);
2005 if Nkind_In (P, N_If_Statement, N_Elsif_Part)
2006 and then Ref_In (Condition (P))
2007 then
2008 return;
2010 elsif Nkind (P) = N_Loop_Statement
2011 and then Present (Iteration_Scheme (P))
2012 and then
2013 Ref_In (Condition (Iteration_Scheme (P)))
2014 then
2015 return;
2016 end if;
2017 end loop;
2018 end Access_Type_Case;
2019 end if;
2021 -- One more check, don't bother if we are within a
2022 -- postcondition, since the expression occurs in a
2023 -- place unrelated to the actual test.
2025 if not Within_Postcondition then
2027 -- Here we definitely have a case for giving a warning
2028 -- for a reference to an unset value. But we don't
2029 -- give the warning now. Instead set Unset_Reference
2030 -- in the identifier involved. The reason for this is
2031 -- that if we find the variable is never ever assigned
2032 -- a value then that warning is more important and
2033 -- there is no point in giving the reference warning.
2035 -- If this is an identifier, set the field directly
2037 if Nkind (N) = N_Identifier then
2038 Set_Unset_Reference (E, N);
2040 -- Otherwise it is an expanded name, so set the field
2041 -- of the actual identifier for the reference.
2043 else
2044 Set_Unset_Reference (E, Selector_Name (N));
2045 end if;
2046 end if;
2047 end Potential_Unset_Reference;
2048 end if;
2049 end;
2051 -- Indexed component or slice
2053 when N_Indexed_Component | N_Slice =>
2055 -- If prefix does not involve dereferencing an access type, then
2056 -- we know we are OK if the component type is fully initialized,
2057 -- since the component will have been set as part of the default
2058 -- initialization.
2060 if not Prefix_Has_Dereference (Prefix (N))
2061 and then Is_OK_Fully_Initialized
2062 then
2063 return;
2065 -- Look at prefix in access type case, or if the component is not
2066 -- fully initialized.
2068 else
2069 Check_Unset_Reference (Prefix (N));
2070 end if;
2072 -- Record component
2074 when N_Selected_Component =>
2075 declare
2076 Pref : constant Node_Id := Prefix (N);
2077 Ent : constant Entity_Id := Entity (Selector_Name (N));
2079 begin
2080 -- If prefix involves dereferencing an access type, always
2081 -- check the prefix, since the issue then is whether this
2082 -- access value is null.
2084 if Prefix_Has_Dereference (Pref) then
2085 null;
2087 -- Always go to prefix if no selector entity is set. Can this
2088 -- happen in the normal case? Not clear, but it definitely can
2089 -- happen in error cases.
2091 elsif No (Ent) then
2092 null;
2094 -- For a record component, check some cases where we have
2095 -- reasonable cause to consider that the component is known to
2096 -- be or probably is initialized. In this case, we don't care
2097 -- if the prefix itself was explicitly initialized.
2099 -- Discriminants are always considered initialized
2101 elsif Ekind (Ent) = E_Discriminant then
2102 return;
2104 -- An explicitly initialized component is certainly initialized
2106 elsif Nkind (Parent (Ent)) = N_Component_Declaration
2107 and then Present (Expression (Parent (Ent)))
2108 then
2109 return;
2111 -- A fully initialized component is initialized
2113 elsif Is_OK_Fully_Initialized then
2114 return;
2115 end if;
2117 -- If none of those cases apply, check the record type prefix
2119 Check_Unset_Reference (Pref);
2120 end;
2122 -- For type conversions, qualifications, or expressions with actions,
2123 -- examine the expression.
2125 when N_Type_Conversion |
2126 N_Qualified_Expression |
2127 N_Expression_With_Actions =>
2128 Check_Unset_Reference (Expression (N));
2130 -- For explicit dereference, always check prefix, which will generate
2131 -- an unset reference (since this is a case of dereferencing null).
2133 when N_Explicit_Dereference =>
2134 Check_Unset_Reference (Prefix (N));
2136 -- All other cases are not cases of an unset reference
2138 when others =>
2139 null;
2141 end case;
2142 end Check_Unset_Reference;
2144 ------------------------
2145 -- Check_Unused_Withs --
2146 ------------------------
2148 procedure Check_Unused_Withs (Spec_Unit : Unit_Number_Type := No_Unit) is
2149 Cnode : Node_Id;
2150 Item : Node_Id;
2151 Lunit : Node_Id;
2152 Ent : Entity_Id;
2154 Munite : constant Entity_Id := Cunit_Entity (Main_Unit);
2155 -- This is needed for checking the special renaming case
2157 procedure Check_One_Unit (Unit : Unit_Number_Type);
2158 -- Subsidiary procedure, performs checks for specified unit
2160 --------------------
2161 -- Check_One_Unit --
2162 --------------------
2164 procedure Check_One_Unit (Unit : Unit_Number_Type) is
2165 Is_Visible_Renaming : Boolean := False;
2166 Pack : Entity_Id;
2168 procedure Check_Inner_Package (Pack : Entity_Id);
2169 -- Pack is a package local to a unit in a with_clause. Both the unit
2170 -- and Pack are referenced. If none of the entities in Pack are
2171 -- referenced, then the only occurrence of Pack is in a USE clause
2172 -- or a pragma, and a warning is worthwhile as well.
2174 function Check_System_Aux return Boolean;
2175 -- Before giving a warning on a with_clause for System, check whether
2176 -- a system extension is present.
2178 function Find_Package_Renaming
2179 (P : Entity_Id;
2180 L : Entity_Id) return Entity_Id;
2181 -- The only reference to a context unit may be in a renaming
2182 -- declaration. If this renaming declares a visible entity, do not
2183 -- warn that the context clause could be moved to the body, because
2184 -- the renaming may be intended to re-export the unit.
2186 function Has_Visible_Entities (P : Entity_Id) return Boolean;
2187 -- This function determines if a package has any visible entities.
2188 -- True is returned if there is at least one declared visible entity,
2189 -- otherwise False is returned (e.g. case of only pragmas present).
2191 -------------------------
2192 -- Check_Inner_Package --
2193 -------------------------
2195 procedure Check_Inner_Package (Pack : Entity_Id) is
2196 E : Entity_Id;
2197 Un : constant Node_Id := Sinfo.Unit (Cnode);
2199 function Check_Use_Clause (N : Node_Id) return Traverse_Result;
2200 -- If N is a use_clause for Pack, emit warning
2202 procedure Check_Use_Clauses is new
2203 Traverse_Proc (Check_Use_Clause);
2205 ----------------------
2206 -- Check_Use_Clause --
2207 ----------------------
2209 function Check_Use_Clause (N : Node_Id) return Traverse_Result is
2210 Nam : Node_Id;
2212 begin
2213 if Nkind (N) = N_Use_Package_Clause then
2214 Nam := First (Names (N));
2215 while Present (Nam) loop
2216 if Entity (Nam) = Pack then
2218 -- Suppress message if any serious errors detected
2219 -- that turn off expansion, and thus result in false
2220 -- positives for this warning.
2222 if Serious_Errors_Detected = 0 then
2223 Error_Msg_Qual_Level := 1;
2224 Error_Msg_NE -- CODEFIX
2225 ("?u?no entities of package& are referenced!",
2226 Nam, Pack);
2227 Error_Msg_Qual_Level := 0;
2228 end if;
2229 end if;
2231 Next (Nam);
2232 end loop;
2233 end if;
2235 return OK;
2236 end Check_Use_Clause;
2238 -- Start of processing for Check_Inner_Package
2240 begin
2241 E := First_Entity (Pack);
2242 while Present (E) loop
2243 if Referenced_Check_Spec (E) then
2244 return;
2245 end if;
2247 Next_Entity (E);
2248 end loop;
2250 -- No entities of the package are referenced. Check whether the
2251 -- reference to the package itself is a use clause, and if so
2252 -- place a warning on it.
2254 Check_Use_Clauses (Un);
2255 end Check_Inner_Package;
2257 ----------------------
2258 -- Check_System_Aux --
2259 ----------------------
2261 function Check_System_Aux return Boolean is
2262 Ent : Entity_Id;
2264 begin
2265 if Chars (Lunit) = Name_System
2266 and then Scope (Lunit) = Standard_Standard
2267 and then Present_System_Aux
2268 then
2269 Ent := First_Entity (System_Aux_Id);
2270 while Present (Ent) loop
2271 if Referenced_Check_Spec (Ent) then
2272 return True;
2273 end if;
2275 Next_Entity (Ent);
2276 end loop;
2277 end if;
2279 return False;
2280 end Check_System_Aux;
2282 ---------------------------
2283 -- Find_Package_Renaming --
2284 ---------------------------
2286 function Find_Package_Renaming
2287 (P : Entity_Id;
2288 L : Entity_Id) return Entity_Id
2290 E1 : Entity_Id;
2291 R : Entity_Id;
2293 begin
2294 Is_Visible_Renaming := False;
2296 E1 := First_Entity (P);
2297 while Present (E1) loop
2298 if Ekind (E1) = E_Package and then Renamed_Object (E1) = L then
2299 Is_Visible_Renaming := not Is_Hidden (E1);
2300 return E1;
2302 elsif Ekind (E1) = E_Package
2303 and then No (Renamed_Object (E1))
2304 and then not Is_Generic_Instance (E1)
2305 then
2306 R := Find_Package_Renaming (E1, L);
2308 if Present (R) then
2309 Is_Visible_Renaming := not Is_Hidden (R);
2310 return R;
2311 end if;
2312 end if;
2314 Next_Entity (E1);
2315 end loop;
2317 return Empty;
2318 end Find_Package_Renaming;
2320 --------------------------
2321 -- Has_Visible_Entities --
2322 --------------------------
2324 function Has_Visible_Entities (P : Entity_Id) return Boolean is
2325 E : Entity_Id;
2327 begin
2328 -- If unit in context is not a package, it is a subprogram that
2329 -- is not called or a generic unit that is not instantiated
2330 -- in the current unit, and warning is appropriate.
2332 if Ekind (P) /= E_Package then
2333 return True;
2334 end if;
2336 -- If unit comes from a limited_with clause, look for declaration
2337 -- of shadow entities.
2339 if Present (Limited_View (P)) then
2340 E := First_Entity (Limited_View (P));
2341 else
2342 E := First_Entity (P);
2343 end if;
2345 while Present (E) and then E /= First_Private_Entity (P) loop
2346 if Comes_From_Source (E) or else Present (Limited_View (P)) then
2347 return True;
2348 end if;
2350 Next_Entity (E);
2351 end loop;
2353 return False;
2354 end Has_Visible_Entities;
2356 -- Start of processing for Check_One_Unit
2358 begin
2359 Cnode := Cunit (Unit);
2361 -- Only do check in units that are part of the extended main unit.
2362 -- This is actually a necessary restriction, because in the case of
2363 -- subprogram acting as its own specification, there can be with's in
2364 -- subunits that we will not see.
2366 if not In_Extended_Main_Source_Unit (Cnode) then
2367 return;
2369 -- In configurable run time mode, we remove the bodies of non-inlined
2370 -- subprograms, which may lead to spurious warnings, which are
2371 -- clearly undesirable.
2373 elsif Configurable_Run_Time_Mode
2374 and then Is_Predefined_File_Name (Unit_File_Name (Unit))
2375 then
2376 return;
2377 end if;
2379 -- Loop through context items in this unit
2381 Item := First (Context_Items (Cnode));
2382 while Present (Item) loop
2383 if Nkind (Item) = N_With_Clause
2384 and then not Implicit_With (Item)
2385 and then In_Extended_Main_Source_Unit (Item)
2387 -- Guard for no entity present. Not clear under what conditions
2388 -- this happens, but it does occur, and since this is only a
2389 -- warning, we just suppress the warning in this case.
2391 and then Nkind (Name (Item)) in N_Has_Entity
2392 and then Present (Entity (Name (Item)))
2393 then
2394 Lunit := Entity (Name (Item));
2396 -- Check if this unit is referenced (skip the check if this
2397 -- is explicitly marked by a pragma Unreferenced).
2399 if not Referenced (Lunit) and then not Has_Unreferenced (Lunit)
2400 then
2401 -- Suppress warnings in internal units if not in -gnatg mode
2402 -- (these would be junk warnings for an application program,
2403 -- since they refer to problems in internal units).
2405 if GNAT_Mode
2406 or else not Is_Internal_File_Name (Unit_File_Name (Unit))
2407 then
2408 -- Here we definitely have a non-referenced unit. If it
2409 -- is the special call for a spec unit, then just set the
2410 -- flag to be read later.
2412 if Unit = Spec_Unit then
2413 Set_Unreferenced_In_Spec (Item);
2415 -- Otherwise simple unreferenced message, but skip this
2416 -- if no visible entities, because that is most likely a
2417 -- case where warning would be false positive (e.g. a
2418 -- package with only a linker options pragma and nothing
2419 -- else or a pragma elaborate with a body library task).
2421 elsif Has_Visible_Entities (Entity (Name (Item))) then
2422 Error_Msg_N -- CODEFIX
2423 ("?u?unit& is not referenced!", Name (Item));
2424 end if;
2425 end if;
2427 -- If main unit is a renaming of this unit, then we consider
2428 -- the with to be OK (obviously it is needed in this case).
2429 -- This may be transitive: the unit in the with_clause may
2430 -- itself be a renaming, in which case both it and the main
2431 -- unit rename the same ultimate package.
2433 elsif Present (Renamed_Entity (Munite))
2434 and then
2435 (Renamed_Entity (Munite) = Lunit
2436 or else Renamed_Entity (Munite) = Renamed_Entity (Lunit))
2437 then
2438 null;
2440 -- If this unit is referenced, and it is a package, we do
2441 -- another test, to see if any of the entities in the package
2442 -- are referenced. If none of the entities are referenced, we
2443 -- still post a warning. This occurs if the only use of the
2444 -- package is in a use clause, or in a package renaming
2445 -- declaration. This check is skipped for packages that are
2446 -- renamed in a spec, since the entities in such a package are
2447 -- visible to clients via the renaming.
2449 elsif Ekind (Lunit) = E_Package
2450 and then not Renamed_In_Spec (Lunit)
2451 then
2452 -- If Is_Instantiated is set, it means that the package is
2453 -- implicitly instantiated (this is the case of parent
2454 -- instance or an actual for a generic package formal), and
2455 -- this counts as a reference.
2457 if Is_Instantiated (Lunit) then
2458 null;
2460 -- If no entities in package, and there is a pragma
2461 -- Elaborate_Body present, then assume that this with is
2462 -- done for purposes of this elaboration.
2464 elsif No (First_Entity (Lunit))
2465 and then Has_Pragma_Elaborate_Body (Lunit)
2466 then
2467 null;
2469 -- Otherwise see if any entities have been referenced
2471 else
2472 if Limited_Present (Item) then
2473 Ent := First_Entity (Limited_View (Lunit));
2474 else
2475 Ent := First_Entity (Lunit);
2476 end if;
2478 loop
2479 -- No more entities, and we did not find one that was
2480 -- referenced. Means we have a definite case of a with
2481 -- none of whose entities was referenced.
2483 if No (Ent) then
2485 -- If in spec, just set the flag
2487 if Unit = Spec_Unit then
2488 Set_No_Entities_Ref_In_Spec (Item);
2490 elsif Check_System_Aux then
2491 null;
2493 -- Else the warning may be needed
2495 else
2496 declare
2497 Eitem : constant Entity_Id :=
2498 Entity (Name (Item));
2500 begin
2501 -- Warn if we unreferenced flag set and we
2502 -- have not had serious errors. The reason we
2503 -- inhibit the message if there are errors is
2504 -- to prevent false positives from disabling
2505 -- expansion.
2507 if not Has_Unreferenced (Eitem)
2508 and then Serious_Errors_Detected = 0
2509 then
2510 -- Get possible package renaming
2512 Pack :=
2513 Find_Package_Renaming (Munite, Lunit);
2515 -- No warning if either the package or its
2516 -- renaming is used as a generic actual.
2518 if Used_As_Generic_Actual (Eitem)
2519 or else
2520 (Present (Pack)
2521 and then
2522 Used_As_Generic_Actual (Pack))
2523 then
2524 exit;
2525 end if;
2527 -- Here we give the warning
2529 Error_Msg_N -- CODEFIX
2530 ("?u?no entities of & are referenced!",
2531 Name (Item));
2533 -- Flag renaming of package as well. If
2534 -- the original package has warnings off,
2535 -- we suppress the warning on the renaming
2536 -- as well.
2538 if Present (Pack)
2539 and then not Has_Warnings_Off (Lunit)
2540 and then not Has_Unreferenced (Pack)
2541 then
2542 Error_Msg_NE -- CODEFIX
2543 ("?u?no entities of& are referenced!",
2544 Unit_Declaration_Node (Pack), Pack);
2545 end if;
2546 end if;
2547 end;
2548 end if;
2550 exit;
2552 -- Case of entity being referenced. The reference may
2553 -- come from a limited_with_clause, in which case the
2554 -- limited view of the entity carries the flag.
2556 elsif Referenced_Check_Spec (Ent)
2557 or else Referenced_As_LHS_Check_Spec (Ent)
2558 or else Referenced_As_Out_Parameter_Check_Spec (Ent)
2559 or else
2560 (From_Limited_With (Ent)
2561 and then Is_Incomplete_Type (Ent)
2562 and then Present (Non_Limited_View (Ent))
2563 and then Referenced (Non_Limited_View (Ent)))
2564 then
2565 -- This means that the with is indeed fine, in that
2566 -- it is definitely needed somewhere, and we can
2567 -- quit worrying about this one...
2569 -- Except for one little detail: if either of the
2570 -- flags was set during spec processing, this is
2571 -- where we complain that the with could be moved
2572 -- from the spec. If the spec contains a visible
2573 -- renaming of the package, inhibit warning to move
2574 -- with_clause to body.
2576 if Ekind (Munite) = E_Package_Body then
2577 Pack :=
2578 Find_Package_Renaming
2579 (Spec_Entity (Munite), Lunit);
2580 else
2581 Pack := Empty;
2582 end if;
2584 -- If a renaming is present in the spec do not warn
2585 -- because the body or child unit may depend on it.
2587 if Present (Pack)
2588 and then Renamed_Entity (Pack) = Lunit
2589 then
2590 exit;
2592 elsif Unreferenced_In_Spec (Item) then
2593 Error_Msg_N -- CODEFIX
2594 ("?u?unit& is not referenced in spec!",
2595 Name (Item));
2597 elsif No_Entities_Ref_In_Spec (Item) then
2598 Error_Msg_N -- CODEFIX
2599 ("?u?no entities of & are referenced in spec!",
2600 Name (Item));
2602 else
2603 if Ekind (Ent) = E_Package then
2604 Check_Inner_Package (Ent);
2605 end if;
2607 exit;
2608 end if;
2610 if not Is_Visible_Renaming then
2611 Error_Msg_N -- CODEFIX
2612 ("\?u?with clause might be moved to body!",
2613 Name (Item));
2614 end if;
2616 exit;
2618 -- Move to next entity to continue search
2620 else
2621 Next_Entity (Ent);
2622 end if;
2623 end loop;
2624 end if;
2626 -- For a generic package, the only interesting kind of
2627 -- reference is an instantiation, since entities cannot be
2628 -- referenced directly.
2630 elsif Is_Generic_Unit (Lunit) then
2632 -- Unit was never instantiated, set flag for case of spec
2633 -- call, or give warning for normal call.
2635 if not Is_Instantiated (Lunit) then
2636 if Unit = Spec_Unit then
2637 Set_Unreferenced_In_Spec (Item);
2638 else
2639 Error_Msg_N -- CODEFIX
2640 ("?u?unit& is never instantiated!", Name (Item));
2641 end if;
2643 -- If unit was indeed instantiated, make sure that flag is
2644 -- not set showing it was uninstantiated in the spec, and if
2645 -- so, give warning.
2647 elsif Unreferenced_In_Spec (Item) then
2648 Error_Msg_N
2649 ("?u?unit& is not instantiated in spec!", Name (Item));
2650 Error_Msg_N -- CODEFIX
2651 ("\?u?with clause can be moved to body!", Name (Item));
2652 end if;
2653 end if;
2654 end if;
2656 Next (Item);
2657 end loop;
2658 end Check_One_Unit;
2660 -- Start of processing for Check_Unused_Withs
2662 begin
2663 -- Immediate return if no semantics or warning flag not set
2665 if not Opt.Check_Withs or else Operating_Mode = Check_Syntax then
2666 return;
2667 end if;
2669 Process_Deferred_References;
2671 -- Flag any unused with clauses. For a subunit, check only the units
2672 -- in its context, not those of the parent, which may be needed by other
2673 -- subunits. We will get the full warnings when we compile the parent,
2674 -- but the following is helpful when compiling a subunit by itself.
2676 if Nkind (Unit (Cunit (Main_Unit))) = N_Subunit then
2677 if Current_Sem_Unit = Main_Unit then
2678 Check_One_Unit (Main_Unit);
2679 end if;
2681 return;
2682 end if;
2684 -- Process specified units
2686 if Spec_Unit = No_Unit then
2688 -- For main call, check all units
2690 for Unit in Main_Unit .. Last_Unit loop
2691 Check_One_Unit (Unit);
2692 end loop;
2694 else
2695 -- For call for spec, check only the spec
2697 Check_One_Unit (Spec_Unit);
2698 end if;
2699 end Check_Unused_Withs;
2701 ---------------------------------
2702 -- Generic_Package_Spec_Entity --
2703 ---------------------------------
2705 function Generic_Package_Spec_Entity (E : Entity_Id) return Boolean is
2706 S : Entity_Id;
2708 begin
2709 if Is_Package_Body_Entity (E) then
2710 return False;
2712 else
2713 S := Scope (E);
2714 loop
2715 if S = Standard_Standard then
2716 return False;
2718 elsif Ekind (S) = E_Generic_Package then
2719 return True;
2721 elsif Ekind (S) = E_Package then
2722 S := Scope (S);
2724 else
2725 return False;
2726 end if;
2727 end loop;
2728 end if;
2729 end Generic_Package_Spec_Entity;
2731 ----------------------
2732 -- Goto_Spec_Entity --
2733 ----------------------
2735 function Goto_Spec_Entity (E : Entity_Id) return Entity_Id is
2736 begin
2737 if Is_Formal (E) and then Present (Spec_Entity (E)) then
2738 return Spec_Entity (E);
2739 else
2740 return E;
2741 end if;
2742 end Goto_Spec_Entity;
2744 -------------------
2745 -- Has_Junk_Name --
2746 -------------------
2748 function Has_Junk_Name (E : Entity_Id) return Boolean is
2749 function Match (S : String) return Boolean;
2750 -- Return true if substring S is found in Name_Buffer (1 .. Name_Len)
2752 -----------
2753 -- Match --
2754 -----------
2756 function Match (S : String) return Boolean is
2757 Slen1 : constant Integer := S'Length - 1;
2759 begin
2760 for J in 1 .. Name_Len - S'Length + 1 loop
2761 if Name_Buffer (J .. J + Slen1) = S then
2762 return True;
2763 end if;
2764 end loop;
2766 return False;
2767 end Match;
2769 -- Start of processing for Has_Junk_Name
2771 begin
2772 Get_Unqualified_Decoded_Name_String (Chars (E));
2774 return
2775 Match ("discard") or else
2776 Match ("dummy") or else
2777 Match ("ignore") or else
2778 Match ("junk") or else
2779 Match ("unused");
2780 end Has_Junk_Name;
2782 --------------------------------------
2783 -- Has_Pragma_Unmodified_Check_Spec --
2784 --------------------------------------
2786 function Has_Pragma_Unmodified_Check_Spec
2787 (E : Entity_Id) return Boolean
2789 begin
2790 if Is_Formal (E) and then Present (Spec_Entity (E)) then
2792 -- Note: use of OR instead of OR ELSE here is deliberate, we want
2793 -- to mess with Unmodified flags on both body and spec entities.
2795 return Has_Unmodified (E)
2797 Has_Unmodified (Spec_Entity (E));
2799 else
2800 return Has_Unmodified (E);
2801 end if;
2802 end Has_Pragma_Unmodified_Check_Spec;
2804 ----------------------------------------
2805 -- Has_Pragma_Unreferenced_Check_Spec --
2806 ----------------------------------------
2808 function Has_Pragma_Unreferenced_Check_Spec
2809 (E : Entity_Id) return Boolean
2811 begin
2812 if Is_Formal (E) and then Present (Spec_Entity (E)) then
2814 -- Note: use of OR here instead of OR ELSE is deliberate, we want
2815 -- to mess with flags on both entities.
2817 return Has_Unreferenced (E)
2819 Has_Unreferenced (Spec_Entity (E));
2821 else
2822 return Has_Unreferenced (E);
2823 end if;
2824 end Has_Pragma_Unreferenced_Check_Spec;
2826 ----------------
2827 -- Initialize --
2828 ----------------
2830 procedure Initialize is
2831 begin
2832 Warnings_Off_Pragmas.Init;
2833 Unreferenced_Entities.Init;
2834 In_Out_Warnings.Init;
2835 end Initialize;
2837 ------------------------------------
2838 -- Never_Set_In_Source_Check_Spec --
2839 ------------------------------------
2841 function Never_Set_In_Source_Check_Spec (E : Entity_Id) return Boolean is
2842 begin
2843 if Is_Formal (E) and then Present (Spec_Entity (E)) then
2844 return Never_Set_In_Source (E)
2845 and then
2846 Never_Set_In_Source (Spec_Entity (E));
2847 else
2848 return Never_Set_In_Source (E);
2849 end if;
2850 end Never_Set_In_Source_Check_Spec;
2852 -------------------------------------
2853 -- Operand_Has_Warnings_Suppressed --
2854 -------------------------------------
2856 function Operand_Has_Warnings_Suppressed (N : Node_Id) return Boolean is
2858 function Check_For_Warnings (N : Node_Id) return Traverse_Result;
2859 -- Function used to check one node to see if it is or was originally
2860 -- a reference to an entity for which Warnings are off. If so, Abandon
2861 -- is returned, otherwise OK_Orig is returned to continue the traversal
2862 -- of the original expression.
2864 function Traverse is new Traverse_Func (Check_For_Warnings);
2865 -- Function used to traverse tree looking for warnings
2867 ------------------------
2868 -- Check_For_Warnings --
2869 ------------------------
2871 function Check_For_Warnings (N : Node_Id) return Traverse_Result is
2872 R : constant Node_Id := Original_Node (N);
2874 begin
2875 if Nkind (R) in N_Has_Entity
2876 and then Present (Entity (R))
2877 and then Has_Warnings_Off (Entity (R))
2878 then
2879 return Abandon;
2880 else
2881 return OK_Orig;
2882 end if;
2883 end Check_For_Warnings;
2885 -- Start of processing for Operand_Has_Warnings_Suppressed
2887 begin
2888 return Traverse (N) = Abandon;
2890 -- If any exception occurs, then something has gone wrong, and this is
2891 -- only a minor aesthetic issue anyway, so just say we did not find what
2892 -- we are looking for, rather than blow up.
2894 exception
2895 when others =>
2896 return False;
2897 end Operand_Has_Warnings_Suppressed;
2899 -----------------------------------------
2900 -- Output_Non_Modified_In_Out_Warnings --
2901 -----------------------------------------
2903 procedure Output_Non_Modified_In_Out_Warnings is
2905 function No_Warn_On_In_Out (E : Entity_Id) return Boolean;
2906 -- Given a formal parameter entity E, determines if there is a reason to
2907 -- suppress IN OUT warnings (not modified, could be IN) for formals of
2908 -- the subprogram. We suppress these warnings if Warnings Off is set, or
2909 -- if we have seen the address of the subprogram being taken, or if the
2910 -- subprogram is used as a generic actual (in the latter cases the
2911 -- context may force use of IN OUT, even if the parameter is not
2912 -- modifies for this particular case.
2914 -----------------------
2915 -- No_Warn_On_In_Out --
2916 -----------------------
2918 function No_Warn_On_In_Out (E : Entity_Id) return Boolean is
2919 S : constant Entity_Id := Scope (E);
2920 SE : constant Entity_Id := Spec_Entity (E);
2922 begin
2923 -- Do not warn if address is taken, since funny business may be going
2924 -- on in treating the parameter indirectly as IN OUT.
2926 if Address_Taken (S)
2927 or else (Present (SE) and then Address_Taken (Scope (SE)))
2928 then
2929 return True;
2931 -- Do not warn if used as a generic actual, since the generic may be
2932 -- what is forcing the use of an "unnecessary" IN OUT.
2934 elsif Used_As_Generic_Actual (S)
2935 or else (Present (SE) and then Used_As_Generic_Actual (Scope (SE)))
2936 then
2937 return True;
2939 -- Else test warnings off
2941 elsif Warnings_Off_Check_Spec (S) then
2942 return True;
2944 -- All tests for suppressing warning failed
2946 else
2947 return False;
2948 end if;
2949 end No_Warn_On_In_Out;
2951 -- Start of processing for Output_Non_Modified_In_Out_Warnings
2953 begin
2954 -- Loop through entities for which a warning may be needed
2956 for J in In_Out_Warnings.First .. In_Out_Warnings.Last loop
2957 declare
2958 E1 : constant Entity_Id := In_Out_Warnings.Table (J);
2960 begin
2961 -- Suppress warning in specific cases (see details in comments for
2962 -- No_Warn_On_In_Out), or if there is a pragma Unmodified.
2964 if Has_Pragma_Unmodified_Check_Spec (E1)
2965 or else No_Warn_On_In_Out (E1)
2966 then
2967 null;
2969 -- Here we generate the warning
2971 else
2972 -- If -gnatwc is set then output message that we could be IN
2974 if not Is_Trivial_Subprogram (Scope (E1)) then
2975 if Warn_On_Constant then
2976 Error_Msg_N
2977 ("?u?formal parameter & is not modified!", E1);
2978 Error_Msg_N
2979 ("\?u?mode could be IN instead of `IN OUT`!", E1);
2981 -- We do not generate warnings for IN OUT parameters
2982 -- unless we have at least -gnatwu. This is deliberately
2983 -- inconsistent with the treatment of variables, but
2984 -- otherwise we get too many unexpected warnings in
2985 -- default mode.
2987 elsif Check_Unreferenced then
2988 Error_Msg_N
2989 ("?u?formal parameter& is read but "
2990 & "never assigned!", E1);
2991 end if;
2992 end if;
2994 -- Kill any other warnings on this entity, since this is the
2995 -- one that should dominate any other unreferenced warning.
2997 Set_Warnings_Off (E1);
2998 end if;
2999 end;
3000 end loop;
3001 end Output_Non_Modified_In_Out_Warnings;
3003 ----------------------------------------
3004 -- Output_Obsolescent_Entity_Warnings --
3005 ----------------------------------------
3007 procedure Output_Obsolescent_Entity_Warnings (N : Node_Id; E : Entity_Id) is
3008 P : constant Node_Id := Parent (N);
3009 S : Entity_Id;
3011 begin
3012 S := Current_Scope;
3014 -- Do not output message if we are the scope of standard. This means
3015 -- we have a reference from a context clause from when it is originally
3016 -- processed, and that's too early to tell whether it is an obsolescent
3017 -- unit doing the with'ing. In Sem_Ch10.Analyze_Compilation_Unit we make
3018 -- sure that we have a later call when the scope is available. This test
3019 -- also eliminates all messages for use clauses, which is fine (we do
3020 -- not want messages for use clauses, since they are always redundant
3021 -- with respect to the associated with clause).
3023 if S = Standard_Standard then
3024 return;
3025 end if;
3027 -- Do not output message if we are in scope of an obsolescent package
3028 -- or subprogram.
3030 loop
3031 if Is_Obsolescent (S) then
3032 return;
3033 end if;
3035 S := Scope (S);
3036 exit when S = Standard_Standard;
3037 end loop;
3039 -- Here we will output the message
3041 Error_Msg_Sloc := Sloc (E);
3043 -- Case of with clause
3045 if Nkind (P) = N_With_Clause then
3046 if Ekind (E) = E_Package then
3047 Error_Msg_NE
3048 ("?j?with of obsolescent package& declared#", N, E);
3049 elsif Ekind (E) = E_Procedure then
3050 Error_Msg_NE
3051 ("?j?with of obsolescent procedure& declared#", N, E);
3052 else
3053 Error_Msg_NE
3054 ("??with of obsolescent function& declared#", N, E);
3055 end if;
3057 -- If we do not have a with clause, then ignore any reference to an
3058 -- obsolescent package name. We only want to give the one warning of
3059 -- withing the package, not one each time it is used to qualify.
3061 elsif Ekind (E) = E_Package then
3062 return;
3064 -- Procedure call statement
3066 elsif Nkind (P) = N_Procedure_Call_Statement then
3067 Error_Msg_NE
3068 ("??call to obsolescent procedure& declared#", N, E);
3070 -- Function call
3072 elsif Nkind (P) = N_Function_Call then
3073 Error_Msg_NE
3074 ("??call to obsolescent function& declared#", N, E);
3076 -- Reference to obsolescent type
3078 elsif Is_Type (E) then
3079 Error_Msg_NE
3080 ("??reference to obsolescent type& declared#", N, E);
3082 -- Reference to obsolescent component
3084 elsif Ekind_In (E, E_Component, E_Discriminant) then
3085 Error_Msg_NE
3086 ("??reference to obsolescent component& declared#", N, E);
3088 -- Reference to obsolescent variable
3090 elsif Ekind (E) = E_Variable then
3091 Error_Msg_NE
3092 ("??reference to obsolescent variable& declared#", N, E);
3094 -- Reference to obsolescent constant
3096 elsif Ekind (E) = E_Constant or else Ekind (E) in Named_Kind then
3097 Error_Msg_NE
3098 ("??reference to obsolescent constant& declared#", N, E);
3100 -- Reference to obsolescent enumeration literal
3102 elsif Ekind (E) = E_Enumeration_Literal then
3103 Error_Msg_NE
3104 ("??reference to obsolescent enumeration literal& declared#", N, E);
3106 -- Generic message for any other case we missed
3108 else
3109 Error_Msg_NE
3110 ("??reference to obsolescent entity& declared#", N, E);
3111 end if;
3113 -- Output additional warning if present
3115 for J in Obsolescent_Warnings.First .. Obsolescent_Warnings.Last loop
3116 if Obsolescent_Warnings.Table (J).Ent = E then
3117 String_To_Name_Buffer (Obsolescent_Warnings.Table (J).Msg);
3118 Error_Msg_Strlen := Name_Len;
3119 Error_Msg_String (1 .. Name_Len) := Name_Buffer (1 .. Name_Len);
3120 Error_Msg_N ("\\??~", N);
3121 exit;
3122 end if;
3123 end loop;
3124 end Output_Obsolescent_Entity_Warnings;
3126 ----------------------------------
3127 -- Output_Unreferenced_Messages --
3128 ----------------------------------
3130 procedure Output_Unreferenced_Messages is
3131 begin
3132 for J in Unreferenced_Entities.First .. Unreferenced_Entities.Last loop
3133 Warn_On_Unreferenced_Entity (Unreferenced_Entities.Table (J));
3134 end loop;
3135 end Output_Unreferenced_Messages;
3137 -----------------------------------------
3138 -- Output_Unused_Warnings_Off_Warnings --
3139 -----------------------------------------
3141 procedure Output_Unused_Warnings_Off_Warnings is
3142 begin
3143 for J in Warnings_Off_Pragmas.First .. Warnings_Off_Pragmas.Last loop
3144 declare
3145 Wentry : Warnings_Off_Entry renames Warnings_Off_Pragmas.Table (J);
3146 N : Node_Id renames Wentry.N;
3147 E : Node_Id renames Wentry.E;
3149 begin
3150 -- Turn off Warnings_Off, or we won't get the warning
3152 Set_Warnings_Off (E, False);
3154 -- Nothing to do if pragma was used to suppress a general warning
3156 if Warnings_Off_Used (E) then
3157 null;
3159 -- If pragma was used both in unmodified and unreferenced contexts
3160 -- then that's as good as the general case, no warning.
3162 elsif Warnings_Off_Used_Unmodified (E)
3164 Warnings_Off_Used_Unreferenced (E)
3165 then
3166 null;
3168 -- Used only in context where Unmodified would have worked
3170 elsif Warnings_Off_Used_Unmodified (E) then
3171 Error_Msg_NE
3172 ("?W?could use Unmodified instead of "
3173 & "Warnings Off for &", Pragma_Identifier (N), E);
3175 -- Used only in context where Unreferenced would have worked
3177 elsif Warnings_Off_Used_Unreferenced (E) then
3178 Error_Msg_NE
3179 ("?W?could use Unreferenced instead of "
3180 & "Warnings Off for &", Pragma_Identifier (N), E);
3182 -- Not used at all
3184 else
3185 Error_Msg_NE
3186 ("?W?pragma Warnings Off for & unused, "
3187 & "could be omitted", N, E);
3188 end if;
3189 end;
3190 end loop;
3191 end Output_Unused_Warnings_Off_Warnings;
3193 ---------------------------
3194 -- Referenced_Check_Spec --
3195 ---------------------------
3197 function Referenced_Check_Spec (E : Entity_Id) return Boolean is
3198 begin
3199 if Is_Formal (E) and then Present (Spec_Entity (E)) then
3200 return Referenced (E) or else Referenced (Spec_Entity (E));
3201 else
3202 return Referenced (E);
3203 end if;
3204 end Referenced_Check_Spec;
3206 ----------------------------------
3207 -- Referenced_As_LHS_Check_Spec --
3208 ----------------------------------
3210 function Referenced_As_LHS_Check_Spec (E : Entity_Id) return Boolean is
3211 begin
3212 if Is_Formal (E) and then Present (Spec_Entity (E)) then
3213 return Referenced_As_LHS (E)
3214 or else Referenced_As_LHS (Spec_Entity (E));
3215 else
3216 return Referenced_As_LHS (E);
3217 end if;
3218 end Referenced_As_LHS_Check_Spec;
3220 --------------------------------------------
3221 -- Referenced_As_Out_Parameter_Check_Spec --
3222 --------------------------------------------
3224 function Referenced_As_Out_Parameter_Check_Spec
3225 (E : Entity_Id) return Boolean
3227 begin
3228 if Is_Formal (E) and then Present (Spec_Entity (E)) then
3229 return Referenced_As_Out_Parameter (E)
3230 or else Referenced_As_Out_Parameter (Spec_Entity (E));
3231 else
3232 return Referenced_As_Out_Parameter (E);
3233 end if;
3234 end Referenced_As_Out_Parameter_Check_Spec;
3236 -----------------------------
3237 -- Warn_On_Known_Condition --
3238 -----------------------------
3240 procedure Warn_On_Known_Condition (C : Node_Id) is
3241 P : Node_Id;
3242 Orig : constant Node_Id := Original_Node (C);
3243 Test_Result : Boolean;
3245 function Is_Known_Branch return Boolean;
3246 -- If the type of the condition is Boolean, the constant value of the
3247 -- condition is a boolean literal. If the type is a derived boolean
3248 -- type, the constant is wrapped in a type conversion of the derived
3249 -- literal. If the value of the condition is not a literal, no warnings
3250 -- can be produced. This function returns True if the result can be
3251 -- determined, and Test_Result is set True/False accordingly. Otherwise
3252 -- False is returned, and Test_Result is unchanged.
3254 procedure Track (N : Node_Id; Loc : Node_Id);
3255 -- Adds continuation warning(s) pointing to reason (assignment or test)
3256 -- for the operand of the conditional having a known value (or at least
3257 -- enough is known about the value to issue the warning). N is the node
3258 -- which is judged to have a known value. Loc is the warning location.
3260 ---------------------
3261 -- Is_Known_Branch --
3262 ---------------------
3264 function Is_Known_Branch return Boolean is
3265 begin
3266 if Etype (C) = Standard_Boolean
3267 and then Is_Entity_Name (C)
3268 and then
3269 (Entity (C) = Standard_False or else Entity (C) = Standard_True)
3270 then
3271 Test_Result := Entity (C) = Standard_True;
3272 return True;
3274 elsif Is_Boolean_Type (Etype (C))
3275 and then Nkind (C) = N_Unchecked_Type_Conversion
3276 and then Is_Entity_Name (Expression (C))
3277 and then Ekind (Entity (Expression (C))) = E_Enumeration_Literal
3278 then
3279 Test_Result :=
3280 Chars (Entity (Expression (C))) = Chars (Standard_True);
3281 return True;
3283 else
3284 return False;
3285 end if;
3286 end Is_Known_Branch;
3288 -----------
3289 -- Track --
3290 -----------
3292 procedure Track (N : Node_Id; Loc : Node_Id) is
3293 Nod : constant Node_Id := Original_Node (N);
3295 begin
3296 if Nkind (Nod) in N_Op_Compare then
3297 Track (Left_Opnd (Nod), Loc);
3298 Track (Right_Opnd (Nod), Loc);
3300 elsif Is_Entity_Name (Nod) and then Is_Object (Entity (Nod)) then
3301 declare
3302 CV : constant Node_Id := Current_Value (Entity (Nod));
3304 begin
3305 if Present (CV) then
3306 Error_Msg_Sloc := Sloc (CV);
3308 if Nkind (CV) not in N_Subexpr then
3309 Error_Msg_N ("\\??(see test #)", Loc);
3311 elsif Nkind (Parent (CV)) =
3312 N_Case_Statement_Alternative
3313 then
3314 Error_Msg_N ("\\??(see case alternative #)", Loc);
3316 else
3317 Error_Msg_N ("\\??(see assignment #)", Loc);
3318 end if;
3319 end if;
3320 end;
3321 end if;
3322 end Track;
3324 -- Start of processing for Warn_On_Known_Condition
3326 begin
3327 -- Adjust SCO condition if from source
3329 if Generate_SCO
3330 and then Comes_From_Source (Orig)
3331 and then Is_Known_Branch
3332 then
3333 declare
3334 Atrue : Boolean;
3336 begin
3337 Atrue := Test_Result;
3339 if Present (Parent (C)) and then Nkind (Parent (C)) = N_Op_Not then
3340 Atrue := not Atrue;
3341 end if;
3343 Set_SCO_Condition (Orig, Atrue);
3344 end;
3345 end if;
3347 -- Argument replacement in an inlined body can make conditions static.
3348 -- Do not emit warnings in this case.
3350 if In_Inlined_Body then
3351 return;
3352 end if;
3354 if Constant_Condition_Warnings
3355 and then Is_Known_Branch
3356 and then Comes_From_Source (Orig)
3357 and then not In_Instance
3358 then
3359 -- Don't warn if comparison of result of attribute against a constant
3360 -- value, since this is likely legitimate conditional compilation.
3362 if Nkind (Orig) in N_Op_Compare
3363 and then Compile_Time_Known_Value (Right_Opnd (Orig))
3364 and then Nkind (Original_Node (Left_Opnd (Orig))) =
3365 N_Attribute_Reference
3366 then
3367 return;
3368 end if;
3370 -- See if this is in a statement or a declaration
3372 P := Parent (C);
3373 loop
3374 -- If tree is not attached, do not issue warning (this is very
3375 -- peculiar, and probably arises from some other error condition).
3377 if No (P) then
3378 return;
3380 -- If we are in a declaration, then no warning, since in practice
3381 -- conditionals in declarations are used for intended tests which
3382 -- may be known at compile time, e.g. things like
3384 -- x : constant Integer := 2 + (Word'Size = 32);
3386 -- And a warning is annoying in such cases
3388 elsif Nkind (P) in N_Declaration
3389 or else
3390 Nkind (P) in N_Later_Decl_Item
3391 then
3392 return;
3394 -- Don't warn in assert or check pragma, since presumably tests in
3395 -- such a context are very definitely intended, and might well be
3396 -- known at compile time. Note that we have to test the original
3397 -- node, since assert pragmas get rewritten at analysis time.
3399 elsif Nkind (Original_Node (P)) = N_Pragma
3400 and then Nam_In (Pragma_Name (Original_Node (P)), Name_Assert,
3401 Name_Check)
3402 then
3403 return;
3404 end if;
3406 exit when Is_Statement (P);
3407 P := Parent (P);
3408 end loop;
3410 -- Here we issue the warning unless some sub-operand has warnings
3411 -- set off, in which case we suppress the warning for the node. If
3412 -- the original expression is an inequality, it has been expanded
3413 -- into a negation, and the value of the original expression is the
3414 -- negation of the equality. If the expression is an entity that
3415 -- appears within a negation, it is clearer to flag the negation
3416 -- itself, and report on its constant value.
3418 if not Operand_Has_Warnings_Suppressed (C) then
3419 declare
3420 True_Branch : Boolean := Test_Result;
3421 Cond : Node_Id := C;
3423 begin
3424 if Present (Parent (C))
3425 and then Nkind (Parent (C)) = N_Op_Not
3426 then
3427 True_Branch := not True_Branch;
3428 Cond := Parent (C);
3429 end if;
3431 -- Condition always True
3433 if True_Branch then
3434 if Is_Entity_Name (Original_Node (C))
3435 and then Nkind (Cond) /= N_Op_Not
3436 then
3437 Error_Msg_NE
3438 ("object & is always True at this point?c?",
3439 Cond, Original_Node (C));
3440 Track (Original_Node (C), Cond);
3442 else
3443 Error_Msg_N ("condition is always True?c?", Cond);
3444 Track (Cond, Cond);
3445 end if;
3447 -- Condition always False
3449 else
3450 if Is_Entity_Name (Original_Node (C))
3451 and then Nkind (Cond) /= N_Op_Not
3452 then
3453 Error_Msg_NE
3454 ("object & is always False at this point?c?",
3455 Cond, Original_Node (C));
3456 Track (Original_Node (C), Cond);
3458 else
3459 Error_Msg_N ("condition is always False?c?", Cond);
3460 Track (Cond, Cond);
3461 end if;
3462 end if;
3463 end;
3464 end if;
3465 end if;
3466 end Warn_On_Known_Condition;
3468 ---------------------------------------
3469 -- Warn_On_Modified_As_Out_Parameter --
3470 ---------------------------------------
3472 function Warn_On_Modified_As_Out_Parameter (E : Entity_Id) return Boolean is
3473 begin
3474 return
3475 (Warn_On_Modified_Unread and then Is_Only_Out_Parameter (E))
3476 or else Warn_On_All_Unread_Out_Parameters;
3477 end Warn_On_Modified_As_Out_Parameter;
3479 ---------------------------------
3480 -- Warn_On_Overlapping_Actuals --
3481 ---------------------------------
3483 procedure Warn_On_Overlapping_Actuals (Subp : Entity_Id; N : Node_Id) is
3484 Act1, Act2 : Node_Id;
3485 Form1, Form2 : Entity_Id;
3487 function Is_Covered_Formal (Formal : Node_Id) return Boolean;
3488 -- Return True if Formal is covered by the rule
3490 function Refer_Same_Object (Act1, Act2 : Node_Id) return Boolean;
3491 -- Two names are known to refer to the same object if the two names
3492 -- are known to denote the same object; or one of the names is a
3493 -- selected_component, indexed_component, or slice and its prefix is
3494 -- known to refer to the same object as the other name; or one of the
3495 -- two names statically denotes a renaming declaration whose renamed
3496 -- object_name is known to refer to the same object as the other name
3497 -- (RM 6.4.1(6.11/3))
3499 -----------------------
3500 -- Refer_Same_Object --
3501 -----------------------
3503 function Refer_Same_Object (Act1, Act2 : Node_Id) return Boolean is
3504 begin
3505 return Denotes_Same_Object (Act1, Act2)
3506 or else Denotes_Same_Prefix (Act1, Act2);
3507 end Refer_Same_Object;
3509 -----------------------
3510 -- Is_Covered_Formal --
3511 -----------------------
3513 function Is_Covered_Formal (Formal : Node_Id) return Boolean is
3514 begin
3515 return
3516 Ekind_In (Formal, E_Out_Parameter, E_In_Out_Parameter)
3517 and then (Is_Elementary_Type (Etype (Formal))
3518 or else Is_Record_Type (Etype (Formal))
3519 or else Is_Array_Type (Etype (Formal)));
3520 end Is_Covered_Formal;
3522 begin
3523 if Ada_Version < Ada_2012 and then not Warn_On_Overlap then
3524 return;
3525 end if;
3527 -- Exclude calls rewritten as enumeration literals
3529 if Nkind (N) not in N_Subprogram_Call
3530 and then Nkind (N) /= N_Entry_Call_Statement
3531 then
3532 return;
3533 end if;
3535 -- If a call C has two or more parameters of mode in out or out that are
3536 -- of an elementary type, then the call is legal only if for each name
3537 -- N that is passed as a parameter of mode in out or out to the call C,
3538 -- there is no other name among the other parameters of mode in out or
3539 -- out to C that is known to denote the same object (RM 6.4.1(6.15/3))
3541 -- If appropriate warning switch is set, we also report warnings on
3542 -- overlapping parameters that are record types or array types.
3544 Form1 := First_Formal (Subp);
3545 Act1 := First_Actual (N);
3546 while Present (Form1) and then Present (Act1) loop
3547 if Is_Covered_Formal (Form1) then
3548 Form2 := First_Formal (Subp);
3549 Act2 := First_Actual (N);
3550 while Present (Form2) and then Present (Act2) loop
3551 if Form1 /= Form2
3552 and then Is_Covered_Formal (Form2)
3553 and then Refer_Same_Object (Act1, Act2)
3554 then
3555 -- Guard against previous errors
3557 if Error_Posted (N)
3558 or else No (Etype (Act1))
3559 or else No (Etype (Act2))
3560 then
3561 null;
3563 -- If the actual is a function call in prefix notation,
3564 -- there is no real overlap.
3566 elsif Nkind (Act2) = N_Function_Call then
3567 null;
3569 -- If type is not by-copy, assume that aliasing is intended
3571 elsif
3572 Present (Underlying_Type (Etype (Form1)))
3573 and then
3574 (Is_By_Reference_Type (Underlying_Type (Etype (Form1)))
3575 or else
3576 Convention (Underlying_Type (Etype (Form1))) =
3577 Convention_Ada_Pass_By_Reference)
3578 then
3579 null;
3581 -- Under Ada 2012 we only report warnings on overlapping
3582 -- arrays and record types if switch is set.
3584 elsif Ada_Version >= Ada_2012
3585 and then not Is_Elementary_Type (Etype (Form1))
3586 and then not Warn_On_Overlap
3587 then
3588 null;
3590 -- Here we may need to issue overlap message
3592 else
3593 Error_Msg_Warn :=
3595 -- Overlap checking is an error only in Ada 2012. For
3596 -- earlier versions of Ada, this is a warning.
3598 Ada_Version < Ada_2012
3600 -- Overlap is only illegal in Ada 2012 in the case of
3601 -- elementary types (passed by copy). For other types,
3602 -- we always have a warning in all Ada versions.
3604 or else not Is_Elementary_Type (Etype (Form1))
3606 -- Finally, debug flag -gnatd.E changes the error to a
3607 -- warning even in Ada 2012 mode.
3609 or else Error_To_Warning;
3611 declare
3612 Act : Node_Id;
3613 Form : Entity_Id;
3615 begin
3616 -- Find matching actual
3618 Act := First_Actual (N);
3619 Form := First_Formal (Subp);
3620 while Act /= Act2 loop
3621 Next_Formal (Form);
3622 Next_Actual (Act);
3623 end loop;
3625 if Is_Elementary_Type (Etype (Act1))
3626 and then Ekind (Form2) = E_In_Parameter
3627 then
3628 null; -- No real aliasing
3630 elsif Is_Elementary_Type (Etype (Act2))
3631 and then Ekind (Form2) = E_In_Parameter
3632 then
3633 null; -- Ditto
3635 -- If the call was written in prefix notation, and
3636 -- thus its prefix before rewriting was a selected
3637 -- component, count only visible actuals in the call.
3639 elsif Is_Entity_Name (First_Actual (N))
3640 and then Nkind (Original_Node (N)) = Nkind (N)
3641 and then Nkind (Name (Original_Node (N))) =
3642 N_Selected_Component
3643 and then
3644 Is_Entity_Name (Prefix (Name (Original_Node (N))))
3645 and then
3646 Entity (Prefix (Name (Original_Node (N)))) =
3647 Entity (First_Actual (N))
3648 then
3649 if Act1 = First_Actual (N) then
3650 Error_Msg_FE
3651 ("<<`IN OUT` prefix overlaps with "
3652 & "actual for&", Act1, Form);
3654 else
3655 -- For greater clarity, give name of formal
3657 Error_Msg_Node_2 := Form;
3658 Error_Msg_FE
3659 ("<<writable actual for & overlaps with "
3660 & "actual for&", Act1, Form);
3661 end if;
3663 else
3664 -- For greater clarity, give name of formal
3666 Error_Msg_Node_2 := Form;
3668 -- This is one of the messages
3670 Error_Msg_FE
3671 ("<<writable actual for & overlaps with "
3672 & "actual for&", Act1, Form1);
3673 end if;
3674 end;
3675 end if;
3677 return;
3678 end if;
3680 Next_Formal (Form2);
3681 Next_Actual (Act2);
3682 end loop;
3683 end if;
3685 Next_Formal (Form1);
3686 Next_Actual (Act1);
3687 end loop;
3688 end Warn_On_Overlapping_Actuals;
3690 ------------------------------
3691 -- Warn_On_Suspicious_Index --
3692 ------------------------------
3694 procedure Warn_On_Suspicious_Index (Name : Entity_Id; X : Node_Id) is
3696 Low_Bound : Uint;
3697 -- Set to lower bound for a suspicious type
3699 Ent : Entity_Id;
3700 -- Entity for array reference
3702 Typ : Entity_Id;
3703 -- Array type
3705 function Is_Suspicious_Type (Typ : Entity_Id) return Boolean;
3706 -- Tests to see if Typ is a type for which we may have a suspicious
3707 -- index, namely an unconstrained array type, whose lower bound is
3708 -- either zero or one. If so, True is returned, and Low_Bound is set
3709 -- to this lower bound. If not, False is returned, and Low_Bound is
3710 -- undefined on return.
3712 -- For now, we limit this to standard string types, so any other
3713 -- unconstrained types return False. We may change our minds on this
3714 -- later on, but strings seem the most important case.
3716 procedure Test_Suspicious_Index;
3717 -- Test if index is of suspicious type and if so, generate warning
3719 ------------------------
3720 -- Is_Suspicious_Type --
3721 ------------------------
3723 function Is_Suspicious_Type (Typ : Entity_Id) return Boolean is
3724 LB : Node_Id;
3726 begin
3727 if Is_Array_Type (Typ)
3728 and then not Is_Constrained (Typ)
3729 and then Number_Dimensions (Typ) = 1
3730 and then Is_Standard_String_Type (Typ)
3731 and then not Has_Warnings_Off (Typ)
3732 then
3733 LB := Type_Low_Bound (Etype (First_Index (Typ)));
3735 if Compile_Time_Known_Value (LB) then
3736 Low_Bound := Expr_Value (LB);
3737 return Low_Bound = Uint_0 or else Low_Bound = Uint_1;
3738 end if;
3739 end if;
3741 return False;
3742 end Is_Suspicious_Type;
3744 ---------------------------
3745 -- Test_Suspicious_Index --
3746 ---------------------------
3748 procedure Test_Suspicious_Index is
3750 function Length_Reference (N : Node_Id) return Boolean;
3751 -- Check if node N is of the form Name'Length
3753 procedure Warn1;
3754 -- Generate first warning line
3756 ----------------------
3757 -- Length_Reference --
3758 ----------------------
3760 function Length_Reference (N : Node_Id) return Boolean is
3761 R : constant Node_Id := Original_Node (N);
3762 begin
3763 return
3764 Nkind (R) = N_Attribute_Reference
3765 and then Attribute_Name (R) = Name_Length
3766 and then Is_Entity_Name (Prefix (R))
3767 and then Entity (Prefix (R)) = Ent;
3768 end Length_Reference;
3770 -----------
3771 -- Warn1 --
3772 -----------
3774 procedure Warn1 is
3775 begin
3776 Error_Msg_Uint_1 := Low_Bound;
3777 Error_Msg_FE -- CODEFIX
3778 ("?w?index for& may assume lower bound of^", X, Ent);
3779 end Warn1;
3781 -- Start of processing for Test_Suspicious_Index
3783 begin
3784 -- Nothing to do if subscript does not come from source (we don't
3785 -- want to give garbage warnings on compiler expanded code, e.g. the
3786 -- loops generated for slice assignments. Such junk warnings would
3787 -- be placed on source constructs with no subscript in sight).
3789 if not Comes_From_Source (Original_Node (X)) then
3790 return;
3791 end if;
3793 -- Case where subscript is a constant integer
3795 if Nkind (X) = N_Integer_Literal then
3796 Warn1;
3798 -- Case where original form of subscript is an integer literal
3800 if Nkind (Original_Node (X)) = N_Integer_Literal then
3801 if Intval (X) = Low_Bound then
3802 Error_Msg_FE -- CODEFIX
3803 ("\?w?suggested replacement: `&''First`", X, Ent);
3804 else
3805 Error_Msg_Uint_1 := Intval (X) - Low_Bound;
3806 Error_Msg_FE -- CODEFIX
3807 ("\?w?suggested replacement: `&''First + ^`", X, Ent);
3809 end if;
3811 -- Case where original form of subscript is more complex
3813 else
3814 -- Build string X'First - 1 + expression where the expression
3815 -- is the original subscript. If the expression starts with "1
3816 -- + ", then the "- 1 + 1" is elided.
3818 Error_Msg_String (1 .. 13) := "'First - 1 + ";
3819 Error_Msg_Strlen := 13;
3821 declare
3822 Sref : Source_Ptr := Sloc (First_Node (Original_Node (X)));
3823 Tref : constant Source_Buffer_Ptr :=
3824 Source_Text (Get_Source_File_Index (Sref));
3825 -- Tref (Sref) is used to scan the subscript
3827 Pctr : Natural;
3828 -- Parentheses counter when scanning subscript
3830 begin
3831 -- Tref (Sref) points to start of subscript
3833 -- Elide - 1 if subscript starts with 1 +
3835 if Tref (Sref .. Sref + 2) = "1 +" then
3836 Error_Msg_Strlen := Error_Msg_Strlen - 6;
3837 Sref := Sref + 2;
3839 elsif Tref (Sref .. Sref + 1) = "1+" then
3840 Error_Msg_Strlen := Error_Msg_Strlen - 6;
3841 Sref := Sref + 1;
3842 end if;
3844 -- Now we will copy the subscript to the string buffer
3846 Pctr := 0;
3847 loop
3848 -- Count parens, exit if terminating right paren. Note
3849 -- check to ignore paren appearing as character literal.
3851 if Tref (Sref + 1) = '''
3852 and then
3853 Tref (Sref - 1) = '''
3854 then
3855 null;
3856 else
3857 if Tref (Sref) = '(' then
3858 Pctr := Pctr + 1;
3859 elsif Tref (Sref) = ')' then
3860 exit when Pctr = 0;
3861 Pctr := Pctr - 1;
3862 end if;
3863 end if;
3865 -- Done if terminating double dot (slice case)
3867 exit when Pctr = 0
3868 and then (Tref (Sref .. Sref + 1) = ".."
3869 or else
3870 Tref (Sref .. Sref + 2) = " ..");
3872 -- Quit if we have hit EOF character, something wrong
3874 if Tref (Sref) = EOF then
3875 return;
3876 end if;
3878 -- String literals are too much of a pain to handle
3880 if Tref (Sref) = '"' or else Tref (Sref) = '%' then
3881 return;
3882 end if;
3884 -- If we have a 'Range reference, then this is a case
3885 -- where we cannot easily give a replacement. Don't try.
3887 if Tref (Sref .. Sref + 4) = "range"
3888 and then Tref (Sref - 1) < 'A'
3889 and then Tref (Sref + 5) < 'A'
3890 then
3891 return;
3892 end if;
3894 -- Else store next character
3896 Error_Msg_Strlen := Error_Msg_Strlen + 1;
3897 Error_Msg_String (Error_Msg_Strlen) := Tref (Sref);
3898 Sref := Sref + 1;
3900 -- If we get more than 40 characters then the expression
3901 -- is too long to copy, or something has gone wrong. In
3902 -- either case, just skip the attempt at a suggested fix.
3904 if Error_Msg_Strlen > 40 then
3905 return;
3906 end if;
3907 end loop;
3908 end;
3910 -- Replacement subscript is now in string buffer
3912 Error_Msg_FE -- CODEFIX
3913 ("\?w?suggested replacement: `&~`", Original_Node (X), Ent);
3914 end if;
3916 -- Case where subscript is of the form X'Length
3918 elsif Length_Reference (X) then
3919 Warn1;
3920 Error_Msg_Node_2 := Ent;
3921 Error_Msg_FE
3922 ("\?w?suggest replacement of `&''Length` by `&''Last`",
3923 X, Ent);
3925 -- Case where subscript is of the form X'Length - expression
3927 elsif Nkind (X) = N_Op_Subtract
3928 and then Length_Reference (Left_Opnd (X))
3929 then
3930 Warn1;
3931 Error_Msg_Node_2 := Ent;
3932 Error_Msg_FE
3933 ("\?w?suggest replacement of `&''Length` by `&''Last`",
3934 Left_Opnd (X), Ent);
3935 end if;
3936 end Test_Suspicious_Index;
3938 -- Start of processing for Warn_On_Suspicious_Index
3940 begin
3941 -- Only process if warnings activated
3943 if Warn_On_Assumed_Low_Bound then
3945 -- Test if array is simple entity name
3947 if Is_Entity_Name (Name) then
3949 -- Test if array is parameter of unconstrained string type
3951 Ent := Entity (Name);
3952 Typ := Etype (Ent);
3954 if Is_Formal (Ent)
3955 and then Is_Suspicious_Type (Typ)
3956 and then not Low_Bound_Tested (Ent)
3957 then
3958 Test_Suspicious_Index;
3959 end if;
3960 end if;
3961 end if;
3962 end Warn_On_Suspicious_Index;
3964 -------------------------------
3965 -- Warn_On_Suspicious_Update --
3966 -------------------------------
3968 procedure Warn_On_Suspicious_Update (N : Node_Id) is
3969 Par : constant Node_Id := Parent (N);
3970 Arg : Node_Id;
3972 begin
3973 -- Only process if warnings activated
3975 if Warn_On_Suspicious_Contract then
3976 if Nkind_In (Par, N_Op_Eq, N_Op_Ne) then
3977 if N = Left_Opnd (Par) then
3978 Arg := Right_Opnd (Par);
3979 else
3980 Arg := Left_Opnd (Par);
3981 end if;
3983 if Same_Object (Prefix (N), Arg) then
3984 if Nkind (Par) = N_Op_Eq then
3985 Error_Msg_N
3986 ("suspicious equality test with modified version of "
3987 & "same object?T?", Par);
3988 else
3989 Error_Msg_N
3990 ("suspicious inequality test with modified version of "
3991 & "same object?T?", Par);
3992 end if;
3993 end if;
3994 end if;
3995 end if;
3996 end Warn_On_Suspicious_Update;
3998 --------------------------------------
3999 -- Warn_On_Unassigned_Out_Parameter --
4000 --------------------------------------
4002 procedure Warn_On_Unassigned_Out_Parameter
4003 (Return_Node : Node_Id;
4004 Scope_Id : Entity_Id)
4006 Form : Entity_Id;
4007 Form2 : Entity_Id;
4009 begin
4010 -- Ignore if procedure or return statement does not come from source
4012 if not Comes_From_Source (Scope_Id)
4013 or else not Comes_From_Source (Return_Node)
4014 then
4015 return;
4016 end if;
4018 -- Loop through formals
4020 Form := First_Formal (Scope_Id);
4021 while Present (Form) loop
4023 -- We are only interested in OUT parameters that come from source
4024 -- and are never set in the source, and furthermore only in scalars
4025 -- since non-scalars generate too many false positives.
4027 if Ekind (Form) = E_Out_Parameter
4028 and then Never_Set_In_Source_Check_Spec (Form)
4029 and then Is_Scalar_Type (Etype (Form))
4030 and then not Present (Unset_Reference (Form))
4031 then
4032 -- Before we issue the warning, an add ad hoc defence against the
4033 -- most common case of false positives with this warning which is
4034 -- the case where there is a Boolean OUT parameter that has been
4035 -- set, and whose meaning is "ignore the values of the other
4036 -- parameters". We can't of course reliably tell this case at
4037 -- compile time, but the following test kills a lot of false
4038 -- positives, without generating a significant number of false
4039 -- negatives (missed real warnings).
4041 Form2 := First_Formal (Scope_Id);
4042 while Present (Form2) loop
4043 if Ekind (Form2) = E_Out_Parameter
4044 and then Root_Type (Etype (Form2)) = Standard_Boolean
4045 and then not Never_Set_In_Source_Check_Spec (Form2)
4046 then
4047 return;
4048 end if;
4050 Next_Formal (Form2);
4051 end loop;
4053 -- Here all conditions are met, record possible unset reference
4055 Set_Unset_Reference (Form, Return_Node);
4056 end if;
4058 Next_Formal (Form);
4059 end loop;
4060 end Warn_On_Unassigned_Out_Parameter;
4062 ---------------------------------
4063 -- Warn_On_Unreferenced_Entity --
4064 ---------------------------------
4066 procedure Warn_On_Unreferenced_Entity
4067 (Spec_E : Entity_Id;
4068 Body_E : Entity_Id := Empty)
4070 E : Entity_Id := Spec_E;
4072 begin
4073 if not Referenced_Check_Spec (E)
4074 and then not Has_Pragma_Unreferenced_Check_Spec (E)
4075 and then not Warnings_Off_Check_Spec (E)
4076 and then not Has_Junk_Name (Spec_E)
4077 and then not Is_Exported (Spec_E)
4078 then
4079 case Ekind (E) is
4080 when E_Variable =>
4082 -- Case of variable that is assigned but not read. We suppress
4083 -- the message if the variable is volatile, has an address
4084 -- clause, is aliased, or is a renaming, or is imported.
4086 if Referenced_As_LHS_Check_Spec (E)
4087 and then No (Address_Clause (E))
4088 and then not Is_Volatile (E)
4089 then
4090 if Warn_On_Modified_Unread
4091 and then not Is_Imported (E)
4092 and then not Is_Aliased (E)
4093 and then No (Renamed_Object (E))
4094 then
4095 if not Has_Pragma_Unmodified_Check_Spec (E) then
4096 Error_Msg_N -- CODEFIX
4097 ("?u?variable & is assigned but never read!", E);
4098 end if;
4100 Set_Last_Assignment (E, Empty);
4101 end if;
4103 -- Normal case of neither assigned nor read (exclude variables
4104 -- referenced as out parameters, since we already generated
4105 -- appropriate warnings at the call point in this case).
4107 elsif not Referenced_As_Out_Parameter (E) then
4109 -- We suppress the message for types for which a valid
4110 -- pragma Unreferenced_Objects has been given, otherwise
4111 -- we go ahead and give the message.
4113 if not Has_Pragma_Unreferenced_Objects (Etype (E)) then
4115 -- Distinguish renamed case in message
4117 if Present (Renamed_Object (E))
4118 and then Comes_From_Source (Renamed_Object (E))
4119 then
4120 Error_Msg_N -- CODEFIX
4121 ("?u?renamed variable & is not referenced!", E);
4122 else
4123 Error_Msg_N -- CODEFIX
4124 ("?u?variable & is not referenced!", E);
4125 end if;
4126 end if;
4127 end if;
4129 when E_Constant =>
4130 if not Has_Pragma_Unreferenced_Objects (Etype (E)) then
4131 if Present (Renamed_Object (E))
4132 and then Comes_From_Source (Renamed_Object (E))
4133 then
4134 Error_Msg_N -- CODEFIX
4135 ("?u?renamed constant & is not referenced!", E);
4136 else
4137 Error_Msg_N -- CODEFIX
4138 ("?u?constant & is not referenced!", E);
4139 end if;
4140 end if;
4142 when E_In_Parameter |
4143 E_In_Out_Parameter =>
4145 -- Do not emit message for formals of a renaming, because
4146 -- they are never referenced explicitly.
4148 if Nkind (Original_Node (Unit_Declaration_Node (Scope (E)))) /=
4149 N_Subprogram_Renaming_Declaration
4150 then
4151 -- Suppress this message for an IN OUT parameter of a
4152 -- non-scalar type, since it is normal to have only an
4153 -- assignment in such a case.
4155 if Ekind (E) = E_In_Parameter
4156 or else not Referenced_As_LHS_Check_Spec (E)
4157 or else Is_Scalar_Type (Etype (E))
4158 then
4159 if Present (Body_E) then
4160 E := Body_E;
4161 end if;
4163 if not Is_Trivial_Subprogram (Scope (E)) then
4164 Error_Msg_NE -- CODEFIX
4165 ("?u?formal parameter & is not referenced!",
4166 E, Spec_E);
4167 end if;
4168 end if;
4169 end if;
4171 when E_Out_Parameter =>
4172 null;
4174 when E_Discriminant =>
4175 Error_Msg_N ("?u?discriminant & is not referenced!", E);
4177 when E_Named_Integer |
4178 E_Named_Real =>
4179 Error_Msg_N -- CODEFIX
4180 ("?u?named number & is not referenced!", E);
4182 when Formal_Object_Kind =>
4183 Error_Msg_N -- CODEFIX
4184 ("?u?formal object & is not referenced!", E);
4186 when E_Enumeration_Literal =>
4187 Error_Msg_N -- CODEFIX
4188 ("?u?literal & is not referenced!", E);
4190 when E_Function =>
4191 Error_Msg_N -- CODEFIX
4192 ("?u?function & is not referenced!", E);
4194 when E_Procedure =>
4195 Error_Msg_N -- CODEFIX
4196 ("?u?procedure & is not referenced!", E);
4198 when E_Package =>
4199 Error_Msg_N -- CODEFIX
4200 ("?u?package & is not referenced!", E);
4202 when E_Exception =>
4203 Error_Msg_N -- CODEFIX
4204 ("?u?exception & is not referenced!", E);
4206 when E_Label =>
4207 Error_Msg_N -- CODEFIX
4208 ("?u?label & is not referenced!", E);
4210 when E_Generic_Procedure =>
4211 Error_Msg_N -- CODEFIX
4212 ("?u?generic procedure & is never instantiated!", E);
4214 when E_Generic_Function =>
4215 Error_Msg_N -- CODEFIX
4216 ("?u?generic function & is never instantiated!", E);
4218 when Type_Kind =>
4219 Error_Msg_N -- CODEFIX
4220 ("?u?type & is not referenced!", E);
4222 when others =>
4223 Error_Msg_N -- CODEFIX
4224 ("?u?& is not referenced!", E);
4225 end case;
4227 -- Kill warnings on the entity on which the message has been posted
4228 -- (nothing is posted on out parameters because back end might be
4229 -- able to uncover an uninitialized path, and warn accordingly).
4231 if Ekind (E) /= E_Out_Parameter then
4232 Set_Warnings_Off (E);
4233 end if;
4234 end if;
4235 end Warn_On_Unreferenced_Entity;
4237 --------------------------------
4238 -- Warn_On_Useless_Assignment --
4239 --------------------------------
4241 procedure Warn_On_Useless_Assignment
4242 (Ent : Entity_Id;
4243 N : Node_Id := Empty)
4245 P : Node_Id;
4246 X : Node_Id;
4248 function Check_Ref (N : Node_Id) return Traverse_Result;
4249 -- Used to instantiate Traverse_Func. Returns Abandon if a reference to
4250 -- the entity in question is found.
4252 function Test_No_Refs is new Traverse_Func (Check_Ref);
4254 ---------------
4255 -- Check_Ref --
4256 ---------------
4258 function Check_Ref (N : Node_Id) return Traverse_Result is
4259 begin
4260 -- Check reference to our identifier. We use name equality here
4261 -- because the exception handlers have not yet been analyzed. This
4262 -- is not quite right, but it really does not matter that we fail
4263 -- to output the warning in some obscure cases of name clashes.
4265 if Nkind (N) = N_Identifier and then Chars (N) = Chars (Ent) then
4266 return Abandon;
4267 else
4268 return OK;
4269 end if;
4270 end Check_Ref;
4272 -- Start of processing for Warn_On_Useless_Assignment
4274 begin
4275 -- Check if this is a case we want to warn on, a scalar or access
4276 -- variable with the last assignment field set, with warnings enabled,
4277 -- and which is not imported or exported. We also check that it is OK
4278 -- to capture the value. We are not going to capture any value, but
4279 -- the warning message depends on the same kind of conditions.
4281 if Is_Assignable (Ent)
4282 and then not Is_Return_Object (Ent)
4283 and then Present (Last_Assignment (Ent))
4284 and then not Is_Imported (Ent)
4285 and then not Is_Exported (Ent)
4286 and then Safe_To_Capture_Value (N, Ent)
4287 and then not Has_Pragma_Unreferenced_Check_Spec (Ent)
4288 and then not Has_Junk_Name (Ent)
4289 then
4290 -- Before we issue the message, check covering exception handlers.
4291 -- Search up tree for enclosing statement sequences and handlers.
4293 P := Parent (Last_Assignment (Ent));
4294 while Present (P) loop
4296 -- Something is really wrong if we don't find a handled statement
4297 -- sequence, so just suppress the warning.
4299 if No (P) then
4300 Set_Last_Assignment (Ent, Empty);
4301 return;
4303 -- When we hit a package/subprogram body, issue warning and exit
4305 elsif Nkind_In (P, N_Entry_Body,
4306 N_Package_Body,
4307 N_Subprogram_Body,
4308 N_Task_Body)
4309 then
4310 -- Case of assigned value never referenced
4312 if No (N) then
4313 declare
4314 LA : constant Node_Id := Last_Assignment (Ent);
4316 begin
4317 -- Don't give this for OUT and IN OUT formals, since
4318 -- clearly caller may reference the assigned value. Also
4319 -- never give such warnings for internal variables.
4321 if Ekind (Ent) = E_Variable
4322 and then not Is_Internal_Name (Chars (Ent))
4323 then
4324 -- Give appropriate message, distinguishing between
4325 -- assignment statements and out parameters.
4327 if Nkind_In (Parent (LA), N_Procedure_Call_Statement,
4328 N_Parameter_Association)
4329 then
4330 Error_Msg_NE
4331 ("?m?& modified by call, but value never "
4332 & "referenced", LA, Ent);
4334 else
4335 Error_Msg_NE -- CODEFIX
4336 ("?m?useless assignment to&, value never "
4337 & "referenced!", LA, Ent);
4338 end if;
4339 end if;
4340 end;
4342 -- Case of assigned value overwritten
4344 else
4345 declare
4346 LA : constant Node_Id := Last_Assignment (Ent);
4348 begin
4349 Error_Msg_Sloc := Sloc (N);
4351 -- Give appropriate message, distinguishing between
4352 -- assignment statements and out parameters.
4354 if Nkind_In (Parent (LA), N_Procedure_Call_Statement,
4355 N_Parameter_Association)
4356 then
4357 Error_Msg_NE
4358 ("?m?& modified by call, but value overwritten #!",
4359 LA, Ent);
4360 else
4361 Error_Msg_NE -- CODEFIX
4362 ("?m?useless assignment to&, value overwritten #!",
4363 LA, Ent);
4364 end if;
4365 end;
4366 end if;
4368 -- Clear last assignment indication and we are done
4370 Set_Last_Assignment (Ent, Empty);
4371 return;
4373 -- Enclosing handled sequence of statements
4375 elsif Nkind (P) = N_Handled_Sequence_Of_Statements then
4377 -- Check exception handlers present
4379 if Present (Exception_Handlers (P)) then
4381 -- If we are not at the top level, we regard an inner
4382 -- exception handler as a decisive indicator that we should
4383 -- not generate the warning, since the variable in question
4384 -- may be accessed after an exception in the outer block.
4386 if not Nkind_In (Parent (P), N_Entry_Body,
4387 N_Package_Body,
4388 N_Subprogram_Body,
4389 N_Task_Body)
4390 then
4391 Set_Last_Assignment (Ent, Empty);
4392 return;
4394 -- Otherwise we are at the outer level. An exception
4395 -- handler is significant only if it references the
4396 -- variable in question, or if the entity in question
4397 -- is an OUT or IN OUT parameter, in which case
4398 -- the caller can reference it after the exception
4399 -- handler completes.
4401 else
4402 if Is_Formal (Ent) then
4403 Set_Last_Assignment (Ent, Empty);
4404 return;
4406 else
4407 X := First (Exception_Handlers (P));
4408 while Present (X) loop
4409 if Test_No_Refs (X) = Abandon then
4410 Set_Last_Assignment (Ent, Empty);
4411 return;
4412 end if;
4414 X := Next (X);
4415 end loop;
4416 end if;
4417 end if;
4418 end if;
4419 end if;
4421 P := Parent (P);
4422 end loop;
4423 end if;
4424 end Warn_On_Useless_Assignment;
4426 ---------------------------------
4427 -- Warn_On_Useless_Assignments --
4428 ---------------------------------
4430 procedure Warn_On_Useless_Assignments (E : Entity_Id) is
4431 Ent : Entity_Id;
4433 begin
4434 Process_Deferred_References;
4436 if Warn_On_Modified_Unread
4437 and then In_Extended_Main_Source_Unit (E)
4438 then
4439 Ent := First_Entity (E);
4440 while Present (Ent) loop
4441 Warn_On_Useless_Assignment (Ent);
4442 Next_Entity (Ent);
4443 end loop;
4444 end if;
4445 end Warn_On_Useless_Assignments;
4447 -----------------------------
4448 -- Warnings_Off_Check_Spec --
4449 -----------------------------
4451 function Warnings_Off_Check_Spec (E : Entity_Id) return Boolean is
4452 begin
4453 if Is_Formal (E) and then Present (Spec_Entity (E)) then
4455 -- Note: use of OR here instead of OR ELSE is deliberate, we want
4456 -- to mess with flags on both entities.
4458 return Has_Warnings_Off (E)
4460 Has_Warnings_Off (Spec_Entity (E));
4462 else
4463 return Has_Warnings_Off (E);
4464 end if;
4465 end Warnings_Off_Check_Spec;
4467 end Sem_Warn;