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 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083
|
// Copyright © 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016,
// 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024
// VladimÃr VondruÅ¡ <mosra@centrum.cz> and contributors
// Copyright © 2020-2024 Dan R.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
#pragma once
#include "Array.h"
#include <cstdlib>
#include <cstring>
// No __has_feature() on GCC: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=60512
// Using a dedicated macro instead: https://stackoverflow.com/a/34814667
#if !defined(DEATH_CONTAINERS_NO_SANITIZER_ANNOTATIONS)
# if defined(__has_feature)
# if __has_feature(address_sanitizer)
# define __DEATH_CONTAINERS_SANITIZER_ENABLED
# endif
# endif
# if defined(__SANITIZE_ADDRESS__)
# define __DEATH_CONTAINERS_SANITIZER_ENABLED
# endif
#endif
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
// https://github.com/llvm/llvm-project/blob/main/compiler-rt/include/sanitizer/common_interface_defs.h
extern "C" void __sanitizer_annotate_contiguous_container(const void* beg, const void* end, const void* old_mid, const void* new_mid)
// Declaration of this function in <vector> in MSVC 2022 14.35 and earlier STL includes a noexcept for some strange unexplained reason,
// which makes the signature differ from Clang's. See the PR comment here:
// https://github.com/microsoft/STL/pull/2071/commits/daa4db9bf10400678438d9c6b33630c7947e469e
// It got then subsequently removed, but without any additional explanation in the commit message nor links
// to corresponding bug reports and the STL repo has no tags or mapping to actual releases:
// https://github.com/microsoft/STL/pull/3164/commits/9f503ca22bcc32cd885184ea754ec4223759c431
// So I only accidentally discovered that this commit is in 14.36:
// https://developercommunity.visualstudio.com/t/__sanitizer_annotate_contiguous_containe/10119696
// The difference in noexcept is only a problem with `/std:c++17` (where noexcept becomes a part of the function signature) *and* with
// the `/permissive-` flag set, or `/std:c++20` alone (where the flag is implicitly enabled).
# if defined(DEATH_TARGET_DINKUMWARE) && _MSC_VER < 1936
noexcept
# endif
;
#endif
namespace Death { namespace Containers {
//###==##====#=====--==~--~=~- --- -- - - - -
namespace Implementation
{
enum : std::size_t {
DefaultAllocationAlignment =
// Emscripten has __STDCPP_DEFAULT_NEW_ALIGNMENT__ set to 16 but actually does just 8, so don't use this macro there:
// https://github.com/emscripten-core/emscripten/issues/10072
#if defined(__STDCPP_DEFAULT_NEW_ALIGNMENT__) && !defined(DEATH_TARGET_EMSCRIPTEN)
__STDCPP_DEFAULT_NEW_ALIGNMENT__
#else
2 * sizeof(std::size_t)
#endif
};
template<class T, typename std::enable_if<
/* Unlike with Array, where is_trivial is used instead of
is_trivially_constructible to work around issues on libstdc++ before
version 8, here such a case wouldn't compile anyway because it'd pick
the below overload which *needs* the default constructor to work anyway,
so it's less of a problem */
std::is_trivially_constructible<T>::value
, int>::type = 0>
inline void arrayConstruct(ValueInitT, T* const begin, T* const end) {
if (begin < end) std::memset(begin, 0, (end - begin) * sizeof(T));
}
template<class T, typename std::enable_if<!
/* Unlike with Array, where is_trivial is used instead of
is_trivially_constructible to work around issues on libstdc++ before
version 8, here such a case wouldn't compile anyway because it *needs*
the default constructor to work anyway, so it's less of a problem */
std::is_trivially_constructible<T>::value
, int>::type = 0>
inline void arrayConstruct(ValueInitT, T* begin, T* const end) {
/* Needs to be < because sometimes begin > end. The () instead of {} works
around a featurebug in C++ where new T{} doesn't work for an explicit defaulted constructor. */
for (; begin < end; ++begin) new(begin) T{};
}
template<class T> struct AllocatorTraits {
enum : std::size_t {
Offset = alignof(T) < sizeof(std::size_t) ? sizeof(std::size_t) :
(alignof(T) < Implementation::DefaultAllocationAlignment ?
alignof(T) : Implementation::DefaultAllocationAlignment)
};
};
}
/**
@brief New-based allocator for growable arrays
An @ref ArrayAllocator that allocates and deallocates memory using the C++
@cpp new[] @ce / @cpp delete[] @ce constructs, reserving an extra space
* *before* to store array capacity.
All reallocation operations expect that @p T is nothrow move-constructible.
*/
template<class T> struct ArrayNewAllocator {
typedef T Type; /**< Pointer type */
enum : std::size_t {
/** @copydoc ArrayMallocAllocator::AllocationOffset */
AllocationOffset = Implementation::AllocatorTraits<T>::Offset
};
/**
* @brief Allocate (but not construct) an array of given capacity
*
* @cpp new[] @ce-allocates a @cpp char @ce array with an extra space to
* store @p capacity *before* the front, returning it cast to @cpp T* @ce.
* The allocation is guaranteed to follow `T` allocation requirements up to
* the platform default allocation alignment.
*/
static T* allocate(std::size_t capacity) {
char* const memory = new char[capacity * sizeof(T) + AllocationOffset];
reinterpret_cast<std::size_t*>(memory)[0] = capacity;
return reinterpret_cast<T*>(memory + AllocationOffset);
}
/**
* @brief Reallocate an array to given capacity
*
* Calls @p allocate(), move-constructs @p prevSize elements from @p array
* into the new array, calls destructors on the original elements, calls
* @ref deallocate() and updates the @p array reference to point to the new
* array. The allocation is guaranteed to follow `T` allocation
* requirements up to the platform default allocation alignment.
*/
static void reallocate(T*& array, std::size_t prevSize, std::size_t newCapacity);
/**
* @brief Deallocate an array
*
* Calls @cpp delete[] @ce on a pointer offset by the extra space needed to
* store its capacity.
*/
static void deallocate(T* data) {
delete[](reinterpret_cast<char*>(data) - AllocationOffset);
}
/**
* @brief Grow an array
*
* If current occupied size (including the space needed to store capacity)
* is less than 64 bytes, the capacity always doubled, with the allocation
* being at least as large as @cpp __STDCPP_DEFAULT_NEW_ALIGNMENT__ @ce
* (*usually* @cpp 2*sizeof(std::size_t) @ce). After that, the capacity is
* increased to 1.5x of current capacity (again including the space needed
* to store capacity). This is similar to what MSVC STL does with
* @ref std::vector, except for libc++ / libstdc++, which both use a factor
* of 2. With a factor of 2 the allocation would crawl forward in memory,
* never able to reuse the holes after previous allocations, with a factor
* 1.5 it's possible after four reallocations. Further info in
* [Folly FBVector docs](https://github.com/facebook/folly/blob/master/folly/docs/FBVector.md#memory-handling).
*/
static std::size_t grow(T* array, std::size_t desired);
/**
* @brief Array capacity
*
* Retrieves the capacity that's stored *before* the front of the @p array.
*/
static std::size_t capacity(T* array) {
return *reinterpret_cast<std::size_t*>(reinterpret_cast<char*>(array) - AllocationOffset);
}
/**
* @brief Array base address
*
* Returns the address with @ref AllocationOffset subtracted.
*/
static void* base(T* array) {
return reinterpret_cast<char*>(array) - AllocationOffset;
}
/**
* @brief Array deleter
*
* Calls a destructor on @p size elements and then delegates into
* @ref deallocate().
*/
static void deleter(T* data, std::size_t size) {
for (T* it = data, *end = data + size; it != end; ++it) it->~T();
deallocate(data);
}
};
/**
@brief Malloc-based allocator for growable arrays
An @ref ArrayAllocator that allocates and deallocates memory using the C
@ref std::malloc() / @ref std::free() constructs in order to be able to use
@ref std::realloc() for fast reallocations. Similarly to @ref ArrayNewAllocator
it's reserving an extra space *before* to store array capacity.
All reallocation operations expect that @p T is trivially copyable. If it's
not, use @ref ArrayNewAllocator instead.
Compared to @ref ArrayNewAllocator, this allocator stores array capacity in
bytes and, together with the fact that @ref std::free() doesn't care about the
actual array type, growable arrays using this allocator can be freely cast to
different compatible types using @ref arrayAllocatorCast().
*/
template<class T> struct ArrayMallocAllocator {
static_assert(std::is_trivially_copyable<T>::value, "Only trivially copyable types are usable with this allocator");
typedef T Type; /**< Pointer type */
enum : std::size_t {
/**
* Offset at the beginning of the allocation to store allocation
* capacity. At least as large as @ref std::size_t. If the type
* alignment is larger than that (for example @cpp double @ce on a
* 32-bit platform), then it's equal to type alignment, but only at
* most as large as the default allocation alignment.
*/
AllocationOffset = Implementation::AllocatorTraits<T>::Offset
};
/**
* @brief Allocate an array of given capacity
*
* @ref std::malloc()'s an @cpp char @ce array with an extra space to store
* @p capacity *before* the front, returning it cast to @cpp T* @ce. The
* allocation is guaranteed to follow `T` allocation requirements up to the
* platform default allocation alignment.
*/
static T* allocate(std::size_t capacity) {
// Compared to ArrayNewAllocator, here the capacity is stored in bytes so it's possible to "reinterpret"
// the array into a different type (as the deleter is a typeless std::free() in any case)
const std::size_t inBytes = capacity * sizeof(T) + AllocationOffset;
char* const memory = static_cast<char*>(std::malloc(inBytes));
DEATH_ASSERT(memory != nullptr, ("Cannot allocate {} bytes", inBytes), {});
reinterpret_cast<std::size_t*>(memory)[0] = inBytes;
return reinterpret_cast<T*>(memory + AllocationOffset);
}
/**
* @brief Reallocate an array to given capacity
*
* Calls @ref std::realloc() on @p array (offset by the space to store
* capacity) and then updates the stored capacity to @p newCapacity and the
* @p array reference to point to the new (offset) location, in case the
* reallocation wasn't done in-place. The @p prevSize parameter is ignored,
* as @ref std::realloc() always copies the whole original capacity. The
* allocation is guaranteed to follow `T` allocation requirements up to the
* platform default allocation alignment.
*/
static void reallocate(T*& array, std::size_t prevSize, std::size_t newCapacity);
/**
* @brief Deallocate an array
*
* Calls @ref std::free() on a pointer offset by the extra space needed to
* store its capacity.
*/
static void deallocate(T* data) {
if (data != nullptr) std::free(reinterpret_cast<char*>(data) - AllocationOffset);
}
/**
* @brief Grow an array
*
* Behaves the same as @ref ArrayNewAllocator::grow().
*/
static std::size_t grow(T* array, std::size_t desired);
/**
* @brief Array capacity
*
* Retrieves the capacity that's stored *before* the front of the @p array.
*/
static std::size_t capacity(T* array) {
return (*reinterpret_cast<std::size_t*>(reinterpret_cast<char*>(array) - AllocationOffset) - AllocationOffset) / sizeof(T);
}
/**
* @brief Array base address
*
* Returns the address with @ref AllocationOffset subtracted.
*/
static void* base(T* array) {
return reinterpret_cast<char*>(array) - AllocationOffset;
}
/**
* @brief Array deleter
*
* Since the types have trivial destructors, directly delegates into
* @ref deallocate(). The @p size parameter is unused.
*/
static void deleter(T* data, std::size_t size) {
static_cast<void>(size);
deallocate(data);
}
};
#ifdef DOXYGEN_GENERATING_OUTPUT
/**
@brief Allocator for growable arrays
Is either @ref ArrayMallocAllocator for trivially copyable @p T, or
@ref ArrayNewAllocator otherwise, in which case reallocation operations expect
@p T to be nothrow move-constructible.
See @ref Containers-Array-growable for an introduction to growable arrays.
You can provide your own allocator by implementing a class that with @ref Type,
@ref allocate(), @ref reallocate(), @ref deallocate(), @ref grow(),
@ref capacity(), @ref base() and @ref deleter() following the documented
semantics.
*/
template<class T> struct ArrayAllocator {
typedef T Type; /**< Pointer type */
/**
* @brief Allocate (but not construct) an array of given capacity
*
* Implementations are expected to store the @p capacity in a way that
* makes it possible to retrieve it later via @ref capacity().
*/
static T* allocate(std::size_t capacity);
/**
* @brief Reallocate an array to given capacity
*
* Assumes @p array was returned earlier by @ref allocate() or
* @ref reallocate(). Implementations are expected to either extend
* @p array in-place to @p newCapacity or allocate a new array with
* @p newCapacity, move @p prevSize elements from @p array to it and call
* destructors on their original location, deallocate the @p array and
* update the reference to point to the new memory.
*/
static void reallocate(T*& array, std::size_t prevSize, std::size_t newCapacity);
/**
* @brief Deallocate (but not destruct) an array
*
* Assumes that @p data was returned earlier by @ref allocate() or
* @ref reallocate(). Implementations are expected to free all memory
* associated with @p data.
*/
static void deallocate(T* data);
/**
* @brief Grow an array
*
* Assumes that @p array is either @cpp nullptr @ce or was returned earlier
* by @ref allocate() or @ref reallocate(). Implementations are expected to
* return a new capacity with an an optimal tradeoff between reallocation
* count and memory usage, the value then being passed to
* @ref reallocate().
*
* See documentation of a particular implementation (such as
* @ref ArrayNewAllocator::grow()) for details about growth strategy.
*/
static std::size_t grow(T* array, std::size_t desired);
/**
* @brief Array capacity
*
* Implementations are expected to retrieve the capacity information from
* @p array.
*/
static std::size_t capacity(T* array);
/**
* @brief Array base address
*
* Returns base address of the allocation backing @p array. For use by
* Address Sanitizer to annotate which area of the allocation is safe to
* access and which not.
*/
static void* base(T* array);
/**
* @brief Array deleter
*
* Passed as a function pointer into @ref Array. Calls destructors on
* @p size elements and delegates into @ref deallocate(). The deleter
* function pointer is used to distinguish if given array is using this
* particular allocator --- you might want to turn this function into an
* exported symbol when growing arrays across shared library boundaries to
* avoid each library thinking it's using some other allocator and
* reallocating on each addition.
*/
static void deleter(T* data, std::size_t size);
};
#else
template<class T> using ArrayAllocator = typename std::conditional<std::is_trivially_copyable<T>::value,
ArrayMallocAllocator<T>, ArrayNewAllocator<T>>::type;
#endif
/**
@brief Reinterpret-cast a growable array
If the array is growable using @ref ArrayMallocAllocator (which is aliased to
@ref ArrayAllocator for all trivially-copyable types), the deleter is a simple
call to a typeless @ref std::free(). This makes it possible to change the array
type without having to use a different deleter, losing the growable property in
the process.
Equivalently to @ref arrayCast(), the size of the new array is calculated as
@cpp view.size()*sizeof(T)/sizeof(U) @ce. Expects that both types are
trivially copyable and [standard layout](http://en.cppreference.com/w/cpp/concept/StandardLayoutType)
and the total byte size doesn't change.
*/
template<class U, class T> Array<U> arrayAllocatorCast(Array<T>&& array);
/** @overload */
template<class U, template<class> class Allocator, class T> Array<U> arrayAllocatorCast(Array<T>&& array) {
static_assert(std::is_standard_layout<T>::value, "The source type is not standard layout");
static_assert(std::is_standard_layout<U>::value, "The target type is not standard layout");
static_assert(std::is_trivially_copyable<T>::value && std::is_trivially_copyable<U>::value, "Only trivially copyable types can use the allocator cast");
// If the array is default-constructed or just generally empty with the default deleter, just pass it through without changing anything.
// This behavior is consistent with calling `arrayResize(array, 0)`, `arrayReserve(array, 0)` and such, which also just pass empty arrays
// through without affecting their deleter.
if (array.isEmpty() && !array.data() && !array.deleter())
return {};
// Unlike arrayInsert() etc, this is not called that often and should be as checked as possible, so it's not a debug assert
DEATH_ASSERT(array.deleter() == Allocator<T>::deleter && (std::is_base_of<ArrayMallocAllocator<T>, Allocator<T>>::value),
"The array has to use the ArrayMallocAllocator or a derivative", {});
const std::size_t size = array.size() * sizeof(T) / sizeof(U);
DEATH_ASSERT(size * sizeof(U) == array.size() * sizeof(T),
("Cannot reinterpret {} {}-byte items into a {}-byte type", array.size(), sizeof(T), sizeof(U)), {});
return Array<U>{reinterpret_cast<U*>(array.release()), size, Allocator<U>::deleter};
}
template<class U, class T> Array<U> arrayAllocatorCast(Array<T>&& array) {
return arrayAllocatorCast<U, ArrayAllocator, T>(Death::move(array));
}
/**
@brief Whether an array is growable
Returns @cpp true @ce if the array is growable and using given @p Allocator,
@cpp false @ce otherwise. Note that even non-growable arrays are usable with
the @ref arrayAppend(), @ref arrayReserve(), ... family of utilities --- these
will reallocate the array using provided allocator if needed.
*/
template<class T, class Allocator = ArrayAllocator<T>> bool arrayIsGrowable(Array<T>& array);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class T> class Allocator, class T> inline bool arrayIsGrowable(Array<T>& array) {
return arrayIsGrowable<T, Allocator<T>>(array);
}
#endif
/**
@brief Array capacity
For a growable array using given @p Allocator returns its capacity, otherwise
returns @ref Array::size().
This function is equivalent to calling @relativeref{std::vector,capacity()} on
a @ref std::vector.
*/
template<class T, class Allocator = ArrayAllocator<T>> std::size_t arrayCapacity(Array<T>& array);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class T> class Allocator, class T> inline std::size_t arrayCapacity(Array<T>& array) {
return arrayCapacity<T, Allocator<T>>(array);
}
#endif
/**
@brief Reserve given capacity in an array
@return New capacity of the array
If @p array capacity is already large enough, the function returns the current
capacity. Otherwise the memory is reallocated to desired @p capacity, with the
@ref Array::size() staying the same, and @p capacity returned back. Note that
in case the array is non-growable of sufficient size, it's kept as such,
without being reallocated to a growable version.
Complexity is at most @f$ \mathcal{O}(n) @f$ in the size of the original
container, @f$ \mathcal{O}(1) @f$ if the capacity is already large enough or
if the reallocation can be done in-place. On top of what the @p Allocator (or
the default @ref ArrayAllocator) itself needs, @p T is required to be nothrow
move-constructible and move-assignable.
This function is equivalent to calling @relativeref{std::vector,reserve()} on
a @ref std::vector.
*/
template<class T, class Allocator = ArrayAllocator<T>> std::size_t arrayReserve(Array<T>& array, std::size_t capacity);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class T> class Allocator, class T> inline std::size_t arrayReserve(Array<T>& array, std::size_t capacity) {
return arrayReserve<T, Allocator<T>>(array, capacity);
}
#endif
/**
@brief Resize an array to given size, value-initializing new elements
If the array is growable and capacity is large enough, calls a destructor on
elements that get cut off the end (if any, and if @p T is not trivially
destructible, in which case nothing is done) and returns. Otherwise, the memory
is reallocated to desired @p size. After that, new elements at the end of the
array are value-initialized (i.e., zero-initialized for trivial types and using
placement new otherwise). Note that in case the array is non-growable of
exactly the requested size, it's kept as such, without being reallocated to a
growable version.
Complexity is at most @f$ \mathcal{O}(n) @f$ in the size of the new container,
@f$ \mathcal{O}(1) @f$ if current container size is already exactly of given
size. On top of what the @p Allocator (or the default @ref ArrayAllocator)
itself needs, @p T is required to be nothrow move-constructible and
default-constructible.
*/
template<class T, class Allocator = ArrayAllocator<T>> void arrayResize(Array<T>& array, ValueInitT, std::size_t size);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline void arrayResize(Array<T>& array, ValueInitT, std::size_t size) {
arrayResize<T, Allocator<T>>(array, ValueInit, size);
}
#endif
/**
@brief Resize an array to given size, value-initializing new elements
Alias to @ref arrayResize(Array<T>&, ValueInitT, std::size_t).
This function is equivalent to calling @relativeref{std::vector,resize()} on
a @ref std::vector.
*/
template<class T, class Allocator = ArrayAllocator<T>> inline void arrayResize(Array<T>& array, std::size_t size) {
return arrayResize<T, Allocator>(array, ValueInit, size);
}
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline void arrayResize(Array<T>& array, std::size_t size) {
arrayResize<T, Allocator<T>>(array, size);
}
#endif
/**
@brief Resize an array to given size, keeping new elements uninitialized
Similar to @ref arrayResize(Array<T>&, ValueInitT, std::size_t) except that
the new elements at the end are not value-initialized, but left in an
uninitialized state instead. I.e., placement-new is meant to be used on *all*
newly added elements with a non-trivially-copyable @p T.
On top of what the @p Allocator (or the default @ref ArrayAllocator) itself
needs, @p T is required to be nothrow move-constructible.
*/
template<class T, class Allocator = ArrayAllocator<T>> void arrayResize(Array<T>& array, NoInitT, std::size_t size);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline void arrayResize(Array<T>& array, NoInitT, std::size_t size) {
arrayResize<T, Allocator<T>>(array, NoInit, size);
}
#endif
/**
@brief Resize an array to given size, constructing new elements using provided arguments
Similar to @ref arrayResize(Array<T>&, ValueInitT, std::size_t) except that
the new elements at the end are constructed using placement-new with provided
@p args.
On top of what the @p Allocator (or the default @ref ArrayAllocator) itself
needs, @p T is required to be nothrow move-constructible and constructible from
provided @p args.
*/
template<class T, class ...Args> void arrayResize(Array<T>& array, DirectInitT, std::size_t size, Args&&... args);
/** @overload */
template<class T, class Allocator, class ...Args> void arrayResize(Array<T>& array, DirectInitT, std::size_t size, Args&&... args);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T, class ...Args> inline void arrayResize(Array<T>& array, DirectInitT, std::size_t size, Args&&... args) {
arrayResize<T, Allocator<T>>(array, DirectInit, size, Death::forward<Args>(args)...);
}
#endif
/**
@brief Resize an array to given size, copy-constructing new elements using the provided value
Calls @ref arrayResize(Array<T>&, DirectInitT, std::size_t, Args&&... args)
with @p value.
This function is equivalent to calling @relativeref{std::vector,resize()} on
a @ref std::vector.
*/
template<class T, class Allocator = ArrayAllocator<T>> inline void arrayResize(Array<T>& array, std::size_t size, const typename std::common_type<T>::type& value) {
arrayResize<T, Allocator>(array, DirectInit, size, value);
}
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline void arrayResize(Array<T>& array, std::size_t size, const typename std::common_type<T>::type& value) {
arrayResize<T, Allocator<T>>(array, size, value);
}
#endif
/**
@brief Copy-append an item to an array
@return Reference to the newly appended item
If the array is not growable or the capacity is not large enough, the array
capacity is grown first according to rules described in the
@ref ArrayAllocator::grow() "grow()" function of a particular allocator. Then,
@p value is copy-constructed at the end of the array and @ref Array::size()
increased by 1.
Amortized complexity is @f$ \mathcal{O}(1) @f$ providing the allocator growth
ratio is exponential. On top of what the @p Allocator (or the default
@ref ArrayAllocator) itself needs, @p T is required to be nothrow
move-constructible and copy-constructible.
To have the append operation as performant as possible, the @p value
reference is expected to *not* point inside @p array. If you need to append
values from within the array itself, use the list-taking
@ref arrayAppend(Array<T>&, typename std::common_type<ArrayView<const T>>::type)
overload, which handles this case.
This function is equivalent to calling @relativeref{std::vector,push_back()} on
a @ref std::vector.
*/
template<class T, class Allocator = ArrayAllocator<T>> T& arrayAppend(Array<T>& array, const typename std::common_type<T>::type& value);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline T& arrayAppend(Array<T>& array, const typename std::common_type<T>::type& value) {
return arrayAppend<T, Allocator<T>>(array, value);
}
#endif
/**
@brief In-place append an item to an array
@return Reference to the newly appended item
Similar to @ref arrayAppend(Array<T>&, const typename std::common_type<T>::type&)
except that the new element is constructed using placement-new with provided
@p args.
On top of what the @p Allocator (or the default @ref ArrayAllocator) itself
needs, @p T is required to be nothrow move-constructible and constructible from
provided @p args.
The behavior is undefined if any @p args are pointing inside the @p array
items or their internals as the implementation has no way to check for such
scenario. If you want to have robust checks against such cases, use the
@ref arrayAppend(Array<T>&, const typename std::common_type<T>::type&),
@ref arrayAppend(Array<T>&, typename std::common_type<T>::type&&)
overloads which perform a copy or move instead of an in-place construction,
or the list-taking @ref arrayAppend(Array<T>&, typename std::common_type<ArrayView<const T>>::type)
which detects and appropriately adjusts the view in case it's a
slice of the @p array itself.
This function is equivalent to calling @relativeref{std::vector,emplace_back()}
on a @ref std::vector.
*/
template<class T, class ...Args> T& arrayAppend(Array<T>& array, InPlaceInitT, Args&&... args);
/** @overload */
template<class T, class Allocator, class ...Args> T& arrayAppend(Array<T>& array, InPlaceInitT, Args&&... args);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T, class ...Args> inline T& arrayAppend(Array<T>& array, InPlaceInitT, Args&&... args) {
return arrayAppend<T, Allocator<T>>(array, InPlaceInit, Death::forward<Args>(args)...);
}
#endif
/**
@brief Move-append an item to an array
@return Reference to the newly appended item
Calls @ref arrayAppend(Array<T>&, InPlaceInitT, Args&&... args) with @p value.
To have the append operation as performant as possible, the @p value
reference is expected to *not* point inside @p array. If you need to
move-append values from within the array itself, move them to a temporary
location first.
*/
template<class T, class Allocator = ArrayAllocator<T>> inline T& arrayAppend(Array<T>& array, typename std::common_type<T>::type&& value) {
DEATH_DEBUG_ASSERT(std::size_t(&value - array.data()) >= (arrayCapacity<T, Allocator>(array)),
"Use the list variant to append values from within the array itself", *array.data());
return arrayAppend<T, Allocator>(array, InPlaceInit, Death::move(value));
}
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline T& arrayAppend(Array<T>& array, typename std::common_type<T>::type&& value) {
return arrayAppend<T, Allocator<T>>(array, InPlaceInit, Death::move(value));
}
#endif
/**
@brief Copy-append a list of items to an array
@return View on the newly appended items
Like @ref arrayAppend(Array<T>&, const typename std::common_type<T>::type&),
but inserting multiple values at once.
On top of what the @p Allocator (or the default @ref ArrayAllocator) itself
needs, @p T is required to be nothrow move-constructible and
copy-constructible.
Compared to the single-value @ref arrayAppend(Array<T>&, const typename std::common_type<T>::type&),
this function also handles the case where @p values are a slice of the @p array
itself. In particular, if the @p array needs to be reallocated in order to fit
the new items, the @p arrayvalues to append are then copied from the new location.
*/
template<class T, class Allocator = ArrayAllocator<T>> ArrayView<T> arrayAppend(Array<T>& array, typename std::common_type<ArrayView<const T>>::type values);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline ArrayView<T> arrayAppend(Array<T>& array, typename std::common_type<ArrayView<const T>>::type values) {
return arrayAppend<T, Allocator<T>>(array, values);
}
#endif
/** @overload */
template<class T, class Allocator = ArrayAllocator<T>> inline ArrayView<T> arrayAppend(Array<T>& array, std::initializer_list<typename std::common_type<T>::type> values) {
return arrayAppend<T, Allocator>(array, arrayView(values));
}
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline ArrayView<T> arrayAppend(Array<T>& array, std::initializer_list<typename std::common_type<T>::type> values) {
return arrayAppend<T, Allocator<T>>(array, values);
}
#endif
/**
@brief Append given count of value-initialized values to an array
@return View on the newly appended items
A variant of @ref arrayAppend(Array<T>&, typename std::common_type<ArrayView<const T>>::type)
where the new values are value-initialized (i.e., trivial types
zero-initialized and default constructor called otherwise), instead of being
copied from a pre-existing location.
On top of what the @p Allocator (or the default @ref ArrayAllocator) itself
needs, @p T is required to be nothrow move-constructible and
default-constructible.
*/
template<class T, class Allocator = ArrayAllocator<T>> ArrayView<T> arrayAppend(Array<T>& array, ValueInitT, std::size_t count);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline ArrayView<T> arrayAppend(Array<T>& array, ValueInitT, std::size_t count) {
return arrayAppend<T, Allocator<T>>(array, ValueInit, count);
}
#endif
/**
@brief Append given count of uninitialized values to an array
@return View on the newly appended items
A variant of @ref arrayAppend(Array<T>&, ValueInitT, std::size_t) where the new
values are left uninitialized --- i.e., placement-new is meant to be used on
* *all* appended elements with a non-trivially-copyable @p T.
On top of what the @p Allocator (or the default @ref ArrayAllocator) itself
needs, @p T is required to be nothrow move-constructible.
*/
template<class T, class Allocator = ArrayAllocator<T>> ArrayView<T> arrayAppend(Array<T>& array, NoInitT, std::size_t count);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline ArrayView<T> arrayAppend(Array<T>& array, NoInitT, std::size_t count) {
return arrayAppend<T, Allocator<T>>(array, NoInit, count);
}
#endif
/**
@brief Append given count of values to an array, constructing each using provided arguments
@return View on the newly appended items
Similar to @ref arrayAppend(Array<T>&, ValueInitT, std::size_t) except that
the elements are constructed using placement-new with provided @p args.
On top of what the @p Allocator (or the default @ref ArrayAllocator) itself
needs, @p T is required to be nothrow move-constructible and constructible from
provided @p args.
*/
template<class T, class ...Args> ArrayView<T> arrayAppend(Array<T>& array, DirectInitT, std::size_t count, Args&&... args);
/** @overload */
template<class T, class Allocator, class ...Args> ArrayView<T> arrayAppend(Array<T>& array, DirectInitT, std::size_t count, Args&&... args);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T, class ...Args> inline ArrayView<T> arrayAppend(Array<T>& array, DirectInitT, std::size_t count, Args&&... args) {
return arrayAppend<T, Allocator<T>>(array, DirectInit, count, Death::forward<Args>(args)...);
}
#endif
/**
@brief Copy-insert an item into an array
@return Reference to the newly inserted item
Expects that @p index is not larger than @ref Array::size(). If the array is
not growable or the capacity is not large enough, the array capacity is grown
first according to rules described in the
@ref ArrayAllocator::grow() "grow()" function of a particular allocator. Then,
items starting at @p index are moved one item forward, @p value is copied to
@p index and @ref Array::size() is increased by 1.
Amortized complexity is @f$ \mathcal{O}(n) @f$. On top of what the @p Allocator
(or the default @ref ArrayAllocator) itself needs, @p T is required to be
nothrow move-constructible, nothrow move-assignable and copy-constructible.
To have the insert operation as performant as possible, the @p value
reference is expected to *not* point inside @p array. If you need to insert
values from within the array itself, use the list-taking
@ref arrayInsert(Array<T>&, std::size_t, typename std::common_type<ArrayView<const T>>::type)
overload, which handles this case.
This function is equivalent to calling @relativeref{std::vector,insert()} on
a @ref std::vector.
*/
template<class T, class Allocator = ArrayAllocator<T>> T& arrayInsert(Array<T>& array, std::size_t index, const typename std::common_type<T>::type& value);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> T& arrayInsert(Array<T>& array, std::size_t index, const typename std::common_type<T>::type& value) {
return arrayInsert<T, Allocator<T>>(array, index, value);
}
#endif
/**
@brief In-place insert an item into an array
@return Reference to the newly inserted item
Similar to @ref arrayInsert(Array<T>&, std::size_t, const typename std::common_type<T>::type&)
except that the new element is constructed using placement-new with provided
@p args.
On top of what the @p Allocator (or the default @ref ArrayAllocator) itself
needs, @p T is required to be nothrow move-constructible, nothrow
move-assignable and constructible from provided @p args.
The behavior is undefined if any @p args are pointing inside the @p array
items or their internals as the implementation has no way to check for such
scenario. If you want to have robust checks against such cases, use the
@ref arrayInsert(Array<T>&, std::size_t, const typename std::common_type<T>::type&),
@ref arrayInsert(Array<T>&, std::size_t, typename std::common_type<T>::type&&)
overloads which perform a copy or move instead of an in-place construction,
or the list-taking @ref arrayInsert(Array<T>&, std::size_t, typename std::common_type<ArrayView<const T>>::type)
which detects and appropriately adjusts the view in case it's a slice of
the @p array itself.
This function is equivalent to calling @relativeref{std::vector,emplace()}
on a @ref std::vector.
*/
template<class T, class ...Args> T& arrayInsert(Array<T>& array, std::size_t index, InPlaceInitT, Args&&... args);
/** @overload */
template<class T, class Allocator, class ...Args> T& arrayInsert(Array<T>& array, std::size_t index, InPlaceInitT, Args&&... args);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T, class ...Args> T& arrayInsert(Array<T>& array, std::size_t index, InPlaceInitT, Args&&... args) {
return arrayInsert<T, Allocator<T>>(array, index, Death::forward<Args>(args)...);
}
#endif
/**
@brief Move-insert an item into an array
@return Reference to the newly appended item
Calls @ref arrayInsert(Array<T>&, std::size_t, InPlaceInitT, Args&&... args)
with @p value.
To have the insert operation as performant as possible, the @p value
reference is expected to *not* point inside @p array. If you need to
move-insert values from within the array itself, move them to a temporary
location first.
*/
template<class T, class Allocator = ArrayAllocator<T>> inline T& arrayInsert(Array<T>& array, std::size_t index, typename std::common_type<T>::type&& value) {
DEATH_DEBUG_ASSERT(std::size_t(&value - array.data()) >= (arrayCapacity<T, Allocator>(array)),
"Use the list variant to insert values from within the array itself", *array.data());
return arrayInsert<T, Allocator>(array, index, InPlaceInit, Death::move(value));
}
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline T& arrayInsert(Array<T>& array, std::size_t index, typename std::common_type<T>::type&& value) {
return arrayInsert<T, Allocator<T>>(array, index, InPlaceInit, Death::move(value));
}
#endif
/**
@brief Copy-insert a list of items into an array
@return View on the newly appended items
Like @ref arrayInsert(Array<T>&, std::size_t, const typename std::common_type<T>::type&),
but inserting multiple values at once.
Amortized complexity is @f$ \mathcal{O}(m + n) @f$, where @f$ m @f$ is the
number of items being inserted and @f$ n @f$ is the existing array size. On top
of what the @p Allocator (or the default @ref ArrayAllocator) itself needs,
@p T is required to be nothrow move-constructible, nothrow move-assignable and
copy-constructible.
Compared to the single-value @ref arrayInsert(Array<T>&, std::size_t, const typename std::common_type<T>::type&),
this function also handles the case where @p values are a slice of the @p array
itself. In particular, if the @p array needs to be reallocated in order to fit
the new items, the @p values to insert are then copied from the new location.
It's however expected that the slice and @p index don't overlap --- in that
case the caller has to handle that on its own, such as by splitting the
insertion in two.
*/
template<class T, class Allocator = ArrayAllocator<T>> ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, typename std::common_type<ArrayView<const T>>::type values);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, typename std::common_type<ArrayView<const T>>::type values) {
return arrayInsert<T, Allocator<T>>(array, index, values);
}
#endif
/** @overload */
template<class T, class Allocator = ArrayAllocator<T>> ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, std::initializer_list<typename std::common_type<T>::type> values) {
return arrayInsert<T, Allocator>(array, index, arrayView(values));
}
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, std::initializer_list<typename std::common_type<T>::type> values) {
return arrayInsert<T, Allocator<T>>(array, index, values);
}
#endif
/**
@brief Insert given count of value-initialized values into an array
@return View on the newly inserted items
A variant of @ref arrayInsert(Array<T>&, std::size_t, typename std::common_type<ArrayView<const T>>::type)
where the new values are value-initialized (i.e., trivial types
zero-initialized and default constructor called otherwise), instead of being
copied from a pre-existing location.
Amortized complexity is @f$ \mathcal{O}(m + n) @f$, where @f$ m @f$ is the
number of items being inserted and @f$ n @f$ is the existing array size. On top
of what the @p Allocator (or the default @ref ArrayAllocator) itself needs,
@p T is required to be nothrow move-constructible, nothrow move-assignable and
default-constructible.
*/
template<class T, class Allocator = ArrayAllocator<T>> ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, ValueInitT, std::size_t count);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, ValueInitT, std::size_t count) {
return arrayInsert<T, Allocator<T>>(array, index, ValueInit, count);
}
#endif
/**
@brief Insert given count of uninitialized values into an array
@return View on the newly inserted items
A variant of @ref arrayInsert(Array<T>&, std::size_t, ValueInitT, std::size_t)
where the new values are left uninitialized. Independently of whether the array
was reallocated to fit the new items or the items were just shifted around
because the capacity was large enough, the new values are always uninitialized
--- i.e., placement-new is meant to be used on *all* inserted elements with a
non-trivially-copyable @p T.
Amortized complexity is @f$ \mathcal{O}(n) @f$, where @f$ n @f$ is the existing
array size. On top of what the @p Allocator (or the default @ref ArrayAllocator)
itself needs, @p T is required to be nothrow move-constructible and nothrow
move-assignable.
*/
template<class T, class Allocator = ArrayAllocator<T>> ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, NoInitT, std::size_t count);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, NoInitT, std::size_t count) {
return arrayInsert<T, Allocator<T>>(array, index, NoInit, count);
}
#endif
/**
@brief Insert given count of values into an array, constructing each using provided arguments
@return View on the newly inserted items
Similar to @ref arrayInsert(Array<T>&, std::size_t, ValueInitT, std::size_t)
except that the elements are constructed using placement-new with provided
@p args.
On top of what the @p Allocator (or the default @ref ArrayAllocator)
itself needs, @p T is required to be nothrow move-constructible, nothrow
move-assignable and constructible from provided @p args.
*/
template<class T, class ...Args> ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, DirectInitT, std::size_t count, Args&&... args);
/** @overload */
template<class T, class Allocator, class ...Args> ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, DirectInitT, std::size_t count, Args&&... args);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T, class ...Args> inline ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, DirectInitT, std::size_t count, Args&&... args) {
return arrayInsert<T, Allocator<T>>(array, index, DirectInit, count, Death::forward<Args>(args)...);
}
#endif
/**
@brief Remove an element from an array
Expects that @cpp index + count @ce is not larger than @ref Array::size(). If
the array is not growable, all elements except the removed ones are reallocated
to a growable version. Otherwise, items starting at @cpp index + count @ce are
moved @cpp count @ce items backward and the @ref Array::size() is decreased by
@p count.
Amortized complexity is @f$ \mathcal{O}(m + n) @f$ where @f$ m @f$ is the
number of items being removed and @f$ n @f$ is the array size after removal. On
top of what the @p Allocator (or the default @ref ArrayAllocator) itself needs,
@p T is required to be nothrow move-constructible and nothrow move-assignable.
This function is equivalent to calling @relativeref{std::vector,erase()} on a
@ref std::vector.
*/
template<class T, class Allocator = ArrayAllocator<T>> void arrayRemove(Array<T>& array, std::size_t index, std::size_t count = 1);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline void arrayRemove(Array<T>& array, std::size_t index, std::size_t count = 1) {
arrayRemove<T, Allocator<T>>(array, index, count);
}
#endif
/**
@brief Remove an element from an unordered array
A variant of @ref arrayRemove() that is more efficient in case the order of
items in the array doesn't have to be preserved. Expects that
@cpp index + count @ce is not larger than @ref Array::size(). If the array is
not growable, all elements except the removed ones are reallocated to a
growable version. Otherwise, the last @cpp min(count, array.size() - index - count) @ce
items are moved over the items at @p index and the @ref Array::size() is
decreased by @p count.
Amortized complexity is @f$ \mathcal{O}(m) @f$ where @f$ m @f$ is the number of
items being removed. On top of what the @p Allocator (or the default
@ref ArrayAllocator) itself needs, @p T is required to be nothrow
move-constructible and nothrow move-assignable.
*/
template<class T, class Allocator = ArrayAllocator<T>> void arrayRemoveUnordered(Array<T>& array, std::size_t index, std::size_t count = 1);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline void arrayRemoveUnordered(Array<T>& array, std::size_t index, std::size_t count = 1) {
arrayRemoveUnordered<T, Allocator<T>>(array, index, count);
}
#endif
/**
@brief Remove a suffix from an array
Expects that @p count is not larger than @ref Array::size(). If the array is
not growable, all its elements except the removed suffix are reallocated to a
growable version. Otherwise, a destructor is called on removed elements and the
@ref Array::size() is decreased by @p count.
Amortized complexity is @f$ \mathcal{O}(m) @f$ where @f$ m @f$ is the number of
items removed. On top of what the @p Allocator (or the default
@ref ArrayAllocator) itself needs, @p T is required to be nothrow
move-constructible.
With @p count set to @cpp 1 @ce, this function is equivalent to calling
@relativeref{std::vector,pop_back()} on a @ref std::vector.
*/
template<class T, class Allocator = ArrayAllocator<T>> void arrayRemoveSuffix(Array<T>& array, std::size_t count = 1);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline void arrayRemoveSuffix(Array<T>& array, std::size_t count = 1) {
arrayRemoveSuffix<T, Allocator<T>>(array, count);
}
#endif
/**
@brief Clear an array
If the array is not growable, it's replaced by an empty instance, freeing its
contents as a whole. Otherwise a destructor is called on all existing elements
and the @ref Array::size() is set to @cpp 0 @ce, with @ref arrayCapacity()
staying the same as before.
Amortized complexity is @f$ \mathcal{O}(n) @f$ where @f$ n @f$ is the number of
items in the array. On top of what the @p Allocator (or the default
@ref ArrayAllocator) itself needs, @p T is required to be nothrow
move-constructible.
This function is equivalent to calling @relativeref{std::vector,clear()} on a
@ref std::vector.
@m_keywords{clear()}
*/
template<class T, class Allocator = ArrayAllocator<T>> void arrayClear(Array<T>& array);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline void arrayClear(Array<T>& array) {
arrayClear<T, Allocator<T>>(array);
}
#endif
/**
@brief Convert an array back to non-growable
Allocates a @ref NoInit array that's exactly large enough to fit
@ref Array::size() elements, move-constructs the elements there and frees the
old memory using @ref Array::deleter(). If the array is not growable using
given @p Allocator, it's assumed to be already as small as possible, and
nothing is done.
Complexity is at most @f$ \mathcal{O}(n) @f$ in the size of the container,
@f$ \mathcal{O}(1) @f$ if the array is already non-growable. No constraints
on @p T from @p Allocator (or the default @ref ArrayAllocator) apply here but
@p T is required to be nothrow move-constructible.
This function is equivalent to calling @relativeref{std::vector,shrink_to_fit()}
on a @ref std::vector.
*/
template<class T, class Allocator = ArrayAllocator<T>> void arrayShrink(Array<T>& array, NoInitT = NoInit);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline void arrayShrink(Array<T>& array, NoInitT = NoInit) {
arrayShrink<T, Allocator<T>>(array, NoInit);
}
#endif
/**
@brief Convert an array back to non-growable using a value initialization
Allocates a @ref ValueInit array that's exactly large enough
to fit @ref Array::size() elements, move-assigns the elements there and frees
the old memory using @ref Array::deleter(). If the array is not growable using
given @p Allocator, it's assumed to be already as small as possible, and
nothing is done.
Complexity is at most @f$ \mathcal{O}(n) @f$ in the size of the container,
@f$ \mathcal{O}(1) @f$ if the array is already non-growable. No constraints on
@p T from @p Allocator (or the default @ref ArrayAllocator) apply here but @p T
is required to be default-constructible and nothrow move-assignable.
Compared to @ref arrayShrink(Array<T>&, NoInitT), the resulting array instance
always has a default (@cpp nullptr @ce) deleter. This is useful when it's not
possible to use custom deleters, such as in plugin implementations.
*/
template<class T, class Allocator = ArrayAllocator<T>> void arrayShrink(Array<T>& array, ValueInitT);
#ifndef DOXYGEN_GENERATING_OUTPUT
/**
@overload
Convenience overload allowing to specify just the allocator template, with
array type being inferred.
*/
template<template<class> class Allocator, class T> inline void arrayShrink(Array<T>& array, ValueInitT) {
arrayShrink<T, Allocator<T>>(array, ValueInit);
}
#endif
namespace Implementation
{
// Used to avoid calling getter functions to speed up debug builds
template<class T> struct ArrayGuts {
T* data;
std::size_t size;
void(*deleter)(T*, std::size_t);
};
template<class T, typename std::enable_if<std::is_trivially_copyable<T>::value, int>::type = 0>
inline void arrayMoveConstruct(T* const src, T* const dst, const std::size_t count) {
// Apparently memcpy() can't be called with null pointers, even if size is zero. I call that bullying.
if (count != 0) std::memcpy(dst, src, count * sizeof(T));
}
template<class T, typename std::enable_if<!std::is_trivially_copyable<T>::value, int>::type = 0>
inline void arrayMoveConstruct(T* src, T* dst, const std::size_t count) {
static_assert(std::is_nothrow_move_constructible<T>::value,
"nothrow move-constructible type is required");
for (T* end = src + count; src != end; ++src, ++dst)
// Can't use {}, see the GCC 4.8-specific overload for details
#if defined(DEATH_TARGET_GCC) && !defined(DEATH_TARGET_CLANG) && __GNUC__ < 5
Implementation::construct(*dst, Death::move(*src));
#else
new(dst) T{Death::move(*src)};
#endif
}
template<class T, typename std::enable_if<std::is_trivially_copyable<T>::value, int>::type = 0>
inline void arrayMoveAssign(T* const src, T* const dst, const std::size_t count) {
// Apparently memcpy() can't be called with null pointers, even if size is zero. I call that bullying.
if (count != 0) std::memcpy(dst, src, count * sizeof(T));
}
template<class T, typename std::enable_if<!std::is_trivially_copyable<T>::value, int>::type = 0>
inline void arrayMoveAssign(T* src, T* dst, const std::size_t count) {
static_assert(std::is_nothrow_move_assignable<T>::value,
"nothrow move-assignable type is required");
for (T* end = src + count; src != end; ++src, ++dst)
*dst = Death::move(*src);
}
template<class T, typename std::enable_if<std::is_trivially_copyable<T>::value, int>::type = 0>
inline void arrayCopyConstruct(const T* const src, T* const dst, const std::size_t count) {
// Apparently memcpy() can't be called with null pointers, even if size is zero. I call that bullying.
if (count != 0) std::memcpy(dst, src, count * sizeof(T));
}
template<class T, typename std::enable_if<!std::is_trivially_copyable<T>::value, int>::type = 0>
inline void arrayCopyConstruct(const T* src, T* dst, const std::size_t count) {
for (const T* end = src + count; src != end; ++src, ++dst)
// Can't use {}, see the GCC 4.8-specific overload for details
#if defined(DEATH_TARGET_GCC) && !defined(DEATH_TARGET_CLANG) && __GNUC__ < 5
Implementation::construct(*dst, *src);
#else
new(dst) T{*src};
#endif
}
template<class T, typename std::enable_if<std::is_trivially_destructible<T>::value, int>::type = 0> inline void arrayDestruct(T*, T*) {
// Nothing to do
}
template<class T, typename std::enable_if<!std::is_trivially_destructible<T>::value, int>::type = 0> inline void arrayDestruct(T* begin, T* const end) {
// Needs to be < because sometimes begin > end
for (; begin < end; ++begin) begin->~T();
}
template<class T> inline std::size_t arrayGrowth(const std::size_t currentCapacity, const std::size_t desiredCapacity) {
const std::size_t currentCapacityInBytes = sizeof(T) * currentCapacity + Implementation::AllocatorTraits<T>::Offset;
// For small allocations we want to tightly fit into size buckets (8, 16, 32, 64 bytes), so it's better to double
// the capacity every time. For larger, increase just by 50%. The capacity is calculated including the space needed
// to store the capacity value (so e.g. a 16-byte allocation can store two ints, but when it's doubled to 32 bytes,
// it can store six of them).
std::size_t grown;
if (currentCapacityInBytes < DefaultAllocationAlignment)
grown = DefaultAllocationAlignment;
else if (currentCapacityInBytes < 64)
grown = currentCapacityInBytes * 2;
else
grown = currentCapacityInBytes + currentCapacityInBytes / 2;
const std::size_t candidate = (grown - Implementation::AllocatorTraits<T>::Offset) / sizeof(T);
return desiredCapacity > candidate ? desiredCapacity : candidate;
}
}
template<class T> void ArrayNewAllocator<T>::reallocate(T*& array, const std::size_t prevSize, const std::size_t newCapacity) {
T* newArray = allocate(newCapacity);
static_assert(std::is_nothrow_move_constructible<T>::value, "nothrow move-constructible type is required");
for (T* src = array, *end = src + prevSize, *dst = newArray; src != end; ++src, ++dst)
// Can't use {}, see the GCC 4.8-specific overload for details
#if defined(DEATH_TARGET_GCC) && !defined(DEATH_TARGET_CLANG) && __GNUC__ < 5
Implementation::construct(*dst, Death::move(*src));
#else
new(dst) T{Death::move(*src)};
#endif
for (T* it = array, *end = array + prevSize; it < end; ++it) it->~T();
deallocate(array);
array = newArray;
}
template<class T> void ArrayMallocAllocator<T>::reallocate(T*& array, std::size_t, const std::size_t newCapacity) {
const std::size_t inBytes = newCapacity * sizeof(T) + AllocationOffset;
char* const memory = static_cast<char*>(std::realloc(reinterpret_cast<char*>(array) - AllocationOffset, inBytes));
DEATH_ASSERT(memory != nullptr, ("Cannot reallocate {} bytes", inBytes), );
reinterpret_cast<std::size_t*>(memory)[0] = inBytes;
array = reinterpret_cast<T*>(memory + AllocationOffset);
}
template<class T> std::size_t ArrayNewAllocator<T>::grow(T* const array, const std::size_t desiredCapacity) {
return Implementation::arrayGrowth<T>(array ? capacity(array) : 0, desiredCapacity);
}
template<class T> std::size_t ArrayMallocAllocator<T>::grow(T* const array, const std::size_t desiredCapacity) {
return Implementation::arrayGrowth<T>(array ? capacity(array) : 0, desiredCapacity);
}
template<class T, class Allocator> bool arrayIsGrowable(Array<T>& array) {
return array.deleter() == Allocator::deleter;
}
template<class T, class Allocator> std::size_t arrayCapacity(Array<T>& array) {
if (array.deleter() == Allocator::deleter)
return Allocator::capacity(array.data());
return array.size();
}
template<class T, class Allocator> std::size_t arrayReserve(Array<T>& array, const std::size_t capacity) {
// Direct access & value caching to speed up debug builds
auto& arrayGuts = reinterpret_cast<Implementation::ArrayGuts<T>&>(array);
const bool hasGrowingDeleter = (arrayGuts.deleter == Allocator::deleter);
// If the capacity is large enough, nothing to do (even if we have the array allocated by something different)
const std::size_t currentCapacity = arrayCapacity<T, Allocator>(array);
if (currentCapacity >= capacity) return currentCapacity;
// Otherwise allocate a new array, move the previous data there and replace the old Array instance with it. Array's deleter
// will take care of destructing & deallocating the previous memory.
if (!hasGrowingDeleter) {
T* newArray = Allocator::allocate(capacity);
Implementation::arrayMoveConstruct<T>(arrayGuts.data, newArray, arrayGuts.size);
array = Array<T>{newArray, arrayGuts.size, Allocator::deleter};
} else Allocator::reallocate(arrayGuts.data, arrayGuts.size, capacity);
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + capacity,
arrayGuts.data + capacity, // ASan assumes this for new allocations
arrayGuts.data + arrayGuts.size);
#endif
return capacity;
}
template<class T, class Allocator> void arrayResize(Array<T>& array, NoInitT, const std::size_t size) {
// Direct access & value caching to speed up debug builds
auto& arrayGuts = reinterpret_cast<Implementation::ArrayGuts<T>&>(array);
const bool hasGrowingDeleter = (arrayGuts.deleter == Allocator::deleter);
// New size is the same as the old one, nothing to do
if (arrayGuts.size == size) return;
// Reallocate if we don't have our growable deleter, as the default deleter might then call destructors even in the non-initialized area ...
if (!hasGrowingDeleter) {
T* newArray = Allocator::allocate(size);
Implementation::arrayMoveConstruct<T>(array, newArray,
// Move the min of the two sizes -- if we shrink, move only what will fit in the new array; if we extend,
// move only what's initialized in the original and left the rest not initialized
arrayGuts.size < size ? arrayGuts.size : size);
array = Array<T>{newArray, size, Allocator::deleter};
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size);
#endif
// ... or the desired size is larger than the capacity. In that case make use of the reallocate() function that might be able to grow in-place.
} else if (Allocator::capacity(array) < size) {
Allocator::reallocate(arrayGuts.data,
// Move the min of the two sizes -- if we shrink, move only what will fit in the new array; if we extend,
// move only what's initialized in the original and left the rest not initialized
arrayGuts.size < size ? arrayGuts.size : size, size);
arrayGuts.size = size;
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size);
#endif
// Otherwise call a destructor on the extra elements. If we get here, we have our growable deleter and didn't
// need to reallocate (which would make this unnecessary).
} else {
Implementation::arrayDestruct<T>(arrayGuts.data + size, arrayGuts.data + arrayGuts.size);
// This is a NoInit resize, so not constructing the new elements, only updating the size
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + Allocator::capacity(array),
arrayGuts.data + arrayGuts.size,
arrayGuts.data + size);
#endif
arrayGuts.size = size;
}
}
template<class T, class Allocator> void arrayResize(Array<T>& array, ValueInitT, const std::size_t size) {
const std::size_t prevSize = array.size();
arrayResize<T, Allocator>(array, NoInit, size);
Implementation::arrayConstruct(ValueInit, array + prevSize, array.end());
}
template<class T, class Allocator, class ...Args> void arrayResize(Array<T>& array, DirectInitT, const std::size_t size, Args&&... args) {
const std::size_t prevSize = array.size();
arrayResize<T, Allocator>(array, NoInit, size);
// In-place construct the new elements. No helper function for this as there's no way we could memcpy such a thing.
for (T* it = array + prevSize; it < array.end(); ++it)
Implementation::construct(*it, Death::forward<Args>(args)...);
}
template<class T, class ...Args> inline void arrayResize(Array<T>& array, DirectInitT, const std::size_t size, Args&&... args) {
arrayResize<T, ArrayAllocator<T>>(array, DirectInit, size, Death::forward<Args>(args)...);
}
namespace Implementation
{
template<class T, class Allocator> T* arrayGrowBy(Array<T>& array, const std::size_t count) {
// Direct access & caching to speed up debug builds
auto& arrayGuts = reinterpret_cast<Implementation::ArrayGuts<T>&>(array);
// No values to add, early exit
if (count == 0)
return arrayGuts.data + arrayGuts.size;
// For arrays with an unknown deleter we'll always copy-allocate to a new place. Not using reallocate()
// as we don't know where the original memory comes from.
const std::size_t desiredCapacity = arrayGuts.size + count;
std::size_t capacity;
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
T* oldMid = nullptr;
#endif
if (arrayGuts.deleter != Allocator::deleter) {
capacity = Allocator::grow(nullptr, desiredCapacity);
T* const newArray = Allocator::allocate(capacity);
arrayMoveConstruct<T>(arrayGuts.data, newArray, arrayGuts.size);
array = Array<T>{newArray, arrayGuts.size, Allocator::deleter};
// Otherwise, if there's no space anymore, reallocate, which might be able to grow in-place
} else {
capacity = Allocator::capacity(arrayGuts.data);
if (arrayGuts.size + count > capacity) {
capacity = Allocator::grow(arrayGuts.data, desiredCapacity);
Allocator::reallocate(arrayGuts.data, arrayGuts.size, capacity);
} else {
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
oldMid = arrayGuts.data + arrayGuts.size;
#endif
}
}
// Increase array size and return the previous end pointer
T* const it = arrayGuts.data + arrayGuts.size;
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + capacity,
// For a new allocation, ASan assumes the previous middle pointer is at the end of the array. If we grew an existing
// allocation, the previous middle is set what __sanitier_acc() received as a middle value before.
oldMid ? oldMid : arrayGuts.data + capacity,
arrayGuts.data + arrayGuts.size + count);
#endif
arrayGuts.size += count;
return it;
}
}
template<class T, class Allocator> inline T& arrayAppend(Array<T>& array, const typename std::common_type<T>::type& value) {
DEATH_DEBUG_ASSERT(std::size_t(&value - array.data()) >= arrayCapacity(array),
"Use the list variant to append values from within the array itself", *array.data());
T* const it = Implementation::arrayGrowBy<T, Allocator>(array, 1);
// Can't use {}, see the GCC 4.8-specific overload for details
#if defined(DEATH_TARGET_GCC) && !defined(DEATH_TARGET_CLANG) && __GNUC__ < 5
Implementation::construct(*it, value);
#else
new(it) T{value};
#endif
return *it;
}
template<class T, class Allocator> inline ArrayView<T> arrayAppend(Array<T>& array, const typename std::common_type<ArrayView<const T>>::type values) {
// Direct access & caching to speed up debug builds
const T* const valueData = values.data();
const std::size_t valueCount = values.size();
// If the values are actually a slice of the original array, we need to relocate the view after growing
// because it may point to a stale location afterwards. If the offset is outside of the [0, capacity) range
// of the original array, we don't relocate. Similar check is in arrayInsert(), where it additionally has
// to adjust the offset based on whether the values are before or after the insertion point.
std::size_t relocateOffset = std::size_t(valueData - array.data());
if (relocateOffset >= arrayCapacity<T, Allocator>(array))
relocateOffset = ~std::size_t{};
T* const it = Implementation::arrayGrowBy<T, Allocator>(array, valueCount);
Implementation::arrayCopyConstruct<T>(
// If values were a slice of the original array, relocate the view pointer relative to the (potentially reallocated)
// array. It may have pointed into the (potentially uninitialized) capacity, in which case we'll likely copy some
// garbage or we overwrite ourselves, but that's the user fault (and ASan would catch it). OTOH, if the capacity
// wouldn't be taken into account above, we may end up reading from freed memory, which is far worse.
relocateOffset != ~std::size_t{} ? array.data() + relocateOffset : valueData,
it, valueCount);
return {it, valueCount};
}
template<class T, class ...Args> inline T& arrayAppend(Array<T>& array, InPlaceInitT, Args&&... args) {
return arrayAppend<T, ArrayAllocator<T>>(array, InPlaceInit, Death::forward<Args>(args)...);
}
template<class T, class Allocator, class ...Args> T& arrayAppend(Array<T>& array, InPlaceInitT, Args&&... args) {
T* const it = Implementation::arrayGrowBy<T, Allocator>(array, 1);
// No helper function as there's no way we could memcpy such a thing.
// On GCC 4.8 this includes another workaround, see the 4.8-specific overload docs for details
Implementation::construct(*it, Death::forward<Args>(args)...);
return *it;
}
template<class T, class Allocator> ArrayView<T> arrayAppend(Array<T>& array, NoInitT, const std::size_t count) {
T* const it = Implementation::arrayGrowBy<T, Allocator>(array, count);
return {it, count};
}
template<class T, class Allocator> ArrayView<T> arrayAppend(Array<T>& array, ValueInitT, const std::size_t count) {
const ArrayView<T> out = arrayAppend<T, Allocator>(array, NoInit, count);
Implementation::arrayConstruct(ValueInit, out.begin(), out.end());
return out;
}
template<class T, class Allocator, class ...Args> ArrayView<T> arrayAppend(Array<T>& array, DirectInitT, const std::size_t count, Args&&... args) {
const ArrayView<T> out = arrayAppend<T, Allocator>(array, NoInit, count);
// In-place construct the new elements. No helper function for this as
// there's no way we could memcpy such a thing.
for (T* it = out.begin(); it < out.end(); ++it)
Implementation::construct(*it, Death::forward<Args>(args)...);
return out;
}
template<class T, class ...Args> ArrayView<T> arrayAppend(Array<T>& array, DirectInitT, const std::size_t count, Args&&... args) {
return arrayAppend<T, ArrayAllocator<T>>(array, DirectInit, count, Death::forward<Args>(args)...);
}
namespace Implementation
{
template<class T, typename std::enable_if<std::is_trivially_copyable<T>::value, int>::type = 0>
inline void arrayShiftForward(T* const src, T* const dst, const std::size_t count) {
// Compared to the non-trivially-copyable variant below, just delegate to memmove() and assume it can figure
// out how to copy from back to front more efficiently that we ever could.
// Same as with memcpy(), apparently memmove() can't be called with null pointers, even if size is zero. I call that bullying.
if (count != 0) std::memmove(dst, src, count * sizeof(T));
}
template<class T, typename std::enable_if<!std::is_trivially_copyable<T>::value, int>::type = 0>
inline void arrayShiftForward(T* const src, T* const dst, const std::size_t count) {
static_assert(std::is_nothrow_move_constructible<T>::value && std::is_nothrow_move_assignable<T>::value,
"nothrow move-constructible and move-assignable type is required");
// Count of non-overlapping items, which will be move-constructed on one
// side and destructed on the other. The rest will be move-assigned.
const std::size_t nonOverlappingCount = src + count < dst ? count : dst - src;
// Move-construct the non-overlapping elements. Doesn't matter if going forward or backward as we're not
// overwriting anything, but go backward for consistency with the move-assignment loop below.
for (T* end = src + count - nonOverlappingCount, *constructSrc = src + count, *constructDst = dst + count; constructSrc > end; --constructSrc, --constructDst) {
// Can't use {}, see the GCC 4.8-specific overload for details
#if defined(DEATH_TARGET_GCC) && !defined(DEATH_TARGET_CLANG) && __GNUC__ < 5
Implementation::construct(*(constructDst - 1), Death::move(*(constructSrc - 1)));
#else
new(constructDst - 1) T{Death::move(*(constructSrc - 1))};
#endif
}
// Move-assign overlapping elements, going backwards to avoid overwriting values that are yet to be moved.
// This loop is never entered if nonOverlappingCount >= count.
for (T* assignSrc = src + count - nonOverlappingCount, *assignDst = dst + count - nonOverlappingCount; assignSrc > src; --assignSrc, --assignDst)
*(assignDst - 1) = Death::move(*(assignSrc - 1));
// Destruct non-overlapping elements in the newly-formed gap so the calling code can assume uninitialized memory
// both in all cases. Here it again doesn't matter if going forward or backward, but go backward for consistency.
for (T* destructSrc = src + nonOverlappingCount; destructSrc != src; --destructSrc)
(destructSrc - 1)->~T();
}
template<class T, class Allocator> T* arrayGrowAtBy(Array<T>& array, const std::size_t index, const std::size_t count) {
// Direct access & caching to speed up debug builds
auto& arrayGuts = reinterpret_cast<Implementation::ArrayGuts<T>&>(array);
DEATH_DEBUG_ASSERT(index <= arrayGuts.size, ("Cannot insert at index {} into an array of size {}", index, arrayGuts.size), arrayGuts.data);
// No values to add, early exit
if (count == 0)
return arrayGuts.data + index;
// For arrays with an unknown deleter we'll always move-allocate to a new place, the parts before and after
// index separately. Not using reallocate() as we don't know where the original memory comes from.
const std::size_t desiredCapacity = arrayGuts.size + count;
std::size_t capacity;
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
T* oldMid = nullptr;
#endif
bool needsShiftForward = false;
if (arrayGuts.deleter != Allocator::deleter) {
capacity = Allocator::grow(nullptr, desiredCapacity);
T* const newArray = Allocator::allocate(capacity);
arrayMoveConstruct<T>(arrayGuts.data, newArray, index);
arrayMoveConstruct<T>(arrayGuts.data + index, newArray + index + count, arrayGuts.size - index);
array = Array<T>{newArray, arrayGuts.size, Allocator::deleter};
// Otherwise, if there's no space anymore, reallocate. which might be able to grow in-place.
// However we still need to shift the part after index forward.
} else {
capacity = Allocator::capacity(arrayGuts.data);
if (arrayGuts.size + count > capacity) {
capacity = Allocator::grow(arrayGuts.data, desiredCapacity);
Allocator::reallocate(arrayGuts.data, arrayGuts.size, capacity);
} else {
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
oldMid = arrayGuts.data + arrayGuts.size;
#endif
}
needsShiftForward = true;
}
// Increase array size and return the position at index
T* const it = arrayGuts.data + index;
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + capacity,
// For a new allocation, ASan assumes the previous middle pointer is at the end of the array. If we grew an existing
// allocation, the previous middle is set what __sanitier_acc() received as a middle value before.
oldMid ? oldMid : arrayGuts.data + capacity,
arrayGuts.data + arrayGuts.size + count);
#endif
// Perform a shift of elements after index. Needs to be done after the ASan annotation is updated, otherwise it'll
// trigger a failure due to outdated bounds information.
if (needsShiftForward)
arrayShiftForward(arrayGuts.data + index, arrayGuts.data + index + count, arrayGuts.size - index);
arrayGuts.size += count;
return it;
}
}
template<class T, class Allocator> inline T& arrayInsert(Array<T>& array, std::size_t index, const typename std::common_type<T>::type& value) {
DEATH_DEBUG_ASSERT(std::size_t(&value - array.data()) >= arrayCapacity(array),
"Use the list variant to insert values from within the array itself", *array.data());
T* const it = Implementation::arrayGrowAtBy<T, Allocator>(array, index, 1);
// Can't use {}, see the GCC 4.8-specific overload for details
#if defined(DEATH_TARGET_GCC) && !defined(DEATH_TARGET_CLANG) && __GNUC__ < 5
Implementation::construct(*it, value);
#else
new(it) T{value};
#endif
return *it;
}
template<class T, class Allocator> inline ArrayView<T> arrayInsert(Array<T>& array, std::size_t index, const typename std::common_type<ArrayView<const T>>::type values) {
// Direct access & caching to speed up debug builds
const T* const valueData = values.data();
const std::size_t valueCount = values.size();
// If the values are actually a slice of the original array, we need to relocate the view after growing
// because it may point to a stale location afterwards. If the offset is outside of the [0, capacity)
// range of the original array, we don't relocate. Similar but simpler check is in arrayAppend().
std::size_t relocateOffset = std::size_t(valueData - array.data());
if (relocateOffset < arrayCapacity<T, Allocator>(array)) {
// If we're inserting before the original slice, the new offset has to include also the inserted size
if (index <= relocateOffset)
relocateOffset += valueCount;
// Otherwise the index should not point inside the slice, as we'd have to split the copy into two parts.
// The assumption is that this is a very rare scenario (with very questionable practical usefulness),
// and the caller should handle that on its own.
else DEATH_DEBUG_ASSERT(relocateOffset + valueCount <= index,
("Attempting to insert a slice [{}:{}] into itself at index {}", relocateOffset, relocateOffset + valueCount, index), {});
} else relocateOffset = ~std::size_t{};
T* const it = Implementation::arrayGrowAtBy<T, Allocator>(array, index, valueCount);
Implementation::arrayCopyConstruct<T>(
// If values were a slice of the original array, relocate the view pointer relative to the (potentially
// reallocated) array. Similarly as with arrayAppend(), it may have pointed into the capacity, which
// we handle by copying potential garbage instead of accessing freed memory.
relocateOffset != ~std::size_t{} ? array.data() + relocateOffset : valueData,
it, valueCount);
return {it, valueCount};
}
template<class T, class ...Args> inline T& arrayInsert(Array<T>& array, std::size_t index, InPlaceInitT, Args&&... args) {
return arrayInsert<T, ArrayAllocator<T>>(array, index, InPlaceInit, Death::forward<Args>(args)...);
}
template<class T, class Allocator, class ...Args> T& arrayInsert(Array<T>& array, std::size_t index, InPlaceInitT, Args&&... args) {
T* const it = Implementation::arrayGrowAtBy<T, Allocator>(array, index, 1);
// No helper function as there's no way we could memcpy such a thing.
// On GCC 4.8 this includes another workaround, see the 4.8-specific overload docs for details
Implementation::construct(*it, Death::forward<Args>(args)...);
return *it;
}
template<class T, class Allocator> ArrayView<T> arrayInsert(Array<T>& array, const std::size_t index, NoInitT, const std::size_t count) {
T* const it = Implementation::arrayGrowAtBy<T, Allocator>(array, index, count);
return {it, count};
}
template<class T, class Allocator> ArrayView<T> arrayInsert(Array<T>& array, const std::size_t index, ValueInitT, const std::size_t count) {
const ArrayView<T> out = arrayInsert<T, Allocator>(array, index, NoInit, count);
Implementation::arrayConstruct(ValueInit, out.begin(), out.end());
return out;
}
template<class T, class Allocator, class ...Args> ArrayView<T> arrayInsert(Array<T>& array, const std::size_t index, DirectInitT, const std::size_t count, Args&&... args) {
const ArrayView<T> out = arrayInsert<T, Allocator>(array, index, NoInit, count);
// In-place construct the new elements. No helper function for this as
// there's no way we could memcpy such a thing.
for (T* it = out.begin(); it < out.end(); ++it)
Implementation::construct(*it, Death::forward<Args>(args)...);
return out;
}
template<class T, class ...Args> ArrayView<T> arrayInsert(Array<T>& array, const std::size_t index, DirectInitT, const std::size_t count, Args&&... args) {
return arrayInsert<T, ArrayAllocator<T>>(array, index, DirectInit, count, Death::forward<Args>(args)...);
}
namespace Implementation
{
template<class T, typename std::enable_if<std::is_trivially_copyable<T>::value, int>::type = 0>
inline void arrayShiftBackward(T* const src, T* const dst, const std::size_t moveCount, std::size_t) {
// Compared to the non-trivially-copyable variant below, just delegate to memmove() and assume it can figure
// out how to copy from front to back more efficiently that we ever could.
// Same as with memcpy(), apparently memmove() can't be called with null pointers, even if size is zero. I call that bullying.
if (moveCount != 0) std::memmove(dst, src, moveCount * sizeof(T));
}
template<class T, typename std::enable_if<!std::is_trivially_copyable<T>::value, int>::type = 0>
inline void arrayShiftBackward(T* const src, T* const dst, const std::size_t moveCount, std::size_t destructCount) {
static_assert(std::is_nothrow_move_constructible<T>::value && std::is_nothrow_move_assignable<T>::value,
"nothrow move-constructible and move-assignable type is required");
// Move-assign later elements to earlier
for (T* end = src + moveCount, *assignSrc = src, *assignDst = dst; assignSrc != end; ++assignSrc, ++assignDst)
*assignDst = Death::move(*assignSrc);
// Destruct remaining moved-out elements
for (T* end = src + moveCount, *destructSrc = end - destructCount; destructSrc != end; ++destructSrc)
destructSrc->~T();
}
}
template<class T, class Allocator> void arrayRemove(Array<T>& array, const std::size_t index, const std::size_t count) {
// Direct access to speed up debug builds
auto& arrayGuts = reinterpret_cast<Implementation::ArrayGuts<T>&>(array);
DEATH_DEBUG_ASSERT(index + count <= arrayGuts.size, ("Cannot remove {} elements at index {} from an array of size {}", count, index, arrayGuts.size), );
// Nothing to remove, yay!
if (count == 0) return;
// If we don't have our own deleter, we need to reallocate in order to store the capacity. Move the parts before
// and after the index separately, which will also cause the removed elements to be properly destructed, so nothing
// else needs to be done. Not using reallocate() as we don't know where the original memory comes from.
if (arrayGuts.deleter != Allocator::deleter) {
T* const newArray = Allocator::allocate(arrayGuts.size - count);
Implementation::arrayMoveConstruct<T>(arrayGuts.data, newArray, index);
Implementation::arrayMoveConstruct<T>(arrayGuts.data + index + count, newArray + index, arrayGuts.size - index - count);
array = Array<T>{newArray, arrayGuts.size - count, Allocator::deleter};
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size);
#endif
// Otherwise shift the elements after index backward
} else {
Implementation::arrayShiftBackward(arrayGuts.data + index + count, arrayGuts.data + index, arrayGuts.size - index - count, count);
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + Allocator::capacity(arrayGuts.data),
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size - count);
#endif
arrayGuts.size -= count;
}
}
template<class T, class Allocator> void arrayRemoveUnordered(Array<T>& array, const std::size_t index, const std::size_t count) {
// Direct access to speed up debug builds
auto& arrayGuts = reinterpret_cast<Implementation::ArrayGuts<T>&>(array);
DEATH_DEBUG_ASSERT(index + count <= arrayGuts.size, ("Cannot remove {} elements at index {} from an array of size {}", count, index, arrayGuts.size), );
// Nothing to remove, yay!
if (count == 0) return;
// If we don't have our own deleter, we need to reallocate in order to store the capacity. Move the parts before
// and after the index separately, which will also cause the removed elements to be properly destructed, so nothing
// else needs to be done. Not using reallocate() as we don't know where the original memory comes from.
if (arrayGuts.deleter != Allocator::deleter) {
T* const newArray = Allocator::allocate(arrayGuts.size - count);
Implementation::arrayMoveConstruct<T>(arrayGuts.data, newArray, index);
Implementation::arrayMoveConstruct<T>(arrayGuts.data + index + count, newArray + index, arrayGuts.size - index - count);
array = Array<T>{newArray, arrayGuts.size - count, Allocator::deleter};
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size);
#endif
// Otherwise move the last count elements over the ones at index, or less if there's not that many after the removed range
} else {
const std::size_t remainingCount = arrayGuts.size - count - index;
const std::size_t moveCount = (count < remainingCount ? count : remainingCount);
Implementation::arrayShiftBackward(arrayGuts.data + arrayGuts.size - moveCount, arrayGuts.data + index, moveCount, count);
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + Allocator::capacity(arrayGuts.data),
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size - count);
#endif
arrayGuts.size -= count;
}
}
template<class T, class Allocator> void arrayRemoveSuffix(Array<T>& array, const std::size_t count) {
// Direct access to speed up debug builds
auto& arrayGuts = reinterpret_cast<Implementation::ArrayGuts<T>&>(array);
DEATH_DEBUG_ASSERT(count <= arrayGuts.size, ("Cannot remove {} elements from an array of size {}", count, arrayGuts.size), );
// Nothing to remove, yay!
if (count == 0) return;
// If we don't have our own deleter, we need to reallocate in order to store the capacity. That'll
// also cause the excessive elements to be properly destructed, so nothing else needs to be done.
// Not using reallocate() as we don't know where the original memory comes from.
if (arrayGuts.deleter != Allocator::deleter) {
T* const newArray = Allocator::allocate(arrayGuts.size - count);
Implementation::arrayMoveConstruct<T>(arrayGuts.data, newArray, arrayGuts.size - count);
array = Array<T>{newArray, arrayGuts.size - count, Allocator::deleter};
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size);
#endif
// Otherwise call the destructor on the excessive elements and update the size
} else {
Implementation::arrayDestruct<T>(arrayGuts.data + arrayGuts.size - count, arrayGuts.data + arrayGuts.size);
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + Allocator::capacity(arrayGuts.data),
arrayGuts.data + arrayGuts.size,
arrayGuts.data + arrayGuts.size - count);
#endif
arrayGuts.size -= count;
}
}
template<class T, class Allocator> void arrayClear(Array<T>& array) {
// Direct access to speed up debug builds
auto& arrayGuts = reinterpret_cast<Implementation::ArrayGuts<T>&>(array);
// If not using our growing allocator, simply free the existing contents
if(arrayGuts.deleter != Allocator::deleter) {
array = {};
// Otherwise call the destructor on the excessive elements and update the size
} else {
Implementation::arrayDestruct<T>(arrayGuts.data, arrayGuts.data + arrayGuts.size);
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
__sanitizer_annotate_contiguous_container(
Allocator::base(arrayGuts.data),
arrayGuts.data + Allocator::capacity(arrayGuts.data),
arrayGuts.data + arrayGuts.size,
arrayGuts.data);
#endif
arrayGuts.size = 0;
}
}
template<class T, class Allocator> void arrayShrink(Array<T>& array, NoInitT) {
// Direct access to speed up debug builds
auto& arrayGuts = reinterpret_cast<Implementation::ArrayGuts<T>&>(array);
// If not using our growing allocator, assume the array size equals its capacity and do nothing
if (arrayGuts.deleter != Allocator::deleter)
return;
// Even if we don't need to shrink, reallocating to an usual array with common deleters to avoid surprises
Array<T> newArray{NoInit, arrayGuts.size};
Implementation::arrayMoveConstruct<T>(arrayGuts.data, newArray, arrayGuts.size);
array = Death::move(newArray);
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
// Nothing to do (not annotating the arrays with default deleter)
#endif
}
template<class T, class Allocator> void arrayShrink(Array<T>& array, ValueInitT) {
// Direct access to speed up debug builds
auto& arrayGuts = reinterpret_cast<Implementation::ArrayGuts<T>&>(array);
// If not using our growing allocator, assume the array size equals its capacity and do nothing
if (arrayGuts.deleter != Allocator::deleter)
return;
// Even if we don't need to shrink, reallocating to an usual array with common deleters to avoid surprises
Array<T> newArray{ValueInit, arrayGuts.size};
Implementation::arrayMoveAssign<T>(arrayGuts.data, newArray, arrayGuts.size);
array = Death::move(newArray);
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
// Nothing to do (not annotating the arrays with default deleter)
#endif
}
}}
#if defined(__DEATH_CONTAINERS_SANITIZER_ENABLED)
# undef __DEATH_CONTAINERS_SANITIZER_ENABLED
#endif
|