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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
|
------------------------------------------------------------------------------
-- --
-- GNAT COMPILER COMPONENTS --
-- --
-- E X P _ I M G V --
-- --
-- B o d y --
-- --
-- Copyright (C) 2001-2020, Free Software Foundation, Inc. --
-- --
-- GNAT is free software; you can redistribute it and/or modify it 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. GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
-- 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 COPYING3. If not, go to --
-- http://www.gnu.org/licenses for a complete copy of the license. --
-- --
-- GNAT was originally developed by the GNAT team at New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
------------------------------------------------------------------------------
with Atree; use Atree;
with Casing; use Casing;
with Checks; use Checks;
with Einfo; use Einfo;
with Exp_Put_Image;
with Exp_Util; use Exp_Util;
with Lib; use Lib;
with Namet; use Namet;
with Nmake; use Nmake;
with Nlists; use Nlists;
with Opt; use Opt;
with Rtsfind; use Rtsfind;
with Sem_Aux; use Sem_Aux;
with Sem_Res; use Sem_Res;
with Sem_Util; use Sem_Util;
with Sinfo; use Sinfo;
with Snames; use Snames;
with Stand; use Stand;
with Stringt; use Stringt;
with Tbuild; use Tbuild;
with Ttypes; use Ttypes;
with Uintp; use Uintp;
with Urealp; use Urealp;
package body Exp_Imgv is
procedure Rewrite_Object_Image
(N : Node_Id;
Pref : Entity_Id;
Attr_Name : Name_Id;
Str_Typ : Entity_Id);
-- AI12-0124: Rewrite attribute 'Image when it is applied to an object
-- reference as an attribute applied to a type. N denotes the node to be
-- rewritten, Pref denotes the prefix of the 'Image attribute, and Name
-- and Str_Typ specify which specific string type and 'Image attribute to
-- apply (e.g. Name_Wide_Image and Standard_Wide_String).
------------------------------------
-- Build_Enumeration_Image_Tables --
------------------------------------
procedure Build_Enumeration_Image_Tables (E : Entity_Id; N : Node_Id) is
Loc : constant Source_Ptr := Sloc (E);
Eind : Entity_Id;
Estr : Entity_Id;
Ind : List_Id;
Ityp : Node_Id;
Len : Nat;
Lit : Entity_Id;
Nlit : Nat;
Str : String_Id;
Saved_SSO : constant Character := Opt.Default_SSO;
-- Used to save the current scalar storage order during the generation
-- of the literal lookup table.
begin
-- Nothing to do for types other than a root enumeration type
if E /= Root_Type (E) then
return;
-- Nothing to do if pragma Discard_Names applies
elsif Discard_Names (E) then
return;
end if;
-- Otherwise tables need constructing
Start_String;
Ind := New_List;
Lit := First_Literal (E);
Len := 1;
Nlit := 0;
loop
Append_To (Ind,
Make_Integer_Literal (Loc, UI_From_Int (Len)));
exit when No (Lit);
Nlit := Nlit + 1;
Get_Unqualified_Decoded_Name_String (Chars (Lit));
if Name_Buffer (1) /= ''' then
Set_Casing (All_Upper_Case);
end if;
Store_String_Chars (Name_Buffer (1 .. Name_Len));
Len := Len + Int (Name_Len);
Next_Literal (Lit);
end loop;
if Len < Int (2 ** (8 - 1)) then
Ityp := Standard_Integer_8;
elsif Len < Int (2 ** (16 - 1)) then
Ityp := Standard_Integer_16;
else
Ityp := Standard_Integer_32;
end if;
Str := End_String;
Estr :=
Make_Defining_Identifier (Loc,
Chars => New_External_Name (Chars (E), 'S'));
Eind :=
Make_Defining_Identifier (Loc,
Chars => New_External_Name (Chars (E), 'N'));
Set_Lit_Strings (E, Estr);
Set_Lit_Indexes (E, Eind);
-- Temporarily set the current scalar storage order to the default
-- during the generation of the literals table, since both the Image and
-- Value attributes rely on runtime routines for interpreting table
-- values.
Opt.Default_SSO := ' ';
-- Generate literal table
Insert_Actions (N,
New_List (
Make_Object_Declaration (Loc,
Defining_Identifier => Estr,
Constant_Present => True,
Object_Definition =>
New_Occurrence_Of (Standard_String, Loc),
Expression =>
Make_String_Literal (Loc,
Strval => Str)),
Make_Object_Declaration (Loc,
Defining_Identifier => Eind,
Constant_Present => True,
Object_Definition =>
Make_Constrained_Array_Definition (Loc,
Discrete_Subtype_Definitions => New_List (
Make_Range (Loc,
Low_Bound => Make_Integer_Literal (Loc, 0),
High_Bound => Make_Integer_Literal (Loc, Nlit))),
Component_Definition =>
Make_Component_Definition (Loc,
Aliased_Present => False,
Subtype_Indication => New_Occurrence_Of (Ityp, Loc))),
Expression =>
Make_Aggregate (Loc,
Expressions => Ind))),
Suppress => All_Checks);
-- Reset the scalar storage order to the saved value
Opt.Default_SSO := Saved_SSO;
end Build_Enumeration_Image_Tables;
----------------------------
-- Expand_Image_Attribute --
----------------------------
-- For all cases other than user-defined enumeration types, the scheme
-- is as follows. First we insert the following code:
-- Snn : String (1 .. rt'Width);
-- Pnn : Natural;
-- Image_xx (tv, Snn, Pnn [,pm]);
--
-- and then Expr is replaced by Snn (1 .. Pnn)
-- In the above expansion:
-- rt is the root type of the expression
-- tv is the expression with the value, usually a type conversion
-- pm is an extra parameter present in some cases
-- The following table shows tv, xx, and (if used) pm for the various
-- possible types of the argument:
-- For types whose root type is Character
-- xx = Character
-- tv = Character (Expr)
-- For types whose root type is Boolean
-- xx = Boolean
-- tv = Boolean (Expr)
-- For signed integer types
-- xx = [Long_Long_[Long_]]Integer
-- tv = [Long_Long_[Long_]]Integer (Expr)
-- For modular types
-- xx = [Long_Long_[Long_]]Unsigned
-- tv = System.Unsigned_Types.[Long_Long_[Long_]]Unsigned (Expr)
-- For types whose root type is Wide_Character
-- xx = Wide_Character
-- tv = Wide_Character (Expr)
-- pm = Boolean, true if Ada 2005 mode, False otherwise
-- For types whose root type is Wide_Wide_Character
-- xx = Wide_Wide_Character
-- tv = Wide_Wide_Character (Expr)
-- For floating-point types
-- xx = Floating_Point
-- tv = Long_Long_Float (Expr)
-- pm = typ'Digits (typ = subtype of expression)
-- For decimal fixed-point types
-- xx = Decimal{32,64,128}
-- tv = Integer_{32,64,128} (Expr)? [convert with no scaling]
-- pm = typ'Scale (typ = subtype of expression)
-- For the most common ordinary fixed-point types
-- xx = Fixed{32,64,128}
-- tv = Integer_{32,64,128} (Expr) [convert with no scaling]
-- pm = typ'Small (typ = subtype of expression)
-- 1.0 / typ'Small
-- (Integer_{32,64,128} x typ'Small)'Fore
-- typ'Aft
-- For other ordinary fixed-point types
-- xx = Ordinary_Fixed_Point
-- tv = Long_Long_Float (Expr)
-- pm = typ'Aft (typ = subtype of expression)
-- For enumeration types other than those declared in package Standard
-- or System, Snn, Pnn, are expanded as above, but the call looks like:
-- Image_Enumeration_NN (rt'Pos (X), Snn, Pnn, typS, typI'Address)
-- where rt is the root type of the expression, and typS and typI are
-- the entities constructed as described in the spec for the procedure
-- Build_Enumeration_Image_Tables and NN is 32/16/8 depending on the
-- element type of Lit_Indexes. The rewriting of the expression to
-- Snn (1 .. Pnn) then occurs as in the other cases. A special case is
-- when pragma Discard_Names applies, in which case we replace expr by:
-- (rt'Pos (expr))'Img
-- So that the result is a space followed by the decimal value for the
-- position of the enumeration value in the enumeration type.
procedure Expand_Image_Attribute (N : Node_Id) is
Loc : constant Source_Ptr := Sloc (N);
Exprs : constant List_Id := Expressions (N);
Expr : constant Node_Id := Relocate_Node (First (Exprs));
Pref : constant Node_Id := Prefix (N);
procedure Expand_User_Defined_Enumeration_Image;
-- Expand attribute 'Image in user-defined enumeration types, avoiding
-- string copy.
function Is_User_Defined_Enumeration_Type
(Typ : Entity_Id) return Boolean;
-- Return True if Typ is a user-defined enumeration type
-------------------------------------------
-- Expand_User_Defined_Enumeration_Image --
-------------------------------------------
procedure Expand_User_Defined_Enumeration_Image is
Ins_List : constant List_Id := New_List;
P1_Id : constant Entity_Id := Make_Temporary (Loc, 'P');
P2_Id : constant Entity_Id := Make_Temporary (Loc, 'P');
P3_Id : constant Entity_Id := Make_Temporary (Loc, 'P');
P4_Id : constant Entity_Id := Make_Temporary (Loc, 'P');
Ptyp : constant Entity_Id := Entity (Pref);
Rtyp : constant Entity_Id := Root_Type (Ptyp);
S1_Id : constant Entity_Id := Make_Temporary (Loc, 'S');
begin
-- Apply a validity check, since it is a bit drastic to get a
-- completely junk image value for an invalid value.
if not Expr_Known_Valid (Expr) then
Insert_Valid_Check (Expr);
end if;
-- Generate:
-- P1 : constant Natural := Pos;
Append_To (Ins_List,
Make_Object_Declaration (Loc,
Defining_Identifier => P1_Id,
Object_Definition =>
New_Occurrence_Of (Standard_Natural, Loc),
Constant_Present => True,
Expression =>
Convert_To (Standard_Natural,
Make_Attribute_Reference (Loc,
Attribute_Name => Name_Pos,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Expressions => New_List (Expr)))));
-- Compute the index of the string start, generating:
-- P2 : constant Natural := call_put_enumN (P1);
Append_To (Ins_List,
Make_Object_Declaration (Loc,
Defining_Identifier => P2_Id,
Object_Definition =>
New_Occurrence_Of (Standard_Natural, Loc),
Constant_Present => True,
Expression =>
Convert_To (Standard_Natural,
Make_Indexed_Component (Loc,
Prefix =>
New_Occurrence_Of (Lit_Indexes (Rtyp), Loc),
Expressions =>
New_List (New_Occurrence_Of (P1_Id, Loc))))));
-- Compute the index of the next value, generating:
-- P3 : constant Natural := call_put_enumN (P1 + 1);
declare
Add_Node : constant Node_Id := New_Op_Node (N_Op_Add, Loc);
begin
Set_Left_Opnd (Add_Node, New_Occurrence_Of (P1_Id, Loc));
Set_Right_Opnd (Add_Node, Make_Integer_Literal (Loc, 1));
Append_To (Ins_List,
Make_Object_Declaration (Loc,
Defining_Identifier => P3_Id,
Object_Definition =>
New_Occurrence_Of (Standard_Natural, Loc),
Constant_Present => True,
Expression =>
Convert_To (Standard_Natural,
Make_Indexed_Component (Loc,
Prefix =>
New_Occurrence_Of (Lit_Indexes (Rtyp), Loc),
Expressions =>
New_List (Add_Node)))));
end;
-- Generate:
-- S4 : String renames call_put_enumS (S2 .. S3 - 1);
declare
Sub_Node : constant Node_Id := New_Op_Node (N_Op_Subtract, Loc);
begin
Set_Left_Opnd (Sub_Node, New_Occurrence_Of (P3_Id, Loc));
Set_Right_Opnd (Sub_Node, Make_Integer_Literal (Loc, 1));
Append_To (Ins_List,
Make_Object_Renaming_Declaration (Loc,
Defining_Identifier => P4_Id,
Subtype_Mark =>
New_Occurrence_Of (Standard_String, Loc),
Name =>
Make_Slice (Loc,
Prefix =>
New_Occurrence_Of (Lit_Strings (Rtyp), Loc),
Discrete_Range =>
Make_Range (Loc,
Low_Bound => New_Occurrence_Of (P2_Id, Loc),
High_Bound => Sub_Node))));
end;
-- Generate:
-- subtype S1 is string (1 .. P3 - P2);
declare
HB : constant Node_Id := New_Op_Node (N_Op_Subtract, Loc);
begin
Set_Left_Opnd (HB, New_Occurrence_Of (P3_Id, Loc));
Set_Right_Opnd (HB, New_Occurrence_Of (P2_Id, Loc));
Append_To (Ins_List,
Make_Subtype_Declaration (Loc,
Defining_Identifier => S1_Id,
Subtype_Indication =>
Make_Subtype_Indication (Loc,
Subtype_Mark =>
New_Occurrence_Of (Standard_String, Loc),
Constraint =>
Make_Index_Or_Discriminant_Constraint (Loc,
Constraints => New_List (
Make_Range (Loc,
Low_Bound => Make_Integer_Literal (Loc, 1),
High_Bound => HB))))));
end;
-- Insert all the above declarations before N. We suppress checks
-- because everything is in range at this stage.
Insert_Actions (N, Ins_List, Suppress => All_Checks);
Rewrite (N,
Unchecked_Convert_To (S1_Id, New_Occurrence_Of (P4_Id, Loc)));
Analyze_And_Resolve (N, Standard_String);
end Expand_User_Defined_Enumeration_Image;
--------------------------------------
-- Is_User_Defined_Enumeration_Type --
--------------------------------------
function Is_User_Defined_Enumeration_Type
(Typ : Entity_Id) return Boolean is
begin
return Ekind (Typ) = E_Enumeration_Type
and then Typ /= Standard_Boolean
and then Typ /= Standard_Character
and then Typ /= Standard_Wide_Character
and then Typ /= Standard_Wide_Wide_Character;
end Is_User_Defined_Enumeration_Type;
-- Local variables
Enum_Case : Boolean;
Imid : RE_Id;
Proc_Ent : Entity_Id;
Ptyp : Entity_Id;
Rtyp : Entity_Id;
Tent : Entity_Id := Empty;
Ttyp : Entity_Id;
Arg_List : List_Id;
-- List of arguments for run-time procedure call
Ins_List : List_Id;
-- List of actions to be inserted
Snn : constant Entity_Id := Make_Temporary (Loc, 'S');
Pnn : constant Entity_Id := Make_Temporary (Loc, 'P');
-- Start of processing for Expand_Image_Attribute
begin
if Is_Object_Image (Pref) then
Rewrite_Object_Image (N, Pref, Name_Image, Standard_String);
return;
end if;
Ptyp := Entity (Pref);
-- Ada 2020 allows 'Image on private types, so fetch the underlying
-- type to obtain the structure of the type. We use the base type,
-- not the root type, to handle properly derived types, but we use
-- the root type for enumeration types, because the literal map is
-- attached to the root. Should be inherited ???
if Is_Enumeration_Type (Ptyp) then
Rtyp := Underlying_Type (Root_Type (Ptyp));
else
Rtyp := Underlying_Type (Base_Type (Ptyp));
end if;
-- Enable speed-optimized expansion of user-defined enumeration types
-- if we are compiling with optimizations enabled and enumeration type
-- literals are generated. Otherwise the call will be expanded into a
-- call to the runtime library.
if Optimization_Level > 0
and then not Global_Discard_Names
and then Is_User_Defined_Enumeration_Type (Rtyp)
then
Expand_User_Defined_Enumeration_Image;
return;
end if;
-- Build declarations of Snn and Pnn to be inserted
Ins_List := New_List (
-- Snn : String (1 .. typ'Width);
Make_Object_Declaration (Loc,
Defining_Identifier => Snn,
Object_Definition =>
Make_Subtype_Indication (Loc,
Subtype_Mark => New_Occurrence_Of (Standard_String, Loc),
Constraint =>
Make_Index_Or_Discriminant_Constraint (Loc,
Constraints => New_List (
Make_Range (Loc,
Low_Bound => Make_Integer_Literal (Loc, 1),
High_Bound =>
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Rtyp, Loc),
Attribute_Name => Name_Width)))))),
-- Pnn : Natural;
Make_Object_Declaration (Loc,
Defining_Identifier => Pnn,
Object_Definition => New_Occurrence_Of (Standard_Natural, Loc)));
-- Set Imid (RE_Id of procedure to call), and Tent, target for the
-- type conversion of the first argument for all possibilities.
Enum_Case := False;
-- If this is a case where Image should be transformed using Put_Image,
-- then do so. See Exp_Put_Image for details.
if Exp_Put_Image.Image_Should_Call_Put_Image (N) then
Rewrite (N, Exp_Put_Image.Build_Image_Call (N));
Analyze_And_Resolve (N, Standard_String, Suppress => All_Checks);
return;
elsif Rtyp = Standard_Boolean then
Imid := RE_Image_Boolean;
Tent := Rtyp;
-- For standard character, we have to select the version which handles
-- soft hyphen correctly, based on the version of Ada in use (this is
-- ugly, but we have no choice).
elsif Rtyp = Standard_Character then
if Ada_Version < Ada_2005 then
Imid := RE_Image_Character;
else
Imid := RE_Image_Character_05;
end if;
Tent := Rtyp;
elsif Rtyp = Standard_Wide_Character then
Imid := RE_Image_Wide_Character;
Tent := Rtyp;
elsif Rtyp = Standard_Wide_Wide_Character then
Imid := RE_Image_Wide_Wide_Character;
Tent := Rtyp;
elsif Is_Signed_Integer_Type (Rtyp) then
if Esize (Rtyp) <= Standard_Integer_Size then
Imid := RE_Image_Integer;
Tent := Standard_Integer;
elsif Esize (Rtyp) <= Standard_Long_Long_Integer_Size then
Imid := RE_Image_Long_Long_Integer;
Tent := Standard_Long_Long_Integer;
else
Imid := RE_Image_Long_Long_Long_Integer;
Tent := Standard_Long_Long_Long_Integer;
end if;
elsif Is_Modular_Integer_Type (Rtyp) then
if Modulus (Rtyp) <= Modulus (RTE (RE_Unsigned)) then
Imid := RE_Image_Unsigned;
Tent := RTE (RE_Unsigned);
elsif Modulus (Rtyp) <= Modulus (RTE (RE_Long_Long_Unsigned)) then
Imid := RE_Image_Long_Long_Unsigned;
Tent := RTE (RE_Long_Long_Unsigned);
else
Imid := RE_Image_Long_Long_Long_Unsigned;
Tent := RTE (RE_Long_Long_Long_Unsigned);
end if;
elsif Is_Decimal_Fixed_Point_Type (Rtyp) then
if Esize (Rtyp) <= 32 then
Imid := RE_Image_Decimal32;
Tent := RTE (RE_Integer_32);
elsif Esize (Rtyp) <= 64 then
Imid := RE_Image_Decimal64;
Tent := RTE (RE_Integer_64);
else
Imid := RE_Image_Decimal128;
Tent := RTE (RE_Integer_128);
end if;
elsif Is_Ordinary_Fixed_Point_Type (Rtyp) then
declare
Num : constant Uint := Norm_Num (Small_Value (Rtyp));
Den : constant Uint := Norm_Den (Small_Value (Rtyp));
Max : constant Uint := UI_Max (Num, Den);
Min : constant Uint := UI_Min (Num, Den);
Siz : constant Uint := Esize (Rtyp);
begin
if Siz <= 32
and then Min = Uint_1
and then Max <= Uint_2 ** 31
then
Imid := RE_Image_Fixed32;
Tent := RTE (RE_Integer_32);
elsif Siz <= 64
and then Min = Uint_1
and then Max <= Uint_2 ** 63
then
Imid := RE_Image_Fixed64;
Tent := RTE (RE_Integer_64);
elsif System_Max_Integer_Size = 128
and then Min = Uint_1
and then Max <= Uint_2 ** 127
then
Imid := RE_Image_Fixed128;
Tent := RTE (RE_Integer_128);
else
Imid := RE_Image_Ordinary_Fixed_Point;
Tent := Standard_Long_Long_Float;
end if;
end;
elsif Is_Floating_Point_Type (Rtyp) then
Imid := RE_Image_Floating_Point;
Tent := Standard_Long_Long_Float;
-- Only other possibility is user-defined enumeration type
else
pragma Assert (Is_Enumeration_Type (Rtyp));
if Discard_Names (First_Subtype (Ptyp))
or else No (Lit_Strings (Rtyp))
then
-- When pragma Discard_Names applies to the first subtype, build
-- (Long_Long_Integer (Pref'Pos (Expr)))'Img. The conversion is
-- there to avoid applying 'Img directly in Universal_Integer,
-- which can be a very large type. See also the handling of 'Val.
Rewrite (N,
Make_Attribute_Reference (Loc,
Prefix =>
Convert_To (Standard_Long_Long_Integer,
Make_Attribute_Reference (Loc,
Prefix => Pref,
Attribute_Name => Name_Pos,
Expressions => New_List (Expr))),
Attribute_Name =>
Name_Img));
Analyze_And_Resolve (N, Standard_String);
return;
else
-- Here for enumeration type case
Ttyp := Component_Type (Etype (Lit_Indexes (Rtyp)));
if Ttyp = Standard_Integer_8 then
Imid := RE_Image_Enumeration_8;
elsif Ttyp = Standard_Integer_16 then
Imid := RE_Image_Enumeration_16;
else
Imid := RE_Image_Enumeration_32;
end if;
-- Apply a validity check, since it is a bit drastic to get a
-- completely junk image value for an invalid value.
if not Expr_Known_Valid (Expr) then
Insert_Valid_Check (Expr);
end if;
Enum_Case := True;
end if;
end if;
-- Build first argument for call
if Enum_Case then
declare
T : Entity_Id;
begin
-- In Ada 2020 we need the underlying type here, because 'Image is
-- allowed on private types. We have already checked the version
-- when resolving the attribute.
if Is_Private_Type (Ptyp) then
T := Rtyp;
else
T := Ptyp;
end if;
Arg_List := New_List (
Make_Attribute_Reference (Loc,
Attribute_Name => Name_Pos,
Prefix => New_Occurrence_Of (T, Loc),
Expressions => New_List (Expr)));
end;
-- AI12-0020: Ada 2020 allows 'Image for all types, including private
-- types. If the full type is not a fixed-point type, then it is enough
-- to set the Conversion_OK flag. However, that would not work for
-- fixed-point types, because that flag changes the run-time semantics
-- of fixed-point type conversions; therefore, we must first convert to
-- Rtyp, and then to Tent.
else
declare
Conv : Node_Id;
begin
if Is_Private_Type (Etype (Expr)) then
if Is_Fixed_Point_Type (Rtyp) then
Conv := Convert_To (Tent, OK_Convert_To (Rtyp, Expr));
else
Conv := OK_Convert_To (Tent, Expr);
end if;
else
Conv := Convert_To (Tent, Expr);
end if;
Arg_List := New_List (Conv);
end;
end if;
-- Append Snn, Pnn arguments
Append_To (Arg_List, New_Occurrence_Of (Snn, Loc));
Append_To (Arg_List, New_Occurrence_Of (Pnn, Loc));
-- Get entity of procedure to call
Proc_Ent := RTE (Imid);
-- If the procedure entity is empty, that means we have a case in
-- no run time mode where the operation is not allowed, and an
-- appropriate diagnostic has already been issued.
if No (Proc_Ent) then
return;
end if;
-- Otherwise complete preparation of arguments for run-time call
-- Add extra arguments for Enumeration case
if Enum_Case then
Append_To (Arg_List, New_Occurrence_Of (Lit_Strings (Rtyp), Loc));
Append_To (Arg_List,
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Lit_Indexes (Rtyp), Loc),
Attribute_Name => Name_Address));
-- For floating-point types, append Digits argument
elsif Is_Floating_Point_Type (Rtyp) then
Append_To (Arg_List,
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_Digits));
-- For decimal, append Scale and also set to do literal conversion
elsif Is_Decimal_Fixed_Point_Type (Rtyp) then
Set_Conversion_OK (First (Arg_List));
Append_To (Arg_List, Make_Integer_Literal (Loc, Scale_Value (Ptyp)));
-- For ordinary fixed-point types, append Num, Den, Fore, Aft parameters
-- and also set to do literal conversion.
elsif Is_Ordinary_Fixed_Point_Type (Rtyp) then
if Imid /= RE_Image_Ordinary_Fixed_Point then
Set_Conversion_OK (First (Arg_List));
Append_To (Arg_List,
Make_Integer_Literal (Loc, -Norm_Num (Small_Value (Ptyp))));
Append_To (Arg_List,
Make_Integer_Literal (Loc, -Norm_Den (Small_Value (Ptyp))));
-- We want to compute the Fore value for the fixed point type
-- whose mantissa type is Tent and whose small is typ'Small.
declare
T : Ureal := Uint_2 ** (Esize (Tent) - 1) * Small_Value (Ptyp);
F : Nat := 2;
begin
while T >= Ureal_10 loop
F := F + 1;
T := T / Ureal_10;
end loop;
Append_To (Arg_List,
Make_Integer_Literal (Loc, UI_From_Int (F)));
end;
end if;
Append_To (Arg_List, Make_Integer_Literal (Loc, Aft_Value (Ptyp)));
-- For Wide_Character, append Ada 2005 indication
elsif Rtyp = Standard_Wide_Character then
Append_To (Arg_List,
New_Occurrence_Of
(Boolean_Literals (Ada_Version >= Ada_2005), Loc));
end if;
-- Now append the procedure call to the insert list
Append_To (Ins_List,
Make_Procedure_Call_Statement (Loc,
Name => New_Occurrence_Of (Proc_Ent, Loc),
Parameter_Associations => Arg_List));
-- Insert declarations of Snn, Pnn, and the procedure call. We suppress
-- checks because we are sure that everything is in range at this stage.
Insert_Actions (N, Ins_List, Suppress => All_Checks);
-- Final step is to rewrite the expression as a slice and analyze,
-- again with no checks, since we are sure that everything is OK.
Rewrite (N,
Make_Slice (Loc,
Prefix => New_Occurrence_Of (Snn, Loc),
Discrete_Range =>
Make_Range (Loc,
Low_Bound => Make_Integer_Literal (Loc, 1),
High_Bound => New_Occurrence_Of (Pnn, Loc))));
Analyze_And_Resolve (N, Standard_String, Suppress => All_Checks);
end Expand_Image_Attribute;
----------------------------
-- Expand_Value_Attribute --
----------------------------
-- For scalar types derived from Boolean, Character and integer types
-- in package Standard, typ'Value (X) expands into:
-- btyp (Value_xx (X))
-- where btyp is the base type of the prefix
-- For types whose root type is Character
-- xx = Character
-- For types whose root type is Wide_Character
-- xx = Wide_Character
-- For types whose root type is Wide_Wide_Character
-- xx = Wide_Wide_Character
-- For types whose root type is Boolean
-- xx = Boolean
-- For signed integer types
-- xx = [Long_Long_[Long_]]Integer
-- For modular types
-- xx = [Long_Long_[Long_]]Unsigned
-- For floating-point types
-- xx = Real
-- For decimal fixed-point types, typ'Value (X) expands into
-- btyp?(Value_Decimal{32,64,128} (X, typ'Scale));
-- For the most common ordinary fixed-point types
-- btyp?(Value_Fixed{32,64,128} (X, S, 1.0 / S));
-- where S = typ'Small
-- For Wide_[Wide_]Character types, typ'Value (X) expands into:
-- btyp (Value_xx (X, EM))
-- where btyp is the base type of the prefix, and EM is the encoding method
-- For enumeration types other than those derived from types Boolean,
-- Character, Wide_[Wide_]Character in Standard, typ'Value (X) expands to:
-- Enum'Val (Value_Enumeration_NN (typS, typI'Address, Num, X))
-- where typS and typI and the Lit_Strings and Lit_Indexes entities
-- from T's root type entity, and Num is Enum'Pos (Enum'Last). The
-- Value_Enumeration_NN function will search the tables looking for
-- X and return the position number in the table if found which is
-- used to provide the result of 'Value (using Enum'Val). If the
-- value is not found Constraint_Error is raised. The suffix _NN
-- depends on the element type of typI.
procedure Expand_Value_Attribute (N : Node_Id) is
Loc : constant Source_Ptr := Sloc (N);
Typ : constant Entity_Id := Etype (N);
Btyp : constant Entity_Id := Base_Type (Typ);
Rtyp : constant Entity_Id := Root_Type (Typ);
Exprs : constant List_Id := Expressions (N);
Vid : RE_Id;
Args : List_Id;
Func : RE_Id;
Ttyp : Entity_Id;
begin
Args := Exprs;
if Rtyp = Standard_Character then
Vid := RE_Value_Character;
elsif Rtyp = Standard_Boolean then
Vid := RE_Value_Boolean;
elsif Rtyp = Standard_Wide_Character then
Vid := RE_Value_Wide_Character;
Append_To (Args,
Make_Integer_Literal (Loc,
Intval => Int (Wide_Character_Encoding_Method)));
elsif Rtyp = Standard_Wide_Wide_Character then
Vid := RE_Value_Wide_Wide_Character;
Append_To (Args,
Make_Integer_Literal (Loc,
Intval => Int (Wide_Character_Encoding_Method)));
elsif Is_Signed_Integer_Type (Rtyp) then
if Esize (Rtyp) <= Standard_Integer_Size then
Vid := RE_Value_Integer;
elsif Esize (Rtyp) <= Standard_Long_Long_Integer_Size then
Vid := RE_Value_Long_Long_Integer;
else
Vid := RE_Value_Long_Long_Long_Integer;
end if;
elsif Is_Modular_Integer_Type (Rtyp) then
if Modulus (Rtyp) <= Modulus (RTE (RE_Unsigned)) then
Vid := RE_Value_Unsigned;
elsif Modulus (Rtyp) <= Modulus (RTE (RE_Long_Long_Unsigned)) then
Vid := RE_Value_Long_Long_Unsigned;
else
Vid := RE_Value_Long_Long_Long_Unsigned;
end if;
elsif Is_Decimal_Fixed_Point_Type (Rtyp) then
if Esize (Rtyp) <= 32 and then abs (Scale_Value (Rtyp)) <= 9 then
Vid := RE_Value_Decimal32;
elsif Esize (Rtyp) <= 64 and then abs (Scale_Value (Rtyp)) <= 18 then
Vid := RE_Value_Decimal64;
else
Vid := RE_Value_Decimal128;
end if;
Append_To (Args, Make_Integer_Literal (Loc, Scale_Value (Rtyp)));
Rewrite (N,
OK_Convert_To (Btyp,
Make_Function_Call (Loc,
Name => New_Occurrence_Of (RTE (Vid), Loc),
Parameter_Associations => Args)));
Set_Etype (N, Btyp);
Analyze_And_Resolve (N, Btyp);
return;
elsif Is_Ordinary_Fixed_Point_Type (Rtyp) then
declare
Num : constant Uint := Norm_Num (Small_Value (Rtyp));
Den : constant Uint := Norm_Den (Small_Value (Rtyp));
Max : constant Uint := UI_Max (Num, Den);
Min : constant Uint := UI_Min (Num, Den);
Siz : constant Uint := Esize (Rtyp);
begin
if Siz <= 32
and then Min = Uint_1
and then Max <= Uint_2 ** 31
then
Vid := RE_Value_Fixed32;
elsif Siz <= 64
and then Min = Uint_1
and then Max <= Uint_2 ** 63
then
Vid := RE_Value_Fixed64;
elsif System_Max_Integer_Size = 128
and then Min = Uint_1
and then Max <= Uint_2 ** 127
then
Vid := RE_Value_Fixed128;
else
Vid := RE_Value_Real;
end if;
if Vid /= RE_Value_Real then
Append_To (Args,
Make_Integer_Literal (Loc, -Norm_Num (Small_Value (Rtyp))));
Append_To (Args,
Make_Integer_Literal (Loc, -Norm_Den (Small_Value (Rtyp))));
Rewrite (N,
OK_Convert_To (Btyp,
Make_Function_Call (Loc,
Name => New_Occurrence_Of (RTE (Vid), Loc),
Parameter_Associations => Args)));
Set_Etype (N, Btyp);
Analyze_And_Resolve (N, Btyp);
return;
end if;
end;
elsif Is_Floating_Point_Type (Rtyp) then
Vid := RE_Value_Real;
-- Only other possibility is user-defined enumeration type
else
pragma Assert (Is_Enumeration_Type (Rtyp));
-- Case of pragma Discard_Names, transform the Value
-- attribute to Btyp'Val (Long_Long_Integer'Value (Args))
if Discard_Names (First_Subtype (Typ))
or else No (Lit_Strings (Rtyp))
then
Rewrite (N,
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Btyp, Loc),
Attribute_Name => Name_Val,
Expressions => New_List (
Make_Attribute_Reference (Loc,
Prefix =>
New_Occurrence_Of (Standard_Long_Long_Integer, Loc),
Attribute_Name => Name_Value,
Expressions => Args))));
Analyze_And_Resolve (N, Btyp);
-- Here for normal case where we have enumeration tables, this
-- is where we build
-- T'Val (Value_Enumeration_NN (typS, typI'Address, Num, X))
else
Ttyp := Component_Type (Etype (Lit_Indexes (Rtyp)));
if Ttyp = Standard_Integer_8 then
Func := RE_Value_Enumeration_8;
elsif Ttyp = Standard_Integer_16 then
Func := RE_Value_Enumeration_16;
else
Func := RE_Value_Enumeration_32;
end if;
Prepend_To (Args,
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Rtyp, Loc),
Attribute_Name => Name_Pos,
Expressions => New_List (
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Rtyp, Loc),
Attribute_Name => Name_Last))));
Prepend_To (Args,
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Lit_Indexes (Rtyp), Loc),
Attribute_Name => Name_Address));
Prepend_To (Args,
New_Occurrence_Of (Lit_Strings (Rtyp), Loc));
Rewrite (N,
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Typ, Loc),
Attribute_Name => Name_Val,
Expressions => New_List (
Make_Function_Call (Loc,
Name =>
New_Occurrence_Of (RTE (Func), Loc),
Parameter_Associations => Args))));
Analyze_And_Resolve (N, Btyp);
end if;
return;
end if;
-- Fall through for all cases except user-defined enumeration type
-- and decimal types, with Vid set to the Id of the entity for the
-- Value routine and Args set to the list of parameters for the call.
-- Compiling package Ada.Tags under No_Run_Time_Mode we disable the
-- expansion of the attribute into the function call statement to avoid
-- generating spurious errors caused by the use of Integer_Address'Value
-- in our implementation of Ada.Tags.Internal_Tag
-- Seems like a bit of a odd approach, there should be a better way ???
-- There is a better way, test RTE_Available ???
if No_Run_Time_Mode
and then Rtyp = RTE (RE_Integer_Address)
and then RTU_Loaded (Ada_Tags)
and then Cunit_Entity (Current_Sem_Unit)
= Body_Entity (RTU_Entity (Ada_Tags))
then
Rewrite (N,
Unchecked_Convert_To (Rtyp,
Make_Integer_Literal (Loc, Uint_0)));
else
Rewrite (N,
Convert_To (Btyp,
Make_Function_Call (Loc,
Name => New_Occurrence_Of (RTE (Vid), Loc),
Parameter_Associations => Args)));
end if;
Analyze_And_Resolve (N, Btyp);
end Expand_Value_Attribute;
---------------------------------
-- Expand_Wide_Image_Attribute --
---------------------------------
-- We expand typ'Wide_Image (X) as follows. First we insert this code:
-- Rnn : Wide_String (1 .. rt'Wide_Width);
-- Lnn : Natural;
-- String_To_Wide_String
-- (typ'Image (Expr), Rnn, Lnn, Wide_Character_Encoding_Method);
-- where rt is the root type of the prefix type
-- Now we replace the Wide_Image reference by
-- Rnn (1 .. Lnn)
-- This works in all cases because String_To_Wide_String converts any
-- wide character escape sequences resulting from the Image call to the
-- proper Wide_Character equivalent
-- not quite right for typ = Wide_Character ???
procedure Expand_Wide_Image_Attribute (N : Node_Id) is
Loc : constant Source_Ptr := Sloc (N);
Pref : constant Entity_Id := Prefix (N);
Rnn : constant Entity_Id := Make_Temporary (Loc, 'S');
Lnn : constant Entity_Id := Make_Temporary (Loc, 'P');
Rtyp : Entity_Id;
begin
if Is_Object_Image (Pref) then
Rewrite_Object_Image (N, Pref, Name_Wide_Image, Standard_Wide_String);
return;
end if;
Rtyp := Root_Type (Entity (Pref));
Insert_Actions (N, New_List (
-- Rnn : Wide_String (1 .. base_typ'Width);
Make_Object_Declaration (Loc,
Defining_Identifier => Rnn,
Object_Definition =>
Make_Subtype_Indication (Loc,
Subtype_Mark =>
New_Occurrence_Of (Standard_Wide_String, Loc),
Constraint =>
Make_Index_Or_Discriminant_Constraint (Loc,
Constraints => New_List (
Make_Range (Loc,
Low_Bound => Make_Integer_Literal (Loc, 1),
High_Bound =>
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Rtyp, Loc),
Attribute_Name => Name_Wide_Width)))))),
-- Lnn : Natural;
Make_Object_Declaration (Loc,
Defining_Identifier => Lnn,
Object_Definition => New_Occurrence_Of (Standard_Natural, Loc)),
-- String_To_Wide_String
-- (typ'Image (X), Rnn, Lnn, Wide_Character_Encoding_Method);
Make_Procedure_Call_Statement (Loc,
Name =>
New_Occurrence_Of (RTE (RE_String_To_Wide_String), Loc),
Parameter_Associations => New_List (
Make_Attribute_Reference (Loc,
Prefix => Prefix (N),
Attribute_Name => Name_Image,
Expressions => Expressions (N)),
New_Occurrence_Of (Rnn, Loc),
New_Occurrence_Of (Lnn, Loc),
Make_Integer_Literal (Loc,
Intval => Int (Wide_Character_Encoding_Method))))),
-- Suppress checks because we know everything is properly in range
Suppress => All_Checks);
-- Final step is to rewrite the expression as a slice and analyze,
-- again with no checks, since we are sure that everything is OK.
Rewrite (N,
Make_Slice (Loc,
Prefix => New_Occurrence_Of (Rnn, Loc),
Discrete_Range =>
Make_Range (Loc,
Low_Bound => Make_Integer_Literal (Loc, 1),
High_Bound => New_Occurrence_Of (Lnn, Loc))));
Analyze_And_Resolve (N, Standard_Wide_String, Suppress => All_Checks);
end Expand_Wide_Image_Attribute;
--------------------------------------
-- Expand_Wide_Wide_Image_Attribute --
--------------------------------------
-- We expand typ'Wide_Wide_Image (X) as follows. First we insert this code:
-- Rnn : Wide_Wide_String (1 .. rt'Wide_Wide_Width);
-- Lnn : Natural;
-- String_To_Wide_Wide_String
-- (typ'Image (Expr), Rnn, Lnn, Wide_Character_Encoding_Method);
-- where rt is the root type of the prefix type
-- Now we replace the Wide_Wide_Image reference by
-- Rnn (1 .. Lnn)
-- This works in all cases because String_To_Wide_Wide_String converts any
-- wide character escape sequences resulting from the Image call to the
-- proper Wide_Wide_Character equivalent
-- not quite right for typ = Wide_Wide_Character ???
procedure Expand_Wide_Wide_Image_Attribute (N : Node_Id) is
Loc : constant Source_Ptr := Sloc (N);
Pref : constant Entity_Id := Prefix (N);
Rnn : constant Entity_Id := Make_Temporary (Loc, 'S');
Lnn : constant Entity_Id := Make_Temporary (Loc, 'P');
Rtyp : Entity_Id;
begin
if Is_Object_Image (Pref) then
Rewrite_Object_Image
(N, Pref, Name_Wide_Wide_Image, Standard_Wide_Wide_String);
return;
end if;
Rtyp := Root_Type (Entity (Pref));
Insert_Actions (N, New_List (
-- Rnn : Wide_Wide_String (1 .. rt'Wide_Wide_Width);
Make_Object_Declaration (Loc,
Defining_Identifier => Rnn,
Object_Definition =>
Make_Subtype_Indication (Loc,
Subtype_Mark =>
New_Occurrence_Of (Standard_Wide_Wide_String, Loc),
Constraint =>
Make_Index_Or_Discriminant_Constraint (Loc,
Constraints => New_List (
Make_Range (Loc,
Low_Bound => Make_Integer_Literal (Loc, 1),
High_Bound =>
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Rtyp, Loc),
Attribute_Name => Name_Wide_Wide_Width)))))),
-- Lnn : Natural;
Make_Object_Declaration (Loc,
Defining_Identifier => Lnn,
Object_Definition => New_Occurrence_Of (Standard_Natural, Loc)),
-- String_To_Wide_Wide_String
-- (typ'Image (X), Rnn, Lnn, Wide_Character_Encoding_Method);
Make_Procedure_Call_Statement (Loc,
Name =>
New_Occurrence_Of (RTE (RE_String_To_Wide_Wide_String), Loc),
Parameter_Associations => New_List (
Make_Attribute_Reference (Loc,
Prefix => Prefix (N),
Attribute_Name => Name_Image,
Expressions => Expressions (N)),
New_Occurrence_Of (Rnn, Loc),
New_Occurrence_Of (Lnn, Loc),
Make_Integer_Literal (Loc,
Intval => Int (Wide_Character_Encoding_Method))))),
-- Suppress checks because we know everything is properly in range
Suppress => All_Checks);
-- Final step is to rewrite the expression as a slice and analyze,
-- again with no checks, since we are sure that everything is OK.
Rewrite (N,
Make_Slice (Loc,
Prefix => New_Occurrence_Of (Rnn, Loc),
Discrete_Range =>
Make_Range (Loc,
Low_Bound => Make_Integer_Literal (Loc, 1),
High_Bound => New_Occurrence_Of (Lnn, Loc))));
Analyze_And_Resolve
(N, Standard_Wide_Wide_String, Suppress => All_Checks);
end Expand_Wide_Wide_Image_Attribute;
----------------------------
-- Expand_Width_Attribute --
----------------------------
-- The processing here also handles the case of Wide_[Wide_]Width. With the
-- exceptions noted, the processing is identical
-- For scalar types derived from Boolean, character and integer types
-- in package Standard. Note that the Width attribute is computed at
-- compile time for all cases except those involving non-static sub-
-- types. For such subtypes, typ'[Wide_[Wide_]]Width expands into:
-- Result_Type (xx (yy (Ptyp'First), yy (Ptyp'Last)))
-- where
-- For types whose root type is Character
-- xx = Width_Character
-- yy = Character
-- For types whose root type is Wide_Character
-- xx = Wide_Width_Character
-- yy = Character
-- For types whose root type is Wide_Wide_Character
-- xx = Wide_Wide_Width_Character
-- yy = Character
-- For types whose root type is Boolean
-- xx = Width_Boolean
-- yy = Boolean
-- For signed integer types
-- xx = Width_[Long_Long_[Long_]]Integer
-- yy = [Long_Long_[Long_]]Integer
-- For modular integer types
-- xx = Width_[Long_Long_[Long_]]Unsigned
-- yy = [Long_Long_[Long_]]Unsigned
-- For types derived from Wide_Character, typ'Width expands into
-- Result_Type (Width_Wide_Character (
-- Wide_Character (typ'First),
-- Wide_Character (typ'Last),
-- and typ'Wide_Width expands into:
-- Result_Type (Wide_Width_Wide_Character (
-- Wide_Character (typ'First),
-- Wide_Character (typ'Last));
-- and typ'Wide_Wide_Width expands into
-- Result_Type (Wide_Wide_Width_Wide_Character (
-- Wide_Character (typ'First),
-- Wide_Character (typ'Last));
-- For types derived from Wide_Wide_Character, typ'Width expands into
-- Result_Type (Width_Wide_Wide_Character (
-- Wide_Wide_Character (typ'First),
-- Wide_Wide_Character (typ'Last),
-- and typ'Wide_Width expands into:
-- Result_Type (Wide_Width_Wide_Wide_Character (
-- Wide_Wide_Character (typ'First),
-- Wide_Wide_Character (typ'Last));
-- and typ'Wide_Wide_Width expands into
-- Result_Type (Wide_Wide_Width_Wide_Wide_Char (
-- Wide_Wide_Character (typ'First),
-- Wide_Wide_Character (typ'Last));
-- For fixed point types, typ'Width and typ'Wide_[Wide_]Width expand into
-- if Ptyp'First > Ptyp'Last then 0 else Ptyp'Fore + 1 + Ptyp'Aft end if
-- and for floating point types, they expand into
-- if Ptyp'First > Ptyp'Last then 0 else btyp'Width end if
-- where btyp is the base type. This looks recursive but it isn't
-- because the base type is always static, and hence the expression
-- in the else is reduced to an integer literal.
-- For user-defined enumeration types, typ'Width expands into
-- Result_Type (Width_Enumeration_NN
-- (typS,
-- typI'Address,
-- typ'Pos (typ'First),
-- typ'Pos (Typ'Last)));
-- and typ'Wide_Width expands into:
-- Result_Type (Wide_Width_Enumeration_NN
-- (typS,
-- typI,
-- typ'Pos (typ'First),
-- typ'Pos (Typ'Last))
-- Wide_Character_Encoding_Method);
-- and typ'Wide_Wide_Width expands into:
-- Result_Type (Wide_Wide_Width_Enumeration_NN
-- (typS,
-- typI,
-- typ'Pos (typ'First),
-- typ'Pos (Typ'Last))
-- Wide_Character_Encoding_Method);
-- where typS and typI are the enumeration image strings and indexes
-- table, as described in Build_Enumeration_Image_Tables. NN is 8/16/32
-- for depending on the element type for typI.
-- Finally if Discard_Names is in effect for an enumeration type, then
-- a special if expression is built that yields the space needed for the
-- decimal representation of the largest pos value in the subtype. See
-- code below for details.
procedure Expand_Width_Attribute (N : Node_Id; Attr : Atype := Normal) is
Loc : constant Source_Ptr := Sloc (N);
Typ : constant Entity_Id := Etype (N);
Pref : constant Node_Id := Prefix (N);
Ptyp : constant Entity_Id := Etype (Pref);
Rtyp : constant Entity_Id := Root_Type (Ptyp);
Arglist : List_Id;
Ttyp : Entity_Id;
XX : RE_Id;
YY : Entity_Id;
begin
-- Types derived from Standard.Boolean
if Rtyp = Standard_Boolean then
XX := RE_Width_Boolean;
YY := Rtyp;
-- Types derived from Standard.Character
elsif Rtyp = Standard_Character then
case Attr is
when Normal => XX := RE_Width_Character;
when Wide => XX := RE_Wide_Width_Character;
when Wide_Wide => XX := RE_Wide_Wide_Width_Character;
end case;
YY := Rtyp;
-- Types derived from Standard.Wide_Character
elsif Rtyp = Standard_Wide_Character then
case Attr is
when Normal => XX := RE_Width_Wide_Character;
when Wide => XX := RE_Wide_Width_Wide_Character;
when Wide_Wide => XX := RE_Wide_Wide_Width_Wide_Character;
end case;
YY := Rtyp;
-- Types derived from Standard.Wide_Wide_Character
elsif Rtyp = Standard_Wide_Wide_Character then
case Attr is
when Normal => XX := RE_Width_Wide_Wide_Character;
when Wide => XX := RE_Wide_Width_Wide_Wide_Character;
when Wide_Wide => XX := RE_Wide_Wide_Width_Wide_Wide_Char;
end case;
YY := Rtyp;
-- Signed integer types
elsif Is_Signed_Integer_Type (Rtyp) then
if Esize (Rtyp) <= Standard_Integer_Size then
XX := RE_Width_Integer;
YY := Standard_Integer;
elsif Esize (Rtyp) <= Standard_Long_Long_Integer_Size then
XX := RE_Width_Long_Long_Integer;
YY := Standard_Long_Long_Integer;
else
XX := RE_Width_Long_Long_Long_Integer;
YY := Standard_Long_Long_Long_Integer;
end if;
-- Modular integer types
elsif Is_Modular_Integer_Type (Rtyp) then
if Modulus (Rtyp) <= Modulus (RTE (RE_Unsigned)) then
XX := RE_Width_Unsigned;
YY := RTE (RE_Unsigned);
elsif Modulus (Rtyp) <= Modulus (RTE (RE_Long_Long_Unsigned)) then
XX := RE_Width_Long_Long_Unsigned;
YY := RTE (RE_Long_Long_Unsigned);
else
XX := RE_Width_Long_Long_Long_Unsigned;
YY := RTE (RE_Long_Long_Long_Unsigned);
end if;
-- Fixed point types
elsif Is_Fixed_Point_Type (Rtyp) then
Rewrite (N,
Make_If_Expression (Loc,
Expressions => New_List (
Make_Op_Gt (Loc,
Left_Opnd =>
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_First),
Right_Opnd =>
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_Last)),
Make_Integer_Literal (Loc, 0),
Make_Op_Add (Loc,
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_Fore),
Make_Op_Add (Loc,
Make_Integer_Literal (Loc, 1),
Make_Integer_Literal (Loc, Aft_Value (Ptyp)))))));
Analyze_And_Resolve (N, Typ);
return;
-- Floating point types
elsif Is_Floating_Point_Type (Rtyp) then
Rewrite (N,
Make_If_Expression (Loc,
Expressions => New_List (
Make_Op_Gt (Loc,
Left_Opnd =>
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_First),
Right_Opnd =>
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_Last)),
Make_Integer_Literal (Loc, 0),
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Base_Type (Ptyp), Loc),
Attribute_Name => Name_Width))));
Analyze_And_Resolve (N, Typ);
return;
-- User-defined enumeration types
else
pragma Assert (Is_Enumeration_Type (Rtyp));
-- Whenever pragma Discard_Names is in effect, the value we need
-- is the value needed to accommodate the largest integer pos value
-- in the range of the subtype + 1 for the space at the start. We
-- build:
-- Tnn : constant Integer := Rtyp'Pos (Ptyp'Last)
-- and replace the expression by
-- (if Ptyp'Range_Length = 0 then 0
-- else (if Tnn < 10 then 2
-- else (if Tnn < 100 then 3
-- ...
-- else n)))...
-- where n is equal to Rtyp'Pos (Ptyp'Last) + 1
-- Note: The above processing is in accordance with the intent of
-- the RM, which is that Width should be related to the impl-defined
-- behavior of Image. It is not clear what this means if Image is
-- not defined (as in the configurable run-time case for GNAT) and
-- gives an error at compile time.
-- We choose in this case to just go ahead and implement Width the
-- same way, returning what Image would have returned if it has been
-- available in the configurable run-time library.
if Discard_Names (Rtyp) then
declare
Tnn : constant Entity_Id := Make_Temporary (Loc, 'T');
Cexpr : Node_Id;
P : Int;
M : Int;
K : Int;
begin
Insert_Action (N,
Make_Object_Declaration (Loc,
Defining_Identifier => Tnn,
Constant_Present => True,
Object_Definition =>
New_Occurrence_Of (Standard_Integer, Loc),
Expression =>
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Rtyp, Loc),
Attribute_Name => Name_Pos,
Expressions => New_List (
Convert_To (Rtyp,
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_Last))))));
-- OK, now we need to build the if expression. First get the
-- value of M, the largest possible value needed.
P := UI_To_Int
(Enumeration_Pos (Entity (Type_High_Bound (Rtyp))));
K := 1;
M := 1;
while M < P loop
M := M * 10;
K := K + 1;
end loop;
-- Build inner else
Cexpr := Make_Integer_Literal (Loc, K);
-- Wrap in inner if's until counted down to 2
while K > 2 loop
M := M / 10;
K := K - 1;
Cexpr :=
Make_If_Expression (Loc,
Expressions => New_List (
Make_Op_Lt (Loc,
Left_Opnd => New_Occurrence_Of (Tnn, Loc),
Right_Opnd => Make_Integer_Literal (Loc, M)),
Make_Integer_Literal (Loc, K),
Cexpr));
end loop;
-- Add initial comparison for null range and we are done, so
-- rewrite the attribute occurrence with this expression.
Rewrite (N,
Convert_To (Typ,
Make_If_Expression (Loc,
Expressions => New_List (
Make_Op_Eq (Loc,
Left_Opnd =>
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_Range_Length),
Right_Opnd => Make_Integer_Literal (Loc, 0)),
Make_Integer_Literal (Loc, 0),
Cexpr))));
Analyze_And_Resolve (N, Typ);
return;
end;
end if;
-- Normal case, not Discard_Names
Ttyp := Component_Type (Etype (Lit_Indexes (Rtyp)));
case Attr is
when Normal =>
if Ttyp = Standard_Integer_8 then
XX := RE_Width_Enumeration_8;
elsif Ttyp = Standard_Integer_16 then
XX := RE_Width_Enumeration_16;
else
XX := RE_Width_Enumeration_32;
end if;
when Wide =>
if Ttyp = Standard_Integer_8 then
XX := RE_Wide_Width_Enumeration_8;
elsif Ttyp = Standard_Integer_16 then
XX := RE_Wide_Width_Enumeration_16;
else
XX := RE_Wide_Width_Enumeration_32;
end if;
when Wide_Wide =>
if Ttyp = Standard_Integer_8 then
XX := RE_Wide_Wide_Width_Enumeration_8;
elsif Ttyp = Standard_Integer_16 then
XX := RE_Wide_Wide_Width_Enumeration_16;
else
XX := RE_Wide_Wide_Width_Enumeration_32;
end if;
end case;
Arglist :=
New_List (
New_Occurrence_Of (Lit_Strings (Rtyp), Loc),
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Lit_Indexes (Rtyp), Loc),
Attribute_Name => Name_Address),
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_Pos,
Expressions => New_List (
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_First))),
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_Pos,
Expressions => New_List (
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_Last))));
Rewrite (N,
Convert_To (Typ,
Make_Function_Call (Loc,
Name => New_Occurrence_Of (RTE (XX), Loc),
Parameter_Associations => Arglist)));
Analyze_And_Resolve (N, Typ);
return;
end if;
-- If we fall through XX and YY are set
Arglist := New_List (
Convert_To (YY,
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_First)),
Convert_To (YY,
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Ptyp, Loc),
Attribute_Name => Name_Last)));
Rewrite (N,
Convert_To (Typ,
Make_Function_Call (Loc,
Name => New_Occurrence_Of (RTE (XX), Loc),
Parameter_Associations => Arglist)));
Analyze_And_Resolve (N, Typ);
end Expand_Width_Attribute;
--------------------------
-- Rewrite_Object_Image --
--------------------------
procedure Rewrite_Object_Image
(N : Node_Id;
Pref : Entity_Id;
Attr_Name : Name_Id;
Str_Typ : Entity_Id)
is
begin
Rewrite (N,
Make_Attribute_Reference (Sloc (N),
Prefix => New_Occurrence_Of (Etype (Pref), Sloc (N)),
Attribute_Name => Attr_Name,
Expressions => New_List (Relocate_Node (Pref))));
Analyze_And_Resolve (N, Str_Typ);
end Rewrite_Object_Image;
end Exp_Imgv;
|