1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471 | ------------------------------------------------------------------------------
-- --
-- GNAT2XML COMPONENTS --
-- --
-- G N A T 2 X M L . A D A _ T R E E S . G E N E R A T E _ F A C T O R Y --
-- --
-- B o d y --
-- --
-- Copyright (C) 2012-2016, AdaCore --
-- --
-- Gnat2xml is free software; you can redistribute it and/or modify it --
-- under terms of the GNU General Public License as published by the Free --
-- Software Foundation; either version 2, or (at your option) any later --
-- version. Gnat2xml is distributed in the hope that it will be useful, --
-- but WITHOUT ANY WARRANTY; without even the implied warranty of MER- --
-- CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General --
-- Public License for more details. You should have received a copy of the --
-- GNU General Public License distributed with GNAT; see file COPYING. If --
-- not, write to the Free Software Foundation, 59 Temple Place Suite 330, --
-- Boston, MA 02111-1307, USA. --
-- The gnat2xml tool was derived from the Avatox sources. --
------------------------------------------------------------------------------
pragma Ada_2012;
-- This program generates the package Ada_Trees.Factory, which contains
-- subtypes and constructors for each kind/class of tree, and getters and
-- setters for each query.
-- The code is placed in two files ada_trees-factory.ns and
-- ada_trees-factory.nb, which should be copied to .ads and .adb. This allows
-- to avoid the copy in case the files haven't changed, which avoids changing
-- the timestamps, which avoids unnecessary recompilations.
with Ada.Wide_Text_IO;
with ASIS_UL.Formatted_Output; use ASIS_UL.Formatted_Output;
with ASIS_UL.String_Utilities; use ASIS_UL.String_Utilities;
procedure Ada_Trees.Generate_Factory is
Factory_Spec, Factory_Body : Wide_Text_IO.File_Type;
function Subtype_Name (Class : Classes) return String;
function List_Component_Subtype_Name (Kind : Flat_List_Kinds) return String;
procedure Construct_Constructor (Kind : Opt_ASIS_Elems; Is_Body : Boolean);
procedure Construct_List_Constructor
(Kind : Flat_List_Kinds;
Is_Body : Boolean);
function Subtype_Name (Class : Classes) return String is
begin
if Class = Not_An_Element then
return "Nil_Element";
else
return Capitalize (Strip_Article (Class'Img)) &
(if Class in ASIS_Elems | Flat_List_Kinds then "_Tree" else "");
-- Some of the ASIS_Elems conflict with query names, so append
-- "_Tree" to those. ASIS_Elems and lists conflict with constructor
-- names. This also avoids conflict with reserved words.
end if;
end Subtype_Name;
function List_Component_Subtype_Name
(Kind : Flat_List_Kinds)
return String
is
begin
return Subtype_Name (List_Component_Type (Kind));
end List_Component_Subtype_Name;
procedure Construct_Constructor
(Kind : Opt_ASIS_Elems;
Is_Body : Boolean)
is
Qs : Query_List renames Appropriate_Queries (Kind).all;
First_Time : Boolean := True;
begin
Put ("function \1", Constructor_Name (Kind));
Put ("\i\n(");
case Kind is
when A_Compilation_Unit | Def_Names =>
Put ("Def_Name : Name_Id;\n");
case Kind is
when A_Compilation_Unit =>
Put ("Unit_Kind : Unit_Kinds;\n");
Put ("Unit_Class : Unit_Classes;\n");
Put ("Unit_Origin : Unit_Origins;\n");
Put ("Unit_Full_Name : Name_Id;\n");
Put ("Source_File : Name_Id;\n");
when Def_Names =>
Put ("Def : Name_Id;\n");
Put ("Decl_Type : Name_Id;\n");
when others =>
null;
end case;
when Flat_Expression_Kinds =>
Put ("Expr_Type : Name_Id;\n");
case Kind is
when Usage_Names =>
Put ("Ref_Name : Name_Id;\n");
Put ("Ref : Name_Id;\n");
when An_Integer_Literal | A_Real_Literal | A_String_Literal =>
Put ("Lit_Val : Name_Id;\n");
when others =>
null;
end case;
when Flat_Pragma_Kinds =>
Put ("Pragma_Name : Name_Id;\n");
when A_Parameter_Specification | A_Formal_Object_Declaration =>
Put ("Mode : Asis.Mode_Kinds;\n");
when A_Comment =>
Put ("Text : Name_Id;\n");
when others =>
null;
end case;
for Q of Qs loop
Put ("\1 : \2;\n", Q_Name (Q), Subtype_Name (Query_Result_Types (Q)));
end loop;
Put ("Sloc : Asis.Text.Span := Asis.Text.Nil_Span)\n");
Put ("return \1\o", Subtype_Name (Kind));
if not Is_Body then
Put (";\n");
else
Put (" is\n");
Put ("begin\n\i");
Put
("return Result : constant \1 := Make (\2,\n\i",
Subtype_Name (Kind),
Capitalize (Kind'Img));
Put ("(");
if Qs'Length = 0 then
Put ("1 .. 0 => <>");
else
if Qs'Length = 1 then
Put ("1 => ");
end if;
for Q of Qs loop
if First_Time then
First_Time := False;
else
Put (", ");
end if;
Put ("(Queries.\1, \1\n)", Q_Name (Q));
-- We need "Queries.", because the parameter name hides the
-- Query name.
end loop;
end if;
Put ("),\n");
Put ("Sloc)\n\odo\n\i");
case Kind is
when A_Compilation_Unit | Def_Names =>
Put ("Result.Def_Name := Def_Name;\n");
case Kind is
when A_Compilation_Unit =>
Put ("Result.Unit_Kind := Unit_Kind;\n");
Put ("Result.Unit_Class := Unit_Class;\n");
Put ("Result.Unit_Origin := Unit_Origin;\n");
Put ("Result.Unit_Full_Name := Unit_Full_Name;\n");
Put ("Result.Source_File := Source_File;\n");
when Def_Names =>
Put ("Result.Def := Def;\n");
Put ("Result.Decl_Type := Decl_Type;\n");
when others =>
null;
end case;
when Flat_Expression_Kinds =>
Put ("Result.Expr_Type := Expr_Type;\n");
case Kind is
when Usage_Names =>
Put ("Result.Ref_Name := Ref_Name;\n");
Put ("Result.Ref := Ref;\n");
when An_Integer_Literal |
A_Real_Literal |
A_String_Literal =>
Put ("Result.Lit_Val := Lit_Val;\n");
when others =>
null;
end case;
when Flat_Pragma_Kinds =>
Put ("Result.Pragma_Name := Pragma_Name;\n");
when A_Parameter_Specification | A_Formal_Object_Declaration =>
Put ("Result.Mode := Mode;\n");
when A_Comment =>
Put ("Result.Text := Text;\n");
when others =>
Put ("null;\n");
end case;
Put ("\oend return;\n");
Put ("\oend \1;\n\n", Constructor_Name (Kind));
end if;
end Construct_Constructor;
procedure Construct_List_Constructor
(Kind : Flat_List_Kinds;
Is_Body : Boolean)
is
begin
Put ("function \1", Constructor_Name (Kind));
Put ("\i\n(Subtrees : Ada_Tree_Array := (1 .. 0 => <>);\n");
Put ("Sloc : Asis.Text.Span := Asis.Text.Nil_Span)\n");
Put ("return \1\o", Subtype_Name (Kind));
if not Is_Body then
Put (";\n");
else
Put (" is\n");
Put ("begin\n\i");
Put
("return Result : constant \1 := Make_List (\2,\n\i",
Subtype_Name (Kind),
Capitalize (Kind'Img));
Put ("Subtrees, Sloc);\n\o");
Put ("\oend \1;\n\n", Constructor_Name (Kind));
end if;
end Construct_List_Constructor;
-- Start of processing for Generate_Factory
begin
Wide_Text_IO.Create
(Factory_Spec,
Name => "ada_trees-factory.ns",
Form => "TEXT_TRANSLATION=NO");
Wide_Text_IO.Create
(Factory_Body,
Name => "ada_trees-factory.nb",
Form => "TEXT_TRANSLATION=NO");
-- We need TEXT_TRANSLATION=NO to generate Unix-style line endings on
-- Windows; otherwise, we will fail style checks.
Wide_Text_IO.Set_Output (Factory_Spec);
Put ("-- Automatically generated by Ada_Trees.Generate_Factory.\n\n");
Put ("pragma Ada_2012;\n\n");
Wide_Text_IO.Set_Output (Factory_Body);
Put ("-- Automatically generated by Ada_Trees.Generate_Factory.\n\n");
Put ("pragma Ada_2012;\n\n");
Wide_Text_IO.Set_Output (Factory_Spec);
Put ("package Ada_Trees.Factory is\n\n");
Wide_Text_IO.Set_Output (Factory_Body);
Put ("package body Ada_Trees.Factory is\n\n");
Indent;
Wide_Text_IO.Set_Output (Factory_Spec);
Put ("pragma Style_Checks (""M200""); -- Allow long lines\n");
Put ("pragma Style_Checks (Off); -- ???\n");
Put ("-- Above can be removed if we pretty-print this code\n\n");
Wide_Text_IO.Set_Output (Factory_Body);
Put ("pragma Style_Checks (""M200""); -- Allow long lines\n");
Put ("pragma Style_Checks (Off); -- ???\n");
Put ("-- Above can be removed if we pretty-print this code\n\n");
Wide_Text_IO.Set_Output (Factory_Spec);
Put ("-- One subtype for each type/class. A concrete type asserts that\n");
Put ("-- its Kind is equal to the appropriate kind. A list type\n");
Put ("-- asserts (in addition) that all of its elements are in the\n");
Put ("-- appropriate class. And an abstract class asserts that its\n");
Put ("-- Kind is some Kind in the class.\n");
Put
("-- \1 classes total.\n\n",
Image (Integer'(Flat_Element_Kinds'Pos (Flat_Element_Kinds'Base'Last))));
Put ("------------------------\n");
Put ("-- Abstract classes --\n");
Put ("------------------------\n\n");
for Class in Flat_Abstract_Classes loop
Put
("subtype \1 is Ada_Tree with\n" & "\iPredicate => -- \2 kinds\n\i",
Subtype_Name (Class),
Image (Cardinality (Kinds_In_Class (Class))));
Put ("\1.Kind in\n\i", Subtype_Name (Class));
Put_Kinds (Kinds_In_Class (Class));
Put ("\o");
Put (";\n\n\o\o");
end loop;
Put ("-------------\n");
Put ("-- Lists --\n");
Put ("-------------\n\n");
for Class in Flat_List_Kinds loop
Put
("subtype \1 is Ada_Tree with\n" & "\iPredicate =>\n\i",
Subtype_Name (Class));
if False then -- ???
Put
("\1.Kind = \2 and then\n" &
"\i(for all Subtree of \1.Subtrees =>\n" &
"\iSubtree in \3)\o\o",
Subtype_Name (Class),
Capitalize (Class'Img),
List_Component_Subtype_Name (Class));
else
Put ("\1.Kind = \2", Subtype_Name (Class), Capitalize (Class'Img));
end if;
Put (";\n\n\o\o");
end loop;
Put ("-----------------------------\n");
Put ("-- Concrete single kinds --\n");
Put ("-----------------------------\n\n");
for Class in Opt_ASIS_Elems loop
Put
("subtype \1 is Ada_Tree with\n" & "\iPredicate =>\n\i",
Subtype_Name (Class));
if False then -- ???
Put ("\1.Kind = \2", Subtype_Name (Class), Capitalize (Class'Img));
else
if Class = Not_An_Element then
Put ("\1.Kind = \2", Subtype_Name (Class), Capitalize (Class'Img));
else
Put
("\1.Kind in \2 | Not_An_Element",
Subtype_Name (Class),
Capitalize (Class'Img));
end if;
end if;
Put (";\n\n\o\o");
end loop;
Put ("---------------\n");
Put ("-- Getters --\n");
Put ("---------------\n\n");
-- ???Could narrow down the parameter type, too.
for Q in Structural_Queries loop
-- No_Query isn't a real query, so skip it.
if Q not in No_Query then
Put
("function \1 (Tree : Ada_Tree) return \2 is\n\i" &
"(Get (Tree, \1));\n\o",
Q_Name (Q),
Subtype_Name (Query_Result_Types (Q)));
end if;
end loop;
Put ("\n");
Wide_Text_IO.Set_Output (Factory_Spec);
Put ("---------------\n");
Put ("-- Setters --\n");
Put ("---------------\n\n");
for Q in Structural_Queries loop
if Q not in No_Query then
if False then -- ???
Put
("procedure Set_\1 is new Generic_Setter\n\i" & "(\1, \2);\n\o",
Q_Name (Q),
Subtype_Name (Query_Result_Types (Q)));
else
Put
("procedure Set_\1 (Tree : Ada_Tree; Subtree: \2);\n",
Q_Name (Q),
Subtype_Name (Query_Result_Types (Q)));
end if;
end if;
end loop;
Put ("\n");
Wide_Text_IO.Set_Output (Factory_Body);
Put ("---------------\n");
Put ("-- Setters --\n");
Put ("---------------\n\n");
for Q in Structural_Queries loop
if Q not in No_Query then
Put
("procedure Set_\1 (Tree : Ada_Tree; Subtree: \2) is\n" &
"begin\n" &
"\iSet (Tree, \1, Subtree);\o\n" &
"end Set_\1;\n\n",
Q_Name (Q),
Subtype_Name (Query_Result_Types (Q)));
end if;
end loop;
Wide_Text_IO.Set_Output (Factory_Spec);
Put ("--------------------\n");
Put ("-- Constructors --\n");
Put ("--------------------\n\n");
for Kind in Opt_ASIS_Elems loop
Construct_Constructor (Kind, Is_Body => False);
end loop;
for Kind in Flat_List_Kinds loop
Construct_List_Constructor (Kind, Is_Body => False);
end loop;
Wide_Text_IO.Set_Output (Factory_Body);
Put ("--------------------\n");
Put ("-- Constructors --\n");
Put ("--------------------\n\n");
for Kind in Opt_ASIS_Elems loop
Construct_Constructor (Kind, Is_Body => True);
end loop;
for Kind in Flat_List_Kinds loop
Construct_List_Constructor (Kind, Is_Body => True);
end loop;
Outdent;
Wide_Text_IO.Set_Output (Factory_Spec);
Put ("\nend Ada_Trees.Factory;\n");
Wide_Text_IO.Set_Output (Factory_Body);
Put ("end Ada_Trees.Factory;\n");
Wide_Text_IO.Set_Output (Wide_Text_IO.Standard_Output);
Wide_Text_IO.Close (Factory_Spec);
Wide_Text_IO.Close (Factory_Body);
Main_Done := True;
end Ada_Trees.Generate_Factory;
|