ocarina-backends-properties-utils.ads 5.6 KB
Newer Older
1 2 3 4 5 6 7 8
------------------------------------------------------------------------------
--                                                                          --
--                           OCARINA COMPONENTS                             --
--                                                                          --
--    O C A R I N A . B A C K E N D S . P R O P E R T I E S . U T I L S     --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
--                   Copyright (C) 2014-2015 ESA & ISAE.                    --
--                                                                          --
-- Ocarina  is free software; you can redistribute it and/or modify under   --
-- terms of the  GNU General Public License as published  by the Free Soft- --
-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
-- sion. Ocarina is distributed in the hope that it will be useful, but     --
-- WITHOUT ANY WARRANTY; without even the implied warranty of               --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     --
--                                                                          --
-- As a special exception under Section 7 of GPL version 3, you are granted --
-- additional permissions described in the GCC Runtime Library Exception,   --
-- version 3.1, as published by the Free Software Foundation.               --
--                                                                          --
-- You should have received a copy of the GNU General Public License and    --
-- a copy of the GCC Runtime Library Exception along with this program;     --
-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
-- <http://www.gnu.org/licenses/>.                                          --
26 27 28 29 30 31
--                                                                          --
--                 Ocarina is maintained by the TASTE project               --
--                      (taste-users@lists.tuxfamily.org)                   --
--                                                                          --
------------------------------------------------------------------------------

yoogx's avatar
yoogx committed
32 33
with GNAT.OS_Lib;                 use GNAT.OS_Lib;
with Ocarina.AADL_Values;         use Ocarina.AADL_Values;
34
with Ocarina.Backends.Properties; use Ocarina.Backends.Properties;
35

36 37
package Ocarina.Backends.Properties.Utils is

38 39 40 41 42 43 44 45 46 47 48 49 50 51
   --  This package proposes various generic accessor to ease the
   --  retrieval of property values.

   --  This high-level accessor return a GNAT.OS_Lib.String_List made
   --  of the name of the property in lower case, followed by a list
   --  of strings representing the property value. E.g.
   --
   --  ("source_stack_size", "13952 Bytes")
   --  ("Deadline", "500 Ms")
   --  ("Compute_Execution_Time", "0 Ms .. 3 Ms")
   --  ("Dispatch_Offset", "100 Ms")
   --  ("Period", "500 Ms")
   --  ("Dispatch_Protocol", "Periodic")

52
   function Check_And_Get_Property
yoogx's avatar
yoogx committed
53 54
     (E         : Node_Id;
      Prop_Name : Name_Id) return String_List;
55

56
   function Check_And_Get_Property
yoogx's avatar
yoogx committed
57 58
     (E        : Node_Id;
      Property : Node_Id) return String_List;
59 60 61 62 63 64

   --  The following accessors takes as parameters the following entities
   --  * E: entity from the instance tree for which we look for a property
   --  * Property_Name: name of the property we are looking for, in
   --    lower case

65
   function Check_And_Get_Property
yoogx's avatar
yoogx committed
66
     (E             : Node_Id;
67
      Property_Name : Name_Id;
yoogx's avatar
yoogx committed
68
      Default_Value : Unsigned_Long_Long := 0) return Unsigned_Long_Long;
yoogx's avatar
yoogx committed
69 70

   function Check_And_Get_Property
yoogx's avatar
yoogx committed
71
     (E             : Node_Id;
yoogx's avatar
yoogx committed
72
      Property_Name : Name_Id;
yoogx's avatar
yoogx committed
73
      Default_Value : Name_Id := No_Name) return Name_Id;
yoogx's avatar
yoogx committed
74 75

   function Check_And_Get_Property
yoogx's avatar
yoogx committed
76
     (E             : Node_Id;
yoogx's avatar
yoogx committed
77
      Property_Name : Name_Id;
yoogx's avatar
yoogx committed
78
      Default_Value : Node_Id := No_Node) return Node_Id;
yoogx's avatar
yoogx committed
79

yoogx's avatar
yoogx committed
80
   function Check_And_Get_Property
yoogx's avatar
yoogx committed
81
     (E             : Node_Id;
yoogx's avatar
yoogx committed
82
      Property_Name : Name_Id;
yoogx's avatar
yoogx committed
83
      Default_Value : List_Id := No_List) return List_Id;
yoogx's avatar
yoogx committed
84

yoogx's avatar
yoogx committed
85
   function Check_And_Get_Property
yoogx's avatar
yoogx committed
86
     (E             : Node_Id;
yoogx's avatar
yoogx committed
87
      Property_Name : Name_Id;
yoogx's avatar
yoogx committed
88
      Default_Value : Boolean := False) return Boolean;
yoogx's avatar
yoogx committed
89

yoogx's avatar
yoogx committed
90
   function Check_And_Get_Property
yoogx's avatar
yoogx committed
91
     (E             : Node_Id;
yoogx's avatar
yoogx committed
92
      Property_Name : Name_Id;
yoogx's avatar
yoogx committed
93 94
      Names         : Name_Array;
      Default_Value : Int := Int'First) return Int;
yoogx's avatar
yoogx committed
95

96
   function Check_And_Get_Property
yoogx's avatar
yoogx committed
97 98
     (E             : Node_Id;
      Property_Name : Name_Id) return Name_Array;
99 100 101 102 103 104 105 106

   generic
      type Elt_Type is private;
      type Elt_Array is array (Nat range <>) of Elt_Type;
      with function Extract_Value (V : Value_Type) return Elt_Type;
      Default_Value : Elt_Array;

   function Check_And_Get_Property_Generic
yoogx's avatar
yoogx committed
107 108
     (E             : Node_Id;
      Property_Name : Name_Id) return Elt_Array;
109 110

   function Check_And_Get_Property
yoogx's avatar
yoogx committed
111 112
     (E             : Node_Id;
      Property_Name : Name_Id) return ULL_Array;
113 114

   function Check_And_Get_Property
yoogx's avatar
yoogx committed
115 116
     (E             : Node_Id;
      Property_Name : Name_Id) return LL_Array;
117 118

   function Check_And_Get_Property
yoogx's avatar
yoogx committed
119 120
     (E             : Node_Id;
      Property_Name : Name_Id) return LD_Array;
121 122 123 124

   generic
      type T is (<>);
   function Check_And_Get_Property_Enumerator
yoogx's avatar
yoogx committed
125 126
     (E             : Node_Id;
      Property_Name : Name_Id) return T;
127 128 129 130 131

   generic
      type T is (<>);
      Default_Value : T;
   function Check_And_Get_Property_Enumerator_With_Default
yoogx's avatar
yoogx committed
132 133
     (E             : Node_Id;
      Property_Name : Name_Id) return T;
134

135
end Ocarina.Backends.Properties.Utils;