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 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565
|
#include "EncyclopediaDetailPanel.h"
#include <charconv>
#include <unordered_map>
#include <boost/algorithm/clamp.hpp>
#include <boost/algorithm/string/predicate.hpp>
#include <boost/locale/conversion.hpp>
#include <GG/GUI.h>
#include <GG/RichText/RichText.h>
#include <GG/ScrollPanel.h>
#include <GG/StaticGraphic.h>
#include <GG/Texture.h>
#include <GG/utf8/checked.h>
#include "CUIControls.h"
#include "CUILinkTextBlock.h"
#include "DesignWnd.h"
#include "FleetWnd.h"
#include "GraphControl.h"
#include "Hotkeys.h"
#include "LinkText.h"
#include "MapWnd.h"
#include "../client/human/GGHumanClientApp.h"
#include "../combat/CombatLogManager.h"
#include "../Empire/Empire.h"
#include "../Empire/EmpireManager.h"
#include "../Empire/Government.h"
#include "../universe/Building.h"
#include "../universe/BuildingType.h"
#include "../universe/Condition.h"
#include "../universe/Effect.h"
#include "../universe/Encyclopedia.h"
#include "../universe/Field.h"
#include "../universe/FieldType.h"
#include "../universe/Fleet.h"
#include "../universe/NamedValueRefManager.h"
#include "../universe/Planet.h"
#include "../universe/ShipDesign.h"
#include "../universe/Ship.h"
#include "../universe/ShipHull.h"
#include "../universe/ShipPart.h"
#include "../universe/Special.h"
#include "../universe/Species.h"
#include "../universe/System.h"
#include "../universe/Tech.h"
#include "../universe/Universe.h"
#include "../universe/UnlockableItem.h"
#include "../universe/ValueRef.h"
#include "../util/Directories.h"
#include "../util/GameRules.h"
#include "../util/i18n.h"
#include "../util/Logger.h"
#include "../util/OptionsDB.h"
#include "../util/ScopedTimer.h"
#include "../util/ThreadPool.h"
#include "../util/VarText.h"
namespace {
constexpr int DESCRIPTION_PADDING(3);
void AddOptions(OptionsDB& db) {
db.Add("resource.effects.description.shown", UserStringNop("OPTIONS_DB_DUMP_EFFECTS_GROUPS_DESC"), false);
db.Add("ui.pedia.search.articles.enabled", UserStringNop("OPTIONS_DB_UI_ENC_SEARCH_ARTICLE"), true);
}
bool temp_bool = RegisterOptions(&AddOptions);
#if defined(__cpp_lib_constexpr_string) && ((!defined(__GNUC__) || (__GNUC__ > 12) || (__GNUC__ == 12 && __GNUC_MINOR__ >= 2))) && ((!defined(_MSC_VER) || (_MSC_VER >= 1934))) && ((!defined(__clang_major__) || (__clang_major__ >= 17)))
constexpr std::string EMPTY_STRING;
#else
const std::string EMPTY_STRING;
#endif
constexpr std::string_view INCOMPLETE_DESIGN = "incomplete design";
constexpr std::string_view UNIVERSE_OBJECT = "universe object";
constexpr std::string_view PLANET_SUITABILITY_REPORT = "planet suitability report";
constexpr std::string_view TEXT_SEARCH_RESULTS = "dynamic generated text";
/** @content_tag{CTRL_ALWAYS_REPORT} Always display a species on a planet suitability report. **/
constexpr std::string_view TAG_ALWAYS_REPORT = "CTRL_ALWAYS_REPORT";
/** @content_tag{CTRL_EXTINCT} Added to both a species and their enabling tech. Handles display in planet suitability report. **/
constexpr std::string_view TAG_EXTINCT = "CTRL_EXTINCT";
}
namespace {
constexpr auto prefix_len{TAG_PEDIA_PREFIX.length()};
// Checks content \a tags for any custom pedia categories, which are tags
// that have the TAG_PEDIA_PREFIX as their first few chars
bool HasCustomCategory(const auto& tags) {
return std::any_of(tags.begin(), tags.end(), [](std::string_view sv)
{ return sv.substr(0, prefix_len) == TAG_PEDIA_PREFIX; });
}
// Checks content \a tags for custom defined pedia category \a cat
bool HasCustomCategory(const std::vector<std::string_view>& tags, const std::string_view cat) {
return std::any_of(tags.begin(), tags.end(), [cat](std::string_view sv) {
return sv.substr(0, prefix_len) == TAG_PEDIA_PREFIX &&
sv.substr(prefix_len) == cat;
});
}
// checks \a tags for entries whose substring after the length of the pedia
// prefix matches \a cat but does not check the portion before that
bool HasCustomCategoryNoPrefixCheck(const std::vector<std::string_view>& tags, const std::string_view cat) {
return std::any_of(tags.begin(), tags.end(), [cat](std::string_view sv)
{ return sv.substr(prefix_len) == cat; });
}
// checks \a tags for entries that match \a cat
bool HasCustomCategoryNoPrefixes(const std::vector<std::string_view>& tags, const std::string_view cat) {
return std::any_of(tags.begin(), tags.end(), [cat](std::string_view sv)
{ return sv == cat; });
}
}
namespace {
// wrapper for converting string to integer
[[nodiscard]] int ToInt(std::string_view sv, int default_result = -1)
noexcept(noexcept(std::from_chars("", "", std::declval<int&>())))
{
int retval = default_result;
std::from_chars(sv.data(), sv.data() + sv.size(), retval);
return retval;
}
static_assert(std::numeric_limits<long long>::max() > std::numeric_limits<int>::max());
static_assert(std::numeric_limits<int>::max() > 0);
// how many base-10 digits are needed to represent a number as text
// note that numeric_limits<>::digits10 is how many base 10 digits can be represented by this type
template <typename T> requires (std::is_integral_v<T>)
[[nodiscard]] consteval std::size_t Digits(T t) noexcept {
std::size_t retval = 1;
if constexpr (std::is_same_v<T, bool>) {
return 5; // for "false"
} else {
if constexpr (std::is_signed_v<T>)
retval += (t < 0);
while (t != 0) {
retval += 1;
t /= 10;
}
return retval;
}
}
constexpr auto digits_int_max = Digits(std::numeric_limits<int>::max());
constexpr auto digits_int_min = Digits(std::numeric_limits<int>::min());
static_assert(digits_int_min >= std::numeric_limits<int>::digits10);
static_assert(digits_int_min <= 22 && digits_int_max <= 15);
constexpr auto digits_long_long_int_max = Digits(std::numeric_limits<long long int>::max());
constexpr auto digits_long_long_int_min = Digits(std::numeric_limits<long long int>::min());
static_assert(digits_long_long_int_min <= 22 && digits_long_long_int_max <= 22);
namespace {
// <concepts> library not fully implemented in XCode 13.2
template <class T>
concept integral = std::is_integral_v<T>;
}
// wrapper for converting number to string/string_view
template <integral T>
auto ToChars(T t) noexcept(std::is_same_v<T, bool>) {
if constexpr (std::is_same_v<T, bool>) {
return t ? std::string_view{"true"} : std::string_view{"false"};
} else {
#if !defined(__cpp_lib_to_chars)
return std::to_string(t);
#else
// to_chars + string construction is faster than calling to_string in my benchmarks.
// allocating just enough local buffer space for the input type might also allow
// small string optimization of string storage to work better when <= 15 or <= 23
// chars are required for a given type, depending on the standard library used
static constexpr auto digits = std::max(Digits(std::numeric_limits<T>::min()),
Digits(std::numeric_limits<T>::max()));
std::array<std::string::value_type, digits> buf; // uninitialized since result.ptr should suffice
const auto result = std::to_chars(buf.data(), buf.data() + buf.size(), t);
return std::string(buf.data(), result.ptr);
#endif
}
}
}
namespace {
/** Retreive a value label and general string representation for @a meter_type
* eg. {"METER_STEALTH_VALUE_LABEL", UserString("METER_STEALTH")} */
auto MeterValueLabelAndString(MeterType meter_type) {
static_assert(std::is_same_v<std::string_view, decltype(to_string(meter_type))>);
std::pair<std::string_view, std::string_view> retval{"", to_string(meter_type)};
if (meter_type == MeterType::INVALID_METER_TYPE)
return retval;
using signed_idx_type = std::underlying_type_t<MeterType>;
static constexpr auto INVALID_IDX = static_cast<signed_idx_type>(MeterType::INVALID_METER_TYPE);
static_assert(INVALID_IDX == -1);
static constexpr bool all_gte_neg1 = []() {
for (auto& [val, str] : MeterTypeValues()) {
if (static_cast<signed_idx_type>(val) < -1)
return false;
}
return true;
}();
static_assert(all_gte_neg1);
static const auto label_value_strings = []() {
static constexpr auto NUM_IDX = static_cast<signed_idx_type>(MeterType::NUM_METER_TYPES);
std::array<std::string, NUM_IDX> retval{};
for (std::size_t idx = 0; idx < NUM_IDX; ++idx)
retval[idx] = std::string{to_string(MeterType(static_cast<signed_idx_type>(idx)))}
.append("_VALUE_LABEL");
return retval;
}();
auto idx = static_cast<std::size_t>(static_cast<signed_idx_type>(meter_type));
retval.first = label_value_strings[idx];
if (UserStringExists(retval.first)) {
retval.first = UserString(retval.first);
} else {
DebugLogger() << "No pedia entry found for value of Meter Type: "
<< retval.second << "(" << meter_type << ")";
retval.first = UserString(retval.second);
}
return retval;
}
void MeterTypeDirEntry(MeterType meter_type,
std::vector<std::pair<std::string,
std::pair<std::string, std::string>>>& list)
{
auto [value_label, string_rep] = MeterValueLabelAndString(meter_type);
if (value_label.empty() || string_rep.empty())
return;
list.emplace_back(std::piecewise_construct,
std::forward_as_tuple(value_label),
std::forward_as_tuple(LinkTaggedPresetText(VarText::METER_TYPE_TAG, string_rep, value_label).append("\n"),
string_rep));
}
}
namespace {
std::map<std::string, std::string> prepended_homeworld_names;
std::mutex prepended_homeworld_names_access;
/** Returns map from (Human-readable and thus sorted article name) to
pair of (article link tag text, key for article category or
subcategorization of it or article key). Category is something like
"ENC_TECH" and subcategorization is something like a tech category
(eg. growth) or tech_name or an object ID. */
auto GetSortedPediaDirEntires(
std::string_view dir_name,
bool exclude_custom_categories_from_dir_name = true)
{
ScopedTimer subdir_timer(std::string{"GetSortedPediaDirEntires("}.append(dir_name).append(")"),
true, std::chrono::milliseconds(20));
// first: readable name. can't be a view because some names are on-the fly generated, eg. system apparent name
// second.first: link text. generated on the fly
// second.second: item name/id/key within category. could be dynamically generated from an ID number
std::vector<std::pair<std::string, std::pair<std::string, std::string>>> retval;
const Encyclopedia& encyclopedia = GetEncyclopedia();
int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
const Universe& universe = GetUniverse();
const ObjectMap& objects = universe.Objects();
if (dir_name == "ENC_INDEX") {
// add entries consisting of links to pedia page lists of
// articles of various types
static constexpr std::array<std::string_view, 26> SEARCH_TEXT_DIR_NAMES{{
"ENC_SHIP_PART", "ENC_SHIP_HULL", "ENC_TECH", "ENC_POLICY",
"ENC_BUILDING_TYPE","ENC_SPECIAL", "ENC_SPECIES", "ENC_FIELD_TYPE",
"ENC_METER_TYPE", "ENC_EMPIRE", "ENC_SHIP_DESIGN", "ENC_SHIP",
"ENC_MONSTER", "ENC_MONSTER_TYPE", "ENC_FLEET", "ENC_PLANET",
"ENC_BUILDING", "ENC_SYSTEM", "ENC_FIELD", "ENC_GRAPH",
"ENC_GALAXY_SETUP", "ENC_GAME_RULES", "ENC_NAMED_VALUE_REF",
"ENC_STRINGS", "ENC_TEXTURES", "ENC_HOMEWORLDS"}};
for (std::string_view str : SEARCH_TEXT_DIR_NAMES) {
auto& us_name{UserString(str)};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(LinkTaggedPresetText(TextLinker::ENCYCLOPEDIA_TAG, str, us_name).append("\n"),
str));
}
for (const auto& category_name : encyclopedia.Articles() | range_keys) {
// Do not add sub-categories
const EncyclopediaArticle& article = encyclopedia.GetArticleByKey(category_name);
// No article found or specifically a top-level category
if (!article.category.empty() && article.category != "ENC_INDEX")
continue;
auto& us_name{UserString(category_name)};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(LinkTaggedPresetText(TextLinker::ENCYCLOPEDIA_TAG, category_name, us_name).append("\n"),
category_name));
}
}
else if (dir_name == "ENC_SHIP_PART") {
for (auto& [part_name, part] : GetShipPartManager()) {
if (!exclude_custom_categories_from_dir_name ||
part->PediaTags().empty())
{
auto& us_name{UserString(part_name)};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(LinkTaggedPresetText(VarText::SHIP_PART_TAG, part_name, us_name).append("\n"),
part_name));
}
}
}
else if (dir_name == "ENC_SHIP_HULL") {
for (auto& [hull_name, hull] : GetShipHullManager()) {
if (!exclude_custom_categories_from_dir_name ||
!HasCustomCategory(hull->Tags()))
{
auto& us_name{UserString(hull_name)};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(LinkTaggedPresetText(VarText::SHIP_HULL_TAG, hull_name, us_name).append("\n"),
hull_name));
}
}
}
else if (dir_name == "ENC_TECH") {
// sort tech names by user-visible name, so names are shown alphabetically in UI
auto tech_names{GetTechManager().TechNames()};
static_assert(std::is_same_v<std::string_view, decltype(tech_names)::value_type>);
using two_sv_t = std::pair<std::string_view, std::string_view>;
std::vector<two_sv_t> userstring_tech_names;
userstring_tech_names.reserve(tech_names.size());
std::transform(tech_names.begin(), tech_names.end(), std::back_inserter(userstring_tech_names),
[](const auto tech_name) -> std::pair<std::string_view, std::string_view> {
return {UserString(tech_name), tech_name};
});
std::sort(userstring_tech_names.begin(), userstring_tech_names.end());
// second loop over alphabetically sorted names...
for (auto& [us_name, tech_name] : userstring_tech_names) {
if (!exclude_custom_categories_from_dir_name ||
GetTech(tech_name)->PediaTags().empty())
{
// already iterating over userstring-looked-up names, so don't need to re-look-up-here
std::string tagged_text{LinkTaggedPresetText(VarText::TECH_TAG, tech_name, us_name).append("\n")};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(std::move(tagged_text),
tech_name));
}
}
}
else if (dir_name == "ENC_POLICY") {
for (auto& policy_name : GetPolicyManager().PolicyNames()) {
auto& us_name{UserString(policy_name)}; // line before to avoid order of evaluation issues when moving from policy_name
std::string tagged_text{LinkTaggedPresetText(VarText::POLICY_TAG, policy_name, us_name).append("\n")};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(std::move(tagged_text),
policy_name));
}
}
else if (dir_name == "ENC_BUILDING_TYPE") {
for (const auto& [building_name, building_type] : GetBuildingTypeManager()) {
if (!exclude_custom_categories_from_dir_name ||
!HasCustomCategory(building_type->Tags()))
{
auto& us_name{UserString(building_name)};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(LinkTaggedPresetText(VarText::BUILDING_TYPE_TAG, building_name, us_name).append("\n"),
building_name));
}
}
}
else if (dir_name == "ENC_SPECIAL") {
for (auto special_name : SpecialNames()) {
auto& us_name{UserString(special_name)}; // line before to avoid order of operations issues when moving from special_name
std::string tagged_text{LinkTaggedPresetText(VarText::SPECIAL_TAG, special_name, us_name).append("\n")};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(std::move(tagged_text),
special_name));
}
}
else if (dir_name == "ENC_SPECIES") {
// directory populated with list of links to other articles that list species
if (!exclude_custom_categories_from_dir_name) {
for (const auto& species_name : GetSpeciesManager() | range_keys) {
auto& us_name{UserString(species_name)};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(LinkTaggedPresetText(VarText::SPECIES_TAG, species_name, us_name).append("\n"),
species_name));
}
}
}
else if (dir_name == "ENC_HOMEWORLDS") {
const auto& homeworlds{GetSpeciesManager().GetSpeciesHomeworldsMap()};
for (const auto& entry : GetSpeciesManager()) {
std::set<int> known_homeworlds;
std::string species_entry = LinkTaggedText(VarText::SPECIES_TAG, entry.first).append(" ");
// TODO: stealthy worlds should be hidden on the server side and not show up as clear text here, only when the empire has sufficient detection strength
// homeworld
if (!homeworlds.contains(entry.first) || homeworlds.at(entry.first).empty()) {
continue;
} else {
const auto& this_species_homeworlds = homeworlds.at(entry.first);
std::string homeworld_info;
species_entry.append("(").append(ToChars(this_species_homeworlds.size())).append("): ");
bool first = true;
for (int homeworld_id : this_species_homeworlds) {
if (first) first = false;
else homeworld_info.append(", ");
if (auto homeworld = objects.get<Planet>(homeworld_id)) {
known_homeworlds.insert(homeworld_id);
// if known, add to beginning
homeworld_info.append(
LinkTaggedIDText(VarText::PLANET_ID_TAG, homeworld_id,
homeworld->PublicName(client_empire_id, universe))
);
} else {
// add to end
homeworld_info.append(UserString("UNKNOWN_PLANET"));
}
}
species_entry += homeworld_info;
}
// occupied planets
const auto is_species_occupied = [&entry, &known_homeworlds](const auto* planet)
{ return (planet->SpeciesName() == entry.first) && !known_homeworlds.contains(planet->ID()); };
auto species_occupied_planets = objects.findRaw<Planet>(is_species_occupied);
if (!species_occupied_planets.empty()) {
if (species_occupied_planets.size() >= 5) {
species_entry.append(" | ").append(ToChars(species_occupied_planets.size()))
.append(" ").append(UserString("OCCUPIED_PLANETS"));
} else {
species_entry.append(" | ").append(UserString("OCCUPIED_PLANETS")).append(": ");
for (auto& planet : species_occupied_planets) {
species_entry.append(LinkTaggedIDText(VarText::PLANET_ID_TAG, planet->ID(),
planet->PublicName(client_empire_id, universe)))
.append(" ");
}
}
}
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(UserString(entry.first)),
std::forward_as_tuple(species_entry.append("\n"), entry.first));
}
#if defined(__cpp_lib_char8_t)
static constexpr std::u8string_view slash_thing_chars = u8"\u20E0 ";
static constexpr auto slash_thing_arr = []() {
std::array<std::string_view::value_type, slash_thing_chars.size()> retval{};
for (std::size_t idx = 0; idx < retval.size(); ++idx)
retval[idx] = slash_thing_chars[idx];
return retval;
}();
static constexpr std::string_view slash_thing(slash_thing_arr.data(), slash_thing_arr.size());
#else
static constexpr std::string_view slash_thing = u8"\u20E0 "; // "⃠" ⃠ Combining Enclosing Circle Backslash
#endif
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(slash_thing),
std::forward_as_tuple("\n\n", " "));
for (const auto& entry : GetSpeciesManager()) {
if (!homeworlds.contains(entry.first) || homeworlds.at(entry.first).empty()) {
std::string species_entry{
LinkTaggedPresetText(VarText::SPECIES_TAG, entry.first, UserString(entry.first))
.append(": ")
.append(UserString("NO_HOMEWORLD"))
.append("\n")
};
const auto& us_entry_first = UserString(entry.first);
{
std::scoped_lock prepended_lock{prepended_homeworld_names_access};
const auto& prep_entry = prepended_homeworld_names.try_emplace(
us_entry_first, std::string{slash_thing}.append(us_entry_first)).first->second;
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(prep_entry),
std::forward_as_tuple(std::move(species_entry), entry.first));
}
}
}
}
else if (dir_name == "ENC_FIELD_TYPE") {
for (const auto& [field_name, field] : GetFieldTypeManager()) {
if (!exclude_custom_categories_from_dir_name ||
!HasCustomCategory(field->Tags()))
{
auto& us_name{UserString(field_name)};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(LinkTaggedPresetText(VarText::FIELD_TYPE_TAG, field_name, us_name).append("\n"),
field_name));
}
}
}
else if (dir_name == "ENC_METER_TYPE") {
for (MeterType meter_type = MeterType::METER_POPULATION;
meter_type != MeterType::NUM_METER_TYPES;
meter_type = static_cast<MeterType>(static_cast<int>(meter_type) + 1))
{
if (meter_type > MeterType::INVALID_METER_TYPE && meter_type < MeterType::NUM_METER_TYPES)
MeterTypeDirEntry(meter_type, retval);
}
}
else if (dir_name == "ENC_EMPIRE") {
for (const auto& [id, empire] : Empires()) {
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(empire->Name()),
std::forward_as_tuple(LinkTaggedIDText(VarText::EMPIRE_ID_TAG, id, empire->Name()).append("\n"),
ToChars(id)));
}
}
else if (dir_name == "ENC_SHIP_DESIGN") {
for (const auto& [design_id, design] : universe.ShipDesigns()) {
if (design.IsMonster())
continue;
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(design.Name()),
std::forward_as_tuple(LinkTaggedIDText(VarText::DESIGN_ID_TAG, design_id, design.Name()).append("\n"),
ToChars(design_id)));
}
}
else if (dir_name == "ENC_SHIP") {
for (auto* ship : objects.allRaw<Ship>()) {
auto& ship_name = ship->PublicName(client_empire_id, universe);
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(ship_name),
std::forward_as_tuple(LinkTaggedIDText(VarText::SHIP_ID_TAG, ship->ID(), ship_name).append(" "),
ToChars(ship->ID())));
}
}
else if (dir_name == "ENC_MONSTER") {
for (auto* ship : objects.allRaw<Ship>()) {
if (!ship->IsMonster(universe))
continue;
auto& ship_name = ship->PublicName(client_empire_id, universe);
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(ship_name),
std::forward_as_tuple(LinkTaggedIDText(VarText::SHIP_ID_TAG, ship->ID(), ship_name).append(" "),
ToChars(ship->ID())));
}
}
else if (dir_name == "ENC_MONSTER_TYPE") {
for (const auto& [design_id, design] : universe.ShipDesigns()) {
if (design.IsMonster())
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(design.Name()),
std::forward_as_tuple(LinkTaggedIDText(VarText::DESIGN_ID_TAG, design_id, design.Name()).append("\n"),
ToChars(design_id)));
}
}
else if (dir_name == "ENC_FLEET") {
for (auto* fleet : objects.allRaw<Fleet>()) {
auto& flt_name = fleet->PublicName(client_empire_id, universe);
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(flt_name),
std::forward_as_tuple(LinkTaggedIDText(VarText::FLEET_ID_TAG, fleet->ID(), flt_name).append(" "),
ToChars(fleet->ID())));
}
}
else if (dir_name == "ENC_PLANET") {
for (auto* planet : objects.allRaw<Planet>()) {
auto& plt_name = planet->PublicName(client_empire_id, universe);
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(plt_name),
std::forward_as_tuple(LinkTaggedIDText(VarText::PLANET_ID_TAG, planet->ID(), plt_name).append(" "),
ToChars(planet->ID())));
}
}
else if (dir_name == "ENC_BUILDING") {
for (auto* building : objects.allRaw<Building>()) {
auto& bld_name = building->PublicName(client_empire_id, universe);
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(bld_name),
std::forward_as_tuple(LinkTaggedIDText(VarText::BUILDING_ID_TAG, building->ID(), bld_name).append(" "),
ToChars(building->ID())));
}
}
else if (dir_name == "ENC_SYSTEM") {
for (auto* system : objects.allRaw<System>()) {
auto sys_name = system->ApparentName(client_empire_id, universe);
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(sys_name),
std::forward_as_tuple(LinkTaggedIDText(VarText::SYSTEM_ID_TAG, system->ID(), sys_name).append(" "),
ToChars(system->ID())));
}
}
else if (dir_name == "ENC_FIELD") {
for (auto* field : objects.allRaw<Field>()) {
std::string_view field_name = field->Name();
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(field_name),
std::forward_as_tuple(LinkTaggedIDText(VarText::FIELD_ID_TAG, field->ID(), field_name).append(" "),
ToChars(field->ID())));
}
}
else if (dir_name == "ENC_GRAPH") {
for (const auto& stat_record : universe.GetStatRecords()) {
auto& us_name{UserString(stat_record.first)};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(LinkTaggedPresetText(TextLinker::GRAPH_TAG, stat_record.first, us_name).append("\n"),
stat_record.first));
}
}
else if (dir_name == "ENC_TEXTURES") {
for (auto& [tex_name, tex] : GG::GetTextureManager().Textures()) {
auto texture_info_str = boost::io::str(
FlexibleFormat(UserString("ENC_TEXTURE_INFO")) %
Value(tex->Width()) %
Value(tex->Height()) %
tex->BytesPP() %
tex_name);
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(tex_name),
std::forward_as_tuple(std::move(texture_info_str),
tex_name));
}
}
else if (dir_name == "ENC_STRINGS") {
// show all stringable keys and values
for (auto& [str_key, str_val] : AllStringtableEntries())
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(str_key),
std::forward_as_tuple(str_key + ": " + str_val + "\n",
str_key));
}
else if (dir_name == "ENC_NAMED_VALUE_REF") {
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple("ENC_NAMED_VALUE_REF_DESC"),
std::forward_as_tuple(UserString("ENC_NAMED_VALUE_REF_DESC") + "\n\n", dir_name));
for (auto& [ref_key, val_ref] : GetNamedValueRefManager().GetItems()) {
auto& vref = val_ref.get();
std::string_view value_type = dynamic_cast<ValueRef::ValueRef<int>*>(&vref)? " int " : (dynamic_cast<ValueRef::ValueRef<double>*>(&vref)?" real ":" any ");
std::string_view key_str = UserStringExists(ref_key) ?
std::string_view{UserString(ref_key)} : std::string_view{""};
// (human-readable article name) -> (link tag text, category stringtable key)
retval.emplace_back(
std::piecewise_construct,
std::forward_as_tuple(ref_key),
std::forward_as_tuple(std::string{ref_key}.append(value_type)
.append(LinkTaggedPresetText(VarText::FOCS_VALUE_TAG, ref_key, key_str))
.append(key_str.empty() ? "" : (std::string{" '"}.append(key_str).append(" '")))
.append(" ").append(vref.InvariancePattern().append("\n")),
dir_name));
}
}
else {
// Any content definitions (FOCS files) that define a pedia category
// should have their pedia article added to this category.
std::vector<std::pair<std::string_view, std::pair<std::string_view, std::string_view>>> dir_entries;
dir_entries.reserve(GetShipPartManager().size() + GetShipHullManager().size() +
GetTechManager().size() + GetBuildingTypeManager().NumBuildingTypes() +
GetSpeciesManager().NumSpecies() + GetFieldTypeManager().size());
// part types
for (auto& [part_name, part_type] : GetShipPartManager())
if (HasCustomCategoryNoPrefixCheck(part_type->PediaTags(), dir_name))
dir_entries.emplace_back(std::piecewise_construct,
std::forward_as_tuple(UserString(part_name)),
std::forward_as_tuple(VarText::SHIP_PART_TAG, part_name));
// hull types
for (auto& [hull_name, hull_type] : GetShipHullManager())
if (HasCustomCategory(hull_type->Tags(), dir_name))
dir_entries.emplace_back(std::piecewise_construct,
std::forward_as_tuple(UserString(hull_name)),
std::forward_as_tuple(VarText::SHIP_HULL_TAG, hull_name));
// techs
for (const auto& [tech_name, tech] : GetTechManager()) {
if (HasCustomCategoryNoPrefixCheck(tech.PediaTags(), dir_name))
dir_entries.emplace_back(std::piecewise_construct,
std::forward_as_tuple(UserString(tech_name)),
std::forward_as_tuple(VarText::TECH_TAG, tech_name));
}
// building types
for (auto& [building_name, building_type] : GetBuildingTypeManager())
if (HasCustomCategory(building_type->Tags(), dir_name))
dir_entries.emplace_back(std::piecewise_construct,
std::forward_as_tuple(UserString(building_name)),
std::forward_as_tuple(VarText::BUILDING_TYPE_TAG, building_name));
// species
for (auto& [species_name, species] : GetSpeciesManager())
if (dir_name == "ALL_SPECIES" ||
(dir_name == "NATIVE_SPECIES" && species.Native()) ||
(dir_name == "PLAYABLE_SPECIES" && species.Playable()) ||
HasCustomCategoryNoPrefixes(species.PediaTags(), dir_name))
{
dir_entries.emplace_back(std::piecewise_construct,
std::forward_as_tuple(UserString(species_name)),
std::forward_as_tuple(VarText::SPECIES_TAG, species_name));
}
// field types
for (auto& [field_name, field_type] : GetFieldTypeManager())
if (HasCustomCategory(field_type->Tags(), dir_name))
dir_entries.emplace_back(std::piecewise_construct,
std::forward_as_tuple(UserString(field_name)),
std::forward_as_tuple(VarText::FIELD_TYPE_TAG, field_name));
// Sort entries, keyed by human-readable article name,
// containing (tag, article stringtable key)
std::sort(dir_entries.begin(), dir_entries.end());
for (auto& [readable_name, tag_key] : dir_entries) {
auto linked_text{LinkTaggedText(tag_key.first, tag_key.second).append("\n")};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(readable_name),
std::forward_as_tuple(std::move(linked_text), tag_key.second));
}
}
// Add any defined entries for this directory
const auto& articles = encyclopedia.Articles();
if (auto category_it = articles.find(dir_name); category_it != articles.end()) {
for (const EncyclopediaArticle& article : category_it->second) {
// Prevent duplicate addition of hard-coded directories that also have a content definition
if (article.name == dir_name)
continue;
auto& us_name{UserString(article.name)};
retval.emplace_back(std::piecewise_construct,
std::forward_as_tuple(us_name),
std::forward_as_tuple(LinkTaggedPresetText(TextLinker::ENCYCLOPEDIA_TAG, article.name, us_name) + "\n",
article.name));
}
}
if (!retval.empty()) {
if (dir_name == "ENC_NAMED_VALUE_REF") {
// leave explanitory text first
std::sort(std::next(retval.begin()), retval.end());
} else {
std::sort(retval.begin(), retval.end());
}
}
return retval;
}
std::string PediaDirText(const std::string& dir_name) {
// get sorted list of entries for requested directory
auto sorted_entries = GetSortedPediaDirEntires(dir_name, true);
std::string retval;
retval.reserve(sorted_entries.size() * 256); // rough guesstimate
// add sorted entries linktext representation to page text
for (const auto& entry : sorted_entries)
retval += entry.second.first;
return retval;
}
}
namespace {
class SearchEdit : public CUIEdit {
public:
SearchEdit() :
CUIEdit("")
{ DisallowChars("\n\r"); }
void KeyPress(GG::Key key, uint32_t key_code_point, GG::Flags<GG::ModKey> mod_keys) override {
switch (key) {
case GG::Key::GGK_RETURN:
case GG::Key::GGK_KP_ENTER:
TextEnteredSignal();
break;
default:
break;
}
CUIEdit::KeyPress(key, key_code_point, mod_keys);
}
mutable boost::signals2::signal<void ()> TextEnteredSignal;
};
}
std::list<std::pair<std::string, std::string>>
EncyclopediaDetailPanel::m_items = std::list<std::pair<std::string, std::string>>(0);
std::list<std::pair<std::string, std::string>>::iterator
EncyclopediaDetailPanel::m_items_it = m_items.begin();
EncyclopediaDetailPanel::EncyclopediaDetailPanel(GG::Flags<GG::WndFlag> flags,
std::string_view config_name) :
CUIWnd(UserString("MAP_BTN_PEDIA"), flags, config_name, false)
{}
void EncyclopediaDetailPanel::CompleteConstruction() {
CUIWnd::CompleteConstruction();
const int PTS = ClientUI::Pts();
const int NAME_PTS = PTS*3/2;
const int SUMMARY_PTS = PTS*4/3;
static constexpr GG::X CONTROL_WIDTH{54};
static constexpr GG::Y CONTROL_HEIGHT{74};
const GG::Pt PALETTE_MIN_SIZE{GG::X{CONTROL_WIDTH + 70}, GG::Y{CONTROL_HEIGHT + 70}};
m_name_text = GG::Wnd::Create<CUILabel>("");
m_cost_text = GG::Wnd::Create<CUILabel>("");
m_summary_text = GG::Wnd::Create<CUILabel>("");
m_name_text->SetFont(ClientUI::GetBoldFont(NAME_PTS));
m_summary_text->SetFont(ClientUI::GetFont(SUMMARY_PTS));
boost::filesystem::path button_texture_dir = ClientUI::ArtDir() / "icons" / "buttons";
m_index_button = Wnd::Create<CUIButton>(
GG::SubTexture(ClientUI::GetTexture(button_texture_dir / "uparrownormal.png")),
GG::SubTexture(ClientUI::GetTexture(button_texture_dir / "uparrowclicked.png")),
GG::SubTexture(ClientUI::GetTexture(button_texture_dir / "uparrowmouseover.png")));
m_back_button = Wnd::Create<CUIButton>(
GG::SubTexture(ClientUI::GetTexture(button_texture_dir / "leftarrownormal.png")),
GG::SubTexture(ClientUI::GetTexture(button_texture_dir / "leftarrowclicked.png")),
GG::SubTexture(ClientUI::GetTexture(button_texture_dir / "leftarrowmouseover.png")));
m_next_button = Wnd::Create<CUIButton>(
GG::SubTexture(ClientUI::GetTexture(button_texture_dir / "rightarrownormal.png")),
GG::SubTexture(ClientUI::GetTexture(button_texture_dir / "rightarrowclicked.png")),
GG::SubTexture(ClientUI::GetTexture(button_texture_dir / "rightarrowmouseover.png")));
m_back_button->Disable();
m_next_button->Disable();
m_index_button->LeftClickedSignal.connect(boost::bind(&EncyclopediaDetailPanel::OnIndex, this));
m_back_button->LeftClickedSignal.connect(boost::bind(&EncyclopediaDetailPanel::OnBack, this));
m_next_button->LeftClickedSignal.connect(boost::bind(&EncyclopediaDetailPanel::OnNext, this));
m_description_rich_text = GG::Wnd::Create<GG::RichText>(
GG::X0, GG::Y0, ClientWidth(), ClientHeight(), "",
ClientUI::GetFont(), ClientUI::TextColor(),
GG::FORMAT_TOP | GG::FORMAT_LEFT | GG::FORMAT_LINEWRAP | GG::FORMAT_WORDBREAK,
GG::INTERACTIVE);
m_scroll_panel = GG::Wnd::Create<GG::ScrollPanel>(GG::X0, GG::Y0, ClientWidth(),
ClientHeight(), m_description_rich_text);
namespace ph = boost::placeholders;
// Create a block factory that handles link clicks via this panel
auto factory = std::make_shared<CUILinkTextBlock::Factory>();
factory->LinkClickedSignal.connect(
boost::bind(&EncyclopediaDetailPanel::HandleLinkClick, this, ph::_1, ph::_2));
factory->LinkDoubleClickedSignal.connect(
boost::bind(&EncyclopediaDetailPanel::HandleLinkDoubleClick, this, ph::_1, ph::_2));
factory->LinkRightClickedSignal.connect(
boost::bind(&EncyclopediaDetailPanel::HandleLinkDoubleClick, this, ph::_1, ph::_2));
// make copy of default block factories map
auto custom_block_factory_map{GG::RichText::DefaultBlockFactoryMap()};
// insert or replace plain text factory with one made above
auto plain_text_it = std::find_if(custom_block_factory_map.begin(), custom_block_factory_map.end(),
[](const auto& fac) { return fac.first == GG::RichText::PLAINTEXT_TAG; });
if (plain_text_it == custom_block_factory_map.end())
custom_block_factory_map.emplace_back(GG::RichText::PLAINTEXT_TAG, std::move(factory));
else
plain_text_it->second = std::move(factory);
// use block factory map modified copy for this control
m_description_rich_text->SetBlockFactoryMap(std::move(custom_block_factory_map));
m_description_rich_text->SetPadding(DESCRIPTION_PADDING);
m_scroll_panel->SetBackgroundColor(ClientUI::CtrlColor());
m_scroll_panel->InstallEventFilter(shared_from_this());
m_graph = GG::Wnd::Create<GraphControl>();
m_graph->ShowPoints(false);
auto search_edit = GG::Wnd::Create<SearchEdit>();
search_edit->TextEnteredSignal.connect(boost::bind(&EncyclopediaDetailPanel::HandleSearchTextEntered, this));
m_search_edit = std::move(search_edit);
AttachChild(m_search_edit);
AttachChild(m_graph);
AttachChild(m_name_text);
AttachChild(m_cost_text);
AttachChild(m_summary_text);
AttachChild(m_scroll_panel);
AttachChild(m_index_button);
AttachChild(m_back_button);
AttachChild(m_next_button);
SetChildClippingMode(ChildClippingMode::ClipToWindow);
DoLayout();
SetMinSize(PALETTE_MIN_SIZE);
MoveChildUp(m_graph);
SaveDefaultedOptions();
AddItem(TextLinker::ENCYCLOPEDIA_TAG, "ENC_INDEX");
}
namespace {
constexpr int BTN_WIDTH = 36;
constexpr int PAD = 2;
int IconSize() {
const int NAME_PTS = ClientUI::TitlePts();
const int COST_PTS = ClientUI::Pts();
const int SUMMARY_PTS = ClientUI::Pts()*4/3;
return 12 + NAME_PTS + COST_PTS + SUMMARY_PTS;
}
}
void EncyclopediaDetailPanel::DoLayout() {
const int NAME_PTS = ClientUI::TitlePts();
const int COST_PTS = ClientUI::Pts();
const int SUMMARY_PTS = ClientUI::Pts()*4/3;
const int ICON_SIZE = IconSize();
SectionedScopedTimer timer("EncyclopediaDetailPanel::DoLayout");
// name
GG::Pt ul = GG::Pt(BORDER_LEFT, CUIWnd::TopBorder() + PAD);
GG::Pt lr = ul + GG::Pt(Width(), GG::Y(NAME_PTS + 2*PAD));
m_name_text->SetTextFormat(GG::FORMAT_LEFT);
m_name_text->SizeMove(ul, lr);
// cost / turns
ul += GG::Pt(GG::X0, m_name_text->Height() + PAD);
lr = ul + GG::Pt(Width(), GG::Y(COST_PTS + 2*PAD));
m_cost_text->SetTextFormat(GG::FORMAT_LEFT);
m_cost_text->SizeMove(ul, lr);
// one line summary
ul += GG::Pt(GG::X0, m_cost_text->Height());
lr = ul + GG::Pt(Width(), GG::Y(SUMMARY_PTS + 2*PAD));
m_summary_text->SetTextFormat(GG::FORMAT_LEFT);
m_summary_text->SizeMove(ul, lr);
// "back" button
ul = GG::Pt{BORDER_LEFT, ICON_SIZE + CUIWnd::TopBorder() + PAD*2};
lr = ul + GG::Pt{GG::X{BTN_WIDTH}, GG::Y{BTN_WIDTH}};
m_back_button->SizeMove(ul, lr);
ul += GG::Pt{GG::X{BTN_WIDTH}, GG::Y0};
// "up" button
lr = ul + GG::Pt{GG::X{BTN_WIDTH}, GG::Y{BTN_WIDTH}};
m_index_button->SizeMove(ul, lr);
ul += GG::Pt{GG::X{BTN_WIDTH}, GG::Y0};
// "next" button
lr = ul + GG::Pt{GG::X{BTN_WIDTH}, GG::Y{BTN_WIDTH}};
m_next_button->SizeMove(ul, lr);
ul += GG::Pt{GG::X{BTN_WIDTH}, GG::Y0};
// search edit box
lr = GG::Pt{ClientWidth(), ul.y + GG::Y{BTN_WIDTH}};
m_search_edit->SizeMove(ul, lr);
// main verbose description (fluff, effects, unlocks, ...)
ul = GG::Pt{BORDER_LEFT, lr.y + PAD*3};
lr = ClientSize() - GG::Pt{GG::X0, GG::Y{CUIWnd::INNER_BORDER_ANGLE_OFFSET}};
timer.EnterSection("m_scroll_panel->SizeMove");
m_scroll_panel->SizeMove(ul, lr);
timer.EnterSection("");
// graph
m_graph->SizeMove(ul + GG::Pt(GG::X1, GG::Y1), lr - GG::Pt(GG::X1, GG::Y1));
// icon
if (m_icon) {
lr = GG::Pt(Width() - BORDER_RIGHT, GG::Y(ICON_SIZE + CUIWnd::TopBorder()));
ul = lr - GG::Pt(GG::X(ICON_SIZE), GG::Y(ICON_SIZE));
m_icon->SizeMove(ul, lr);
}
PositionButtons();
MoveChildUp(m_close_button); // so it's over top of the top-right icon
}
void EncyclopediaDetailPanel::SizeMove(GG::Pt ul, GG::Pt lr) {
GG::Pt old_size = GG::Wnd::Size();
CUIWnd::SizeMove(ul, lr);
if (old_size != GG::Wnd::Size())
RequirePreRender();
}
void EncyclopediaDetailPanel::KeyPress(GG::Key key, uint32_t key_code_point,
GG::Flags<GG::ModKey> mod_keys)
{
if (key == GG::Key::GGK_RETURN || key == GG::Key::GGK_KP_ENTER) {
GG::GUI::GetGUI()->SetFocusWnd(m_search_edit);
} else if (key == GG::Key::GGK_BACKSPACE) {
this->OnBack();
} else {
m_scroll_panel->KeyPress(key, key_code_point, mod_keys);
}
}
void EncyclopediaDetailPanel::Render() {
CUIWnd::Render();
// title underline
glDisable(GL_TEXTURE_2D);
glLineWidth(1.0f);
glPushClientAttrib(GL_CLIENT_ALL_ATTRIB_BITS);
glEnableClientState(GL_VERTEX_ARRAY);
glDisableClientState(GL_COLOR_ARRAY);
glDisableClientState(GL_TEXTURE_COORD_ARRAY);
m_vertex_buffer.activate();
if (!m_minimized) {
glColor(ClientUI::WndInnerBorderColor());
glDrawArrays(GL_LINES, m_buffer_indices[4].first, m_buffer_indices[4].second);
}
glEnable(GL_TEXTURE_2D);
glPopClientAttrib();
}
void EncyclopediaDetailPanel::InitBuffers() {
m_vertex_buffer.clear();
m_vertex_buffer.reserve(19);
m_buffer_indices.resize(5);
std::size_t previous_buffer_size = m_vertex_buffer.size();
GG::Pt ul = UpperLeft();
GG::Pt lr = LowerRight();
const GG::Y ICON_SIZE = m_summary_text->Bottom() - m_name_text->Top();
GG::Pt cl_ul = ul + GG::Pt(BORDER_LEFT, ICON_SIZE + CUIWnd::TopBorder() + BTN_WIDTH + PAD*3);
GG::Pt cl_lr = lr - GG::Pt(BORDER_RIGHT, BORDER_BOTTOM);
// within m_vertex_buffer:
// [0] is the start and range for minimized background triangle fan and minimized border line loop
// [1] is ... the background fan / outer border line loop
// [2] is ... the inner border line loop
// [3] is ... the resize tab line list
// minimized background fan and border line loop
m_vertex_buffer.store(Value(ul.x), Value(ul.y));
m_vertex_buffer.store(Value(lr.x), Value(ul.y));
m_vertex_buffer.store(Value(lr.x), Value(lr.y));
m_vertex_buffer.store(Value(ul.x), Value(lr.y));
m_buffer_indices[0].first = previous_buffer_size;
m_buffer_indices[0].second = m_vertex_buffer.size() - previous_buffer_size;
previous_buffer_size = m_vertex_buffer.size();
// outer border, with optional corner cutout
m_vertex_buffer.store(Value(ul.x), Value(ul.y));
m_vertex_buffer.store(Value(lr.x), Value(ul.y));
if (!m_resizable) {
m_vertex_buffer.store(Value(lr.x), Value(lr.y) - OUTER_EDGE_ANGLE_OFFSET);
m_vertex_buffer.store(Value(lr.x) - OUTER_EDGE_ANGLE_OFFSET, Value(lr.y));
} else {
m_vertex_buffer.store(Value(lr.x), Value(lr.y));
}
m_vertex_buffer.store(Value(ul.x), Value(lr.y));
m_buffer_indices[1].first = previous_buffer_size;
m_buffer_indices[1].second = m_vertex_buffer.size() - previous_buffer_size;
previous_buffer_size = m_vertex_buffer.size();
// inner border, with optional corner cutout
m_vertex_buffer.store(Value(cl_ul.x), Value(cl_ul.y));
m_vertex_buffer.store(Value(cl_lr.x), Value(cl_ul.y));
if (m_resizable) {
m_vertex_buffer.store(Value(cl_lr.x), Value(cl_lr.y) - INNER_BORDER_ANGLE_OFFSET);
m_vertex_buffer.store(Value(cl_lr.x) - INNER_BORDER_ANGLE_OFFSET, Value(cl_lr.y));
} else {
m_vertex_buffer.store(Value(cl_lr.x), Value(cl_lr.y));
}
m_vertex_buffer.store(Value(cl_ul.x), Value(cl_lr.y));
m_buffer_indices[2].first = previous_buffer_size;
m_buffer_indices[2].second = m_vertex_buffer.size() - previous_buffer_size;
previous_buffer_size = m_vertex_buffer.size();
// resize hash marks
m_vertex_buffer.store(Value(cl_lr.x), Value(cl_lr.y) - RESIZE_HASHMARK1_OFFSET);
m_vertex_buffer.store(Value(cl_lr.x) - RESIZE_HASHMARK1_OFFSET, Value(cl_lr.y));
m_vertex_buffer.store(Value(cl_lr.x), Value(cl_lr.y) - RESIZE_HASHMARK2_OFFSET);
m_vertex_buffer.store(Value(cl_lr.x) - RESIZE_HASHMARK2_OFFSET, Value(cl_lr.y));
m_buffer_indices[3].first = previous_buffer_size;
m_buffer_indices[3].second = m_vertex_buffer.size() - previous_buffer_size;
previous_buffer_size = m_vertex_buffer.size();
// title underline
GG::Pt underline_ul{UpperLeft() + GG::Pt{BORDER_LEFT, CUIWnd::TopBorder() - 2}};
GG::Pt underline_lr{underline_ul + GG::Pt{Width() - BORDER_RIGHT*3, GG::Y0}};
m_vertex_buffer.store(Value(underline_ul.x), Value(underline_ul.y));
m_vertex_buffer.store(Value(underline_lr.x), Value(underline_lr.y));
m_buffer_indices[4].first = previous_buffer_size;
m_buffer_indices[4].second = m_vertex_buffer.size() - previous_buffer_size;
//previous_buffer_size = m_vertex_buffer.size();
m_vertex_buffer.createServerBuffer();
}
void EncyclopediaDetailPanel::HandleLinkClick(const std::string& link_type, const std::string& data) {
if (link_type == VarText::PLANET_ID_TAG) {
auto id = ToInt(data, INVALID_OBJECT_ID);
ClientUI::GetClientUI()->ZoomToPlanet(id);
this->SetPlanet(id);
} else if (link_type == VarText::SYSTEM_ID_TAG) {
ClientUI::GetClientUI()->ZoomToSystem(ToInt(data, INVALID_OBJECT_ID));
} else if (link_type == VarText::FLEET_ID_TAG) {
ClientUI::GetClientUI()->ZoomToFleet(ToInt(data, INVALID_OBJECT_ID));
} else if (link_type == VarText::SHIP_ID_TAG) {
ClientUI::GetClientUI()->ZoomToShip(ToInt(data, INVALID_OBJECT_ID));
} else if (link_type == VarText::BUILDING_ID_TAG) {
ClientUI::GetClientUI()->ZoomToBuilding(ToInt(data, INVALID_OBJECT_ID));
} else if (link_type == VarText::FIELD_ID_TAG) {
ClientUI::GetClientUI()->ZoomToField(ToInt(data, INVALID_OBJECT_ID));
} else if (link_type == VarText::COMBAT_ID_TAG) {
ClientUI::GetClientUI()->ZoomToCombatLog(ToInt(data, CombatLogManager::INVALID_COMBAT_LOG_ID));
} else if (link_type == VarText::EMPIRE_ID_TAG) {
this->SetEmpire(ToInt(data, ALL_EMPIRES));
} else if (link_type == VarText::DESIGN_ID_TAG) {
this->SetDesign(ToInt(data, INVALID_DESIGN_ID));
} else if (link_type == VarText::PREDEFINED_DESIGN_TAG) {
if (const ShipDesign* design = GetUniverse().GetGenericShipDesign(data))
this->SetDesign(design->ID());
} else if (link_type == VarText::TECH_TAG) {
this->SetTech(data);
} else if (link_type == VarText::POLICY_TAG) {
this->SetPolicy(data);
} else if (link_type == VarText::BUILDING_TYPE_TAG) {
this->SetBuildingType(data);
} else if (link_type == VarText::FIELD_TYPE_TAG) {
this->SetFieldType(data);
} else if (link_type == VarText::METER_TYPE_TAG) {
this->SetMeterType(data);
} else if (link_type == VarText::SPECIAL_TAG) {
this->SetSpecial(data);
} else if (link_type == VarText::SHIP_HULL_TAG) {
this->SetShipHull(data);
} else if (link_type == VarText::SHIP_PART_TAG) {
this->SetShipPart(data);
} else if (link_type == VarText::SPECIES_TAG) {
this->SetSpecies(data);
} else if (link_type == TextLinker::ENCYCLOPEDIA_TAG) {
this->SetText(data, false);
} else if (link_type == TextLinker::GRAPH_TAG) {
this->SetGraph(data);
} else if (link_type == TextLinker::URL_TAG) {
GGHumanClientApp::GetApp()->OpenURL(data);
} else if (link_type == TextLinker::BROWSE_PATH_TAG) {
GGHumanClientApp::GetApp()->BrowsePath(FilenameToPath(data));
}
}
void EncyclopediaDetailPanel::HandleLinkDoubleClick(const std::string& link_type, const std::string& data) {
using boost::lexical_cast;
try {
if (link_type == VarText::PLANET_ID_TAG) {
ClientUI::GetClientUI()->ZoomToPlanet(lexical_cast<int>(data));
} else if (link_type == VarText::SYSTEM_ID_TAG) {
ClientUI::GetClientUI()->ZoomToSystem(lexical_cast<int>(data));
} else if (link_type == VarText::FLEET_ID_TAG) {
ClientUI::GetClientUI()->ZoomToFleet(lexical_cast<int>(data));
} else if (link_type == VarText::SHIP_ID_TAG) {
ClientUI::GetClientUI()->ZoomToShip(lexical_cast<int>(data));
} else if (link_type == VarText::BUILDING_ID_TAG) {
ClientUI::GetClientUI()->ZoomToBuilding(lexical_cast<int>(data));
} else if (link_type == VarText::EMPIRE_ID_TAG) {
ClientUI::GetClientUI()->ZoomToEmpire(lexical_cast<int>(data));
} else if (link_type == VarText::DESIGN_ID_TAG) {
ClientUI::GetClientUI()->ZoomToShipDesign(lexical_cast<int>(data));
} else if (link_type == VarText::PREDEFINED_DESIGN_TAG) {
if (const ShipDesign* design = GetUniverse().GetGenericShipDesign(data))
ClientUI::GetClientUI()->ZoomToShipDesign(design->ID());
} else if (link_type == VarText::TECH_TAG) {
ClientUI::GetClientUI()->ZoomToTech(data);
} else if (link_type == VarText::POLICY_TAG) {
ClientUI::GetClientUI()->ZoomToPolicy(data);
} else if (link_type == VarText::BUILDING_TYPE_TAG) {
ClientUI::GetClientUI()->ZoomToBuildingType(data);
} else if (link_type == VarText::SPECIAL_TAG) {
ClientUI::GetClientUI()->ZoomToSpecial(data);
} else if (link_type == VarText::SHIP_HULL_TAG) {
ClientUI::GetClientUI()->ZoomToShipHull(data);
} else if (link_type == VarText::SHIP_PART_TAG) {
ClientUI::GetClientUI()->ZoomToShipPart(data);
} else if (link_type == VarText::SPECIES_TAG) {
ClientUI::GetClientUI()->ZoomToSpecies(data);
} else if (link_type == TextLinker::ENCYCLOPEDIA_TAG) {
this->SetText(data, false);
} else if (link_type == TextLinker::GRAPH_TAG) {
this->SetGraph(data);
}
} catch (const boost::bad_lexical_cast&) {
ErrorLogger() << "EncyclopediaDetailPanel::HandleLinkDoubleClick caught lexical cast exception for link type: " << link_type << " and data: " << data;
}
}
namespace {
/** Recursively searches pedia directory \a dir_name for articles and
* sub-directories. Returns a map from
* (article_key, dir_name) to (readable_article_name, link_text) */
[[nodiscard]] auto GetSubDirs(std::string_view dir_name,
bool exclude_custom_categories_from_dir_name = true,
int depth = 0)
{
std::map<std::pair<std::string, std::string>, std::pair<std::string, std::string>> retval;
if (dir_name == "ENC_STRINGS")
return retval;
ScopedTimer subdir_timer{
std::string{"GetSubDirs("}.append(dir_name).append(", ")
.append(ToChars(exclude_custom_categories_from_dir_name))
.append(", ").append(ToChars(depth) + ")")};
depth++;
// safety check to pre-empt potential infinite loop
if (depth > 50) {
WarnLogger() << "Exceeded recursive limit with lookup for pedia category " << dir_name;
return retval;
}
// map from (human readable article name) to (article-link-tag-text, article name stringtable key)
auto sorted_entries = GetSortedPediaDirEntires(dir_name, exclude_custom_categories_from_dir_name);
std::vector<std::future<decltype(GetSubDirs(""))>> futures;
futures.reserve(sorted_entries.size());
for (auto& [readable_article_name, link_key] : sorted_entries) {
auto& [link_text, key] = link_key;
if (!utf8::is_valid(readable_article_name.begin(), readable_article_name.end())) {
ErrorLogger() << "GetSubDirs invalid article name: " << readable_article_name
<< " with key: " << key;
}
// explicitly exclude textures and input directory itself
if (key == "ENC_TEXTURES" || key == dir_name)
continue;
futures.push_back(std::async(std::launch::async,
GetSubDirs,
key, exclude_custom_categories_from_dir_name, depth));
retval.emplace(std::pair{key, dir_name}, // don't move from key as it's viewed by the above future
std::pair{std::move(readable_article_name), std::move(link_text)});
}
for (auto& fut : futures)
retval.merge(fut.get());
return retval;
}
[[nodiscard]] int DefaultLocationForEmpire(int empire_id, const ScriptingContext& context) {
if (empire_id == ALL_EMPIRES)
return INVALID_OBJECT_ID;
const auto empire = context.GetEmpire(empire_id);
if (!empire) {
DebugLogger() << "DefaultLocationForEmpire: Unable to get empire with ID: " << empire_id;
return INVALID_OBJECT_ID;
}
// get a location where the empire might build something.
const UniverseObject* location = context.ContextObjects().getRaw(empire->CapitalID());
// no capital? scan through all objects to find one owned by this empire
// TODO: only loop over planets?
// TODO: pass in a location condition, and pick a location that matches it if possible
if (!location) {
for (const auto* obj : context.ContextObjects().allRaw()) {
if (obj->OwnedBy(empire_id)) {
location = obj;
break;
}
}
}
return location ? location->ID() : INVALID_OBJECT_ID;
}
[[nodiscard]] std::vector<std::string> TechsThatUnlockItem(const UnlockableItem& item) {
std::vector<std::string> retval;
retval.reserve(GetTechManager().size()); // rough guesstimate
// transform_if
for (const auto& [tech_name, tech] : GetTechManager()) {
const auto& tech_items = tech.UnlockedItems();
auto it = std::find(tech_items.begin(), tech_items.end(), item);
if (it != tech_items.end())
retval.push_back(tech_name);
}
return retval;
}
[[nodiscard]] std::vector<std::string> PoliciesThatUnlockItem(const UnlockableItem& item) {
std::vector<std::string> retval;
for (auto& [policy_name, policy] : GetPolicyManager()) {
// transform_if
const auto& unlocks = policy.UnlockedItems();
const auto it = std::find(unlocks.begin(), unlocks.end(), item);
if (it != unlocks.end())
retval.push_back(policy_name);
}
return retval;
}
[[nodiscard]] const std::string& GeneralTypeOfObject(UniverseObjectType obj_type) {
switch (obj_type) {
case UniverseObjectType::OBJ_SHIP: return UserString("ENC_SHIP"); break;
case UniverseObjectType::OBJ_FLEET: return UserString("ENC_FLEET"); break;
case UniverseObjectType::OBJ_PLANET: return UserString("ENC_PLANET"); break;
case UniverseObjectType::OBJ_BUILDING: return UserString("ENC_BUILDING"); break;
case UniverseObjectType::OBJ_SYSTEM: return UserString("ENC_SYSTEM"); break;
case UniverseObjectType::OBJ_FIELD: return UserString("ENC_FIELD"); break;
case UniverseObjectType::OBJ_FIGHTER: return UserString("ENC_FIGHTER"); break;
default: return EMPTY_STRING;
}
}
void RefreshDetailPanelPediaTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color)
{
name = UserString(item_name);
// special case for galaxy setup data: display info
if (item_name == "ENC_GALAXY_SETUP") {
const GalaxySetupData& gsd = ClientApp::GetApp()->GetGalaxySetupData();
detailed_description += str(FlexibleFormat(UserString("ENC_GALAXY_SETUP_SETTINGS"))
% gsd.seed
% ToChars(gsd.size)
% TextForGalaxyShape(gsd.shape)
% TextForGalaxySetupSetting(gsd.age)
% TextForGalaxySetupSetting(gsd.starlane_freq)
% TextForGalaxySetupSetting(gsd.planet_density)
% TextForGalaxySetupSetting(gsd.specials_freq)
% TextForGalaxySetupSetting(gsd.monster_freq)
% TextForGalaxySetupSetting(gsd.native_freq)
% TextForAIAggression(gsd.ai_aggr)
% gsd.game_uid);
return;
}
else if (item_name == "ENC_GAME_RULES") {
std::string_view last_category;
detailed_description += UserString("GENERAL") + ":\n";
for (const auto* rule : GetGameRules().GetSortedByCategoryAndRank()) {
if (last_category != rule->category) {
last_category = rule->category;
detailed_description += "\n\n" + UserString(last_category.empty() ? "GENERAL" : last_category) + ":\n";
}
if (rule->ValueIsDefault())
detailed_description += " " + UserString(rule->name) + " : " + rule->ValueToString() + "\n";
else
detailed_description += " <u>" + UserString(rule->name) + " : " + rule->ValueToString() + "</u>\n";
}
return;
}
// search for article in custom pedia entries.
for (const auto& entry : GetEncyclopedia().Articles()) {
bool done = false;
for (const EncyclopediaArticle& article : entry.second) {
if (article.name != item_name)
continue;
detailed_description = UserString(article.description);
const std::string& article_cat = article.category;
if (article_cat != "ENC_INDEX" && !article_cat.empty())
general_type = UserString(article_cat);
const std::string& article_brief = article.short_description;
if (!article_brief.empty())
specific_type = UserString(article_brief);
texture = ClientUI::GetTexture(ClientUI::ArtDir() / article.icon, true);
done = true;
break;
}
if (done)
break;
}
// add listing of articles in this category
auto dir_text = PediaDirText(item_name);
if (dir_text.empty())
return;
if (!detailed_description.empty()) {
detailed_description += "\n\n";
detailed_description += dir_text;
} else {
detailed_description = std::move(dir_text);
}
}
void RefreshDetailPanelShipPartTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, bool only_description = false)
{
const ShipPart* part = GetShipPart(item_name);
if (!part) {
ErrorLogger() << "EncyclopediaDetailPanel::Refresh couldn't find part with name " << item_name;
return;
}
int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
const ScriptingContext context;
// Ship Parts
if (!only_description) {
name = UserString(item_name);
texture = ClientUI::PartIcon(item_name);
int default_location_id = DefaultLocationForEmpire(client_empire_id, context);
turns = part->ProductionTime(client_empire_id, default_location_id, context);
cost = part->ProductionCost(client_empire_id, default_location_id, context);
cost_units = UserString("ENC_PP");
general_type = UserString("ENC_SHIP_PART");
specific_type = UserString(to_string(part->Class()));
}
detailed_description += UserString(part->Description()) + "\n\n" + part->CapacityDescription();
std::string slot_types_list;
if (part->CanMountInSlotType(ShipSlotType::SL_EXTERNAL))
slot_types_list += UserString("SL_EXTERNAL") + " ";
if (part->CanMountInSlotType(ShipSlotType::SL_INTERNAL))
slot_types_list += UserString("SL_INTERNAL") + " ";
if (part->CanMountInSlotType(ShipSlotType::SL_CORE))
slot_types_list += UserString("SL_CORE");
if (!slot_types_list.empty())
detailed_description += "\n\n" + UserString("ENC_SHIP_PART_CAN_MOUNT_IN_SLOT_TYPES") + slot_types_list;
const auto& exclusions = part->Exclusions();
if (!exclusions.empty()) {
detailed_description += "\n\n" + UserString("ENC_SHIP_EXCLUSIONS");
detailed_description.append(LinkList(exclusions));
}
auto unlocked_by_techs = TechsThatUnlockItem(UnlockableItem(UnlockableItemType::UIT_SHIP_PART, item_name));
if (!unlocked_by_techs.empty()) {
detailed_description += "\n\n" + UserString("ENC_UNLOCKED_BY");
detailed_description.append(LinkList(unlocked_by_techs));
}
auto unlocked_by_policies = PoliciesThatUnlockItem(UnlockableItem(UnlockableItemType::UIT_SHIP_PART, item_name));
if (!unlocked_by_policies.empty()) {
detailed_description += "\n\n" + UserString("ENC_UNLOCKED_BY");
detailed_description.append(LinkList(unlocked_by_policies));
}
// species that like / dislike part
auto species_that_like = context.species.SpeciesThatLike(item_name);
auto species_that_dislike = context.species.SpeciesThatDislike(item_name);
if (!species_that_like.empty()) {
detailed_description += "\n\n" + UserString("SPECIES_THAT_LIKE");
detailed_description.append(LinkList(species_that_like));
}
if (!species_that_dislike.empty()) {
detailed_description += "\n\n" + UserString("SPECIES_THAT_DISLIKE");
detailed_description.append(LinkList(species_that_dislike));
}
if (GetOptionsDB().Get<bool>("resource.effects.description.shown")) {
detailed_description += "\n\n";
if (part->Location())
detailed_description += "\n" + part->Location()->Dump();
if (!part->Effects().empty())
detailed_description += "\n" + Dump(part->Effects());
}
detailed_description.append("\n");
}
void RefreshDetailPanelShipHullTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, bool only_description = false)
{
const ShipHull* hull = GetShipHull(item_name);
if (!hull) {
ErrorLogger() << "EncyclopediaDetailPanel::Refresh couldn't find hull with name " << item_name;
return;
}
int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
const ScriptingContext context;
// Ship Hulls
if (!only_description) {
name = UserString(item_name);
texture = ClientUI::HullTexture(item_name);
int default_location_id = DefaultLocationForEmpire(client_empire_id, context);
turns = hull->ProductionTime(client_empire_id, default_location_id, context);
cost = hull->ProductionCost(client_empire_id, default_location_id, context);
cost_units = UserString("ENC_PP");
general_type = UserString("ENC_SHIP_HULL");
}
std::string slots_list;
for (auto slot_type : {ShipSlotType::SL_EXTERNAL, ShipSlotType::SL_INTERNAL, ShipSlotType::SL_CORE})
slots_list.append(UserString(to_string(slot_type))).append(": ")
.append(ToChars(hull->NumSlots(slot_type))).append("\n");
detailed_description.append(UserString(hull->Description())).append("\n\n")
.append(str(FlexibleFormat(UserString("HULL_DESC"))
% hull->Speed() % hull->Fuel() % hull->Stealth()
% hull->Structure() % slots_list));
static std::vector<std::string> hull_tags_to_describe = UserStringList("FUNCTIONAL_HULL_DESC_TAGS_LIST");
for (const std::string& tag : hull_tags_to_describe) {
if (hull->HasTag(tag)) {
if (UserStringExists("HULL_DESC_" + tag)) {
detailed_description.append("\n\n").append(UserString("HULL_DESC_" + tag));
} else {
detailed_description.append("\n\n").append(tag);
}
}
}
const auto& exclusions = hull->Exclusions();
if (!exclusions.empty()) {
detailed_description += "\n\n" + UserString("ENC_SHIP_EXCLUSIONS");
detailed_description.append(LinkList(exclusions));
}
auto unlocked_by_techs = TechsThatUnlockItem(UnlockableItem(UnlockableItemType::UIT_SHIP_HULL, item_name));
if (!unlocked_by_techs.empty()) {
detailed_description.append("\n\n").append(UserString("ENC_UNLOCKED_BY"));
detailed_description.append(LinkList(unlocked_by_techs));
detailed_description.append("\n\n");
}
auto unlocked_by_policies = PoliciesThatUnlockItem(UnlockableItem(UnlockableItemType::UIT_SHIP_HULL, item_name));
if (!unlocked_by_policies.empty()) {
detailed_description.append("\n\n").append(UserString("ENC_UNLOCKED_BY"));
detailed_description.append(LinkList(unlocked_by_policies));
}
// species that like / dislike hull
auto species_that_like = context.species.SpeciesThatLike(item_name);
auto species_that_dislike = context.species.SpeciesThatDislike(item_name);
if (!species_that_like.empty()) {
detailed_description.append("\n\n").append(UserString("SPECIES_THAT_LIKE"));
detailed_description.append(LinkList(species_that_like));
}
if (!species_that_dislike.empty()) {
detailed_description.append("\n\n").append(UserString("SPECIES_THAT_DISLIKE"));
detailed_description.append(LinkList(species_that_dislike));
}
if (GetOptionsDB().Get<bool>("resource.effects.description.shown")) {
detailed_description.append("\n\n");
if (hull->Location())
detailed_description.append("\n").append(hull->Location()->Dump());
if (!hull->Effects().empty())
detailed_description.append("\n").append(Dump(hull->Effects()));
}
detailed_description.append("\n");
}
void RefreshDetailPanelTechTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, bool only_description = false)
{
const Tech* tech = GetTech(item_name);
if (!tech) {
ErrorLogger() << "EncyclopediaDetailPanel::Refresh couldn't find tech with name " << item_name;
return;
}
int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
// Technologies
if (!only_description) {
name = UserString(item_name);
texture = ClientUI::TechIcon(item_name);
other_texture = ClientUI::CategoryIcon(tech->Category());
color = ClientUI::CategoryColor(tech->Category());
ScriptingContext context;
turns = tech->ResearchTime(client_empire_id, context);
cost = tech->ResearchCost(client_empire_id, context);
cost_units = UserString("ENC_RP");
general_type = UserString(tech->ShortDescription());
specific_type = str(FlexibleFormat(UserString("ENC_TECH_DETAIL_TYPE_STR")) % UserString(tech->Category()));
}
const auto& unlocked_techs = tech->UnlockedTechs();
const auto& unlocked_items = tech->UnlockedItems();
if (!unlocked_techs.empty() || !unlocked_items.empty())
detailed_description += UserString("ENC_UNLOCKS");
if (!unlocked_techs.empty()) {
for (const auto& tech_name : unlocked_techs) {
std::string link_text = LinkTaggedPresetText(VarText::TECH_TAG, tech_name, UserString(tech_name));
detailed_description += str(FlexibleFormat(UserString("ENC_TECH_DETAIL_UNLOCKED_ITEM_STR"))
% UserString("UIT_TECH")
% link_text);
}
}
if (!unlocked_items.empty()) {
for (const UnlockableItem& item : unlocked_items) {
auto TAG = [type{item.type}]() -> std::string_view {
switch (type) {
case UnlockableItemType::UIT_BUILDING: return VarText::BUILDING_TYPE_TAG; break;
case UnlockableItemType::UIT_SHIP_PART: return VarText::SHIP_PART_TAG; break;
case UnlockableItemType::UIT_SHIP_HULL: return VarText::SHIP_HULL_TAG; break;
case UnlockableItemType::UIT_SHIP_DESIGN: return VarText::PREDEFINED_DESIGN_TAG; break;
case UnlockableItemType::UIT_TECH: return VarText::TECH_TAG; break;
case UnlockableItemType::UIT_POLICY: return VarText::POLICY_TAG; break;
default: return "";
}
}();
std::string link_text = TAG.empty()
? UserString(item.name)
: LinkTaggedPresetText(TAG, item.name, UserString(item.name));
detailed_description += str(FlexibleFormat(UserString("ENC_TECH_DETAIL_UNLOCKED_ITEM_STR"))
% UserString(to_string(item.type))
% link_text);
}
}
if (!unlocked_techs.empty() || !unlocked_items.empty())
detailed_description += "\n";
detailed_description += UserString(tech->Description());
const auto& unlocked_by_techs = tech->Prerequisites();
if (!unlocked_by_techs.empty()) {
detailed_description += "\n\n" + UserString("ENC_UNLOCKED_BY");
detailed_description.append(LinkList(unlocked_by_techs));
detailed_description += "\n\n";
}
if (GetOptionsDB().Get<bool>("resource.effects.description.shown") && !tech->Effects().empty())
detailed_description += "\n" + Dump(tech->Effects());
}
void RefreshDetailPanelPolicyTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, bool only_description = false)
{
const Policy* policy = GetPolicy(item_name);
if (!policy) {
ErrorLogger() << "EncyclopediaDetailPanel::Refresh couldn't find policy with name " << item_name;
return;
}
int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
// Policies
if (!only_description) {
name = UserString(item_name);
texture = ClientUI::PolicyIcon(item_name);
const ScriptingContext context;
cost = policy->AdoptionCost(client_empire_id, context);
cost_units = UserString("ENC_IP");
general_type = UserString(policy->ShortDescription());
specific_type = str(FlexibleFormat(UserString("ENC_POLICY_DETAIL_TYPE_STR")) % UserString(policy->Category()));
}
detailed_description += UserString(policy->Description());
const auto& unlocked_items = policy->UnlockedItems();
if (!unlocked_items.empty()) {
detailed_description += "\n\n" + UserString("ENC_UNLOCKS");
for (const UnlockableItem& item : unlocked_items) {
std::string TAG;
switch (item.type) {
case UnlockableItemType::UIT_BUILDING: TAG = VarText::BUILDING_TYPE_TAG; break;
case UnlockableItemType::UIT_SHIP_PART: TAG = VarText::SHIP_PART_TAG; break;
case UnlockableItemType::UIT_SHIP_HULL: TAG = VarText::SHIP_HULL_TAG; break;
case UnlockableItemType::UIT_SHIP_DESIGN: TAG = VarText::PREDEFINED_DESIGN_TAG; break;
case UnlockableItemType::UIT_TECH: TAG = VarText::TECH_TAG; break;
case UnlockableItemType::UIT_POLICY: TAG = VarText::POLICY_TAG; break;
default: break;
}
std::string link_text = TAG.empty()
? UserString(item.name)
: LinkTaggedPresetText(TAG, item.name, UserString(item.name));
detailed_description += str(FlexibleFormat(UserString("ENC_TECH_DETAIL_UNLOCKED_ITEM_STR"))
% UserString(to_string(item.type))
% link_text);
}
}
auto unlocked_by_techs = TechsThatUnlockItem(UnlockableItem(UnlockableItemType::UIT_POLICY, item_name));
if (!unlocked_by_techs.empty()) {
detailed_description += "\n\n" + UserString("ENC_UNLOCKED_BY");
detailed_description.append(LinkList(unlocked_by_techs));
}
auto unlocked_by_policies = PoliciesThatUnlockItem(UnlockableItem(UnlockableItemType::UIT_POLICY, item_name));
if (!unlocked_by_policies.empty()) {
detailed_description += "\n\n" + UserString("ENC_UNLOCKED_BY");
detailed_description.append(LinkList(unlocked_by_policies));
}
if (!policy->Prerequisites().empty()) {
detailed_description += "\n\n" + UserString("ENC_POICY_PREREQUISITES");
detailed_description.append(LinkList(policy->Prerequisites()));
}
if (!policy->Exclusions().empty()) {
detailed_description += "\n\n" + UserString("ENC_POICY_EXCLUSIONS");
detailed_description.append(LinkList(policy->Exclusions()));
}
// species that like / dislike policy
auto species_that_like = GetSpeciesManager().SpeciesThatLike(item_name);
auto species_that_dislike = GetSpeciesManager().SpeciesThatDislike(item_name);
if (!species_that_like.empty()) {
detailed_description += "\n\n" + UserString("SPECIES_THAT_LIKE");
detailed_description.append(LinkList(species_that_like));
}
if (!species_that_dislike.empty()) {
detailed_description += "\n\n" + UserString("SPECIES_THAT_DISLIKE");
detailed_description.append(LinkList(species_that_dislike));
}
detailed_description += "\n";
if (GetOptionsDB().Get<bool>("resource.effects.description.shown") &&
!policy->Effects().empty())
{ detailed_description += "\n" + Dump(policy->Effects()); }
detailed_description.append("\n");
}
void RefreshDetailPanelBuildingTypeTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, bool only_description = false)
{
const BuildingType* building_type = GetBuildingType(item_name);
if (!building_type) {
ErrorLogger() << "EncyclopediaDetailPanel::Refresh couldn't find building type with name " << item_name;
return;
}
int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
const ScriptingContext context;
int this_location_id = ClientUI::GetClientUI()->GetMapWnd()->SelectedPlanetID();
if (this_location_id == INVALID_OBJECT_ID && !only_description)
this_location_id = DefaultLocationForEmpire(client_empire_id, context);
// Building types
if (!only_description) {
name = UserString(item_name);
texture = ClientUI::BuildingIcon(item_name);
turns = building_type->ProductionTime(client_empire_id, this_location_id, context);
cost = building_type->ProductionCost(client_empire_id, this_location_id, context);
cost_units = UserString("ENC_PP");
general_type = UserString("ENC_BUILDING_TYPE");
}
detailed_description += UserString(building_type->Description());
if (building_type->ProductionCostTimeLocationInvariant()) {
detailed_description += str(FlexibleFormat(UserString("ENC_AUTO_TIME_COST_INVARIANT_STR")) % UserString("ENC_VERB_PRODUCE_STR"));
} else {
detailed_description += str(FlexibleFormat(UserString("ENC_AUTO_TIME_COST_VARIABLE_STR")) % UserString("ENC_VERB_PRODUCE_STR"));
if (auto* planet = context.ContextObjects().getRaw<Planet>(this_location_id)) {
const int local_cost = only_description ? 1 : building_type->ProductionCost(client_empire_id, this_location_id, context);
const int local_time = only_description ? 1 : building_type->ProductionTime(client_empire_id, this_location_id, context);
auto& local_name = planet->Name();
detailed_description += str(FlexibleFormat(UserString("ENC_AUTO_TIME_COST_VARIABLE_DETAIL_STR"))
% local_name % local_cost % cost_units % local_time);
}
}
auto unlocked_by_techs = TechsThatUnlockItem(UnlockableItem(UnlockableItemType::UIT_BUILDING, item_name));
if (!unlocked_by_techs.empty()) {
detailed_description += "\n\n" + UserString("ENC_UNLOCKED_BY");
detailed_description.append(LinkList(unlocked_by_techs));
detailed_description += "\n\n";
}
auto unlocked_by_policies = PoliciesThatUnlockItem(UnlockableItem(UnlockableItemType::UIT_BUILDING, item_name));
if (!unlocked_by_policies.empty()) {
detailed_description += "\n\n" + UserString("ENC_UNLOCKED_BY");
detailed_description.append(LinkList(unlocked_by_policies));
}
// species that like / dislike building type
auto species_that_like = context.species.SpeciesThatLike(item_name);
auto species_that_dislike = context.species.SpeciesThatDislike(item_name);
if (!species_that_like.empty()) {
detailed_description += "\n\n" + UserString("SPECIES_THAT_LIKE");
detailed_description.append(LinkList(species_that_like));
}
if (!species_that_dislike.empty()) {
detailed_description += "\n\n" + UserString("SPECIES_THAT_DISLIKE");
detailed_description.append(LinkList(species_that_dislike));
}
if (GetOptionsDB().Get<bool>("resource.effects.description.shown")) {
if (!building_type->ProductionCostTimeLocationInvariant()) {
auto& cost_template{UserString("PRODUCTION_WND_TOOLTIP_PROD_COST")};
auto& time_template{UserString("PRODUCTION_WND_TOOLTIP_PROD_TIME_MINIMUM")};
if (building_type->Cost() && !building_type->Cost()->ConstantExpr())
detailed_description += "\n\n" + str(FlexibleFormat(cost_template) % building_type->Cost()->Dump());
if (building_type->Time() && !building_type->Time()->ConstantExpr())
detailed_description += "\n\n" + str(FlexibleFormat(time_template) % building_type->Time()->Dump());
}
if (building_type->EnqueueLocation())
detailed_description += "\n\n" + UserString("ENC_ENQUEUE_LOCATION_REQUIREMENTS") + building_type->EnqueueLocation()->Dump();
if (building_type->Location())
detailed_description += "\n\n" + UserString("ENC_PRODUCTION_LOCATION_REQUIREMENTS") + building_type->Location()->Dump();
if (!building_type->Effects().empty())
detailed_description += "\n\n" + UserString("ENC_EFFECTS") + Dump(building_type->Effects());
}
detailed_description.append("\n");
}
void RefreshDetailPanelSpecialTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, bool only_description = false)
{
const Special* special = GetSpecial(item_name);
if (!special) {
ErrorLogger() << "EncyclopediaDetailPanel::Refresh couldn't find special with name " << item_name;
return;
}
int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
const Universe& u = GetUniverse();
const ObjectMap& objects = u.Objects();
// Specials
if (!only_description) {
name = UserString(item_name);
texture = ClientUI::SpecialIcon(item_name);
detailed_description = special->Description();
general_type = UserString("ENC_SPECIAL");
}
// objects that have special
std::vector<const UniverseObject*> objects_with_special;
objects_with_special.reserve(objects.size());
for (const auto& obj : objects.allRaw())
if (obj->HasSpecial(item_name))
objects_with_special.push_back(obj);
if (!objects_with_special.empty()) {
detailed_description += "\n\n" + UserString("OBJECTS_WITH_SPECIAL");
bool first = true;
for (auto& obj : objects_with_special) {
if (first) first = false;
else detailed_description.append(", ");
auto TEXT_TAG = [&obj]() -> std::string_view {
switch (obj->ObjectType()) {
case UniverseObjectType::OBJ_SHIP: return VarText::SHIP_ID_TAG; break;
case UniverseObjectType::OBJ_FLEET: return VarText::FLEET_ID_TAG; break;
case UniverseObjectType::OBJ_PLANET: return VarText::PLANET_ID_TAG; break;
case UniverseObjectType::OBJ_BUILDING: return VarText::BUILDING_ID_TAG;break;
case UniverseObjectType::OBJ_SYSTEM: return VarText::SYSTEM_ID_TAG; break;
default: return "";
}
}();
if (!TEXT_TAG.empty())
detailed_description.append(
LinkTaggedIDText(TEXT_TAG, obj->ID(), obj->PublicName(client_empire_id, u))
);
else
detailed_description.append(obj->PublicName(client_empire_id, u));
}
detailed_description += "\n";
}
// species that like / dislike special
auto species_that_like = GetSpeciesManager().SpeciesThatLike(item_name);
auto species_that_dislike = GetSpeciesManager().SpeciesThatDislike(item_name);
if (!species_that_like.empty()) {
detailed_description.append("\n\n").append(UserString("SPECIES_THAT_LIKE"));
detailed_description.append(LinkList(species_that_like));
}
if (!species_that_dislike.empty()) {
detailed_description.append("\n\n").append(UserString("SPECIES_THAT_DISLIKE"));
detailed_description.append(LinkList(species_that_dislike));
}
if (GetOptionsDB().Get<bool>("resource.effects.description.shown")) {
if (special->Location())
detailed_description.append("\n").append(special->Location()->Dump());
if (!special->Effects().empty())
detailed_description.append("\n").append(Dump(special->Effects()));
}
detailed_description.append("\n");
}
void RefreshDetailPanelEmpireTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, bool only_description = false)
{
const int empire_id = ToInt(item_name, ALL_EMPIRES);
const ScriptingContext context;
const auto empire = context.GetEmpire(empire_id);
if (!empire) {
ErrorLogger() << "EncyclopediaDetailPanel::Refresh couldn't find empire with id " << item_name;
return;
}
const int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
const Universe& universe = GetUniverse();
const ObjectMap& objects = universe.Objects();
if (!only_description)
name = empire->Name();
// Capital
if (const auto capital = objects.get<Planet>(empire->CapitalID()))
detailed_description += UserString("EMPIRE_CAPITAL") +
LinkTaggedIDText(VarText::PLANET_ID_TAG, capital->ID(), capital->Name());
else
detailed_description += UserString("NO_CAPITAL");
// to facilitate AI debugging
detailed_description += "\n" + UserString("EMPIRE_ID") + ": " + item_name;
// Empire meters
const auto& meters = empire->GetMeters();
if (!meters.empty()) {
detailed_description += "\n\n";
for (auto& [mt, m] : meters) {
detailed_description += UserString(mt) + ": "
+ DoubleToString(m.Initial(), 3, false)
+ "\n";
}
}
// Policies
const auto policies = empire->AdoptedPolicies();
if (!policies.empty()) {
// re-sort by adoption turn
const auto turns_policies_adopted = [&empire, &policies]() {
std::vector<std::pair<int, std::string_view>> turns_policies_adopted;
using tpa_val_t = typename decltype(turns_policies_adopted)::value_type;
turns_policies_adopted.reserve(policies.size());
std::transform(policies.begin(), policies.end(), std::back_inserter(turns_policies_adopted),
[&empire](const auto& policy_name) -> tpa_val_t
{ return { empire->TurnPolicyAdopted(policy_name), policy_name}; });
return turns_policies_adopted;
}();
detailed_description.append("\n").append(UserString("ADOPTED_POLICIES"));
for (auto& [adoption_turn, policy_name] : turns_policies_adopted) {
detailed_description += "\n";
const std::string turn_text{adoption_turn == BEFORE_FIRST_TURN ? UserString("BEFORE_FIRST_TURN") :
(UserString("TURN") + " " + ToChars(adoption_turn))};
detailed_description.append(LinkTaggedPresetText(VarText::POLICY_TAG, policy_name, UserString(policy_name)))
.append(" : ").append(turn_text);
}
} else {
detailed_description.append("\n\n").append(UserString("NO_POLICIES_ADOPTED"));
}
// Species opinions
const auto& seom = context.species.GetSpeciesEmpireOpinionsMap();
detailed_description.append("\n\n").append(UserString("SPECIES_OPINIONS")).append("\n");
for (const auto& [species_name_, empire_opinions] : seom) {
const auto empire_it = empire_opinions.find(empire_id);
if (empire_it == empire_opinions.end())
continue;
const auto current_opinion = empire_it->second.first.Initial();
const auto* species = context.species.GetSpecies(species_name_);
if (species)
detailed_description.append(LinkTaggedText(VarText::SPECIES_TAG, species->Name()));
else
detailed_description.append(UserString("UNKNOWN_SPECIES"));
detailed_description.append(" : ").append(DoubleToString(current_opinion, 3, false)).append("\n");
}
// Planets
const auto is_owned = [empire_id](const UniverseObject* obj)
{ return empire_id != ALL_EMPIRES && obj->OwnedBy(empire_id); };
const auto empire_planets = objects.findRaw<const Planet>(is_owned);
if (!empire_planets.empty()) {
detailed_description.append("\n\n").append(UserString("OWNED_PLANETS"));
for (auto& obj : empire_planets) {
detailed_description += LinkTaggedIDText(VarText::PLANET_ID_TAG, obj->ID(),
obj->PublicName(client_empire_id, universe)) + ", ";
}
} else {
detailed_description.append("\n\n").append(UserString("NO_OWNED_PLANETS_KNOWN"));
}
// Fleets
const auto is_nonempty_owned_fleet = [empire_id](const Fleet* fleet) {
return empire_id != ALL_EMPIRES &&
fleet->OwnedBy(empire_id) &&
!fleet->Empty();
};
const auto nonempty_empire_fleets = objects.findRaw<const Fleet>(is_nonempty_owned_fleet);
if (!nonempty_empire_fleets.empty()) {
detailed_description.append("\n\n").append(UserString("OWNED_FLEETS")).append("\n");
for (auto* obj : nonempty_empire_fleets) {
const auto fleet_link = LinkTaggedIDText(VarText::FLEET_ID_TAG, obj->ID(),
obj->PublicName(client_empire_id, universe));
if (auto system = objects.getRaw<System>(obj->SystemID())) {
const auto sys_name = system->ApparentName(client_empire_id, universe);
const auto system_link = LinkTaggedIDText(VarText::SYSTEM_ID_TAG, system->ID(), sys_name);
detailed_description += str(FlexibleFormat(UserString("OWNED_FLEET_AT_SYSTEM"))
% fleet_link % system_link);
} else {
detailed_description += fleet_link;
}
detailed_description += "\n";
}
} else {
detailed_description.append("\n\n").append(UserString("NO_OWNED_FLEETS_KNOWN"));
}
// Issued orders this turn
if (empire_id == GGHumanClientApp::GetApp()->EmpireID())
detailed_description.append("\n\n").append(UserString("ISSUED_ORDERS"))
.append("\n").append(GGHumanClientApp::GetApp()->Orders().Dump());
// Techs
const auto& techs = empire->ResearchedTechs();
if (!techs.empty()) {
detailed_description.append("\n\n").append(UserString("RESEARCHED_TECHS"));
const auto sorted_techs = [&techs]() {
std::vector<std::pair<int, std::string_view>> retval;
using retval_val_t = typename decltype(retval)::value_type;
retval.reserve(techs.size());
std::transform(techs.begin(), techs.end(), std::back_inserter(retval),
[](const auto& tech_turn) -> retval_val_t
{ return {tech_turn.second, tech_turn.first}; });
std::sort(retval.begin(), retval.end());
return retval;
}();
for (const auto& [researched_turn, tech_name] : sorted_techs) {
detailed_description += "\n";
const std::string turn_text = (researched_turn == BEFORE_FIRST_TURN) ?
UserString("BEFORE_FIRST_TURN") : (UserString("TURN") + " " + ToChars(researched_turn));
detailed_description.append(LinkTaggedPresetText(VarText::TECH_TAG, tech_name, UserString(tech_name)))
.append(" : ").append(turn_text);
}
} else {
detailed_description.append("\n\n").append(UserString("NO_TECHS_RESEARCHED"));
}
// WIP: Parts, Hulls, Buildings, ... available
const auto& parts = empire->AvailableShipParts();
if (!parts.empty()) {
detailed_description.append("\n\n").append(UserString("AVAILABLE_PARTS"));
for (const auto& part_name : parts) {
detailed_description.append("\n")
.append(LinkTaggedPresetText(VarText::SHIP_PART_TAG, part_name, UserString(part_name)));
}
} else {
detailed_description.append("\n\n").append(UserString("NO_PARTS_AVAILABLE"));
}
const auto& hulls = empire->AvailableShipHulls();
if (!hulls.empty()) {
detailed_description.append("\n\n").append(UserString("AVAILABLE_HULLS"));
for (const auto& hull_name : hulls) {
detailed_description.append("\n")
.append(LinkTaggedPresetText(VarText::SHIP_HULL_TAG, hull_name, UserString(hull_name)));
}
} else {
detailed_description.append("\n\n").append(UserString("NO_HULLS_AVAILABLE"));
}
const auto& buildings = empire->AvailableBuildingTypes();
if (!buildings.empty()) {
detailed_description.append("\n\n").append(UserString("AVAILABLE_BUILDINGS"));
for (const auto& building_name : buildings) {
detailed_description.append("\n")
.append(LinkTaggedPresetText(VarText::BUILDING_TYPE_TAG, building_name, UserString(building_name)));
}
} else {
detailed_description.append("\n\n").append(UserString("NO_BUILDINGS_AVAILABLE"));
}
// Misc. Statistics
// empire destroyed ships...
const auto& empire_ships_destroyed = empire->EmpireShipsDestroyed();
if (!empire_ships_destroyed.empty())
detailed_description.append("\n\n").append(UserString("EMPIRE_SHIPS_DESTROYED"));
for (const auto& [empire_id, num] : empire_ships_destroyed) {
const Empire* target_empire = GetEmpire(empire_id);
detailed_description.append("\n");
if (target_empire)
detailed_description.append(LinkTaggedIDText(VarText::EMPIRE_ID_TAG, empire_id, target_empire->Name()));
else
detailed_description.append(UserString("UNOWNED"));
detailed_description.append(" : ").append(ToChars(num));
}
// ship designs destroyed
const auto& empire_designs_destroyed = empire->ShipDesignsDestroyed();
if (!empire_designs_destroyed.empty())
detailed_description.append("\n\n").append(UserString("SHIP_DESIGNS_DESTROYED"));
for (const auto& [design_id, num] : empire_designs_destroyed) {
const std::string num_str = ToChars(num);
const ShipDesign* design = universe.GetShipDesign(design_id);
const std::string design_name = design ? design->Name() : UserString("UNKNOWN");
detailed_description += "\n" + design_name + " : " + num_str;
}
// species ships destroyed
const auto& species_ships_destroyed = empire->SpeciesShipsDestroyed();
if (!species_ships_destroyed.empty())
detailed_description.append("\n\n").append(UserString("SPECIES_SHIPS_DESTROYED"));
for (const auto& [species_name_, num] : species_ships_destroyed) {
const std::string num_str = ToChars(num);
const auto& species_name = species_name_.empty() ? UserString("NONE") : UserString(species_name_);
detailed_description += "\n" + species_name + " : " + num_str;;
}
// species planets invaded
const auto& species_planets_invaded = empire->SpeciesPlanetsInvaded();
if (!species_planets_invaded.empty())
detailed_description.append("\n\n").append(UserString("SPECIES_PLANETS_INVADED"));
for (const auto& [species_name_, num] : species_planets_invaded) {
const std::string num_str = ToChars(num);
const auto& species_name = species_name_.empty() ? UserString("NONE") : UserString(species_name_);
detailed_description += "\n" + species_name + " : " + num_str;
}
// species ships produced
const auto& species_ships_produced = empire->SpeciesShipsProduced();
if (!species_ships_produced.empty())
detailed_description.append("\n\n").append(UserString("SPECIES_SHIPS_PRODUCED"));
for (const auto& [species_name_, num] : species_ships_produced) {
const std::string num_str = ToChars(num);
const auto& species_name = species_name_.empty() ? UserString("NONE") : UserString(species_name_);
detailed_description += "\n" + species_name + " : " + num_str;
}
// ship designs produced
const auto& ship_designs_produced = empire->ShipDesignsProduced();
if (!ship_designs_produced.empty())
detailed_description.append("\n\n").append(UserString("SHIP_DESIGNS_PRODUCED"));
for (const auto& [design_id, num] : ship_designs_produced) {
const std::string num_str = ToChars(num);
const ShipDesign* design = universe.GetShipDesign(design_id);
const auto& design_name = design ? design->Name() : UserString("UNKNOWN");
detailed_description += "\n" + design_name + " : " + num_str;
}
// species ships lost
const auto& species_ships_lost = empire->SpeciesShipsLost();
if (!species_ships_lost.empty())
detailed_description.append("\n\n").append(UserString("SPECIES_SHIPS_LOST"));
for (const auto& [species_name_, num] : species_ships_lost) {
const std::string num_str = ToChars(num);
const auto& species_name = species_name_.empty() ? UserString("NONE") : UserString(species_name_);
detailed_description += "\n" + species_name + " : " + num_str;
}
// ship designs lost
const auto& ship_designs_lost = empire->ShipDesignsLost();
if (!ship_designs_lost.empty())
detailed_description.append("\n\n").append(UserString("SHIP_DESIGNS_LOST"));
for (const auto& [species_name_, num] : ship_designs_lost) {
const std::string num_str = ToChars(num);
const ShipDesign* design = universe.GetShipDesign(species_name_);
const auto& design_name = design ? design->Name() : UserString("UNKNOWN");
detailed_description += "\n" + design_name + " : " + num_str;
}
// species ships scrapped
const auto& species_ships_scrapped = empire->SpeciesShipsScrapped();
if (!species_ships_scrapped.empty())
detailed_description.append("\n\n").append(UserString("SPECIES_SHIPS_SCRAPPED"));
for (const auto& [species_name_, num] : species_ships_scrapped) {
const std::string num_str = ToChars(num);
const auto& species_name = species_name_.empty() ? UserString("NONE") : UserString(species_name_);
detailed_description += "\n" + species_name + " : " + num_str;
}
// ship designs scrapped
const auto& ship_designs_scrapped = empire->ShipDesignsScrapped();
if (!ship_designs_scrapped.empty())
detailed_description.append("\n\n").append(UserString("SHIP_DESIGNS_SCRAPPED"));
for (const auto& [design_id, num] : ship_designs_scrapped) {
const std::string num_str = ToChars(num);
const ShipDesign* design = universe.GetShipDesign(design_id);
const auto& design_name = design ? design->Name() : UserString("UNKNOWN");
detailed_description += "\n" + design_name + " : " + num_str;
}
// species planets depopulated
const auto& species_planets_depoped = empire->SpeciesPlanetsDepoped();
if (!species_planets_depoped.empty())
detailed_description.append("\n\n").append(UserString("SPECIES_PLANETS_DEPOPED"));
for (const auto& [species_name_, num] : species_planets_depoped) {
const std::string num_str = ToChars(num);
const auto& species_name = species_name_.empty() ? UserString("NONE") : UserString(species_name_);
detailed_description += "\n" + species_name + " : " + num_str;
}
// species planets bombed
const auto& species_planets_bombed = empire->SpeciesPlanetsBombed();
if (!species_planets_bombed.empty())
detailed_description.append("\n\n").append(UserString("SPECIES_PLANETS_BOMBED"));
for (const auto& [species_name_, num] : species_planets_bombed) {
const std::string num_str = ToChars(num);
const auto& species_name = species_name_.empty() ? UserString("NONE") : UserString(species_name_);
detailed_description += "\n" + species_name + " : " + num_str;
}
// buildings produced
const auto& building_types_produced = empire->BuildingTypesProduced();
if (!building_types_produced.empty())
detailed_description.append("\n\n").append(UserString("BUILDING_TYPES_PRODUCED"));
for (const auto& [bt_name_, num] : building_types_produced) {
const std::string num_str = ToChars(num);
const auto& building_type_name = bt_name_.empty() ? UserString("NONE") : UserString(bt_name_);
detailed_description += "\n" + building_type_name + " : " + num_str;
}
// buildings scrapped
const auto& building_types_scrapped = empire->BuildingTypesScrapped();
if (!building_types_scrapped.empty())
detailed_description.append("\n\n").append(UserString("BUILDING_TYPES_SCRAPPED"));
for (const auto& [bt_name_, num] : building_types_scrapped) {
const std::string num_str = ToChars(num);
const auto& building_type_name = bt_name_.empty() ? UserString("NONE") : UserString(bt_name_);
detailed_description += "\n" + building_type_name + " : " + num_str;
}
detailed_description += "\n";
}
void RefreshDetailPanelSpeciesTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, bool only_description = false)
{
const SpeciesManager& sm = GetSpeciesManager();
const Species* species = sm.GetSpecies(item_name);
if (!species) {
ErrorLogger() << "EncyclopediaDetailPanel::Refresh couldn't find species with name " << item_name;
return;
}
const int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
const Universe& universe = GetUniverse();
const ObjectMap& objects = universe.Objects();
const EmpireManager& empires = Empires();
if (!only_description) {
name = UserString(item_name);
texture = ClientUI::SpeciesIcon(item_name);
general_type = UserString("ENC_SPECIES");
}
detailed_description = species->GameplayDescription();
// inherent species limitations
detailed_description += "\n";
if (species->CanProduceShips())
detailed_description += UserString("CAN_PRODUCE_SHIPS");
else
detailed_description += UserString("CANNOT_PRODUCE_SHIPS");
detailed_description += "\n";
if (species->CanColonize())
detailed_description += UserString("CAN_COLONIZE");
else
detailed_description += UserString("CANNNOT_COLONIZE");
// focus preference
if (!species->DefaultFocus().empty()) {
detailed_description.append("\n\n").append(UserString("FOCUS_PREFERENCE"))
.append(UserString(species->DefaultFocus()));
}
// likes
if (!species->Likes().empty()) {
detailed_description.append("\n\n").append(UserString("LIKES"));
detailed_description.append(LinkList(species->Likes()));
}
// dislikes
if (!species->Dislikes().empty()) {
detailed_description.append("\n\n").append(UserString("DISLIKES"));
int count = 0;
for (const auto& s : species->Dislikes())
detailed_description
.append(count++ == 0 ? "" : ", ")
.append(LinkStringIfPossible(std::string{s}, UserString(s)))
//.append(UserString(s))
;
}
// environmental preferences
detailed_description += "\n\n";
const auto& pt_env_map = species->PlanetEnvironments();
if (!pt_env_map.empty()) {
detailed_description.append(UserString("ENVIRONMENTAL_PREFERENCES")).append("\n");
for (auto& [ptype, penv] : pt_env_map) {
detailed_description += UserString(to_string(ptype)) + " : " +
UserString(to_string(penv)) + "\n";
// add blank line between cyclical environments and asteroids and gas giants
if (ptype == PlanetType::PT_OCEAN)
detailed_description += "\n";
}
} else {
detailed_description += "\n";
}
// homeworld
detailed_description += "\n";
const auto& homeworlds = GetSpeciesManager().GetSpeciesHomeworldsMap();
if (!homeworlds.contains(species->Name()) || homeworlds.at(species->Name()).empty()) {
detailed_description.append(UserString("NO_HOMEWORLD")).append("\n");
} else {
detailed_description.append(UserString("HOMEWORLD")).append("\n");
bool first = true;
// TODO: alphabetical sorting order to make the list better readable
// TODO: stealthy worlds should be hidden on the server side and not show up as clear text here, only when the empire has sufficient detection strength
for (int hw_id : homeworlds.at(species->Name())) {
if (first) first = false;
else detailed_description.append(", ");
if (auto homeworld = objects.get<Planet>(hw_id))
detailed_description
.append(LinkTaggedIDText(VarText::PLANET_ID_TAG, hw_id, homeworld->PublicName(client_empire_id, universe)));
else
detailed_description
.append(UserString("UNKNOWN_PLANET"));
}
detailed_description.append("\n");
}
// occupied planets
auto planet_has_species = [item_name](const Planet& p) { return p.SpeciesName() == item_name; };
auto planets_with_species = objects.findRaw<const Planet>(planet_has_species);
if (!planets_with_species.empty()) {
detailed_description.append("\n").append(UserString("OCCUPIED_PLANETS")).append("\n");
std::sort(planets_with_species.begin(), planets_with_species.end(), // alphabetize
[](const Planet* l, const Planet* r) { return l && r && l->SpeciesName() < r->SpeciesName(); });
bool first = true;
for (auto p : planets_with_species) {
if (first)
first = false;
else
detailed_description.append(", ");
detailed_description.append(LinkTaggedIDText(VarText::PLANET_ID_TAG, p->ID(),
p->PublicName(client_empire_id, universe)));
detailed_description.append("\n");
}
}
// empire opinions
const auto& seom = GetSpeciesManager().GetSpeciesEmpireOpinionsMap();
auto species_it = seom.find(species->Name());
if (species_it != seom.end()) {
detailed_description.append("\n").append(UserString("OPINIONS_OF_EMPIRES")).append("\n");
for (const auto& [op_id, op] : species_it->second) {
const auto& [opinion, target] = op;
auto empire = empires.GetEmpire(op_id);
if (empire)
detailed_description.append(LinkTaggedIDText(VarText::EMPIRE_ID_TAG, op_id, empire->Name()));
else
detailed_description.append(boost::io::str(FlexibleFormat(UserString("UNKNOWN_EMPIRE"))
% op_id));
detailed_description.append(" : Opinion: ").append(DoubleToString(opinion.Initial(), 3, false))
.append(" : Target Opinion: ").append(DoubleToString(target.Initial(), 3, false))
.append("\n");
}
}
// species opinions
const auto& ssom = sm.GetSpeciesSpeciesOpinionsMap();
auto species_it2 = ssom.find(species->Name());
if (species_it2 != ssom.end()) {
detailed_description.append("\n").append(UserString("OPINIONS_OF_OTHER_SPECIES")).append("\n");
for (const auto& [op_name, op] : species_it2->second) {
const auto& [opinion, target] = op;
detailed_description.append(UserString(op_name))
.append(" : Opinion: ").append(DoubleToString(opinion.Current(), 3, false))
.append(" Target Opinion: ").append(DoubleToString(target.Current(), 3, false))
.append("\n");
}
}
// species that like / dislike other species
auto species_that_like = sm.SpeciesThatLike(item_name);
auto species_that_dislike = sm.SpeciesThatDislike(item_name);
if (!species_that_like.empty()) {
detailed_description.append("\n\n").append(UserString("SPECIES_THAT_LIKE"));
detailed_description.append(LinkList(species_that_like));
}
if (!species_that_dislike.empty()) {
detailed_description.append("\n\n").append(UserString("SPECIES_THAT_DISLIKE"));
detailed_description.append(LinkList(species_that_dislike));
}
// Long description
detailed_description.append("\n\n").append(UserString(species->Description()));
if (GetOptionsDB().Get<bool>("resource.effects.description.shown")) {
// autogenerated dump text of annexation condition and cost
if (species->AnnexationCondition())
detailed_description.append("\nAnnexation Condition: ").append(species->AnnexationCondition()->Dump());
if (species->AnnexationCost())
detailed_description.append("\nAnnexation Cost: ").append(species->AnnexationCost()->Dump());
// autogenerated dump text of parsed scripted species effects, if enabled in options
if (!species->Effects().empty())
detailed_description.append("\n").append(Dump(species->Effects()));
}
detailed_description.append("\n");
}
void RefreshDetailPanelFieldTypeTag(const std::string& item_type,
const std::string& item_name,
std::string& name,
std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture,
int& turns,
float& cost,
std::string& cost_units,
std::string& general_type,
std::string& specific_type,
std::string& detailed_description,
GG::Clr& color,
bool only_description = false
) {
// DONE: list current known occurances of the fieldtype with id / galactic coordinates to be clickable like instances of ship designs
// TODO: second method for detailled view of particular field instances, listing affected systems, fleets, etc.
const FieldType* field_type = GetFieldType(item_name);
if (!field_type) {
ErrorLogger() << "EncyclopediaDetailPanel::Refresh couldn't find fiedl type with name " << item_name;
return;
}
// Field types
if (!only_description) {
name = UserString(item_name);
texture = ClientUI::FieldTexture(item_name);
general_type = UserString("ENC_FIELD_TYPE");
}
detailed_description += UserString(field_type->Description());
// species that like / dislike field
auto species_that_like = GetSpeciesManager().SpeciesThatLike(item_name);
auto species_that_dislike = GetSpeciesManager().SpeciesThatDislike(item_name);
if (!species_that_like.empty()) {
detailed_description.append("\n\n").append(UserString("SPECIES_THAT_LIKE"));
detailed_description.append(LinkList(species_that_like));
}
if (!species_that_dislike.empty()) {
detailed_description.append("\n\n").append(UserString("SPECIES_THAT_DISLIKE"));
detailed_description.append(LinkList(species_that_dislike));
}
if (GetOptionsDB().Get<bool>("resource.effects.description.shown")) {
if (!field_type->Effects().empty())
detailed_description.append("\n").append(Dump(field_type->Effects()));
}
// get current fields from map
const ScriptingContext context;
const Universe& u = GetUniverse();
const ObjectMap& objects = u.Objects();
const auto current_fields = objects.findRaw<Field>(
[item_name](auto* f) { return f->FieldTypeName() == item_name; });
detailed_description.append("\n\n").append(UserString("KNOWN_FIELDS_OF_THIS_TYPE")).append("\n");
if (!current_fields.empty()) {
const int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
for (auto& obj : current_fields) {
auto TEXT_TAG = VarText::FIELD_ID_TAG;
detailed_description.append(
LinkTaggedIDText(
TEXT_TAG, obj->ID(),
obj->PublicName(client_empire_id, u)
)
);
std::stringstream ssx,ssy;
ssx << std::fixed << std::setprecision(0) << obj->X();
ssy << std::fixed << std::setprecision(0) << obj->Y();
detailed_description.append(" @ X=").append(ssx.str());
detailed_description.append(", Y=").append(ssy.str());
detailed_description.append("\n");
}
} else {
detailed_description.append(UserString("NO_KNOWN_FIELDS"));
}
detailed_description.append("\n");
}
void RefreshDetailPanelMeterTypeTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, bool only_description = false)
{
// TODO: don't need to go back and forth to MeterType and string_view.
// can concatenate and look up input item_name
MeterType meter_type = MeterTypeFromString(item_name, MeterType::INVALID_METER_TYPE);
auto [meter_value_label, meter_name] = MeterValueLabelAndString(meter_type);
std::string meter_name_value_desc{std::string{meter_name}.append("_VALUE_DESC")};
if (!only_description) {
texture = ClientUI::MeterIcon(meter_type);
general_type = UserString("ENC_METER_TYPE");
name = meter_value_label;
}
if (UserStringExists(meter_name_value_desc))
detailed_description += UserString(meter_name_value_desc);
else
detailed_description += meter_value_label;
}
std::string GetDetailedDescriptionBase(const ShipDesign& design) {
std::string hull_link;
if (!design.Hull().empty())
hull_link = LinkTaggedPresetText(VarText::SHIP_HULL_TAG, design.Hull(), UserString(design.Hull()));
std::string parts_list;
std::map<std::string, int> non_empty_parts_count; // TODO: can key be string_view ?
for (const auto& part_name : design.Parts()) {
if (part_name.empty())
continue;
non_empty_parts_count[part_name]++;
}
for (auto part_it = non_empty_parts_count.begin();
part_it != non_empty_parts_count.end(); ++part_it)
{
if (part_it != non_empty_parts_count.begin())
parts_list += ", ";
auto& [part_name, part_count] = *part_it;
parts_list += LinkTaggedPresetText(VarText::SHIP_PART_TAG, part_name, UserString(part_name));
if (part_it->second > 1)
parts_list.append(" x").append(ToChars(part_count));
}
return str(FlexibleFormat(UserString("ENC_SHIP_DESIGN_DESCRIPTION_BASE_STR"))
% design.Description()
% hull_link
% parts_list);
}
std::string GetDetailedDescriptionStats(const std::shared_ptr<Ship>& ship,
float enemy_DR, std::set<float> enemy_shots, float cost)
{
//The strength of a fleet is approximately weapons * armor, or
//(weapons - enemyShield) * armor / (enemyWeapons - shield). This
//depends on the enemy's weapons and shields, so we estimate the
//enemy technology from the turn.
// use the current meter values here, not initial, as this is used
// within a loop that sets the species, updates meter, then checks
// meter values for display
const Universe& universe = GetUniverse();
const ScriptingContext context{universe, Empires()};
auto& species = ship->SpeciesName().empty() ? "Generic" : UserString(ship->SpeciesName());
const float structure = ship->GetMeter(MeterType::METER_MAX_STRUCTURE)->Current();
const float shield = ship->GetMeter(MeterType::METER_MAX_SHIELD)->Current();
const float attack = ship->TotalWeaponsShipDamage(context);
const float destruction = ship->TotalWeaponsFighterDamage(context);
const float strength = std::pow(attack * structure, 0.6f);
const float typical_shot = enemy_shots.empty() ? 0.0f : *std::max_element(enemy_shots.begin(), enemy_shots.end()); // TODO: cbegin, cend (also elsewhere)
const float typical_strength = std::pow(ship->TotalWeaponsShipDamage(context, enemy_DR) * structure * typical_shot / std::max(typical_shot - shield, 0.001f), 0.6f); // FIXME: TotalWeaponsFighterDamage
return (FlexibleFormat(UserString("ENC_SHIP_DESIGN_DESCRIPTION_STATS_STR"))
% species
% attack
% destruction
% structure
% shield
% ship->GetMeter(MeterType::METER_DETECTION)->Current()
% ship->GetMeter(MeterType::METER_STEALTH)->Current()
% ship->GetMeter(MeterType::METER_SPEED)->Current()
% ship->GetMeter(MeterType::METER_MAX_FUEL)->Current()
% ship->SumCurrentPartMeterValuesForPartClass(MeterType::METER_CAPACITY, ShipPartClass::PC_COLONY, universe)
% ship->SumCurrentPartMeterValuesForPartClass(MeterType::METER_CAPACITY, ShipPartClass::PC_TROOPS, universe)
% ship->FighterMax()
% (attack - ship->TotalWeaponsShipDamage(context, 0.0f, false)) // FIXME: TotalWeaponsFighterDamage
% ship->SumCurrentPartMeterValuesForPartClass(MeterType::METER_MAX_CAPACITY, ShipPartClass::PC_FIGHTER_BAY, universe)
% strength
% (strength / cost)
% typical_shot
% enemy_DR
% typical_strength
% (typical_strength / cost)).str();
}
void RefreshDetailPanelShipDesignTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, bool only_description = false)
{
int design_id = ToInt(item_name, INVALID_DESIGN_ID);
int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
ScriptingContext context;
Universe& universe = context.ContextUniverse();
ObjectMap& objects = context.ContextObjects();
const SpeciesManager& species_manager = context.species;
const ShipDesign* design_ptr = universe.GetShipDesign(design_id);
if (!design_ptr) {
ErrorLogger() << "RefreshDetailPanelShipDesignTag couldn't find ShipDesign with id " << design_id;
return;
}
const auto& design = *design_ptr;
universe.InhibitUniverseObjectSignals(true);
// Ship Designs
if (!only_description) {
name = design.Name();
texture = ClientUI::ShipDesignIcon(design_id);
int default_location_id = DefaultLocationForEmpire(client_empire_id, context);
turns = design.ProductionTime(client_empire_id, default_location_id, context);
cost = design.ProductionCost(client_empire_id, default_location_id, context);
cost_units = UserString("ENC_PP");
general_type = design.IsMonster() ? UserString("ENC_MONSTER") : UserString("ENC_SHIP_DESIGN");
}
const float tech_level = boost::algorithm::clamp(context.current_turn / 400.0f, 0.0f, 1.0f);
const double scaling = GetGameRules().Get<double>("RULE_SHIP_WEAPON_DAMAGE_FACTOR");
const float typical_shot = (3 + 27 * tech_level) * scaling;
float enemy_DR = 20 * tech_level * scaling;
TraceLogger() << "RefreshDetailPanelShipDesignTag default enemy stats:: tech_level: " << tech_level
<< " DR: " << enemy_DR << " attack: " << typical_shot << " incl.scaling: " << scaling;
std::set<float> enemy_shots{typical_shot};
// select which species to show info for
// TODO: can this be a vector of string_view ?
std::set<std::string> additional_species; // from currently selected planet and fleets, if any
const auto& map_wnd = ClientUI::GetClientUI()->GetMapWnd();
if (const auto planet = objects.get<Planet>(map_wnd->SelectedPlanetID())) {
if (!planet->SpeciesName().empty())
additional_species.insert(planet->SpeciesName());
}
FleetUIManager& fleet_manager = FleetUIManager::GetFleetUIManager();
std::set<int> chosen_ships;
int selected_ship = fleet_manager.SelectedShipID();
const FleetWnd* fleet_wnd = FleetUIManager::GetFleetUIManager().ActiveFleetWnd();
if ((selected_ship == INVALID_OBJECT_ID) && fleet_wnd) {
auto selected_fleets = fleet_wnd->SelectedFleetIDs();
auto selected_ships = fleet_wnd->SelectedShipIDs();
if (selected_ships.size() > 0)
selected_ship = *selected_ships.begin();
else {
int selected_fleet_id = INVALID_OBJECT_ID;
if (selected_fleets.size() == 1)
selected_fleet_id = *selected_fleets.begin();
else if (fleet_wnd->FleetIDs().size() > 0)
selected_fleet_id = *fleet_wnd->FleetIDs().begin();
if (auto selected_fleet = objects.get<Fleet>(selected_fleet_id))
if (!selected_fleet->ShipIDs().empty())
selected_ship = *selected_fleet->ShipIDs().begin();
}
}
if (selected_ship != INVALID_OBJECT_ID) {
chosen_ships.insert(selected_ship);
if (const auto this_ship = objects.get<Ship>(selected_ship)) {
if (!this_ship->SpeciesName().empty())
additional_species.insert(this_ship->SpeciesName());
if (!this_ship->OwnedBy(client_empire_id)) {
enemy_DR = this_ship->GetMeter(MeterType::METER_MAX_SHIELD)->Initial();
DebugLogger() << "Using selected ship for enemy values, DR: " << enemy_DR;
enemy_shots.clear();
auto this_damage = this_ship->AllWeaponsMaxShipDamage(context); // FIXME: FighterDamage
for (float shot : this_damage)
DebugLogger() << "Weapons Dmg " << shot;
enemy_shots.insert(this_damage.begin(), this_damage.end());
}
}
} else if (fleet_manager.ActiveFleetWnd()) {
for (const auto* fleet : objects.findRaw<Fleet>(fleet_manager.ActiveFleetWnd()->SelectedFleetIDs())) {
if (!fleet)
continue;
chosen_ships.insert(fleet->ShipIDs().begin(), fleet->ShipIDs().end());
}
}
for (const auto& this_ship : objects.find<Ship>(chosen_ships)) {
if (!this_ship || !this_ship->SpeciesName().empty())
continue;
additional_species.emplace(this_ship->SpeciesName());
}
std::vector<std::string> species_list(additional_species.begin(), additional_species.end());
detailed_description = GetDetailedDescriptionBase(design);
if (!only_description) { // don't generate detailed stat description involving adding / removing temporary ship from universe
// temporary ship to use for estimating design's meter values
auto temp = universe.InsertTemp<Ship>(client_empire_id, design_id, "", universe,
species_manager, client_empire_id,
context.current_turn);
// apply empty species for 'Generic' entry
universe.UpdateMeterEstimates(temp->ID(), context);
temp->Resupply(context.current_turn);
detailed_description.append(GetDetailedDescriptionStats(temp, enemy_DR, enemy_shots, cost));
// apply various species to ship, re-calculating the meter values for each
for (std::string& species_name : species_list) {
temp->SetSpecies(std::move(species_name), species_manager);
universe.UpdateMeterEstimates(temp->ID(), context);
temp->Resupply(context.current_turn);
detailed_description.append(GetDetailedDescriptionStats(temp, enemy_DR, enemy_shots, cost));
}
universe.Delete(temp->ID());
universe.InhibitUniverseObjectSignals(false);
}
// ships of this design
const auto is_of_design = [design_id](const Ship& ship) { return ship.DesignID() == design_id; };
const auto design_ships = objects.findExistingRaw<Ship>(is_of_design);
if (!design_ships.empty()) {
detailed_description += "\n\n" + UserString("SHIPS_OF_DESIGN");
for (auto* ship : design_ships) {
detailed_description += LinkTaggedIDText(VarText::SHIP_ID_TAG, ship->ID(),
ship->PublicName(client_empire_id, universe)) + ", ";
}
} else {
detailed_description += "\n\n" + UserString("NO_SHIPS_OF_DESIGN");
}
}
void RefreshDetailPanelIncomplDesignTag(const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, std::weak_ptr<const ShipDesign>& inc_design,
bool only_description = false)
{
int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
general_type = UserString("ENC_INCOMPETE_SHIP_DESIGN");
auto incomplete_design = inc_design.lock();
if (!incomplete_design)
return;
if (only_description) {
detailed_description = GetDetailedDescriptionBase(*incomplete_design);
return;
}
ScriptingContext context;
Universe& universe = context.ContextUniverse();
ObjectMap& objects = context.ContextObjects();
const SpeciesManager& species_manager = context.species;
universe.InhibitUniverseObjectSignals(true);
// incomplete design. not yet in game universe; being created on design screen
name = incomplete_design->Name();
const auto& design_icon = incomplete_design->Icon();
if (design_icon.empty())
texture = ClientUI::HullIcon(incomplete_design->Hull());
else
texture = ClientUI::GetTexture(ClientUI::ArtDir() / design_icon, true);
const int default_location_id = DefaultLocationForEmpire(client_empire_id, context);
turns = incomplete_design->ProductionTime(client_empire_id, default_location_id, context);
cost = incomplete_design->ProductionCost(client_empire_id, default_location_id, context);
cost_units = UserString("ENC_PP");
universe.InsertShipDesignID(*incomplete_design, client_empire_id, incomplete_design->ID());
detailed_description = GetDetailedDescriptionBase(*incomplete_design);
// baseline values, may be overridden
const float tech_level = boost::algorithm::clamp(context.current_turn / 400.0f, 0.0f, 1.0f);
const double scaling = GetGameRules().Get<double>("RULE_SHIP_WEAPON_DAMAGE_FACTOR");
const float typical_shot = (3 + 27 * tech_level) * scaling;
float enemy_DR = 20 * tech_level * scaling;
DebugLogger() << "default enemy stats:: tech_level: " << tech_level
<< " DR: " << enemy_DR << " attack: " << typical_shot << " incl.scaling: " << scaling;
std::set<float> enemy_shots{typical_shot};
std::set<std::string> additional_species; // TODO: from currently selected planet and ship, if any
const auto& map_wnd = ClientUI::GetClientUI()->GetMapWnd();
if (const auto* planet = objects.getRaw<Planet>(map_wnd->SelectedPlanetID())) {
if (!planet->SpeciesName().empty())
additional_species.insert(planet->SpeciesName());
}
FleetUIManager& fleet_manager = FleetUIManager::GetFleetUIManager();
std::set<int> chosen_ships;
const int selected_ship = fleet_manager.SelectedShipID();
if (selected_ship != INVALID_OBJECT_ID) {
chosen_ships.insert(selected_ship);
if (auto this_ship = objects.getRaw<const Ship>(selected_ship)) {
if (!additional_species.empty() && (
(this_ship->GetMeter(MeterType::METER_MAX_SHIELD)->Initial() > 0) ||
!this_ship->OwnedBy(client_empire_id)))
{
enemy_DR = this_ship->GetMeter(MeterType::METER_MAX_SHIELD)->Initial();
DebugLogger() << "Using selected ship for enemy values, DR: " << enemy_DR;
enemy_shots.clear();
auto this_damage = this_ship->AllWeaponsMaxShipDamage(context); // FIXME: MaxFighterDamage
for (float shot : this_damage)
DebugLogger() << "Weapons Dmg " << shot;
enemy_shots.insert(this_damage.begin(), this_damage.end());
}
}
} else if (fleet_manager.ActiveFleetWnd()) {
for (const auto& fleet : objects.find<const Fleet>(fleet_manager.ActiveFleetWnd()->SelectedFleetIDs())) {
if (!fleet)
continue;
const auto& fleet_ship_ids{fleet->ShipIDs()};
chosen_ships.insert(fleet_ship_ids.begin(), fleet_ship_ids.end());
}
}
for (const auto* this_ship : objects.findRaw<const Ship>(chosen_ships)) {
if (this_ship && !this_ship->SpeciesName().empty())
additional_species.insert(this_ship->SpeciesName());
}
// temporary ship to use for estimating design's meter values
auto temp = universe.InsertTemp<Ship>(client_empire_id, incomplete_design->ID(), "",
universe, species_manager, client_empire_id,
context.current_turn);
// apply empty species for 'Generic' entry
universe.UpdateMeterEstimates(temp->ID(), context);
temp->Resupply(context.current_turn);
detailed_description.append(GetDetailedDescriptionStats(temp, enemy_DR, enemy_shots, cost));
// apply various species to ship, re-calculating the meter values for each
for (auto& species_name : additional_species) {
temp->SetSpecies(species_name, species_manager);
universe.UpdateMeterEstimates(temp->ID(), context);
temp->Resupply(context.current_turn);
detailed_description.append(GetDetailedDescriptionStats(temp, enemy_DR, enemy_shots, cost));
}
universe.Delete(temp->ID());
universe.DeleteShipDesign(TEMPORARY_OBJECT_ID);
universe.InhibitUniverseObjectSignals(false);
}
void RefreshDetailPanelObjectTag( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, bool only_description = false)
{
int object_id = ToInt(item_name, INVALID_OBJECT_ID);
int client_empire_id = GGHumanClientApp::GetApp()->EmpireID();
const Universe& universe = GetUniverse();
const ObjectMap& objects = universe.Objects();
auto obj = objects.get(object_id);
if (!obj) {
ErrorLogger() << "EncyclopediaDetailPanel::Refresh couldn't find UniverseObject with id " << object_id;
return;
}
detailed_description = obj->Dump();
if (only_description)
return;
name = obj->PublicName(client_empire_id, universe);
general_type = GeneralTypeOfObject(obj->ObjectType());
if (general_type.empty()) {
ErrorLogger() << "EncyclopediaDetailPanel::Refresh couldn't interpret object: " << obj->Name()
<< " (" << object_id << ")";
return;
}
}
std::vector<std::string_view> ReportedSpeciesForPlanet(Planet& planet) {
std::vector<std::string_view> retval;
const ScriptingContext context;
const ObjectMap& objects = context.ContextObjects();
const SpeciesManager& species_manager = context.species;
const EmpireManager& empires = context.Empires();
const auto empire_id = GGHumanClientApp::GetApp()->EmpireID();
const auto empire = empires.GetEmpire(empire_id);
if (!empire)
return retval;
const auto& planet_current_species{planet.SpeciesName()};
// Collect species colonizing/environment hospitality information
// start by building roster-- any species tagged as 'ALWAYS_REPORT' plus any species
// represented in this empire's PopCenters
for (auto& [species_str, species] : species_manager) {
if (species.HasTag(TAG_ALWAYS_REPORT)) {
retval.push_back(species_str);
continue;
}
if (species.HasTag(TAG_EXTINCT)) {
for (auto& [tech_name, turn_researched] : empire->ResearchedTechs()) {
// Check for presence of tags in tech
auto tech = GetTech(tech_name);
if (!tech) {
ErrorLogger() << "ReportedSpeciesForPlanet couldn't get tech " << tech_name
<< " (researched on turn " << turn_researched << ")";
continue;
}
if (tech->HasTag(TAG_EXTINCT) && tech->HasTag(species_str)) {
retval.push_back(species_str);
break;
}
}
}
}
const auto empire_planets = [empire_id](const Planet& p) { return p.OwnedBy(empire_id) && p.Populated(); };
for (const auto* planet : objects.findRaw<Planet>(empire_planets)) {
if (!planet)
continue;
const std::string& species_name = planet->SpeciesName();
if (species_name.empty() || std::find(retval.begin(), retval.end(), species_name) != retval.end())
continue;
const Species* species = species_manager.GetSpecies(species_name);
if (!species)
continue;
// Exclude species that can't colonize UNLESS they
// are already here (aka: it's their home planet). Showing them on
// their own planet allows comparison vs other races, which might
// be better suited to this planet.
if (species->CanColonize() || species_name == planet_current_species)
// The planet's species may change, so better create a string_view
// from the species->Name(), not species_name
retval.push_back(species->Name());
}
return retval;
}
auto SpeciesEnvByTargetPop(const std::shared_ptr<Planet>& planet,
const std::vector<std::string_view>& species_names)
{
std::vector<std::tuple<float, std::string_view, PlanetEnvironment>> retval;
if (species_names.empty() || !planet)
return retval;
retval.reserve(species_names.size());
// store original state of planet
const auto original_planet_species{planet->SpeciesName()}; // intentional copy
const auto original_owner_id = planet->Owner();
const auto orig_initial_target_pop = planet->GetMeter(MeterType::METER_TARGET_POPULATION)->Initial();
const std::vector<int> planet_id_vec{planet->ID()};
const auto empire_id = GGHumanClientApp::GetApp()->EmpireID();
Universe& universe = GetUniverse();
ScriptingContext context{universe, Empires(), GetGalaxySetupData(),
GetSpeciesManager(), GetSupplyManager()};
universe.InhibitUniverseObjectSignals(true);
for (const auto species_name : species_names) { // TODO: parallelize somehow? tricky since an existing planet is being modified, rather than adding a test planet...
// Setting the planet's species allows all of it meters to reflect
// species (and empire) properties, such as environment type
// preferences and tech.
// @see also: MapWnd::ApplyMeterEffectsAndUpdateMeters
// NOTE: Overridding current or initial value of MeterType::METER_TARGET_POPULATION prior to update
// results in incorrect estimates for at least effects with a min target population of 0
try {
planet->SetSpecies(std::string{species_name}, context.current_turn, context.species);
planet->SetOwner(empire_id);
universe.ApplyMeterEffectsAndUpdateMeters(planet_id_vec, context, false);
} catch (const std::exception& e) {
ErrorLogger() << "Caught exception applying species name " << species_name
<< " and owner empire id " << empire_id << " : " << e.what();
}
try {
const auto species = context.species.GetSpecies(species_name);
const auto planet_environment = species ?
species->GetPlanetEnvironment(planet->Type()) : PlanetEnvironment::PE_UNINHABITABLE;
float planet_capacity = ((planet_environment == PlanetEnvironment::PE_UNINHABITABLE) ?
0.0f : planet->GetMeter(MeterType::METER_TARGET_POPULATION)->Current()); // want value after temporary meter update, so get current, not initial value of meter
retval.emplace_back(planet_capacity, species_name, planet_environment);
} catch (const std::exception& e) {
ErrorLogger() << "Caught exception emplacing into species env by target pop : " << e.what();
}
}
try {
// restore planet to original state
planet->SetSpecies(original_planet_species, context.current_turn, context.species);
planet->SetOwner(original_owner_id);
planet->GetMeter(MeterType::METER_TARGET_POPULATION)->Set(
orig_initial_target_pop, orig_initial_target_pop);
} catch (const std::exception& e) {
ErrorLogger() << "Caught exception restoring planet to original state after setting test species / owner : " << e.what();
}
try {
universe.InhibitUniverseObjectSignals(false);
universe.ApplyMeterEffectsAndUpdateMeters(planet_id_vec, context, false);
} catch (const std::exception& e) {
ErrorLogger() << "Caught exception re-applying meter effects to planet after temporary species / owner : " << e.what();
}
std::sort(retval.begin(), retval.end());
return retval;
}
GG::Pt HairSpaceExtent() {
static GG::Pt retval;
if (retval > GG::Pt0)
return retval;
static constexpr auto format = GG::FORMAT_NONE;
auto font = ClientUI::GetFont();
#if defined(__cpp_lib_char8_t)
DebugLogger() << "HairSpaceExtext with __cpp_lib_char8_t defined";
static constexpr std::u8string_view hair_space_u8chars{u8"\u200A"};
static constexpr auto hair_space_arr = []() {
std::array<std::string_view::value_type, hair_space_u8chars.size()> retval{};
for (std::size_t idx = 0; idx < retval.size(); ++idx)
retval[idx] = hair_space_u8chars[idx];
return retval;
}();
static constexpr std::string_view hair_space_chars(hair_space_arr.data(), hair_space_arr.size());
#else
DebugLogger() << "HairSpaceExtext without __cpp_lib_char8_t defined";
static constexpr std::string_view hair_space_chars{u8"\u200A"};
#endif
static const std::string hair_space_str{hair_space_chars};
DebugLogger() << "hair_space_str: " << hair_space_str << " valid UTF8?: "
<< utf8::is_valid(hair_space_str.begin(), hair_space_str.end());
try {
auto elems = font->ExpensiveParseFromTextToTextElements(hair_space_str, format);
auto lines = font->DetermineLines(hair_space_str, format, GG::X(1 << 15), elems);
retval = font->TextExtent(lines);
} catch (const std::exception& e) {
ErrorLogger() << "Caught exception in HairSpaceExtext parsing or determining lines: " << e.what();
}
return retval;
}
auto SpeciesSuitabilityColumn1(const std::vector<std::string_view>& species_names) {
std::unordered_map<std::string_view, std::string> retval;
auto font = ClientUI::GetFont();
for (const auto& species_name : species_names) {
try {
retval.emplace(species_name, str(
FlexibleFormat(UserString("ENC_SPECIES_PLANET_TYPE_SUITABILITY_COLUMN1"))
% LinkTaggedPresetText(VarText::SPECIES_TAG, species_name, UserString(species_name))));
} catch (const std::exception& e) {
ErrorLogger() << "Caught exception in SpeciesSuitabilityColumn1 when handling species " << species_name << " : " << e.what();
}
}
// determine widest column, storing extents of each row for later alignment
static constexpr auto format = GG::FORMAT_NONE;
GG::X longest_width{0};
std::unordered_map<std::string_view, GG::Pt> column1_species_extents;
for (auto& [species_name, formatted_col1] : retval) {
std::vector<GG::Font::TextElement> text_elements;
try {
text_elements = font->ExpensiveParseFromTextToTextElements(formatted_col1, format);
} catch (const std::exception& e) {
ErrorLogger() << "Caught exception in SpeciesSuitabilityColumn1 when during expensive parse: " << e.what();
ErrorLogger() << " ... text was: " << formatted_col1;
}
try {
auto lines = font->DetermineLines(formatted_col1, format, GG::X(1 << 15), text_elements);
GG::Pt extent = font->TextExtent(lines);
column1_species_extents[species_name] = extent;
longest_width = std::max(longest_width, extent.x);
} catch (const std::exception& e) {
ErrorLogger() << "Caught exception in SpeciesSuitabilityColumn1 when determining lines: " << e.what();
}
}
try {
// align end of column with end of longest row
auto hair_space_width = HairSpaceExtent().x;
auto hair_space_width_str = ToChars(Value(hair_space_width));
#if defined(__cpp_lib_char8_t)
std::u8string hair_space_chars{u8"\u200A"};
std::string hair_space_str{hair_space_chars.begin(), hair_space_chars.end()};
#else
static constexpr auto hair_space_str{u8"\u200A"};
#endif
for (auto& [species_name, formatted_col1] : retval) {
if (!column1_species_extents.contains(species_name)) {
ErrorLogger() << "No column1 extent stored for " << species_name;
continue;
}
auto distance = longest_width - column1_species_extents.at(species_name).x;
std::size_t num_spaces = Value(distance) / Value(hair_space_width);
TraceLogger() << species_name << " Num spaces: " << ToChars(Value(longest_width))
<< " - " << ToChars(Value(column1_species_extents.at(species_name).x))
<< " = " << ToChars(Value(distance))
<< " / " << ToChars(Value(hair_space_width))
<< " = " << ToChars(num_spaces);;
for (std::size_t i = 0; i < num_spaces; ++i)
formatted_col1.append(hair_space_str);
TraceLogger() << "Species Suitability Column 1:\n\t" << species_name << " \"" << formatted_col1 << "\""
<< [&](const auto& species_name, const auto& formatted_col1)
{
std::string out;
out.reserve(1000); // guesstimate
auto col_val = Value(column1_species_extents.at(species_name).x);
out.append("\n\t\t(" + ToChars(col_val) + " + (" + ToChars(num_spaces) + " * " + hair_space_width_str);
out.append(") = " + ToChars(col_val + (num_spaces * Value(hair_space_width))) + ")");
auto text_elements = font->ExpensiveParseFromTextToTextElements(formatted_col1, format);
auto lines = font->DetermineLines(formatted_col1, format, GG::X(1 << 15), text_elements);
out.append(" = " + ToChars(Value(font->TextExtent(lines).x)));
return out;
}(species_name, formatted_col1);
}
} catch (const std::exception& e) {
ErrorLogger() << "Caught exception in SpeciesSuitabilityColumn1 when doing hair space and maybe trace stuff?: " << e.what();
}
return retval;
}
namespace {
std::mutex planet_type_names_mutex;
constexpr auto NUM_PT = static_cast<std::size_t>(static_cast<std::underlying_type_t<PlanetType>>(
PlanetType::NUM_PLANET_TYPES));
// all lower-case string representations of PlanetType value names
constexpr auto lower_planet_type_names{[]() {
std::array<std::array<std::string::value_type, 16>, NUM_PT> retval{}; // 16 chars should be big enough for all planet types as text...
for (std::size_t idx = 0; idx < NUM_PT; ++idx) {
const auto sv = to_string(PlanetType(idx));
for (std::size_t idx2 = 0; idx2 < sv.size(); ++idx2) {
const auto c = sv[idx2];
retval[idx][idx2] = (c >= 'A' && c <= 'Z') ? c + ('a' - 'A') : c;
}
}
return retval;
}()};
constexpr auto lower_names_by_type{[]() {
std::array<std::string_view, lower_planet_type_names.size()> retval;
for (std::size_t idx = 0; idx < retval.size(); ++idx)
retval[idx] = std::string_view{lower_planet_type_names[idx].data()};
return retval;
}()};
constexpr auto TypeToLowerName(PlanetType planet_type) -> std::string_view {
const auto pt_num = static_cast<std::underlying_type_t<PlanetType>>(planet_type);
const auto pt_idx = static_cast<std::size_t>(pt_num);
return planet_type > PlanetType::INVALID_PLANET_TYPE && planet_type < PlanetType::NUM_PLANET_TYPES ?
lower_names_by_type[pt_idx] : "";
};
static_assert(TypeToLowerName(PlanetType::PT_TERRAN) == "pt_terran");
boost::signals2::scoped_connection resource_dir_changed_signal_connection{};
std::array<std::vector<std::string>, NUM_PT> filenames_by_type{};
// assume already locked
void InitFilenames() {
std::scoped_lock ptn_lock(planet_type_names_mutex);
DebugLogger() << "Initializing planet pedia banner filenames";
// cache filenames for each planet type for current art directory
const auto pe_path = ClientUI::ArtDir() / "encyclopedia" / "planet_environments";
for (std::size_t pt_idx = 0; pt_idx < filenames_by_type.size(); ++pt_idx) {
auto& planet_type_str = lower_names_by_type[pt_idx];
// get and retain the filenames of each path for this type
auto pe_type_func = [planet_type_str, &pe_path](const boost::filesystem::path& path) {
return IsExistingFile(path)
&& (pe_path == path.parent_path())
&& boost::algorithm::starts_with(PathToString(path.filename()), planet_type_str);
};
for (const auto& file_path : ListDir(pe_path, pe_type_func))
filenames_by_type[pt_idx].push_back(PathToString(file_path.filename()));
}
}
}
std::string_view PlanetEnvFilename(PlanetType planet_type, std::size_t idx) {
if (planet_type == PlanetType::INVALID_PLANET_TYPE || planet_type >= PlanetType::NUM_PLANET_TYPES)
return "";
const auto pt_num = static_cast<std::underlying_type_t<PlanetType>>(planet_type);
const auto pt_idx = static_cast<std::size_t>(pt_num);
// init, and ensure that if the resource directory is changed, the cached filenames are regenerated
if (!resource_dir_changed_signal_connection.connected()) {
auto& signal = GetOptionsDB().OptionChangedSignal("resource.path");
resource_dir_changed_signal_connection = signal.connect([]() { InitFilenames(); });
InitFilenames();
}
{
std::scoped_lock ptn_lock(planet_type_names_mutex);
const auto& pe_paths = filenames_by_type[pt_idx]; // vector of filenames for input planet type
static constexpr std::size_t arbitrary_prime = 37;
if (pe_paths.empty())
return "";
else {
std::size_t vec_idx = (idx % arbitrary_prime) % pe_paths.size();
return pe_paths[vec_idx];
}
}
return "";
}
void RefreshDetailPanelSuitabilityTag(const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color)
{
ScopedTimer suitability_timer{"RefreshDetailPanelSuitabilityTag"};
general_type = UserString("SP_PLANET_SUITABILITY");
Universe& universe = GetUniverse();
ObjectMap& objects = universe.Objects();
int planet_id = ToInt(item_name, INVALID_OBJECT_ID);
auto planet = objects.get<Planet>(planet_id); // non-const so it can be test modified to check results for various species
if (!planet) {
ErrorLogger() << "RefreshDetailPlanetSuitability couldn't find planet with id " << planet_id;
return;
}
// show image of planet environment at the top of the suitability report
auto filename = PlanetEnvFilename(planet->Type(), planet_id);
if (!filename.empty()) {
auto env_img_tag = std::string{"<img src=\"encyclopedia/planet_environments/"}
.append(filename).append("\"></img>");
TraceLogger() << "Suitability report env image tag \"" << env_img_tag << "\"";
detailed_description.append(env_img_tag);
}
try {
name = planet->PublicName(planet_id, universe);
const auto species_names = ReportedSpeciesForPlanet(*planet);
const auto target_population_species = SpeciesEnvByTargetPop(planet, species_names);
const auto species_suitability_column1 = SpeciesSuitabilityColumn1(species_names);
bool positive_header_placed = false;
bool negative_header_placed = false;
for (auto it = target_population_species.rbegin(); it != target_population_species.rend(); ++it) {
const auto& [target_pop, species_name, env] = *it;
auto species_name_column1_it = species_suitability_column1.find(species_name);
if (species_name_column1_it == species_suitability_column1.end())
continue;
if (target_pop > 0) {
if (!positive_header_placed) {
auto pos_header = str(FlexibleFormat(UserString("ENC_SUITABILITY_REPORT_POSITIVE_HEADER"))
% planet->PublicName(planet_id, universe));
TraceLogger() << "Suitability report positive header \"" << pos_header << "\"";
detailed_description.append(pos_header);
positive_header_placed = true;
}
auto pos_row = str(FlexibleFormat(UserString("ENC_SPECIES_PLANET_TYPE_SUITABILITY"))
% species_name_column1_it->second
% UserString(to_string(env))
% (GG::RgbaTag(ClientUI::StatIncrColor()) + DoubleToString(target_pop, 2, true) + "</rgba>"));
TraceLogger() << "Suitability report positive row \"" << pos_row << "\"";
detailed_description.append(pos_row);
} else if (target_pop <= 0) {
if (!negative_header_placed) {
if (positive_header_placed)
detailed_description += "\n\n";
auto neg_header = str(FlexibleFormat(UserString("ENC_SUITABILITY_REPORT_NEGATIVE_HEADER"))
% planet->PublicName(planet_id, universe));
TraceLogger() << "Suitability report regative header \"" << neg_header << "\"";
detailed_description.append(neg_header);
negative_header_placed = true;
}
auto neg_row = str(FlexibleFormat(UserString("ENC_SPECIES_PLANET_TYPE_SUITABILITY"))
% species_name_column1_it->second
% UserString(to_string(env))
% (GG::RgbaTag(ClientUI::StatDecrColor()) + DoubleToString(target_pop, 2, true) + "</rgba>"));
TraceLogger() << "Suitability report negative row \"" << neg_row << "\"";
detailed_description.append(neg_row);
}
detailed_description += "\n";
}
} catch (const std::exception& e) {
ErrorLogger() << "Caught exception generating planet suitability info: " << e.what();
}
if (planet->Type() < PlanetType::PT_ASTEROIDS && planet->Type() > PlanetType::INVALID_PLANET_TYPE) {
detailed_description.append(UserString("ENC_SUITABILITY_REPORT_WHEEL_INTRO"))
.append("<img src=\"encyclopedia/EP_wheel.png\"></img>");
}
}
void RefreshDetailPanelSearchResultsTag(std::string item_name,
std::shared_ptr<GG::Texture>& texture,
std::string& general_type,
std::string& detailed_description)
{
general_type = UserString("SEARCH_RESULTS");
texture = ClientUI::GetTexture(ClientUI::ArtDir() / "icons" / "buttons" / "search.png");
detailed_description = std::move(item_name);
}
void GetRefreshDetailPanelInfo( const std::string& item_type, const std::string& item_name,
std::string& name, std::shared_ptr<GG::Texture>& texture,
std::shared_ptr<GG::Texture>& other_texture, int& turns,
float& cost, std::string& cost_units, std::string& general_type,
std::string& specific_type, std::string& detailed_description,
GG::Clr& color, std::weak_ptr<const ShipDesign>& incomplete_design,
bool only_description = false)
{
if (item_type == TextLinker::ENCYCLOPEDIA_TAG) {
RefreshDetailPanelPediaTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description, color);
}
else if (item_type == "ENC_SHIP_PART") {
RefreshDetailPanelShipPartTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == "ENC_SHIP_HULL") {
RefreshDetailPanelShipHullTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == "ENC_TECH") {
RefreshDetailPanelTechTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == "ENC_POLICY") {
RefreshDetailPanelPolicyTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == "ENC_BUILDING_TYPE") {
RefreshDetailPanelBuildingTypeTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == "ENC_SPECIAL") {
RefreshDetailPanelSpecialTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == "ENC_EMPIRE") {
RefreshDetailPanelEmpireTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == "ENC_SPECIES") {
RefreshDetailPanelSpeciesTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == "ENC_FIELD_TYPE") {
RefreshDetailPanelFieldTypeTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == "ENC_METER_TYPE") {
RefreshDetailPanelMeterTypeTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == "ENC_SHIP_DESIGN") {
RefreshDetailPanelShipDesignTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == INCOMPLETE_DESIGN) {
RefreshDetailPanelIncomplDesignTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description, color,
incomplete_design, only_description);
}
else if (item_type == UNIVERSE_OBJECT || item_type == "ENC_BUILDING" ||
item_type == "ENC_FIELD" || item_type == "ENC_FLEET" ||
item_type == "ENC_PLANET" || item_type == "ENC_SHIP" ||
item_type == "ENC_SYSTEM")
{
RefreshDetailPanelObjectTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color, only_description);
}
else if (item_type == PLANET_SUITABILITY_REPORT) {
RefreshDetailPanelSuitabilityTag( item_type, item_name,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description,
color);
}
else if (item_type == TEXT_SEARCH_RESULTS) {
RefreshDetailPanelSearchResultsTag(item_name, texture, general_type, detailed_description);
}
else if (item_type == TextLinker::GRAPH_TAG) {
// should be handled externally...
}
}
namespace {
// UTF-8 code points that can be easily converted from lower and upper case by offsetting the wchar_t
// Latin-1 supplement
constexpr uint8_t A_WITH_GRAVE_byte1 = 0x80; // À
//static_assert(u8"\u00C0"[1] == A_WITH_GRAVE_byte1);
//static_assert(u8"\u00C0"[0] == u8"À"[0] && u8"\u00C0"[1] == u8"À"[1]);
constexpr uint8_t O_WITH_DIARESIS_byte1 = 0x96; // Ö
// multiply symbol × is between these ranges...
constexpr uint8_t O_WITH_STROKE_byte1 = 0x98; // Ø
constexpr uint8_t THORN_byte1 = 0x9E; // Þ
//static_assert(u8"\u00DE"[1] == THORN_byte1);
constexpr uint8_t a_with_grave_byte1 = 0xA0; // à
//static_assert(u8"\u00E0"[1] == a_with_grave_byte1);
constexpr uint8_t y_with_diaresis_byte1 = 0xBF; // ÿ
// Latin extended-A first half
constexpr uint8_t A_WITH_MACRON_byte1 = 0x80; // Ā
//static_assert(u8"\u0100"[1] == A_WITH_MACRON_byte1);
//static_assert(u8"\u0100"[0] == u8"Ā"[0] && u8"\u0100"[1] == u8"Ā"[1]);
constexpr uint8_t I_WITH_OGONEK_byte1 = 0xAE; // Į
//static_assert(u8"\u012E"[1] == I_WITH_OGONEK_byte1);
//static_assert(u8"\u012E"[0] == u8"Į"[0] && u8"\u012E"[1] == u8"Į"[1]);
constexpr uint8_t LIGATURE_IJ_byte1 = 0xB2; // IJ
//static_assert(u8"\u0132"[1] == LIGATURE_IJ_byte1);
//static_assert(u8"\u0132"[0] == u8"IJ"[0] && u8"\u0132"[1] == u8"IJ"[1]);
constexpr uint8_t K_WITH_CEDILLA_byte1 = 0xB6; // Ķ
//static_assert(u8"\u0136"[1] == K_WITH_CEDILLA_byte1);
//static_assert(u8"\u0136"[0] == u8"Ķ"[0] && u8"\u0136"[1] == u8"Ķ"[1]);
constexpr uint8_t kra_byte1 = 0xB8; // ĸ
constexpr uint8_t L_WITH_ACUTE_byte1 = 0xB9; // Ĺ
//static_assert(u8"\u0139"[1] == L_WITH_ACUTE_byte1);
//static_assert(u8"\u0139"[0] == u8"Ĺ"[0] && u8"\u0139"[1] == u8"Ĺ"[1]);
constexpr uint8_t L_WITH_CARON_byte1 = 0xBD; // Ľ
//static_assert(u8"\u013D"[1] == L_WITH_CARON_byte1);
//static_assert(u8"\u013D"[0] == u8"Ľ"[0] && u8"\u013D"[1] == u8"Ľ"[1]);
constexpr uint8_t a_with_macron_byte1 = 0x81; // ā
constexpr uint8_t awmb0 = u8"\u0101"[0];
constexpr uint8_t awmb1 = u8"\u0101"[1];
static_assert(awmb0 == 0xC4);
static_assert(awmb1 == 0x81);
static_assert(awmb1 == a_with_macron_byte1);
static_assert(a_with_macron_byte1 - A_WITH_MACRON_byte1 == 1); // this range of chars is offset by one between upper and and lower case
// Latin Extended-A first-to-second half
constexpr uint8_t L_WITH_MIDDLE_DOT_byte1 = 0xBF; // first byte C4
constexpr uint8_t l_with_middle_dot_byte1 = 0x80; // first byte C5
// Latin Extended-A second half
constexpr uint8_t L_WITH_STROKE_byte1 = 0x81; // Ł
//static constexpr uint8_t l_with_stroke_byte1 = 0x82; // ł
constexpr uint8_t N_WITH_CARON_byte1 = 0x87; // Ň
constexpr uint8_t n_preceeded_by_apostrophe_byte1 = 0x89; // ʼn
constexpr uint8_t ENG_byte1 = 0x8A; // Ŋ
constexpr uint8_t Y_WITH_CIRCUMFLEX_byte1 = 0xB6; // Ŷ
constexpr uint8_t Y_WITH_DIARESIS_byte1 = 0xB8; // Ÿ
constexpr uint8_t Z_WITH_ACCUTE_byte1 = 0xB9; // Ź
constexpr uint8_t Z_WITH_CARON_byte1 = 0xBD; // Ž
constexpr uint8_t long_s_byte1 = 0xBF; // ſ
// Greek and Coptic
// first byte 0xCE
constexpr uint8_t ALPHA_byte1 = 0x91; // Α
constexpr uint8_t OMICRON_byte1 = 0x9F; // Ο
constexpr uint8_t PI_byte1 = 0xA0; // Π
constexpr uint8_t RHO_byte1 = 0xA1; // Ρ
// no code at 0xA2
constexpr uint8_t SIGMA_byte1 = 0xA3; // Ρ
//static constexpr uint8_t OMEGA_byte1 = 0xA9; // Ω
constexpr uint8_t UPSILON_WITH_DIALYTIKA_byte1 = 0xAB; // Ϋ
constexpr uint8_t alpha_with_tonos_byte1 = 0xAC; // ά
constexpr uint8_t alpha_byte1 = 0xB1; // α
constexpr uint8_t omicron_byte1 = 0xBF; // ο
// first byte 0xCF
constexpr uint8_t pi_byte1 = 0x80;
constexpr uint8_t rho_byte1 = 0x81; // ρ
//constexpr uint8_t final_sigma_byte1 = 0x82; // ς
constexpr uint8_t sigma_byte1 = 0x83; // σ
//static constexpr uint8_t upsilon_with_dialytika_byte1 = 0x8B; // ϋ
//static constexpr uint8_t omicron_with_tonos_byte1 = 0x8C; // ό
constexpr uint8_t omega_with_tonos_byte1 = 0x8E; // ώ
// note: alternate mu/micro encoding covered by full page 0xC2 case
constexpr auto micro = u8"\u00B5"; // µ (micro)
constexpr uint8_t microb0 = micro[0];
constexpr uint8_t microb1 = micro[1];
static_assert(microb0 == 0xC2);
static_assert(microb1 == 0xB5);
constexpr auto micro2 = u8"µ";
constexpr uint8_t micro2b0 = micro2[0];
constexpr uint8_t micro2b1 = micro2[1];
static_assert(micro2b0 == 0xC2);
static_assert(micro2b1 == 0xB5);
constexpr auto mu = u8"\u03BC"; // μ (lower case mu)
constexpr uint8_t mub0 = mu[0];
constexpr uint8_t mub1 = mu[1];
static_assert(mub0 == 0xCE);
static_assert(mub1 == 0xBC);
// following tests fail on MSVC x64
//constexpr auto mu2 = u8"μ";
//constexpr uint8_t mu2b0 = mu2[0];
//constexpr uint8_t mu2b1 = mu2[1];
//static_assert(mu2b0 == 0xCE);
//static_assert(mu2b1 == 0xBC);
constexpr auto o_with_dot_below = u8"ọ";
constexpr uint8_t o_with_dot_below_byte1 = o_with_dot_below[1];
constexpr uint8_t o_with_dot_below_byte2 = o_with_dot_below[2];
}
// Checks if the (next few) chars starting at \a it are a 3-byte code
// point that is handled by CustomToLower or does not need modification
// to be lower-case. Returns true if it is OK or handled. Returns false
// to indicate that CustomToLower won't check for that char or make it
// lower case if it is not already.
inline bool IsOK3CharCode(const std::string::iterator it) {
uint8_t c1 = *it;
uint8_t c2 = *(it + 1);
uint8_t c3 = *(it + 2);
if (c1 == 0xE2) {
if ((c2 >= 0x80 && c2 <= 0x83) ||
(c2 >= 0x86 && c2 <= 0x91) ||
(c2 >= 0x94 && c2 <= 0xAF) ||
(c2 >= 0xB4))
{
// all caseless or lower
return true;
}
} else if (c1 == 0xE1) {
if (c2 == o_with_dot_below_byte1 && c3 == o_with_dot_below_byte2) {
// already lower case
return true;
}
} else if (c1 >= 0xE3 && c1 <= 0xE9) {
// all caseless or lower
return true;
}
// are other ranges that could be checked: https://www.unicode.org/Public/14.0.0/ucd/CaseFolding.txt
return false; // character not in handled pages
}
// Converts some UTF-8 upper-case chars to lower-case. returns true if
// all code points in the text were in ranges known to not require further
// case conversion after having applied this function. If some code points were
// outside the known rage or couldn't be converted, returns false, indicating
// that further case conversion may be needed.
bool CustomToLower(std::string::iterator it, const std::string::iterator end_it) {
std::ptrdiff_t dist = std::distance(it, end_it);
bool retval = true; // util an char outside the handled range is seen
auto prev_char_it = it;
bool once = true;
//DebugLogger() << "CustomToLower on: " << std::string_view(it, end_it) << " : " << [it, end_it]() mutable {
// std::string retval;
// for (; it != end_it; ++it) {
// uint8_t c = *it;
// retval += std::to_string(static_cast<unsigned int>(c));
// }
// return retval;
//}();
while (dist >= 2) {
if (!retval && once) {
once = false;
const uint8_t prev_c1 = *prev_char_it;
std::ptrdiff_t prev_sequence_length = (prev_c1 < 0x80) ? 1 : (prev_c1 <= 0xDF) ? 2 : (prev_c1 <= 0xEF) ? 3 : 4;
DebugLogger() << "not handled char: " << std::string_view(&*prev_char_it, prev_sequence_length);
}
prev_char_it = it;
const uint8_t c1 = *it;
const std::ptrdiff_t sequence_length = (c1 < 0x80) ? 1 : (c1 <= 0xDF) ? 2 : (c1 <= 0xEF) ? 3 : 4;
//DebugLogger() << std::string_view(&*it, sequence_length) << "(" << sequence_length << ") : " << static_cast<int>(c1) << " " << static_cast<int>(*(it+1));
// adjust current sequence if it is a recognized capital letter
if (sequence_length == 1) { // ASCII
if (c1 >= 'A' && c1 <= 'Z')
*it += ('a' - 'A');
// other code points are lower case or caseless
} else if (sequence_length == 2) {
if (c1 >= 0x80 && c1 <= 0xC1) {
retval = false;
break; // invalid UTF-8 ?
} else if (c1 == 0xC2) { // first 64 Latin Supplement has no upper-case
} else if (c1 == 0xC3) { // Latin-1 Supplement starting at capital A with Grave
auto cur_it = it + 1;
const uint8_t c2 = *cur_it;
if ((c2 >= A_WITH_GRAVE_byte1 && c2 <= O_WITH_DIARESIS_byte1) ||
(c2 >= O_WITH_STROKE_byte1 && c2 <= THORN_byte1))
{
static constexpr uint8_t offset = a_with_grave_byte1 - A_WITH_GRAVE_byte1;
*cur_it += offset;
}
// other code poitns are lower case or caseless
} else if (c1 == 0xC4) { // Latin Extended-A starting at A with Macron
auto cur_it = it + 1;
const uint8_t c2 = *cur_it;
if ((c2 >= A_WITH_MACRON_byte1 && c2 <= I_WITH_OGONEK_byte1) ||
(c2 >= LIGATURE_IJ_byte1 && c2 <= K_WITH_CEDILLA_byte1))
{
*cur_it += (c2 % 2 == 0);
} else if (c2 == kra_byte1) {
// do nothing, already lower case
} else if (c2 >= L_WITH_ACUTE_byte1 && c2 <= L_WITH_CARON_byte1) {
*cur_it += (c2 % 2/* == 1*/);
} else if (c2 == L_WITH_MIDDLE_DOT_byte1) {
*it += 1; // to 0xC5
*cur_it = l_with_middle_dot_byte1;
} else {
retval = false; // character not handled
}
} else if (c1 == 0xC5) { // Latin Extended-A starting with L with Stroke
auto cur_it = it + 1;
const uint8_t c2 = *cur_it;
if (c2 >= L_WITH_STROKE_byte1 && c2 <= N_WITH_CARON_byte1) {
*cur_it += (c2 % 2/* == 1*/);
} else if (c2 == n_preceeded_by_apostrophe_byte1) {
// do nothing, already lower case
} else if (c2 >= ENG_byte1 && c2 <= Y_WITH_CIRCUMFLEX_byte1) {
*cur_it += (c2 % 2 == 0);
} else if (c2 == Y_WITH_DIARESIS_byte1) {
*it -= 2; // to 0xC3;
*cur_it = y_with_diaresis_byte1;
static_assert(0xBF == y_with_diaresis_byte1);
} else if (c2 >= Z_WITH_ACCUTE_byte1 && c2 <= Z_WITH_CARON_byte1) {
*cur_it += (c2 % 2/* == 1*/);
} else if (c2 == long_s_byte1) {
// do nothing, already lower case
} else {
retval = false; // character not handled
}
} else if (c1 == 0xCC || // // spacing modified letters, combining diacritical marks
(c1 == 0xCD && static_cast<uint8_t>(*(it + 1)) <= 0xAF))
{
static_assert(static_cast<uint8_t>(192) == 0xC0);
using it_char_t = std::decay_t<decltype(*it)>;
static constexpr it_char_t neg_40(-40);
static constexpr uint8_t neg_40_uint_8 = static_cast<uint8_t>(neg_40);
static_assert(neg_40_uint_8 == 0xD8);
// do nothing, not cased
// note: some Greek in 0xCD page not handled
} else if (c1 == 0xCE) { // Greek and Coptic
auto cur_it = it + 1;
const uint8_t c2 = *cur_it;
if (c2 >= ALPHA_byte1 && c2 <= OMICRON_byte1) {
static constexpr auto offset = alpha_byte1 - ALPHA_byte1;
static_assert(ALPHA_byte1 + offset == alpha_byte1);
*cur_it += offset;
} else if (c2 == PI_byte1) {
*it += 1; // to 0xCF
*cur_it = pi_byte1;
} else if (c2 == RHO_byte1) {
*it += 1; // to 0xCF
*cur_it = rho_byte1;
} else if (c2 >= SIGMA_byte1 && c2 <= UPSILON_WITH_DIALYTIKA_byte1) {
*it += 1; // to 0xCF
static constexpr auto offset = sigma_byte1 - SIGMA_byte1;
static_assert(SIGMA_byte1 + offset == sigma_byte1);
*cur_it += offset;
} else if (c2 >= alpha_with_tonos_byte1 && c2 <= omicron_byte1) {
// do nothing, already lower case
} else {
retval = false; // character not handled
}
} else if (c1 == 0xCF) { // Greek and Coptic
auto cur_it = it + 1;
const uint8_t c2 = *cur_it;
if (c2 >= pi_byte1 && c2 <= omega_with_tonos_byte1) {
// do nothing, already lower case
} else {
retval = false;
}
} else {
retval = false; // character not handled
}
} else if (sequence_length == 3) {
if (dist < 3 || !IsOK3CharCode(it)) {
//DebugLogger() << "unrecognized 3 length code: " << std::string_view(&*it, 3);
retval = false; // unrecognized code
}
} else { // if (sequence_length >= 4) {
retval = false; // unrecognized code
}
if (dist < sequence_length) {
retval = false;
break; // invalid UTF-8, possibly due to truncation of string
}
it += sequence_length;
dist -= sequence_length;
}
if (dist == 1) {
uint8_t c1 = *it;
*it += (c1 >= 'A' && c1 <= 'Z') * ('a' - 'A');
}
return retval;
}
auto ExtractWords(std::string_view text)
{ return GG::GUI::GetGUI()->FindWordsStringViews(text); }
void SearchPediaArticleTextForWords( const std::string& article_key,
const std::string& article_directory,
std::pair<std::string, std::string> article_name_link,
std::pair<std::string, std::string>& article_match,
const std::string& search_text,
const std::vector<std::string_view>& words_in_search_text,
std::size_t idx)
{
// search for matches within article text
const auto& article_entry = GetEncyclopedia().GetArticleByCategoryAndKey(article_directory, article_key);
if (!article_entry.description.empty()) {
// article present in pedia directly
const auto& article_text{UserString(article_entry.description)};
std::string article_text_lower = boost::locale::to_lower(article_text, GetLocale("en_US.UTF-8"));
if (boost::contains(article_text_lower, search_text))
article_match = std::move(article_name_link);
return;
}
// article not in pedia. may be generated by GetRefreshDetailPanelInfo
// most of this disregarded in this case, but needs to be passed in...
std::shared_ptr<GG::Texture> dummy1, dummy2;
int dummyA = 0;
float dummyB = 0.0f;
std::string dummy3, dummy4, dummy5, dummy6;
std::string detailed_description;
detailed_description.reserve(2000); // guessitmate
GG::Clr dummyC;
std::weak_ptr<const ShipDesign> dummyD;
//std::cout << "cat: " << article_category << " key: " << article_key << "\n";
GetRefreshDetailPanelInfo(article_directory, article_key,
dummy3, dummy1, dummy2, dummyA, dummyB, dummy4,
dummy5, dummy6, detailed_description, dummyC,
dummyD, true);
if (boost::contains(detailed_description, search_text)) {
article_match = std::move(article_name_link);
return;
}
auto desc_lower{detailed_description};
const bool all_handled = CustomToLower(desc_lower.begin(), desc_lower.end());
if (!all_handled)
desc_lower = boost::locale::to_lower(detailed_description, GetLocale("en_US.UTF-8"));
if (boost::contains(desc_lower, search_text))
article_match = std::move(article_name_link);
}
void SearchPediaArticleForWords( std::string article_key,
std::string article_directory,
std::pair<std::string, std::string> article_name_link,
std::pair<std::string, std::string>& exact_match,
std::pair<std::string, std::string>& word_match,
std::pair<std::string, std::string>& partial_match,
std::pair<std::string, std::string>& article_match,
const std::string& search_text,
const std::vector<std::string_view>& words_in_search_text,
std::size_t idx,
bool search_article_text)
{
//std::cout << "start scanning article " << idx << ": " << article_name_link.first << std::endl;
auto article_name{article_name_link.first};
auto all_handled = CustomToLower(article_name.begin(), article_name.end());
if (!all_handled)
article_name = boost::locale::to_lower(article_name_link.first, GetLocale("en_US.UTF-8"));
// search for exact title matches
if (article_name == search_text) {
exact_match = std::move(article_name_link);
return;
}
// search for full word matches in title
auto title_words{ExtractWords(article_name)};
for (const auto& title_word : title_words) {
if (std::any_of(words_in_search_text.begin(), words_in_search_text.end(),
[title_word](const auto& wist) { return wist == title_word; }))
{
word_match = std::move(article_name_link);
return;
}
}
// search for partial word matches: searched-for words that appear
// in the title text, not necessarily as a complete word
for (const auto& word : words_in_search_text) {
// reject searches in text for words less than 3 characters
if (word.size() < 3)
continue;
if (boost::contains(article_name, word)) {
partial_match = std::move(article_name_link);
return;
}
}
if (search_article_text)
SearchPediaArticleTextForWords(article_key, article_directory, article_name_link,
article_match, search_text, words_in_search_text, idx);
}
}
void EncyclopediaDetailPanel::HandleSearchTextEntered() {
SectionedScopedTimer timer("HandleSearchTextEntered");
timer.EnterSection("Find words in search text");
// force MapWnd construction before possible parallel accesses below...
ClientUI::GetClientUI()->GetMapWnd();
const unsigned int num_threads = static_cast<unsigned int>(std::max(1, EffectsProcessingThreads()));
boost::asio::thread_pool thread_pool(num_threads);
// search lists of articles for typed text
auto search_text = m_search_edit->Text();
if (search_text.empty())
return;
auto all_handled = CustomToLower(search_text.begin(), search_text.end());
if (!all_handled)
search_text = boost::locale::to_lower(m_search_edit->Text(), GetLocale("en_US.UTF-8"));
// find distinct words in search text
auto words_in_search_text = ExtractWords(search_text);
if (words_in_search_text.empty())
return;
// search through all articles for full or partial matches to search query
timer.EnterSection("get subdirs");
auto pedia_entries = GetSubDirs("ENC_INDEX", false, 0);
std::vector<std::pair<std::string, std::string>> exact_match_report;
std::vector<std::pair<std::string, std::string>> word_match_report;
std::vector<std::pair<std::string, std::string>> partial_match_report;
std::vector<std::pair<std::string, std::string>> article_match_report;
exact_match_report.resize(pedia_entries.size()); // each entry will be sorted into just one of these, but empties will be later ignored
word_match_report.resize(pedia_entries.size());
partial_match_report.resize(pedia_entries.size());
article_match_report.resize(pedia_entries.size());
bool search_desc = GetOptionsDB().Get<bool>("ui.pedia.search.articles.enabled");
timer.EnterSection("search subdirs dispatch");
// assemble link text to all pedia entries, indexed by name
std::size_t idx = -1;
for (auto& [article_key_directory, article_name_link] : pedia_entries) {
if (!utf8::is_valid(article_key_directory.first.begin(), article_key_directory.first.end())) {
ErrorLogger() << "Invalid key UTF8: " << article_key_directory.first
<< " name: " << article_name_link.first
<< " dir: " << article_key_directory.second;
continue;
}
if (!utf8::is_valid(article_name_link.first.begin(), article_name_link.first.end())) {
ErrorLogger() << "Invalid name UTF8: " << article_name_link.first
<< " key: " << article_key_directory.first
<< " dir: " << article_key_directory.second;
continue;
}
idx++;
auto& emr{exact_match_report[idx]};
auto& wmr{word_match_report[idx]};
auto& pmr{partial_match_report[idx]};
auto& amr{article_match_report[idx]};
boost::asio::post(
thread_pool, [
article_key{article_key_directory.first},
article_dir{article_key_directory.second},
article_name_link{article_name_link},
&emr, &wmr, &pmr, &amr,
&search_text,
&words_in_search_text,
idx
]() mutable {
SearchPediaArticleForWords(article_key,
article_dir,
std::move(article_name_link),
emr, wmr, pmr, amr,
search_text,
words_in_search_text,
idx,
false);
});
}
timer.EnterSection("search subdirs eval waiting");
thread_pool.join();
if (search_desc) {
timer.EnterSection("non-parallel article text search");
idx = -1;
for (auto& [article_key_directory, article_name_link] : pedia_entries) {
if (!utf8::is_valid(article_key_directory.first.begin(), article_key_directory.first.end()))
continue;
if (!utf8::is_valid(article_name_link.first.begin(), article_name_link.first.end()))
continue;
idx++;
auto& article_match{article_match_report[idx]};
auto& [article_key, article_directory] = article_key_directory;
SearchPediaArticleTextForWords(article_key, article_directory, std::move(article_name_link),
article_match, search_text, words_in_search_text, idx);
}
}
timer.EnterSection("sort");
// sort results...
std::sort(exact_match_report.begin(), exact_match_report.end());
std::sort(word_match_report.begin(), word_match_report.end());
std::sort(partial_match_report.begin(), partial_match_report.end());
std::sort(article_match_report.begin(), article_match_report.end());
timer.EnterSection("assemble report");
// compile list of articles into some dynamically generated search report text
std::string match_report;
if (!exact_match_report.empty()) {
match_report += "\n" + UserString("ENC_SEARCH_EXACT_MATCHES") + "\n\n";
for (auto&& match : exact_match_report) {
if (!match.second.empty())
match_report += match.second;
}
}
if (!word_match_report.empty()) {
match_report += "\n" + UserString("ENC_SEARCH_WORD_MATCHES") + "\n\n";
for (auto&& match : word_match_report)
match_report += match.second;
}
if (!partial_match_report.empty()) {
match_report += "\n" + UserString("ENC_SEARCH_PARTIAL_MATCHES") + "\n\n";
for (auto&& match : partial_match_report)
match_report += match.second;
}
if (!article_match_report.empty()) {
match_report += "\n" + UserString("ENC_SEARCH_ARTICLE_MATCHES") + "\n\n";
for (auto&& match : article_match_report)
match_report += match.second;
}
if (match_report.empty())
match_report = UserString("ENC_SEARCH_NOTHING_FOUND");
auto duration = timer.Elapsed();
auto duration_ms = std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
match_report += "\n\n" + boost::io::str(FlexibleFormat(UserString("ENC_SEARCH_TOOK"))
% search_text % (ToChars(duration_ms) + " ms"));
AddItem(TEXT_SEARCH_RESULTS, std::move(match_report));
}
void EncyclopediaDetailPanel::Refresh() {
m_needs_refresh = true;
RequirePreRender();
}
void EncyclopediaDetailPanel::PreRender() {
CUIWnd::PreRender();
if (m_needs_refresh) {
m_needs_refresh = false;
RefreshImpl();
}
DoLayout();
}
void EncyclopediaDetailPanel::RefreshImpl() {
if (m_icon) {
DetachChild(m_icon);
m_icon.reset();
}
m_name_text->Clear();
m_summary_text->Clear();
m_cost_text->Clear();
m_description_rich_text->SetText(EMPTY_STRING);
DetachChild(m_graph);
// get details of item as applicable in order to set summary, cost, description TextControls
std::string name;
std::shared_ptr<GG::Texture> texture;
std::shared_ptr<GG::Texture> other_texture;
int turns = -1;
float cost = 0.0f;
std::string cost_units; // "PP" or "RP" or empty string, depending on whether and what something costs
std::string general_type; // general type of thing being shown, eg. "Building" or "Ship Part"
std::string specific_type; // specific type of thing; thing's purpose. eg. "Farming" or "Colonization". May be left blank for things without specific types (eg. specials)
std::string detailed_description;
detailed_description.reserve(2000); // guesstimate
GG::Clr color(GG::CLR_ZERO);
if (m_items.empty())
return;
GetRefreshDetailPanelInfo(m_items_it->first, m_items_it->second,
name, texture, other_texture, turns, cost, cost_units,
general_type, specific_type, detailed_description, color,
m_incomplete_design);
if (m_items_it->first == TextLinker::GRAPH_TAG) {
const std::string& graph_id = m_items_it->second;
const auto& stat_records = GetUniverse().GetStatRecords();
auto stat_name_it = stat_records.find(graph_id);
if (stat_name_it != stat_records.end()) {
const auto& empire_lines = stat_name_it->second;
m_graph->Clear();
// add lines for each empire
for (const auto& [empire_id, linemap] : empire_lines) {
GG::Clr empire_clr = GG::CLR_WHITE;
if (const Empire* empire = GetEmpire(empire_id))
empire_clr = empire->Color();
// convert formats...
std::vector<std::pair<double, double>> line_data_pts;
line_data_pts.reserve(linemap.size());
for (const auto& [turn, stat_value] : linemap)
line_data_pts.emplace_back(turn, stat_value);
m_graph->AddSeries(std::move(line_data_pts), empire_clr);
}
m_graph->AutoSetRange();
AttachChild(m_graph);
m_graph->Show();
}
name = UserString(graph_id);
general_type = UserString("ENC_GRAPH");
}
// Create Icons
if (texture) {
m_icon = GG::Wnd::Create<GG::StaticGraphic>(std::move(texture), GG::GRAPHIC_FITGRAPHIC | GG::GRAPHIC_PROPSCALE);
if (color != GG::CLR_ZERO)
m_icon->SetColor(color);
}
if (m_icon) {
m_icon->Show();
AttachChild(m_icon);
}
// Set Text
if (!name.empty())
m_name_text->SetText(std::move(name));
m_summary_text->SetText(str(FlexibleFormat(UserString("ENC_DETAIL_TYPE_STR"))
% specific_type
% general_type));
if (color != GG::CLR_ZERO)
m_summary_text->SetColor(color);
if (cost != 0.0 && turns != -1) {
m_cost_text->SetText(str(FlexibleFormat(UserString("ENC_COST_AND_TURNS_STR"))
% DoubleToString(cost, 3, false)
% cost_units
% turns));
} else if (cost != 0.0) {
m_cost_text->SetText(str(FlexibleFormat(UserString("ENC_COST_STR"))
% DoubleToString(cost, 3, false)
% cost_units));
}
if (!detailed_description.empty())
m_description_rich_text->SetText(std::move(detailed_description));
m_scroll_panel->ScrollTo(GG::Y0);
}
void EncyclopediaDetailPanel::AddItem(std::string_view type, std::string name) {
// if the actual item is not the last one, all aubsequented items are deleted
if (!m_items.empty()) {
if (m_items_it->first == type && m_items_it->second == name)
return;
auto end = m_items.end();
--end;
if (m_items_it != end) {
auto i = m_items_it;
++i;
m_items.erase(i, m_items.end());
}
}
m_items.emplace_back(type, std::move(name));
if (m_items.size() == 1)
m_items_it = m_items.begin();
else
++m_items_it;
if (m_back_button->Disabled() && m_items.size() > 1) // enable Back button
m_back_button->Disable(false);
if (!m_next_button->Disabled()) // disable Next button
m_next_button->Disable(true);
Refresh();
m_scroll_panel->ScrollTo(GG::Y0); // revert to top for new screen
}
void EncyclopediaDetailPanel::PopItem() {
if (!m_items.empty()) {
m_items.pop_back();
if (m_items_it == m_items.end() && m_items_it != m_items.begin())
--m_items_it;
Refresh();
m_scroll_panel->ScrollTo(GG::Y0); // revert to top for new screen
}
}
void EncyclopediaDetailPanel::ClearItems() {
m_items.clear();
m_items_it = m_items.end();
Refresh();
m_scroll_panel->ScrollTo(GG::Y0); // revert to top for new screen
}
void EncyclopediaDetailPanel::SetText(const std::string& text, bool lookup_in_stringtable) {
if (m_items_it != m_items.end() && text == m_items_it->second)
return;
if (text == "ENC_INDEX")
SetIndex();
else
AddItem(TextLinker::ENCYCLOPEDIA_TAG, (text.empty() || !lookup_in_stringtable) ? text : UserString(text));
}
void EncyclopediaDetailPanel::SetPlanet(int planet_id) {
int current_item_id =
(m_items_it != m_items.end() && m_items_it->first == PLANET_SUITABILITY_REPORT) ?
ToInt(m_items_it->second, INVALID_OBJECT_ID) : INVALID_OBJECT_ID;
if (planet_id == current_item_id)
return;
AddItem(PLANET_SUITABILITY_REPORT, ToChars(planet_id));
}
void EncyclopediaDetailPanel::SetTech(std::string tech_name) {
if (m_items_it != m_items.end() && tech_name == m_items_it->second)
return;
AddItem("ENC_TECH", std::move(tech_name));
}
void EncyclopediaDetailPanel::SetPolicy(std::string policy_name) {
if (m_items_it != m_items.end() && policy_name == m_items_it->second)
return;
AddItem("ENC_POLICY", std::move(policy_name));
}
void EncyclopediaDetailPanel::SetShipPart(std::string part_name) {
if (m_items_it != m_items.end() && part_name == m_items_it->second)
return;
AddItem("ENC_SHIP_PART", std::move(part_name));
}
void EncyclopediaDetailPanel::SetShipHull(std::string hull_name) {
if (m_items_it != m_items.end() && hull_name == m_items_it->second)
return;
AddItem("ENC_SHIP_HULL", std::move(hull_name));
}
void EncyclopediaDetailPanel::SetBuildingType(std::string building_name) {
if (m_items_it != m_items.end() && building_name == m_items_it->second)
return;
AddItem("ENC_BUILDING_TYPE", std::move(building_name));
}
void EncyclopediaDetailPanel::SetSpecial(std::string special_name) {
if (m_items_it != m_items.end() && special_name == m_items_it->second)
return;
AddItem("ENC_SPECIAL", std::move(special_name));
}
void EncyclopediaDetailPanel::SetSpecies(std::string species_name) {
if (m_items_it != m_items.end() && species_name == m_items_it->second)
return;
AddItem("ENC_SPECIES", std::move(species_name));
}
void EncyclopediaDetailPanel::SetFieldType(std::string field_type_name) {
if (m_items_it != m_items.end() && field_type_name == m_items_it->second)
return;
AddItem("ENC_FIELD_TYPE", std::move(field_type_name));
}
void EncyclopediaDetailPanel::SetMeterType(std::string meter_string) {
if (!meter_string.empty())
AddItem("ENC_METER_TYPE", std::move(meter_string));
}
void EncyclopediaDetailPanel::SetMeterType(MeterType meter_type) {
if (meter_type != MeterType::INVALID_METER_TYPE)
AddItem("ENC_METER_TYPE", std::string{to_string(meter_type)});
}
void EncyclopediaDetailPanel::SetObject(int object_id) {
int current_item_id = ToInt(m_items_it->second, INVALID_OBJECT_ID);
if (object_id == current_item_id)
return;
AddItem(UNIVERSE_OBJECT, ToChars(object_id));
}
void EncyclopediaDetailPanel::SetObject(std::string object_id) {
if (m_items_it != m_items.end() && object_id == m_items_it->second)
return;
AddItem(UNIVERSE_OBJECT, std::move(object_id));
}
void EncyclopediaDetailPanel::SetEmpire(int empire_id) {
int current_item_id = ToInt(m_items_it->second, ALL_EMPIRES);
if (empire_id == current_item_id)
return;
AddItem("ENC_EMPIRE", ToChars(empire_id));
}
void EncyclopediaDetailPanel::SetEmpire(std::string empire_id) {
if (m_items_it != m_items.end() && empire_id == m_items_it->second)
return;
AddItem("ENC_EMPIRE", std::move(empire_id));
}
void EncyclopediaDetailPanel::SetDesign(int design_id) {
int current_item_id = (m_items_it->first == "ENC_SHIP_DESIGN") ?
ToInt(m_items_it->second, INVALID_DESIGN_ID) : INVALID_DESIGN_ID;
if (design_id == current_item_id)
return;
AddItem("ENC_SHIP_DESIGN", ToChars(design_id));
}
void EncyclopediaDetailPanel::SetDesign(std::string design_id) {
if (m_items_it != m_items.end() && design_id == m_items_it->second)
return;
AddItem("ENC_SHIP_DESIGN", std::move(design_id));
}
void EncyclopediaDetailPanel::SetIncompleteDesign(std::weak_ptr<const ShipDesign> incomplete_design) {
m_incomplete_design = std::move(incomplete_design);
if (m_items_it == m_items.end() ||
m_items_it->first != INCOMPLETE_DESIGN) {
AddItem(INCOMPLETE_DESIGN, EMPTY_STRING);
} else {
Refresh();
}
}
void EncyclopediaDetailPanel::SetGraph(std::string graph_id)
{ AddItem(TextLinker::GRAPH_TAG, std::move(graph_id)); }
void EncyclopediaDetailPanel::SetIndex()
{ AddItem(TextLinker::ENCYCLOPEDIA_TAG, "ENC_INDEX"); }
void EncyclopediaDetailPanel::SetItem(const std::shared_ptr<const Planet>& planet)
{ SetPlanet(planet ? planet->ID() : INVALID_OBJECT_ID); }
void EncyclopediaDetailPanel::SetItem(const Tech* tech)
{ SetTech(tech ? tech->Name() : EMPTY_STRING); }
void EncyclopediaDetailPanel::SetItem(const Policy* policy)
{ SetPolicy(policy ? policy->Name() : EMPTY_STRING); }
void EncyclopediaDetailPanel::SetItem(const ShipPart* part)
{ SetShipPart(part ? part->Name() : EMPTY_STRING); }
void EncyclopediaDetailPanel::SetItem(const ShipHull* ship_hull)
{ SetShipHull(ship_hull ? ship_hull->Name() : EMPTY_STRING); }
void EncyclopediaDetailPanel::SetItem(const BuildingType* building_type)
{ SetBuildingType(building_type ? building_type->Name() : EMPTY_STRING); }
void EncyclopediaDetailPanel::SetItem(const Special* special)
{ SetSpecial(special ? special->Name() : EMPTY_STRING); }
void EncyclopediaDetailPanel::SetItem(const Species* species)
{ SetSpecies(species ? species->Name() : EMPTY_STRING); }
void EncyclopediaDetailPanel::SetItem(const FieldType* field_type)
{ SetFieldType(field_type ? field_type->Name() : EMPTY_STRING); }
void EncyclopediaDetailPanel::SetItem(const std::shared_ptr<const UniverseObject>& obj)
{ SetObject(obj ? obj->ID() : INVALID_OBJECT_ID); }
void EncyclopediaDetailPanel::SetItem(const Empire* empire)
{ SetEmpire(empire ? empire->EmpireID() : ALL_EMPIRES); }
void EncyclopediaDetailPanel::SetItem(const ShipDesign* design)
{ SetDesign(design ? design->ID() : INVALID_DESIGN_ID); }
void EncyclopediaDetailPanel::SetItem(MeterType meter_type)
{ SetMeterType(std::string{to_string(meter_type)}); }
void EncyclopediaDetailPanel::SetEncyclopediaArticle(std::string name)
{ AddItem(TextLinker::ENCYCLOPEDIA_TAG, std::move(name)); }
void EncyclopediaDetailPanel::OnIndex()
{ AddItem(TextLinker::ENCYCLOPEDIA_TAG, "ENC_INDEX"); }
void EncyclopediaDetailPanel::OnBack() {
if (m_items_it != m_items.begin())
--m_items_it;
if (m_items_it == m_items.begin()) // disable Back button, if the beginning is reached
m_back_button->Disable(true);
if (m_next_button->Disabled()) // enable Next button
m_next_button->Disable(false);
Refresh();
m_scroll_panel->ScrollTo(GG::Y0); // revert to top for new screen
}
void EncyclopediaDetailPanel::OnNext() {
auto end = m_items.end();
--end;
if (m_items_it != end && !m_items.empty())
++m_items_it;
if (m_items_it == end) // disable Next button, if the end is reached;
m_next_button->Disable(true);
if (m_back_button->Disabled()) // enable Back button
m_back_button->Disable(false);
Refresh();
m_scroll_panel->ScrollTo(GG::Y0); // revert to top for new screen
}
void EncyclopediaDetailPanel::CloseClicked()
{ ClosingSignal(); }
bool EncyclopediaDetailPanel::EventFilter(GG::Wnd* w, const GG::WndEvent& event) {
if (w == this)
return false;
if (event.Type() != GG::WndEvent::EventType::KeyPress)
return false;
this->HandleEvent(event);
return true;
}
|