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
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
|
// file : libbuild2/cc/pkgconfig.cxx -*- C++ -*-
// license : MIT; see accompanying LICENSE file
// In order not to complicate the bootstrap procedure with libpkgconf building
// exclude functionality that involves reading of .pc files.
//
#ifndef BUILD2_BOOTSTRAP
# include <libpkgconf/libpkgconf.h>
#endif
#include <libbuild2/scope.hxx>
#include <libbuild2/target.hxx>
#include <libbuild2/context.hxx>
#include <libbuild2/variable.hxx>
#include <libbuild2/algorithm.hxx>
#include <libbuild2/filesystem.hxx>
#include <libbuild2/diagnostics.hxx>
#include <libbuild2/install/utility.hxx>
#include <libbuild2/bin/target.hxx>
#include <libbuild2/cc/types.hxx>
#include <libbuild2/cc/target.hxx> // pc
#include <libbuild2/cc/utility.hxx>
#include <libbuild2/cc/common.hxx>
#include <libbuild2/cc/compile-rule.hxx>
#include <libbuild2/cc/link-rule.hxx>
#ifndef BUILD2_BOOTSTRAP
// Note that the libpkgconf library doesn't provide the version macro that we
// could use to compile the code conditionally against different API versions.
// Thus, we need to sense the pkgconf_client_new() function signature
// ourselves to call it properly.
//
namespace details
{
void*
pkgconf_cross_personality_default (); // Never called.
}
using namespace details;
template <typename H>
static inline pkgconf_client_t*
call_pkgconf_client_new (pkgconf_client_t* (*f) (H, void*),
H error_handler,
void* error_handler_data)
{
return f (error_handler, error_handler_data);
}
template <typename H, typename P>
static inline pkgconf_client_t*
call_pkgconf_client_new (pkgconf_client_t* (*f) (H, void*, P),
H error_handler,
void* error_handler_data)
{
return f (error_handler,
error_handler_data,
::pkgconf_cross_personality_default ());
}
#endif
using namespace std;
using namespace butl;
namespace build2
{
#ifndef BUILD2_BOOTSTRAP
// Load package information from a .pc file. Filter out the -I/-L options
// that refer to system directories. This makes sure all the system search
// directories are "pushed" to the back which minimizes the chances of
// picking up wrong (e.g., old installed version) header/library.
//
// Note that the prerequisite package .pc files search order is as follows:
//
// - in directory of the specified file
// - in pc_dirs directories (in the natural order)
//
class pkgconf
{
public:
using path_type = build2::path;
path_type path;
public:
explicit
pkgconf (path_type,
const dir_paths& pc_dirs,
const dir_paths& sys_hdr_dirs,
const dir_paths& sys_lib_dirs);
// Create a special empty object. Querying package information on such
// an object is illegal.
//
pkgconf () = default;
~pkgconf ();
// Movable-only type.
//
pkgconf (pkgconf&& p)
: path (move (p.path)),
client_ (p.client_),
pkg_ (p.pkg_)
{
p.client_ = nullptr;
p.pkg_ = nullptr;
}
pkgconf&
operator= (pkgconf&& p)
{
if (this != &p)
{
this->~pkgconf ();
new (this) pkgconf (move (p)); // Assume noexcept move-construction.
}
return *this;
}
pkgconf (const pkgconf&) = delete;
pkgconf& operator= (const pkgconf&) = delete;
strings
cflags (bool stat) const;
strings
libs (bool stat) const;
optional<string>
variable (const char*) const;
optional<string>
variable (const string& s) const {return variable (s.c_str ());}
private:
// Keep them as raw pointers not to deal with API thread-unsafety in
// deleters and introducing additional mutex locks.
//
pkgconf_client_t* client_ = nullptr;
pkgconf_pkg_t* pkg_ = nullptr;
};
// Currently the library is not thread-safe, even on the pkgconf_client_t
// level (see issue #128 for details).
//
// @@ An update: seems that the obvious thread-safety issues are fixed.
// However, let's keep mutex locking for now not to introduce potential
// issues before we make sure that there are no other ones.
//
static mutex pkgconf_mutex;
// The package dependency traversal depth limit.
//
static const int pkgconf_max_depth = 100;
// Normally the error_handler() callback can be called multiple times to
// report a single error (once per message line), to produce a multi-line
// message like this:
//
// Package foo was not found in the pkg-config search path.\n
// Perhaps you should add the directory containing `foo.pc'\n
// to the PKG_CONFIG_PATH environment variable\n
// Package 'foo', required by 'bar', not found\n
//
// For the above example callback will be called 4 times. To suppress all the
// junk we will use PKGCONF_PKG_PKGF_SIMPLIFY_ERRORS to get just:
//
// Package 'foo', required by 'bar', not found\n
//
// Also disable merging options like -framework into a single fragment, if
// possible.
//
static const int pkgconf_flags =
PKGCONF_PKG_PKGF_SIMPLIFY_ERRORS
#ifdef PKGCONF_PKG_PKGF_DONT_MERGE_SPECIAL_FRAGMENTS
| PKGCONF_PKG_PKGF_DONT_MERGE_SPECIAL_FRAGMENTS
#endif
;
static bool
pkgconf_error_handler (const char* msg, const pkgconf_client_t*, const void*)
{
error << runtime_error (msg); // Sanitize the message.
return true;
}
// Deleters. Note that they are thread-safe.
//
struct fragments_deleter
{
void operator() (pkgconf_list_t* f) const {pkgconf_fragment_free (f);}
};
// Convert fragments to strings. Skip the -I/-L options that refer to system
// directories.
//
static strings
to_strings (const pkgconf_list_t& frags,
char type,
const pkgconf_list_t& sysdirs)
{
assert (type == 'I' || type == 'L');
strings r;
auto add = [&r] (const pkgconf_fragment_t* frag)
{
string s;
if (frag->type != '\0')
{
s += '-';
s += frag->type;
}
s += frag->data;
r.push_back (move (s));
};
// Option that is separated from its value, for example:
//
// -I /usr/lib
//
const pkgconf_fragment_t* opt (nullptr);
pkgconf_node_t *node;
PKGCONF_FOREACH_LIST_ENTRY(frags.head, node)
{
auto frag (static_cast<const pkgconf_fragment_t*> (node->data));
// Add the separated option and directory, unless the latest is a system
// one.
//
if (opt != nullptr)
{
// Note that we should restore the directory path that was
// (mis)interpreted as an option, for example:
//
// -I -Ifoo
//
// In the above example option '-I' is followed by directory '-Ifoo',
// which is represented by libpkgconf library as fragment 'foo' with
// type 'I'.
//
if (!pkgconf_path_match_list (
frag->type == '\0'
? frag->data
: (string ({'-', frag->type}) + frag->data).c_str (),
&sysdirs))
{
add (opt);
add (frag);
}
opt = nullptr;
continue;
}
// Skip the -I/-L option if it refers to a system directory.
//
if (frag->type == type)
{
// The option is separated from a value, that will (presumably) follow.
//
if (*frag->data == '\0')
{
opt = frag;
continue;
}
if (pkgconf_path_match_list (frag->data, &sysdirs))
continue;
}
add (frag);
}
if (opt != nullptr) // Add the dangling option.
add (opt);
return r;
}
// Note that some libpkgconf functions can potentially return NULL, failing
// to allocate the required memory block. However, we will not check the
// returned value for NULL as the library doesn't do so, prior to filling the
// allocated structures. So such a code complication on our side would be
// useless. Also, for some functions the NULL result has a special semantics,
// for example "not found".
//
pkgconf::
pkgconf (path_type p,
const dir_paths& pc_dirs,
const dir_paths& sys_lib_dirs,
const dir_paths& sys_hdr_dirs)
: path (move (p))
{
auto add_dirs = [] (pkgconf_list_t& dir_list,
const dir_paths& dirs,
bool suppress_dups,
bool cleanup = false)
{
if (cleanup)
{
pkgconf_path_free (&dir_list);
dir_list = PKGCONF_LIST_INITIALIZER;
}
for (const auto& d: dirs)
pkgconf_path_add (d.string ().c_str (), &dir_list, suppress_dups);
};
mlock l (pkgconf_mutex);
// Initialize the client handle.
//
unique_ptr<pkgconf_client_t, void (*) (pkgconf_client_t*)> c (
call_pkgconf_client_new (&pkgconf_client_new,
pkgconf_error_handler,
nullptr /* handler_data */),
[] (pkgconf_client_t* c) {pkgconf_client_free (c);});
pkgconf_client_set_flags (c.get (), pkgconf_flags);
// Note that the system header and library directory lists are
// automatically pre-filled by the pkgconf_client_new() call (see above).
// We will re-create these lists from scratch.
//
add_dirs (c->filter_libdirs,
sys_lib_dirs,
false /* suppress_dups */,
true /* cleanup */);
add_dirs (c->filter_includedirs,
sys_hdr_dirs,
false /* suppress_dups */,
true /* cleanup */);
// Note that the loaded file directory is added to the (yet empty) search
// list. Also note that loading of the prerequisite packages is delayed
// until flags retrieval, and their file directories are not added to the
// search list.
//
pkg_ = pkgconf_pkg_find (c.get (), path.string ().c_str ());
if (pkg_ == nullptr)
fail << "package '" << path << "' not found or invalid";
// Add the .pc file search directories.
//
assert (c->dir_list.length == 1); // Package file directory (see above).
add_dirs (c->dir_list, pc_dirs, true /* suppress_dups */);
client_ = c.release ();
}
pkgconf::
~pkgconf ()
{
if (client_ != nullptr) // Not empty.
{
assert (pkg_ != nullptr);
mlock l (pkgconf_mutex);
pkgconf_pkg_unref (client_, pkg_);
pkgconf_client_free (client_);
}
}
strings pkgconf::
cflags (bool stat) const
{
assert (client_ != nullptr); // Must not be empty.
mlock l (pkgconf_mutex);
pkgconf_client_set_flags (
client_,
pkgconf_flags |
// Walk through the private package dependencies (Requires.private)
// besides the public ones while collecting the flags. Note that we do
// this for both static and shared linking.
//
PKGCONF_PKG_PKGF_SEARCH_PRIVATE |
// Collect flags from Cflags.private besides those from Cflags for the
// static linking.
//
(stat
? PKGCONF_PKG_PKGF_MERGE_PRIVATE_FRAGMENTS
: 0));
pkgconf_list_t f = PKGCONF_LIST_INITIALIZER; // Aggregate initialization.
int e (pkgconf_pkg_cflags (client_, pkg_, &f, pkgconf_max_depth));
if (e != PKGCONF_PKG_ERRF_OK)
throw failed (); // Assume the diagnostics is issued.
unique_ptr<pkgconf_list_t, fragments_deleter> fd (&f); // Auto-deleter.
return to_strings (f, 'I', client_->filter_includedirs);
}
strings pkgconf::
libs (bool stat) const
{
assert (client_ != nullptr); // Must not be empty.
mlock l (pkgconf_mutex);
pkgconf_client_set_flags (
client_,
pkgconf_flags |
// Additionally collect flags from the private dependency packages
// (see above) and from the Libs.private value for the static linking.
//
(stat
? PKGCONF_PKG_PKGF_SEARCH_PRIVATE |
PKGCONF_PKG_PKGF_MERGE_PRIVATE_FRAGMENTS
: 0));
pkgconf_list_t f = PKGCONF_LIST_INITIALIZER; // Aggregate initialization.
int e (pkgconf_pkg_libs (client_, pkg_, &f, pkgconf_max_depth));
if (e != PKGCONF_PKG_ERRF_OK)
throw failed (); // Assume the diagnostics is issued.
unique_ptr<pkgconf_list_t, fragments_deleter> fd (&f); // Auto-deleter.
return to_strings (f, 'L', client_->filter_libdirs);
}
optional<string> pkgconf::
variable (const char* name) const
{
assert (client_ != nullptr); // Must not be empty.
mlock l (pkgconf_mutex);
const char* r (pkgconf_tuple_find (client_, &pkg_->vars, name));
return r != nullptr ? optional<string> (r) : nullopt;
}
#endif
namespace cc
{
using namespace bin;
// In pkg-config backslashes, spaces, etc are escaped with a backslash.
//
static string
escape (const string& s)
{
string r;
for (size_t p (0);;)
{
size_t sp (s.find_first_of (" \\\"'", p));
if (sp != string::npos)
{
r.append (s, p, sp - p);
r += '\\';
r += s[sp];
p = sp + 1;
}
else
{
r.append (s, p, sp);
break;
}
}
return r;
}
// Try to find a .pc file in the pkgconfig/ subdirectory of libd, trying
// several names derived from stem. If not found, return false. If found,
// load poptions, loptions, libs, and modules, set the corresponding
// *.export.* variables and add prerequisites on targets, and return true.
// Note that we assume the targets are locked so that all of this is
// MT-safe.
//
// System library search paths (those extracted from the compiler) are
// passed in top_sysd while the user-provided (via -L) in top_usrd.
//
// Note that scope and link order should be "top-level" from the
// search_library() POV.
//
// Also note that the bootstrapped version of build2 will not search for
// .pc files, always returning false (see above for the reasoning).
//
#ifndef BUILD2_BOOTSTRAP
// Derive pkgconf search directories from the specified library search
// directory passing them to the callback function for as long as it
// returns false (e.g., not found). Return true if the callback returned
// true.
//
bool common::
pkgconfig_derive (const dir_path& d, const pkgconfig_callback& f) const
{
dir_path pd (d);
// First always check the pkgconfig/ subdirectory in this library
// directory. Even on platforms where this is not the canonical place,
// .pc files of autotools-based packages installed by the user often
// still end up there.
//
if (exists (pd /= "pkgconfig") && f (move (pd)))
return true;
// Platform-specific locations.
//
if (tsys == "linux-gnu")
{
// On Linux (at least on Debain and Fedora) .pc files for header-only
// libraries often go to /usr/share/pkgconfig/.
//
(((pd = d) /= "..") /= "share") /= "pkgconfig";
if (exists (pd) && f (move (pd)))
return true;
}
else if (tsys == "freebsd")
{
// On FreeBSD (but not NetBSD) .pc files go to libdata/pkgconfig/, not
// lib/pkgconfig/.
//
(((pd = d) /= "..") /= "libdata") /= "pkgconfig";
if (exists (pd) && f (move (pd)))
return true;
}
return false;
}
// Search for the .pc files in the pkgconf directories that correspond to
// the specified library directory. If found, return static (first) and
// shared (second) library .pc files. If common is false, then only
// consider our .static/.shared files.
//
pair<path, path> common::
pkgconfig_search (const dir_path& libd,
const optional<project_name>& proj,
const string& stem,
bool common) const
{
// When it comes to looking for .pc files we have to decide where to
// search (which directory(ies)) as well as what to search for (which
// names). Suffix is our ".shared" or ".static" extension.
//
auto search_dir = [&proj, &stem] (const dir_path& dir,
const string& sfx) -> path
{
path f;
// See if there is a corresponding .pc file. About half of them are
// called foo.pc and half libfoo.pc (and one of the pkg-config's
// authors suggests that some of you should call yours foolib.pc, just
// to keep things interesting, you know).
//
// Given the (general) import in the form <proj>%lib{<stem>}, we will
// first try lib<stem>.pc, then <stem>.pc. Maybe it also makes sense
// to try <proj>.pc, just in case. Though, according to pkg-config
// docs, the .pc file should correspond to a library, not project. But
// then you get something like zlib which calls it zlib.pc. So let's
// just do it.
//
f = dir;
f /= "lib";
f += stem;
f += sfx;
f += ".pc";
if (exists (f))
return f;
f = dir;
f /= stem;
f += sfx;
f += ".pc";
if (exists (f))
return f;
if (proj)
{
f = dir;
f /= proj->string ();
f += sfx;
f += ".pc";
if (exists (f))
return f;
}
return path ();
};
// Return false (and so stop the iteration) if a .pc file is found.
//
// Note that we rely on the "small function object" optimization here.
//
struct data
{
path a;
path s;
bool common;
} d {path (), path (), common};
auto check = [&d, &search_dir] (dir_path&& p) -> bool
{
// First look for static/shared-specific files.
//
d.a = search_dir (p, ".static");
d.s = search_dir (p, ".shared");
if (!d.a.empty () || !d.s.empty ())
return true;
// Then the common.
//
if (d.common)
d.a = d.s = search_dir (p, "");
return !d.a.empty ();
};
pair<path, path> r;
if (pkgconfig_derive (libd, check))
{
r.first = move (d.a);
r.second = move (d.s);
}
return r;
};
bool common::
pkgconfig_load (action a,
const scope& s,
lib& lt,
liba* at,
libs* st,
const optional<project_name>& proj,
const string& stem,
const dir_path& libd,
const dir_paths& top_sysd,
const dir_paths& top_usrd) const
{
assert (at != nullptr || st != nullptr);
pair<path, path> p (
pkgconfig_search (libd, proj, stem, true /* common */));
if (p.first.empty () && p.second.empty ())
return false;
pkgconfig_load (a, s, lt, at, st, p, libd, top_sysd, top_usrd);
return true;
}
void common::
pkgconfig_load (action a,
const scope& s,
lib& lt,
liba* at,
libs* st,
const pair<path, path>& paths,
const dir_path& libd,
const dir_paths& top_sysd,
const dir_paths& top_usrd) const
{
tracer trace (x, "pkgconfig_load");
assert (at != nullptr || st != nullptr);
const path& ap (paths.first);
const path& sp (paths.second);
assert (!ap.empty () || !sp.empty ());
// Extract --cflags and set them as lib?{}:export.poptions. Note that we
// still pass --static in case this is pkgconf which has Cflags.private.
//
auto parse_cflags = [&trace, this] (target& t,
const pkgconf& pc,
bool la)
{
strings pops;
bool arg (false);
for (auto& o: pc.cflags (la))
{
if (arg)
{
// Can only be an argument for -I, -D, -U options.
//
pops.push_back (move (o));
arg = false;
continue;
}
size_t n (o.size ());
// We only keep -I, -D and -U.
//
if (n >= 2 &&
o[0] == '-' &&
(o[1] == 'I' || o[1] == 'D' || o[1] == 'U'))
{
pops.push_back (move (o));
arg = (n == 2);
continue;
}
l4 ([&]{trace << "ignoring " << pc.path << " --cflags option "
<< o;});
}
if (arg)
fail << "argument expected after " << pops.back () <<
info << "while parsing pkg-config --cflags " << pc.path;
if (!pops.empty ())
{
auto p (t.vars.insert (c_export_poptions));
// The only way we could already have this value is if this same
// library was also imported as a project (as opposed to installed).
// Unlikely but possible. In this case the values were set by the
// export stub and we shouldn't touch them.
//
if (p.second)
p.first = move (pops);
}
};
// Parse --libs into loptions/libs (interface and implementation). If
// ps is not NULL, add each resolved library target as a prerequisite.
//
auto parse_libs = [a, &s, top_sysd, this] (target& t,
bool binless,
const pkgconf& pc,
bool la,
prerequisites* ps)
{
strings lops;
vector<name> libs;
// Normally we will have zero or more -L's followed by one or more
// -l's, with the first one being the library itself, unless the
// library is binless. But sometimes we may have other linker options,
// for example, -Wl,... or -pthread. It's probably a bad idea to
// ignore them. Also, theoretically, we could have just the library
// name/path.
//
// The tricky part, of course, is to know whether what follows after
// an option we don't recognize is its argument or another option or
// library. What we do at the moment is stop recognizing just library
// names (without -l) after seeing an unknown option.
//
bool arg (false), first (true), known (true), have_L;
for (auto& o: pc.libs (la))
{
if (arg)
{
// Can only be an argument for an loption.
//
lops.push_back (move (o));
arg = false;
continue;
}
size_t n (o.size ());
// See if this is -L.
//
if (n >= 2 && o[0] == '-' && o[1] == 'L')
{
have_L = true;
lops.push_back (move (o));
arg = (n == 2);
continue;
}
// See if that's -l or just the library name/path.
//
if ((known && o[0] != '-') ||
(n > 2 && o[0] == '-' && o[1] == 'l'))
{
// Unless binless, the first one is the library itself, which we
// skip. Note that we don't verify this and theoretically it could
// be some other library, but we haven't encountered such a beast
// yet.
//
if (first)
{
first = false;
if (!binless)
continue;
}
// @@ If by some reason this is the library itself (doesn't go
// first or libpkgconf parsed libs in some bizarre way) we will
// have a dependency cycle by trying to lock its target inside
// search_library() as by now it is already locked. To be safe
// we probably shouldn't rely on the position and filter out
// all occurrences of the library itself (by name?) and
// complain if none were encountered.
//
// Note also that the same situation can occur if we have a
// binful library for which we could not find the library
// binary and are treating it as binless. We now have a diag
// frame around the call to search_library() to help diagnose
// such situations.
//
libs.push_back (name (move (o)));
continue;
}
// Otherwise we assume it is some other loption.
//
known = false;
lops.push_back (move (o));
}
if (arg)
fail << "argument expected after " << lops.back () <<
info << "while parsing pkg-config --libs " << pc.path;
// Space-separated list of escaped library flags.
//
auto lflags = [&pc, la] () -> string
{
string r;
for (const auto& o: pc.libs (la))
{
if (!r.empty ())
r += ' ';
r += escape (o);
}
return r;
};
if (first && !binless)
fail << "library expected in '" << lflags () << "'" <<
info << "while parsing pkg-config --libs " << pc.path;
// Resolve -lfoo into the library file path using our import installed
// machinery (i.e., we are going to call search_library() that will
// probably call us again, and so on).
//
// The reason we do it is the link order. For general libraries it
// shouldn't matter if we imported them via an export stub, direct
// import installed, or via a .pc file (which we could have generated
// from the export stub). The exception is "runtime libraries" (which
// are really the extension of libc or the operating system in case of
// Windows) such as -lm, -ldl, -lpthread, etc. Those we will detect
// and leave as -l*.
//
// If we managed to resolve all the -l's (sans runtime), then we can
// omit -L's for a nice and tidy command line.
//
bool all (true);
optional<dir_paths> usrd; // Populate lazily.
for (auto i (libs.begin ()); i != libs.end (); ++i)
{
name& n (*i);
string& l (n.value);
if (tclass == "windows")
{
// This is a potentially very long and unstable list and we may
// need a mechanism to extend it on the fly. See issue #59 for one
// idea.
//
auto cmp = [&l] (const char* s, size_t n = string::npos)
{
return icasecmp (l.c_str () + 2, s, n) == 0;
};
if (l[0] != '-') // e.g., just shell32.lib
continue;
else if (cmp ("advapi32") ||
cmp ("bcrypt") ||
cmp ("crypt32") ||
cmp ("dbgeng") ||
cmp ("d2d1") ||
cmp ("d3d", 3) || // d3d*
cmp ("dwmapi") ||
cmp ("dwrite") ||
cmp ("dxgi") ||
cmp ("dxguid") ||
cmp ("gdi32") ||
cmp ("glu32") ||
cmp ("imagehlp") ||
cmp ("imm32") ||
cmp ("iphlpapi") ||
cmp ("kernel32") ||
cmp ("mpr") ||
cmp ("mswsock") ||
cmp ("msxml", 5) || // msxml*
cmp ("netapi32") ||
cmp ("normaliz") ||
cmp ("odbc32") ||
cmp ("ole32") ||
cmp ("oleaut32") ||
cmp ("opengl32") ||
cmp ("psapi") ||
cmp ("rpcrt4") ||
cmp ("secur32") ||
cmp ("shell32") ||
cmp ("shlwapi") ||
cmp ("synchronization") ||
cmp ("user32") ||
cmp ("userenv") ||
cmp ("uuid") ||
cmp ("version") ||
cmp ("winmm") ||
cmp ("winspool") ||
cmp ("ws2") ||
cmp ("ws2_32") ||
cmp ("wsock32") ||
cmp ("wtsapi32"))
{
if (tsys == "win32-msvc")
{
// Translate -l<name> to <name>.lib.
//
l.erase (0, 2);
l += ".lib";
}
continue;
}
}
else
{
// These ones are common/standard/POSIX.
//
if (l[0] != '-' || // e.g., absolute path
l == "-lm" ||
l == "-ldl" ||
l == "-lrt" ||
l == "-lpthread")
continue;
// Note: these lists are most likely incomplete.
//
if (tclass == "linux")
{
// Some extras from libc (see libc6-dev) and other places.
//
if (l == "-lanl" ||
l == "-lcrypt" ||
l == "-lnsl" ||
l == "-lresolv" ||
l == "-lgcc")
continue;
}
else if (tclass == "macos")
{
if (l == "-lSystem")
continue;
}
else if (tclass == "bsd")
{
if (l == "-lexecinfo")
continue;
}
}
// Prepare user search paths by entering the -L paths from the .pc
// file.
//
if (have_L && !usrd)
{
usrd = dir_paths ();
for (auto i (lops.begin ()); i != lops.end (); ++i)
{
const string& o (*i);
if (o.size () >= 2 && o[0] == '-' && o[1] == 'L')
{
string p;
if (o.size () == 2)
p = *++i; // We've verified it's there.
else
p = string (o, 2);
try
{
dir_path d (move (p));
if (d.relative ())
fail << "relative -L directory '" << d << "' in '"
<< lflags () << "'" <<
info << "while parsing pkg-config --libs " << pc.path;
usrd->push_back (move (d));
}
catch (const invalid_path& e)
{
fail << "invalid -L directory '" << e.path << "' in '"
<< lflags () << "'" <<
info << "while parsing pkg-config --libs " << pc.path;
}
}
}
}
// @@ OUT: for now we assume out is undetermined, just like in
// resolve_library().
//
dir_path out;
string nm (l, 2); // Sans -l.
prerequisite_key pk {
nullopt, {&lib::static_type, &out, &out, &nm, nullopt}, &s};
const target* lt;
{
auto df = make_diag_frame (
[&pc, &l](const diag_record& dr)
{
location f (pc.path);
dr << info (f) << "while resolving pkg-config dependency " << l;
});
lt = search_library (a, top_sysd, usrd, pk);
}
if (lt != nullptr)
{
// We used to pick a member but that doesn't seem right since the
// same target could be used with different link orders.
//
n.dir = lt->dir;
n.type = lib::static_type.name;
n.value = lt->name;
if (!lt->out.empty ())
{
n.pair = true;
i = libs.insert (i + 1, name (lt->out));
}
if (ps != nullptr)
ps->push_back (prerequisite (*lt));
}
else
{
// If we couldn't find the library, then leave it as -l.
//
all = false;
if (tsys == "win32-msvc")
{
// Again, translate -l<name> to <name>.lib.
//
l = move (nm += ".lib");
}
}
}
// If all the -l's resolved and there were no other options, then drop
// all the -L's. If we have unknown options, then leave them in to be
// safe.
//
if (all && known)
lops.clear ();
if (!lops.empty ())
{
if (tsys == "win32-msvc")
{
// Translate -L to /LIBPATH.
//
for (auto i (lops.begin ()); i != lops.end (); )
{
string& o (*i);
size_t n (o.size ());
if (n >= 2 && o[0] == '-' && o[1] == 'L')
{
o.replace (0, 2, "/LIBPATH:");
if (n == 2)
{
o += *++i; // We've verified it's there.
i = lops.erase (i);
continue;
}
}
++i;
}
}
auto p (t.vars.insert (c_export_loptions));
if (p.second)
p.first = move (lops);
}
// Set even if empty (export override).
//
{
auto p (t.vars.insert (la ? c_export_impl_libs : c_export_libs));
if (p.second)
p.first = move (libs);
}
};
// On Windows pkg-config will escape backslahses in paths. In fact, it
// may escape things even on non-Windows platforms, for example,
// spaces. So we use a slightly modified version of next_word().
//
auto next = [] (const string& s, size_t& b, size_t& e) -> string
{
string r;
size_t n (s.size ());
if (b != e)
b = e;
// Skip leading delimiters.
//
for (; b != n && s[b] == ' '; ++b) ;
if (b == n)
{
e = n;
return r;
}
// Find first trailing delimiter while taking care of escapes.
//
r = s[b];
for (e = b + 1; e != n && s[e] != ' '; ++e)
{
if (s[e] == '\\')
{
if (++e == n)
fail << "dangling escape in pkg-config output '" << s << "'";
}
r += s[e];
}
return r;
};
// Parse modules, enter them as targets, and add them to the
// prerequisites.
//
auto parse_modules = [&trace, this,
&next, &s, <] (const pkgconf& pc,
prerequisites& ps)
{
optional<string> val (pc.variable ("cxx_modules"));
if (!val)
return;
string m;
for (size_t b (0), e (0); !(m = next (*val, b, e)).empty (); )
{
// The format is <name>=<path> with `..` used as a partition
// separator (see pkgconfig_save() for details).
//
size_t p (m.find ('='));
if (p == string::npos ||
p == 0 || // Empty name.
p == m.size () - 1) // Empty path.
fail << "invalid module information in '" << *val << "'" <<
info << "while parsing pkg-config --variable=cxx_modules "
<< pc.path;
string mn (m, 0, p);
path mp (m, p + 1, string::npos);
path mf (mp.leaf ());
// Extract module properties, if any.
//
optional<string> pp (pc.variable ("cxx_module_preprocessed." + mn));
optional<string> se (pc.variable ("cxx_module_symexport." + mn));
// Replace the partition separator.
//
if ((p = mn.find ("..")) != string::npos)
mn.replace (p, 2, 1, ':');
// For now there are only C++ modules.
//
auto tl (
s.ctx.targets.insert_locked (
*x_mod,
mp.directory (),
dir_path (),
mf.base ().string (),
mf.extension (),
target_decl::implied,
trace));
target& mt (tl.first);
// If the target already exists, then setting its variables is not
// MT-safe. So currently we only do it if we have the lock (and thus
// nobody can see this target yet) verifying that this has already
// been done otherwise.
//
// @@ This is not quite correct, though: this target could already
// exist but for a "different purpose" (e.g., it could be used as
// a header). Well, maybe it shouldn't.
//
// @@ Could setting it in the rule-specific vars help? (But we
// are not matching a rule for it.) Note that we are setting
// it on the module source, not bmi*{}! So rule-specific vars
// don't seem to the answer here.
//
if (tl.second.owns_lock ())
{
mt.vars.assign (c_module_name) = move (mn);
// Set module properties. Note that if unspecified we should still
// set them to their default values since the hosting project may
// have them set to incompatible values.
//
{
value& v (mt.vars.assign (x_preprocessed)); // NULL
if (pp)
v = move (*pp);
}
{
mt.vars.assign (x_symexport) = (se && *se == "true");
}
tl.second.unlock ();
}
else
{
if (!mt.vars[c_module_name])
fail << "unexpected metadata for module target " << mt <<
info << "module is expected to have assigned name" <<
info << "make sure this module is used via " << lt
<< " prerequisite";
}
ps.push_back (prerequisite (mt));
}
};
// Parse importable headers, enter them as targets, and add them to
// the prerequisites.
//
auto parse_headers = [&trace, this,
&next, &s, <] (const pkgconf& pc,
const target_type& tt,
const char* lang,
prerequisites& ps)
{
string var (string (lang) + "_importable_headers");
optional<string> val (pc.variable (var));
if (!val)
return;
string h;
for (size_t b (0), e (0); !(h = next (*val, b, e)).empty (); )
{
path hp (move (h));
path hf (hp.leaf ());
auto tl (
s.ctx.targets.insert_locked (
tt,
hp.directory (),
dir_path (),
hf.base ().string (),
hf.extension (),
target_decl::implied,
trace));
target& ht (tl.first);
// If the target already exists, then setting its variables is not
// MT-safe. So currently we only do it if we have the lock (and thus
// nobody can see this target yet) verifying that this has already
// been done otherwise.
//
if (tl.second.owns_lock ())
{
ht.vars.assign (c_importable) = true;
tl.second.unlock ();
}
else
{
if (!cast_false<bool> (ht.vars[c_importable]))
fail << "unexpected metadata for existing header target " << ht <<
info << "header is expected to be marked importable" <<
info << "make sure this header is used via " << lt
<< " prerequisite";
}
ps.push_back (prerequisite (ht));
}
};
// For now we only populate prerequisites for lib{}. To do it for
// liba{} would require weeding out duplicates that are already in
// lib{}.
//
// Currently, this information is only used by the modules machinery to
// resolve module names to module files (but we cannot only do this if
// modules are enabled since the same installed library can be used by
// multiple builds).
//
prerequisites prs;
pkgconf apc;
pkgconf spc;
// Create the .pc files search directory list.
//
dir_paths pc_dirs;
// Note that we rely on the "small function object" optimization here.
//
auto add_pc_dir = [&pc_dirs] (dir_path&& d) -> bool
{
pc_dirs.emplace_back (move (d));
return false;
};
pkgconfig_derive (libd, add_pc_dir);
for (const dir_path& d: top_usrd) pkgconfig_derive (d, add_pc_dir);
for (const dir_path& d: top_sysd) pkgconfig_derive (d, add_pc_dir);
bool pa (at != nullptr && !ap.empty ());
if (pa || sp.empty ())
apc = pkgconf (ap, pc_dirs, sys_lib_dirs, sys_hdr_dirs);
bool ps (st != nullptr && !sp.empty ());
if (ps || ap.empty ())
spc = pkgconf (sp, pc_dirs, sys_lib_dirs, sys_hdr_dirs);
// Sort out the interface dependencies (which we are setting on lib{}).
// If we have the shared .pc variant, then we use that. Otherwise --
// static but extract without the --static option (see also the saving
// logic).
//
pkgconf& ipc (ps ? spc : apc); // Interface package info.
parse_libs (
lt,
(ps ? st->mtime () : at->mtime ()) == timestamp_unreal /* binless */,
ipc,
false,
&prs);
if (pa)
{
parse_cflags (*at, apc, true);
parse_libs (*at, at->path ().empty (), apc, true, nullptr);
}
if (ps)
parse_cflags (*st, spc, false);
// Load the bin.whole flag (whole archive).
//
if (at != nullptr)
{
// Note that if unspecified we leave it unset letting the consumer
// override it, if necessary (see the bin.lib lookup semantics for
// details).
//
if (optional<string> v = (pa ? apc : spc).variable ("bin.whole"))
{
at->vars.assign ("bin.whole") = (*v == "true");
}
}
// For now we assume static and shared variants export the same set of
// modules/importable headers. While technically possible, having
// different sets will most likely lead to all sorts of complications
// (at least for installed libraries) and life is short.
//
if (modules)
{
parse_modules (ipc, prs);
// We treat headers outside of any project as C headers (see
// enter_header() for details).
//
parse_headers (ipc, h::static_type /* **x_hdr */, x, prs);
parse_headers (ipc, h::static_type, "c", prs);
}
assert (!lt.has_prerequisites ());
if (!prs.empty ())
lt.prerequisites (move (prs));
}
#else
pair<path, path> common::
pkgconfig_search (const dir_path&,
const optional<project_name>&,
const string&,
bool) const
{
return pair<path, path> ();
}
bool common::
pkgconfig_load (action,
const scope&,
lib&,
liba*,
libs*,
const optional<project_name>&,
const string&,
const dir_path&,
const dir_paths&,
const dir_paths&) const
{
return false;
}
void common::
pkgconfig_load (action,
const scope&,
lib&,
liba*,
libs*,
const pair<path, path>&,
const dir_path&,
const dir_paths&,
const dir_paths&) const
{
assert (false); // Should never be called.
}
#endif
// If common is true, generate a "best effort" (i.e., not guaranteed to be
// sufficient in all cases) common .pc file by ignoring any static/shared-
// specific poptions and splitting loptions/libs into Libs/Libs.private.
// Note that if both static and shared are being installed, the common
// file must be generated based on the static library to get accurate
// Libs.private.
//
void link_rule::
pkgconfig_save (action a,
const file& l,
bool la,
bool common,
bool binless) const
{
tracer trace (x, "pkgconfig_save");
context& ctx (l.ctx);
const scope& bs (l.base_scope ());
const scope& rs (*bs.root_scope ());
auto* t (find_adhoc_member<pc> (l, (common ? pc::static_type :
la ? pca::static_type :
/* */ pcs::static_type)));
assert (t != nullptr);
const path& p (t->path ());
// If we are uninstalling, skip regenerating the file if it already
// exists (I think we could have skipped this even if it doesn't exist,
// but let's keep things close to the install case).
//
if (ctx.current_action ().outer_operation () == uninstall_id)
{
if (exists (p))
return;
}
// This is the lib{} group if we are generating the common file and the
// target itself otherwise.
//
const file& g (common ? l.group->as<file> () : l);
// By default we assume things go into install.{include, lib}.
//
// If include.lib does not resolve, then assume this is update-for-
// install without actual install and remove the file if it exists.
//
// @@ Shouldn't we use target's install value rather than install.lib
// in case it gets installed into a custom location?
//
using install::resolve_dir;
dir_path ldir (resolve_dir (g,
cast<dir_path> (g["install.lib"]),
false /* fail_unknown */));
if (ldir.empty ())
{
rmfile (ctx, p, 3 /* verbosity */);
return;
}
dir_path idir (resolve_dir (g, cast<dir_path> (g["install.include"])));
// Note that generation can take some time if we have a large number of
// prerequisite libraries.
//
if (verb)
text << "pc " << *t;
else if (verb >= 2)
text << "cat >" << p;
if (ctx.dry_run)
return;
auto_rmfile arm (p);
try
{
ofdstream os (p);
{
const project_name& n (project (rs));
if (n.empty ())
fail << "no project name in " << rs;
lookup vl (rs.vars[ctx.var_version]);
if (!vl)
fail << "no version variable in project " << n <<
info << "while generating " << p;
const string& v (cast<string> (vl));
os << "Name: " << n << endl;
os << "Version: " << v << endl;
// This one is required so make something up if unspecified.
//
os << "Description: ";
if (const string* s = cast_null<string> (rs[ctx.var_project_summary]))
os << *s << endl;
else
os << n << ' ' << v << endl;
if (const string* u = cast_null<string> (rs[ctx.var_project_url]))
os << "URL: " << *u << endl;
}
auto save_poptions = [&g, &os] (const variable& var)
{
if (const strings* v = cast_null<strings> (g[var]))
{
for (auto i (v->begin ()); i != v->end (); ++i)
{
const string& o (*i);
// Filter out -I (both -I<dir> and -I <dir> forms).
//
if (o[0] == '-' && o[1] == 'I')
{
if (o.size () == 2)
++i;
continue;
}
os << ' ' << escape (o);
}
}
};
// Given a library target, return its -l-style library name.
//
auto save_library_target = [this] (const file& l) -> string
{
// If available (it may not, in case of import-installed libraris),
// use the .pc file name to derive the -l library name (in case of
// the shared library, l.path() may contain version).
//
string n;
auto strip_lib = [&n] ()
{
if (n.size () > 3 &&
path::traits_type::compare (n.c_str (), 3, "lib", 3) == 0)
n.erase (0, 3);
};
if (auto* t = find_adhoc_member<pc> (l))
{
// We also want to strip the lib prefix unless it is part of the
// target name while keeping custom library prefix/suffix, if any.
//
n = t->path ().leaf ().base ().base ().string ();
if (path::traits_type::compare (n.c_str (), n.size (),
l.name.c_str (), l.name.size ()) != 0)
strip_lib ();
}
else
{
const path& p (l.path ());
if (p.empty ()) // Binless.
{
// For a binless library the target name is all it can possibly
// be.
//
n = l.name;
}
else
{
// Derive -l-name from the file name in a fuzzy, platform-
// specific manner.
//
n = p.leaf ().base ().string ();
if (cclass != compiler_class::msvc)
strip_lib ();
}
}
return "-l" + n;
};
// Given a (presumably) compiler-specific library name, return its
// -l-style library name.
//
auto save_library_name = [this] (const string& n) -> string
{
if (tsys == "win32-msvc")
{
// Translate <name>.lib to -l<name>.
//
size_t p (path::traits_type::find_extension (n));
if (p != string::npos && icasecmp (n.c_str () + p + 1, "lib") == 0)
{
return "-l" + string (n, 0, p);
}
// Fall through and return as is.
}
return n;
};
// @@ TODO: support whole archive?
//
// Cflags.
//
os << "Cflags:";
os << " -I" << escape (idir.string ());
save_poptions (x_export_poptions);
save_poptions (c_export_poptions);
os << endl;
// Libs.
//
// While we generate split shared/static .pc files, in case of static
// we still want to sort things out into Libs/Libs.private. This is
// necessary to distinguish between interface and implementation
// dependencies if we don't have the shared variant (see the load
// logic for details). And also for the common .pc file, naturally.
//
{
os << "Libs:";
// While we don't need it for a binless library itselt, it may be
// necessary to resolve its binful dependencies.
//
os << " -L" << escape (ldir.string ());
// Now process ourselves as if we were being linked to something (so
// pretty similar to link_rule::append_libraries()). We also reuse
// the link_rule's machinery to suppress duplicates.
//
appended_libraries ls;
strings args;
bool priv (false);
struct data
{
ofdstream& os;
appended_libraries* pls; // Previous.
appended_libraries* ls; // Current.
strings& args;
} d {os, nullptr, &ls, args};
auto imp = [&priv] (const target&, bool la) {return priv && la;};
auto lib = [&d, &save_library_target, &save_library_name] (
const target* const* lc,
const small_vector<reference_wrapper<const string>, 2>& ns,
lflags,
const string*,
bool)
{
const file* l (lc != nullptr ? &(*lc)->as<file> () : nullptr);
// Suppress duplicates from the previous run (Libs/Libs.private
// split).
//
if (d.pls != nullptr)
{
// Doesn't feel like we can prune here: we may have seen this
// interface library but not its implementation dependencies.
//
if ((l != nullptr
? d.pls->find (*l)
: d.pls->find (ns)) != nullptr)
return true;
}
// Suppress duplicates (see append_libraries() for details).
//
// Note that we use the original name for duplicate tracking.
//
appended_library* al (l != nullptr
? &d.ls->append (*l, d.args.size ())
: d.ls->append (ns, d.args.size ()));
if (al != nullptr && al->end != appended_library::npos)
{
d.ls->hoist (d.args, *al);
return true;
}
if (l != nullptr)
{
if (l->is_a<libs> () || l->is_a<liba> ()) // See through libux.
d.args.push_back (save_library_target (*l));
}
else
{
// Something "system'y", save as is.
//
for (const string& n: ns)
d.args.push_back (save_library_name (n));
}
if (al != nullptr)
al->end = d.args.size (); // Close.
return true;
};
auto opt = [&d] (const target& lt, const string&, bool, bool)
{
const file& l (lt.as<file> ());
//@@ TODO: should we filter -L similar to -I?
//@@ TODO: how will the Libs/Libs.private work?
//@@ TODO: remember to use escape()
if (d.pls != nullptr && d.pls->find (l) != nullptr)
return true;
// See link_rule::append_libraries().
if (d.ls->append (l, d.args.size ()).end != appended_library::npos)
return true;
return true;
};
// Pretend we are linking an executable using what would be normal,
// system-default link order.
//
linfo li {otype::e, la ? lorder::a_s : lorder::s_a};
library_cache lib_cache;
process_libraries (a, bs, li, sys_lib_dirs,
l, la, 0, // Link flags.
imp, lib, opt, !binless /* self */, &lib_cache);
for (const string& a: args)
os << ' ' << a;
os << endl;
if (la)
{
os << "Libs.private:";
args.clear ();
priv = true;
// Use previous appended_libraries to weed out entries that are
// already in Libs.
//
appended_libraries als;
d.pls = d.ls;
d.ls = &als;
process_libraries (a, bs, li, sys_lib_dirs,
l, la, 0, // Link flags.
imp, lib, opt, false /* self */, &lib_cache);
for (const string& a: args)
os << ' ' << a;
os << endl;
// Save the bin.whole (whole archive) flag (see the link rule for
// details on the lookup semantics).
//
if (cast_false<bool> (
l.lookup_original (ctx.var_pool["bin.whole"],
true /* target_only */).first))
{
os << endl
<< "bin.whole = true"
<< endl;
}
}
}
// If we have modules and/or importable headers, list them in the
// respective variables. We also save some extra info about modules
// (yes, the rabbit hole runs deep). This code is pretty similar to
// compiler::search_modules().
//
// Note that we want to convey the importable headers information even
// if modules are not enabled.
//
{
struct module
{
string name;
path file;
string preprocessed;
bool symexport;
};
vector<module> mods;
// If we were to ever support another C-based language (e.g.,
// Objective-C) and libraries that can use a mix of languages (e.g.,
// C++ and Objective-C), then we would need to somehow reverse-
// lookup header target type to language. Let's hope we don't.
//
vector<path> x_hdrs;
vector<path> c_hdrs;
// We need to (recursively) see through libu*{}. See similar logic
// in search_modules().
//
// Note that the prerequisite targets are in the member, not the
// group (for now we don't support different sets of modules/headers
// for static/shared library; see load above for details).
//
auto collect = [a, this,
&mods,
&x_hdrs, &c_hdrs] (const target& l,
const auto& collect) -> void
{
for (const target* pt: l.prerequisite_targets[a])
{
if (pt == nullptr)
continue;
if (modules && pt->is_a<bmix> ())
{
// What we have is a binary module interface. What we need is
// a module interface source it was built from. We assume it's
// the first mxx{} target that we see.
//
const target* mt (nullptr);
for (const target* t: pt->prerequisite_targets[a])
{
if (t != nullptr && (mt = t->is_a (*x_mod)))
break;
}
// Can/should there be a bmi{} without mxx{}? Can't think of a
// reason.
//
assert (mt != nullptr);
path p (install::resolve_file (mt->as<file> ()));
if (p.empty ()) // Not installed.
continue;
string pp;
if (const string* v = cast_null<string> ((*mt)[x_preprocessed]))
pp = *v;
mods.push_back (
module {
cast<string> (pt->state[a].vars[c_module_name]),
move (p),
move (pp),
symexport});
}
else if (pt->is_a (**x_hdr) || pt->is_a<h> ())
{
if (cast_false<bool> ((*pt)[c_importable]))
{
path p (install::resolve_file (pt->as<file> ()));
if (p.empty ()) // Not installed.
continue;
(pt->is_a<h> () ? c_hdrs : x_hdrs).push_back (move (p));
}
}
// Note that in prerequisite targets we will have the libux{}
// members, not the group.
//
else if (pt->is_a<libux> ())
collect (*pt, collect);
}
};
collect (l, collect);
if (size_t n = mods.size ())
{
os << endl
<< "cxx_modules =";
// The partition separator (`:`) is not a valid character in the
// variable name. In fact, from the pkg-config source we can see
// that the only valid special characters in variable names are
// `_` and `.`. So to represent partition separators we use `..`,
// for example hello.print..impl. While in the variable values we
// can use `:`, for consistency we use `..` there as well.
//
for (module& m: mods)
{
size_t p (m.name.find (':'));
if (p != string::npos)
m.name.replace (p, 1, 2, '.');
// Module names shouldn't require escaping.
//
os << (n != 1 ? " \\\n" : " ")
<< m.name << '=' << escape (m.file.string ());
}
os << endl;
// Module-specific properties. The format is:
//
// <lang>_module_<property>.<module> = <value>
//
for (const module& m: mods)
{
if (!m.preprocessed.empty ())
os << "cxx_module_preprocessed." << m.name << " = "
<< m.preprocessed << endl;
if (m.symexport)
os << "cxx_module_symexport." << m.name << " = true" << endl;
}
}
if (size_t n = c_hdrs.size ())
{
os << endl
<< "c_importable_headers =";
for (const path& h: c_hdrs)
os << (n != 1 ? " \\\n" : " ") << escape (h.string ());
os << endl;
}
if (size_t n = x_hdrs.size ())
{
os << endl
<< x << "_importable_headers =";
for (const path& h: x_hdrs)
os << (n != 1 ? " \\\n" : " ") << escape (h.string ());
os << endl;
}
}
os.close ();
arm.cancel ();
}
catch (const io_error& e)
{
fail << "unable to write to " << p << ": " << e;
}
}
}
}
|