2014-08-04 Robert Dewar <dewar@adacore.com>
[official-gcc.git] / gcc / ada / sem_warn.adb
blobe8c8f0b1f7f529eefe3159dc41943f3b41a18c5e
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-2014, 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_Util; use Sem_Util;
44 with Sinfo; use Sinfo;
45 with Sinput; use Sinput;
46 with Snames; use Snames;
47 with Stand; use Stand;
48 with Stringt; use Stringt;
49 with Uintp; use Uintp;
51 package body Sem_Warn is
53 -- The following table collects Id's of entities that are potentially
54 -- unreferenced. See Check_Unset_Reference for further details.
55 -- ??? Check_Unset_Reference has zero information about this table.
57 package Unreferenced_Entities is new Table.Table (
58 Table_Component_Type => Entity_Id,
59 Table_Index_Type => Nat,
60 Table_Low_Bound => 1,
61 Table_Initial => Alloc.Unreferenced_Entities_Initial,
62 Table_Increment => Alloc.Unreferenced_Entities_Increment,
63 Table_Name => "Unreferenced_Entities");
65 -- The following table collects potential warnings for IN OUT parameters
66 -- that are referenced but not modified. These warnings are processed when
67 -- the front end calls the procedure Output_Non_Modified_In_Out_Warnings.
68 -- The reason that we defer output of these messages is that we want to
69 -- detect the case where the relevant procedure is used as a generic actual
70 -- in an instantiation, since we suppress the warnings in this case. The
71 -- flag Used_As_Generic_Actual will be set in this case, but only at the
72 -- point of usage. Similarly, we suppress the message if the address of the
73 -- procedure is taken, where the flag Address_Taken may be set later.
75 package In_Out_Warnings is new Table.Table (
76 Table_Component_Type => Entity_Id,
77 Table_Index_Type => Nat,
78 Table_Low_Bound => 1,
79 Table_Initial => Alloc.In_Out_Warnings_Initial,
80 Table_Increment => Alloc.In_Out_Warnings_Increment,
81 Table_Name => "In_Out_Warnings");
83 --------------------------------------------------------
84 -- Handling of Warnings Off, Unmodified, Unreferenced --
85 --------------------------------------------------------
87 -- The functions Has_Warnings_Off, Has_Unmodified, Has_Unreferenced must
88 -- generally be used instead of Warnings_Off, Has_Pragma_Unmodified and
89 -- Has_Pragma_Unreferenced, as noted in the specs in Einfo.
91 -- In order to avoid losing warnings in -gnatw.w (warn on unnecessary
92 -- warnings off pragma) mode, i.e. to avoid false negatives, the code
93 -- must follow some important rules.
95 -- Call these functions as late as possible, after completing all other
96 -- tests, just before the warnings is given. For example, don't write:
98 -- if not Has_Warnings_Off (E)
99 -- and then some-other-predicate-on-E then ..
101 -- Instead the following is preferred
103 -- if some-other-predicate-on-E
104 -- and then Has_Warnings_Off (E)
106 -- This way if some-other-predicate is false, we avoid a false indication
107 -- that a Warnings (Off, E) pragma was useful in preventing a warning.
109 -- The second rule is that if both Has_Unmodified and Has_Warnings_Off, or
110 -- Has_Unreferenced and Has_Warnings_Off are called, make sure that the
111 -- call to Has_Unmodified/Has_Unreferenced comes first, this way we record
112 -- that the Warnings (Off) could have been Unreferenced or Unmodified. In
113 -- fact Has_Unmodified/Has_Unreferenced includes a test for Warnings Off,
114 -- and so a subsequent test is not needed anyway (though it is harmless).
116 -----------------------
117 -- Local Subprograms --
118 -----------------------
120 function Generic_Package_Spec_Entity (E : Entity_Id) return Boolean;
121 -- This returns true if the entity E is declared within a generic package.
122 -- The point of this is to detect variables which are not assigned within
123 -- the generic, but might be assigned outside the package for any given
124 -- instance. These are cases where we leave the warnings to be posted for
125 -- the instance, when we will know more.
127 function Goto_Spec_Entity (E : Entity_Id) return Entity_Id;
128 -- If E is a parameter entity for a subprogram body, then this function
129 -- returns the corresponding spec entity, if not, E is returned unchanged.
131 function Has_Pragma_Unmodified_Check_Spec (E : Entity_Id) return Boolean;
132 -- Tests Has_Pragma_Unmodified flag for entity E. If E is not a formal,
133 -- this is simply the setting of the flag Has_Pragma_Unmodified. If E is
134 -- a body formal, the setting of the flag in the corresponding spec is
135 -- also checked (and True returned if either flag is True).
137 function Has_Pragma_Unreferenced_Check_Spec (E : Entity_Id) return Boolean;
138 -- Tests Has_Pragma_Unreferenced flag for entity E. If E is not a formal,
139 -- this is simply the setting of the flag Has_Pragma_Unreferenced. If E is
140 -- a body formal, the setting of the flag in the corresponding spec is
141 -- also checked (and True returned if either flag is True).
143 function Never_Set_In_Source_Check_Spec (E : Entity_Id) return Boolean;
144 -- Tests Never_Set_In_Source status for entity E. If E is not a formal,
145 -- this is simply the setting of the flag Never_Set_In_Source. If E is
146 -- a body formal, the setting of the flag in the corresponding spec is
147 -- also checked (and False returned if either flag is False).
149 function Operand_Has_Warnings_Suppressed (N : Node_Id) return Boolean;
150 -- This function traverses the expression tree represented by the node N
151 -- and determines if any sub-operand is a reference to an entity for which
152 -- the Warnings_Off flag is set. True is returned if such an entity is
153 -- encountered, and False otherwise.
155 function Referenced_Check_Spec (E : Entity_Id) return Boolean;
156 -- Tests Referenced status for entity E. If E is not a formal, this is
157 -- simply the setting of the flag Referenced. If E is a body formal, the
158 -- setting of the flag in the corresponding spec is also checked (and True
159 -- returned if either flag is True).
161 function Referenced_As_LHS_Check_Spec (E : Entity_Id) return Boolean;
162 -- Tests Referenced_As_LHS status for entity E. If E is not a formal, this
163 -- is simply the setting of the flag Referenced_As_LHS. If E is a body
164 -- formal, the setting of the flag in the corresponding spec is also
165 -- checked (and True returned if either flag is True).
167 function Referenced_As_Out_Parameter_Check_Spec
168 (E : Entity_Id) return Boolean;
169 -- Tests Referenced_As_Out_Parameter status for entity E. If E is not a
170 -- formal, this is simply the setting of Referenced_As_Out_Parameter. If E
171 -- is a body formal, the setting of the flag in the corresponding spec is
172 -- also checked (and True returned if either flag is True).
174 procedure Warn_On_Unreferenced_Entity
175 (Spec_E : Entity_Id;
176 Body_E : Entity_Id := Empty);
177 -- Output warnings for unreferenced entity E. For the case of an entry
178 -- formal, Body_E is the corresponding body entity for a particular
179 -- accept statement, and the message is posted on Body_E. In all other
180 -- cases, Body_E is ignored and must be Empty.
182 function Warnings_Off_Check_Spec (E : Entity_Id) return Boolean;
183 -- Returns True if Warnings_Off is set for the entity E or (in the case
184 -- where there is a Spec_Entity), Warnings_Off is set for the Spec_Entity.
186 --------------------------
187 -- Check_Code_Statement --
188 --------------------------
190 procedure Check_Code_Statement (N : Node_Id) is
191 begin
192 -- If volatile, nothing to worry about
194 if Is_Asm_Volatile (N) then
195 return;
196 end if;
198 -- Warn if no input or no output
200 Setup_Asm_Inputs (N);
202 if No (Asm_Input_Value) then
203 Error_Msg_F
204 ("??code statement with no inputs should usually be Volatile!", N);
205 return;
206 end if;
208 Setup_Asm_Outputs (N);
210 if No (Asm_Output_Variable) then
211 Error_Msg_F
212 ("??code statement with no outputs should usually be Volatile!", N);
213 return;
214 end if;
215 end Check_Code_Statement;
217 ---------------------------------
218 -- Check_Infinite_Loop_Warning --
219 ---------------------------------
221 -- The case we look for is a while loop which tests a local variable, where
222 -- there is no obvious direct or possible indirect update of the variable
223 -- within the body of the loop.
225 procedure Check_Infinite_Loop_Warning (Loop_Statement : Node_Id) is
226 Expression : Node_Id := Empty;
227 -- Set to WHILE or EXIT WHEN condition to be tested
229 Ref : Node_Id := Empty;
230 -- Reference in Expression to variable that might not be modified
231 -- in loop, indicating a possible infinite loop.
233 Var : Entity_Id := Empty;
234 -- Corresponding entity (entity of Ref)
236 Function_Call_Found : Boolean := False;
237 -- True if Find_Var found a function call in the condition
239 procedure Find_Var (N : Node_Id);
240 -- Inspect condition to see if it depends on a single entity reference.
241 -- If so, Ref is set to point to the reference node, and Var is set to
242 -- the referenced Entity.
244 function Has_Indirection (T : Entity_Id) return Boolean;
245 -- If the controlling variable is an access type, or is a record type
246 -- with access components, assume that it is changed indirectly and
247 -- suppress the warning. As a concession to low-level programming, in
248 -- particular within Declib, we also suppress warnings on a record
249 -- type that contains components of type Address or Short_Address.
251 function Is_Suspicious_Function_Name (E : Entity_Id) return Boolean;
252 -- Given an entity name, see if the name appears to have something to
253 -- do with I/O or network stuff, and if so, return True. Used to kill
254 -- some false positives on a heuristic basis that such functions will
255 -- likely have some strange side effect dependencies. A rather strange
256 -- test, but warning messages are in the heuristics business.
258 function Test_Ref (N : Node_Id) return Traverse_Result;
259 -- Test for reference to variable in question. Returns Abandon if
260 -- matching reference found. Used in instantiation of No_Ref_Found.
262 function No_Ref_Found is new Traverse_Func (Test_Ref);
263 -- Function to traverse body of procedure. Returns Abandon if matching
264 -- reference found.
266 --------------
267 -- Find_Var --
268 --------------
270 procedure Find_Var (N : Node_Id) is
271 begin
272 -- Condition is a direct variable reference
274 if Is_Entity_Name (N) then
275 Ref := N;
276 Var := Entity (Ref);
278 -- Case of condition is a comparison with compile time known value
280 elsif Nkind (N) in N_Op_Compare then
281 if Compile_Time_Known_Value (Right_Opnd (N)) then
282 Find_Var (Left_Opnd (N));
284 elsif Compile_Time_Known_Value (Left_Opnd (N)) then
285 Find_Var (Right_Opnd (N));
287 -- Ignore any other comparison
289 else
290 return;
291 end if;
293 -- If condition is a negation, check its operand
295 elsif Nkind (N) = N_Op_Not then
296 Find_Var (Right_Opnd (N));
298 -- Case of condition is function call
300 elsif Nkind (N) = N_Function_Call then
302 Function_Call_Found := True;
304 -- Forget it if function name is not entity, who knows what
305 -- we might be calling?
307 if not Is_Entity_Name (Name (N)) then
308 return;
310 -- Forget it if function name is suspicious. A strange test
311 -- but warning generation is in the heuristics business.
313 elsif Is_Suspicious_Function_Name (Entity (Name (N))) then
314 return;
316 -- Forget it if warnings are suppressed on function entity
318 elsif Has_Warnings_Off (Entity (Name (N))) then
319 return;
320 end if;
322 -- OK, see if we have one argument
324 declare
325 PA : constant List_Id := Parameter_Associations (N);
327 begin
328 -- One argument, so check the argument
330 if Present (PA) and then List_Length (PA) = 1 then
331 if Nkind (First (PA)) = N_Parameter_Association then
332 Find_Var (Explicit_Actual_Parameter (First (PA)));
333 else
334 Find_Var (First (PA));
335 end if;
337 -- Not one argument
339 else
340 return;
341 end if;
342 end;
344 -- Any other kind of node is not something we warn for
346 else
347 return;
348 end if;
349 end Find_Var;
351 ---------------------
352 -- Has_Indirection --
353 ---------------------
355 function Has_Indirection (T : Entity_Id) return Boolean is
356 Comp : Entity_Id;
357 Rec : Entity_Id;
359 begin
360 if Is_Access_Type (T) then
361 return True;
363 elsif Is_Private_Type (T)
364 and then Present (Full_View (T))
365 and then Is_Access_Type (Full_View (T))
366 then
367 return True;
369 elsif Is_Record_Type (T) then
370 Rec := T;
372 elsif Is_Private_Type (T)
373 and then Present (Full_View (T))
374 and then Is_Record_Type (Full_View (T))
375 then
376 Rec := Full_View (T);
377 else
378 return False;
379 end if;
381 Comp := First_Component (Rec);
382 while Present (Comp) loop
383 if Is_Access_Type (Etype (Comp))
384 or else Is_Descendent_Of_Address (Etype (Comp))
385 then
386 return True;
387 end if;
389 Next_Component (Comp);
390 end loop;
392 return False;
393 end Has_Indirection;
395 ---------------------------------
396 -- Is_Suspicious_Function_Name --
397 ---------------------------------
399 function Is_Suspicious_Function_Name (E : Entity_Id) return Boolean is
400 S : Entity_Id;
402 function Substring_Present (S : String) return Boolean;
403 -- Returns True if name buffer has given string delimited by non-
404 -- alphabetic characters or by end of string. S is lower case.
406 -----------------------
407 -- Substring_Present --
408 -----------------------
410 function Substring_Present (S : String) return Boolean is
411 Len : constant Natural := S'Length;
413 begin
414 for J in 1 .. Name_Len - (Len - 1) loop
415 if Name_Buffer (J .. J + (Len - 1)) = S
416 and then (J = 1 or else Name_Buffer (J - 1) not in 'a' .. 'z')
417 and then
418 (J + Len > Name_Len
419 or else Name_Buffer (J + Len) not in 'a' .. 'z')
420 then
421 return True;
422 end if;
423 end loop;
425 return False;
426 end Substring_Present;
428 -- Start of processing for Is_Suspicious_Function_Name
430 begin
431 S := E;
432 while Present (S) and then S /= Standard_Standard loop
433 Get_Name_String (Chars (S));
435 if Substring_Present ("io")
436 or else Substring_Present ("file")
437 or else Substring_Present ("network")
438 then
439 return True;
440 else
441 S := Scope (S);
442 end if;
443 end loop;
445 return False;
446 end Is_Suspicious_Function_Name;
448 --------------
449 -- Test_Ref --
450 --------------
452 function Test_Ref (N : Node_Id) return Traverse_Result is
453 begin
454 -- Waste of time to look at the expression we are testing
456 if N = Expression then
457 return Skip;
459 -- Direct reference to variable in question
461 elsif Is_Entity_Name (N)
462 and then Present (Entity (N))
463 and then Entity (N) = Var
464 then
465 -- If this is an lvalue, then definitely abandon, since
466 -- this could be a direct modification of the variable.
468 if May_Be_Lvalue (N) then
469 return Abandon;
470 end if;
472 -- If the condition contains a function call, we consider it may
473 -- be modified by side-effects from a procedure call. Otherwise,
474 -- we consider the condition may not be modified, although that
475 -- might happen if Variable is itself a by-reference parameter,
476 -- and the procedure called modifies the global object referred to
477 -- by Variable, but we actually prefer to issue a warning in this
478 -- odd case. Note that the case where the procedure called has
479 -- visibility over Variable is treated in another case below.
481 if Function_Call_Found then
482 declare
483 P : Node_Id;
485 begin
486 P := N;
487 loop
488 P := Parent (P);
489 exit when P = Loop_Statement;
491 -- Abandon if at procedure call, or something strange is
492 -- going on (perhaps a node with no parent that should
493 -- have one but does not?) As always, for a warning we
494 -- prefer to just abandon the warning than get into the
495 -- business of complaining about the tree structure here.
497 if No (P)
498 or else Nkind (P) = N_Procedure_Call_Statement
499 then
500 return Abandon;
501 end if;
502 end loop;
503 end;
504 end if;
506 -- Reference to variable renaming variable in question
508 elsif Is_Entity_Name (N)
509 and then Present (Entity (N))
510 and then Ekind (Entity (N)) = E_Variable
511 and then Present (Renamed_Object (Entity (N)))
512 and then Is_Entity_Name (Renamed_Object (Entity (N)))
513 and then Entity (Renamed_Object (Entity (N))) = Var
514 and then May_Be_Lvalue (N)
515 then
516 return Abandon;
518 -- Call to subprogram
520 elsif Nkind (N) in N_Subprogram_Call then
522 -- If subprogram is within the scope of the entity we are dealing
523 -- with as the loop variable, then it could modify this parameter,
524 -- so we abandon in this case. In the case of a subprogram that is
525 -- not an entity we also abandon. The check for no entity being
526 -- present is a defense against previous errors.
528 if not Is_Entity_Name (Name (N))
529 or else No (Entity (Name (N)))
530 or else Scope_Within (Entity (Name (N)), Scope (Var))
531 then
532 return Abandon;
533 end if;
535 -- If any of the arguments are of type access to subprogram, then
536 -- we may have funny side effects, so no warning in this case.
538 declare
539 Actual : Node_Id;
540 begin
541 Actual := First_Actual (N);
542 while Present (Actual) loop
543 if Is_Access_Subprogram_Type (Etype (Actual)) then
544 return Abandon;
545 else
546 Next_Actual (Actual);
547 end if;
548 end loop;
549 end;
551 -- Declaration of the variable in question
553 elsif Nkind (N) = N_Object_Declaration
554 and then Defining_Identifier (N) = Var
555 then
556 return Abandon;
557 end if;
559 -- All OK, continue scan
561 return OK;
562 end Test_Ref;
564 -- Start of processing for Check_Infinite_Loop_Warning
566 begin
567 -- Skip processing if debug flag gnatd.w is set
569 if Debug_Flag_Dot_W then
570 return;
571 end if;
573 -- Deal with Iteration scheme present
575 declare
576 Iter : constant Node_Id := Iteration_Scheme (Loop_Statement);
578 begin
579 if Present (Iter) then
581 -- While iteration
583 if Present (Condition (Iter)) then
585 -- Skip processing for while iteration with conditions actions,
586 -- since they make it too complicated to get the warning right.
588 if Present (Condition_Actions (Iter)) then
589 return;
590 end if;
592 -- Capture WHILE condition
594 Expression := Condition (Iter);
596 -- For iteration, do not process, since loop will always terminate
598 elsif Present (Loop_Parameter_Specification (Iter)) then
599 return;
600 end if;
601 end if;
602 end;
604 -- Check chain of EXIT statements, we only process loops that have a
605 -- single exit condition (either a single EXIT WHEN statement, or a
606 -- WHILE loop not containing any EXIT WHEN statements).
608 declare
609 Ident : constant Node_Id := Identifier (Loop_Statement);
610 Exit_Stmt : Node_Id;
612 begin
613 -- If we don't have a proper chain set, ignore call entirely. This
614 -- happens because of previous errors.
616 if No (Entity (Ident))
617 or else Ekind (Entity (Ident)) /= E_Loop
618 then
619 Check_Error_Detected;
620 return;
621 end if;
623 -- Otherwise prepare to scan list of EXIT statements
625 Exit_Stmt := First_Exit_Statement (Entity (Ident));
626 while Present (Exit_Stmt) loop
628 -- Check for EXIT WHEN
630 if Present (Condition (Exit_Stmt)) then
632 -- Quit processing if EXIT WHEN in WHILE loop, or more than
633 -- one EXIT WHEN statement present in the loop.
635 if Present (Expression) then
636 return;
638 -- Otherwise capture condition from EXIT WHEN statement
640 else
641 Expression := Condition (Exit_Stmt);
642 end if;
644 -- If an unconditional exit statement is the last statement in the
645 -- loop, assume that no warning is needed, without any attempt at
646 -- checking whether the exit is reachable.
648 elsif Exit_Stmt = Last (Statements (Loop_Statement)) then
649 return;
650 end if;
652 Exit_Stmt := Next_Exit_Statement (Exit_Stmt);
653 end loop;
654 end;
656 -- Return if no condition to test
658 if No (Expression) then
659 return;
660 end if;
662 -- Initial conditions met, see if condition is of right form
664 Find_Var (Expression);
666 -- Nothing to do if local variable from source not found. If it's a
667 -- renaming, it is probably renaming something too complicated to deal
668 -- with here.
670 if No (Var)
671 or else Ekind (Var) /= E_Variable
672 or else Is_Library_Level_Entity (Var)
673 or else not Comes_From_Source (Var)
674 or else Nkind (Parent (Var)) = N_Object_Renaming_Declaration
675 then
676 return;
678 -- Nothing to do if there is some indirection involved (assume that the
679 -- designated variable might be modified in some way we don't see).
680 -- However, if no function call was found, then we don't care about
681 -- indirections, because the condition must be something like "while X
682 -- /= null loop", so we don't care if X.all is modified in the loop.
684 elsif Function_Call_Found and then Has_Indirection (Etype (Var)) then
685 return;
687 -- Same sort of thing for volatile variable, might be modified by
688 -- some other task or by the operating system in some way.
690 elsif Is_Volatile (Var) then
691 return;
692 end if;
694 -- Filter out case of original statement sequence starting with delay.
695 -- We assume this is a multi-tasking program and that the condition
696 -- is affected by other threads (some kind of busy wait).
698 declare
699 Fstm : constant Node_Id :=
700 Original_Node (First (Statements (Loop_Statement)));
701 begin
702 if Nkind (Fstm) = N_Delay_Relative_Statement
703 or else Nkind (Fstm) = N_Delay_Until_Statement
704 then
705 return;
706 end if;
707 end;
709 -- We have a variable reference of the right form, now we scan the loop
710 -- body to see if it looks like it might not be modified
712 if No_Ref_Found (Loop_Statement) = OK then
713 Error_Msg_NE
714 ("??variable& is not modified in loop body!", Ref, Var);
715 Error_Msg_N
716 ("\??possible infinite loop!", Ref);
717 end if;
718 end Check_Infinite_Loop_Warning;
720 ----------------------------
721 -- Check_Low_Bound_Tested --
722 ----------------------------
724 procedure Check_Low_Bound_Tested (Expr : Node_Id) is
725 begin
726 if Comes_From_Source (Expr) then
727 declare
728 L : constant Node_Id := Left_Opnd (Expr);
729 R : constant Node_Id := Right_Opnd (Expr);
730 begin
731 if Nkind (L) = N_Attribute_Reference
732 and then Attribute_Name (L) = Name_First
733 and then Is_Entity_Name (Prefix (L))
734 and then Is_Formal (Entity (Prefix (L)))
735 then
736 Set_Low_Bound_Tested (Entity (Prefix (L)));
737 end if;
739 if Nkind (R) = N_Attribute_Reference
740 and then Attribute_Name (R) = Name_First
741 and then Is_Entity_Name (Prefix (R))
742 and then Is_Formal (Entity (Prefix (R)))
743 then
744 Set_Low_Bound_Tested (Entity (Prefix (R)));
745 end if;
746 end;
747 end if;
748 end Check_Low_Bound_Tested;
750 ----------------------
751 -- Check_References --
752 ----------------------
754 procedure Check_References (E : Entity_Id; Anod : Node_Id := Empty) is
755 E1 : Entity_Id;
756 E1T : Entity_Id;
757 UR : Node_Id;
759 function Body_Formal
760 (E : Entity_Id;
761 Accept_Statement : Node_Id) return Entity_Id;
762 -- For an entry formal entity from an entry declaration, find the
763 -- corresponding body formal from the given accept statement.
765 procedure May_Need_Initialized_Actual (Ent : Entity_Id);
766 -- If an entity of a generic type has default initialization, then the
767 -- corresponding actual type should be fully initialized, or else there
768 -- will be uninitialized components in the instantiation, that might go
769 -- unreported. This routine marks the type of the uninitialized variable
770 -- appropriately to allow the compiler to emit an appropriate warning
771 -- in the instance. In a sense, the use of a type that requires full
772 -- initialization is a weak part of the generic contract.
774 function Missing_Subunits return Boolean;
775 -- We suppress warnings when there are missing subunits, because this
776 -- may generate too many false positives: entities in a parent may only
777 -- be referenced in one of the subunits. We make an exception for
778 -- subunits that contain no other stubs.
780 procedure Output_Reference_Error (M : String);
781 -- Used to output an error message. Deals with posting the error on the
782 -- body formal in the accept case.
784 function Publicly_Referenceable (Ent : Entity_Id) return Boolean;
785 -- This is true if the entity in question is potentially referenceable
786 -- from another unit. This is true for entities in packages that are at
787 -- the library level.
789 function Warnings_Off_E1 return Boolean;
790 -- Return True if Warnings_Off is set for E1, or for its Etype (E1T),
791 -- or for the base type of E1T.
793 -----------------
794 -- Body_Formal --
795 -----------------
797 function Body_Formal
798 (E : Entity_Id;
799 Accept_Statement : Node_Id) return Entity_Id
801 Body_Param : Node_Id;
802 Body_E : Entity_Id;
804 begin
805 -- Loop to find matching parameter in accept statement
807 Body_Param := First (Parameter_Specifications (Accept_Statement));
808 while Present (Body_Param) loop
809 Body_E := Defining_Identifier (Body_Param);
811 if Chars (Body_E) = Chars (E) then
812 return Body_E;
813 end if;
815 Next (Body_Param);
816 end loop;
818 -- Should never fall through, should always find a match
820 raise Program_Error;
821 end Body_Formal;
823 ---------------------------------
824 -- May_Need_Initialized_Actual --
825 ---------------------------------
827 procedure May_Need_Initialized_Actual (Ent : Entity_Id) is
828 T : constant Entity_Id := Etype (Ent);
829 Par : constant Node_Id := Parent (T);
831 begin
832 if not Is_Generic_Type (T) then
833 null;
835 elsif (Nkind (Par)) = N_Private_Extension_Declaration then
837 -- We only indicate the first such variable in the generic.
839 if No (Uninitialized_Variable (Par)) then
840 Set_Uninitialized_Variable (Par, Ent);
841 end if;
843 elsif (Nkind (Par)) = N_Formal_Type_Declaration
844 and then Nkind (Formal_Type_Definition (Par)) =
845 N_Formal_Private_Type_Definition
846 then
847 if No (Uninitialized_Variable (Formal_Type_Definition (Par))) then
848 Set_Uninitialized_Variable (Formal_Type_Definition (Par), Ent);
849 end if;
850 end if;
851 end May_Need_Initialized_Actual;
853 ----------------------
854 -- Missing_Subunits --
855 ----------------------
857 function Missing_Subunits return Boolean is
858 D : Node_Id;
860 begin
861 if not Unloaded_Subunits then
863 -- Normal compilation, all subunits are present
865 return False;
867 elsif E /= Main_Unit_Entity then
869 -- No warnings on a stub that is not the main unit
871 return True;
873 elsif Nkind (Unit_Declaration_Node (E)) in N_Proper_Body then
874 D := First (Declarations (Unit_Declaration_Node (E)));
875 while Present (D) loop
877 -- No warnings if the proper body contains nested stubs
879 if Nkind (D) in N_Body_Stub then
880 return True;
881 end if;
883 Next (D);
884 end loop;
886 return False;
888 else
889 -- Missing stubs elsewhere
891 return True;
892 end if;
893 end Missing_Subunits;
895 ----------------------------
896 -- Output_Reference_Error --
897 ----------------------------
899 procedure Output_Reference_Error (M : String) is
900 begin
901 -- Never issue messages for internal names, nor for renamings
903 if Is_Internal_Name (Chars (E1))
904 or else Nkind (Parent (E1)) = N_Object_Renaming_Declaration
905 then
906 return;
907 end if;
909 -- Don't output message for IN OUT formal unless we have the warning
910 -- flag specifically set. It is a bit odd to distinguish IN OUT
911 -- formals from other cases. This distinction is historical in
912 -- nature. Warnings for IN OUT formals were added fairly late.
914 if Ekind (E1) = E_In_Out_Parameter
915 and then not Check_Unreferenced_Formals
916 then
917 return;
918 end if;
920 -- Other than accept case, post error on defining identifier
922 if No (Anod) then
923 Error_Msg_N (M, E1);
925 -- Accept case, find body formal to post the message
927 else
928 Error_Msg_NE (M, Body_Formal (E1, Accept_Statement => Anod), E1);
930 end if;
931 end Output_Reference_Error;
933 ----------------------------
934 -- Publicly_Referenceable --
935 ----------------------------
937 function Publicly_Referenceable (Ent : Entity_Id) return Boolean is
938 P : Node_Id;
939 Prev : Node_Id;
941 begin
942 -- A formal parameter is never referenceable outside the body of its
943 -- subprogram or entry.
945 if Is_Formal (Ent) then
946 return False;
947 end if;
949 -- Examine parents to look for a library level package spec. But if
950 -- we find a body or block or other similar construct along the way,
951 -- we cannot be referenced.
953 Prev := Ent;
954 P := Parent (Ent);
955 loop
956 case Nkind (P) is
958 -- If we get to top of tree, then publicly referenceable
960 when N_Empty =>
961 return True;
963 -- If we reach a generic package declaration, then always
964 -- consider this referenceable, since any instantiation will
965 -- have access to the entities in the generic package. Note
966 -- that the package itself may not be instantiated, but then
967 -- we will get a warning for the package entity.
969 -- Note that generic formal parameters are themselves not
970 -- publicly referenceable in an instance, and warnings on them
971 -- are useful.
973 when N_Generic_Package_Declaration =>
974 return
975 not Is_List_Member (Prev)
976 or else List_Containing (Prev) /=
977 Generic_Formal_Declarations (P);
979 -- Similarly, the generic formals of a generic subprogram are
980 -- not accessible.
982 when N_Generic_Subprogram_Declaration =>
983 if Is_List_Member (Prev)
984 and then List_Containing (Prev) =
985 Generic_Formal_Declarations (P)
986 then
987 return False;
988 else
989 P := Parent (P);
990 end if;
992 -- If we reach a subprogram body, entity is not referenceable
993 -- unless it is the defining entity of the body. This will
994 -- happen, e.g. when a function is an attribute renaming that
995 -- is rewritten as a body.
997 when N_Subprogram_Body =>
998 if Ent /= Defining_Entity (P) then
999 return False;
1000 else
1001 P := Parent (P);
1002 end if;
1004 -- If we reach any other body, definitely not referenceable
1006 when N_Package_Body |
1007 N_Task_Body |
1008 N_Entry_Body |
1009 N_Protected_Body |
1010 N_Block_Statement |
1011 N_Subunit =>
1012 return False;
1014 -- For all other cases, keep looking up tree
1016 when others =>
1017 Prev := P;
1018 P := Parent (P);
1019 end case;
1020 end loop;
1021 end Publicly_Referenceable;
1023 ---------------------
1024 -- Warnings_Off_E1 --
1025 ---------------------
1027 function Warnings_Off_E1 return Boolean is
1028 begin
1029 return Has_Warnings_Off (E1T)
1030 or else Has_Warnings_Off (Base_Type (E1T))
1031 or else Warnings_Off_Check_Spec (E1);
1032 end Warnings_Off_E1;
1034 -- Start of processing for Check_References
1036 begin
1037 Process_Deferred_References;
1039 -- No messages if warnings are suppressed, or if we have detected any
1040 -- real errors so far (this last check avoids junk messages resulting
1041 -- from errors, e.g. a subunit that is not loaded).
1043 if Warning_Mode = Suppress or else Serious_Errors_Detected /= 0 then
1044 return;
1045 end if;
1047 -- We also skip the messages if any subunits were not loaded (see
1048 -- comment in Sem_Ch10 to understand how this is set, and why it is
1049 -- necessary to suppress the warnings in this case).
1051 if Missing_Subunits then
1052 return;
1053 end if;
1055 -- Otherwise loop through entities, looking for suspicious stuff
1057 E1 := First_Entity (E);
1058 while Present (E1) loop
1059 E1T := Etype (E1);
1061 -- We are only interested in source entities. We also don't issue
1062 -- warnings within instances, since the proper place for such
1063 -- warnings is on the template when it is compiled, and we don't
1064 -- issue warnings for variables with names like Junk, Discard etc.
1066 if Comes_From_Source (E1)
1067 and then Instantiation_Location (Sloc (E1)) = No_Location
1068 then
1069 -- We are interested in variables and out/in-out parameters, but
1070 -- we exclude protected types, too complicated to worry about.
1072 if Ekind (E1) = E_Variable
1073 or else
1074 (Ekind_In (E1, E_Out_Parameter, E_In_Out_Parameter)
1075 and then not Is_Protected_Type (Current_Scope))
1076 then
1077 -- Case of an unassigned variable
1079 -- First gather any Unset_Reference indication for E1. In the
1080 -- case of a parameter, it is the Spec_Entity that is relevant.
1082 if Ekind (E1) = E_Out_Parameter
1083 and then Present (Spec_Entity (E1))
1084 then
1085 UR := Unset_Reference (Spec_Entity (E1));
1086 else
1087 UR := Unset_Reference (E1);
1088 end if;
1090 -- Special processing for access types
1092 if Present (UR) and then Is_Access_Type (E1T) then
1094 -- For access types, the only time we made a UR entry was
1095 -- for a dereference, and so we post the appropriate warning
1096 -- here (note that the dereference may not be explicit in
1097 -- the source, for example in the case of a dispatching call
1098 -- with an anonymous access controlling formal, or of an
1099 -- assignment of a pointer involving discriminant check on
1100 -- the designated object).
1102 if not Warnings_Off_E1 then
1103 Error_Msg_NE ("??& may be null!", UR, E1);
1104 end if;
1106 goto Continue;
1108 -- Case of variable that could be a constant. Note that we
1109 -- never signal such messages for generic package entities,
1110 -- since a given instance could have modifications outside
1111 -- the package.
1113 -- Note that we used to check Address_Taken here, but we don't
1114 -- want to do that since it can be set for non-source cases,
1115 -- e.g. the Unrestricted_Access from a valid attribute, and
1116 -- the wanted effect is included in Never_Set_In_Source.
1118 elsif Warn_On_Constant
1119 and then (Ekind (E1) = E_Variable
1120 and then Has_Initial_Value (E1))
1121 and then Never_Set_In_Source_Check_Spec (E1)
1122 and then not Generic_Package_Spec_Entity (E1)
1123 then
1124 -- A special case, if this variable is volatile and not
1125 -- imported, it is not helpful to tell the programmer
1126 -- to mark the variable as constant, since this would be
1127 -- illegal by virtue of RM C.6(13).
1129 if (Is_Volatile (E1) or else Has_Volatile_Components (E1))
1130 and then not Is_Imported (E1)
1131 then
1132 Error_Msg_N
1133 ("?k?& is not modified, volatile has no effect!", E1);
1135 -- Another special case, Exception_Occurrence, this catches
1136 -- the case of exception choice (and a bit more too, but not
1137 -- worth doing more investigation here).
1139 elsif Is_RTE (E1T, RE_Exception_Occurrence) then
1140 null;
1142 -- Here we give the warning if referenced and no pragma
1143 -- Unreferenced or Unmodified is present.
1145 else
1146 -- Variable case
1148 if Ekind (E1) = E_Variable then
1149 if Referenced_Check_Spec (E1)
1150 and then not Has_Pragma_Unreferenced_Check_Spec (E1)
1151 and then not Has_Pragma_Unmodified_Check_Spec (E1)
1152 then
1153 if not Warnings_Off_E1
1154 and then not Has_Junk_Name (E1)
1155 then
1156 Error_Msg_N -- CODEFIX
1157 ("?k?& is not modified, "
1158 & "could be declared constant!",
1159 E1);
1160 end if;
1161 end if;
1162 end if;
1163 end if;
1165 -- Other cases of a variable or parameter never set in source
1167 elsif Never_Set_In_Source_Check_Spec (E1)
1169 -- No warning if warning for this case turned off
1171 and then Warn_On_No_Value_Assigned
1173 -- No warning if address taken somewhere
1175 and then not Address_Taken (E1)
1177 -- No warning if explicit initial value
1179 and then not Has_Initial_Value (E1)
1181 -- No warning for generic package spec entities, since we
1182 -- might set them in a child unit or something like that
1184 and then not Generic_Package_Spec_Entity (E1)
1186 -- No warning if fully initialized type, except that for
1187 -- this purpose we do not consider access types to qualify
1188 -- as fully initialized types (relying on an access type
1189 -- variable being null when it is never set is a bit odd).
1191 -- Also we generate warning for an out parameter that is
1192 -- never referenced, since again it seems odd to rely on
1193 -- default initialization to set an out parameter value.
1195 and then (Is_Access_Type (E1T)
1196 or else Ekind (E1) = E_Out_Parameter
1197 or else not Is_Fully_Initialized_Type (E1T))
1198 then
1199 -- Do not output complaint about never being assigned a
1200 -- value if a pragma Unmodified applies to the variable
1201 -- we are examining, or if it is a parameter, if there is
1202 -- a pragma Unreferenced for the corresponding spec, or
1203 -- if the type is marked as having unreferenced objects.
1204 -- The last is a little peculiar, but better too few than
1205 -- too many warnings in this situation.
1207 if Has_Pragma_Unreferenced_Objects (E1T)
1208 or else Has_Pragma_Unmodified_Check_Spec (E1)
1209 then
1210 null;
1212 -- IN OUT parameter case where parameter is referenced. We
1213 -- separate this out, since this is the case where we delay
1214 -- output of the warning until more information is available
1215 -- (about use in an instantiation or address being taken).
1217 elsif Ekind (E1) = E_In_Out_Parameter
1218 and then Referenced_Check_Spec (E1)
1219 then
1220 -- Suppress warning if private type, and the procedure
1221 -- has a separate declaration in a different unit. This
1222 -- is the case where the client of a package sees only
1223 -- the private type, and it may be quite reasonable
1224 -- for the logical view to be IN OUT, even if the
1225 -- implementation ends up using access types or some
1226 -- other method to achieve the local effect of a
1227 -- modification. On the other hand if the spec and body
1228 -- are in the same unit, we are in the package body and
1229 -- there we have less excuse for a junk IN OUT parameter.
1231 if Has_Private_Declaration (E1T)
1232 and then Present (Spec_Entity (E1))
1233 and then not In_Same_Source_Unit (E1, Spec_Entity (E1))
1234 then
1235 null;
1237 -- Suppress warning for any parameter of a dispatching
1238 -- operation, since it is quite reasonable to have an
1239 -- operation that is overridden, and for some subclasses
1240 -- needs the formal to be IN OUT and for others happens
1241 -- not to assign it.
1243 elsif Is_Dispatching_Operation
1244 (Scope (Goto_Spec_Entity (E1)))
1245 then
1246 null;
1248 -- Suppress warning if composite type contains any access
1249 -- component, since the logical effect of modifying a
1250 -- parameter may be achieved by modifying a referenced
1251 -- object.
1253 elsif Is_Composite_Type (E1T)
1254 and then Has_Access_Values (E1T)
1255 then
1256 null;
1258 -- Suppress warning on formals of an entry body. All
1259 -- references are attached to the formal in the entry
1260 -- declaration, which are marked Is_Entry_Formal.
1262 elsif Ekind (Scope (E1)) = E_Entry
1263 and then not Is_Entry_Formal (E1)
1264 then
1265 null;
1267 -- OK, looks like warning for an IN OUT parameter that
1268 -- could be IN makes sense, but we delay the output of
1269 -- the warning, pending possibly finding out later on
1270 -- that the associated subprogram is used as a generic
1271 -- actual, or its address/access is taken. In these two
1272 -- cases, we suppress the warning because the context may
1273 -- force use of IN OUT, even if in this particular case
1274 -- the formal is not modified.
1276 else
1277 -- Suppress the warnings for a junk name
1279 if not Has_Junk_Name (E1) then
1280 In_Out_Warnings.Append (E1);
1281 end if;
1282 end if;
1284 -- Other cases of formals
1286 elsif Is_Formal (E1) then
1287 if not Is_Trivial_Subprogram (Scope (E1)) then
1288 if Referenced_Check_Spec (E1) then
1289 if not Has_Pragma_Unmodified_Check_Spec (E1)
1290 and then not Warnings_Off_E1
1291 and then not Has_Junk_Name (E1)
1292 then
1293 Output_Reference_Error
1294 ("?f?formal parameter& is read but "
1295 & "never assigned!");
1296 end if;
1298 elsif not Has_Pragma_Unreferenced_Check_Spec (E1)
1299 and then not Warnings_Off_E1
1300 and then not Has_Junk_Name (E1)
1301 then
1302 Output_Reference_Error
1303 ("?f?formal parameter& is not referenced!");
1304 end if;
1305 end if;
1307 -- Case of variable
1309 else
1310 if Referenced (E1) then
1311 if not Has_Unmodified (E1)
1312 and then not Warnings_Off_E1
1313 and then not Has_Junk_Name (E1)
1314 then
1315 Output_Reference_Error
1316 ("?v?variable& is read but never assigned!");
1317 May_Need_Initialized_Actual (E1);
1318 end if;
1320 elsif not Has_Unreferenced (E1)
1321 and then not Warnings_Off_E1
1322 and then not Has_Junk_Name (E1)
1323 then
1324 Output_Reference_Error -- CODEFIX
1325 ("?v?variable& is never read and never assigned!");
1326 end if;
1328 -- Deal with special case where this variable is hidden
1329 -- by a loop variable.
1331 if Ekind (E1) = E_Variable
1332 and then Present (Hiding_Loop_Variable (E1))
1333 and then not Warnings_Off_E1
1334 then
1335 Error_Msg_N
1336 ("?v?for loop implicitly declares loop variable!",
1337 Hiding_Loop_Variable (E1));
1339 Error_Msg_Sloc := Sloc (E1);
1340 Error_Msg_N
1341 ("\?v?declaration hides & declared#!",
1342 Hiding_Loop_Variable (E1));
1343 end if;
1344 end if;
1346 goto Continue;
1347 end if;
1349 -- Check for unset reference
1351 if Warn_On_No_Value_Assigned and then Present (UR) then
1353 -- For other than access type, go back to original node to
1354 -- deal with case where original unset reference has been
1355 -- rewritten during expansion.
1357 -- In some cases, the original node may be a type conversion
1358 -- or qualification, and in this case we want the object
1359 -- entity inside.
1361 UR := Original_Node (UR);
1362 while Nkind (UR) = N_Type_Conversion
1363 or else Nkind (UR) = N_Qualified_Expression
1364 or else Nkind (UR) = N_Expression_With_Actions
1365 loop
1366 UR := Expression (UR);
1367 end loop;
1369 -- Don't issue warning if appearing inside Initial_Condition
1370 -- pragma or aspect, since that expression is not evaluated
1371 -- at the point where it occurs in the source.
1373 if In_Pragma_Expression (UR, Name_Initial_Condition) then
1374 goto Continue;
1375 end if;
1377 -- Here we issue the warning, all checks completed
1379 -- If we have a return statement, this was a case of an OUT
1380 -- parameter not being set at the time of the return. (Note:
1381 -- it can't be N_Extended_Return_Statement, because those
1382 -- are only for functions, and functions do not allow OUT
1383 -- parameters.)
1385 if not Is_Trivial_Subprogram (Scope (E1)) then
1386 if Nkind (UR) = N_Simple_Return_Statement
1387 and then not Has_Pragma_Unmodified_Check_Spec (E1)
1388 then
1389 if not Warnings_Off_E1
1390 and then not Has_Junk_Name (E1)
1391 then
1392 Error_Msg_NE
1393 ("?v?OUT parameter& not set before return",
1394 UR, E1);
1395 end if;
1397 -- If the unset reference is a selected component
1398 -- prefix from source, mention the component as well.
1399 -- If the selected component comes from expansion, all
1400 -- we know is that the entity is not fully initialized
1401 -- at the point of the reference. Locate a random
1402 -- uninitialized component to get a better message.
1404 elsif Nkind (Parent (UR)) = N_Selected_Component then
1405 Error_Msg_Node_2 := Selector_Name (Parent (UR));
1407 if not Comes_From_Source (Parent (UR)) then
1408 declare
1409 Comp : Entity_Id;
1411 begin
1412 Comp := First_Entity (E1T);
1413 while Present (Comp) loop
1414 if Ekind (Comp) = E_Component
1415 and then Nkind (Parent (Comp)) =
1416 N_Component_Declaration
1417 and then No (Expression (Parent (Comp)))
1418 then
1419 Error_Msg_Node_2 := Comp;
1420 exit;
1421 end if;
1423 Next_Entity (Comp);
1424 end loop;
1425 end;
1426 end if;
1428 -- Issue proper warning. This is a case of referencing
1429 -- a variable before it has been explicitly assigned.
1430 -- For access types, UR was only set for dereferences,
1431 -- so the issue is that the value may be null.
1433 if not Is_Trivial_Subprogram (Scope (E1)) then
1434 if not Warnings_Off_E1 then
1435 if Is_Access_Type (Etype (Parent (UR))) then
1436 Error_Msg_N ("??`&.&` may be null!", UR);
1437 else
1438 Error_Msg_N
1439 ("??`&.&` may be referenced before "
1440 & "it has a value!", UR);
1441 end if;
1442 end if;
1443 end if;
1445 -- All other cases of unset reference active
1447 elsif not Warnings_Off_E1 then
1448 Error_Msg_N
1449 ("??& may be referenced before it has a value!", UR);
1450 end if;
1451 end if;
1453 goto Continue;
1455 end if;
1456 end if;
1458 -- Then check for unreferenced entities. Note that we are only
1459 -- interested in entities whose Referenced flag is not set.
1461 if not Referenced_Check_Spec (E1)
1463 -- If Referenced_As_LHS is set, then that's still interesting
1464 -- (potential "assigned but never read" case), but not if we
1465 -- have pragma Unreferenced, which cancels this warning.
1467 and then (not Referenced_As_LHS_Check_Spec (E1)
1468 or else not Has_Unreferenced (E1))
1470 -- Check that warnings on unreferenced entities are enabled
1472 and then
1473 ((Check_Unreferenced and then not Is_Formal (E1))
1475 -- Case of warning on unreferenced formal
1477 or else (Check_Unreferenced_Formals and then Is_Formal (E1))
1479 -- Case of warning on unread variables modified by an
1480 -- assignment, or an OUT parameter if it is the only one.
1482 or else (Warn_On_Modified_Unread
1483 and then Referenced_As_LHS_Check_Spec (E1))
1485 -- Case of warning on any unread OUT parameter (note such
1486 -- indications are only set if the appropriate warning
1487 -- options were set, so no need to recheck here.)
1489 or else Referenced_As_Out_Parameter_Check_Spec (E1))
1491 -- All other entities, including local packages that cannot be
1492 -- referenced from elsewhere, including those declared within a
1493 -- package body.
1495 and then (Is_Object (E1)
1496 or else Is_Type (E1)
1497 or else Ekind (E1) = E_Label
1498 or else Ekind_In (E1, E_Exception,
1499 E_Named_Integer,
1500 E_Named_Real)
1501 or else Is_Overloadable (E1)
1503 -- Package case, if the main unit is a package spec
1504 -- or generic package spec, then there may be a
1505 -- corresponding body that references this package
1506 -- in some other file. Otherwise we can be sure
1507 -- that there is no other reference.
1509 or else
1510 (Ekind (E1) = E_Package
1511 and then
1512 not Is_Package_Or_Generic_Package
1513 (Cunit_Entity (Current_Sem_Unit))))
1515 -- Exclude instantiations, since there is no reason why every
1516 -- entity in an instantiation should be referenced.
1518 and then Instantiation_Location (Sloc (E1)) = No_Location
1520 -- Exclude formal parameters from bodies if the corresponding
1521 -- spec entity has been referenced in the case where there is
1522 -- a separate spec.
1524 and then not (Is_Formal (E1)
1525 and then Ekind (Scope (E1)) = E_Subprogram_Body
1526 and then Present (Spec_Entity (E1))
1527 and then Referenced (Spec_Entity (E1)))
1529 -- Consider private type referenced if full view is referenced.
1530 -- If there is not full view, this is a generic type on which
1531 -- warnings are also useful.
1533 and then
1534 not (Is_Private_Type (E1)
1535 and then Present (Full_View (E1))
1536 and then Referenced (Full_View (E1)))
1538 -- Don't worry about full view, only about private type
1540 and then not Has_Private_Declaration (E1)
1542 -- Eliminate dispatching operations from consideration, we
1543 -- cannot tell if these are referenced or not in any easy
1544 -- manner (note this also catches Adjust/Finalize/Initialize).
1546 and then not Is_Dispatching_Operation (E1)
1548 -- Check entity that can be publicly referenced (we do not give
1549 -- messages for such entities, since there could be other
1550 -- units, not involved in this compilation, that contain
1551 -- relevant references.
1553 and then not Publicly_Referenceable (E1)
1555 -- Class wide types are marked as source entities, but they are
1556 -- not really source entities, and are always created, so we do
1557 -- not care if they are not referenced.
1559 and then Ekind (E1) /= E_Class_Wide_Type
1561 -- Objects other than parameters of task types are allowed to
1562 -- be non-referenced, since they start up tasks.
1564 and then ((Ekind (E1) /= E_Variable
1565 and then Ekind (E1) /= E_Constant
1566 and then Ekind (E1) /= E_Component)
1567 or else not Is_Task_Type (E1T))
1569 -- For subunits, only place warnings on the main unit itself,
1570 -- since parent units are not completely compiled.
1572 and then (Nkind (Unit (Cunit (Main_Unit))) /= N_Subunit
1573 or else Get_Source_Unit (E1) = Main_Unit)
1575 -- No warning on a return object, because these are often
1576 -- created with a single expression and an implicit return.
1577 -- If the object is a variable there will be a warning
1578 -- indicating that it could be declared constant.
1580 and then not
1581 (Ekind (E1) = E_Constant and then Is_Return_Object (E1))
1582 then
1583 -- Suppress warnings in internal units if not in -gnatg mode
1584 -- (these would be junk warnings for an applications program,
1585 -- since they refer to problems in internal units).
1587 if GNAT_Mode
1588 or else not Is_Internal_File_Name
1589 (Unit_File_Name (Get_Source_Unit (E1)))
1590 then
1591 -- We do not immediately flag the error. This is because we
1592 -- have not expanded generic bodies yet, and they may have
1593 -- the missing reference. So instead we park the entity on a
1594 -- list, for later processing. However for the case of an
1595 -- accept statement we want to output messages now, since
1596 -- we know we already have all information at hand, and we
1597 -- also want to have separate warnings for each accept
1598 -- statement for the same entry.
1600 if Present (Anod) then
1601 pragma Assert (Is_Formal (E1));
1603 -- The unreferenced entity is E1, but post the warning
1604 -- on the body entity for this accept statement.
1606 if not Warnings_Off_E1 then
1607 Warn_On_Unreferenced_Entity
1608 (E1, Body_Formal (E1, Accept_Statement => Anod));
1609 end if;
1611 elsif not Warnings_Off_E1
1612 and then not Has_Junk_Name (E1)
1613 then
1614 Unreferenced_Entities.Append (E1);
1615 end if;
1616 end if;
1618 -- Generic units are referenced in the generic body, but if they
1619 -- are not public and never instantiated we want to force a
1620 -- warning on them. We treat them as redundant constructs to
1621 -- minimize noise.
1623 elsif Is_Generic_Subprogram (E1)
1624 and then not Is_Instantiated (E1)
1625 and then not Publicly_Referenceable (E1)
1626 and then Instantiation_Depth (Sloc (E1)) = 0
1627 and then Warn_On_Redundant_Constructs
1628 then
1629 if not Warnings_Off_E1 and then not Has_Junk_Name (E1) then
1630 Unreferenced_Entities.Append (E1);
1632 -- Force warning on entity
1634 Set_Referenced (E1, False);
1635 end if;
1636 end if;
1637 end if;
1639 -- Recurse into nested package or block. Do not recurse into a formal
1640 -- package, because the corresponding body is not analyzed.
1642 <<Continue>>
1643 if (Is_Package_Or_Generic_Package (E1)
1644 and then Nkind (Parent (E1)) = N_Package_Specification
1645 and then
1646 Nkind (Original_Node (Unit_Declaration_Node (E1))) /=
1647 N_Formal_Package_Declaration)
1649 or else Ekind (E1) = E_Block
1650 then
1651 Check_References (E1);
1652 end if;
1654 Next_Entity (E1);
1655 end loop;
1656 end Check_References;
1658 ---------------------------
1659 -- Check_Unset_Reference --
1660 ---------------------------
1662 procedure Check_Unset_Reference (N : Node_Id) is
1663 Typ : constant Entity_Id := Etype (N);
1665 function Is_OK_Fully_Initialized return Boolean;
1666 -- This function returns true if the given node N is fully initialized
1667 -- so that the reference is safe as far as this routine is concerned.
1668 -- Safe generally means that the type of N is a fully initialized type.
1669 -- The one special case is that for access types, which are always fully
1670 -- initialized, we don't consider a dereference OK since it will surely
1671 -- be dereferencing a null value, which won't do.
1673 function Prefix_Has_Dereference (Pref : Node_Id) return Boolean;
1674 -- Used to test indexed or selected component or slice to see if the
1675 -- evaluation of the prefix depends on a dereference, and if so, returns
1676 -- True, in which case we always check the prefix, even if we know that
1677 -- the referenced component is initialized. Pref is the prefix to test.
1679 -----------------------------
1680 -- Is_OK_Fully_Initialized --
1681 -----------------------------
1683 function Is_OK_Fully_Initialized return Boolean is
1684 begin
1685 if Is_Access_Type (Typ) and then Is_Dereferenced (N) then
1686 return False;
1687 else
1688 return Is_Fully_Initialized_Type (Typ);
1689 end if;
1690 end Is_OK_Fully_Initialized;
1692 ----------------------------
1693 -- Prefix_Has_Dereference --
1694 ----------------------------
1696 function Prefix_Has_Dereference (Pref : Node_Id) return Boolean is
1697 begin
1698 -- If prefix is of an access type, it certainly needs a dereference
1700 if Is_Access_Type (Etype (Pref)) then
1701 return True;
1703 -- If prefix is explicit dereference, that's a dereference for sure
1705 elsif Nkind (Pref) = N_Explicit_Dereference then
1706 return True;
1708 -- If prefix is itself a component reference or slice check prefix
1710 elsif Nkind (Pref) = N_Slice
1711 or else Nkind (Pref) = N_Indexed_Component
1712 or else Nkind (Pref) = N_Selected_Component
1713 then
1714 return Prefix_Has_Dereference (Prefix (Pref));
1716 -- All other cases do not involve a dereference
1718 else
1719 return False;
1720 end if;
1721 end Prefix_Has_Dereference;
1723 -- Start of processing for Check_Unset_Reference
1725 begin
1726 -- Nothing to do if warnings suppressed
1728 if Warning_Mode = Suppress then
1729 return;
1730 end if;
1732 -- Nothing to do for numeric or string literal. Do this test early to
1733 -- save time in a common case (it does not matter that we do not include
1734 -- character literal here, since that will be caught later on in the
1735 -- when others branch of the case statement).
1737 if Nkind (N) in N_Numeric_Or_String_Literal then
1738 return;
1739 end if;
1741 -- Ignore reference unless it comes from source. Almost always if we
1742 -- have a reference from generated code, it is bogus (e.g. calls to init
1743 -- procs to set default discriminant values).
1745 if not Comes_From_Source (N) then
1746 return;
1747 end if;
1749 -- Otherwise see what kind of node we have. If the entity already has an
1750 -- unset reference, it is not necessarily the earliest in the text,
1751 -- because resolution of the prefix of selected components is completed
1752 -- before the resolution of the selected component itself. As a result,
1753 -- given (R /= null and then R.X > 0), the occurrences of R are examined
1754 -- in right-to-left order. If there is already an unset reference, we
1755 -- check whether N is earlier before proceeding.
1757 case Nkind (N) is
1759 -- For identifier or expanded name, examine the entity involved
1761 when N_Identifier | N_Expanded_Name =>
1762 declare
1763 E : constant Entity_Id := Entity (N);
1765 begin
1766 if Ekind_In (E, E_Variable, E_Out_Parameter)
1767 and then Never_Set_In_Source_Check_Spec (E)
1768 and then not Has_Initial_Value (E)
1769 and then (No (Unset_Reference (E))
1770 or else
1771 Earlier_In_Extended_Unit
1772 (Sloc (N), Sloc (Unset_Reference (E))))
1773 and then not Has_Pragma_Unmodified_Check_Spec (E)
1774 and then not Warnings_Off_Check_Spec (E)
1775 and then not Has_Junk_Name (E)
1776 then
1777 -- We may have an unset reference. The first test is whether
1778 -- this is an access to a discriminant of a record or a
1779 -- component with default initialization. Both of these
1780 -- cases can be ignored, since the actual object that is
1781 -- referenced is definitely initialized. Note that this
1782 -- covers the case of reading discriminants of an OUT
1783 -- parameter, which is OK even in Ada 83.
1785 -- Note that we are only interested in a direct reference to
1786 -- a record component here. If the reference is through an
1787 -- access type, then the access object is being referenced,
1788 -- not the record, and still deserves an unset reference.
1790 if Nkind (Parent (N)) = N_Selected_Component
1791 and not Is_Access_Type (Typ)
1792 then
1793 declare
1794 ES : constant Entity_Id :=
1795 Entity (Selector_Name (Parent (N)));
1796 begin
1797 if Ekind (ES) = E_Discriminant
1798 or else
1799 (Present (Declaration_Node (ES))
1800 and then
1801 Present (Expression (Declaration_Node (ES))))
1802 then
1803 return;
1804 end if;
1805 end;
1806 end if;
1808 -- Exclude fully initialized types
1810 if Is_OK_Fully_Initialized then
1811 return;
1812 end if;
1814 -- Here we have a potential unset reference. But before we
1815 -- get worried about it, we have to make sure that the
1816 -- entity declaration is in the same procedure as the
1817 -- reference, since if they are in separate procedures, then
1818 -- we have no idea about sequential execution.
1820 -- The tests in the loop below catch all such cases, but do
1821 -- allow the reference to appear in a loop, block, or
1822 -- package spec that is nested within the declaring scope.
1823 -- As always, it is possible to construct cases where the
1824 -- warning is wrong, that is why it is a warning.
1826 Potential_Unset_Reference : declare
1827 SR : Entity_Id;
1828 SE : constant Entity_Id := Scope (E);
1830 function Within_Postcondition return Boolean;
1831 -- Returns True if N is within a Postcondition, a
1832 -- Refined_Post, an Ensures component in a Test_Case,
1833 -- or a Contract_Cases.
1835 --------------------------
1836 -- Within_Postcondition --
1837 --------------------------
1839 function Within_Postcondition return Boolean is
1840 Nod, P : Node_Id;
1842 begin
1843 Nod := Parent (N);
1844 while Present (Nod) loop
1845 if Nkind (Nod) = N_Pragma
1846 and then Nam_In (Pragma_Name (Nod),
1847 Name_Postcondition,
1848 Name_Refined_Post,
1849 Name_Contract_Cases)
1850 then
1851 return True;
1853 elsif Present (Parent (Nod)) then
1854 P := Parent (Nod);
1856 if Nkind (P) = N_Pragma
1857 and then Pragma_Name (P) = Name_Test_Case
1858 and then Nod = Get_Ensures_From_CTC_Pragma (P)
1859 then
1860 return True;
1861 end if;
1862 end if;
1864 Nod := Parent (Nod);
1865 end loop;
1867 return False;
1868 end Within_Postcondition;
1870 -- Start of processing for Potential_Unset_Reference
1872 begin
1873 SR := Current_Scope;
1874 while SR /= SE loop
1875 if SR = Standard_Standard
1876 or else Is_Subprogram (SR)
1877 or else Is_Concurrent_Body (SR)
1878 or else Is_Concurrent_Type (SR)
1879 then
1880 return;
1881 end if;
1883 SR := Scope (SR);
1884 end loop;
1886 -- Case of reference has an access type. This is a
1887 -- special case since access types are always set to null
1888 -- so cannot be truly uninitialized, but we still want to
1889 -- warn about cases of obvious null dereference.
1891 if Is_Access_Type (Typ) then
1892 Access_Type_Case : declare
1893 P : Node_Id;
1895 function Process
1896 (N : Node_Id) return Traverse_Result;
1897 -- Process function for instantiation of Traverse
1898 -- below. Checks if N contains reference to E other
1899 -- than a dereference.
1901 function Ref_In (Nod : Node_Id) return Boolean;
1902 -- Determines whether Nod contains a reference to
1903 -- the entity E that is not a dereference.
1905 -------------
1906 -- Process --
1907 -------------
1909 function Process
1910 (N : Node_Id) return Traverse_Result
1912 begin
1913 if Is_Entity_Name (N)
1914 and then Entity (N) = E
1915 and then not Is_Dereferenced (N)
1916 then
1917 return Abandon;
1918 else
1919 return OK;
1920 end if;
1921 end Process;
1923 ------------
1924 -- Ref_In --
1925 ------------
1927 function Ref_In (Nod : Node_Id) return Boolean is
1928 function Traverse is new Traverse_Func (Process);
1929 begin
1930 return Traverse (Nod) = Abandon;
1931 end Ref_In;
1933 -- Start of processing for Access_Type_Case
1935 begin
1936 -- Don't bother if we are inside an instance, since
1937 -- the compilation of the generic template is where
1938 -- the warning should be issued.
1940 if In_Instance then
1941 return;
1942 end if;
1944 -- Don't bother if this is not the main unit. If we
1945 -- try to give this warning for with'ed units, we
1946 -- get some false positives, since we do not record
1947 -- references in other units.
1949 if not In_Extended_Main_Source_Unit (E)
1950 or else
1951 not In_Extended_Main_Source_Unit (N)
1952 then
1953 return;
1954 end if;
1956 -- We are only interested in dereferences
1958 if not Is_Dereferenced (N) then
1959 return;
1960 end if;
1962 -- One more check, don't bother with references
1963 -- that are inside conditional statements or WHILE
1964 -- loops if the condition references the entity in
1965 -- question. This avoids most false positives.
1967 P := Parent (N);
1968 loop
1969 P := Parent (P);
1970 exit when No (P);
1972 if Nkind_In (P, N_If_Statement, N_Elsif_Part)
1973 and then Ref_In (Condition (P))
1974 then
1975 return;
1977 elsif Nkind (P) = N_Loop_Statement
1978 and then Present (Iteration_Scheme (P))
1979 and then
1980 Ref_In (Condition (Iteration_Scheme (P)))
1981 then
1982 return;
1983 end if;
1984 end loop;
1985 end Access_Type_Case;
1986 end if;
1988 -- One more check, don't bother if we are within a
1989 -- postcondition, since the expression occurs in a
1990 -- place unrelated to the actual test.
1992 if not Within_Postcondition then
1994 -- Here we definitely have a case for giving a warning
1995 -- for a reference to an unset value. But we don't
1996 -- give the warning now. Instead set Unset_Reference
1997 -- in the identifier involved. The reason for this is
1998 -- that if we find the variable is never ever assigned
1999 -- a value then that warning is more important and
2000 -- there is no point in giving the reference warning.
2002 -- If this is an identifier, set the field directly
2004 if Nkind (N) = N_Identifier then
2005 Set_Unset_Reference (E, N);
2007 -- Otherwise it is an expanded name, so set the field
2008 -- of the actual identifier for the reference.
2010 else
2011 Set_Unset_Reference (E, Selector_Name (N));
2012 end if;
2013 end if;
2014 end Potential_Unset_Reference;
2015 end if;
2016 end;
2018 -- Indexed component or slice
2020 when N_Indexed_Component | N_Slice =>
2022 -- If prefix does not involve dereferencing an access type, then
2023 -- we know we are OK if the component type is fully initialized,
2024 -- since the component will have been set as part of the default
2025 -- initialization.
2027 if not Prefix_Has_Dereference (Prefix (N))
2028 and then Is_OK_Fully_Initialized
2029 then
2030 return;
2032 -- Look at prefix in access type case, or if the component is not
2033 -- fully initialized.
2035 else
2036 Check_Unset_Reference (Prefix (N));
2037 end if;
2039 -- Record component
2041 when N_Selected_Component =>
2042 declare
2043 Pref : constant Node_Id := Prefix (N);
2044 Ent : constant Entity_Id := Entity (Selector_Name (N));
2046 begin
2047 -- If prefix involves dereferencing an access type, always
2048 -- check the prefix, since the issue then is whether this
2049 -- access value is null.
2051 if Prefix_Has_Dereference (Pref) then
2052 null;
2054 -- Always go to prefix if no selector entity is set. Can this
2055 -- happen in the normal case? Not clear, but it definitely can
2056 -- happen in error cases.
2058 elsif No (Ent) then
2059 null;
2061 -- For a record component, check some cases where we have
2062 -- reasonable cause to consider that the component is known to
2063 -- be or probably is initialized. In this case, we don't care
2064 -- if the prefix itself was explicitly initialized.
2066 -- Discriminants are always considered initialized
2068 elsif Ekind (Ent) = E_Discriminant then
2069 return;
2071 -- An explicitly initialized component is certainly initialized
2073 elsif Nkind (Parent (Ent)) = N_Component_Declaration
2074 and then Present (Expression (Parent (Ent)))
2075 then
2076 return;
2078 -- A fully initialized component is initialized
2080 elsif Is_OK_Fully_Initialized then
2081 return;
2082 end if;
2084 -- If none of those cases apply, check the record type prefix
2086 Check_Unset_Reference (Pref);
2087 end;
2089 -- For type conversions, qualifications, or expressions with actions,
2090 -- examine the expression.
2092 when N_Type_Conversion |
2093 N_Qualified_Expression |
2094 N_Expression_With_Actions =>
2095 Check_Unset_Reference (Expression (N));
2097 -- For explicit dereference, always check prefix, which will generate
2098 -- an unset reference (since this is a case of dereferencing null).
2100 when N_Explicit_Dereference =>
2101 Check_Unset_Reference (Prefix (N));
2103 -- All other cases are not cases of an unset reference
2105 when others =>
2106 null;
2108 end case;
2109 end Check_Unset_Reference;
2111 ------------------------
2112 -- Check_Unused_Withs --
2113 ------------------------
2115 procedure Check_Unused_Withs (Spec_Unit : Unit_Number_Type := No_Unit) is
2116 Cnode : Node_Id;
2117 Item : Node_Id;
2118 Lunit : Node_Id;
2119 Ent : Entity_Id;
2121 Munite : constant Entity_Id := Cunit_Entity (Main_Unit);
2122 -- This is needed for checking the special renaming case
2124 procedure Check_One_Unit (Unit : Unit_Number_Type);
2125 -- Subsidiary procedure, performs checks for specified unit
2127 --------------------
2128 -- Check_One_Unit --
2129 --------------------
2131 procedure Check_One_Unit (Unit : Unit_Number_Type) is
2132 Is_Visible_Renaming : Boolean := False;
2133 Pack : Entity_Id;
2135 procedure Check_Inner_Package (Pack : Entity_Id);
2136 -- Pack is a package local to a unit in a with_clause. Both the unit
2137 -- and Pack are referenced. If none of the entities in Pack are
2138 -- referenced, then the only occurrence of Pack is in a USE clause
2139 -- or a pragma, and a warning is worthwhile as well.
2141 function Check_System_Aux return Boolean;
2142 -- Before giving a warning on a with_clause for System, check whether
2143 -- a system extension is present.
2145 function Find_Package_Renaming
2146 (P : Entity_Id;
2147 L : Entity_Id) return Entity_Id;
2148 -- The only reference to a context unit may be in a renaming
2149 -- declaration. If this renaming declares a visible entity, do not
2150 -- warn that the context clause could be moved to the body, because
2151 -- the renaming may be intended to re-export the unit.
2153 function Has_Visible_Entities (P : Entity_Id) return Boolean;
2154 -- This function determines if a package has any visible entities.
2155 -- True is returned if there is at least one declared visible entity,
2156 -- otherwise False is returned (e.g. case of only pragmas present).
2158 -------------------------
2159 -- Check_Inner_Package --
2160 -------------------------
2162 procedure Check_Inner_Package (Pack : Entity_Id) is
2163 E : Entity_Id;
2164 Un : constant Node_Id := Sinfo.Unit (Cnode);
2166 function Check_Use_Clause (N : Node_Id) return Traverse_Result;
2167 -- If N is a use_clause for Pack, emit warning
2169 procedure Check_Use_Clauses is new
2170 Traverse_Proc (Check_Use_Clause);
2172 ----------------------
2173 -- Check_Use_Clause --
2174 ----------------------
2176 function Check_Use_Clause (N : Node_Id) return Traverse_Result is
2177 Nam : Node_Id;
2179 begin
2180 if Nkind (N) = N_Use_Package_Clause then
2181 Nam := First (Names (N));
2182 while Present (Nam) loop
2183 if Entity (Nam) = Pack then
2185 -- Suppress message if any serious errors detected
2186 -- that turn off expansion, and thus result in false
2187 -- positives for this warning.
2189 if Serious_Errors_Detected = 0 then
2190 Error_Msg_Qual_Level := 1;
2191 Error_Msg_NE -- CODEFIX
2192 ("?u?no entities of package& are referenced!",
2193 Nam, Pack);
2194 Error_Msg_Qual_Level := 0;
2195 end if;
2196 end if;
2198 Next (Nam);
2199 end loop;
2200 end if;
2202 return OK;
2203 end Check_Use_Clause;
2205 -- Start of processing for Check_Inner_Package
2207 begin
2208 E := First_Entity (Pack);
2209 while Present (E) loop
2210 if Referenced_Check_Spec (E) then
2211 return;
2212 end if;
2214 Next_Entity (E);
2215 end loop;
2217 -- No entities of the package are referenced. Check whether the
2218 -- reference to the package itself is a use clause, and if so
2219 -- place a warning on it.
2221 Check_Use_Clauses (Un);
2222 end Check_Inner_Package;
2224 ----------------------
2225 -- Check_System_Aux --
2226 ----------------------
2228 function Check_System_Aux return Boolean is
2229 Ent : Entity_Id;
2231 begin
2232 if Chars (Lunit) = Name_System
2233 and then Scope (Lunit) = Standard_Standard
2234 and then Present_System_Aux
2235 then
2236 Ent := First_Entity (System_Aux_Id);
2237 while Present (Ent) loop
2238 if Referenced_Check_Spec (Ent) then
2239 return True;
2240 end if;
2242 Next_Entity (Ent);
2243 end loop;
2244 end if;
2246 return False;
2247 end Check_System_Aux;
2249 ---------------------------
2250 -- Find_Package_Renaming --
2251 ---------------------------
2253 function Find_Package_Renaming
2254 (P : Entity_Id;
2255 L : Entity_Id) return Entity_Id
2257 E1 : Entity_Id;
2258 R : Entity_Id;
2260 begin
2261 Is_Visible_Renaming := False;
2263 E1 := First_Entity (P);
2264 while Present (E1) loop
2265 if Ekind (E1) = E_Package and then Renamed_Object (E1) = L then
2266 Is_Visible_Renaming := not Is_Hidden (E1);
2267 return E1;
2269 elsif Ekind (E1) = E_Package
2270 and then No (Renamed_Object (E1))
2271 and then not Is_Generic_Instance (E1)
2272 then
2273 R := Find_Package_Renaming (E1, L);
2275 if Present (R) then
2276 Is_Visible_Renaming := not Is_Hidden (R);
2277 return R;
2278 end if;
2279 end if;
2281 Next_Entity (E1);
2282 end loop;
2284 return Empty;
2285 end Find_Package_Renaming;
2287 --------------------------
2288 -- Has_Visible_Entities --
2289 --------------------------
2291 function Has_Visible_Entities (P : Entity_Id) return Boolean is
2292 E : Entity_Id;
2294 begin
2295 -- If unit in context is not a package, it is a subprogram that
2296 -- is not called or a generic unit that is not instantiated
2297 -- in the current unit, and warning is appropriate.
2299 if Ekind (P) /= E_Package then
2300 return True;
2301 end if;
2303 -- If unit comes from a limited_with clause, look for declaration
2304 -- of shadow entities.
2306 if Present (Limited_View (P)) then
2307 E := First_Entity (Limited_View (P));
2308 else
2309 E := First_Entity (P);
2310 end if;
2312 while Present (E) and then E /= First_Private_Entity (P) loop
2313 if Comes_From_Source (E) or else Present (Limited_View (P)) then
2314 return True;
2315 end if;
2317 Next_Entity (E);
2318 end loop;
2320 return False;
2321 end Has_Visible_Entities;
2323 -- Start of processing for Check_One_Unit
2325 begin
2326 Cnode := Cunit (Unit);
2328 -- Only do check in units that are part of the extended main unit.
2329 -- This is actually a necessary restriction, because in the case of
2330 -- subprogram acting as its own specification, there can be with's in
2331 -- subunits that we will not see.
2333 if not In_Extended_Main_Source_Unit (Cnode) then
2334 return;
2336 -- In configurable run time mode, we remove the bodies of non-inlined
2337 -- subprograms, which may lead to spurious warnings, which are
2338 -- clearly undesirable.
2340 elsif Configurable_Run_Time_Mode
2341 and then Is_Predefined_File_Name (Unit_File_Name (Unit))
2342 then
2343 return;
2344 end if;
2346 -- Loop through context items in this unit
2348 Item := First (Context_Items (Cnode));
2349 while Present (Item) loop
2350 if Nkind (Item) = N_With_Clause
2351 and then not Implicit_With (Item)
2352 and then In_Extended_Main_Source_Unit (Item)
2353 then
2354 Lunit := Entity (Name (Item));
2356 -- Check if this unit is referenced (skip the check if this
2357 -- is explicitly marked by a pragma Unreferenced).
2359 if not Referenced (Lunit) and then not Has_Unreferenced (Lunit)
2360 then
2361 -- Suppress warnings in internal units if not in -gnatg mode
2362 -- (these would be junk warnings for an application program,
2363 -- since they refer to problems in internal units).
2365 if GNAT_Mode
2366 or else not Is_Internal_File_Name (Unit_File_Name (Unit))
2367 then
2368 -- Here we definitely have a non-referenced unit. If it
2369 -- is the special call for a spec unit, then just set the
2370 -- flag to be read later.
2372 if Unit = Spec_Unit then
2373 Set_Unreferenced_In_Spec (Item);
2375 -- Otherwise simple unreferenced message, but skip this
2376 -- if no visible entities, because that is most likely a
2377 -- case where warning would be false positive (e.g. a
2378 -- package with only a linker options pragma and nothing
2379 -- else or a pragma elaborate with a body library task).
2381 elsif Has_Visible_Entities (Entity (Name (Item))) then
2382 Error_Msg_N -- CODEFIX
2383 ("?u?unit& is not referenced!", Name (Item));
2384 end if;
2385 end if;
2387 -- If main unit is a renaming of this unit, then we consider
2388 -- the with to be OK (obviously it is needed in this case).
2389 -- This may be transitive: the unit in the with_clause may
2390 -- itself be a renaming, in which case both it and the main
2391 -- unit rename the same ultimate package.
2393 elsif Present (Renamed_Entity (Munite))
2394 and then
2395 (Renamed_Entity (Munite) = Lunit
2396 or else Renamed_Entity (Munite) = Renamed_Entity (Lunit))
2397 then
2398 null;
2400 -- If this unit is referenced, and it is a package, we do
2401 -- another test, to see if any of the entities in the package
2402 -- are referenced. If none of the entities are referenced, we
2403 -- still post a warning. This occurs if the only use of the
2404 -- package is in a use clause, or in a package renaming
2405 -- declaration. This check is skipped for packages that are
2406 -- renamed in a spec, since the entities in such a package are
2407 -- visible to clients via the renaming.
2409 elsif Ekind (Lunit) = E_Package
2410 and then not Renamed_In_Spec (Lunit)
2411 then
2412 -- If Is_Instantiated is set, it means that the package is
2413 -- implicitly instantiated (this is the case of parent
2414 -- instance or an actual for a generic package formal), and
2415 -- this counts as a reference.
2417 if Is_Instantiated (Lunit) then
2418 null;
2420 -- If no entities in package, and there is a pragma
2421 -- Elaborate_Body present, then assume that this with is
2422 -- done for purposes of this elaboration.
2424 elsif No (First_Entity (Lunit))
2425 and then Has_Pragma_Elaborate_Body (Lunit)
2426 then
2427 null;
2429 -- Otherwise see if any entities have been referenced
2431 else
2432 if Limited_Present (Item) then
2433 Ent := First_Entity (Limited_View (Lunit));
2434 else
2435 Ent := First_Entity (Lunit);
2436 end if;
2438 loop
2439 -- No more entities, and we did not find one that was
2440 -- referenced. Means we have a definite case of a with
2441 -- none of whose entities was referenced.
2443 if No (Ent) then
2445 -- If in spec, just set the flag
2447 if Unit = Spec_Unit then
2448 Set_No_Entities_Ref_In_Spec (Item);
2450 elsif Check_System_Aux then
2451 null;
2453 -- Else give the warning
2455 else
2456 -- Warn if we unreferenced flag set and we have
2457 -- not had serious errors. The reason we inhibit
2458 -- the message if there are errors is to prevent
2459 -- false positives from disabling expansion.
2461 if not Has_Unreferenced (Entity (Name (Item)))
2462 and then Serious_Errors_Detected = 0
2463 then
2464 Error_Msg_N -- CODEFIX
2465 ("?u?no entities of & are referenced!",
2466 Name (Item));
2467 end if;
2469 -- Look for renamings of this package, and flag
2470 -- them as well. If the original package has
2471 -- warnings off, we suppress the warning on the
2472 -- renaming as well.
2474 Pack := Find_Package_Renaming (Munite, Lunit);
2476 if Present (Pack)
2477 and then not Has_Warnings_Off (Lunit)
2478 and then not Has_Unreferenced (Pack)
2479 then
2480 Error_Msg_NE -- CODEFIX
2481 ("?u?no entities of & are referenced!",
2482 Unit_Declaration_Node (Pack),
2483 Pack);
2484 end if;
2485 end if;
2487 exit;
2489 -- Case of entity being referenced. The reference may
2490 -- come from a limited_with_clause, in which case the
2491 -- limited view of the entity carries the flag.
2493 elsif Referenced_Check_Spec (Ent)
2494 or else Referenced_As_LHS_Check_Spec (Ent)
2495 or else Referenced_As_Out_Parameter_Check_Spec (Ent)
2496 or else
2497 (From_Limited_With (Ent)
2498 and then Is_Incomplete_Type (Ent)
2499 and then Present (Non_Limited_View (Ent))
2500 and then Referenced (Non_Limited_View (Ent)))
2501 then
2502 -- This means that the with is indeed fine, in that
2503 -- it is definitely needed somewhere, and we can
2504 -- quit worrying about this one...
2506 -- Except for one little detail: if either of the
2507 -- flags was set during spec processing, this is
2508 -- where we complain that the with could be moved
2509 -- from the spec. If the spec contains a visible
2510 -- renaming of the package, inhibit warning to move
2511 -- with_clause to body.
2513 if Ekind (Munite) = E_Package_Body then
2514 Pack :=
2515 Find_Package_Renaming
2516 (Spec_Entity (Munite), Lunit);
2517 else
2518 Pack := Empty;
2519 end if;
2521 -- If a renaming is present in the spec do not warn
2522 -- because the body or child unit may depend on it.
2524 if Present (Pack)
2525 and then Renamed_Entity (Pack) = Lunit
2526 then
2527 exit;
2529 elsif Unreferenced_In_Spec (Item) then
2530 Error_Msg_N -- CODEFIX
2531 ("?u?unit& is not referenced in spec!",
2532 Name (Item));
2534 elsif No_Entities_Ref_In_Spec (Item) then
2535 Error_Msg_N -- CODEFIX
2536 ("?u?no entities of & are referenced in spec!",
2537 Name (Item));
2539 else
2540 if Ekind (Ent) = E_Package then
2541 Check_Inner_Package (Ent);
2542 end if;
2544 exit;
2545 end if;
2547 if not Is_Visible_Renaming then
2548 Error_Msg_N -- CODEFIX
2549 ("\?u?with clause might be moved to body!",
2550 Name (Item));
2551 end if;
2553 exit;
2555 -- Move to next entity to continue search
2557 else
2558 Next_Entity (Ent);
2559 end if;
2560 end loop;
2561 end if;
2563 -- For a generic package, the only interesting kind of
2564 -- reference is an instantiation, since entities cannot be
2565 -- referenced directly.
2567 elsif Is_Generic_Unit (Lunit) then
2569 -- Unit was never instantiated, set flag for case of spec
2570 -- call, or give warning for normal call.
2572 if not Is_Instantiated (Lunit) then
2573 if Unit = Spec_Unit then
2574 Set_Unreferenced_In_Spec (Item);
2575 else
2576 Error_Msg_N -- CODEFIX
2577 ("?u?unit& is never instantiated!", Name (Item));
2578 end if;
2580 -- If unit was indeed instantiated, make sure that flag is
2581 -- not set showing it was uninstantiated in the spec, and if
2582 -- so, give warning.
2584 elsif Unreferenced_In_Spec (Item) then
2585 Error_Msg_N
2586 ("?u?unit& is not instantiated in spec!", Name (Item));
2587 Error_Msg_N -- CODEFIX
2588 ("\?u?with clause can be moved to body!", Name (Item));
2589 end if;
2590 end if;
2591 end if;
2593 Next (Item);
2594 end loop;
2595 end Check_One_Unit;
2597 -- Start of processing for Check_Unused_Withs
2599 begin
2600 -- Immediate return if no semantics or warning flag not set
2602 if not Opt.Check_Withs or else Operating_Mode = Check_Syntax then
2603 return;
2604 end if;
2606 Process_Deferred_References;
2608 -- Flag any unused with clauses. For a subunit, check only the units
2609 -- in its context, not those of the parent, which may be needed by other
2610 -- subunits. We will get the full warnings when we compile the parent,
2611 -- but the following is helpful when compiling a subunit by itself.
2613 if Nkind (Unit (Cunit (Main_Unit))) = N_Subunit then
2614 if Current_Sem_Unit = Main_Unit then
2615 Check_One_Unit (Main_Unit);
2616 end if;
2618 return;
2619 end if;
2621 -- Process specified units
2623 if Spec_Unit = No_Unit then
2625 -- For main call, check all units
2627 for Unit in Main_Unit .. Last_Unit loop
2628 Check_One_Unit (Unit);
2629 end loop;
2631 else
2632 -- For call for spec, check only the spec
2634 Check_One_Unit (Spec_Unit);
2635 end if;
2636 end Check_Unused_Withs;
2638 ---------------------------------
2639 -- Generic_Package_Spec_Entity --
2640 ---------------------------------
2642 function Generic_Package_Spec_Entity (E : Entity_Id) return Boolean is
2643 S : Entity_Id;
2645 begin
2646 if Is_Package_Body_Entity (E) then
2647 return False;
2649 else
2650 S := Scope (E);
2651 loop
2652 if S = Standard_Standard then
2653 return False;
2655 elsif Ekind (S) = E_Generic_Package then
2656 return True;
2658 elsif Ekind (S) = E_Package then
2659 S := Scope (S);
2661 else
2662 return False;
2663 end if;
2664 end loop;
2665 end if;
2666 end Generic_Package_Spec_Entity;
2668 ----------------------
2669 -- Goto_Spec_Entity --
2670 ----------------------
2672 function Goto_Spec_Entity (E : Entity_Id) return Entity_Id is
2673 begin
2674 if Is_Formal (E) and then Present (Spec_Entity (E)) then
2675 return Spec_Entity (E);
2676 else
2677 return E;
2678 end if;
2679 end Goto_Spec_Entity;
2681 -------------------
2682 -- Has_Junk_Name --
2683 -------------------
2685 function Has_Junk_Name (E : Entity_Id) return Boolean is
2686 function Match (S : String) return Boolean;
2687 -- Return true if substring S is found in Name_Buffer (1 .. Name_Len)
2689 -----------
2690 -- Match --
2691 -----------
2693 function Match (S : String) return Boolean is
2694 Slen1 : constant Integer := S'Length - 1;
2696 begin
2697 for J in 1 .. Name_Len - S'Length + 1 loop
2698 if Name_Buffer (J .. J + Slen1) = S then
2699 return True;
2700 end if;
2701 end loop;
2703 return False;
2704 end Match;
2706 -- Start of processing for Has_Junk_Name
2708 begin
2709 Get_Unqualified_Decoded_Name_String (Chars (E));
2711 return
2712 Match ("discard") or else
2713 Match ("dummy") or else
2714 Match ("ignore") or else
2715 Match ("junk") or else
2716 Match ("unused");
2717 end Has_Junk_Name;
2719 --------------------------------------
2720 -- Has_Pragma_Unmodified_Check_Spec --
2721 --------------------------------------
2723 function Has_Pragma_Unmodified_Check_Spec
2724 (E : Entity_Id) return Boolean
2726 begin
2727 if Is_Formal (E) and then Present (Spec_Entity (E)) then
2729 -- Note: use of OR instead of OR ELSE here is deliberate, we want
2730 -- to mess with Unmodified flags on both body and spec entities.
2732 return Has_Unmodified (E)
2734 Has_Unmodified (Spec_Entity (E));
2736 else
2737 return Has_Unmodified (E);
2738 end if;
2739 end Has_Pragma_Unmodified_Check_Spec;
2741 ----------------------------------------
2742 -- Has_Pragma_Unreferenced_Check_Spec --
2743 ----------------------------------------
2745 function Has_Pragma_Unreferenced_Check_Spec
2746 (E : Entity_Id) return Boolean
2748 begin
2749 if Is_Formal (E) and then Present (Spec_Entity (E)) then
2751 -- Note: use of OR here instead of OR ELSE is deliberate, we want
2752 -- to mess with flags on both entities.
2754 return Has_Unreferenced (E)
2756 Has_Unreferenced (Spec_Entity (E));
2758 else
2759 return Has_Unreferenced (E);
2760 end if;
2761 end Has_Pragma_Unreferenced_Check_Spec;
2763 ----------------
2764 -- Initialize --
2765 ----------------
2767 procedure Initialize is
2768 begin
2769 Warnings_Off_Pragmas.Init;
2770 Unreferenced_Entities.Init;
2771 In_Out_Warnings.Init;
2772 end Initialize;
2774 ------------------------------------
2775 -- Never_Set_In_Source_Check_Spec --
2776 ------------------------------------
2778 function Never_Set_In_Source_Check_Spec (E : Entity_Id) return Boolean is
2779 begin
2780 if Is_Formal (E) and then Present (Spec_Entity (E)) then
2781 return Never_Set_In_Source (E)
2782 and then
2783 Never_Set_In_Source (Spec_Entity (E));
2784 else
2785 return Never_Set_In_Source (E);
2786 end if;
2787 end Never_Set_In_Source_Check_Spec;
2789 -------------------------------------
2790 -- Operand_Has_Warnings_Suppressed --
2791 -------------------------------------
2793 function Operand_Has_Warnings_Suppressed (N : Node_Id) return Boolean is
2795 function Check_For_Warnings (N : Node_Id) return Traverse_Result;
2796 -- Function used to check one node to see if it is or was originally
2797 -- a reference to an entity for which Warnings are off. If so, Abandon
2798 -- is returned, otherwise OK_Orig is returned to continue the traversal
2799 -- of the original expression.
2801 function Traverse is new Traverse_Func (Check_For_Warnings);
2802 -- Function used to traverse tree looking for warnings
2804 ------------------------
2805 -- Check_For_Warnings --
2806 ------------------------
2808 function Check_For_Warnings (N : Node_Id) return Traverse_Result is
2809 R : constant Node_Id := Original_Node (N);
2811 begin
2812 if Nkind (R) in N_Has_Entity
2813 and then Present (Entity (R))
2814 and then Has_Warnings_Off (Entity (R))
2815 then
2816 return Abandon;
2817 else
2818 return OK_Orig;
2819 end if;
2820 end Check_For_Warnings;
2822 -- Start of processing for Operand_Has_Warnings_Suppressed
2824 begin
2825 return Traverse (N) = Abandon;
2827 -- If any exception occurs, then something has gone wrong, and this is
2828 -- only a minor aesthetic issue anyway, so just say we did not find what
2829 -- we are looking for, rather than blow up.
2831 exception
2832 when others =>
2833 return False;
2834 end Operand_Has_Warnings_Suppressed;
2836 -----------------------------------------
2837 -- Output_Non_Modified_In_Out_Warnings --
2838 -----------------------------------------
2840 procedure Output_Non_Modified_In_Out_Warnings is
2842 function No_Warn_On_In_Out (E : Entity_Id) return Boolean;
2843 -- Given a formal parameter entity E, determines if there is a reason to
2844 -- suppress IN OUT warnings (not modified, could be IN) for formals of
2845 -- the subprogram. We suppress these warnings if Warnings Off is set, or
2846 -- if we have seen the address of the subprogram being taken, or if the
2847 -- subprogram is used as a generic actual (in the latter cases the
2848 -- context may force use of IN OUT, even if the parameter is not
2849 -- modifies for this particular case.
2851 -----------------------
2852 -- No_Warn_On_In_Out --
2853 -----------------------
2855 function No_Warn_On_In_Out (E : Entity_Id) return Boolean is
2856 S : constant Entity_Id := Scope (E);
2857 SE : constant Entity_Id := Spec_Entity (E);
2859 begin
2860 -- Do not warn if address is taken, since funny business may be going
2861 -- on in treating the parameter indirectly as IN OUT.
2863 if Address_Taken (S)
2864 or else (Present (SE) and then Address_Taken (Scope (SE)))
2865 then
2866 return True;
2868 -- Do not warn if used as a generic actual, since the generic may be
2869 -- what is forcing the use of an "unnecessary" IN OUT.
2871 elsif Used_As_Generic_Actual (S)
2872 or else (Present (SE) and then Used_As_Generic_Actual (Scope (SE)))
2873 then
2874 return True;
2876 -- Else test warnings off
2878 elsif Warnings_Off_Check_Spec (S) then
2879 return True;
2881 -- All tests for suppressing warning failed
2883 else
2884 return False;
2885 end if;
2886 end No_Warn_On_In_Out;
2888 -- Start of processing for Output_Non_Modified_In_Out_Warnings
2890 begin
2891 -- Loop through entities for which a warning may be needed
2893 for J in In_Out_Warnings.First .. In_Out_Warnings.Last loop
2894 declare
2895 E1 : constant Entity_Id := In_Out_Warnings.Table (J);
2897 begin
2898 -- Suppress warning in specific cases (see details in comments for
2899 -- No_Warn_On_In_Out), or if there is a pragma Unmodified.
2901 if Has_Pragma_Unmodified_Check_Spec (E1)
2902 or else No_Warn_On_In_Out (E1)
2903 then
2904 null;
2906 -- Here we generate the warning
2908 else
2909 -- If -gnatwc is set then output message that we could be IN
2911 if not Is_Trivial_Subprogram (Scope (E1)) then
2912 if Warn_On_Constant then
2913 Error_Msg_N
2914 ("?u?formal parameter & is not modified!", E1);
2915 Error_Msg_N
2916 ("\?u?mode could be IN instead of `IN OUT`!", E1);
2918 -- We do not generate warnings for IN OUT parameters
2919 -- unless we have at least -gnatwu. This is deliberately
2920 -- inconsistent with the treatment of variables, but
2921 -- otherwise we get too many unexpected warnings in
2922 -- default mode.
2924 elsif Check_Unreferenced then
2925 Error_Msg_N
2926 ("?u?formal parameter& is read but "
2927 & "never assigned!", E1);
2928 end if;
2929 end if;
2931 -- Kill any other warnings on this entity, since this is the
2932 -- one that should dominate any other unreferenced warning.
2934 Set_Warnings_Off (E1);
2935 end if;
2936 end;
2937 end loop;
2938 end Output_Non_Modified_In_Out_Warnings;
2940 ----------------------------------------
2941 -- Output_Obsolescent_Entity_Warnings --
2942 ----------------------------------------
2944 procedure Output_Obsolescent_Entity_Warnings (N : Node_Id; E : Entity_Id) is
2945 P : constant Node_Id := Parent (N);
2946 S : Entity_Id;
2948 begin
2949 S := Current_Scope;
2951 -- Do not output message if we are the scope of standard. This means
2952 -- we have a reference from a context clause from when it is originally
2953 -- processed, and that's too early to tell whether it is an obsolescent
2954 -- unit doing the with'ing. In Sem_Ch10.Analyze_Compilation_Unit we make
2955 -- sure that we have a later call when the scope is available. This test
2956 -- also eliminates all messages for use clauses, which is fine (we do
2957 -- not want messages for use clauses, since they are always redundant
2958 -- with respect to the associated with clause).
2960 if S = Standard_Standard then
2961 return;
2962 end if;
2964 -- Do not output message if we are in scope of an obsolescent package
2965 -- or subprogram.
2967 loop
2968 if Is_Obsolescent (S) then
2969 return;
2970 end if;
2972 S := Scope (S);
2973 exit when S = Standard_Standard;
2974 end loop;
2976 -- Here we will output the message
2978 Error_Msg_Sloc := Sloc (E);
2980 -- Case of with clause
2982 if Nkind (P) = N_With_Clause then
2983 if Ekind (E) = E_Package then
2984 Error_Msg_NE
2985 ("?j?with of obsolescent package& declared#", N, E);
2986 elsif Ekind (E) = E_Procedure then
2987 Error_Msg_NE
2988 ("?j?with of obsolescent procedure& declared#", N, E);
2989 else
2990 Error_Msg_NE
2991 ("??with of obsolescent function& declared#", N, E);
2992 end if;
2994 -- If we do not have a with clause, then ignore any reference to an
2995 -- obsolescent package name. We only want to give the one warning of
2996 -- withing the package, not one each time it is used to qualify.
2998 elsif Ekind (E) = E_Package then
2999 return;
3001 -- Procedure call statement
3003 elsif Nkind (P) = N_Procedure_Call_Statement then
3004 Error_Msg_NE
3005 ("??call to obsolescent procedure& declared#", N, E);
3007 -- Function call
3009 elsif Nkind (P) = N_Function_Call then
3010 Error_Msg_NE
3011 ("??call to obsolescent function& declared#", N, E);
3013 -- Reference to obsolescent type
3015 elsif Is_Type (E) then
3016 Error_Msg_NE
3017 ("??reference to obsolescent type& declared#", N, E);
3019 -- Reference to obsolescent component
3021 elsif Ekind_In (E, E_Component, E_Discriminant) then
3022 Error_Msg_NE
3023 ("??reference to obsolescent component& declared#", N, E);
3025 -- Reference to obsolescent variable
3027 elsif Ekind (E) = E_Variable then
3028 Error_Msg_NE
3029 ("??reference to obsolescent variable& declared#", N, E);
3031 -- Reference to obsolescent constant
3033 elsif Ekind (E) = E_Constant or else Ekind (E) in Named_Kind then
3034 Error_Msg_NE
3035 ("??reference to obsolescent constant& declared#", N, E);
3037 -- Reference to obsolescent enumeration literal
3039 elsif Ekind (E) = E_Enumeration_Literal then
3040 Error_Msg_NE
3041 ("??reference to obsolescent enumeration literal& declared#", N, E);
3043 -- Generic message for any other case we missed
3045 else
3046 Error_Msg_NE
3047 ("??reference to obsolescent entity& declared#", N, E);
3048 end if;
3050 -- Output additional warning if present
3052 for J in Obsolescent_Warnings.First .. Obsolescent_Warnings.Last loop
3053 if Obsolescent_Warnings.Table (J).Ent = E then
3054 String_To_Name_Buffer (Obsolescent_Warnings.Table (J).Msg);
3055 Error_Msg_Strlen := Name_Len;
3056 Error_Msg_String (1 .. Name_Len) := Name_Buffer (1 .. Name_Len);
3057 Error_Msg_N ("\\??~", N);
3058 exit;
3059 end if;
3060 end loop;
3061 end Output_Obsolescent_Entity_Warnings;
3063 ----------------------------------
3064 -- Output_Unreferenced_Messages --
3065 ----------------------------------
3067 procedure Output_Unreferenced_Messages is
3068 begin
3069 for J in Unreferenced_Entities.First ..
3070 Unreferenced_Entities.Last
3071 loop
3072 Warn_On_Unreferenced_Entity (Unreferenced_Entities.Table (J));
3073 end loop;
3074 end Output_Unreferenced_Messages;
3076 -----------------------------------------
3077 -- Output_Unused_Warnings_Off_Warnings --
3078 -----------------------------------------
3080 procedure Output_Unused_Warnings_Off_Warnings is
3081 begin
3082 for J in Warnings_Off_Pragmas.First .. Warnings_Off_Pragmas.Last loop
3083 declare
3084 Wentry : Warnings_Off_Entry renames Warnings_Off_Pragmas.Table (J);
3085 N : Node_Id renames Wentry.N;
3086 E : Node_Id renames Wentry.E;
3088 begin
3089 -- Turn off Warnings_Off, or we won't get the warning
3091 Set_Warnings_Off (E, False);
3093 -- Nothing to do if pragma was used to suppress a general warning
3095 if Warnings_Off_Used (E) then
3096 null;
3098 -- If pragma was used both in unmodified and unreferenced contexts
3099 -- then that's as good as the general case, no warning.
3101 elsif Warnings_Off_Used_Unmodified (E)
3103 Warnings_Off_Used_Unreferenced (E)
3104 then
3105 null;
3107 -- Used only in context where Unmodified would have worked
3109 elsif Warnings_Off_Used_Unmodified (E) then
3110 Error_Msg_NE
3111 ("?W?could use Unmodified instead of "
3112 & "Warnings Off for &", Pragma_Identifier (N), E);
3114 -- Used only in context where Unreferenced would have worked
3116 elsif Warnings_Off_Used_Unreferenced (E) then
3117 Error_Msg_NE
3118 ("?W?could use Unreferenced instead of "
3119 & "Warnings Off for &", Pragma_Identifier (N), E);
3121 -- Not used at all
3123 else
3124 Error_Msg_NE
3125 ("?W?pragma Warnings Off for & unused, "
3126 & "could be omitted", N, E);
3127 end if;
3128 end;
3129 end loop;
3130 end Output_Unused_Warnings_Off_Warnings;
3132 ---------------------------
3133 -- Referenced_Check_Spec --
3134 ---------------------------
3136 function Referenced_Check_Spec (E : Entity_Id) return Boolean is
3137 begin
3138 if Is_Formal (E) and then Present (Spec_Entity (E)) then
3139 return Referenced (E) or else Referenced (Spec_Entity (E));
3140 else
3141 return Referenced (E);
3142 end if;
3143 end Referenced_Check_Spec;
3145 ----------------------------------
3146 -- Referenced_As_LHS_Check_Spec --
3147 ----------------------------------
3149 function Referenced_As_LHS_Check_Spec (E : Entity_Id) return Boolean is
3150 begin
3151 if Is_Formal (E) and then Present (Spec_Entity (E)) then
3152 return Referenced_As_LHS (E)
3153 or else Referenced_As_LHS (Spec_Entity (E));
3154 else
3155 return Referenced_As_LHS (E);
3156 end if;
3157 end Referenced_As_LHS_Check_Spec;
3159 --------------------------------------------
3160 -- Referenced_As_Out_Parameter_Check_Spec --
3161 --------------------------------------------
3163 function Referenced_As_Out_Parameter_Check_Spec
3164 (E : Entity_Id) return Boolean
3166 begin
3167 if Is_Formal (E) and then Present (Spec_Entity (E)) then
3168 return Referenced_As_Out_Parameter (E)
3169 or else Referenced_As_Out_Parameter (Spec_Entity (E));
3170 else
3171 return Referenced_As_Out_Parameter (E);
3172 end if;
3173 end Referenced_As_Out_Parameter_Check_Spec;
3175 -----------------------------
3176 -- Warn_On_Known_Condition --
3177 -----------------------------
3179 procedure Warn_On_Known_Condition (C : Node_Id) is
3180 P : Node_Id;
3181 Orig : constant Node_Id := Original_Node (C);
3182 Test_Result : Boolean;
3184 function Is_Known_Branch return Boolean;
3185 -- If the type of the condition is Boolean, the constant value of the
3186 -- condition is a boolean literal. If the type is a derived boolean
3187 -- type, the constant is wrapped in a type conversion of the derived
3188 -- literal. If the value of the condition is not a literal, no warnings
3189 -- can be produced. This function returns True if the result can be
3190 -- determined, and Test_Result is set True/False accordingly. Otherwise
3191 -- False is returned, and Test_Result is unchanged.
3193 procedure Track (N : Node_Id; Loc : Node_Id);
3194 -- Adds continuation warning(s) pointing to reason (assignment or test)
3195 -- for the operand of the conditional having a known value (or at least
3196 -- enough is known about the value to issue the warning). N is the node
3197 -- which is judged to have a known value. Loc is the warning location.
3199 ---------------------
3200 -- Is_Known_Branch --
3201 ---------------------
3203 function Is_Known_Branch return Boolean is
3204 begin
3205 if Etype (C) = Standard_Boolean
3206 and then Is_Entity_Name (C)
3207 and then
3208 (Entity (C) = Standard_False or else Entity (C) = Standard_True)
3209 then
3210 Test_Result := Entity (C) = Standard_True;
3211 return True;
3213 elsif Is_Boolean_Type (Etype (C))
3214 and then Nkind (C) = N_Unchecked_Type_Conversion
3215 and then Is_Entity_Name (Expression (C))
3216 and then Ekind (Entity (Expression (C))) = E_Enumeration_Literal
3217 then
3218 Test_Result :=
3219 Chars (Entity (Expression (C))) = Chars (Standard_True);
3220 return True;
3222 else
3223 return False;
3224 end if;
3225 end Is_Known_Branch;
3227 -----------
3228 -- Track --
3229 -----------
3231 procedure Track (N : Node_Id; Loc : Node_Id) is
3232 Nod : constant Node_Id := Original_Node (N);
3234 begin
3235 if Nkind (Nod) in N_Op_Compare then
3236 Track (Left_Opnd (Nod), Loc);
3237 Track (Right_Opnd (Nod), Loc);
3239 elsif Is_Entity_Name (Nod) and then Is_Object (Entity (Nod)) then
3240 declare
3241 CV : constant Node_Id := Current_Value (Entity (Nod));
3243 begin
3244 if Present (CV) then
3245 Error_Msg_Sloc := Sloc (CV);
3247 if Nkind (CV) not in N_Subexpr then
3248 Error_Msg_N ("\\??(see test #)", Loc);
3250 elsif Nkind (Parent (CV)) =
3251 N_Case_Statement_Alternative
3252 then
3253 Error_Msg_N ("\\??(see case alternative #)", Loc);
3255 else
3256 Error_Msg_N ("\\??(see assignment #)", Loc);
3257 end if;
3258 end if;
3259 end;
3260 end if;
3261 end Track;
3263 -- Start of processing for Warn_On_Known_Condition
3265 begin
3266 -- Adjust SCO condition if from source
3268 if Generate_SCO
3269 and then Comes_From_Source (Orig)
3270 and then Is_Known_Branch
3271 then
3272 declare
3273 Atrue : Boolean;
3275 begin
3276 Atrue := Test_Result;
3278 if Present (Parent (C)) and then Nkind (Parent (C)) = N_Op_Not then
3279 Atrue := not Atrue;
3280 end if;
3282 Set_SCO_Condition (Orig, Atrue);
3283 end;
3284 end if;
3286 -- Argument replacement in an inlined body can make conditions static.
3287 -- Do not emit warnings in this case.
3289 if In_Inlined_Body then
3290 return;
3291 end if;
3293 if Constant_Condition_Warnings
3294 and then Is_Known_Branch
3295 and then Comes_From_Source (Orig)
3296 and then not In_Instance
3297 then
3298 -- Don't warn if comparison of result of attribute against a constant
3299 -- value, since this is likely legitimate conditional compilation.
3301 if Nkind (Orig) in N_Op_Compare
3302 and then Compile_Time_Known_Value (Right_Opnd (Orig))
3303 and then Nkind (Original_Node (Left_Opnd (Orig))) =
3304 N_Attribute_Reference
3305 then
3306 return;
3307 end if;
3309 -- See if this is in a statement or a declaration
3311 P := Parent (C);
3312 loop
3313 -- If tree is not attached, do not issue warning (this is very
3314 -- peculiar, and probably arises from some other error condition)
3316 if No (P) then
3317 return;
3319 -- If we are in a declaration, then no warning, since in practice
3320 -- conditionals in declarations are used for intended tests which
3321 -- may be known at compile time, e.g. things like
3323 -- x : constant Integer := 2 + (Word'Size = 32);
3325 -- And a warning is annoying in such cases
3327 elsif Nkind (P) in N_Declaration
3328 or else
3329 Nkind (P) in N_Later_Decl_Item
3330 then
3331 return;
3333 -- Don't warn in assert or check pragma, since presumably tests in
3334 -- such a context are very definitely intended, and might well be
3335 -- known at compile time. Note that we have to test the original
3336 -- node, since assert pragmas get rewritten at analysis time.
3338 elsif Nkind (Original_Node (P)) = N_Pragma
3339 and then Nam_In (Pragma_Name (Original_Node (P)), Name_Assert,
3340 Name_Check)
3341 then
3342 return;
3343 end if;
3345 exit when Is_Statement (P);
3346 P := Parent (P);
3347 end loop;
3349 -- Here we issue the warning unless some sub-operand has warnings
3350 -- set off, in which case we suppress the warning for the node. If
3351 -- the original expression is an inequality, it has been expanded
3352 -- into a negation, and the value of the original expression is the
3353 -- negation of the equality. If the expression is an entity that
3354 -- appears within a negation, it is clearer to flag the negation
3355 -- itself, and report on its constant value.
3357 if not Operand_Has_Warnings_Suppressed (C) then
3358 declare
3359 True_Branch : Boolean := Test_Result;
3360 Cond : Node_Id := C;
3362 begin
3363 if Present (Parent (C)) and then Nkind (Parent (C)) = N_Op_Not
3364 then
3365 True_Branch := not True_Branch;
3366 Cond := Parent (C);
3367 end if;
3369 if True_Branch then
3370 if Is_Entity_Name (Original_Node (C))
3371 and then Nkind (Cond) /= N_Op_Not
3372 then
3373 Error_Msg_NE
3374 ("object & is always True?c?", Cond, Original_Node (C));
3375 Track (Original_Node (C), Cond);
3377 else
3378 Error_Msg_N ("condition is always True?c?", Cond);
3379 Track (Cond, Cond);
3380 end if;
3382 else
3383 Error_Msg_N ("condition is always False?c?", Cond);
3384 Track (Cond, Cond);
3385 end if;
3386 end;
3387 end if;
3388 end if;
3389 end Warn_On_Known_Condition;
3391 ---------------------------------------
3392 -- Warn_On_Modified_As_Out_Parameter --
3393 ---------------------------------------
3395 function Warn_On_Modified_As_Out_Parameter (E : Entity_Id) return Boolean is
3396 begin
3397 return
3398 (Warn_On_Modified_Unread and then Is_Only_Out_Parameter (E))
3399 or else Warn_On_All_Unread_Out_Parameters;
3400 end Warn_On_Modified_As_Out_Parameter;
3402 ---------------------------------
3403 -- Warn_On_Overlapping_Actuals --
3404 ---------------------------------
3406 procedure Warn_On_Overlapping_Actuals (Subp : Entity_Id; N : Node_Id) is
3407 Act1, Act2 : Node_Id;
3408 Form1, Form2 : Entity_Id;
3410 function Is_Covered_Formal (Formal : Node_Id) return Boolean;
3411 -- Return True if Formal is covered by the rule
3413 function Refer_Same_Object (Act1, Act2 : Node_Id) return Boolean;
3414 -- Two names are known to refer to the same object if the two names
3415 -- are known to denote the same object; or one of the names is a
3416 -- selected_component, indexed_component, or slice and its prefix is
3417 -- known to refer to the same object as the other name; or one of the
3418 -- two names statically denotes a renaming declaration whose renamed
3419 -- object_name is known to refer to the same object as the other name
3420 -- (RM 6.4.1(6.11/3))
3422 -----------------------
3423 -- Refer_Same_Object --
3424 -----------------------
3426 function Refer_Same_Object (Act1, Act2 : Node_Id) return Boolean is
3427 begin
3428 return Denotes_Same_Object (Act1, Act2)
3429 or else Denotes_Same_Prefix (Act1, Act2);
3430 end Refer_Same_Object;
3432 -----------------------
3433 -- Is_Covered_Formal --
3434 -----------------------
3436 function Is_Covered_Formal (Formal : Node_Id) return Boolean is
3437 begin
3438 return
3439 Ekind_In (Formal, E_Out_Parameter, E_In_Out_Parameter)
3440 and then (Is_Elementary_Type (Etype (Formal))
3441 or else Is_Record_Type (Etype (Formal))
3442 or else Is_Array_Type (Etype (Formal)));
3443 end Is_Covered_Formal;
3445 begin
3446 if Ada_Version < Ada_2012 and then not Warn_On_Overlap then
3447 return;
3448 end if;
3450 -- Exclude calls rewritten as enumeration literals
3452 if Nkind (N) not in N_Subprogram_Call
3453 and then Nkind (N) /= N_Entry_Call_Statement
3454 then
3455 return;
3456 end if;
3458 -- If a call C has two or more parameters of mode in out or out that are
3459 -- of an elementary type, then the call is legal only if for each name
3460 -- N that is passed as a parameter of mode in out or out to the call C,
3461 -- there is no other name among the other parameters of mode in out or
3462 -- out to C that is known to denote the same object (RM 6.4.1(6.15/3))
3464 -- If appropriate warning switch is set, we also report warnings on
3465 -- overlapping parameters that are record types or array types.
3467 Form1 := First_Formal (Subp);
3468 Act1 := First_Actual (N);
3469 while Present (Form1) and then Present (Act1) loop
3470 if Is_Covered_Formal (Form1) then
3471 Form2 := First_Formal (Subp);
3472 Act2 := First_Actual (N);
3473 while Present (Form2) and then Present (Act2) loop
3474 if Form1 /= Form2
3475 and then Is_Covered_Formal (Form2)
3476 and then Refer_Same_Object (Act1, Act2)
3477 then
3478 -- Guard against previous errors
3480 if Error_Posted (N)
3481 or else No (Etype (Act1))
3482 or else No (Etype (Act2))
3483 then
3484 null;
3486 -- If the actual is a function call in prefix notation,
3487 -- there is no real overlap.
3489 elsif Nkind (Act2) = N_Function_Call then
3490 null;
3492 -- If type is not by-copy, assume that aliasing is intended
3494 elsif
3495 Present (Underlying_Type (Etype (Form1)))
3496 and then
3497 (Is_By_Reference_Type (Underlying_Type (Etype (Form1)))
3498 or else
3499 Convention (Underlying_Type (Etype (Form1))) =
3500 Convention_Ada_Pass_By_Reference)
3501 then
3502 null;
3504 -- Under Ada 2012 we only report warnings on overlapping
3505 -- arrays and record types if switch is set.
3507 elsif Ada_Version >= Ada_2012
3508 and then not Is_Elementary_Type (Etype (Form1))
3509 and then not Warn_On_Overlap
3510 then
3511 null;
3513 -- Here we may need to issue overlap message
3515 else
3516 Error_Msg_Warn :=
3518 -- Overlap checking is an error only in Ada 2012. For
3519 -- earlier versions of Ada, this is a warning.
3521 Ada_Version < Ada_2012
3523 -- Overlap is only illegal in Ada 2012 in the case of
3524 -- elementary types (passed by copy). For other types,
3525 -- we always have a warning in all Ada versions.
3527 or else not Is_Elementary_Type (Etype (Form1))
3529 -- Finally, debug flag -gnatd.E changes the error to a
3530 -- warning even in Ada 2012 mode.
3532 or else Error_To_Warning;
3534 declare
3535 Act : Node_Id;
3536 Form : Entity_Id;
3538 begin
3539 -- Find matching actual
3541 Act := First_Actual (N);
3542 Form := First_Formal (Subp);
3543 while Act /= Act2 loop
3544 Next_Formal (Form);
3545 Next_Actual (Act);
3546 end loop;
3548 if Is_Elementary_Type (Etype (Act1))
3549 and then Ekind (Form2) = E_In_Parameter
3550 then
3551 null; -- No real aliasing
3553 elsif Is_Elementary_Type (Etype (Act2))
3554 and then Ekind (Form2) = E_In_Parameter
3555 then
3556 null; -- Ditto
3558 -- If the call was written in prefix notation, and
3559 -- thus its prefix before rewriting was a selected
3560 -- component, count only visible actuals in the call.
3562 elsif Is_Entity_Name (First_Actual (N))
3563 and then Nkind (Original_Node (N)) = Nkind (N)
3564 and then Nkind (Name (Original_Node (N))) =
3565 N_Selected_Component
3566 and then
3567 Is_Entity_Name (Prefix (Name (Original_Node (N))))
3568 and then
3569 Entity (Prefix (Name (Original_Node (N)))) =
3570 Entity (First_Actual (N))
3571 then
3572 if Act1 = First_Actual (N) then
3573 Error_Msg_FE
3574 ("<<`IN OUT` prefix overlaps with "
3575 & "actual for&", Act1, Form);
3577 else
3578 -- For greater clarity, give name of formal
3580 Error_Msg_Node_2 := Form;
3581 Error_Msg_FE
3582 ("<<writable actual for & overlaps with "
3583 & "actual for&", Act1, Form);
3584 end if;
3586 else
3587 -- For greater clarity, give name of formal
3589 Error_Msg_Node_2 := Form;
3591 -- This is one of the messages
3593 Error_Msg_FE
3594 ("<<writable actual for & overlaps with "
3595 & "actual for&", Act1, Form1);
3596 end if;
3597 end;
3598 end if;
3600 return;
3601 end if;
3603 Next_Formal (Form2);
3604 Next_Actual (Act2);
3605 end loop;
3606 end if;
3608 Next_Formal (Form1);
3609 Next_Actual (Act1);
3610 end loop;
3611 end Warn_On_Overlapping_Actuals;
3613 ------------------------------
3614 -- Warn_On_Suspicious_Index --
3615 ------------------------------
3617 procedure Warn_On_Suspicious_Index (Name : Entity_Id; X : Node_Id) is
3619 Low_Bound : Uint;
3620 -- Set to lower bound for a suspicious type
3622 Ent : Entity_Id;
3623 -- Entity for array reference
3625 Typ : Entity_Id;
3626 -- Array type
3628 function Is_Suspicious_Type (Typ : Entity_Id) return Boolean;
3629 -- Tests to see if Typ is a type for which we may have a suspicious
3630 -- index, namely an unconstrained array type, whose lower bound is
3631 -- either zero or one. If so, True is returned, and Low_Bound is set
3632 -- to this lower bound. If not, False is returned, and Low_Bound is
3633 -- undefined on return.
3635 -- For now, we limit this to standard string types, so any other
3636 -- unconstrained types return False. We may change our minds on this
3637 -- later on, but strings seem the most important case.
3639 procedure Test_Suspicious_Index;
3640 -- Test if index is of suspicious type and if so, generate warning
3642 ------------------------
3643 -- Is_Suspicious_Type --
3644 ------------------------
3646 function Is_Suspicious_Type (Typ : Entity_Id) return Boolean is
3647 LB : Node_Id;
3649 begin
3650 if Is_Array_Type (Typ)
3651 and then not Is_Constrained (Typ)
3652 and then Number_Dimensions (Typ) = 1
3653 and then (Root_Type (Typ) = Standard_String
3654 or else
3655 Root_Type (Typ) = Standard_Wide_String
3656 or else
3657 Root_Type (Typ) = Standard_Wide_Wide_String)
3658 and then not Has_Warnings_Off (Typ)
3659 then
3660 LB := Type_Low_Bound (Etype (First_Index (Typ)));
3662 if Compile_Time_Known_Value (LB) then
3663 Low_Bound := Expr_Value (LB);
3664 return Low_Bound = Uint_0 or else Low_Bound = Uint_1;
3665 end if;
3666 end if;
3668 return False;
3669 end Is_Suspicious_Type;
3671 ---------------------------
3672 -- Test_Suspicious_Index --
3673 ---------------------------
3675 procedure Test_Suspicious_Index is
3677 function Length_Reference (N : Node_Id) return Boolean;
3678 -- Check if node N is of the form Name'Length
3680 procedure Warn1;
3681 -- Generate first warning line
3683 ----------------------
3684 -- Length_Reference --
3685 ----------------------
3687 function Length_Reference (N : Node_Id) return Boolean is
3688 R : constant Node_Id := Original_Node (N);
3689 begin
3690 return
3691 Nkind (R) = N_Attribute_Reference
3692 and then Attribute_Name (R) = Name_Length
3693 and then Is_Entity_Name (Prefix (R))
3694 and then Entity (Prefix (R)) = Ent;
3695 end Length_Reference;
3697 -----------
3698 -- Warn1 --
3699 -----------
3701 procedure Warn1 is
3702 begin
3703 Error_Msg_Uint_1 := Low_Bound;
3704 Error_Msg_FE -- CODEFIX
3705 ("?w?index for& may assume lower bound of^", X, Ent);
3706 end Warn1;
3708 -- Start of processing for Test_Suspicious_Index
3710 begin
3711 -- Nothing to do if subscript does not come from source (we don't
3712 -- want to give garbage warnings on compiler expanded code, e.g. the
3713 -- loops generated for slice assignments. Such junk warnings would
3714 -- be placed on source constructs with no subscript in sight).
3716 if not Comes_From_Source (Original_Node (X)) then
3717 return;
3718 end if;
3720 -- Case where subscript is a constant integer
3722 if Nkind (X) = N_Integer_Literal then
3723 Warn1;
3725 -- Case where original form of subscript is an integer literal
3727 if Nkind (Original_Node (X)) = N_Integer_Literal then
3728 if Intval (X) = Low_Bound then
3729 Error_Msg_FE -- CODEFIX
3730 ("\?w?suggested replacement: `&''First`", X, Ent);
3731 else
3732 Error_Msg_Uint_1 := Intval (X) - Low_Bound;
3733 Error_Msg_FE -- CODEFIX
3734 ("\?w?suggested replacement: `&''First + ^`", X, Ent);
3736 end if;
3738 -- Case where original form of subscript is more complex
3740 else
3741 -- Build string X'First - 1 + expression where the expression
3742 -- is the original subscript. If the expression starts with "1
3743 -- + ", then the "- 1 + 1" is elided.
3745 Error_Msg_String (1 .. 13) := "'First - 1 + ";
3746 Error_Msg_Strlen := 13;
3748 declare
3749 Sref : Source_Ptr := Sloc (First_Node (Original_Node (X)));
3750 Tref : constant Source_Buffer_Ptr :=
3751 Source_Text (Get_Source_File_Index (Sref));
3752 -- Tref (Sref) is used to scan the subscript
3754 Pctr : Natural;
3755 -- Parentheses counter when scanning subscript
3757 begin
3758 -- Tref (Sref) points to start of subscript
3760 -- Elide - 1 if subscript starts with 1 +
3762 if Tref (Sref .. Sref + 2) = "1 +" then
3763 Error_Msg_Strlen := Error_Msg_Strlen - 6;
3764 Sref := Sref + 2;
3766 elsif Tref (Sref .. Sref + 1) = "1+" then
3767 Error_Msg_Strlen := Error_Msg_Strlen - 6;
3768 Sref := Sref + 1;
3769 end if;
3771 -- Now we will copy the subscript to the string buffer
3773 Pctr := 0;
3774 loop
3775 -- Count parens, exit if terminating right paren. Note
3776 -- check to ignore paren appearing as character literal.
3778 if Tref (Sref + 1) = '''
3779 and then
3780 Tref (Sref - 1) = '''
3781 then
3782 null;
3783 else
3784 if Tref (Sref) = '(' then
3785 Pctr := Pctr + 1;
3786 elsif Tref (Sref) = ')' then
3787 exit when Pctr = 0;
3788 Pctr := Pctr - 1;
3789 end if;
3790 end if;
3792 -- Done if terminating double dot (slice case)
3794 exit when Pctr = 0
3795 and then (Tref (Sref .. Sref + 1) = ".."
3796 or else
3797 Tref (Sref .. Sref + 2) = " ..");
3799 -- Quit if we have hit EOF character, something wrong
3801 if Tref (Sref) = EOF then
3802 return;
3803 end if;
3805 -- String literals are too much of a pain to handle
3807 if Tref (Sref) = '"' or else Tref (Sref) = '%' then
3808 return;
3809 end if;
3811 -- If we have a 'Range reference, then this is a case
3812 -- where we cannot easily give a replacement. Don't try.
3814 if Tref (Sref .. Sref + 4) = "range"
3815 and then Tref (Sref - 1) < 'A'
3816 and then Tref (Sref + 5) < 'A'
3817 then
3818 return;
3819 end if;
3821 -- Else store next character
3823 Error_Msg_Strlen := Error_Msg_Strlen + 1;
3824 Error_Msg_String (Error_Msg_Strlen) := Tref (Sref);
3825 Sref := Sref + 1;
3827 -- If we get more than 40 characters then the expression
3828 -- is too long to copy, or something has gone wrong. In
3829 -- either case, just skip the attempt at a suggested fix.
3831 if Error_Msg_Strlen > 40 then
3832 return;
3833 end if;
3834 end loop;
3835 end;
3837 -- Replacement subscript is now in string buffer
3839 Error_Msg_FE -- CODEFIX
3840 ("\?w?suggested replacement: `&~`", Original_Node (X), Ent);
3841 end if;
3843 -- Case where subscript is of the form X'Length
3845 elsif Length_Reference (X) then
3846 Warn1;
3847 Error_Msg_Node_2 := Ent;
3848 Error_Msg_FE
3849 ("\?w?suggest replacement of `&''Length` by `&''Last`",
3850 X, Ent);
3852 -- Case where subscript is of the form X'Length - expression
3854 elsif Nkind (X) = N_Op_Subtract
3855 and then Length_Reference (Left_Opnd (X))
3856 then
3857 Warn1;
3858 Error_Msg_Node_2 := Ent;
3859 Error_Msg_FE
3860 ("\?w?suggest replacement of `&''Length` by `&''Last`",
3861 Left_Opnd (X), Ent);
3862 end if;
3863 end Test_Suspicious_Index;
3865 -- Start of processing for Warn_On_Suspicious_Index
3867 begin
3868 -- Only process if warnings activated
3870 if Warn_On_Assumed_Low_Bound then
3872 -- Test if array is simple entity name
3874 if Is_Entity_Name (Name) then
3876 -- Test if array is parameter of unconstrained string type
3878 Ent := Entity (Name);
3879 Typ := Etype (Ent);
3881 if Is_Formal (Ent)
3882 and then Is_Suspicious_Type (Typ)
3883 and then not Low_Bound_Tested (Ent)
3884 then
3885 Test_Suspicious_Index;
3886 end if;
3887 end if;
3888 end if;
3889 end Warn_On_Suspicious_Index;
3891 --------------------------------------
3892 -- Warn_On_Unassigned_Out_Parameter --
3893 --------------------------------------
3895 procedure Warn_On_Unassigned_Out_Parameter
3896 (Return_Node : Node_Id;
3897 Scope_Id : Entity_Id)
3899 Form : Entity_Id;
3900 Form2 : Entity_Id;
3902 begin
3903 -- Ignore if procedure or return statement does not come from source
3905 if not Comes_From_Source (Scope_Id)
3906 or else not Comes_From_Source (Return_Node)
3907 then
3908 return;
3909 end if;
3911 -- Loop through formals
3913 Form := First_Formal (Scope_Id);
3914 while Present (Form) loop
3916 -- We are only interested in OUT parameters that come from source
3917 -- and are never set in the source, and furthermore only in scalars
3918 -- since non-scalars generate too many false positives.
3920 if Ekind (Form) = E_Out_Parameter
3921 and then Never_Set_In_Source_Check_Spec (Form)
3922 and then Is_Scalar_Type (Etype (Form))
3923 and then not Present (Unset_Reference (Form))
3924 then
3925 -- Before we issue the warning, an add ad hoc defence against the
3926 -- most common case of false positives with this warning which is
3927 -- the case where there is a Boolean OUT parameter that has been
3928 -- set, and whose meaning is "ignore the values of the other
3929 -- parameters". We can't of course reliably tell this case at
3930 -- compile time, but the following test kills a lot of false
3931 -- positives, without generating a significant number of false
3932 -- negatives (missed real warnings).
3934 Form2 := First_Formal (Scope_Id);
3935 while Present (Form2) loop
3936 if Ekind (Form2) = E_Out_Parameter
3937 and then Root_Type (Etype (Form2)) = Standard_Boolean
3938 and then not Never_Set_In_Source_Check_Spec (Form2)
3939 then
3940 return;
3941 end if;
3943 Next_Formal (Form2);
3944 end loop;
3946 -- Here all conditions are met, record possible unset reference
3948 Set_Unset_Reference (Form, Return_Node);
3949 end if;
3951 Next_Formal (Form);
3952 end loop;
3953 end Warn_On_Unassigned_Out_Parameter;
3955 ---------------------------------
3956 -- Warn_On_Unreferenced_Entity --
3957 ---------------------------------
3959 procedure Warn_On_Unreferenced_Entity
3960 (Spec_E : Entity_Id;
3961 Body_E : Entity_Id := Empty)
3963 E : Entity_Id := Spec_E;
3965 begin
3966 if not Referenced_Check_Spec (E)
3967 and then not Has_Pragma_Unreferenced_Check_Spec (E)
3968 and then not Warnings_Off_Check_Spec (E)
3969 and then not Has_Junk_Name (Spec_E)
3970 then
3971 case Ekind (E) is
3972 when E_Variable =>
3974 -- Case of variable that is assigned but not read. We suppress
3975 -- the message if the variable is volatile, has an address
3976 -- clause, is aliased, or is a renaming, or is imported.
3978 if Referenced_As_LHS_Check_Spec (E)
3979 and then No (Address_Clause (E))
3980 and then not Is_Volatile (E)
3981 then
3982 if Warn_On_Modified_Unread
3983 and then not Is_Imported (E)
3984 and then not Is_Aliased (E)
3985 and then No (Renamed_Object (E))
3986 then
3987 if not Has_Pragma_Unmodified_Check_Spec (E) then
3988 Error_Msg_N -- CODEFIX
3989 ("?u?variable & is assigned but never read!", E);
3990 end if;
3992 Set_Last_Assignment (E, Empty);
3993 end if;
3995 -- Normal case of neither assigned nor read (exclude variables
3996 -- referenced as out parameters, since we already generated
3997 -- appropriate warnings at the call point in this case).
3999 elsif not Referenced_As_Out_Parameter (E) then
4001 -- We suppress the message for types for which a valid
4002 -- pragma Unreferenced_Objects has been given, otherwise
4003 -- we go ahead and give the message.
4005 if not Has_Pragma_Unreferenced_Objects (Etype (E)) then
4007 -- Distinguish renamed case in message
4009 if Present (Renamed_Object (E))
4010 and then Comes_From_Source (Renamed_Object (E))
4011 then
4012 Error_Msg_N -- CODEFIX
4013 ("?u?renamed variable & is not referenced!", E);
4014 else
4015 Error_Msg_N -- CODEFIX
4016 ("?u?variable & is not referenced!", E);
4017 end if;
4018 end if;
4019 end if;
4021 when E_Constant =>
4022 if not Has_Pragma_Unreferenced_Objects (Etype (E)) then
4023 if Present (Renamed_Object (E))
4024 and then Comes_From_Source (Renamed_Object (E))
4025 then
4026 Error_Msg_N -- CODEFIX
4027 ("?u?renamed constant & is not referenced!", E);
4028 else
4029 Error_Msg_N -- CODEFIX
4030 ("?u?constant & is not referenced!", E);
4031 end if;
4032 end if;
4034 when E_In_Parameter |
4035 E_In_Out_Parameter =>
4037 -- Do not emit message for formals of a renaming, because
4038 -- they are never referenced explicitly.
4040 if Nkind (Original_Node (Unit_Declaration_Node (Scope (E)))) /=
4041 N_Subprogram_Renaming_Declaration
4042 then
4043 -- Suppress this message for an IN OUT parameter of a
4044 -- non-scalar type, since it is normal to have only an
4045 -- assignment in such a case.
4047 if Ekind (E) = E_In_Parameter
4048 or else not Referenced_As_LHS_Check_Spec (E)
4049 or else Is_Scalar_Type (Etype (E))
4050 then
4051 if Present (Body_E) then
4052 E := Body_E;
4053 end if;
4055 if not Is_Trivial_Subprogram (Scope (E)) then
4056 Error_Msg_NE -- CODEFIX
4057 ("?u?formal parameter & is not referenced!",
4058 E, Spec_E);
4059 end if;
4060 end if;
4061 end if;
4063 when E_Out_Parameter =>
4064 null;
4066 when E_Discriminant =>
4067 Error_Msg_N ("?u?discriminant & is not referenced!", E);
4069 when E_Named_Integer |
4070 E_Named_Real =>
4071 Error_Msg_N -- CODEFIX
4072 ("?u?named number & is not referenced!", E);
4074 when Formal_Object_Kind =>
4075 Error_Msg_N -- CODEFIX
4076 ("?u?formal object & is not referenced!", E);
4078 when E_Enumeration_Literal =>
4079 Error_Msg_N -- CODEFIX
4080 ("?u?literal & is not referenced!", E);
4082 when E_Function =>
4083 Error_Msg_N -- CODEFIX
4084 ("?u?function & is not referenced!", E);
4086 when E_Procedure =>
4087 Error_Msg_N -- CODEFIX
4088 ("?u?procedure & is not referenced!", E);
4090 when E_Package =>
4091 Error_Msg_N -- CODEFIX
4092 ("?u?package & is not referenced!", E);
4094 when E_Exception =>
4095 Error_Msg_N -- CODEFIX
4096 ("?u?exception & is not referenced!", E);
4098 when E_Label =>
4099 Error_Msg_N -- CODEFIX
4100 ("?u?label & is not referenced!", E);
4102 when E_Generic_Procedure =>
4103 Error_Msg_N -- CODEFIX
4104 ("?u?generic procedure & is never instantiated!", E);
4106 when E_Generic_Function =>
4107 Error_Msg_N -- CODEFIX
4108 ("?u?generic function & is never instantiated!", E);
4110 when Type_Kind =>
4111 Error_Msg_N -- CODEFIX
4112 ("?u?type & is not referenced!", E);
4114 when others =>
4115 Error_Msg_N -- CODEFIX
4116 ("?u?& is not referenced!", E);
4117 end case;
4119 -- Kill warnings on the entity on which the message has been posted
4121 Set_Warnings_Off (E);
4122 end if;
4123 end Warn_On_Unreferenced_Entity;
4125 --------------------------------
4126 -- Warn_On_Useless_Assignment --
4127 --------------------------------
4129 procedure Warn_On_Useless_Assignment
4130 (Ent : Entity_Id;
4131 N : Node_Id := Empty)
4133 P : Node_Id;
4134 X : Node_Id;
4136 function Check_Ref (N : Node_Id) return Traverse_Result;
4137 -- Used to instantiate Traverse_Func. Returns Abandon if a reference to
4138 -- the entity in question is found.
4140 function Test_No_Refs is new Traverse_Func (Check_Ref);
4142 ---------------
4143 -- Check_Ref --
4144 ---------------
4146 function Check_Ref (N : Node_Id) return Traverse_Result is
4147 begin
4148 -- Check reference to our identifier. We use name equality here
4149 -- because the exception handlers have not yet been analyzed. This
4150 -- is not quite right, but it really does not matter that we fail
4151 -- to output the warning in some obscure cases of name clashes.
4153 if Nkind (N) = N_Identifier and then Chars (N) = Chars (Ent) then
4154 return Abandon;
4155 else
4156 return OK;
4157 end if;
4158 end Check_Ref;
4160 -- Start of processing for Warn_On_Useless_Assignment
4162 begin
4163 -- Check if this is a case we want to warn on, a scalar or access
4164 -- variable with the last assignment field set, with warnings enabled,
4165 -- and which is not imported or exported. We also check that it is OK
4166 -- to capture the value. We are not going to capture any value, but
4167 -- the warning message depends on the same kind of conditions.
4169 if Is_Assignable (Ent)
4170 and then not Is_Return_Object (Ent)
4171 and then Present (Last_Assignment (Ent))
4172 and then not Is_Imported (Ent)
4173 and then not Is_Exported (Ent)
4174 and then Safe_To_Capture_Value (N, Ent)
4175 and then not Has_Pragma_Unreferenced_Check_Spec (Ent)
4176 and then not Has_Junk_Name (Ent)
4177 then
4178 -- Before we issue the message, check covering exception handlers.
4179 -- Search up tree for enclosing statement sequences and handlers.
4181 P := Parent (Last_Assignment (Ent));
4182 while Present (P) loop
4184 -- Something is really wrong if we don't find a handled statement
4185 -- sequence, so just suppress the warning.
4187 if No (P) then
4188 Set_Last_Assignment (Ent, Empty);
4189 return;
4191 -- When we hit a package/subprogram body, issue warning and exit
4193 elsif Nkind (P) = N_Subprogram_Body
4194 or else Nkind (P) = N_Package_Body
4195 then
4196 -- Case of assigned value never referenced
4198 if No (N) then
4199 declare
4200 LA : constant Node_Id := Last_Assignment (Ent);
4202 begin
4203 -- Don't give this for OUT and IN OUT formals, since
4204 -- clearly caller may reference the assigned value. Also
4205 -- never give such warnings for internal variables.
4207 if Ekind (Ent) = E_Variable
4208 and then not Is_Internal_Name (Chars (Ent))
4209 then
4210 -- Give appropriate message, distinguishing between
4211 -- assignment statements and out parameters.
4213 if Nkind_In (Parent (LA), N_Procedure_Call_Statement,
4214 N_Parameter_Association)
4215 then
4216 Error_Msg_NE
4217 ("?m?& modified by call, but value never "
4218 & "referenced", LA, Ent);
4220 else
4221 Error_Msg_NE -- CODEFIX
4222 ("?m?useless assignment to&, value never "
4223 & "referenced!", LA, Ent);
4224 end if;
4225 end if;
4226 end;
4228 -- Case of assigned value overwritten
4230 else
4231 declare
4232 LA : constant Node_Id := Last_Assignment (Ent);
4234 begin
4235 Error_Msg_Sloc := Sloc (N);
4237 -- Give appropriate message, distinguishing between
4238 -- assignment statements and out parameters.
4240 if Nkind_In (Parent (LA), N_Procedure_Call_Statement,
4241 N_Parameter_Association)
4242 then
4243 Error_Msg_NE
4244 ("?m?& modified by call, but value overwritten #!",
4245 LA, Ent);
4246 else
4247 Error_Msg_NE -- CODEFIX
4248 ("?m?useless assignment to&, value overwritten #!",
4249 LA, Ent);
4250 end if;
4251 end;
4252 end if;
4254 -- Clear last assignment indication and we are done
4256 Set_Last_Assignment (Ent, Empty);
4257 return;
4259 -- Enclosing handled sequence of statements
4261 elsif Nkind (P) = N_Handled_Sequence_Of_Statements then
4263 -- Check exception handlers present
4265 if Present (Exception_Handlers (P)) then
4267 -- If we are not at the top level, we regard an inner
4268 -- exception handler as a decisive indicator that we should
4269 -- not generate the warning, since the variable in question
4270 -- may be accessed after an exception in the outer block.
4272 if Nkind (Parent (P)) /= N_Subprogram_Body
4273 and then Nkind (Parent (P)) /= N_Package_Body
4274 then
4275 Set_Last_Assignment (Ent, Empty);
4276 return;
4278 -- Otherwise we are at the outer level. An exception
4279 -- handler is significant only if it references the
4280 -- variable in question, or if the entity in question
4281 -- is an OUT or IN OUT parameter, which which case
4282 -- the caller can reference it after the exception
4283 -- handler completes.
4285 else
4286 if Is_Formal (Ent) then
4287 Set_Last_Assignment (Ent, Empty);
4288 return;
4290 else
4291 X := First (Exception_Handlers (P));
4292 while Present (X) loop
4293 if Test_No_Refs (X) = Abandon then
4294 Set_Last_Assignment (Ent, Empty);
4295 return;
4296 end if;
4298 X := Next (X);
4299 end loop;
4300 end if;
4301 end if;
4302 end if;
4303 end if;
4305 P := Parent (P);
4306 end loop;
4307 end if;
4308 end Warn_On_Useless_Assignment;
4310 ---------------------------------
4311 -- Warn_On_Useless_Assignments --
4312 ---------------------------------
4314 procedure Warn_On_Useless_Assignments (E : Entity_Id) is
4315 Ent : Entity_Id;
4317 begin
4318 Process_Deferred_References;
4320 if Warn_On_Modified_Unread
4321 and then In_Extended_Main_Source_Unit (E)
4322 then
4323 Ent := First_Entity (E);
4324 while Present (Ent) loop
4325 Warn_On_Useless_Assignment (Ent);
4326 Next_Entity (Ent);
4327 end loop;
4328 end if;
4329 end Warn_On_Useless_Assignments;
4331 -----------------------------
4332 -- Warnings_Off_Check_Spec --
4333 -----------------------------
4335 function Warnings_Off_Check_Spec (E : Entity_Id) return Boolean is
4336 begin
4337 if Is_Formal (E) and then Present (Spec_Entity (E)) then
4339 -- Note: use of OR here instead of OR ELSE is deliberate, we want
4340 -- to mess with flags on both entities.
4342 return Has_Warnings_Off (E)
4344 Has_Warnings_Off (Spec_Entity (E));
4346 else
4347 return Has_Warnings_Off (E);
4348 end if;
4349 end Warnings_Off_Check_Spec;
4351 end Sem_Warn;