buildsupport_utils.ads 6.24 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin committed
1
--  *************************** buildsupport ****************************  --
Maxime Perrotin's avatar
Maxime Perrotin committed
2
--  (c) 2017 European Space Agency - maxime.perrotin@esa.int
Maxime Perrotin's avatar
Maxime Perrotin committed
3
4
5
--  LGPL license, see LICENSE file

--  Set of helper functions for buildsupport
Maxime Perrotin's avatar
Maxime Perrotin committed
6
with Ocarina,
7
8
     --  Ocarina.Types,
     Types,
Maxime Perrotin's avatar
Maxime Perrotin committed
9
     Namet,
10
     Ocarina.Backends.Properties,
11
     Ada.Containers.Indefinite_Ordered_Maps,
12
     Ada.Containers.Indefinite_Vectors,
Maxime Perrotin's avatar
Maxime Perrotin committed
13
14
     Ocarina.ME_AADL.AADL_Tree.Nodes,
     Ocarina.ME_AADL.AADL_Instances.Nodes,
15
     Ada.Strings.Unbounded;
Maxime Perrotin's avatar
Maxime Perrotin committed
16

Maxime Perrotin's avatar
Maxime Perrotin committed
17
use Ocarina,
Maxime Perrotin's avatar
Maxime Perrotin committed
18
19
    Types,
    Namet,
20
    Ocarina.Backends.Properties,
Maxime Perrotin's avatar
Maxime Perrotin committed
21
22
    Ocarina.ME_AADL.AADL_Tree.Nodes,
    Ocarina.ME_AADL.AADL_Instances.Nodes,
23
24
    Ada.Containers,
    Ada.Strings.Unbounded;
Maxime Perrotin's avatar
Maxime Perrotin committed
25
26
27

package Buildsupport_Utils is

Maxime Perrotin's avatar
Maxime Perrotin committed
28
29
30
31
   package ATN renames Ocarina.ME_AADL.AADL_Tree.Nodes;
   package AIN renames Ocarina.ME_AADL.AADL_Instances.Nodes;
   function US (Source : in String) return Unbounded_String renames
       To_Unbounded_String;
Maxime Perrotin's avatar
Maxime Perrotin committed
32
33
34
35
36
37
38
39
40
41
42
43
44
45

   procedure Banner;

   procedure Usage;

   procedure Exit_On_Error (Error : Boolean; Reason : String);

   type Synchronism is (Sync, Async);

   procedure Init;

   type Supported_RCM_Operation_Kind is (Unprotected_Operation,
                                         Protected_Operation,
                                         Cyclic_Operation,
Maxime Perrotin's avatar
Maxime Perrotin committed
46
                                         Sporadic_Operation);
Maxime Perrotin's avatar
Maxime Perrotin committed
47

48
   function Get_RCM_Operation_Kind (E : Node_Id)
Maxime Perrotin's avatar
Maxime Perrotin committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
     return Supported_RCM_Operation_Kind;

   function Get_RCM_Operation (E : Node_Id) return Node_Id;

   function Get_RCM_Period (D : Node_Id) return Unsigned_Long_Long;

   function Get_APLC_Binding (E : Node_Id) return List_Id;

   type Supported_ASN1_Encoding is (Default, Native, UPER, ACN);

   function Get_ASN1_Encoding (E : Node_Id) return Supported_ASN1_Encoding;

   type Supported_ASN1_Basic_Type is (ASN1_Sequence,
                                      ASN1_SequenceOf,
                                      ASN1_Enumerated,
                                      ASN1_Set,
                                      ASN1_SetOf,
                                      ASN1_Integer,
                                      ASN1_Boolean,
                                      ASN1_Real,
                                      ASN1_OctetString,
                                      ASN1_Choice,
                                      ASN1_String,
                                      ASN1_Unknown);

74
   package Property_Maps is new Indefinite_Ordered_Maps (String, String);
75
76
   use Property_Maps;
   package String_Vectors is new Indefinite_Vectors (Natural, String);
77

Maxime Perrotin's avatar
Maxime Perrotin committed
78
79
80
81
82
83
84
85
86
87
   function Get_ASN1_Basic_Type (E : Node_Id) return Supported_ASN1_Basic_Type;

   function Get_Ada_Package_Name (D : Node_Id) return Name_Id;

   function Get_Ellidiss_Tool_Version (D : Node_Id) return Name_Id;

   function Get_Interface_Name (D : Node_Id) return Name_Id;

   function Get_ASN1_Module_Name (D : Node_Id) return String;

Maxime Perrotin's avatar
Maxime Perrotin committed
88
89
   function Get_Properties_Map (D : Node_Id) return Property_Maps.Map;

Maxime Perrotin's avatar
Maxime Perrotin committed
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
   --  Shortcut to read an identifier from the parser, in lowercase
   function ATN_Lower (N : Node_Id) return String is
       (Get_Name_String (ATN.Name (ATN.Identifier (N))));

   --  Shortcut to read an identifier from the parser, with original case
   function ATN_Case (N : Node_Id) return String is
       (Get_Name_String (ATN.Display_Name (ATN.Identifier (N))));

   --  Shortcut to read an identifier from the parser, in lowercase
   function AIN_Lower (N : Node_Id) return String is
       (Get_Name_String (AIN.Name (AIN.Identifier (N))));

   --  Shortcut to read an identifier from the parser, with original case
   function AIN_Case (N : Node_Id) return String is
       (Get_Name_String (AIN.Display_Name (AIN.Identifier (N))));

106
107
108
109
   --  Types needed to build the AST of the TASTE Interface View in Ada
   type Parameter_Direction is (param_in, param_out);

   type ASN1_Parameter is
110
       record
111
112
113
114
115
116
117
           Name            : Unbounded_String;
           Sort            : Unbounded_String;
           ASN1_Module     : Unbounded_String;
           ASN1_Basic_Type : Supported_ASN1_Basic_Type;
           ASN1_File_Name  : Unbounded_String;
           Encoding        : Supported_ASN1_Encoding;
           Direction       : Parameter_Direction;
118
119
       end record;

120
   package Parameters is new Indefinite_Vectors (Natural, ASN1_Parameter);
121

122
123
   type Taste_Interface is
       record
Maxime Perrotin's avatar
Maxime Perrotin committed
124
125
126
127
128
129
130
131
132
           Name            : Unbounded_String;
           In_Parameters   : Parameters.Vector;
           Out_Parameters  : Parameters.Vector;
           RCM             : Supported_RCM_Operation_Kind;
           Period_Or_MIAT  : Natural;
           WCET            : Natural;
           WCET_Unit       : Unbounded_String;
           Queue_Size      : Natural;
           User_Properties : Property_Maps.Map;
133
134
135
       end record;

   package Interfaces is new Indefinite_Vectors (Natural, Taste_Interface);
136

Maxime Perrotin's avatar
Maxime Perrotin committed
137
   type Context_Parameter is
138
       record
139
           Name           : Unbounded_String;
Maxime Perrotin's avatar
Maxime Perrotin committed
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
           Sort           : Unbounded_String;
           Default_Value  : Unbounded_String;
           ASN1_Module    : Unbounded_String;
           ASN1_File_Name : Unbounded_String;
       end record;

   package Ctxt_Params is new Indefinite_Vectors (Natural, Context_Parameter);

   type Taste_Terminal_Function is
       record
           Name            : Unbounded_String;
           Language        : Supported_Source_Language;
           Zip_File        : Unbounded_String;
           Context_Params  : Ctxt_Params.Vector;
           User_Properties : Property_Maps.Map;
           Timers          : String_Vectors.Vector;
           Provided        : Interfaces.Vector;
           Required        : Interfaces.Vector;
158
159
       end record;

160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
   package Functions is new Indefinite_Vectors (Natural,
                                                Taste_Terminal_Function);

   type Connection is
       record
           Source_Function : Taste_Terminal_Function;
           Dest_Function   : Taste_Terminal_Function;
           Source_RI       : Taste_Interface;
           Dest_PI         : Taste_Interface;
       end record;

   package Channels is new Indefinite_Vectors (Natural, Connection);

   type Complete_Interface_View is limited
       record
           Flat_Functions : Functions.Vector;
           Connections    : Channels.Vector;
       end record;

Maxime Perrotin's avatar
Maxime Perrotin committed
179
end Buildsupport_Utils;