1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1999-2011, Free Software Foundation, Inc. --
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. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
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;
33 with Namet; use Namet;
34 with Nlists; use Nlists;
36 with Par_SCO; use Par_SCO;
37 with Rtsfind; use Rtsfind;
39 with Sem_Ch8; use Sem_Ch8;
40 with Sem_Aux; use Sem_Aux;
41 with Sem_Eval; use Sem_Eval;
42 with Sem_Util; use Sem_Util;
43 with Sinfo; use Sinfo;
44 with Sinput; use Sinput;
45 with Snames; use Snames;
46 with Stand; use Stand;
47 with Stringt; use Stringt;
48 with Uintp; use Uintp;
50 package body Sem_Warn is
52 -- The following table collects Id's of entities that are potentially
53 -- unreferenced. See Check_Unset_Reference for further details.
54 -- ??? Check_Unset_Reference has zero information about this table.
56 package Unreferenced_Entities is new Table.Table (
57 Table_Component_Type => Entity_Id,
58 Table_Index_Type => Nat,
60 Table_Initial => Alloc.Unreferenced_Entities_Initial,
61 Table_Increment => Alloc.Unreferenced_Entities_Increment,
62 Table_Name => "Unreferenced_Entities");
64 -- The following table collects potential warnings for IN OUT parameters
65 -- that are referenced but not modified. These warnings are processed when
66 -- the front end calls the procedure Output_Non_Modified_In_Out_Warnings.
67 -- The reason that we defer output of these messages is that we want to
68 -- detect the case where the relevant procedure is used as a generic actual
69 -- in an instantiation, since we suppress the warnings in this case. The
70 -- flag Used_As_Generic_Actual will be set in this case, but only at the
71 -- point of usage. Similarly, we suppress the message if the address of the
72 -- procedure is taken, where the flag Address_Taken may be set later.
74 package In_Out_Warnings is new Table.Table (
75 Table_Component_Type => Entity_Id,
76 Table_Index_Type => Nat,
78 Table_Initial => Alloc.In_Out_Warnings_Initial,
79 Table_Increment => Alloc.In_Out_Warnings_Increment,
80 Table_Name => "In_Out_Warnings");
82 --------------------------------------------------------
83 -- Handling of Warnings Off, Unmodified, Unreferenced --
84 --------------------------------------------------------
86 -- The functions Has_Warnings_Off, Has_Unmodified, Has_Unreferenced must
87 -- generally be used instead of Warnings_Off, Has_Pragma_Unmodified and
88 -- Has_Pragma_Unreferenced, as noted in the specs in Einfo.
90 -- In order to avoid losing warnings in -gnatw.w (warn on unnecessary
91 -- warnings off pragma) mode, i.e. to avoid false negatives, the code
92 -- must follow some important rules.
94 -- Call these functions as late as possible, after completing all other
95 -- tests, just before the warnings is given. For example, don't write:
97 -- if not Has_Warnings_Off (E)
98 -- and then some-other-predicate-on-E then ..
100 -- Instead the following is preferred
102 -- if some-other-predicate-on-E
103 -- and then Has_Warnings_Off (E)
105 -- This way if some-other-predicate is false, we avoid a false indication
106 -- that a Warnings (Off,E) pragma was useful in preventing a warning.
108 -- The second rule is that if both Has_Unmodified and Has_Warnings_Off, or
109 -- Has_Unreferenced and Has_Warnings_Off are called, make sure that the
110 -- call to Has_Unmodified/Has_Unreferenced comes first, this way we record
111 -- that the Warnings (Off) could have been Unreferenced or Unmodified. In
112 -- fact Has_Unmodified/Has_Unreferenced includes a test for Warnings Off,
113 -- and so a subsequent test is not needed anyway (though it is harmless).
115 -----------------------
116 -- Local Subprograms --
117 -----------------------
119 function Generic_Package_Spec_Entity (E : Entity_Id) return Boolean;
120 -- This returns true if the entity E is declared within a generic package.
121 -- The point of this is to detect variables which are not assigned within
122 -- the generic, but might be assigned outside the package for any given
123 -- instance. These are cases where we leave the warnings to be posted for
124 -- the instance, when we will know more.
126 function Goto_Spec_Entity (E : Entity_Id) return Entity_Id;
127 -- If E is a parameter entity for a subprogram body, then this function
128 -- returns the corresponding spec entity, if not, E is returned unchanged.
130 function Has_Pragma_Unmodified_Check_Spec (E : Entity_Id) return Boolean;
131 -- Tests Has_Pragma_Unmodified flag for entity E. If E is not a formal,
132 -- this is simply the setting of the flag Has_Pragma_Unmodified. If E is
133 -- a body formal, the setting of the flag in the corresponding spec is
134 -- also checked (and True returned if either flag is True).
136 function Has_Pragma_Unreferenced_Check_Spec (E : Entity_Id) return Boolean;
137 -- Tests Has_Pragma_Unreferenced flag for entity E. If E is not a formal,
138 -- this is simply the setting of the flag Has_Pragma_Unreferenced. If E is
139 -- a body formal, the setting of the flag in the corresponding spec is
140 -- also checked (and True returned if either flag is True).
142 function Never_Set_In_Source_Check_Spec (E : Entity_Id) return Boolean;
143 -- Tests Never_Set_In_Source status for entity E. If E is not a formal,
144 -- this is simply the setting of the flag Never_Set_In_Source. If E is
145 -- a body formal, the setting of the flag in the corresponding spec is
146 -- also checked (and False returned if either flag is False).
148 function Operand_Has_Warnings_Suppressed (N : Node_Id) return Boolean;
149 -- This function traverses the expression tree represented by the node N
150 -- and determines if any sub-operand is a reference to an entity for which
151 -- the Warnings_Off flag is set. True is returned if such an entity is
152 -- encountered, and False otherwise.
154 function Referenced_Check_Spec (E : Entity_Id) return Boolean;
155 -- Tests Referenced status for entity E. If E is not a formal, this is
156 -- simply the setting of the flag Referenced. If E is a body formal, the
157 -- setting of the flag in the corresponding spec is also checked (and True
158 -- returned if either flag is True).
160 function Referenced_As_LHS_Check_Spec (E : Entity_Id) return Boolean;
161 -- Tests Referenced_As_LHS status for entity E. If E is not a formal, this
162 -- is simply the setting of the flag Referenced_As_LHS. If E is a body
163 -- formal, the setting of the flag in the corresponding spec is also
164 -- checked (and True returned if either flag is True).
166 function Referenced_As_Out_Parameter_Check_Spec
167 (E : Entity_Id) return Boolean;
168 -- Tests Referenced_As_Out_Parameter status for entity E. If E is not a
169 -- formal, this is simply the setting of Referenced_As_Out_Parameter. If E
170 -- is a body formal, the setting of the flag in the corresponding spec is
171 -- also checked (and True returned if either flag is True).
173 procedure Warn_On_Unreferenced_Entity
175 Body_E : Entity_Id := Empty);
176 -- Output warnings for unreferenced entity E. For the case of an entry
177 -- formal, Body_E is the corresponding body entity for a particular
178 -- accept statement, and the message is posted on Body_E. In all other
179 -- cases, Body_E is ignored and must be Empty.
181 function Warnings_Off_Check_Spec (E : Entity_Id) return Boolean;
182 -- Returns True if Warnings_Off is set for the entity E or (in the case
183 -- where there is a Spec_Entity), Warnings_Off is set for the Spec_Entity.
185 --------------------------
186 -- Check_Code_Statement --
187 --------------------------
189 procedure Check_Code_Statement (N : Node_Id) is
191 -- If volatile, nothing to worry about
193 if Is_Asm_Volatile (N) then
197 -- Warn if no input or no output
199 Setup_Asm_Inputs (N);
201 if No (Asm_Input_Value) then
203 ("?code statement with no inputs should usually be Volatile!", N);
207 Setup_Asm_Outputs (N);
209 if No (Asm_Output_Variable) then
211 ("?code statement with no outputs should usually be Volatile!", N);
214 end Check_Code_Statement;
216 ---------------------------------
217 -- Check_Infinite_Loop_Warning --
218 ---------------------------------
220 -- The case we look for is a while loop which tests a local variable, where
221 -- there is no obvious direct or possible indirect update of the variable
222 -- within the body of the loop.
224 procedure Check_Infinite_Loop_Warning (Loop_Statement : Node_Id) is
225 Expression : Node_Id := Empty;
226 -- Set to WHILE or EXIT WHEN condition to be tested
228 Ref : Node_Id := Empty;
229 -- Reference in Expression to variable that might not be modified
230 -- in loop, indicating a possible infinite loop.
232 Var : Entity_Id := Empty;
233 -- Corresponding entity (entity of Ref)
235 Function_Call_Found : Boolean := False;
236 -- True if Find_Var found a function call in the condition
238 procedure Find_Var (N : Node_Id);
239 -- Inspect condition to see if it depends on a single entity reference.
240 -- If so, Ref is set to point to the reference node, and Var is set to
241 -- the referenced Entity.
243 function Has_Indirection (T : Entity_Id) return Boolean;
244 -- If the controlling variable is an access type, or is a record type
245 -- with access components, assume that it is changed indirectly and
246 -- suppress the warning. As a concession to low-level programming, in
247 -- particular within Declib, we also suppress warnings on a record
248 -- type that contains components of type Address or Short_Address.
250 function Is_Suspicious_Function_Name (E : Entity_Id) return Boolean;
251 -- Given an entity name, see if the name appears to have something to
252 -- do with I/O or network stuff, and if so, return True. Used to kill
253 -- some false positives on a heuristic basis that such functions will
254 -- likely have some strange side effect dependencies. A rather funny
255 -- kludge, but warning messages are in the heuristics business.
257 function Test_Ref (N : Node_Id) return Traverse_Result;
258 -- Test for reference to variable in question. Returns Abandon if
259 -- matching reference found. Used in instantiation of No_Ref_Found.
261 function No_Ref_Found is new Traverse_Func (Test_Ref);
262 -- Function to traverse body of procedure. Returns Abandon if matching
269 procedure Find_Var (N : Node_Id) is
271 -- Condition is a direct variable reference
273 if Is_Entity_Name (N) then
277 -- Case of condition is a comparison with compile time known value
279 elsif Nkind (N) in N_Op_Compare then
280 if Compile_Time_Known_Value (Right_Opnd (N)) then
281 Find_Var (Left_Opnd (N));
283 elsif Compile_Time_Known_Value (Left_Opnd (N)) then
284 Find_Var (Right_Opnd (N));
286 -- Ignore any other comparison
292 -- If condition is a negation, check its operand
294 elsif Nkind (N) = N_Op_Not then
295 Find_Var (Right_Opnd (N));
297 -- Case of condition is function call
299 elsif Nkind (N) = N_Function_Call then
301 Function_Call_Found := True;
303 -- Forget it if function name is not entity, who knows what
304 -- we might be calling?
306 if not Is_Entity_Name (Name (N)) then
309 -- Forget it if function name is suspicious. A strange test
310 -- but warning generation is in the heuristics business!
312 elsif Is_Suspicious_Function_Name (Entity (Name (N))) then
315 -- Forget it if warnings are suppressed on function entity
317 elsif Has_Warnings_Off (Entity (Name (N))) then
321 -- OK, see if we have one argument
324 PA : constant List_Id := Parameter_Associations (N);
327 -- One argument, so check the argument
330 and then List_Length (PA) = 1
332 if Nkind (First (PA)) = N_Parameter_Association then
333 Find_Var (Explicit_Actual_Parameter (First (PA)));
335 Find_Var (First (PA));
345 -- Any other kind of node is not something we warn for
352 ---------------------
353 -- Has_Indirection --
354 ---------------------
356 function Has_Indirection (T : Entity_Id) return Boolean is
361 if Is_Access_Type (T) then
364 elsif Is_Private_Type (T)
365 and then Present (Full_View (T))
366 and then Is_Access_Type (Full_View (T))
370 elsif Is_Record_Type (T) then
373 elsif Is_Private_Type (T)
374 and then Present (Full_View (T))
375 and then Is_Record_Type (Full_View (T))
377 Rec := Full_View (T);
382 Comp := First_Component (Rec);
383 while Present (Comp) loop
384 if Is_Access_Type (Etype (Comp))
385 or else Is_Descendent_Of_Address (Etype (Comp))
390 Next_Component (Comp);
396 ---------------------------------
397 -- Is_Suspicious_Function_Name --
398 ---------------------------------
400 function Is_Suspicious_Function_Name (E : Entity_Id) return Boolean is
403 function Substring_Present (S : String) return Boolean;
404 -- Returns True if name buffer has given string delimited by non-
405 -- alphabetic characters or by end of string. S is lower case.
407 -----------------------
408 -- Substring_Present --
409 -----------------------
411 function Substring_Present (S : String) return Boolean is
412 Len : constant Natural := S'Length;
415 for J in 1 .. Name_Len - (Len - 1) loop
416 if Name_Buffer (J .. J + (Len - 1)) = S
419 or else Name_Buffer (J - 1) not in 'a' .. 'z')
422 or else Name_Buffer (J + Len) not in 'a' .. 'z')
429 end Substring_Present;
431 -- Start of processing for Is_Suspicious_Function_Name
435 while Present (S) and then S /= Standard_Standard loop
436 Get_Name_String (Chars (S));
438 if Substring_Present ("io")
439 or else Substring_Present ("file")
440 or else Substring_Present ("network")
449 end Is_Suspicious_Function_Name;
455 function Test_Ref (N : Node_Id) return Traverse_Result is
457 -- Waste of time to look at the expression we are testing
459 if N = Expression then
462 -- Direct reference to variable in question
464 elsif Is_Entity_Name (N)
465 and then Present (Entity (N))
466 and then Entity (N) = Var
468 -- If this is an lvalue, then definitely abandon, since
469 -- this could be a direct modification of the variable.
471 if May_Be_Lvalue (N) then
475 -- If we appear in the context of a procedure call, then also
476 -- abandon, since there may be issues of non-visible side
477 -- effects going on in the call.
486 exit when P = Loop_Statement;
488 -- Abandon if at procedure call, or something strange is
489 -- going on (perhaps a node with no parent that should
490 -- have one but does not?) As always, for a warning we
491 -- prefer to just abandon the warning than get into the
492 -- business of complaining about the tree structure here!
494 if No (P) or else Nkind (P) = N_Procedure_Call_Statement then
500 -- Reference to variable renaming variable in question
502 elsif Is_Entity_Name (N)
503 and then Present (Entity (N))
504 and then Ekind (Entity (N)) = E_Variable
505 and then Present (Renamed_Object (Entity (N)))
506 and then Is_Entity_Name (Renamed_Object (Entity (N)))
507 and then Entity (Renamed_Object (Entity (N))) = Var
508 and then May_Be_Lvalue (N)
512 -- Call to subprogram
514 elsif Nkind (N) = N_Procedure_Call_Statement
515 or else Nkind (N) = N_Function_Call
517 -- If subprogram is within the scope of the entity we are dealing
518 -- with as the loop variable, then it could modify this parameter,
519 -- so we abandon in this case. In the case of a subprogram that is
520 -- not an entity we also abandon. The check for no entity being
521 -- present is a defense against previous errors.
523 if not Is_Entity_Name (Name (N))
524 or else No (Entity (Name (N)))
525 or else Scope_Within (Entity (Name (N)), Scope (Var))
530 -- If any of the arguments are of type access to subprogram, then
531 -- we may have funny side effects, so no warning in this case.
536 Actual := First_Actual (N);
537 while Present (Actual) loop
538 if Is_Access_Subprogram_Type (Etype (Actual)) then
541 Next_Actual (Actual);
546 -- Declaration of the variable in question
548 elsif Nkind (N) = N_Object_Declaration
549 and then Defining_Identifier (N) = Var
554 -- All OK, continue scan
559 -- Start of processing for Check_Infinite_Loop_Warning
562 -- Skip processing if debug flag gnatd.w is set
564 if Debug_Flag_Dot_W then
568 -- Deal with Iteration scheme present
571 Iter : constant Node_Id := Iteration_Scheme (Loop_Statement);
574 if Present (Iter) then
578 if Present (Condition (Iter)) then
580 -- Skip processing for while iteration with conditions actions,
581 -- since they make it too complicated to get the warning right.
583 if Present (Condition_Actions (Iter)) then
587 -- Capture WHILE condition
589 Expression := Condition (Iter);
591 -- For iteration, do not process, since loop will always terminate
593 elsif Present (Loop_Parameter_Specification (Iter)) then
599 -- Check chain of EXIT statements, we only process loops that have a
600 -- single exit condition (either a single EXIT WHEN statement, or a
601 -- WHILE loop not containing any EXIT WHEN statements).
604 Ident : constant Node_Id := Identifier (Loop_Statement);
608 -- If we don't have a proper chain set, ignore call entirely. This
609 -- happens because of previous errors.
611 if No (Entity (Ident))
612 or else Ekind (Entity (Ident)) /= E_Loop
617 -- Otherwise prepare to scan list of EXIT statements
619 Exit_Stmt := First_Exit_Statement (Entity (Ident));
620 while Present (Exit_Stmt) loop
622 -- Check for EXIT WHEN
624 if Present (Condition (Exit_Stmt)) then
626 -- Quit processing if EXIT WHEN in WHILE loop, or more than
627 -- one EXIT WHEN statement present in the loop.
629 if Present (Expression) then
632 -- Otherwise capture condition from EXIT WHEN statement
635 Expression := Condition (Exit_Stmt);
639 Exit_Stmt := Next_Exit_Statement (Exit_Stmt);
643 -- Return if no condition to test
645 if No (Expression) then
649 -- Initial conditions met, see if condition is of right form
651 Find_Var (Expression);
653 -- Nothing to do if local variable from source not found. If it's a
654 -- renaming, it is probably renaming something too complicated to deal
658 or else Ekind (Var) /= E_Variable
659 or else Is_Library_Level_Entity (Var)
660 or else not Comes_From_Source (Var)
661 or else Nkind (Parent (Var)) = N_Object_Renaming_Declaration
665 -- Nothing to do if there is some indirection involved (assume that the
666 -- designated variable might be modified in some way we don't see).
667 -- However, if no function call was found, then we don't care about
668 -- indirections, because the condition must be something like "while X
669 -- /= null loop", so we don't care if X.all is modified in the loop.
671 elsif Function_Call_Found and then Has_Indirection (Etype (Var)) then
674 -- Same sort of thing for volatile variable, might be modified by
675 -- some other task or by the operating system in some way.
677 elsif Is_Volatile (Var) then
681 -- Filter out case of original statement sequence starting with delay.
682 -- We assume this is a multi-tasking program and that the condition
683 -- is affected by other threads (some kind of busy wait).
686 Fstm : constant Node_Id :=
687 Original_Node (First (Statements (Loop_Statement)));
689 if Nkind (Fstm) = N_Delay_Relative_Statement
690 or else Nkind (Fstm) = N_Delay_Until_Statement
696 -- We have a variable reference of the right form, now we scan the loop
697 -- body to see if it looks like it might not be modified
699 if No_Ref_Found (Loop_Statement) = OK then
701 ("?variable& is not modified in loop body!", Ref, Var);
703 ("\?possible infinite loop!", Ref);
705 end Check_Infinite_Loop_Warning;
707 ----------------------------
708 -- Check_Low_Bound_Tested --
709 ----------------------------
711 procedure Check_Low_Bound_Tested (Expr : Node_Id) is
713 if Comes_From_Source (Expr) then
715 L : constant Node_Id := Left_Opnd (Expr);
716 R : constant Node_Id := Right_Opnd (Expr);
718 if Nkind (L) = N_Attribute_Reference
719 and then Attribute_Name (L) = Name_First
720 and then Is_Entity_Name (Prefix (L))
721 and then Is_Formal (Entity (Prefix (L)))
723 Set_Low_Bound_Tested (Entity (Prefix (L)));
726 if Nkind (R) = N_Attribute_Reference
727 and then Attribute_Name (R) = Name_First
728 and then Is_Entity_Name (Prefix (R))
729 and then Is_Formal (Entity (Prefix (R)))
731 Set_Low_Bound_Tested (Entity (Prefix (R)));
735 end Check_Low_Bound_Tested;
737 ----------------------
738 -- Check_References --
739 ----------------------
741 procedure Check_References (E : Entity_Id; Anod : Node_Id := Empty) is
748 Accept_Statement : Node_Id) return Entity_Id;
749 -- For an entry formal entity from an entry declaration, find the
750 -- corresponding body formal from the given accept statement.
752 function Missing_Subunits return Boolean;
753 -- We suppress warnings when there are missing subunits, because this
754 -- may generate too many false positives: entities in a parent may only
755 -- be referenced in one of the subunits. We make an exception for
756 -- subunits that contain no other stubs.
758 procedure Output_Reference_Error (M : String);
759 -- Used to output an error message. Deals with posting the error on the
760 -- body formal in the accept case.
762 function Publicly_Referenceable (Ent : Entity_Id) return Boolean;
763 -- This is true if the entity in question is potentially referenceable
764 -- from another unit. This is true for entities in packages that are at
765 -- the library level.
767 function Warnings_Off_E1 return Boolean;
768 -- Return True if Warnings_Off is set for E1, or for its Etype (E1T),
769 -- or for the base type of E1T.
777 Accept_Statement : Node_Id) return Entity_Id
779 Body_Param : Node_Id;
783 -- Loop to find matching parameter in accept statement
785 Body_Param := First (Parameter_Specifications (Accept_Statement));
786 while Present (Body_Param) loop
787 Body_E := Defining_Identifier (Body_Param);
789 if Chars (Body_E) = Chars (E) then
796 -- Should never fall through, should always find a match
801 ----------------------
802 -- Missing_Subunits --
803 ----------------------
805 function Missing_Subunits return Boolean is
809 if not Unloaded_Subunits then
811 -- Normal compilation, all subunits are present
815 elsif E /= Main_Unit_Entity then
817 -- No warnings on a stub that is not the main unit
821 elsif Nkind (Unit_Declaration_Node (E)) in N_Proper_Body then
822 D := First (Declarations (Unit_Declaration_Node (E)));
823 while Present (D) loop
825 -- No warnings if the proper body contains nested stubs
827 if Nkind (D) in N_Body_Stub then
837 -- Missing stubs elsewhere
841 end Missing_Subunits;
843 ----------------------------
844 -- Output_Reference_Error --
845 ----------------------------
847 procedure Output_Reference_Error (M : String) is
849 -- Never issue messages for internal names, nor for renamings
851 if Is_Internal_Name (Chars (E1))
852 or else Nkind (Parent (E1)) = N_Object_Renaming_Declaration
857 -- Don't output message for IN OUT formal unless we have the warning
858 -- flag specifically set. It is a bit odd to distinguish IN OUT
859 -- formals from other cases. This distinction is historical in
860 -- nature. Warnings for IN OUT formals were added fairly late.
862 if Ekind (E1) = E_In_Out_Parameter
863 and then not Check_Unreferenced_Formals
868 -- Other than accept case, post error on defining identifier
873 -- Accept case, find body formal to post the message
876 Error_Msg_NE (M, Body_Formal (E1, Accept_Statement => Anod), E1);
879 end Output_Reference_Error;
881 ----------------------------
882 -- Publicly_Referenceable --
883 ----------------------------
885 function Publicly_Referenceable (Ent : Entity_Id) return Boolean is
890 -- A formal parameter is never referenceable outside the body of its
891 -- subprogram or entry.
893 if Is_Formal (Ent) then
897 -- Examine parents to look for a library level package spec. But if
898 -- we find a body or block or other similar construct along the way,
899 -- we cannot be referenced.
906 -- If we get to top of tree, then publicly referenceable
911 -- If we reach a generic package declaration, then always
912 -- consider this referenceable, since any instantiation will
913 -- have access to the entities in the generic package. Note
914 -- that the package itself may not be instantiated, but then
915 -- we will get a warning for the package entity.
917 -- Note that generic formal parameters are themselves not
918 -- publicly referenceable in an instance, and warnings on them
921 when N_Generic_Package_Declaration =>
923 not Is_List_Member (Prev)
924 or else List_Containing (Prev)
925 /= Generic_Formal_Declarations (P);
927 -- Similarly, the generic formals of a generic subprogram are
930 when N_Generic_Subprogram_Declaration =>
931 if Is_List_Member (Prev)
932 and then List_Containing (Prev) =
933 Generic_Formal_Declarations (P)
940 -- If we reach a subprogram body, entity is not referenceable
941 -- unless it is the defining entity of the body. This will
942 -- happen, e.g. when a function is an attribute renaming that
943 -- is rewritten as a body.
945 when N_Subprogram_Body =>
946 if Ent /= Defining_Entity (P) then
952 -- If we reach any other body, definitely not referenceable
954 when N_Package_Body |
962 -- For all other cases, keep looking up tree
969 end Publicly_Referenceable;
971 ---------------------
972 -- Warnings_Off_E1 --
973 ---------------------
975 function Warnings_Off_E1 return Boolean is
977 return Has_Warnings_Off (E1T)
978 or else Has_Warnings_Off (Base_Type (E1T))
979 or else Warnings_Off_Check_Spec (E1);
982 -- Start of processing for Check_References
985 -- No messages if warnings are suppressed, or if we have detected any
986 -- real errors so far (this last check avoids junk messages resulting
987 -- from errors, e.g. a subunit that is not loaded).
989 if Warning_Mode = Suppress
990 or else Serious_Errors_Detected /= 0
995 -- We also skip the messages if any subunits were not loaded (see
996 -- comment in Sem_Ch10 to understand how this is set, and why it is
997 -- necessary to suppress the warnings in this case).
999 if Missing_Subunits then
1003 -- Otherwise loop through entities, looking for suspicious stuff
1005 E1 := First_Entity (E);
1006 while Present (E1) loop
1009 -- We are only interested in source entities. We also don't issue
1010 -- warnings within instances, since the proper place for such
1011 -- warnings is on the template when it is compiled.
1013 if Comes_From_Source (E1)
1014 and then Instantiation_Location (Sloc (E1)) = No_Location
1016 -- We are interested in variables and out/in-out parameters, but
1017 -- we exclude protected types, too complicated to worry about.
1019 if Ekind (E1) = E_Variable
1021 (Ekind_In (E1, E_Out_Parameter, E_In_Out_Parameter)
1022 and then not Is_Protected_Type (Current_Scope))
1024 -- Case of an unassigned variable
1026 -- First gather any Unset_Reference indication for E1. In the
1027 -- case of a parameter, it is the Spec_Entity that is relevant.
1029 if Ekind (E1) = E_Out_Parameter
1030 and then Present (Spec_Entity (E1))
1032 UR := Unset_Reference (Spec_Entity (E1));
1034 UR := Unset_Reference (E1);
1037 -- Special processing for access types
1040 and then Is_Access_Type (E1T)
1042 -- For access types, the only time we made a UR entry was
1043 -- for a dereference, and so we post the appropriate warning
1044 -- here (note that the dereference may not be explicit in
1045 -- the source, for example in the case of a dispatching call
1046 -- with an anonymous access controlling formal, or of an
1047 -- assignment of a pointer involving discriminant check on
1048 -- the designated object).
1050 if not Warnings_Off_E1 then
1051 Error_Msg_NE ("?& may be null!", UR, E1);
1056 -- Case of variable that could be a constant. Note that we
1057 -- never signal such messages for generic package entities,
1058 -- since a given instance could have modifications outside
1061 elsif Warn_On_Constant
1062 and then (Ekind (E1) = E_Variable
1063 and then Has_Initial_Value (E1))
1064 and then Never_Set_In_Source_Check_Spec (E1)
1065 and then not Address_Taken (E1)
1066 and then not Generic_Package_Spec_Entity (E1)
1068 -- A special case, if this variable is volatile and not
1069 -- imported, it is not helpful to tell the programmer
1070 -- to mark the variable as constant, since this would be
1071 -- illegal by virtue of RM C.6(13).
1073 if (Is_Volatile (E1) or else Has_Volatile_Components (E1))
1074 and then not Is_Imported (E1)
1077 ("?& is not modified, volatile has no effect!", E1);
1079 -- Another special case, Exception_Occurrence, this catches
1080 -- the case of exception choice (and a bit more too, but not
1081 -- worth doing more investigation here).
1083 elsif Is_RTE (E1T, RE_Exception_Occurrence) then
1086 -- Here we give the warning if referenced and no pragma
1087 -- Unreferenced or Unmodified is present.
1092 if Ekind (E1) = E_Variable then
1093 if Referenced_Check_Spec (E1)
1094 and then not Has_Pragma_Unreferenced_Check_Spec (E1)
1095 and then not Has_Pragma_Unmodified_Check_Spec (E1)
1097 if not Warnings_Off_E1 then
1098 Error_Msg_N -- CODEFIX
1099 ("?& is not modified, "
1100 & "could be declared constant!",
1107 -- Other cases of a variable or parameter never set in source
1109 elsif Never_Set_In_Source_Check_Spec (E1)
1111 -- No warning if warning for this case turned off
1113 and then Warn_On_No_Value_Assigned
1115 -- No warning if address taken somewhere
1117 and then not Address_Taken (E1)
1119 -- No warning if explicit initial value
1121 and then not Has_Initial_Value (E1)
1123 -- No warning for generic package spec entities, since we
1124 -- might set them in a child unit or something like that
1126 and then not Generic_Package_Spec_Entity (E1)
1128 -- No warning if fully initialized type, except that for
1129 -- this purpose we do not consider access types to qualify
1130 -- as fully initialized types (relying on an access type
1131 -- variable being null when it is never set is a bit odd!)
1133 -- Also we generate warning for an out parameter that is
1134 -- never referenced, since again it seems odd to rely on
1135 -- default initialization to set an out parameter value.
1137 and then (Is_Access_Type (E1T)
1138 or else Ekind (E1) = E_Out_Parameter
1139 or else not Is_Fully_Initialized_Type (E1T))
1141 -- Do not output complaint about never being assigned a
1142 -- value if a pragma Unmodified applies to the variable
1143 -- we are examining, or if it is a parameter, if there is
1144 -- a pragma Unreferenced for the corresponding spec, or
1145 -- if the type is marked as having unreferenced objects.
1146 -- The last is a little peculiar, but better too few than
1147 -- too many warnings in this situation.
1149 if Has_Pragma_Unreferenced_Objects (E1T)
1150 or else Has_Pragma_Unmodified_Check_Spec (E1)
1154 -- IN OUT parameter case where parameter is referenced. We
1155 -- separate this out, since this is the case where we delay
1156 -- output of the warning until more information is available
1157 -- (about use in an instantiation or address being taken).
1159 elsif Ekind (E1) = E_In_Out_Parameter
1160 and then Referenced_Check_Spec (E1)
1162 -- Suppress warning if private type, and the procedure
1163 -- has a separate declaration in a different unit. This
1164 -- is the case where the client of a package sees only
1165 -- the private type, and it may be quite reasonable
1166 -- for the logical view to be IN OUT, even if the
1167 -- implementation ends up using access types or some
1168 -- other method to achieve the local effect of a
1169 -- modification. On the other hand if the spec and body
1170 -- are in the same unit, we are in the package body and
1171 -- there we have less excuse for a junk IN OUT parameter.
1173 if Has_Private_Declaration (E1T)
1174 and then Present (Spec_Entity (E1))
1175 and then not In_Same_Source_Unit (E1, Spec_Entity (E1))
1179 -- Suppress warning for any parameter of a dispatching
1180 -- operation, since it is quite reasonable to have an
1181 -- operation that is overridden, and for some subclasses
1182 -- needs the formal to be IN OUT and for others happens
1183 -- not to assign it.
1185 elsif Is_Dispatching_Operation
1186 (Scope (Goto_Spec_Entity (E1)))
1190 -- Suppress warning if composite type contains any access
1191 -- component, since the logical effect of modifying a
1192 -- parameter may be achieved by modifying a referenced
1195 elsif Is_Composite_Type (E1T)
1196 and then Has_Access_Values (E1T)
1200 -- Suppress warning on formals of an entry body. All
1201 -- references are attached to the formal in the entry
1202 -- declaration, which are marked Is_Entry_Formal.
1204 elsif Ekind (Scope (E1)) = E_Entry
1205 and then not Is_Entry_Formal (E1)
1209 -- OK, looks like warning for an IN OUT parameter that
1210 -- could be IN makes sense, but we delay the output of
1211 -- the warning, pending possibly finding out later on
1212 -- that the associated subprogram is used as a generic
1213 -- actual, or its address/access is taken. In these two
1214 -- cases, we suppress the warning because the context may
1215 -- force use of IN OUT, even if in this particular case
1216 -- the formal is not modified.
1219 In_Out_Warnings.Append (E1);
1222 -- Other cases of formals
1224 elsif Is_Formal (E1) then
1225 if not Is_Trivial_Subprogram (Scope (E1)) then
1226 if Referenced_Check_Spec (E1) then
1227 if not Has_Pragma_Unmodified_Check_Spec (E1)
1228 and then not Warnings_Off_E1
1230 Output_Reference_Error
1231 ("?formal parameter& is read but "
1232 & "never assigned!");
1235 elsif not Has_Pragma_Unreferenced_Check_Spec (E1)
1236 and then not Warnings_Off_E1
1238 Output_Reference_Error
1239 ("?formal parameter& is not referenced!");
1246 if Referenced (E1) then
1247 if not Has_Unmodified (E1)
1248 and then not Warnings_Off_E1
1250 Output_Reference_Error
1251 ("?variable& is read but never assigned!");
1254 elsif not Has_Unreferenced (E1)
1255 and then not Warnings_Off_E1
1257 Output_Reference_Error -- CODEFIX
1258 ("?variable& is never read and never assigned!");
1261 -- Deal with special case where this variable is hidden
1262 -- by a loop variable.
1264 if Ekind (E1) = E_Variable
1265 and then Present (Hiding_Loop_Variable (E1))
1266 and then not Warnings_Off_E1
1269 ("?for loop implicitly declares loop variable!",
1270 Hiding_Loop_Variable (E1));
1272 Error_Msg_Sloc := Sloc (E1);
1274 ("\?declaration hides & declared#!",
1275 Hiding_Loop_Variable (E1));
1282 -- Check for unset reference
1284 if Warn_On_No_Value_Assigned and then Present (UR) then
1286 -- For other than access type, go back to original node to
1287 -- deal with case where original unset reference has been
1288 -- rewritten during expansion.
1290 -- In some cases, the original node may be a type conversion
1291 -- or qualification, and in this case we want the object
1294 UR := Original_Node (UR);
1295 while Nkind (UR) = N_Type_Conversion
1296 or else Nkind (UR) = N_Qualified_Expression
1298 UR := Expression (UR);
1301 -- Here we issue the warning, all checks completed
1303 -- If we have a return statement, this was a case of an OUT
1304 -- parameter not being set at the time of the return. (Note:
1305 -- it can't be N_Extended_Return_Statement, because those
1306 -- are only for functions, and functions do not allow OUT
1309 if not Is_Trivial_Subprogram (Scope (E1)) then
1310 if Nkind (UR) = N_Simple_Return_Statement
1311 and then not Has_Pragma_Unmodified_Check_Spec (E1)
1313 if not Warnings_Off_E1 then
1315 ("?OUT parameter& not set before return", UR, E1);
1318 -- If the unset reference is a selected component
1319 -- prefix from source, mention the component as well.
1320 -- If the selected component comes from expansion, all
1321 -- we know is that the entity is not fully initialized
1322 -- at the point of the reference. Locate a random
1323 -- uninitialized component to get a better message.
1325 elsif Nkind (Parent (UR)) = N_Selected_Component then
1326 Error_Msg_Node_2 := Selector_Name (Parent (UR));
1328 if not Comes_From_Source (Parent (UR)) then
1333 Comp := First_Entity (E1T);
1334 while Present (Comp) loop
1335 if Ekind (Comp) = E_Component
1336 and then Nkind (Parent (Comp)) =
1337 N_Component_Declaration
1338 and then No (Expression (Parent (Comp)))
1340 Error_Msg_Node_2 := Comp;
1349 -- Issue proper warning. This is a case of referencing
1350 -- a variable before it has been explicitly assigned.
1351 -- For access types, UR was only set for dereferences,
1352 -- so the issue is that the value may be null.
1354 if not Is_Trivial_Subprogram (Scope (E1)) then
1355 if not Warnings_Off_E1 then
1356 if Is_Access_Type (Etype (Parent (UR))) then
1357 Error_Msg_N ("?`&.&` may be null!", UR);
1360 ("?`&.&` may be referenced before "
1361 & "it has a value!", UR);
1366 -- All other cases of unset reference active
1368 elsif not Warnings_Off_E1 then
1370 ("?& may be referenced before it has a value!",
1379 -- Then check for unreferenced entities. Note that we are only
1380 -- interested in entities whose Referenced flag is not set.
1382 if not Referenced_Check_Spec (E1)
1384 -- If Referenced_As_LHS is set, then that's still interesting
1385 -- (potential "assigned but never read" case), but not if we
1386 -- have pragma Unreferenced, which cancels this warning.
1388 and then (not Referenced_As_LHS_Check_Spec (E1)
1389 or else not Has_Unreferenced (E1))
1391 -- Check that warnings on unreferenced entities are enabled
1394 ((Check_Unreferenced and then not Is_Formal (E1))
1396 -- Case of warning on unreferenced formal
1399 (Check_Unreferenced_Formals and then Is_Formal (E1))
1401 -- Case of warning on unread variables modified by an
1402 -- assignment, or an OUT parameter if it is the only one.
1405 (Warn_On_Modified_Unread
1406 and then Referenced_As_LHS_Check_Spec (E1))
1408 -- Case of warning on any unread OUT parameter (note
1409 -- such indications are only set if the appropriate
1410 -- warning options were set, so no need to recheck here.)
1413 Referenced_As_Out_Parameter_Check_Spec (E1))
1415 -- All other entities, including local packages that cannot be
1416 -- referenced from elsewhere, including those declared within a
1419 and then (Is_Object (E1)
1423 Ekind (E1) = E_Label
1425 Ekind (E1) = E_Exception
1427 Ekind (E1) = E_Named_Integer
1429 Ekind (E1) = E_Named_Real
1431 Is_Overloadable (E1)
1433 -- Package case, if the main unit is a package spec
1434 -- or generic package spec, then there may be a
1435 -- corresponding body that references this package
1436 -- in some other file. Otherwise we can be sure
1437 -- that there is no other reference.
1440 (Ekind (E1) = E_Package
1442 not Is_Package_Or_Generic_Package
1443 (Cunit_Entity (Current_Sem_Unit))))
1445 -- Exclude instantiations, since there is no reason why every
1446 -- entity in an instantiation should be referenced.
1448 and then Instantiation_Location (Sloc (E1)) = No_Location
1450 -- Exclude formal parameters from bodies if the corresponding
1451 -- spec entity has been referenced in the case where there is
1454 and then not (Is_Formal (E1)
1455 and then Ekind (Scope (E1)) = E_Subprogram_Body
1456 and then Present (Spec_Entity (E1))
1457 and then Referenced (Spec_Entity (E1)))
1459 -- Consider private type referenced if full view is referenced.
1460 -- If there is not full view, this is a generic type on which
1461 -- warnings are also useful.
1464 not (Is_Private_Type (E1)
1465 and then Present (Full_View (E1))
1466 and then Referenced (Full_View (E1)))
1468 -- Don't worry about full view, only about private type
1470 and then not Has_Private_Declaration (E1)
1472 -- Eliminate dispatching operations from consideration, we
1473 -- cannot tell if these are referenced or not in any easy
1474 -- manner (note this also catches Adjust/Finalize/Initialize).
1476 and then not Is_Dispatching_Operation (E1)
1478 -- Check entity that can be publicly referenced (we do not give
1479 -- messages for such entities, since there could be other
1480 -- units, not involved in this compilation, that contain
1481 -- relevant references.
1483 and then not Publicly_Referenceable (E1)
1485 -- Class wide types are marked as source entities, but they are
1486 -- not really source entities, and are always created, so we do
1487 -- not care if they are not referenced.
1489 and then Ekind (E1) /= E_Class_Wide_Type
1491 -- Objects other than parameters of task types are allowed to
1492 -- be non-referenced, since they start up tasks!
1494 and then ((Ekind (E1) /= E_Variable
1495 and then Ekind (E1) /= E_Constant
1496 and then Ekind (E1) /= E_Component)
1497 or else not Is_Task_Type (E1T))
1499 -- For subunits, only place warnings on the main unit itself,
1500 -- since parent units are not completely compiled.
1502 and then (Nkind (Unit (Cunit (Main_Unit))) /= N_Subunit
1503 or else Get_Source_Unit (E1) = Main_Unit)
1505 -- No warning on a return object, because these are often
1506 -- created with a single expression and an implicit return.
1507 -- If the object is a variable there will be a warning
1508 -- indicating that it could be declared constant.
1511 (Ekind (E1) = E_Constant and then Is_Return_Object (E1))
1513 -- Suppress warnings in internal units if not in -gnatg mode
1514 -- (these would be junk warnings for an applications program,
1515 -- since they refer to problems in internal units).
1518 or else not Is_Internal_File_Name
1519 (Unit_File_Name (Get_Source_Unit (E1)))
1521 -- We do not immediately flag the error. This is because we
1522 -- have not expanded generic bodies yet, and they may have
1523 -- the missing reference. So instead we park the entity on a
1524 -- list, for later processing. However for the case of an
1525 -- accept statement we want to output messages now, since
1526 -- we know we already have all information at hand, and we
1527 -- also want to have separate warnings for each accept
1528 -- statement for the same entry.
1530 if Present (Anod) then
1531 pragma Assert (Is_Formal (E1));
1533 -- The unreferenced entity is E1, but post the warning
1534 -- on the body entity for this accept statement.
1536 if not Warnings_Off_E1 then
1537 Warn_On_Unreferenced_Entity
1538 (E1, Body_Formal (E1, Accept_Statement => Anod));
1541 elsif not Warnings_Off_E1 then
1542 Unreferenced_Entities.Append (E1);
1546 -- Generic units are referenced in the generic body, but if they
1547 -- are not public and never instantiated we want to force a
1548 -- warning on them. We treat them as redundant constructs to
1551 elsif Is_Generic_Subprogram (E1)
1552 and then not Is_Instantiated (E1)
1553 and then not Publicly_Referenceable (E1)
1554 and then Instantiation_Depth (Sloc (E1)) = 0
1555 and then Warn_On_Redundant_Constructs
1557 if not Warnings_Off_E1 then
1558 Unreferenced_Entities.Append (E1);
1560 -- Force warning on entity
1562 Set_Referenced (E1, False);
1567 -- Recurse into nested package or block. Do not recurse into a formal
1568 -- package, because the corresponding body is not analyzed.
1571 if (Is_Package_Or_Generic_Package (E1)
1572 and then Nkind (Parent (E1)) = N_Package_Specification
1574 Nkind (Original_Node (Unit_Declaration_Node (E1)))
1575 /= N_Formal_Package_Declaration)
1577 or else Ekind (E1) = E_Block
1579 Check_References (E1);
1584 end Check_References;
1586 ---------------------------
1587 -- Check_Unset_Reference --
1588 ---------------------------
1590 procedure Check_Unset_Reference (N : Node_Id) is
1591 Typ : constant Entity_Id := Etype (N);
1593 function Is_OK_Fully_Initialized return Boolean;
1594 -- This function returns true if the given node N is fully initialized
1595 -- so that the reference is safe as far as this routine is concerned.
1596 -- Safe generally means that the type of N is a fully initialized type.
1597 -- The one special case is that for access types, which are always fully
1598 -- initialized, we don't consider a dereference OK since it will surely
1599 -- be dereferencing a null value, which won't do.
1601 function Prefix_Has_Dereference (Pref : Node_Id) return Boolean;
1602 -- Used to test indexed or selected component or slice to see if the
1603 -- evaluation of the prefix depends on a dereference, and if so, returns
1604 -- True, in which case we always check the prefix, even if we know that
1605 -- the referenced component is initialized. Pref is the prefix to test.
1607 -----------------------------
1608 -- Is_OK_Fully_Initialized --
1609 -----------------------------
1611 function Is_OK_Fully_Initialized return Boolean is
1613 if Is_Access_Type (Typ) and then Is_Dereferenced (N) then
1616 return Is_Fully_Initialized_Type (Typ);
1618 end Is_OK_Fully_Initialized;
1620 ----------------------------
1621 -- Prefix_Has_Dereference --
1622 ----------------------------
1624 function Prefix_Has_Dereference (Pref : Node_Id) return Boolean is
1626 -- If prefix is of an access type, it certainly needs a dereference
1628 if Is_Access_Type (Etype (Pref)) then
1631 -- If prefix is explicit dereference, that's a dereference for sure
1633 elsif Nkind (Pref) = N_Explicit_Dereference then
1636 -- If prefix is itself a component reference or slice check prefix
1638 elsif Nkind (Pref) = N_Slice
1639 or else Nkind (Pref) = N_Indexed_Component
1640 or else Nkind (Pref) = N_Selected_Component
1642 return Prefix_Has_Dereference (Prefix (Pref));
1644 -- All other cases do not involve a dereference
1649 end Prefix_Has_Dereference;
1651 -- Start of processing for Check_Unset_Reference
1654 -- Nothing to do if warnings suppressed
1656 if Warning_Mode = Suppress then
1660 -- Ignore reference unless it comes from source. Almost always if we
1661 -- have a reference from generated code, it is bogus (e.g. calls to init
1662 -- procs to set default discriminant values).
1664 if not Comes_From_Source (N) then
1668 -- Otherwise see what kind of node we have. If the entity already has an
1669 -- unset reference, it is not necessarily the earliest in the text,
1670 -- because resolution of the prefix of selected components is completed
1671 -- before the resolution of the selected component itself. As a result,
1672 -- given (R /= null and then R.X > 0), the occurrences of R are examined
1673 -- in right-to-left order. If there is already an unset reference, we
1674 -- check whether N is earlier before proceeding.
1678 -- For identifier or expanded name, examine the entity involved
1680 when N_Identifier | N_Expanded_Name =>
1682 E : constant Entity_Id := Entity (N);
1685 if (Ekind (E) = E_Variable
1687 Ekind (E) = E_Out_Parameter)
1688 and then Never_Set_In_Source_Check_Spec (E)
1689 and then not Has_Initial_Value (E)
1690 and then (No (Unset_Reference (E))
1692 Earlier_In_Extended_Unit
1693 (Sloc (N), Sloc (Unset_Reference (E))))
1694 and then not Has_Pragma_Unmodified_Check_Spec (E)
1695 and then not Warnings_Off_Check_Spec (E)
1697 -- We may have an unset reference. The first test is whether
1698 -- this is an access to a discriminant of a record or a
1699 -- component with default initialization. Both of these
1700 -- cases can be ignored, since the actual object that is
1701 -- referenced is definitely initialized. Note that this
1702 -- covers the case of reading discriminants of an OUT
1703 -- parameter, which is OK even in Ada 83.
1705 -- Note that we are only interested in a direct reference to
1706 -- a record component here. If the reference is through an
1707 -- access type, then the access object is being referenced,
1708 -- not the record, and still deserves an unset reference.
1710 if Nkind (Parent (N)) = N_Selected_Component
1711 and not Is_Access_Type (Typ)
1714 ES : constant Entity_Id :=
1715 Entity (Selector_Name (Parent (N)));
1717 if Ekind (ES) = E_Discriminant
1719 (Present (Declaration_Node (ES))
1721 Present (Expression (Declaration_Node (ES))))
1728 -- Exclude fully initialized types
1730 if Is_OK_Fully_Initialized then
1734 -- Here we have a potential unset reference. But before we
1735 -- get worried about it, we have to make sure that the
1736 -- entity declaration is in the same procedure as the
1737 -- reference, since if they are in separate procedures, then
1738 -- we have no idea about sequential execution.
1740 -- The tests in the loop below catch all such cases, but do
1741 -- allow the reference to appear in a loop, block, or
1742 -- package spec that is nested within the declaring scope.
1743 -- As always, it is possible to construct cases where the
1744 -- warning is wrong, that is why it is a warning!
1746 Potential_Unset_Reference : declare
1748 SE : constant Entity_Id := Scope (E);
1750 function Within_Postcondition return Boolean;
1751 -- Returns True iff N is within a Postcondition or
1752 -- Ensures component in a Test_Case.
1754 --------------------------
1755 -- Within_Postcondition --
1756 --------------------------
1758 function Within_Postcondition return Boolean is
1763 while Present (Nod) loop
1764 if Nkind (Nod) = N_Pragma
1765 and then Pragma_Name (Nod) = Name_Postcondition
1769 elsif Present (Parent (Nod)) then
1772 if Nkind (P) = N_Pragma
1773 and then Pragma_Name (P) = Name_Test_Case
1775 Nod = Get_Ensures_From_Test_Case_Pragma (P)
1781 Nod := Parent (Nod);
1785 end Within_Postcondition;
1787 -- Start of processing for Potential_Unset_Reference
1790 SR := Current_Scope;
1792 if SR = Standard_Standard
1793 or else Is_Subprogram (SR)
1794 or else Is_Concurrent_Body (SR)
1795 or else Is_Concurrent_Type (SR)
1803 -- Case of reference has an access type. This is a
1804 -- special case since access types are always set to null
1805 -- so cannot be truly uninitialized, but we still want to
1806 -- warn about cases of obvious null dereference.
1808 if Is_Access_Type (Typ) then
1809 Access_Type_Case : declare
1813 (N : Node_Id) return Traverse_Result;
1814 -- Process function for instantiation of Traverse
1815 -- below. Checks if N contains reference to E other
1816 -- than a dereference.
1818 function Ref_In (Nod : Node_Id) return Boolean;
1819 -- Determines whether Nod contains a reference to
1820 -- the entity E that is not a dereference.
1827 (N : Node_Id) return Traverse_Result
1830 if Is_Entity_Name (N)
1831 and then Entity (N) = E
1832 and then not Is_Dereferenced (N)
1844 function Ref_In (Nod : Node_Id) return Boolean is
1845 function Traverse is new Traverse_Func (Process);
1847 return Traverse (Nod) = Abandon;
1850 -- Start of processing for Access_Type_Case
1853 -- Don't bother if we are inside an instance, since
1854 -- the compilation of the generic template is where
1855 -- the warning should be issued.
1861 -- Don't bother if this is not the main unit. If we
1862 -- try to give this warning for with'ed units, we
1863 -- get some false positives, since we do not record
1864 -- references in other units.
1866 if not In_Extended_Main_Source_Unit (E)
1868 not In_Extended_Main_Source_Unit (N)
1873 -- We are only interested in dereferences
1875 if not Is_Dereferenced (N) then
1879 -- One more check, don't bother with references
1880 -- that are inside conditional statements or WHILE
1881 -- loops if the condition references the entity in
1882 -- question. This avoids most false positives.
1889 if (Nkind (P) = N_If_Statement
1891 Nkind (P) = N_Elsif_Part)
1892 and then Ref_In (Condition (P))
1896 elsif Nkind (P) = N_Loop_Statement
1897 and then Present (Iteration_Scheme (P))
1899 Ref_In (Condition (Iteration_Scheme (P)))
1904 end Access_Type_Case;
1907 -- One more check, don't bother if we are within a
1908 -- postcondition, since the expression occurs in a
1909 -- place unrelated to the actual test.
1911 if not Within_Postcondition then
1913 -- Here we definitely have a case for giving a warning
1914 -- for a reference to an unset value. But we don't
1915 -- give the warning now. Instead set Unset_Reference
1916 -- in the identifier involved. The reason for this is
1917 -- that if we find the variable is never ever assigned
1918 -- a value then that warning is more important and
1919 -- there is no point in giving the reference warning.
1921 -- If this is an identifier, set the field directly
1923 if Nkind (N) = N_Identifier then
1924 Set_Unset_Reference (E, N);
1926 -- Otherwise it is an expanded name, so set the field
1927 -- of the actual identifier for the reference.
1930 Set_Unset_Reference (E, Selector_Name (N));
1933 end Potential_Unset_Reference;
1937 -- Indexed component or slice
1939 when N_Indexed_Component | N_Slice =>
1941 -- If prefix does not involve dereferencing an access type, then
1942 -- we know we are OK if the component type is fully initialized,
1943 -- since the component will have been set as part of the default
1946 if not Prefix_Has_Dereference (Prefix (N))
1947 and then Is_OK_Fully_Initialized
1951 -- Look at prefix in access type case, or if the component is not
1952 -- fully initialized.
1955 Check_Unset_Reference (Prefix (N));
1960 when N_Selected_Component =>
1962 Pref : constant Node_Id := Prefix (N);
1963 Ent : constant Entity_Id := Entity (Selector_Name (N));
1966 -- If prefix involves dereferencing an access type, always
1967 -- check the prefix, since the issue then is whether this
1968 -- access value is null.
1970 if Prefix_Has_Dereference (Pref) then
1973 -- Always go to prefix if no selector entity is set. Can this
1974 -- happen in the normal case? Not clear, but it definitely can
1975 -- happen in error cases.
1980 -- For a record component, check some cases where we have
1981 -- reasonable cause to consider that the component is known to
1982 -- be or probably is initialized. In this case, we don't care
1983 -- if the prefix itself was explicitly initialized.
1985 -- Discriminants are always considered initialized
1987 elsif Ekind (Ent) = E_Discriminant then
1990 -- An explicitly initialized component is certainly initialized
1992 elsif Nkind (Parent (Ent)) = N_Component_Declaration
1993 and then Present (Expression (Parent (Ent)))
1997 -- A fully initialized component is initialized
1999 elsif Is_OK_Fully_Initialized then
2003 -- If none of those cases apply, check the record type prefix
2005 Check_Unset_Reference (Pref);
2008 -- For type conversions or qualifications examine the expression
2010 when N_Type_Conversion | N_Qualified_Expression =>
2011 Check_Unset_Reference (Expression (N));
2013 -- For explicit dereference, always check prefix, which will generate
2014 -- an unset reference (since this is a case of dereferencing null).
2016 when N_Explicit_Dereference =>
2017 Check_Unset_Reference (Prefix (N));
2019 -- All other cases are not cases of an unset reference
2025 end Check_Unset_Reference;
2027 ------------------------
2028 -- Check_Unused_Withs --
2029 ------------------------
2031 procedure Check_Unused_Withs (Spec_Unit : Unit_Number_Type := No_Unit) is
2037 Munite : constant Entity_Id := Cunit_Entity (Main_Unit);
2038 -- This is needed for checking the special renaming case
2040 procedure Check_One_Unit (Unit : Unit_Number_Type);
2041 -- Subsidiary procedure, performs checks for specified unit
2043 --------------------
2044 -- Check_One_Unit --
2045 --------------------
2047 procedure Check_One_Unit (Unit : Unit_Number_Type) is
2048 Is_Visible_Renaming : Boolean := False;
2051 procedure Check_Inner_Package (Pack : Entity_Id);
2052 -- Pack is a package local to a unit in a with_clause. Both the unit
2053 -- and Pack are referenced. If none of the entities in Pack are
2054 -- referenced, then the only occurrence of Pack is in a USE clause
2055 -- or a pragma, and a warning is worthwhile as well.
2057 function Check_System_Aux return Boolean;
2058 -- Before giving a warning on a with_clause for System, check whether
2059 -- a system extension is present.
2061 function Find_Package_Renaming
2063 L : Entity_Id) return Entity_Id;
2064 -- The only reference to a context unit may be in a renaming
2065 -- declaration. If this renaming declares a visible entity, do not
2066 -- warn that the context clause could be moved to the body, because
2067 -- the renaming may be intended to re-export the unit.
2069 function Has_Visible_Entities (P : Entity_Id) return Boolean;
2070 -- This function determines if a package has any visible entities.
2071 -- True is returned if there is at least one declared visible entity,
2072 -- otherwise False is returned (e.g. case of only pragmas present).
2074 -------------------------
2075 -- Check_Inner_Package --
2076 -------------------------
2078 procedure Check_Inner_Package (Pack : Entity_Id) is
2080 Un : constant Node_Id := Sinfo.Unit (Cnode);
2082 function Check_Use_Clause (N : Node_Id) return Traverse_Result;
2083 -- If N is a use_clause for Pack, emit warning
2085 procedure Check_Use_Clauses is new
2086 Traverse_Proc (Check_Use_Clause);
2088 ----------------------
2089 -- Check_Use_Clause --
2090 ----------------------
2092 function Check_Use_Clause (N : Node_Id) return Traverse_Result is
2096 if Nkind (N) = N_Use_Package_Clause then
2097 Nam := First (Names (N));
2098 while Present (Nam) loop
2099 if Entity (Nam) = Pack then
2100 Error_Msg_Qual_Level := 1;
2101 Error_Msg_NE -- CODEFIX
2102 ("?no entities of package& are referenced!",
2104 Error_Msg_Qual_Level := 0;
2112 end Check_Use_Clause;
2114 -- Start of processing for Check_Inner_Package
2117 E := First_Entity (Pack);
2118 while Present (E) loop
2119 if Referenced_Check_Spec (E) then
2126 -- No entities of the package are referenced. Check whether the
2127 -- reference to the package itself is a use clause, and if so
2128 -- place a warning on it.
2130 Check_Use_Clauses (Un);
2131 end Check_Inner_Package;
2133 ----------------------
2134 -- Check_System_Aux --
2135 ----------------------
2137 function Check_System_Aux return Boolean is
2141 if Chars (Lunit) = Name_System
2142 and then Scope (Lunit) = Standard_Standard
2143 and then Present_System_Aux
2145 Ent := First_Entity (System_Aux_Id);
2146 while Present (Ent) loop
2147 if Referenced_Check_Spec (Ent) then
2156 end Check_System_Aux;
2158 ---------------------------
2159 -- Find_Package_Renaming --
2160 ---------------------------
2162 function Find_Package_Renaming
2164 L : Entity_Id) return Entity_Id
2170 Is_Visible_Renaming := False;
2172 E1 := First_Entity (P);
2173 while Present (E1) loop
2174 if Ekind (E1) = E_Package
2175 and then Renamed_Object (E1) = L
2177 Is_Visible_Renaming := not Is_Hidden (E1);
2180 elsif Ekind (E1) = E_Package
2181 and then No (Renamed_Object (E1))
2182 and then not Is_Generic_Instance (E1)
2184 R := Find_Package_Renaming (E1, L);
2187 Is_Visible_Renaming := not Is_Hidden (R);
2196 end Find_Package_Renaming;
2198 --------------------------
2199 -- Has_Visible_Entities --
2200 --------------------------
2202 function Has_Visible_Entities (P : Entity_Id) return Boolean is
2206 -- If unit in context is not a package, it is a subprogram that
2207 -- is not called or a generic unit that is not instantiated
2208 -- in the current unit, and warning is appropriate.
2210 if Ekind (P) /= E_Package then
2214 -- If unit comes from a limited_with clause, look for declaration
2215 -- of shadow entities.
2217 if Present (Limited_View (P)) then
2218 E := First_Entity (Limited_View (P));
2220 E := First_Entity (P);
2224 and then E /= First_Private_Entity (P)
2226 if Comes_From_Source (E)
2227 or else Present (Limited_View (P))
2236 end Has_Visible_Entities;
2238 -- Start of processing for Check_One_Unit
2241 Cnode := Cunit (Unit);
2243 -- Only do check in units that are part of the extended main unit.
2244 -- This is actually a necessary restriction, because in the case of
2245 -- subprogram acting as its own specification, there can be with's in
2246 -- subunits that we will not see.
2248 if not In_Extended_Main_Source_Unit (Cnode) then
2251 -- In configurable run time mode, we remove the bodies of non-inlined
2252 -- subprograms, which may lead to spurious warnings, which are
2253 -- clearly undesirable.
2255 elsif Configurable_Run_Time_Mode
2256 and then Is_Predefined_File_Name (Unit_File_Name (Unit))
2261 -- Loop through context items in this unit
2263 Item := First (Context_Items (Cnode));
2264 while Present (Item) loop
2265 if Nkind (Item) = N_With_Clause
2266 and then not Implicit_With (Item)
2267 and then In_Extended_Main_Source_Unit (Item)
2269 Lunit := Entity (Name (Item));
2271 -- Check if this unit is referenced (skip the check if this
2272 -- is explicitly marked by a pragma Unreferenced).
2274 if not Referenced (Lunit)
2275 and then not Has_Unreferenced (Lunit)
2277 -- Suppress warnings in internal units if not in -gnatg mode
2278 -- (these would be junk warnings for an application program,
2279 -- since they refer to problems in internal units).
2282 or else not Is_Internal_File_Name (Unit_File_Name (Unit))
2284 -- Here we definitely have a non-referenced unit. If it
2285 -- is the special call for a spec unit, then just set the
2286 -- flag to be read later.
2288 if Unit = Spec_Unit then
2289 Set_Unreferenced_In_Spec (Item);
2291 -- Otherwise simple unreferenced message, but skip this
2292 -- if no visible entities, because that is most likely a
2293 -- case where warning would be false positive (e.g. a
2294 -- package with only a linker options pragma and nothing
2295 -- else or a pragma elaborate with a body library task).
2297 elsif Has_Visible_Entities (Entity (Name (Item))) then
2298 Error_Msg_N -- CODEFIX
2299 ("?unit& is not referenced!", Name (Item));
2303 -- If main unit is a renaming of this unit, then we consider
2304 -- the with to be OK (obviously it is needed in this case!)
2305 -- This may be transitive: the unit in the with_clause may
2306 -- itself be a renaming, in which case both it and the main
2307 -- unit rename the same ultimate package.
2309 elsif Present (Renamed_Entity (Munite))
2311 (Renamed_Entity (Munite) = Lunit
2312 or else Renamed_Entity (Munite) = Renamed_Entity (Lunit))
2316 -- If this unit is referenced, and it is a package, we do
2317 -- another test, to see if any of the entities in the package
2318 -- are referenced. If none of the entities are referenced, we
2319 -- still post a warning. This occurs if the only use of the
2320 -- package is in a use clause, or in a package renaming
2321 -- declaration. This check is skipped for packages that are
2322 -- renamed in a spec, since the entities in such a package are
2323 -- visible to clients via the renaming.
2325 elsif Ekind (Lunit) = E_Package
2326 and then not Renamed_In_Spec (Lunit)
2328 -- If Is_Instantiated is set, it means that the package is
2329 -- implicitly instantiated (this is the case of parent
2330 -- instance or an actual for a generic package formal), and
2331 -- this counts as a reference.
2333 if Is_Instantiated (Lunit) then
2336 -- If no entities in package, and there is a pragma
2337 -- Elaborate_Body present, then assume that this with is
2338 -- done for purposes of this elaboration.
2340 elsif No (First_Entity (Lunit))
2341 and then Has_Pragma_Elaborate_Body (Lunit)
2345 -- Otherwise see if any entities have been referenced
2348 if Limited_Present (Item) then
2349 Ent := First_Entity (Limited_View (Lunit));
2351 Ent := First_Entity (Lunit);
2355 -- No more entities, and we did not find one that was
2356 -- referenced. Means we have a definite case of a with
2357 -- none of whose entities was referenced.
2361 -- If in spec, just set the flag
2363 if Unit = Spec_Unit then
2364 Set_No_Entities_Ref_In_Spec (Item);
2366 elsif Check_System_Aux then
2369 -- Else give the warning
2373 Has_Unreferenced (Entity (Name (Item)))
2375 Error_Msg_N -- CODEFIX
2376 ("?no entities of & are referenced!",
2380 -- Look for renamings of this package, and flag
2381 -- them as well. If the original package has
2382 -- warnings off, we suppress the warning on the
2383 -- renaming as well.
2385 Pack := Find_Package_Renaming (Munite, Lunit);
2388 and then not Has_Warnings_Off (Lunit)
2389 and then not Has_Unreferenced (Pack)
2391 Error_Msg_NE -- CODEFIX
2392 ("?no entities of & are referenced!",
2393 Unit_Declaration_Node (Pack),
2400 -- Case of entity being referenced. The reference may
2401 -- come from a limited_with_clause, in which case the
2402 -- limited view of the entity carries the flag.
2404 elsif Referenced_Check_Spec (Ent)
2405 or else Referenced_As_LHS_Check_Spec (Ent)
2406 or else Referenced_As_Out_Parameter_Check_Spec (Ent)
2408 (From_With_Type (Ent)
2409 and then Is_Incomplete_Type (Ent)
2410 and then Present (Non_Limited_View (Ent))
2411 and then Referenced (Non_Limited_View (Ent)))
2413 -- This means that the with is indeed fine, in that
2414 -- it is definitely needed somewhere, and we can
2415 -- quit worrying about this one...
2417 -- Except for one little detail: if either of the
2418 -- flags was set during spec processing, this is
2419 -- where we complain that the with could be moved
2420 -- from the spec. If the spec contains a visible
2421 -- renaming of the package, inhibit warning to move
2422 -- with_clause to body.
2424 if Ekind (Munite) = E_Package_Body then
2426 Find_Package_Renaming
2427 (Spec_Entity (Munite), Lunit);
2432 -- If a renaming is present in the spec do not warn
2433 -- because the body or child unit may depend on it.
2436 and then Renamed_Entity (Pack) = Lunit
2440 elsif Unreferenced_In_Spec (Item) then
2441 Error_Msg_N -- CODEFIX
2442 ("?unit& is not referenced in spec!",
2445 elsif No_Entities_Ref_In_Spec (Item) then
2446 Error_Msg_N -- CODEFIX
2447 ("?no entities of & are referenced in spec!",
2451 if Ekind (Ent) = E_Package then
2452 Check_Inner_Package (Ent);
2458 if not Is_Visible_Renaming then
2459 Error_Msg_N -- CODEFIX
2460 ("\?with clause might be moved to body!",
2466 -- Move to next entity to continue search
2474 -- For a generic package, the only interesting kind of
2475 -- reference is an instantiation, since entities cannot be
2476 -- referenced directly.
2478 elsif Is_Generic_Unit (Lunit) then
2480 -- Unit was never instantiated, set flag for case of spec
2481 -- call, or give warning for normal call.
2483 if not Is_Instantiated (Lunit) then
2484 if Unit = Spec_Unit then
2485 Set_Unreferenced_In_Spec (Item);
2487 Error_Msg_N -- CODEFIX
2488 ("?unit& is never instantiated!", Name (Item));
2491 -- If unit was indeed instantiated, make sure that flag is
2492 -- not set showing it was uninstantiated in the spec, and if
2493 -- so, give warning.
2495 elsif Unreferenced_In_Spec (Item) then
2497 ("?unit& is not instantiated in spec!", Name (Item));
2498 Error_Msg_N -- CODEFIX
2499 ("\?with clause can be moved to body!", Name (Item));
2508 -- Start of processing for Check_Unused_Withs
2511 if not Opt.Check_Withs
2512 or else Operating_Mode = Check_Syntax
2517 -- Flag any unused with clauses, but skip this step if we are compiling
2518 -- a subunit on its own, since we do not have enough information to
2519 -- determine whether with's are used. We will get the relevant warnings
2520 -- when we compile the parent. This is the normal style of GNAT
2521 -- compilation in any case.
2523 if Nkind (Unit (Cunit (Main_Unit))) = N_Subunit then
2527 -- Process specified units
2529 if Spec_Unit = No_Unit then
2531 -- For main call, check all units
2533 for Unit in Main_Unit .. Last_Unit loop
2534 Check_One_Unit (Unit);
2538 -- For call for spec, check only the spec
2540 Check_One_Unit (Spec_Unit);
2542 end Check_Unused_Withs;
2544 ---------------------------------
2545 -- Generic_Package_Spec_Entity --
2546 ---------------------------------
2548 function Generic_Package_Spec_Entity (E : Entity_Id) return Boolean is
2552 if Is_Package_Body_Entity (E) then
2558 if S = Standard_Standard then
2561 elsif Ekind (S) = E_Generic_Package then
2564 elsif Ekind (S) = E_Package then
2572 end Generic_Package_Spec_Entity;
2574 ----------------------
2575 -- Goto_Spec_Entity --
2576 ----------------------
2578 function Goto_Spec_Entity (E : Entity_Id) return Entity_Id is
2581 and then Present (Spec_Entity (E))
2583 return Spec_Entity (E);
2587 end Goto_Spec_Entity;
2589 --------------------------------------
2590 -- Has_Pragma_Unmodified_Check_Spec --
2591 --------------------------------------
2593 function Has_Pragma_Unmodified_Check_Spec
2594 (E : Entity_Id) return Boolean
2597 if Is_Formal (E) and then Present (Spec_Entity (E)) then
2599 -- Note: use of OR instead of OR ELSE here is deliberate, we want
2600 -- to mess with Unmodified flags on both body and spec entities.
2602 return Has_Unmodified (E)
2604 Has_Unmodified (Spec_Entity (E));
2607 return Has_Unmodified (E);
2609 end Has_Pragma_Unmodified_Check_Spec;
2611 ----------------------------------------
2612 -- Has_Pragma_Unreferenced_Check_Spec --
2613 ----------------------------------------
2615 function Has_Pragma_Unreferenced_Check_Spec
2616 (E : Entity_Id) return Boolean
2619 if Is_Formal (E) and then Present (Spec_Entity (E)) then
2621 -- Note: use of OR here instead of OR ELSE is deliberate, we want
2622 -- to mess with flags on both entities.
2624 return Has_Unreferenced (E)
2626 Has_Unreferenced (Spec_Entity (E));
2629 return Has_Unreferenced (E);
2631 end Has_Pragma_Unreferenced_Check_Spec;
2637 procedure Initialize is
2639 Warnings_Off_Pragmas.Init;
2640 Unreferenced_Entities.Init;
2641 In_Out_Warnings.Init;
2644 ------------------------------------
2645 -- Never_Set_In_Source_Check_Spec --
2646 ------------------------------------
2648 function Never_Set_In_Source_Check_Spec (E : Entity_Id) return Boolean is
2650 if Is_Formal (E) and then Present (Spec_Entity (E)) then
2651 return Never_Set_In_Source (E)
2653 Never_Set_In_Source (Spec_Entity (E));
2655 return Never_Set_In_Source (E);
2657 end Never_Set_In_Source_Check_Spec;
2659 -------------------------------------
2660 -- Operand_Has_Warnings_Suppressed --
2661 -------------------------------------
2663 function Operand_Has_Warnings_Suppressed (N : Node_Id) return Boolean is
2665 function Check_For_Warnings (N : Node_Id) return Traverse_Result;
2666 -- Function used to check one node to see if it is or was originally
2667 -- a reference to an entity for which Warnings are off. If so, Abandon
2668 -- is returned, otherwise OK_Orig is returned to continue the traversal
2669 -- of the original expression.
2671 function Traverse is new Traverse_Func (Check_For_Warnings);
2672 -- Function used to traverse tree looking for warnings
2674 ------------------------
2675 -- Check_For_Warnings --
2676 ------------------------
2678 function Check_For_Warnings (N : Node_Id) return Traverse_Result is
2679 R : constant Node_Id := Original_Node (N);
2682 if Nkind (R) in N_Has_Entity
2683 and then Present (Entity (R))
2684 and then Has_Warnings_Off (Entity (R))
2690 end Check_For_Warnings;
2692 -- Start of processing for Operand_Has_Warnings_Suppressed
2695 return Traverse (N) = Abandon;
2697 -- If any exception occurs, then something has gone wrong, and this is
2698 -- only a minor aesthetic issue anyway, so just say we did not find what
2699 -- we are looking for, rather than blow up.
2704 end Operand_Has_Warnings_Suppressed;
2706 -----------------------------------------
2707 -- Output_Non_Modified_In_Out_Warnings --
2708 -----------------------------------------
2710 procedure Output_Non_Modified_In_Out_Warnings is
2712 function No_Warn_On_In_Out (E : Entity_Id) return Boolean;
2713 -- Given a formal parameter entity E, determines if there is a reason to
2714 -- suppress IN OUT warnings (not modified, could be IN) for formals of
2715 -- the subprogram. We suppress these warnings if Warnings Off is set, or
2716 -- if we have seen the address of the subprogram being taken, or if the
2717 -- subprogram is used as a generic actual (in the latter cases the
2718 -- context may force use of IN OUT, even if the parameter is not
2719 -- modifies for this particular case.
2721 -----------------------
2722 -- No_Warn_On_In_Out --
2723 -----------------------
2725 function No_Warn_On_In_Out (E : Entity_Id) return Boolean is
2726 S : constant Entity_Id := Scope (E);
2727 SE : constant Entity_Id := Spec_Entity (E);
2730 -- Do not warn if address is taken, since funny business may be going
2731 -- on in treating the parameter indirectly as IN OUT.
2733 if Address_Taken (S)
2734 or else (Present (SE) and then Address_Taken (Scope (SE)))
2738 -- Do not warn if used as a generic actual, since the generic may be
2739 -- what is forcing the use of an "unnecessary" IN OUT.
2741 elsif Used_As_Generic_Actual (S)
2742 or else (Present (SE) and then Used_As_Generic_Actual (Scope (SE)))
2746 -- Else test warnings off
2748 elsif Warnings_Off_Check_Spec (S) then
2751 -- All tests for suppressing warning failed
2756 end No_Warn_On_In_Out;
2758 -- Start of processing for Output_Non_Modified_In_Out_Warnings
2761 -- Loop through entities for which a warning may be needed
2763 for J in In_Out_Warnings.First .. In_Out_Warnings.Last loop
2765 E1 : constant Entity_Id := In_Out_Warnings.Table (J);
2768 -- Suppress warning in specific cases (see details in comments for
2769 -- No_Warn_On_In_Out), or if there is a pragma Unmodified.
2771 if Has_Pragma_Unmodified_Check_Spec (E1)
2772 or else No_Warn_On_In_Out (E1)
2776 -- Here we generate the warning
2779 -- If -gnatwc is set then output message that we could be IN
2781 if not Is_Trivial_Subprogram (Scope (E1)) then
2782 if Warn_On_Constant then
2784 ("?formal parameter & is not modified!", E1);
2786 ("\?mode could be IN instead of `IN OUT`!", E1);
2788 -- We do not generate warnings for IN OUT parameters
2789 -- unless we have at least -gnatwu. This is deliberately
2790 -- inconsistent with the treatment of variables, but
2791 -- otherwise we get too many unexpected warnings in
2794 elsif Check_Unreferenced then
2796 ("?formal parameter& is read but "
2797 & "never assigned!", E1);
2801 -- Kill any other warnings on this entity, since this is the
2802 -- one that should dominate any other unreferenced warning.
2804 Set_Warnings_Off (E1);
2808 end Output_Non_Modified_In_Out_Warnings;
2810 ----------------------------------------
2811 -- Output_Obsolescent_Entity_Warnings --
2812 ----------------------------------------
2814 procedure Output_Obsolescent_Entity_Warnings (N : Node_Id; E : Entity_Id) is
2815 P : constant Node_Id := Parent (N);
2821 -- Do not output message if we are the scope of standard. This means
2822 -- we have a reference from a context clause from when it is originally
2823 -- processed, and that's too early to tell whether it is an obsolescent
2824 -- unit doing the with'ing. In Sem_Ch10.Analyze_Compilation_Unit we make
2825 -- sure that we have a later call when the scope is available. This test
2826 -- also eliminates all messages for use clauses, which is fine (we do
2827 -- not want messages for use clauses, since they are always redundant
2828 -- with respect to the associated with clause).
2830 if S = Standard_Standard then
2834 -- Do not output message if we are in scope of an obsolescent package
2838 if Is_Obsolescent (S) then
2843 exit when S = Standard_Standard;
2846 -- Here we will output the message
2848 Error_Msg_Sloc := Sloc (E);
2850 -- Case of with clause
2852 if Nkind (P) = N_With_Clause then
2853 if Ekind (E) = E_Package then
2855 ("?with of obsolescent package& declared#", N, E);
2856 elsif Ekind (E) = E_Procedure then
2858 ("?with of obsolescent procedure& declared#", N, E);
2861 ("?with of obsolescent function& declared#", N, E);
2864 -- If we do not have a with clause, then ignore any reference to an
2865 -- obsolescent package name. We only want to give the one warning of
2866 -- withing the package, not one each time it is used to qualify.
2868 elsif Ekind (E) = E_Package then
2871 -- Procedure call statement
2873 elsif Nkind (P) = N_Procedure_Call_Statement then
2875 ("?call to obsolescent procedure& declared#", N, E);
2879 elsif Nkind (P) = N_Function_Call then
2881 ("?call to obsolescent function& declared#", N, E);
2883 -- Reference to obsolescent type
2885 elsif Is_Type (E) then
2887 ("?reference to obsolescent type& declared#", N, E);
2889 -- Reference to obsolescent component
2891 elsif Ekind_In (E, E_Component, E_Discriminant) then
2893 ("?reference to obsolescent component& declared#", N, E);
2895 -- Reference to obsolescent variable
2897 elsif Ekind (E) = E_Variable then
2899 ("?reference to obsolescent variable& declared#", N, E);
2901 -- Reference to obsolescent constant
2903 elsif Ekind (E) = E_Constant
2904 or else Ekind (E) in Named_Kind
2907 ("?reference to obsolescent constant& declared#", N, E);
2909 -- Reference to obsolescent enumeration literal
2911 elsif Ekind (E) = E_Enumeration_Literal then
2913 ("?reference to obsolescent enumeration literal& declared#", N, E);
2915 -- Generic message for any other case we missed
2919 ("?reference to obsolescent entity& declared#", N, E);
2922 -- Output additional warning if present
2924 for J in Obsolescent_Warnings.First .. Obsolescent_Warnings.Last loop
2925 if Obsolescent_Warnings.Table (J).Ent = E then
2926 String_To_Name_Buffer (Obsolescent_Warnings.Table (J).Msg);
2927 Error_Msg_Strlen := Name_Len;
2928 Error_Msg_String (1 .. Name_Len) := Name_Buffer (1 .. Name_Len);
2929 Error_Msg_N ("\\?~", N);
2933 end Output_Obsolescent_Entity_Warnings;
2935 ----------------------------------
2936 -- Output_Unreferenced_Messages --
2937 ----------------------------------
2939 procedure Output_Unreferenced_Messages is
2941 for J in Unreferenced_Entities.First ..
2942 Unreferenced_Entities.Last
2944 Warn_On_Unreferenced_Entity (Unreferenced_Entities.Table (J));
2946 end Output_Unreferenced_Messages;
2948 -----------------------------------------
2949 -- Output_Unused_Warnings_Off_Warnings --
2950 -----------------------------------------
2952 procedure Output_Unused_Warnings_Off_Warnings is
2954 for J in Warnings_Off_Pragmas.First .. Warnings_Off_Pragmas.Last loop
2956 Wentry : Warnings_Off_Entry renames Warnings_Off_Pragmas.Table (J);
2957 N : Node_Id renames Wentry.N;
2958 E : Node_Id renames Wentry.E;
2961 -- Turn off Warnings_Off, or we won't get the warning!
2963 Set_Warnings_Off (E, False);
2965 -- Nothing to do if pragma was used to suppress a general warning
2967 if Warnings_Off_Used (E) then
2970 -- If pragma was used both in unmodified and unreferenced contexts
2971 -- then that's as good as the general case, no warning.
2973 elsif Warnings_Off_Used_Unmodified (E)
2975 Warnings_Off_Used_Unreferenced (E)
2979 -- Used only in context where Unmodified would have worked
2981 elsif Warnings_Off_Used_Unmodified (E) then
2983 ("?could use Unmodified instead of "
2984 & "Warnings Off for &", Pragma_Identifier (N), E);
2986 -- Used only in context where Unreferenced would have worked
2988 elsif Warnings_Off_Used_Unreferenced (E) then
2990 ("?could use Unreferenced instead of "
2991 & "Warnings Off for &", Pragma_Identifier (N), E);
2997 ("?pragma Warnings Off for & unused, "
2998 & "could be omitted", N, E);
3002 end Output_Unused_Warnings_Off_Warnings;
3004 ---------------------------
3005 -- Referenced_Check_Spec --
3006 ---------------------------
3008 function Referenced_Check_Spec (E : Entity_Id) return Boolean is
3010 if Is_Formal (E) and then Present (Spec_Entity (E)) then
3011 return Referenced (E) or else Referenced (Spec_Entity (E));
3013 return Referenced (E);
3015 end Referenced_Check_Spec;
3017 ----------------------------------
3018 -- Referenced_As_LHS_Check_Spec --
3019 ----------------------------------
3021 function Referenced_As_LHS_Check_Spec (E : Entity_Id) return Boolean is
3023 if Is_Formal (E) and then Present (Spec_Entity (E)) then
3024 return Referenced_As_LHS (E)
3025 or else Referenced_As_LHS (Spec_Entity (E));
3027 return Referenced_As_LHS (E);
3029 end Referenced_As_LHS_Check_Spec;
3031 --------------------------------------------
3032 -- Referenced_As_Out_Parameter_Check_Spec --
3033 --------------------------------------------
3035 function Referenced_As_Out_Parameter_Check_Spec
3036 (E : Entity_Id) return Boolean
3039 if Is_Formal (E) and then Present (Spec_Entity (E)) then
3040 return Referenced_As_Out_Parameter (E)
3041 or else Referenced_As_Out_Parameter (Spec_Entity (E));
3043 return Referenced_As_Out_Parameter (E);
3045 end Referenced_As_Out_Parameter_Check_Spec;
3047 -----------------------------
3048 -- Warn_On_Known_Condition --
3049 -----------------------------
3051 procedure Warn_On_Known_Condition (C : Node_Id) is
3053 Orig : constant Node_Id := Original_Node (C);
3054 Test_Result : Boolean;
3056 function Is_Known_Branch return Boolean;
3057 -- If the type of the condition is Boolean, the constant value of the
3058 -- condition is a boolean literal. If the type is a derived boolean
3059 -- type, the constant is wrapped in a type conversion of the derived
3060 -- literal. If the value of the condition is not a literal, no warnings
3061 -- can be produced. This function returns True if the result can be
3062 -- determined, and Test_Result is set True/False accordingly. Otherwise
3063 -- False is returned, and Test_Result is unchanged.
3065 procedure Track (N : Node_Id; Loc : Node_Id);
3066 -- Adds continuation warning(s) pointing to reason (assignment or test)
3067 -- for the operand of the conditional having a known value (or at least
3068 -- enough is known about the value to issue the warning). N is the node
3069 -- which is judged to have a known value. Loc is the warning location.
3071 ---------------------
3072 -- Is_Known_Branch --
3073 ---------------------
3075 function Is_Known_Branch return Boolean is
3077 if Etype (C) = Standard_Boolean
3078 and then Is_Entity_Name (C)
3080 (Entity (C) = Standard_False or else Entity (C) = Standard_True)
3082 Test_Result := Entity (C) = Standard_True;
3085 elsif Is_Boolean_Type (Etype (C))
3086 and then Nkind (C) = N_Unchecked_Type_Conversion
3087 and then Is_Entity_Name (Expression (C))
3088 and then Ekind (Entity (Expression (C))) = E_Enumeration_Literal
3091 Chars (Entity (Expression (C))) = Chars (Standard_True);
3097 end Is_Known_Branch;
3103 procedure Track (N : Node_Id; Loc : Node_Id) is
3104 Nod : constant Node_Id := Original_Node (N);
3107 if Nkind (Nod) in N_Op_Compare then
3108 Track (Left_Opnd (Nod), Loc);
3109 Track (Right_Opnd (Nod), Loc);
3111 elsif Is_Entity_Name (Nod)
3112 and then Is_Object (Entity (Nod))
3115 CV : constant Node_Id := Current_Value (Entity (Nod));
3118 if Present (CV) then
3119 Error_Msg_Sloc := Sloc (CV);
3121 if Nkind (CV) not in N_Subexpr then
3122 Error_Msg_N ("\\?(see test #)", Loc);
3124 elsif Nkind (Parent (CV)) =
3125 N_Case_Statement_Alternative
3127 Error_Msg_N ("\\?(see case alternative #)", Loc);
3130 Error_Msg_N ("\\?(see assignment #)", Loc);
3137 -- Start of processing for Warn_On_Known_Condition
3140 -- Adjust SCO condition if from source
3143 and then Comes_From_Source (Orig)
3144 and then Is_Known_Branch
3150 Atrue := Test_Result;
3152 if Present (Parent (C)) and then Nkind (Parent (C)) = N_Op_Not then
3156 Set_SCO_Condition (Orig, Atrue);
3160 -- Argument replacement in an inlined body can make conditions static.
3161 -- Do not emit warnings in this case.
3163 if In_Inlined_Body then
3167 if Constant_Condition_Warnings
3168 and then Is_Known_Branch
3169 and then Comes_From_Source (Original_Node (C))
3170 and then not In_Instance
3172 -- See if this is in a statement or a declaration
3176 -- If tree is not attached, do not issue warning (this is very
3177 -- peculiar, and probably arises from some other error condition)
3182 -- If we are in a declaration, then no warning, since in practice
3183 -- conditionals in declarations are used for intended tests which
3184 -- may be known at compile time, e.g. things like
3186 -- x : constant Integer := 2 + (Word'Size = 32);
3188 -- And a warning is annoying in such cases
3190 elsif Nkind (P) in N_Declaration
3192 Nkind (P) in N_Later_Decl_Item
3196 -- Don't warn in assert or check pragma, since presumably tests in
3197 -- such a context are very definitely intended, and might well be
3198 -- known at compile time. Note that we have to test the original
3199 -- node, since assert pragmas get rewritten at analysis time.
3201 elsif Nkind (Original_Node (P)) = N_Pragma
3202 and then (Pragma_Name (Original_Node (P)) = Name_Assert
3204 Pragma_Name (Original_Node (P)) = Name_Check)
3209 exit when Is_Statement (P);
3213 -- Here we issue the warning unless some sub-operand has warnings
3214 -- set off, in which case we suppress the warning for the node. If
3215 -- the original expression is an inequality, it has been expanded
3216 -- into a negation, and the value of the original expression is the
3217 -- negation of the equality. If the expression is an entity that
3218 -- appears within a negation, it is clearer to flag the negation
3219 -- itself, and report on its constant value.
3221 if not Operand_Has_Warnings_Suppressed (C) then
3223 True_Branch : Boolean := Test_Result;
3224 Cond : Node_Id := C;
3227 if Present (Parent (C))
3228 and then Nkind (Parent (C)) = N_Op_Not
3230 True_Branch := not True_Branch;
3235 if Is_Entity_Name (Original_Node (C))
3236 and then Nkind (Cond) /= N_Op_Not
3239 ("object & is always True?", Cond, Original_Node (C));
3240 Track (Original_Node (C), Cond);
3243 Error_Msg_N ("condition is always True?", Cond);
3248 Error_Msg_N ("condition is always False?", Cond);
3254 end Warn_On_Known_Condition;
3256 ---------------------------------------
3257 -- Warn_On_Modified_As_Out_Parameter --
3258 ---------------------------------------
3260 function Warn_On_Modified_As_Out_Parameter (E : Entity_Id) return Boolean is
3263 (Warn_On_Modified_Unread and then Is_Only_Out_Parameter (E))
3264 or else Warn_On_All_Unread_Out_Parameters;
3265 end Warn_On_Modified_As_Out_Parameter;
3267 ---------------------------------
3268 -- Warn_On_Overlapping_Actuals --
3269 ---------------------------------
3271 procedure Warn_On_Overlapping_Actuals (Subp : Entity_Id; N : Node_Id) is
3272 Act1, Act2 : Node_Id;
3273 Form1, Form2 : Entity_Id;
3276 if not Warn_On_Overlap then
3280 -- Exclude calls rewritten as enumeration literals
3282 if not Nkind_In (N, N_Function_Call, N_Procedure_Call_Statement) then
3286 -- Exclude calls to library subprograms. Container operations specify
3287 -- safe behavior when source and target coincide.
3289 if Is_Predefined_File_Name
3290 (Unit_File_Name (Get_Source_Unit (Sloc (Subp))))
3295 Form1 := First_Formal (Subp);
3296 Act1 := First_Actual (N);
3297 while Present (Form1) and then Present (Act1) loop
3298 if Ekind (Form1) /= E_In_Parameter then
3299 Form2 := First_Formal (Subp);
3300 Act2 := First_Actual (N);
3301 while Present (Form2) and then Present (Act2) loop
3303 and then Ekind (Form2) /= E_Out_Parameter
3305 (Denotes_Same_Object (Act1, Act2)
3307 Denotes_Same_Prefix (Act1, Act2))
3309 -- Exclude generic types and guard against previous errors.
3312 or else No (Etype (Act1))
3313 or else No (Etype (Act2))
3317 elsif Is_Generic_Type (Etype (Act1))
3319 Is_Generic_Type (Etype (Act2))
3323 -- If the actual is a function call in prefix notation,
3324 -- there is no real overlap.
3326 elsif Nkind (Act2) = N_Function_Call then
3329 -- If type is not by-copy we can assume that the aliasing is
3333 Is_By_Reference_Type (Underlying_Type (Etype (Form1)))
3343 -- Find matching actual
3345 Act := First_Actual (N);
3346 Form := First_Formal (Subp);
3347 while Act /= Act2 loop
3352 if Is_Elementary_Type (Etype (Act1))
3353 and then Ekind (Form2) = E_In_Parameter
3355 null; -- No real aliasing
3357 elsif Is_Elementary_Type (Etype (Act2))
3358 and then Ekind (Form2) = E_In_Parameter
3362 -- If the call was written in prefix notation, and
3363 -- thus its prefix before rewriting was a selected
3364 -- component, count only visible actuals in the call.
3366 elsif Is_Entity_Name (First_Actual (N))
3367 and then Nkind (Original_Node (N)) = Nkind (N)
3368 and then Nkind (Name (Original_Node (N))) =
3369 N_Selected_Component
3371 Is_Entity_Name (Prefix (Name (Original_Node (N))))
3373 Entity (Prefix (Name (Original_Node (N)))) =
3374 Entity (First_Actual (N))
3376 if Act1 = First_Actual (N) then
3378 ("`IN OUT` prefix overlaps with actual for&?",
3382 -- For greater clarity, give name of formal.
3384 Error_Msg_Node_2 := Form;
3386 ("writable actual for & overlaps with"
3387 & " actual for&?", Act1, Form);
3391 Error_Msg_Node_2 := Form;
3393 ("writable actual for & overlaps with"
3394 & " actual for&?", Act1, Form1);
3402 Next_Formal (Form2);
3407 Next_Formal (Form1);
3410 end Warn_On_Overlapping_Actuals;
3412 ------------------------------
3413 -- Warn_On_Suspicious_Index --
3414 ------------------------------
3416 procedure Warn_On_Suspicious_Index (Name : Entity_Id; X : Node_Id) is
3419 -- Set to lower bound for a suspicious type
3422 -- Entity for array reference
3427 function Is_Suspicious_Type (Typ : Entity_Id) return Boolean;
3428 -- Tests to see if Typ is a type for which we may have a suspicious
3429 -- index, namely an unconstrained array type, whose lower bound is
3430 -- either zero or one. If so, True is returned, and Low_Bound is set
3431 -- to this lower bound. If not, False is returned, and Low_Bound is
3432 -- undefined on return.
3434 -- For now, we limit this to standard string types, so any other
3435 -- unconstrained types return False. We may change our minds on this
3436 -- later on, but strings seem the most important case.
3438 procedure Test_Suspicious_Index;
3439 -- Test if index is of suspicious type and if so, generate warning
3441 ------------------------
3442 -- Is_Suspicious_Type --
3443 ------------------------
3445 function Is_Suspicious_Type (Typ : Entity_Id) return Boolean is
3449 if Is_Array_Type (Typ)
3450 and then not Is_Constrained (Typ)
3451 and then Number_Dimensions (Typ) = 1
3452 and then (Root_Type (Typ) = Standard_String
3454 Root_Type (Typ) = Standard_Wide_String
3456 Root_Type (Typ) = Standard_Wide_Wide_String)
3457 and then not Has_Warnings_Off (Typ)
3459 LB := Type_Low_Bound (Etype (First_Index (Typ)));
3461 if Compile_Time_Known_Value (LB) then
3462 Low_Bound := Expr_Value (LB);
3463 return Low_Bound = Uint_0 or else Low_Bound = Uint_1;
3468 end Is_Suspicious_Type;
3470 ---------------------------
3471 -- Test_Suspicious_Index --
3472 ---------------------------
3474 procedure Test_Suspicious_Index is
3476 function Length_Reference (N : Node_Id) return Boolean;
3477 -- Check if node N is of the form Name'Length
3480 -- Generate first warning line
3482 ----------------------
3483 -- Length_Reference --
3484 ----------------------
3486 function Length_Reference (N : Node_Id) return Boolean is
3487 R : constant Node_Id := Original_Node (N);
3490 Nkind (R) = N_Attribute_Reference
3491 and then Attribute_Name (R) = Name_Length
3492 and then Is_Entity_Name (Prefix (R))
3493 and then Entity (Prefix (R)) = Ent;
3494 end Length_Reference;
3502 Error_Msg_Uint_1 := Low_Bound;
3503 Error_Msg_FE -- CODEFIX
3504 ("?index for& may assume lower bound of^", X, Ent);
3507 -- Start of processing for Test_Suspicious_Index
3510 -- Nothing to do if subscript does not come from source (we don't
3511 -- want to give garbage warnings on compiler expanded code, e.g. the
3512 -- loops generated for slice assignments. Such junk warnings would
3513 -- be placed on source constructs with no subscript in sight!)
3515 if not Comes_From_Source (Original_Node (X)) then
3519 -- Case where subscript is a constant integer
3521 if Nkind (X) = N_Integer_Literal then
3524 -- Case where original form of subscript is an integer literal
3526 if Nkind (Original_Node (X)) = N_Integer_Literal then
3527 if Intval (X) = Low_Bound then
3528 Error_Msg_FE -- CODEFIX
3529 ("\suggested replacement: `&''First`", X, Ent);
3531 Error_Msg_Uint_1 := Intval (X) - Low_Bound;
3532 Error_Msg_FE -- CODEFIX
3533 ("\suggested replacement: `&''First + ^`", X, Ent);
3537 -- Case where original form of subscript is more complex
3540 -- Build string X'First - 1 + expression where the expression
3541 -- is the original subscript. If the expression starts with "1
3542 -- + ", then the "- 1 + 1" is elided.
3544 Error_Msg_String (1 .. 13) := "'First - 1 + ";
3545 Error_Msg_Strlen := 13;
3548 Sref : Source_Ptr := Sloc (First_Node (Original_Node (X)));
3549 Tref : constant Source_Buffer_Ptr :=
3550 Source_Text (Get_Source_File_Index (Sref));
3551 -- Tref (Sref) is used to scan the subscript
3554 -- Parentheses counter when scanning subscript
3557 -- Tref (Sref) points to start of subscript
3559 -- Elide - 1 if subscript starts with 1 +
3561 if Tref (Sref .. Sref + 2) = "1 +" then
3562 Error_Msg_Strlen := Error_Msg_Strlen - 6;
3565 elsif Tref (Sref .. Sref + 1) = "1+" then
3566 Error_Msg_Strlen := Error_Msg_Strlen - 6;
3570 -- Now we will copy the subscript to the string buffer
3574 -- Count parens, exit if terminating right paren. Note
3575 -- check to ignore paren appearing as character literal.
3577 if Tref (Sref + 1) = '''
3579 Tref (Sref - 1) = '''
3583 if Tref (Sref) = '(' then
3585 elsif Tref (Sref) = ')' then
3591 -- Done if terminating double dot (slice case)
3594 and then (Tref (Sref .. Sref + 1) = ".."
3596 Tref (Sref .. Sref + 2) = " ..");
3598 -- Quit if we have hit EOF character, something wrong
3600 if Tref (Sref) = EOF then
3604 -- String literals are too much of a pain to handle
3606 if Tref (Sref) = '"' or else Tref (Sref) = '%' then
3610 -- If we have a 'Range reference, then this is a case
3611 -- where we cannot easily give a replacement. Don't try!
3613 if Tref (Sref .. Sref + 4) = "range"
3614 and then Tref (Sref - 1) < 'A'
3615 and then Tref (Sref + 5) < 'A'
3620 -- Else store next character
3622 Error_Msg_Strlen := Error_Msg_Strlen + 1;
3623 Error_Msg_String (Error_Msg_Strlen) := Tref (Sref);
3626 -- If we get more than 40 characters then the expression
3627 -- is too long to copy, or something has gone wrong. In
3628 -- either case, just skip the attempt at a suggested fix.
3630 if Error_Msg_Strlen > 40 then
3636 -- Replacement subscript is now in string buffer
3638 Error_Msg_FE -- CODEFIX
3639 ("\suggested replacement: `&~`", Original_Node (X), Ent);
3642 -- Case where subscript is of the form X'Length
3644 elsif Length_Reference (X) then
3646 Error_Msg_Node_2 := Ent;
3648 ("\suggest replacement of `&''Length` by `&''Last`",
3651 -- Case where subscript is of the form X'Length - expression
3653 elsif Nkind (X) = N_Op_Subtract
3654 and then Length_Reference (Left_Opnd (X))
3657 Error_Msg_Node_2 := Ent;
3659 ("\suggest replacement of `&''Length` by `&''Last`",
3660 Left_Opnd (X), Ent);
3662 end Test_Suspicious_Index;
3664 -- Start of processing for Warn_On_Suspicious_Index
3667 -- Only process if warnings activated
3669 if Warn_On_Assumed_Low_Bound then
3671 -- Test if array is simple entity name
3673 if Is_Entity_Name (Name) then
3675 -- Test if array is parameter of unconstrained string type
3677 Ent := Entity (Name);
3681 and then Is_Suspicious_Type (Typ)
3682 and then not Low_Bound_Tested (Ent)
3684 Test_Suspicious_Index;
3688 end Warn_On_Suspicious_Index;
3690 --------------------------------------
3691 -- Warn_On_Unassigned_Out_Parameter --
3692 --------------------------------------
3694 procedure Warn_On_Unassigned_Out_Parameter
3695 (Return_Node : Node_Id;
3696 Scope_Id : Entity_Id)
3702 -- Ignore if procedure or return statement does not come from source
3704 if not Comes_From_Source (Scope_Id)
3705 or else not Comes_From_Source (Return_Node)
3710 -- Loop through formals
3712 Form := First_Formal (Scope_Id);
3713 while Present (Form) loop
3715 -- We are only interested in OUT parameters that come from source
3716 -- and are never set in the source, and furthermore only in scalars
3717 -- since non-scalars generate too many false positives.
3719 if Ekind (Form) = E_Out_Parameter
3720 and then Never_Set_In_Source_Check_Spec (Form)
3721 and then Is_Scalar_Type (Etype (Form))
3722 and then not Present (Unset_Reference (Form))
3724 -- Before we issue the warning, an add ad hoc defence against the
3725 -- most common case of false positives with this warning which is
3726 -- the case where there is a Boolean OUT parameter that has been
3727 -- set, and whose meaning is "ignore the values of the other
3728 -- parameters". We can't of course reliably tell this case at
3729 -- compile time, but the following test kills a lot of false
3730 -- positives, without generating a significant number of false
3731 -- negatives (missed real warnings).
3733 Form2 := First_Formal (Scope_Id);
3734 while Present (Form2) loop
3735 if Ekind (Form2) = E_Out_Parameter
3736 and then Root_Type (Etype (Form2)) = Standard_Boolean
3737 and then not Never_Set_In_Source_Check_Spec (Form2)
3742 Next_Formal (Form2);
3745 -- Here all conditions are met, record possible unset reference
3747 Set_Unset_Reference (Form, Return_Node);
3752 end Warn_On_Unassigned_Out_Parameter;
3754 ---------------------------------
3755 -- Warn_On_Unreferenced_Entity --
3756 ---------------------------------
3758 procedure Warn_On_Unreferenced_Entity
3759 (Spec_E : Entity_Id;
3760 Body_E : Entity_Id := Empty)
3762 E : Entity_Id := Spec_E;
3765 if not Referenced_Check_Spec (E)
3766 and then not Has_Pragma_Unreferenced_Check_Spec (E)
3767 and then not Warnings_Off_Check_Spec (E)
3772 -- Case of variable that is assigned but not read. We suppress
3773 -- the message if the variable is volatile, has an address
3774 -- clause, is aliased, or is a renaming, or is imported.
3776 if Referenced_As_LHS_Check_Spec (E)
3777 and then No (Address_Clause (E))
3778 and then not Is_Volatile (E)
3780 if Warn_On_Modified_Unread
3781 and then not Is_Imported (E)
3782 and then not Is_Aliased (E)
3783 and then No (Renamed_Object (E))
3785 if not Has_Pragma_Unmodified_Check_Spec (E) then
3786 Error_Msg_N -- CODEFIX
3787 ("?variable & is assigned but never read!", E);
3790 Set_Last_Assignment (E, Empty);
3793 -- Normal case of neither assigned nor read (exclude variables
3794 -- referenced as out parameters, since we already generated
3795 -- appropriate warnings at the call point in this case).
3797 elsif not Referenced_As_Out_Parameter (E) then
3799 -- We suppress the message for types for which a valid
3800 -- pragma Unreferenced_Objects has been given, otherwise
3801 -- we go ahead and give the message.
3803 if not Has_Pragma_Unreferenced_Objects (Etype (E)) then
3805 -- Distinguish renamed case in message
3807 if Present (Renamed_Object (E))
3808 and then Comes_From_Source (Renamed_Object (E))
3810 Error_Msg_N -- CODEFIX
3811 ("?renamed variable & is not referenced!", E);
3813 Error_Msg_N -- CODEFIX
3814 ("?variable & is not referenced!", E);
3820 if Present (Renamed_Object (E))
3821 and then Comes_From_Source (Renamed_Object (E))
3823 Error_Msg_N -- CODEFIX
3824 ("?renamed constant & is not referenced!", E);
3826 Error_Msg_N -- CODEFIX
3827 ("?constant & is not referenced!", E);
3830 when E_In_Parameter |
3831 E_In_Out_Parameter =>
3833 -- Do not emit message for formals of a renaming, because
3834 -- they are never referenced explicitly.
3836 if Nkind (Original_Node (Unit_Declaration_Node (Scope (E))))
3837 /= N_Subprogram_Renaming_Declaration
3839 -- Suppress this message for an IN OUT parameter of a
3840 -- non-scalar type, since it is normal to have only an
3841 -- assignment in such a case.
3843 if Ekind (E) = E_In_Parameter
3844 or else not Referenced_As_LHS_Check_Spec (E)
3845 or else Is_Scalar_Type (Etype (E))
3847 if Present (Body_E) then
3851 if not Is_Trivial_Subprogram (Scope (E)) then
3852 Error_Msg_NE -- CODEFIX
3853 ("?formal parameter & is not referenced!",
3859 when E_Out_Parameter =>
3862 when E_Discriminant =>
3863 Error_Msg_N ("?discriminant & is not referenced!", E);
3865 when E_Named_Integer |
3867 Error_Msg_N -- CODEFIX
3868 ("?named number & is not referenced!", E);
3870 when Formal_Object_Kind =>
3871 Error_Msg_N -- CODEFIX
3872 ("?formal object & is not referenced!", E);
3874 when E_Enumeration_Literal =>
3875 Error_Msg_N -- CODEFIX
3876 ("?literal & is not referenced!", E);
3879 Error_Msg_N -- CODEFIX
3880 ("?function & is not referenced!", E);
3883 Error_Msg_N -- CODEFIX
3884 ("?procedure & is not referenced!", E);
3887 Error_Msg_N -- CODEFIX
3888 ("?package & is not referenced!", E);
3891 Error_Msg_N -- CODEFIX
3892 ("?exception & is not referenced!", E);
3895 Error_Msg_N -- CODEFIX
3896 ("?label & is not referenced!", E);
3898 when E_Generic_Procedure =>
3899 Error_Msg_N -- CODEFIX
3900 ("?generic procedure & is never instantiated!", E);
3902 when E_Generic_Function =>
3903 Error_Msg_N -- CODEFIX
3904 ("?generic function & is never instantiated!", E);
3907 Error_Msg_N -- CODEFIX
3908 ("?type & is not referenced!", E);
3911 Error_Msg_N -- CODEFIX
3912 ("?& is not referenced!", E);
3915 -- Kill warnings on the entity on which the message has been posted
3917 Set_Warnings_Off (E);
3919 end Warn_On_Unreferenced_Entity;
3921 --------------------------------
3922 -- Warn_On_Useless_Assignment --
3923 --------------------------------
3925 procedure Warn_On_Useless_Assignment
3927 N : Node_Id := Empty)
3932 function Check_Ref (N : Node_Id) return Traverse_Result;
3933 -- Used to instantiate Traverse_Func. Returns Abandon if a reference to
3934 -- the entity in question is found.
3936 function Test_No_Refs is new Traverse_Func (Check_Ref);
3942 function Check_Ref (N : Node_Id) return Traverse_Result is
3944 -- Check reference to our identifier. We use name equality here
3945 -- because the exception handlers have not yet been analyzed. This
3946 -- is not quite right, but it really does not matter that we fail
3947 -- to output the warning in some obscure cases of name clashes.
3949 if Nkind (N) = N_Identifier
3950 and then Chars (N) = Chars (Ent)
3958 -- Start of processing for Warn_On_Useless_Assignment
3961 -- Check if this is a case we want to warn on, a scalar or access
3962 -- variable with the last assignment field set, with warnings enabled,
3963 -- and which is not imported or exported. We also check that it is OK
3964 -- to capture the value. We are not going to capture any value, but
3965 -- the warning message depends on the same kind of conditions.
3967 if Is_Assignable (Ent)
3968 and then not Is_Return_Object (Ent)
3969 and then Present (Last_Assignment (Ent))
3970 and then not Is_Imported (Ent)
3971 and then not Is_Exported (Ent)
3972 and then Safe_To_Capture_Value (N, Ent)
3973 and then not Has_Pragma_Unreferenced_Check_Spec (Ent)
3975 -- Before we issue the message, check covering exception handlers.
3976 -- Search up tree for enclosing statement sequences and handlers.
3978 P := Parent (Last_Assignment (Ent));
3979 while Present (P) loop
3981 -- Something is really wrong if we don't find a handled statement
3982 -- sequence, so just suppress the warning.
3985 Set_Last_Assignment (Ent, Empty);
3988 -- When we hit a package/subprogram body, issue warning and exit
3990 elsif Nkind (P) = N_Subprogram_Body
3991 or else Nkind (P) = N_Package_Body
3993 -- Case of assigned value never referenced
3997 LA : constant Node_Id := Last_Assignment (Ent);
4000 -- Don't give this for OUT and IN OUT formals, since
4001 -- clearly caller may reference the assigned value. Also
4002 -- never give such warnings for internal variables.
4004 if Ekind (Ent) = E_Variable
4005 and then not Is_Internal_Name (Chars (Ent))
4007 -- Give appropriate message, distinguishing between
4008 -- assignment statements and out parameters.
4010 if Nkind_In (Parent (LA), N_Procedure_Call_Statement,
4011 N_Parameter_Association)
4014 ("?& modified by call, but value never "
4015 & "referenced", LA, Ent);
4018 Error_Msg_NE -- CODEFIX
4019 ("?useless assignment to&, value never "
4020 & "referenced!", LA, Ent);
4025 -- Case of assigned value overwritten
4029 LA : constant Node_Id := Last_Assignment (Ent);
4032 Error_Msg_Sloc := Sloc (N);
4034 -- Give appropriate message, distinguishing between
4035 -- assignment statements and out parameters.
4037 if Nkind_In (Parent (LA), N_Procedure_Call_Statement,
4038 N_Parameter_Association)
4041 ("?& modified by call, but value overwritten #!",
4044 Error_Msg_NE -- CODEFIX
4045 ("?useless assignment to&, value overwritten #!",
4051 -- Clear last assignment indication and we are done
4053 Set_Last_Assignment (Ent, Empty);
4056 -- Enclosing handled sequence of statements
4058 elsif Nkind (P) = N_Handled_Sequence_Of_Statements then
4060 -- Check exception handlers present
4062 if Present (Exception_Handlers (P)) then
4064 -- If we are not at the top level, we regard an inner
4065 -- exception handler as a decisive indicator that we should
4066 -- not generate the warning, since the variable in question
4067 -- may be accessed after an exception in the outer block.
4069 if Nkind (Parent (P)) /= N_Subprogram_Body
4070 and then Nkind (Parent (P)) /= N_Package_Body
4072 Set_Last_Assignment (Ent, Empty);
4075 -- Otherwise we are at the outer level. An exception
4076 -- handler is significant only if it references the
4077 -- variable in question, or if the entity in question
4078 -- is an OUT or IN OUT parameter, which which case
4079 -- the caller can reference it after the exception
4080 -- handler completes.
4083 if Is_Formal (Ent) then
4084 Set_Last_Assignment (Ent, Empty);
4088 X := First (Exception_Handlers (P));
4089 while Present (X) loop
4090 if Test_No_Refs (X) = Abandon then
4091 Set_Last_Assignment (Ent, Empty);
4105 end Warn_On_Useless_Assignment;
4107 ---------------------------------
4108 -- Warn_On_Useless_Assignments --
4109 ---------------------------------
4111 procedure Warn_On_Useless_Assignments (E : Entity_Id) is
4114 if Warn_On_Modified_Unread
4115 and then In_Extended_Main_Source_Unit (E)
4117 Ent := First_Entity (E);
4118 while Present (Ent) loop
4119 Warn_On_Useless_Assignment (Ent);
4123 end Warn_On_Useless_Assignments;
4125 -----------------------------
4126 -- Warnings_Off_Check_Spec --
4127 -----------------------------
4129 function Warnings_Off_Check_Spec (E : Entity_Id) return Boolean is
4131 if Is_Formal (E) and then Present (Spec_Entity (E)) then
4133 -- Note: use of OR here instead of OR ELSE is deliberate, we want
4134 -- to mess with flags on both entities.
4136 return Has_Warnings_Off (E)
4138 Has_Warnings_Off (Spec_Entity (E));
4141 return Has_Warnings_Off (E);
4143 end Warnings_Off_Check_Spec;