ocarina-backends-properties-utils.ads 4.2 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)                   --
--                                                                          --
------------------------------------------------------------------------------

32 33
with GNAT.OS_Lib; use GNAT.OS_Lib;

34 35
package Ocarina.Backends.Properties.Utils is

36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
   --  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")

   function Check_And_Get_Property
     (E : Node_Id;
      Property : Node_Id)
     return String_List;

   --  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

60 61 62 63 64
   function Check_And_Get_Property
     (E : Node_Id;
      Property_Name : Name_Id;
      Default_Value : Unsigned_Long_Long := 0)
     return Unsigned_Long_Long;
yoogx's avatar
yoogx committed
65 66 67 68 69 70 71 72 73 74 75 76 77

   function Check_And_Get_Property
     (E : Node_Id;
      Property_Name : Name_Id;
      Default_Value : Name_Id := No_Name)
     return Name_Id;

   function Check_And_Get_Property
     (E : Node_Id;
      Property_Name : Name_Id;
      Default_Value : Node_Id := No_Node)
     return Node_Id;

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

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

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

97
end Ocarina.Backends.Properties.Utils;