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
pub const PHYSFS_VER_MAJOR: u32 = 3;
pub const PHYSFS_VER_MINOR: u32 = 0;
pub const PHYSFS_VER_PATCH: u32 = 2;
#[doc = " \\typedef PHYSFS_uint8"]
#[doc = " \\brief An unsigned, 8-bit integer type."]
pub type PHYSFS_uint8 = ::std::os::raw::c_uchar;
#[doc = " \\typedef PHYSFS_sint8"]
#[doc = " \\brief A signed, 8-bit integer type."]
pub type PHYSFS_sint8 = ::std::os::raw::c_schar;
#[doc = " \\typedef PHYSFS_uint16"]
#[doc = " \\brief An unsigned, 16-bit integer type."]
pub type PHYSFS_uint16 = ::std::os::raw::c_ushort;
#[doc = " \\typedef PHYSFS_sint16"]
#[doc = " \\brief A signed, 16-bit integer type."]
pub type PHYSFS_sint16 = ::std::os::raw::c_short;
#[doc = " \\typedef PHYSFS_uint32"]
#[doc = " \\brief An unsigned, 32-bit integer type."]
pub type PHYSFS_uint32 = ::std::os::raw::c_uint;
#[doc = " \\typedef PHYSFS_sint32"]
#[doc = " \\brief A signed, 32-bit integer type."]
pub type PHYSFS_sint32 = ::std::os::raw::c_int;
pub type PHYSFS_uint64 = ::std::os::raw::c_ulonglong;
pub type PHYSFS_sint64 = ::std::os::raw::c_longlong;
pub type PHYSFS_compile_time_assert_uint8IsOneByte = [::std::os::raw::c_int; 1usize];
pub type PHYSFS_compile_time_assert_sint8IsOneByte = [::std::os::raw::c_int; 1usize];
pub type PHYSFS_compile_time_assert_uint16IsTwoBytes = [::std::os::raw::c_int; 1usize];
pub type PHYSFS_compile_time_assert_sint16IsTwoBytes = [::std::os::raw::c_int; 1usize];
pub type PHYSFS_compile_time_assert_uint32IsFourBytes = [::std::os::raw::c_int; 1usize];
pub type PHYSFS_compile_time_assert_sint32IsFourBytes = [::std::os::raw::c_int; 1usize];
pub type PHYSFS_compile_time_assert_uint64IsEightBytes = [::std::os::raw::c_int; 1usize];
pub type PHYSFS_compile_time_assert_sint64IsEightBytes = [::std::os::raw::c_int; 1usize];
#[doc = " \\struct PHYSFS_File"]
#[doc = " \\brief A PhysicsFS file handle."]
#[doc = ""]
#[doc = " You get a pointer to one of these when you open a file for reading,"]
#[doc = " writing, or appending via PhysicsFS."]
#[doc = ""]
#[doc = " As you can see from the lack of meaningful fields, you should treat this"]
#[doc = " as opaque data. Don't try to manipulate the file handle, just pass the"]
#[doc = " pointer you got, unmolested, to various PhysicsFS APIs."]
#[doc = ""]
#[doc = " \\sa PHYSFS_openRead"]
#[doc = " \\sa PHYSFS_openWrite"]
#[doc = " \\sa PHYSFS_openAppend"]
#[doc = " \\sa PHYSFS_close"]
#[doc = " \\sa PHYSFS_read"]
#[doc = " \\sa PHYSFS_write"]
#[doc = " \\sa PHYSFS_seek"]
#[doc = " \\sa PHYSFS_tell"]
#[doc = " \\sa PHYSFS_eof"]
#[doc = " \\sa PHYSFS_setBuffer"]
#[doc = " \\sa PHYSFS_flush"]
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct PHYSFS_File {
#[doc = "< That's all you get. Don't touch."]
pub opaque: *mut ::std::os::raw::c_void,
}
#[test]
fn bindgen_test_layout_PHYSFS_File() {
assert_eq!(
::std::mem::size_of::<PHYSFS_File>(),
8usize,
concat!("Size of: ", stringify!(PHYSFS_File))
);
assert_eq!(
::std::mem::align_of::<PHYSFS_File>(),
8usize,
concat!("Alignment of ", stringify!(PHYSFS_File))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_File>())).opaque as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_File),
"::",
stringify!(opaque)
)
);
}
#[doc = " \\struct PHYSFS_ArchiveInfo"]
#[doc = " \\brief Information on various PhysicsFS-supported archives."]
#[doc = ""]
#[doc = " This structure gives you details on what sort of archives are supported"]
#[doc = " by this implementation of PhysicsFS. Archives tend to be things like"]
#[doc = " ZIP files and such."]
#[doc = ""]
#[doc = " \\warning Not all binaries are created equal! PhysicsFS can be built with"]
#[doc = " or without support for various archives. You can check with"]
#[doc = " PHYSFS_supportedArchiveTypes() to see if your archive type is"]
#[doc = " supported."]
#[doc = ""]
#[doc = " \\sa PHYSFS_supportedArchiveTypes"]
#[doc = " \\sa PHYSFS_registerArchiver"]
#[doc = " \\sa PHYSFS_deregisterArchiver"]
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct PHYSFS_ArchiveInfo {
#[doc = "< Archive file extension: \"ZIP\", for example."]
pub extension: *const ::std::os::raw::c_char,
#[doc = "< Human-readable archive description."]
pub description: *const ::std::os::raw::c_char,
#[doc = "< Person who did support for this archive."]
pub author: *const ::std::os::raw::c_char,
#[doc = "< URL related to this archive"]
pub url: *const ::std::os::raw::c_char,
#[doc = "< non-zero if archive offers symbolic links."]
pub supportsSymlinks: ::std::os::raw::c_int,
}
#[test]
fn bindgen_test_layout_PHYSFS_ArchiveInfo() {
assert_eq!(
::std::mem::size_of::<PHYSFS_ArchiveInfo>(),
40usize,
concat!("Size of: ", stringify!(PHYSFS_ArchiveInfo))
);
assert_eq!(
::std::mem::align_of::<PHYSFS_ArchiveInfo>(),
8usize,
concat!("Alignment of ", stringify!(PHYSFS_ArchiveInfo))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_ArchiveInfo>())).extension as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_ArchiveInfo),
"::",
stringify!(extension)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_ArchiveInfo>())).description as *const _ as usize },
8usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_ArchiveInfo),
"::",
stringify!(description)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_ArchiveInfo>())).author as *const _ as usize },
16usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_ArchiveInfo),
"::",
stringify!(author)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_ArchiveInfo>())).url as *const _ as usize },
24usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_ArchiveInfo),
"::",
stringify!(url)
)
);
assert_eq!(
unsafe {
&(*(::std::ptr::null::<PHYSFS_ArchiveInfo>())).supportsSymlinks as *const _ as usize
},
32usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_ArchiveInfo),
"::",
stringify!(supportsSymlinks)
)
);
}
#[doc = " \\struct PHYSFS_Version"]
#[doc = " \\brief Information the version of PhysicsFS in use."]
#[doc = ""]
#[doc = " Represents the library's version as three levels: major revision"]
#[doc = " (increments with massive changes, additions, and enhancements),"]
#[doc = " minor revision (increments with backwards-compatible changes to the"]
#[doc = " major revision), and patchlevel (increments with fixes to the minor"]
#[doc = " revision)."]
#[doc = ""]
#[doc = " \\sa PHYSFS_VERSION"]
#[doc = " \\sa PHYSFS_getLinkedVersion"]
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct PHYSFS_Version {
#[doc = "< major revision"]
pub major: PHYSFS_uint8,
#[doc = "< minor revision"]
pub minor: PHYSFS_uint8,
#[doc = "< patchlevel"]
pub patch: PHYSFS_uint8,
}
#[test]
fn bindgen_test_layout_PHYSFS_Version() {
assert_eq!(
::std::mem::size_of::<PHYSFS_Version>(),
3usize,
concat!("Size of: ", stringify!(PHYSFS_Version))
);
assert_eq!(
::std::mem::align_of::<PHYSFS_Version>(),
1usize,
concat!("Alignment of ", stringify!(PHYSFS_Version))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Version>())).major as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Version),
"::",
stringify!(major)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Version>())).minor as *const _ as usize },
1usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Version),
"::",
stringify!(minor)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Version>())).patch as *const _ as usize },
2usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Version),
"::",
stringify!(patch)
)
);
}
extern "C" {
#[doc = " \\fn void PHYSFS_getLinkedVersion(PHYSFS_Version *ver)"]
#[doc = " \\brief Get the version of PhysicsFS that is linked against your program."]
#[doc = ""]
#[doc = " If you are using a shared library (DLL) version of PhysFS, then it is"]
#[doc = " possible that it will be different than the version you compiled against."]
#[doc = ""]
#[doc = " This is a real function; the macro PHYSFS_VERSION tells you what version"]
#[doc = " of PhysFS you compiled against:"]
#[doc = ""]
#[doc = " \\code"]
#[doc = " PHYSFS_Version compiled;"]
#[doc = " PHYSFS_Version linked;"]
#[doc = ""]
#[doc = " PHYSFS_VERSION(&compiled);"]
#[doc = " PHYSFS_getLinkedVersion(&linked);"]
#[doc = " printf(\"We compiled against PhysFS version %d.%d.%d ...\\n\","]
#[doc = " compiled.major, compiled.minor, compiled.patch);"]
#[doc = " printf(\"But we linked against PhysFS version %d.%d.%d.\\n\","]
#[doc = " linked.major, linked.minor, linked.patch);"]
#[doc = " \\endcode"]
#[doc = ""]
#[doc = " This function may be called safely at any time, even before PHYSFS_init()."]
#[doc = ""]
#[doc = " \\sa PHYSFS_VERSION"]
pub fn PHYSFS_getLinkedVersion(ver: *mut PHYSFS_Version);
}
extern "C" {
#[doc = " \\fn int PHYSFS_init(const char *argv0)"]
#[doc = " \\brief Initialize the PhysicsFS library."]
#[doc = ""]
#[doc = " This must be called before any other PhysicsFS function."]
#[doc = ""]
#[doc = " This should be called prior to any attempts to change your process's"]
#[doc = " current working directory."]
#[doc = ""]
#[doc = " \\param argv0 the argv[0] string passed to your program's mainline."]
#[doc = " This may be NULL on most platforms (such as ones without a"]
#[doc = " standard main() function), but you should always try to pass"]
#[doc = " something in here. Unix-like systems such as Linux _need_ to"]
#[doc = " pass argv[0] from main() in here."]
#[doc = " \\return nonzero on success, zero on error. Specifics of the error can be"]
#[doc = " gleaned from PHYSFS_getLastError()."]
#[doc = ""]
#[doc = " \\sa PHYSFS_deinit"]
#[doc = " \\sa PHYSFS_isInit"]
pub fn PHYSFS_init(argv0: *const ::std::os::raw::c_char) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_deinit(void)"]
#[doc = " \\brief Deinitialize the PhysicsFS library."]
#[doc = ""]
#[doc = " This closes any files opened via PhysicsFS, blanks the search/write paths,"]
#[doc = " frees memory, and invalidates all of your file handles."]
#[doc = ""]
#[doc = " Note that this call can FAIL if there's a file open for writing that"]
#[doc = " refuses to close (for example, the underlying operating system was"]
#[doc = " buffering writes to network filesystem, and the fileserver has crashed,"]
#[doc = " or a hard drive has failed, etc). It is usually best to close all write"]
#[doc = " handles yourself before calling this function, so that you can gracefully"]
#[doc = " handle a specific failure."]
#[doc = ""]
#[doc = " Once successfully deinitialized, PHYSFS_init() can be called again to"]
#[doc = " restart the subsystem. All default API states are restored at this"]
#[doc = " point, with the exception of any custom allocator you might have"]
#[doc = " specified, which survives between initializations."]
#[doc = ""]
#[doc = " \\return nonzero on success, zero on error. Specifics of the error can be"]
#[doc = " gleaned from PHYSFS_getLastError(). If failure, state of PhysFS is"]
#[doc = " undefined, and probably badly screwed up."]
#[doc = ""]
#[doc = " \\sa PHYSFS_init"]
#[doc = " \\sa PHYSFS_isInit"]
pub fn PHYSFS_deinit() -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void)"]
#[doc = " \\brief Get a list of supported archive types."]
#[doc = ""]
#[doc = " Get a list of archive types supported by this implementation of PhysicFS."]
#[doc = " These are the file formats usable for search path entries. This is for"]
#[doc = " informational purposes only. Note that the extension listed is merely"]
#[doc = " convention: if we list \"ZIP\", you can open a PkZip-compatible archive"]
#[doc = " with an extension of \"XYZ\", if you like."]
#[doc = ""]
#[doc = " The returned value is an array of pointers to PHYSFS_ArchiveInfo structures,"]
#[doc = " with a NULL entry to signify the end of the list:"]
#[doc = ""]
#[doc = " \\code"]
#[doc = " PHYSFS_ArchiveInfo **i;"]
#[doc = ""]
#[doc = " for (i = PHYSFS_supportedArchiveTypes(); *i != NULL; i++)"]
#[doc = " {"]
#[doc = " printf(\"Supported archive: [%s], which is [%s].\\n\","]
#[doc = " (*i)->extension, (*i)->description);"]
#[doc = " }"]
#[doc = " \\endcode"]
#[doc = ""]
#[doc = " The return values are pointers to internal memory, and should"]
#[doc = " be considered READ ONLY, and never freed. The returned values are"]
#[doc = " valid until the next call to PHYSFS_deinit(), PHYSFS_registerArchiver(),"]
#[doc = " or PHYSFS_deregisterArchiver()."]
#[doc = ""]
#[doc = " \\return READ ONLY Null-terminated array of READ ONLY structures."]
#[doc = ""]
#[doc = " \\sa PHYSFS_registerArchiver"]
#[doc = " \\sa PHYSFS_deregisterArchiver"]
pub fn PHYSFS_supportedArchiveTypes() -> *mut *const PHYSFS_ArchiveInfo;
}
extern "C" {
#[doc = " \\fn void PHYSFS_freeList(void *listVar)"]
#[doc = " \\brief Deallocate resources of lists returned by PhysicsFS."]
#[doc = ""]
#[doc = " Certain PhysicsFS functions return lists of information that are"]
#[doc = " dynamically allocated. Use this function to free those resources."]
#[doc = ""]
#[doc = " It is safe to pass a NULL here, but doing so will cause a crash in versions"]
#[doc = " before PhysicsFS 2.1.0."]
#[doc = ""]
#[doc = " \\param listVar List of information specified as freeable by this function."]
#[doc = " Passing NULL is safe; it is a valid no-op."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getCdRomDirs"]
#[doc = " \\sa PHYSFS_enumerateFiles"]
#[doc = " \\sa PHYSFS_getSearchPath"]
pub fn PHYSFS_freeList(listVar: *mut ::std::os::raw::c_void);
}
extern "C" {
#[doc = " \\fn const char *PHYSFS_getLastError(void)"]
#[doc = " \\brief Get human-readable error information."]
#[doc = ""]
#[doc = " \\deprecated Use PHYSFS_getLastErrorCode() and PHYSFS_getErrorByCode() instead."]
#[doc = ""]
#[doc = " \\warning As of PhysicsFS 2.1, this function has been nerfed."]
#[doc = " Before PhysicsFS 2.1, this function was the only way to get"]
#[doc = " error details beyond a given function's basic return value."]
#[doc = " This was meant to be a human-readable string in one of several"]
#[doc = " languages, and was not useful for application parsing. This was"]
#[doc = " a problem, because the developer and not the user chose the"]
#[doc = " language at compile time, and the PhysicsFS maintainers had"]
#[doc = " to (poorly) maintain a significant amount of localization work."]
#[doc = " The app couldn't parse the strings, even if they counted on a"]
#[doc = " specific language, since some were dynamically generated."]
#[doc = " In 2.1 and later, this always returns a static string in"]
#[doc = " English; you may use it as a key string for your own"]
#[doc = " localizations if you like, as we'll promise not to change"]
#[doc = " existing error strings. Also, if your application wants to"]
#[doc = " look at specific errors, we now offer a better option:"]
#[doc = " use PHYSFS_getLastErrorCode() instead."]
#[doc = ""]
#[doc = " Get the last PhysicsFS error message as a human-readable, null-terminated"]
#[doc = " string. This will return NULL if there's been no error since the last call"]
#[doc = " to this function. The pointer returned by this call points to an internal"]
#[doc = " buffer. Each thread has a unique error state associated with it, but each"]
#[doc = " time a new error message is set, it will overwrite the previous one"]
#[doc = " associated with that thread. It is safe to call this function at anytime,"]
#[doc = " even before PHYSFS_init()."]
#[doc = ""]
#[doc = " PHYSFS_getLastError() and PHYSFS_getLastErrorCode() both reset the same"]
#[doc = " thread-specific error state. Calling one will wipe out the other's"]
#[doc = " data. If you need both, call PHYSFS_getLastErrorCode(), then pass that"]
#[doc = " value to PHYSFS_getErrorByCode()."]
#[doc = ""]
#[doc = " As of PhysicsFS 2.1, this function only presents text in the English"]
#[doc = " language, but the strings are static, so you can use them as keys into"]
#[doc = " your own localization dictionary. These strings are meant to be passed on"]
#[doc = " directly to the user."]
#[doc = ""]
#[doc = " Generally, applications should only concern themselves with whether a"]
#[doc = " given function failed; however, if your code require more specifics, you"]
#[doc = " should use PHYSFS_getLastErrorCode() instead of this function."]
#[doc = ""]
#[doc = " \\return READ ONLY string of last error message."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getLastErrorCode"]
#[doc = " \\sa PHYSFS_getErrorByCode"]
pub fn PHYSFS_getLastError() -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " \\fn const char *PHYSFS_getDirSeparator(void)"]
#[doc = " \\brief Get platform-dependent dir separator string."]
#[doc = ""]
#[doc = " This returns \"\\\\\" on win32, \"/\" on Unix, and \":\" on MacOS. It may be more"]
#[doc = " than one character, depending on the platform, and your code should take"]
#[doc = " that into account. Note that this is only useful for setting up the"]
#[doc = " search/write paths, since access into those dirs always use '/'"]
#[doc = " (platform-independent notation) to separate directories. This is also"]
#[doc = " handy for getting platform-independent access when using stdio calls."]
#[doc = ""]
#[doc = " \\return READ ONLY null-terminated string of platform's dir separator."]
pub fn PHYSFS_getDirSeparator() -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " \\fn void PHYSFS_permitSymbolicLinks(int allow)"]
#[doc = " \\brief Enable or disable following of symbolic links."]
#[doc = ""]
#[doc = " Some physical filesystems and archives contain files that are just pointers"]
#[doc = " to other files. On the physical filesystem, opening such a link will"]
#[doc = " (transparently) open the file that is pointed to."]
#[doc = ""]
#[doc = " By default, PhysicsFS will check if a file is really a symlink during open"]
#[doc = " calls and fail if it is. Otherwise, the link could take you outside the"]
#[doc = " write and search paths, and compromise security."]
#[doc = ""]
#[doc = " If you want to take that risk, call this function with a non-zero parameter."]
#[doc = " Note that this is more for sandboxing a program's scripting language, in"]
#[doc = " case untrusted scripts try to compromise the system. Generally speaking,"]
#[doc = " a user could very well have a legitimate reason to set up a symlink, so"]
#[doc = " unless you feel there's a specific danger in allowing them, you should"]
#[doc = " permit them."]
#[doc = ""]
#[doc = " Symlinks are only explicitly checked when dealing with filenames"]
#[doc = " in platform-independent notation. That is, when setting up your"]
#[doc = " search and write paths, etc, symlinks are never checked for."]
#[doc = ""]
#[doc = " Please note that PHYSFS_stat() will always check the path specified; if"]
#[doc = " that path is a symlink, it will not be followed in any case. If symlinks"]
#[doc = " aren't permitted through this function, PHYSFS_stat() ignores them, and"]
#[doc = " would treat the query as if the path didn't exist at all."]
#[doc = ""]
#[doc = " Symbolic link permission can be enabled or disabled at any time after"]
#[doc = " you've called PHYSFS_init(), and is disabled by default."]
#[doc = ""]
#[doc = " \\param allow nonzero to permit symlinks, zero to deny linking."]
#[doc = ""]
#[doc = " \\sa PHYSFS_symbolicLinksPermitted"]
pub fn PHYSFS_permitSymbolicLinks(allow: ::std::os::raw::c_int);
}
extern "C" {
#[doc = " \\fn char **PHYSFS_getCdRomDirs(void)"]
#[doc = " \\brief Get an array of paths to available CD-ROM drives."]
#[doc = ""]
#[doc = " The dirs returned are platform-dependent (\"D:\\\" on Win32, \"/cdrom\" or"]
#[doc = " whatnot on Unix). Dirs are only returned if there is a disc ready and"]
#[doc = " accessible in the drive. So if you've got two drives (D: and E:), and only"]
#[doc = " E: has a disc in it, then that's all you get. If the user inserts a disc"]
#[doc = " in D: and you call this function again, you get both drives. If, on a"]
#[doc = " Unix box, the user unmounts a disc and remounts it elsewhere, the next"]
#[doc = " call to this function will reflect that change."]
#[doc = ""]
#[doc = " This function refers to \"CD-ROM\" media, but it really means \"inserted disc"]
#[doc = " media,\" such as DVD-ROM, HD-DVD, CDRW, and Blu-Ray discs. It looks for"]
#[doc = " filesystems, and as such won't report an audio CD, unless there's a"]
#[doc = " mounted filesystem track on it."]
#[doc = ""]
#[doc = " The returned value is an array of strings, with a NULL entry to signify the"]
#[doc = " end of the list:"]
#[doc = ""]
#[doc = " \\code"]
#[doc = " char **cds = PHYSFS_getCdRomDirs();"]
#[doc = " char **i;"]
#[doc = ""]
#[doc = " for (i = cds; *i != NULL; i++)"]
#[doc = " printf(\"cdrom dir [%s] is available.\\n\", *i);"]
#[doc = ""]
#[doc = " PHYSFS_freeList(cds);"]
#[doc = " \\endcode"]
#[doc = ""]
#[doc = " This call may block while drives spin up. Be forewarned."]
#[doc = ""]
#[doc = " When you are done with the returned information, you may dispose of the"]
#[doc = " resources by calling PHYSFS_freeList() with the returned pointer."]
#[doc = ""]
#[doc = " \\return Null-terminated array of null-terminated strings."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getCdRomDirsCallback"]
pub fn PHYSFS_getCdRomDirs() -> *mut *mut ::std::os::raw::c_char;
}
extern "C" {
#[doc = " \\fn const char *PHYSFS_getBaseDir(void)"]
#[doc = " \\brief Get the path where the application resides."]
#[doc = ""]
#[doc = " Helper function."]
#[doc = ""]
#[doc = " Get the \"base dir\". This is the directory where the application was run"]
#[doc = " from, which is probably the installation directory, and may or may not"]
#[doc = " be the process's current working directory."]
#[doc = ""]
#[doc = " You should probably use the base dir in your search path."]
#[doc = ""]
#[doc = " \\return READ ONLY string of base dir in platform-dependent notation."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getPrefDir"]
pub fn PHYSFS_getBaseDir() -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " \\fn const char *PHYSFS_getUserDir(void)"]
#[doc = " \\brief Get the path where user's home directory resides."]
#[doc = ""]
#[doc = " \\deprecated As of PhysicsFS 2.1, you probably want PHYSFS_getPrefDir()."]
#[doc = ""]
#[doc = " Helper function."]
#[doc = ""]
#[doc = " Get the \"user dir\". This is meant to be a suggestion of where a specific"]
#[doc = " user of the system can store files. On Unix, this is her home directory."]
#[doc = " On systems with no concept of multiple home directories (MacOS, win95),"]
#[doc = " this will default to something like \"C:\\mybasedir\\users\\username\""]
#[doc = " where \"username\" will either be the login name, or \"default\" if the"]
#[doc = " platform doesn't support multiple users, either."]
#[doc = ""]
#[doc = " \\return READ ONLY string of user dir in platform-dependent notation."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getBaseDir"]
#[doc = " \\sa PHYSFS_getPrefDir"]
pub fn PHYSFS_getUserDir() -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " \\fn const char *PHYSFS_getWriteDir(void)"]
#[doc = " \\brief Get path where PhysicsFS will allow file writing."]
#[doc = ""]
#[doc = " Get the current write dir. The default write dir is NULL."]
#[doc = ""]
#[doc = " \\return READ ONLY string of write dir in platform-dependent notation,"]
#[doc = " OR NULL IF NO WRITE PATH IS CURRENTLY SET."]
#[doc = ""]
#[doc = " \\sa PHYSFS_setWriteDir"]
pub fn PHYSFS_getWriteDir() -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " \\fn int PHYSFS_setWriteDir(const char *newDir)"]
#[doc = " \\brief Tell PhysicsFS where it may write files."]
#[doc = ""]
#[doc = " Set a new write dir. This will override the previous setting."]
#[doc = ""]
#[doc = " This call will fail (and fail to change the write dir) if the current"]
#[doc = " write dir still has files open in it."]
#[doc = ""]
#[doc = " \\param newDir The new directory to be the root of the write dir,"]
#[doc = " specified in platform-dependent notation. Setting to NULL"]
#[doc = " disables the write dir, so no files can be opened for"]
#[doc = " writing via PhysicsFS."]
#[doc = " \\return non-zero on success, zero on failure. All attempts to open a file"]
#[doc = " for writing via PhysicsFS will fail until this call succeeds."]
#[doc = " Use PHYSFS_getLastErrorCode() to obtain the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getWriteDir"]
pub fn PHYSFS_setWriteDir(newDir: *const ::std::os::raw::c_char) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_addToSearchPath(const char *newDir, int appendToPath)"]
#[doc = " \\brief Add an archive or directory to the search path."]
#[doc = ""]
#[doc = " \\deprecated As of PhysicsFS 2.0, use PHYSFS_mount() instead. This"]
#[doc = " function just wraps it anyhow."]
#[doc = ""]
#[doc = " This function is equivalent to:"]
#[doc = ""]
#[doc = " \\code"]
#[doc = " PHYSFS_mount(newDir, NULL, appendToPath);"]
#[doc = " \\endcode"]
#[doc = ""]
#[doc = " You must use this and not PHYSFS_mount if binary compatibility with"]
#[doc = " PhysicsFS 1.0 is important (which it may not be for many people)."]
#[doc = ""]
#[doc = " \\sa PHYSFS_mount"]
#[doc = " \\sa PHYSFS_removeFromSearchPath"]
#[doc = " \\sa PHYSFS_getSearchPath"]
pub fn PHYSFS_addToSearchPath(
newDir: *const ::std::os::raw::c_char,
appendToPath: ::std::os::raw::c_int,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_removeFromSearchPath(const char *oldDir)"]
#[doc = " \\brief Remove a directory or archive from the search path."]
#[doc = ""]
#[doc = " \\deprecated As of PhysicsFS 2.1, use PHYSFS_unmount() instead. This"]
#[doc = " function just wraps it anyhow. There's no functional difference"]
#[doc = " except the vocabulary changed from \"adding to the search path\""]
#[doc = " to \"mounting\" when that functionality was extended, and thus"]
#[doc = " the preferred way to accomplish this function's work is now"]
#[doc = " called \"unmounting.\""]
#[doc = ""]
#[doc = " This function is equivalent to:"]
#[doc = ""]
#[doc = " \\code"]
#[doc = " PHYSFS_unmount(oldDir);"]
#[doc = " \\endcode"]
#[doc = ""]
#[doc = " You must use this and not PHYSFS_unmount if binary compatibility with"]
#[doc = " PhysicsFS 1.0 is important (which it may not be for many people)."]
#[doc = ""]
#[doc = " \\sa PHYSFS_addToSearchPath"]
#[doc = " \\sa PHYSFS_getSearchPath"]
#[doc = " \\sa PHYSFS_unmount"]
pub fn PHYSFS_removeFromSearchPath(
oldDir: *const ::std::os::raw::c_char,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn char **PHYSFS_getSearchPath(void)"]
#[doc = " \\brief Get the current search path."]
#[doc = ""]
#[doc = " The default search path is an empty list."]
#[doc = ""]
#[doc = " The returned value is an array of strings, with a NULL entry to signify the"]
#[doc = " end of the list:"]
#[doc = ""]
#[doc = " \\code"]
#[doc = " char **i;"]
#[doc = ""]
#[doc = " for (i = PHYSFS_getSearchPath(); *i != NULL; i++)"]
#[doc = " printf(\"[%s] is in the search path.\\n\", *i);"]
#[doc = " \\endcode"]
#[doc = ""]
#[doc = " When you are done with the returned information, you may dispose of the"]
#[doc = " resources by calling PHYSFS_freeList() with the returned pointer."]
#[doc = ""]
#[doc = " \\return Null-terminated array of null-terminated strings. NULL if there"]
#[doc = " was a problem (read: OUT OF MEMORY)."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getSearchPathCallback"]
#[doc = " \\sa PHYSFS_addToSearchPath"]
#[doc = " \\sa PHYSFS_removeFromSearchPath"]
pub fn PHYSFS_getSearchPath() -> *mut *mut ::std::os::raw::c_char;
}
extern "C" {
#[doc = " \\fn int PHYSFS_setSaneConfig(const char *organization, const char *appName, const char *archiveExt, int includeCdRoms, int archivesFirst)"]
#[doc = " \\brief Set up sane, default paths."]
#[doc = ""]
#[doc = " Helper function."]
#[doc = ""]
#[doc = " The write dir will be set to the pref dir returned by"]
#[doc = " \\code PHYSFS_getPrefDir(organization, appName) \\endcode, which is"]
#[doc = " created if it doesn't exist."]
#[doc = ""]
#[doc = " The above is sufficient to make sure your program's configuration directory"]
#[doc = " is separated from other clutter, and platform-independent."]
#[doc = ""]
#[doc = " The search path will be:"]
#[doc = ""]
#[doc = " - The Write Dir (created if it doesn't exist)"]
#[doc = " - The Base Dir (PHYSFS_getBaseDir())"]
#[doc = " - All found CD-ROM dirs (optionally)"]
#[doc = ""]
#[doc = " These directories are then searched for files ending with the extension"]
#[doc = " (archiveExt), which, if they are valid and supported archives, will also"]
#[doc = " be added to the search path. If you specified \"PKG\" for (archiveExt), and"]
#[doc = " there's a file named data.PKG in the base dir, it'll be checked. Archives"]
#[doc = " can either be appended or prepended to the search path in alphabetical"]
#[doc = " order, regardless of which directories they were found in. All archives"]
#[doc = " are mounted in the root of the virtual file system (\"/\")."]
#[doc = ""]
#[doc = " All of this can be accomplished from the application, but this just does it"]
#[doc = " all for you. Feel free to add more to the search path manually, too."]
#[doc = ""]
#[doc = " \\param organization Name of your company/group/etc to be used as a"]
#[doc = " dirname, so keep it small, and no-frills."]
#[doc = ""]
#[doc = " \\param appName Program-specific name of your program, to separate it"]
#[doc = " from other programs using PhysicsFS."]
#[doc = ""]
#[doc = " \\param archiveExt File extension used by your program to specify an"]
#[doc = " archive. For example, Quake 3 uses \"pk3\", even though"]
#[doc = " they are just zipfiles. Specify NULL to not dig out"]
#[doc = " archives automatically. Do not specify the '.' char;"]
#[doc = " If you want to look for ZIP files, specify \"ZIP\" and"]
#[doc = " not \".ZIP\" ... the archive search is case-insensitive."]
#[doc = ""]
#[doc = " \\param includeCdRoms Non-zero to include CD-ROMs in the search path, and"]
#[doc = " (if (archiveExt) != NULL) search them for archives."]
#[doc = " This may cause a significant amount of blocking"]
#[doc = " while discs are accessed, and if there are no discs"]
#[doc = " in the drive (or even not mounted on Unix systems),"]
#[doc = " then they may not be made available anyhow. You may"]
#[doc = " want to specify zero and handle the disc setup"]
#[doc = " yourself."]
#[doc = ""]
#[doc = " \\param archivesFirst Non-zero to prepend the archives to the search path."]
#[doc = " Zero to append them. Ignored if !(archiveExt)."]
#[doc = ""]
#[doc = " \\return nonzero on success, zero on error. Use PHYSFS_getLastErrorCode()"]
#[doc = " to obtain the specific error."]
pub fn PHYSFS_setSaneConfig(
organization: *const ::std::os::raw::c_char,
appName: *const ::std::os::raw::c_char,
archiveExt: *const ::std::os::raw::c_char,
includeCdRoms: ::std::os::raw::c_int,
archivesFirst: ::std::os::raw::c_int,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_mkdir(const char *dirName)"]
#[doc = " \\brief Create a directory."]
#[doc = ""]
#[doc = " This is specified in platform-independent notation in relation to the"]
#[doc = " write dir. All missing parent directories are also created if they"]
#[doc = " don't exist."]
#[doc = ""]
#[doc = " So if you've got the write dir set to \"C:\\mygame\\writedir\" and call"]
#[doc = " PHYSFS_mkdir(\"downloads/maps\") then the directories"]
#[doc = " \"C:\\mygame\\writedir\\downloads\" and \"C:\\mygame\\writedir\\downloads\\maps\""]
#[doc = " will be created if possible. If the creation of \"maps\" fails after we"]
#[doc = " have successfully created \"downloads\", then the function leaves the"]
#[doc = " created directory behind and reports failure."]
#[doc = ""]
#[doc = " \\param dirName New dir to create."]
#[doc = " \\return nonzero on success, zero on error. Use"]
#[doc = " PHYSFS_getLastErrorCode() to obtain the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_delete"]
pub fn PHYSFS_mkdir(dirName: *const ::std::os::raw::c_char) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_delete(const char *filename)"]
#[doc = " \\brief Delete a file or directory."]
#[doc = ""]
#[doc = " (filename) is specified in platform-independent notation in relation to the"]
#[doc = " write dir."]
#[doc = ""]
#[doc = " A directory must be empty before this call can delete it."]
#[doc = ""]
#[doc = " Deleting a symlink will remove the link, not what it points to, regardless"]
#[doc = " of whether you \"permitSymLinks\" or not."]
#[doc = ""]
#[doc = " So if you've got the write dir set to \"C:\\mygame\\writedir\" and call"]
#[doc = " PHYSFS_delete(\"downloads/maps/level1.map\") then the file"]
#[doc = " \"C:\\mygame\\writedir\\downloads\\maps\\level1.map\" is removed from the"]
#[doc = " physical filesystem, if it exists and the operating system permits the"]
#[doc = " deletion."]
#[doc = ""]
#[doc = " Note that on Unix systems, deleting a file may be successful, but the"]
#[doc = " actual file won't be removed until all processes that have an open"]
#[doc = " filehandle to it (including your program) close their handles."]
#[doc = ""]
#[doc = " Chances are, the bits that make up the file still exist, they are just"]
#[doc = " made available to be written over at a later point. Don't consider this"]
#[doc = " a security method or anything. :)"]
#[doc = ""]
#[doc = " \\param filename Filename to delete."]
#[doc = " \\return nonzero on success, zero on error. Use PHYSFS_getLastErrorCode()"]
#[doc = " to obtain the specific error."]
pub fn PHYSFS_delete(filename: *const ::std::os::raw::c_char) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn const char *PHYSFS_getRealDir(const char *filename)"]
#[doc = " \\brief Figure out where in the search path a file resides."]
#[doc = ""]
#[doc = " The file is specified in platform-independent notation. The returned"]
#[doc = " filename will be the element of the search path where the file was found,"]
#[doc = " which may be a directory, or an archive. Even if there are multiple"]
#[doc = " matches in different parts of the search path, only the first one found"]
#[doc = " is used, just like when opening a file."]
#[doc = ""]
#[doc = " So, if you look for \"maps/level1.map\", and C:\\\\mygame is in your search"]
#[doc = " path and C:\\\\mygame\\\\maps\\\\level1.map exists, then \"C:\\mygame\" is returned."]
#[doc = ""]
#[doc = " If a any part of a match is a symbolic link, and you've not explicitly"]
#[doc = " permitted symlinks, then it will be ignored, and the search for a match"]
#[doc = " will continue."]
#[doc = ""]
#[doc = " If you specify a fake directory that only exists as a mount point, it'll"]
#[doc = " be associated with the first archive mounted there, even though that"]
#[doc = " directory isn't necessarily contained in a real archive."]
#[doc = ""]
#[doc = " \\warning This will return NULL if there is no real directory associated"]
#[doc = " with (filename). Specifically, PHYSFS_mountIo(),"]
#[doc = " PHYSFS_mountMemory(), and PHYSFS_mountHandle() will return NULL"]
#[doc = " even if the filename is found in the search path. Plan accordingly."]
#[doc = ""]
#[doc = " \\param filename file to look for."]
#[doc = " \\return READ ONLY string of element of search path containing the"]
#[doc = " the file in question. NULL if not found."]
pub fn PHYSFS_getRealDir(
filename: *const ::std::os::raw::c_char,
) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " \\fn char **PHYSFS_enumerateFiles(const char *dir)"]
#[doc = " \\brief Get a file listing of a search path's directory."]
#[doc = ""]
#[doc = " \\warning In PhysicsFS versions prior to 2.1, this function would return"]
#[doc = " as many items as it could in the face of a failure condition"]
#[doc = " (out of memory, disk i/o error, etc). Since this meant apps"]
#[doc = " couldn't distinguish between complete success and partial failure,"]
#[doc = " and since the function could always return NULL to report"]
#[doc = " catastrophic failures anyway, in PhysicsFS 2.1 this function's"]
#[doc = " policy changed: it will either return a list of complete results"]
#[doc = " or it will return NULL for any failure of any kind, so we can"]
#[doc = " guarantee that the enumeration ran to completion and has no gaps"]
#[doc = " in its results."]
#[doc = ""]
#[doc = " Matching directories are interpolated. That is, if \"C:\\mydir\" is in the"]
#[doc = " search path and contains a directory \"savegames\" that contains \"x.sav\","]
#[doc = " \"y.sav\", and \"z.sav\", and there is also a \"C:\\userdir\" in the search path"]
#[doc = " that has a \"savegames\" subdirectory with \"w.sav\", then the following code:"]
#[doc = ""]
#[doc = " \\code"]
#[doc = " char **rc = PHYSFS_enumerateFiles(\"savegames\");"]
#[doc = " char **i;"]
#[doc = ""]
#[doc = " for (i = rc; *i != NULL; i++)"]
#[doc = " printf(\" * We've got [%s].\\n\", *i);"]
#[doc = ""]
#[doc = " PHYSFS_freeList(rc);"]
#[doc = " \\endcode"]
#[doc = ""]
#[doc = " \\...will print:"]
#[doc = ""]
#[doc = " \\verbatim"]
#[doc = " We've got [x.sav]."]
#[doc = " We've got [y.sav]."]
#[doc = " We've got [z.sav]."]
#[doc = " We've got [w.sav].\\endverbatim"]
#[doc = ""]
#[doc = " Feel free to sort the list however you like. However, the returned data"]
#[doc = " will always contain no duplicates, and will be always sorted in alphabetic"]
#[doc = " (rather: case-sensitive Unicode) order for you."]
#[doc = ""]
#[doc = " Don't forget to call PHYSFS_freeList() with the return value from this"]
#[doc = " function when you are done with it."]
#[doc = ""]
#[doc = " \\param dir directory in platform-independent notation to enumerate."]
#[doc = " \\return Null-terminated array of null-terminated strings, or NULL for"]
#[doc = " failure cases."]
#[doc = ""]
#[doc = " \\sa PHYSFS_enumerate"]
pub fn PHYSFS_enumerateFiles(
dir: *const ::std::os::raw::c_char,
) -> *mut *mut ::std::os::raw::c_char;
}
extern "C" {
#[doc = " \\fn int PHYSFS_exists(const char *fname)"]
#[doc = " \\brief Determine if a file exists in the search path."]
#[doc = ""]
#[doc = " Reports true if there is an entry anywhere in the search path by the"]
#[doc = " name of (fname)."]
#[doc = ""]
#[doc = " Note that entries that are symlinks are ignored if"]
#[doc = " PHYSFS_permitSymbolicLinks(1) hasn't been called, so you"]
#[doc = " might end up further down in the search path than expected."]
#[doc = ""]
#[doc = " \\param fname filename in platform-independent notation."]
#[doc = " \\return non-zero if filename exists. zero otherwise."]
pub fn PHYSFS_exists(fname: *const ::std::os::raw::c_char) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_isDirectory(const char *fname)"]
#[doc = " \\brief Determine if a file in the search path is really a directory."]
#[doc = ""]
#[doc = " \\deprecated As of PhysicsFS 2.1, use PHYSFS_stat() instead. This"]
#[doc = " function just wraps it anyhow."]
#[doc = ""]
#[doc = " Determine if the first occurence of (fname) in the search path is"]
#[doc = " really a directory entry."]
#[doc = ""]
#[doc = " Note that entries that are symlinks are ignored if"]
#[doc = " PHYSFS_permitSymbolicLinks(1) hasn't been called, so you"]
#[doc = " might end up further down in the search path than expected."]
#[doc = ""]
#[doc = " \\param fname filename in platform-independent notation."]
#[doc = " \\return non-zero if filename exists and is a directory. zero otherwise."]
#[doc = ""]
#[doc = " \\sa PHYSFS_stat"]
#[doc = " \\sa PHYSFS_exists"]
pub fn PHYSFS_isDirectory(fname: *const ::std::os::raw::c_char) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_isSymbolicLink(const char *fname)"]
#[doc = " \\brief Determine if a file in the search path is really a symbolic link."]
#[doc = ""]
#[doc = " \\deprecated As of PhysicsFS 2.1, use PHYSFS_stat() instead. This"]
#[doc = " function just wraps it anyhow."]
#[doc = ""]
#[doc = " Determine if the first occurence of (fname) in the search path is"]
#[doc = " really a symbolic link."]
#[doc = ""]
#[doc = " Note that entries that are symlinks are ignored if"]
#[doc = " PHYSFS_permitSymbolicLinks(1) hasn't been called, and as such,"]
#[doc = " this function will always return 0 in that case."]
#[doc = ""]
#[doc = " \\param fname filename in platform-independent notation."]
#[doc = " \\return non-zero if filename exists and is a symlink. zero otherwise."]
#[doc = ""]
#[doc = " \\sa PHYSFS_stat"]
#[doc = " \\sa PHYSFS_exists"]
pub fn PHYSFS_isSymbolicLink(fname: *const ::std::os::raw::c_char) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint64 PHYSFS_getLastModTime(const char *filename)"]
#[doc = " \\brief Get the last modification time of a file."]
#[doc = ""]
#[doc = " \\deprecated As of PhysicsFS 2.1, use PHYSFS_stat() instead. This"]
#[doc = " function just wraps it anyhow."]
#[doc = ""]
#[doc = " The modtime is returned as a number of seconds since the Unix epoch"]
#[doc = " (midnight, Jan 1, 1970). The exact derivation and accuracy of this time"]
#[doc = " depends on the particular archiver. If there is no reasonable way to"]
#[doc = " obtain this information for a particular archiver, or there was some sort"]
#[doc = " of error, this function returns (-1)."]
#[doc = ""]
#[doc = " You must use this and not PHYSFS_stat() if binary compatibility with"]
#[doc = " PhysicsFS 2.0 is important (which it may not be for many people)."]
#[doc = ""]
#[doc = " \\param filename filename to check, in platform-independent notation."]
#[doc = " \\return last modified time of the file. -1 if it can't be determined."]
#[doc = ""]
#[doc = " \\sa PHYSFS_stat"]
pub fn PHYSFS_getLastModTime(filename: *const ::std::os::raw::c_char) -> PHYSFS_sint64;
}
extern "C" {
#[doc = " \\fn PHYSFS_File *PHYSFS_openWrite(const char *filename)"]
#[doc = " \\brief Open a file for writing."]
#[doc = ""]
#[doc = " Open a file for writing, in platform-independent notation and in relation"]
#[doc = " to the write dir as the root of the writable filesystem. The specified"]
#[doc = " file is created if it doesn't exist. If it does exist, it is truncated to"]
#[doc = " zero bytes, and the writing offset is set to the start."]
#[doc = ""]
#[doc = " Note that entries that are symlinks are ignored if"]
#[doc = " PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a"]
#[doc = " symlink with this function will fail in such a case."]
#[doc = ""]
#[doc = " \\param filename File to open."]
#[doc = " \\return A valid PhysicsFS filehandle on success, NULL on error. Use"]
#[doc = " PHYSFS_getLastErrorCode() to obtain the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_openRead"]
#[doc = " \\sa PHYSFS_openAppend"]
#[doc = " \\sa PHYSFS_write"]
#[doc = " \\sa PHYSFS_close"]
pub fn PHYSFS_openWrite(filename: *const ::std::os::raw::c_char) -> *mut PHYSFS_File;
}
extern "C" {
#[doc = " \\fn PHYSFS_File *PHYSFS_openAppend(const char *filename)"]
#[doc = " \\brief Open a file for appending."]
#[doc = ""]
#[doc = " Open a file for writing, in platform-independent notation and in relation"]
#[doc = " to the write dir as the root of the writable filesystem. The specified"]
#[doc = " file is created if it doesn't exist. If it does exist, the writing offset"]
#[doc = " is set to the end of the file, so the first write will be the byte after"]
#[doc = " the end."]
#[doc = ""]
#[doc = " Note that entries that are symlinks are ignored if"]
#[doc = " PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a"]
#[doc = " symlink with this function will fail in such a case."]
#[doc = ""]
#[doc = " \\param filename File to open."]
#[doc = " \\return A valid PhysicsFS filehandle on success, NULL on error. Use"]
#[doc = " PHYSFS_getLastErrorCode() to obtain the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_openRead"]
#[doc = " \\sa PHYSFS_openWrite"]
#[doc = " \\sa PHYSFS_write"]
#[doc = " \\sa PHYSFS_close"]
pub fn PHYSFS_openAppend(filename: *const ::std::os::raw::c_char) -> *mut PHYSFS_File;
}
extern "C" {
#[doc = " \\fn PHYSFS_File *PHYSFS_openRead(const char *filename)"]
#[doc = " \\brief Open a file for reading."]
#[doc = ""]
#[doc = " Open a file for reading, in platform-independent notation. The search path"]
#[doc = " is checked one at a time until a matching file is found, in which case an"]
#[doc = " abstract filehandle is associated with it, and reading may be done."]
#[doc = " The reading offset is set to the first byte of the file."]
#[doc = ""]
#[doc = " Note that entries that are symlinks are ignored if"]
#[doc = " PHYSFS_permitSymbolicLinks(1) hasn't been called, and opening a"]
#[doc = " symlink with this function will fail in such a case."]
#[doc = ""]
#[doc = " \\param filename File to open."]
#[doc = " \\return A valid PhysicsFS filehandle on success, NULL on error."]
#[doc = " Use PHYSFS_getLastErrorCode() to obtain the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_openWrite"]
#[doc = " \\sa PHYSFS_openAppend"]
#[doc = " \\sa PHYSFS_read"]
#[doc = " \\sa PHYSFS_close"]
pub fn PHYSFS_openRead(filename: *const ::std::os::raw::c_char) -> *mut PHYSFS_File;
}
extern "C" {
#[doc = " \\fn int PHYSFS_close(PHYSFS_File *handle)"]
#[doc = " \\brief Close a PhysicsFS filehandle."]
#[doc = ""]
#[doc = " This call is capable of failing if the operating system was buffering"]
#[doc = " writes to the physical media, and, now forced to write those changes to"]
#[doc = " physical media, can not store the data for some reason. In such a case,"]
#[doc = " the filehandle stays open. A well-written program should ALWAYS check the"]
#[doc = " return value from the close call in addition to every writing call!"]
#[doc = ""]
#[doc = " \\param handle handle returned from PHYSFS_open*()."]
#[doc = " \\return nonzero on success, zero on error. Use PHYSFS_getLastErrorCode()"]
#[doc = " to obtain the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_openRead"]
#[doc = " \\sa PHYSFS_openWrite"]
#[doc = " \\sa PHYSFS_openAppend"]
pub fn PHYSFS_close(handle: *mut PHYSFS_File) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint64 PHYSFS_read(PHYSFS_File *handle, void *buffer, PHYSFS_uint32 objSize, PHYSFS_uint32 objCount)"]
#[doc = " \\brief Read data from a PhysicsFS filehandle"]
#[doc = ""]
#[doc = " The file must be opened for reading."]
#[doc = ""]
#[doc = " \\deprecated As of PhysicsFS 2.1, use PHYSFS_readBytes() instead. This"]
#[doc = " function just wraps it anyhow. This function never clarified"]
#[doc = " what would happen if you managed to read a partial object, so"]
#[doc = " working at the byte level makes this cleaner for everyone,"]
#[doc = " especially now that PHYSFS_Io interfaces can be supplied by the"]
#[doc = " application."]
#[doc = ""]
#[doc = " \\param handle handle returned from PHYSFS_openRead()."]
#[doc = " \\param buffer buffer to store read data into."]
#[doc = " \\param objSize size in bytes of objects being read from (handle)."]
#[doc = " \\param objCount number of (objSize) objects to read from (handle)."]
#[doc = " \\return number of objects read. PHYSFS_getLastErrorCode() can shed light"]
#[doc = " on the reason this might be < (objCount), as can PHYSFS_eof()."]
#[doc = " -1 if complete failure."]
#[doc = ""]
#[doc = " \\sa PHYSFS_readBytes"]
#[doc = " \\sa PHYSFS_eof"]
pub fn PHYSFS_read(
handle: *mut PHYSFS_File,
buffer: *mut ::std::os::raw::c_void,
objSize: PHYSFS_uint32,
objCount: PHYSFS_uint32,
) -> PHYSFS_sint64;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint64 PHYSFS_write(PHYSFS_File *handle, const void *buffer, PHYSFS_uint32 objSize, PHYSFS_uint32 objCount)"]
#[doc = " \\brief Write data to a PhysicsFS filehandle"]
#[doc = ""]
#[doc = " The file must be opened for writing."]
#[doc = ""]
#[doc = " \\deprecated As of PhysicsFS 2.1, use PHYSFS_writeBytes() instead. This"]
#[doc = " function just wraps it anyhow. This function never clarified"]
#[doc = " what would happen if you managed to write a partial object, so"]
#[doc = " working at the byte level makes this cleaner for everyone,"]
#[doc = " especially now that PHYSFS_Io interfaces can be supplied by the"]
#[doc = " application."]
#[doc = ""]
#[doc = " \\param handle retval from PHYSFS_openWrite() or PHYSFS_openAppend()."]
#[doc = " \\param buffer buffer of bytes to write to (handle)."]
#[doc = " \\param objSize size in bytes of objects being written to (handle)."]
#[doc = " \\param objCount number of (objSize) objects to write to (handle)."]
#[doc = " \\return number of objects written. PHYSFS_getLastErrorCode() can shed"]
#[doc = " light on the reason this might be < (objCount). -1 if complete"]
#[doc = " failure."]
#[doc = ""]
#[doc = " \\sa PHYSFS_writeBytes"]
pub fn PHYSFS_write(
handle: *mut PHYSFS_File,
buffer: *const ::std::os::raw::c_void,
objSize: PHYSFS_uint32,
objCount: PHYSFS_uint32,
) -> PHYSFS_sint64;
}
extern "C" {
#[doc = " \\fn int PHYSFS_eof(PHYSFS_File *handle)"]
#[doc = " \\brief Check for end-of-file state on a PhysicsFS filehandle."]
#[doc = ""]
#[doc = " Determine if the end of file has been reached in a PhysicsFS filehandle."]
#[doc = ""]
#[doc = " \\param handle handle returned from PHYSFS_openRead()."]
#[doc = " \\return nonzero if EOF, zero if not."]
#[doc = ""]
#[doc = " \\sa PHYSFS_read"]
#[doc = " \\sa PHYSFS_tell"]
pub fn PHYSFS_eof(handle: *mut PHYSFS_File) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint64 PHYSFS_tell(PHYSFS_File *handle)"]
#[doc = " \\brief Determine current position within a PhysicsFS filehandle."]
#[doc = ""]
#[doc = " \\param handle handle returned from PHYSFS_open*()."]
#[doc = " \\return offset in bytes from start of file. -1 if error occurred."]
#[doc = " Use PHYSFS_getLastErrorCode() to obtain the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_seek"]
pub fn PHYSFS_tell(handle: *mut PHYSFS_File) -> PHYSFS_sint64;
}
extern "C" {
#[doc = " \\fn int PHYSFS_seek(PHYSFS_File *handle, PHYSFS_uint64 pos)"]
#[doc = " \\brief Seek to a new position within a PhysicsFS filehandle."]
#[doc = ""]
#[doc = " The next read or write will occur at that place. Seeking past the"]
#[doc = " beginning or end of the file is not allowed, and causes an error."]
#[doc = ""]
#[doc = " \\param handle handle returned from PHYSFS_open*()."]
#[doc = " \\param pos number of bytes from start of file to seek to."]
#[doc = " \\return nonzero on success, zero on error. Use PHYSFS_getLastErrorCode()"]
#[doc = " to obtain the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_tell"]
pub fn PHYSFS_seek(handle: *mut PHYSFS_File, pos: PHYSFS_uint64) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint64 PHYSFS_fileLength(PHYSFS_File *handle)"]
#[doc = " \\brief Get total length of a file in bytes."]
#[doc = ""]
#[doc = " Note that if another process/thread is writing to this file at the same"]
#[doc = " time, then the information this function supplies could be incorrect"]
#[doc = " before you get it. Use with caution, or better yet, don't use at all."]
#[doc = ""]
#[doc = " \\param handle handle returned from PHYSFS_open*()."]
#[doc = " \\return size in bytes of the file. -1 if can't be determined."]
#[doc = ""]
#[doc = " \\sa PHYSFS_tell"]
#[doc = " \\sa PHYSFS_seek"]
pub fn PHYSFS_fileLength(handle: *mut PHYSFS_File) -> PHYSFS_sint64;
}
extern "C" {
#[doc = " \\fn int PHYSFS_setBuffer(PHYSFS_File *handle, PHYSFS_uint64 bufsize)"]
#[doc = " \\brief Set up buffering for a PhysicsFS file handle."]
#[doc = ""]
#[doc = " Define an i/o buffer for a file handle. A memory block of (bufsize) bytes"]
#[doc = " will be allocated and associated with (handle)."]
#[doc = ""]
#[doc = " For files opened for reading, up to (bufsize) bytes are read from (handle)"]
#[doc = " and stored in the internal buffer. Calls to PHYSFS_read() will pull"]
#[doc = " from this buffer until it is empty, and then refill it for more reading."]
#[doc = " Note that compressed files, like ZIP archives, will decompress while"]
#[doc = " buffering, so this can be handy for offsetting CPU-intensive operations."]
#[doc = " The buffer isn't filled until you do your next read."]
#[doc = ""]
#[doc = " For files opened for writing, data will be buffered to memory until the"]
#[doc = " buffer is full or the buffer is flushed. Closing a handle implicitly"]
#[doc = " causes a flush...check your return values!"]
#[doc = ""]
#[doc = " Seeking, etc transparently accounts for buffering."]
#[doc = ""]
#[doc = " You can resize an existing buffer by calling this function more than once"]
#[doc = " on the same file. Setting the buffer size to zero will free an existing"]
#[doc = " buffer."]
#[doc = ""]
#[doc = " PhysicsFS file handles are unbuffered by default."]
#[doc = ""]
#[doc = " Please check the return value of this function! Failures can include"]
#[doc = " not being able to seek backwards in a read-only file when removing the"]
#[doc = " buffer, not being able to allocate the buffer, and not being able to"]
#[doc = " flush the buffer to disk, among other unexpected problems."]
#[doc = ""]
#[doc = " \\param handle handle returned from PHYSFS_open*()."]
#[doc = " \\param bufsize size, in bytes, of buffer to allocate."]
#[doc = " \\return nonzero if successful, zero on error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_flush"]
#[doc = " \\sa PHYSFS_read"]
#[doc = " \\sa PHYSFS_write"]
#[doc = " \\sa PHYSFS_close"]
pub fn PHYSFS_setBuffer(
handle: *mut PHYSFS_File,
bufsize: PHYSFS_uint64,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_flush(PHYSFS_File *handle)"]
#[doc = " \\brief Flush a buffered PhysicsFS file handle."]
#[doc = ""]
#[doc = " For buffered files opened for writing, this will put the current contents"]
#[doc = " of the buffer to disk and flag the buffer as empty if possible."]
#[doc = ""]
#[doc = " For buffered files opened for reading or unbuffered files, this is a safe"]
#[doc = " no-op, and will report success."]
#[doc = ""]
#[doc = " \\param handle handle returned from PHYSFS_open*()."]
#[doc = " \\return nonzero if successful, zero on error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_setBuffer"]
#[doc = " \\sa PHYSFS_close"]
pub fn PHYSFS_flush(handle: *mut PHYSFS_File) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint16 PHYSFS_swapSLE16(PHYSFS_sint16 val)"]
#[doc = " \\brief Swap littleendian signed 16 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 16-bit signed value in littleendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
pub fn PHYSFS_swapSLE16(val: PHYSFS_sint16) -> PHYSFS_sint16;
}
extern "C" {
#[doc = " \\fn PHYSFS_uint16 PHYSFS_swapULE16(PHYSFS_uint16 val)"]
#[doc = " \\brief Swap littleendian unsigned 16 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 16-bit unsigned value in littleendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
pub fn PHYSFS_swapULE16(val: PHYSFS_uint16) -> PHYSFS_uint16;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint32 PHYSFS_swapSLE32(PHYSFS_sint32 val)"]
#[doc = " \\brief Swap littleendian signed 32 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 32-bit signed value in littleendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
pub fn PHYSFS_swapSLE32(val: PHYSFS_sint32) -> PHYSFS_sint32;
}
extern "C" {
#[doc = " \\fn PHYSFS_uint32 PHYSFS_swapULE32(PHYSFS_uint32 val)"]
#[doc = " \\brief Swap littleendian unsigned 32 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 32-bit unsigned value in littleendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
pub fn PHYSFS_swapULE32(val: PHYSFS_uint32) -> PHYSFS_uint32;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint64 PHYSFS_swapSLE64(PHYSFS_sint64 val)"]
#[doc = " \\brief Swap littleendian signed 64 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 64-bit signed value in littleendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_sint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_swapSLE64(val: PHYSFS_sint64) -> PHYSFS_sint64;
}
extern "C" {
#[doc = " \\fn PHYSFS_uint64 PHYSFS_swapULE64(PHYSFS_uint64 val)"]
#[doc = " \\brief Swap littleendian unsigned 64 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 64-bit unsigned value in littleendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_uint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_swapULE64(val: PHYSFS_uint64) -> PHYSFS_uint64;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint16 PHYSFS_swapSBE16(PHYSFS_sint16 val)"]
#[doc = " \\brief Swap bigendian signed 16 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 16-bit signed value in bigendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
pub fn PHYSFS_swapSBE16(val: PHYSFS_sint16) -> PHYSFS_sint16;
}
extern "C" {
#[doc = " \\fn PHYSFS_uint16 PHYSFS_swapUBE16(PHYSFS_uint16 val)"]
#[doc = " \\brief Swap bigendian unsigned 16 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 16-bit unsigned value in bigendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
pub fn PHYSFS_swapUBE16(val: PHYSFS_uint16) -> PHYSFS_uint16;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint32 PHYSFS_swapSBE32(PHYSFS_sint32 val)"]
#[doc = " \\brief Swap bigendian signed 32 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 32-bit signed value in bigendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
pub fn PHYSFS_swapSBE32(val: PHYSFS_sint32) -> PHYSFS_sint32;
}
extern "C" {
#[doc = " \\fn PHYSFS_uint32 PHYSFS_swapUBE32(PHYSFS_uint32 val)"]
#[doc = " \\brief Swap bigendian unsigned 32 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 32-bit unsigned value in bigendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
pub fn PHYSFS_swapUBE32(val: PHYSFS_uint32) -> PHYSFS_uint32;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint64 PHYSFS_swapSBE64(PHYSFS_sint64 val)"]
#[doc = " \\brief Swap bigendian signed 64 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 64-bit signed value in bigendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_sint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_swapSBE64(val: PHYSFS_sint64) -> PHYSFS_sint64;
}
extern "C" {
#[doc = " \\fn PHYSFS_uint64 PHYSFS_swapUBE64(PHYSFS_uint64 val)"]
#[doc = " \\brief Swap bigendian unsigned 64 to platform's native byte order."]
#[doc = ""]
#[doc = " Take a 64-bit unsigned value in bigendian format and convert it to"]
#[doc = " the platform's native byte order."]
#[doc = ""]
#[doc = " \\param val value to convert"]
#[doc = " \\return converted value."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_uint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_swapUBE64(val: PHYSFS_uint64) -> PHYSFS_uint64;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readSLE16(PHYSFS_File *file, PHYSFS_sint16 *val)"]
#[doc = " \\brief Read and convert a signed 16-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Read a signed 16-bit littleendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_readSLE16(
file: *mut PHYSFS_File,
val: *mut PHYSFS_sint16,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readULE16(PHYSFS_File *file, PHYSFS_uint16 *val)"]
#[doc = " \\brief Read and convert an unsigned 16-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Read an unsigned 16-bit littleendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
#[doc = ""]
pub fn PHYSFS_readULE16(
file: *mut PHYSFS_File,
val: *mut PHYSFS_uint16,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readSBE16(PHYSFS_File *file, PHYSFS_sint16 *val)"]
#[doc = " \\brief Read and convert a signed 16-bit bigendian value."]
#[doc = ""]
#[doc = " Convenience function. Read a signed 16-bit bigendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_readSBE16(
file: *mut PHYSFS_File,
val: *mut PHYSFS_sint16,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readUBE16(PHYSFS_File *file, PHYSFS_uint16 *val)"]
#[doc = " \\brief Read and convert an unsigned 16-bit bigendian value."]
#[doc = ""]
#[doc = " Convenience function. Read an unsigned 16-bit bigendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
#[doc = ""]
pub fn PHYSFS_readUBE16(
file: *mut PHYSFS_File,
val: *mut PHYSFS_uint16,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readSLE32(PHYSFS_File *file, PHYSFS_sint32 *val)"]
#[doc = " \\brief Read and convert a signed 32-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Read a signed 32-bit littleendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_readSLE32(
file: *mut PHYSFS_File,
val: *mut PHYSFS_sint32,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readULE32(PHYSFS_File *file, PHYSFS_uint32 *val)"]
#[doc = " \\brief Read and convert an unsigned 32-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Read an unsigned 32-bit littleendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
#[doc = ""]
pub fn PHYSFS_readULE32(
file: *mut PHYSFS_File,
val: *mut PHYSFS_uint32,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readSBE32(PHYSFS_File *file, PHYSFS_sint32 *val)"]
#[doc = " \\brief Read and convert a signed 32-bit bigendian value."]
#[doc = ""]
#[doc = " Convenience function. Read a signed 32-bit bigendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_readSBE32(
file: *mut PHYSFS_File,
val: *mut PHYSFS_sint32,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readUBE32(PHYSFS_File *file, PHYSFS_uint32 *val)"]
#[doc = " \\brief Read and convert an unsigned 32-bit bigendian value."]
#[doc = ""]
#[doc = " Convenience function. Read an unsigned 32-bit bigendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
#[doc = ""]
pub fn PHYSFS_readUBE32(
file: *mut PHYSFS_File,
val: *mut PHYSFS_uint32,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readSLE64(PHYSFS_File *file, PHYSFS_sint64 *val)"]
#[doc = " \\brief Read and convert a signed 64-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Read a signed 64-bit littleendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_sint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_readSLE64(
file: *mut PHYSFS_File,
val: *mut PHYSFS_sint64,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readULE64(PHYSFS_File *file, PHYSFS_uint64 *val)"]
#[doc = " \\brief Read and convert an unsigned 64-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Read an unsigned 64-bit littleendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_uint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_readULE64(
file: *mut PHYSFS_File,
val: *mut PHYSFS_uint64,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readSBE64(PHYSFS_File *file, PHYSFS_sint64 *val)"]
#[doc = " \\brief Read and convert a signed 64-bit bigendian value."]
#[doc = ""]
#[doc = " Convenience function. Read a signed 64-bit bigendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_sint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_readSBE64(
file: *mut PHYSFS_File,
val: *mut PHYSFS_sint64,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_readUBE64(PHYSFS_File *file, PHYSFS_uint64 *val)"]
#[doc = " \\brief Read and convert an unsigned 64-bit bigendian value."]
#[doc = ""]
#[doc = " Convenience function. Read an unsigned 64-bit bigendian value from a"]
#[doc = " file and convert it to the platform's native byte order."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle from which to read."]
#[doc = " \\param val pointer to where value should be stored."]
#[doc = " \\return zero on failure, non-zero on success. If successful, (*val) will"]
#[doc = " store the result. On failure, you can find out what went wrong"]
#[doc = " from PHYSFS_getLastErrorCode()."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_uint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_readUBE64(
file: *mut PHYSFS_File,
val: *mut PHYSFS_uint64,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeSLE16(PHYSFS_File *file, PHYSFS_sint16 val)"]
#[doc = " \\brief Convert and write a signed 16-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Convert a signed 16-bit value from the platform's"]
#[doc = " native byte order to littleendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_writeSLE16(file: *mut PHYSFS_File, val: PHYSFS_sint16) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeULE16(PHYSFS_File *file, PHYSFS_uint16 val)"]
#[doc = " \\brief Convert and write an unsigned 16-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Convert an unsigned 16-bit value from the platform's"]
#[doc = " native byte order to littleendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_writeULE16(file: *mut PHYSFS_File, val: PHYSFS_uint16) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeSBE16(PHYSFS_File *file, PHYSFS_sint16 val)"]
#[doc = " \\brief Convert and write a signed 16-bit bigendian value."]
#[doc = ""]
#[doc = " Convenience function. Convert a signed 16-bit value from the platform's"]
#[doc = " native byte order to bigendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_writeSBE16(file: *mut PHYSFS_File, val: PHYSFS_sint16) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeUBE16(PHYSFS_File *file, PHYSFS_uint16 val)"]
#[doc = " \\brief Convert and write an unsigned 16-bit bigendian value."]
#[doc = ""]
#[doc = " Convenience function. Convert an unsigned 16-bit value from the platform's"]
#[doc = " native byte order to bigendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_writeUBE16(file: *mut PHYSFS_File, val: PHYSFS_uint16) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeSLE32(PHYSFS_File *file, PHYSFS_sint32 val)"]
#[doc = " \\brief Convert and write a signed 32-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Convert a signed 32-bit value from the platform's"]
#[doc = " native byte order to littleendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_writeSLE32(file: *mut PHYSFS_File, val: PHYSFS_sint32) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeULE32(PHYSFS_File *file, PHYSFS_uint32 val)"]
#[doc = " \\brief Convert and write an unsigned 32-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Convert an unsigned 32-bit value from the platform's"]
#[doc = " native byte order to littleendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_writeULE32(file: *mut PHYSFS_File, val: PHYSFS_uint32) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeSBE32(PHYSFS_File *file, PHYSFS_sint32 val)"]
#[doc = " \\brief Convert and write a signed 32-bit bigendian value."]
#[doc = ""]
#[doc = " Convenience function. Convert a signed 32-bit value from the platform's"]
#[doc = " native byte order to bigendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_writeSBE32(file: *mut PHYSFS_File, val: PHYSFS_sint32) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeUBE32(PHYSFS_File *file, PHYSFS_uint32 val)"]
#[doc = " \\brief Convert and write an unsigned 32-bit bigendian value."]
#[doc = ""]
#[doc = " Convenience function. Convert an unsigned 32-bit value from the platform's"]
#[doc = " native byte order to bigendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
pub fn PHYSFS_writeUBE32(file: *mut PHYSFS_File, val: PHYSFS_uint32) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeSLE64(PHYSFS_File *file, PHYSFS_sint64 val)"]
#[doc = " \\brief Convert and write a signed 64-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Convert a signed 64-bit value from the platform's"]
#[doc = " native byte order to littleendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_sint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_writeSLE64(file: *mut PHYSFS_File, val: PHYSFS_sint64) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeULE64(PHYSFS_File *file, PHYSFS_uint64 val)"]
#[doc = " \\brief Convert and write an unsigned 64-bit littleendian value."]
#[doc = ""]
#[doc = " Convenience function. Convert an unsigned 64-bit value from the platform's"]
#[doc = " native byte order to littleendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_uint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_writeULE64(file: *mut PHYSFS_File, val: PHYSFS_uint64) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeSBE64(PHYSFS_File *file, PHYSFS_sint64 val)"]
#[doc = " \\brief Convert and write a signed 64-bit bigending value."]
#[doc = ""]
#[doc = " Convenience function. Convert a signed 64-bit value from the platform's"]
#[doc = " native byte order to bigendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_sint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_writeSBE64(file: *mut PHYSFS_File, val: PHYSFS_sint64) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_writeUBE64(PHYSFS_File *file, PHYSFS_uint64 val)"]
#[doc = " \\brief Convert and write an unsigned 64-bit bigendian value."]
#[doc = ""]
#[doc = " Convenience function. Convert an unsigned 64-bit value from the platform's"]
#[doc = " native byte order to bigendian and write it to a file."]
#[doc = ""]
#[doc = " \\param file PhysicsFS file handle to which to write."]
#[doc = " \\param val Value to convert and write."]
#[doc = " \\return zero on failure, non-zero on success. On failure, you can"]
#[doc = " find out what went wrong from PHYSFS_getLastErrorCode()."]
#[doc = ""]
#[doc = " \\warning Remember, PHYSFS_uint64 is only 32 bits on platforms without"]
#[doc = " any sort of 64-bit support."]
pub fn PHYSFS_writeUBE64(file: *mut PHYSFS_File, val: PHYSFS_uint64) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_isInit(void)"]
#[doc = " \\brief Determine if the PhysicsFS library is initialized."]
#[doc = ""]
#[doc = " Once PHYSFS_init() returns successfully, this will return non-zero."]
#[doc = " Before a successful PHYSFS_init() and after PHYSFS_deinit() returns"]
#[doc = " successfully, this will return zero. This function is safe to call at"]
#[doc = " any time."]
#[doc = ""]
#[doc = " \\return non-zero if library is initialized, zero if library is not."]
#[doc = ""]
#[doc = " \\sa PHYSFS_init"]
#[doc = " \\sa PHYSFS_deinit"]
pub fn PHYSFS_isInit() -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_symbolicLinksPermitted(void)"]
#[doc = " \\brief Determine if the symbolic links are permitted."]
#[doc = ""]
#[doc = " This reports the setting from the last call to PHYSFS_permitSymbolicLinks()."]
#[doc = " If PHYSFS_permitSymbolicLinks() hasn't been called since the library was"]
#[doc = " last initialized, symbolic links are implicitly disabled."]
#[doc = ""]
#[doc = " \\return non-zero if symlinks are permitted, zero if not."]
#[doc = ""]
#[doc = " \\sa PHYSFS_permitSymbolicLinks"]
pub fn PHYSFS_symbolicLinksPermitted() -> ::std::os::raw::c_int;
}
#[doc = " \\struct PHYSFS_Allocator"]
#[doc = " \\brief PhysicsFS allocation function pointers."]
#[doc = ""]
#[doc = " (This is for limited, hardcore use. If you don't immediately see a need"]
#[doc = " for it, you can probably ignore this forever.)"]
#[doc = ""]
#[doc = " You create one of these structures for use with PHYSFS_setAllocator."]
#[doc = " Allocators are assumed to be reentrant by the caller; please mutex"]
#[doc = " accordingly."]
#[doc = ""]
#[doc = " Allocations are always discussed in 64-bits, for future expansion...we're"]
#[doc = " on the cusp of a 64-bit transition, and we'll probably be allocating 6"]
#[doc = " gigabytes like it's nothing sooner or later, and I don't want to change"]
#[doc = " this again at that point. If you're on a 32-bit platform and have to"]
#[doc = " downcast, it's okay to return NULL if the allocation is greater than"]
#[doc = " 4 gigabytes, since you'd have to do so anyhow."]
#[doc = ""]
#[doc = " \\sa PHYSFS_setAllocator"]
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct PHYSFS_Allocator {
#[doc = "< Initialize. Can be NULL. Zero on failure."]
pub Init: ::std::option::Option<unsafe extern "C" fn() -> ::std::os::raw::c_int>,
#[doc = "< Deinitialize your allocator. Can be NULL."]
pub Deinit: ::std::option::Option<unsafe extern "C" fn()>,
#[doc = "< Allocate like malloc()."]
pub Malloc: ::std::option::Option<
unsafe extern "C" fn(arg1: PHYSFS_uint64) -> *mut ::std::os::raw::c_void,
>,
#[doc = "< Reallocate like realloc()."]
pub Realloc: ::std::option::Option<
unsafe extern "C" fn(
arg1: *mut ::std::os::raw::c_void,
arg2: PHYSFS_uint64,
) -> *mut ::std::os::raw::c_void,
>,
#[doc = "< Free memory from Malloc or Realloc."]
pub Free: ::std::option::Option<unsafe extern "C" fn(arg1: *mut ::std::os::raw::c_void)>,
}
#[test]
fn bindgen_test_layout_PHYSFS_Allocator() {
assert_eq!(
::std::mem::size_of::<PHYSFS_Allocator>(),
40usize,
concat!("Size of: ", stringify!(PHYSFS_Allocator))
);
assert_eq!(
::std::mem::align_of::<PHYSFS_Allocator>(),
8usize,
concat!("Alignment of ", stringify!(PHYSFS_Allocator))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Allocator>())).Init as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Allocator),
"::",
stringify!(Init)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Allocator>())).Deinit as *const _ as usize },
8usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Allocator),
"::",
stringify!(Deinit)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Allocator>())).Malloc as *const _ as usize },
16usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Allocator),
"::",
stringify!(Malloc)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Allocator>())).Realloc as *const _ as usize },
24usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Allocator),
"::",
stringify!(Realloc)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Allocator>())).Free as *const _ as usize },
32usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Allocator),
"::",
stringify!(Free)
)
);
}
extern "C" {
#[doc = " \\fn int PHYSFS_setAllocator(const PHYSFS_Allocator *allocator)"]
#[doc = " \\brief Hook your own allocation routines into PhysicsFS."]
#[doc = ""]
#[doc = " (This is for limited, hardcore use. If you don't immediately see a need"]
#[doc = " for it, you can probably ignore this forever.)"]
#[doc = ""]
#[doc = " By default, PhysicsFS will use whatever is reasonable for a platform"]
#[doc = " to manage dynamic memory (usually ANSI C malloc/realloc/free, but"]
#[doc = " some platforms might use something else), but in some uncommon cases, the"]
#[doc = " app might want more control over the library's memory management. This"]
#[doc = " lets you redirect PhysicsFS to use your own allocation routines instead."]
#[doc = " You can only call this function before PHYSFS_init(); if the library is"]
#[doc = " initialized, it'll reject your efforts to change the allocator mid-stream."]
#[doc = " You may call this function after PHYSFS_deinit() if you are willing to"]
#[doc = " shut down the library and restart it with a new allocator; this is a safe"]
#[doc = " and supported operation. The allocator remains intact between deinit/init"]
#[doc = " calls. If you want to return to the platform's default allocator, pass a"]
#[doc = " NULL in here."]
#[doc = ""]
#[doc = " If you aren't immediately sure what to do with this function, you can"]
#[doc = " safely ignore it altogether."]
#[doc = ""]
#[doc = " \\param allocator Structure containing your allocator's entry points."]
#[doc = " \\return zero on failure, non-zero on success. This call only fails"]
#[doc = " when used between PHYSFS_init() and PHYSFS_deinit() calls."]
pub fn PHYSFS_setAllocator(allocator: *const PHYSFS_Allocator) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_mount(const char *newDir, const char *mountPoint, int appendToPath)"]
#[doc = " \\brief Add an archive or directory to the search path."]
#[doc = ""]
#[doc = " If this is a duplicate, the entry is not added again, even though the"]
#[doc = " function succeeds. You may not add the same archive to two different"]
#[doc = " mountpoints: duplicate checking is done against the archive and not the"]
#[doc = " mountpoint."]
#[doc = ""]
#[doc = " When you mount an archive, it is added to a virtual file system...all files"]
#[doc = " in all of the archives are interpolated into a single hierachical file"]
#[doc = " tree. Two archives mounted at the same place (or an archive with files"]
#[doc = " overlapping another mountpoint) may have overlapping files: in such a case,"]
#[doc = " the file earliest in the search path is selected, and the other files are"]
#[doc = " inaccessible to the application. This allows archives to be used to"]
#[doc = " override previous revisions; you can use the mounting mechanism to place"]
#[doc = " archives at a specific point in the file tree and prevent overlap; this"]
#[doc = " is useful for downloadable mods that might trample over application data"]
#[doc = " or each other, for example."]
#[doc = ""]
#[doc = " The mountpoint does not need to exist prior to mounting, which is different"]
#[doc = " than those familiar with the Unix concept of \"mounting\" may expect."]
#[doc = " As well, more than one archive can be mounted to the same mountpoint, or"]
#[doc = " mountpoints and archive contents can overlap...the interpolation mechanism"]
#[doc = " still functions as usual."]
#[doc = ""]
#[doc = " Specifying a symbolic link to an archive or directory is allowed here,"]
#[doc = " regardless of the state of PHYSFS_permitSymbolicLinks(). That function"]
#[doc = " only deals with symlinks inside the mounted directory or archive."]
#[doc = ""]
#[doc = " \\param newDir directory or archive to add to the path, in"]
#[doc = " platform-dependent notation."]
#[doc = " \\param mountPoint Location in the interpolated tree that this archive"]
#[doc = " will be \"mounted\", in platform-independent notation."]
#[doc = " NULL or \"\" is equivalent to \"/\"."]
#[doc = " \\param appendToPath nonzero to append to search path, zero to prepend."]
#[doc = " \\return nonzero if added to path, zero on failure (bogus archive, dir"]
#[doc = " missing, etc). Use PHYSFS_getLastErrorCode() to obtain"]
#[doc = " the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_removeFromSearchPath"]
#[doc = " \\sa PHYSFS_getSearchPath"]
#[doc = " \\sa PHYSFS_getMountPoint"]
#[doc = " \\sa PHYSFS_mountIo"]
pub fn PHYSFS_mount(
newDir: *const ::std::os::raw::c_char,
mountPoint: *const ::std::os::raw::c_char,
appendToPath: ::std::os::raw::c_int,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_getMountPoint(const char *dir)"]
#[doc = " \\brief Determine a mounted archive's mountpoint."]
#[doc = ""]
#[doc = " You give this function the name of an archive or dir you successfully"]
#[doc = " added to the search path, and it reports the location in the interpolated"]
#[doc = " tree where it is mounted. Files mounted with a NULL mountpoint or through"]
#[doc = " PHYSFS_addToSearchPath() will report \"/\". The return value is READ ONLY"]
#[doc = " and valid until the archive is removed from the search path."]
#[doc = ""]
#[doc = " \\param dir directory or archive previously added to the path, in"]
#[doc = " platform-dependent notation. This must match the string"]
#[doc = " used when adding, even if your string would also reference"]
#[doc = " the same file with a different string of characters."]
#[doc = " \\return READ-ONLY string of mount point if added to path, NULL on failure"]
#[doc = " (bogus archive, etc). Use PHYSFS_getLastErrorCode() to obtain the"]
#[doc = " specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_removeFromSearchPath"]
#[doc = " \\sa PHYSFS_getSearchPath"]
#[doc = " \\sa PHYSFS_getMountPoint"]
pub fn PHYSFS_getMountPoint(
dir: *const ::std::os::raw::c_char,
) -> *const ::std::os::raw::c_char;
}
#[doc = " \\typedef PHYSFS_StringCallback"]
#[doc = " \\brief Function signature for callbacks that report strings."]
#[doc = ""]
#[doc = " These are used to report a list of strings to an original caller, one"]
#[doc = " string per callback. All strings are UTF-8 encoded. Functions should not"]
#[doc = " try to modify or free the string's memory."]
#[doc = ""]
#[doc = " These callbacks are used, starting in PhysicsFS 1.1, as an alternative to"]
#[doc = " functions that would return lists that need to be cleaned up with"]
#[doc = " PHYSFS_freeList(). The callback means that the library doesn't need to"]
#[doc = " allocate an entire list and all the strings up front."]
#[doc = ""]
#[doc = " Be aware that promises data ordering in the list versions are not"]
#[doc = " necessarily so in the callback versions. Check the documentation on"]
#[doc = " specific APIs, but strings may not be sorted as you expect."]
#[doc = ""]
#[doc = " \\param data User-defined data pointer, passed through from the API"]
#[doc = " that eventually called the callback."]
#[doc = " \\param str The string data about which the callback is meant to inform."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getCdRomDirsCallback"]
#[doc = " \\sa PHYSFS_getSearchPathCallback"]
pub type PHYSFS_StringCallback = ::std::option::Option<
unsafe extern "C" fn(data: *mut ::std::os::raw::c_void, str: *const ::std::os::raw::c_char),
>;
#[doc = " \\typedef PHYSFS_EnumFilesCallback"]
#[doc = " \\brief Function signature for callbacks that enumerate files."]
#[doc = ""]
#[doc = " \\warning As of PhysicsFS 2.1, Use PHYSFS_EnumerateCallback with"]
#[doc = " PHYSFS_enumerate() instead; it gives you more control over the process."]
#[doc = ""]
#[doc = " These are used to report a list of directory entries to an original caller,"]
#[doc = " one file/dir/symlink per callback. All strings are UTF-8 encoded."]
#[doc = " Functions should not try to modify or free any string's memory."]
#[doc = ""]
#[doc = " These callbacks are used, starting in PhysicsFS 1.1, as an alternative to"]
#[doc = " functions that would return lists that need to be cleaned up with"]
#[doc = " PHYSFS_freeList(). The callback means that the library doesn't need to"]
#[doc = " allocate an entire list and all the strings up front."]
#[doc = ""]
#[doc = " Be aware that promised data ordering in the list versions are not"]
#[doc = " necessarily so in the callback versions. Check the documentation on"]
#[doc = " specific APIs, but strings may not be sorted as you expect and you might"]
#[doc = " get duplicate strings."]
#[doc = ""]
#[doc = " \\param data User-defined data pointer, passed through from the API"]
#[doc = " that eventually called the callback."]
#[doc = " \\param origdir A string containing the full path, in platform-independent"]
#[doc = " notation, of the directory containing this file. In most"]
#[doc = " cases, this is the directory on which you requested"]
#[doc = " enumeration, passed in the callback for your convenience."]
#[doc = " \\param fname The filename that is being enumerated. It may not be in"]
#[doc = " alphabetical order compared to other callbacks that have"]
#[doc = " fired, and it will not contain the full path. You can"]
#[doc = " recreate the fullpath with $origdir/$fname ... The file"]
#[doc = " can be a subdirectory, a file, a symlink, etc."]
#[doc = ""]
#[doc = " \\sa PHYSFS_enumerateFilesCallback"]
pub type PHYSFS_EnumFilesCallback = ::std::option::Option<
unsafe extern "C" fn(
data: *mut ::std::os::raw::c_void,
origdir: *const ::std::os::raw::c_char,
fname: *const ::std::os::raw::c_char,
),
>;
extern "C" {
#[doc = " \\fn void PHYSFS_getCdRomDirsCallback(PHYSFS_StringCallback c, void *d)"]
#[doc = " \\brief Enumerate CD-ROM directories, using an application-defined callback."]
#[doc = ""]
#[doc = " Internally, PHYSFS_getCdRomDirs() just calls this function and then builds"]
#[doc = " a list before returning to the application, so functionality is identical"]
#[doc = " except for how the information is represented to the application."]
#[doc = ""]
#[doc = " Unlike PHYSFS_getCdRomDirs(), this function does not return an array."]
#[doc = " Rather, it calls a function specified by the application once per"]
#[doc = " detected disc:"]
#[doc = ""]
#[doc = " \\code"]
#[doc = ""]
#[doc = " static void foundDisc(void *data, const char *cddir)"]
#[doc = " {"]
#[doc = " printf(\"cdrom dir [%s] is available.\\n\", cddir);"]
#[doc = " }"]
#[doc = ""]
#[doc = " // ..."]
#[doc = " PHYSFS_getCdRomDirsCallback(foundDisc, NULL);"]
#[doc = " \\endcode"]
#[doc = ""]
#[doc = " This call may block while drives spin up. Be forewarned."]
#[doc = ""]
#[doc = " \\param c Callback function to notify about detected drives."]
#[doc = " \\param d Application-defined data passed to callback. Can be NULL."]
#[doc = ""]
#[doc = " \\sa PHYSFS_StringCallback"]
#[doc = " \\sa PHYSFS_getCdRomDirs"]
pub fn PHYSFS_getCdRomDirsCallback(c: PHYSFS_StringCallback, d: *mut ::std::os::raw::c_void);
}
extern "C" {
#[doc = " \\fn void PHYSFS_getSearchPathCallback(PHYSFS_StringCallback c, void *d)"]
#[doc = " \\brief Enumerate the search path, using an application-defined callback."]
#[doc = ""]
#[doc = " Internally, PHYSFS_getSearchPath() just calls this function and then builds"]
#[doc = " a list before returning to the application, so functionality is identical"]
#[doc = " except for how the information is represented to the application."]
#[doc = ""]
#[doc = " Unlike PHYSFS_getSearchPath(), this function does not return an array."]
#[doc = " Rather, it calls a function specified by the application once per"]
#[doc = " element of the search path:"]
#[doc = ""]
#[doc = " \\code"]
#[doc = ""]
#[doc = " static void printSearchPath(void *data, const char *pathItem)"]
#[doc = " {"]
#[doc = " printf(\"[%s] is in the search path.\\n\", pathItem);"]
#[doc = " }"]
#[doc = ""]
#[doc = " // ..."]
#[doc = " PHYSFS_getSearchPathCallback(printSearchPath, NULL);"]
#[doc = " \\endcode"]
#[doc = ""]
#[doc = " Elements of the search path are reported in order search priority, so the"]
#[doc = " first archive/dir that would be examined when looking for a file is the"]
#[doc = " first element passed through the callback."]
#[doc = ""]
#[doc = " \\param c Callback function to notify about search path elements."]
#[doc = " \\param d Application-defined data passed to callback. Can be NULL."]
#[doc = ""]
#[doc = " \\sa PHYSFS_StringCallback"]
#[doc = " \\sa PHYSFS_getSearchPath"]
pub fn PHYSFS_getSearchPathCallback(c: PHYSFS_StringCallback, d: *mut ::std::os::raw::c_void);
}
extern "C" {
#[doc = " \\fn void PHYSFS_enumerateFilesCallback(const char *dir, PHYSFS_EnumFilesCallback c, void *d)"]
#[doc = " \\brief Get a file listing of a search path's directory, using an application-defined callback."]
#[doc = ""]
#[doc = " \\deprecated As of PhysicsFS 2.1, use PHYSFS_enumerate() instead. This"]
#[doc = " function has no way to report errors (or to have the callback signal an"]
#[doc = " error or request a stop), so if data will be lost, your callback has no"]
#[doc = " way to direct the process, and your calling app has no way to know."]
#[doc = ""]
#[doc = " As of PhysicsFS 2.1, this function just wraps PHYSFS_enumerate() and"]
#[doc = " ignores errors. Consider using PHYSFS_enumerate() or"]
#[doc = " PHYSFS_enumerateFiles() instead."]
#[doc = ""]
#[doc = " \\sa PHYSFS_enumerate"]
#[doc = " \\sa PHYSFS_enumerateFiles"]
#[doc = " \\sa PHYSFS_EnumFilesCallback"]
pub fn PHYSFS_enumerateFilesCallback(
dir: *const ::std::os::raw::c_char,
c: PHYSFS_EnumFilesCallback,
d: *mut ::std::os::raw::c_void,
);
}
extern "C" {
#[doc = " \\fn void PHYSFS_utf8FromUcs4(const PHYSFS_uint32 *src, char *dst, PHYSFS_uint64 len)"]
#[doc = " \\brief Convert a UCS-4 string to a UTF-8 string."]
#[doc = ""]
#[doc = " \\warning This function will not report an error if there are invalid UCS-4"]
#[doc = " values in the source string. It will replace them with a '?'"]
#[doc = " character and continue on."]
#[doc = ""]
#[doc = " UCS-4 (aka UTF-32) strings are 32-bits per character: \\c wchar_t on Unix."]
#[doc = ""]
#[doc = " To ensure that the destination buffer is large enough for the conversion,"]
#[doc = " please allocate a buffer that is the same size as the source buffer. UTF-8"]
#[doc = " never uses more than 32-bits per character, so while it may shrink a UCS-4"]
#[doc = " string, it will never expand it."]
#[doc = ""]
#[doc = " Strings that don't fit in the destination buffer will be truncated, but"]
#[doc = " will always be null-terminated and never have an incomplete UTF-8"]
#[doc = " sequence at the end. If the buffer length is 0, this function does nothing."]
#[doc = ""]
#[doc = " \\param src Null-terminated source string in UCS-4 format."]
#[doc = " \\param dst Buffer to store converted UTF-8 string."]
#[doc = " \\param len Size, in bytes, of destination buffer."]
pub fn PHYSFS_utf8FromUcs4(
src: *const PHYSFS_uint32,
dst: *mut ::std::os::raw::c_char,
len: PHYSFS_uint64,
);
}
extern "C" {
#[doc = " \\fn void PHYSFS_utf8ToUcs4(const char *src, PHYSFS_uint32 *dst, PHYSFS_uint64 len)"]
#[doc = " \\brief Convert a UTF-8 string to a UCS-4 string."]
#[doc = ""]
#[doc = " \\warning This function will not report an error if there are invalid UTF-8"]
#[doc = " sequences in the source string. It will replace them with a '?'"]
#[doc = " character and continue on."]
#[doc = ""]
#[doc = " UCS-4 (aka UTF-32) strings are 32-bits per character: \\c wchar_t on Unix."]
#[doc = ""]
#[doc = " To ensure that the destination buffer is large enough for the conversion,"]
#[doc = " please allocate a buffer that is four times the size of the source buffer."]
#[doc = " UTF-8 uses from one to four bytes per character, but UCS-4 always uses"]
#[doc = " four, so an entirely low-ASCII string will quadruple in size!"]
#[doc = ""]
#[doc = " Strings that don't fit in the destination buffer will be truncated, but"]
#[doc = " will always be null-terminated and never have an incomplete UCS-4"]
#[doc = " sequence at the end. If the buffer length is 0, this function does nothing."]
#[doc = ""]
#[doc = " \\param src Null-terminated source string in UTF-8 format."]
#[doc = " \\param dst Buffer to store converted UCS-4 string."]
#[doc = " \\param len Size, in bytes, of destination buffer."]
pub fn PHYSFS_utf8ToUcs4(
src: *const ::std::os::raw::c_char,
dst: *mut PHYSFS_uint32,
len: PHYSFS_uint64,
);
}
extern "C" {
#[doc = " \\fn void PHYSFS_utf8FromUcs2(const PHYSFS_uint16 *src, char *dst, PHYSFS_uint64 len)"]
#[doc = " \\brief Convert a UCS-2 string to a UTF-8 string."]
#[doc = ""]
#[doc = " \\warning you almost certainly should use PHYSFS_utf8FromUtf16(), which"]
#[doc = " became available in PhysicsFS 2.1, unless you know what you're doing."]
#[doc = ""]
#[doc = " \\warning This function will not report an error if there are invalid UCS-2"]
#[doc = " values in the source string. It will replace them with a '?'"]
#[doc = " character and continue on."]
#[doc = ""]
#[doc = " UCS-2 strings are 16-bits per character: \\c TCHAR on Windows, when building"]
#[doc = " with Unicode support. Please note that modern versions of Windows use"]
#[doc = " UTF-16, which is an extended form of UCS-2, and not UCS-2 itself. You"]
#[doc = " almost certainly want PHYSFS_utf8FromUtf16() instead."]
#[doc = ""]
#[doc = " To ensure that the destination buffer is large enough for the conversion,"]
#[doc = " please allocate a buffer that is double the size of the source buffer."]
#[doc = " UTF-8 never uses more than 32-bits per character, so while it may shrink"]
#[doc = " a UCS-2 string, it may also expand it."]
#[doc = ""]
#[doc = " Strings that don't fit in the destination buffer will be truncated, but"]
#[doc = " will always be null-terminated and never have an incomplete UTF-8"]
#[doc = " sequence at the end. If the buffer length is 0, this function does nothing."]
#[doc = ""]
#[doc = " \\param src Null-terminated source string in UCS-2 format."]
#[doc = " \\param dst Buffer to store converted UTF-8 string."]
#[doc = " \\param len Size, in bytes, of destination buffer."]
#[doc = ""]
#[doc = " \\sa PHYSFS_utf8FromUtf16"]
pub fn PHYSFS_utf8FromUcs2(
src: *const PHYSFS_uint16,
dst: *mut ::std::os::raw::c_char,
len: PHYSFS_uint64,
);
}
extern "C" {
#[doc = " \\fn PHYSFS_utf8ToUcs2(const char *src, PHYSFS_uint16 *dst, PHYSFS_uint64 len)"]
#[doc = " \\brief Convert a UTF-8 string to a UCS-2 string."]
#[doc = ""]
#[doc = " \\warning you almost certainly should use PHYSFS_utf8ToUtf16(), which"]
#[doc = " became available in PhysicsFS 2.1, unless you know what you're doing."]
#[doc = ""]
#[doc = " \\warning This function will not report an error if there are invalid UTF-8"]
#[doc = " sequences in the source string. It will replace them with a '?'"]
#[doc = " character and continue on."]
#[doc = ""]
#[doc = " UCS-2 strings are 16-bits per character: \\c TCHAR on Windows, when building"]
#[doc = " with Unicode support. Please note that modern versions of Windows use"]
#[doc = " UTF-16, which is an extended form of UCS-2, and not UCS-2 itself. You"]
#[doc = " almost certainly want PHYSFS_utf8ToUtf16() instead, but you need to"]
#[doc = " understand how that changes things, too."]
#[doc = ""]
#[doc = " To ensure that the destination buffer is large enough for the conversion,"]
#[doc = " please allocate a buffer that is double the size of the source buffer."]
#[doc = " UTF-8 uses from one to four bytes per character, but UCS-2 always uses"]
#[doc = " two, so an entirely low-ASCII string will double in size!"]
#[doc = ""]
#[doc = " Strings that don't fit in the destination buffer will be truncated, but"]
#[doc = " will always be null-terminated and never have an incomplete UCS-2"]
#[doc = " sequence at the end. If the buffer length is 0, this function does nothing."]
#[doc = ""]
#[doc = " \\param src Null-terminated source string in UTF-8 format."]
#[doc = " \\param dst Buffer to store converted UCS-2 string."]
#[doc = " \\param len Size, in bytes, of destination buffer."]
#[doc = ""]
#[doc = " \\sa PHYSFS_utf8ToUtf16"]
pub fn PHYSFS_utf8ToUcs2(
src: *const ::std::os::raw::c_char,
dst: *mut PHYSFS_uint16,
len: PHYSFS_uint64,
);
}
extern "C" {
#[doc = " \\fn void PHYSFS_utf8FromLatin1(const char *src, char *dst, PHYSFS_uint64 len)"]
#[doc = " \\brief Convert a UTF-8 string to a Latin1 string."]
#[doc = ""]
#[doc = " Latin1 strings are 8-bits per character: a popular \"high ASCII\" encoding."]
#[doc = ""]
#[doc = " To ensure that the destination buffer is large enough for the conversion,"]
#[doc = " please allocate a buffer that is double the size of the source buffer."]
#[doc = " UTF-8 expands latin1 codepoints over 127 from 1 to 2 bytes, so the string"]
#[doc = " may grow in some cases."]
#[doc = ""]
#[doc = " Strings that don't fit in the destination buffer will be truncated, but"]
#[doc = " will always be null-terminated and never have an incomplete UTF-8"]
#[doc = " sequence at the end. If the buffer length is 0, this function does nothing."]
#[doc = ""]
#[doc = " Please note that we do not supply a UTF-8 to Latin1 converter, since Latin1"]
#[doc = " can't express most Unicode codepoints. It's a legacy encoding; you should"]
#[doc = " be converting away from it at all times."]
#[doc = ""]
#[doc = " \\param src Null-terminated source string in Latin1 format."]
#[doc = " \\param dst Buffer to store converted UTF-8 string."]
#[doc = " \\param len Size, in bytes, of destination buffer."]
pub fn PHYSFS_utf8FromLatin1(
src: *const ::std::os::raw::c_char,
dst: *mut ::std::os::raw::c_char,
len: PHYSFS_uint64,
);
}
extern "C" {
#[doc = " \\fn int PHYSFS_caseFold(const PHYSFS_uint32 from, PHYSFS_uint32 *to)"]
#[doc = " \\brief \"Fold\" a Unicode codepoint to a lowercase equivalent."]
#[doc = ""]
#[doc = " (This is for limited, hardcore use. If you don't immediately see a need"]
#[doc = " for it, you can probably ignore this forever.)"]
#[doc = ""]
#[doc = " This will convert a Unicode codepoint into its lowercase equivalent."]
#[doc = " Bogus codepoints and codepoints without a lowercase equivalent will"]
#[doc = " be returned unconverted."]
#[doc = ""]
#[doc = " Note that you might get multiple codepoints in return! The German Eszett,"]
#[doc = " for example, will fold down to two lowercase latin 's' codepoints. The"]
#[doc = " theory is that if you fold two strings, one with an Eszett and one with"]
#[doc = " \"SS\" down, they will match."]
#[doc = ""]
#[doc = " \\warning Anyone that is a student of Unicode knows about the \"Turkish I\""]
#[doc = " problem. This API does not handle it. Assume this one letter"]
#[doc = " in all of Unicode will definitely fold sort of incorrectly. If"]
#[doc = " you don't know what this is about, you can probably ignore this"]
#[doc = " problem for most of the planet, but perfection is impossible."]
#[doc = ""]
#[doc = " \\param from The codepoint to fold."]
#[doc = " \\param to Buffer to store the folded codepoint values into. This should"]
#[doc = " point to space for at least 3 PHYSFS_uint32 slots."]
#[doc = " \\return The number of codepoints the folding produced. Between 1 and 3."]
pub fn PHYSFS_caseFold(from: PHYSFS_uint32, to: *mut PHYSFS_uint32) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_utf8stricmp(const char *str1, const char *str2)"]
#[doc = " \\brief Case-insensitive compare of two UTF-8 strings."]
#[doc = ""]
#[doc = " This is a strcasecmp/stricmp replacement that expects both strings"]
#[doc = " to be in UTF-8 encoding. It will do \"case folding\" to decide if the"]
#[doc = " Unicode codepoints in the strings match."]
#[doc = ""]
#[doc = " If both strings are exclusively low-ASCII characters, this will do the"]
#[doc = " right thing, as that is also valid UTF-8. If there are any high-ASCII"]
#[doc = " chars, this will not do what you expect!"]
#[doc = ""]
#[doc = " It will report which string is \"greater than\" the other, but be aware that"]
#[doc = " this doesn't necessarily mean anything: 'a' may be \"less than\" 'b', but"]
#[doc = " a Japanese kuten has no meaningful alphabetically relationship to"]
#[doc = " a Greek lambda, but being able to assign a reliable \"value\" makes sorting"]
#[doc = " algorithms possible, if not entirely sane. Most cases should treat the"]
#[doc = " return value as \"equal\" or \"not equal\"."]
#[doc = ""]
#[doc = " Like stricmp, this expects both strings to be NULL-terminated."]
#[doc = ""]
#[doc = " \\param str1 First string to compare."]
#[doc = " \\param str2 Second string to compare."]
#[doc = " \\return -1 if str1 is \"less than\" str2, 1 if \"greater than\", 0 if equal."]
pub fn PHYSFS_utf8stricmp(
str1: *const ::std::os::raw::c_char,
str2: *const ::std::os::raw::c_char,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_utf16stricmp(const PHYSFS_uint16 *str1, const PHYSFS_uint16 *str2)"]
#[doc = " \\brief Case-insensitive compare of two UTF-16 strings."]
#[doc = ""]
#[doc = " This is a strcasecmp/stricmp replacement that expects both strings"]
#[doc = " to be in UTF-16 encoding. It will do \"case folding\" to decide if the"]
#[doc = " Unicode codepoints in the strings match."]
#[doc = ""]
#[doc = " It will report which string is \"greater than\" the other, but be aware that"]
#[doc = " this doesn't necessarily mean anything: 'a' may be \"less than\" 'b', but"]
#[doc = " a Japanese kuten has no meaningful alphabetically relationship to"]
#[doc = " a Greek lambda, but being able to assign a reliable \"value\" makes sorting"]
#[doc = " algorithms possible, if not entirely sane. Most cases should treat the"]
#[doc = " return value as \"equal\" or \"not equal\"."]
#[doc = ""]
#[doc = " Like stricmp, this expects both strings to be NULL-terminated."]
#[doc = ""]
#[doc = " \\param str1 First string to compare."]
#[doc = " \\param str2 Second string to compare."]
#[doc = " \\return -1 if str1 is \"less than\" str2, 1 if \"greater than\", 0 if equal."]
pub fn PHYSFS_utf16stricmp(
str1: *const PHYSFS_uint16,
str2: *const PHYSFS_uint16,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_ucs4stricmp(const PHYSFS_uint32 *str1, const PHYSFS_uint32 *str2)"]
#[doc = " \\brief Case-insensitive compare of two UCS-4 strings."]
#[doc = ""]
#[doc = " This is a strcasecmp/stricmp replacement that expects both strings"]
#[doc = " to be in UCS-4 (aka UTF-32) encoding. It will do \"case folding\" to decide"]
#[doc = " if the Unicode codepoints in the strings match."]
#[doc = ""]
#[doc = " It will report which string is \"greater than\" the other, but be aware that"]
#[doc = " this doesn't necessarily mean anything: 'a' may be \"less than\" 'b', but"]
#[doc = " a Japanese kuten has no meaningful alphabetically relationship to"]
#[doc = " a Greek lambda, but being able to assign a reliable \"value\" makes sorting"]
#[doc = " algorithms possible, if not entirely sane. Most cases should treat the"]
#[doc = " return value as \"equal\" or \"not equal\"."]
#[doc = ""]
#[doc = " Like stricmp, this expects both strings to be NULL-terminated."]
#[doc = ""]
#[doc = " \\param str1 First string to compare."]
#[doc = " \\param str2 Second string to compare."]
#[doc = " \\return -1 if str1 is \"less than\" str2, 1 if \"greater than\", 0 if equal."]
pub fn PHYSFS_ucs4stricmp(
str1: *const PHYSFS_uint32,
str2: *const PHYSFS_uint32,
) -> ::std::os::raw::c_int;
}
#[doc = "< Stop enumerating, report error to app."]
pub const PHYSFS_EnumerateCallbackResult_PHYSFS_ENUM_ERROR: PHYSFS_EnumerateCallbackResult = -1;
#[doc = "< Stop enumerating, report success to app."]
pub const PHYSFS_EnumerateCallbackResult_PHYSFS_ENUM_STOP: PHYSFS_EnumerateCallbackResult = 0;
#[doc = "< Keep enumerating, no problems"]
pub const PHYSFS_EnumerateCallbackResult_PHYSFS_ENUM_OK: PHYSFS_EnumerateCallbackResult = 1;
#[doc = " \\typedef PHYSFS_EnumerateCallback"]
#[doc = " \\brief Possible return values from PHYSFS_EnumerateCallback."]
#[doc = ""]
#[doc = " These values dictate if an enumeration callback should continue to fire,"]
#[doc = " or stop (and why it is stopping)."]
#[doc = ""]
#[doc = " \\sa PHYSFS_EnumerateCallback"]
#[doc = " \\sa PHYSFS_enumerate"]
pub type PHYSFS_EnumerateCallbackResult = i32;
#[doc = " \\typedef PHYSFS_EnumerateCallback"]
#[doc = " \\brief Function signature for callbacks that enumerate and return results."]
#[doc = ""]
#[doc = " This is the same thing as PHYSFS_EnumFilesCallback from PhysicsFS 2.0,"]
#[doc = " except it can return a result from the callback: namely: if you're looking"]
#[doc = " for something specific, once you find it, you can tell PhysicsFS to stop"]
#[doc = " enumerating further. This is used with PHYSFS_enumerate(), which we"]
#[doc = " hopefully got right this time. :)"]
#[doc = ""]
#[doc = " \\param data User-defined data pointer, passed through from the API"]
#[doc = " that eventually called the callback."]
#[doc = " \\param origdir A string containing the full path, in platform-independent"]
#[doc = " notation, of the directory containing this file. In most"]
#[doc = " cases, this is the directory on which you requested"]
#[doc = " enumeration, passed in the callback for your convenience."]
#[doc = " \\param fname The filename that is being enumerated. It may not be in"]
#[doc = " alphabetical order compared to other callbacks that have"]
#[doc = " fired, and it will not contain the full path. You can"]
#[doc = " recreate the fullpath with $origdir/$fname ... The file"]
#[doc = " can be a subdirectory, a file, a symlink, etc."]
#[doc = " \\return A value from PHYSFS_EnumerateCallbackResult."]
#[doc = " All other values are (currently) undefined; don't use them."]
#[doc = ""]
#[doc = " \\sa PHYSFS_enumerate"]
#[doc = " \\sa PHYSFS_EnumerateCallbackResult"]
pub type PHYSFS_EnumerateCallback = ::std::option::Option<
unsafe extern "C" fn(
data: *mut ::std::os::raw::c_void,
origdir: *const ::std::os::raw::c_char,
fname: *const ::std::os::raw::c_char,
) -> PHYSFS_EnumerateCallbackResult,
>;
extern "C" {
#[doc = " \\fn int PHYSFS_enumerate(const char *dir, PHYSFS_EnumerateCallback c, void *d)"]
#[doc = " \\brief Get a file listing of a search path's directory, using an application-defined callback, with errors reported."]
#[doc = ""]
#[doc = " Internally, PHYSFS_enumerateFiles() just calls this function and then builds"]
#[doc = " a list before returning to the application, so functionality is identical"]
#[doc = " except for how the information is represented to the application."]
#[doc = ""]
#[doc = " Unlike PHYSFS_enumerateFiles(), this function does not return an array."]
#[doc = " Rather, it calls a function specified by the application once per"]
#[doc = " element of the search path:"]
#[doc = ""]
#[doc = " \\code"]
#[doc = ""]
#[doc = " static int printDir(void *data, const char *origdir, const char *fname)"]
#[doc = " {"]
#[doc = " printf(\" * We've got [%s] in [%s].\\n\", fname, origdir);"]
#[doc = " return 1; // give me more data, please."]
#[doc = " }"]
#[doc = ""]
#[doc = " // ..."]
#[doc = " PHYSFS_enumerate(\"/some/path\", printDir, NULL);"]
#[doc = " \\endcode"]
#[doc = ""]
#[doc = " Items sent to the callback are not guaranteed to be in any order whatsoever."]
#[doc = " There is no sorting done at this level, and if you need that, you should"]
#[doc = " probably use PHYSFS_enumerateFiles() instead, which guarantees"]
#[doc = " alphabetical sorting. This form reports whatever is discovered in each"]
#[doc = " archive before moving on to the next. Even within one archive, we can't"]
#[doc = " guarantee what order it will discover data. <em>Any sorting you find in"]
#[doc = " these callbacks is just pure luck. Do not rely on it.</em> As this walks"]
#[doc = " the entire list of archives, you may receive duplicate filenames."]
#[doc = ""]
#[doc = " This API and the callbacks themselves are capable of reporting errors."]
#[doc = " Prior to this API, callbacks had to accept every enumerated item, even if"]
#[doc = " they were only looking for a specific thing and wanted to stop after that,"]
#[doc = " or had a serious error and couldn't alert anyone. Furthermore, if"]
#[doc = " PhysicsFS itself had a problem (disk error or whatnot), it couldn't report"]
#[doc = " it to the calling app, it would just have to skip items or stop"]
#[doc = " enumerating outright, and the caller wouldn't know it had lost some data"]
#[doc = " along the way."]
#[doc = ""]
#[doc = " Now the caller can be sure it got a complete data set, and its callback has"]
#[doc = " control if it wants enumeration to stop early. See the documentation for"]
#[doc = " PHYSFS_EnumerateCallback for details on how your callback should behave."]
#[doc = ""]
#[doc = " \\param dir Directory, in platform-independent notation, to enumerate."]
#[doc = " \\param c Callback function to notify about search path elements."]
#[doc = " \\param d Application-defined data passed to callback. Can be NULL."]
#[doc = " \\return non-zero on success, zero on failure. Use"]
#[doc = " PHYSFS_getLastErrorCode() to obtain the specific error. If the"]
#[doc = " callback returns PHYSFS_ENUM_STOP to stop early, this will be"]
#[doc = " considered success. Callbacks returning PHYSFS_ENUM_ERROR will"]
#[doc = " make this function return zero and set the error code to"]
#[doc = " PHYSFS_ERR_APP_CALLBACK."]
#[doc = ""]
#[doc = " \\sa PHYSFS_EnumerateCallback"]
#[doc = " \\sa PHYSFS_enumerateFiles"]
pub fn PHYSFS_enumerate(
dir: *const ::std::os::raw::c_char,
c: PHYSFS_EnumerateCallback,
d: *mut ::std::os::raw::c_void,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_unmount(const char *oldDir)"]
#[doc = " \\brief Remove a directory or archive from the search path."]
#[doc = ""]
#[doc = " This is functionally equivalent to PHYSFS_removeFromSearchPath(), but that"]
#[doc = " function is deprecated to keep the vocabulary paired with PHYSFS_mount()."]
#[doc = ""]
#[doc = " This must be a (case-sensitive) match to a dir or archive already in the"]
#[doc = " search path, specified in platform-dependent notation."]
#[doc = ""]
#[doc = " This call will fail (and fail to remove from the path) if the element still"]
#[doc = " has files open in it."]
#[doc = ""]
#[doc = " \\warning This function wants the path to the archive or directory that was"]
#[doc = " mounted (the same string used for the \"newDir\" argument of"]
#[doc = " PHYSFS_addToSearchPath or any of the mount functions), not the"]
#[doc = " path where it is mounted in the tree (the \"mountPoint\" argument"]
#[doc = " to any of the mount functions)."]
#[doc = ""]
#[doc = " \\param oldDir dir/archive to remove."]
#[doc = " \\return nonzero on success, zero on failure. Use"]
#[doc = " PHYSFS_getLastErrorCode() to obtain the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getSearchPath"]
#[doc = " \\sa PHYSFS_mount"]
pub fn PHYSFS_unmount(oldDir: *const ::std::os::raw::c_char) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn const PHYSFS_Allocator *PHYSFS_getAllocator(void)"]
#[doc = " \\brief Discover the current allocator."]
#[doc = ""]
#[doc = " (This is for limited, hardcore use. If you don't immediately see a need"]
#[doc = " for it, you can probably ignore this forever.)"]
#[doc = ""]
#[doc = " This function exposes the function pointers that make up the currently used"]
#[doc = " allocator. This can be useful for apps that want to access PhysicsFS's"]
#[doc = " internal, default allocation routines, as well as for external code that"]
#[doc = " wants to share the same allocator, even if the application specified their"]
#[doc = " own."]
#[doc = ""]
#[doc = " This call is only valid between PHYSFS_init() and PHYSFS_deinit() calls;"]
#[doc = " it will return NULL if the library isn't initialized. As we can't"]
#[doc = " guarantee the state of the internal allocators unless the library is"]
#[doc = " initialized, you shouldn't use any allocator returned here after a call"]
#[doc = " to PHYSFS_deinit()."]
#[doc = ""]
#[doc = " Do not call the returned allocator's Init() or Deinit() methods under any"]
#[doc = " circumstances."]
#[doc = ""]
#[doc = " If you aren't immediately sure what to do with this function, you can"]
#[doc = " safely ignore it altogether."]
#[doc = ""]
#[doc = " \\return Current allocator, as set by PHYSFS_setAllocator(), or PhysicsFS's"]
#[doc = " internal, default allocator if no application defined allocator"]
#[doc = " is currently set. Will return NULL if the library is not"]
#[doc = " initialized."]
#[doc = ""]
#[doc = " \\sa PHYSFS_Allocator"]
#[doc = " \\sa PHYSFS_setAllocator"]
pub fn PHYSFS_getAllocator() -> *const PHYSFS_Allocator;
}
#[doc = "< a normal file"]
pub const PHYSFS_FileType_PHYSFS_FILETYPE_REGULAR: PHYSFS_FileType = 0;
#[doc = "< a directory"]
pub const PHYSFS_FileType_PHYSFS_FILETYPE_DIRECTORY: PHYSFS_FileType = 1;
#[doc = "< a symlink"]
pub const PHYSFS_FileType_PHYSFS_FILETYPE_SYMLINK: PHYSFS_FileType = 2;
#[doc = "< something completely different like a device"]
pub const PHYSFS_FileType_PHYSFS_FILETYPE_OTHER: PHYSFS_FileType = 3;
#[doc = " \\enum PHYSFS_FileType"]
#[doc = " \\brief Type of a File"]
#[doc = ""]
#[doc = " Possible types of a file."]
#[doc = ""]
#[doc = " \\sa PHYSFS_stat"]
pub type PHYSFS_FileType = u32;
#[doc = " \\struct PHYSFS_Stat"]
#[doc = " \\brief Meta data for a file or directory"]
#[doc = ""]
#[doc = " Container for various meta data about a file in the virtual file system."]
#[doc = " PHYSFS_stat() uses this structure for returning the information. The time"]
#[doc = " data will be either the number of seconds since the Unix epoch (midnight,"]
#[doc = " Jan 1, 1970), or -1 if the information isn't available or applicable."]
#[doc = " The (filesize) field is measured in bytes."]
#[doc = " The (readonly) field tells you whether the archive thinks a file is"]
#[doc = " not writable, but tends to be only an estimate (for example, your write"]
#[doc = " dir might overlap with a .zip file, meaning you _can_ successfully open"]
#[doc = " that path for writing, as it gets created elsewhere."]
#[doc = ""]
#[doc = " \\sa PHYSFS_stat"]
#[doc = " \\sa PHYSFS_FileType"]
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct PHYSFS_Stat {
#[doc = "< size in bytes, -1 for non-files and unknown"]
pub filesize: PHYSFS_sint64,
#[doc = "< last modification time"]
pub modtime: PHYSFS_sint64,
#[doc = "< like modtime, but for file creation time"]
pub createtime: PHYSFS_sint64,
#[doc = "< like modtime, but for file access time"]
pub accesstime: PHYSFS_sint64,
#[doc = "< File? Directory? Symlink?"]
pub filetype: PHYSFS_FileType,
#[doc = "< non-zero if read only, zero if writable."]
pub readonly: ::std::os::raw::c_int,
}
#[test]
fn bindgen_test_layout_PHYSFS_Stat() {
assert_eq!(
::std::mem::size_of::<PHYSFS_Stat>(),
40usize,
concat!("Size of: ", stringify!(PHYSFS_Stat))
);
assert_eq!(
::std::mem::align_of::<PHYSFS_Stat>(),
8usize,
concat!("Alignment of ", stringify!(PHYSFS_Stat))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Stat>())).filesize as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Stat),
"::",
stringify!(filesize)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Stat>())).modtime as *const _ as usize },
8usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Stat),
"::",
stringify!(modtime)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Stat>())).createtime as *const _ as usize },
16usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Stat),
"::",
stringify!(createtime)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Stat>())).accesstime as *const _ as usize },
24usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Stat),
"::",
stringify!(accesstime)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Stat>())).filetype as *const _ as usize },
32usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Stat),
"::",
stringify!(filetype)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Stat>())).readonly as *const _ as usize },
36usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Stat),
"::",
stringify!(readonly)
)
);
}
extern "C" {
#[doc = " \\fn int PHYSFS_stat(const char *fname, PHYSFS_Stat *stat)"]
#[doc = " \\brief Get various information about a directory or a file."]
#[doc = ""]
#[doc = " Obtain various information about a file or directory from the meta data."]
#[doc = ""]
#[doc = " This function will never follow symbolic links. If you haven't enabled"]
#[doc = " symlinks with PHYSFS_permitSymbolicLinks(), stat'ing a symlink will be"]
#[doc = " treated like stat'ing a non-existant file. If symlinks are enabled,"]
#[doc = " stat'ing a symlink will give you information on the link itself and not"]
#[doc = " what it points to."]
#[doc = ""]
#[doc = " \\param fname filename to check, in platform-indepedent notation."]
#[doc = " \\param stat pointer to structure to fill in with data about (fname)."]
#[doc = " \\return non-zero on success, zero on failure. On failure, (stat)'s"]
#[doc = " contents are undefined."]
#[doc = ""]
#[doc = " \\sa PHYSFS_Stat"]
pub fn PHYSFS_stat(
fname: *const ::std::os::raw::c_char,
stat: *mut PHYSFS_Stat,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn void PHYSFS_utf8FromUtf16(const PHYSFS_uint16 *src, char *dst, PHYSFS_uint64 len)"]
#[doc = " \\brief Convert a UTF-16 string to a UTF-8 string."]
#[doc = ""]
#[doc = " \\warning This function will not report an error if there are invalid UTF-16"]
#[doc = " sequences in the source string. It will replace them with a '?'"]
#[doc = " character and continue on."]
#[doc = ""]
#[doc = " UTF-16 strings are 16-bits per character (except some chars, which are"]
#[doc = " 32-bits): \\c TCHAR on Windows, when building with Unicode support. Modern"]
#[doc = " Windows releases use UTF-16. Windows releases before 2000 used TCHAR, but"]
#[doc = " only handled UCS-2. UTF-16 _is_ UCS-2, except for the characters that"]
#[doc = " are 4 bytes, which aren't representable in UCS-2 at all anyhow. If you"]
#[doc = " aren't sure, you should be using UTF-16 at this point on Windows."]
#[doc = ""]
#[doc = " To ensure that the destination buffer is large enough for the conversion,"]
#[doc = " please allocate a buffer that is double the size of the source buffer."]
#[doc = " UTF-8 never uses more than 32-bits per character, so while it may shrink"]
#[doc = " a UTF-16 string, it may also expand it."]
#[doc = ""]
#[doc = " Strings that don't fit in the destination buffer will be truncated, but"]
#[doc = " will always be null-terminated and never have an incomplete UTF-8"]
#[doc = " sequence at the end. If the buffer length is 0, this function does nothing."]
#[doc = ""]
#[doc = " \\param src Null-terminated source string in UTF-16 format."]
#[doc = " \\param dst Buffer to store converted UTF-8 string."]
#[doc = " \\param len Size, in bytes, of destination buffer."]
pub fn PHYSFS_utf8FromUtf16(
src: *const PHYSFS_uint16,
dst: *mut ::std::os::raw::c_char,
len: PHYSFS_uint64,
);
}
extern "C" {
#[doc = " \\fn PHYSFS_utf8ToUtf16(const char *src, PHYSFS_uint16 *dst, PHYSFS_uint64 len)"]
#[doc = " \\brief Convert a UTF-8 string to a UTF-16 string."]
#[doc = ""]
#[doc = " \\warning This function will not report an error if there are invalid UTF-8"]
#[doc = " sequences in the source string. It will replace them with a '?'"]
#[doc = " character and continue on."]
#[doc = ""]
#[doc = " UTF-16 strings are 16-bits per character (except some chars, which are"]
#[doc = " 32-bits): \\c TCHAR on Windows, when building with Unicode support. Modern"]
#[doc = " Windows releases use UTF-16. Windows releases before 2000 used TCHAR, but"]
#[doc = " only handled UCS-2. UTF-16 _is_ UCS-2, except for the characters that"]
#[doc = " are 4 bytes, which aren't representable in UCS-2 at all anyhow. If you"]
#[doc = " aren't sure, you should be using UTF-16 at this point on Windows."]
#[doc = ""]
#[doc = " To ensure that the destination buffer is large enough for the conversion,"]
#[doc = " please allocate a buffer that is double the size of the source buffer."]
#[doc = " UTF-8 uses from one to four bytes per character, but UTF-16 always uses"]
#[doc = " two to four, so an entirely low-ASCII string will double in size! The"]
#[doc = " UTF-16 characters that would take four bytes also take four bytes in UTF-8,"]
#[doc = " so you don't need to allocate 4x the space just in case: double will do."]
#[doc = ""]
#[doc = " Strings that don't fit in the destination buffer will be truncated, but"]
#[doc = " will always be null-terminated and never have an incomplete UTF-16"]
#[doc = " surrogate pair at the end. If the buffer length is 0, this function does"]
#[doc = " nothing."]
#[doc = ""]
#[doc = " \\param src Null-terminated source string in UTF-8 format."]
#[doc = " \\param dst Buffer to store converted UTF-16 string."]
#[doc = " \\param len Size, in bytes, of destination buffer."]
#[doc = ""]
#[doc = " \\sa PHYSFS_utf8ToUtf16"]
pub fn PHYSFS_utf8ToUtf16(
src: *const ::std::os::raw::c_char,
dst: *mut PHYSFS_uint16,
len: PHYSFS_uint64,
);
}
extern "C" {
#[doc = " \\fn PHYSFS_sint64 PHYSFS_readBytes(PHYSFS_File *handle, void *buffer, PHYSFS_uint64 len)"]
#[doc = " \\brief Read bytes from a PhysicsFS filehandle"]
#[doc = ""]
#[doc = " The file must be opened for reading."]
#[doc = ""]
#[doc = " \\param handle handle returned from PHYSFS_openRead()."]
#[doc = " \\param buffer buffer of at least (len) bytes to store read data into."]
#[doc = " \\param len number of bytes being read from (handle)."]
#[doc = " \\return number of bytes read. This may be less than (len); this does not"]
#[doc = " signify an error, necessarily (a short read may mean EOF)."]
#[doc = " PHYSFS_getLastErrorCode() can shed light on the reason this might"]
#[doc = " be < (len), as can PHYSFS_eof(). -1 if complete failure."]
#[doc = ""]
#[doc = " \\sa PHYSFS_eof"]
pub fn PHYSFS_readBytes(
handle: *mut PHYSFS_File,
buffer: *mut ::std::os::raw::c_void,
len: PHYSFS_uint64,
) -> PHYSFS_sint64;
}
extern "C" {
#[doc = " \\fn PHYSFS_sint64 PHYSFS_writeBytes(PHYSFS_File *handle, const void *buffer, PHYSFS_uint64 len)"]
#[doc = " \\brief Write data to a PhysicsFS filehandle"]
#[doc = ""]
#[doc = " The file must be opened for writing."]
#[doc = ""]
#[doc = " Please note that while (len) is an unsigned 64-bit integer, you are limited"]
#[doc = " to 63 bits (9223372036854775807 bytes), so we can return a negative value"]
#[doc = " on error. If length is greater than 0x7FFFFFFFFFFFFFFF, this function will"]
#[doc = " immediately fail. For systems without a 64-bit datatype, you are limited"]
#[doc = " to 31 bits (0x7FFFFFFF, or 2147483647 bytes). We trust most things won't"]
#[doc = " need to do multiple gigabytes of i/o in one call anyhow, but why limit"]
#[doc = " things?"]
#[doc = ""]
#[doc = " \\param handle retval from PHYSFS_openWrite() or PHYSFS_openAppend()."]
#[doc = " \\param buffer buffer of (len) bytes to write to (handle)."]
#[doc = " \\param len number of bytes being written to (handle)."]
#[doc = " \\return number of bytes written. This may be less than (len); in the case"]
#[doc = " of an error, the system may try to write as many bytes as possible,"]
#[doc = " so an incomplete write might occur. PHYSFS_getLastErrorCode() can"]
#[doc = " shed light on the reason this might be < (len). -1 if complete"]
#[doc = " failure."]
pub fn PHYSFS_writeBytes(
handle: *mut PHYSFS_File,
buffer: *const ::std::os::raw::c_void,
len: PHYSFS_uint64,
) -> PHYSFS_sint64;
}
#[doc = " \\struct PHYSFS_Io"]
#[doc = " \\brief An abstract i/o interface."]
#[doc = ""]
#[doc = " \\warning This is advanced, hardcore stuff. You don't need this unless you"]
#[doc = " really know what you're doing. Most apps will not need this."]
#[doc = ""]
#[doc = " Historically, PhysicsFS provided access to the physical filesystem and"]
#[doc = " archives within that filesystem. However, sometimes you need more power"]
#[doc = " than this. Perhaps you need to provide an archive that is entirely"]
#[doc = " contained in RAM, or you need to bridge some other file i/o API to"]
#[doc = " PhysicsFS, or you need to translate the bits (perhaps you have a"]
#[doc = " a standard .zip file that's encrypted, and you need to decrypt on the fly"]
#[doc = " for the unsuspecting zip archiver)."]
#[doc = ""]
#[doc = " A PHYSFS_Io is the interface that Archivers use to get archive data."]
#[doc = " Historically, this has mapped to file i/o to the physical filesystem, but"]
#[doc = " as of PhysicsFS 2.1, applications can provide their own i/o implementations"]
#[doc = " at runtime."]
#[doc = ""]
#[doc = " This interface isn't necessarily a good universal fit for i/o. There are a"]
#[doc = " few requirements of note:"]
#[doc = ""]
#[doc = " - They only do blocking i/o (at least, for now)."]
#[doc = " - They need to be able to duplicate. If you have a file handle from"]
#[doc = " fopen(), you need to be able to create a unique clone of it (so we"]
#[doc = " have two handles to the same file that can both seek/read/etc without"]
#[doc = " stepping on each other)."]
#[doc = " - They need to know the size of their entire data set."]
#[doc = " - They need to be able to seek and rewind on demand."]
#[doc = ""]
#[doc = " ...in short, you're probably not going to write an HTTP implementation."]
#[doc = ""]
#[doc = " Thread safety: PHYSFS_Io implementations are not guaranteed to be thread"]
#[doc = " safe in themselves. Under the hood where PhysicsFS uses them, the library"]
#[doc = " provides its own locks. If you plan to use them directly from separate"]
#[doc = " threads, you should either use mutexes to protect them, or don't use the"]
#[doc = " same PHYSFS_Io from two threads at the same time."]
#[doc = ""]
#[doc = " \\sa PHYSFS_mountIo"]
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct PHYSFS_Io {
#[doc = " \\brief Binary compatibility information."]
#[doc = ""]
#[doc = " This must be set to zero at this time. Future versions of this"]
#[doc = " struct will increment this field, so we know what a given"]
#[doc = " implementation supports. We'll presumably keep supporting older"]
#[doc = " versions as we offer new features, though."]
pub version: PHYSFS_uint32,
#[doc = " \\brief Instance data for this struct."]
#[doc = ""]
#[doc = " Each instance has a pointer associated with it that can be used to"]
#[doc = " store anything it likes. This pointer is per-instance of the stream,"]
#[doc = " so presumably it will change when calling duplicate(). This can be"]
#[doc = " deallocated during the destroy() method."]
pub opaque: *mut ::std::os::raw::c_void,
#[doc = " \\brief Read more data."]
#[doc = ""]
#[doc = " Read (len) bytes from the interface, at the current i/o position, and"]
#[doc = " store them in (buffer). The current i/o position should move ahead"]
#[doc = " by the number of bytes successfully read."]
#[doc = ""]
#[doc = " You don't have to implement this; set it to NULL if not implemented."]
#[doc = " This will only be used if the file is opened for reading. If set to"]
#[doc = " NULL, a default implementation that immediately reports failure will"]
#[doc = " be used."]
#[doc = ""]
#[doc = " \\param io The i/o instance to read from."]
#[doc = " \\param buf The buffer to store data into. It must be at least"]
#[doc = " (len) bytes long and can't be NULL."]
#[doc = " \\param len The number of bytes to read from the interface."]
#[doc = " \\return number of bytes read from file, 0 on EOF, -1 if complete"]
#[doc = " failure."]
pub read: ::std::option::Option<
unsafe extern "C" fn(
io: *mut PHYSFS_Io,
buf: *mut ::std::os::raw::c_void,
len: PHYSFS_uint64,
) -> PHYSFS_sint64,
>,
#[doc = " \\brief Write more data."]
#[doc = ""]
#[doc = " Write (len) bytes from (buffer) to the interface at the current i/o"]
#[doc = " position. The current i/o position should move ahead by the number of"]
#[doc = " bytes successfully written."]
#[doc = ""]
#[doc = " You don't have to implement this; set it to NULL if not implemented."]
#[doc = " This will only be used if the file is opened for writing. If set to"]
#[doc = " NULL, a default implementation that immediately reports failure will"]
#[doc = " be used."]
#[doc = ""]
#[doc = " You are allowed to buffer; a write can succeed here and then later"]
#[doc = " fail when flushing. Note that PHYSFS_setBuffer() may be operating a"]
#[doc = " level above your i/o, so you should usually not implement your"]
#[doc = " own buffering routines."]
#[doc = ""]
#[doc = " \\param io The i/o instance to write to."]
#[doc = " \\param buffer The buffer to read data from. It must be at least"]
#[doc = " (len) bytes long and can't be NULL."]
#[doc = " \\param len The number of bytes to read from (buffer)."]
#[doc = " \\return number of bytes written to file, -1 if complete failure."]
pub write: ::std::option::Option<
unsafe extern "C" fn(
io: *mut PHYSFS_Io,
buffer: *const ::std::os::raw::c_void,
len: PHYSFS_uint64,
) -> PHYSFS_sint64,
>,
#[doc = " \\brief Move i/o position to a given byte offset from start."]
#[doc = ""]
#[doc = " This method moves the i/o position, so the next read/write will"]
#[doc = " be of the byte at (offset) offset. Seeks past the end of file should"]
#[doc = " be treated as an error condition."]
#[doc = ""]
#[doc = " \\param io The i/o instance to seek."]
#[doc = " \\param offset The new byte offset for the i/o position."]
#[doc = " \\return non-zero on success, zero on error."]
pub seek: ::std::option::Option<
unsafe extern "C" fn(io: *mut PHYSFS_Io, offset: PHYSFS_uint64) -> ::std::os::raw::c_int,
>,
#[doc = " \\brief Report current i/o position."]
#[doc = ""]
#[doc = " Return bytes offset, or -1 if you aren't able to determine. A failure"]
#[doc = " will almost certainly be fatal to further use of this stream, so you"]
#[doc = " may not leave this unimplemented."]
#[doc = ""]
#[doc = " \\param io The i/o instance to query."]
#[doc = " \\return The current byte offset for the i/o position, -1 if unknown."]
pub tell: ::std::option::Option<unsafe extern "C" fn(io: *mut PHYSFS_Io) -> PHYSFS_sint64>,
#[doc = " \\brief Determine size of the i/o instance's dataset."]
#[doc = ""]
#[doc = " Return number of bytes available in the file, or -1 if you"]
#[doc = " aren't able to determine. A failure will almost certainly be fatal"]
#[doc = " to further use of this stream, so you may not leave this unimplemented."]
#[doc = ""]
#[doc = " \\param io The i/o instance to query."]
#[doc = " \\return Total size, in bytes, of the dataset."]
pub length: ::std::option::Option<unsafe extern "C" fn(io: *mut PHYSFS_Io) -> PHYSFS_sint64>,
#[doc = " \\brief Duplicate this i/o instance."]
#[doc = ""]
#[doc = " This needs to result in a full copy of this PHYSFS_Io, that can live"]
#[doc = " completely independently. The copy needs to be able to perform all"]
#[doc = " its operations without altering the original, including either object"]
#[doc = " being destroyed separately (so, for example: they can't share a file"]
#[doc = " handle; they each need their own)."]
#[doc = ""]
#[doc = " If you can't duplicate a handle, it's legal to return NULL, but you"]
#[doc = " almost certainly need this functionality if you want to use this to"]
#[doc = " PHYSFS_Io to back an archive."]
#[doc = ""]
#[doc = " \\param io The i/o instance to duplicate."]
#[doc = " \\return A new value for a stream's (opaque) field, or NULL on error."]
pub duplicate:
::std::option::Option<unsafe extern "C" fn(io: *mut PHYSFS_Io) -> *mut PHYSFS_Io>,
#[doc = " \\brief Flush resources to media, or wherever."]
#[doc = ""]
#[doc = " This is the chance to report failure for writes that had claimed"]
#[doc = " success earlier, but still had a chance to actually fail. This method"]
#[doc = " can be NULL if flushing isn't necessary."]
#[doc = ""]
#[doc = " This function may be called before destroy(), as it can report failure"]
#[doc = " and destroy() can not. It may be called at other times, too."]
#[doc = ""]
#[doc = " \\param io The i/o instance to flush."]
#[doc = " \\return Zero on error, non-zero on success."]
pub flush:
::std::option::Option<unsafe extern "C" fn(io: *mut PHYSFS_Io) -> ::std::os::raw::c_int>,
#[doc = " \\brief Cleanup and deallocate i/o instance."]
#[doc = ""]
#[doc = " Free associated resources, including (opaque) if applicable."]
#[doc = ""]
#[doc = " This function must always succeed: as such, it returns void. The"]
#[doc = " system may call your flush() method before this. You may report"]
#[doc = " failure there if necessary. This method may still be called if"]
#[doc = " flush() fails, in which case you'll have to abandon unflushed data"]
#[doc = " and other failing conditions and clean up."]
#[doc = ""]
#[doc = " Once this method is called for a given instance, the system will assume"]
#[doc = " it is unsafe to touch that instance again and will discard any"]
#[doc = " references to it."]
#[doc = ""]
#[doc = " \\param s The i/o instance to destroy."]
pub destroy: ::std::option::Option<unsafe extern "C" fn(io: *mut PHYSFS_Io)>,
}
#[test]
fn bindgen_test_layout_PHYSFS_Io() {
assert_eq!(
::std::mem::size_of::<PHYSFS_Io>(),
80usize,
concat!("Size of: ", stringify!(PHYSFS_Io))
);
assert_eq!(
::std::mem::align_of::<PHYSFS_Io>(),
8usize,
concat!("Alignment of ", stringify!(PHYSFS_Io))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Io>())).version as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Io),
"::",
stringify!(version)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Io>())).opaque as *const _ as usize },
8usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Io),
"::",
stringify!(opaque)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Io>())).read as *const _ as usize },
16usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Io),
"::",
stringify!(read)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Io>())).write as *const _ as usize },
24usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Io),
"::",
stringify!(write)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Io>())).seek as *const _ as usize },
32usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Io),
"::",
stringify!(seek)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Io>())).tell as *const _ as usize },
40usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Io),
"::",
stringify!(tell)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Io>())).length as *const _ as usize },
48usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Io),
"::",
stringify!(length)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Io>())).duplicate as *const _ as usize },
56usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Io),
"::",
stringify!(duplicate)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Io>())).flush as *const _ as usize },
64usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Io),
"::",
stringify!(flush)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Io>())).destroy as *const _ as usize },
72usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Io),
"::",
stringify!(destroy)
)
);
}
extern "C" {
#[doc = " \\fn int PHYSFS_mountIo(PHYSFS_Io *io, const char *newDir, const char *mountPoint, int appendToPath)"]
#[doc = " \\brief Add an archive, built on a PHYSFS_Io, to the search path."]
#[doc = ""]
#[doc = " \\warning Unless you have some special, low-level need, you should be using"]
#[doc = " PHYSFS_mount() instead of this."]
#[doc = ""]
#[doc = " This function operates just like PHYSFS_mount(), but takes a PHYSFS_Io"]
#[doc = " instead of a pathname. Behind the scenes, PHYSFS_mount() calls this"]
#[doc = " function with a physical-filesystem-based PHYSFS_Io."]
#[doc = ""]
#[doc = " (newDir) must be a unique string to identify this archive. It is used"]
#[doc = " to optimize archiver selection (if you name it XXXXX.zip, we might try"]
#[doc = " the ZIP archiver first, for example, or directly choose an archiver that"]
#[doc = " can only trust the data is valid by filename extension). It doesn't"]
#[doc = " need to refer to a real file at all. If the filename extension isn't"]
#[doc = " helpful, the system will try every archiver until one works or none"]
#[doc = " of them do. This filename must be unique, as the system won't allow you"]
#[doc = " to have two archives with the same name."]
#[doc = ""]
#[doc = " (io) must remain until the archive is unmounted. When the archive is"]
#[doc = " unmounted, the system will call (io)->destroy(io), which will give you"]
#[doc = " a chance to free your resources."]
#[doc = ""]
#[doc = " If this function fails, (io)->destroy(io) is not called."]
#[doc = ""]
#[doc = " \\param io i/o instance for archive to add to the path."]
#[doc = " \\param newDir Filename that can represent this stream."]
#[doc = " \\param mountPoint Location in the interpolated tree that this archive"]
#[doc = " will be \"mounted\", in platform-independent notation."]
#[doc = " NULL or \"\" is equivalent to \"/\"."]
#[doc = " \\param appendToPath nonzero to append to search path, zero to prepend."]
#[doc = " \\return nonzero if added to path, zero on failure (bogus archive, stream"]
#[doc = " i/o issue, etc). Use PHYSFS_getLastErrorCode() to obtain"]
#[doc = " the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_unmount"]
#[doc = " \\sa PHYSFS_getSearchPath"]
#[doc = " \\sa PHYSFS_getMountPoint"]
pub fn PHYSFS_mountIo(
io: *mut PHYSFS_Io,
newDir: *const ::std::os::raw::c_char,
mountPoint: *const ::std::os::raw::c_char,
appendToPath: ::std::os::raw::c_int,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_mountMemory(const void *buf, PHYSFS_uint64 len, void (*del)(void *), const char *newDir, const char *mountPoint, int appendToPath)"]
#[doc = " \\brief Add an archive, contained in a memory buffer, to the search path."]
#[doc = ""]
#[doc = " \\warning Unless you have some special, low-level need, you should be using"]
#[doc = " PHYSFS_mount() instead of this."]
#[doc = ""]
#[doc = " This function operates just like PHYSFS_mount(), but takes a memory buffer"]
#[doc = " instead of a pathname. This buffer contains all the data of the archive,"]
#[doc = " and is used instead of a real file in the physical filesystem."]
#[doc = ""]
#[doc = " (newDir) must be a unique string to identify this archive. It is used"]
#[doc = " to optimize archiver selection (if you name it XXXXX.zip, we might try"]
#[doc = " the ZIP archiver first, for example, or directly choose an archiver that"]
#[doc = " can only trust the data is valid by filename extension). It doesn't"]
#[doc = " need to refer to a real file at all. If the filename extension isn't"]
#[doc = " helpful, the system will try every archiver until one works or none"]
#[doc = " of them do. This filename must be unique, as the system won't allow you"]
#[doc = " to have two archives with the same name."]
#[doc = ""]
#[doc = " (ptr) must remain until the archive is unmounted. When the archive is"]
#[doc = " unmounted, the system will call (del)(ptr), which will notify you that"]
#[doc = " the system is done with the buffer, and give you a chance to free your"]
#[doc = " resources. (del) can be NULL, in which case the system will make no"]
#[doc = " attempt to free the buffer."]
#[doc = ""]
#[doc = " If this function fails, (del) is not called."]
#[doc = ""]
#[doc = " \\param buf Address of the memory buffer containing the archive data."]
#[doc = " \\param len Size of memory buffer, in bytes."]
#[doc = " \\param del A callback that triggers upon unmount. Can be NULL."]
#[doc = " \\param newDir Filename that can represent this stream."]
#[doc = " \\param mountPoint Location in the interpolated tree that this archive"]
#[doc = " will be \"mounted\", in platform-independent notation."]
#[doc = " NULL or \"\" is equivalent to \"/\"."]
#[doc = " \\param appendToPath nonzero to append to search path, zero to prepend."]
#[doc = " \\return nonzero if added to path, zero on failure (bogus archive, etc)."]
#[doc = " Use PHYSFS_getLastErrorCode() to obtain the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_unmount"]
#[doc = " \\sa PHYSFS_getSearchPath"]
#[doc = " \\sa PHYSFS_getMountPoint"]
pub fn PHYSFS_mountMemory(
buf: *const ::std::os::raw::c_void,
len: PHYSFS_uint64,
del: ::std::option::Option<unsafe extern "C" fn(arg1: *mut ::std::os::raw::c_void)>,
newDir: *const ::std::os::raw::c_char,
mountPoint: *const ::std::os::raw::c_char,
appendToPath: ::std::os::raw::c_int,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_mountHandle(PHYSFS_File *file, const char *newDir, const char *mountPoint, int appendToPath)"]
#[doc = " \\brief Add an archive, contained in a PHYSFS_File handle, to the search path."]
#[doc = ""]
#[doc = " \\warning Unless you have some special, low-level need, you should be using"]
#[doc = " PHYSFS_mount() instead of this."]
#[doc = ""]
#[doc = " \\warning Archives-in-archives may be very slow! While a PHYSFS_File can"]
#[doc = " seek even when the data is compressed, it may do so by rewinding"]
#[doc = " to the start and decompressing everything before the seek point."]
#[doc = " Normal archive usage may do a lot of seeking behind the scenes."]
#[doc = " As such, you might find normal archive usage extremely painful"]
#[doc = " if mounted this way. Plan accordingly: if you, say, have a"]
#[doc = " self-extracting .zip file, and want to mount something in it,"]
#[doc = " compress the contents of the inner archive and make sure the outer"]
#[doc = " .zip file doesn't compress the inner archive too."]
#[doc = ""]
#[doc = " This function operates just like PHYSFS_mount(), but takes a PHYSFS_File"]
#[doc = " handle instead of a pathname. This handle contains all the data of the"]
#[doc = " archive, and is used instead of a real file in the physical filesystem."]
#[doc = " The PHYSFS_File may be backed by a real file in the physical filesystem,"]
#[doc = " but isn't necessarily. The most popular use for this is likely to mount"]
#[doc = " archives stored inside other archives."]
#[doc = ""]
#[doc = " (newDir) must be a unique string to identify this archive. It is used"]
#[doc = " to optimize archiver selection (if you name it XXXXX.zip, we might try"]
#[doc = " the ZIP archiver first, for example, or directly choose an archiver that"]
#[doc = " can only trust the data is valid by filename extension). It doesn't"]
#[doc = " need to refer to a real file at all. If the filename extension isn't"]
#[doc = " helpful, the system will try every archiver until one works or none"]
#[doc = " of them do. This filename must be unique, as the system won't allow you"]
#[doc = " to have two archives with the same name."]
#[doc = ""]
#[doc = " (file) must remain until the archive is unmounted. When the archive is"]
#[doc = " unmounted, the system will call PHYSFS_close(file). If you need this"]
#[doc = " handle to survive, you will have to wrap this in a PHYSFS_Io and use"]
#[doc = " PHYSFS_mountIo() instead."]
#[doc = ""]
#[doc = " If this function fails, PHYSFS_close(file) is not called."]
#[doc = ""]
#[doc = " \\param file The PHYSFS_File handle containing archive data."]
#[doc = " \\param newDir Filename that can represent this stream."]
#[doc = " \\param mountPoint Location in the interpolated tree that this archive"]
#[doc = " will be \"mounted\", in platform-independent notation."]
#[doc = " NULL or \"\" is equivalent to \"/\"."]
#[doc = " \\param appendToPath nonzero to append to search path, zero to prepend."]
#[doc = " \\return nonzero if added to path, zero on failure (bogus archive, etc)."]
#[doc = " Use PHYSFS_getLastErrorCode() to obtain the specific error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_unmount"]
#[doc = " \\sa PHYSFS_getSearchPath"]
#[doc = " \\sa PHYSFS_getMountPoint"]
pub fn PHYSFS_mountHandle(
file: *mut PHYSFS_File,
newDir: *const ::std::os::raw::c_char,
mountPoint: *const ::std::os::raw::c_char,
appendToPath: ::std::os::raw::c_int,
) -> ::std::os::raw::c_int;
}
#[doc = "< Success; no error."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_OK: PHYSFS_ErrorCode = 0;
#[doc = "< Error not otherwise covered here."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_OTHER_ERROR: PHYSFS_ErrorCode = 1;
#[doc = "< Memory allocation failed."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_OUT_OF_MEMORY: PHYSFS_ErrorCode = 2;
#[doc = "< PhysicsFS is not initialized."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_NOT_INITIALIZED: PHYSFS_ErrorCode = 3;
#[doc = "< PhysicsFS is already initialized."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_IS_INITIALIZED: PHYSFS_ErrorCode = 4;
#[doc = "< Needed argv[0], but it is NULL."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_ARGV0_IS_NULL: PHYSFS_ErrorCode = 5;
#[doc = "< Operation or feature unsupported."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_UNSUPPORTED: PHYSFS_ErrorCode = 6;
#[doc = "< Attempted to access past end of file."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_PAST_EOF: PHYSFS_ErrorCode = 7;
#[doc = "< Files still open."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_FILES_STILL_OPEN: PHYSFS_ErrorCode = 8;
#[doc = "< Bad parameter passed to an function."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_INVALID_ARGUMENT: PHYSFS_ErrorCode = 9;
#[doc = "< Requested archive/dir not mounted."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_NOT_MOUNTED: PHYSFS_ErrorCode = 10;
#[doc = "< File (or whatever) not found."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_NOT_FOUND: PHYSFS_ErrorCode = 11;
#[doc = "< Symlink seen when not permitted."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_SYMLINK_FORBIDDEN: PHYSFS_ErrorCode = 12;
#[doc = "< No write dir has been specified."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_NO_WRITE_DIR: PHYSFS_ErrorCode = 13;
#[doc = "< Wrote to a file opened for reading."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_OPEN_FOR_READING: PHYSFS_ErrorCode = 14;
#[doc = "< Read from a file opened for writing."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_OPEN_FOR_WRITING: PHYSFS_ErrorCode = 15;
#[doc = "< Needed a file, got a directory (etc)."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_NOT_A_FILE: PHYSFS_ErrorCode = 16;
#[doc = "< Wrote to a read-only filesystem."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_READ_ONLY: PHYSFS_ErrorCode = 17;
#[doc = "< Corrupted data encountered."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_CORRUPT: PHYSFS_ErrorCode = 18;
#[doc = "< Infinite symbolic link loop."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_SYMLINK_LOOP: PHYSFS_ErrorCode = 19;
#[doc = "< i/o error (hardware failure, etc)."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_IO: PHYSFS_ErrorCode = 20;
#[doc = "< Permission denied."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_PERMISSION: PHYSFS_ErrorCode = 21;
#[doc = "< No space (disk full, over quota, etc)"]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_NO_SPACE: PHYSFS_ErrorCode = 22;
#[doc = "< Filename is bogus/insecure."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_BAD_FILENAME: PHYSFS_ErrorCode = 23;
#[doc = "< Tried to modify a file the OS needs."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_BUSY: PHYSFS_ErrorCode = 24;
#[doc = "< Tried to delete dir with files in it."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_DIR_NOT_EMPTY: PHYSFS_ErrorCode = 25;
#[doc = "< Unspecified OS-level error."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_OS_ERROR: PHYSFS_ErrorCode = 26;
#[doc = "< Duplicate entry."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_DUPLICATE: PHYSFS_ErrorCode = 27;
#[doc = "< Bad password."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_BAD_PASSWORD: PHYSFS_ErrorCode = 28;
#[doc = "< Application callback reported error."]
pub const PHYSFS_ErrorCode_PHYSFS_ERR_APP_CALLBACK: PHYSFS_ErrorCode = 29;
#[doc = " \\enum PHYSFS_ErrorCode"]
#[doc = " \\brief Values that represent specific causes of failure."]
#[doc = ""]
#[doc = " Most of the time, you should only concern yourself with whether a given"]
#[doc = " operation failed or not, but there may be occasions where you plan to"]
#[doc = " handle a specific failure case gracefully, so we provide specific error"]
#[doc = " codes."]
#[doc = ""]
#[doc = " Most of these errors are a little vague, and most aren't things you can"]
#[doc = " fix...if there's a permission error, for example, all you can really do"]
#[doc = " is pass that information on to the user and let them figure out how to"]
#[doc = " handle it. In most these cases, your program should only care that it"]
#[doc = " failed to accomplish its goals, and not care specifically why."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getLastErrorCode"]
#[doc = " \\sa PHYSFS_getErrorByCode"]
pub type PHYSFS_ErrorCode = u32;
extern "C" {
#[doc = " \\fn PHYSFS_ErrorCode PHYSFS_getLastErrorCode(void)"]
#[doc = " \\brief Get machine-readable error information."]
#[doc = ""]
#[doc = " Get the last PhysicsFS error message as an integer value. This will return"]
#[doc = " PHYSFS_ERR_OK if there's been no error since the last call to this"]
#[doc = " function. Each thread has a unique error state associated with it, but"]
#[doc = " each time a new error message is set, it will overwrite the previous one"]
#[doc = " associated with that thread. It is safe to call this function at anytime,"]
#[doc = " even before PHYSFS_init()."]
#[doc = ""]
#[doc = " PHYSFS_getLastError() and PHYSFS_getLastErrorCode() both reset the same"]
#[doc = " thread-specific error state. Calling one will wipe out the other's"]
#[doc = " data. If you need both, call PHYSFS_getLastErrorCode(), then pass that"]
#[doc = " value to PHYSFS_getErrorByCode()."]
#[doc = ""]
#[doc = " Generally, applications should only concern themselves with whether a"]
#[doc = " given function failed; however, if you require more specifics, you can"]
#[doc = " try this function to glean information, if there's some specific problem"]
#[doc = " you're expecting and plan to handle. But with most things that involve"]
#[doc = " file systems, the best course of action is usually to give up, report the"]
#[doc = " problem to the user, and let them figure out what should be done about it."]
#[doc = " For that, you might prefer PHYSFS_getErrorByCode() instead."]
#[doc = ""]
#[doc = " \\return Enumeration value that represents last reported error."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getErrorByCode"]
pub fn PHYSFS_getLastErrorCode() -> PHYSFS_ErrorCode;
}
extern "C" {
#[doc = " \\fn const char *PHYSFS_getErrorByCode(PHYSFS_ErrorCode code)"]
#[doc = " \\brief Get human-readable description string for a given error code."]
#[doc = ""]
#[doc = " Get a static string, in UTF-8 format, that represents an English"]
#[doc = " description of a given error code."]
#[doc = ""]
#[doc = " This string is guaranteed to never change (although we may add new strings"]
#[doc = " for new error codes in later versions of PhysicsFS), so you can use it"]
#[doc = " for keying a localization dictionary."]
#[doc = ""]
#[doc = " It is safe to call this function at anytime, even before PHYSFS_init()."]
#[doc = ""]
#[doc = " These strings are meant to be passed on directly to the user."]
#[doc = " Generally, applications should only concern themselves with whether a"]
#[doc = " given function failed, but not care about the specifics much."]
#[doc = ""]
#[doc = " Do not attempt to free the returned strings; they are read-only and you"]
#[doc = " don't own their memory pages."]
#[doc = ""]
#[doc = " \\param code Error code to convert to a string."]
#[doc = " \\return READ ONLY string of requested error message, NULL if this"]
#[doc = " is not a valid PhysicsFS error code. Always check for NULL if"]
#[doc = " you might be looking up an error code that didn't exist in an"]
#[doc = " earlier version of PhysicsFS."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getLastErrorCode"]
pub fn PHYSFS_getErrorByCode(code: PHYSFS_ErrorCode) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " \\fn void PHYSFS_setErrorCode(PHYSFS_ErrorCode code)"]
#[doc = " \\brief Set the current thread's error code."]
#[doc = ""]
#[doc = " This lets you set the value that will be returned by the next call to"]
#[doc = " PHYSFS_getLastErrorCode(). This will replace any existing error code,"]
#[doc = " whether set by your application or internally by PhysicsFS."]
#[doc = ""]
#[doc = " Error codes are stored per-thread; what you set here will not be"]
#[doc = " accessible to another thread."]
#[doc = ""]
#[doc = " Any call into PhysicsFS may change the current error code, so any code you"]
#[doc = " set here is somewhat fragile, and thus you shouldn't build any serious"]
#[doc = " error reporting framework on this function. The primary goal of this"]
#[doc = " function is to allow PHYSFS_Io implementations to set the error state,"]
#[doc = " which generally will be passed back to your application when PhysicsFS"]
#[doc = " makes a PHYSFS_Io call that fails internally."]
#[doc = ""]
#[doc = " This function doesn't care if the error code is a value known to PhysicsFS"]
#[doc = " or not (but PHYSFS_getErrorByCode() will return NULL for unknown values)."]
#[doc = " The value will be reported unmolested by PHYSFS_getLastErrorCode()."]
#[doc = ""]
#[doc = " \\param code Error code to become the current thread's new error state."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getLastErrorCode"]
#[doc = " \\sa PHYSFS_getErrorByCode"]
pub fn PHYSFS_setErrorCode(code: PHYSFS_ErrorCode);
}
extern "C" {
#[doc = " \\fn const char *PHYSFS_getPrefDir(const char *org, const char *app)"]
#[doc = " \\brief Get the user-and-app-specific path where files can be written."]
#[doc = ""]
#[doc = " Helper function."]
#[doc = ""]
#[doc = " Get the \"pref dir\". This is meant to be where users can write personal"]
#[doc = " files (preferences and save games, etc) that are specific to your"]
#[doc = " application. This directory is unique per user, per application."]
#[doc = ""]
#[doc = " This function will decide the appropriate location in the native filesystem,"]
#[doc = " create the directory if necessary, and return a string in"]
#[doc = " platform-dependent notation, suitable for passing to PHYSFS_setWriteDir()."]
#[doc = ""]
#[doc = " On Windows, this might look like:"]
#[doc = " \"C:\\\\Users\\\\bob\\\\AppData\\\\Roaming\\\\My Company\\\\My Program Name\""]
#[doc = ""]
#[doc = " On Linux, this might look like:"]
#[doc = " \"/home/bob/.local/share/My Program Name\""]
#[doc = ""]
#[doc = " On Mac OS X, this might look like:"]
#[doc = " \"/Users/bob/Library/Application Support/My Program Name\""]
#[doc = ""]
#[doc = " (etc.)"]
#[doc = ""]
#[doc = " You should probably use the pref dir for your write dir, and also put it"]
#[doc = " near the beginning of your search path. Older versions of PhysicsFS"]
#[doc = " offered only PHYSFS_getUserDir() and left you to figure out where the"]
#[doc = " files should go under that tree. This finds the correct location"]
#[doc = " for whatever platform, which not only changes between operating systems,"]
#[doc = " but also versions of the same operating system."]
#[doc = ""]
#[doc = " You specify the name of your organization (if it's not a real organization,"]
#[doc = " your name or an Internet domain you own might do) and the name of your"]
#[doc = " application. These should be proper names."]
#[doc = ""]
#[doc = " Both the (org) and (app) strings may become part of a directory name, so"]
#[doc = " please follow these rules:"]
#[doc = ""]
#[doc = " - Try to use the same org string (including case-sensitivity) for"]
#[doc = " all your applications that use this function."]
#[doc = " - Always use a unique app string for each one, and make sure it never"]
#[doc = " changes for an app once you've decided on it."]
#[doc = " - Unicode characters are legal, as long as it's UTF-8 encoded, but..."]
#[doc = " - ...only use letters, numbers, and spaces. Avoid punctuation like"]
#[doc = " \"Game Name 2: Bad Guy's Revenge!\" ... \"Game Name 2\" is sufficient."]
#[doc = ""]
#[doc = " The pointer returned by this function remains valid until you call this"]
#[doc = " function again, or call PHYSFS_deinit(). This is not necessarily a fast"]
#[doc = " call, though, so you should call this once at startup and copy the string"]
#[doc = " if you need it."]
#[doc = ""]
#[doc = " You should assume the path returned by this function is the only safe"]
#[doc = " place to write files (and that PHYSFS_getUserDir() and PHYSFS_getBaseDir(),"]
#[doc = " while they might be writable, or even parents of the returned path, aren't"]
#[doc = " where you should be writing things)."]
#[doc = ""]
#[doc = " \\param org The name of your organization."]
#[doc = " \\param app The name of your application."]
#[doc = " \\return READ ONLY string of user dir in platform-dependent notation. NULL"]
#[doc = " if there's a problem (creating directory failed, etc)."]
#[doc = ""]
#[doc = " \\sa PHYSFS_getBaseDir"]
#[doc = " \\sa PHYSFS_getUserDir"]
pub fn PHYSFS_getPrefDir(
org: *const ::std::os::raw::c_char,
app: *const ::std::os::raw::c_char,
) -> *const ::std::os::raw::c_char;
}
#[doc = " \\struct PHYSFS_Archiver"]
#[doc = " \\brief Abstract interface to provide support for user-defined archives."]
#[doc = ""]
#[doc = " \\warning This is advanced, hardcore stuff. You don't need this unless you"]
#[doc = " really know what you're doing. Most apps will not need this."]
#[doc = ""]
#[doc = " Historically, PhysicsFS provided a means to mount various archive file"]
#[doc = " formats, and physical directories in the native filesystem. However,"]
#[doc = " applications have been limited to the file formats provided by the"]
#[doc = " library. This interface allows an application to provide their own"]
#[doc = " archive file types."]
#[doc = ""]
#[doc = " Conceptually, a PHYSFS_Archiver provides directory entries, while"]
#[doc = " PHYSFS_Io provides data streams for those directory entries. The most"]
#[doc = " obvious use of PHYSFS_Archiver is to provide support for an archive"]
#[doc = " file type that isn't provided by PhysicsFS directly: perhaps some"]
#[doc = " proprietary format that only your application needs to understand."]
#[doc = ""]
#[doc = " Internally, all the built-in archive support uses this interface, so the"]
#[doc = " best examples for building a PHYSFS_Archiver is the source code to"]
#[doc = " PhysicsFS itself."]
#[doc = ""]
#[doc = " An archiver is added to the system with PHYSFS_registerArchiver(), and then"]
#[doc = " it will be available for use automatically with PHYSFS_mount(); if a"]
#[doc = " given archive can be handled with your archiver, it will be given control"]
#[doc = " as appropriate."]
#[doc = ""]
#[doc = " These methods deal with dir handles. You have one instance of your"]
#[doc = " archiver, and it generates a unique, opaque handle for each opened"]
#[doc = " archive in its openArchive() method. Since the lifetime of an Archiver"]
#[doc = " (not an archive) is generally the entire lifetime of the process, and it's"]
#[doc = " assumed to be a singleton, we do not provide any instance data for the"]
#[doc = " archiver itself; the app can just use some static variables if necessary."]
#[doc = ""]
#[doc = " Symlinks should always be followed (except in stat()); PhysicsFS will"]
#[doc = " use the stat() method to check for symlinks and make a judgement on"]
#[doc = " whether to continue to call other methods based on that."]
#[doc = ""]
#[doc = " Archivers, when necessary, should set the PhysicsFS error state with"]
#[doc = " PHYSFS_setErrorCode() before returning. PhysicsFS will pass these errors"]
#[doc = " back to the application unmolested in most cases."]
#[doc = ""]
#[doc = " Thread safety: PHYSFS_Archiver implementations are not guaranteed to be"]
#[doc = " thread safe in themselves. PhysicsFS provides thread safety when it calls"]
#[doc = " into a given archiver inside the library, but it does not promise that"]
#[doc = " using the same PHYSFS_File from two threads at once is thread-safe; as"]
#[doc = " such, your PHYSFS_Archiver can assume that locking is handled for you"]
#[doc = " so long as the PHYSFS_Io you return from PHYSFS_open* doesn't change any"]
#[doc = " of your Archiver state, as the PHYSFS_Io won't be as aggressively"]
#[doc = " protected."]
#[doc = ""]
#[doc = " \\sa PHYSFS_registerArchiver"]
#[doc = " \\sa PHYSFS_deregisterArchiver"]
#[doc = " \\sa PHYSFS_supportedArchiveTypes"]
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct PHYSFS_Archiver {
#[doc = " \\brief Binary compatibility information."]
#[doc = ""]
#[doc = " This must be set to zero at this time. Future versions of this"]
#[doc = " struct will increment this field, so we know what a given"]
#[doc = " implementation supports. We'll presumably keep supporting older"]
#[doc = " versions as we offer new features, though."]
pub version: PHYSFS_uint32,
#[doc = " \\brief Basic info about this archiver."]
#[doc = ""]
#[doc = " This is used to identify your archive, and is returned in"]
#[doc = " PHYSFS_supportedArchiveTypes()."]
pub info: PHYSFS_ArchiveInfo,
#[doc = " \\brief Open an archive provided by (io)."]
#[doc = ""]
#[doc = " This is where resources are allocated and data is parsed when mounting"]
#[doc = " an archive."]
#[doc = " (name) is a filename associated with (io), but doesn't necessarily"]
#[doc = " map to anything, let alone a real filename. This possibly-"]
#[doc = " meaningless name is in platform-dependent notation."]
#[doc = " (forWrite) is non-zero if this is to be used for"]
#[doc = " the write directory, and zero if this is to be used for an"]
#[doc = " element of the search path."]
#[doc = " (claimed) should be set to 1 if this is definitely an archive your"]
#[doc = " archiver implementation can handle, even if it fails. We use to"]
#[doc = " decide if we should stop trying other archivers if you fail to open"]
#[doc = " it. For example: the .zip archiver will set this to 1 for something"]
#[doc = " that's got a .zip file signature, even if it failed because the file"]
#[doc = " was also truncated. No sense in trying other archivers here, we"]
#[doc = " already tried to handle it with the appropriate implementation!."]
#[doc = " Return NULL on failure and set (claimed) appropriately. If no archiver"]
#[doc = " opened the archive or set (claimed), PHYSFS_mount() will report"]
#[doc = " PHYSFS_ERR_UNSUPPORTED. Otherwise, it will report the error from the"]
#[doc = " archiver that claimed the data through (claimed)."]
#[doc = " Return non-NULL on success. The pointer returned will be"]
#[doc = " passed as the \"opaque\" parameter for later calls."]
pub openArchive: ::std::option::Option<
unsafe extern "C" fn(
io: *mut PHYSFS_Io,
name: *const ::std::os::raw::c_char,
forWrite: ::std::os::raw::c_int,
claimed: *mut ::std::os::raw::c_int,
) -> *mut ::std::os::raw::c_void,
>,
#[doc = " \\brief List all files in (dirname)."]
#[doc = ""]
#[doc = " Each file is passed to (cb), where a copy is made if appropriate, so"]
#[doc = " you can dispose of it upon return from the callback. (dirname) is in"]
#[doc = " platform-independent notation."]
#[doc = " If you have a failure, call PHYSFS_SetErrorCode() with whatever code"]
#[doc = " seem appropriate and return PHYSFS_ENUM_ERROR."]
#[doc = " If the callback returns PHYSFS_ENUM_ERROR, please call"]
#[doc = " PHYSFS_SetErrorCode(PHYSFS_ERR_APP_CALLBACK) and then return"]
#[doc = " PHYSFS_ENUM_ERROR as well. Don't call the callback again in any"]
#[doc = " circumstances."]
#[doc = " If the callback returns PHYSFS_ENUM_STOP, stop enumerating and return"]
#[doc = " PHYSFS_ENUM_STOP as well. Don't call the callback again in any"]
#[doc = " circumstances. Don't set an error code in this case."]
#[doc = " Callbacks are only supposed to return a value from"]
#[doc = " PHYSFS_EnumerateCallbackResult. Any other result has undefined"]
#[doc = " behavior."]
#[doc = " As long as the callback returned PHYSFS_ENUM_OK and you haven't"]
#[doc = " experienced any errors of your own, keep enumerating until you're done"]
#[doc = " and then return PHYSFS_ENUM_OK without setting an error code."]
#[doc = ""]
#[doc = " \\warning PHYSFS_enumerate returns zero or non-zero (success or failure),"]
#[doc = " so be aware this function pointer returns different values!"]
pub enumerate: ::std::option::Option<
unsafe extern "C" fn(
opaque: *mut ::std::os::raw::c_void,
dirname: *const ::std::os::raw::c_char,
cb: PHYSFS_EnumerateCallback,
origdir: *const ::std::os::raw::c_char,
callbackdata: *mut ::std::os::raw::c_void,
) -> PHYSFS_EnumerateCallbackResult,
>,
#[doc = " \\brief Open a file in this archive for reading."]
#[doc = ""]
#[doc = " This filename, (fnm), is in platform-independent notation."]
#[doc = " Fail if the file does not exist."]
#[doc = " Returns NULL on failure, and calls PHYSFS_setErrorCode()."]
#[doc = " Returns non-NULL on success. The pointer returned will be"]
#[doc = " passed as the \"opaque\" parameter for later file calls."]
pub openRead: ::std::option::Option<
unsafe extern "C" fn(
opaque: *mut ::std::os::raw::c_void,
fnm: *const ::std::os::raw::c_char,
) -> *mut PHYSFS_Io,
>,
#[doc = " \\brief Open a file in this archive for writing."]
#[doc = ""]
#[doc = " If the file does not exist, it should be created. If it exists,"]
#[doc = " it should be truncated to zero bytes. The writing offset should"]
#[doc = " be the start of the file."]
#[doc = " If the archive is read-only, this operation should fail."]
#[doc = " This filename is in platform-independent notation."]
#[doc = " Returns NULL on failure, and calls PHYSFS_setErrorCode()."]
#[doc = " Returns non-NULL on success. The pointer returned will be"]
#[doc = " passed as the \"opaque\" parameter for later file calls."]
pub openWrite: ::std::option::Option<
unsafe extern "C" fn(
opaque: *mut ::std::os::raw::c_void,
filename: *const ::std::os::raw::c_char,
) -> *mut PHYSFS_Io,
>,
#[doc = " \\brief Open a file in this archive for appending."]
#[doc = ""]
#[doc = " If the file does not exist, it should be created. The writing"]
#[doc = " offset should be the end of the file."]
#[doc = " If the archive is read-only, this operation should fail."]
#[doc = " This filename is in platform-independent notation."]
#[doc = " Returns NULL on failure, and calls PHYSFS_setErrorCode()."]
#[doc = " Returns non-NULL on success. The pointer returned will be"]
#[doc = " passed as the \"opaque\" parameter for later file calls."]
pub openAppend: ::std::option::Option<
unsafe extern "C" fn(
opaque: *mut ::std::os::raw::c_void,
filename: *const ::std::os::raw::c_char,
) -> *mut PHYSFS_Io,
>,
#[doc = " \\brief Delete a file or directory in the archive."]
#[doc = ""]
#[doc = " This same call is used for both files and directories; there is not a"]
#[doc = " separate rmdir() call. Directories are only meant to be removed if"]
#[doc = " they are empty."]
#[doc = " If the archive is read-only, this operation should fail."]
#[doc = ""]
#[doc = " Return non-zero on success, zero on failure."]
#[doc = " This filename is in platform-independent notation."]
#[doc = " On failure, call PHYSFS_setErrorCode()."]
pub remove: ::std::option::Option<
unsafe extern "C" fn(
opaque: *mut ::std::os::raw::c_void,
filename: *const ::std::os::raw::c_char,
) -> ::std::os::raw::c_int,
>,
#[doc = " \\brief Create a directory in the archive."]
#[doc = ""]
#[doc = " If the application is trying to make multiple dirs, PhysicsFS"]
#[doc = " will split them up into multiple calls before passing them to"]
#[doc = " your driver."]
#[doc = " If the archive is read-only, this operation should fail."]
#[doc = " Return non-zero on success, zero on failure."]
#[doc = " This filename is in platform-independent notation."]
#[doc = " On failure, call PHYSFS_setErrorCode()."]
pub mkdir: ::std::option::Option<
unsafe extern "C" fn(
opaque: *mut ::std::os::raw::c_void,
filename: *const ::std::os::raw::c_char,
) -> ::std::os::raw::c_int,
>,
#[doc = " \\brief Obtain basic file metadata."]
#[doc = ""]
#[doc = " On success, fill in all the fields in (stat), using"]
#[doc = " reasonable defaults for fields that apply to your archive."]
#[doc = ""]
#[doc = " Returns non-zero on success, zero on failure."]
#[doc = " This filename is in platform-independent notation."]
#[doc = " On failure, call PHYSFS_setErrorCode()."]
pub stat: ::std::option::Option<
unsafe extern "C" fn(
opaque: *mut ::std::os::raw::c_void,
fn_: *const ::std::os::raw::c_char,
stat: *mut PHYSFS_Stat,
) -> ::std::os::raw::c_int,
>,
#[doc = " \\brief Destruct a previously-opened archive."]
#[doc = ""]
#[doc = " Close this archive, and free any associated memory,"]
#[doc = " including the original PHYSFS_Io and (opaque) itself, if"]
#[doc = " applicable. Implementation can assume that it won't be called if"]
#[doc = " there are still files open from this archive."]
pub closeArchive:
::std::option::Option<unsafe extern "C" fn(opaque: *mut ::std::os::raw::c_void)>,
}
#[test]
fn bindgen_test_layout_PHYSFS_Archiver() {
assert_eq!(
::std::mem::size_of::<PHYSFS_Archiver>(),
120usize,
concat!("Size of: ", stringify!(PHYSFS_Archiver))
);
assert_eq!(
::std::mem::align_of::<PHYSFS_Archiver>(),
8usize,
concat!("Alignment of ", stringify!(PHYSFS_Archiver))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Archiver>())).version as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Archiver),
"::",
stringify!(version)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Archiver>())).info as *const _ as usize },
8usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Archiver),
"::",
stringify!(info)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Archiver>())).openArchive as *const _ as usize },
48usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Archiver),
"::",
stringify!(openArchive)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Archiver>())).enumerate as *const _ as usize },
56usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Archiver),
"::",
stringify!(enumerate)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Archiver>())).openRead as *const _ as usize },
64usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Archiver),
"::",
stringify!(openRead)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Archiver>())).openWrite as *const _ as usize },
72usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Archiver),
"::",
stringify!(openWrite)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Archiver>())).openAppend as *const _ as usize },
80usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Archiver),
"::",
stringify!(openAppend)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Archiver>())).remove as *const _ as usize },
88usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Archiver),
"::",
stringify!(remove)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Archiver>())).mkdir as *const _ as usize },
96usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Archiver),
"::",
stringify!(mkdir)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Archiver>())).stat as *const _ as usize },
104usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Archiver),
"::",
stringify!(stat)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<PHYSFS_Archiver>())).closeArchive as *const _ as usize },
112usize,
concat!(
"Offset of field: ",
stringify!(PHYSFS_Archiver),
"::",
stringify!(closeArchive)
)
);
}
extern "C" {
#[doc = " \\fn int PHYSFS_registerArchiver(const PHYSFS_Archiver *archiver)"]
#[doc = " \\brief Add a new archiver to the system."]
#[doc = ""]
#[doc = " \\warning This is advanced, hardcore stuff. You don't need this unless you"]
#[doc = " really know what you're doing. Most apps will not need this."]
#[doc = ""]
#[doc = " If you want to provide your own archiver (for example, a custom archive"]
#[doc = " file format, or some virtual thing you want to make look like a filesystem"]
#[doc = " that you can access through the usual PhysicsFS APIs), this is where you"]
#[doc = " start. Once an archiver is successfully registered, then you can use"]
#[doc = " PHYSFS_mount() to add archives that your archiver supports to the"]
#[doc = " search path, or perhaps use it as the write dir. Internally, PhysicsFS"]
#[doc = " uses this function to register its own built-in archivers, like .zip"]
#[doc = " support, etc."]
#[doc = ""]
#[doc = " You may not have two archivers that handle the same extension. If you are"]
#[doc = " going to have a clash, you can deregister the other archiver (including"]
#[doc = " built-in ones) with PHYSFS_deregisterArchiver()."]
#[doc = ""]
#[doc = " The data in (archiver) is copied; you may free this pointer when this"]
#[doc = " function returns."]
#[doc = ""]
#[doc = " Once this function returns successfully, PhysicsFS will be able to support"]
#[doc = " archives of this type until you deregister the archiver again."]
#[doc = ""]
#[doc = " \\param archiver The archiver to register."]
#[doc = " \\return Zero on error, non-zero on success."]
#[doc = ""]
#[doc = " \\sa PHYSFS_Archiver"]
#[doc = " \\sa PHYSFS_deregisterArchiver"]
pub fn PHYSFS_registerArchiver(archiver: *const PHYSFS_Archiver) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " \\fn int PHYSFS_deregisterArchiver(const char *ext)"]
#[doc = " \\brief Remove an archiver from the system."]
#[doc = ""]
#[doc = " If for some reason, you only need your previously-registered archiver to"]
#[doc = " live for a portion of your app's lifetime, you can remove it from the"]
#[doc = " system once you're done with it through this function."]
#[doc = ""]
#[doc = " This fails if there are any archives still open that use this archiver."]
#[doc = ""]
#[doc = " This function can also remove internally-supplied archivers, like .zip"]
#[doc = " support or whatnot. This could be useful in some situations, like"]
#[doc = " disabling support for them outright or overriding them with your own"]
#[doc = " implementation. Once an internal archiver is disabled like this,"]
#[doc = " PhysicsFS provides no mechanism to recover them, short of calling"]
#[doc = " PHYSFS_deinit() and PHYSFS_init() again."]
#[doc = ""]
#[doc = " PHYSFS_deinit() will automatically deregister all archivers, so you don't"]
#[doc = " need to explicitly deregister yours if you otherwise shut down cleanly."]
#[doc = ""]
#[doc = " \\param ext Filename extension that the archiver handles."]
#[doc = " \\return Zero on error, non-zero on success."]
#[doc = ""]
#[doc = " \\sa PHYSFS_Archiver"]
#[doc = " \\sa PHYSFS_registerArchiver"]
pub fn PHYSFS_deregisterArchiver(ext: *const ::std::os::raw::c_char) -> ::std::os::raw::c_int;
}