File: keymap.c

package info (click to toggle)
starlink-ast 7.0.4%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 27,216 kB
  • sloc: ansic: 165,183; sh: 8,558; makefile: 635; perl: 158
file content (10558 lines) | stat: -rw-r--r-- 344,867 bytes parent folder | download
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
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
/*
*class++
*  Name:
*     KeyMap

*  Purpose:
*     Store a set of key/value pairs.

*  Constructor Function:
c     astKeyMap
f     AST_KEYMAP

*  Description:
*     The KeyMap class is used to store a set of values with associated keys
*     which identify the values. The keys are strings. These may be case
*     sensitive or insensitive as selected by the KeyCase attribute, and
*     trailing spaces are ignored. The value associated with a key can be
*     integer (signed 4 and 2 byte, or unsigned 1 byte), floating point
*     (single or double precision),
c     void pointer,
*     character string or AST Object pointer. Each
*     value can be a scalar or a one-dimensional vector. A KeyMap is
*     conceptually similar to a Mapping in that a KeyMap transforms an
*     input into an output - the input is the key, and the output is the
*     value associated with the key. However, this is only a conceptual
*     similarity, and it should be noted that the KeyMap class inherits from
*     the Object class rather than the Mapping class. The methods of the
*     Mapping class cannot be used with a KeyMap.

*  Inheritance:
*     The KeyMap class inherits from the Object class.

*  Attributes:
*     In addition to those attributes common to all Objects, every
*     KeyMap also has the following attributes:
*
*     - KeyCase: Sets the case in which keys are stored
*     - KeyError: Report an error if the requested key does not exist?
*     - SizeGuess: The expected size of the KeyMap.
*     - SortBy: Determines how keys are sorted in a KeyMap.
*     - MapLocked: Prevent new entries being added to the KeyMap?

*  Functions:
c     In addition to those functions applicable to all Objects, the
c     following functions may also be applied to all KeyMaps:
f     In addition to those routines applicable to all Objects, the
f     following routines may also be applied to all KeyMaps:
*
c     - astMapGet0<X>: Get a named scalar entry from a KeyMap
c     - astMapGet1<X>: Get a named vector entry from a KeyMap
c     - astMapGetElem<X>: Get an element of a named vector entry from a KeyMap
c     - astMapHasKey: Does the KeyMap contain a named entry?
c     - astMapKey: Return the key name at a given index in the KeyMap
c     - astMapLenC: Get the length of a named character entry in a KeyMap
c     - astMapLength: Get the length of a named entry in a KeyMap
c     - astMapCopy: Copy entries from one KeyMap into another
c     - astMapPut0<X>: Add a new scalar entry to a KeyMap
c     - astMapPut1<X>: Add a new vector entry to a KeyMap
c     - astMapPutElem<X>: Puts a value into a vector entry in a KeyMap
c     - astMapPutU: Add a new entry to a KeyMap with an undefined value
c     - astMapRemove: Removed a named entry from a KeyMap
c     - astMapRename: Rename an existing entry in a KeyMap
c     - astMapSize: Get the number of entries in a KeyMap
c     - astMapType: Return the data type of a named entry in a map
f     - AST_MAPGET0<X>: Get a named scalar entry from a KeyMap
f     - AST_MAPGET1<X>: Get a named vector entry from a KeyMap
f     - AST_MAPGETELEM<X>: Get an element of a named vector entry from a KeyMap
f     - AST_MAPHASKEY: Does the KeyMap contain a named entry?
f     - AST_MAPKEY: Return the key name at a given index in the KeyMap
f     - AST_MAPLENC: Get the length of a named character entry in a KeyMap
f     - AST_MAPLENGTH: Get the length of a named entry in a KeyMap
f     - AST_MAPCOPY: Copy entries from one KeyMap into another
f     - AST_MAPPUT0<X>: Add a new scalar entry to a KeyMap
f     - AST_MAPPUT1<X>: Add a new vector entry to a KeyMap
f     - AST_MAPPUTELEM<X>: Puts a value into a vector entry in a KeyMap
f     - AST_MAPPUTU: Add a new entry to a KeyMap with an undefined value
f     - AST_MAPREMOVE: Removed a named entry from a KeyMap
f     - AST_MAPRENAME: Rename an existing entry in a KeyMap
f     - AST_MAPSIZE: Get the number of entries in a KeyMap
f     - AST_MAPTYPE: Return the data type of a named entry in a map

*  Copyright:
*     Copyright (C) 1997-2006 Council for the Central Laboratory of the
*     Research Councils
*     Copyright (C) 2008-2010 Science & Technology Facilities Council.
*     All Rights Reserved.

*  Licence:
*     This program is free software; you can redistribute it and/or
*     modify it under the terms of the GNU General Public Licence as
*     published by the Free Software Foundation; either version 2 of
*     the Licence, or (at your option) any later version.
*
*     This program is distributed in the hope that it will be
*     useful,but WITHOUT ANY WARRANTY; without even the implied
*     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
*     PURPOSE. See the GNU General Public Licence for more details.
*
*     You should have received a copy of the GNU General Public Licence
*     along with this program; if not, write to the Free Software
*     Foundation, Inc., 51 Franklin Street,Fifth Floor, Boston, MA
*     02110-1301, USA

*  Authors:
*     DSB: B.S. Berry (Starlink)

*  History:
*     12-NOV-2004 (DSB):
*        Original version.
*     5-JAN-2005 (DSB):
*        Added astMapLenC method.
*     17-JAN-2005 (DSB):
*        Remove "void *" arithmetic.
*     25-JAN-2005 (DSB):
*        Added more DEBUG blocks
*     30-SEP-2005 (DSB):
*        Allow an integer to be read from a formatted floating point value.
*     6-DEC-2005 (DSB):
*        Remove astMapGet0C stuff from description of astMapGet1C.
*     14-FEB-2006 (DSB):
*        Override astGetObjSize.
*     1-MAR-2006 (DSB):
*        Replace astSetPermMap within DEBUG blocks by astBeginPM/astEndPM.
*     5-JUN-2006 (DSB):
*        Added support for single precision entries.
*     30-NOV-2007 (DSB):
*        Added SizeGuess attribute.
*     4-DEC-2007 (DSB):
*        Allow size of hash table to grow dynamically as more entries are
*        added to the KeyMap.
*     5-DEC-2007 (DSB):
*        Ensure mapsize is always a power of 2.
*     6-DEC-2007 (DSB):
*        - Define the minium table size rather than the default SizeGuess
*        value, and derive the default SizeGuess value from the minimum
*        table size.
*        - Use "&" rather than "%" to get the hash table index from the
*        full width hash value (& may be faster than %).
*     7-MAR-2008 (DSB):
*         Added support for pointer ("P") entries.
*     31-MAR-2009 (DSB):
*         Remove rounding errors from formatted double values.
*     27-APR-2009 (DSB):
*         Added astMapGetElem<X>.
*     1-SEP-2009 (DSB):
*         Added KeyError attribute.
*     12-FEB-2010 (DSB):
*         When converting an entry value between double and string, treat
*         "<bad>" as the formatted version of AST__BAD.
*     3-MAR-2010 (DSB):
*         Added astMapPutElem<X>.
*     27-APR-2010 (DSB):
*         Added MapLocked attribute.
*     4-MAY-2010 (DSB):
*         - Propagate MapLocked and KeyError attributes to any encapsulated
*         KeyMaps.
*         - Added astMapCopy method.
*         - Added astMapPutU method and AST__UNDEFTYPE data type.
*     11-AUG-2010 (DSB):
*        Added SortBy attribute.
*     12-AUG-2010 (DSB):
*        Speed up access to large KeyMaps.
*     13-AUG-2010 (DSB):
*        - No need to sort all entries when doubling the table size since
*        changing the table size does not change the linked list of sorted
*        entries.
*        - Initialise the sortby attribute to the cleared value, rather
*        than the default value.
*     2-OCT-2010 (DSB):
*        Added support for short int valued entries.
*     24-NOV-2010 (DSB):
*        Fix memory leak in astMapPutElemC and astMapPutElemA.
*     26-NOV-2010 (DSB):
*        Added support for unsigned byte valued entries.
*     3-DEC-2010 (DSB):
*         Added KeyCase attribute.
*     14-JAN-2011 (DSB):
*         Fix bug that prevented zero length strings being stored in a
*         keymap.
*class--
*/

/* Module Macros. */
/* ============== */
/* Set the name of the class we are implementing. This indicates to
   the header files that define class interfaces that they should make
   "protected" symbols available. */
#define astCLASS KeyMap

/* Minimum size for the hash table. */
#define MIN_TABLE_SIZE 16

/* The maximum number of entries per element of the hash table. If this
   value is exceeded the hash table will be doubled in size. */
#define MAX_ENTRIES_PER_TABLE_ENTRY 10

/* String used to represent the formatetd version of AST__BAD. */
#define BAD_STRING "<bad>"

/* Integer values to represent the different values of the SortBy attribute. */
#define SORTBY_NONE 0
#define SORTBY_AGEUP 1
#define SORTBY_AGEDOWN 2
#define SORTBY_KEYUP 3
#define SORTBY_KEYDOWN 4


/* Include files. */
/* ============== */
/* Interface definitions. */
/* ---------------------- */

#include "globals.h"             /* Thread-safe global data access */
#include "error.h"               /* Error reporting facilities */
#include "memory.h"              /* Memory management facilities */
#include "object.h"              /* Base Object class */
#include "pointset.h"            /* For AST__BAD */
#include "channel.h"             /* I/O channels */
#include "keymap.h"              /* Interface definition for this class */
#include "globals.h"             /* Thread-safe global data access */

/* Error code definitions. */
/* ----------------------- */
#include "ast_err.h"             /* AST error codes */

/* C header files. */
/* --------------- */
#include <limits.h>
#include <stdarg.h>
#include <stddef.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>

/* Type Definitions */
/* ================ */

/* This structure is a AstMapEntry holding a scalar int */
typedef struct Entry0I {
   struct AstMapEntry entry; /* The parent Entry information */
   int value;                /* The integer value */
} Entry0I;

/* This structure is a AstMapEntry holding a scalar double */
typedef struct Entry0D {
   struct AstMapEntry entry; /* The parent Entry information */
   double value;             /* The floating point value */
} Entry0D;

/* This structure is a AstMapEntry holding a scalar short int */
typedef struct Entry0S {
   struct AstMapEntry entry; /* The parent Entry information */
   short int value;          /* The short int value */
} Entry0S;

/* This structure is a AstMapEntry holding a scalar unsigned byte
   (unsigned char) */
typedef struct Entry0B {
   struct AstMapEntry entry; /* The parent Entry information */
   unsigned char value;      /* The byte value */
} Entry0B;

/* This structure is a AstMapEntry holding a scalar float */
typedef struct Entry0F {
   struct AstMapEntry entry; /* The parent Entry information */
   float value;              /* The floating point value */
} Entry0F;

/* This structure is a AstMapEntry holding a scalar string */
typedef struct Entry0C {
   struct AstMapEntry entry; /* The parent Entry information */
   const char *value;        /* The string pointer */
} Entry0C;

/* This structure is a AstMapEntry holding a scalar AST Object */
typedef struct Entry0A {
   struct AstMapEntry entry; /* The parent Entry information */
   AstObject *value;         /* The Object pointer */
   struct AstMapEntry *next; /* Pointer to next AST Object entry */
   struct AstMapEntry *prev; /* Pointer to previous AST Object entry */
} Entry0A;

/* This structure is a AstMapEntry holding a scalar void pointer */
typedef struct Entry0P {
   struct AstMapEntry entry; /* The parent Entry information */
   void *value;              /* The pointer */
} Entry0P;

/* This structure is a AstMapEntry holding a 1D array of ints */
typedef struct Entry1I {
   struct AstMapEntry entry; /* The parent Entry information */
   int *value;               /* The integer values */
} Entry1I;

/* This structure is a AstMapEntry holding a 1D array of doubles */
typedef struct Entry1D {
   struct AstMapEntry entry; /* The parent Entry information */
   double *value;            /* The floating point values */
} Entry1D;

/* This structure is a AstMapEntry holding a 1D array of short ints */
typedef struct Entry1S {
   struct AstMapEntry entry; /* The parent Entry information */
   short int *value;         /* The short int values */
} Entry1S;

/* This structure is a AstMapEntry holding a 1D array of unsigned bytes */
typedef struct Entry1B {
   struct AstMapEntry entry; /* The parent Entry information */
   unsigned char *value;     /* The byte values */
} Entry1B;

/* This structure is a AstMapEntry holding a 1D array of floats */
typedef struct Entry1F {
   struct AstMapEntry entry; /* The parent Entry information */
   float *value;             /* The floating point values */
} Entry1F;

/* This structure is a AstMapEntry holding a 1D array of strings */
typedef struct Entry1C {
   struct AstMapEntry entry; /* The parent Entry information */
   const char **value;       /* The string pointers */
} Entry1C;

/* This structure is a AstMapEntry holding a 1D array of AST Objects */
typedef struct Entry1A {
   struct AstMapEntry entry; /* The parent Entry information */
   AstObject **value;        /* The Object pointers */
   struct AstMapEntry *next; /* Pointer to next AST Object entry */
   struct AstMapEntry *prev; /* Pointer to previous AST Object entry */
} Entry1A;

/* This structure is a AstMapEntry holding a 1D array of void pointers. */
typedef struct Entry1P {
   struct AstMapEntry entry; /* The parent Entry information */
   void **value;             /* The pointers */
} Entry1P;


/* Module Variables. */
/* ================= */

/* Address of this static variable is used as a unique identifier for
   member of this class. */
static int class_check;

/* Pointers to parent class methods which are extended by this class. */
static int (* parent_getobjsize)( AstObject *, int * );
static const char *(* parent_getattrib)( AstObject *, const char *, int * );
static int (* parent_testattrib)( AstObject *, const char *, int * );
static void (* parent_clearattrib)( AstObject *, const char *, int * );
static void (* parent_setattrib)( AstObject *, const char *, int * );

#if defined(THREAD_SAFE)
static int (* parent_managelock)( AstObject *, int, int, AstObject **, int * );
#endif

/* Define macros for accessing each item of thread specific global data. */
#ifdef THREAD_SAFE

/* Define how to initialise thread-specific globals. */
#define GLOBAL_inits \
   globals->Class_Init = 0; \
   globals->GetAttrib_Buff[ 0 ] = 0; \
   globals->ConvertValue_Init = 0; \
   globals->ConvertValue_Istr = 0; \
   globals->ConvertValue_Buff[ 0 ] = 0; \
   globals->MapKey_Init = 0; \
   globals->MapKey_Istr = 0;

/* Create the function that initialises global data for this module. */
astMAKE_INITGLOBALS(KeyMap)

/* Define macros for accessing each item of thread specific global data. */
#define class_init astGLOBAL(KeyMap,Class_Init)
#define class_vtab astGLOBAL(KeyMap,Class_Vtab)
#define getattrib_buff astGLOBAL(KeyMap,GetAttrib_Buff)
#define convertvalue_strings astGLOBAL(KeyMap,ConvertValue_Strings)
#define convertvalue_istr astGLOBAL(KeyMap,ConvertValue_Istr)
#define convertvalue_init astGLOBAL(KeyMap,ConvertValue_Init)
#define convertvalue_buff astGLOBAL(KeyMap,ConvertValue_Buff)
#define mapkey_strings astGLOBAL(KeyMap,MapKey_Strings)
#define mapkey_istr astGLOBAL(KeyMap,MapKey_Istr)
#define mapkey_init astGLOBAL(KeyMap,MapKey_Init)



/* If thread safety is not needed, declare and initialise globals at static
   variables. */
#else

/* Buffer returned by GetAttrib. */ \
static char getattrib_buff[ AST__KEYMAP_GETATTRIB_BUFF_LEN + 1 ];

/* Strings returned by ConvertValue */ \
static char *convertvalue_strings[ AST__KEYMAP_CONVERTVALUE_MAX_STRINGS ];

/* Offset of next string in "ConvertValue_Strings" */ \
static int convertvalue_istr;

/* "ConvertValue_Strings" array initialised? */ \
static int convertvalue_init;

/* ConvertValue string buffer */ \
static char convertvalue_buff[ AST__KEYMAP_CONVERTVALUE_BUFF_LEN + 1 ];

/* Strings returned by MapKey */ \
static char *mapkey_strings[ AST__KEYMAP_MAPKEY_MAX_STRINGS ];

/* Offset of next string in "MapKey_Strings" */ \
static int mapkey_istr;

/* "MapKey_Strings" array initialised? */ \
static int mapkey_init;


/* Define the class virtual function table and its initialisation flag
   as static variables. */
static AstKeyMapVtab class_vtab;   /* Virtual function table */
static int class_init = 0;         /* Virtual function table initialised? */

#endif

/* External Interface Function Prototypes. */
/* ======================================= */
/* The following functions have public prototypes only (i.e. no
   protected prototypes), so we must provide local prototypes for use
   within this module. */
AstKeyMap *astKeyMapId_( const char *, ... );

/* Prototypes for Private Member Functions. */
/* ======================================== */
static AstMapEntry *AddTableEntry( AstKeyMap *, int, AstMapEntry *, int * );
static AstMapEntry *CopyMapEntry( AstMapEntry *, int * );
static AstMapEntry *FreeMapEntry( AstMapEntry *, int * );
static AstMapEntry *RemoveTableEntry( AstKeyMap *, int, const char *, int * );
static AstMapEntry *SearchTableEntry( AstKeyMap *, int, const char *, int * );
static const char *ConvertKey( AstKeyMap *, const char *, char *, int, const char *, int * );
static const char *GetKey( AstKeyMap *, int index, int * );
static const char *MapIterate( AstKeyMap *, int, int * );
static const char *MapKey( AstKeyMap *, int index, int * );
static const char *SortByString( int, const char *, int * );
static int CompareEntries( const void *, const void * );
static int ConvertValue( void *, int, void *, int, int * );
static int GetObjSize( AstObject *, int * );
static int HashFun( const char *, int, unsigned long *, int * );
static int KeyCmp( const char *, const char * );
static int MapGet0A( AstKeyMap *, const char *, AstObject **, int * );
static int MapGet0C( AstKeyMap *, const char *, const char **, int * );
static int MapGet0D( AstKeyMap *, const char *, double *, int * );
static int MapGet0S( AstKeyMap *, const char *, short int *, int * );
static int MapGet0B( AstKeyMap *, const char *, unsigned char *, int * );
static int MapGet0F( AstKeyMap *, const char *, float *, int * );
static int MapGet0I( AstKeyMap *, const char *, int *, int * );
static int MapGet0P( AstKeyMap *, const char *, void **, int * );
static int MapGet1A( AstKeyMap *, const char *, int, int *, AstObject **, int * );
static int MapGet1C( AstKeyMap *, const char *, int, int, int *, char *, int * );
static int MapGet1D( AstKeyMap *, const char *, int, int *, double *, int * );
static int MapGet1B( AstKeyMap *, const char *, int, int *, unsigned char *, int * );
static int MapGet1S( AstKeyMap *, const char *, int, int *, short int *, int * );
static int MapGet1F( AstKeyMap *, const char *, int, int *, float *, int * );
static int MapGet1I( AstKeyMap *, const char *, int, int *, int *, int * );
static int MapGet1P( AstKeyMap *, const char *, int, int *, void **, int * );
static int MapGetElemA( AstKeyMap *, const char *, int, AstObject **, int * );
static int MapGetElemC( AstKeyMap *, const char *, int, int, char *, int * );
static int MapGetElemD( AstKeyMap *, const char *, int, double *, int * );
static int MapGetElemB( AstKeyMap *, const char *, int, unsigned char *, int * );
static int MapGetElemS( AstKeyMap *, const char *, int, short int *, int * );
static int MapGetElemF( AstKeyMap *, const char *, int, float *, int * );
static int MapGetElemI( AstKeyMap *, const char *, int, int *, int * );
static int MapGetElemP( AstKeyMap *, const char *, int, void **, int * );
static int MapHasKey( AstKeyMap *, const char *, int * );
static int MapLenC( AstKeyMap *, const char *, int * );
static int MapLength( AstKeyMap *, const char *, int * );
static int MapSize( AstKeyMap *, int * );
static int MapType( AstKeyMap *, const char *, int * );
static int SortByInt( const char *, const char *, int * );
static size_t SizeOfEntry( AstMapEntry *, int * );
static void AddToObjectList( AstKeyMap *, AstMapEntry *, int * );
static void AddToSortedList( AstKeyMap *, AstMapEntry *, int * );
static void CheckCircle( AstKeyMap *, AstObject *, const char *, int * );
static void Copy( const AstObject *, AstObject *, int * );
static void CopyTableEntry( AstKeyMap *, AstKeyMap *, int, int * );
static void Delete( AstObject *, int * );
static void DoubleTableSize( AstKeyMap *, int * );
static void Dump( AstObject *, AstChannel *, int * );
static void DumpEntry( AstMapEntry *, AstChannel *, int, int * );
static void FreeTableEntry( AstKeyMap *, int itab, int * );
static void InitMapEntry( AstMapEntry *, int, int, int * );
static void MapCopy( AstKeyMap *, AstKeyMap *, int * );
static void MapPut0A( AstKeyMap *, const char *, AstObject *, const char *, int * );
static void MapPut0C( AstKeyMap *, const char *, const char *, const char *, int * );
static void MapPut0D( AstKeyMap *, const char *, double, const char *, int * );
static void MapPut0B( AstKeyMap *, const char *, unsigned char, const char *, int * );
static void MapPut0S( AstKeyMap *, const char *, short int, const char *, int * );
static void MapPut0F( AstKeyMap *, const char *, float, const char *, int * );
static void MapPut0I( AstKeyMap *, const char *, int, const char *, int * );
static void MapPut0P( AstKeyMap *, const char *, void *, const char *, int * );
static void MapPut1A( AstKeyMap *, const char *, int, AstObject *const [], const char *, int * );
static void MapPut1C( AstKeyMap *, const char *, int, const char *const [], const char *, int * );
static void MapPut1D( AstKeyMap *, const char *, int, const double *, const char *, int * );
static void MapPut1B( AstKeyMap *, const char *, int, const unsigned char *, const char *, int * );
static void MapPut1S( AstKeyMap *, const char *, int, const short int *, const char *, int * );
static void MapPut1F( AstKeyMap *, const char *, int, const float *, const char *, int * );
static void MapPut1I( AstKeyMap *, const char *, int, const int *, const char *, int * );
static void MapPut1P( AstKeyMap *, const char *, int, void *const [], const char *, int * );
static void MapPutElemA( AstKeyMap *, const char *, int, AstObject *, int * );
static void MapPutElemC( AstKeyMap *, const char *, int, const char *, int * );
static void MapPutElemD( AstKeyMap *, const char *, int, double, int * );
static void MapPutElemB( AstKeyMap *, const char *, int, unsigned char, int * );
static void MapPutElemS( AstKeyMap *, const char *, int, short int, int * );
static void MapPutElemF( AstKeyMap *, const char *, int, float, int * );
static void MapPutElemI( AstKeyMap *, const char *, int, int, int * );
static void MapPutElemP( AstKeyMap *, const char *, int, void *, int * );
static void MapPutU( AstKeyMap *, const char *, const char *, int * );
static void MapRemove( AstKeyMap *, const char *, int * );
static void MapRename( AstKeyMap *, const char *, const char *, int * );
static void NewTable( AstKeyMap *, int, int * );
static void RemoveFromSortedList( AstKeyMap *, AstMapEntry *, int * );
static void RemoveFromObjectList( AstKeyMap *, AstMapEntry *, int * );
static void SortEntries( AstKeyMap *, int * );

static const char *GetAttrib( AstObject *, const char *, int * );
static int TestAttrib( AstObject *, const char *, int * );
static void ClearAttrib( AstObject *, const char *, int * );
static void SetAttrib( AstObject *, const char *, int * );

static int GetSizeGuess( AstKeyMap *, int * );
static int TestSizeGuess( AstKeyMap *, int * );
static void ClearSizeGuess( AstKeyMap *, int * );
static void SetSizeGuess( AstKeyMap *, int, int * );

static int GetSortBy( AstKeyMap *, int * );
static int TestSortBy( AstKeyMap *, int * );
static void ClearSortBy( AstKeyMap *, int * );
static void SetSortBy( AstKeyMap *, int, int * );

static int GetKeyError( AstKeyMap *, int * );
static int TestKeyError( AstKeyMap *, int * );
static void ClearKeyError( AstKeyMap *, int * );
static void SetKeyError( AstKeyMap *, int, int * );

static int GetKeyCase( AstKeyMap *, int * );
static int TestKeyCase( AstKeyMap *, int * );
static void ClearKeyCase( AstKeyMap *, int * );
static void SetKeyCase( AstKeyMap *, int, int * );

static int GetMapLocked( AstKeyMap *, int * );
static int TestMapLocked( AstKeyMap *, int * );
static void ClearMapLocked( AstKeyMap *, int * );
static void SetMapLocked( AstKeyMap *, int, int * );

#if defined(THREAD_SAFE)
static int ManageLock( AstObject *, int, int, AstObject **, int * );
#endif

/* Member functions. */
/* ================= */
static AstMapEntry *AddTableEntry( AstKeyMap *this, int itab, AstMapEntry *entry, int *status ){
/*
*  Name:
*     AddTableEntry

*  Purpose:
*     Add an new entry to a linked-list of KeyMap entries.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     AstMapEntry *AddTableEntry( AstKeyMap *this, int itab, AstMapEntry *entry, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function adds the supplied MapEntry to the head of the linked
*     list of MapEntries stored at the specified entry of the hash table.
*     If this results in the linked list having too many entries, then a
*     new larger hash table is allocated and the entries in the existing
*     table are moved into the new table.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     itab
*        Index of the hash table element to be searched.
*     entry
*        Pointer to the MapEntry to be added.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     A NULL pointer.

*/

/* Check the global error status. */
   if ( !astOK ) return NULL;

/* Put a pointer to the MapEntry which is currently at the head of the
   linked list in the "next" component of the supplied MapEntry. */
   entry->next = this->table[ itab ];

/* Store the supplied MapEntry pointer in the requested element of the
   hash table. */
   this->table[ itab ] = entry;

/* Increment the length of linked list. */
   this->nentry[ itab ]++;

/* Each entry added to the KeyMap has a unique member index that is
   never re-used. */
   entry->member = (this->member_count)++;

/* Insert the supplied MapEntry into a list sorted by key. */
   AddToSortedList( this, entry, status );

/* If the entry is of type AST__OBJECTTYPE, add it to the head of the
   list of AST__OBJECTTYPE entries in the KeyMap. */
   AddToObjectList( this, entry, status );

/* If the population of this table entry is now too large, double the size
   of the table, moving the table entries to appropriate places in the
   new larger table. */
   if( this->nentry[ itab ] > MAX_ENTRIES_PER_TABLE_ENTRY ) {
      DoubleTableSize( this, status );
   }

/* Return a NULL pointer. */
   return NULL;
}

static void AddToObjectList( AstKeyMap *this, AstMapEntry *entry, int *status ){
/*
*  Name:
*     AddToObjectList

*  Purpose:
*     Add AST__OBJECTTYPE entries into a linked-list of such entries.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void AddToObjectList( AstKeyMap *this, AstMapEntry *entry, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     If the supplied MapEntry holds one or more pointers to AST Objects,
*     then the entry is added to a linked list of such entries.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     entry
*        Pointer to the MapEntry to be added.
*     status
*        Pointer to the inherited status variable.

*/

/* Local Variables: */
   Entry0A *scalar;         /* Pointer to a scalar AST__OBJECTTYPE entry */
   Entry1A *vector;         /* Pointer to a vector AST__OBJECTTYPE entry */

/* Check the global error status. */
   if ( !astOK ) return;

/* Do nothing if the entry does not hold AST Object pointers. */
   if( entry->type == AST__OBJECTTYPE ) {

/* If the list is not currently empty, add the new entry into the list. */
      if( this->firstA ) {

/* Store a pointer to the new entry as the previous link in the current
   first entry in the list. */
         if( this->firstA->nel == 0 ) {
            scalar = (Entry0A *) this->firstA;
            scalar->prev = entry;
         } else {
            vector = (Entry1A *) this->firstA;
            vector->prev = entry;
         }

/* Store a pointer to the current first entry as the next link in the new
   entry, and nullify the previus link. */
         if( entry->nel == 0 ) {
            scalar = (Entry0A *) entry;
            scalar->next = this->firstA;
            scalar->prev = NULL;
         } else {
            vector = (Entry1A *) entry;
            vector->next = this->firstA;
            vector->prev = NULL;
         }

/* If the list is currently empty, nullify both links in the entry. */
      } else {
         if( entry->nel == 0 ) {
            scalar = (Entry0A *) entry;
            scalar->next = NULL;
            scalar->prev = NULL;
         } else {
            vector = (Entry1A *) entry;
            vector->next = NULL;
            vector->prev = NULL;
         }

      }

/* Store the new entry as the first entry. */
      this->firstA = entry;
   }
}

static void AddToSortedList( AstKeyMap *this, AstMapEntry *entry, int *status ){
/*
*  Name:
*     AddToSortedList

*  Purpose:
*     Add an entry into the linked-list of sorted KeyMap entries.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void AddToSortedList( AstKeyMap *this, AstMapEntry *entry, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function adds the supplied MapEntry into the linked list of
*     sorted MapEntries at a position that maintains the sorted order.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     entry
*        Pointer to the MapEntry to be added.
*     status
*        Pointer to the inherited status variable.

*/

/* Local Variables: */
   AstMapEntry *hi;         /* MapEntry at high end of current range */
   AstMapEntry *lo;         /* MapEntry at low end of current range */
   AstMapEntry *mid;        /* MapEntry at middle of current range */
   int cmp;                 /* Result of comparing two entries */
   int istep;               /* Step counter */
   int nstep;               /* Number of entries in current range */
   int sortby;              /* How to sort the keys */

/* Check the global error status. */
   if ( !astOK ) return;

/* Get the SortBy value. */
   sortby = astGetSortBy( this );

/* Do nothing if no sorting is required. */
   if( sortby != SORTBY_NONE ) {

/* Get pointers to the entries at the start and end of the sorted list. */
      lo = this->first;
      hi = lo ? lo->sprev : NULL;

/* Store sortby value in the mapentry structures. */
      if( lo ) lo->sortby = sortby;
      if( hi ) hi->sortby = sortby;
      entry->sortby = sortby;

/* If the sorted list is empty, just store the supplied entry at the
   head, and set the links to point back to itself. */
      if( !lo ) {
         this->first = entry;
         entry->sprev = entry;
         entry->snext = entry;

/* If the new entry comes before the first entry or is equal to the first
   entry, record it as the new first entry, and insert it into the linked
   list before the original first entry. */
      } else if( CompareEntries( &entry, &lo ) <= 0 ) {
         this->first = entry;
         entry->snext = lo;
         entry->sprev = hi;
         lo->sprev = entry;
         hi->snext = entry;

/* If the new entry comes after the last entry or is equal to the last
   entry, insert it into the linked list after the last entry. */
      } else if( CompareEntries( &entry, &hi ) >= 0 ) {
         entry->snext = lo;
         entry->sprev = hi;
         lo->sprev = entry;
         hi->snext = entry;

/* If the list only contains two values, insert the new entry into the linked
   list between the existing two entries. */
      } else if( lo->snext == hi ) {
         entry->snext = hi;
         entry->sprev = lo;
         lo->snext = entry;
         hi->sprev = entry;

/* Otherwise we do a binary chop within the existing sorted list to find the
   correct position for the new entry. */
      } else {

/* Get a pointer to the entry mid way between the hi and lo entries. The
   mid entry will be on the upper side of half way if there are an even
   number of entries. */
         nstep = this->nsorted/2;
         mid = lo;
         for( istep = 0; istep < nstep; istep++ ) mid = mid->snext;

/* Loop until we have a pointer to the first entry which is equal to or
   higher than the new entry. */
         while( lo->snext != hi ) {

/* The next step will be half the length of the previous step. Do not
   allow the step size to fall to zero. */
            nstep = ( nstep > 1 ) ? nstep/2 : 1;

/* Compare the new entry with the current mid-way entry. */
            mid->sortby = sortby;
            cmp = CompareEntries( &entry, &mid );

/* If the new entry comes before the mid entry, use the mid entry as the
   next hi entry, and go down the list by the new step size to find the
   new mid-way entry. */
            if( cmp < 0 ) {
               hi = mid;
               for( istep = 0; istep < nstep; istep++ ) mid = mid->sprev;

/* If the new entry comes after the mid entry, use the mid entry as the
   next lo entry, and go up the list by the new step size to find the
   new mid-way entry. */
            } else if( cmp > 0 ) {
               lo = mid;
               for( istep = 0; istep < nstep; istep++ ) mid = mid->snext;

/* If the new entry is equal to the mid entry, use the mid entry as hi
   and set lo to the previous entry. This causes the loop to quit. */
            } else {
               hi = mid;
               lo = mid->sprev;
            }
         }

/* Insert the new entry into the list between lo and hi. */
         entry->sprev = lo;
         entry->snext = hi;
         lo->snext = entry;
         hi->sprev = entry;
      }

/* Increment the number of entries in the sorted list. */
      (this->nsorted)++;
   }
}

static void CheckCircle( AstKeyMap *this, AstObject *obj, const char *method, int *status ) {
/*
*  Name:
*     CheckCircle

*  Purpose:
*     Check for circular dependencies between KeyMaps.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void CheckCircle( AstKeyMap *this, AstObject *obj, const char *method, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function checks that the given AstObject is not a KeyMap which
*     contains "this". If it is, an error is reported.

*  Parameters:
*     this
*        The KeyMap pointer.
*     obj
*        Pointer to the AstObject to be inserted into the KeyMap, or NULL.
*     method
*        Name of method to include in error messages.
*     status
*        Pointer to the inherited status variable.

*/

/* Local Variables: */
   AstKeyMap *keymap;       /* The KeyMap being added to "this" */
   AstObject **vec;         /* Pointer to list of AstObject pointers */
   const char *key;         /* The i'th key within second KeyMap */
   int i;                   /* Index of entry within second KeyMap */
   int j;                   /* Index within the vector of values */
   int len;                 /* No. of AST pointers stored in the entry */
   int nkey;                /* No. of entries in the second KeyMap */

/* Check the global error status. */
   if( !astOK ) return;

/* Return if the AstObject is not a KeyMap. */
   if( obj && astIsAKeyMap( obj ) ) {
      keymap = (AstKeyMap *) obj;

/* First check if the supplied Objects are the same. You cannot store a
   KeyMap as an entry within itself. */
      if( keymap == this ) {
         astError( AST__KYCIR, "%s(%s): Cannot add a %s into another "
                   "%s because they are same %s.", status, method,
                   astGetClass( this ), astGetClass( this ),
                   astGetClass( this ), astGetClass( this ) );

/* Otherwise, loop through all the entries in the KeyMap looking for AstObject
   entries. */
      } else {
         nkey = astMapSize( keymap );
         for( i = 0; i < nkey && astOK; i++ ) {
            key = astMapKey( keymap, i );
            if( astMapType( keymap, key ) == AST__OBJECTTYPE ) {

/* Find the number of AstObject pointers stored in this entry, and
   allocate memory to store a copy of the every pointer. */
               len = astMapLength( keymap, key );
               vec = astMalloc( sizeof( AstObject *) * len );
               if( vec ) {

/* Extract pointers to the AstObjects at this entry, and loop round them. */
                  astMapGet1A( keymap, key, len, &len, vec );
                  for( j = 0; j < len; j++ ) {

/* If this entry is a KeyMap, we need to check if is the same as "this"
   or contains "this". */
                     if( astIsAKeyMap( vec[ j ] ) ) {

/* If it is the same as "this", report an error. */
                        if( vec[ j ] == (AstObject *) this ) {
                           astError( AST__KYCIR, "%s(%s): Cannot add a KeyMap "
                                     "into another KeyMap because the first "
                                     "KeyMap contains the second KeyMap.", status,
                                     method, astGetClass( this ) );
                           break;

/* Otherwise, see if it contains "this". */
                        } else {
                           CheckCircle( this, vec[ j ], method, status );
                        }
                     }

/* Free resources. */
                     vec[ j ] = astAnnul( vec[ j ] );
                  }
                  vec = astFree( vec );
               }
            }
         }
      }
   }
}

static void ClearAttrib( AstObject *this_object, const char *attrib, int *status ) {
/*
*  Name:
*     ClearAttrib

*  Purpose:
*     Clear an attribute value for a KeyMap.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void ClearAttrib( AstObject *this, const char *attrib, int *status )

*  Class Membership:
*     KeyMap member function (over-rides the astClearAttrib protected
*     method inherited from the Mapping class).

*  Description:
*     This function clears the value of a specified attribute for a
*     KeyMap, so that the default value will subsequently be used.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     attrib
*        Pointer to a null-terminated string specifying the attribute
*        name.  This should be in lower case with no surrounding white
*        space.
*     status
*        Pointer to the inherited status variable.
*/

/* Local Variables: */
   AstKeyMap *this;             /* Pointer to the KeyMap structure */

/* Check the global error status. */
   if ( !astOK ) return;

/* Obtain a pointer to the KeyMap structure. */
   this = (AstKeyMap *) this_object;

/* Check the attribute name and clear the appropriate attribute. */

/* SizeGuess. */
/* ---------- */
   if ( !strcmp( attrib, "sizeguess" ) ) {
      astClearSizeGuess( this );

/* KeyError. */
/* --------- */
   } else if ( !strcmp( attrib, "keyerror" ) ) {
      astClearKeyError( this );

/* KeyCase. */
/* --------- */
   } else if ( !strcmp( attrib, "keycase" ) ) {
      astClearKeyCase( this );

/* MapLocked. */
/* --------- */
   } else if ( !strcmp( attrib, "maplocked" ) ) {
      astClearMapLocked( this );

/* SortBy. */
/* ------- */
   } else if ( !strcmp( attrib, "sortby" ) ) {
      astClearSortBy( this );

/* If the attribute is still not recognised, pass it on to the parent
   method for further interpretation. */
   } else {
      (*parent_clearattrib)( this_object, attrib, status );
   }
}

static void ClearKeyCase( AstKeyMap *this, int *status ) {
/*
*+
*  Name:
*     astClearKeyCase

*  Purpose:
*     Clear the value of the KeyCase attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     void astSetKeyCase( AstKeyMap *this )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function Clears the KeyCase attribute of a KeyMap. It reports
*     an error if the KeyMap contains any entries.

*  Parameters:
*     this
*        Pointer to the KeyMap.

*-
*/

/* Local Variables: */
   int defval;                /* Default KeyCase value */
   int itab;                  /* Index into hash table */
   int oldval;                /* Old KeyCase value */

/* Check the global error status. */
   if ( !astOK ) return;

/* Save the old value. */
   oldval = astGetKeyCase( this );

/* Clear it. */
   this->keycase = -1;

/* Get the default value. */
   defval = astGetKeyCase( this );

/* If the old value and the default value are not the same, we must check
   that the KeyMap is empty. If not, restore the old value and report an
   error. */
   if( defval != oldval ) {
      for( itab = 0; itab < this->mapsize; itab++ ) {
         if( this->nentry[ itab ] > 0 ) {
            this->keycase = oldval;
            astError( AST__NOWRT, "astClearAttrib(KeyMap): Illegal attempt to "
                      "clear the KeyCase attribute of a non-empty KeyMap.",
                      status);
            break;
         }
      }
   }
}

static void ClearKeyError( AstKeyMap *this, int *status ) {
/*
*+
*  Name:
*     astClearKeyError

*  Purpose:
*     Clear the value of the KeyError attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     void astClearKeyError( AstKeyMap *this )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function clears the value of the KeyError attribute for a
*     KeyMap. It clears the attribute recursively in any KeyMaps
*     contained within the supplied KeyMap.

*  Parameters:
*     this
*        Pointer to the KeyMap.

*-
*/

/* Local Variables: */
   AstMapEntry *next;     /* Pointer to next Entry to copy */
   AstObject **obj_list;  /* List of pointers to AST Object entries */
   int i;                 /* Index into hash table */
   int iel;               /* Index of current vector element */
   int nel;               /* Number of elements in vector */

/* Check the global error status. */
   if ( !astOK ) return;

/* Clear the KeyError value in the supplied KeyMap. */
   this->keyerror = -INT_MAX;

/* Loop round each entry in the hash table. */
   for( i = 0; i < this->mapsize; i++ ) {

/* Get a pointer to the next KeyMap entry. */
      next = this->table[ i ];

/* Loop round all entries in this element of the hash table. */
      while( next && astOK ) {

/* If this entry has an Object data type, see if holds any KeyMaps. */
         if( next->type == AST__OBJECTTYPE ) {

/* Get the number of objects to check, and a pointer to the first. */
            nel = next->nel;
            if( nel == 0 ) {
               obj_list = &( ((Entry0A *)next)->value );
               nel = 1;
            } else {
               obj_list = ((Entry1A *)next)->value;
            }

/* Loop round checking all Objects. */
            for( iel = 0; iel < nel; iel++ ) {

/* If this Object is a KeyMap, clear its KeyError attribute. */
               if( astIsAKeyMap( obj_list[ iel ] ) ) {
                  astClearKeyError( (AstKeyMap *) obj_list[ iel ] );
               }
            }
         }

/* Get a pointer to the next entry. */
         next = next->next;
      }
   }
}

static void ClearMapLocked( AstKeyMap *this, int *status ) {
/*
*+
*  Name:
*     astClearMapLocked

*  Purpose:
*     Clear the value of the MapLocked attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     void astClearMapLocked( AstKeyMap *this )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function clears the value of the MapLocked attribute for a
*     KeyMap. It clears the attribute recursively in any KeyMaps
*     contained within the supplied KeyMap.

*  Parameters:
*     this
*        Pointer to the KeyMap.

*-
*/

/* Local Variables: */
   AstMapEntry *next;     /* Pointer to next Entry to copy */
   AstObject **obj_list;  /* List of pointers to AST Object entries */
   int i;                 /* Index into hash table */
   int iel;               /* Index of current vector element */
   int nel;               /* Number of elements in vector */

/* Check the global error status. */
   if ( !astOK ) return;

/* Clear the MapLocked value in the supplied KeyMap. */
   this->maplocked = -INT_MAX;

/* Loop round each entry in the hash table. */
   for( i = 0; i < this->mapsize; i++ ) {

/* Get a pointer to the next KeyMap entry. */
      next = this->table[ i ];

/* Loop round all entries in this element of the hash table. */
      while( next && astOK ) {

/* If this entry has an Object data type, see if holds any KeyMaps. */
         if( next->type == AST__OBJECTTYPE ) {

/* Get the number of objects to check, and a pointer to the first. */
            nel = next->nel;
            if( nel == 0 ) {
               obj_list = &( ((Entry0A *)next)->value );
               nel = 1;
            } else {
               obj_list = ((Entry1A *)next)->value;
            }

/* Loop round checking all Objects. */
            for( iel = 0; iel < nel; iel++ ) {

/* If this Object is a KeyMap, clear its MapLocked attribute. */
               if( astIsAKeyMap( obj_list[ iel ] ) ) {
                  astClearMapLocked( (AstKeyMap *) obj_list[ iel ] );
               }
            }
         }

/* Get a pointer to the next entry. */
         next = next->next;
      }
   }
}

static void ClearSizeGuess( AstKeyMap *this, int *status ) {
/*
*+
*  Name:
*     astClearSizeGuess

*  Purpose:
*     Clear the value of the SizeGuess attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     void astClearSizeGuess( AstKeyMap *this )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function clears the value of the SizeGuess attribute for a
*     KeyMap. It reports an error if the KeyMap contains any entries.

*  Parameters:
*     this
*        Pointer to the KeyMap.

*-
*/

/* Local Variables: */
   int empty;                 /* Is the KeyMap empty? */
   int itab;                  /* Index into hash table */

/* Check the global error status. */
   if ( !astOK ) return;

/* See if the KeyMap is empty. */
   empty = 1;
   for( itab = 0; itab < this->mapsize; itab++ ) {
      if( this->nentry[ itab ] > 0 ) {
         empty = 0;
         break;
      }
   }

/* If not report an error. */
   if( !empty ) {
      astError( AST__NOWRT, "astClearAttrib(KeyMap): Illegal attempt to "
                "clear the SizeGuess attribute of a non-empty KeyMap." , status);

/* Otherwise, store the "cleared" value and change the size of the hash
   table. */
   } else {
      this->sizeguess = INT_MAX;
      NewTable( this, MIN_TABLE_SIZE, status );
   }
}

static void ClearSortBy( AstKeyMap *this, int *status ) {
/*
*+
*  Name:
*     astClearSortBy

*  Purpose:
*     Clear the value of the SortBy attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     void astClearSortBy( AstKeyMap *this )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function clears the value of the SortBy attribute for a
*     KeyMap.

*  Parameters:
*     this
*        Pointer to the KeyMap.

*-
*/

/* Local Variables: */
   int oldval;            /* The old sortby value */

/* Check the global error status. */
   if ( !astOK ) return;

/* Get the original SortBy value. */
   oldval = astGetSortBy( this );

/* Clear the SortBy value in the supplied KeyMap. */
   this->sortby = -INT_MAX;

/* If the value has changed, re-sort the keys. */
   if( oldval != astGetSortBy( this ) ) SortEntries( this, status );
}

static int CompareEntries( const void *first_void, const void *second_void ) {
/*
*  Name:
*     CompareEntries

*  Purpose:
*     Determine the sorting order of two mapEntries.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     int CompareEntries( const void *first, const void *second )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function returns a value indicating if the first MapEntry
*     is less than, equal to, or greater than the second MapEntry using
*     the indicated sorting method. It is designed for use with the
*     "qsort" function, and therefore must used "void *" pointers.

*  Parameters:
*     first
*        Pointer to the address of the first MapEntry.
*     second
*        Pointer to the address of the second MapEntry.

*  Returned Value:
*     -1 if "first" is less than "second". This implies that "first"
*     should come before "second" in the sorted list.
*
*     0 if "first" is equal to "second".
*
*     +1 if "first" is greater than "second". This implies that "first"
*     should come after "second" in the sorted list.

*/

/* Local Variables: */
   AstMapEntry *first;   /* Pointer to first MapEntry structure */
   AstMapEntry *second;  /* Pointer to second MapEntry structure */
   int result;           /* Returned value */
   int sortby;           /* Sorting method */

/* Initialise returned value */
   result = 0;

/* Get pointers to the MapEntry structures, and get the sorting method. */
   first = *( (AstMapEntry **) first_void );
   second = *( (AstMapEntry **) second_void );
   sortby = first->sortby;

/* First handle sorting by increasing age */
   if( sortby == SORTBY_AGEUP ) {
      if( first->member < second->member ) {
         result = 1;
      } else if( first->member > second->member ) {
         result = -1;
      } else {
         result = 0;
      }

/* Next handle sorting by decreasing age */
   } else if( sortby == SORTBY_AGEDOWN ) {
      if( first->member < second->member ) {
         result = -1;
      } else if( first->member > second->member ) {
         result = 1;
      } else {
         result = 0;
      }

/* Next handle sorting by increasing alphabetical position. */
   } else if( sortby == SORTBY_KEYUP ) {
      result = KeyCmp( first->key, second->key );

/* Next handle sorting by decreasing alphabetical position. */
   } else if( sortby == SORTBY_KEYDOWN ) {
      result = KeyCmp( second->key, first->key );

   }

/* Return the result. */
   return result;

}

static const char *ConvertKey( AstKeyMap *this, const char *skey, char *keybuf,
                               int blen, const char *method, int *status ){
/*
*  Name:
*     ConvertValue

*  Purpose:
*     Convert the supplied key to upper case if required.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     const char *ConvertKey( AstKeyMap *this, const char *skey, char *keybuf,
*                             int blen, const char *method, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function converts the supplied key string to uppercase if the
*     KeyCase attribute it currently set to zero in the supplied KeyMap.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     skey
*        Pointer to the supplied key string.
*     keybuf
*        Pointer to a buffer in which to place the converted string. This
*        will only be used if the supplied key string needs to be
*        converted.
*     blen
*        The length of the "keybuf" buffer. This should include room for
*        a terminating null character.
*     method
*        Pointer to a string holding the name of the method to include in
*        any error message.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     If the KeyMap's KeyCase attribute is currently set to a non-zero
*     value, the returned value will be a copy of "skey". Otherwise it
*     will be copy of "keybuf" (the buffer holding the upper case version
*     of the supplied string).

*  Notes:
*     - The valeu of "skey" will be returned if this function is invoked
*     with the global error status set, or if it should fail for any reason.
*/

/* Local Variables: */
   const char *result;
   int len;

/* Initialise. */
   result = skey;

/* Check the global error status and the supplied pointers. */
   if( !astOK ) return result;

/* If the KeyCase attribute is non-zero, return "skey". Otherwise, convert
   the "skey" string to upper case and return "keybuf". Report an error if
   the key is too long. */
   if( !astGetKeyCase( this ) && astOK ) {
      len = astChrLen( skey );
      if( len >= blen ) {
         astError( AST__BIGKEY, "%s(%s): Supplied key '%s' is too long "
                   "(keys must be no more than %d characters long).",
                   status, method, astGetClass( this ), skey, blen - 1 );
      } else {
         astChrCase( skey, keybuf, 1, blen );
         result = keybuf;
      }
   }

/* Return the result. */
   return result;
}

static int ConvertValue( void *raw, int raw_type, void *out, int out_type, int *status ) {
/*
*  Name:
*     ConvertValue

*  Purpose:
*     Convert a value from one KeyMap data type to another.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     int ConvertValue( void *raw, int raw_type, void *out, int out_type, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function converts a supplied value from one KeyMap data type to
*     another, if possible.

*  Parameters:
*     raw
*        Pointer to input value.
*     raw_type
*        The data type of the input value.
*     out
*        Pointer to the location at which to store the output value. This
*        may be NULL, in which case the conversion is still performed if
*        possible, but the result of the conversion is thrown away.
*     out_type
*        The data type of the output value.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     Non-zero if the conversion was performed succesfully, otherwise zero.
*     In the case of the output type being AST__STRINGTYPE, the returned
*     non-zero value will be the length of the formatted string (including
*     the terminating null character). This value will be returned correctly
*     even if "out" is NULL.

*  Notes:
*     - Zero will be returned if this function is invoked with the global
*     error status set, or if it should fail for any reason.
*/

/* Local Variables: */
   AstObject *aval;              /* AstObject pointer value */
   astDECLARE_GLOBALS            /* Declare the thread specific global data */
   const char *cval;             /* Pointer to string value */
   const char *cvalue;           /* Pointer to output string value */
   double dval;                  /* Double precision value */
   float fval;                   /* Single precision value */
   int i;                        /* Loop count */
   int ival;                     /* Integer value */
   int n1;                       /* Number of characters at reduced precision */
   int n2;                       /* Number of characters at full precision */
   int nc;                       /* Number of characters read from string */
   int nval;                     /* Number of values read from string */
   int result;                   /* Returned flag */
   short int sval;               /* Short int value */
   unsigned char bval;           /* Byte value */

/* Initialise. */
   result = 0;

/* Check the global error status and the supplied pointers. */
   if( !astOK || !raw ) return result;

/* Get a pointer to the structure holding thread-specific global data. */
   astGET_GLOBALS(NULL);

/* If the "convertvalue_strings" array has not been initialised, fill it with
   NULL pointers. */
   if( !convertvalue_init ) {
      convertvalue_init = 1;
      for( i = 0; i < AST__KEYMAP_CONVERTVALUE_MAX_STRINGS; i++ ) convertvalue_strings[ i ] = NULL;
   }

/* Assume conversion is possible */
   result = 1;
   cvalue = NULL;

/* Do nothing if both data types are AST__UNDEFTYPE. */
    if( raw_type == AST__UNDEFTYPE && out_type == AST__UNDEFTYPE ) {

/* Indicate failure if one of the two types is AST__UNDEFTYPE and the
   other is not. */
    } else if( raw_type == AST__UNDEFTYPE || out_type == AST__UNDEFTYPE ) {
      result = 0;

/* Otherwise, consider conversion from "int". */
    } else if( raw_type == AST__INTTYPE ) {
      ival = *( (int *) raw );

/* Consider conversion to "int". */
      if( out_type == AST__INTTYPE ) {
         if( out ) *( (int *) out ) = ival;

/* Consider conversion to "short int". */
      } else if( out_type == AST__SINTTYPE ) {
         if( out ) *( (short int *) out ) = (short int) ival;

/* Consider conversion to "byte". */
      } else if( out_type == AST__BYTETYPE ) {
         if( out ) *( (unsigned char *) out ) = (unsigned char) ival;

/* Consider conversion to "float". */
      } else if( out_type == AST__FLOATTYPE ) {
         if( out ) *( (float *) out ) = (float) ival;

/* Consider conversion to "double". */
      } else if( out_type == AST__DOUBLETYPE ) {
         if( out ) *( (double *) out ) = (double) ival;

/* Consider conversion to "const char *". */
      } else if( out_type == AST__STRINGTYPE ) {
         (void) sprintf( convertvalue_buff, "%d", ival );
         cvalue = convertvalue_buff;

/* Consider conversion to "AstObject *". */
      } else if( out_type == AST__OBJECTTYPE ) {
         result = 0;

/* Consider conversion to "void *". */
      } else if( out_type == AST__POINTERTYPE ) {
         result = 0;

/* Report an error if the data type is unknown. */
      } else {
         result = 0;
         astError( AST__INTER, "ConvertValue(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   out_type );
      }

/* Otherwise, consider conversion from "short int". */
    } else if( raw_type == AST__SINTTYPE ) {
      sval = *( (short int *) raw );

/* Consider conversion to "int". */
      if( out_type == AST__INTTYPE ) {
         if( out ) *( (int *) out ) = sval;

/* Consider conversion to "short int". */
      } else if( out_type == AST__SINTTYPE ) {
         if( out ) *( (short int *) out ) = sval;

/* Consider conversion to "byte". */
      } else if( out_type == AST__BYTETYPE ) {
         if( out ) *( (unsigned char *) out ) = sval;

/* Consider conversion to "float". */
      } else if( out_type == AST__FLOATTYPE ) {
         if( out ) *( (float *) out ) = (float) sval;

/* Consider conversion to "double". */
      } else if( out_type == AST__DOUBLETYPE ) {
         if( out ) *( (double *) out ) = (double) sval;

/* Consider conversion to "const char *". */
      } else if( out_type == AST__STRINGTYPE ) {
         (void) sprintf( convertvalue_buff, "%d", (int) sval );
         cvalue = convertvalue_buff;

/* Consider conversion to "AstObject *". */
      } else if( out_type == AST__OBJECTTYPE ) {
         result = 0;

/* Consider conversion to "void *". */
      } else if( out_type == AST__POINTERTYPE ) {
         result = 0;

/* Report an error if the data type is unknown. */
      } else {
         result = 0;
         astError( AST__INTER, "ConvertValue(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   out_type );
      }

/* Otherwise, consider conversion from "byte". */
    } else if( raw_type == AST__BYTETYPE ) {
      bval = *( (unsigned char *) raw );

/* Consider conversion to "int". */
      if( out_type == AST__INTTYPE ) {
         if( out ) *( (int *) out ) = bval;

/* Consider conversion to "short int". */
      } else if( out_type == AST__SINTTYPE ) {
         if( out ) *( (short int *) out ) = bval;

/* Consider conversion to "byte". */
      } else if( out_type == AST__BYTETYPE ) {
         if( out ) *( (unsigned char *) out ) = bval;

/* Consider conversion to "float". */
      } else if( out_type == AST__FLOATTYPE ) {
         if( out ) *( (float *) out ) = (float) bval;

/* Consider conversion to "double". */
      } else if( out_type == AST__DOUBLETYPE ) {
         if( out ) *( (double *) out ) = (double) bval;

/* Consider conversion to "const char *". */
      } else if( out_type == AST__STRINGTYPE ) {
         (void) sprintf( convertvalue_buff, "%d", (int) bval );
         cvalue = convertvalue_buff;

/* Consider conversion to "AstObject *". */
      } else if( out_type == AST__OBJECTTYPE ) {
         result = 0;

/* Consider conversion to "void *". */
      } else if( out_type == AST__POINTERTYPE ) {
         result = 0;

/* Report an error if the data type is unknown. */
      } else {
         result = 0;
         astError( AST__INTER, "ConvertValue(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   out_type );
      }

/* Consider conversion from "double". */
   } else if( raw_type == AST__DOUBLETYPE ) {
      dval = *( (double *) raw );

/* Consider conversion to "int". */
      if( out_type == AST__INTTYPE ) {
         if( out ) *( (int *) out ) = (int)( dval + 0.5 );

/* Consider conversion to "short int". */
      } else if( out_type == AST__SINTTYPE ) {
         if( out ) *( (short int *) out ) = (int)( dval + 0.5 );

/* Consider conversion to "byte". */
      } else if( out_type == AST__BYTETYPE ) {
         if( out ) *( (unsigned char *) out ) = (int)( dval + 0.5 );

/* Consider conversion to "double". */
      } else if( out_type == AST__DOUBLETYPE ) {
         if( out ) *( (double *) out ) = dval;

/* Consider conversion to "float". */
      } else if( out_type == AST__FLOATTYPE ) {
         if( out ) *( (float *) out ) = (float) dval;

/* Consider conversion to "const char *". If reducing the number of
   decimal places by two produces a saving of 10 or more characters,
   assume the least significant two characters are rounding error. */
      } else if( out_type == AST__STRINGTYPE ) {
         if( dval != AST__BAD ) {
            n1 = sprintf( convertvalue_buff, "%.*g", DBL_DIG - 2, dval );
            n2 = sprintf( convertvalue_buff, "%.*g", DBL_DIG, dval );
            if( n2 - n1 > 9 ) {
               (void) sprintf( convertvalue_buff, "%.*g", DBL_DIG - 2, dval );
            }
            cvalue = convertvalue_buff;
         } else {
            cvalue = BAD_STRING;
         }

/* Consider conversion to "AstObject *". */
      } else if( out_type == AST__OBJECTTYPE ) {
         result = 0;

/* Consider conversion to "void *". */
      } else if( out_type == AST__POINTERTYPE ) {
         result = 0;

/* Report an error if the data type is unknown. */
      } else {
         result = 0;
         astError( AST__INTER, "ConvertValue(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   out_type );
      }

/* Consider conversion from "float". */
   } else if( raw_type == AST__FLOATTYPE ) {
      fval = *( (float *) raw );

/* Consider conversion to "int". */
      if( out_type == AST__INTTYPE ) {
         if( out ) *( (int *) out ) = (int)( fval + 0.5 );

/* Consider conversion to "short int". */
      } else if( out_type == AST__SINTTYPE ) {
         if( out ) *( (short int *) out ) = (int)( fval + 0.5 );

/* Consider conversion to "byte". */
      } else if( out_type == AST__BYTETYPE ) {
         if( out ) *( (unsigned char *) out ) = (int)( fval + 0.5 );

/* Consider conversion to "double". */
      } else if( out_type == AST__DOUBLETYPE ) {
         if( out ) *( (double *) out ) = (double) fval;

/* Consider conversion to "float". */
      } else if( out_type == AST__FLOATTYPE ) {
         if( out ) *( (float *) out ) = fval;

/* Consider conversion to "const char *". */
      } else if( out_type == AST__STRINGTYPE ) {
         (void) sprintf( convertvalue_buff, "%.*g", FLT_DIG, fval );
         cvalue = convertvalue_buff;

/* Consider conversion to "AstObject *". */
      } else if( out_type == AST__OBJECTTYPE ) {
         result = 0;

/* Consider conversion to "void *". */
      } else if( out_type == AST__POINTERTYPE ) {
         result = 0;

/* Report an error if the data type is unknown. */
      } else {
         result = 0;
         astError( AST__INTER, "ConvertValue(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   out_type );
      }

/* Consider conversion from "const char *". */
   } else if( raw_type == AST__STRINGTYPE ) {
      cval = *( (const char **) raw );

/* Consider conversion to "int". */
      if( out_type == AST__INTTYPE ) {
         nc = 0;
         nval = astSscanf( cval, " %d %n", &ival, &nc );
         if( ( nval == 1 ) && ( nc >= (int) strlen( cval ) ) ) {
            if( out ) *( (int *) out ) = ival;
         } else {
            nc = 0;
            nval = astSscanf( cval, " %lf %n", &dval, &nc );
            if( ( nval == 1 ) && ( nc >= (int) strlen( cval ) ) ) {
               if( out ) *( (int *) out ) = (int) ( dval + 0.5 );
            } else {
               result = 0;
            }
         }

/* Consider conversion to "short int". */
      } else if( out_type == AST__SINTTYPE ) {
         nc = 0;
         nval = astSscanf( cval, " %d %n", &ival, &nc );
         if( ( nval == 1 ) && ( nc >= (int) strlen( cval ) ) ) {
            if( out ) *( (short int *) out ) = ival;
         } else {
            nc = 0;
            nval = astSscanf( cval, " %lf %n", &dval, &nc );
            if( ( nval == 1 ) && ( nc >= (int) strlen( cval ) ) ) {
               if( out ) *( (short int *) out ) = (int) ( dval + 0.5 );
            } else {
               result = 0;
            }
         }

/* Consider conversion to "byte". */
      } else if( out_type == AST__BYTETYPE ) {
         nc = 0;
         nval = astSscanf( cval, " %d %n", &ival, &nc );
         if( ( nval == 1 ) && ( nc >= (int) strlen( cval ) ) ) {
            if( out ) *( (unsigned char *) out ) = ival;
         } else {
            nc = 0;
            nval = astSscanf( cval, " %lf %n", &dval, &nc );
            if( ( nval == 1 ) && ( nc >= (int) strlen( cval ) ) ) {
               if( out ) *( (unsigned char *) out ) = (int) ( dval + 0.5 );
            } else {
               result = 0;
            }
         }

/* Consider conversion to "double". */
      } else if( out_type == AST__DOUBLETYPE ) {
         nc = 0;
         nval = astSscanf( cval, " " BAD_STRING " %n", &nc );
         if( ( astSscanf( cval, " " BAD_STRING " %n", &nc ) == 0 ) &&
             ( nc >= (int) strlen( cval ) ) ) {
            if( out ) *( (double *) out ) = AST__BAD;

         } else if( ( astSscanf( cval, " %lf %n", &dval, &nc ) == 1 ) &&
                     ( nc >= (int) strlen( cval ) ) ) {
            if( out ) *( (double *) out ) = dval;

         } else {
            result = 0;
         }

/* Consider conversion to "float". */
      } else if( out_type == AST__FLOATTYPE ) {
         nc = 0;
         nval = astSscanf( cval, " %f %n", &fval, &nc );
         if( ( nval == 1 ) && ( nc >= (int) strlen( cval ) ) ) {
            if( out ) *( (float *) out ) = fval;
         } else {
            result = 0;
         }

/* Consider conversion to "const char *". */
      } else if( out_type == AST__STRINGTYPE ) {
         cvalue = cval;

/* Consider conversion to "AstObject *". */
      } else if( out_type == AST__OBJECTTYPE ) {
         result = 0;

/* Consider conversion to "void *". */
      } else if( out_type == AST__POINTERTYPE ) {
         result = 0;

/* Report an error if the data type is unknown. */
      } else {
         result = 0;
         astError( AST__INTER, "ConvertValue(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   out_type );
      }

/* Consider conversion from "AstObject *". */
   } else if( raw_type == AST__OBJECTTYPE ) {

/* Consider conversion to "int". */
      if( out_type == AST__INTTYPE ) {
         result = 0;

/* Consider conversion to "short int". */
      } else if( out_type == AST__SINTTYPE ) {
         result = 0;

/* Consider conversion to "byte". */
      } else if( out_type == AST__BYTETYPE ) {
         result = 0;

/* Consider conversion to "double". */
      } else if( out_type == AST__DOUBLETYPE ) {
         result = 0;

/* Consider conversion to "float". */
      } else if( out_type == AST__FLOATTYPE ) {
         result = 0;

/* Consider conversion to "const char *". */
      } else if( out_type == AST__STRINGTYPE ) {
         result = 0;

/* Consider conversion to "AstObject *". */
      } else if( out_type == AST__OBJECTTYPE ) {
         aval = *( (AstObject **) raw );
         if( out ) *( (AstObject **) out ) = aval ? astClone( aval ) : NULL;

/* Consider conversion to "void *". */
      } else if( out_type == AST__POINTERTYPE ) {
         result = 0;

/* Report an error if the data type is unknown. */
      } else {
         result = 0;
         astError( AST__INTER, "ConvertValue(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   out_type );
      }

/* Consider conversion from "void *". */
   } else if( raw_type == AST__POINTERTYPE ) {

/* Consider conversion to "int". */
      if( out_type == AST__INTTYPE ) {
         result = 0;

/* Consider conversion to "short int". */
      } else if( out_type == AST__SINTTYPE ) {
         result = 0;

/* Consider conversion to "byte". */
      } else if( out_type == AST__BYTETYPE ) {
         result = 0;

/* Consider conversion to "double". */
      } else if( out_type == AST__DOUBLETYPE ) {
         result = 0;

/* Consider conversion to "float". */
      } else if( out_type == AST__FLOATTYPE ) {
         result = 0;

/* Consider conversion to "const char *". */
      } else if( out_type == AST__STRINGTYPE ) {
         result = 0;

/* Consider conversion to "AstObject *". */
      } else if( out_type == AST__OBJECTTYPE ) {
         result = 0;

/* Consider conversion to "void *". */
      } else if( out_type == AST__POINTERTYPE ) {
         if( out ) *( (void **) out ) = *( (void **) raw );

/* Report an error if the data type is unknown. */
      } else {
         result = 0;
         astError( AST__INTER, "ConvertValue(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   out_type );
      }

/* Report an error if the data type is unknown. */
   } else {
      result = 0;
      astError( AST__INTER, "ConvertValue(KeyMap): Illegal map entry data "
                "type %d encountered (internal AST programming error).", status,
                raw_type );
   }

/* If the output is a string, store a copy of the resulting string in
   dynamically allocated memory, putting a pointer to the copy into the next
   element of the "convertvalue_strings" array.  (This process also de-allocates
   any previously allocated memory pointed at by this "convertvalue_strings"
   element, so the earlier string is effectively replaced by the new
   one.) */
   if( out_type == AST__STRINGTYPE && astOK && result && cvalue ) {
      result = strlen( cvalue ) + 1;

      astBeginPM;
      convertvalue_strings[ convertvalue_istr ] = astStore( convertvalue_strings[ convertvalue_istr ], cvalue,
                                  (size_t) result );
      astEndPM;

/* If OK, return a pointer to the copy and increment "convertvalue_istr" to use the
   next element of "convertvalue_strings" on the next invocation. Recycle "convertvalue_istr" to
   zero when all elements have been used. */
      if ( astOK ) {
         if( out ) *( (const char **) out ) = convertvalue_strings[ convertvalue_istr++ ];
         if( convertvalue_istr == ( AST__KEYMAP_CONVERTVALUE_MAX_STRINGS - 1 ) ) convertvalue_istr = 0;
      }
   }

/* If an error has occurred, return zero. */
   if( !astOK ) result = 0;

/* Return the result. */
   return result;
}


static AstMapEntry *CopyMapEntry( AstMapEntry *in, int *status ){
/*
*  Name:
*     CopyMapEntry

*  Purpose:
*     Produces a copy of the supplied KeyMap entry.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     AstMapEntry *CopyMapEntry( AstMapEntry *in, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function creates a deep copy of the supplied KeyMap entry.

*  Parameters:
*     in
*        Pointer to the MapEntry to be copied. NULL may be supplied in
*        which case NULL will be returned.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     Pointer to the new copy. The link to the next MapEntry in the
*     linked list is set NULL in the returned copy.

*  Notes:
*     - A NULL pointer will be returned if this function is invoked
*     with the global error status set, or if it should fail for any
*     reason.
*/

/* Local Variables: */
   AstMapEntry *result;   /* Returned pointer */
   AstObject **alist;     /* Pointer to list of AST object pointers */
   AstObject *obj;        /* Pointer to AstObject value */
   const char **slist;    /* Pointer to list of text pointers */
   const char *text;      /* Pointer to text string */
   int i;                 /* Loop count */
   int nel;               /* No. of values in entry vector (0 => scalar) */
   int type;              /* Entry data type */
   size_t size;           /* Size of Entry structure */

/* Initialise. */
   result = NULL;

/* Check the global error status and the supplied pointer. */
   if ( !astOK || !in ) return result;

/* Get the size, data type and length of the MapEntry. */
   size = SizeOfEntry( in, status );
   nel = in->nel;
   type = in->type;

/* Do a byte-for-byte copy of the supplied MapEntry. */
   result = astStore( NULL, in, size );

/* Copy or nullify pointers in the AstMapEntry structure. */
   result->next = NULL;
   result->snext = NULL;
   result->sprev = NULL;
   text = in->key;
   result->key = text ? astStore( NULL, text, strlen( text ) + 1 ) : NULL;
   text = in->comment;
   result->comment = text ? astStore( NULL, text, strlen( text ) + 1 ) : NULL;

/* Nothing further to do for undefined values. */
   if( type == AST__UNDEFTYPE ) {

/* Next deal with string entries. */
   } else if( type == AST__STRINGTYPE ) {

/* Scalar valued entries... */
      if( nel == 0 ) {

/* Take a copy of the single string in the input entry. */
         text = ( (Entry0C *) in )->value;
         ( (Entry0C *) result )->value = text ? astStore( NULL, text,
                                                strlen( text ) + 1 ) : NULL;
/* Vector valued entries... */
      } else {

/* Allocate an array to store the string pointers. */
         slist = astMalloc( sizeof(char *)*(size_t)nel );
         ( (Entry1C *) result )->value = slist;

/* Copy the strings. */
         if( slist ) {
            for( i = 0; i < nel; i++ ) {
               text = ( (Entry1C *) in )->value[ i ];
               slist[ i ] = text ? astStore( NULL, text, strlen( text ) + 1 ) : NULL;
            }
         }
      }

/* Similarly deal with AST Object entries. */
   } else if( type == AST__OBJECTTYPE ) {
      if( nel == 0 ) {
         obj = ( (Entry0A *) in )->value;
         ( (Entry0A *) result )->value = obj ? astCopy( obj ) : NULL;
         ( (Entry0A *) result )->next = NULL;
         ( (Entry0A *) result )->prev = NULL;
      } else {
         alist = astMalloc( sizeof(AstObject *)*(size_t)nel );
         ( (Entry1A *) result )->value = alist;
         if( alist ) {
            for( i = 0; i < nel; i++ ) {
               obj = ( (Entry1A *) in )->value[ i ];
               alist[ i ] = obj ? astCopy( obj ) : NULL;
            }
            ( (Entry1A *) result )->next = NULL;
            ( (Entry1A *) result )->prev = NULL;
         }
      }

/* Now deal with integer entries. Scalar entries do not need any further
   action. If this is a vector entry copy the values array. */
   } else if( type == AST__INTTYPE ) {
      if( nel > 0 ) {
         ( (Entry1I *) result )->value = astStore( NULL,
                                                  ( (Entry1I *) in )->value,
                                                  sizeof( int )*(size_t)nel );
      }

/* Now deal with short int entries. Scalar entries do not need any further
   action. If this is a vector entry copy the values array. */
   } else if( type == AST__SINTTYPE ) {
      if( nel > 0 ) {
         ( (Entry1S *) result )->value = astStore( NULL,
                                            ( (Entry1S *) in )->value,
                                            sizeof( short int )*(size_t)nel );
      }

/* Now deal with byte entries. Scalar entries do not need any further
   action. If this is a vector entry copy the values array. */
   } else if( type == AST__BYTETYPE ) {
      if( nel > 0 ) {
         ( (Entry1B *) result )->value = astStore( NULL,
                                            ( (Entry1B *) in )->value,
                                            sizeof( unsigned char )*(size_t)nel );
      }

/* Similarly deal with floating point entries. */
   } else if( type == AST__DOUBLETYPE ) {
      if( nel > 0 ) {
         ( (Entry1D *) result )->value = astStore( NULL,
                                                  ( (Entry1D *) in )->value,
                                                  sizeof( double )*(size_t)nel );
      }

   } else if( type == AST__FLOATTYPE ) {
      if( nel > 0 ) {
         ( (Entry1F *) result )->value = astStore( NULL,
                                                  ( (Entry1F *) in )->value,
                                                  sizeof( float )*(size_t)nel );
      }

/* Similarly deal with void pointer entries. */
   } else if( type == AST__POINTERTYPE ) {
      if( nel > 0 ) {
         ( (Entry1P *) result )->value = astStore( NULL,
                                                  ( (Entry1P *) in )->value,
                                                  sizeof( void * )*(size_t)nel );
      }

/* Report an error if the data type is unknown. */
   } else {
      astError( AST__INTER, "CopyMapEntry(KeyMap): Illegal map entry data "
                "type %d encountered (internal AST programming error).", status,
                type );
   }

/* If an error has occurred, attempt to delete the returned MapEntry. */
   if( !astOK ) result = FreeMapEntry( result, status );

/* Return the result. */
   return result;
}

static void CopyTableEntry( AstKeyMap *in, AstKeyMap *out, int itab, int *status ){
/*
*  Name:
*     CopyTableEntry

*  Purpose:
*     Produces a deep copy of a hash table element.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void CopyTableEntry( AstKeyMap *in, AstKeyMap *out, int itab, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function creates a deep copy of the linked-list of KeyMap entries
*     stored in the specified element of the input KeyMaps hash table.

*  Parameters:
*     in
*        Pointer to the input KeyMap.
*     out
*        Pointer to the output KeyMap.
*     itab
*        Index of the hash table element to be copied.
*     status
*        Pointer to the inherited status variable.

*/

/* Local Variables: */
   AstMapEntry **link;    /* Address to store foward link */
   AstMapEntry *next;     /* Pointer to next Entry to copy */

/* Check the global error status. */
   if ( !astOK ) return;

/* The "link" variable holds the address of the location at which the
   pointer to the next copied MapEntry should be stored. Initialise this to
   be the address of the required element of the output hash table. */
   link = &( out->table[ itab ] );

/* The "next" variable holds the address of the next MapEntry to be
   copied. Initialise this to the MapEntry at the head of the linked list
   associated with the specified index of the input KeyMaps hash table. */
   next = in->table[ itab ];

/* If the hash table element is empty, store a null pointer and pass on. */
   if( !next ) {
      out->table[ itab ] = NULL;

/* Otherwise copy the liked list. */
   } else {

/* Loop round until we have copied all entries. */
      while( next && astOK ) {

/* Copy the next entry, storing the resulting pointer at the position
   indicated by "link". */
         *link = CopyMapEntry( next, status );

/* If the entry is of type AST__OBJECTTYPE, add it to the head of the
   list of AST__OBJECTTYPE entries in the output KeyMap. */
         AddToObjectList( out, *link, status );

/* Update "link" and "next" */
         next = next->next;
         link = &( (*link)->next );
      }
   }

/* Set the number of entries in the output to be the same as the input. */
   out->nentry[ itab ] = in->nentry[ itab ];

/* If an error has occurred, attempt to delete the returned MapEntry. */
   if( !astOK ) FreeTableEntry( out, itab, status );
}

static void DoubleTableSize( AstKeyMap *this, int *status ) {
/*
*  Name:
*     DoubleTableSize

*  Purpose:
*     Double the size of the hash table in a KeyMap

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void DoubleTableSize( AstKeyMap *this, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function creates a new hash table which has twice as many
*     elements as the current hash table, and moves all the entries out
*     of the old table into the new table (at their new positions).

*  Parameters:
*     this
*        The KeyMap pointer.
*     status
*        Pointer to the inherited status variable.

*/

/* Local Variables: */
   AstMapEntry **newtable;
   AstMapEntry *next;
   AstMapEntry *new_next;
   int *newnentry;
   int bitmask;
   int i;
   int newi;
   int newmapsize;

/* Check the global error status. */
   if( !astOK ) return;

/* Determine the new hash table size. Since mapsize starts out as a power
   of 2 (ensured by the NewTable function), the new mapsize will also be
   a power of 2. Also, create a bit mask that can be used to zero the
   upper bits in a full width hash value. */
   newmapsize = 2*this->mapsize;
   bitmask = newmapsize - 1;

/* Create the new arrays, leaving the old arrays intact for the moment. */
   newtable = astMalloc( newmapsize*sizeof( AstMapEntry * ) );
   newnentry = astMalloc( newmapsize*sizeof( int ) );
   if( astOK ) {

/* Initialise the new table. */
      for( i = 0; i < newmapsize; i++ ) {
         newtable[ i ] = NULL;
         newnentry[ i ] = 0;
      }

/* Loop round each of the existing table entries. */
      for( i = 0; i < this->mapsize; i++ ) {

/* The "next" variable holds the address of the next MapEntry to be
   moved. Initialise this to the MapEntry at the head of the linked list
   associated with the specified index of the input KeyMaps hash table. */
         next = this->table[ i ];

/* Loop round until we have moved all entries. */
         while( next && astOK ) {

/* Find the index within the new table at which to store this entry. */
            newi = ( next->hash & bitmask );

/* Save the pointer to the next entry following the current one in the
   linked list. */
            new_next = next->next;

/* Put a pointer to the MapEntry which is currently at the head of the
   linked list in the "next" component of the current MapEntry. */
            next->next = newtable[ newi ];

/* Store the supplied MapEntry pointer in the requested element of the
   hash table. */
            newtable[ newi ] = next;

/* Increment the length of linked list. */
            newnentry[ newi ]++;

/* Use the pointer to the next map entry to be moved. */
            next = new_next;
         }
      }
   }

/* If OK, delete the existing table and use the new table */
   if( astOK ) {
      this->mapsize = newmapsize;

      (void) astFree( this->table );
      this->table = newtable;

      (void) astFree( this->nentry );
      this->nentry = newnentry;

/* If not OK, delete the new table. */
   } else {
      newtable = astFree( newtable );
      newnentry = astFree( newnentry );
   }
}

static void DumpEntry( AstMapEntry *entry, AstChannel *channel, int nentry, int *status ) {
/*
*  Name:
*     DumpEntry

*  Purpose:
*     Dump a single AstMapEntry to a Channel.

*  Type:
*     Private function.

*  Synopsis:
*     void DumpEntry( AstMapEntry *entry, AstChannel *channel, int nentry )

*  Description:
*     This function dumps the supplied MapEntry to the supplied Channel.

*  Parameters:
*     entry
*        Pointer to the MapEntry whose data are being written.
*     channel
*        Pointer to the Channel to which the data are being written.
*     nentry
*        The integer index value to use when describing the MapEntry in
*        the dump.
*/

/* Local Variables: */
   char buff[20];                /* Buffer for item names */
   const char *com;              /* Pointer to comment string */
   int index;                    /* Index into vector valued entry */
   int nel;                      /* Number of elements in value */
   int type;                     /* Entry data type */

/* Check the global error status. */
   if ( !astOK ) return;

/* Dump the entry key. */
   (void) sprintf( buff, "Key%d", nentry );
   astWriteString( channel, buff, 1, 1, entry->key, "Item name" );

/* Dump the comment if not blank. */
   if( entry->comment && *(entry->comment) ) {
      (void) sprintf( buff, "Com%d", nentry );
      astWriteString( channel, buff, 1, 1, entry->comment, "Item comment" );
   }

/* Get the data type and the length of the Entry. */
   type = entry->type;
   nel = entry->nel;

/* Dump the entry data type. */
   if( type == AST__STRINGTYPE ) {
      com = "Item data type (string)";

   } else if( type == AST__OBJECTTYPE ) {
      com = "Item data type (AST Object)";

   } else if( type == AST__INTTYPE ) {
      com = "Item data type (int)";

   } else if( type == AST__SINTTYPE ) {
      com = "Item data type (short int)";

   } else if( type == AST__BYTETYPE ) {
      com = "Item data type (unsigned byte)";

   } else if( type == AST__DOUBLETYPE ) {
      com = "Item data type (double)";

   } else if( type == AST__FLOATTYPE ) {
      com = "Item data type (float)";

   } else if( type == AST__POINTERTYPE ) {
      com = "Item data type (pointer)";

   } else if( type == AST__UNDEFTYPE ) {
      com = "Item data type (undefined)";

   } else {
      com = "";
      astError( AST__INTER, "DumpEntry(KeyMap): Illegal map entry data "
                "type %d encountered (internal AST programming error).", status,
                type );
   }
   (void) sprintf( buff, "Typ%d", nentry );
   astWriteInt( channel, buff, 1, 1, entry->type, com );

/* Dump the vector length */
   if( entry->nel > 0 ) {
      (void) sprintf( buff, "Nel%d", nentry );
      astWriteInt( channel, buff, 1, 1, entry->nel, "Vector length" );
   }

/* First deal with integer entries. */
   if( type == AST__INTTYPE ) {
      if( entry->nel == 0 ) {
         (void) sprintf( buff, "Val%d", nentry );
         astWriteInt( channel, buff, 1, 1, ((Entry0I *)entry)->value, "Item value" );
      } else {
         com = "Item values";
         for( index = 0; index < nel; index++ ){
            (void) sprintf( buff, "V%d_%d", nentry, index + 1 );
            astWriteInt( channel, buff, 1, 1, ((Entry1I *)entry)->value[ index ], com );
            com = "";
         }
      }

/* Similarly, deal with short int entries. */
   } else if( type == AST__SINTTYPE ) {
      if( entry->nel == 0 ) {
         (void) sprintf( buff, "Val%d", nentry );
         astWriteInt( channel, buff, 1, 1, (int) ((Entry0S *)entry)->value, "Item value" );
      } else {
         com = "Item values";
         for( index = 0; index < nel; index++ ){
            (void) sprintf( buff, "V%d_%d", nentry, index + 1 );
            astWriteInt( channel, buff, 1, 1, (int) ((Entry1S *)entry)->value[ index ], com );
            com = "";
         }
      }

/* Similarly, deal with byte entries. */
   } else if( type == AST__BYTETYPE ) {
      if( entry->nel == 0 ) {
         (void) sprintf( buff, "Val%d", nentry );
         astWriteInt( channel, buff, 1, 1, (int) ((Entry0B *)entry)->value, "Item value" );
      } else {
         com = "Item values";
         for( index = 0; index < nel; index++ ){
            (void) sprintf( buff, "V%d_%d", nentry, index + 1 );
            astWriteInt( channel, buff, 1, 1, (int) ((Entry1B *)entry)->value[ index ], com );
            com = "";
         }
      }

/* Similarly deal with floating point entries. */
   } else if( type == AST__DOUBLETYPE ) {
      if( entry->nel == 0 ) {
         if( ((Entry0D *)entry)->value != AST__BAD ) {
            (void) sprintf( buff, "Val%d", nentry );
            astWriteDouble( channel, buff, 1, 1, ((Entry0D *)entry)->value, "Item value" );
         }
      } else {
         com = "Item values";
         for( index = 0; index < nel; index++ ){
            if( ((Entry1D *)entry)->value[ index ] != AST__BAD ) {
               (void) sprintf( buff, "V%d_%d", nentry, index + 1 );
               astWriteDouble( channel, buff, 1, 1, ((Entry1D *)entry)->value[ index ], com );
               com = "";
            }
         }
      }

/* Similarly deal with single precision floating point entries. */
   } else if( type == AST__FLOATTYPE ) {
      if( entry->nel == 0 ) {
         (void) sprintf( buff, "Val%d", nentry );
         astWriteDouble( channel, buff, 1, 1, (double) ((Entry0F *)entry)->value, "Item value" );
      } else {
         com = "Item values";
         for( index = 0; index < nel; index++ ){
            (void) sprintf( buff, "V%d_%d", nentry, index + 1 );
            astWriteDouble( channel, buff, 1, 1, (double) ((Entry1F *)entry)->value[ index ], com );
            com = "";
         }
      }

/* Do the same for string values. */
   } else if( type == AST__STRINGTYPE ) {
      if( entry->nel == 0 ) {
         (void) sprintf( buff, "Val%d", nentry );
         astWriteString( channel, buff, 1, 1, ((Entry0C *)entry)->value, "Item value" );
      } else {
         com = "Item values";
         for( index = 0; index < nel; index++ ){
            (void) sprintf( buff, "V%d_%d", nentry, index + 1 );
            astWriteString( channel, buff, 1, 1, ((Entry1C *)entry)->value[ index ], com );
            com = "";
         }
      }

/* Do the same for Object values. */
   } else if( type == AST__OBJECTTYPE ) {
      if( entry->nel == 0 ) {
         if( ((Entry0A *)entry)->value ) {
            (void) sprintf( buff, "Val%d", nentry );
            astWriteObject( channel, buff, 1, 1, ((Entry0A *)entry)->value, "Item value" );
         }
      } else {
         com = "Item values";
         for( index = 0; index < nel; index++ ){
            if( ((Entry1A *)entry)->value[ index ] ) {
               (void) sprintf( buff, "V%d_%d", nentry, index + 1 );
               astWriteObject( channel, buff, 1, 1, ((Entry1A *)entry)->value[ index ], com );
               com = "";
            }
         }
      }

/* Void pointer values cannot be dumped. */
   } else if( type == AST__POINTERTYPE ) {
      astError( AST__INTER, "DumpEntry(KeyMap): Cannot dump KeyMaps in "
                "which the values are arbitrary C pointers (possible "
                "programming error)." , status);

/* Nothing further to do for undefined values. */
   } else if( type == AST__UNDEFTYPE ) {

/* Report an error if the data type is unknown. */
   } else if( astOK ) {
      astError( AST__INTER, "DumpEntry(KeyMap): Illegal map entry data "
                "type %d encountered (internal AST programming error).", status,
                type );
   }
}

static AstMapEntry *FreeMapEntry( AstMapEntry *in, int *status ){
/*
*  Name:
*     FreeMapEntry

*  Purpose:
*     Frees the supplied KeyMap entry.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     AstMapEntry *FreeMapEntry( AstMapEntry *in, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function frees resources used by the supplied MapEntry, then
*     frees the MapEntry structure itself and returns a NULL pointer.

*  Parameters:
*     in
*        Pointer to the MapEntry to be freed. NULL may be supplied in
*        which the function returns without action.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     A NULL pointer.

*  Notes:
*     - It is the callers responsibility to ensure that any other MapEntry
*     which refers to the supplied MapEntry (e.g. through the "next" link
*     in the MapEntry structure) is modified to take account of the
*     freeing of the supplied MapEntry.
*     - This function attempts to execute even if it is invoked with the
*     global error status set.
*/

/* Local Variables: */
   AstObject **alist;     /* Pointer to list of AST object pointers */
   AstObject *obj;        /* Pointer to AST object */
   const char **slist;    /* Pointer to list of text pointers */
   int i;                 /* Loop count */
   int nel;               /* No. of values in entry vector (0 => scalar) */
   int type;              /* Entry data type */

/* Check the supplied pointer. */
   if( !in ) return NULL;

/* Get the data type and length of the MapEntry. */
   nel = in->nel;
   type = in->type;

/* First deal with string entries. */
   if( type == AST__STRINGTYPE ) {

/* For scalar valued entries, free the single string in the input entry. */
      if( nel == 0 ) {
         ( (Entry0C *) in )->value = (const char *) astFree( ( void *) ( (Entry0C *) in )->value );

/* For vector valued entries, free the strings, then free the array storing
   the string pointers. */
      } else {
         slist = ( (Entry1C *) in )->value;
         if( slist ) {
            for( i = 0; i < nel; i++ ) slist[ i ] = astFree( (void *) slist[ i ] );
            ( (Entry1C *) in )->value = astFree( (void *) slist );
         }
      }

/* Similarly deal with AST Object entries. */
   } else if( type == AST__OBJECTTYPE ) {
      if( nel == 0 ) {
         obj = ( (Entry0A *) in )->value;
         if( obj ) ( (Entry0A *) in )->value = astAnnul( obj );
         ( (Entry0A *) in )->next = NULL;
         ( (Entry0A *) in )->prev = NULL;
      } else {
         alist = ( (Entry1A *) in )->value;
         if( alist ) {
            for( i = 0; i < nel; i++ ) {
               if( alist[ i ] ) alist[ i ] = astAnnul( alist[ i ] );
            }
            ( (Entry1A *) in )->value = astFree( alist );
            ( (Entry1A *) in )->next = NULL;
            ( (Entry1A *) in )->prev = NULL;
         }
      }

/* Now deal with integer entries. Scalar entries do not need any further
   action. If this is a vector entry free the values array. */
   } else if( type == AST__INTTYPE ) {
      if( nel > 0 ) ( (Entry1I *) in )->value = astFree( ( (Entry1I *) in )->value );

/* Now deal with short int entries. Scalar entries do not need any further
   action. If this is a vector entry free the values array. */
   } else if( type == AST__SINTTYPE ) {
      if( nel > 0 ) ( (Entry1S *) in )->value = astFree( ( (Entry1S *) in )->value );

/* Now deal with byte entries. Scalar entries do not need any further
   action. If this is a vector entry free the values array. */
   } else if( type == AST__BYTETYPE ) {
      if( nel > 0 ) ( (Entry1B *) in )->value = astFree( ( (Entry1B *) in )->value );

/* Similarly deal with void * pointer entries. */
   } else if( type == AST__POINTERTYPE ) {
      if( nel > 0 ) ( (Entry1P *) in )->value = astFree( ( (Entry1P *) in )->value );

/* Similarly deal with floating point entries. */
   } else if( type == AST__DOUBLETYPE ) {
      if( nel > 0 ) ( (Entry1D *) in )->value = astFree( ( (Entry1D *) in )->value );

/* Similarly deal with single precision floating point entries. */
   } else if( type == AST__FLOATTYPE ) {
      if( nel > 0 ) ( (Entry1F *) in )->value = astFree( ( (Entry1F *) in )->value );

/* Nothing further to do for undefined values. */
   } else if( type == AST__UNDEFTYPE ) {

/* Report an error if the data type is unknown. */
   } else {
      astError( AST__INTER, "FreeMapEntry(KeyMap): Illegal map entry data "
                "type %d encountered (internal AST programming error).", status,
                type );
   }

/* Free or nullify pointers in the AstMapEntry structure. */
   in->next = NULL;
   in->snext = NULL;
   in->sprev = NULL;
   in->key = astFree( (void *) in->key );
   in->comment = astFree( (void *) in->comment );

/* Free the complete AstMapEntry structure. */
   astFree( in );

/* Return a NULL pointer. */
   return NULL;
}

static void FreeTableEntry( AstKeyMap *this, int itab, int *status ){
/*
*  Name:
*     FreeTableEntry

*  Purpose:
*     Frees the linked list of KeyMap entries stored in a given element of
*     the hash table.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void FreeTableEntry( AstKeyMap *this, int itab, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function frees resources used by all the MapEntries in the
*     linked list associated with the specified element of the hash table
*     of the supplied KeyMap.

*  Parameters:
*     this
*        Pointer to the KeyMap
*     itab
*        Index of the hash table element to free.
*     status
*        Pointer to the inherited status variable.

*  Notes:
*     - This function attempts to execute even if it is invoked with the
*     global error status set.
*/

/* Local Variables: */
   AstMapEntry *link;     /* Pointer the next but one MapEntry to be freed */
   AstMapEntry *next;     /* Pointer the next MapEntry to be freed */

/* Check it is safe to proceed. */
   if( this && itab >= 0 && itab < this->mapsize ) {

/* Store a pointer to the MapEntry which is to be freed next. */
      next = this->table[ itab ];

/* Loop round freeing all MapEntries in the linked list. */
      while( next ) {

/* Store a pointer to the MapEntry which will be freed after this one. */
         link = next->next;

/* Free this MapEntry */
         (void) FreeMapEntry( next, status );

/* Set up the next MapEntry to be freed. */
         next = link;
      }

/* Store a NULL pointer in the table element. */
      this->table[ itab ] = NULL;

/* Sets the number of entries in this hash table element to zero. */
      this->nentry[ itab ] = 0;
   }
}

static const char *GetAttrib( AstObject *this_object, const char *attrib, int *status ) {
/*
*  Name:
*     GetAttrib

*  Purpose:
*     Get the value of a specified attribute for a KeyMap.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     const char *GetAttrib( AstObject *this, const char *attrib, int *status )

*  Class Membership:
*     KeyMap member function (over-rides the protected astGetAttrib
*     method inherited from the Mapping class).

*  Description:
*     This function returns a pointer to the value of a specified
*     attribute for a KeyMap, formatted as a character string.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     attrib
*        Pointer to a null-terminated string containing the name of
*        the attribute whose value is required. This name should be in
*        lower case, with all white space removed.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     - Pointer to a null-terminated string containing the attribute
*     value.

*  Notes:
*     - The returned string pointer may point at memory allocated
*     within the KeyMap, or at static memory. The contents of the
*     string may be over-written or the pointer may become invalid
*     following a further invocation of the same function or any
*     modification of the KeyMap. A copy of the string should
*     therefore be made if necessary.
*     - A NULL pointer will be returned if this function is invoked
*     with the global error status set, or if it should fail for any
*     reason.
*/

/* Local Variables: */
   astDECLARE_GLOBALS            /* Declare the thread specific global data */
   AstKeyMap *this;              /* Pointer to the KeyMap structure */
   const char *result;           /* Pointer value to return */
   int ival;                     /* Attribute value */

/* Initialise. */
   result = NULL;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Get a pointer to the structure holding thread-specific global data. */
   astGET_GLOBALS(this_object);

/* Obtain a pointer to the KeyMap structure. */
   this = (AstKeyMap *) this_object;

/* Compare "attrib" with each recognised attribute name in turn,
   obtaining the value of the required attribute. If necessary, write
   the value into "getattrib_buff" as a null-terminated string in an appropriate
   format.  Set "result" to point at the result string. */

/* SizeGuess. */
/* ---------- */
   if ( !strcmp( attrib, "sizeguess" ) ) {
      ival = astGetSizeGuess( this );
      if ( astOK ) {
         (void) sprintf( getattrib_buff, "%d", ival );
         result = getattrib_buff;
      }

/* KeyCase. */
/* --------- */
   } else if ( !strcmp( attrib, "keycase" ) ) {
      ival = astGetKeyCase( this );
      if ( astOK ) {
         (void) sprintf( getattrib_buff, "%d", ival );
         result = getattrib_buff;
      }

/* KeyError. */
/* --------- */
   } else if ( !strcmp( attrib, "keyerror" ) ) {
      ival = astGetKeyError( this );
      if ( astOK ) {
         (void) sprintf( getattrib_buff, "%d", ival );
         result = getattrib_buff;
      }

/* MapLocked. */
/* --------- */
   } else if ( !strcmp( attrib, "maplocked" ) ) {
      ival = astGetMapLocked( this );
      if ( astOK ) {
         (void) sprintf( getattrib_buff, "%d", ival );
         result = getattrib_buff;
      }

/* SortBy. */
/* --------- */
   } else if ( !strcmp( attrib, "sortby" ) ) {
      ival = astGetSortBy( this );
      if ( astOK ) {
         result = SortByString( ival, "astGetAttrib", status );
      }

/* If the attribute name was not recognised, pass it on to the parent
   method for further interpretation. */
   } else {
      result = (*parent_getattrib)( this_object, attrib, status );
   }

/* Return the result. */
   return result;

}

static int GetObjSize( AstObject *this_object, int *status ) {
/*
*  Name:
*     GetObjSize

*  Purpose:
*     Return the in-memory size of an Object.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     int GetObjSize( AstObject *this, int *status )

*  Class Membership:
*     KeyMap member function (over-rides the astGetObjSize protected
*     method inherited from the parent class).

*  Description:
*     This function returns the in-memory size of the supplied KeyMap,
*     in bytes.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     The Object size, in bytes.

*  Notes:
*     - A value of zero will be returned if this function is invoked
*     with the global status set, or if it should fail for any reason.
*/

/* Local Variables: */
   AstKeyMap *this;       /* Pointer to KeyMap structure */
   AstMapEntry *next;     /* Pointer the next MapEntry */
   AstObject **alist;     /* Pointer to list of AST object pointers */
   AstObject *obj;        /* Pointer to AST object */
   const char **slist;    /* Pointer to list of text pointers */
   int i;                 /* Loop count */
   int itab;              /* Table entry index */
   int nel;               /* No. of values in entry vector (0 => scalar) */
   int result;            /* Result value to return */
   int type;              /* Entry data type */

/* Initialise. */
   result = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Obtain a pointers to the KeyMap structure. */
   this = (AstKeyMap *) this_object;

/* Invoke the GetObjSize method inherited from the parent class, and then
   add on any components of the class structure defined by thsi class
   which are stored in dynamically allocated memory. */
   result = (*parent_getobjsize)( this_object, status );

   for( itab = 0; itab < this->mapsize; itab++ ) {
      next = this->table[ itab ];
      while( next ) {
         nel = next->nel;
         type = next->type;

         if( type == AST__STRINGTYPE ) {

            if( nel == 0 ) {
               result += astTSizeOf( ( void *) ( (Entry0C *) next )->value );

            } else {
               slist = ( (Entry1C *) next )->value;
               if( slist ) {
                  for( i = 0; i < nel; i++ ) result += astTSizeOf( (void *) slist[ i ] );
                  result += astTSizeOf( (void *) slist );
               }
            }

         } else if( type == AST__OBJECTTYPE ) {
            if( nel == 0 ) {
               obj = ( (Entry0A *) next )->value;
               result += astGetObjSize( obj );
            } else {
               alist = ( (Entry1A *) next )->value;
               if( alist ) {
                  for( i = 0; i < nel; i++ ) {
                     result += astGetObjSize( alist[ i ] );
                  }
                  result += astTSizeOf( alist );
               }
            }

         } else if( type == AST__POINTERTYPE ) {
            if( nel > 0 ) result += astTSizeOf( ( (Entry1P *) next )->value );

         } else if( type == AST__INTTYPE ) {
            if( nel > 0 ) result += astTSizeOf( ( (Entry1I *) next )->value );

         } else if( type == AST__SINTTYPE ) {
            if( nel > 0 ) result += astTSizeOf( ( (Entry1S *) next )->value );

         } else if( type == AST__BYTETYPE ) {
            if( nel > 0 ) result += astTSizeOf( ( (Entry1B *) next )->value );

         } else if( type == AST__DOUBLETYPE ) {
            if( nel > 0 ) result += astTSizeOf( ( (Entry1D *) next )->value );

         } else if( type == AST__FLOATTYPE ) {
            if( nel > 0 ) result += astTSizeOf( ( (Entry1F *) next )->value );

         } else if( type == AST__UNDEFTYPE ) {

         } else {
            astError( AST__INTER, "astGetObjSize(KeyMap): Illegal map entry data "
                      "type %d encountered (internal AST programming error).", status,
                      type );
         }

         result += astTSizeOf( (void *) next->key );
         result += astTSizeOf( (void *) next->comment );
         result += astTSizeOf( next );

         next = next->next;
      }
   }

/* If an error occurred, clear the result value. */
   if ( !astOK ) result = 0;

/* Return the result, */
   return result;
}

static const char *GetKey( AstKeyMap *this, int index, int *status ) {
/*
*  Name:
*     GetKey

*  Purpose:
*     Get the key at a given index within the KeyMap.

*  Type:
*     Private member function.

*  Synopsis:
*     #include "keymap.h"
*     const char *GetKey( AstKeyMap *this, int index, int *status )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function returns a string holding the key for the entry with
*     the given index within the KeyMap. The index associated with a
*     given key is determined by the current setting of the SortBy attribute.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     index
*        The index into the KeyMap. The first entry has index zero, and the last
*        has index "size-1", where "size" is the value returned by the
*        astMapSize function. An error is reported if the supplied index is
*        out of bounds.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*        A pointer to a null-terminated string containing the key.

*  Notes:
*     - A NULL pointer will be returned if this function is invoked
*     with the AST error status set, or if it should fail for any
*     reason.
*/

/* Local Variables: */
   AstMapEntry *entry;         /* Pointer to the entry */
   const char *result;         /* Pointer value to return */
   int ifirst;                 /* Index of first entry in this table element */
   int ilast;                  /* Index of last entry in this table element */
   int istep;                  /* Entry count */
   int itab;                   /* Index into hash table */
   int nstep;                  /* No. of entries to skip */
   int sortby;                 /* The value of the SortBy attribute */

/* Initialise. */
   result = NULL;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Get the SortBy value. */
   sortby = astGetSortBy( this );

/* First deal with unsorted keys. */
   if( sortby == SORTBY_NONE ) {

/* Loop round each entry in the hash table. */
      ilast = -1;
      for( itab = 0; itab < this->mapsize; itab++ ) {

/* Find the index of the first and the last Entry in the linked list associated
   with this element of the hash table. */
         ifirst = ilast + 1;
         ilast += this->nentry[ itab ];

/* Pass on if we have not yet reached the element containing the required
   key. */
         if( ilast >= index ) {

/* Find how many steps we need to proceed down the linked list to reach
   the required index. */
            nstep = index - ifirst;

/* Make this many steps down the linked list.*/
            entry = this->table[ itab ];
            for( istep = 0; entry && istep < nstep; istep++ ) entry = entry->next;

/* Return a pointer to the key string, and break out of the loop. */
            if( entry ) result = entry->key;
            break;

         }
      }

/* Now deal with sorted keys. */
   } else {

/* Get a pointer to the first entry in the sorted list. */
      entry = this->first;

/* Move up the sorted list by the required number of entries. */
      for( istep = 0; entry && istep < index; istep++ ) entry = entry->snext;

/* Return a pointer to the key string. */
      if( entry ) result = entry->key;
   }

/* Report an error if the element was not found. */
   if( !result && astOK ) {
      astError( AST__MPIND, "astMapKey(%s): Cannot find element "
                "%d (zero-based) of the %s.", status, astGetClass( this ),
                index, astGetClass( this ) );
   }

/* Return the result.*/
   return result;
}

static int GetSizeGuess( AstKeyMap *this, int *status ) {
/*
*+
*  Name:
*     astGetSizeGuess

*  Purpose:
*     Get the value of the SizeGuess attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     int astGetSizeGuess( AstKeyMap *this )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function returns the value of the SizeGuess attribute for a
*     KeyMap.

*  Parameters:
*     this
*        Pointer to the KeyMap.

*  Returned Value:
*     The value of the SizeGuess attribute.

*  Notes:
*     - A value of zero is returned if this function is invoked with the
*     global error status set.

*-
*/

/* Local Variables: */
   int result;                /* Returned value */

/* Initialise */
   result = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Return the attribute value using a default if not set. */
   return ( this->sizeguess == INT_MAX ) ?
           MIN_TABLE_SIZE*MAX_ENTRIES_PER_TABLE_ENTRY : this->sizeguess;
}

static int HashFun( const char *key, int bitmask, unsigned long *hash, int *status ){
/*
*  Name:
*     HashFun

*  Purpose:
*     Returns an integer hash code for a string

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     int HashFun( const char *key, int bitmask, int *hash, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function returns an integer hash code for the supplied string,
*     This is the value that isused as the index into the hash table for
*     the specified key.

*  Parameters:
*     key
*        Pointer to the string. Trailing spaces are ignored.
*     bitmask
*        A bit mask that is used to zero the upper bits of a full width
*        hash value in order to produce the required array index. This
*        should be one less than the length of the hash table.
*     hash
*        Pointer to a location at which to put the full width hash value.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     An integer in the range zero to ( mapsize - 1 ).

*  Notes:
*     - A value of zero is returned if this function is invoked with the
*     global error status set.
*/

/* Local Variables: */
   int c;

/* Check the local error status. */
   if ( !astOK ) return 0;

/* djb2: This hash function was first reported by Dan Bernstein many years
   ago in comp.lang.c Each through the "hile" loop corresponds to
   "hash = hash*33 + c ". Ignore spaces so that trailing spaces used to
   pad F77 character variables will be ignored. */
   *hash = 5381;
   while( (c = *key++) ) {
      if( c != ' ' ) {
         *hash = ((*hash << 5) + *hash) + c;
      }
   }
   return ( *hash & bitmask );
}

void astInitKeyMapVtab_(  AstKeyMapVtab *vtab, const char *name, int *status ) {
/*
*+
*  Name:
*     astInitKeyMapVtab

*  Purpose:
*     Initialise a virtual function table for a KeyMap.

*  Type:
*     Protected function.

*  Synopsis:
*     #include "keymap.h"
*     void astInitKeyMapVtab( AstKeyMapVtab *vtab, const char *name )

*  Class Membership:
*     KeyMap vtab initialiser.

*  Description:
*     This function initialises the component of a virtual function
*     table which is used by the KeyMap class.

*  Parameters:
*     vtab
*        Pointer to the virtual function table. The components used by
*        all ancestral classes will be initialised if they have not already
*        been initialised.
*     name
*        Pointer to a constant null-terminated character string which contains
*        the name of the class to which the virtual function table belongs (it
*        is this pointer value that will subsequently be returned by the Object
*        astClass function).
*-
*/

/* Local Variables: */
   astDECLARE_GLOBALS            /* Pointer to thread-specific global data */
   AstObjectVtab *object;        /* Pointer to Object component of Vtab */

/* Check the local error status. */
   if ( !astOK ) return;

/* Get a pointer to the thread specific global data structure. */
   astGET_GLOBALS(NULL);

/* Initialize the component of the virtual function table used by the
   parent class. */
   astInitObjectVtab( (AstObjectVtab *) vtab, name );

/* Store a unique "magic" value in the virtual function table. This
   will be used (by astIsAKeyMap) to determine if an object belongs
   to this class.  We can conveniently use the address of the (static)
   class_check variable to generate this unique value. */
   vtab->id.check = &class_check;
   vtab->id.parent = &(((AstObjectVtab *) vtab)->id);

/* Initialise member function pointers. */
/* ------------------------------------ */
/* Store pointers to the member functions (implemented here) that provide
   virtual methods for this class. */

   vtab->MapGet0P = MapGet0P;
   vtab->MapGet0A = MapGet0A;
   vtab->MapGet0C = MapGet0C;
   vtab->MapGet0D = MapGet0D;
   vtab->MapGet0F = MapGet0F;
   vtab->MapGet0I = MapGet0I;
   vtab->MapGet0B = MapGet0B;
   vtab->MapGet0S = MapGet0S;
   vtab->MapGet1P = MapGet1P;
   vtab->MapGet1A = MapGet1A;
   vtab->MapGet1C = MapGet1C;
   vtab->MapGet1D = MapGet1D;
   vtab->MapGet1F = MapGet1F;
   vtab->MapGet1I = MapGet1I;
   vtab->MapGet1B = MapGet1B;
   vtab->MapGet1S = MapGet1S;
   vtab->MapGetElemP = MapGetElemP;
   vtab->MapGetElemA = MapGetElemA;
   vtab->MapGetElemC = MapGetElemC;
   vtab->MapGetElemD = MapGetElemD;
   vtab->MapGetElemF = MapGetElemF;
   vtab->MapGetElemI = MapGetElemI;
   vtab->MapGetElemS = MapGetElemS;
   vtab->MapGetElemB = MapGetElemB;
   vtab->MapPutElemP = MapPutElemP;
   vtab->MapPutElemA = MapPutElemA;
   vtab->MapPutElemC = MapPutElemC;
   vtab->MapPutElemD = MapPutElemD;
   vtab->MapPutElemF = MapPutElemF;
   vtab->MapPutElemI = MapPutElemI;
   vtab->MapPutElemS = MapPutElemS;
   vtab->MapPutElemB = MapPutElemB;
   vtab->MapPut0A = MapPut0A;
   vtab->MapPut0P = MapPut0P;
   vtab->MapPut0C = MapPut0C;
   vtab->MapPut0D = MapPut0D;
   vtab->MapPut0F = MapPut0F;
   vtab->MapPut0I = MapPut0I;
   vtab->MapPut0S = MapPut0S;
   vtab->MapPut0B = MapPut0B;
   vtab->MapPut1P = MapPut1P;
   vtab->MapPut1A = MapPut1A;
   vtab->MapPut1C = MapPut1C;
   vtab->MapPut1D = MapPut1D;
   vtab->MapPut1F = MapPut1F;
   vtab->MapPut1I = MapPut1I;
   vtab->MapPut1S = MapPut1S;
   vtab->MapPut1B = MapPut1B;
   vtab->MapPutU = MapPutU;
   vtab->MapRemove = MapRemove;
   vtab->MapRename = MapRename;
   vtab->MapCopy = MapCopy;
   vtab->MapSize = MapSize;
   vtab->MapLenC = MapLenC;
   vtab->MapLength = MapLength;
   vtab->MapType = MapType;
   vtab->MapHasKey = MapHasKey;
   vtab->MapKey = MapKey;
   vtab->MapIterate = MapIterate;

   vtab->ClearSizeGuess = ClearSizeGuess;
   vtab->SetSizeGuess = SetSizeGuess;
   vtab->GetSizeGuess = GetSizeGuess;
   vtab->TestSizeGuess = TestSizeGuess;

   vtab->ClearSortBy = ClearSortBy;
   vtab->SetSortBy = SetSortBy;
   vtab->GetSortBy = GetSortBy;
   vtab->TestSortBy = TestSortBy;

   vtab->ClearKeyError = ClearKeyError;
   vtab->SetKeyError = SetKeyError;
   vtab->GetKeyError = GetKeyError;
   vtab->TestKeyError = TestKeyError;

   vtab->ClearKeyCase = ClearKeyCase;
   vtab->SetKeyCase = SetKeyCase;
   vtab->GetKeyCase = GetKeyCase;
   vtab->TestKeyCase = TestKeyCase;

   vtab->ClearMapLocked = ClearMapLocked;
   vtab->SetMapLocked = SetMapLocked;
   vtab->GetMapLocked = GetMapLocked;
   vtab->TestMapLocked = TestMapLocked;

/* Save the inherited pointers to methods that will be extended, and
   replace them with pointers to the new member functions. */
   object = (AstObjectVtab *) vtab;

/* Store replacement pointers for methods which will be over-ridden by
   new member functions implemented here. */
   parent_getobjsize = object->GetObjSize;
   object->GetObjSize = GetObjSize;

   parent_clearattrib = object->ClearAttrib;
   object->ClearAttrib = ClearAttrib;
   parent_getattrib = object->GetAttrib;
   object->GetAttrib = GetAttrib;
   parent_setattrib = object->SetAttrib;
   object->SetAttrib = SetAttrib;
   parent_testattrib = object->TestAttrib;
   object->TestAttrib = TestAttrib;

#if defined(THREAD_SAFE)
   parent_managelock = object->ManageLock;
   object->ManageLock = ManageLock;
#endif

/* Declare the destructor, copy constructor and dump function. */
   astSetDelete( vtab, Delete );
   astSetCopy( vtab, Copy );
   astSetDump( vtab, Dump, "KeyMap", "Map of key/value pairs" );

/* If we have just initialised the vtab for the current class, indicate
   that the vtab is now initialised, and store a pointer to the class
   identifier in the base "object" level of the vtab. */
   if( vtab == &class_vtab ) {
      class_init = 1;
      astSetVtabClassIdentifier( vtab, &(vtab->id) );
   }
}

static void InitMapEntry( AstMapEntry *entry, int type, int nel, int *status ){
/*
*  Name:
*     InitMapEntry

*  Purpose:
*     initialise a MapEntry structure to null values.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void InitMapEntry( AstMapEntry *entry, int type, int nel, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function initialises the contents of a MapEntry to null values.

*  Parameters:
*     this
*        Pointer to the MapEntry.
*     type
*        The type of the MapEntry.
*     nel
*        The number of elements in the entry: 0 = scalar, >0 = vector.
*     status
*        Pointer to the inherited status variable.

*/

/* Check the global error status. */
   if( !astOK ) return;

/* Initialise all elements with in the MapEntry structure. */
   entry->next = NULL;
   entry->key = NULL;
   entry->hash = 0;
   entry->type = type;
   entry->nel = nel;
   entry->comment = NULL;
   entry->defined = 0;
   entry->snext = NULL;
   entry->sprev = NULL;
   entry->member = 0;
   entry->sortby = SORTBY_NONE;

   if( type == AST__OBJECTTYPE ) {
      if( nel == 0 ) {
         ( (Entry0A *) entry )->next = NULL;
         ( (Entry0A *) entry )->prev = NULL;
      } else {
         ( (Entry1A *) entry )->next = NULL;
         ( (Entry1A *) entry )->prev = NULL;
      }
   }

}

static int KeyCmp( const char *key1, const char *key2 ) {
/*
*  Name:
*     KeyCmp

*  Purpose:
*     Compares keys for equality.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     int KeyCmp( const char *key1, const char *key2 )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function compares two strings. It is like strcmp except that it
*     ignores trailing spaces.

*  Parameters:
*     key1
*        Pointer to first string.
*     key2
*        Pointer to second string.

*  Returned Value:
*     One if the keys differ. Zero if they are identical (except for
*     trailing spaces).

*/

/* Local Variables: */
   const char *k1;               /* Pointer to next "key1" character */
   const char *k2;               /* Pointer to next "key2" character */
   int result;                   /* Returned flag */

/* Check the strings are deifned. */
   if ( !key1 || !key2 ) return 0;

/* Get pointers to the first characters to differ, or to the first null
   character, which ever comes first. */
   k1 = key1;
   k2 = key2;
   while( *k1 && ( *k1 == *k2 ) ) {
      k1++;
      k2++;
   }

/* If both characters are null, the strings are identical. If neither is null,
   the string definitely differ. If one is null, we need to check if the
   other one only has spaces to the end of the string. */
   if( *k1 ) {
      if( *k2 ) {
         result = ( *k1 > *k2 ) ? 1 : -1;
      } else {
         while( *k1 == ' ' ) k1++;
         result = ( *k1 == 0 ) ? 0 : 1;
      }
   } else {
      if( *k2 ) {
         while( *k2 == ' ' ) k2++;
         result = ( *k2 == 0 ) ? 0 : -1;
      } else {
         result = 0;
      }
   }

/* Return the result. */
   return result;
}

#if defined(THREAD_SAFE)
static int ManageLock( AstObject *this_object, int mode, int extra,
                       AstObject **fail, int *status ) {
/*
*  Name:
*     ManageLock

*  Purpose:
*     Manage the thread lock on an Object.

*  Type:
*     Private function.

*  Synopsis:
*     #include "object.h"
*     AstObject *ManageLock( AstObject *this, int mode, int extra,
*                            AstObject **fail, int *status )

*  Class Membership:
*     KeyMap member function (over-rides the astManageLock protected
*     method inherited from the parent class).

*  Description:
*     This function manages the thread lock on the supplied Object. The
*     lock can be locked, unlocked or checked by this function as
*     deteremined by parameter "mode". See astLock for details of the way
*     these locks are used.

*  Parameters:
*     this
*        Pointer to the Object.
*     mode
*        An integer flag indicating what the function should do:
*
*        AST__LOCK: Lock the Object for exclusive use by the calling
*        thread. The "extra" value indicates what should be done if the
*        Object is already locked (wait or report an error - see astLock).
*
*        AST__UNLOCK: Unlock the Object for use by other threads.
*
*        AST__CHECKLOCK: Check that the object is locked for use by the
*        calling thread (report an error if not).
*     extra
*        Extra mode-specific information.
*     fail
*        If a non-zero function value is returned, a pointer to the
*        Object that caused the failure is returned at "*fail". This may
*        be "this" or it may be an Object contained within "this". Note,
*        the Object's reference count is not incremented, and so the
*        returned pointer should not be annulled. A NULL pointer is
*        returned if this function returns a value of zero.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*    A local status value:
*        0 - Success
*        1 - Could not lock or unlock the object because it was already
*            locked by another thread.
*        2 - Failed to lock a POSIX mutex
*        3 - Failed to unlock a POSIX mutex
*        4 - Bad "mode" value supplied.

*  Notes:
*     - This function attempts to execute even if an error has already
*     occurred.
*/

/* Local Variables: */
   AstKeyMap *this;       /* Pointer to KeyMap structure */
   AstMapEntry *next;     /* Pointer the next MapEntry */
   AstObject **alist;     /* Pointer to list of AST object pointers */
   AstObject *obj;        /* Pointer to AST object */
   int i;                 /* Loop count */
   int nel;               /* No. of values in entry vector (0 => scalar) */
   int result;            /* Returned status value */

/* Initialise */
   result = 0;

/* Check the supplied pointer is not NULL. */
   if( !this_object ) return result;

/* Obtain a pointers to the KeyMap structure. */
   this = (AstKeyMap *) this_object;

/* Invoke the ManageLock method inherited from the parent class. */
   if( !result ) result = (*parent_managelock)( this_object, mode, extra,
                                                fail, status );

/* Invoke the astManageLock method on any Objects contained within
   the supplied Object. */

   next = this->firstA;
   while( next ) {
      nel = next->nel;
      if( nel == 0 ) {
         obj = ( (Entry0A *) next )->value;
         if( !result ) result = astManageLock( obj, mode, extra, fail );
         next = ( (Entry0A *) next)->next;
      } else {
         alist = ( (Entry1A *) next )->value;
         if( alist ) {
            for( i = 0; i < nel; i++ ) {
               if( !result ) result = astManageLock( alist[ i ], mode,
                                                     extra, fail );
            }
         }
         next = ( (Entry1A *) next)->next;
      }
   }

   return result;

}
#endif

static void MapCopy( AstKeyMap *this, AstKeyMap *that, int *status ) {
/*
*++
*  Name:
c     astMapCopy
f     AST_MAPCOPY

*  Purpose:
*     Copy entries from one KeyMap into another.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "keymap.h"
c     void astMapCopy( AstKeyMap *this, AstKeyMap *that )
f     CALL AST_MAPCOPY( THIS, THAT, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
c     This function
f     This routine
*     copies all entries from one KeyMap into another.

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the destination KeyMap.
c     that
f     THAT = INTEGER (Given)
*        Pointer to the source KeyMap.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Notes:
*     - Entries from the source KeyMap will replace any existing entries in
*     the destination KeyMap that have the same key.
*     - The one exception to the above rule is that if a source entry
*     contains a scalar KeyMap entry, and the destination contains a
*     scalar KeyMap entry with the same key, then the source KeyMap entry
*     will be copied into the destination KeyMap entry using this function,
*     rather than simply replacing the destination KeyMap entry.
*     - If the destination entry has a non-zero value for its MapLocked
*     attribute, then an error will be reported if the source KeyMap
*     contains any keys that do not already exist within the destination
*     KeyMap.

*--
*/

/* Local Variables: */
   AstMapEntry *in_entry; /* Pointer to next source entry to copy */
   AstMapEntry *out_entry;/* Pointer to existing destination entry */
   AstObject *in_obj;     /* Pointer for source Object entry */
   AstObject *out_obj;    /* Pointer for destination Object entry */
   const char *key;       /* Key for current entry */
   int i;                 /* Index into source hash table */
   int itab;              /* Index of destination hash table element */
   int merged;            /* Were source and destination KeyMaps merged? */
   unsigned long hash;    /* Full width hash value */

/* Check the global error status. */
   if ( !astOK ) return;

/* Loop round all entries in the source hash table. */
   for( i = 0; i < that->mapsize; i++ ) {

/* Get a pointer to the next source KeyMap entry. */
      in_entry = that->table[ i ];

/* Loop round all entries in this element of the source hash table. */
      while( in_entry && astOK ) {

/* Get its key. */
         key = in_entry->key;

/* Search for a destination entry with the same key. */
         itab = HashFun( key, this->mapsize - 1, &hash, status );
         out_entry = SearchTableEntry( this, itab, key, status );

/* If the destination KeyMap does not contain an entry with the current
   key, store a copy of the entry in the destination, or report an error
   if the destination's MapLocked attribute is set. */
         if( !out_entry ) {
            if( astGetMapLocked( this ) ) {
               astError( AST__BADKEY, "astMapCopy(%s): Failed to copy "
                         "item \"%s\": \"%s\" is not a known item.", status,
                         astGetClass( this ), key, key );
            } else {
               out_entry = CopyMapEntry( in_entry, status );
               out_entry = AddTableEntry( this, itab, out_entry, status );
            }

/* If the destination KeyMap contains an entry with the current key... */
         } else {

/* The usual thing is to just replace the existing entry in the
   destination with a copy of the source entry. The one case where this is
   not done is if both entries are scalar KeyMaps. In this case the source
   KeyMap is merged into the destination KeyMap using this function. First
   see if we have this situation, and if so, copy the entries from the
   source KeyMap to the destination KeyMap. */
            merged = 0;
            if( in_entry->nel == 0 || in_entry->nel == 1 ) {
               if( out_entry->nel == 0 || out_entry->nel == 1 ) {
                  if( in_entry->type == AST__OBJECTTYPE &&
                      out_entry->type == AST__OBJECTTYPE ) {

                     if( in_entry->nel == 0 ) {
                        in_obj = ((Entry0A *)in_entry)->value;
                     } else {
                        in_obj = (((Entry1A *)in_entry)->value)[ 0 ];
                     }

                     if( out_entry->nel == 0 ) {
                        out_obj = ((Entry0A *)out_entry)->value;
                     } else {
                        out_obj = (((Entry1A *)out_entry)->value)[ 0 ];
                     }

                     if( astIsAKeyMap( in_obj ) &&
                         astIsAKeyMap( out_obj ) ) {
                        astMapCopy( (AstKeyMap *) out_obj,
                                    (AstKeyMap *) in_obj );
                        merged = 1;
                     }
                  }
               }
            }

/* If the source and desination entries are not KeyMaps, then just remove
   the entry in the desination KeyMap and add a copy of the source entry. */
            if( ! merged ) {
               (void) FreeMapEntry( RemoveTableEntry( this, itab, key, status ),
                                    status );
               out_entry = CopyMapEntry( in_entry, status );
               out_entry = AddTableEntry( this, itab, out_entry, status );
            }
         }

/* Update the address of the next MapEntry in the source. */
         in_entry = in_entry->next;
      }
   }
}

static const char *MapKey( AstKeyMap *this, int index, int *status ) {
/*
*++
*  Name:
c     astMapKey
f     AST_MAPKEY

*  Purpose:
*     Get the key at a given index within the KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "keymap.h"
c     const char *astMapKey( AstKeyMap *this, int index )
f     RESULT = AST_MAPKEY( THIS, INDEX, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function returns a string holding the key for the entry with
*     the given index within the KeyMap.
*
*     This function is intended primarily as a means of iterating round all
*     the elements in a KeyMap. For this purpose, the number of entries in
*     the KeyMap should first be found using
c     astMapSize
f     AST_MAPSIZE
*     and this function should then be called in a loop, with the index
*     value going from
c     zero to one less than the size of the KeyMap.
f     one to the size of the KeyMap.
*     The index associated with a given entry is determined by the SortBy
*     attribute.

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
c     index
f     INDEX = INTEGER (Given)
*        The index into the KeyMap. The first entry has index
c        zero, and the last has index "size-1", where "size" is the value
c        returned by the astMapSize function.
f        one, and the last has index SIZE, the value returned by the
f        AST_MAPSIZE function.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Returned Value:
c     astMapKey()
c        A pointer to a null-terminated string containing the key.
f     AST_MAPKEY = CHARACTER * ( AST__SZCHR )
f        The key value.

*  Notes:
c     - The returned pointer is guaranteed to remain valid and the
c     string to which it points will not be over-written for a total
c     of 50 successive invocations of this function. After this, the
c     memory containing the string may be re-used, so a copy of the
c     string should be made if it is needed for longer than this.
c     - A NULL pointer will be returned if this function is invoked
c     with the AST error status set, or if it should fail for any
c     reason.
f     - A blank string will be returned if this function is invoked
f     with STATUS set to an error value, or if it should fail for any
f     reason.
*--
*/

/* Local Variables: */
   astDECLARE_GLOBALS            /* Declare the thread specific global data */
   const char *result;           /* Pointer value to return */
   const char *value;            /* Pointer to key value */
   int i;                        /* Loop counter for initialisation */

/* Initialise. */
   result = NULL;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Get a pointer to the structure holding thread-specific global data. */
   astGET_GLOBALS(this);

/* If the "mapkey_strings" array has not been initialised, fill it with
   NULL pointers. */
   if ( !mapkey_init ) {
      mapkey_init = 1;
      for ( i = 0; i < AST__KEYMAP_MAPKEY_MAX_STRINGS; i++ ) mapkey_strings[ i ] = NULL;
   }

/* Obtain a pointer to the required key value. */
   value = GetKey( this, index, status );

/* If OK, store a copy of the resulting string in dynamically
   allocated memory, putting a pointer to the copy into the next
   element of the "mapkey_strings" array.  (This process also de-allocates
   any previously allocated memory pointed at by this "mapkey_strings"
   element, so the earlier string is effectively replaced by the new
   one.) */
   if ( astOK ) {
      astBeginPM;
      mapkey_strings[ mapkey_istr ] = astStore( mapkey_strings[ mapkey_istr ], value,
                                  strlen( value ) + (size_t) 1 );
      astEndPM;

/* If OK, return a pointer to the copy and increment "mapkey_istr" to use the
   next element of "mapkey_strings" on the next invocation. Recycle "mapkey_istr" to
   zero when all elements have been used. */
      if ( astOK ) {
         result = mapkey_strings[ mapkey_istr++ ];
         if ( mapkey_istr == ( AST__KEYMAP_MAPKEY_MAX_STRINGS - 1 ) ) mapkey_istr = 0;
      }
   }

/* Return the result. */
   return result;

}

/*
*++
*  Name:
c     astMapPut0<X>
f     AST_MAPPUT0<X>

*  Purpose:
*     Add a scalar value to a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "ast.h"
c     void astMapPut0<X>( AstKeyMap *this, const char *key, <X>type value,
c                         const char *comment );
f     CALL AST_MAPPUT0<X>( THIS, KEY, VALUE, COMMENT, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
c     This is a set of functions
f     This is a set of routine
*     for adding scalar values to a KeyMap. You should use a
c     function
f     routine
*     which matches the data type of the data you wish to add to the KeyMap
*     by replacing <X> in the generic
c     function name astMapPut0<X>
f     routine name AST_MAPPUT0<X>
*     by an appropriate 1-character type code (see the "Data Type Codes"
*     section below for the code appropriate to each supported data type).

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap in which to store the supplied value.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        A character string to be stored with the value, which can later
*        be used to identify the value. Trailing spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
c     value
f     VALUE = <X>type (Given)
*        The value to be stored. The data type of this value should match the
*        1-character type code appended to the
c        function name (e.g. if you are using astMapPut0A, the type of this
c        value should be "pointer to AstObject").
f        routine name (e.g. if you are using AST_MAPPUT0A, the type of this
f        value should be "integer pointer for an AstObject").
c     comment
f     COMMENT = CHARACTER * ( * ) (Given)
f        A comment string to be stored with the value.
c        A pointer to a null-terminated comment string to be stored with the
c        value. A NULL pointer may be supplied, in which case no comment is
c        stored.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Notes:
*     - If the supplied key is already in use in the KeyMap, the new value
*     will replace the old value.
*     - If the stored value is an AST Object pointer, the Object's reference
*     count is incremented by this call. Any subsequent changes made to
*     the Object using the returned pointer will be reflected in any
*     any other active pointers for the Object, including any obtained
*     later using
c     astMapget0A.
f     AST_MAPGET0A.
*     The reference count for the Object will be decremented when the
*     KeyMap is destroyed, or the entry is removed or over-written with a
*     different pointer.

*  Data Type Codes:
*     To select the appropriate
c     function, you should replace <X> in the generic function name astMapPut0<X>
f     routine, you should replace <X> in the generic routine name AST_MAPPUT0<X>
*     with a 1-character data type code, so as to match the data type <X>type
*     of the data you are processing, as follows:
c     - D: double
c     - F: float
c     - I: int
c     - C: "const" pointer to null terminated character string
c     - A: Pointer to AstObject
c     - P: Generic "void *" pointer
c     - S: short int
c     - B: unsigned byte (i.e. unsigned char)
f     - D: DOUBLE PRECISION
f     - R: REAL
f     - I: INTEGER
f     - C: CHARACTER
f     - A: INTEGER used to identify an AstObject
f     - S: INTEGER*2 (short integer)
f     - B: Unsigned byte
*
c     For example, astMapPut0D would be used to store a "double" value,
c     while astMapPut0I would be used to store an "int", etc.
f     For example, AST_MAPPUT0D would be used to store a DOUBLE PRECISION value,
f     while AST_MAPPUT0I would be used to store an INTEGER, etc.
c
c     Note that KeyMaps containing generic "void *" pointers cannot be
c     written out using astShow or astWrite. An error will be reported if
c     this is attempted.
*--
*/
/* Define a macro to implement the function for a specific data type. */
#define MAKE_MAPPUT0(X,Xtype,Itype,ValExp) \
static void MapPut0##X( AstKeyMap *this, const char *skey, Xtype value, \
                        const char *comment, int *status ) { \
\
/* Local Variables: */ \
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */ \
   AstMapEntry *oldent;    /* Pointer to existing MapEntry */ \
   Entry0##X *entry;       /* Structure holding the data for the new Entry */ \
   const char *key;        /* Pointer to key string to use */ \
   char *p;                /* Pointer to next key character */ \
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */ \
   int itab;               /* Index of hash table element to use */ \
   int keylen;             /* Length of supplied key string */ \
   int there;              /* Did the entry already exist in the KeyMap? */ \
\
/* Check the global error status. */ \
   if ( !astOK ) return; \
\
/* Perform any necessary checks on the supplied value to be stored. */ \
   CHECK_##X \
\
/* Convert the supplied key to upper case if required. */ \
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapPut0" #X, \
                     status ); \
\
/* Allocate memory for the new MapEntry. */ \
   entry = astMalloc( sizeof( Entry0##X ) ); \
   if( astOK ) { \
\
/* Initialise the new structure.*/ \
      mapentry = (AstMapEntry *) entry; \
      InitMapEntry( mapentry, Itype, 0, status ); \
\
/* Now store the new values. */ \
      keylen = strlen( key ); \
      mapentry->key = astStore( NULL, key, keylen + 1 ); \
      if( comment ) mapentry->comment = astStore( NULL, comment, strlen( comment ) + 1 ); \
      mapentry->defined = 1; \
      entry->value = ValExp; \
\
/* Terminate the key string to exclude any trailing spaces. */ \
      if( astOK ) { \
         p = (char *) mapentry->key + keylen; \
         while( --p >= mapentry->key ) { \
            if( *p == ' ' ) { \
               *p = 0; \
            } else { \
               break; \
            } \
         } \
      } \
\
/* Use the hash function to determine the element of the hash table in \
   which to store the new entry. */ \
      itab = HashFun( mapentry->key, this->mapsize - 1, &(mapentry->hash), status ); \
\
/* Remove any existing entry with the given key from the table element. */ \
      oldent = RemoveTableEntry( this, itab, mapentry->key, status ); \
      if( oldent ) { \
         oldent = FreeMapEntry( oldent, status ); \
         there = 1; \
      } else { \
         there = 0; \
      } \
\
/* If the KeyMap is locked we report an error if an attempt is made to add a value for \
   a new key. */ \
      if( !there && astGetMapLocked( this ) ) { \
         astError( AST__BADKEY, "astMapPut0" #X "(%s): Failed to add item \"%s\" to a KeyMap: " \
                   "\"%s\" is not a known item.", status, astGetClass( this ), key, key ); \
      } \
\
/* If all has gone OK, store the new entry at the head of the linked list \
   associated with the selected table entry. */ \
      if( astOK ) { \
         mapentry = AddTableEntry( this, itab, mapentry, status ); \
\
/* If anything went wrong, try to delete the new entry. */ \
      } else { \
         mapentry = FreeMapEntry( mapentry, status ); \
      } \
   } \
}

/* Define macros which perform any necessary checks on the supplied value
   to be stored. For Object entries, check that we are not adding a KeyMap
   which already contains "this". This avoids circular dependencies.
   Other types do not need any checks. */
#define CHECK_A CheckCircle( this, value, "astMapPut0A", status );
#define CHECK_I
#define CHECK_D
#define CHECK_F
#define CHECK_C
#define CHECK_P
#define CHECK_S
#define CHECK_B

/* Expand the above macro to generate a function for each required
   data type. */
MAKE_MAPPUT0(I,int,AST__INTTYPE,value)
MAKE_MAPPUT0(D,double,AST__DOUBLETYPE,value)
MAKE_MAPPUT0(F,float,AST__FLOATTYPE,value)
MAKE_MAPPUT0(C,const char *,AST__STRINGTYPE,astStore(NULL,value,strlen(value)+1))
MAKE_MAPPUT0(A,AstObject *,AST__OBJECTTYPE,(value?astClone(value):NULL))
MAKE_MAPPUT0(P,void *,AST__POINTERTYPE,value)
MAKE_MAPPUT0(S,short int,AST__SINTTYPE,value)
MAKE_MAPPUT0(B,unsigned char,AST__BYTETYPE,value)

/* Undefine the macro. */
#undef MAKE_MAPPUT0
#undef CHECK_A
#undef CHECK_I
#undef CHECK_S
#undef CHECK_D
#undef CHECK_F
#undef CHECK_C
#undef CHECK_P
#undef CHECK_B

/*
*++
*  Name:
c     astMapPut1<X>
f     AST_MAPPUT1<X>

*  Purpose:
*     Add a vector value to a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "ast.h"
c     void astMapPut1<X>( AstKeyMap *this, const char *key, int size,
c                         const <X>type value[], const char *comment );
f     CALL AST_MAPPUT1<X>( THIS, KEY, SIZE, VALUE, COMMENT, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
c     This is a set of functions
f     This is a set of routine
*     for adding vector values to a KeyMap. You should use a
c     function
f     routine
*     which matches the data type of the data you wish to add to the KeyMap
*     by replacing <X> in the generic
c     function name astMapPut1<X>
f     routine name AST_MAPPUT1<X>
*     by an appropriate 1-character type code (see the "Data Type Codes"
*     section below for the code appropriate to each supported data type).

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap in which to store the supplied values.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        A character string to be stored with the values, which can later
*        be used to identify the values. Trailing spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
c     size
f     SIZE = INTEGER (Given)
*        The number of elements in the supplied array of values.
c     value
f     VALUE( * ) = <X>type (Given)
*        The array of values to be stored. The data type of this value should
*        match the 1-character type code appended to the
c        function name (e.g. if you are using astMapPut1A, the type of this
c        value should be "array of pointers to AstObject").
f        routine name (e.g. if you are using AST_MAPPUT1A, the type of this
f        value should be "integer pointer for an AstObject)".
c     comment
f     COMMENT = CHARACTER * ( * ) (Given)
f        A comment string to be stored with the values.
c        A pointer to a null-terminated comment string to be stored with the
c        values. A NULL pointer may be supplied, in which case no comment is
c        stored.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Notes:
*     - If the supplied key is already in use in the KeyMap, the new values
*     will replace the old values.

*  Data Type Codes:
*     To select the appropriate
c     function, you should replace <X> in the generic function name astMapPut1<X>
f     routine, you should replace <X> in the generic routine name AST_MAPPUT1<X>
*     with a 1-character data type code, so as to match the data type <X>type
*     of the data you are processing, as follows:
c     - D: double
c     - F: float
c     - I: int
c     - C: "const" pointer to null terminated character string
c     - A: Pointer to AstObject
c     - P: Generic "void *" pointer
c     - S: short int
c     - B: Unsigned byte (i.e. char)
f     - D: DOUBLE PRECISION
f     - R: REAL
f     - I: INTEGER
f     - C: CHARACTER
f     - A: INTEGER used to identify an AstObject
f     - S: INTEGER*2 (short integer)
f     - B: Unsigned byte
*
c     For example, astMapPut1D would be used to store "double" values,
c     while astMapPut1I would be used to store "int", etc.
f     For example, AST_MAPPUT1D would be used to store DOUBLE PRECISION values,
f     while AST_MAPPUT1I would be used to store INTEGER, etc.
c
c     Note that KeyMaps containing generic "void *" pointers cannot be
c     written out using astShow or astWrite. An error will be reported if
c     this is attempted.
*--
*/
/* Define a macro to implement the function for a specific data type. */
#define MAKE_MAPPUT1(X,Xtype,Itype,ValExp) \
static void MapPut1##X( AstKeyMap *this, const char *skey, int size, \
                        Xtype value[], const char *comment, \
                        int *status ) { \
\
/* Local Variables: */ \
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */ \
   AstMapEntry *oldent;    /* Pointer to existing MapEntry */ \
   Entry1##X *entry;       /* Structure holding the data for the new Entry */ \
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */ \
   const char *key;        /* Pointer to key string to use */ \
   char *p;                /* Pointer to next key character */ \
   int itab;               /* Index of hash table element to use */ \
   int i;                  /* Loop count */ \
   int keylen;             /* Length of supplied key string */ \
   int there;              /* Did the entry already exist in the KeyMap? */ \
\
/* Check the global error status. */ \
   if ( !astOK ) return; \
\
/* Perform any necessary checks on the supplied value to be stored. */ \
   CHECK_##X \
\
/* Convert the supplied key to upper case if required. */ \
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapPut1" #X, \
                     status ); \
\
/* Allocate memory for the new MapEntry. */ \
   entry = astMalloc( sizeof( Entry1##X ) ); \
   if( astOK ) { \
\
/* Initialise the new structure.*/ \
      mapentry = (AstMapEntry *) entry; \
      InitMapEntry( mapentry, Itype, size, status ); \
\
/* Now store the new values. */ \
      keylen = strlen( key ); \
      mapentry->key = astStore( NULL, key, keylen + 1 ); \
      if( comment ) mapentry->comment = astStore( NULL, comment, strlen( comment ) + 1 ); \
      mapentry->defined = 1; \
      entry->value = astMalloc( sizeof( Xtype )*(size_t)size ); \
\
      if( astOK ) { \
         for( i = 0; i < size; i++ ) { \
            entry->value[ i ] = ValExp; \
         } \
\
/* Terminate the key string to exclude any trailing spaces. */ \
         p = (char *) mapentry->key + keylen; \
         while( --p >= mapentry->key ) { \
            if( *p == ' ' ) { \
               *p = 0; \
            } else { \
               break; \
            } \
         } \
      } \
\
/* Use the hash function to determine the element of the hash table in \
   which to store the new entry. */ \
      itab = HashFun( mapentry->key, this->mapsize - 1, &(mapentry->hash), status ); \
\
/* Remove any existing entry with the given key from the table element. */ \
      oldent = RemoveTableEntry( this, itab, mapentry->key, status ); \
      if( oldent ) { \
         oldent = FreeMapEntry( oldent, status ); \
         there = 1; \
      } else { \
         there = 0; \
      } \
\
/* If the KeyMap is locked we report an error if an attempt is made to add a value for \
   a new key. */ \
      if( !there && astGetMapLocked( this ) ) { \
         astError( AST__BADKEY, "astMapPut1" #X "(%s): Failed to add item \"%s\" to a KeyMap: " \
                   "\"%s\" is not a known item.", status, astGetClass( this ), key, key ); \
      } \
\
/* If all has gone OK, store the new entry at the head of the linked list \
   associated with the selected table entry. */ \
      if( astOK ) { \
         mapentry = AddTableEntry( this, itab, mapentry, status ); \
\
/* If anything went wrong, try to delete the new entry. */ \
      } else { \
         mapentry = FreeMapEntry( mapentry, status ); \
      } \
   } \
}

/* Define macros which perform any necessary checks on the supplied values
   to be stored. For Object entries, check that we are not adding a KeyMap
   which already contains "this". This avoids circular dependencies.
   Other types do not need any checks. */
#define CHECK_A \
for( i = 0; i < size; i++ ) { \
   CheckCircle( this, value[ i ], "astMapPut1A", status ); \
}
#define CHECK_I
#define CHECK_S
#define CHECK_B
#define CHECK_D
#define CHECK_F
#define CHECK_C
#define CHECK_P

/* Expand the above macro to generate a function for each required
   data type. */
MAKE_MAPPUT1(D,const double,AST__DOUBLETYPE,value[i])
MAKE_MAPPUT1(F,const float,AST__FLOATTYPE,value[i])
MAKE_MAPPUT1(I,const int,AST__INTTYPE,value[i])
MAKE_MAPPUT1(C,const char *const,AST__STRINGTYPE,astStore(NULL,value[i],strlen(value[i])+1))
MAKE_MAPPUT1(A,AstObject *const,AST__OBJECTTYPE,(value[i]?astClone(value[i]):NULL))
MAKE_MAPPUT1(P,void *const,AST__POINTERTYPE,value[i])
MAKE_MAPPUT1(S,const short int,AST__SINTTYPE,value[i])
MAKE_MAPPUT1(B,const unsigned char,AST__BYTETYPE,value[i])

/* Undefine the macro. */
#undef MAKE_MAPPUT1
#undef CHECK_A
#undef CHECK_I
#undef CHECK_B
#undef CHECK_S
#undef CHECK_D
#undef CHECK_F
#undef CHECK_C
#undef CHECK_P

void astMapPut1AId_( AstKeyMap *this, const char *skey, int size,
                     AstObject *const value[], const char *comment,
                     int *status ) {
/*
*  Name:
*     astMapPut1AId_

*  Purpose:
*     Add a vector of AstObject pointers to a KeyMap.

*  Type:
*     Private function.

*  Synopsis:
*     #include "ast.h"
*     void astMapPut1A( AstKeyMap *this, const char *key, int size,
*                       AstObject *const value[], const char *comment )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This is the public implementation of the astMapPut1A function
*     It is identical to astMapPut1A_ except that ID values are supplied
*     via the "value" parameter instead of a true C pointers.

*  Parameters:
*     (see astMapPut1<X>)

*/

/* Local Variables: */
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */
   AstMapEntry *oldent;    /* Pointer to existing MapEntry */
   AstObject *op;          /* Object pointer */
   Entry1A *entry;         /* Structure holding the data for the new Entry */
   char *p;                /* Pointer to next key character */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */ \
   const char *key;        /* Pointer to key string to use */ \
   int i;                  /* Loop count */
   int itab;               /* Index of hash table element to use */
   int keylen;             /* Length of supplied key string */
   int there;              /* Did the entry already exist in the KeyMap? */

/* Check the global error status. */
   if ( !astOK ) return;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapPut1A",
                     status );

/* Allocate memory for the new MapEntry. */
   entry = astMalloc( sizeof( Entry1A ) );
   if( astOK ) {

/* Initialise the new structure.*/
      mapentry = (AstMapEntry *) entry;
      InitMapEntry( mapentry, AST__OBJECTTYPE, size, status );

/* Now store the new values. */
      keylen = strlen( key );
      mapentry->key = astStore( NULL, key, keylen + 1 );
      if( comment ) mapentry->comment = astStore( NULL, comment, strlen( comment ) + 1 );
      mapentry->defined = 1;
      entry->value = astMalloc( sizeof( AstObject * )*(size_t)size );

      if( astOK ) {
         for( i = 0; i < size; i++ ) {
            op = value[ i ] ? astMakePointer( value[ i ] ) : NULL;
            entry->value[ i ] = op ? astClone( op ) : NULL;
         }

/* Terminate the key string to exclude any trailing spaces. */ \
         p = (char *) mapentry->key + keylen;
         while( --p >= mapentry->key ) {
            if( *p == ' ' ) {
               *p = 0;
            } else {
               break;
            }
         }
      }

/* Use the hash function to determine the element of the hash table in
   which to store the new entry. */
      itab = HashFun( mapentry->key, this->mapsize - 1, &(mapentry->hash), status );

/* Remove any existing entry with the given key from the table element. */
      oldent = RemoveTableEntry( this, itab, mapentry->key, status );
      if( oldent ) {
         oldent = FreeMapEntry( oldent, status );
         there = 1;
      } else {
         there = 0;
      }

/* If the KeyMap is locked we report an error if an attempt is made to add a value for
   a new key. */
      if( !there && astGetMapLocked( this ) ) {
         astError( AST__BADKEY, "astMapPut1A(%s): Failed to add item \"%s\" to a KeyMap: "
                   "\"%s\" is not a known item.", status, astGetClass( this ), key, key );
      }

/* If all has gone OK, store the new entry at the head of the linked list
   associated with the selected table entry. */
      if( astOK ) {
         mapentry = AddTableEntry( this, itab, mapentry, status );

/* If anything went wrong, try to delete the new entry. */
      } else {
         mapentry = FreeMapEntry( mapentry, status );
      }
   }
}

static void MapPutU( AstKeyMap *this, const char *skey, const char *comment,
                     int *status ) {
/*
*++
*  Name:
c     astMapPutU
f     AST_MAPPUTU

*  Purpose:
*     Add an entry to a KeyMap with an undefined value.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "ast.h"
c     void astMapPutU( AstKeyMap *this, const char *key, const char *comment );
f     CALL AST_MAPPUTU( THIS, KEY, COMMENT, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
c     This function
f     This routine
*     adds a new entry to a KeyMap, but no value is stored with the
*     entry. The entry therefore has a special data type represented by
*     symbolic constant AST__UNDEFTYPE.
*
*     An example use is to add entries with undefined values to a KeyMap
*     prior to locking them with the MapLocked attribute. Such entries
*     can act as placeholders for values that can be added to the KeyMap
*     later.

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap in which to store the supplied value.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        A character string to be stored with the value, which can later
*        be used to identify the value. Trailing spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
c     comment
f     COMMENT = CHARACTER * ( * ) (Given)
f        A comment string to be stored with the value.
c        A pointer to a null-terminated comment string to be stored with the
c        value. A NULL pointer may be supplied, in which case no comment is
c        stored.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Notes:
*     - If the supplied key is already in use in the KeyMap, the value
*     associated with the key will be removed.

*--
*/

/* Local Variables: */
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */
   AstMapEntry *oldent;    /* Pointer to existing MapEntry */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */
   const char *key;        /* Pointer to key string to use */
   char *p;                /* Pointer to next key character */
   int itab;               /* Index of hash table element to use */
   int keylen;             /* Length of supplied key string */
   int there;              /* Did the entry already exist in the KeyMap? */

/* Check the global error status. */
   if ( !astOK ) return;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapPutU",
                     status );

/* Allocate memory for the new MapEntry. */
   mapentry = astMalloc( sizeof( AstMapEntry ) );
   if( astOK ) {

/* Initialise the new structure.*/
      InitMapEntry( mapentry, AST__UNDEFTYPE, 0, status );

/* Now store the new values. */
      keylen = strlen( key );
      mapentry->key = astStore( NULL, key, keylen + 1 );
      if( comment ) mapentry->comment = astStore( NULL, comment, strlen( comment ) + 1 );
      mapentry->defined = 0;

/* Terminate the key string to exclude any trailing spaces. */
      if( astOK ) {
         p = (char *) mapentry->key + keylen;
         while( --p >= mapentry->key ) {
            if( *p == ' ' ) {
               *p = 0;
            } else {
               break;
            }
         }
      }

/* Use the hash function to determine the element of the hash table in
   which to store the new entry. */
      itab = HashFun( mapentry->key, this->mapsize - 1, &(mapentry->hash), status );

/* Remove any existing entry with the given key from the table element. */
      oldent = RemoveTableEntry( this, itab, mapentry->key, status );
      if( oldent ) {
         oldent = FreeMapEntry( oldent, status );
         there = 1;
      } else {
         there = 0;
      }

/* If the KeyMap is locked we report an error if an attempt is made to add a value for
   a new key. */
      if( !there && astGetMapLocked( this ) ) {
         astError( AST__BADKEY, "astMapPutU(%s): Failed to add item \"%s\" to a KeyMap: "
                   "\"%s\" is not a known item.", status, astGetClass( this ), key, key );
      }

/* If all has gone OK, store the new entry at the head of the linked list
   associated with the selected table entry. */
      if( astOK ) {
         mapentry = AddTableEntry( this, itab, mapentry, status );

/* If anything went wrong, try to delete the new entry. */
      } else {
         mapentry = FreeMapEntry( mapentry, status );
      }
   }
}

/*
*++
*  Name:
c     astMapGet0<X>
f     AST_MAPGET0<X>

*  Purpose:
*     Get a scalar value from a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "ast.h"
c     int astMapGet0<X>( AstKeyMap *this, const char *key, <X>type *value );
f     RESULT = AST_MAPGET0<X>( THIS, KEY, VALUE, STATUS )

f     RESULT = AST_MAPGET0C( THIS, KEY, VALUE, L, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This is a set of functions for retrieving a scalar value from a KeyMap.
*     You should replace <X> in the generic function name
c     astMapGet0<X>
f     AST_MAPGET0<X>
*     by an appropriate 1-character type code (see the "Data Type Codes"
*     section below for the code appropriate to each supported data type).
*     The stored value is converted to the data type indiced by <X>
*     before being returned (an error is reported if it is not possible to
*     convert the stored value to the requested data type).
f     Note, the version of this function which returns character strings,
f     AST_MAPGET0C, has an extra parameter in which is returned the number
f     of characters written into the supplied CHARACTER variable.

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        The character string identifying the value to be retrieved. Trailing
*        spaces are ignored. The supplied string is converted to upper
*        case before use if the KeyCase attribute is currently set to zero.
c     value
f     VALUE = <X>type (Returned)
c        A pointer to a buffer in which to return the requested value.
f        The requested value.
*        If the requested key is not found, or if it is found but has an
*        undefined value (see
c        astMapPutU),
f        AST_MAPPUTU),
*        then the contents of the
*        buffer on entry to this function will be unchanged on exit.
c        For pointer types ("A" and "C"), the buffer should be a suitable
c        pointer, and the address of this pointer should be supplied as the
c        "value" parameter.
f     L = INTEGER (Returned)
f        This parameter is only present in the interface for the AST_MAPGET0C
f        function. It is returned holding the number of characters
f        written into the CHARACTER variable supplied for parameter VALUE.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Returned Value:
c     astMapGet0<X>()
f     AST_MAPGET0<X> = LOGICAL
c        A non-zero value
f        .TRUE.
*        is returned if the requested key name was found, and does not have
*        an undefined value (see
c        astMapPutU). Zero
f        AST_MAPPUTU). .FALSE.
*        is returned otherwise.

*  Notes:
*     - No error is reported if the requested key cannot be found in the
*     given KeyMap, but a
c     zero
f     .FALSE.
*     value will be returned as the function value. The supplied buffer
*     will be returned unchanged.
*     - If the stored value is a vector value, then the first value in
*     the vector will be returned.
c     - A string pointer returned by astMapGet0C is guaranteed to remain valid
c     and the string to which it points will not be over-written for a
c     total of 50 successive invocations of this function. After this,
c     the memory containing the string may be re-used, so a copy of
c     the string should be made if it is needed for longer than this.
*     - If the returned value is an AST Object pointer, the Object's reference
*     count is incremented by this call. Any subsequent changes made to
*     the Object using the returned pointer will be reflected in any
*     any other active pointers for the Object. The returned pointer
*     should be annulled using
c     astAnnul
f     AST_ANNUL
*     when it is no longer needed.

*  Data Type Codes:
*     To select the appropriate
c     function, you should replace <X> in the generic function name astMapGet0<X>
f     routine, you should replace <X> in the generic routine name AST_MAPGET0<X>
*     with a 1-character data type code, so as to match the data type <X>type
*     of the data you are processing, as follows:
c     - F: float
c     - D: double
c     - I: int
c     - C: "const" pointer to null terminated character string
c     - A: Pointer to AstObject
c     - P: Generic "void *" pointer
c     - S: short int
c     - B: Unsigned byte (i.e. word)
f     - D: DOUBLE PRECISION
f     - R: REAL
f     - I: INTEGER
f     - C: CHARACTER
f     - A: INTEGER used to identify an AstObject
f     - S: INTEGER*2 (short integer)
f     - B: Unsigned byte
*
c     For example, astMapGet0D would be used to get a "double" value,
c     while astMapGet0I would be used to get an "int", etc.
f     For example, AST_MAPGET0D would be used to get a DOUBLE PRECISION value,
f     while AST_MAPGET0I would be used to get an INTEGER, etc.
*--
*/
/* Define a macro to implement the function for a specific data type. */
#define MAKE_MAPGET0(X,Xtype,Itype) \
static int MapGet0##X( AstKeyMap *this, const char *skey, Xtype *value, int *status ) { \
\
/* Local Variables: */ \
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */ \
   const char *key;        /* Pointer to key string to use */ \
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */ \
   int itab;               /* Index of hash table element to use */ \
   int raw_type;           /* Data type of stored value */ \
   int result;             /* Returned flag */ \
   unsigned long hash;     /* Full width hash value */ \
   void *raw;              /* Pointer to stored value */ \
\
/* Initialise */ \
   result = 0; \
\
/* Check the global error status. */ \
   if ( !astOK ) return result; \
\
/* Convert the supplied key to upper case if required. */ \
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapGet0" #X, \
                     status ); \
\
/* Use the hash function to determine the element of the hash table in \
   which the key will be stored. */ \
   itab = HashFun( key, this->mapsize - 1, &hash, status ); \
\
/* Search the relevent table entry for the required MapEntry. */ \
   mapentry = SearchTableEntry( this, itab, key, status ); \
\
/* Skip rest if the key was not found. */ \
   if( mapentry ) { \
\
/* Get the address of the raw value, and its data type. */ \
      raw_type = mapentry->type; \
      if( raw_type == AST__INTTYPE ){ \
         if( mapentry->nel == 0 ) { \
            raw = &( ((Entry0I *)mapentry)->value ); \
         } else { \
            raw = ((Entry1I *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__SINTTYPE ){ \
         if( mapentry->nel == 0 ) { \
            raw = &( ((Entry0S *)mapentry)->value ); \
         } else { \
            raw = ((Entry1S *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__BYTETYPE ){ \
         if( mapentry->nel == 0 ) { \
            raw = &( ((Entry0B *)mapentry)->value ); \
         } else { \
            raw = ((Entry1B *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__DOUBLETYPE ){ \
         if( mapentry->nel == 0 ) { \
            raw = &( ((Entry0D *)mapentry)->value ); \
         } else { \
            raw = ((Entry1D *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__FLOATTYPE ){ \
         if( mapentry->nel == 0 ) { \
            raw = &( ((Entry0F *)mapentry)->value ); \
         } else { \
            raw = ((Entry1F *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__POINTERTYPE ){ \
         if( mapentry->nel == 0 ) { \
            raw = &( ((Entry0P *)mapentry)->value ); \
         } else { \
            raw = ((Entry1P *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__STRINGTYPE ){ \
         if( mapentry->nel == 0 ) { \
            raw = &( ((Entry0C *)mapentry)->value ); \
         } else { \
            raw = ((Entry1C *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__OBJECTTYPE ){ \
         if( mapentry->nel == 0 ) { \
            raw = &( ((Entry0A *)mapentry)->value ); \
         } else { \
            raw = ((Entry1A *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__UNDEFTYPE ){ \
         raw = NULL; \
\
      } else { \
         raw = NULL; \
         astError( AST__INTER, "astMapGet0<X>(KeyMap): Illegal map entry data " \
                   "type %d encountered (internal AST programming error).", status, \
                   raw_type ); \
      } \
\
/* Convert the value, storing the result the supplied buffer. Report an \
   error if conversion is not possible. */ \
      if( !raw ) { \
         result = 0; \
\
      } else if( !ConvertValue( raw, raw_type, value, Itype, status ) && astOK ){ \
         astError( AST__MPGER, "astMapGet0" #X "(%s): The value of KeyMap key " \
                   "\"%s\" cannot be read using the requested data " \
                   "type.", status,astGetClass( this ), key ); \
\
      } else { \
         result = 1; \
      } \
\
/* If the KeyError attribute is non-zero, report an error if the key is not \
   found */ \
   } else if( astGetKeyError( this ) && astOK ) { \
      astError( AST__MPKER, "astMapGet0" #X "(%s): No value was found for " \
                "%s in the supplied KeyMap.", status, astGetClass( this ), \
                key ); \
   } \
\
/* If an error occurred, return zero. */ \
   if( !astOK ) result = 0; \
\
/* Return the result.*/ \
   return result; \
}

/* Expand the above macro to generate a function for each required
   data type. */
MAKE_MAPGET0(I,int,AST__INTTYPE)
MAKE_MAPGET0(D,double,AST__DOUBLETYPE)
MAKE_MAPGET0(F,float,AST__FLOATTYPE)
MAKE_MAPGET0(C,const char *,AST__STRINGTYPE)
MAKE_MAPGET0(A,AstObject *,AST__OBJECTTYPE)
MAKE_MAPGET0(P,void *,AST__POINTERTYPE)
MAKE_MAPGET0(S,short int,AST__SINTTYPE)
MAKE_MAPGET0(B,unsigned char,AST__BYTETYPE)

/* Undefine the macro. */
#undef MAKE_MAPGET0

int astMapGet0AId_( AstKeyMap *this, const char *skey, AstObject **value, int *status ) {
/*
*  Name:
*     astMapGet0AId_

*  Purpose:
*     Get a scalar AstObject pointer from a KeyMap.

*  Type:
*     Private function.

*  Synopsis:
*     #include "ast.h"
*     int astMapGet0A( AstKeyMap *this, const char *key, AstObject **value )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This is the public implementation of the astMapGet0A function
*     It is identical to astMapGet0A_ except that an ID value is returned
*     via the "value" parameter instead of a true C pointer. This is required
*     because this conversion cannot be performed by the macro that invokes
*     the function.

*  Parameters:
*     (see astMapGet0<X>)

*/

/* Local Variables: */
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */ \
   const char *key;        /* Pointer to key string to use */ \
   int itab;               /* Index of hash table element to use */
   int raw_type;           /* Data type of stored value */
   int result;             /* Returned flag */
   unsigned long hash;     /* Full width hash value */
   void *raw;              /* Pointer to stored value */

/* Initialise */
   result = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapGet0A",
                     status );

/* Use the hash function to determine the element of the hash table in
   which the key will be stored. */
   itab = HashFun( key, this->mapsize - 1, &hash, status );

/* Search the relevent table entry for the required MapEntry. */
   mapentry = SearchTableEntry( this, itab, key, status );

/* Skip rest if the key was not found. */
   if( mapentry ) {

/* Get the address of the raw value, and its data type. */
      raw_type = mapentry->type;
      if( raw_type == AST__INTTYPE ){
         if( mapentry->nel == 0 ) {
            raw = &( ((Entry0I *)mapentry)->value );
         } else {
            raw = ((Entry1I *)mapentry)->value;
         }

      } else if( raw_type == AST__POINTERTYPE ){
         if( mapentry->nel == 0 ) {
            raw = &( ((Entry0P *)mapentry)->value );
         } else {
            raw = ((Entry1P *)mapentry)->value;
         }

      } else if( raw_type == AST__SINTTYPE ){
         if( mapentry->nel == 0 ) {
            raw = &( ((Entry0S *)mapentry)->value );
         } else {
            raw = ((Entry1S *)mapentry)->value;
         }

      } else if( raw_type == AST__BYTETYPE ){
         if( mapentry->nel == 0 ) {
            raw = &( ((Entry0B *)mapentry)->value );
         } else {
            raw = ((Entry1B *)mapentry)->value;
         }

      } else if( raw_type == AST__DOUBLETYPE ){
         if( mapentry->nel == 0 ) {
            raw = &( ((Entry0D *)mapentry)->value );
         } else {
            raw = ((Entry1D *)mapentry)->value;
         }

      } else if( raw_type == AST__FLOATTYPE ){
         if( mapentry->nel == 0 ) {
            raw = &( ((Entry0F *)mapentry)->value );
         } else {
            raw = ((Entry1F *)mapentry)->value;
         }

      } else if( raw_type == AST__STRINGTYPE ){
         if( mapentry->nel == 0 ) {
            raw = &( ((Entry0C *)mapentry)->value );
         } else {
            raw = ((Entry1C *)mapentry)->value;
         }

      } else if( raw_type == AST__OBJECTTYPE ){
         if( mapentry->nel == 0 ) {
            raw = &( ((Entry0A *)mapentry)->value );
         } else {
            raw = ((Entry1A *)mapentry)->value;
         }

      } else if( raw_type == AST__UNDEFTYPE ){
         raw = NULL;

      } else {
         raw = NULL;
         astError( AST__INTER, "astMapGet0<X>(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   raw_type );
      }

/* Convert the value, storing the result the supplied buffer. Report an
   error if conversion is not possible. */
      if( !raw ) {
         result = 0;

      } else if( !ConvertValue( raw, raw_type, value, AST__OBJECTTYPE, status ) && astOK ){
         astError( AST__MPGER, "astMapGet0A(%s): The value of KeyMap key "
                   "\"%s\" cannot be read using the requested data "
                   "type.", status, astGetClass( this ), key );

      } else {
         result = 1;
      }

/* If the KeyError attribute is non-zero, report an error if the key is not
   found */
   } else if( astGetKeyError( this ) && astOK ) {
      astError( AST__MPKER, "astMapGet0A(%s): No value was found for "
                "%s in the supplied KeyMap.", status, astGetClass( this ),
                key );
   }

/* If required, return an ID value for the Object. */
   if( result && *value ) *value = astMakeId( *value );

/* Return the result.*/
   return result;
}

/*
*++
*  Name:
c     astMapGet1<X>
f     AST_MAPGET1<X>

*  Purpose:
*     Get a vector value from a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "ast.h"
c     int astMapGet1<X>( AstKeyMap *this, const char *key, int mxval,
c                        int *nval, <X>type *value )
c     int astMapGet1C( AstKeyMap *this, const char *key, int l, int mxval,
c                      int *nval, const char *value )
f     RESULT = AST_MAPGET1<X>( THIS, KEY, MXVAL, NVAL, VALUE, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This is a set of functions for retrieving a vector value from a KeyMap.
*     You should replace <X> in the generic function name
c     astMapGet1<X>
f     AST_MAPGET1<X>
*     by an appropriate 1-character type code (see the "Data Type Codes"
*     section below for the code appropriate to each supported data type).
*     The stored value is converted to the data type indiced by <X>
*     before being returned (an error is reported if it is not possible to
*     convert the stored value to the requested data type).
c     Note, the astMapGet1C function has an extra parameter "l" which
c     specifies the maximum length of each string to be stored in the
c     "value" buffer (see the "astMapGet1C" section below).

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        The character string identifying the value to be retrieved. Trailing
*        spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
c     mxval
f     MXVAL = INTEGER (Given)
*        The number of elements in the
c        "value" array.
f        VALUE array.
c     nval
f     NVAL = INTEGER (Returned)
c        The address of an integer in which to put the
f        The
*        number of elements stored in the
c        "value" array.
*        Any unused elements of the array are left unchanged.
c     value
f     VALUE( MXVAL ) = <X>type (Returned)
c        A pointer to an array in which to return the requested values.
f        The requested values.
*        If the requested key is not found, or if it is found but has an
*        undefined value (see
c        astMapPutU),
f        AST_MAPPUTU),
*        then the contents of the
*        buffer on entry to this function will be unchanged on exit.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Returned Value:
c     astMapGet1<X>()
f     AST_MAPGET1<X> = LOGICAL
c        A non-zero value
f        .TRUE.
*        is returned if the requested key name was found, and does not have
*        an undefined value (see
c        astMapPutU). Zero
f        AST_MAPPUTU). .FALSE.
*        is returned otherwise.

*  Notes:
*     - No error is reported if the requested key cannot be found in the
*     given KeyMap, but a
c     zero
f     .FALSE.
*     value will be returned as the function value. The supplied array
*     will be returned unchanged.
*     - If the stored value is a scalar value, then the value will be
*     returned in the first element of the supplied array, and
c     "nval"
f     NVAL
*     will be returned set to 1.

c  astMapGet1C:
c     The "value" buffer supplied to the astMapGet1C function should be a
c     pointer to a character array with "mxval*l" elements, where "l" is
c     the maximum length of a string to be returned. The value of "l"
c     should be supplied as an extra parameter following "key" when
c     invoking astMapGet1C, and should include space for a terminating
c     null character.

*  Data Type Codes:
*     To select the appropriate
c     function, you should replace <X> in the generic function name astMapGet1<X>
f     routine, you should replace <X> in the generic routine name AST_MAPGET1<X>
*     with a 1-character data type code, so as to match the data type <X>type
*     of the data you are processing, as follows:
c     - D: double
c     - F: float
c     - I: int
c     - C: "const" pointer to null terminated character string
c     - A: Pointer to AstObject
c     - P: Generic "void *" pointer
c     - S: short int
c     - B: Unsigned byte (i.e. char)
f     - D: DOUBLE PRECISION
f     - R: REAL
f     - I: INTEGER
f     - C: CHARACTER
f     - A: INTEGER used to identify an AstObject
f     - S: INTEGER*2 (short integer)
f     - B: Unsigned byte
*
c     For example, astMapGet1D would be used to get "double" values, while
c     astMapGet1I would be used to get "int" values, etc. For D or I, the
c     supplied "value" parameter should be a pointer to an array of doubles
c     or ints, with "mxval" elements. For C, the supplied "value" parameter
c     should be a pointer to a character string with "mxval*l" elements.
c     For A, the supplied "value" parameter should be a pointer to an
c     array of AstObject pointers.
f     For example, AST_MAPGET1D would be used to get DOUBLE PRECISION values,
f     while AST_MAPGET1I would be used to get INTEGER values, etc.

*--
*/
/* Define a macro to implement the function for a specific data type
(excluding "C" since that needs an extra parameter). */
#define MAKE_MAPGET1(X,Xtype,Itype) \
static int MapGet1##X( AstKeyMap *this, const char *skey, int mxval, int *nval, Xtype *value, int *status ) { \
\
/* Local Variables: */ \
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */ \
   const char *key;        /* Pointer to key string to use */ \
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */ \
   int i;                  /* Element index */ \
   int itab;               /* Index of hash table element to use */ \
   int nel;                /* Number of elements in raw vector */ \
   int raw_type;           /* Data type of stored value */ \
   int result;             /* Returned flag */ \
   size_t raw_size;        /* Size of a single raw value */ \
   unsigned long hash;     /* Full width hash value */ \
   void *raw;              /* Pointer to stored value */ \
\
/* Initialise */ \
   result = 0; \
   *nval = 0; \
\
/* Check the global error status. */ \
   if ( !astOK ) return result; \
\
/* Convert the supplied key to upper case if required. */ \
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapGet1" #X, \
                     status ); \
\
/* Use the hash function to determine the element of the hash table in \
   which the key will be stored. */ \
   itab = HashFun( key, this->mapsize - 1, &hash, status ); \
\
/* Search the relevent table entry for the required MapEntry. */ \
   mapentry = SearchTableEntry( this, itab, key, status ); \
\
/* Skip rest if the key was not found. */ \
   if( mapentry ) { \
      result = 1; \
\
/* Get the address of the first raw value, and its data type. Also get \
   the size of each element of the vector. */ \
      nel = mapentry->nel; \
      raw_type = mapentry->type; \
      if( raw_type == AST__INTTYPE ){ \
         raw_size = sizeof( int ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0I *)mapentry)->value ); \
         } else { \
            raw = ((Entry1I *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__DOUBLETYPE ){ \
         raw_size = sizeof( double ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0D *)mapentry)->value ); \
         } else { \
            raw = ((Entry1D *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__SINTTYPE ){ \
         raw_size = sizeof( short int ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0S *)mapentry)->value ); \
         } else { \
            raw = ((Entry1S *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__BYTETYPE ){ \
         raw_size = sizeof( unsigned char ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0B *)mapentry)->value ); \
         } else { \
            raw = ((Entry1B *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__POINTERTYPE ){ \
         raw_size = sizeof( void * ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0P *)mapentry)->value ); \
         } else { \
            raw = ((Entry1P *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__FLOATTYPE ){ \
         raw_size = sizeof( float ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0F *)mapentry)->value ); \
         } else { \
            raw = ((Entry1F *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__STRINGTYPE ){ \
         raw_size = sizeof( const char * ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0C *)mapentry)->value ); \
         } else { \
            raw = ((Entry1C *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__OBJECTTYPE ){ \
         raw_size = sizeof( AstObject * ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0A *)mapentry)->value ); \
         } else { \
            raw = ((Entry1A *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__UNDEFTYPE ){ \
         raw_size = 0; \
         raw = NULL; \
\
      } else { \
         raw_size = 0; \
         raw = NULL; \
         astError( AST__INTER, "astMapGet1<X>(KeyMap): Illegal map entry data " \
                   "type %d encountered (internal AST programming error).", status, \
                   raw_type ); \
      } \
\
/* Treat scalars as single-value vectors. */ \
      if( nel == 0 ) nel = 1; \
\
/* Ensure no more than "mxval" values are returned. */ \
      if( nel > mxval ) nel = mxval; \
\
/* Return the number of values stored in the buffer. */ \
      *nval = nel; \
\
/* Loop round all values in the vector. */ \
      for( i = 0; i < nel && astOK; i++ ) { \
\
/* Convert the value, storing the result in the supplied buffer. Report an \
   error if conversion is not possible. */ \
         if( !raw ) { \
            result = 0; \
\
         } else if( !ConvertValue( raw, raw_type, value + i, Itype, status ) && astOK ){ \
            astError( AST__MPGER, "astMapGet1" #X "(%s): The value of " \
                      "element %d of KeyMap key \"%s\" cannot be read using " \
                      "the requested data type.", status,astGetClass( this ), i + 1, key ); \
         } \
\
/* Increment the pointers to the next raw value. */ \
         raw = (char *) raw + raw_size; \
      } \
\
/* If the KeyError attribute is non-zero, report an error if the key is not \
   found */ \
   } else if( astGetKeyError( this ) && astOK ) { \
      astError( AST__MPKER, "astMapGet1" #X "(%s): No value was found for " \
                "%s in the supplied KeyMap.", status, astGetClass( this ), \
                key ); \
   } \
\
/* If an error occurred,return zero. */ \
   if( !astOK ) result = 0; \
\
/* Return the result.*/ \
   return result; \
}

/* Expand the above macro to generate a function for each required
   data type (except C which is done differently). */
MAKE_MAPGET1(I,int,AST__INTTYPE)
MAKE_MAPGET1(D,double,AST__DOUBLETYPE)
MAKE_MAPGET1(F,float,AST__FLOATTYPE)
MAKE_MAPGET1(A,AstObject *,AST__OBJECTTYPE)
MAKE_MAPGET1(P,void *,AST__POINTERTYPE)
MAKE_MAPGET1(S,short int,AST__SINTTYPE)
MAKE_MAPGET1(B,unsigned char,AST__BYTETYPE)

/* Undefine the macro. */
#undef MAKE_MAPGET1


static int MapGet1C( AstKeyMap *this, const char *skey, int l, int mxval,
                     int *nval, char *value, int *status ) {
/*
*  Name:
*     MapGet1C

*  Purpose:
*     Get a vector value from a KeyMap.

*  Type:
*     Private member function.

*  Synopsis:
*     #include "ast.h"
*     int MapGet1C( AstKeyMap *this, const char *key, int l, int mxval,
*                   int *nval, char *value, int *status )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This is the implementation of astMapGet1<X> for <X> = "C". We
*     cannot use the MAKE_MAPGET1 macro for this because the string
*     version of this function has an extra parameter giving the maximum
*     length of each string which can be stored in the supplied buffer.

*  Parameters:
*     (see astMapGet1<X>)
*/

/* Local Variables: */
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */
   char *val;              /* Pointer to next buffer element */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */ \
   const char *cvalue;     /* Pointer to converted string */
   const char *key;        /* Pointer to key string to use */ \
   int i;                  /* Element index */
   int itab;               /* Index of hash table element to use */
   int nel;                /* Number of elements in raw vector */
   int raw_type;           /* Data type of stored value */
   int result;             /* Returned flag */
   size_t raw_size;        /* Size of a single raw value */
   unsigned long hash;     /* Full width hash value */
   void *raw;              /* Pointer to stored value */

/* Initialise */
   result = 0;
   *nval = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapGet1C",
                     status );

/* Use the hash function to determine the element of the hash table in
   which the key will be stored. */
   itab = HashFun( key, this->mapsize - 1, &hash, status );

/* Search the relevent table entry for the required MapEntry. */
   mapentry = SearchTableEntry( this, itab, key, status );

/* Skip rest if the key was not found. */
   if( mapentry ) {
      result = 1;

/* Get the address of the first raw value, and its data type. Also get
   the size of each element of the vector. */
      nel = mapentry->nel;
      raw_type = mapentry->type;
      if( raw_type == AST__INTTYPE ){
         raw_size = sizeof( int );
         if( nel == 0 ) {
            raw = &( ((Entry0I *)mapentry)->value );
         } else {
            raw = ((Entry1I *)mapentry)->value;
         }

      } else if( raw_type == AST__POINTERTYPE ){
         raw_size = sizeof( void * );
         if( nel == 0 ) {
            raw = &( ((Entry0P *)mapentry)->value );
         } else {
            raw = ((Entry1P *)mapentry)->value;
         }

      } else if( raw_type == AST__DOUBLETYPE ){
         raw_size = sizeof( double );
         if( nel == 0 ) {
            raw = &( ((Entry0D *)mapentry)->value );
         } else {
            raw = ((Entry1D *)mapentry)->value;
         }

      } else if( raw_type == AST__SINTTYPE ){
         raw_size = sizeof( short int );
         if( nel == 0 ) {
            raw = &( ((Entry0S *)mapentry)->value );
         } else {
            raw = ((Entry1S *)mapentry)->value;
         }

      } else if( raw_type == AST__BYTETYPE ){
         raw_size = sizeof( unsigned char );
         if( nel == 0 ) {
            raw = &( ((Entry0B *)mapentry)->value );
         } else {
            raw = ((Entry1B *)mapentry)->value;
         }

      } else if( raw_type == AST__FLOATTYPE ){
         raw_size = sizeof( float );
         if( nel == 0 ) {
            raw = &( ((Entry0F *)mapentry)->value );
         } else {
            raw = ((Entry1F *)mapentry)->value;
         }

      } else if( raw_type == AST__STRINGTYPE ){
         raw_size = sizeof( const char * );
         if( nel == 0 ) {
            raw = &( ((Entry0C *)mapentry)->value );
         } else {
            raw = ((Entry1C *)mapentry)->value;
         }

      } else if( raw_type == AST__OBJECTTYPE ){
         raw_size = sizeof( AstObject * );
         if( nel == 0 ) {
            raw = &( ((Entry0A *)mapentry)->value );
         } else {
            raw = ((Entry1A *)mapentry)->value;
         }

      } else if( raw_type == AST__UNDEFTYPE ){
         raw_size = 0;
         raw = NULL;

      } else {
         raw_size = 0;
         raw = NULL;
         astError( AST__INTER, "astMapGet1C(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   raw_type );
      }

/* Treat scalars as single-value vectors. */
      if( nel == 0 ) nel = 1;

/* Ensure no more than "mxval" values are returned. */
      if( nel > mxval ) nel = mxval;

/* Return the number of values stored in the buffer. */
      *nval = nel;

/* Loop round all values in the vector. */
      val = value;
      for( i = 0; i < nel && astOK; i++ ) {

/* Convert the value, storing the result in the supplied buffer. Report an
   error if conversion is not possible. */
         if( !raw ) {
            result = 0;

         } else if( !ConvertValue( raw, raw_type, &cvalue, AST__STRINGTYPE, status ) && astOK ){
            astError( AST__MPGER, "astMapGet1C(%s): The value of "
                      "element %d of KeyMap key \"%s\" cannot be read using "
                      "the requested data type.", status,astGetClass( this ), i + 1, key );

/* If succesful, copy the string into the supplied buffer, or as much of
   it as will fit. Leave room for a trailing null character. */
         } else {
            strncpy( val, cvalue, l - 1 );
            val[ l - 1 ] = 0;
         }

/* Increment the pointers to the next raw value and the next buffer
   location. */
         raw = (char *) raw + raw_size;
         val += l;
      }

/* If the KeyError attribute is non-zero, report an error if the key is not
   found */
   } else if( astGetKeyError( this ) && astOK ) {
      astError( AST__MPKER, "astMapGet1C(%s): No value was found for "
                "%s in the supplied KeyMap.", status, astGetClass( this ),
                key );
   }

/* If an error occurred,return zero. */
   if( !astOK ) result = 0;

/* Return the result.*/
   return result;
}

int astMapGet1AId_( AstKeyMap *this, const char *skey, int mxval, int *nval,
                    AstObject **value, int *status ) {
/*
*  Name:
*     astMapGet1AId_

*  Purpose:
*     Get a vector of AstObject pointers from a KeyMap.

*  Type:
*     Private function.

*  Synopsis:
*     #include "ast.h"
*     int astMapGet1A( AstKeyMap *this, const char *key, int mxval, int *nval,
*                      AstObject **value )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This is the public implementation of the astMapGet1A function
*     It is identical to astMapGet1A_ except that ID values are returned
*     via the "value" parameter instead of a true C pointers. This is required
*     because this conversion cannot be performed by the macro that invokes
*     the function.

*  Parameters:
*     (see astMapGet1<X>)

*/

/* Local Variables: */
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */
   AstObject *avalue;      /* Pointer to AstObject */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */ \
   const char *key;        /* Pointer to key string to use */ \
   int i;                  /* Element index */
   int itab;               /* Index of hash table element to use */
   int nel;                /* Number of elements in raw vector */
   int raw_type;           /* Data type of stored value */
   int result;             /* Returned flag */
   size_t raw_size;        /* Size of a single raw value */
   unsigned long hash;     /* Full width hash value */
   void *raw;              /* Pointer to stored value */

/* Initialise */
   result = 0;
   *nval = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapGet1A",
                     status );

/* Use the hash function to determine the element of the hash table in
   which the key will be stored. */
   itab = HashFun( key, this->mapsize - 1, &hash, status );

/* Search the relevent table entry for the required MapEntry. */
   mapentry = SearchTableEntry( this, itab, key, status );

/* Skip rest if the key was not found. */
   if( mapentry ) {
      result = 1;

/* Get the address of the first raw value, and its data type. Also get
   the size of each element of the vector. */
      nel = mapentry->nel;
      raw_type = mapentry->type;
      if( raw_type == AST__INTTYPE ){
         raw_size = sizeof( int );
         if( nel == 0 ) {
            raw = &( ((Entry0I *)mapentry)->value );
         } else {
            raw = ((Entry1I *)mapentry)->value;
         }

      } else if( raw_type == AST__DOUBLETYPE ){
         raw_size = sizeof( double );
         if( nel == 0 ) {
            raw = &( ((Entry0D *)mapentry)->value );
         } else {
            raw = ((Entry1D *)mapentry)->value;
         }

      } else if( raw_type == AST__SINTTYPE ){
         raw_size = sizeof( short int );
         if( nel == 0 ) {
            raw = &( ((Entry0S *)mapentry)->value );
         } else {
            raw = ((Entry1S *)mapentry)->value;
         }

      } else if( raw_type == AST__BYTETYPE ){
         raw_size = sizeof( unsigned char );
         if( nel == 0 ) {
            raw = &( ((Entry0B *)mapentry)->value );
         } else {
            raw = ((Entry1B *)mapentry)->value;
         }

      } else if( raw_type == AST__POINTERTYPE ){
         raw_size = sizeof( void * );
         if( nel == 0 ) {
            raw = &( ((Entry0P *)mapentry)->value );
         } else {
            raw = ((Entry1P *)mapentry)->value;
         }

      } else if( raw_type == AST__FLOATTYPE ){
         raw_size = sizeof( float );
         if( nel == 0 ) {
            raw = &( ((Entry0F *)mapentry)->value );
         } else {
            raw = ((Entry1F *)mapentry)->value;
         }

      } else if( raw_type == AST__STRINGTYPE ){
         raw_size = sizeof( const char * );
         if( nel == 0 ) {
            raw = &( ((Entry0C *)mapentry)->value );
         } else {
            raw = ((Entry1C *)mapentry)->value;
         }

      } else if( raw_type == AST__OBJECTTYPE ){
         raw_size = sizeof( AstObject * );
         if( nel == 0 ) {
            raw = &( ((Entry0A *)mapentry)->value );
         } else {
            raw = ((Entry1A *)mapentry)->value;
         }

      } else if( raw_type == AST__UNDEFTYPE ){
         raw_size = 0;
         raw = NULL;

      } else {
         raw_size = 0;
         raw = NULL;
         astError( AST__INTER, "astMapGet1A(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).",
                   status, raw_type );
      }

/* Treat scalars as single-value vectors. */
      if( nel == 0 ) nel = 1;

/* Ensure no more than "mxval" values are returned. */
      if( nel > mxval ) nel = mxval;

/* Return the number of values stored in the buffer. */
      *nval = nel;

/* Loop round all values in the vector. */
      for( i = 0; i < nel && astOK; i++ ) {

/* Convert the value, storing the result in the supplied buffer. Report an
   error if conversion is not possible. */
         if( !raw ) {
            result = 0;

         } else if( !ConvertValue( raw, raw_type, &avalue, AST__OBJECTTYPE, status ) && astOK ){
            astError( AST__MPGER, "astMapGet1A(%s): The value of "
                      "element %d of KeyMap key \"%s\" cannot be read using "
                      "the requested data type.", status, astGetClass( this ),
                      i + 1, key );

/* If succesful, return an ID value for the Object. */
         } else {
           value[ i ] = avalue ? astMakeId( avalue ) : NULL;
         }

/* Increment the pointers to the next raw value. */
         raw = (char *) raw + raw_size;
      }

/* If the KeyError attribute is non-zero, report an error if the key is not
   found */
   } else if( astGetKeyError( this ) && astOK ) {
      astError( AST__MPKER, "astMapGet1A(%s): No value was found for "
                "%s in the supplied KeyMap.", status, astGetClass( this ),
                key );
   }

/* If an error occurred,return zero. */
   if( !astOK ) result = 0;

/* Return the result.*/
   return result;
}

/*
*++
*  Name:
c     astMapGetElem<X>
f     AST_MAPGETELEM<X>

*  Purpose:
*     Get a single element of a vector value from a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "ast.h"
c     int astMapGetElem<X>( AstKeyMap *this, const char *key, int elem,
c                           <X>type *value )
c     int astMapGetElemC( AstKeyMap *this, const char *key, int l, int elem,
c                         char *value )
f     RESULT = AST_MAPGETELEM<X>( THIS, KEY, ELEM, VALUE, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This is a set of functions for retrieving a single element of a vector
*     value from a KeyMap. You should replace <X> in the generic function name
c     astMapGetElem<X>
f     AST_MAPGETELEM<X>
*     by an appropriate 1-character type code (see the "Data Type Codes"
*     section below for the code appropriate to each supported data type).
*     The stored value is converted to the data type indiced by <X>
*     before being returned (an error is reported if it is not possible to
*     convert the stored value to the requested data type).
c     Note, the astMapGetElemC function has an extra parameter "l" which
c     specifies the maximum length of the string to be stored in the
c     "value" buffer (see the "astMapGetElemC" section below).

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        The character string identifying the value to be retrieved. Trailing
*        spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
c     elem
f     ELEM = INTEGER (Given)
*        The index of the required vector element, starting at
c        zero.
f        one.
*        An error will be reported if the value is outside the range of
*        the vector.
c     value
f     VALUE = <X>type (Returned)
c        A pointer to a buffer in which to return the requested value.
f        The requested value.
*        If the requested key is not found, or if it is found but has an
*        undefined value (see
c        astMapPutU),
f        AST_MAPPUTU),
*        then the contents of the
*        buffer on entry to this function will be unchanged on exit.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Returned Value:
c     astMapGetElem<X>()
f     AST_MAPGETELEM<X> = LOGICAL
c        A non-zero value
f        .TRUE.
*        is returned if the requested key name was found, and does not have
*        an undefined value (see
c        astMapPutU). Zero
f        AST_MAPPUTU). .FALSE.
*        is returned otherwise.

*  Notes:
*     - No error is reported if the requested key cannot be found in the
*     given KeyMap, or if it has an undefined value, but a
c     zero
f     .FALSE.
*     value will be returned as the function value.

c  astMapGetElemC:
c     The "value" buffer supplied to the astMapGetElemC function should be a
c     pointer to a character array with "l" elements, where "l" is the
c     maximum length of the string to be returned. The value of "l"
c     should be supplied as an extra parameter following "key" when
c     invoking astMapGetElemC, and should include space for a terminating
c     null character.

*  Data Type Codes:
*     To select the appropriate
c     function, you should replace <X> in the generic function name
c     astMapGetElem<X>
f     routine, you should replace <X> in the generic routine name
f     AST_MAPGETELEM<X>
*     with a 1-character data type code, so as to match the data type <X>type
*     of the data you are processing, as follows:
c     - D: double
c     - F: float
c     - I: int
c     - C: "const" pointer to null terminated character string
c     - A: Pointer to AstObject
c     - P: Generic "void *" pointer
c     - S: short int
c     - B: Unsigned byte (i.e. char)
f     - D: DOUBLE PRECISION
f     - R: REAL
f     - I: INTEGER
f     - C: CHARACTER
f     - A: INTEGER used to identify an AstObject
f     - S: INTEGER*2 (short integer)
f     - B: Unsigned byte
*
c     For example, astMapGetElemD would be used to get a "double" value, while
c     astMapGetElemI would be used to get an "int" value, etc. For D or I, the
c     supplied "value" parameter should be a pointer to a double or int. For
c     C, the supplied "value" parameter should be a pointer to a character
c     string with "l" elements. For A, the supplied "value" parameter should
c     be a pointer to an AstObject pointer.
f     For example, AST_MAPGETELEMD would be used to get a DOUBLE PRECISION
f     value, while AST_MAPGETELEMI would be used to get an INTEGER value, etc.

*--
*/
/* Define a macro to implement the function for a specific data type
(excluding "C" since that needs an extra parameter). */
#define MAKE_MAPGETELEM(X,Xtype,Itype) \
static int MapGetElem##X( AstKeyMap *this, const char *skey, int elem, \
                          Xtype *value, int *status ) { \
\
/* Local Variables: */ \
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */ \
   const char *key;        /* Pointer to key string to use */ \
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */ \
   int itab;               /* Index of hash table element to use */ \
   int nel;                /* Number of elements in raw vector */ \
   int raw_type;           /* Data type of stored value */ \
   int result;             /* Returned flag */ \
   size_t raw_size;        /* Size of a single raw value */ \
   unsigned long hash;     /* Full width hash value */ \
   void *raw;              /* Pointer to stored value */ \
\
/* Initialise */ \
   result = 0; \
\
/* Check the global error status. */ \
   if ( !astOK ) return result; \
\
/* Convert the supplied key to upper case if required. */ \
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapGetElem" #X, \
                     status ); \
\
/* Use the hash function to determine the element of the hash table in \
   which the key will be stored. */ \
   itab = HashFun( key, this->mapsize - 1, &hash, status ); \
\
/* Search the relevent table entry for the required MapEntry. */ \
   mapentry = SearchTableEntry( this, itab, key, status ); \
\
/* Skip rest if the key was not found. */ \
   if( mapentry ) { \
      result = 1; \
\
/* Get the address of the first raw value, and its data type. Also get \
   the size of each element of the vector. */ \
      nel = mapentry->nel; \
      raw_type = mapentry->type; \
      if( raw_type == AST__INTTYPE ){ \
         raw_size = sizeof( int ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0I *)mapentry)->value ); \
         } else { \
            raw = ((Entry1I *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__DOUBLETYPE ){ \
         raw_size = sizeof( double ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0D *)mapentry)->value ); \
         } else { \
            raw = ((Entry1D *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__SINTTYPE ){ \
         raw_size = sizeof( short int ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0S *)mapentry)->value ); \
         } else { \
            raw = ((Entry1S *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__BYTETYPE ){ \
         raw_size = sizeof( unsigned char ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0B *)mapentry)->value ); \
         } else { \
            raw = ((Entry1B *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__POINTERTYPE ){ \
         raw_size = sizeof( void * ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0P *)mapentry)->value ); \
         } else { \
            raw = ((Entry1P *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__FLOATTYPE ){ \
         raw_size = sizeof( float ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0F *)mapentry)->value ); \
         } else { \
            raw = ((Entry1F *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__STRINGTYPE ){ \
         raw_size = sizeof( const char * ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0C *)mapentry)->value ); \
         } else { \
            raw = ((Entry1C *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__OBJECTTYPE ){ \
         raw_size = sizeof( AstObject * ); \
         if( nel == 0 ) { \
            raw = &( ((Entry0A *)mapentry)->value ); \
         } else { \
            raw = ((Entry1A *)mapentry)->value; \
         } \
\
      } else if( raw_type == AST__UNDEFTYPE ){ \
         raw = NULL; \
\
      } else { \
         raw_size = 0; \
         raw = NULL; \
         astError( AST__INTER, "astMapGetElem<X>(KeyMap): Illegal map entry " \
                   "data type %d encountered (internal AST programming " \
                   "error).", status, raw_type ); \
      } \
\
/* Treat scalars as single-value vectors. */ \
      if( nel == 0 ) nel = 1; \
\
/* Ensure the requested element is within the bounds of the vector */ \
      if( elem >= nel || elem < 0 ) { \
         if( astOK ) { \
            astError( AST__MPVIN, "astMapGetElem<X>(KeyMap): Illegal " \
                      "zero-based vector index %d supplied for KeyMap " \
                      "entry '%s' - the vector has %d elements.", status, \
                      elem, key, nel ); \
         } \
\
/* Get a pointer to the requested raw value. */ \
      } else if( raw ) { \
         raw = (char *) raw + elem*raw_size; \
\
/* Convert the requested value, storing the result in the supplied buffer. \
   Report an error if conversion is not possible. */ \
         if( !ConvertValue( raw, raw_type, value, Itype, status ) && astOK ){ \
            astError( AST__MPGER, "astMapGetElem" #X "(%s): The value of " \
                      "element %d of KeyMap key \"%s\" cannot be read using " \
                      "the requested data type.", status, astGetClass( this ), \
                      elem + 1, key ); \
         } \
      } \
\
/* If the KeyError attribute is non-zero, report an error if the key is not \
   found */ \
   } else if( astGetKeyError( this ) && astOK ) { \
      astError( AST__MPKER, "astMapGetElem" #X "(%s): No value was found for " \
                "%s in the supplied KeyMap.", status, astGetClass( this ), \
                key ); \
   } \
\
/* If an error occurred,return zero. */ \
   if( !astOK ) result = 0; \
\
/* Return the result.*/ \
   return result; \
}

/* Expand the above macro to generate a function for each required
   data type (except C which is done differently). */
MAKE_MAPGETELEM(I,int,AST__INTTYPE)
MAKE_MAPGETELEM(D,double,AST__DOUBLETYPE)
MAKE_MAPGETELEM(F,float,AST__FLOATTYPE)
MAKE_MAPGETELEM(A,AstObject *,AST__OBJECTTYPE)
MAKE_MAPGETELEM(P,void *,AST__POINTERTYPE)
MAKE_MAPGETELEM(S,short int,AST__SINTTYPE)
MAKE_MAPGETELEM(B,unsigned char,AST__BYTETYPE)

/* Undefine the macro. */
#undef MAKE_MAPGETELEM


static int MapGetElemC( AstKeyMap *this, const char *skey, int l, int elem,
                        char *value, int *status ) {
/*
*  Name:
*     MapGetElemC

*  Purpose:
*     Get a single element of a vector value from a KeyMap.

*  Type:
*     Private member function.

*  Synopsis:
*     #include "ast.h"
*     int MapGetElemC( AstKeyMap *this, const char *key, int l, int elem,
*                      char *value, int *status )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This is the implementation of astMapGetElem<X> for <X> = "C". We
*     cannot use the MAKE_MAPGETELEM macro for this because the string
*     version of this function has an extra parameter giving the maximum
*     length of each string which can be stored in the supplied buffer.

*  Parameters:
*     (see astMapGetElem<X>)
*/

/* Local Variables: */
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */
   const char *key;        /* Pointer to key string to use */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */
   const char *cvalue;     /* Pointer to converted string */
   int itab;               /* Index of hash table element to use */
   int nel;                /* Number of elements in raw vector */
   int raw_type;           /* Data type of stored value */
   int result;             /* Returned flag */
   size_t raw_size;        /* Size of a single raw value */
   unsigned long hash;     /* Full width hash value */
   void *raw;              /* Pointer to stored value */

/* Initialise */
   result = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapGetElemC",
                     status );

/* Use the hash function to determine the element of the hash table in
   which the key will be stored. */
   itab = HashFun( key, this->mapsize - 1, &hash, status );

/* Search the relevent table entry for the required MapEntry. */
   mapentry = SearchTableEntry( this, itab, key, status );

/* Skip rest if the key was not found. */
   if( mapentry ) {
      result = 1;

/* Get the address of the first raw value, and its data type. Also get
   the size of each element of the vector. */
      nel = mapentry->nel;
      raw_type = mapentry->type;
      if( raw_type == AST__INTTYPE ){
         raw_size = sizeof( int );
         if( nel == 0 ) {
            raw = &( ((Entry0I *)mapentry)->value );
         } else {
            raw = ((Entry1I *)mapentry)->value;
         }

      } else if( raw_type == AST__POINTERTYPE ){
         raw_size = sizeof( void * );
         if( nel == 0 ) {
            raw = &( ((Entry0P *)mapentry)->value );
         } else {
            raw = ((Entry1P *)mapentry)->value;
         }

      } else if( raw_type == AST__DOUBLETYPE ){
         raw_size = sizeof( double );
         if( nel == 0 ) {
            raw = &( ((Entry0D *)mapentry)->value );
         } else {
            raw = ((Entry1D *)mapentry)->value;
         }

      } else if( raw_type == AST__SINTTYPE ){
         raw_size = sizeof( short int );
         if( nel == 0 ) {
            raw = &( ((Entry0S *)mapentry)->value );
         } else {
            raw = ((Entry1S *)mapentry)->value;
         }

      } else if( raw_type == AST__BYTETYPE ){
         raw_size = sizeof( unsigned char );
         if( nel == 0 ) {
            raw = &( ((Entry0B *)mapentry)->value );
         } else {
            raw = ((Entry1B *)mapentry)->value;
         }

      } else if( raw_type == AST__FLOATTYPE ){
         raw_size = sizeof( float );
         if( nel == 0 ) {
            raw = &( ((Entry0F *)mapentry)->value );
         } else {
            raw = ((Entry1F *)mapentry)->value;
         }

      } else if( raw_type == AST__STRINGTYPE ){
         raw_size = sizeof( const char * );
         if( nel == 0 ) {
            raw = &( ((Entry0C *)mapentry)->value );
         } else {
            raw = ((Entry1C *)mapentry)->value;
         }

      } else if( raw_type == AST__OBJECTTYPE ){
         raw_size = sizeof( AstObject * );
         if( nel == 0 ) {
            raw = &( ((Entry0A *)mapentry)->value );
         } else {
            raw = ((Entry1A *)mapentry)->value;
         }

      } else if( raw_type == AST__UNDEFTYPE ){
         raw = NULL;

      } else {
         raw_size = 0;
         raw = NULL;
         astError( AST__INTER, "astMapGetElemC(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   raw_type );
      }

/* Treat scalars as single-value vectors. */
      if( nel == 0 ) nel = 1;

/* Ensure the requested element is within the bounds of the vector */
      if( elem >= nel || elem < 0 ) {
         if( astOK ) {
            astError( AST__MPVIN, "astMapGetElemC(KeyMap): Illegal vector "
                      "index %d supplied for KeyMap entry '%s' - should be "
                      "in the range 1 to %d.", status, elem + 1, key, nel + 1 );
         }

/* Get a pointer to the requested raw value. */
      } else if( raw ){
         raw = (char *) raw + elem*raw_size;

/* Convert the value, storing the result in the supplied buffer. Report an
   error if conversion is not possible. */
         if( !ConvertValue( raw, raw_type, &cvalue, AST__STRINGTYPE, status ) && astOK ){
            astError( AST__MPGER, "astMapGetElemC(%s): The value of "
                      "element %d of KeyMap key \"%s\" cannot be read using "
                      "the requested data type.", status,astGetClass( this ),
                      elem + 1, key );

/* If succesful, copy the string into the supplied buffer, or as much of
   it as will fit. Leave room for a trailing null character. */
         } else {
            strncpy( value, cvalue, l - 1 );
            value[ l - 1 ] = 0;
         }
      }

/* If the KeyError attribute is non-zero, report an error if the key is not
   found */
   } else if( astGetKeyError( this ) && astOK ) {
      astError( AST__MPKER, "astMapGetElemC(%s): No value was found for "
                "%s in the supplied KeyMap.", status, astGetClass( this ),
                key );
   }

/* If an error occurred,return zero. */
   if( !astOK ) result = 0;

/* Return the result.*/
   return result;
}

int astMapGetElemAId_( AstKeyMap *this, const char *skey, int elem,
                       AstObject **value, int *status ) {
/*
*  Name:
*     astMapGetElemAId_

*  Purpose:
*     Get a single element of a vector of AstObject pointers from a KeyMap.

*  Type:
*     Private function.

*  Synopsis:
*     #include "ast.h"
*     int astMapGetElemA( AstKeyMap *this, const char *key, int elem,
*                         AstObject **value )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This is the public implementation of the astMapGetElemA function
*     It is identical to astMapGetElemA_ except that an ID value is returned
*     via the "value" parameter instead of a true C pointer. This is required
*     because this conversion cannot be performed by the macro that invokes
*     the function.

*  Parameters:
*     (see astMapGet1<X>)

*/

/* Local Variables: */
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */
   AstObject *avalue;      /* Pointer to AstObject */
   const char *key;        /* Pointer to key string to use */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */
   int itab;               /* Index of hash table element to use */
   int nel;                /* Number of elements in raw vector */
   int raw_type;           /* Data type of stored value */
   int result;             /* Returned flag */
   size_t raw_size;        /* Size of a single raw value */
   unsigned long hash;     /* Full width hash value */
   void *raw;              /* Pointer to stored value */

/* Initialise */
   result = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapGetElemA",
                     status );

/* Use the hash function to determine the element of the hash table in
   which the key will be stored. */
   itab = HashFun( key, this->mapsize - 1, &hash, status );

/* Search the relevent table entry for the required MapEntry. */
   mapentry = SearchTableEntry( this, itab, key, status );

/* Skip rest if the key was not found. */
   if( mapentry ) {
      result = 1;

/* Get the address of the first raw value, and its data type. Also get
   the size of each element of the vector. */
      nel = mapentry->nel;
      raw_type = mapentry->type;
      if( raw_type == AST__INTTYPE ){
         raw_size = sizeof( int );
         if( nel == 0 ) {
            raw = &( ((Entry0I *)mapentry)->value );
         } else {
            raw = ((Entry1I *)mapentry)->value;
         }

      } else if( raw_type == AST__SINTTYPE ){
         raw_size = sizeof( short int );
         if( nel == 0 ) {
            raw = &( ((Entry0S *)mapentry)->value );
         } else {
            raw = ((Entry1S *)mapentry)->value;
         }

      } else if( raw_type == AST__BYTETYPE ){
         raw_size = sizeof( unsigned char );
         if( nel == 0 ) {
            raw = &( ((Entry0B *)mapentry)->value );
         } else {
            raw = ((Entry1B *)mapentry)->value;
         }

      } else if( raw_type == AST__DOUBLETYPE ){
         raw_size = sizeof( double );
         if( nel == 0 ) {
            raw = &( ((Entry0D *)mapentry)->value );
         } else {
            raw = ((Entry1D *)mapentry)->value;
         }

      } else if( raw_type == AST__POINTERTYPE ){
         raw_size = sizeof( void * );
         if( nel == 0 ) {
            raw = &( ((Entry0P *)mapentry)->value );
         } else {
            raw = ((Entry1P *)mapentry)->value;
         }

      } else if( raw_type == AST__FLOATTYPE ){
         raw_size = sizeof( float );
         if( nel == 0 ) {
            raw = &( ((Entry0F *)mapentry)->value );
         } else {
            raw = ((Entry1F *)mapentry)->value;
         }

      } else if( raw_type == AST__STRINGTYPE ){
         raw_size = sizeof( const char * );
         if( nel == 0 ) {
            raw = &( ((Entry0C *)mapentry)->value );
         } else {
            raw = ((Entry1C *)mapentry)->value;
         }

      } else if( raw_type == AST__OBJECTTYPE ){
         raw_size = sizeof( AstObject * );
         if( nel == 0 ) {
            raw = &( ((Entry0A *)mapentry)->value );
         } else {
            raw = ((Entry1A *)mapentry)->value;
         }

      } else if( raw_type == AST__UNDEFTYPE ){
         raw = NULL;

      } else {
         raw_size = 0;
         raw = NULL;
         astError( AST__INTER, "astMapGetElemA(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   raw_type );
      }

/* Treat scalars as single-value vectors. */
      if( nel == 0 ) nel = 1;

/* Ensure the requested element is within the bounds of the vector */
      if( elem >= nel || elem < 0 ) {
         if( astOK ) {
            astError( AST__MPVIN, "astMapGetElemA(KeyMap): Illegal vector "
                      "index %d supplied for KeyMap entry '%s' - should be "
                      "in the range 1 to %d.", status, elem + 1, key, nel + 1 );
         }

/* Get a pointer to the requested raw value. */
      } else if( raw ){
         raw = (char *) raw + elem*raw_size;

/* Convert the value, storing the result in the supplied buffer. Report an
   error if conversion is not possible. */
         if( !ConvertValue( raw, raw_type, &avalue, AST__OBJECTTYPE, status ) && astOK ){
            astError( AST__MPGER, "astMapGetElemA(%s): The value of "
                      "element %d of KeyMap key \"%s\" cannot be read using "
                      "the requested data type.", status,astGetClass( this ),
                      elem + 1, key );

/* If succesful, return an ID value for the Object. */
         } else {
            *value = avalue ? astMakeId( avalue ) : NULL;
         }
      }

/* If the KeyError attribute is non-zero, report an error if the key is not
   found */
   } else if( astGetKeyError( this ) && astOK ) {
      astError( AST__MPKER, "astMapGetElemA(%s): No value was found for "
                "%s in the supplied KeyMap.", status, astGetClass( this ),
                key );
   }

/* If an error occurred,return zero. */
   if( !astOK ) result = 0;

/* Return the result.*/
   return result;
}

static int MapHasKey( AstKeyMap *this, const char *skey, int *status ) {
/*
*++
*  Name:
c     astMapHasKey
f     AST_MAPHASKEY

*  Purpose:
*     Check if an entry with a given key exists in a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "keymap.h"
c     int astMapHasKey( AstKeyMap *this, const char *key )
f     RESULT = AST_MAPHASKEY( THIS, KEY, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function returns a flag indicating if the KeyMap contains an
*     entry with the given key.

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        The character string identifying the KeyMap entry. Trailing spaces are
*        ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Returned Value:
c     astMapHasKey()
f     AST_MAPHASKEY = LOGICAL
c        Non-zero if the key was found, and zero otherwise.
f        .TRUE. if the key was found, and .FALSE. otherwise.

*  Notes:
c     - A non-zero function value
f     - .TRUE.
*     is returned if the key exists but has an undefined value (that is,
*     the returned value does not depend on whether the entry has a
*     defined value or not).
*     - A function value of
c     zero
f     .FALSE.
*     will be returned if an error has already occurred, or if this
*     function should fail for any reason.

*--
*/

/* Local Variables: */
   AstMapEntry *mapentry;  /* Pointer to entry in linked list */
   const char *key;        /* Pointer to key string to use */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */
   int itab;               /* Index of hash table element to use */
   int result;             /* Returned value */
   unsigned long hash;     /* Full width hash value */

/* Initialise */
   result = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapHasKey",
                     status );

/* Use the hash function to determine the element of the hash table in
   which the key will be stored. */
   itab = HashFun( key, this->mapsize - 1, &hash, status );

/* Search the relevent table entry for the required MapEntry. */
   mapentry = SearchTableEntry( this, itab, key, status );

/* Set a non-zero return value if the key was found. */
   if( mapentry ) result = 1;

/* If an error has occurred, return zero. */
   if( !astOK ) result = 0;

/* Return the result. */
   return result;

}

static void MapRemove( AstKeyMap *this, const char *skey, int *status ) {
/*
*++
*  Name:
c     astMapRemove
f     AST_MAPREMOVE

*  Purpose:
*     Removed a named entry from a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "keymap.h"
c     void astMapRemove( AstKeyMap *this, const char *key )
f     CALL AST_MAPREMOVE( THIS, KEY, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
c     This function
f     This routine
*     removes a named entry from a KeyMap. It returns without action if the
*     KeyMap does not contain the specified key.

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        The character string identifying the value to be retrieved. Trailing
*        spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
f     STATUS = INTEGER (Given and Returned)
f        The global status.
*--
*/

/* Local Variables: */
   const char *key;        /* Pointer to key string to use */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */
   int itab;               /* Index of hash table element to use */
   unsigned long hash;     /* Full width hash value */

/* Check the global error status. */
   if ( !astOK ) return;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapRemove",
                     status );

/* Use the hash function to determine the element of the hash table in
   which the key will be stored. */
   itab = HashFun( key, this->mapsize - 1, &hash, status );

/* Search the relevent table entry for the required MapEntry and remove it. */
   (void) FreeMapEntry( RemoveTableEntry( this, itab, key, status ), status );
}

static void MapRename( AstKeyMap *this, const char *soldkey, const char *snewkey,
                       int *status ) {
/*
*++
*  Name:
c     astMapRename
f     AST_MAPRENAME

*  Purpose:
*     Rename an existing KeyMap entry.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "keymap.h"
c     void astMapRename( AstKeyMap *this, const char *oldkey, const char *newkey )
f     CALL AST_MAPRENAME( THIS, OLDKEY, NEWKEY, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
c     This function
f     This routine
*     associated a new key with an existing entry in a KeyMap. It returns
*     without action if the oldkey does not exist in the KeyMap.

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
c     oldkey
f     OLDKEY = CHARACTER * ( * ) (Given)
*        The character string identifying the entry to be renamed. Trailing
*        spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
c     newkey
f     NEKEY = CHARACTER * ( * ) (Given)
*        The new character string to associated with the renamed entry.
*        Trailing spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
f     STATUS = INTEGER (Given and Returned)
f        The global status.
*--
*/

/* Local Variables: */
   AstMapEntry *entry;     /* Pointer to the entry being renamed */
   AstMapEntry *oldent;    /* Pointer to old entry with new name */
   const char *oldkey;     /* Pointer to key string to use */
   char oldkeybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */
   const char *newkey;     /* Pointer to key string to use */
   char newkeybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */
   char *p;                /* Pointer to next key character */
   int itab;               /* Index of hash table element to use */
   int keylen;             /* Length of supplied key string */
   int there;              /* Did the entry already exist in the KeyMap? */
   unsigned long hash;     /* Full width hash value */

/* Check the global error status. */
   if ( !astOK ) return;

/* Convert the supplied keys to upper case if required. */
   oldkey = ConvertKey( this, soldkey, oldkeybuf, AST__MXKEYLEN + 1,
                        "astMapRename", status );
   newkey = ConvertKey( this, snewkey, newkeybuf, AST__MXKEYLEN + 1,
                        "astMapRename", status );

/* Do nothing if the keys are the same. */
   if( strcmp( oldkey, newkey ) ){

/* Use the hash function to determine the element of the hash table in
   which the old key will be stored. */
      itab = HashFun( oldkey, this->mapsize - 1, &hash, status );

/* Search the relevent table entry for the required MapEntry. Remove it
   from the list, but do not free it. */
      entry = RemoveTableEntry( this, itab, oldkey, status );

/* Skip rest if the key was not found. */
      if( entry ) {

/* Store the new key string, and terminate it to exclude any trailing
   spaces. */
         keylen = strlen( newkey );
         entry->key = astStore( (void *) entry->key, newkey, keylen + 1 );
         if( astOK ) {
            p = (char *) entry->key + keylen;
            while( --p >= entry->key ) {
               if( *p == ' ' ) {
                  *p = 0;
               } else {
                  break;
               }
            }
         }

/* Use the hash function to determine the element of the hash table in
   which to store the entry with its new key. */
         itab = HashFun( entry->key, this->mapsize - 1, &(entry->hash), status );

/* Remove and free any existing entry with the given key from the table
   element. */
         oldent = RemoveTableEntry( this, itab, entry->key, status );
         if( oldent ) {
            oldent = FreeMapEntry( oldent, status );
            there = 1;
         } else {
            there = 0;
         }

/* If the KeyMap is locked we report an error if an attempt is made to
   introduce a new key. */
         if( !there && astGetMapLocked( this ) ) {
            astError( AST__BADKEY, "astMapRename(%s): Failed to rename item "
                      "\"%s\" in a KeyMap to \"%s\": \"%s\" is not a known "
                      "item.", status, astGetClass( this ), oldkey, newkey,
                      newkey );
         }

/* If all has gone OK, store the renamed entry at the head of the linked list
   associated with the selected table entry. */
         if( astOK ) {
            entry = AddTableEntry( this, itab, entry, status );

/* If anything went wrong, try to delete the renamed entry. */
         } else {
            entry = FreeMapEntry( entry, status );
         }
      }
   }
}

static int MapSize( AstKeyMap *this, int *status ) {
/*
*++
*  Name:
c     astMapSize
f     AST_MAPSIZE

*  Purpose:
*     Get the number of entries in a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "keymap.h"
c     int astMapSize( AstKeyMap *this )
f     RESULT = AST_MAPSIZE( THIS, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function returns the number of entries in a KeyMap.

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Returned Value:
c     astMapSize()
f     AST_MAPSIZE = INTEGER
*        The number of entries in the KeyMap.

*  Notes:
*     - A function value of zero will be returned if an error has already
*     occurred, or if this function should fail for any reason.

*--
*/

/* Local Variables: */
   int itab;               /* Index of hash table element to use */
   int result;             /* Returned value */

/* Initialise */
   result = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Add up the number of entries in all elements of the hash table. */
   for( itab = 0; itab < this->mapsize; itab++ ) result += this->nentry[ itab ];

/* Return the result. */
   return result;

}

static int MapLenC( AstKeyMap *this, const char *skey, int *status ) {
/*
*++
*  Name:
c     astMapLenC
f     AST_MAPLENC

*  Purpose:
*     Get the number of characters in a character entry in a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "keymap.h"
c     int astMapLenC( AstKeyMap *this, const char *key )
f     RESULT = AST_MAPLENC( THIS, KEY, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function returns the minimum length which a character variable
*     which must have in order to be able to store a specified entry in
*     the supplied KeyMap. If the named entry is a vector entry, then the
*     returned value is the length of the longest element of the vector
*     value.

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        The character string identifying the KeyMap entry. Trailing
*        spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Returned Value:
c     astMapLenC()
f     AST_MAPLENC = INTEGER
*        The length (i.e. number of characters) of the longest formatted
*        value associated with the named entry.
c        This does not include the trailing null character.

*  Notes:
*     - A function value of zero will be returned without error if the
*     named entry cannot be formatted as a character string.
*     - A function value of zero will be returned if an error has already
*     occurred, or if this function should fail for any reason.

*--
*/

/* Local Variables: */
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */
   const char *key;        /* Pointer to key string to use */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */
   int i;                  /* Element index */
   int itab;               /* Index of hash table element to use */
   int l;                  /* Length of formatted vector element */
   int nel;                /* Number of elements in raw vector */
   int raw_type;           /* Data type of stored value */
   int result;             /* Returned value */
   size_t raw_size;        /* Size of a single raw value */
   unsigned long hash;     /* Full width hash value */
   void *raw;              /* Pointer to stored value */

/* Initialise */
   result = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapLenC",
                     status );

/* Use the hash function to determine the element of the hash table in
   which the key will be stored. */
   itab = HashFun( key, this->mapsize - 1, &hash, status );

/* Search the relevent table entry for the required MapEntry. */
   mapentry = SearchTableEntry( this, itab, key, status );

/* Skip rest if the key was not found. */
   if( mapentry ) {

/* Get the address of the first raw value, and its data type. Also get
   the size of each element of the vector. */
      nel = mapentry->nel;
      raw_type = mapentry->type;
      if( raw_type == AST__INTTYPE ){
         raw_size = sizeof( int );
         if( nel == 0 ) {
            raw = &( ((Entry0I *)mapentry)->value );
         } else {
            raw = ((Entry1I *)mapentry)->value;
         }

      } else if( raw_type == AST__POINTERTYPE ){
         raw_size = sizeof( void * );
         if( nel == 0 ) {
            raw = &( ((Entry0P *)mapentry)->value );
         } else {
            raw = ((Entry1P *)mapentry)->value;
         }

      } else if( raw_type == AST__DOUBLETYPE ){
         raw_size = sizeof( double );
         if( nel == 0 ) {
            raw = &( ((Entry0D *)mapentry)->value );
         } else {
            raw = ((Entry1D *)mapentry)->value;
         }

      } else if( raw_type == AST__SINTTYPE ){
         raw_size = sizeof( short int );
         if( nel == 0 ) {
            raw = &( ((Entry0S *)mapentry)->value );
         } else {
            raw = ((Entry1S *)mapentry)->value;
         }

      } else if( raw_type == AST__BYTETYPE ){
         raw_size = sizeof( unsigned char );
         if( nel == 0 ) {
            raw = &( ((Entry0B *)mapentry)->value );
         } else {
            raw = ((Entry1B *)mapentry)->value;
         }

      } else if( raw_type == AST__FLOATTYPE ){
         raw_size = sizeof( float );
         if( nel == 0 ) {
            raw = &( ((Entry0F *)mapentry)->value );
         } else {
            raw = ((Entry1F *)mapentry)->value;
         }

      } else if( raw_type == AST__STRINGTYPE ){
         raw_size = sizeof( const char * );
         if( nel == 0 ) {
            raw = &( ((Entry0C *)mapentry)->value );
         } else {
            raw = ((Entry1C *)mapentry)->value;
         }

      } else if( raw_type == AST__OBJECTTYPE ){
         raw_size = sizeof( AstObject * );
         if( nel == 0 ) {
            raw = &( ((Entry0A *)mapentry)->value );
         } else {
            raw = ((Entry1A *)mapentry)->value;
         }

      } else if( raw_type == AST__UNDEFTYPE ){
         raw_size = 0;
         raw = NULL;

      } else {
         raw_size = 0;
         raw = NULL;
         astError( AST__INTER, "astMapLenC(KeyMap): Illegal map entry data "
                   "type %d encountered (internal AST programming error).", status,
                   raw_type );
      }

/* Treat scalars as single-value vectors. */
      if( nel == 0 ) nel = 1;

/* Skip undefined values. */
      if( raw ) {

/* Initialise the maximum length of any formatted value in the entry. */
         result= 0;

/* Loop round all values in the vector. */
         for( i = 0; i < nel && astOK; i++ ) {

/* Go through the motions of formatting the value. We do not actually
   need the formatted string (just its length) so we provide a NULL pointer
   for the output buffer. The entry is ignored if it cannot be formatted.
   Note, the length returned by ConvertValue includes the terminating null,
   so decrement it first. */
            l = ConvertValue( raw, raw_type, NULL, AST__STRINGTYPE, status );
            if( --l > result ) result = l;

/* Increment the pointer to the next raw value. */
            raw = (char *) raw + raw_size;
         }
      }
   }

/* If an error has occurred, return zero. */
   if( !astOK ) result = 0;

/* Return the result. */
   return result;

}

static int MapLength( AstKeyMap *this, const char *skey, int *status ) {
/*
*++
*  Name:
c     astMapLength
f     AST_MAPLENGTH

*  Purpose:
*     Get the vector length of an entry in a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "keymap.h"
c     int astMapLength( AstKeyMap *this, const char *key )
f     RESULT = AST_MAPLENGTH( THIS, KEY, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function returns the vector length of a named entry in a KeyMap,
*     (that is, how many values are associated with the entry).

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        The character string identifying the KeyMap entry. Trailing
*        spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Returned Value:
c     astMapLength()
f     AST_MAPLENGTH = INTEGER
*        The length of the entry. One for a scalar, greater than one for
*        a vector. A value of zero is returned if the KeyMap does not
*        contain the named entry.

*  Notes:
*     - A function value of zero will be returned if an error has already
*     occurred, or if this function should fail for any reason.

*--
*/

/* Local Variables: */
   AstMapEntry *mapentry;  /* Pointer to entry in linked list */
   const char *key;        /* Pointer to key string to use */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */
   int itab;               /* Index of hash table element to use */
   int result;             /* Returned value */
   unsigned long hash;     /* Full width hash value */

/* Initialise */
   result = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapLength",
                     status );

/* Use the hash function to determine the element of the hash table in
   which the key will be stored. */
   itab = HashFun( key, this->mapsize - 1, &hash, status );

/* Search the relevent table entry for the required MapEntry. */
   mapentry = SearchTableEntry( this, itab, key, status );

/* Skip rest if the key was not found. */
   if( mapentry ) {

/* Store the netry length */
      result = mapentry->nel;

/* Return 1 for a scalar. */
      if( result == 0 ) result = 1;

   }

/* If an error has occurred, return zero. */
   if( !astOK ) result = 0;

/* Return the result. */
   return result;

}

/*
*++
*  Name:
c     astMapPutElem<X>
f     AST_MAPPUTELEM<X>

*  Purpose:
*     Put a value into an element of a vector value in a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "ast.h"
c     void astMapPutElem<X>( AstKeyMap *this, const char *key, int elem,
c                            <X>type *value )
f     CALL AST_MAPPUTELEM<X>( THIS, KEY, ELEM, VALUE, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This is a set of functions for storing a value in a single element of
*     a vector value in a KeyMap. You should replace <X> in the generic
*     function name
c     astMapPutElem<X>
f     AST_MAPPUTELEM<X>
*     by an appropriate 1-character type code (see the "Data Type Codes"
*     section below for the code appropriate to each supported data type).
*     The supplied value is converted from the data type indicated by <X>
*     to the data type of the KeyMap entry before being stored (an error
*     is reported if it is not possible to convert the value to the
*     required data type).

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        The character string identifying the value to be retrieved. Trailing
*        spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
c     elem
f     ELEM = INTEGER (Given)
*        The index of the vector element to modify, starting at
c        zero.
f        one.
c     value
f     VALUE = <X>type (Given)
*        The value to store.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Applicability:
*     KeyMap
*        If the
c        "elem"
f        ELEM
*        index is outside the range of the vector, the length of
*        the vector will be increased by one element and the supplied
*        value will be stored at the end of the vector in the new element.
*     Table
*        If the
c        "elem"
f        ELEM
*        index is outside the range of the vector, an error will be
*        reported. The number of elements in each cell of a column is
*        specified when the column is created using
c        astAddColumn.
f        AST_ADDCOLUMN.

*  Notes:
*     - If the entry originally holds a scalar value, it will be treated
*     like a vector entry of length 1.
*     - If the specified key cannot be found in the given KeyMap, or is
*     found but has an undefined value, a new
*     vector entry with the given name, and data type implied by <X>, is
*     created and the supplied value is stored in its first entry.

*  Data Type Codes:
*     To select the appropriate
c     function, you should replace <X> in the generic function name
c     astMapPutElem<X>
f     routine, you should replace <X> in the generic routine name
f     AST_MAPPUTELEM<X>
*     with a 1-character data type code, so as to match the data type <X>type
*     of the data you are processing, as follows:
c     - D: double
c     - F: float
c     - I: int
c     - C: "const" pointer to null terminated character string
c     - A: Pointer to AstObject
c     - P: Generic "void *" pointer
c     - S: short int
c     - B: Unsigned byte (i.e. char)
f     - D: DOUBLE PRECISION
f     - R: REAL
f     - I: INTEGER
f     - C: CHARACTER
f     - A: INTEGER used to identify an AstObject
f     - S: INTEGER*2 (short integer)
f     - B: BYTE (unsigned)
*
c     For example, astMapPutElemD would be used to put a "double" value, while
c     astMapPutElemI would be used to put an "int" value, etc. For D or I, the
c     supplied "value" parameter should be a double or int. For
c     C, the supplied "value" parameter should be a pointer to a character
c     string. For A, the supplied "value" parameter should be an AstObject
c     pointer.
f     For example, AST_MAPPUTELEMD would be used to put a DOUBLE PRECISION
f     value, while AST_MAPPUTELEMI would be used to put an INTEGER value, etc.

*--
*/
/* Define a macro to implement the function for a specific data type
(excluding "C" since that needs an extra parameter). */
#define MAKE_MAPPUTELEM(X,Xtype,Itype) \
static void MapPutElem##X( AstKeyMap *this, const char *skey, int elem, \
                           Xtype value, int *status ) { \
\
/* Local Variables: */ \
   AstMapEntry *mapentry;  /* Pointer to parent MapEntry structure */ \
   const char *key;        /* Pointer to key string to use */ \
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */ \
   int itab;               /* Index of hash table element to use */ \
   int nel;                /* Number of elements in raw vector */ \
   int new;                /* Was a new uninitialised element created? */ \
   int raw_type;           /* Data type of stored value */ \
   size_t raw_size;        /* Size of a single raw value */ \
   unsigned long hash;     /* Full width hash value */ \
   void *raw;              /* Pointer to stored value */ \
\
/* Check the global error status. */ \
   if ( !astOK ) return; \
\
/* Perform any necessary checks on the supplied value to be stored. */ \
   CHECK_##X \
\
/* Convert the supplied key to upper case if required. */ \
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapPutElem" #X, \
                     status ); \
\
/* Use the hash function to determine the element of the hash table in \
   which the key will be stored. */ \
   itab = HashFun( key, this->mapsize - 1, &hash, status ); \
\
/* Search the relevent table entry for the required MapEntry. */ \
   mapentry = SearchTableEntry( this, itab, key, status ); \
\
/* If the key was not found, or was found but has an undefined value, create \
   a new one with a single element, \
   and store the supplied value in it. */ \
   if( !mapentry || mapentry->type == AST__UNDEFTYPE ) { \
      astMapPut1##X( this, key, 1, &value, NULL ); \
\
/* If the key was found.... */ \
   } else { \
\
/* Get the current length of the vector (0=>scalar), and the data type. */ \
      nel = mapentry->nel; \
      raw_type = mapentry->type; \
\
/* Do each data type in turn. */ \
      if( raw_type == AST__INTTYPE ){ \
\
/* If the existing entry is scalar, create a new vector entry with the \
   same name, value, data type and comment. Then get a pointer to the new \
   entry, and indicate that we now have a vector entry of length 1. */ \
         if( nel == 0 ) { \
            astMapPut1I( this, key, 1, &( ((Entry0I *)mapentry)->value ), \
                         mapentry->comment ); \
            mapentry = SearchTableEntry( this, itab, key, status ); \
            nel = 1; \
         } \
\
/* Get the address of the first raw value in the vector. Also get \
   the size of each element of the vector. */ \
         raw = ((Entry1I *)mapentry)->value; \
         raw_size = sizeof( int ); \
\
/* Handle other data type in the same way. */ \
      } else if( raw_type == AST__SINTTYPE ){ \
         if( nel == 0 ) { \
            astMapPut1S( this, key, 1, &( ((Entry0S *)mapentry)->value ), \
                         mapentry->comment ); \
            mapentry = SearchTableEntry( this, itab, key, status ); \
            nel = 1; \
         } \
         raw = ((Entry1S *)mapentry)->value; \
         raw_size = sizeof( short int ); \
\
      } else if( raw_type == AST__BYTETYPE ){ \
         if( nel == 0 ) { \
            astMapPut1B( this, key, 1, &( ((Entry0B *)mapentry)->value ), \
                         mapentry->comment ); \
            mapentry = SearchTableEntry( this, itab, key, status ); \
            nel = 1; \
         } \
         raw = ((Entry1B *)mapentry)->value; \
         raw_size = sizeof( unsigned char ); \
\
      } else if( raw_type == AST__DOUBLETYPE ){ \
         if( nel == 0 ) { \
            astMapPut1D( this, key, 1, &( ((Entry0D *)mapentry)->value ), \
                         mapentry->comment ); \
            mapentry = SearchTableEntry( this, itab, key, status ); \
            nel = 1; \
         } \
         raw = ((Entry1D *)mapentry)->value; \
         raw_size = sizeof( double ); \
\
      } else if( raw_type == AST__POINTERTYPE ){ \
         if( nel == 0 ) { \
            astMapPut1P( this, key, 1, &( ((Entry0P *)mapentry)->value ), \
                         mapentry->comment ); \
            mapentry = SearchTableEntry( this, itab, key, status ); \
            nel = 1; \
         } \
         raw = ((Entry1P *)mapentry)->value; \
         raw_size = sizeof( void * ); \
\
      } else if( raw_type == AST__FLOATTYPE ){ \
         if( nel == 0 ) { \
            astMapPut1F( this, key, 1, &( ((Entry0F *)mapentry)->value ), \
                         mapentry->comment ); \
            mapentry = SearchTableEntry( this, itab, key, status ); \
            nel = 1; \
         } \
         raw = ((Entry1F *)mapentry)->value; \
         raw_size = sizeof( float ); \
\
      } else if( raw_type == AST__STRINGTYPE ){ \
         if( nel == 0 ) { \
            astMapPut1C( this, key, 1, &( ((Entry0C *)mapentry)->value ), \
                         mapentry->comment ); \
            mapentry = SearchTableEntry( this, itab, key, status ); \
            nel = 1; \
         } \
         raw = ((Entry1C *)mapentry)->value; \
         raw_size = sizeof( const char * ); \
\
      } else if( raw_type == AST__OBJECTTYPE ){ \
         if( nel == 0 ) { \
            astMapPut1A( this, key, 1, &( ((Entry0A *)mapentry)->value ), \
                         mapentry->comment ); \
            mapentry = SearchTableEntry( this, itab, key, status ); \
            nel = 1; \
         } \
         raw = ((Entry1A *)mapentry)->value; \
         raw_size = sizeof( AstObject * ); \
\
      } else { \
         raw_size = 0; \
         raw = NULL; \
         astError( AST__INTER, "astMapPutElem<X>(KeyMap): Illegal map entry " \
                   "data type %d encountered (internal AST programming " \
                   "error).", status, raw_type ); \
      } \
\
/* If the requested element is outside the bounds of the vector, extend \
   the vector by one element. */ \
      new = ( elem >= nel || elem < 0 ); \
      if( new ) { \
         elem = nel++; \
         raw = astGrow( raw, nel, raw_size ); \
         if( astOK ) { \
            mapentry->nel = nel; \
            if( raw_type == AST__INTTYPE ){ \
               ((Entry1I *)mapentry)->value = (int *) raw; \
            } else if( raw_type == AST__SINTTYPE ){ \
               ((Entry1S *)mapentry)->value = (short int *) raw; \
            } else if( raw_type == AST__BYTETYPE ){ \
               ((Entry1B *)mapentry)->value = (unsigned char *) raw; \
            } else if( raw_type == AST__DOUBLETYPE ){ \
               ((Entry1D *)mapentry)->value = (double *) raw; \
            } else if( raw_type == AST__POINTERTYPE ){ \
               ((Entry1P *)mapentry)->value = (void *) raw; \
            } else if( raw_type == AST__FLOATTYPE ){ \
               ((Entry1F *)mapentry)->value = (float *) raw; \
            } else if( raw_type == AST__STRINGTYPE ){ \
               ((Entry1C *)mapentry)->value = (const char **) raw; \
            } else if( raw_type == AST__OBJECTTYPE ){ \
               ((Entry1A *)mapentry)->value = (AstObject **) raw; \
            } \
         } \
      } \
\
/* Get a pointer to the requested element. */ \
      if( astOK ) { \
         raw = (char *) raw + elem*raw_size; \
\
/* Free any memory used by the value already in the requested element. */ \
         if( ! new ) { \
            if( raw_type == AST__STRINGTYPE ){ \
               char **cp = (char **) raw; \
               *cp = astFree( *cp ); \
            } else if( raw_type == AST__OBJECTTYPE ){ \
               AstObject **op = (AstObject **) raw; \
               if( *op ) *op = astAnnul( *op ); \
            } \
         } \
\
/* Convert the supplied value, storing the result in the requested element. \
   Report an error if conversion is not possible. */ \
         if( !ConvertValue( &value, Itype, raw, raw_type, status ) && astOK ){ \
            astError( AST__MPPER, "astMapPutElem" #X "(%s): The supplied " \
                      "value cannot be converted to the data type of " \
                      "KeyMap key \"%s\".", status, astGetClass( this ), \
                      key ); \
         } \
      } \
   } \
}

/* Define macros which perform any necessary checks on the supplied value
   to be stored. For Object entries, check that we are not adding a KeyMap
   which already contains "this". This avoids circular dependencies.
   Other types do not need any checks. */
#define CHECK_A CheckCircle( this, value, "astMapPutElemA", status );
#define CHECK_I
#define CHECK_B
#define CHECK_S
#define CHECK_D
#define CHECK_F
#define CHECK_C
#define CHECK_P

/* Expand the above macro to generate a function for each required
   data type. */
MAKE_MAPPUTELEM(I,int,AST__INTTYPE)
MAKE_MAPPUTELEM(D,double,AST__DOUBLETYPE)
MAKE_MAPPUTELEM(F,float,AST__FLOATTYPE)
MAKE_MAPPUTELEM(A,AstObject *,AST__OBJECTTYPE)
MAKE_MAPPUTELEM(P,void *,AST__POINTERTYPE)
MAKE_MAPPUTELEM(C,const char *,AST__STRINGTYPE)
MAKE_MAPPUTELEM(S,short int,AST__SINTTYPE)
MAKE_MAPPUTELEM(B,unsigned char,AST__BYTETYPE)

/* Undefine the macro. */
#undef MAKE_MAPPUTELEM
#undef CHECK_A
#undef CHECK_I
#undef CHECK_B
#undef CHECK_S
#undef CHECK_D
#undef CHECK_F
#undef CHECK_C
#undef CHECK_P


static int MapType( AstKeyMap *this, const char *skey, int *status ) {
/*
*++
*  Name:
c     astMapType
f     AST_MAPTYPE

*  Purpose:
*     Get the data type of an entry in a KeyMap.

*  Type:
*     Public virtual function.

*  Synopsis:
c     #include "keymap.h"
c     int astMapType( AstKeyMap *this, const char *key )
f     RESULT = AST_MAPTYPE( THIS, KEY, STATUS )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function returns a value indicating the data type of a
*     named entry in a KeyMap. This is the data type which was used when the
*     entry was added to the KeyMap.

*  Parameters:
c     this
f     THIS = INTEGER (Given)
*        Pointer to the KeyMap.
c     key
f     KEY = CHARACTER * ( * ) (Given)
*        The character string identifying the KeyMap entry. Trailing
*        spaces are ignored.
*        The supplied string is converted to upper case before use if the
*        KeyCase attribute is currently set to zero.
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Returned Value:
c     astMapType()
f     AST_MAPTYPE = INTEGER
*        One of AST__INTTYPE (for integer), AST__SINTTYPE (for
c        short int),
f        INTEGER*2),
*        AST__BYTETYPE (for unsigned bytes
c        - i.e. unsigned chars
*        ) AST__DOUBLETYPE (for double
*        precision floating point), AST__FLOATTYPE (for single
*        precision floating point), AST__STRINGTYPE (for character string),
*        AST__OBJECTTYPE (for AST Object pointer), AST__POINTERTYPE (for
*        arbitrary C pointer) or AST__UNDEFTYPE (for undefined values
*        created by
c        astMapPutU).
f        AST_MAPPUTU).
*        AST__BADTYPE is returned if the supplied key is not found in the KeyMap.

*  Notes:
*     - A function value of AST__BADTYPE will be returned if an error has
*     already occurred, or if this function should fail for any reason.

*--
*/

/* Local Variables: */
   AstMapEntry *mapentry;  /* Pointer to entry in linked list */
   const char *key;        /* Pointer to key string to use */
   char keybuf[ AST__MXKEYLEN + 1 ]; /* Buffer for upper cas key */
   int itab;               /* Index of hash table element to use */
   int result;             /* Returned value */
   unsigned long hash;     /* Full width hash value */

/* Initialise */
   result = AST__BADTYPE;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Convert the supplied key to upper case if required. */
   key = ConvertKey( this, skey, keybuf, AST__MXKEYLEN + 1, "astMapType",
                     status );

/* Use the hash function to determine the element of the hash table in
   which the key will be stored. */
   itab = HashFun( key, this->mapsize - 1, &hash, status );

/* Search the relevent table entry for the required MapEntry. */
   mapentry = SearchTableEntry( this, itab, key, status );

/* Store the type if found. */
   if( mapentry ) result = mapentry->type;

/* If an error has occurred, return zero. */
   if( !astOK ) result = AST__BADTYPE;

/* Return the result. */
   return result;

}

static const char *MapIterate( AstKeyMap *this, int reset, int *status ) {
/*
*+
*  Name:
*     astMapIterate

*  Purpose:
*     Iterate through the keys in a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     const char *astMapIterate( AstKeyMap *this, int reset, int *status )

*  Class Membership:
*     KeyMap method.

*  Description:
*     If "reset" is non-zero, this function returns a pointer to a string
*     holding the first key in the KeyMap. On subsequent invocation (if
*     reset is zero) it returns a pointer to the next key in the KeyMap. The
*     context is stored within the KeyMap structure, so calls on different
*     KeyMaps can be mixed.
*
*     The order in which keys are returned is determined by the KeyMap
*     SortBy attribute.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     reset
*        If non-zero, return the first key in the KeyMap. Otherwise,
*        returns the key following the one returned by the previous
*        invocation of this function.

*  Returned Value:
*        A pointer to the null-terminated string holding the next key,
*        or NULL if there are no more keys in the KeyMap. The returned
*        string should NOT be freed or modified.

*  Notes:
*     - A NULL pointer will be returned if this function is invoked
*     with the AST error status set, or if it should fail for any
*     reason.
*/

/* Local Variables: */
   AstMapEntry *entry;         /* Pointer to the entry */
   const char *key;            /* Pointer value to return */
   int itab;                   /* Index into hash table */
   int sortby;                 /* The value of the SortBy attribute */

/* Initialise. */
   key = NULL;

/* Check the global error status. */
   if ( !astOK ) return key;

/* Get the SortBy value. */
   sortby = astGetSortBy( this );

/* First deal with unsorted keys. */
   if( sortby == SORTBY_NONE ) {

/* Get the index of the hash table to check first. Also get a pointer to
   the entry within the hash table to check next. */
      if( reset ){
         itab = 0;
         entry = this->table[ 0 ];
      } else {
         itab = this->iter_itab;
         entry = this->iter_entry;
      }

/* Move through elements of the hash table until we have a non-null entry. */
      while( !entry && ++itab < this->mapsize ) {
         entry = this->table[ itab ];
      }

/* Return a pointer to the key. */
      if( entry ) {
         key = entry->key;

/* Move on to the next entry in the unsorted linked list, saving the context
   in the KeyMap structure. */
         this->iter_itab = itab;
         this->iter_entry = entry->next;
      }

/* Now deal with sorted keys. */
   } else {

/* If starting from the beginning, use the "first" entry. Otherwise, use
   the nxt entry. */
      if( reset ) {
         entry = this->first;
      } else {
         entry = this->iter_entry;
      }

/* If we have an entry, return a pointer to its key, and then update the
   context to point to the next entry in the *sorted* list. */
      if( entry ) {
         key = entry->key;
         this->iter_entry = entry->snext;
      }
   }

/* If no more entries were found, reset the context in the KeyMap
   structure. */
   if( ! key ) {
      this->iter_itab = 0;
      this->iter_entry = NULL;
   }

/* Return the result.*/
   return key;
}

static void NewTable( AstKeyMap *this, int size, int *status ){
/*
*  Name:
*     NewTable

*  Purpose:
*     Create a new hash table.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void NewTable( AstKeyMap *this, int size, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function removes any existing hash table and allocates memory
*     for a new one of the specified size (except that the supplied size
*     is modified to be the next higher power of 2). The table is
*     initialised to indicate that it is empty.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     size
*        The reuqired size of the hash table.
*     status
*        Pointer to the inherited status variable.

*/

/* Local Variables: */
   int i;

/* Check the global error status. */
   if ( !astOK ) return;

/* Ensure the table size is at least MIN_TABLE_SIZE and is a power of 2. */
   if( size <= MIN_TABLE_SIZE ) {
      size = MIN_TABLE_SIZE;
   } else {
      size = (int) ( 0.5 + pow( 2.0, ceil( log( size )/log( 2.0 ) ) ) );
   }

/* Remove any existing entries. */
   for( i = 0; i < this->mapsize; i++ ) FreeTableEntry( this, i, status );

/* Do nothing more if the table size is not changing. */
   if( size != this->mapsize ) {

/* Modify the size of the existing table. */
      this->mapsize = size;
      this->table = astGrow( this->table, size, sizeof( AstMapEntry * ) );
      this->nentry = astGrow( this->nentry, size, sizeof( int ) );

/* Initialise the new table. */
      if( astOK ) {
         for( i = 0; i < size; i++ ) {
            this->table[ i ] = NULL;
            this->nentry[ i ] = 0;
         }
      }
   }
}

static void RemoveFromObjectList( AstKeyMap *this, AstMapEntry *entry,
                                  int *status ){
/*
*  Name:
*     RemoveFromObjectList

*  Purpose:
*     Remove an entry from the linked-list of AST__OBJECTTYPE entries.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void RemoveFromObjectList( AstKeyMap *this, AstMapEntry *entry,
*                                int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function removes the supplied MapEntry from the linked list of
*     AST__OBJECTTYPE entries.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     entry
*        Pointer to the MapEntry to be removed.
*     status
*        Pointer to the inherited status variable.

*/

/* Local Variables: */
   AstMapEntry *a;          /* Previous entry */
   AstMapEntry *b;          /* Next entry */
   Entry0A *scalar;         /* Pointer to a scalar AST__OBJECTTYPE entry */
   Entry1A *vector;         /* Pointer to a vector AST__OBJECTTYPE entry */

/* Check the global error status. */
   if ( !astOK ) return;

/* Do nothing if the entry does not hold AST Object pointers. */
   if( entry->type == AST__OBJECTTYPE ) {

/* Get pointers to the MapEntries before and after the entry being
   removed. At the same time, nullify both pointers in the entry itself. */
      if( entry->nel == 0 ) {
         scalar = (Entry0A *) entry;
         a = scalar->prev;
         b = scalar->next;
         scalar->prev = NULL;
         scalar->next = NULL;
      } else {
         vector = (Entry1A *) entry;
         a = vector->prev;
         b = vector->next;
         vector->prev = NULL;
         vector->next = NULL;
      }

/* Set the forward link in the previous entry. */
      if( a ) {
         if( a->nel == 0 ) {
            scalar = (Entry0A *) a;
            scalar->next = b;
         } else {
            vector = (Entry1A *) a;
            vector->next = b;
         }

/* If we are removing the list head, store the following entry as the new head. */
      } else {
         this->firstA = b;
      }

/* Set the backward link in the next entry. */
      if( b ) {
         if( b->nel == 0 ) {
            scalar = (Entry0A *) b;
            scalar->prev = a;
         } else {
            vector = (Entry1A *) b;
            vector->prev = a;
         }
      }
   }
}

static void RemoveFromSortedList( AstKeyMap *this, AstMapEntry *entry,
                                  int *status ){
/*
*  Name:
*     RemoveFromSortedList

*  Purpose:
*     Remove an entry from the linked-list of sorted KeyMap entries.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void RemoveFromSortedList( AstKeyMap *this, AstMapEntry *entry,
*                                int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function removes the supplied MapEntry from the linked list of
*     sorted MapEntries.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     entry
*        Pointer to the MapEntry to be removed.
*     status
*        Pointer to the inherited status variable.

*/

/* Local Variables: */
   AstMapEntry *next;       /* Next higher MapEntry */
   AstMapEntry *prev;       /* Next lower MapEntry */

/* Check the global error status. */
   if ( !astOK ) return;

/* Get pointers to the entries on either side of the entry to be removed. */
   next = entry->snext;
   prev = entry->sprev;

/* If the entry is not in the sorted list, abort. */
   if( next && prev ) {

/* Connect the previous to the next, bypassing the entry being removed. */
      next->sprev = prev;
      prev->snext = next;

/* NULLify the next and previous entries stored in the entry being
   removed. */
      entry->snext = NULL;
      entry->sprev = NULL;

/* Decrement the number of entries in the sorted list. */
      (this->nsorted)--;

/* If the entry being removed is the first entry, store a pointer to the new
   first entry. */
      if( this->nsorted == 0 ) {
         this->first = NULL;
      } else if( entry == this->first ) {
         this->first = next;
      }
   }
}

static AstMapEntry *RemoveTableEntry( AstKeyMap *this, int itab,
                                      const char *key, int *status ){
/*
*  Name:
*     RemoveTableEntry

*  Purpose:
*     Remove an entry from a linked-list of KeyMap entries.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     AstMapEntry *RemoveTableEntry( AstKeyMap *this, int itab,
*                                    const char *key, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function removes any entries with the specified key from the
*     linked-list of entries stored at the specified entry of the hash
*     table. If the supplied key is found in the list, a pointer to the
*     first removed entry is returned. Otherwise, a NULL pointer is returned.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     itab
*        Index of the hash table element to be searched.
*     key
*        The key string to be searched for. Trailing spaces are ignored.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     Pointer to the removed Entry, or NULL if no matching entry found.

*/

/* Local Variables: */
   AstMapEntry **link;    /* Address to store foward link */
   AstMapEntry *next;     /* Pointer to next Entry to copy */
   AstMapEntry *result;

/* Initialise */
   result = NULL;

/* Check the global error status. */
   if ( !astOK ) return result;

/* The "next" variable holds the address of the next MapEntry to be
   checked. Initialise this to the MapEntry at the head of the linked
   list associated with the supplied element of the hash table. */
   next = this->table[ itab ];

/* The "link" variable holds the address of the location at which the
   pointer to the MapEntry following the removed MapEntry should be stored.
   Initialise this to be the address of the hash table element. */
   link = &( this->table[ itab ] );

/* Loop round until we have checked all entries. */
   while( next && astOK ) {

/* If the key for the current entry macthes the supplied key... */
      if( !KeyCmp( next->key, key ) ) {

/* Remove the MapEntry from the list sorted by key. */
         RemoveFromSortedList( this, next, status );

/* If the entry is of type AST__OBJECTTYPE, remove it from the
   list of AST__OBJECTTYPE entries. */
         RemoveFromObjectList( this, next, status );

/* Store a pointer to the next MapEntry in the list, replacing the
   original pointer to the MapEntry which is being deleted. */
         *link = next->next;

/* Return a pointer to the first matching MapEntry. Free any subsequent
   matching MapEntries.  */
         if( result ) {
            FreeMapEntry( next, status );
         } else {
            result = next;
         }

/* Decrement the number of entries in the linked list. */
         this->nentry[ itab ]--;

/* Set up the next MapEntry to be freed. */
         next = *link;

/* If the key for the current entry does not match the supplied key... */
      } else {

/* Update the address at which to store the pointer to the next MapEntry
   in the list. */
         link = &(next->next);

/* Update the address of the next MapEntry in the list. */
         next = next->next;
      }
   }

/* Return the result */
   return result;
}

static AstMapEntry *SearchTableEntry( AstKeyMap *this, int itab, const char *key, int *status ){
/*
*  Name:
*     SearchTableEntry

*  Purpose:
*     Search an element of a has table for a given key.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     AstMapEntry *SearchTableEntry( AstKeyMap *this, int itab, const char *key, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function searches the specified element of the KeyMaps hash table
*     until an element is found which has a key matching the supplied key.
*     The address of this entry is returned. If no suitable entry is found,
*     then NULL is returned.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     itab
*        The index of the hash table to be searched.
*     key
*        The key string to be searched for. Trailing spaces are ignored.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     The address of the first MapEntry in the linked list which refers
*     to the given key, or NULL if the key is not found.

*/

/* Local Variables: */
   AstMapEntry *next;     /* Pointer to next Entry to check */
   AstMapEntry *result;   /* Returned pointer */

/* Initialise */
   result = NULL;

/* Check the global error status. */
   if ( !astOK ) return result;

/* The "next" variable holds the address of the next MapEntry to be
   checked. Initialise this to the supplied MapEntry. */
   next = this->table[ itab ];

/* Loop round until we have checked all entries. */
   while( next ) {

/* If the key for the current entry matches the supplied key, store the
   MapEntry pointer and break. */
      if( !KeyCmp( next->key, key ) ) {
         result = next;
         break;
      }

/* Update the address of the next MapEntry in the list. */
      next = next->next;

   }

/* Return the result. */
   return result;
}

static void SetAttrib( AstObject *this_object, const char *setting, int *status ) {
/*
*  Name:
*     SetAttrib

*  Purpose:
*     Set an attribute value for a KeyMap.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void SetAttrib( AstObject *this, const char *setting )

*  Class Membership:
*     KeyMap member function (over-rides the astSetAttrib protected
*     method inherited from the Mapping class).

*  Description:
*     This function assigns an attribute value for a KeyMap, the
*     attribute and its value being specified by means of a string of
*     the form:
*
*        "attribute= value "
*
*     Here, "attribute" specifies the attribute name and should be in
*     lower case with no white space present. The value to the right
*     of the "=" should be a suitable textual representation of the
*     value to be assigned and this will be interpreted according to
*     the attribute's data type.  White space surrounding the value is
*     only significant for string attributes.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     setting
*        Pointer to a null-terminated string specifying the new attribute
*        value.
*/

/* Local Variables: */
   AstKeyMap *this;             /* Pointer to the KeyMap structure */
   int ival;                    /* Attribute value */
   int len;                     /* Length of setting string */
   int nc;                      /* Number of characters read by astSscanf */

/* Check the global error status. */
   if ( !astOK ) return;

/* Obtain a pointer to the KeyMap structure. */
   this = (AstKeyMap *) this_object;

/* Obtain the length of the setting string. */
   len = (int) strlen( setting );

/* Test for each recognised attribute in turn, using "astSscanf" to parse
   the setting string and extract the attribute value (or an offset to
   it in the case of string values). In each case, use the value set
   in "nc" to check that the entire string was matched. Once a value
   has been obtained, use the appropriate method to set it. */

/* SizeGuess. */
/* ---------- */
   if ( nc = 0,
        ( 1 == astSscanf( setting, "sizeguess= %d %n", &ival, &nc ) )
        && ( nc >= len ) ) {
      astSetSizeGuess( this, ival );

/* KeyCase. */
/* --------- */
   } else if ( nc = 0,
        ( 1 == astSscanf( setting, "keycase= %d %n", &ival, &nc ) )
        && ( nc >= len ) ) {
      astSetKeyCase( this, ival );

/* KeyError. */
/* --------- */
   } else if ( nc = 0,
        ( 1 == astSscanf( setting, "keyerror= %d %n", &ival, &nc ) )
        && ( nc >= len ) ) {
      astSetKeyError( this, ival );

/* MapLocked. */
/* --------- */
   } else if ( nc = 0,
        ( 1 == astSscanf( setting, "maplocked= %d %n", &ival, &nc ) )
        && ( nc >= len ) ) {
      astSetMapLocked( this, ival );

/* SortBy. */
/* ------- */
   } else if ( nc = 0,
        ( 0 == astSscanf( setting, "sortby= %n%*s %n", &ival, &nc ) )
        && ( nc >= len ) ) {
      astSetSortBy( this, SortByInt( setting + ival, "astSetAttrib", status ) );

/* If the attribute is still not recognised, pass it on to the parent
   method for further interpretation. */
   } else {
      (*parent_setattrib)( this_object, setting, status );
   }
}

static void SetKeyCase( AstKeyMap *this, int keycase, int *status ) {
/*
*+
*  Name:
*     astSetKeyCase

*  Purpose:
*     Set the value of the KeyCase attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     void astSetKeyCase( AstKeyMap *this, int keycase )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function sets a new value for the KeyCase attribute of a
*     KeyMap. It reports an error if the KeyMap contains any entries.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     keycase
*        The new attribute value.

*-
*/

/* Local Variables: */
   int ok;                    /* Can the KeyCase value be changed? */
   int itab;                  /* Index into hash table */
   int newval;                /* New KeyCase value */

/* Check the global error status. */
   if ( !astOK ) return;

/* Normalise the new value */
   newval = keycase ? 1 : 0;

/* If the KeyCase value is to be changed, see if the KeyMap is empty. */
   ok = 1;
   if( astGetKeyCase( this ) != newval ) {
      for( itab = 0; itab < this->mapsize; itab++ ) {
         if( this->nentry[ itab ] > 0 ) {
            ok = 0;
            break;
         }
      }
   }

/* If not report an error. */
   if( !ok ) {
      astError( AST__NOWRT, "astSetAttrib(KeyMap): Illegal attempt to "
                "change the KeyCase attribute of a non-empty KeyMap." , status);

/* Otherwise, store the new value. */
   } else {
      this->keycase = newval;
   }
}

static void SetKeyError( AstKeyMap *this, int keyerror, int *status ) {
/*
*+
*  Name:
*     astSetKeyError

*  Purpose:
*     Set the value of the KeyError attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     void astSetKeyError( AstKeyMap *this, int keyerror )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function sets the value of the KeyError attribute for a
*     KeyMap. It also sets the attribute recursively in any KeyMaps
*     contained within the supplied KeyMap.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     keyerror
*        The new value for the attribute.
*-
*/

/* Local Variables: */
   AstMapEntry *next;     /* Pointer to next Entry to copy */
   AstObject **obj_list;  /* List of pointers to AST Object entries */
   int i;                 /* Index into hash table */
   int iel;               /* Index of current vector element */
   int nel;               /* Number of elements in vector */

/* Check the global error status. */
   if ( !astOK ) return;

/* Set the KeyError value in the supplied KeyMap. */
   this->keyerror = keyerror ? 1 : 0;

/* Loop round each entry in the hash table. */
   for( i = 0; i < this->mapsize; i++ ) {

/* Get a pointer to the next KeyMap entry. */
      next = this->table[ i ];

/* Loop round all entries in this element of the hash table. */
      while( next && astOK ) {

/* If this entry has an Object data type, see if holds any KeyMaps. */
         if( next->type == AST__OBJECTTYPE ) {

/* Get the number of objects to check, and a pointer to the first. */
            nel = next->nel;
            if( nel == 0 ) {
               obj_list = &( ((Entry0A *)next)->value );
               nel = 1;
            } else {
               obj_list = ((Entry1A *)next)->value;
            }

/* Loop round checking all Objects. */
            for( iel = 0; iel < nel; iel++ ) {

/* If this Object is a KeyMap, set its KeyError attribute. */
               if( astIsAKeyMap( obj_list[ iel ] ) ) {
                  astSetKeyError( (AstKeyMap *) obj_list[ iel ], keyerror );
               }
            }
         }

/* Get a pointer to the next entry. */
         next = next->next;
      }
   }
}

static void SetMapLocked( AstKeyMap *this, int maplocked, int *status ) {
/*
*+
*  Name:
*     astSetMapLocked

*  Purpose:
*     Set the value of the MapLocked attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     void astSetMapLocked( AstKeyMap *this, int maplocked )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function sets the value of the MapLocked attribute for a
*     KeyMap. It also sets the attribute recursively in any KeyMaps
*     contained within the supplied KeyMap.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     maplocked
*        The new value for the attribute.
*-
*/

/* Local Variables: */
   AstMapEntry *next;     /* Pointer to next Entry to copy */
   AstObject **obj_list;  /* List of pointers to AST Object entries */
   int i;                 /* Index into hash table */
   int iel;               /* Index of current vector element */
   int nel;               /* Number of elements in vector */

/* Check the global error status. */
   if ( !astOK ) return;

/* Set the MapLocked value in the supplied KeyMap. */
   this->maplocked = maplocked ? 1 : 0;

/* Loop round each entry in the hash table. */
   for( i = 0; i < this->mapsize; i++ ) {

/* Get a pointer to the next KeyMap entry. */
      next = this->table[ i ];

/* Loop round all entries in this element of the hash table. */
      while( next && astOK ) {

/* If this entry has an Object data type, see if holds any KeyMaps. */
         if( next->type == AST__OBJECTTYPE ) {

/* Get the number of objects to check, and a pointer to the first. */
            nel = next->nel;
            if( nel == 0 ) {
               obj_list = &( ((Entry0A *)next)->value );
               nel = 1;
            } else {
               obj_list = ((Entry1A *)next)->value;
            }

/* Loop round checking all Objects. */
            for( iel = 0; iel < nel; iel++ ) {

/* If this Object is a KeyMap, set its MapLocked attribute. */
               if( astIsAKeyMap( obj_list[ iel ] ) ) {
                  astSetMapLocked( (AstKeyMap *) obj_list[ iel ], maplocked );
               }
            }
         }

/* Get a pointer to the next entry. */
         next = next->next;
      }
   }
}

static void SetSizeGuess( AstKeyMap *this, int sizeguess, int *status ) {
/*
*+
*  Name:
*     astSetSizeGuess

*  Purpose:
*     Set the value of the SizeGuess attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     void astSetSizeGuess( AstKeyMap *this, int sizeguess )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function sets a new value for the SizeGuess attribute of a
*     KeyMap. It reports an error if the KeyMap contains any entries.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     sizeguess
*        The new attribute value.

*-
*/

/* Local Variables: */
   int empty;                 /* Is the KeyMap empty? */
   int itab;                  /* Index into hash table */

/* Check the global error status. */
   if ( !astOK ) return;

/* See if the KeyMap is empty. */
   empty = 1;
   for( itab = 0; itab < this->mapsize; itab++ ) {
      if( this->nentry[ itab ] > 0 ) {
         empty = 0;
         break;
      }
   }

/* If not report an error. */
   if( !empty ) {
      astError( AST__NOWRT, "astSetAttrib(KeyMap): Illegal attempt to "
                "change the SizeGuess attribute of a non-empty KeyMap." , status);

/* Otherwise, store the new value and change the size of the hash
   table. */
   } else {
      this->sizeguess = sizeguess;
      NewTable( this, sizeguess/MAX_ENTRIES_PER_TABLE_ENTRY, status );
   }
}

static void SetSortBy( AstKeyMap *this, int sortby, int *status ) {
/*
*+
*  Name:
*     astSetSortBy

*  Purpose:
*     Set the value of the SortBy attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     void astSetSortBy( AstKeyMap *this, int sortby )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function sets the value of the SortBy attribute for a
*     KeyMap.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     sortby
*        The new value for the attribute.
*-
*/

/* Local Variables: */
   int oldval;            /* The old sortby value */

/* Check the global error status. */
   if ( !astOK ) return;

/* Get the old SortBy value. */
   oldval = astGetSortBy( this );

/* Set the new SortBy value. */
   this->sortby = sortby;

/* If the value has changed, re-sort the keys. */
   if( oldval != sortby ) SortEntries( this, status );

}

static size_t SizeOfEntry( AstMapEntry *entry, int *status ){
/*
*  Name:
*     SizeOfEntry

*  Purpose:
*     Return the size of the supplied MapEntry structure.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     size_t SizeOfEntry( AstMapEntry *entry, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function returns the size of the supplied MapEntry structure.

*  Parameters:
*     entry
*        Pointer to the MapEntry.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     The size of the MapEntry structure. This does not include the size
*     of any data for which pointers are stored in the MapEntry structure.

*  Notes:
*     - A value of zero will be returned if this function is invoked
*     with the global error status set, or if it should fail for any
*     reason.
*/

/* Local Variables: */
   size_t result;         /* Returned value */
   int nel;               /* Entry length */
   int type;              /* Data type */

/* Initialise. */
   result = 0;

/* Check the global error status and the supplied pointer. */
   if ( !astOK || !entry ) return result;

/* Get the data type and length of the MapEntry. */
   type = entry->type;
   nel = entry->nel;

/* Deal with each type. */
   if( type == AST__STRINGTYPE ) {
      result = ( nel == 0 ) ? sizeof( Entry0C ) : sizeof( Entry1C );

   } else if( type == AST__OBJECTTYPE ) {
      result = ( nel == 0 ) ? sizeof( Entry0A ) : sizeof( Entry1A );

   } else if( type == AST__INTTYPE ) {
      result = ( nel == 0 ) ? sizeof( Entry0I ) : sizeof( Entry1I );

   } else if( type == AST__POINTERTYPE ) {
      result = ( nel == 0 ) ? sizeof( Entry0P ) : sizeof( Entry1P );

   } else if( type == AST__SINTTYPE ) {
      result = ( nel == 0 ) ? sizeof( Entry0S ) : sizeof( Entry1S );

   } else if( type == AST__BYTETYPE ) {
      result = ( nel == 0 ) ? sizeof( Entry0B ) : sizeof( Entry1B );

   } else if( type == AST__DOUBLETYPE ) {
      result = ( nel == 0 ) ? sizeof( Entry0D ) : sizeof( Entry1D );

   } else if( type == AST__FLOATTYPE ) {
      result = ( nel == 0 ) ? sizeof( Entry0F ) : sizeof( Entry1F );

   } else if( type == AST__UNDEFTYPE ) {
      result = sizeof( AstMapEntry );

/* Report an error if the data type is unknown. */
   } else {
      astError( AST__INTER, "SizeOfEntry(KeyMap): Illegal map entry data "
                "type %d encountered (internal AST programming error).", status,
                type );
   }

/* Return the result. */
   return result;
}

static int SortByInt( const char *sortby, const char *method, int *status ){
/*
*  Name:
*     SortByInt

*  Purpose:
*     Get the integer associated with a string SortBy value.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     int SortByInt( const char *sortby, const char *method, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function returns the integer associated with the supplied
*     string SortBy value.

*  Parameters:
*     sortby
*        Pointer to the string SortBy value (case insensitive).
*     method
*        Pointer to a string holding the name of the calling method for
*        inclusion in error messages.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     The associated SortBy integer.

*/

/* Local Variables: */
   int result;             /* The returned integer */

/* Initialise. */
   result = SORTBY_NONE;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Check each known value. */
   if( astChrMatch( sortby, "None" ) ) {
      result = SORTBY_NONE;

   } else if( astChrMatch( sortby, "AgeUp" ) ) {
      result = SORTBY_AGEUP;

   } else if( astChrMatch( sortby, "AgeDown" ) ) {
      result = SORTBY_AGEDOWN;

   } else if( astChrMatch( sortby, "KeyUp" ) ) {
      result = SORTBY_KEYUP;

   } else if( astChrMatch( sortby, "KeyDown" ) ) {
      result = SORTBY_KEYDOWN;

   } else {
      astError( AST__INTER, "%s(KeyMap): Illegal SortBy value %s "
                "encountered.", status, method, sortby );
   }

/* Return the result. */
   return result;
}

static const char *SortByString( int sortby, const char *method, int *status ){
/*
*  Name:
*     SortByString

*  Purpose:
*     Get the string associated with an integer SortBy value.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     const char *SortByString( int sortby, const char *method, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function returns the string associated with the supplied
*     integer SortBy value.

*  Parameters:
*     sortby
*        The integer SortBy value.
*     method
*        Pointer to a string holding the name of the calling method for
*        inclusion in error messages.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     Pointer to the associated SortBy string.

*/

/* Local Variables: */
   const char *result;    /* The returned string */

/* Initialise. */
   result = NULL;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Check each value. */
   if( sortby == SORTBY_NONE ) {
      result = "None";

   } else if( sortby == SORTBY_AGEUP ) {
      result = "AgeUp";

   } else if( sortby == SORTBY_AGEDOWN ) {
      result = "AgeDown";

   } else if( sortby == SORTBY_KEYUP ) {
      result = "KeyUp";

   } else if( sortby == SORTBY_KEYDOWN ) {
      result = "KeyDown";

   } else {
      astError( AST__INTER, "%s(KeyMap): Illegal integer SortBy value %d "
                "encountered (internal AST programming error).", status,
                method, sortby );
   }

/* Return the result. */
   return result;
}

static void SortEntries( AstKeyMap *this, int *status ){
/*
*  Name:
*     SortEntries

*  Purpose:
*     Ensure the entries in a KeyMap are sorted correctly.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     void SortEntries( AstKeyMap *this, int *status )

*  Class Membership:
*     KeyMap member function.

*  Description:
*     This function sorts all the entries in the supplied KeyMap in
*     the manner indicated by the SortBy attribute value in the KeyMap.
*     A double linked list is maintained indicating the ordering, with
*     the first entry in the sorted list being pointed to by "this->first".
*     Each entry contains "snext" and "sprev" pointers that point to the
*     next and previous entries in the sorted list. The number of entries
*     in the sorted list (which should usually equal the total number of
*     entries currently in the KeyMap), is stored in "this->nsorted".

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     status
*        Pointer to the inherited status variable.

*/

/* Local Variables: */
   AstMapEntry **ents;
   AstMapEntry **pent;
   AstMapEntry **a;
   AstMapEntry **b;
   AstMapEntry *entry;
   int i;
   int nent;
   int sortby;

/* Check the global error status. */
   if ( !astOK ) return;

/* Empty the sorted list. */
   this->nsorted = 0;
   this->first = NULL;

/* Get the SortBy value. */
   sortby = astGetSortBy( this );

/* Do nothing more if no sorting is required. */
   if( sortby != SORTBY_NONE ) {

/* Get the number of entries in the keyMap. */
      nent = astMapSize( this );

/* Only sort if the KeyMap is not empty. */
      if( nent > 0 ) {

/* Allocate an array with one element for each entry. Each element is a
   pointer to a MapEntry structure. */
         ents = astMalloc( sizeof( *ents )*nent );
         if( astOK ) {

/* Loop round all entries in the hash table. */
            pent = ents;
            for( i = 0; i < this->mapsize; i++ ) {

/* Get a pointer to the next KeyMap entry. */
               entry = this->table[ i ];

/* Loop round all entries in this element of the hash table. */
               while( entry ) {

/* Store the sorting method in the MapEntry. */
                  entry->sortby = sortby;

/* Put a pointer to the MapEntry into the array. */
                  *(pent++) = entry;

/* Update the address of the next MapEntry in the source. */
                  entry = entry->next;
               }
            }

/* No need for sorting if there is only one entry. */
            if( nent == 1 ) {
               ents[ 0 ]->snext = ents[ 0 ];
               ents[ 0 ]->sprev = ents[ 0 ];

/* Sort the array of pointers if there is more than one entry... */
            } else {
               qsort( ents, nent, sizeof( *ents ), CompareEntries );

/* Establish the double linked list. */
               a = ents;
               b = ents + 1;
               for( i = 1; i < nent; i++ ) {
                  (*b)->sprev = *a;
                  (*a)->snext = *b;
                  a = b++;
               }

               b = ents;
               (*b)->sprev = *a;
               (*a)->snext = *b;

            }

/* Store a pointer to the first entry in the sorted list. */
            this->first = ents[ 0 ];

/* Store the number of entrie sin the sorted list. */
            this->nsorted = nent;
         }

/* Free resources. */
         ents = astFree( ents );
      }
   }
}

static int TestAttrib( AstObject *this_object, const char *attrib, int *status ) {
/*
*  Name:
*     TestAttrib

*  Purpose:
*     Test if a specified attribute value is set for a KeyMap.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     int TestAttrib( AstObject *this, const char *attrib, int *status )

*  Class Membership:
*     KeyMap member function (over-rides the astTestAttrib protected
*     method inherited from the Mapping class).

*  Description:
*     This function returns a boolean result (0 or 1) to indicate whether
*     a value has been set for one of a KeyMap's attributes.

*  Parameters:
*     this
*        Pointer to the KeyMap.
*     attrib
*        Pointer to a null-terminated string specifying the attribute
*        name.  This should be in lower case with no surrounding white
*        space.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     One if a value has been set, otherwise zero.

*  Notes:
*     - A value of zero will be returned if this function is invoked
*     with the global status set, or if it should fail for any reason.
*/

/* Local Variables: */
   AstKeyMap *this;             /* Pointer to the KeyMap structure */
   int result;                   /* Result value to return */

/* Initialise. */
   result = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Obtain a pointer to the KeyMap structure. */
   this = (AstKeyMap *) this_object;

/* Check the attribute name and test the appropriate attribute. */

/* SizeGuess. */
/* ---------- */
   if ( !strcmp( attrib, "sizeguess" ) ) {
      result = astTestSizeGuess( this );

/* KeyCase. */
/* --------- */
   } else if ( !strcmp( attrib, "keycase" ) ) {
      result = astTestKeyCase( this );

/* KeyError. */
/* --------- */
   } else if ( !strcmp( attrib, "keyerror" ) ) {
      result = astTestKeyError( this );

/* MapLocked. */
/* --------- */
   } else if ( !strcmp( attrib, "maplocked" ) ) {
      result = astTestMapLocked( this );

/* SortBy. */
/* ------- */
   } else if ( !strcmp( attrib, "sortby" ) ) {
      result = astTestSortBy( this );

/* If the attribute is still not recognised, pass it on to the parent
   method for further interpretation. */
   } else {
      result = (*parent_testattrib)( this_object, attrib, status );
   }

/* Return the result, */
   return result;
}

static int TestSizeGuess( AstKeyMap *this, int *status ) {
/*
*+
*  Name:
*     astTestSizeGuess

*  Purpose:
*     Test the value of the SizeGuess attribute for a KeyMap.

*  Type:
*     Protected virtual function.

*  Synopsis:
*     #include "keymap.h"
*     int astTestSizeGuess( AstKeyMap *this )

*  Class Membership:
*     KeyMap method.

*  Description:
*     This function returns a non-zero value if the SizeGuess attribute
*     has been set in a KeyMap.

*  Parameters:
*     this
*        Pointer to the KeyMap.

*  Returned Value:
*     Non-zero if the SizeGuess attribute is set.

*  Notes:
*     - A value of zero is returned if this function is invoked with the
*     global error status set.

*-
*/

/* Local Variables: */
   int result;                /* Returned value */

/* Initialise */
   result = 0;

/* Check the global error status. */
   if ( !astOK ) return result;

/* Return non-zero if the attribute is still set to its "not set" value. */
   return ( this->sizeguess != INT_MAX );
}

/* Functions which access class attributes. */
/* ---------------------------------------- */

/*
*att++
*  Name:
*     SizeGuess

*  Purpose:
*     The expected size of the KeyMap.

*  Type:
*     Public attribute.

*  Synopsis:
*     Integer.

*  Description:
*     This is attribute gives an estimate of the number of entries that
*     will be stored in the KeyMap. It is used to tune the internal
*     properties of the KeyMap for speed and efficiency. A larger value
*     will result in faster access at the expense of increased memory
*     requirements. However if the SizeGuess value is much larger than
*     the actual size of the KeyMap, then there will be little, if any,
*     speed gained by making the SizeGuess even larger. The default value
*     is 300.
*
*     The value of this attribute can only be changed if the KeyMap is
*     empty. Its value can be set conveniently when creating the KeyMap.
*     An error will be reported if an attempt is made to set or clear the
*     attribute when the KeyMap contains any entries.

*  Applicability:
*     KeyMap
*        All KeyMaps have this attribute.
*att--
*/

/*
*att++
*  Name:
*     KeyCase

*  Purpose:
*     Are keys case sensitive?

*  Type:
*     Public attribute.

*  Synopsis:
*     Integer (boolean).

*  Description:
*     This attribute is a boolean value which controls how keys are
*     used. If KeyCase is zero, then key strings supplied to any method
*     are automatically converted to upper case before being used. If
*     KeyCase is non-zero (the default), then supplied key strings are
*     used without modification.
*
*     The value of this attribute can only be changed if the KeyMap is
*     empty. Its value can be set conveniently when creating the KeyMap.
*     An error will be reported if an attempt is made to change the
*     attribute value when the KeyMap contains any entries.

*  Applicability:
*     KeyMap
*        All KeyMaps have this attribute.
*     Table
*        The Table class over-rides this attribute by forcing it to zero.
*        That is, keys within a Table are always case insensitive.
*att--
*/
astMAKE_GET(KeyMap,KeyCase,int,1,(this->keycase == -1 ? 1 : this->keycase))
astMAKE_TEST(KeyMap,KeyCase,( this->keycase != -1 ))

/*
*att++
*  Name:
*     KeyError

*  Purpose:
*     Report an error when getting the value of a non-existant KeyMap entry?

*  Type:
*     Public attribute.

*  Synopsis:
*     Integer (boolean).

*  Description:
*     This attribute is a boolean value which controls how the
c     astMapGet...
f     AST_MAPGET...
*     functions behave if the requested key is not found in the KeyMap.
*     If KeyError is zero (the default), then these functions will return
c     zero
f     .FALSE.
*     but no error will be reported. If KeyError is non-zero, then the
*     same values are returned but an error is also reported.

*  Notes:
*     - When setting a new value for KeyError, the supplied value is
*     propagated to any KeyMaps contained within the supplied KeyMap.
*     - When clearing the KeyError attribute, the attribute is also
*     cleared in any KeyMaps contained within the supplied KeyMap.

*  Applicability:
*     KeyMap
*        All KeyMaps have this attribute.
*att--
*/
astMAKE_GET(KeyMap,KeyError,int,0,( ( this->keyerror != -INT_MAX ) ?
                                   this->keyerror : 0 ))
astMAKE_TEST(KeyMap,KeyError,( this->keyerror != -INT_MAX ))

/*
*att++
*  Name:
*     MapLocked

*  Purpose:
*     Prevent new entries being added to a KeyMap?

*  Type:
*     Public attribute.

*  Synopsis:
*     Integer (boolean).

*  Description:
*     If this boolean attribute is set to
c     a non-zero value,
f     .TRUE.,
*     an error will be reported if an attempt is made to add a new entry
*     to the KeyMap. Note, the value associated with any existing entries
*     can still be changed, but no new entries can be stored in the KeyMap.
*     The default value
c     (zero)
f     (.FALSE.)
*     allows new entries to be added to the KeyMap.

*  Notes:
*     - When setting a new value for MapLocked, the supplied value is
*     propagated to any KeyMaps contained within the supplied KeyMap.
*     - When clearing the MapLocked attribute, the attribute is also
*     cleared in any KeyMaps contained within the supplied KeyMap.

*  Applicability:
*     KeyMap
*        All KeyMaps have this attribute.
*att--
*/
astMAKE_GET(KeyMap,MapLocked,int,0,( ( this->maplocked != -INT_MAX ) ?
                                   this->maplocked : 0 ))
astMAKE_TEST(KeyMap,MapLocked,( this->maplocked != -INT_MAX ))

/*
*att++
*  Name:
*     SortBy

*  Purpose:
*     Determines how keys are sorted in a KeyMap.

*  Type:
*     Public attribute.

*  Synopsis:
*     String.

*  Description:
*     This attribute determines the order in which keys are returned by the
c     astMapKey
f     AST_MAPKEY
*     function. It may take the following values (the default is "None"):
*
*     - "None": The keys are returned in an arbitrary order. This is the
*     fastest method as it avoids the need for a sorted list of keys to
*     be maintained and used.
*
*     - "AgeDown": The keys are returned in the order in which they were
*     stored in the KeyMap, with the most recent key being returned last.
*
*     - "AgeUp": The keys are returned in the order in which they were
*     stored in the KeyMap, with the most recent key being returned first.
*
*     - "KeyDown": The keys are returned in alphabetical order, with "A..."
*     being returned last.
*
*     - "KeyUp": The keys are returned in alphabetical order, with "A..."
*     being returned first.

*  Notes:
*     - If a new value is assigned to SortBy (or if SortBy is cleared),
*     all entries currently in the KeyMap are re-sorted according to the
*     new SortBy value.

*  Applicability:
*     KeyMap
*        All KeyMaps have this attribute.
*att--
*/
astMAKE_GET(KeyMap,SortBy,int,SORTBY_NONE,( ( this->sortby != -INT_MAX ) ?
                                           this->sortby : SORTBY_NONE ))
astMAKE_TEST(KeyMap,SortBy,( this->sortby != -INT_MAX ))

/* Copy constructor. */
/* ----------------- */
static void Copy( const AstObject *objin, AstObject *objout, int *status ) {
/*
*  Name:
*     Copy

*  Purpose:
*     Copy constructor for KeyMap objects.

*  Type:
*     Private function.

*  Synopsis:
*     void Copy( const AstObject *objin, AstObject *objout, int *status )

*  Description:
*     This function implements the copy constructor for KeyMap objects.

*  Parameters:
*     objin
*        Pointer to the object to be copied.
*     objout
*        Pointer to the object being constructed.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     void

*  Notes:
*     -  This constructor makes a deep copy.
*/

/* Local Variables: */
   AstKeyMap *in;                  /* Pointer to input KeyMap */
   AstKeyMap *out;                 /* Pointer to output KeyMap */
   int i;                       /* Index into hash table */

/* Check the global error status. */
   if ( !astOK ) return;

/* Obtain pointers to the input and output KeyMap structures. */
   in = (AstKeyMap *) objin;
   out = (AstKeyMap *) objout;

/* For safety, first clear any references to the input memory from
   the output KeyMap. */
   out->table = NULL;
   out->nentry = NULL;
   out->first = NULL;
   out->firstA = NULL;

/* Make copies of the table entries. */
   out->table = astMalloc( sizeof( AstMapEntry * )*( out->mapsize ) );
   out->nentry = astMalloc( sizeof( int )*( out->mapsize ) );

   for( i = 0; i < out->mapsize; i++ ) CopyTableEntry( in, out, i, status );

/* Create the required sorted key list in the new KeyMap. */
   SortEntries( out, status );

/* If an error occurred, clean up by freeing all memory allocated above. */
   if ( !astOK ) {
      for( i = 0; i < out->mapsize; i++ ) FreeTableEntry( out, i, status );
      out->table = astFree( out->table );
      out->nentry = astFree( out->nentry );
   }
}

/* Destructor. */
/* ----------- */
static void Delete( AstObject *obj, int *status ) {
/*
*  Name:
*     Delete

*  Purpose:
*     Destructor for KeyMap objects.

*  Type:
*     Private function.

*  Synopsis:
*     void Delete( AstObject *obj, int *status )

*  Description:
*     This function implements the destructor for KeyMap objects.

*  Parameters:
*     obj
*        Pointer to the object to be deleted.
*     status
*        Pointer to the inherited status variable.

*  Returned Value:
*     void

*  Notes:
*     This function attempts to execute even if the global error status is
*     set.
*/

/* Local Variables: */
   AstKeyMap *this;             /* Pointer to the KeyMap structure */
   int i;                    /* Loop count */

/* Obtain a pointer to the KeyMap structure. */
   this = (AstKeyMap *) obj;

/* Free all allocated memory. */
   for( i = 0; i < this->mapsize; i++ ) FreeTableEntry( this, i, status );

/* Free memory used to hold tables. */
   this->table = astFree( this->table );
   this->nentry = astFree( this->nentry );

/* Nullify other pointers. */
   this->first = NULL;
   this->firstA = NULL;
}

/* Dump function. */
/* -------------- */
static void Dump( AstObject *this_object, AstChannel *channel, int *status ) {
/*
*  Name:
*     Dump

*  Purpose:
*     Dump function for KeyMap objects.

*  Type:
*     Private function.

*  Synopsis:
*     void Dump( AstObject *this, AstChannel *channel, int *status )

*  Description:
*     This function implements the Dump function which writes out data
*     for the KeyMap class to an output Channel.

*  Parameters:
*     this
*        Pointer to the KeyMap whose data are being written.
*     channel
*        Pointer to the Channel to which the data are being written.
*     status
*        Pointer to the inherited status variable.
*/

/* Local Variables: */
   AstKeyMap *this;              /* Pointer to the KeyMap structure */
   AstMapEntry *next;            /* Pointer to the next AstMapEntry to dump */
   int i;                        /* Index into hash table */
   int nentry;                   /* Number of entries dumped so far */
   int set;                      /* Is attribute set? */
   int ival;                     /* Attribute value */

/* Check the global error status. */
   if ( !astOK ) return;

/* Obtain a pointer to the KeyMap structure. */
   this = (AstKeyMap *) this_object;

/* Initialise the number of KeyMap entries dumped so far. */
   nentry = 0;

/* SizeGuess. */
/* ---------- */
   set = TestSizeGuess( this, status );
   ival = set ? GetSizeGuess( this, status ) : astGetSizeGuess( this );
   astWriteInt( channel, "SzGss", set, 0, ival, "Guess at KeyMap size" );

/* SortBy. */
/* ------- */
   set = TestSortBy( this, status );
   ival = set ? GetSortBy( this, status ) : astGetSortBy( this );
   astWriteString( channel, "SortBy", set, 0, SortByString( ival, "astDump",
                                                            status ),
                   "Sorting scheme for keys" );

/* KeyCase. */
/* --------- */
   set = TestKeyCase( this, status );
   ival = set ? GetKeyCase( this, status ) : astGetKeyCase( this );
   astWriteInt( channel, "KyCas", set, 0, ival, "Are keys case sensitive?" );

/* KeyError. */
/* --------- */
   set = TestKeyError( this, status );
   ival = set ? GetKeyError( this, status ) : astGetKeyError( this );
   astWriteInt( channel, "KyErr", set, 0, ival, "Report non-existant keys?" );

/* MapLocked. */
/* --------- */
   set = TestMapLocked( this, status );
   ival = set ? GetMapLocked( this, status ) : astGetMapLocked( this );
   astWriteInt( channel, "MpLck", set, 0, ival, "Prevent addition of new entries?" );

/* MapSize. */
/* -------- */
   astWriteInt( channel, "MapSz", 1, 1, this->mapsize, "Size of hash table" );

/* member count. */
   astWriteInt( channel, "MemCnt", 1, 1, this->member_count, "Total member count" );

/* Loop round each entry in the hash table. */
   for( i = 0; i < this->mapsize; i++ ) {

/* Get a pointer to the next KeyMap entry to dump. */
      next = this->table[ i ];

/* Loop round dumping all KeyMap entries in this element of the hash table. */
      while( next && astOK ) {
         DumpEntry( next, channel, ++nentry, status );

/* Get a pointer to the next entry to dump. */
         next = next->next;

      }
   }
}

/* Standard class functions. */
/* ========================= */
/* Implement the astIsAKeyMap and astCheckKeyMap functions using the macros
   defined for this purpose in the "object.h" header file. */
astMAKE_ISA(KeyMap,Object)
astMAKE_CHECK(KeyMap)

AstKeyMap *astKeyMap_( const char *options, int *status, ...) {
/*
*++
*  Name:
c     astKeyMap
f     AST_KEYMAP

*  Purpose:
*     Create a KeyMap.

*  Type:
*     Public function.

*  Synopsis:
c     #include "keymap.h"
c     AstKeyMap *astKeyMap( const char *options, ... )
f     RESULT = AST_KEYMAP( OPTIONS, STATUS )

*  Class Membership:
*     KeyMap constructor.

*  Description:
*     This function creates a new empty KeyMap and optionally initialises its
*     attributes. Entries can then be added to the KeyMap using the
c     astMapPut0<X> and astMapPut1<X> functions.
f     AST_MAPPUT0<X> and AST_MAPPUT1<X> functions.
*
*     The KeyMap class is used to store a set of values with associated keys
*     which identify the values. The keys are strings. These may be case
*     sensitive or insensitive as selected by the KeyCase attribute, and
*     trailing spaces are ignored. The value associated with a key can be
*     integer (signed 4 and 2 byte, or unsigned 1 byte), floating point
*     (single or double precision),
c     void pointer,
*     character string or AST Object pointer. Each
*     value can be a scalar or a one-dimensional vector. A KeyMap is
*     conceptually similar to a Mapping in that a KeyMap transforms an
*     input into an output - the input is the key, and the output is the
*     value associated with the key. However, this is only a conceptual
*     similarity, and it should be noted that the KeyMap class inherits from
*     the Object class rather than the Mapping class. The methods of the
*     Mapping class cannot be used with a KeyMap.

*  Parameters:
c     options
f     OPTIONS = CHARACTER * ( * ) (Given)
c        Pointer to a null-terminated string containing an optional
c        comma-separated list of attribute assignments to be used for
c        initialising the new KeyMap. The syntax used is identical to
c        that for the astSet function and may include "printf" format
c        specifiers identified by "%" symbols in the normal way.
f        A character string containing an optional comma-separated
f        list of attribute assignments to be used for initialising the
f        new KeyMap. The syntax used is identical to that for the
f        AST_SET routine.
c     ...
c        If the "options" string contains "%" format specifiers, then
c        an optional list of additional arguments may follow it in
c        order to supply values to be substituted for these
c        specifiers. The rules for supplying these are identical to
c        those for the astSet function (and for the C "printf"
c        function).
f     STATUS = INTEGER (Given and Returned)
f        The global status.

*  Returned Value:
c     astKeyMap()
f     AST_MAP = INTEGER
*        A pointer to the new KeyMap.

*  Notes:
*     - A null Object pointer (AST__NULL) will be returned if this
c     function is invoked with the AST error status set, or if it
f     function is invoked with STATUS set to an error value, or if it
*     should fail for any reason.

*  Status Handling:
*     The protected interface to this function includes an extra
*     parameter at the end of the parameter list descirbed above. This
*     parameter is a pointer to the integer inherited status
*     variable: "int *status".

*--
*/

/* Local Variables: */
   astDECLARE_GLOBALS            /* Pointer to thread-specific global data */
   AstKeyMap *new;                 /* Pointer to new KeyMap */
   va_list args;                /* Variable argument list */

/* Get a pointer to the thread specific global data structure. */
   astGET_GLOBALS(NULL);

/* Check the global status. */
   if ( !astOK ) return NULL;

/* Initialise the KeyMap, allocating memory and initialising the
   virtual function table as well if necessary. */
   new = astInitKeyMap( NULL, sizeof( AstKeyMap ), !class_init, &class_vtab, "KeyMap" );

/* If successful, note that the virtual function table has been
   initialised. */
   if ( astOK ) {
      class_init = 1;

/* Obtain the variable argument list and pass it along with the options string
   to the astVSet method to initialise the new KeyMap's attributes. */
      va_start( args, status );
      astVSet( new, options, NULL, args );
      va_end( args );

/* If an error occurred, clean up by deleting the new object. */
      if ( !astOK ) new = astDelete( new );
   }

/* Return a pointer to the new KeyMap. */
   return new;
}

AstKeyMap *astKeyMapId_( const char *options, ... ) {
/*
*  Name:
*     astKeyMapId_

*  Purpose:
*     Create a KeyMap.

*  Type:
*     Private function.

*  Synopsis:
*     #include "keymap.h"
*     AstKeyMap *astKeyMapId_( const char *options, ... )

*  Class Membership:
*     KeyMap constructor.

*  Description:
*     This function implements the external (public) interface to the
*     astKeyMap constructor function. It returns an ID value (instead
*     of a true C pointer) to external users, and must be provided
*     because astKeyMap_ has a variable argument list which cannot be
*     encapsulated in a macro (where this conversion would otherwise
*     occur).
*
*     The variable argument list also prevents this function from
*     invoking astKeyMap_ directly, so it must be a re-implementation
*     of it in all respects, except for the final conversion of the
*     result to an ID value.

*  Parameters:
*     As for astKeyMap_.

*  Returned Value:
*     The ID value associated with the new KeyMap.
*/

/* Local Variables: */
   astDECLARE_GLOBALS            /* Pointer to thread-specific global data */
   AstKeyMap *new;                 /* Pointer to new KeyMap */
   va_list args;                /* Variable argument list */

   int *status;                  /* Pointer to inherited status value */

/* Get a pointer to the inherited status value. */
   status = astGetStatusPtr;

/* Get a pointer to the thread specific global data structure. */
   astGET_GLOBALS(NULL);

/* Check the global status. */
   if ( !astOK ) return NULL;

/* Initialise the KeyMap, allocating memory and initialising the
   virtual function table as well if necessary. */
   new = astInitKeyMap( NULL, sizeof( AstKeyMap ), !class_init, &class_vtab, "KeyMap" );

/* If successful, note that the virtual function table has been
   initialised. */
   if ( astOK ) {
      class_init = 1;

/* Obtain the variable argument list and pass it along with the options string
   to the astVSet method to initialise the new KeyMap's attributes. */
      va_start( args, options );
      astVSet( new, options, NULL, args );
      va_end( args );

/* If an error occurred, clean up by deleting the new object. */
      if ( !astOK ) new = astDelete( new );
   }

/* Return an ID value for the new KeyMap. */
   return astMakeId( new );
}

AstKeyMap *astInitKeyMap_( void *mem, size_t size, int init, AstKeyMapVtab *vtab,
                           const char *name, int *status ) {
/*
*+
*  Name:
*     astInitKeyMap

*  Purpose:
*     Initialise a KeyMap.

*  Type:
*     Protected function.

*  Synopsis:
*     #include "keymap.h"
*     AstKeyMap *astInitKeyMap( void *mem, size_t size, int init, AstKeyMapVtab *vtab,
*                               const char *name )

*  Class Membership:
*     KeyMap initialiser.

*  Description:
*     This function is provided for use by class implementations to initialise
*     a new KeyMap object. It allocates memory (if necessary) to accommodate
*     the KeyMap plus any additional data associated with the derived class.
*     It then initialises a KeyMap structure at the start of this memory. If
*     the "init" flag is set, it also initialises the contents of a virtual
*     function table for a KeyMap at the start of the memory passed via the
*     "vtab" parameter.

*  Parameters:
*     mem
*        A pointer to the memory in which the KeyMap is to be created. This
*        must be of sufficient size to accommodate the KeyMap data
*        (sizeof(KeyMap)) plus any data used by the derived class. If a value
*        of NULL is given, this function will allocate the memory itself using
*        the "size" parameter to determine its size.
*     size
*        The amount of memory used by the KeyMap (plus derived class data).
*        This will be used to allocate memory if a value of NULL is given for
*        the "mem" parameter. This value is also stored in the KeyMap
*        structure, so a valid value must be supplied even if not required for
*        allocating memory.
*     init
*        A logical flag indicating if the KeyMap's virtual function table is
*        to be initialised. If this value is non-zero, the virtual function
*        table will be initialised by this function.
*     vtab
*        Pointer to the start of the virtual function table to be associated
*        with the new KeyMap.
*     name
*        Pointer to a constant null-terminated character string which contains
*        the name of the class to which the new object belongs (it is this
*        pointer value that will subsequently be returned by the astClass
*        method).

*  Returned Value:
*     A pointer to the new KeyMap.

*  Notes:
*     -  A NULL pointer will be returned if this function is invoked with the
*     global error status set, or if it should fail for any reason.
*-
*/

/* Local Variables: */
   AstKeyMap *new;              /* Pointer to the new KeyMap */

/* Check the global error status. */
   if ( !astOK ) return NULL;

/* If necessary, initialise the virtual function table. */
   if ( init ) astInitKeyMapVtab( vtab, name );

/* Initialise an Object structure (the parent class) as the first component
   within the KeyMap structure, allocating memory if necessary. */
   new = (AstKeyMap *) astInitObject( mem, size, 0, (AstObjectVtab *) vtab,
                                      name );

   if ( astOK ) {

/* Initialise the KeyMap data. */
/* ---------------------------- */
/* Initialise all attributes to their "undefined" values. */
      new->sizeguess = INT_MAX;
      new->mapsize = 0;
      new->table = NULL;
      new->nentry = NULL;
      new->keycase = -1;
      new->keyerror = -INT_MAX;
      new->maplocked = -INT_MAX;
      new->sortby = -INT_MAX;
      new->first = NULL;
      new->nsorted = 0;
      new->member_count = 0;
      new->firstA = NULL;
      new->iter_itab = 0;
      new->iter_entry = NULL;

      NewTable( new, MIN_TABLE_SIZE, status );

/* If an error occurred, clean up by deleting the new KeyMap. */
      if ( !astOK ) new = astDelete( new );
   }

/* Return a pointer to the new KeyMap. */
   return new;
}

AstKeyMap *astLoadKeyMap_( void *mem, size_t size, AstKeyMapVtab *vtab,
                           const char *name, AstChannel *channel, int *status ) {
/*
*+
*  Name:
*     astLoadKeyMap

*  Purpose:
*     Load a KeyMap.

*  Type:
*     Protected function.

*  Synopsis:
*     #include "keymap.h"
*     AstKeyMap *astLoadKeyMap( void *mem, size_t size, AstKeyMapVtab *vtab,
*                               const char *name, AstChannel *channel )

*  Class Membership:
*     KeyMap loader.

*  Description:
*     This function is provided to load a new KeyMap using data read
*     from a Channel. It first loads the data used by the parent class
*     (which allocates memory if necessary) and then initialises a
*     KeyMap structure in this memory, using data read from the input
*     Channel.
*
*     If the "init" flag is set, it also initialises the contents of a
*     virtual function table for a KeyMap at the start of the memory
*     passed via the "vtab" parameter.


*  Parameters:
*     mem
*        A pointer to the memory into which the KeyMap is to be
*        loaded.  This must be of sufficient size to accommodate the
*        KeyMap data (sizeof(KeyMap)) plus any data used by derived
*        classes. If a value of NULL is given, this function will
*        allocate the memory itself using the "size" parameter to
*        determine its size.
*     size
*        The amount of memory used by the KeyMap (plus derived class
*        data).  This will be used to allocate memory if a value of
*        NULL is given for the "mem" parameter. This value is also
*        stored in the KeyMap structure, so a valid value must be
*        supplied even if not required for allocating memory.
*
*        If the "vtab" parameter is NULL, the "size" value is ignored
*        and sizeof(AstKeyMap) is used instead.
*     vtab
*        Pointer to the start of the virtual function table to be
*        associated with the new KeyMap. If this is NULL, a pointer
*        to the (static) virtual function table for the KeyMap class
*        is used instead.
*     name
*        Pointer to a constant null-terminated character string which
*        contains the name of the class to which the new object
*        belongs (it is this pointer value that will subsequently be
*        returned by the astGetClass method).
*
*        If the "vtab" parameter is NULL, the "name" value is ignored
*        and a pointer to the string "KeyMap" is used instead.

*  Returned Value:
*     A pointer to the new KeyMap.

*  Notes:
*     - A null pointer will be returned if this function is invoked
*     with the global error status set, or if it should fail for any
*     reason.
*-
*/

/* Local Variables: */
   AstKeyMap *new;           /* Pointer to the new KeyMap */
   AstObject **alist;        /* Pointer to vector of entry values */
   AstObject *aval;          /* AST Object value for an entry */
   astDECLARE_GLOBALS        /* Pointer to thread-specific global data */
   char *com;                /* Pointer to comment string for an entry */
   char *key;                /* Pointer to key string for an entry */
   char *sval;               /* String value for an entry */
   char buff[ 30 ];          /* Buffer for key names */
   const char **slist;       /* Pointer to vector of entry values */
   double *dlist;            /* Pointer to vector of entry values */
   double dval;              /* Floating point value for an entry */
   float *flist;             /* Pointer to vector of entry values */
   int *ilist;               /* Pointer to vector of entry values */
   int index;                /* Index of next array element in a vector entry */
   int ival;                 /* Integer value for an entry */
   int mapsize;              /* Size for new hash table */
   int nel;                  /* Vector length */
   int nentry;               /* Number of KeyMap entries read so far */
   int type;                 /* Data type for an entry */
   short int *wlist;         /* Pointer to vector of entry values */
   short int wval;           /* Short int value for an entry */
   unsigned char *blist;     /* Pointer to vector of entry values */
   unsigned char bval;       /* Byte value for an entry */

/* Get a pointer to the thread specific global data structure. */
   astGET_GLOBALS(channel);

/* Initialise. */
   new = NULL;

/* Check the global error status. */
   if ( !astOK ) return new;

/* If a NULL virtual function table has been supplied, then this is
   the first loader to be invoked for this KeyMap. In this case the
   KeyMap belongs to this class, so supply appropriate values to be
   passed to the parent class loader (and its parent, etc.). */
   if ( !vtab ) {
      size = sizeof( AstKeyMap );
      vtab = &class_vtab;
      name = "KeyMap";

/* If required, initialise the virtual function table for this class. */
      if ( !class_init ) {
         astInitKeyMapVtab( vtab, name );
         class_init = 1;
      }
   }

/* Invoke the parent class loader to load data for all the ancestral
   classes of the current one, returning a pointer to the resulting
   partly-built KeyMap. */
   new = astLoadObject( mem, size, (AstObjectVtab *) vtab, name, channel );

   if ( astOK ) {

/* Inidicate the KeyMap is empty. */
      new->mapsize = 0;
      new->table = NULL;
      new->nentry = NULL;
      new->firstA = NULL;
      new->iter_itab = 0;
      new->iter_entry = NULL;

/* Read input data. */
/* ================ */
/* Request the input Channel to read all the input data appropriate to
   this class into the internal "values list". */
      astReadClassData( channel, "KeyMap" );

/* Now read each individual data item from this list and use it to
   initialise the appropriate instance variable(s) for this class. */

/* SizeGuess. */
/* ---------- */
      new->sizeguess = astReadInt( channel, "szgss", INT_MAX );
      if ( TestSizeGuess( new, status ) ) SetSizeGuess( new, new->sizeguess, status );

/* KeyCase. */
/* --------- */
      new->keycase = astReadInt( channel, "kycas", -INT_MAX );
      if ( TestKeyCase( new, status ) ) SetKeyCase( new, new->keycase, status );

/* KeyError. */
/* --------- */
      new->keyerror = astReadInt( channel, "kyerr", -INT_MAX );
      if ( TestKeyError( new, status ) ) SetKeyError( new, new->keyerror, status );

/* MapLocked. */
/* --------- */
      new->maplocked = astReadInt( channel, "mplck", -INT_MAX );
      if ( TestMapLocked( new, status ) ) SetMapLocked( new, new->maplocked, status );

/* SortBy. */
/* ------- */
      sval = astReadString( channel, "sortby", " " );
      new->sortby = -INT_MAX;
      if( astOK && strcmp( sval, " " ) ) {
         new->sortby = SortByInt( sval, "astRead", status );
      }
      if( TestSortBy( new, status ) ) SetSortBy( new, new->sortby, status );
      sval = astFree( sval );

/* MapSize. */
/* -------- */
      mapsize = astReadInt( channel, "mapsz", MIN_TABLE_SIZE );
      NewTable( new, mapsize, status );

/* Entries... */
/* ---------- */

/* Initialise the index of the next AstMapEntry to be read. */
      nentry = 0;

/* Read Entries until no more are found */
      while( astOK ) {
         nentry++;

/* Get the entry key. */
         (void) sprintf( buff, "key%d", nentry );
         key = astReadString( channel, buff, NULL );

/* We have finished reading entries if no key was found. */
         if( !key ) break;

/* Get the entry comment. */
         (void) sprintf( buff, "com%d", nentry );
         com = astReadString( channel, buff, NULL );

/* Get the entry data type. */
         (void) sprintf( buff, "typ%d", nentry );
         type = astReadInt( channel, buff, AST__BADTYPE );

         if( type == AST__BADTYPE && astOK ) {
            astError( AST__BDFTS, "astLoadKeyMap(%s): No data type code found "
                      "whilst reading a %s.", status, name, name );

         }

/* Get the vector length. */
         (void) sprintf( buff, "nel%d", nentry );
         nel = astReadInt( channel, buff, 0 );

/* Get the entry member number. Set the KeyMap member count to this value
   so that the next entry added to the KeyMap will get this value as its
   member index. */
         (void) sprintf( buff, "mem%d", nentry );
         new->member_count = astReadInt( channel, buff, 0 );

/* First deal with integer entries. */
         if( type == AST__INTTYPE ) {

/* For scalar entries, use "val<nentry>" to get the value then create a new
   entry and add it to the KeyMap. */
            if( nel == 0 ) {
               (void) sprintf( buff, "val%d", nentry );
               ival = astReadInt( channel, buff, 0 );
               MapPut0I( new, key, ival, com, status );

/* If we must have an array of values... */
            } else {

/* Create an array to hold the values. */
               ilist = astMalloc( sizeof(int)*nel );

/* Loop round reading values. */
               for( index = 0; astOK && index < nel; index++ ) {
                  (void) sprintf( buff, "v%d_%d", nentry, index + 1 );
                  ilist[ index ] = astReadInt( channel, buff, 0 );
               }

/* Create the KeyMap entry. */
               MapPut1I( new, key, nel, ilist, com, status );

/* Free resources. */
               ilist = astFree( ilist );
            }

/* Do the same for short int values. */
         } else if( type == AST__SINTTYPE ) {
            if( nel == 0 ) {
               (void) sprintf( buff, "val%d", nentry );
               wval = (short int) astReadInt( channel, buff, 0 );
               MapPut0S( new, key, wval, com, status );
            } else {
               wlist = astMalloc( sizeof(short int)*nel );
               for( index = 0; astOK && index < nel; index++ ) {
                  (void) sprintf( buff, "v%d_%d", nentry, index + 1 );
                  wlist[ index ] = (short int) astReadInt( channel, buff, 0 );
               }
               MapPut1S( new, key, nel, wlist, com, status );
               wlist = astFree( wlist );
            }

/* Do the same for byte values. */
         } else if( type == AST__BYTETYPE ) {
            if( nel == 0 ) {
               (void) sprintf( buff, "val%d", nentry );
               bval = (unsigned char) astReadInt( channel, buff, 0 );
               MapPut0B( new, key, bval, com, status );
            } else {
               blist = astMalloc( sizeof(unsigned char)*nel );
               for( index = 0; astOK && index < nel; index++ ) {
                  (void) sprintf( buff, "v%d_%d", nentry, index + 1 );
                  blist[ index ] = (unsigned char) astReadInt( channel, buff, 0 );
               }
               MapPut1B( new, key, nel, blist, com, status );
               blist = astFree( blist );
            }

/* Do the same for double values. */
         } else if( type == AST__DOUBLETYPE ) {
            if( nel == 0 ) {
               (void) sprintf( buff, "val%d", nentry );
               dval = astReadDouble( channel, buff, AST__BAD );
               MapPut0D( new, key, dval, com, status );
            } else {
               dlist = astMalloc( sizeof(double)*nel );
               for( index = 0; astOK && index < nel; index++ ) {
                  (void) sprintf( buff, "v%d_%d", nentry, index + 1 );
                  dlist[ index ] = astReadDouble( channel, buff, AST__BAD );
               }
               MapPut1D( new, key, nel, dlist, com, status );
               dlist = astFree( dlist );
            }

/* Do the same for float values. */
         } else if( type == AST__FLOATTYPE ) {
            if( nel == 0 ) {
               (void) sprintf( buff, "val%d", nentry );
               dval = astReadDouble( channel, buff, 0.0 );
               MapPut0F( new, key, (float) dval, com, status );
            } else {
               flist = astMalloc( sizeof(float)*nel );
               for( index = 0; astOK && index < nel; index++ ) {
                  (void) sprintf( buff, "v%d_%d", nentry, index + 1 );
                  flist[ index ] = (float) astReadDouble( channel, buff, 0.0 );
               }
               MapPut1F( new, key, nel, flist, com, status );
               flist = astFree( flist );
            }

/* Do the same for string values. */
         } else if( type == AST__STRINGTYPE ) {
            if( nel == 0 ) {
               (void) sprintf( buff, "val%d", nentry );
               sval = astReadString( channel, buff, "" );
               MapPut0C( new, key, sval, com, status );
               sval = astFree( sval );
            } else {
               slist = astMalloc( sizeof(const char *)*nel );
               for( index = 0; astOK && index < nel; index++ ) {
                  (void) sprintf( buff, "v%d_%d", nentry, index + 1 );
                  slist[ index ] = astReadString( channel, buff, "" );
               }
               MapPut1C( new, key, nel, slist, com, status );
               for( index = 0; astOK && index < nel; index++ ) {
                  slist[ index ] = astFree( (void *) slist[ index ] );
               }
               slist = astFree( slist );
            }

/* Do the same for object values. */
         } else if( type == AST__OBJECTTYPE ) {
            if( nel == 0 ) {
               (void) sprintf( buff, "val%d", nentry );
               aval = astReadObject( channel, buff, NULL );
               MapPut0A( new, key, aval, com, status );
               if( aval ) aval = astAnnul( aval );
            } else {
               alist = astMalloc( sizeof(AstObject *)*nel );
               for( index = 0; astOK && index < nel; index++ ) {
                  (void) sprintf( buff, "v%d_%d", nentry, index + 1 );
                  alist[ index ] = astReadObject( channel, buff, NULL );
               }
               MapPut1A( new, key, nel, alist, com, status );
               for( index = 0; astOK && index < nel; index++ ) {
                  if( alist[ index ] ) alist[ index ] = astAnnul( alist[ index ] );
               }
               alist = astFree( alist );
            }

/* Report an error if the data type is unknown. */
         } else if( astOK ) {
            astError( AST__BDFTS, "astLoadKeyMap(%s): Unknown data type code "
                      "(%d) encountered whilst reading a %s.", status, name, type,
                      name );
         }
/* Free resources. */
         key = astFree( key );
         if( com ) com = astFree( com );

      }

/* Set the final member count for the KeyMap. */
      new->member_count = astReadInt( channel, "memcnt", 0 );

/* If an error occurred, clean up by deleting the new KeyMap. */
      if ( !astOK ) new = astDelete( new );
   }

/* Return the new KeyMap pointer. */
   return new;
}

/* Virtual function interfaces. */
/* ============================ */
/* These provide the external interface to the virtual functions defined by
   this class. Each simply checks the global error status and then locates and
   executes the appropriate member function, using the function pointer stored
   in the object's virtual function table (this pointer is located using the
   astMEMBER macro defined in "object.h").

   Note that the member function may not be the one defined here, as it may
   have been over-ridden by a derived class. However, it should still have the
   same interface. */

#define MAKE_MAPPUT0_(X,Xtype) \
void astMapPut0##X##_( AstKeyMap *this, const char *key, Xtype value, \
                      const char *comment, int *status ){ \
   if ( !astOK ) return; \
   (**astMEMBER(this,KeyMap,MapPut0##X))(this,key,value,comment, status ); \
}
MAKE_MAPPUT0_(D,double)
MAKE_MAPPUT0_(F,float)
MAKE_MAPPUT0_(I,int)
MAKE_MAPPUT0_(C,const char *)
MAKE_MAPPUT0_(A,AstObject *)
MAKE_MAPPUT0_(P,void *)
MAKE_MAPPUT0_(S,short int)
MAKE_MAPPUT0_(B,unsigned char)
#undef MAKE_MAPPUT0_


#define MAKE_MAPPUT1_(X,Xtype) \
void astMapPut1##X##_( AstKeyMap *this, const char *key, int size, \
                       Xtype value[], const char *comment, \
                       int *status ){ \
   if ( !astOK ) return; \
   (**astMEMBER(this,KeyMap,MapPut1##X))(this,key,size,value,comment, status ); \
}
MAKE_MAPPUT1_(S,const short int)
MAKE_MAPPUT1_(B,const unsigned char)
MAKE_MAPPUT1_(D,const double)
MAKE_MAPPUT1_(F,const float)
MAKE_MAPPUT1_(I,const int)
MAKE_MAPPUT1_(C,const char *const)
MAKE_MAPPUT1_(A,AstObject *const)
MAKE_MAPPUT1_(P,void *const)
#undef MAKE_MAPPUT1_

#define MAKE_MAPGET0_(X,Xtype) \
int astMapGet0##X##_( AstKeyMap *this, const char *key, Xtype *value, int *status ){ \
   if ( !astOK ) return 0; \
   return (**astMEMBER(this,KeyMap,MapGet0##X))(this,key,value, status ); \
}
MAKE_MAPGET0_(D,double)
MAKE_MAPGET0_(S,short int)
MAKE_MAPGET0_(B,unsigned char)
MAKE_MAPGET0_(F,float)
MAKE_MAPGET0_(I,int)
MAKE_MAPGET0_(C,const char *)
MAKE_MAPGET0_(A,AstObject *)
MAKE_MAPGET0_(P,void *)
#undef MAKE_MAPGET0_


#define MAKE_MAPGET1_(X,Xtype) \
int astMapGet1##X##_( AstKeyMap *this, const char *key, int mxval, int *nval, \
                      Xtype *value, int *status ){ \
   if ( !astOK ) return 0; \
   return (**astMEMBER(this,KeyMap,MapGet1##X))(this,key,mxval,nval,value,status); \
}
MAKE_MAPGET1_(B,unsigned char)
MAKE_MAPGET1_(S,short int)
MAKE_MAPGET1_(D,double)
MAKE_MAPGET1_(F,float)
MAKE_MAPGET1_(I,int)
MAKE_MAPGET1_(A,AstObject *)
MAKE_MAPGET1_(P,void *)
#undef MAKE_MAPGET1_

#define MAKE_MAPGETELEM_(X,Xtype) \
int astMapGetElem##X##_( AstKeyMap *this, const char *key, int elem, \
                         Xtype *value, int *status ){ \
   if ( !astOK ) return 0; \
   return (**astMEMBER(this,KeyMap,MapGetElem##X))(this,key,elem,value,status); \
}
MAKE_MAPGETELEM_(B,unsigned char)
MAKE_MAPGETELEM_(S,short int)
MAKE_MAPGETELEM_(D,double)
MAKE_MAPGETELEM_(F,float)
MAKE_MAPGETELEM_(I,int)
MAKE_MAPGETELEM_(A,AstObject *)
MAKE_MAPGETELEM_(P,void *)
#undef MAKE_MAPGETELEM_

int astMapGet1C_( AstKeyMap *this, const char *key, int l, int mxval, int *nval,
                  char *value, int *status ){
   if ( !astOK ) return 0;
   return (**astMEMBER(this,KeyMap,MapGet1C))(this,key,l,mxval,nval,value,status);
}

int astMapGetElemC_( AstKeyMap *this, const char *key, int l, int elem,
                     char *value, int *status ){
   if ( !astOK ) return 0;
   return (**astMEMBER(this,KeyMap,MapGetElemC))(this,key,l,elem,value,status);
}

#define MAKE_MAPPUTELEM_(X,Xtype) \
void astMapPutElem##X##_( AstKeyMap *this, const char *key, int elem, \
                         Xtype value, int *status ){ \
   if ( !astOK ) return; \
   (**astMEMBER(this,KeyMap,MapPutElem##X))(this,key,elem,value,status); \
}
MAKE_MAPPUTELEM_(B,unsigned char)
MAKE_MAPPUTELEM_(S,short int)
MAKE_MAPPUTELEM_(D,double)
MAKE_MAPPUTELEM_(F,float)
MAKE_MAPPUTELEM_(I,int)
MAKE_MAPPUTELEM_(A,AstObject *)
MAKE_MAPPUTELEM_(C,const char *)
MAKE_MAPPUTELEM_(P,void *)
#undef MAKE_MAPPUTELEM_

void astMapPutU_( AstKeyMap *this, const char *key, const char *comment, int *status ){
   if ( !astOK ) return;
   (**astMEMBER(this,KeyMap,MapPutU))(this,key,comment,status);
}

void astMapRemove_( AstKeyMap *this, const char *key, int *status ){
   if ( !astOK ) return;
   (**astMEMBER(this,KeyMap,MapRemove))(this,key,status);
}
void astMapRename_( AstKeyMap *this, const char *oldkey, const char *newkey,
                    int *status ){
   if ( !astOK ) return;
   (**astMEMBER(this,KeyMap,MapRename))(this,oldkey,newkey,status);
}
void astMapCopy_( AstKeyMap *this, AstKeyMap *that, int *status ){
   if ( !astOK ) return;
   (**astMEMBER(this,KeyMap,MapCopy))(this,that,status);
}
int astMapSize_( AstKeyMap *this, int *status ){
   if ( !astOK ) return 0;
   return (**astMEMBER(this,KeyMap,MapSize))(this,status);
}
int astMapLenC_( AstKeyMap *this, const char *key, int *status ){
   if ( !astOK ) return 0;
   return (**astMEMBER(this,KeyMap,MapLenC))(this,key,status);
}
int astMapLength_( AstKeyMap *this, const char *key, int *status ){
   if ( !astOK ) return 0;
   return (**astMEMBER(this,KeyMap,MapLength))(this,key,status);
}
int astMapType_( AstKeyMap *this, const char *key, int *status ){
   if ( !astOK ) return 0;
   return (**astMEMBER(this,KeyMap,MapType))(this,key,status);
}
int astMapHasKey_( AstKeyMap *this, const char *key, int *status ){
   if ( !astOK ) return 0;
   return (**astMEMBER(this,KeyMap,MapHasKey))(this,key,status);
}
const char *astMapKey_( AstKeyMap *this, int index, int *status ){
   if ( !astOK ) return NULL;
   return (**astMEMBER(this,KeyMap,MapKey))(this,index,status);
}
const char *astMapIterate_( AstKeyMap *this, int reset, int *status ){
   if ( !astOK ) return NULL;
   return (**astMEMBER(this,KeyMap,MapIterate))(this,reset,status);
}
int astGetSizeGuess_( AstKeyMap *this, int *status ){
   if( !astOK ) return 0;
   return (**astMEMBER(this,KeyMap,GetSizeGuess))(this,status);
}
int astTestSizeGuess_( AstKeyMap *this, int *status ){
   if( !astOK ) return 0;
   return (**astMEMBER(this,KeyMap,TestSizeGuess))(this,status);
}
void astClearSizeGuess_( AstKeyMap *this, int *status ){
   if( !astOK ) return;
   (**astMEMBER(this,KeyMap,ClearSizeGuess))(this,status);
}
void astSetSizeGuess_( AstKeyMap *this, int sizeguess, int *status ){
   if( !astOK ) return;
   (**astMEMBER(this,KeyMap,SetSizeGuess))(this,sizeguess,status);
}

void astClearMapLocked_( AstKeyMap *this, int *status ){
   if( !astOK ) return;
   (**astMEMBER(this,KeyMap,ClearMapLocked))(this,status);
}
void astSetMapLocked_( AstKeyMap *this, int maplocked, int *status ){
   if( !astOK ) return;
   (**astMEMBER(this,KeyMap,SetMapLocked))(this,maplocked,status);
}

void astClearKeyError_( AstKeyMap *this, int *status ){
   if( !astOK ) return;
   (**astMEMBER(this,KeyMap,ClearKeyError))(this,status);
}
void astSetKeyError_( AstKeyMap *this, int keyerror, int *status ){
   if( !astOK ) return;
   (**astMEMBER(this,KeyMap,SetKeyError))(this,keyerror,status);
}

void astClearSortBy_( AstKeyMap *this, int *status ){
   if( !astOK ) return;
   (**astMEMBER(this,KeyMap,ClearSortBy))(this,status);
}
void astSetSortBy_( AstKeyMap *this, int sortby, int *status ){
   if( !astOK ) return;
   (**astMEMBER(this,KeyMap,SetSortBy))(this,sortby,status);
}

void astClearKeyCase_( AstKeyMap *this, int *status ){
   if( !astOK ) return;
   (**astMEMBER(this,KeyMap,ClearKeyCase))(this,status);
}
void astSetKeyCase_( AstKeyMap *this, int keycase, int *status ){
   if( !astOK ) return;
   (**astMEMBER(this,KeyMap,SetKeyCase))(this,keycase,status);
}