Skip to content

Commit

Permalink
Replace Boolean imprecise by Ref_Result_Kind
Browse files Browse the repository at this point in the history 
Homogenize the type used to express if a LAL query was imprecise or not.
Reduces technical debt.
Fixes T714-019_1 regression.
  • Loading branch information
@joaopsazevedo
joaopsazevedo committed Apr 3, 2024
1 parent 9926131 commit 788df8d
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 32 deletions.
4 changes: 2 additions & 2 deletions src/laltools-call_hierarchy.adb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- --
-- Libadalang Tools --
-- --
-- Copyright (C) 2021-2022, AdaCore --
-- Copyright (C) 2021-2024, AdaCore --
-- --
-- Libadalang Tools is free software; you can redistribute it and/or modi- --
-- fy it under terms of the GNU General Public License as published by --
Expand Down Expand Up @@ -59,7 +59,7 @@ package body Laltools.Call_Hierarchy is
Callback : not null access procedure
(Subp_Call : Ada_Node'Class);
Trace : GNATCOLL.Traces.Trace_Handle;
Imprecise : in out Boolean)
Imprecise : in out Ref_Result_Kind)
is

function Process_Body_Children (N : Ada_Node'Class)
Expand Down
4 changes: 2 additions & 2 deletions src/laltools-call_hierarchy.ads
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- --
-- Libadalang Tools --
-- --
-- Copyright (C) 2021, AdaCore --
-- Copyright (C) 2021-2024, AdaCore --
-- --
-- Libadalang Tools is free software; you can redistribute it and/or modi- --
-- fy it under terms of the GNU General Public License as published by --
Expand Down Expand Up @@ -58,7 +58,7 @@ package Laltools.Call_Hierarchy is
Callback : not null access procedure
(Subp_Call : Ada_Node'Class);
Trace : GNATCOLL.Traces.Trace_Handle;
Imprecise : in out Boolean)
Imprecise : in out Ref_Result_Kind)
with Pre => Is_Subprogram (Definition.P_Basic_Decl);
-- Finds all outgoing calls of the subprogram given by Definition and
-- calls Callback on each call that was found.
Expand Down
20 changes: 9 additions & 11 deletions src/laltools-common.adb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- --
-- Libadalang Tools --
-- --
-- Copyright (C) 2021-2023, AdaCore --
-- Copyright (C) 2021-2024, AdaCore --
-- --
-- Libadalang Tools is free software; you can redistribute it and/or modi- --
-- fy it under terms of the GNU General Public License as published by --
Expand Down Expand Up @@ -2571,7 +2571,7 @@ package body Laltools.Common is
function Is_Call
(Node : Ada_Node'Class;
Trace : GNATCOLL.Traces.Trace_Handle;
Imprecise : in out Boolean) return Boolean is
Imprecise : in out Ref_Result_Kind) return Boolean is
begin
return Node.As_Ada_Node /= No_Ada_Node
and then Node.Kind in Ada_Name
Expand Down Expand Up @@ -2704,18 +2704,16 @@ package body Laltools.Common is
function Is_Enum_Literal
(Node : Ada_Node'Class;
Trace : GNATCOLL.Traces.Trace_Handle;
Imprecise : in out Boolean) return Boolean
Imprecise : in out Ref_Result_Kind) return Boolean
is
Definition : Defining_Name;
Ref_Kind : Libadalang.Common.Ref_Result_Kind;

begin
if Node.As_Ada_Node /= No_Ada_Node
and then Node.Kind in Ada_Name
then
Definition := Laltools.Common.Resolve_Name
(Node.As_Name, Trace, Ref_Kind);
Imprecise :=
Ref_Kind in Libadalang.Common.Error | Libadalang.Common.Imprecise;
(Node.As_Name, Trace, Imprecise);
return Definition /= No_Defining_Name
and then Definition.P_Basic_Decl.Kind =
Ada_Enum_Literal_Decl;
Expand Down Expand Up @@ -2821,9 +2819,9 @@ package body Laltools.Common is
--------------------

function List_Bodies_Of
(Definition : Defining_Name;
Trace : GNATCOLL.Traces.Trace_Handle;
Imprecise : in out Boolean)
(Definition : Defining_Name;
Trace : GNATCOLL.Traces.Trace_Handle;
Imprecise : in out Ref_Result_Kind)
return Bodies_List.List
is
List : Bodies_List.List;
Expand Down Expand Up @@ -2874,7 +2872,7 @@ package body Laltools.Common is

Loop_Count := Loop_Count + 1;
if Loop_Count > 5 then
Imprecise := True;
Imprecise := Libadalang.Common.Imprecise;
exit;
end if;
end loop;
Expand Down
18 changes: 9 additions & 9 deletions src/laltools-common.ads
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- --
-- Libadalang Tools --
-- --
-- Copyright (C) 2021-2023, AdaCore --
-- Copyright (C) 2021-2024, AdaCore --
-- --
-- Libadalang Tools is free software; you can redistribute it and/or modi- --
-- fy it under terms of the GNU General Public License as published by --
Expand Down Expand Up @@ -749,7 +749,7 @@ package Laltools.Common is
function Is_Call
(Node : Ada_Node'Class;
Trace : GNATCOLL.Traces.Trace_Handle;
Imprecise : in out Boolean) return Boolean;
Imprecise : in out Ref_Result_Kind) return Boolean;
-- Check if a node is a call and an identifier. Enum literals
-- in DottedName are excluded.

Expand Down Expand Up @@ -777,7 +777,7 @@ package Laltools.Common is
function Is_Enum_Literal
(Node : Ada_Node'Class;
Trace : GNATCOLL.Traces.Trace_Handle;
Imprecise : in out Boolean) return Boolean;
Imprecise : in out Ref_Result_Kind) return Boolean;
-- Check if a node is an enum literal.

function Is_Renamable (Node : Ada_Node'Class) return Boolean;
Expand Down Expand Up @@ -816,13 +816,13 @@ package Laltools.Common is
-- Returns how many Param_Spec nodes L has.

function List_Bodies_Of
(Definition : Defining_Name;
Trace : GNATCOLL.Traces.Trace_Handle;
Imprecise : in out Boolean)
(Definition : Defining_Name;
Trace : GNATCOLL.Traces.Trace_Handle;
Imprecise : in out Ref_Result_Kind)
return Bodies_List.List;
-- List all the bodies of Definition. This does not list the bodies of the
-- parent. It sets Imprecise to True if any request returns
-- imprecise results.
-- parent. It sets Imprecise to Libadalang.Common.Imprecise if any request
-- returns imprecise results.

procedure Merge
(Left : in out Source_Location_Range_Map;
Expand All @@ -832,7 +832,7 @@ package Laltools.Common is
function Resolve_Name
(Name_Node : Name;
Trace : GNATCOLL.Traces.Trace_Handle;
Ref_Kind : out Libadalang.Common.Ref_Result_Kind)
Ref_Kind : out Ref_Result_Kind)
return Defining_Name;
-- Return the definition node (canonical part) of the given name.

Expand Down
20 changes: 12 additions & 8 deletions testsuite/ada_drivers/outgoing_calls/src/outgoing_calls.adb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ with GNATCOLL.Traces;
with Langkit_Support.Slocs;

with Libadalang.Analysis;
with Libadalang.Common;
with Libadalang.Helpers;

with Laltools.Common;
Expand Down Expand Up @@ -138,8 +139,10 @@ procedure Outgoing_Calls is
pragma Unreferenced (Context);

Calls : Laltools.Common.References_By_Subprogram.Map;
Dummy_Trace : GNATCOLL.Traces.Trace_Handle;
Dummy_Imprecise : Boolean := False;

Ignore_Imprecise : Libadalang.Common.Ref_Result_Kind :=
Libadalang.Common.No_Ref;
Ignore_Trace : GNATCOLL.Traces.Trace_Handle;

use type LALAnalysis.Defining_Name;

Expand All @@ -156,9 +159,9 @@ procedure Outgoing_Calls is
Laltools.Common.Get_Node_As_Name (Subp_Call.As_Ada_Node);
begin
-- First try to resolve the called function.

Call_Definition := Laltools.Common.Resolve_Name
(Subp_Call_Name, Dummy_Trace, Dummy_Imprecise);
Call_Definition :=
Laltools.Common.Resolve_Name
(Subp_Call_Name, Ignore_Trace, Ignore_Imprecise);

if Call_Definition /= LALAnalysis.No_Defining_Name then
if Calls.Contains (Call_Definition) then
Expand Down Expand Up @@ -211,7 +214,8 @@ procedure Outgoing_Calls is
end if;

Node_Defining_Name :=
Laltools.Common.Resolve_Name (Node_Name, Dummy_Trace, Dummy_Imprecise);
Laltools.Common.Resolve_Name
(Node_Name, Ignore_Trace, Ignore_Imprecise);

if Node_Defining_Name = LALAnalysis.No_Defining_Name then
Ada.Text_IO.Put_Line ("Node is not a defining name.");
Expand All @@ -224,8 +228,8 @@ procedure Outgoing_Calls is
Laltools.Call_Hierarchy.Find_Outgoing_Calls
(Definition => Node_Defining_Name,
Callback => Callback'Access,
Trace => Dummy_Trace,
Imprecise => Dummy_Imprecise);
Trace => Ignore_Trace,
Imprecise => Ignore_Imprecise);

Print_References_By_Subprogram_Map (Calls);
end Job_Post_Process;
Expand Down

0 comments on commit 788df8d

Please sign in to comment.