1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
*
* Purpose: Generic Property Functions
*/
/****************/
/* Module Setup */
/****************/
#define H5P_PACKAGE /*suppress error about including H5Ppkg */
/* Interface initialization */
#define H5_INTERFACE_INIT_FUNC H5P_init_interface
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5FLprivate.h" /* Free lists */
#include "H5Iprivate.h" /* IDs */
#include "H5MMprivate.h" /* Memory management */
#include "H5Ppkg.h" /* Property lists */
/****************/
/* Local Macros */
/****************/
/* Async. I/O properties */
#define H5P_ASYNC_FLAG_SIZE sizeof(hbool_t)
#define H5P_ASYNC_REQ_SIZE sizeof(void *)
#define H5P_ASYNC_REQ_DEF NULL
/******************/
/* Local Typedefs */
/******************/
/* Typedef for checking for duplicate class names in parent class */
typedef struct {
const H5P_genclass_t *parent; /* Pointer to parent class */
const char *name; /* Pointer to name to check */
H5P_genclass_t *new_class; /* Pointer to class during path traversal */
} H5P_check_class_t;
/* Typedef for property list iterator callback */
typedef struct {
H5P_iterate_int_t cb_func; /* Iterator callback */
void *udata; /* Iterator callback pointer */
const H5P_genplist_t *plist; /* Property list pointer */
H5SL_t *seen; /* Skip list to hold names of properties already seen */
int *curr_idx_ptr; /* Pointer to current iteration index */
int prev_idx; /* Previous iteration index */
} H5P_iter_plist_ud_t;
/* Typedef for property list class iterator callback */
typedef struct {
H5P_iterate_int_t cb_func; /* Iterator callback */
void *udata; /* Iterator callback pointer */
int *curr_idx_ptr; /* Pointer to current iteration index */
int prev_idx; /* Previous iteration index */
} H5P_iter_pclass_ud_t;
/* Typedef for property list comparison callback */
typedef struct {
const H5P_genplist_t *plist2; /* Pointer to second property list */
int cmp_value; /* Value from property comparison */
} H5P_plist_cmp_ud_t;
/********************/
/* Local Prototypes */
/********************/
/* General helper routines */
static H5P_genprop_t *H5P_dup_prop(H5P_genprop_t *oprop, H5P_prop_within_t type);
static herr_t H5P_free_prop(H5P_genprop_t *prop);
static int H5P_cmp_prop(const H5P_genprop_t *prop1, const H5P_genprop_t *prop2);
/* Property class callbacks */
static herr_t H5P__root_reg_prop(H5P_genclass_t *pclass);
/*********************/
/* Package Variables */
/*********************/
/*
* Predefined property list classes. These are initialized at runtime by
* H5P_init_interface() in this source file.
*/
hid_t H5P_CLS_ROOT_g = FAIL;
hid_t H5P_CLS_OBJECT_CREATE_g = FAIL;
hid_t H5P_CLS_FILE_CREATE_g = FAIL;
hid_t H5P_CLS_FILE_ACCESS_g = FAIL;
hid_t H5P_CLS_DATASET_CREATE_g = FAIL;
hid_t H5P_CLS_DATASET_ACCESS_g = FAIL;
hid_t H5P_CLS_DATASET_XFER_g = FAIL;
hid_t H5P_CLS_FILE_MOUNT_g = FAIL;
hid_t H5P_CLS_GROUP_CREATE_g = FAIL;
hid_t H5P_CLS_GROUP_ACCESS_g = FAIL;
hid_t H5P_CLS_DATATYPE_CREATE_g = FAIL;
hid_t H5P_CLS_DATATYPE_ACCESS_g = FAIL;
hid_t H5P_CLS_ATTRIBUTE_CREATE_g = FAIL;
hid_t H5P_CLS_OBJECT_COPY_g = FAIL;
hid_t H5P_CLS_LINK_CREATE_g = FAIL;
hid_t H5P_CLS_LINK_ACCESS_g = FAIL;
hid_t H5P_CLS_STRING_CREATE_g = FAIL;
hid_t H5P_CLS_READ_CONTEXT_ACQUIRE_g = FAIL;
hid_t H5P_CLS_TRANSACTION_START_g = FAIL;
hid_t H5P_CLS_TRANSACTION_FINISH_g = FAIL;
/*
* Predefined property lists for each predefined class. These are initialized
* at runtime by H5P_init_interface() in this source file.
*/
hid_t H5P_LST_FILE_CREATE_g = FAIL;
hid_t H5P_LST_FILE_ACCESS_g = FAIL;
hid_t H5P_LST_DATASET_CREATE_g = FAIL;
hid_t H5P_LST_DATASET_ACCESS_g = FAIL;
hid_t H5P_LST_DATASET_XFER_g = FAIL;
hid_t H5P_LST_FILE_MOUNT_g = FAIL;
hid_t H5P_LST_GROUP_CREATE_g = FAIL;
hid_t H5P_LST_GROUP_ACCESS_g = FAIL;
hid_t H5P_LST_DATATYPE_CREATE_g = FAIL;
hid_t H5P_LST_DATATYPE_ACCESS_g = FAIL;
hid_t H5P_LST_ATTRIBUTE_CREATE_g = FAIL;
hid_t H5P_LST_OBJECT_COPY_g = FAIL;
hid_t H5P_LST_LINK_CREATE_g = FAIL;
hid_t H5P_LST_LINK_ACCESS_g = FAIL;
hid_t H5P_LST_READ_CONTEXT_ACQUIRE_g = FAIL;
hid_t H5P_LST_TRANSACTION_START_g = FAIL;
hid_t H5P_LST_TRANSACTION_FINISH_g = FAIL;
/* Root property list class library initialization object */
const H5P_libclass_t H5P_CLS_ROOT[1] = {{
"root", /* Class name for debugging */
H5P_TYPE_ROOT, /* Class type */
NULL, /* Parent class ID */
&H5P_CLS_ROOT_g, /* Pointer to class ID */
NULL, /* Pointer to default property list ID */
H5P__root_reg_prop, /* Default property registration routine */
NULL, /* Class creation callback */
NULL, /* Class creation callback info */
NULL, /* Class copy callback */
NULL, /* Class copy callback info */
NULL, /* Class close callback */
NULL /* Class close callback info */
}};
/* Group access property list class library initialization object */
/* (move to proper source code file when used for real) */
const H5P_libclass_t H5P_CLS_GACC[1] = {{
"group access", /* Class name for debugging */
H5P_TYPE_GROUP_ACCESS, /* Class type */
&H5P_CLS_LINK_ACCESS_g, /* Parent class ID */
&H5P_CLS_GROUP_ACCESS_g, /* Pointer to class ID */
&H5P_LST_GROUP_ACCESS_g, /* Pointer to default property list ID */
NULL, /* Default property registration routine */
NULL, /* Class creation callback */
NULL, /* Class creation callback info */
NULL, /* Class copy callback */
NULL, /* Class copy callback info */
NULL, /* Class close callback */
NULL /* Class close callback info */
}};
/* Datatype creation property list class library initialization object */
/* (move to proper source code file when used for real) */
const H5P_libclass_t H5P_CLS_TCRT[1] = {{
"datatype create", /* Class name for debugging */
H5P_TYPE_DATATYPE_CREATE, /* Class type */
&H5P_CLS_OBJECT_CREATE_g, /* Parent class ID */
&H5P_CLS_DATATYPE_CREATE_g, /* Pointer to class ID */
&H5P_LST_DATATYPE_CREATE_g, /* Pointer to default property list ID */
NULL, /* Default property registration routine */
NULL, /* Class creation callback */
NULL, /* Class creation callback info */
NULL, /* Class copy callback */
NULL, /* Class copy callback info */
NULL, /* Class close callback */
NULL /* Class close callback info */
}};
/* Datatype access property list class library initialization object */
/* (move to proper source code file when used for real) */
const H5P_libclass_t H5P_CLS_TACC[1] = {{
"datatype access", /* Class name for debugging */
H5P_TYPE_DATATYPE_ACCESS, /* Class type */
&H5P_CLS_LINK_ACCESS_g, /* Parent class ID */
&H5P_CLS_DATATYPE_ACCESS_g, /* Pointer to class ID */
&H5P_LST_DATATYPE_ACCESS_g, /* Pointer to default property list ID */
NULL, /* Default property registration routine */
NULL, /* Class creation callback */
NULL, /* Class creation callback info */
NULL, /* Class copy callback */
NULL, /* Class copy callback info */
NULL, /* Class close callback */
NULL /* Class close callback info */
}};
/* Transaction finish property list class library initialization object */
/* (move to proper source code file when used for real) */
const H5P_libclass_t H5P_CLS_TRFCC[1] = {{
"transaction finish", /* Class name for debugging */
H5P_TYPE_TRANSACTION_FINISH, /* Class type */
&H5P_CLS_ROOT_g, /* Parent class ID */
&H5P_CLS_TRANSACTION_FINISH_g, /* Pointer to class ID */
&H5P_LST_TRANSACTION_FINISH_g, /* Pointer to default property list ID */
NULL, /* Default property registration routine */
NULL, /* Class creation callback */
NULL, /* Class creation callback info */
NULL, /* Class copy callback */
NULL, /* Class copy callback info */
NULL, /* Class close callback */
NULL /* Class close callback info */
}};
/* Library property list classes defined in other code modules */
H5_DLLVAR const H5P_libclass_t H5P_CLS_OCRT[1]; /* Object creation */
H5_DLLVAR const H5P_libclass_t H5P_CLS_STRCRT[1]; /* String create */
H5_DLLVAR const H5P_libclass_t H5P_CLS_LACC[1]; /* Link access */
H5_DLLVAR const H5P_libclass_t H5P_CLS_GCRT[1]; /* Group create */
H5_DLLVAR const H5P_libclass_t H5P_CLS_OCPY[1]; /* Object copy */
H5_DLLVAR const H5P_libclass_t H5P_CLS_FCRT[1]; /* File creation */
H5_DLLVAR const H5P_libclass_t H5P_CLS_FACC[1]; /* File access */
H5_DLLVAR const H5P_libclass_t H5P_CLS_DCRT[1]; /* Dataset creation */
H5_DLLVAR const H5P_libclass_t H5P_CLS_DACC[1]; /* Dataset access */
H5_DLLVAR const H5P_libclass_t H5P_CLS_DXFR[1]; /* Data transfer */
H5_DLLVAR const H5P_libclass_t H5P_CLS_FMNT[1]; /* File mount */
H5_DLLVAR const H5P_libclass_t H5P_CLS_ACRT[1]; /* Attribute creation */
H5_DLLVAR const H5P_libclass_t H5P_CLS_LCRT[1]; /* Link creation */
H5_DLLVAR const H5P_libclass_t H5P_CLS_RCACC[1]; /* Read Context acquire */
H5_DLLVAR const H5P_libclass_t H5P_CLS_TRSCC[1]; /* Transaction start */
//H5_DLLVAR const H5P_libclass_t H5P_CLS_TRFCC[1]; /* Transaction finish */
/*****************************/
/* Library Private Variables */
/*****************************/
/*******************/
/* Local Variables */
/*******************/
/* Track the revision count of a class, to make comparisons faster */
static unsigned H5P_next_rev = 0;
#define H5P_GET_NEXT_REV (H5P_next_rev++)
/* List of all property list classes in the library */
/* (order here is not important, they will be initialized in the proper
* order according to their parent class dependencies)
*/
static H5P_libclass_t const * const init_class[] = {
H5P_CLS_ROOT, /* Root */
H5P_CLS_OCRT, /* Object create */
H5P_CLS_STRCRT, /* String create */
H5P_CLS_LACC, /* Link access */
H5P_CLS_GCRT, /* Group create */
H5P_CLS_OCPY, /* Object copy */
H5P_CLS_GACC, /* Group access */
H5P_CLS_FCRT, /* File creation */
H5P_CLS_FACC, /* File access */
H5P_CLS_DCRT, /* Dataset creation */
H5P_CLS_DACC, /* Dataset access */
H5P_CLS_DXFR, /* Data transfer */
H5P_CLS_FMNT, /* File mount */
H5P_CLS_TCRT, /* Datatype creation */
H5P_CLS_TACC, /* Datatype access */
H5P_CLS_ACRT, /* Attribute creation */
H5P_CLS_RCACC, /* Read Context acquire */
H5P_CLS_TRSCC, /* Transaction start */
H5P_CLS_TRFCC, /* Transaction finish */
H5P_CLS_LCRT /* Link creation */
};
/* Declare a free list to manage the H5P_genclass_t struct */
H5FL_DEFINE_STATIC(H5P_genclass_t);
/* Declare a free list to manage the H5P_genprop_t struct */
H5FL_DEFINE_STATIC(H5P_genprop_t);
/* Declare a free list to manage the H5P_genplist_t struct */
H5FL_DEFINE_STATIC(H5P_genplist_t);
/* Generic Property Class ID class */
static const H5I_class_t H5I_GENPROPCLS_CLS[1] = {{
H5I_GENPROP_CLS, /* ID class value */
0, /* Class flags */
64, /* Minimum hash size for class */
0, /* # of reserved IDs for class */
(H5I_free_t)H5P_close_class,/* Callback routine for closing objects of this class */
NULL /* Callback routine for closing auxilary objects of this class */
}};
/* Generic Property List ID class */
static const H5I_class_t H5I_GENPROPLST_CLS[1] = {{
H5I_GENPROP_LST, /* ID class value */
0, /* Class flags */
128, /* Minimum hash size for class */
0, /* # of reserved IDs for class */
(H5I_free_t)H5P_close, /* Callback routine for closing objects of this class */
NULL /* Callback routine for closing auxilary objects of this class */
}};
/* Property value defaults */
static const hbool_t H5_def_async_flag_g = H5P_ASYNC_FLAG_DEF; /* Default async flag */
static const void *H5_def_async_req_g = H5P_ASYNC_REQ_DEF; /* Default async request pointer */
/*--------------------------------------------------------------------------
NAME
H5P_do_prop_cb1
PURPOSE
Internal routine to call a property list callback routine and update
the property list accordingly.
USAGE
herr_t H5P_do_prop_cb1(slist,prop,cb)
H5SL_t *slist; IN/OUT: Skip list to hold changed properties
H5P_genprop_t *prop; IN: Property to call callback for
H5P_prp_cb1_t *cb; IN: Callback routine to call
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Calls the callback routine passed in. If the callback routine changes
the property value, then the property is duplicated and added to skip list.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5P_do_prop_cb1(H5SL_t *slist, H5P_genprop_t *prop, H5P_prp_cb1_t cb)
{
void *tmp_value=NULL; /* Temporary value buffer */
H5P_genprop_t *pcopy=NULL; /* Copy of property to insert into skip list */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* Allocate space for a temporary copy of the property value */
if(NULL == (tmp_value = H5MM_malloc(prop->size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed for temporary property value")
HDmemcpy(tmp_value,prop->value,prop->size);
/* Call "type 1" callback ('create', 'copy' or 'close') */
if(cb(prop->name,prop->size,tmp_value) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL,"Property callback failed")
/* Check if the property value changed */
if((prop->cmp)(tmp_value,prop->value,prop->size)) {
/* Make a copy of the class's property */
if((pcopy=H5P_dup_prop(prop,H5P_PROP_WITHIN_LIST)) == NULL)
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, FAIL,"Can't copy property")
/* Copy the changed value into the new property */
HDmemcpy(pcopy->value,tmp_value,prop->size);
/* Insert the changed property into the property list */
if(H5P_add_prop(slist,pcopy) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert property into skip list")
} /* end if */
done:
/* Release the temporary value buffer */
if(tmp_value!=NULL)
H5MM_xfree(tmp_value);
/* Cleanup on failure */
if(ret_value<0) {
if(pcopy!=NULL)
H5P_free_prop(pcopy);
} /* end if */
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5P_do_prop_cb1() */
/*-------------------------------------------------------------------------
* Function: H5P_init
*
* Purpose: Initialize the interface from some other layer.
*
* Return: Success: non-negative
*
* Failure: negative
*
* Programmer: Quincey Koziol
* Saturday, March 4, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5P_init(void)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
/* FUNC_ENTER() does all the work */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5P_init() */
/*-------------------------------------------------------------------------
* Function: H5P__root_reg_prop
*
* Purpose: Initialize the root property list class
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* March 20, 2013
*
*-------------------------------------------------------------------------
*/
static herr_t
H5P__root_reg_prop(H5P_genclass_t *pclass)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_STATIC
/* Register async. flag property */
if(H5P_register_real(pclass, H5P_ASYNC_FLAG_NAME, H5P_ASYNC_FLAG_SIZE, &H5_def_async_flag_g,
NULL, NULL, NULL, NULL, NULL,
NULL, NULL, NULL, NULL) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
/* Register async. request property */
if(H5P_register_real(pclass, H5P_ASYNC_REQ_NAME, H5P_ASYNC_REQ_SIZE, &H5_def_async_req_g,
NULL, NULL, NULL, NULL, NULL,
NULL, NULL, NULL, NULL) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5P__root_reg_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_init_interface -- Initialize interface-specific information
USAGE
herr_t H5P_init_interface()
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Initializes any interface-specific data or routines.
--------------------------------------------------------------------------*/
static herr_t
H5P_init_interface(void)
{
size_t tot_init; /* Total # of classes initialized */
size_t pass_init; /* # of classes initialized in each pass */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/*
* Initialize the Generic Property class & object groups.
*/
if(H5I_register_type(H5I_GENPROPCLS_CLS) < 0)
HGOTO_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL, "unable to initialize ID group")
if(H5I_register_type(H5I_GENPROPLST_CLS) < 0)
HGOTO_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL, "unable to initialize ID group")
/* Repeatedly pass over the list of property list classes for the library,
* initializing each class if it's parent class is initialized, until no
* more progress is made.
*/
tot_init = 0;
do {
size_t u; /* Local index variable */
/* Reset pass initialization counter */
pass_init = 0;
/* Make a pass over all the library's property list classes */
for(u = 0; u < NELMTS(init_class); u++) {
H5P_libclass_t const *lib_class = init_class[u]; /* Current class to operate on */
/* Check if the current class hasn't been initialized and can be now */
HDassert(lib_class->class_id);
if(*lib_class->class_id == (-1) && (lib_class->par_class_id == NULL
|| *lib_class->par_class_id > 0)) {
H5P_genclass_t *par_pclass = NULL; /* Parent class of new class */
H5P_genclass_t *new_pclass; /* New property list class created */
/* Sanity check - only the root class is not allowed to have a parent class */
HDassert(lib_class->par_class_id || lib_class == H5P_CLS_ROOT);
/* Check for parent class */
if(lib_class->par_class_id) {
/* Get the pointer to the parent class */
if(NULL == (par_pclass = (H5P_genclass_t *)H5I_object(*lib_class->par_class_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list class")
} /* end if */
/* Allocate the new class */
if(NULL == (new_pclass = H5P_create_class(par_pclass, lib_class->name, lib_class->type, lib_class->create_func, lib_class->create_data, lib_class->copy_func, lib_class->copy_data, lib_class->close_func, lib_class->close_data)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "class initialization failed")
/* Call routine to register properties for class */
if(lib_class->reg_prop_func && (*lib_class->reg_prop_func)(new_pclass) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "can't register properties")
/* Register the new class */
if((*lib_class->class_id = H5I_register(H5I_GENPROP_CLS, new_pclass, FALSE)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "can't register property list class")
/* Only register the default property list if it hasn't been created yet */
if(lib_class->def_plist_id && *lib_class->def_plist_id == (-1)) {
/* Register the default property list for the new class*/
if((*lib_class->def_plist_id = H5P_create_id(new_pclass, FALSE)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "can't register default property list for class")
} /* end if */
/* Increment class initialization counters */
pass_init++;
tot_init++;
} /* end if */
} /* end for */
} while(pass_init > 0);
/* Verify that all classes were initialized */
HDassert(tot_init == NELMTS(init_class));
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5P_init_interface() */
/*--------------------------------------------------------------------------
NAME
H5P_term_interface
PURPOSE
Terminate various H5P objects
USAGE
void H5P_term_interface()
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Release the atom group and any other resources allocated.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Can't report errors...
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
int
H5P_term_interface(void)
{
int nlist=0;
int nclass=0;
int n=0;
FUNC_ENTER_NOAPI_NOINIT_NOERR
if(H5_interface_initialize_g) {
/* Destroy HDF5 library property classes & lists */
/* Check if there are any open property list classes or lists */
nclass = H5I_nmembers(H5I_GENPROP_CLS);
nlist = H5I_nmembers(H5I_GENPROP_LST);
n=nclass+nlist;
/* If there are any open classes or groups, attempt to get rid of them. */
if(n) {
/* Clear the lists */
if(nlist>0) {
H5I_clear_type(H5I_GENPROP_LST, FALSE, FALSE);
/* Reset the default property lists, if they've been closed */
if(H5I_nmembers(H5I_GENPROP_LST)==0) {
H5P_LST_FILE_CREATE_g =
H5P_LST_FILE_ACCESS_g =
H5P_LST_DATASET_CREATE_g =
H5P_LST_DATASET_ACCESS_g =
H5P_LST_DATASET_XFER_g =
H5P_LST_GROUP_CREATE_g =
H5P_LST_GROUP_ACCESS_g =
H5P_LST_DATATYPE_CREATE_g =
H5P_LST_DATATYPE_ACCESS_g =
H5P_LST_ATTRIBUTE_CREATE_g =
H5P_LST_OBJECT_COPY_g =
H5P_LST_LINK_CREATE_g =
H5P_LST_LINK_ACCESS_g =
H5P_LST_READ_CONTEXT_ACQUIRE_g =
H5P_LST_TRANSACTION_START_g =
H5P_LST_TRANSACTION_FINISH_g =
H5P_LST_FILE_MOUNT_g = (-1);
} /* end if */
} /* end if */
/* Only attempt to close the classes after all the lists are closed */
if(nlist==0 && nclass>0) {
H5I_clear_type(H5I_GENPROP_CLS, FALSE, FALSE);
/* Reset the default property lists, if they've been closed */
if(H5I_nmembers(H5I_GENPROP_CLS)==0) {
H5P_CLS_ROOT_g =
H5P_CLS_OBJECT_CREATE_g =
H5P_CLS_FILE_CREATE_g =
H5P_CLS_FILE_ACCESS_g =
H5P_CLS_DATASET_CREATE_g =
H5P_CLS_DATASET_ACCESS_g =
H5P_CLS_DATASET_XFER_g =
H5P_CLS_GROUP_CREATE_g =
H5P_CLS_GROUP_ACCESS_g =
H5P_CLS_DATATYPE_CREATE_g =
H5P_CLS_DATATYPE_ACCESS_g =
H5P_CLS_STRING_CREATE_g =
H5P_CLS_ATTRIBUTE_CREATE_g =
H5P_CLS_OBJECT_COPY_g =
H5P_CLS_LINK_CREATE_g =
H5P_CLS_LINK_ACCESS_g =
H5P_CLS_READ_CONTEXT_ACQUIRE_g =
H5P_CLS_TRANSACTION_START_g =
H5P_CLS_TRANSACTION_FINISH_g =
H5P_CLS_FILE_MOUNT_g = (-1);
} /* end if */
} /* end if */
} else {
H5I_dec_type_ref(H5I_GENPROP_LST);
n++; /*H5I*/
H5I_dec_type_ref(H5I_GENPROP_CLS);
n++; /*H5I*/
H5_interface_initialize_g = 0;
}
}
FUNC_LEAVE_NOAPI(n)
}
/*--------------------------------------------------------------------------
NAME
H5P_copy_pclass
PURPOSE
Internal routine to copy a generic property class
USAGE
hid_t H5P_copy_pclass(pclass)
H5P_genclass_t *pclass; IN: Property class to copy
RETURNS
Success: valid property class ID on success (non-negative)
Failure: negative
DESCRIPTION
Copy a property class and return the ID. This routine does not make
any callbacks. (They are only make when operating on property lists).
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5P_genclass_t *
H5P_copy_pclass(H5P_genclass_t *pclass)
{
H5P_genclass_t *new_pclass = NULL; /* Property list class copied */
H5P_genprop_t *pcopy; /* Copy of property to insert into class */
H5P_genclass_t *ret_value=NULL; /* return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(pclass);
/*
* Create new property class object
*/
/* Create the new property list class */
if(NULL == (new_pclass = H5P_create_class(pclass->parent, pclass->name, pclass->type, pclass->create_func, pclass->create_data, pclass->copy_func, pclass->copy_data, pclass->close_func, pclass->close_data)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCREATE, NULL, "unable to create property list class")
/* Copy the properties registered for this class */
if(pclass->nprops > 0) {
H5SL_node_t *curr_node; /* Current node in skip list */
/* Walk through the properties in the old class */
curr_node=H5SL_first(pclass->props);
while(curr_node!=NULL) {
/* Make a copy of the class's property */
if(NULL == (pcopy = H5P_dup_prop((H5P_genprop_t *)H5SL_item(curr_node), H5P_PROP_WITHIN_CLASS)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, NULL,"Can't copy property")
/* Insert the initialized property into the property list */
if(H5P_add_prop(new_pclass->props,pcopy) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, NULL,"Can't insert property into class")
/* Increment property count for class */
new_pclass->nprops++;
/* Get the next property node in the list */
curr_node=H5SL_next(curr_node);
} /* end while */
} /* end if */
/* Set the return value */
ret_value=new_pclass;
done:
if(ret_value==NULL && new_pclass)
H5P_close_class(new_pclass);
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_copy_pclass() */
/*--------------------------------------------------------------------------
NAME
H5P_copy_plist
PURPOSE
Internal routine to copy a generic property list
USAGE
hid_t H5P_copy_plist(old_plist_id)
hid_t old_plist_id; IN: Property list ID to copy
RETURNS
Success: valid property list ID on success (non-negative)
Failure: negative
DESCRIPTION
Copy a property list and return the ID. This routine calls the
class 'copy' callback after any property 'copy' callbacks are called
(assuming all property 'copy' callbacks return successfully).
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hid_t
H5P_copy_plist(const H5P_genplist_t *old_plist, hbool_t app_ref)
{
H5P_genclass_t *tclass; /* Temporary class pointer */
H5P_genplist_t *new_plist=NULL; /* New property list generated from copy */
H5P_genprop_t *tmp; /* Temporary pointer to properties */
H5P_genprop_t *new_prop; /* New property created for copy */
hid_t new_plist_id; /* Property list ID of new list created */
H5SL_node_t *curr_node; /* Current node in skip list */
H5SL_t *seen=NULL; /* Skip list containing properties already seen */
size_t nseen; /* Number of items 'seen' */
hbool_t has_parent_class; /* Flag to indicate that this property list's class has a parent */
hid_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(FAIL)
HDassert(old_plist);
/*
* Create new property list object
*/
/* Allocate room for the property list */
if(NULL==(new_plist = H5FL_CALLOC(H5P_genplist_t)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,"memory allocation failed")
/* Set class state */
new_plist->pclass = old_plist->pclass;
new_plist->nprops = 0; /* Initially the plist has the same number of properties as the class */
new_plist->class_init = FALSE; /* Initially, wait until the class callback finishes to set */
/* Initialize the skip list to hold the changed properties */
if((new_plist->props = H5SL_create(H5SL_TYPE_STR, NULL)) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTCREATE,FAIL,"can't create skip list for changed properties")
/* Create the skip list for deleted properties */
if((new_plist->del = H5SL_create(H5SL_TYPE_STR, NULL)) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTCREATE,FAIL,"can't create skip list for deleted properties")
/* Create the skip list to hold names of properties already seen
* (This prevents a property in the class hierarchy from having it's
* 'create' callback called, if a property in the class hierarchy has
* already been seen)
*/
if((seen = H5SL_create(H5SL_TYPE_STR, NULL))== NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTCREATE,FAIL,"can't create skip list for seen properties")
nseen = 0;
/* Cycle through the deleted properties & copy them into the new list's deleted section */
if(H5SL_count(old_plist->del)>0) {
curr_node=H5SL_first(old_plist->del);
while(curr_node) {
char *new_name; /* Pointer to new name */
/* Duplicate string for insertion into new deleted property skip list */
if((new_name=H5MM_xstrdup((char *)H5SL_item(curr_node))) == NULL)
HGOTO_ERROR(H5E_RESOURCE,H5E_NOSPACE,FAIL,"memory allocation failed")
/* Insert property name into deleted list */
if(H5SL_insert(new_plist->del,new_name,new_name) < 0)
HGOTO_ERROR(H5E_PLIST,H5E_CANTINSERT,FAIL,"can't insert property into deleted skip list")
/* Add property name to "seen" list */
if(H5SL_insert(seen,new_name,new_name) < 0)
HGOTO_ERROR(H5E_PLIST,H5E_CANTINSERT,FAIL,"can't insert property into seen skip list")
nseen++;
/* Get the next property node in the skip list */
curr_node=H5SL_next(curr_node);
} /* end while */
} /* end if */
/* Cycle through the properties and copy them also */
if(H5SL_count(old_plist->props)>0) {
curr_node=H5SL_first(old_plist->props);
while(curr_node) {
/* Get a pointer to the node's property */
tmp = (H5P_genprop_t *)H5SL_item(curr_node);
/* Make a copy of the list's property */
if(NULL == (new_prop = H5P_dup_prop(tmp, H5P_PROP_WITHIN_LIST)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, FAIL,"Can't copy property")
/* Call property copy callback, if it exists */
if(new_prop->copy) {
if((new_prop->copy)(new_prop->name,new_prop->size,new_prop->value) < 0) {
H5P_free_prop(new_prop);
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, FAIL,"Can't copy property")
} /* end if */
} /* end if */
/* Insert the initialized property into the property list */
if(H5P_add_prop(new_plist->props,new_prop) < 0) {
H5P_free_prop(new_prop);
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert property into list")
} /* end if */
/* Add property name to "seen" list */
if(H5SL_insert(seen,new_prop->name,new_prop->name) < 0)
HGOTO_ERROR(H5E_PLIST,H5E_CANTINSERT,FAIL,"can't insert property into seen skip list")
nseen++;
/* Increment the number of properties in list */
new_plist->nprops++;
/* Get the next property node in the skip list */
curr_node=H5SL_next(curr_node);
} /* end while */
} /* end if */
/*
* Check for copying class properties (up through list of parent classes also),
* initialize each with default value & make property 'copy' callback.
*/
tclass=old_plist->pclass;
has_parent_class = (hbool_t)(tclass != NULL && tclass->parent != NULL && tclass->parent->nprops > 0);
while(tclass!=NULL) {
if(tclass->nprops>0) {
/* Walk through the properties in the old class */
curr_node=H5SL_first(tclass->props);
while(curr_node!=NULL) {
/* Get pointer to property from node */
tmp = (H5P_genprop_t *)H5SL_item(curr_node);
/* Only "copy" properties we haven't seen before */
if(nseen==0 || H5SL_search(seen,tmp->name) == NULL) {
/* Call property creation callback, if it exists */
if(tmp->copy) {
/* Call the callback & insert changed value into skip list (if necessary) */
if(H5P_do_prop_cb1(new_plist->props,tmp,tmp->copy) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, FAIL,"Can't create property")
} /* end if */
/* Add property name to "seen" list, if we have other classes to work on */
if(has_parent_class) {
if(H5SL_insert(seen,tmp->name,tmp->name) < 0)
HGOTO_ERROR(H5E_PLIST,H5E_CANTINSERT,FAIL,"can't insert property into seen skip list")
nseen++;
} /* end if */
/* Increment the number of properties in list */
new_plist->nprops++;
} /* end if */
/* Get the next property node in the skip list */
curr_node=H5SL_next(curr_node);
} /* end while */
} /* end if */
/* Go up to parent class */
tclass=tclass->parent;
} /* end while */
/* Increment the number of property lists derived from class */
if(H5P_access_class(new_plist->pclass, H5P_MOD_INC_LST) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "Can't increment class ref count")
/* Get an atom for the property list */
if((new_plist_id = H5I_register(H5I_GENPROP_LST, new_plist, app_ref)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to atomize property list")
/* Save the property list ID in the property list struct, for use in the property class's 'close' callback */
new_plist->plist_id=new_plist_id;
/* Call the class callback (if it exists) now that we have the property list ID
* (up through chain of parent classes also)
*/
tclass = new_plist->pclass;
while(NULL != tclass) {
if(NULL != tclass->copy_func) {
if((tclass->copy_func)(new_plist_id, old_plist->plist_id, old_plist->pclass->copy_data) < 0) {
/* Delete ID, ignore return value */
H5I_remove(new_plist_id);
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL,"Can't initialize property")
} /* end if */
} /* end if */
/* Go up to parent class */
tclass = tclass->parent;
} /* end while */
/* Set the class initialization flag */
new_plist->class_init = TRUE;
/* Set the return value */
ret_value=new_plist_id;
done:
/* Release the list of 'seen' properties */
if(seen!=NULL)
H5SL_close(seen);
if(ret_value<0 && new_plist)
H5P_close(new_plist);
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_copy_plist() */
/*--------------------------------------------------------------------------
NAME
H5P_dup_prop
PURPOSE
Internal routine to duplicate a property
USAGE
H5P_genprop_t *H5P_dup_prop(oprop)
H5P_genprop_t *oprop; IN: Pointer to property to copy
H5P_prop_within_t type; IN: Type of object the property will be inserted into
RETURNS
Returns a pointer to the newly created duplicate of a property on success,
NULL on failure.
DESCRIPTION
Allocates memory and copies property information into a new property object.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static H5P_genprop_t *
H5P_dup_prop(H5P_genprop_t *oprop, H5P_prop_within_t type)
{
H5P_genprop_t *prop = NULL; /* Pointer to new property copied */
H5P_genprop_t *ret_value; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(oprop);
HDassert(type != H5P_PROP_WITHIN_UNKNOWN);
/* Allocate the new property */
if(NULL == (prop = H5FL_MALLOC(H5P_genprop_t)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed")
/* Copy basic property information */
HDmemcpy(prop, oprop, sizeof(H5P_genprop_t));
/* Check if we should duplicate the name or share it */
/* Duplicating property for a class */
if(type == H5P_PROP_WITHIN_CLASS) {
HDassert(oprop->type == H5P_PROP_WITHIN_CLASS);
HDassert(oprop->shared_name == FALSE);
/* Duplicate name */
prop->name = H5MM_xstrdup(oprop->name);
} /* end if */
/* Duplicating property for a list */
else {
/* Check if we are duplicating a property from a list or a class */
/* Duplicating a property from a list */
if(oprop->type == H5P_PROP_WITHIN_LIST) {
/* If the old property's name wasn't shared, we have to copy it here also */
if(!oprop->shared_name)
prop->name = H5MM_xstrdup(oprop->name);
} /* end if */
/* Duplicating a property from a class */
else {
HDassert(oprop->type == H5P_PROP_WITHIN_CLASS);
HDassert(oprop->shared_name == FALSE);
/* Share the name */
prop->shared_name = TRUE;
/* Set the type */
prop->type = type;
} /* end else */
} /* end else */
/* Duplicate current value, if it exists */
if(oprop->value != NULL) {
HDassert(prop->size > 0);
if(NULL == (prop->value = H5MM_malloc(prop->size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed")
HDmemcpy(prop->value, oprop->value, prop->size);
} /* end if */
/* Set return value */
ret_value = prop;
done:
/* Free any resources allocated */
if(ret_value == NULL) {
if(prop != NULL) {
if(prop->name != NULL)
H5MM_xfree(prop->name);
if(prop->value != NULL)
H5MM_xfree(prop->value);
prop = H5FL_FREE(H5P_genprop_t, prop);
} /* end if */
} /* end if */
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_dup_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_create_prop
PURPOSE
Internal routine to create a new property
USAGE
H5P_genprop_t *H5P_create_prop(name,size,type,value,prp_create,prp_set,
prp_get,prp_delete,prp_close, prp_encode, prp_decode)
const char *name; IN: Name of property to register
size_t size; IN: Size of property in bytes
H5P_prop_within_t type; IN: Type of object the property will be inserted into
void *value; IN: Pointer to buffer containing value for property
H5P_prp_create_func_t prp_create; IN: Function pointer to property
creation callback
H5P_prp_set_func_t prp_set; IN: Function pointer to property set callback
H5P_prp_get_func_t prp_get; IN: Function pointer to property get callback
H5P_prp_encode_func_t prp_encode; IN: Function pointer to property encode
H5P_prp_decode_func_t prp_decode; IN: Function pointer to property decode
H5P_prp_delete_func_t prp_delete; IN: Function pointer to property delete callback
H5P_prp_copy_func_t prp_copy; IN: Function pointer to property copy callback
H5P_prp_compare_func_t prp_cmp; IN: Function pointer to property compare callback
H5P_prp_close_func_t prp_close; IN: Function pointer to property close
callback
RETURNS
Returns a pointer to the newly created property on success,
NULL on failure.
DESCRIPTION
Allocates memory and copies property information into a new property object.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static H5P_genprop_t *
H5P_create_prop(const char *name, size_t size, H5P_prop_within_t type,
const void *value, H5P_prp_create_func_t prp_create,
H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get,
H5P_prp_encode_func_t prp_encode, H5P_prp_decode_func_t prp_decode,
H5P_prp_delete_func_t prp_delete,
H5P_prp_copy_func_t prp_copy, H5P_prp_compare_func_t prp_cmp,
H5P_prp_close_func_t prp_close)
{
H5P_genprop_t *prop = NULL; /* Pointer to new property copied */
H5P_genprop_t *ret_value; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(name);
HDassert((size > 0 && value != NULL) || (size == 0));
HDassert(type != H5P_PROP_WITHIN_UNKNOWN);
/* Allocate the new property */
if(NULL == (prop = H5FL_MALLOC(H5P_genprop_t)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed")
/* Set the property initial values */
prop->name = H5MM_xstrdup(name); /* Duplicate name */
prop->shared_name = FALSE;
prop->size = size;
prop->type = type;
/* Duplicate value, if it exists */
if(value != NULL) {
if(NULL == (prop->value = H5MM_malloc (prop->size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed")
HDmemcpy(prop->value, value, prop->size);
} /* end if */
else
prop->value = NULL;
/* Set the function pointers */
prop->create = prp_create;
prop->set = prp_set;
prop->get = prp_get;
prop->encode = prp_encode;
prop->decode = prp_decode;
prop->del = prp_delete;
prop->copy = prp_copy;
/* Use custom comparison routine if available, otherwise default to memcmp() */
if(prp_cmp != NULL)
prop->cmp = prp_cmp;
else
prop->cmp = &memcmp;
prop->close = prp_close;
/* Set return value */
ret_value = prop;
done:
/* Free any resources allocated */
if(ret_value == NULL) {
if(prop != NULL) {
if(prop->name != NULL)
H5MM_xfree(prop->name);
if(prop->value != NULL)
H5MM_xfree(prop->value);
prop = H5FL_FREE(H5P_genprop_t, prop);
} /* end if */
} /* end if */
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_create_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_add_prop
PURPOSE
Internal routine to insert a property into a property skip list
USAGE
herr_t H5P_add_prop(slist, prop)
H5SL_t *slist; IN/OUT: Pointer to skip list of properties
H5P_genprop_t *prop; IN: Pointer to property to insert
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Inserts a property into a skip list of properties.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_add_prop(H5SL_t *slist, H5P_genprop_t *prop)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
HDassert(slist);
HDassert(prop);
HDassert(prop->type != H5P_PROP_WITHIN_UNKNOWN);
/* Insert property into skip list */
if(H5SL_insert(slist, prop, prop->name) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into skip list")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_add_prop() */
/*--------------------------------------------------------------------------
NAME
H5P__find_prop_plist
PURPOSE
Internal routine to check for a property in a property list's skip list
USAGE
H5P_genprop_t *H5P_find_prop(plist, name)
const H5P_genplist_t *plist; IN: Pointer to property list to check
const char *name; IN: Name of property to check for
RETURNS
Returns pointer to property on success, NULL on failure.
DESCRIPTION
Checks for a property in a property list's skip list of properties.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5P_genprop_t *
H5P__find_prop_plist(const H5P_genplist_t *plist, const char *name)
{
H5P_genprop_t *ret_value; /* Property pointer return value */
FUNC_ENTER_PACKAGE
HDassert(plist);
HDassert(name);
/* Check if the property has been deleted from list */
if(H5SL_search(plist->del,name) != NULL) {
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, NULL, "can't find property in skip list")
} /* end if */
else {
/* Get the property data from the skip list */
if(NULL == (ret_value = (H5P_genprop_t *)H5SL_search(plist->props, name))) {
H5P_genclass_t *tclass; /* Temporary class pointer */
/* Couldn't find property in list itself, start searching through class info */
tclass = plist->pclass;
while(tclass != NULL) {
/* Find the property in the class */
if(NULL != (ret_value = (H5P_genprop_t *)H5SL_search(tclass->props, name)))
/* Got pointer to property - leave now */
break;
/* Go up to parent class */
tclass = tclass->parent;
} /* end while */
/* Check if we haven't found the property */
if(ret_value == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_NOTFOUND,NULL,"can't find property in skip list")
} /* end else */
} /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P__find_prop_plist() */
/*--------------------------------------------------------------------------
NAME
H5P_find_prop_pclass
PURPOSE
Internal routine to check for a property in a class skip list
USAGE
H5P_genprop_t *H5P_find_prop_class(pclass, name)
H5P_genclass *pclass; IN: Pointer generic property class to check
const char *name; IN: Name of property to check for
RETURNS
Returns pointer to property on success, NULL on failure.
DESCRIPTION
Checks for a property in a class's skip list of properties.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static H5P_genprop_t *
H5P_find_prop_pclass(H5P_genclass_t *pclass, const char *name)
{
H5P_genprop_t *ret_value; /* Property pointer return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(pclass);
HDassert(name);
/* Get the property from the skip list */
if(NULL == (ret_value = (H5P_genprop_t *)H5SL_search(pclass->props, name)))
HGOTO_ERROR(H5E_PLIST,H5E_NOTFOUND,NULL,"can't find property in skip list")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_find_prop_pclass() */
/*--------------------------------------------------------------------------
NAME
H5P_free_prop
PURPOSE
Internal routine to destroy a property node
USAGE
herr_t H5P_free_prop(prop)
H5P_genprop_t *prop; IN: Pointer to property to destroy
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Releases all the memory for a property list. Does _not_ call the
properties 'close' callback, that should already have been done.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5P_free_prop(H5P_genprop_t *prop)
{
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(prop);
/* Release the property value if it exists */
if(prop->value)
H5MM_xfree(prop->value);
/* Only free the name if we own it */
if(!prop->shared_name)
H5MM_xfree(prop->name);
prop = H5FL_FREE(H5P_genprop_t, prop);
FUNC_LEAVE_NOAPI(SUCCEED)
} /* H5P_free_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_free_prop_cb
PURPOSE
Internal routine to properties from a property skip list
USAGE
herr_t H5P_free_prop_cb(item, key, op_data)
void *item; IN/OUT: Pointer to property
void *key; IN/OUT: Pointer to property key
void *_make_cb; IN: Whether to make property callbacks or not
RETURNS
Returns zero on success, negative on failure.
DESCRIPTION
Calls the property 'close' callback for a property & frees property
info.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5P_free_prop_cb(void *item, void UNUSED *key, void *op_data)
{
H5P_genprop_t *tprop=(H5P_genprop_t *)item; /* Temporary pointer to property */
hbool_t make_cb = *(hbool_t *)op_data; /* Whether to make property 'close' callback */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(tprop);
/* Call the close callback and ignore the return value, there's nothing we can do about it */
if(make_cb && tprop->close != NULL)
(tprop->close)(tprop->name, tprop->size, tprop->value);
/* Free the property, ignoring return value, nothing we can do */
H5P_free_prop(tprop);
FUNC_LEAVE_NOAPI(0)
} /* H5P_free_prop_cb() */
/*--------------------------------------------------------------------------
NAME
H5P_free_del_name_cb
PURPOSE
Internal routine to free 'deleted' property name
USAGE
herr_t H5P_free_del_name_cb(item, key, op_data)
void *item; IN/OUT: Pointer to deleted name
void *key; IN/OUT: Pointer to key
void *op_data; IN: Operator callback data (unused)
RETURNS
Returns zero on success, negative on failure.
DESCRIPTION
Frees the deleted property name
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5P_free_del_name_cb(void *item, void UNUSED *key, void UNUSED *op_data)
{
char *del_name=(char *)item; /* Temporary pointer to deleted name */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(del_name);
/* Free the name */
H5MM_xfree(del_name);
FUNC_LEAVE_NOAPI(0)
} /* H5P_free_del_name_cb() */
/*--------------------------------------------------------------------------
NAME
H5P_access_class
PURPOSE
Internal routine to increment or decrement list & class dependancies on a
property list class
USAGE
herr_t H5P_access_class(pclass,mod)
H5P_genclass_t *pclass; IN: Pointer to class to modify
H5P_class_mod_t mod; IN: Type of modification to class
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Increment/Decrement the class or list dependancies for a given class.
This routine is the final arbiter on decisions about actually releasing a
class in memory, such action is only taken when the reference counts for
both dependent classes & lists reach zero.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_access_class(H5P_genclass_t *pclass, H5P_class_mod_t mod)
{
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(pclass);
HDassert(mod > H5P_MOD_ERR && mod < H5P_MOD_MAX);
switch(mod) {
case H5P_MOD_INC_CLS: /* Increment the dependant class count*/
pclass->classes++;
break;
case H5P_MOD_DEC_CLS: /* Decrement the dependant class count*/
pclass->classes--;
break;
case H5P_MOD_INC_LST: /* Increment the dependant list count*/
pclass->plists++;
break;
case H5P_MOD_DEC_LST: /* Decrement the dependant list count*/
pclass->plists--;
break;
case H5P_MOD_INC_REF: /* Increment the ID reference count*/
/* Reset the deleted flag if incrementing the reference count */
if(pclass->deleted)
pclass->deleted = FALSE;
pclass->ref_count++;
break;
case H5P_MOD_DEC_REF: /* Decrement the ID reference count*/
pclass->ref_count--;
/* Mark the class object as deleted if reference count drops to zero */
if(pclass->ref_count == 0)
pclass->deleted = TRUE;
break;
case H5P_MOD_ERR:
case H5P_MOD_MAX:
default:
HDassert(0 && "Invalid H5P class modification");
} /* end switch */
/* Check if we can release the class information now */
if(pclass->deleted && pclass->plists == 0 && pclass->classes == 0) {
H5P_genclass_t *par_class = pclass->parent; /* Pointer to class's parent */
HDassert(pclass->name);
H5MM_xfree(pclass->name);
/* Free the class properties without making callbacks */
if(pclass->props) {
hbool_t make_cb = FALSE;
H5SL_destroy(pclass->props, H5P_free_prop_cb, &make_cb);
} /* end if */
pclass = H5FL_FREE(H5P_genclass_t, pclass);
/* Reduce the number of dependent classes on parent class also */
if(par_class != NULL)
H5P_access_class(par_class, H5P_MOD_DEC_CLS);
} /* end if */
FUNC_LEAVE_NOAPI(SUCCEED)
} /* H5P_access_class() */
/*--------------------------------------------------------------------------
NAME
H5P_open_class_path_cb
PURPOSE
Internal callback routine to check for duplicated names in parent class.
USAGE
int H5P_open_class_path_cb(obj, id, key)
H5P_genclass_t *obj; IN: Pointer to class
hid_t id; IN: ID of object being looked at
const void *key; IN: Pointer to information used to compare
classes.
RETURNS
Returns >0 on match, 0 on no match and <0 on failure.
DESCRIPTION
Checks whether a property list class has the same parent and name as a
new class being created. This is a callback routine for H5I_search()
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int
H5P_open_class_path_cb(void *_obj, hid_t UNUSED id, void *_key)
{
H5P_genclass_t *obj = (H5P_genclass_t *)_obj; /* Pointer to the class for this ID */
H5P_check_class_t *key = (H5P_check_class_t *)_key; /* Pointer to key information for comparison */
int ret_value = 0; /* Return value */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(obj);
HDassert(H5I_GENPROP_CLS == H5I_get_type(id));
HDassert(key);
/* Check if the class object has the same parent as the new class */
if(obj->parent == key->parent) {
/* Check if they have the same name */
if(HDstrcmp(obj->name, key->name) == 0) {
key->new_class = obj;
ret_value = 1; /* Indicate a match */
} /* end if */
} /* end if */
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5P_open_class_path_cb() */
/*--------------------------------------------------------------------------
NAME
H5P_create_class
PURPOSE
Internal routine to create a new property list class.
USAGE
H5P_genclass_t H5P_create_class(par_class, name, type,
cls_create, create_data, cls_close, close_data)
H5P_genclass_t *par_class; IN: Pointer to parent class
const char *name; IN: Name of class we are creating
H5P_plist_type_t type; IN: Type of class we are creating
H5P_cls_create_func_t; IN: The callback function to call when each
property list in this class is created.
void *create_data; IN: Pointer to user data to pass along to class
creation callback.
H5P_cls_copy_func_t; IN: The callback function to call when each
property list in this class is copied.
void *copy_data; IN: Pointer to user data to pass along to class
copy callback.
H5P_cls_close_func_t; IN: The callback function to call when each
property list in this class is closed.
void *close_data; IN: Pointer to user data to pass along to class
close callback.
RETURNS
Returns a pointer to the newly created property list class on success,
NULL on failure.
DESCRIPTION
Allocates memory and attaches a class to the property list class hierarchy.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5P_genclass_t *
H5P_create_class(H5P_genclass_t *par_class, const char *name, H5P_plist_type_t type,
H5P_cls_create_func_t cls_create, void *create_data,
H5P_cls_copy_func_t cls_copy, void *copy_data,
H5P_cls_close_func_t cls_close, void *close_data)
{
H5P_genclass_t *pclass=NULL; /* Property list class created */
H5P_genclass_t *ret_value; /* return value */
FUNC_ENTER_NOAPI(NULL)
HDassert(name);
/* Allow internal classes to break some rules */
/* (This allows the root of the tree to be created with this routine -QAK) */
if(type == H5P_TYPE_USER)
HDassert(par_class);
/* Allocate room for the class */
if(NULL == (pclass = H5FL_CALLOC(H5P_genclass_t)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTALLOC, NULL, "propery list class allocation failed")
/* Set class state */
pclass->parent = par_class;
if(NULL == (pclass->name = H5MM_xstrdup(name)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTALLOC, NULL, "propery list class name allocation failed")
pclass->type = type;
pclass->nprops = 0; /* Classes are created without properties initially */
pclass->plists = 0; /* No properties lists of this class yet */
pclass->classes = 0; /* No classes derived from this class yet */
pclass->ref_count = 1; /* This is the first reference to the new class */
pclass->deleted = FALSE; /* Not deleted yet... :-) */
pclass->revision = H5P_GET_NEXT_REV; /* Get a revision number for the class */
/* Create the skip list for properties */
if(NULL == (pclass->props = H5SL_create(H5SL_TYPE_STR, NULL)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCREATE, NULL, "can't create skip list for properties")
/* Set callback functions and pass-along data */
pclass->create_func = cls_create;
pclass->create_data = create_data;
pclass->copy_func = cls_copy;
pclass->copy_data = copy_data;
pclass->close_func = cls_close;
pclass->close_data = close_data;
/* Increment parent class's derived class value */
if(par_class != NULL) {
if(H5P_access_class(par_class, H5P_MOD_INC_CLS) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, NULL, "Can't increment parent class ref count")
} /* end if */
/* Set return value */
ret_value = pclass;
done:
/* Free any resources allocated */
if(ret_value == NULL)
if(pclass) {
if(pclass->name)
H5MM_xfree(pclass->name);
if(pclass->props) {
hbool_t make_cb = FALSE;
H5SL_destroy(pclass->props, H5P_free_prop_cb, &make_cb);
} /* end if */
pclass = H5FL_FREE(H5P_genclass_t, pclass);
} /* end if */
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_create_class() */
/*--------------------------------------------------------------------------
NAME
H5P_create
PURPOSE
Internal routine to create a new property list of a property list class.
USAGE
H5P_genplist_t *H5P_create(class)
H5P_genclass_t *class; IN: Property list class create list from
RETURNS
Returns a pointer to the newly created property list on success,
NULL on failure.
DESCRIPTION
Creates a property list of a given class. If a 'create' callback
exists for the property list class, it is called before the
property list is passed back to the user.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
If this routine is called from a library routine other than
H5P_c, the calling routine is responsible for getting an ID for
the property list and calling the class 'create' callback (if one exists)
and also setting the "class_init" flag.
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static H5P_genplist_t *
H5P_create(H5P_genclass_t *pclass)
{
H5P_genclass_t *tclass; /* Temporary class pointer */
H5P_genplist_t *plist=NULL; /* New property list created */
H5P_genprop_t *tmp; /* Temporary pointer to parent class properties */
H5SL_t *seen=NULL; /* Skip list to hold names of properties already seen */
H5P_genplist_t *ret_value; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(pclass);
/*
* Create new property list object
*/
/* Allocate room for the property list */
if(NULL==(plist = H5FL_CALLOC(H5P_genplist_t)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL,"memory allocation failed")
/* Set class state */
plist->pclass = pclass;
plist->nprops = 0; /* Initially the plist has the same number of properties as the class */
plist->class_init = FALSE; /* Initially, wait until the class callback finishes to set */
/* Create the skip list for changed properties */
if((plist->props = H5SL_create(H5SL_TYPE_STR, NULL)) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTCREATE,NULL,"can't create skip list for changed properties")
/* Create the skip list for deleted properties */
if((plist->del = H5SL_create(H5SL_TYPE_STR, NULL)) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTCREATE,NULL,"can't create skip list for deleted properties")
/* Create the skip list to hold names of properties already seen
* (This prevents a property in the class hierarchy from having it's
* 'create' callback called, if a property in the class hierarchy has
* already been seen)
*/
if((seen = H5SL_create(H5SL_TYPE_STR, NULL)) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTCREATE,NULL,"can't create skip list for seen properties")
/*
* Check if we should copy class properties (up through list of parent classes also),
* initialize each with default value & make property 'create' callback.
*/
tclass=pclass;
while(tclass!=NULL) {
if(tclass->nprops>0) {
H5SL_node_t *curr_node; /* Current node in skip list */
/* Walk through the properties in the old class */
curr_node=H5SL_first(tclass->props);
while(curr_node!=NULL) {
/* Get pointer to property from node */
tmp = (H5P_genprop_t *)H5SL_item(curr_node);
/* Only "create" properties we haven't seen before */
if(H5SL_search(seen,tmp->name) == NULL) {
/* Call property creation callback, if it exists */
if(tmp->create) {
/* Call the callback & insert changed value into skip list (if necessary) */
if(H5P_do_prop_cb1(plist->props,tmp,tmp->create) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, NULL,"Can't create property")
} /* end if */
/* Add property name to "seen" list */
if(H5SL_insert(seen,tmp->name,tmp->name) < 0)
HGOTO_ERROR(H5E_PLIST,H5E_CANTINSERT,NULL,"can't insert property into seen skip list")
/* Increment the number of properties in list */
plist->nprops++;
} /* end if */
/* Get the next property node in the skip list */
curr_node=H5SL_next(curr_node);
} /* end while */
} /* end if */
/* Go up to parent class */
tclass=tclass->parent;
} /* end while */
/* Increment the number of property lists derived from class */
if(H5P_access_class(plist->pclass,H5P_MOD_INC_LST) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, NULL,"Can't increment class ref count")
/* Set return value */
ret_value=plist;
done:
/* Release the skip list of 'seen' properties */
if(seen!=NULL)
H5SL_close(seen);
/* Release resources allocated on failure */
if(ret_value==NULL) {
if(plist!=NULL) {
/* Close & free any changed properties */
if(plist->props) {
unsigned make_cb=1;
H5SL_destroy(plist->props,H5P_free_prop_cb,&make_cb);
} /* end if */
/* Close the deleted property skip list */
if(plist->del)
H5SL_close(plist->del);
/* Release the property list itself */
plist = H5FL_FREE(H5P_genplist_t, plist);
} /* end if */
} /* end if */
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_create() */
/*--------------------------------------------------------------------------
NAME
H5P_create_id
PURPOSE
Internal routine to create a new property list of a property list class.
USAGE
hid_t H5P_create_id(pclass)
H5P_genclass_t *pclass; IN: Property list class create list from
RETURNS
Returns a valid property list ID on success, FAIL on failure.
DESCRIPTION
Creates a property list of a given class. If a 'create' callback
exists for the property list class, it is called before the
property list is passed back to the user. If 'create' callbacks exist for
any individual properties in the property list, they are called before the
class 'create' callback.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hid_t
H5P_create_id(H5P_genclass_t *pclass, hbool_t app_ref)
{
H5P_genclass_t *tclass; /* Temporary class pointer */
H5P_genplist_t *plist = NULL; /* Property list created */
hid_t plist_id = FAIL; /* Property list ID */
hid_t ret_value; /* return value */
FUNC_ENTER_NOAPI(FAIL)
HDassert(pclass);
/* Create the new property list */
if((plist=H5P_create(pclass)) == NULL)
HGOTO_ERROR(H5E_PLIST, H5E_CANTCREATE, FAIL, "unable to create property list")
/* Get an atom for the property list */
if((plist_id = H5I_register(H5I_GENPROP_LST, plist, app_ref)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to atomize property list")
/* Save the property list ID in the property list struct, for use in the property class's 'close' callback */
plist->plist_id=plist_id;
/* Call the class callback (if it exists) now that we have the property list ID
* (up through chain of parent classes also)
*/
tclass = plist->pclass;
while(NULL != tclass) {
if(NULL != tclass->create_func) {
if((tclass->create_func)(plist_id, tclass->create_data) < 0) {
/* Delete ID, ignore return value */
H5I_remove(plist_id);
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL,"Can't initialize property")
} /* end if */
} /* end if */
/* Go up to parent class */
tclass = tclass->parent;
} /* end while */
/* Set the class initialization flag */
plist->class_init = TRUE;
/* Set the return value */
ret_value=plist_id;
done:
if(ret_value<0 && plist)
H5P_close(plist);
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_create_id() */
/*--------------------------------------------------------------------------
NAME
H5P_register_real
PURPOSE
Internal routine to register a new property in a property list class.
USAGE
herr_t H5P_register_real(class, name, size, default, prp_create, prp_set,
prp_get, prp_close, prp_encode, prp_decode)
H5P_genclass_t *class; IN: Property list class to modify
const char *name; IN: Name of property to register
size_t size; IN: Size of property in bytes
void *def_value; IN: Pointer to buffer containing default value
for property in newly created property lists
H5P_prp_create_func_t prp_create; IN: Function pointer to property
creation callback
H5P_prp_set_func_t prp_set; IN: Function pointer to property set callback
H5P_prp_get_func_t prp_get; IN: Function pointer to property get callback
H5P_prp_encode_func_t prp_encode; IN: Function pointer to property encode
H5P_prp_decode_func_t prp_decode; IN: Function pointer to property decode
H5P_prp_delete_func_t prp_delete; IN: Function pointer to property delete callback
H5P_prp_copy_func_t prp_copy; IN: Function pointer to property copy callback
H5P_prp_compare_func_t prp_cmp; IN: Function pointer to property compare callback
H5P_prp_close_func_t prp_close; IN: Function pointer to property close
callback
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Registers a new property with a property list class. The property will
exist in all property list objects of that class after this routine is
finished. The name of the property must not already exist. The default
property value must be provided and all new property lists created with this
property will have the property value set to the default provided. Any of
the callback routines may be set to NULL if they are not needed.
Zero-sized properties are allowed and do not store any data in the
property list. These may be used as flags to indicate the presence or
absence of a particular piece of information. The 'default' pointer for a
zero-sized property may be set to NULL. The property 'create' & 'close'
callbacks are called for zero-sized properties, but the 'set' and 'get'
callbacks are never called.
The 'create' callback is called when a new property list with this
property is being created. H5P_prp_create_func_t is defined as:
typedef herr_t (*H5P_prp_create_func_t)(hid_t prop_id, const char *name,
size_t size, void *initial_value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being created.
const char *name; IN: The name of the property being modified.
size_t size; IN: The size of the property value
void *initial_value; IN/OUT: The initial value for the property being created.
(The 'default' value passed to H5Pregister2)
The 'create' routine may modify the value to be set and those changes will
be stored as the initial value of the property. If the 'create' routine
returns a negative value, the new property value is not copied into the
property and the property list creation routine returns an error value.
The 'set' callback is called before a new value is copied into the
property. H5P_prp_set_func_t is defined as:
typedef herr_t (*H5P_prp_set_func_t)(hid_t prop_id, const char *name,
size_t size, void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being modified.
const char *name; IN: The name of the property being modified.
size_t size; IN: The size of the property value
void *new_value; IN/OUT: The value being set for the property.
The 'set' routine may modify the value to be set and those changes will be
stored as the value of the property. If the 'set' routine returns a
negative value, the new property value is not copied into the property and
the property list set routine returns an error value.
The 'get' callback is called before a value is retrieved from the
property. H5P_prp_get_func_t is defined as:
typedef herr_t (*H5P_prp_get_func_t)(hid_t prop_id, const char *name,
size_t size, void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being queried.
const char *name; IN: The name of the property being queried.
size_t size; IN: The size of the property value
void *value; IN/OUT: The value being retrieved for the property.
The 'get' routine may modify the value to be retrieved and those changes
will be returned to the calling function. If the 'get' routine returns a
negative value, the property value is returned and the property list get
routine returns an error value.
The 'delete' callback is called when a property is deleted from a
property list. H5P_prp_del_func_t is defined as:
typedef herr_t (*H5P_prp_del_func_t)(hid_t prop_id, const char *name,
size_t size, void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list the property is deleted from.
const char *name; IN: The name of the property being deleted.
size_t size; IN: The size of the property value
void *value; IN/OUT: The value of the property being deleted.
The 'delete' routine may modify the value passed in, but the value is not
used by the library when the 'delete' routine returns. If the
'delete' routine returns a negative value, the property list deletion
routine returns an error value but the property is still deleted.
The 'copy' callback is called when a property list with this
property is copied. H5P_prp_copy_func_t is defined as:
typedef herr_t (*H5P_prp_copy_func_t)(const char *name, size_t size,
void *value);
where the parameters to the callback function are:
const char *name; IN: The name of the property being copied.
size_t size; IN: The size of the property value
void *value; IN: The value of the property being copied.
The 'copy' routine may modify the value to be copied and those changes will be
stored as the value of the property. If the 'copy' routine returns a
negative value, the new property value is not copied into the property and
the property list copy routine returns an error value.
The 'compare' callback is called when a property list with this
property is compared to another property list. H5P_prp_compare_func_t is
defined as:
typedef int (*H5P_prp_compare_func_t)( void *value1, void *value2,
size_t size);
where the parameters to the callback function are:
const void *value1; IN: The value of the first property being compared.
const void *value2; IN: The value of the second property being compared.
size_t size; IN: The size of the property value
The 'compare' routine may not modify the values to be compared. The
'compare' routine should return a positive value if VALUE1 is greater than
VALUE2, a negative value if VALUE2 is greater than VALUE1 and zero if VALUE1
and VALUE2 are equal.
The 'close' callback is called when a property list with this
property is being destroyed. H5P_prp_close_func_t is defined as:
typedef herr_t (*H5P_prp_close_func_t)(const char *name, size_t size,
void *value);
where the parameters to the callback function are:
const char *name; IN: The name of the property being closed.
size_t size; IN: The size of the property value
void *value; IN: The value of the property being closed.
The 'close' routine may modify the value passed in, but the value is not
used by the library when the 'close' routine returns. If the
'close' routine returns a negative value, the property list close
routine returns an error value but the property list is still closed.
The 'encode' callback is called when a property list with this
property is being encoded. H5P_prp_encode_func_t is defined as:
typedef herr_t (*H5P_prp_encode_func_t)(void *f, size_t *size,
void *value, void *plist, uint8_t **buf);
where the parameters to the callback function are:
void *f; IN: A fake file structure used to encode.
size_t *size; IN/OUT: The size of the buffer to encode the property.
void *value; IN: The value of the property being encoded.
void *plist; IN: The property list structure.
uint8_t **buf; OUT: The buffer that holds the encoded property;
The 'encode' routine returns the size needed to encode the property value
if the buffer passed in is NULL or the size is zero. Otherwise it encodes
the property value into binary in buf.
The 'decode' callback is called when a property list with this
property is being decoded. H5P_prp_encode_func_t is defined as:
typedef herr_t (*H5P_prp_encode_func_t)(void *f, size_t *size,
void *value, void *plist, uint8_t **buf);
where the parameters to the callback function are:
void *f; IN: A fake file structure used to decode.
size_t *size; IN: UNUSED
void *value; IN: UNUSED
void *plist; IN: The property list structure.
uint8_t **buf; IN: The buffer that holds the binary encoded property;
The 'decode' routine decodes the binary buffer passed in and transforms it into
corresponding property values that are set in the property list passed in.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
The 'set' callback function may be useful to range check the value being
set for the property or may perform some tranformation/translation of the
value set. The 'get' callback would then [probably] reverse the
transformation, etc. A single 'get' or 'set' callback could handle
multiple properties by performing different actions based on the property
name or other properties in the property list.
I would like to say "the property list is not closed" when a 'close'
routine fails, but I don't think that's possible due to other properties in
the list being successfully closed & removed from the property list. I
suppose that it would be possible to just remove the properties which have
successful 'close' callbacks, but I'm not happy with the ramifications
of a mangled, un-closable property list hanging around... Any comments? -QAK
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_register_real(H5P_genclass_t *pclass, const char *name, size_t size,
const void *def_value, H5P_prp_create_func_t prp_create,
H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get,
H5P_prp_encode_func_t prp_encode, H5P_prp_decode_func_t prp_decode,
H5P_prp_delete_func_t prp_delete,
H5P_prp_copy_func_t prp_copy, H5P_prp_compare_func_t prp_cmp,
H5P_prp_close_func_t prp_close)
{
H5P_genprop_t *new_prop = NULL; /* Temporary property pointer */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
HDassert(pclass);
HDassert(0 == pclass->plists);
HDassert(0 == pclass->classes);
HDassert(name);
HDassert((size > 0 && def_value != NULL) || (size == 0));
/* Check for duplicate named properties */
if(NULL != H5SL_search(pclass->props, name))
HGOTO_ERROR(H5E_PLIST, H5E_EXISTS, FAIL, "property already exists")
/* Create property object from parameters */
if(NULL == (new_prop = H5P_create_prop(name, size, H5P_PROP_WITHIN_CLASS,
def_value, prp_create, prp_set, prp_get, prp_encode, prp_decode,
prp_delete, prp_copy, prp_cmp, prp_close)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCREATE, FAIL,"Can't create property")
/* Insert property into property list class */
if(H5P_add_prop(pclass->props, new_prop) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert property into class")
/* Increment property count for class */
pclass->nprops++;
/* Update the revision for the class */
pclass->revision = H5P_GET_NEXT_REV;
done:
if(ret_value < 0)
if(new_prop && H5P_free_prop(new_prop) < 0)
HDONE_ERROR(H5E_PLIST, H5E_CANTRELEASE, FAIL, "unable to close property")
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_register_real() */
/*--------------------------------------------------------------------------
NAME
H5P_register
PURPOSE
Internal routine to register a new property in a property list class.
USAGE
herr_t H5P_register(class, name, size, default, prp_create, prp_set, prp_get, prp_close)
H5P_genclass_t **class; IN: Property list class to modify
const char *name; IN: Name of property to register
size_t size; IN: Size of property in bytes
void *def_value; IN: Pointer to buffer containing default value
for property in newly created property lists
H5P_prp_create_func_t prp_create; IN: Function pointer to property
creation callback
H5P_prp_set_func_t prp_set; IN: Function pointer to property set callback
H5P_prp_get_func_t prp_get; IN: Function pointer to property get callback
H5P_prp_encode_func_t prp_encode; IN: Function pointer to property encode
H5P_prp_decode_func_t prp_decode; IN: Function pointer to property decode
H5P_prp_delete_func_t prp_delete; IN: Function pointer to property delete callback
H5P_prp_copy_func_t prp_copy; IN: Function pointer to property copy callback
H5P_prp_compare_func_t prp_cmp; IN: Function pointer to property compare callback
H5P_prp_close_func_t prp_close; IN: Function pointer to property close
callback
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Registers a new property with a property list class. The property will
exist in all property list objects of that class after this routine is
finished. The name of the property must not already exist. The default
property value must be provided and all new property lists created with this
property will have the property value set to the default provided. Any of
the callback routines may be set to NULL if they are not needed.
Zero-sized properties are allowed and do not store any data in the
property list. These may be used as flags to indicate the presence or
absence of a particular piece of information. The 'default' pointer for a
zero-sized property may be set to NULL. The property 'create' & 'close'
callbacks are called for zero-sized properties, but the 'set' and 'get'
callbacks are never called.
The 'create' callback is called when a new property list with this
property is being created. H5P_prp_create_func_t is defined as:
typedef herr_t (*H5P_prp_create_func_t)(hid_t prop_id, const char *name,
size_t size, void *initial_value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being created.
const char *name; IN: The name of the property being modified.
size_t size; IN: The size of the property value
void *initial_value; IN/OUT: The initial value for the property being created.
(The 'default' value passed to H5Pregister2)
The 'create' routine may modify the value to be set and those changes will
be stored as the initial value of the property. If the 'create' routine
returns a negative value, the new property value is not copied into the
property and the property list creation routine returns an error value.
The 'set' callback is called before a new value is copied into the
property. H5P_prp_set_func_t is defined as:
typedef herr_t (*H5P_prp_set_func_t)(hid_t prop_id, const char *name,
size_t size, void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being modified.
const char *name; IN: The name of the property being modified.
size_t size; IN: The size of the property value
void *new_value; IN/OUT: The value being set for the property.
The 'set' routine may modify the value to be set and those changes will be
stored as the value of the property. If the 'set' routine returns a
negative value, the new property value is not copied into the property and
the property list set routine returns an error value.
The 'get' callback is called before a value is retrieved from the
property. H5P_prp_get_func_t is defined as:
typedef herr_t (*H5P_prp_get_func_t)(hid_t prop_id, const char *name,
size_t size, void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being queried.
const char *name; IN: The name of the property being queried.
size_t size; IN: The size of the property value
void *value; IN/OUT: The value being retrieved for the property.
The 'get' routine may modify the value to be retrieved and those changes
will be returned to the calling function. If the 'get' routine returns a
negative value, the property value is returned and the property list get
routine returns an error value.
The 'encode' callback is called when a property list with this
property is being encoded. H5P_prp_encode_func_t is defined as:
typedef herr_t (*H5P_prp_encode_func_t)(void *f, size_t *size,
void *value, void *plist, uint8_t **buf);
where the parameters to the callback function are:
void *f; IN: A fake file structure used to encode.
size_t *size; IN/OUT: The size of the buffer to encode the property.
void *value; IN: The value of the property being encoded.
void *plist; IN: The property list structure.
uint8_t **buf; OUT: The buffer that holds the encoded property;
The 'encode' routine returns the size needed to encode the property value
if the buffer passed in is NULL or the size is zero. Otherwise it encodes
the property value into binary in buf.
The 'decode' callback is called when a property list with this
property is being decoded. H5P_prp_encode_func_t is defined as:
typedef herr_t (*H5P_prp_encode_func_t)(void *f, size_t *size,
void *value, void *plist, uint8_t **buf);
where the parameters to the callback function are:
void *f; IN: A fake file structure used to decode.
size_t *size; IN: UNUSED
void *value; IN: UNUSED
void *plist; IN: The property list structure.
uint8_t **buf; IN: The buffer that holds the binary encoded property;
The 'decode' routine decodes the binary buffer passed in and transforms it into
corresponding property values that are set in the property list passed in.
The 'delete' callback is called when a property is deleted from a
property list. H5P_prp_del_func_t is defined as:
typedef herr_t (*H5P_prp_del_func_t)(hid_t prop_id, const char *name,
size_t size, void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list the property is deleted from.
const char *name; IN: The name of the property being deleted.
size_t size; IN: The size of the property value
void *value; IN/OUT: The value of the property being deleted.
The 'delete' routine may modify the value passed in, but the value is not
used by the library when the 'delete' routine returns. If the
'delete' routine returns a negative value, the property list deletion
routine returns an error value but the property is still deleted.
The 'copy' callback is called when a property list with this
property is copied. H5P_prp_copy_func_t is defined as:
typedef herr_t (*H5P_prp_copy_func_t)(const char *name, size_t size,
void *value);
where the parameters to the callback function are:
const char *name; IN: The name of the property being copied.
size_t size; IN: The size of the property value
void *value; IN: The value of the property being copied.
The 'copy' routine may modify the value to be copied and those changes will be
stored as the value of the property. If the 'copy' routine returns a
negative value, the new property value is not copied into the property and
the property list copy routine returns an error value.
The 'compare' callback is called when a property list with this
property is compared to another property list. H5P_prp_compare_func_t is
defined as:
typedef int (*H5P_prp_compare_func_t)( void *value1, void *value2,
size_t size);
where the parameters to the callback function are:
const void *value1; IN: The value of the first property being compared.
const void *value2; IN: The value of the second property being compared.
size_t size; IN: The size of the property value
The 'compare' routine may not modify the values to be compared. The
'compare' routine should return a positive value if VALUE1 is greater than
VALUE2, a negative value if VALUE2 is greater than VALUE1 and zero if VALUE1
and VALUE2 are equal.
The 'close' callback is called when a property list with this
property is being destroyed. H5P_prp_close_func_t is defined as:
typedef herr_t (*H5P_prp_close_func_t)(const char *name, size_t size,
void *value);
where the parameters to the callback function are:
const char *name; IN: The name of the property being closed.
size_t size; IN: The size of the property value
void *value; IN: The value of the property being closed.
The 'close' routine may modify the value passed in, but the value is not
used by the library when the 'close' routine returns. If the
'close' routine returns a negative value, the property list close
routine returns an error value but the property list is still closed.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
The 'set' callback function may be useful to range check the value being
set for the property or may perform some tranformation/translation of the
value set. The 'get' callback would then [probably] reverse the
transformation, etc. A single 'get' or 'set' callback could handle
multiple properties by performing different actions based on the property
name or other properties in the property list.
I would like to say "the property list is not closed" when a 'close'
routine fails, but I don't think that's possible due to other properties in
the list being successfully closed & removed from the property list. I
suppose that it would be possible to just remove the properties which have
successful 'close' callbacks, but I'm not happy with the ramifications
of a mangled, un-closable property list hanging around... Any comments? -QAK
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_register(H5P_genclass_t **ppclass, const char *name, size_t size,
const void *def_value, H5P_prp_create_func_t prp_create,
H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get,
H5P_prp_encode_func_t prp_encode, H5P_prp_decode_func_t prp_decode,
H5P_prp_delete_func_t prp_delete,
H5P_prp_copy_func_t prp_copy, H5P_prp_compare_func_t prp_cmp,
H5P_prp_close_func_t prp_close)
{
H5P_genclass_t *pclass = *ppclass; /* Pointer to class to modify */
H5P_genclass_t *new_class = NULL; /* New class pointer */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
/* Sanity check */
HDassert(ppclass);
HDassert(pclass);
/* Check if class needs to be split because property lists or classes have
* been created since the last modification was made to the class.
*/
if(pclass->plists > 0 || pclass->classes > 0) {
if(NULL == (new_class = H5P_create_class(pclass->parent, pclass->name,
pclass->type, pclass->create_func, pclass->create_data,
pclass->copy_func, pclass->copy_data,
pclass->close_func, pclass->close_data)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, FAIL, "can't copy class")
/* Walk through the skip list of the old class and copy properties */
if(pclass->nprops > 0) {
H5SL_node_t *curr_node; /* Current node in skip list */
/* Walk through the properties in the old class */
curr_node = H5SL_first(pclass->props);
while(curr_node != NULL) {
H5P_genprop_t *pcopy; /* Property copy */
/* Make a copy of the class's property */
if(NULL == (pcopy = H5P_dup_prop((H5P_genprop_t *)H5SL_item(curr_node), H5P_PROP_WITHIN_CLASS)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, FAIL, "Can't copy property")
/* Insert the initialized property into the property class */
if(H5P_add_prop(new_class->props, pcopy) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert property into class")
/* Increment property count for class */
new_class->nprops++;
/* Get the next property node in the skip list */
curr_node = H5SL_next(curr_node);
} /* end while */
} /* end if */
/* Use the new class instead of the old one */
pclass = new_class;
} /* end if */
/* Really register the property in the class */
if(H5P_register_real(pclass, name, size, def_value, prp_create, prp_set, prp_get,
prp_encode, prp_decode, prp_delete, prp_copy, prp_cmp, prp_close) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTCREATE, FAIL, "can't register property")
/* Update pointer to pointer to class, if a new one was generated */
if(new_class)
*ppclass = pclass;
done:
if(ret_value < 0)
if(new_class && H5P_close_class(new_class) < 0)
HDONE_ERROR(H5E_PLIST, H5E_CANTRELEASE, FAIL, "unable to close new property class")
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_register() */
/*--------------------------------------------------------------------------
NAME
H5P_insert
PURPOSE
Internal routine to insert a new property in a property list.
USAGE
herr_t H5P_insert(plist, name, size, value, prp_set, prp_get, prp_close,
prp_encode, prp_decode)
H5P_genplist_t *plist; IN: Property list to add property to
const char *name; IN: Name of property to add
size_t size; IN: Size of property in bytes
void *value; IN: Pointer to the value for the property
H5P_prp_set_func_t prp_set; IN: Function pointer to property set callback
H5P_prp_get_func_t prp_get; IN: Function pointer to property get callback
H5P_prp_encode_func_t prp_encode; IN: Function pointer to property encode
H5P_prp_decode_func_t prp_decode; IN: Function pointer to property decode
H5P_prp_delete_func_t prp_delete; IN: Function pointer to property delete callback
H5P_prp_copy_func_t prp_copy; IN: Function pointer to property copy callback
H5P_prp_compare_func_t prp_cmp; IN: Function pointer to property compare callback
H5P_prp_close_func_t prp_close; IN: Function pointer to property close
callback
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Inserts a temporary property into a property list. The property will
exist only in this property list object. The name of the property must not
already exist. The value must be provided unless the property is zero-
sized. Any of the callback routines may be set to NULL if they are not
needed.
Zero-sized properties are allowed and do not store any data in the
property list. These may be used as flags to indicate the presence or
absence of a particular piece of information. The 'value' pointer for a
zero-sized property may be set to NULL. The property 'close' callback is
called for zero-sized properties, but the 'set' and 'get' callbacks are
never called.
The 'set' callback is called before a new value is copied into the
property. H5P_prp_set_func_t is defined as:
typedef herr_t (*H5P_prp_set_func_t)(hid_t prop_id, const char *name,
size_t size, void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being modified.
const char *name; IN: The name of the property being modified.
size_t size; IN: The size of the property value
void *new_value; IN/OUT: The value being set for the property.
The 'set' routine may modify the value to be set and those changes will be
stored as the value of the property. If the 'set' routine returns a
negative value, the new property value is not copied into the property and
the property list set routine returns an error value.
The 'get' callback is called before a value is retrieved from the
property. H5P_prp_get_func_t is defined as:
typedef herr_t (*H5P_prp_get_func_t)(hid_t prop_id, const char *name,
size_t size, void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being queried.
const char *name; IN: The name of the property being queried.
size_t size; IN: The size of the property value
void *value; IN/OUT: The value being retrieved for the property.
The 'get' routine may modify the value to be retrieved and those changes
will be returned to the calling function. If the 'get' routine returns a
negative value, the property value is returned and the property list get
routine returns an error value.
The 'encode' callback is called when a property list with this
property is being encoded. H5P_prp_encode_func_t is defined as:
typedef herr_t (*H5P_prp_encode_func_t)(void *f, size_t *size,
void *value, void *plist, uint8_t **buf);
where the parameters to the callback function are:
void *f; IN: A fake file structure used to encode.
size_t *size; IN/OUT: The size of the buffer to encode the property.
void *value; IN: The value of the property being encoded.
void *plist; IN: The property list structure.
uint8_t **buf; OUT: The buffer that holds the encoded property;
The 'encode' routine returns the size needed to encode the property value
if the buffer passed in is NULL or the size is zero. Otherwise it encodes
the property value into binary in buf.
The 'decode' callback is called when a property list with this
property is being decoded. H5P_prp_encode_func_t is defined as:
typedef herr_t (*H5P_prp_encode_func_t)(void *f, size_t *size,
void *value, void *plist, uint8_t **buf);
where the parameters to the callback function are:
void *f; IN: A fake file structure used to decode.
size_t *size; IN: UNUSED
void *value; IN: UNUSED
void *plist; IN: The property list structure.
uint8_t **buf; IN: The buffer that holds the binary encoded property;
The 'decode' routine decodes the binary buffer passed in and transforms it into
corresponding property values that are set in the property list passed in.
The 'delete' callback is called when a property is deleted from a
property list. H5P_prp_del_func_t is defined as:
typedef herr_t (*H5P_prp_del_func_t)(hid_t prop_id, const char *name,
size_t size, void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list the property is deleted from.
const char *name; IN: The name of the property being deleted.
size_t size; IN: The size of the property value
void *value; IN/OUT: The value of the property being deleted.
The 'delete' routine may modify the value passed in, but the value is not
used by the library when the 'delete' routine returns. If the
'delete' routine returns a negative value, the property list deletion
routine returns an error value but the property is still deleted.
The 'copy' callback is called when a property list with this
property is copied. H5P_prp_copy_func_t is defined as:
typedef herr_t (*H5P_prp_copy_func_t)(const char *name, size_t size,
void *value);
where the parameters to the callback function are:
const char *name; IN: The name of the property being copied.
size_t size; IN: The size of the property value
void *value; IN: The value of the property being copied.
The 'copy' routine may modify the value to be copied and those changes will be
stored as the value of the property. If the 'copy' routine returns a
negative value, the new property value is not copied into the property and
the property list copy routine returns an error value.
The 'compare' callback is called when a property list with this
property is compared to another property list. H5P_prp_compare_func_t is
defined as:
typedef int (*H5P_prp_compare_func_t)( void *value1, void *value2,
size_t size);
where the parameters to the callback function are:
const void *value1; IN: The value of the first property being compared.
const void *value2; IN: The value of the second property being compared.
size_t size; IN: The size of the property value
The 'compare' routine may not modify the values to be compared. The
'compare' routine should return a positive value if VALUE1 is greater than
VALUE2, a negative value if VALUE2 is greater than VALUE1 and zero if VALUE1
and VALUE2 are equal.
The 'close' callback is called when a property list with this
property is being destroyed. H5P_prp_close_func_t is defined as:
typedef herr_t (*H5P_prp_close_func_t)(const char *name, size_t size,
void *value);
where the parameters to the callback function are:
const char *name; IN: The name of the property being closed.
size_t size; IN: The size of the property value
void *value; IN: The value of the property being closed.
The 'close' routine may modify the value passed in, but the value is not
used by the library when the 'close' routine returns. If the
'close' routine returns a negative value, the property list close
routine returns an error value but the property list is still closed.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
The 'set' callback function may be useful to range check the value being
set for the property or may perform some tranformation/translation of the
value set. The 'get' callback would then [probably] reverse the
transformation, etc. A single 'get' or 'set' callback could handle
multiple properties by performing different actions based on the property
name or other properties in the property list.
There is no 'create' callback routine for temporary property list
objects, the initial value is assumed to have any necessary setup already
performed on it.
I would like to say "the property list is not closed" when a 'close'
routine fails, but I don't think that's possible due to other properties in
the list being successfully closed & removed from the property list. I
suppose that it would be possible to just remove the properties which have
successful 'close' callbacks, but I'm not happy with the ramifications
of a mangled, un-closable property list hanging around... Any comments? -QAK
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_insert(H5P_genplist_t *plist, const char *name, size_t size,
void *value, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get,
H5P_prp_encode_func_t prp_encode, H5P_prp_decode_func_t prp_decode,
H5P_prp_delete_func_t prp_delete, H5P_prp_copy_func_t prp_copy,
H5P_prp_compare_func_t prp_cmp, H5P_prp_close_func_t prp_close)
{
H5P_genprop_t *new_prop = NULL; /* Temporary property pointer */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(plist);
HDassert(name);
HDassert((size > 0 && value != NULL) || (size == 0));
/* Check for duplicate named properties */
if(NULL != H5SL_search(plist->props, name))
HGOTO_ERROR(H5E_PLIST, H5E_EXISTS, FAIL, "property already exists")
/* Check if the property has been deleted */
if(NULL != H5SL_search(plist->del, name)) {
char *temp_name = NULL;
/* Remove the property name from the deleted property skip list */
if(NULL == (temp_name = (char *)H5SL_remove(plist->del, name)))
HGOTO_ERROR(H5E_PLIST,H5E_CANTDELETE,FAIL,"can't remove property from deleted skip list")
/* free the name of the removed property */
H5MM_xfree(temp_name);
} /* end if */
else {
H5P_genclass_t *tclass; /* Temporary class pointer */
/* Check if the property is already in the class hierarchy */
tclass = plist->pclass;
while(tclass) {
if(tclass->nprops > 0) {
/* Find the property in the class */
if(NULL != H5SL_search(tclass->props, name))
HGOTO_ERROR(H5E_PLIST, H5E_EXISTS, FAIL, "property already exists")
} /* end if */
/* Go up to parent class */
tclass = tclass->parent;
} /* end while */
} /* end else */
/* Ok to add to property list */
/* Create property object from parameters */
if(NULL == (new_prop = H5P_create_prop(name, size, H5P_PROP_WITHIN_LIST, value, NULL,
prp_set, prp_get, prp_encode, prp_decode, prp_delete, prp_copy,
prp_cmp, prp_close)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCREATE, FAIL, "Can't create property")
/* Insert property into property list class */
if(H5P_add_prop(plist->props, new_prop) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "Can't insert property into class")
/* Increment property count for class */
plist->nprops++;
done:
if(ret_value < 0)
if(new_prop && H5P_free_prop(new_prop) < 0)
HDONE_ERROR(H5E_PLIST, H5E_CANTRELEASE, FAIL, "unable to close property")
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_insert() */
/*--------------------------------------------------------------------------
NAME
H5P_set
PURPOSE
Internal routine to set a property's value in a property list.
USAGE
herr_t H5P_set(plist, name, value)
H5P_genplist_t *plist; IN: Property list to find property in
const char *name; IN: Name of property to set
void *value; IN: Pointer to the value for the property
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Sets a new value for a property in a property list. The property name
must exist or this routine will fail. If there is a 'set' callback routine
registered for this property, the 'value' will be passed to that routine and
any changes to the 'value' will be used when setting the property value.
The information pointed at by the 'value' pointer (possibly modified by the
'set' callback) is copied into the property list value and may be changed
by the application making the H5Pset call without affecting the property
value.
If the 'set' callback routine returns an error, the property value will
not be modified. This routine may not be called for zero-sized properties
and will return an error in that case.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_set(H5P_genplist_t *plist, const char *name, const void *value)
{
H5P_genclass_t *tclass; /* Temporary class pointer */
H5P_genprop_t *prop; /* Temporary property pointer */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
HDassert(plist);
HDassert(name);
HDassert(value);
/* Check if the property has been deleted */
if(H5SL_search(plist->del,name)!=NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property doesn't exist")
/* Find property in changed list */
if(NULL != (prop = (H5P_genprop_t *)H5SL_search(plist->props, name))) {
/* Check for property size >0 */
if(prop->size==0)
HGOTO_ERROR(H5E_PLIST, H5E_BADVALUE, FAIL, "property has zero size")
/* Make a copy of the value and pass to 'set' callback */
if(prop->set!=NULL) {
void *tmp_value; /* Temporary value for property */
/* Make a copy of the current value, in case the callback fails */
if(NULL==(tmp_value=H5MM_malloc(prop->size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed temporary property value")
HDmemcpy(tmp_value,value,prop->size);
/* Call user's callback */
if((*(prop->set))(plist->plist_id,name,prop->size,tmp_value) < 0) {
H5MM_xfree(tmp_value);
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "can't set property value")
} /* end if */
/* Copy new [possibly unchanged] value into property value */
HDmemcpy(prop->value,tmp_value,prop->size);
/* Free the temporary value buffer */
H5MM_xfree(tmp_value);
} /* end if */
/* No 'set' callback, just copy value */
else
HDmemcpy(prop->value,value,prop->size);
} /* end if */
else {
/*
* Check if we should set class properties (up through list of parent classes also),
* & make property 'set' callback.
*/
tclass=plist->pclass;
while(tclass!=NULL) {
if(tclass->nprops>0) {
/* Find the property in the class */
if((prop = (H5P_genprop_t *)H5SL_search(tclass->props,name))!=NULL) {
H5P_genprop_t *pcopy; /* Copy of property to insert into skip list */
/* Check for property size >0 */
if(prop->size==0)
HGOTO_ERROR(H5E_PLIST,H5E_BADVALUE,FAIL,"property has zero size")
/* Make a copy of the value and pass to 'set' callback */
if(prop->set!=NULL) {
void *tmp_value; /* Temporary value for property */
/* Make a copy of the current value, in case the callback fails */
if(NULL==(tmp_value=H5MM_malloc(prop->size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed temporary property value")
HDmemcpy(tmp_value,value,prop->size);
/* Call user's callback */
if((*(prop->set))(plist->plist_id,name,prop->size,tmp_value) < 0) {
H5MM_xfree(tmp_value);
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "can't set property value")
} /* end if */
if((prop->cmp)(tmp_value,prop->value,prop->size)) {
/* Make a copy of the class's property */
if((pcopy=H5P_dup_prop(prop,H5P_PROP_WITHIN_LIST)) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTCOPY,FAIL,"Can't copy property")
/* Copy new value into property value */
HDmemcpy(pcopy->value,tmp_value,pcopy->size);
/* Insert the changed property into the property list */
if(H5P_add_prop(plist->props,pcopy) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert changed property into skip list")
} /* end if */
/* Free the temporary value buffer */
H5MM_xfree(tmp_value);
} /* end if */
/* No 'set' callback, just copy value */
else {
if((prop->cmp)(value,prop->value,prop->size)) {
/* Make a copy of the class's property */
if((pcopy=H5P_dup_prop(prop,H5P_PROP_WITHIN_LIST)) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTCOPY,FAIL,"Can't copy property")
HDmemcpy(pcopy->value,value,pcopy->size);
/* Insert the changed property into the property list */
if(H5P_add_prop(plist->props,pcopy) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert changed property into skip list")
} /* end if */
} /* end else */
/* Leave */
HGOTO_DONE(SUCCEED);
} /* end while */
} /* end if */
/* Go up to parent class */
tclass=tclass->parent;
} /* end while */
/* If we get this far, then it wasn't in the list of changed properties,
* nor in the properties in the class hierarchy, indicate an error
*/
HGOTO_ERROR(H5E_PLIST,H5E_NOTFOUND,FAIL,"can't find property in skip list")
} /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_set() */
/*--------------------------------------------------------------------------
NAME
H5P_exist_plist
PURPOSE
Internal routine to query the existance of a property in a property list.
USAGE
htri_t H5P_exist_plist(plist, name)
const H5P_genplist_t *plist; IN: Property list to check
const char *name; IN: Name of property to check for
RETURNS
Success: Positive if the property exists in the property list, zero
if the property does not exist.
Failure: negative value
DESCRIPTION
This routine checks if a property exists within a property list.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5P_exist_plist(const H5P_genplist_t *plist, const char *name)
{
htri_t ret_value = FAIL; /* return value */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(plist);
HDassert(name);
/* Check for property in deleted property list */
if(H5SL_search(plist->del, name) != NULL)
ret_value = FALSE;
else {
/* Check for property in changed property list */
if(H5SL_search(plist->props, name) != NULL)
ret_value = TRUE;
else {
H5P_genclass_t *tclass; /* Temporary class pointer */
tclass = plist->pclass;
while(tclass != NULL) {
if(H5SL_search(tclass->props, name) != NULL)
HGOTO_DONE(TRUE)
/* Go up to parent class */
tclass = tclass->parent;
} /* end while */
/* If we've reached here, we couldn't find the property */
ret_value = FALSE;
} /* end else */
} /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_exist_plist() */
/*--------------------------------------------------------------------------
NAME
H5P_exist_pclass
PURPOSE
Internal routine to query the existance of a property in a property class.
USAGE
herr_t H5P_exist_pclass(pclass, name)
H5P_genclass_t *pclass; IN: Property class to check
const char *name; IN: Name of property to check for
RETURNS
Success: Positive if the property exists in the property class, zero
if the property does not exist.
Failure: negative value
DESCRIPTION
This routine checks if a property exists within a property class.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5P_exist_pclass(H5P_genclass_t *pclass, const char *name)
{
htri_t ret_value = FAIL; /* return value */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(pclass);
HDassert(name);
/* Check for property in property list */
if(H5SL_search(pclass->props, name) != NULL)
ret_value = TRUE;
else {
H5P_genclass_t *tclass; /* Temporary class pointer */
tclass = pclass->parent;
while(tclass != NULL) {
if(H5SL_search(tclass->props, name) != NULL)
HGOTO_DONE(TRUE)
/* Go up to parent class */
tclass = tclass->parent;
} /* end while */
/* If we've reached here, we couldn't find the property */
ret_value = FALSE;
} /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_exist_pclass() */
/*--------------------------------------------------------------------------
NAME
H5P_get_size_plist
PURPOSE
Internal routine to query the size of a property in a property list.
USAGE
herr_t H5P_get_size_plist(plist, name)
const H5P_genplist_t *plist; IN: Property list to check
const char *name; IN: Name of property to query
size_t *size; OUT: Size of property
RETURNS
Success: non-negative value
Failure: negative value
DESCRIPTION
This routine retrieves the size of a property's value in bytes. Zero-
sized properties are allowed and return a value of 0.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_get_size_plist(const H5P_genplist_t *plist, const char *name, size_t *size)
{
H5P_genprop_t *prop; /* Temporary property pointer */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(plist);
HDassert(name);
HDassert(size);
/* Find property */
if(NULL == (prop = H5P__find_prop_plist(plist, name)))
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property doesn't exist")
/* Get property size */
*size = prop->size;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_get_size_plist() */
/*--------------------------------------------------------------------------
NAME
H5P_get_size_pclass
PURPOSE
Internal routine to query the size of a property in a property class.
USAGE
herr_t H5P_get_size_pclass(pclass, name)
H5P_genclass_t *pclass; IN: Property class to check
const char *name; IN: Name of property to query
size_t *size; OUT: Size of property
RETURNS
Success: non-negative value
Failure: negative value
DESCRIPTION
This routine retrieves the size of a property's value in bytes. Zero-
sized properties are allowed and return a value of 0.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_get_size_pclass(H5P_genclass_t *pclass, const char *name, size_t *size)
{
H5P_genprop_t *prop; /* Temporary property pointer */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(pclass);
HDassert(name);
HDassert(size);
/* Find property */
if((prop=H5P_find_prop_pclass(pclass,name)) == NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property doesn't exist")
/* Get property size */
*size=prop->size;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_get_size_pclass() */
/*--------------------------------------------------------------------------
NAME
H5P_get_class
PURPOSE
Internal routine to query the class of a generic property list
USAGE
H5P_genclass_t *H5P_get_class(plist)
H5P_genplist_t *plist; IN: Property list to check
RETURNS
Success: Pointer to the class for a property list
Failure: NULL
DESCRIPTION
This routine retrieves a pointer to the class for a property list.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5P_genclass_t *
H5P_get_class(const H5P_genplist_t *plist)
{
H5P_genclass_t *ret_value; /* return value */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(plist);
/* Get property size */
ret_value = plist->pclass;
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_get_class() */
/*--------------------------------------------------------------------------
NAME
H5P_get_nprops_plist
PURPOSE
Internal routine to query the number of properties in a property list
USAGE
herr_t H5P_get_nprops_plist(plist, nprops)
H5P_genplist_t *plist; IN: Property list to check
size_t *nprops; OUT: Number of properties in the property list
RETURNS
Success: non-negative value
Failure: negative value
DESCRIPTION
This routine retrieves the number of a properties in a property list.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_get_nprops_plist(const H5P_genplist_t *plist, size_t *nprops)
{
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(plist);
HDassert(nprops);
/* Get property size */
*nprops = plist->nprops;
FUNC_LEAVE_NOAPI(SUCCEED)
} /* H5P_get_nprops_plist() */
/*--------------------------------------------------------------------------
NAME
H5P_get_nprops_pclass
PURPOSE
Internal routine to query the number of properties in a property class
USAGE
herr_t H5P_get_nprops_pclass(pclass, nprops)
H5P_genclass_t *pclass; IN: Property class to check
size_t *nprops; OUT: Number of properties in the property list
hbool_t recurse; IN: Include properties in parent class(es) also
RETURNS
Success: non-negative value (can't fail)
Failure: negative value
DESCRIPTION
This routine retrieves the number of a properties in a property class.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_get_nprops_pclass(const H5P_genclass_t *pclass, size_t *nprops, hbool_t recurse)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
HDassert(pclass);
HDassert(nprops);
/* Get number of properties */
*nprops = pclass->nprops;
/* Check if the class is derived, and walk up the chain, if so */
if(recurse)
while(pclass->parent != NULL) {
pclass = pclass->parent;
*nprops += pclass->nprops;
} /* end while */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_get_nprops_pclass() */
/*--------------------------------------------------------------------------
NAME
H5P_cmp_prop
PURPOSE
Internal routine to compare two generic properties
USAGE
int H5P_cmp_prop(prop1, prop2)
H5P_genprop_t *prop1; IN: 1st property to compare
H5P_genprop_t *prop1; IN: 2nd property to compare
RETURNS
Success: negative if prop1 "less" than prop2, positive if prop1 "greater"
than prop2, zero if prop1 is "equal" to prop2
Failure: can't fail
DESCRIPTION
This function compares two generic properties together to see if
they are the same property.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int
H5P_cmp_prop(const H5P_genprop_t *prop1, const H5P_genprop_t *prop2)
{
int cmp_value; /* Value from comparison */
int ret_value = 0; /* return value */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(prop1);
HDassert(prop2);
/* Check the name */
if((cmp_value = HDstrcmp(prop1->name, prop2->name)) != 0)
HGOTO_DONE(cmp_value);
/* Check the size of properties */
if(prop1->size < prop2->size) HGOTO_DONE(-1);
if(prop1->size > prop2->size) HGOTO_DONE(1);
/* Check if they both have the same 'create' callback */
if(prop1->create == NULL && prop2->create != NULL) HGOTO_DONE(-1);
if(prop1->create != NULL && prop2->create == NULL) HGOTO_DONE(1);
if(prop1->create != prop2->create) HGOTO_DONE(-1);
/* Check if they both have the same 'set' callback */
if(prop1->set == NULL && prop2->set != NULL) HGOTO_DONE(-1);
if(prop1->set != NULL && prop2->set == NULL) HGOTO_DONE(1);
if(prop1->set != prop2->set) HGOTO_DONE(-1);
/* Check if they both have the same 'get' callback */
if(prop1->get == NULL && prop2->get != NULL) HGOTO_DONE(-1);
if(prop1->get != NULL && prop2->get == NULL) HGOTO_DONE(1);
if(prop1->get != prop2->get) HGOTO_DONE(-1);
/* Check if they both have the same 'encode' callback */
if(prop1->encode == NULL && prop2->encode != NULL) HGOTO_DONE(-1);
if(prop1->encode != NULL && prop2->encode == NULL) HGOTO_DONE(1);
if(prop1->encode != prop2->encode) HGOTO_DONE(-1);
/* Check if they both have the same 'decode' callback */
if(prop1->decode == NULL && prop2->decode != NULL) HGOTO_DONE(-1);
if(prop1->decode != NULL && prop2->decode == NULL) HGOTO_DONE(1);
if(prop1->decode != prop2->decode) HGOTO_DONE(-1);
/* Check if they both have the same 'delete' callback */
if(prop1->del == NULL && prop2->del != NULL) HGOTO_DONE(-1);
if(prop1->del != NULL && prop2->del == NULL) HGOTO_DONE(1);
if(prop1->del != prop2->del) HGOTO_DONE(-1);
/* Check if they both have the same 'copy' callback */
if(prop1->copy == NULL && prop2->copy != NULL) HGOTO_DONE(-1);
if(prop1->copy != NULL && prop2->copy == NULL) HGOTO_DONE(1);
if(prop1->copy != prop2->copy) HGOTO_DONE(-1);
/* Check if they both have the same 'compare' callback */
if(prop1->cmp == NULL && prop2->cmp != NULL) HGOTO_DONE(-1);
if(prop1->cmp != NULL && prop2->cmp == NULL) HGOTO_DONE(1);
if(prop1->cmp != prop2->cmp) HGOTO_DONE(-1);
/* Check if they both have the same 'close' callback */
if(prop1->close == NULL && prop2->close != NULL) HGOTO_DONE(-1);
if(prop1->close != NULL && prop2->close == NULL) HGOTO_DONE(1);
if(prop1->close != prop2->close) HGOTO_DONE(-1);
/* Check if they both have values allocated (or not allocated) */
if(prop1->value == NULL && prop2->value != NULL) HGOTO_DONE(-1);
if(prop1->value != NULL && prop2->value == NULL) HGOTO_DONE(1);
if(prop1->value != NULL) {
/* Call comparison routine */
if((cmp_value = prop1->cmp(prop1->value, prop2->value, prop1->size)) != 0)
HGOTO_DONE(cmp_value);
} /* end if */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_cmp_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_cmp_class
PURPOSE
Internal routine to compare two generic property classes
USAGE
int H5P_cmp_class(pclass1, pclass2)
H5P_genclass_t *pclass1; IN: 1st property class to compare
H5P_genclass_t *pclass2; IN: 2nd property class to compare
RETURNS
Success: negative if class1 "less" than class2, positive if class1 "greater"
than class2, zero if class1 is "equal" to class2
Failure: can't fail
DESCRIPTION
This function compares two generic property classes together to see if
they are the same class.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
int
H5P_cmp_class(const H5P_genclass_t *pclass1, const H5P_genclass_t *pclass2)
{
H5SL_node_t *tnode1, *tnode2; /* Temporary pointer to property nodes */
int cmp_value; /* Value from comparison */
int ret_value = 0; /* Return value */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(pclass1);
HDassert(pclass2);
/* Use the revision number to quickly check for identical classes */
if(pclass1->revision == pclass2->revision)
HGOTO_DONE(0);
/* Check the name */
if((cmp_value = HDstrcmp(pclass1->name, pclass2->name)) != 0)
HGOTO_DONE(cmp_value);
/* Check the number of properties */
if(pclass1->nprops < pclass2->nprops) HGOTO_DONE(-1);
if(pclass1->nprops > pclass2->nprops) HGOTO_DONE(1);
/* Check the number of property lists created from the class */
if(pclass1->plists < pclass2->plists) HGOTO_DONE(-1);
if(pclass1->plists > pclass2->plists) HGOTO_DONE(1);
/* Check the number of classes derived from the class */
if(pclass1->classes < pclass2->classes) HGOTO_DONE(-1);
if(pclass1->classes > pclass2->classes) HGOTO_DONE(1);
/* Check the number of ID references open on the class */
if(pclass1->ref_count < pclass2->ref_count) HGOTO_DONE(-1);
if(pclass1->ref_count > pclass2->ref_count) HGOTO_DONE(1);
/* Check the property list types */
if(pclass1->type < pclass2->type) HGOTO_DONE(-1);
if(pclass1->type > pclass2->type) HGOTO_DONE(1);
/* Check whether they are deleted or not */
if(pclass1->deleted < pclass2->deleted) HGOTO_DONE(-1);
if(pclass1->deleted > pclass2->deleted) HGOTO_DONE(1);
/* Check whether they have creation callback functions & data */
if(pclass1->create_func == NULL && pclass2->create_func != NULL) HGOTO_DONE(-1);
if(pclass1->create_func != NULL && pclass2->create_func == NULL) HGOTO_DONE(1);
if(pclass1->create_func != pclass2->create_func) HGOTO_DONE(-1);
if(pclass1->create_data < pclass2->create_data) HGOTO_DONE(-1);
if(pclass1->create_data > pclass2->create_data) HGOTO_DONE(1);
/* Check whether they have close callback functions & data */
if(pclass1->close_func == NULL && pclass2->close_func != NULL) HGOTO_DONE(-1);
if(pclass1->close_func != NULL && pclass2->close_func == NULL) HGOTO_DONE(1);
if(pclass1->close_func != pclass2->close_func) HGOTO_DONE(-1);
if(pclass1->close_data < pclass2->close_data) HGOTO_DONE(-1);
if(pclass1->close_data > pclass2->close_data) HGOTO_DONE(1);
/* Cycle through the properties and compare them also */
tnode1 = H5SL_first(pclass1->props);
tnode2 = H5SL_first(pclass2->props);
while(tnode1 || tnode2) {
H5P_genprop_t *prop1, *prop2; /* Property for node */
/* Check if they both have properties in this skip list node */
if(tnode1 == NULL && tnode2 != NULL) HGOTO_DONE(-1);
if(tnode1 != NULL && tnode2 == NULL) HGOTO_DONE(1);
/* Compare the two properties */
prop1 = (H5P_genprop_t *)H5SL_item(tnode1);
prop2 = (H5P_genprop_t *)H5SL_item(tnode2);
if((cmp_value = H5P_cmp_prop(prop1, prop2)) != 0)
HGOTO_DONE(cmp_value);
/* Advance the pointers */
tnode1 = H5SL_next(tnode1);
tnode2 = H5SL_next(tnode2);
} /* end while */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_cmp_class() */
/*--------------------------------------------------------------------------
NAME
H5P__cmp_plist_cb
PURPOSE
Internal callback routine when iterating over properties in property list
to compare them for equality
USAGE
int H5P__cmp_plist_cb(prop, udata)
H5P_genprop_t *prop; IN: Pointer to the property
void *udata; IN/OUT: Pointer to iteration data from user
RETURNS
Success: Returns whether to continue (H5_ITER_CONT) or stop (H5_ITER_STOP)
iterating over the property lists.
Failure: Negative value (H5_ITER_ERROR)
DESCRIPTION
This routine compares a property from one property list (the one being
iterated over, to a property from the second property list (which is
looked up). Iteration is stopped if the comparison is non-equal.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int
H5P__cmp_plist_cb(H5P_genprop_t *prop, void *_udata)
{
H5P_plist_cmp_ud_t *udata = (H5P_plist_cmp_ud_t *)_udata; /* Pointer to user data */
htri_t prop2_exist; /* Whether the property exists in the second property list */
int ret_value = H5_ITER_CONT; /* Return value */
FUNC_ENTER_STATIC
/* Sanity check */
HDassert(prop);
HDassert(udata);
/* Check if the property exists in the second property list */
if((prop2_exist = H5P_exist_plist(udata->plist2, prop->name)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, H5_ITER_ERROR, "can't lookup existance of property?")
if(prop2_exist) {
const H5P_genprop_t *prop2; /* Pointer to property in second plist */
/* Look up same property in second property list */
if(NULL == (prop2 = H5P__find_prop_plist(udata->plist2, prop->name)))
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, H5_ITER_ERROR, "property doesn't exist")
/* Compare the two properties */
if((udata->cmp_value = H5P_cmp_prop(prop, prop2)) != 0)
HGOTO_DONE(H5_ITER_STOP);
} /* end if */
else {
/* Property exists in first list, but not second */
udata->cmp_value = 1;
HGOTO_DONE(H5_ITER_STOP);
} /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5P__cmp_plist_cb() */
/*--------------------------------------------------------------------------
NAME
H5P_cmp_plist
PURPOSE
Internal routine to compare two generic property lists
USAGE
herr_t H5P_cmp_plist(plist1, plist2, cmp_ret)
H5P_genplist_t *plist1; IN: 1st property list to compare
H5P_genplist_t *plist2; IN: 2nd property list to compare
int *cmp_ret; OUT: Comparison value for two property lists
Negative if list1 "less" than list2,
positive if list1 "greater" than list2,
zero if list1 is "equal" to list2
RETURNS
Success: non-negative value
Failure: negative value
DESCRIPTION
This function compares two generic property lists together to see if
they are equal.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_cmp_plist(const H5P_genplist_t *plist1, const H5P_genplist_t *plist2,
int *cmp_ret)
{
H5P_plist_cmp_ud_t udata; /* User data for callback */
int idx = 0; /* Index of property to begin with */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(plist1);
HDassert(plist2);
HDassert(cmp_ret);
/* Check the number of properties */
if(plist1->nprops < plist2->nprops) {
*cmp_ret = -1;
HGOTO_DONE(SUCCEED);
} /* end if */
if(plist1->nprops > plist2->nprops) {
*cmp_ret = 1;
HGOTO_DONE(SUCCEED);
} /* end if */
/* Check whether they've been initialized */
if(plist1->class_init < plist2->class_init) {
*cmp_ret = -1;
HGOTO_DONE(SUCCEED);
} /* end if */
if(plist1->class_init > plist2->class_init) {
*cmp_ret = 1;
HGOTO_DONE(SUCCEED);
} /* end if */
/* Set up iterator callback info */
udata.cmp_value = 0;
udata.plist2 = plist2;
/* Iterate over properties in first property list */
if((ret_value = H5P_iterate_plist(plist1, TRUE, &idx, H5P__cmp_plist_cb, &udata)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to iterate over list")
if(ret_value != 0) {
*cmp_ret = udata.cmp_value;
HGOTO_DONE(SUCCEED);
} /* end if */
/* Check the parent classes */
if((*cmp_ret = H5P_cmp_class(plist1->pclass, plist2->pclass)) != 0)
HGOTO_DONE(SUCCEED);
/* Property lists must be equal, set comparison value to 0 */
*cmp_ret = 0;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_cmp_plist() */
/*--------------------------------------------------------------------------
NAME
H5P_isa_class_real
PURPOSE
Internal routine to query whether a property class is the same as another
class.
USAGE
htri_t H5P_isa_class_real(pclass1, pclass2)
H5P_genclass_t *pclass1; IN: Property class to check
H5P_genclass_t *pclass2; IN: Property class to compare with
RETURNS
Success: TRUE (1) or FALSE (0)
Failure: negative value
DESCRIPTION
This routine queries whether a property class is the same as another class,
and walks up the hierarchy of derived classes, checking if the first class
is derived from the second class also.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static htri_t
H5P_isa_class_real(H5P_genclass_t *pclass1, H5P_genclass_t *pclass2)
{
htri_t ret_value;
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(pclass1);
HDassert(pclass2);
/* Compare property classes */
if(H5P_cmp_class(pclass1, pclass2) == 0) {
HGOTO_DONE(TRUE);
} else {
/* Check if the class is derived, and walk up the chain, if so */
if(pclass1->parent != NULL)
ret_value = H5P_isa_class_real(pclass1->parent, pclass2);
else
HGOTO_DONE(FALSE);
} /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_isa_class_real() */
/*--------------------------------------------------------------------------
NAME
H5P_isa_class
PURPOSE
Internal routine to query whether a property list is a certain class
USAGE
hid_t H5P_isa_class(plist_id, pclass_id)
hid_t plist_id; IN: Property list to query
hid_t pclass_id; IN: Property class to query
RETURNS
Success: TRUE (1) or FALSE (0)
Failure: negative
DESCRIPTION
This routine queries whether a property list is a member of the property
list class.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
This function is special in that it is an internal library function, but
accepts hid_t's as parameters. Since it is used in basically the same way
as the H5I functions, this should be OK. Don't make more library functions
which accept hid_t's without thorough discussion. -QAK
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5P_isa_class(hid_t plist_id, hid_t pclass_id)
{
H5P_genplist_t *plist; /* Property list to query */
H5P_genclass_t *pclass; /* Property list class */
htri_t ret_value; /* return value */
FUNC_ENTER_NOAPI(FAIL)
/* Check arguments. */
if(NULL == (plist = (H5P_genplist_t *)H5I_object_verify(plist_id, H5I_GENPROP_LST)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list")
if(NULL == (pclass = (H5P_genclass_t *)H5I_object_verify(pclass_id, H5I_GENPROP_CLS)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property class")
/* Compare the property list's class against the other class */
if((ret_value = H5P_isa_class_real(plist->pclass, pclass)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to compare property list classes")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_isa_class() */
/*--------------------------------------------------------------------------
NAME
H5P_object_verify
PURPOSE
Internal routine to query whether a property list is a certain class and
retrieve the property list object associated with it.
USAGE
void *H5P_object_verify(plist_id, pclass_id)
hid_t plist_id; IN: Property list to query
hid_t pclass_id; IN: Property class to query
RETURNS
Success: valid pointer to a property list object
Failure: NULL
DESCRIPTION
This routine queries whether a property list is member of a certain class
and retrieves the property list object associated with it.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
This function is special in that it is an internal library function, but
accepts hid_t's as parameters. Since it is used in basically the same way
as the H5I functions, this should be OK. Don't make more library functions
which accept hid_t's without thorough discussion. -QAK
This function is similar (in spirit) to H5I_object_verify()
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5P_genplist_t *
H5P_object_verify(hid_t plist_id, hid_t pclass_id)
{
H5P_genplist_t *ret_value; /* return value */
FUNC_ENTER_NOAPI(NULL)
/* Compare the property list's class against the other class */
if(H5P_isa_class(plist_id, pclass_id) != TRUE)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, NULL, "property list is not a member of the class")
/* Get the plist structure */
if(NULL == (ret_value = (H5P_genplist_t *)H5I_object(plist_id)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, NULL, "can't find object for ID")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_object_verify() */
/*--------------------------------------------------------------------------
NAME
H5P__iterate_plist_cb
PURPOSE
Internal callback routine when iterating over properties in property list
USAGE
int H5P__iterate_plist_cb(item, key, udata)
void *item; IN: Pointer to the property
void *key; IN: Pointer to the property's name
void *udata; IN/OUT: Pointer to iteration data from user
RETURNS
Success: Returns the return value of the last call to ITER_FUNC
DESCRIPTION
This routine calls the actual callback routine for the property in the
property list.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int
H5P__iterate_plist_cb(void *_item, void *_key, void *_udata)
{
H5P_genprop_t *item = (H5P_genprop_t *)_item; /* Pointer to the property */
char *key = (char *)_key; /* Pointer to the property's name */
H5P_iter_plist_ud_t *udata = (H5P_iter_plist_ud_t *)_udata; /* Pointer to user data */
int ret_value = H5_ITER_CONT; /* Return value */
FUNC_ENTER_STATIC
/* Sanity check */
HDassert(item);
HDassert(key);
/* Check if we've found the correctly indexed property */
if(*udata->curr_idx_ptr >= udata->prev_idx) {
/* Call the callback function */
ret_value = (*udata->cb_func)(item, udata->udata);
if(ret_value != 0)
HGOTO_DONE(ret_value);
} /* end if */
/* Increment the current index */
(*udata->curr_idx_ptr)++;
/* Add property name to 'seen' list */
if(H5SL_insert(udata->seen, key, key) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, H5_ITER_ERROR, "can't insert property into 'seen' skip list")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5P__iterate_plist_cb() */
/*--------------------------------------------------------------------------
NAME
H5P__iterate_plist_pclass_cb
PURPOSE
Internal callback routine when iterating over properties in property class
USAGE
int H5P__iterate_plist_pclass_cb(item, key, udata)
void *item; IN: Pointer to the property
void *key; IN: Pointer to the property's name
void *udata; IN/OUT: Pointer to iteration data from user
RETURNS
Success: Returns the return value of the last call to ITER_FUNC
DESCRIPTION
This routine verifies that the property hasn't already been seen or was
deleted, and then chains to the property list callback.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int
H5P__iterate_plist_pclass_cb(void *_item, void *_key, void *_udata)
{
H5P_genprop_t *item = (H5P_genprop_t *)_item; /* Pointer to the property */
char *key = (char *)_key; /* Pointer to the property's name */
H5P_iter_plist_ud_t *udata = (H5P_iter_plist_ud_t *)_udata; /* Pointer to user data */
int ret_value = H5_ITER_CONT; /* Return value */
FUNC_ENTER_STATIC_NOERR
/* Sanity check */
HDassert(item);
HDassert(key);
/* Only call iterator callback for properties we haven't seen
* before and that haven't been deleted.
*/
if(NULL == H5SL_search(udata->seen, key) &&
NULL == H5SL_search(udata->plist->del, key))
ret_value = H5P__iterate_plist_cb(item, key, udata);
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5P__iterate_plist_pclass_cb() */
/*--------------------------------------------------------------------------
NAME
H5P_iterate_plist
PURPOSE
Internal routine to iterate over the properties in a property list
USAGE
int H5P_iterate_plist(plist, iter_all_prop, idx, cb_func, iter_data)
const H5P_genplist_t *plist; IN: Property list to iterate over
hbool_t iter_all_prop; IN: Whether to iterate over all properties
(TRUE), or just non-default (i.e. changed)
properties (FALSE).
int *idx; IN/OUT: Index of the property to begin with
H5P_iterate_t cb_func; IN: Function pointer to function to be
called with each property iterated over.
void *iter_data; IN/OUT: Pointer to iteration data from user
RETURNS
Success: Returns the return value of the last call to ITER_FUNC if it was
non-zero, or zero if all properties have been processed.
Failure: negative value
DESCRIPTION
This routine iterates over the properties in the property object specified
with PLIST_ID. For each property in the object, the ITER_DATA and some
additional information, specified below, are passed to the ITER_FUNC function.
The iteration begins with the IDX property in the object and the next element
to be processed by the operator is returned in IDX. If IDX is NULL, then the
iterator starts at the first property; since no stopping point is returned in
this case, the iterator cannot be restarted if one of the calls to its operator
returns non-zero.
The prototype for H5P_iterate_t is:
typedef herr_t (*H5P_iterate_t)(hid_t id, const char *name, void *iter_data);
The operation receives the property list or class identifier for the object
being iterated over, ID, the name of the current property within the object,
NAME, and the pointer to the operator data passed in to H5Piterate, ITER_DATA.
The return values from an operator are:
Zero causes the iterator to continue, returning zero when all properties
have been processed.
Positive causes the iterator to immediately return that positive value,
indicating short-circuit success. The iterator can be restarted at the
index of the next property.
Negative causes the iterator to immediately return that value, indicating
failure. The iterator can be restarted at the index of the next
property.
H5Piterate assumes that the properties in the object identified by ID remains
unchanged through the iteration. If the membership changes during the
iteration, the function's behavior is undefined.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
int
H5P_iterate_plist(const H5P_genplist_t *plist, hbool_t iter_all_prop, int *idx,
H5P_iterate_int_t cb_func, void *udata)
{
H5P_genclass_t *tclass; /* Temporary class pointer */
H5P_iter_plist_ud_t udata_int; /* User data for skip list iterator */
H5SL_t *seen = NULL; /* Skip list to hold names of properties already seen */
int curr_idx = 0; /* Current iteration index */
int ret_value = 0; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* Sanity check */
HDassert(plist);
HDassert(idx);
HDassert(cb_func);
/* Create the skip list to hold names of properties already seen */
if(NULL == (seen = H5SL_create(H5SL_TYPE_STR, NULL)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCREATE, FAIL, "can't create skip list for seen properties")
/* Set up iterator callback info */
udata_int.plist = plist;
udata_int.cb_func = cb_func;
udata_int.udata = udata;
udata_int.seen = seen;
udata_int.curr_idx_ptr = &curr_idx;
udata_int.prev_idx = *idx;
/* Iterate over properties in property list proper */
/* (Will be only the non-default (i.e. changed) properties) */
ret_value = H5SL_iterate(plist->props, H5P__iterate_plist_cb, &udata_int);
if(ret_value != 0)
HGOTO_DONE(ret_value);
/* Check for iterating over all properties, or just non-default ones */
if(iter_all_prop) {
/* Walk up the class hiearchy */
tclass = plist->pclass;
while(tclass != NULL) {
/* Iterate over properties in property list class */
ret_value = H5SL_iterate(tclass->props, H5P__iterate_plist_pclass_cb, &udata_int);
if(ret_value != 0)
HGOTO_DONE(ret_value);
/* Go up to parent class */
tclass = tclass->parent;
} /* end while */
} /* end if */
done:
/* Set the index we stopped at */
*idx = curr_idx;
/* Release the skip list of 'seen' properties */
if(seen != NULL)
H5SL_close(seen);
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_iterate_plist() */
/*--------------------------------------------------------------------------
NAME
H5P__iterate_pclass_cb
PURPOSE
Internal callback routine when iterating over properties in property list
class
USAGE
int H5P__iterate_pclass_cb(item, key, udata)
void *item; IN: Pointer to the property
void *key; IN: Pointer to the property's name
void *udata; IN/OUT: Pointer to iteration data from user
RETURNS
Success: Returns the return value of the last call to ITER_FUNC
DESCRIPTION
This routine calls the actual callback routine for the property in the
property list class.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int
H5P__iterate_pclass_cb(void *_item, void *_key, void *_udata)
{
H5P_genprop_t *item = (H5P_genprop_t *)_item; /* Pointer to the property */
char *key = (char *)_key; /* Pointer to the property's name */
H5P_iter_pclass_ud_t *udata = (H5P_iter_pclass_ud_t *)_udata; /* Pointer to user data */
int ret_value = 0; /* Return value */
FUNC_ENTER_STATIC_NOERR
/* Sanity check */
HDassert(item);
HDassert(key);
/* Check if we've found the correctly indexed property */
if(*udata->curr_idx_ptr >= udata->prev_idx) {
/* Call the callback function */
ret_value = (*udata->cb_func)(item, udata->udata);
if(ret_value != 0)
HGOTO_DONE(ret_value);
} /* end if */
/* Increment the current index */
(*udata->curr_idx_ptr)++;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5P__iterate_pclass_cb() */
/*--------------------------------------------------------------------------
NAME
H5P_iterate_pclass
PURPOSE
Internal routine to iterate over the properties in a property class
USAGE
herr_t H5P_iterate_pclass(pclass, idx, cb_func, iter_data)
const H5P_genpclass_t *pclass; IN: Property list class to iterate over
int *idx; IN/OUT: Index of the property to begin with
H5P_iterate_t cb_func; IN: Function pointer to function to be
called with each property iterated over.
void *iter_data; IN/OUT: Pointer to iteration data from user
RETURNS
Success: Returns the return value of the last call to ITER_FUNC if it was
non-zero, or zero if all properties have been processed.
Failure: negative value
DESCRIPTION
This routine iterates over the properties in the property object specified
with PCLASS_ID. For each property in the object, the ITER_DATA and some
additional information, specified below, are passed to the ITER_FUNC function.
The iteration begins with the IDX property in the object and the next element
to be processed by the operator is returned in IDX. If IDX is NULL, then the
iterator starts at the first property; since no stopping point is returned in
this case, the iterator cannot be restarted if one of the calls to its operator
returns non-zero.
The prototype for H5P_iterate_t is:
typedef herr_t (*H5P_iterate_t)(hid_t id, const char *name, void *iter_data);
The operation receives the property list or class identifier for the object
being iterated over, ID, the name of the current property within the object,
NAME, and the pointer to the operator data passed in to H5Piterate, ITER_DATA.
The return values from an operator are:
Zero causes the iterator to continue, returning zero when all properties
have been processed.
Positive causes the iterator to immediately return that positive value,
indicating short-circuit success. The iterator can be restarted at the
index of the next property.
Negative causes the iterator to immediately return that value, indicating
failure. The iterator can be restarted at the index of the next
property.
H5Piterate assumes that the properties in the object identified by ID remains
unchanged through the iteration. If the membership changes during the
iteration, the function's behavior is undefined.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
int
H5P_iterate_pclass(const H5P_genclass_t *pclass, int *idx,
H5P_iterate_int_t cb_func, void *udata)
{
H5P_iter_pclass_ud_t udata_int; /* User data for skip list iterator */
int curr_idx = 0; /* Current iteration index */
int ret_value = 0; /* Return value */
FUNC_ENTER_NOAPI_NOINIT_NOERR
/* Sanity check */
HDassert(pclass);
HDassert(idx);
HDassert(cb_func);
/* Set up iterator callback info */
udata_int.cb_func = cb_func;
udata_int.udata = udata;
udata_int.curr_idx_ptr = &curr_idx;
udata_int.prev_idx = *idx;
/* Iterate over properties in property list class proper */
ret_value = H5SL_iterate(pclass->props, H5P__iterate_pclass_cb, &udata_int);
if(ret_value != 0)
HGOTO_DONE(ret_value);
done:
/* Set the index we stopped at */
*idx = curr_idx;
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_iterate_pclass() */
/*--------------------------------------------------------------------------
NAME
H5P_peek_unsigned
PURPOSE
Internal routine to quickly retrieve the value of a property in a property list.
USAGE
int H5P_peek_unsigned(plist, name)
H5P_genplist_t *plist; IN: Property list to check
const char *name; IN: Name of property to query
RETURNS
Directly returns the value of the property in the list
DESCRIPTION
This function directly returns the value of a property in a property
list. Because this function is only able to just copy a particular property
value to the return value, there is no way to check for errors. We attempt
to make certain that bad things don't happen by validating that the size of
the property is the same as the size of the return type, but that can't
catch all errors.
This function does call the user's 'get' callback routine still.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
No error checking!
Use with caution!
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
unsigned
H5P_peek_unsigned(H5P_genplist_t *plist, const char *name)
{
unsigned ret_value; /* return value */
FUNC_ENTER_NOAPI(UFAIL)
HDassert(plist);
HDassert(name);
/* Get the value to return, don't worry about the return value, we can't return it */
H5P_get(plist,name,&ret_value);
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_peek_unsigned() */
/*--------------------------------------------------------------------------
NAME
H5P_peek_hid_t
PURPOSE
Internal routine to quickly retrieve the value of a property in a property list.
USAGE
hid_t H5P_peek_hid_t(plist, name)
H5P_genplist_t *plist; IN: Property list to check
const char *name; IN: Name of property to query
RETURNS
Directly returns the value of the property in the list
DESCRIPTION
This function directly returns the value of a property in a property
list. Because this function is only able to just copy a particular property
value to the return value, there is no way to check for errors. We attempt
to make certain that bad things don't happen by validating that the size of
the property is the same as the size of the return type, but that can't
catch all errors.
This function does call the user's 'get' callback routine still.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
No error checking!
Use with caution!
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hid_t
H5P_peek_hid_t(H5P_genplist_t *plist, const char *name)
{
hid_t ret_value; /* return value */
FUNC_ENTER_NOAPI(FAIL)
HDassert(plist);
HDassert(name);
/* Get the value to return, don't worry about the return value, we can't return it */
H5P_get(plist,name,&ret_value);
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_peek_hid_t() */
/*--------------------------------------------------------------------------
NAME
H5P_peek_voidp
PURPOSE
Internal routine to quickly retrieve the value of a property in a property list.
USAGE
void *H5P_peek_voidp(plist, name)
H5P_genplist_t *plist; IN: Property list to check
const char *name; IN: Name of property to query
RETURNS
Directly returns the value of the property in the list
DESCRIPTION
This function directly returns the value of a property in a property
list. Because this function is only able to just copy a particular property
value to the return value, there is no way to check for errors. We attempt
to make certain that bad things don't happen by validating that the size of
the property is the same as the size of the return type, but that can't
catch all errors.
This function does call the user's 'get' callback routine still.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
No error checking!
Use with caution!
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
void *
H5P_peek_voidp(H5P_genplist_t *plist, const char *name)
{
void * ret_value; /* return value */
FUNC_ENTER_NOAPI(NULL)
HDassert(plist);
HDassert(name);
/* Get the value to return, don't worry about the return value, we can't return it */
H5P_get(plist,name,&ret_value);
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_peek_voidp() */
/*--------------------------------------------------------------------------
NAME
H5P_peek_size_t
PURPOSE
Internal routine to quickly retrieve the value of a property in a property list.
USAGE
hsize_t H5P_peek_size_t(plist, name)
H5P_genplist_t *plist; IN: Property list to check
const char *name; IN: Name of property to query
RETURNS
Directly returns the value of the property in the list
DESCRIPTION
This function directly returns the value of a property in a property
list. Because this function is only able to just copy a particular property
value to the return value, there is no way to check for errors. We attempt
to make certain that bad things don't happen by validating that the size of
the property is the same as the size of the return type, but that can't
catch all errors.
This function does call the user's 'get' callback routine still.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
No error checking!
Use with caution!
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
size_t
H5P_peek_size_t(H5P_genplist_t *plist, const char *name)
{
size_t ret_value; /* return value */
FUNC_ENTER_NOAPI(UFAIL)
HDassert(plist);
HDassert(name);
/* Get the value to return, don't worry about the return value, we can't return it */
H5P_get(plist,name,&ret_value);
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_peek_size_t() */
/*--------------------------------------------------------------------------
NAME
H5P_get
PURPOSE
Internal routine to query the value of a property in a property list.
USAGE
herr_t H5P_get(plist, name, value)
H5P_genplist_t *plist; IN: Property list to check
const char *name; IN: Name of property to query
void *value; OUT: Pointer to the buffer for the property value
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Retrieves a copy of the value for a property in a property list. The
property name must exist or this routine will fail. If there is a
'get' callback routine registered for this property, the copy of the
value of the property will first be passed to that routine and any changes
to the copy of the value will be used when returning the property value
from this routine.
If the 'get' callback routine returns an error, 'value' will not be
modified and this routine will return an error. This routine may not be
called for zero-sized properties.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_get(const H5P_genplist_t *plist, const char *name, void *value)
{
H5P_genclass_t *tclass; /* Temporary class pointer */
H5P_genprop_t *prop; /* Temporary property pointer */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
HDassert(plist);
HDassert(name);
HDassert(value);
/* Check if the property has been deleted */
if(H5SL_search(plist->del,name)!=NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property doesn't exist")
/* Find property */
if((prop = (H5P_genprop_t *)H5SL_search(plist->props,name))!=NULL) {
/* Check for property size >0 */
if(prop->size==0)
HGOTO_ERROR(H5E_PLIST, H5E_BADVALUE, FAIL, "property has zero size")
/* Make a copy of the value and pass to 'get' callback */
if(prop->get!=NULL) {
void *tmp_value; /* Temporary value for property */
/* Make a copy of the current value, in case the callback fails */
if(NULL==(tmp_value=H5MM_malloc(prop->size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed temporary property value")
HDmemcpy(tmp_value,prop->value,prop->size);
/* Call user's callback */
if((*(prop->get))(plist->plist_id,name,prop->size,tmp_value) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "can't get property value")
/* Copy new [possibly unchanged] value into return value */
HDmemcpy(value,tmp_value,prop->size);
/* Free the temporary value buffer */
H5MM_xfree(tmp_value);
} /* end if */
/* No 'get' callback, just copy value */
else
HDmemcpy(value,prop->value,prop->size);
} /* end if */
else {
/*
* Check if we should get class properties (up through list of parent classes also),
* & make property 'get' callback.
*/
tclass=plist->pclass;
while(tclass!=NULL) {
if(tclass->nprops>0) {
/* Find the property in the class */
if((prop = (H5P_genprop_t *)H5SL_search(tclass->props,name))!=NULL) {
/* Check for property size >0 */
if(prop->size==0)
HGOTO_ERROR(H5E_PLIST,H5E_BADVALUE,FAIL,"property has zero size")
/* Call the 'get' callback, if there is one */
if(prop->get!=NULL) {
void *tmp_value; /* Temporary value for property */
/* Make a copy of the current value, in case the callback fails */
if(NULL==(tmp_value=H5MM_malloc(prop->size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed temporary property value")
HDmemcpy(tmp_value,prop->value,prop->size);
/* Call user's callback */
if((*(prop->get))(plist->plist_id,name,prop->size,tmp_value) < 0) {
H5MM_xfree(tmp_value);
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "can't set property value")
} /* end if */
if((prop->cmp)(tmp_value,prop->value,prop->size)) {
H5P_genprop_t *pcopy; /* Copy of property to insert into skip list */
/* Make a copy of the class's property */
if((pcopy=H5P_dup_prop(prop,H5P_PROP_WITHIN_LIST)) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTCOPY,FAIL,"Can't copy property")
/* Copy new value into property value */
HDmemcpy(pcopy->value,tmp_value,prop->size);
/* Insert the changed property into the property list */
if(H5P_add_prop(plist->props,pcopy) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert changed property into skip list")
} /* end if */
/* Copy new [possibly unchanged] value into return value */
HDmemcpy(value,tmp_value,prop->size);
/* Free the temporary value buffer */
H5MM_xfree(tmp_value);
} /* end if */
/* No 'get' callback, just copy value */
else
HDmemcpy(value,prop->value,prop->size);
/* Leave */
HGOTO_DONE(SUCCEED);
} /* end while */
} /* end if */
/* Go up to parent class */
tclass=tclass->parent;
} /* end while */
/* If we get this far, then it wasn't in the list of changed properties,
* nor in the properties in the class hierarchy, indicate an error
*/
HGOTO_ERROR(H5E_PLIST,H5E_NOTFOUND,FAIL,"can't find property in skip list")
} /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_get() */
/*--------------------------------------------------------------------------
NAME
H5P_remove
PURPOSE
Internal routine to remove a property from a property list.
USAGE
herr_t H5P_remove(plist, name)
H5P_genplist_t *plist; IN: Property list to modify
const char *name; IN: Name of property to remove
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Removes a property from a property list. Both properties which were
in existance when the property list was created (i.e. properties registered
with H5Pregister2) and properties added to the list after it was created
(i.e. added with H5Pinsert2) may be removed from a property list.
Properties do not need to be removed a property list before the list itself
is closed, they will be released automatically when H5Pclose is called.
The 'close' callback for this property is called before the property is
release, if the callback exists.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_remove(hid_t plist_id, H5P_genplist_t *plist, const char *name)
{
H5P_genclass_t *tclass; /* Temporary class pointer */
H5P_genprop_t *prop; /* Temporary property pointer */
char *del_name; /* Pointer to deleted name */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
HDassert(plist);
HDassert(name);
/* Indicate that the property isn't in the list if it has been deleted already */
if(H5SL_search(plist->del,name)!=NULL)
HGOTO_ERROR(H5E_PLIST,H5E_NOTFOUND,FAIL,"can't find property in skip list")
/* Get the property node from the changed property skip list */
if((prop = (H5P_genprop_t *)H5SL_search(plist->props,name))!=NULL) {
/* Pass value to 'close' callback, if it exists */
if(prop->del!=NULL) {
/* Call user's callback */
if((*(prop->del))(plist_id,name,prop->size,prop->value) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "can't close property value")
} /* end if */
/* Duplicate string for insertion into new deleted property skip list */
if((del_name=H5MM_xstrdup(name)) == NULL)
HGOTO_ERROR(H5E_RESOURCE,H5E_NOSPACE,FAIL,"memory allocation failed")
/* Insert property name into deleted list */
if(H5SL_insert(plist->del,del_name,del_name) < 0)
HGOTO_ERROR(H5E_PLIST,H5E_CANTINSERT,FAIL,"can't insert property into deleted skip list")
/* Remove the property from the skip list */
if(H5SL_remove(plist->props,prop->name) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTDELETE,FAIL,"can't remove property from skip list")
/* Free the property, ignoring return value, nothing we can do */
H5P_free_prop(prop);
/* Decrement the number of properties in list */
plist->nprops--;
} /* end if */
/* Walk through all the properties in the class hierarchy, looking for the property */
else {
/*
* Check if we should delete class properties (up through list of parent classes also),
* & make property 'delete' callback.
*/
tclass=plist->pclass;
while(tclass!=NULL) {
if(tclass->nprops>0) {
/* Find the property in the class */
if((prop=H5P_find_prop_pclass(tclass,name))!=NULL) {
/* Pass value to 'del' callback, if it exists */
if(prop->del!=NULL) {
void *tmp_value; /* Temporary value buffer */
/* Allocate space for a temporary copy of the property value */
if(NULL==(tmp_value=H5MM_malloc(prop->size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed for temporary property value")
HDmemcpy(tmp_value,prop->value,prop->size);
/* Call user's callback */
if((*(prop->del))(plist_id,name,prop->size,tmp_value) < 0) {
H5MM_xfree(tmp_value);
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "can't close property value")
} /* end if */
/* Release the temporary value buffer */
H5MM_xfree(tmp_value);
} /* end if */
/* Duplicate string for insertion into new deleted property skip list */
if((del_name=H5MM_xstrdup(name)) == NULL)
HGOTO_ERROR(H5E_RESOURCE,H5E_NOSPACE,FAIL,"memory allocation failed")
/* Insert property name into deleted list */
if(H5SL_insert(plist->del,del_name,del_name) < 0)
HGOTO_ERROR(H5E_PLIST,H5E_CANTINSERT,FAIL,"can't insert property into deleted skip list")
/* Decrement the number of properties in list */
plist->nprops--;
/* Leave */
HGOTO_DONE(SUCCEED);
} /* end while */
} /* end if */
/* Go up to parent class */
tclass=tclass->parent;
} /* end while */
/* If we get this far, then it wasn't in the list of changed properties,
* nor in the properties in the class hierarchy, indicate an error
*/
HGOTO_ERROR(H5E_PLIST,H5E_NOTFOUND,FAIL,"can't find property in skip list")
} /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_remove() */
/*--------------------------------------------------------------------------
NAME
H5P_copy_prop_plist
PURPOSE
Internal routine to copy a property from one list to another
USAGE
herr_t H5P_copy_prop_plist(dst_plist, src_plist, name)
hid_t dst_id; IN: ID of destination property list or class
hid_t src_id; IN: ID of source property list or class
const char *name; IN: Name of property to copy
RETURNS
Success: non-negative value.
Failure: negative value.
DESCRIPTION
Copies a property from one property list to another.
If a property is copied from one list to another, the property will be
first deleted from the destination list (generating a call to the 'close'
callback for the property, if one exists) and then the property is copied
from the source list to the destination list (generating a call to the
'copy' callback for the property, if one exists).
If the property does not exist in the destination list, this call is
equivalent to calling H5Pinsert2 and the 'create' callback will be called
(if such a callback exists for the property).
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_copy_prop_plist(hid_t dst_id, hid_t src_id, const char *name)
{
H5P_genplist_t *dst_plist; /* Pointer to destination property list */
H5P_genplist_t *src_plist; /* Pointer to source property list */
H5P_genprop_t *prop; /* Temporary property pointer */
H5P_genprop_t *new_prop=NULL; /* Pointer to new property */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(name);
/* Get the objects to operate on */
if(NULL == (src_plist = (H5P_genplist_t *)H5I_object(src_id)) || NULL == (dst_plist = (H5P_genplist_t *)H5I_object(dst_id)))
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property object doesn't exist")
/* If the property exists in the destination alread */
if(NULL != H5P__find_prop_plist(dst_plist, name)) {
/* Delete the property from the destination list, calling the 'close' callback if necessary */
if(H5P_remove(dst_id,dst_plist,name) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTDELETE, FAIL, "unable to remove property")
/* Get the pointer to the source property */
prop = H5P__find_prop_plist(src_plist, name);
/* Make a copy of the source property */
if((new_prop=H5P_dup_prop(prop,H5P_PROP_WITHIN_LIST)) == NULL)
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, FAIL,"Can't copy property")
/* Call property copy callback, if it exists */
if(new_prop->copy) {
if((new_prop->copy)(new_prop->name,new_prop->size,new_prop->value) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, FAIL,"Can't copy property")
} /* end if */
/* Insert the initialized property into the property list */
if(H5P_add_prop(dst_plist->props,new_prop) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert property into list")
/* Increment the number of properties in list */
dst_plist->nprops++;
} /* end if */
/* If not, get the information required to do an H5Pinsert2 with the property into the destination list */
else {
/* Get the pointer to the source property */
prop = H5P__find_prop_plist(src_plist, name);
/* Create property object from parameters */
if(NULL == (new_prop = H5P_create_prop(prop->name, prop->size, H5P_PROP_WITHIN_LIST, prop->value,
prop->create, prop->set, prop->get, prop->encode, prop->decode,
prop->del, prop->copy, prop->cmp, prop->close)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCREATE, FAIL,"Can't create property")
/* Call property creation callback, if it exists */
if(new_prop->create) {
if((new_prop->create)(new_prop->name, new_prop->size, new_prop->value) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL,"Can't initialize property")
} /* end if */
/* Insert property into property list class */
if(H5P_add_prop(dst_plist->props, new_prop) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert property into class")
/* Increment property count for class */
dst_plist->nprops++;
} /* end else */
done:
/* Cleanup, if necessary */
if(ret_value<0) {
if(new_prop!=NULL)
H5P_free_prop(new_prop);
} /* end if */
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_copy_prop_plist() */
/*--------------------------------------------------------------------------
NAME
H5P_copy_prop_pclass
PURPOSE
Internal routine to copy a property from one class to another
USAGE
herr_t H5P_copy_prop_pclass(dst_pclass, src_pclass, name)
H5P_genclass_t *dst_pclass; IN: Pointer to destination class
H5P_genclass_t *src_pclass; IN: Pointer to source class
const char *name; IN: Name of property to copy
RETURNS
Success: non-negative value.
Failure: negative value.
DESCRIPTION
Copies a property from one property class to another.
If a property is copied from one class to another, all the property
information will be first deleted from the destination class and then the
property information will be copied from the source class into the
destination class.
If the property does not exist in the destination class or list, this call
is equivalent to calling H5Pregister2.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_copy_prop_pclass(hid_t dst_id, hid_t src_id, const char *name)
{
H5P_genclass_t *src_pclass; /* Source property class, containing property to copy */
H5P_genclass_t *dst_pclass; /* Destination property class */
H5P_genclass_t *orig_dst_pclass; /* Original destination property class */
H5P_genprop_t *prop; /* Temporary property pointer */
herr_t ret_value = SUCCEED; /* return value */
FUNC_ENTER_NOAPI_NOINIT
/* Sanity check */
HDassert(name);
/* Get propery list classes */
if(NULL == (src_pclass = (H5P_genclass_t *)H5I_object(src_id)))
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "source property class object doesn't exist")
if(NULL == (dst_pclass = (H5P_genclass_t *)H5I_object(dst_id)))
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "destination property class object doesn't exist")
/* Get the property from the source */
if(NULL == (prop = H5P_find_prop_pclass(src_pclass, name)))
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "unable to locate property")
/* If the property exists in the destination already */
if(H5P_exist_pclass(dst_pclass, name)) {
/* Delete the old property from the destination class */
if(H5P_unregister(dst_pclass, name) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTDELETE, FAIL, "unable to remove property")
} /* end if */
/* Register the property into the destination */
orig_dst_pclass = dst_pclass;
if(H5P_register(&dst_pclass, name, prop->size, prop->value, prop->create, prop->set, prop->get,
prop->encode, prop->decode, prop->del, prop->copy, prop->cmp, prop->close) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTDELETE, FAIL, "unable to remove property")
/* Check if the property class changed and needs to be substituted in the ID */
if(dst_pclass != orig_dst_pclass) {
H5P_genclass_t *old_dst_pclass; /* Old destination property class */
/* Substitute the new destination property class in the ID */
if(NULL == (old_dst_pclass = (H5P_genclass_t *)H5I_subst(dst_id, dst_pclass)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "unable to substitute property class in ID")
HDassert(old_dst_pclass == orig_dst_pclass);
/* Close the previous class */
if(H5P_close_class(old_dst_pclass) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTCLOSEOBJ, FAIL, "unable to close original property class after substitution")
} /* end if */
done:
/* Cleanup, if necessary */
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_copy_prop_pclass() */
/*--------------------------------------------------------------------------
NAME
H5P_unregister
PURPOSE
Internal routine to remove a property from a property list class.
USAGE
herr_t H5P_unregister(pclass, name)
H5P_genclass_t *pclass; IN: Property list class to modify
const char *name; IN: Name of property to remove
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Removes a property from a property list class. Future property lists
created of that class will not contain this property. Existing property
lists containing this property are not affected.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_unregister(H5P_genclass_t *pclass, const char *name)
{
H5P_genprop_t *prop; /* Temporary property pointer */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(pclass);
HDassert(name);
/* Get the property node from the skip list */
if((prop = (H5P_genprop_t *)H5SL_search(pclass->props,name)) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_NOTFOUND,FAIL,"can't find property in skip list")
/* Remove the property from the skip list */
if(H5SL_remove(pclass->props,prop->name) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTDELETE,FAIL,"can't remove property from skip list")
/* Free the property, ignoring return value, nothing we can do */
H5P_free_prop(prop);
/* Decrement the number of registered properties in class */
pclass->nprops--;
/* Update the revision for the class */
pclass->revision = H5P_GET_NEXT_REV;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_unregister() */
/*--------------------------------------------------------------------------
NAME
H5P_close
PURPOSE
Internal routine to close a property list.
USAGE
herr_t H5P_close(plist)
H5P_genplist_t *plist; IN: Property list to close
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Closes a property list. If a 'close' callback exists for the property
list class, it is called before the property list is destroyed. If 'close'
callbacks exist for any individual properties in the property list, they are
called after the class 'close' callback.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
The property list class 'close' callback routine is not called from
here, it must have been check for and called properly prior to this routine
being called
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_close(void *_plist)
{
H5P_genclass_t *tclass; /* Temporary class pointer */
H5P_genplist_t *plist=(H5P_genplist_t *)_plist;
H5SL_t *seen=NULL; /* Skip list to hold names of properties already seen */
size_t nseen; /* Number of items 'seen' */
hbool_t has_parent_class; /* Flag to indicate that this property list's class has a parent */
size_t ndel; /* Number of items deleted */
H5SL_node_t *curr_node; /* Current node in skip list */
H5P_genprop_t *tmp; /* Temporary pointer to properties */
unsigned make_cb=0; /* Operator data for property free callback */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(plist);
/* Make call to property list class close callback, if needed
* (up through chain of parent classes also)
*/
if(plist->class_init) {
tclass = plist->pclass;
while(NULL != tclass) {
if(NULL != tclass->close_func) {
/* Call user's "close" callback function, ignoring return value */
(tclass->close_func)(plist->plist_id, tclass->close_data);
} /* end if */
/* Go up to parent class */
tclass = tclass->parent;
} /* end while */
} /* end if */
/* Create the skip list to hold names of properties already seen
* (This prevents a property in the class hierarchy from having it's
* 'close' callback called, if a property in the class hierarchy has
* already been seen)
*/
if((seen = H5SL_create(H5SL_TYPE_STR, NULL)) == NULL)
HGOTO_ERROR(H5E_PLIST,H5E_CANTCREATE,FAIL,"can't create skip list for seen properties")
nseen = 0;
/* Walk through the changed properties in the list */
if(H5SL_count(plist->props)>0) {
curr_node=H5SL_first(plist->props);
while(curr_node!=NULL) {
/* Get pointer to property from node */
tmp = (H5P_genprop_t *)H5SL_item(curr_node);
/* Call property close callback, if it exists */
if(tmp->close) {
/* Call the 'close' callback */
(tmp->close)(tmp->name,tmp->size,tmp->value);
} /* end if */
/* Add property name to "seen" list */
if(H5SL_insert(seen,tmp->name,tmp->name) < 0)
HGOTO_ERROR(H5E_PLIST,H5E_CANTINSERT,FAIL,"can't insert property into seen skip list")
nseen++;
/* Get the next property node in the skip list */
curr_node=H5SL_next(curr_node);
} /* end while */
} /* end if */
/* Determine number of deleted items from property list */
ndel=H5SL_count(plist->del);
/*
* Check if we should remove class properties (up through list of parent classes also),
* initialize each with default value & make property 'remove' callback.
*/
tclass=plist->pclass;
has_parent_class = (hbool_t)(tclass != NULL && tclass->parent != NULL && tclass->parent->nprops > 0);
while(tclass!=NULL) {
if(tclass->nprops>0) {
/* Walk through the properties in the class */
curr_node=H5SL_first(tclass->props);
while(curr_node!=NULL) {
/* Get pointer to property from node */
tmp = (H5P_genprop_t *)H5SL_item(curr_node);
/* Only "delete" properties we haven't seen before
* and that haven't already been deleted
*/
if((nseen==0 || H5SL_search(seen,tmp->name) == NULL) &&
(ndel==0 || H5SL_search(plist->del,tmp->name) == NULL)) {
/* Call property close callback, if it exists */
if(tmp->close) {
void *tmp_value; /* Temporary value buffer */
/* Allocate space for a temporary copy of the property value */
if(NULL==(tmp_value=H5MM_malloc(tmp->size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed for temporary property value")
HDmemcpy(tmp_value,tmp->value,tmp->size);
/* Call the 'close' callback */
(tmp->close)(tmp->name,tmp->size,tmp_value);
/* Release the temporary value buffer */
H5MM_xfree(tmp_value);
} /* end if */
/* Add property name to "seen" list, if we have other classes to work on */
if(has_parent_class) {
if(H5SL_insert(seen,tmp->name,tmp->name) < 0)
HGOTO_ERROR(H5E_PLIST,H5E_CANTINSERT,FAIL,"can't insert property into seen skip list")
nseen++;
} /* end if */
} /* end if */
/* Get the next property node in the skip list */
curr_node=H5SL_next(curr_node);
} /* end while */
} /* end if */
/* Go up to parent class */
tclass=tclass->parent;
} /* end while */
/* Decrement class's dependant property list value! */
if(H5P_access_class(plist->pclass,H5P_MOD_DEC_LST) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "Can't decrement class ref count")
/* Free the list of 'seen' properties */
H5SL_close(seen);
seen=NULL;
/* Free the list of deleted property names */
H5SL_destroy(plist->del,H5P_free_del_name_cb,NULL);
/* Free the properties */
H5SL_destroy(plist->props,H5P_free_prop_cb,&make_cb);
/* Destroy property list object */
plist = H5FL_FREE(H5P_genplist_t, plist);
done:
/* Release the skip list of 'seen' properties */
if(seen != NULL)
H5SL_close(seen);
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_close() */
/*--------------------------------------------------------------------------
NAME
H5P_get_class_name
PURPOSE
Internal routine to query the name of a generic property list class
USAGE
char *H5P_get_class_name(pclass)
H5P_genclass_t *pclass; IN: Property list class to check
RETURNS
Success: Pointer to a malloc'ed string containing the class name
Failure: NULL
DESCRIPTION
This routine retrieves the name of a generic property list class.
The pointer to the name must be free'd by the user for successful calls.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
char *
H5P_get_class_name(H5P_genclass_t *pclass)
{
char *ret_value; /* return value */
FUNC_ENTER_NOAPI(NULL)
HDassert(pclass);
/* Get class name */
ret_value=H5MM_xstrdup(pclass->name);
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_get_class_name() */
/*--------------------------------------------------------------------------
NAME
H5P_get_class_path
PURPOSE
Internal routine to query the full path of a generic property list class
USAGE
char *H5P_get_class_name(pclass)
H5P_genclass_t *pclass; IN: Property list class to check
RETURNS
Success: Pointer to a malloc'ed string containing the full path of class
Failure: NULL
DESCRIPTION
This routine retrieves the full path name of a generic property list
class, starting with the root of the class hierarchy.
The pointer to the name must be free'd by the user for successful calls.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
char *
H5P_get_class_path(H5P_genclass_t *pclass)
{
char *par_path; /* Parent class's full path */
size_t par_path_len;/* Parent class's full path's length */
size_t my_path_len; /* This class's name's length */
char *ret_value; /* return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(pclass);
/* Recursively build the full path */
if(pclass->parent!=NULL) {
/* Get the parent class's path */
par_path=H5P_get_class_path(pclass->parent);
if(par_path!=NULL) {
/* Get the string lengths we need to allocate space */
par_path_len=HDstrlen(par_path);
my_path_len=HDstrlen(pclass->name);
/* Allocate enough space for the parent class's path, plus the '/'
* separator, this class's name and the string terminator
*/
if(NULL == (ret_value = (char *)H5MM_malloc(par_path_len + 1 + my_path_len + 1)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for class name")
/* Build the full path for this class */
HDstrcpy(ret_value,par_path);
HDstrcat(ret_value,"/");
HDstrcat(ret_value,pclass->name);
/* Free the parent class's path */
H5MM_xfree(par_path);
} /* end if */
else
ret_value=H5MM_xstrdup(pclass->name);
} /* end if */
else
ret_value=H5MM_xstrdup(pclass->name);
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_get_class_path() */
/*--------------------------------------------------------------------------
NAME
H5P_open_class_path
PURPOSE
Internal routine to open [a copy of] a class with its full path name
USAGE
H5P_genclass_t *H5P_open_class_path(path)
const char *path; IN: Full path name of class to open [copy of]
RETURNS
Success: Pointer to a generic property class object
Failure: NULL
DESCRIPTION
This routine opens [a copy] of the class indicated by the full path.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5P_genclass_t *
H5P_open_class_path(const char *path)
{
char *tmp_path = NULL; /* Temporary copy of the path */
char *curr_name; /* Pointer to current component of path name */
char *delimit; /* Pointer to path delimiter during traversal */
H5P_genclass_t *curr_class; /* Pointer to class during path traversal */
H5P_check_class_t check_info; /* Structure to hold the information for checking duplicate names */
H5P_genclass_t *ret_value; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(path);
/* Duplicate the path to use */
tmp_path = H5MM_xstrdup(path);
HDassert(tmp_path);
/* Find the generic property class with this full path */
curr_name = tmp_path;
curr_class = NULL;
while(NULL != (delimit = HDstrchr(curr_name, '/'))) {
/* Change the delimiter to terminate the string */
*delimit = '\0';
/* Set up the search structure */
check_info.parent = curr_class;
check_info.name = curr_name;
check_info.new_class = NULL;
/* Find the class with this name & parent by iterating over the open classes */
if(H5I_iterate(H5I_GENPROP_CLS, H5P_open_class_path_cb, &check_info, FALSE) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_BADITER, NULL, "can't iterate over classes")
else if(NULL == check_info.new_class)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, NULL, "can't locate class")
/* Advance the pointer in the path to the start of the next component */
curr_class = check_info.new_class;
curr_name = delimit + 1;
} /* end while */
/* Should be pointing to the last component in the path name now... */
/* Set up the search structure */
check_info.parent = curr_class;
check_info.name = curr_name;
check_info.new_class = NULL;
/* Find the class with this name & parent by iterating over the open classes */
if(H5I_iterate(H5I_GENPROP_CLS, H5P_open_class_path_cb, &check_info, FALSE) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_BADITER, NULL, "can't iterate over classes")
else if(NULL == check_info.new_class)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, NULL, "can't locate class")
/* Copy it */
if(NULL == (ret_value = H5P_copy_pclass(check_info.new_class)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, NULL, "can't copy property class")
done:
/* Free the duplicated path */
H5MM_xfree(tmp_path);
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_open_class_path() */
/*--------------------------------------------------------------------------
NAME
H5P_get_class_parent
PURPOSE
Internal routine to query the parent class of a generic property class
USAGE
H5P_genclass_t *H5P_get_class_parent(pclass)
H5P_genclass_t *pclass; IN: Property class to check
RETURNS
Success: Pointer to the parent class of a property class
Failure: NULL
DESCRIPTION
This routine retrieves a pointer to the parent class for a property class.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5P_genclass_t *
H5P_get_class_parent(const H5P_genclass_t *pclass)
{
H5P_genclass_t *ret_value; /* return value */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(pclass);
/* Get property size */
ret_value = pclass->parent;
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_get_class_parent() */
/*--------------------------------------------------------------------------
NAME
H5P_close_class
PURPOSE
Internal routine to close a property list class.
USAGE
herr_t H5P_close_class(class)
H5P_genclass_t *class; IN: Property list class to close
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Releases memory and de-attach a class from the property list class hierarchy.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5P_close_class(void *_pclass)
{
H5P_genclass_t *pclass = (H5P_genclass_t *)_pclass;
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(pclass);
/* Decrement the reference count & check if the object should go away */
if(H5P_access_class(pclass, H5P_MOD_DEC_REF) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "can't decrement ID ref count")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* H5P_close_class() */
/*-------------------------------------------------------------------------
* Function: H5P__new_plist_of_type
*
* Purpose: Create a new property list, of a given type
*
* Return: Success: ID of new property list
* Failure: Negative
*
* Programmer: Quincey Koziol
* Thursday, August 2, 2012
*
*-------------------------------------------------------------------------
*/
hid_t
H5P__new_plist_of_type(H5P_plist_type_t type)
{
H5P_genclass_t *pclass; /* Class of property list to create */
hid_t class_id; /* ID of class to create */
hid_t ret_value; /* Return value */
FUNC_ENTER_PACKAGE
/* Sanity checks */
HDcompile_assert(H5P_TYPE_LINK_ACCESS == (H5P_TYPE_MAX_TYPE - 1));
HDassert(type >= H5P_TYPE_USER && type <= H5P_TYPE_LINK_ACCESS);
/* Check arguments */
if(type == H5P_TYPE_USER)
HGOTO_ERROR(H5E_PLIST, H5E_BADVALUE, FAIL, "can't create user property list");
if(type == H5P_TYPE_ROOT)
HGOTO_ERROR(H5E_PLIST, H5E_BADVALUE, FAIL, "shouldn't be creating root class property list");
/* Instantiate a property list of the proper type */
switch(type) {
case H5P_TYPE_OBJECT_CREATE:
class_id = H5P_CLS_OBJECT_CREATE_g;
break;
case H5P_TYPE_FILE_CREATE:
class_id = H5P_CLS_FILE_CREATE_g;
break;
case H5P_TYPE_FILE_ACCESS:
class_id = H5P_CLS_FILE_ACCESS_g;
break;
case H5P_TYPE_DATASET_CREATE:
class_id = H5P_CLS_DATASET_CREATE_g;
break;
case H5P_TYPE_DATASET_ACCESS:
class_id = H5P_CLS_DATASET_ACCESS_g;
break;
case H5P_TYPE_DATASET_XFER:
class_id = H5P_CLS_DATASET_XFER_g;
break;
case H5P_TYPE_FILE_MOUNT:
class_id = H5P_CLS_FILE_MOUNT_g;
break;
case H5P_TYPE_GROUP_CREATE:
class_id = H5P_CLS_GROUP_CREATE_g;
break;
case H5P_TYPE_GROUP_ACCESS:
class_id = H5P_CLS_GROUP_ACCESS_g;
break;
case H5P_TYPE_DATATYPE_CREATE:
class_id = H5P_CLS_DATATYPE_CREATE_g;
break;
case H5P_TYPE_DATATYPE_ACCESS:
class_id = H5P_CLS_DATATYPE_ACCESS_g;
break;
case H5P_TYPE_STRING_CREATE:
class_id = H5P_CLS_STRING_CREATE_g;
break;
case H5P_TYPE_ATTRIBUTE_CREATE:
class_id = H5P_CLS_ATTRIBUTE_CREATE_g;
break;
case H5P_TYPE_OBJECT_COPY:
class_id = H5P_CLS_OBJECT_COPY_g;
break;
case H5P_TYPE_LINK_CREATE:
class_id = H5P_CLS_LINK_CREATE_g;
break;
case H5P_TYPE_LINK_ACCESS:
class_id = H5P_CLS_LINK_ACCESS_g;
break;
case H5P_TYPE_READ_CONTEXT_ACQUIRE:
class_id = H5P_CLS_READ_CONTEXT_ACQUIRE_g;
break;
case H5P_TYPE_TRANSACTION_START:
class_id = H5P_CLS_TRANSACTION_START_g;
break;
case H5P_TYPE_TRANSACTION_FINISH:
class_id = H5P_CLS_TRANSACTION_FINISH_g;
break;
case H5P_TYPE_USER: /* shut compiler warnings up */
case H5P_TYPE_ROOT:
case H5P_TYPE_MAX_TYPE:
default:
HGOTO_ERROR(H5E_PLIST, H5E_BADRANGE, FAIL, "invalid property list type: %u\n", (unsigned)type);
} /* end switch */
/* Get the class object */
if(NULL == (pclass = (H5P_genclass_t *)H5I_object(class_id)))
HGOTO_ERROR(H5E_PLIST, H5E_BADTYPE, FAIL, "not a property class")
/* Create the new property list */
if((ret_value = H5P_create_id(pclass, TRUE)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTCREATE, FAIL, "unable to create property list")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5P__new_plist_of_type() */
|