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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<!-- $Id: library.html,v 1.7 2001/10/23 06:04:09 miyayama Exp $ -->
<html lang="en-US">
<head>
<title>MDN library specification</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<link rev="made" href="mailto:idn-cmt@nic.ad.jp">
<link rel="stylesheet" type="text/css" href="spec.css">
</head>
<body>
<h1>MDN Library Specification</h1>
<ul>
<li><a href="#func-overview">Function Overview</a>
<li><a href="#module-list">Module List</a>
<li><a href="#module-desc">Details of Modules</a>
</ul>
<!-- =========================================================== -->
<hr>
<h2><a name="func-overview">Function Overview</a></h2>
<p>
The MDN library (libmdn, libmdnlite) is a group of modules that provide various
processing with respect to multilingual domain name conversion. This
library provides the following features.
</p>
<ul>
<li>Encoding (code set) conversion
<li>Normalization of character strings based on NAMEPREP
<li>Analysis and reassembly of DNS messages
<li>Loading of client configuration files
</ul>
<p>
All features are implemented in libmdn, however some of the feature of "Encoding (code set) conversion" is left out.
For details of the feature left out, <a href="#converter-overview">refer to Encoding (code set) conversion</a>.
How to use the feature not left out is quite as same as libmdn.
</p>
<p>
Unless it is specially noted, the description of this document is about common to both libmdn and libmdnlite.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="converter-overview">Encoding (code set) conversion</a></h3>
<p>
Converts character string encoding and returns the result. Inside the
MDN library, character strings are all handled as UTF-8 encoding. This
module provides the following functions.
</p>
<ul>
<li>Conversion from certain encoding methods to UTF-8
<li>Conversion from UTF-8 to certain encoding methods
</ul>
<p>
Encoding is roughly divided into the following two types.
</p>
<ul>
<li>Encoding used by applications (SJIS, EUC, etc.)
<li>Special encoding designed to be used for multilingual domain names
(Punycode, RACE, etc.)
</ul>
<p>
About this, libmdn supports both encoding method, however libmdnlite supports only the later encoding method.
</p>
<p>
For the former encoding conversion, <code>iconv()</code> function is used in libmdn.
In other words, in libmdnlite which supports the former encoding method, <code>iconv()</code> is not used.
</p>
<p>
For the later encoding method, a unique conversion function is implemented and used in libmdn and libmdnlite.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="nameprep-overview">Normalization of character strings based on NAMEPREP</a></h3>
<p>
According to the descriptions provided in NAMEPREP,
normalization-related modules are responsible for performing
normalization of given domain name character strings and, in the
character strings, mapping of characters and checking for inclusion of
prohibited character and unassigned codepoints.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="localmap-overview">Domain name mapping based on local rules</a></h3>
<p>
These functions perform local rule-based character mapping in addition
to NAMEPREP.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="dn-overview">Analysis and assembly of DNS messages</a></h3>
<p>
In the DNS proxy server (mdnsproxy), encoded domain names included in
DNS messages sent from the client are converted and normalized and the
result is sent to the DNS server. This process is comprised of the
following functions:
</p>
<ul>
<li>Analyzes DNS messages and extracts domain names
<li>Re-constructs DNS messages using converted domain names
</ul>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="localencoding-overview">Local encoding identification</a></h3>
<p>
Automatically identifies the local encoding (code set) used by the
application program. Basically, the application locale information is
used, though the local encoding (code set) can also be specified using
an environment variable.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="resconf-overview">Loading of client configuration file</a></h3>
<p>
When the application linked to the MDN library is used to perform
conversion or normalization, the encoding and normalization method to
be used is described in the configuration file. A function is provided
to load this file.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h2><a name="module-list">Module list</a></h2>
<p>
The MDN library consists of the following modules.
</p>
<dl>
<dt><a href="#ace"><code>ace</code> module</a>
<dd>Provides the common processes used by the amcacez and race domain
name conversion modules.
<dt><a href="#altdude"><code>altdude</code> module</a>
<dd>Conversion module for the proposed AltDUDE encoding domain name
encoding method.
<dt><a href="#amcacem"><code>amcacem</code> module</a>
<dd>Conversion module for the proposed AMC-ACE-M encoding domain
name encoding method.
<dt><a href="#amcaceo"><code>amcaceo</code> module</a>
<dd>Conversion module for the proposed AMC-ACE-O encoding domain
name encoding method.
<dt><a href="#amcacer"><code>amcacer</code> module</a>
<dd>Conversion module for the proposed AMC-ACE-R encoding domain
name encoding method.
<dt><a href="#amcacev"><code>amcacev</code> module</a>
<dd>Conversion module for the proposed AMC-ACE-V encoding domain
name encoding method.
<dt><a href="#amcacew"><code>amcacew</code> module</a>
<dd>Conversion module for the proposed AMC-ACE-W encoding domain
name encoding method.
<dt><a href="#amcacez"><code>amcacez</code> module</a>
<dd>Conversion module for the proposed Punycode (it was AMC-ACE-Z before) encoding domain
name encoding method.
<dt><a href="#api"><code>api</code> module</a>
<dd>Provides a high-level interface for applications to perform encoding conversion and normalization of
domain names.
<dt><a href="#brace"><code>brace</code> module</a>
<dd>Conversion module for the proposed BRACE encoding domain name
encoding method.
<dt><a href="#checker"><code>checker</code> module</a>
<dd>Checks whether characters that cannot be used in a domain name
are included therein.
<dt><a href="#converter"><code>converter</code> module</a>
<dd>Conversion module for character string encoding (code set).
<dt><a href="#debug"><code>debug</code> module</a>
<dd>Utility module for debug output.
<dt><a href="#delimitermap"><code>delimitermap</code> module</a>
<dd>Maps specific characters within a domain name to a period (.).
<dt><a href="#dn"><code>dn</code> module</a>
<dd>Extraction/compression module for domain names inside DNS
messages.
<dt><a href="#dude"><code>dude</code> module</a>
<dd>Conversion module for the proposed DUDE encoding domain name
encoding method.
<dt><a href="#filechecker"><code>filechecker</code> module</a>
<dd>Loads a file that defines characters that cannot be used in a
domain name, and checks whether a given character string contains
characters that cannot be used.
<dt><a href="#filemapper"><code>filemapper</code> module</a>
<dd>Loads a file that defines character mapping rules, and maps
characters within a domain name character string.
<dt><a href="#lace"><code>lace</code> module</a>
<dd>Conversion module for the proposed LACE encoding domain name
encoding method.
<dt><a href="#localencoding"><code>localencoding</code> module</a>
<dd>Guesses which encoding is used by the application.
<dt><a href="#log"><code>log</code> module</a>
<dd>Controls MDN library log output processing.
<dt><a href="#mace"><code>mace</code> module</a>
<dd>Conversion module for the proposed MACE encoding domain name
encoding method.
<dt><a href="#mapper"><code>mapper</code> module</a>
<dd>Performs mapping for the characters in the domain name.
<dt><a href="#mapselector"><code>mapselector</code> module</a>
<dd>Performs local mapping for the top level domain of a given
domain name.
<dt><a href="#msgheader"><code>msgheader</code> module</a>
<dd>Analyzes the header of the DNS message.
<dt><a href="#msgtrans"><code>msgtrans</code> module</a>
<dd>Converts the DNS message at the DNS proxy server.
<dt><a href="#nameprep"><code>nameprep</code> module</a>
<dd>Performs domain normalization, mapping, and prohibited character
checking according to the desriptions provided in NAMEPREP.
<dt><a href="#normalizer"><code>normalizer</code> module</a>
<dd>Normalizes character strings.
<dt><a href="#race"><code>race</code> module</a>
<dd>Conversion module for the proposed RACE encoding domain name
encoding method.
<dt><a href="#res"><code>res</code> module</a>
<dd>Provides a lower lever interface to perform encoding conversion
or normalization of domain names by the application.
<dt><a href="#resconf"><code>resconf</code> module</a>
<dd>Provides an interface to perform encoding conversion or
normalization of domain names by the application.
<dt><a href="#result"><code>result</code> module</a>
<dd>Handles the result code returned by each library function.
<dt><a href="#selectiveencode"><code>selectiveencode</code> module</a>
<dd>Finds domain names that include non-ASCII characters.
<dt><a href="#strhash"><code>strhash</code> module</a>
<dd>Implements a hash table that uses character strings as keys.
<dt><a href="#ucsmap"><code>ucsmap</code> module</a>
<dd>Registers character mapping rules and performs mapping.
<dt><a href="#ucsset"><code>ucsset</code> module</a>
<dd>Performs character registration.
<dt><a href="#unicode"><code>unicode</code> module</a>
<dd>Obtains various Unicode character properties.
<dt><a href="#unormalize"><code>unormalize</code> module</a>
<dd>Performs standard normalization defined by Unicode.
<dt><a href="#utf5"><code>utf5</code> module</a>
<dd>Performs basic processing of the proposed UTF-5 encoding domain
name encoding method.
<dt><a href="#utf6"><code>utf6</code> module</a>
<dd>Conversion module for the proposed UTF-6 encoding domain name
encoding method.
<dt><a href="#utf8"><code>utf8</code> module</a>
<dd>Performs basic processing of UTF-8 encoding character strings.
<dt><a href="#util"><code>util</code> module</a>
<dd>Provides common functions used by other modules.
<dt><a href="#version"><code>version</code> module</a>
<dd>Obtains library version information.
</dl>
<p>
The following diagram shows the invoking relationship of
modules. <code>debug</code> and <code>log</code> modules called by
most modules and <code>util</code> modules that store common functions
are omitted in the diagram.
</p>
<p class="center-image">
<img src="../../img/spec/libmdn_callgraph.jpg" alt="libmdn module graph">
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="historical-encodings">Already outdated encodings</a></h3>
<p>
As understand to see <a href="#module-list">Module list</a>, many encodings proposed for multilingual domain names are implemented in MDN library.
</p>
<p>
However, many of the encodings are dealed as already outdated encodings in mDNkit.
The outdated encodings cannot be compiled by usually installation step for mDNkit.
To use, need to specify <code>--enable-extra-ace</code> option of <code>configure</code> in installation.
At the same time, in future MDN library, these encodings subject to unsupport. Please keep in mind this point.
</p>
<p>
The position of each encodings is the following.
</p>
<dl>
<dt>Normally suported encodings
<dd>Punycode (it was AMC-ACE-Z before), DUDE, RACE
<dt>Already outdated encodings
<dd>AltDUDE, AMC-ACE-M, AMC-ACE-O, AMC-ACE-R, AMC-ACE-W, AMC-ACE-V,
BRACE, LACE, MACE, UTF-5, UTF-6
</dl>
<!-- =========================================================== -->
<hr>
<h2><a name="module-desc">Details of Modules</a></h2>
<p>
The specifications of all modules included in MDN library are
explained below. First, the values returned by functions used commonly
by the modules are explained, then each module is discussed in
detail.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="mdn_result_t">Values returned by API functions</a></h3>
<p>
Almost all API functions of the MDN library return values of
<code>mdn_result_t</code>, which is an enumeration type value. The
values and their meanings are explained below.
</p>
<dl>
<dt><code>mdn_success</code>
<dd>Processing was successful.
<dt><code>mdn_notfound</code>
<dd>The target of search processing could not be found.
<dt><code>mdn_invalid_encoding</code>
<dd>Incorrect conversion of encoded input character string.
<dt><code>mdn_invalid_syntax</code>
<dd>Incorrect file format.
<dt><code>mdn_invalid_name</code>
<dd>Specified name is incorrect.
<dt><code>mdn_invalid_message</code>
<dd>Entered DNS message is incorrect.
<dt><code>mdn_invalid_action</code>
<dd>Invalid character string conversion method specified.
<dt><code>mdn_invalid_codepoint</code>
<dd>Codepoint value of input character lies outside of specified
range.
<dt><code>mdn_buffer_overflow</code>
<dd>Insufficient buffer to store result.
<dt><code>mdn_noentry</code>
<dd>Specified item does not exist.
<dt><code>mdn_nomemory</code>
<dd>Memory allocation failed.
<dt><code>mdn_nofile</code>
<dd>Failed to load specified file.
<dt><code>mdn_nomapping</code>
<dd>Conversion could not be performed correctly because a character
in the encoded character string (code set) does not exist in the
target conversion character set.
<dt><code>mdn_context_required</code>
<dd>Indicates that context information is required to correctly
convert uppercase characters to lowercase characters.
<dt><code>mdn_prohibited</code>
<dd>Input character string includes character whose use is
prohibited.
<dt><code>mdn_failure</code>
<dd>Indicates that an error occurred that does not fall into any of
the above categories.
</dl>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="ace"><code>ace</code> module</a></h3>
<p>
The <code>ace</code> module provides the common processes used by the
<a href="#amcacez">amcacez</a>, <a href="#race">race</a> domain name
conversion modules. This module is packaged
as a low-level module for the <a href="#converter"><code>converter</code>
module</a>, and is not called by the application. It is indirectly
called when <code>Punycode</code> or <code>RACE</code> encoding conversion
is requested of the <a href="#converter"><code>converter</code>
module</a>.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ace_convert"><code>mdn__ace_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__ace_convert(mdn__ace_t ctx, mdn_converter_dir_t dir,
const char *from, char *to, size_t tolen)
</pre>
</blockquote>
<p>
Performs bi-directional conversion between ACE character strings and
UTF-8 character strings. It converts the input character string
<var>from</var> and writes it to the area specified by <var>to</var>
and <var>tolen</var>. If <var>dir</var> is
<code>mdn_converter_l2u</code>, it converts from ACE to UTF-8; if dir
is <code>mdn_converter_u2l</code>, it converts from UTF-8 to ACE.
</p>
<p>
The <var>ctx</var> type, <code>mdn_ace_t</code>, is defined as shown
below; and maintains the ACE prefix, suffix, and a pointer to the
actual conversion function.
</p>
<blockquote>
<pre>
enum { mdn__ace_prefix, mdn__ace_suffix };
typedef mdn_result_t
(*mdn__ace_proc_t)(const char *from, size_t fromlen,
char *to, size_t tolen);
typedef struct {
int id_type; /* mdn__ace_prefix/mdn__ace_suffix */
const char *id_str; /* prefix/suffix string */
mdn__ace_proc_t encoder;/* encode procedure */
mdn__ace_proc_t decoder;/* decode procedure */
} mdn__ace_t;
</pre>
</blockquote>
<p>
The following processing is performed when <var>dir</var> is
<code>mdn_converter_l2u</code>:
</p>
<ol>
<li>The domain name character string specified in <var>from</var> is
disassembled into labels, and steps 2 through 5 below are performed on
each label.
<li>The ACE prefix or suffix is extracted from the data specified in
<var>ctx</var>, and each label character string is checked to determine
if it matches this. If it does not match, the label character string
is copied as is without being converted.
<li>If the label character string does match, the matched prefix or
suffix is removed, the decode function specified by <var>ctx</var> is
called, and the label character string is converted to a UTF-8 encoded
label character string.
<li>The result of the decode function is checked to determine if it is
valid as a conventional ASCII domain name. If valid, the label cannot
be converted back to the original ACE, so an error results.
<li>The encoding function specified by <var>ctx</var> is called, and
the decoded character string is returned once more to ACE. It is then
compared to the original ACE character string, and, if it does not
match, error results.
<li>The conversion result of each label is assembled into a domain
name and stored in the area specified by <var>to</var>.
</ol>
<p>
The following processing is performed when <var>dir</var> is
<code>mdn_converter_u2l</code>:
</p>
<ol>
<li>The domain name character string specified by <var>from</var> is
disassembled into labels, and steps 2 through 4 below are performed on
each label.
<li>The label character string is checked to determine if it is valid
as a conventional ASCII domain name. If valid, there is no need to
convert it to ACE, so it is copied as is.
<li>The encoding function specified by <var>ctx</var> is called, and
the label character string is converted to ACE.
<li>The ACE prefix or suffix is extracted from the data specified by
<var>ctx</var>, and it is added to the character string resulting from
the ACE conversion.
<li>The conversion result of each label is assembled into a domain
name and stored in the area specified by <var>to</var>.
</ol>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="altdude"><code>altdude</code> module</a></h3>
<p>
The <code>altdude</code> module converts between the proposed
<a href="../../reference/draft/draft-ietf-idn-altdude-00.txt">AltDUDE
encoding</a> multilingual domain name encoding method and UTF-8
encoding. However, because this encoding is <a href="#historical-encodings">already outdated encoding</a>, be careful to use.
</p>
<p>
This module is packaged as a low-order module for the
<a href="#converter"><code>converter</code> module</a>, and is not
called directly from the application. It is called indirectly when
conversion to or from <code>AltDUDE</code> encoding is requested of
the <a href="#converter"><code>converter</code> module</a>.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__altdude_open"><code>mdn__altdude_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__altdude_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion to and from AltDUDE encoding. Actually, this does not
do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__altdude_close"><code>mdn__altdude_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__altdude_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion to or from AMC-ACE-M encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__altdude_convert"><code>mdn__altdude_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__altdude_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs bi-directional conversion between AltDUDE encoded character
strings and UTF-8 encoded character strings. It converts the input
character string <var>from</var> and writes the result to the area
specified by <var>to</var> and <var>tolen</var>. If <var>dir</var> is
<code>mdn_converter_l2u</code>, it converts the character string from
AltDUDE encoding to UTF-8 encoding; if dir is
<code>mdn_converter_u2l</code>, it converts the character string from
UTF-8 encoding to AltDUDE encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="amcacem"><code>amcacem</code> module</a></h3>
<p>
The <code>amcacem</code> module converts between the proposed
<a href="../../reference/draft/draft-ietf-idn-amc-ace-m-00.txt">
AMC-ACE-M encoding</a> multilingual domain name encoding method and
UTF-8 encoding. However, because this encoding is <a href="#historical-encodings">already outdated encoding</a>, be careful to use.
</p>
<p>
This module is packaged as a low-order module for the
<a href="#converter"><code>converter</code> module</a>, and is not
called directly by the application. It is called indirectly when
conversion to or from <code>AMC-ACE-M</code> encoding is requested of
the <a href="#converter"><code>converter</code> module</a>.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacem_open"><code>mdn__amcacem_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacem_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion to or from AMC-ACE-M encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacem_close"><code>mdn__amcacem_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacem_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion to or from AMC-ACE-M encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacem_convert"><code>mdn__amcacem_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacem_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs bi-directional conversion between AMC-ACE-M encoded character
strings and UTF-8 encoded character strings. It converts the input
character string <var>from</var> and writes the result to the area
specified by <var>to</var> and <var>tolen</var>. If <var>dir</var> is
<code>mdn_converter_l2u</code>, it converts the character string from
AMC-ACE-M encoding to UTF-8 encoding; if dir is
<code>mdn_converter_u2l</code>, it converts the character string from
UTF-8 encoding to AMC-ACE-M encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="amcaceo"><code>amcaceo</code> module</a></h3>
<p>
The <code>amcaceo</code> module converts between the proposed
<a href="../../reference/draft/draft-ietf-idn-amc-ace-o-00.txt">AMC-ACE-O
encoding</a> multilingual domain name encoding method and UTF-8
encoding. This module is packaged as a low-order module for the
<a href="#converter"><code>converter</code> module</a>, and is not
called directly by the application. It is called indirectly when
conversion to or from <code>AMC-ACE-O</code> encoding is requested of
the <a href="#converter"><code>converter</code> module</a>.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcaceo_open"><code>mdn__amcaceo_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcaceo_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion to or from AMC-ACE-O encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcaceo_close"><code>mdn__amcaceo_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcaceo_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion to or from AMC-ACE-O encoding, but does not actually
perform any action. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcaceo_convert"><code>mdn__amcaceo_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcaceo_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs bi-directional conversion between AMC-ACE-O encoded character
strings and UTF-8 encoded character strings. It converts the input
character string <var>from</var> and writes the result to the area
specified by <var>to</var> and <var>tolen</var>. If <var>dir</var> is
<code>mdn_converter_l2u</code>, it converts the character string from
AMC-ACE-O encoding to UTF-8 encoding; if dir is
<code>mdn_converter_u2l</code>, it converts the character string from
UTF-8 encoding to AMC-ACE-O encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="amcacer"><code>amcacer</code> module</a></h3>
<p>
The <code>amcacer</code> module converts between the proposed
<a href="../../reference/draft/draft-ietf-idn-amc-ace-r-01.txt">
AMC-ACE-R encoding</a> multilingual domain name encoding method and
UTF-8 encoding. However, because this encoding is <a href="#historical-encodings">already outdated encoding</a>, be careful to use.
</p>
<p>
This module is packaged as a low-order module for the
<a href="#converter"><code>converter</code> module</a>, and is not
called directly by the application. It is called indirectly when
conversion to or from <code>AMC-ACE-R</code> encoding is requested of
the <a href="#converter"><code>converter</code> module</a>.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacer_open"><code>mdn__amcacer_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacer_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion to or from AMC-ACE-R encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacer_close"><code>mdn__amcacer_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacer_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion to or from AMC-ACE-R encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacer_convert"><code>mdn__amcacer_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacer_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs bi-directional conversion between AMC-ACE-R encoded character
strings and UTF-8 encoded character strings. It converts the input
character string <var>from</var> and writes the result to the area
specified by <var>to</var> and <var>tolen</var>. If <var>dir</var> is
<code>mdn_converter_l2u</code>, it converts the character string from
AMC-ACE-R encoding to UTF-8 encoding; if dir is
<code>mdn_converter_u2l</code>, it converts the character string from
UTF-8 encoding to AMC-ACE-R encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="amcacev"><code>amcacev</code> module</a></h3>
<p>
The <code>amcacev</code> module converts between the proposed
<a href="../../reference/draft/draft-ietf-idn-amc-ace-v-00.txt">
AMC-ACE-V encoding</a> multilingual domain name encoding method and
UTF-8 encoding. However, because this encoding is <a href="#historical-encodings">already outdated encoding</a>, be careful to use.
</p>
<p>
This module is packaged as a low-order module for the
<a href="#converter"><code>converter</code> module</a>, and is not
called directly by the application. It is called indirectly when
conversion to or from <code>AMC-ACE-V</code> encoding is requested of
the <a href="#converter"><code>converter</code> module</a>.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacev_open"><code>mdn__amcacev_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacev_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion to or from AMC-ACE-V encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacev_close"><code>mdn__amcacev_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacev_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion to or from AMC-ACE-V encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacev_convert"><code>mdn__amcacev_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacev_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs bi-directional conversion between AMC-ACE-V encoded character
strings and UTF-8 encoded character strings. It converts the input
character string <var>from</var> and writes the result to the area
specified by <var>to</var> and <var>tolen</var>. If <var>dir</var> is
<code>mdn_converter_l2u</code>, it converts the character string from
AMC-ACE-V encoding to UTF-8 encoding; if dir is
<code>mdn_converter_u2l</code>, it converts the character string from
UTF-8 encoding to AMC-ACE-V encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="amcacew"><code>amcacew</code> module</a></h3>
<p>
The <code>amcacew</code> module converts between the proposed
<a href="../../reference/draft/draft-ietf-idn-amc-ace-w-00.txt">
AMC-ACE-W encoding</a> multilingual domain name encoding method and
UTF-8 encoding. However, because this encoding is <a href="#historical-encodings">already outdated encoding</a>, be careful to use.
</p>
<p>
This module is packaged as a low-order module for the
<a href="#converter"><code>converter</code> module</a>, and is not
called directly by the application. It is called indirectly when
conversion to or from <code>AMC-ACE-W</code> encoding is requested of
the <a href="#converter"><code>converter</code> module</a>.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacew_open"><code>mdn__amcacew_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacew_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion to or from AMC-ACE-W encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacew_close"><code>mdn__amcacew_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacew_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion to or from AMC-ACE-W encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacew_convert"><code>mdn__amcacew_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacew_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs bi-directional conversion between AMC-ACE-W encoded character
strings and UTF-8 encoded character strings. It converts the input
character string <var>from</var> and writes the result to the area
specified by <var>to</var> and <var>tolen</var>. If <var>dir</var> is
<code>mdn_converter_l2u</code>, it converts the character string from
AMC-ACE-W encoding to UTF-8 encoding; if dir is
<code>mdn_converter_u2l</code>, it converts the character string from
UTF-8 encoding to AMC-ACE-W encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="amcacez"><code>amcacez</code> module</a></h3>
<p>
The <code>amcacez</code> module converts between the proposed
<a href="../../reference/draft/draft-ietf-idn-punycode-00.txt">
Punycode</a> encoding (it was AMC-ACE-Z before) multilingual domain name encoding method and
UTF-8 encoding.
</p>
<p>
This module is packaged as a low-order module for the
<a href="#converter"><code>converter</code> module</a>, and is not
called directly by the application. It is called indirectly when
conversion to or from <code>Punycode</code> encoding is requested of
the <a href="#converter"><code>converter</code> module</a>.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacez_open"><code>mdn__amcacez_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacez_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion to or from Punycode encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacez_close"><code>mdn__amcacez_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacez_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion to or from Punycode encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__amcacez_convert"><code>mdn__amcacez_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__amcacez_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs bi-directional conversion between Punycode encoded character
strings and UTF-8 encoded character strings. It converts the input
character string <var>from</var> and writes the result to the area
specified by <var>to</var> and <var>tolen</var>. If <var>dir</var> is
<code>mdn_converter_l2u</code>, it converts the character string from
Punycode encoding to UTF-8 encoding; if dir is
<code>mdn_converter_u2l</code>, it converts the character string from
UTF-8 encoding to Punycode encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="api"><code>api</code> module</a></h3>
<p>
The <code>api</code> module provides a high-level interface for the
applications to perform encoding conversion and
normalization of domain names.
</p>
<p>
Since general applications will use this module, it has been designed
to enable the developer to easily perform a series of processes on
multilingual domain names. Any developer who wishes to perform
specialized processing not supported by this module can use the
<a href="#res"><code>res</code> module</a>, which provides a
lower-level interface.
</p>
<p>
In addition, in the case of setting <a href="../guide/resolvconfig.html#mdn_disable">environment variable MDN_DISABLE</a>, even if using the functions for string conversion which are cited in the following, conversion of strings is not performed, but returned the result as the original string.
In the case of performing conversion of strings forcibly in setting MDN_DISABLE environment, or wanting to assure constant performance whether setting MDN_DISABLE or not in using these API functions in applications, <a href="#mdn_enable"><code>mdn_enable</code></a> must be used on ahead.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_enable"><code>mdn_enable</code></a></h4>
<blockquote>
<pre>
void
mdn_enable(int on_off);
</pre>
</blockquote>
<p>
Usually, in the case of defining <a href="../guide/resolvconfig.html#mdn_disable">environment variable MDN_DISABLE</a>, process of domain name conversion is not performed, but the result as the original string is returned, however this function can overrides the setting.
</p>
<p>
Whether MDN_DISABLE is set or not, if this function is used with setting a value other than 0 for <var>on_off</var>, conversion of domain name become to
perform subsequently.
If setting 0, contrary conversion of domain name is not performed, but the result as the original string is returned.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_nameinit"><code>mdn_nameinit</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_nameinit(void);
</pre>
</blockquote>
<p>
Initializes the entire library, using configuration settings it loads
from a predetermined file (<code>mdn.conf</code>).Initialization will
therafter not be performed for any subsequent calls to this
function. If <code>mdn_encodename</code> or
<code>mdn_decodename</code> (described below) is called before this
function is called, initialization is automatically performed before
encoding or decoding processing occurs.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nofile</code>,
<code>mdn_invalid_syntax</code>,
<code>mdn_invalid_name</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_encodename"><code>mdn_encodename</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_encodename(int actions, const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
Encodes a domain name. It converts the input character string in
<var>from</var> and writes the result to the area specified by
<var>to</var> and <var>tolen</var>.
</p>
<p>
Specify the encoding behavior you wish <code>mdn_encodename</code> to
perform in <var>actions</var>. Specify such that the value is
yielded by logically OR'ing the flags that are listed below (Ex:
<code>MDN_NAMEPREP | MDN_IDNNCONV</code>). The specified behaviors are
perfomed in the order given below.
</p>
<dl>
<dt><code>MDN_LOCALCONV</code>
<dd>Converts local encoding character strings (shift_JIS, Big5,
etc.), to UTF-8. (It is available only in libmdn, not available in libmdnlite.)
<dt><code>MDN_DELIMMAP</code>
<dd>Converts specific characters to periods (U+002E FULL STOP).
<dt><code>MDN_LOCALMAP</code>
<dd>Performs local mapping for the top level domain of a given
domain name.
<dt><code>MDN_NAMEPREP</code>
<dd>Performs normalization of strings by NAMEPREP. Performs mapping,
normalization and determination of whether invalid characters or
unassigned code points are included. (If included, return error code
<code>mdn_prohibited</code>.)
<dt><code>MDN_UNASCHECK</code>
<dd>Determines if the domain name includes a code number that is not
assigned in Unicode.
<dd>The flag have been left for compatibility with older mDNkit. (Refer to the following.)
<dt><code>MDN_IDNCONV</code>
<dd>Converts UTF-8 character strings to a multilingual domain
encoding (Punycode, RACE, etc.)
</dl>
<p>
Additionally, for the developer's convenience, we also provide
<code>MDN_ENCODE_APP</code>
Usually applications will set this <code>MDN_ENCODE_APP</code> to
<code>actions</code>.
In the case of using libmdn as library, this flag is equivalent the following specification (performing all flags).
</p>
<blockquote>
<pre>
MDN_LOCALCONV | MDN_DELIMMAP | MDN_LOCALMAP | MDN_NAMEPREP | MDN_IDNCONV
</pre>
</blockquote>
<p>
In the case of using libmdnlite, it is equivalent the following specification (performing all except for <code>MDN_LOCALCONV</code>).
</p>
<blockquote>
<pre>
MDN_DELIMMAP | MDN_LOCALMAP | MDN_NAMEPREP | MDN_IDNCONV
</pre>
</blockquote>
<p>
If nothing is specified in <code>actions</code>
(that is, 0 is specified), the character string is simply copied.
</p>
<p>
In addition, before mDNkit version 2.4, if <code>MDN_NAMEPREP</code> flag is not specified, unassigned code point check is not performed, it is nessesary to specify <code>MDN_UNASCHECK</code> additionally to perform check.
If you exclude unassigned code point check from <code>MDN_NAMEPREP</code> process, specify the following expression instead of <code>MDN_NAMEPREP</code>.
(This is almost never inescapably with general application. )
</p>
<blockquote>
<pre>
(MDN_NAMEPREP ^ MDN_UNASCHECK)
</pre>
</blockquote>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_invalid_syntax</code>,
<code>mdn_invalid_name</code>,
<code>mdn_invalid_action</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_nomemory</code>,
<code>mdn_nofile</code>,
<code>mdn_prohibited</code>.
</p>
<p>
If <code>MDN_LOCALCONV</code> is specified in using libmdnlite, <code>mdn_invalid_action</code> is returned.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_decodename"><code>mdn_decodename</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_decodename(int actions, const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
Decodes a domain name. It converts the input character string
<code>from</code> and writes the result to the area specified by
<var>to</var> and <var>tolen</var>.
</p>
<p>
Specify the encoding behavior you wish <code>mdn_decodename</code> to
perform in <var>actions</var>. Specify such that the value is
yielded by logically OR'ing the flags that are listed below. The
specified behaviors are perfomed in the order given below.
</p>
<dl>
<dt><code>MDN_IDNCONV</code>
<dd>Converts UTF-8 character strings to a multilingual domain
encoding (Punycode, RACE, etc.)
<dt><code>MDN_NAMEPREP</code>
<dd>Performs determination of whether the string is correctly
performed NAMEPREP (whether normalization and mapping are
performed and invalid characters or unassigned code points are
included).
<dt><code>MDN_UNASCHECK</code>
<dd>The flag have been left for compatibility with older mDNkit. (Refer to the following.)
<dt><code>MDN_LOCALCONV</code>
<dd>Converts local encoding character strings (shift_JIS, Big5,
etc.), to UTF-8. (It is available only in libmdn, not available in libmdnlite.)
</dl>
<p>
Additionally, for the developer's convenience, we also provide
<code>MDN_DECODE_APP</code>
Usually applications will set this <code>MDN_DECODE_APP</code> to
<code>actions</code>.
In the case of using libmdn as library, this flag is equivalent the following specification.
</p>
<blockquote>
<pre>
MDN_IDNCONV | MDN_NAMEPREP | MDN_LOCALCONV
</pre>
</blockquote>
<p>
In the case of using libmdnlite, it is equivalent the following specification.
</p>
<blockquote>
<pre>
MDN_IDNCONV | MDN_NAMEPREP
</pre>
</blockquote>
<p>
If nothing is specified in <code>actions</code>
(that is, 0 is specified), the character string is simply copied.
</p>
<p>
In addition, before mDNkit version 2.4, if <code>MDN_NAMEPREP</code> flag is not specified, unassigned code point check is not performed, it is nessesary to specify <code>MDN_UNASCHECK</code> additionally to perform check.
If you exclude unassigned code point check from <code>MDN_NAMEPREP</code> process, specify the following expression instead of <code>MDN_NAMEPREP</code>.
(This is almost never inescapably with general application. )
</p>
<blockquote>
<pre>
(MDN_NAMEPREP ^ MDN_UNASCHECK)
</pre>
</blockquote>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_invalid_syntax</code>,
<code>mdn_invalid_name</code>,
<code>mdn_invalid_action</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_nomemory</code>,
<code>mdn_nofile</code>,
<code>mdn_prohibited</code>.
</p>
<p>
If <code>MDN_LOCALCONV</code> is specified in using libmdnlite, <code>mdn_invalid_action</code> is returned.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_localtoutf8"><code>mdn_localtoutf8</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_localtoutf8(const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
This entity is a cpp macro, which is equivalent to
<code>mdn_encodename(MDN_LOCAlCONV, from, to, tolen)</code>.
</p>
<p>
This function is available in libmdn. If using in libmdnlite, <code>mdn_invalid_action</code> is returned.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_delimitermap"><code>mdn_delimitermap</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_delimitermap(const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
This entity is a cpp macro, which is equivalent to
<code>mdn_encodename(MDN_DELIMMAP, from, to, tolen)</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_localmap"><code>mdn_localmap</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_localmap(const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
This entity is a cpp macro, which is equivalent to
<code>mdn_encodename(MDN_LOCALMAP, from, to, tolen)</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_nameprep"><code>mdn_nameprep</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_nameprep(const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
This entity is a cpp macro, which is equivalent to
<code>mdn_encodename(MDN_NAMEPREP, from, to, tolen)</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_nameprepcheck"><code>mdn_nameprepcheck</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_nameprepcheck(const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
This entity is a cpp macro, which is equivalent to
<code>mdn_decodename(MDN_NAMEPREP, from, to, tolen)</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_utf8toidn"><code>mdn_utf8toidn</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_utf8toidn(const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
This entity is a cpp macro, which is equivalent to
<code>mdn_encodename(MDN_IDNCONV, from, to, tolen)</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_idntoutf8"><code>mdn_idntoutf8</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_idntoutf8(const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
This entity is a cpp macro, which is equivalent to
<code>mdn_decodename(MDN_IDNCONV, from, to, tolen)</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_utf8tolocal"><code>mdn_utf8tolocal</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_utf8tolocal(const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
This entity is a cpp macro, which is equivalent to
<code>mdn_decodename(MDN_LOCALCONV, from, to, tolen)</code>.
</p>
<p>
This function is available in libmdn. If using in libmdnlite, <code>mdn_invalid_action</code> is returned.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_localtoidn"><code>mdn_localtoidn</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_localtoidn(const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
This entity is cpp macro, which is equivalent to
<code>mdn_encodename(MDN_ENCODE_APP, from, to, tolen)</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_idntolocal"><code>mdn_idntolocal</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_idntolocal(const char *from, char *to, size_t tolen);
</pre>
</blockquote>
<p>
This entity is cpp macro, which is equivalent to
<code>mdn_decodename(MDN_DECODE_APP, from, to, tolen)</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="brace"><code>brace</code> module</a></h3>
<p>
The <code>brace</code> module performs conversion between UTF-8 and
the proposed
<a href="../../reference/draft/draft-ietf-idn-brace-00.txt">BRACE
encoding</a> of multilingual domain names. However, because this encoding is <a href="#historical-encodings">already outdated encoding</a>, be careful to use.
</p>
<p>
This module is implemented
as a low-order <a href="#converter"><code>converter</code> module</a>,
and is not directly called by the application. When
<a href="#converter"><code>converter</code> module</a> is requested in
association with <code>BRACE</code> encoding conversion, this module
is indirectly called.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__brace_open"><code>mdn__brace_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__brace_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion context used for BRACE encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__brace_close"><code>mdn__brace_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__brace_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion context used for BRACE encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__brace_convert"><code>mdn__brace_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__brace_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs bi-directional conversion of BRACE and UTF-8 encoded character
strings. The <var>from</var> input character string is converted and
the result is written in the area specified by <var>to</var> and
<var>tolen</var>. When <var>dir</var> is
<code>mdn_converter_l2u</code>, BRACE strings are converted to UTF-8
encoding and when dir is <code>mdn_converter_u2l</code>, UTF-8 strings
are converted to BRACE encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="checker"><code>checker</code> module</a></h3>
<p>
The <code>checker</code> module checks whether characters that cannot
be used in the domain name are included therein.
</p>
<p>
It currently supports the check schemes given below:
</p>
<ul>
<li>NAMEPREP prohibited character checking
<li>NAMEPREP unassigned codepoint checking
<li>Checking by loading and following the descriptions in a file that
defines prohibited characters and unassigned codepoints.
</ul>
<p>
In addition, we also provide an API for registering additional check
schemes.
</p>
<p>
The <code>checker</code> module uses the concept of a "check context."
First, before checking, a check context is created and the check
schemes to be used are registered to this context. During the actual
check processing, this check context is specified, rather than an
actual check scheme. This check context is of type
<code>mdn_checker_t</code>, which is defined as the opaque type given
below.
</p>
<blockquote>
<pre>
typedef struct mdn_checker *mdn_checker_t;
</pre>
</blockquote>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_checker_initialize"><code>mdn_checker_initialize</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_checker_initialize(void)
</pre>
</blockquote>
<p>
Initializes the checker module. Always call this function before
calling any other API function of the module.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_checker_create"><code>mdn_checker_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_checker_create(mdn_checker_t *ctxp)
</pre>
</blockquote>
<p>
Creates an empty context for use in checking and stores it in the area
pointed to by <var>ctxp</var>. Since the returned context is empty, it
contains no check schemes. To add one or more check schemes, use
<a href="#mdn_checker_add"><code>mdn_checker_add</code></a> or
<a href="#mdn_checker_addall"><code>mdn_checker_addall</code></a>.
When created by a context, the context reference count becomes 1.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_checker_destroy"><code>mdn_checker_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn_checker_destroy(mdn_checker_t ctx)
</pre>
</blockquote>
<p>
Decrements the reference count of the check context created by
<a href="#mdn_checker_create"><code>mdn_checker_create</code></a> by
one. If, as a result, the count becomes 0, it deletes the context, and
releases the allocated memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_checker_incrref"><code>mdn_checker_incrref</code></a></h4>
<blockquote>
<pre>
void
mdn_checker_incrref(mdn_checker_t ctx)
</pre>
</blockquote>
<p>
Increments the reference count of the check context created by
<a href="#mdn_checker_create"><code>mdn_checker_create</code></a> by
one.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_checker_add"><code>mdn_checker_add</code></a></h4>
<blockquote>
<pre>
extern mdn_result_t
mdn_checker_add(mdn_checker_t ctx, const char *name)
</pre>
</blockquote>
<p>
Adds the check scheme specified by <var>name</var> to the check
context created by
<a href="#mdn_checker_create"><code>mdn_checker_create</code></a>.
Multiple check schemes can be added to a single context.
</p>
<p>
The formats for the check scheme <var>name</var> are shown below:
</p>
<dl>
<dt><code>MDN_CHECKER_PROHIBIT_PREFIX</code><var><nameprep-version></var>
<dd>Checks for the prohibited characters provided in NAMEPREP
version <var><nameprep-version></var>.
<dt><code>MDN_CHECKER_UNASSIGNED_PREFIX</code><var><nameprep-version></var>
<dd>Checks for the unassigned codepoints provided in NAMEPREP
version <var><nameprep-version></var>.
<dt><code>MDN_CHECKER_PROHIBIT_PREFIX fileset</code>:<var><path></var>
<dd>Loads the prohibited character definitions in the file specified
by <var><path></var>, and checks as therein described. For
information on the file's description format, see the
<a href="clientconfig.html#setfile-format">Set File Format</a> section.
<dt><code>MDN_CHECKER_UNASSIGNED_PREFIX fileset</code>:<var><path></var>
<dd>Loads the unassigned codepoint definitions from a file, and
checks as therein described. For information on the file's description
format, see the
<a href="clientconfig.html#setfile-format">Set File Format</a> section.
<dt><var><prefix></var><code>:</code><var><parameter></var>
<dd>Checks according to <var><prefix></var> the check scheme
registered by
<a href="#mdn_checker_register"><code>mdn_checker_register</code></a>.
<var><parameter></var> is passed to the registered function
create as an argument <var><parameter></var>.
</dl>
<p>
<code>MDN_CHECKER_PROHIBIT_PREFIX</code> and
<code>MDN_CHECKER_UNASSIGNED_PREFIX</code> are cpp macros, and it is
the values from these macros that are actually used. In addition,
no whitespace can appear between the macro and its following
<code>fileset</code> or <var><nameprep-version></var>. Thus,
character string <var>name</var> is actually generated using the
method shown below:
</p>
<blockquote>
<pre>
sprintf(name, "%s%s", MDN_CHECKER_PROHIBIT_PREFIX, nameprep_version);
sprintf(name, "%sfileset:%s", MDN_CHECKER_UNASSIGNED_PREFIX, file_path);
</pre>
</blockquote>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_name</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_checker_addall"><code>mdn_checker_addall</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_checker_addall(mdn_checker_t ctx, const char **names, int nnames)
</pre>
</blockquote>
<p>
Other than the fact that <code>mdn_checker_addall</code> adds multiple
check schemes at once, it is identical to
<a href="#mdn_checker_add"><code>mdn_checker_add</code></a>. Each
element in the array <var>names</var> of length <var>nnames</var> is
registered as a check scheme. If all schemes are added successfully,
it returns <code>mdn_success</code>. If registration fails, only the
schemes described prior to the failed scheme are registered to context
<code>ctx</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_checker_lookup"><code>mdn_checker_lookup</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_checker_lookup(mdn_checker_t ctx, const char *utf8,
const char **found)
</pre>
</blockquote>
<p>
Checks the UTF-8 encoded character string <var>utf8</var> using the
check schemes specified in <var>ctx</var>. If the character string
includes any prohibited characters or unassigned codepoints, the start
position of the offending character or codepoint is stored in
<var>found</var>. If no illegal characters are included, the function
returns <code>NULL</code>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_checker_register"><code>mdn_checker_register</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_checker_register(const char *prefix,
mdn_checker_createproc_t create,
mdn_checker_destroyproc_t destroy,
mdn_checker_lookupproc_t lookup)
</pre>
</blockquote>
<p>
Registers a new check scheme. The check scheme name is specified in
<var>prefix</var>. The check scheme is specified using this name when
a check scheme is added to a context with
<a href="#mdn_checker_add"><code>mdn_checker_add</code></a> or
<a href="#mdn_checker_addall"><code>mdn_checker_addall</code></a>.
</p>
<p>
<var>create</var>, <var>destroy</var>, and <var>lookup</var> specify
the respective function you wish to call when
<a href="#mdn_checker_create"><code>mdn_checker_create</code></a>,
<a href="#mdn_checker_destroy"><code>mdn_checker_destroy</code></a>, or
<a href="#mdn_checker_lookup"><code>mdn_checker_lookup</code></a>
processing is performed. Each of these functions must have the
following parameters and return values.
</p>
<blockquote>
<pre>
typedef mdn_result_t (*mdn_checker_createproc_t)
(const char *parameter, void **ctxp);
typedef void (*mdn_checker_destroyproc_t)
(void *ctx);
typedef mdn_result_t (*mdn_checker_lookupproc_t)
(void *ctx, const char *utf8, const char **found);
</pre>
</blockquote>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="converter"><code>converter</code> module</a></h3>
<p>
<code>converter</code> module converts character string encoding (code
set). Because the MDN library uses UTF-8 character strings for
internal processing, this module performs bi-directional conversion
between the local encoding method and UTF-8.
</p>
<p>
Support is currently provided for the following encoding methods.
</p>
<ul>
<li><code>iconv()</code> encoding method support<br>
The iconv() function provides general code set conversion functions
and encoding support. The encoding methods supported by iconv() are
implementation-dependent; in that regard, refer to the documentation
included with iconv() for information on which encoding is actually
available.
Moreover, this encoding method can be used in libmdn. it cannot be used in libmdnlite.
<li>Various encodings of multilingual domain names<br>
Many encodings are proposed for multilingual domain names,
then MDN library supports many of these.
About the encodings supported by library, refer to <a href="#historical-encodings">already outdated encodings</a>.
This encoding method can be used both in libmdn and libmdnlite.
</ul>
<p>
The <code>converter</code> module is specially designed for encoding
conversion of domain names and is not suitable for general encoding
conversion. For example, Punycode, RACE, and DUDE
encoding provide special handling of the delimiting periods used in
domain names.
</p>
<p>
The <code>converter</code> module employs the "code conversion
context" concept. When performing bi-directional conversion between a
specific encoding method and UTF-8, first the code conversion context
of that encoding is created. For actual code conversion, the encoding
is not directly specified; instead this code conversion context is
specified. The code conversion context is <code>mdn_converter_t</code>
and is defined as the following opaque type.
</p>
<blockquote>
<pre>
typedef struct mdn_converter *mdn_converter_t;
</pre>
</blockquote>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_converter_initialize"><code>mdn_converter_initialize</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_converter_initialize(void)
</pre>
</blockquote>
<p>
Initializes the module. This function is always called before calling
other API functions of this module.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_converter_create"><code>mdn_converter_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_converter_create(const char *name, mdn_converter_t *ctxp,
int delayedopen)
</pre>
</blockquote>
<p>
Creates the code conversion context used for conversion between the
local encoding specified by <var>name</var> and UTF-8, then
initializes and stores it in the area specified by
<var>ctxp</var>. When created by a context, the context reference
count becomes 1.
</p>
<p>
As encoding schemes, the system currently provides <code>Punycode</code>,
<code>RACE</code>, and <code>DUDE</code> conversion functions. For
encoding methods other than those listed above, conversion is
performed using the <code>iconv()</code> utility provided with the
system. In such a case, when this function is invoked
<code>iconv_open()</code> is called. When <var>delayedopen</var> is
true, calling of <code>iconv_open()</code> is delayed until the
character string is actually converted.
</p>
<p>
In addition,
<a href="#mdn_converter_register"><code>mdn_converter_register</code></a>
can be also used to add new local encoding methods.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_name</code>,
<code>mdn_nomemory</code>,
<code>mdn_failure</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_converter_destroy"><code>mdn_converter_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn_converter_destroy(mdn_converter_t ctx)
</pre>
</blockquote>
<p>
Decrements the reference count of the code conversion context created by
<a href="#mdn_converter_create"><code>mdn_converter_create</code></a>
by one. If, as a result, the count becomes 0, it deletes the context,
and releases the allocated memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_converter_incrref"><code>mdn_converter_incrref</code></a></h4>
<blockquote>
<pre>
void
mdn_converter_incrref(mdn_converter_t ctx)
</pre>
</blockquote>
<p>
Increments the reference count of the code conversion context created by
<a href="#mdn_converter_create"><code>mdn_converter_create</code></a>
by one.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_converter_convert"><code>mdn_converter_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_converter_convert(mdn_converter_t ctx,
mdn_converter_dir_t dir, const char *from,
char *to, size_t tolen)
</pre>
</blockquote>
<p>
Uses the code conversion context created by
<a href="#mdn_converter_create"><code>mdn_converter_create</code></a>
to perform code conversion of character strings <var>from</var> and
stores the result in <var>to</var>. <var>tolen</var> is the length of
<var>to</var>. <var>dir</var> is used to specify the direction of
conversion.
</p>
<dl>
<dt><code>mdn_converter_l2u</code>
<dd>Converts from the encoding set in the context to UTF-8 encoding.
<dt><code>mdn_converter_u2l</code>
<dd>Converts from UTF-8 to the encoding set in the context.
</dl>
<p>
The set encoding is the encoding specified by
<a href="#mdn_converter_create"><code>mdn_converter_create</code></a>.
</p>
<p>
Unlike <code>iconv()</code>, when status-dependent encoding such as
<code>ISO-2022-JP</code> is used, the status that is in effect when
the function is called the first time is not maintained when this
function is called the next time. Conversion starts from the initial
status each time.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_invalid_name</code>,
<code>mdn_nomemory</code>,
<code>mdn_failure</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_converter_localencoding"><code>mdn_converter_localencoding</code></a></h4>
<blockquote>
<pre>
char *
mdn_converter_localencoding(mdn_converter_t ctx)
</pre>
</blockquote>
<p>
Returns the local encoding name of the code conversion context <var>ctx</var>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_converter_isasciicompatible"><code>mdn_converter_isasciicompatible</code></a></h4>
<blockquote>
<pre>
int
mdn_converter_isasciicompatible(mdn_converter_t ctx)
</pre>
</blockquote>
<p>
Returns whether the local encoding of the code conversion
context <var>ctx</var> is ASCII-compatible. If the encoding is
ASCII-compatible, 1 is returned; if not, 0 is returned.
</p>
<p>
<cite>ASCII-compatible encoding</cite> consists of only alphenumeric
characters and hyphens, meaning it is not possible to differentiate
between domain names encoded using this encoding and standard ASCII
domain names. Specifically, Punycode encoding is of this type. These types
of encoding are not generally used for local encoding by applications
but are strong candidates for the encoding used to express domain
names in the DNS protocol (because conventional DNS servers can be
used without modification).
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_converter_addalias"><code>mdn_converter_addalias</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_converter_addalias(const char *alias_name, const char *real_name)
</pre>
</blockquote>
<p>
Used to register the alias <var>alias_name</var> for the encoding name
<var>real_name</var>. Registered aliases can be specified in the
<var>name</var> argument of
<a href="#mdn_converter_create"><code>mdn_converter_create</code></a>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_converter_aliasfile"><code>mdn_converter_aliasfile</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_converter_aliasfile(const char *path)
</pre>
</blockquote>
<p>
Loads the file specified by the <var>path</var> variable and registers
the alias in accordance with the contents of the file. The file
<var>path</var> is a text file consisting of the following simple
format.
</p>
<blockquote>
<pre>
Alias Formal name
</pre>
</blockquote>
<p>
Comment lines begin with <code>#</code>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nofile</code>,
<code>mdn_invalid_syntax</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_converter_resetalias"><code>mdn_converter_resetalias</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_converter_resetalias(void)
</pre>
</blockquote>
<p>
Resets aliases registered using
<a href="#mdn_converter_addalias"><code>mdn_converter_addalias</code></a>
or
<a href="#mdn_converter_aliasfile"><code>mdn_converter_aliasfile</code></a>
to the initial default status (where no aliases are registered).
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_converter_register"><code>mdn_converter_register</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_converter_register(const char *name,
mdn_converter_openproc_t open,
mdn_converter_closeproc_t close,
mdn_converter_convertproc_t convert,
int ascii_compatible)
</pre>
</blockquote>
<p>
Adds the encoding conversion function between the <var>name</var>
local encoding method and UTF-8. <var>open</var>, <var>close</var>,
and <var>convert</var> are used as pointers to processing functions
such as conversion. 1 specifies <var>ascii_compatible</var> local
encoding, 0 that local encoding is not ASCII compatible.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="debug"><code>debug</code> module</a></h3>
<p>
The <code>debug</code> module is a utility module for debug output.
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_debug_hexstring"><code>mdn_debug_hexstring</code></a></h4>
<blockquote>
<pre>
char *
mdn_debug_hexstring(const char *s, int maxbytes)
</pre>
</blockquote>
<p>
Returns a hexidecimal character string of <var>s</var>
length. <var>maxbytes</var> indicates the maximum length expressed and
when <var>s</var> exceeds that length, <code>...</code> is appended to
the string at that point.
</p>
<p>
The memory area allocated for the returned character string is used
for the static variable held by this function and is in effect until
the function is called the next time.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_debug_xstring"><code>mdn_debug_xstring</code></a></h4>
<blockquote>
<pre>
char *
mdn_debug_xstring(const char *s, int maxbytes)
</pre>
</blockquote>
<p>
Of the <var>s</var> character strings, returns in <code>\x{HH}</code>
format those character strings 128 bytes or
larger. <var>maxbytes</var> indicates the maximum length expressed and
when <var>s</var> exceeds this, <code>...</code> is appended to the
string at that point.
</p>
<p>
The memory area allocated for the returned character string is used
for the static variable held by this function and is in effect until
the function is called the next time.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_debug_hexdata"><code>mdn_debug_hexdata</code></a></h4>
<blockquote>
<pre>
char *
mdn_debug_hexdata(const char *s, int length, int maxlength)
</pre>
</blockquote>
<p>
Returns the <var>length</var> of byte row <var>s</var> in hexadecimal
character strings.
</p>
<p>
<var>maxbytes</var> indicates the maximum <var>length</var> expressed
and when length exceeds this, <code>...</code> is appended to the
string at that point.
</p>
<p>
The memory area allocated for the returned character string is used for the
static variable held by this function and is in effect until the function is
called the next time.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_debug_hexdump"><code>mdn_debug_hexdump</code></a></h4>
<blockquote>
<pre>
void
mdn_debug_hexdump(const char *s, int length)
</pre>
</blockquote>
<p>
The standard error output is comprised of a hexidecimal dump of
<var>length</var> of byte row <var>s</var>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="dn"><code>dn</code> module</a></h3>
<p>
The <code>dn</code> module expands or compresses domain names in DNS
messages. This provides the functional equivalent of
<code>res_comp</code> and <code>res_expand</code> in the resolver
library.
</p>
<p>
This module was designed under the assumption that it would only be used by
other modules in the libary.
</p>
<p>
When a domain name is compressed, context information of type <code>mdn__dn_t</code> is used,
as shown below:
</p>
<blockquote>
<pre>
#define MDN_DN_NPTRS 64
typedef struct {
const unsigned char *msg;
int cur;
int offset[MDN_DN_NPTRS];
} mdn__dn_t;
</pre>
</blockquote>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__dn_expand"><code>mdn__dn_expand</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__dn_expand(const char *msg, size_t msglen,
const char *compressed, char *expanded,
size_t buflen, size_t *complenp)
</pre>
</blockquote>
<p>
Expands the <var>compressed</var> domain name in DNS message <var>msg</var> of length <var>msglen</var> and
stores the result in <var>expanded</var>. <var>buflen</var> is the size of <var>expanded</var>. Also, the length
of <var>compressed</var> is stored in <var>*complenp</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_message</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__dn_initcompress"><code>mdn__dn_initcompress</code></a></h4>
<blockquote>
<pre>
void
mdn__dn_initcompress(mdn__dn_t *ctx, const char *msg)
</pre>
</blockquote>
<p>
Initializes context information <var>ctx</var> for domain name compression. This function
must be called before calling <a href="#mdn__dn_compress"><code>mdn__dn_compress</code></a>. <var>msg</var> is the leading address in a
DNS message where the compressed domain name is stored.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__dn_compress"><code>mdn__dn_compress</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__dn_compress(const char *name, char *sptr, size_t length,
mdn__dn_t *ctx, size_t *complenp)
</pre>
</blockquote>
<p>
Compresses the domain name indicated by <var>name</var> and stores it in the location
indicated by <var>sptr</var>. <var>length</var> is the length of available space <var>sptr</var>. When
compression is performed, the previously compressed domain name information in
<var>ctx</var> is referenced. The length of the compressed domain name is placed in
<var>complenp</var> and also the information necessary for compression is added to <var>ctx</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_name</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="delimitermap"><code>delimitermap</code> module</a></h3>
<p>
Normally, a period (<code>.</code>) is the only character used as a delimiter in domain
names. However, to enable characters other than a period to be used as
delimiters, this <code>delimitermap</code> module is used to map other characters to periods.
</p>
<p>
The <code>delimitermap</code> module uses the concept of a "delimiter map context." First,
before mapping, a delimiter map context is created and the characters to be used
as delimiters are registered. During the actual mapping process, this map
context is specified, rather than an actual mapping scheme. The mapping context
is of type <code>mdn_delimitermap_t</code>, which is defined as the opaque type given below.
</p>
<blockquote>
<pre>
typedef struct mdn_delimitermap *mdn_delimitermap_t;
</pre>
</blockquote>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_delimitermap_create"><code>mdn_delimitermap_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_delimitermap_create(mdn_delimitermap_t *ctxp)
</pre>
</blockquote>
<p>
Creates an empty delimiter map context for checking and stores it in the area
pointed to by <var>ctxp</var>. Since the returned context is empty, it contains no
delimiters. To add one or more delimiters, use
<a href="#mdn_delimitermap_add"><code>mdn_delimitermap_add</code></a> or
<a href="#mdn_delimitermap_addall"><code>mdn_delimitermap_addall</code></a>.
When created by a context, the context reference count
becomes 1.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_delimitermap_destroy"><code>mdn_delimitermap_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn_delimitermap_destroy(mdn_delimitermap_t ctx)
</pre>
</blockquote>
<p>
Decrements the reference count of the check context created by
<a href="#mdn_delimitermap_create"><code>mdn_delimitermap_create</code></a>
by one. If, as a result, the count becomes 0, it deletes
the context, and releases the allocated memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_delimitermap_incrref"><code>mdn_delimitermap_incrref</code></a></h4>
<blockquote>
<pre>
void
mdn_delimitermap_incrref(mdn_delimitermap_t ctx)
</pre>
</blockquote>
<p>
Increments the reference count of the context created by
<a href="#mdn_delimitermap_create"><code>mdn_delimitermap_create</code></a>
by one.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_delimitermap_add"><code>mdn_delimitermap_add</code></a></h4>
<blockquote>
<pre>
extern mdn_result_t
mdn_delimitermap_add(mdn_delimitermap_t ctx, unsigned long delimiter)
</pre>
</blockquote>
<p>
Adds UCS codepoint <var>delimiter</var> to the context created by
<a href="#mdn_delimitermap_create"><code>mdn_delimitermap_create</code></a>
as a domain name delimiter.
</p>
<p>
However, to add a delimiter, this function must be called before
<a href="#mdn_delimitermap_fix"><code>mdn_delimitermap_fix</code></a>
is called. If this function is called after
<code>mdn_delimitermap_fix</code> has been called,
<code>mdn_failure</code> is returned.
</p>
<p>
This function returns one of the following values:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_invalid_codepoint</code>,
<code>mdn_failure</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_delimitermap_addall"><code>mdn_delimitermap_addall</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_delimitermap_addall(mdn_delimitermap_t ctx, const char **names, int nnames)
</pre>
</blockquote>
<p>
Other than the fact that <code>mdn_delimitermap_addall</code> adds delimiters at once, it is
identical to
<a href="#mdn_delimitermap_add"><code>mdn_delimitermap_add</code></a>.
Each element in the array <var>names</var> of length
<var>nnames</var> is registered as a delimiter. If all delimiters are added successfully,
it returns <code>mdn_success</code>. If registration fails, only the delimiters described
prior to the failed scheme are registered to context <code>ctx</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_delimitermap_fix"><code>mdn_delimitermap_fix</code></a></h4>
<blockquote>
<pre>
void
mdn_delimitermap_fix(mdn_delimitermap_t ctx)
</pre>
</blockquote>
<p>
Optimizes the arrangement of the data stored in the context. Once this function
is used,
<a href="#mdn_delimitermap_add"><code>mdn_delimitermap_add</code></a> or
<a href="#mdn_delimitermap_addall"><code>mdn_delimitermap_addall</code></a>
cannot be used subsequently to register a delimiter.
</p>
<p>
On the other hand, this function must be called in order to perform mapping with
<a href="#mdn_delimitermap_map"><code>mdn_delimitermap_map</code></a>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_delimitermap_map"><code>mdn_delimitermap_map</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_delimitermap_map(mdn_delimitermap_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Applies the mapping specified in <var>ctx</var> to the UTF-8 encoded character string <var>from</var>.
It maps any delimiter registered in <var>ctx</var> to a period (<code>.</code>), and writes the result
to the area specified by <var>to</var> and <var>tolen</var>.
</p>
<p>
To use this function, you must first have called <code>mdn_delimitermap_fix</code>. If you
call this function without first having called <code>mdn_delimitermap_fix</code>, it returns
<code>mdn_failure</code>.
</p>
<p>
This function returns one of the following values:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_failure</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="dude"><code>dude</code> module</a></h3>
<p>
The <code>dude</code> module converts between the proposed
<a href="../../reference/draft/draft-ietf-idn-dude-02.txt">DUDE encoding</a> multilingual domain
name encoding method and UTF-8 encoding. However, because this encoding is <a href="#historical-encodings">already outdated encoding</a>, be careful to use.
</p>
<p>
This module is packaged as a low-order
module for the <a href="#converter"><code>converter</code> module</a>, and is not called directly from the
application. It is called indirectly when conversion to or from <code>DUDE</code> encoding is
requested of the <a href="#converter"><code>converter</code> module</a>.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__dude_open"><code>mdn__dude_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__dude_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion to or from DUDE encoding. Actually, this does not do anything.
</p>
<p>
Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__dude_close"><code>mdn__dude_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__dude_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion to or from DUDE encoding. Actually, this does not do anything.
</p>
<p>
Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__dude_convert"><code>mdn__dude_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__dude_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
This performs bi-directional conversion between DUDE encoded character strings
and UTF-8 encoded character strings. It converts the input character string
<var>from</var>, and writes the result to the area specified by <var>to</var> and <var>tolen</var>. If <var>dir</var> is
<code>mdn_converter_l2u</code>, it converts from DUDE to UTF-8, if dir is <code>mdn_converter_u2l</code>,
it converts from UTF-8 to DUDE.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="filechecker"><code>filechecker</code> module</a></h3>
<p>
The <code>filechecker</code> module is designed to load a file that defines characters that
cannot be used in domain names, and check the domain name according to those
definitions.
</p>
<p>
This module is packaged as a low-order module of the
<a href="#checker"><code>checker</code> module</a>, and is not
called directly from the application. It is called indirectly when checking by
<code>filecset</code> is requested of the
<a href="#checker"><code>checker</code> module</a>.
</p>
<p>
For information on the file's description format, see the
<a href="clientconfig.html#setfile-format">Set File Format</a> section.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__filechecker_create"><code>mdn__filechecker_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__filechecker_create(const char *file, mdn_filechecker_t *ctxp)
</pre>
</blockquote>
<p>
Creates a single check file context. It loads file <var>file</var>, in which characters
that cannot be used in domain names are defined, and adds them to the generated
context.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_nofile</code>,
<code>mdn_invalid_syntax</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__filechecker_destroy"><code>mdn__filechecker_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn__filechecker_destroy(mdn_filechecker_t ctx)
</pre>
</blockquote>
<p>
Deletes the context created by
<a href="#mdn__filechecker_create"><code>mdn_filechecker_create</code></a>, and releases the
allocated memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__filechecker_lookup"><code>mdn__filechecker_lookup</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__filechecker_lookup(mdn_filechecker_t ctx, const char *utf8,
const char **found)
</pre>
</blockquote>
<p>
Checks the UTF-8 encoded character string <var>utf8</var> using the check scheme specified
by <var>ctx</var>. If the character string includes any prohibited characters or unassigned
codepoints, the start position of the character or codepoint is stored in <var>found</var>.
If no illegal characters are included, the function returns <code>NULL</code>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="filemapper"><code>filemapper</code> module</a></h3>
<p>
The <code>filemapper</code> module is designed to load a file that defines the mapping rules
for each character in a domain name, and perform mapping according to those
definitions.
</p>
<p>
This module is packaged as a low-order module of the
<a href="#mapper"><code>mapper</code> module</a>, and is not
called directly from the application. It is called indirectly when checking by
<code>filecmap</code> is requested of the
<a href="#mapper"><code>mapper</code> module</a>.
</p>
<p>
For information on the file's description format, see the
<a href="clientconfig.html#mapfile-format">Map File Format</a>
section.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__filemapper_create"><code>mdn__filemapper_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__filemapper_create(const char *file, mdn_filemapper_t *ctxp)
</pre>
</blockquote>
<p>
Creates a single map file context. It loads a file <var>file</var> that defines the mapping
rules, and adds them to the generated check context.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_nofile</code>,
<code>mdn_invalid_syntax</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__filemapper_destroy"><code>mdn__filemapper_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn__filemapper_destroy(mdn_filemapper_t ctx)
</pre>
</blockquote>
<p>
Deletes the context created by
<a href="#mdn__filemapper_create"><code>mdn__filemapper_create</code></a>,
and releases the
allocated memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__filemapper_map"><code>mdn__filemapper_map</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__filemapper_map(mdn__filemapper_t ctx, const char *from,
char *to, size_t tolen);
</pre>
</blockquote>
<p>
Applies the mapping specified by <var>ctx</var> to the UTF-8 encoded character string <var>from</var>,
and writes the result to the area specified by <var>to</var> and <var>tolen</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="lace"><code>lace</code> module</a></h3>
<p>
The <code>lace</code> module performs conversion between UTF-8 and the proposed
<a href="../../reference/draft/draft-ietf-idn-lace-01.txt">LACE</a>
multilingual domain name encoding method. However, because this encoding is <a href="#historical-encodings">already outdated encoding</a>, be careful to use.
</p>
<p>
This module is implemented as a
low-order <a href="#converter"><code>converter</code> module</a>, and is not directly called by the application. When
the <a href="#converter"><code>converter</code> module</a> is requested for conversion with <code>LACE</code> encoding, this module
is indirectly called.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__lace_open"><code>mdn__lace_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__lace_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion context with LACE encoding. Actually, this does not do anything.
</p>
<p>
Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__lace_close"><code>mdn__lace_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__lace_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion context with LACE encoding. Actually, this does not do
anything.
</p>
<p>
Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__lace_convert"><code>mdn__lace_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__lace_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Provides bi-directional conversion between LACE character strings and UTF-8
character strings. The <var>from</var> input character string is converted and the result
is written in the area specified by <var>to</var> and <var>tolen</var>. When <var>dir</var> is <code>mdn_converter_l2u</code>,
LACE encoding is converted to UTF-8 encoding. When it is <code>mdn_converter_u2l</code>,
UTF-8 encoding is converted to LACE encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="localencoding"><code>localencoding</code> module</a></h3>
<p>
The <code>localencoding</code> module uses locale information to guess the encoding used by
the application.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_localencoding_name"><code>mdn_localencoding_name</code></a></h4>
<blockquote>
<pre>
const char *
mdn_localencoding_name(void)
</pre>
</blockquote>
<p>
Guesses the type of encoding used by the application (the name passed to
<code><a href="#mdn_converter_create">mdn_converter_create()</a></code>)
and returns it based on the current locale information.
</p>
<p>
To guess the type of encoding, <code>nl_langinfo()</code> is used if it is available in the
the system and if not, <code>setlocale()</code> or environment variable information is
used. In the latter case, the correct encoding name may not be obtained.
</p>
<p>
When <var>MDN_LOCAL_CODESET</var> environment variable is defined in order to deal with
situations in which the correct encoding cannot be guessed from the locale
information or the application is operating using different encoding than that of
the locale, this module returns the value of that variable as the encoding name
regardless of the application locale.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="log"><code>log</code> module</a></h3>
<p>
<code>log</code> module controls MDN library log output. A standard error output log is
written by default. It can, however, be changed to another output method by
registering the handler.
</p>
<p>
The log level can be set as well. The following five log levels are defined.
However, to get the log of <code>mdn_log_level_dump</code> level, needs to create MDN library with debug option.
About the detail, refer to <a href="#mdn_log_dump"><code>mdn_log_dump</code></a>.
</p>
<blockquote>
<pre>
enum {
mdn_log_level_fatal = 0,
mdn_log_level_error = 1,
mdn_log_level_warning = 2,
mdn_log_level_info = 3,
mdn_log_level_trace = 4,
mdn_log_level_dump = 5
};
</pre>
</blockquote>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_log_fatal"><code>mdn_log_fatal</code></a></h4>
<blockquote>
<pre>
void
mdn_log_fatal(const char *fmt, ...)
</pre>
</blockquote>
<p>
Outputs a fatal level log. This level is used when a fatal error occurs that
causes problems such as when program execution cannot be performed. Arguments
are specified using the same format as <code>printf</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_log_error"><code>mdn_log_error</code></a></h4>
<blockquote>
<pre>
void
mdn_log_error(const char *fmt, ...)
</pre>
</blockquote>
<p>
Outputs the error level log. This level is used when an error occurs that is not
fatal. Arguments are specified using the same format as <code>printf</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_log_warning"><code>mdn_log_warning</code></a></h4>
<blockquote>
<pre>
void
mdn_log_warning(const char *fmt, ...)
</pre>
</blockquote>
<p>
Outputs a warning level log. This level is used to display a warning message.
Arguments are specified using the same format as <code>printf</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_log_info"><code>mdn_log_info</code></a></h4>
<blockquote>
<pre>
void
mdn_log_info(const char *fmt, ...)
</pre>
</blockquote>
<p>
Outputs info level log. This level is not used for errors but instead to output
other potentially useful information. Arguments are specified using the same
format as <code>printf</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_log_trace"><code>mdn_log_trace</code></a></h4>
<blockquote>
<pre>
void
mdn_log_trace(const char *fmt, ...)
</pre>
</blockquote>
<p>
Outputs the trace level log. This level is used to output API function trace
information. Generally, this log does not need to be recorded for purposes other
than debugging the library. The arguments are specified using the same format as
<code>printf</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_log_dump"><code>mdn_log_dump</code></a></h4>
<blockquote>
<pre>
void
mdn_log_dump(const char *fmt, ...)
</pre>
</blockquote>
<p>
Outputs the dump level log. This level is used to output additional packet data
dump for debugging. Generally, this level of log does not need to be recorded
for purposes other than debugging the library. The arguments are specified using
the same format as for <code>printf</code>.
</p>
<p>
dump level is created for debug internal of library, then if correctly set log level by <a href="#mdn_log_setlevel"><code>mdn_log_setlevel</code></a> and so on, usually not output.
To output, specifies <code>--enable-debug</code> option in executing <code>configure</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_log_setlevel"><code>mdn_log_setlevel</code></a></h4>
<blockquote>
<pre>
void
mdn_log_setlevel(int level)
</pre>
</blockquote>
<p>
Sets the level of log output. Logs higher than the set level are not output.
When the log level is not specified with this function, the integer value set to
the <code>MDN_LOG_LEVEL</code> environment variable is used.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_log_getlevel"><code>mdn_log_getlevel</code></a></h4>
<blockquote>
<pre>
int
mdn_log_getlevel(void)
</pre>
</blockquote>
<p>
Obtains and returns the integer value for the current level of log output.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_log_setproc"><code>mdn_log_setproc</code></a></h4>
<blockquote>
<pre>
void
mdn_log_setproc(mdn_log_proc_t proc)
</pre>
</blockquote>
<p>
Used to set the log output handler. <var>proc</var> is a pointer to the handler function.
When the handler is not specified or <code>NULL</code> is specified for <var>proc</var>, a standard
error log is output.
</p>
<p>
The <code>mdn_log_proc_t</code> handler type is defined as follows.
</p>
<blockquote>
<pre>
typedef void (*mdn_log_proc_t)(int level, const char *msg);
</pre>
</blockquote>
<p>
The log level is passed to <var>level</var> and the message character string that should be
displayed is passed to <var>msg</var>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="mace"><code>mace</code> module</a></h3>
<p>
The <code>mace</code> module converts between the proposed
<a href="../../reference/draft/draft-ietf-idn-mace-01.txt">
MACE encoding</a> multilingual domain name encoding method and
UTF-8 encoding. However, because this encoding is <a href="#historical-encodings">already outdated encoding</a>, be careful to use.
</p>
<p>
This module is packaged as a low-order module for the
<a href="#converter"><code>converter</code> module</a>, and is not
called directly by the application. It is called indirectly when
conversion to or from <code>MACE</code> encoding is requested of
the <a href="#converter"><code>converter</code> module</a>.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__mace_open"><code>mdn__mace_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__mace_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion to or from MACE encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__mace_close"><code>mdn__mace_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__mace_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion to or from MACE encoding. Actually, this does
not do anything. Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__mace_convert"><code>mdn__mace_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__mace_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs bi-directional conversion between MACE encoded character
strings and UTF-8 encoded character strings. It converts the input
character string <var>from</var> and writes the result to the area
specified by <var>to</var> and <var>tolen</var>. If <var>dir</var> is
<code>mdn_converter_l2u</code>, it converts the character string from
MACE encoding to UTF-8 encoding; if dir is
<code>mdn_converter_u2l</code>, it converts the character string from
UTF-8 encoding to AMC-ACE-M encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="mapper"><code>mapper</code> module</a></h3>
<p>
The <code>mapper</code> module is designed to perform mapping of characters in domain names.
</p>
<p>
The following mapping schemes are currently supported:
</p>
<ul>
<li>NAMEPREP mapping
<li>Loads a file that defines the mapping rules, and maps according to
those rules.
</ul>
<p>
An API is also provided to register additional mapping schemes.
</p>
<p>
The <code>mapper</code> module uses the concept of a "map context." First, before mapping, a
map context is created and the mapping schemes to be used are registered to this
context. During the actual mapping process, this map context is specified,
rather than an actual mapping scheme. The mapping context is of type
<code>mdn_mapper_t</code>, which is defined as the opaque type given below.
</p>
<blockquote>
<pre>
typedef struct mdn_mapper *mdn_mapper_t;
</pre>
</blockquote>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapper_initialize"><code>mdn_mapper_initialize</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_mapper_initialize(void)
</pre>
</blockquote>
<p>
Initializes the module. Always call this function before calling any other API
function of this module.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapper_create"><code>mdn_mapper_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_mapper_create(mdn_mapper_t *ctxp)
</pre>
</blockquote>
<p>
Creates an empty context for mapping and stores it in the area pointed to by
<var>ctxp</var>. Since the returned context is empty, it contains no mapping schemes. To
add one or more mapping schemes, use
<a href="#mdn_mapper_add"><code>mdn_mapper_add</code></a> or
<a href="#mdn_mapper_addall"><code>mdn_mapper_addall</code></a>. When
created by a context, the context reference count becomes 1.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapper_destroy"><code>mdn_mapper_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn_mapper_destroy(mdn_mapper_t ctx)
</pre>
</blockquote>
<p>
Decrements the reference count of the context created by
<a href="#mdn_mapper_create"><code>mdn_mapper_create</code></a> by
one. If, as a result, the count becomes 0, it deletes the context, and releases
the allocated memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapper_incrref"><code>mdn_mapper_incrref</code></a></h4>
<blockquote>
<pre>
void
mdn_mapper_incrref(mdn_mapper_t ctx)
</pre>
</blockquote>
<p>
Increments the reference count of the context created by
<a href="#mdn_mapper_create"><code>mdn_mapper_create</code></a> by one.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapper_add"><code>mdn_mapper_add</code></a></h4>
<blockquote>
<pre>
extern mdn_result_t
mdn_mapper_add(mdn_mapper_t ctx, const char *name)
</pre>
</blockquote>
<p>
Adds the mapping scheme specified by <var>name</var> to the context created by
<a href="#mdn_mapper_create"><code>mdn_mapper_create</code></a>.
Multiple mapping schemes can be added to a single context.
</p>
<p>
The format of the mapping scheme <var>name</var> is as shown below:
</p>
<dl>
<dt><var><nameprep-version></var>
<dd>NAMEPREP version <var><nameprep-version></var> mapping rules.
<dt><code>filemap</code>:<var><path></var>
<dd>Loads the mapping rules in the file specified by <var><path></var>,
and checks as described in this file. For information on the file's
description format, see the
<a href="clientconfig.html#mapfile-format">Map File Format</a> section.
<dt><var><prefix></var><code>:</code><var><parameter></var>
<dd>Checks according to the mapping scheme <var><prefix></var>
registered by <a href="#mdn_mapper_register"><code>mdn_mapper_register</code></a>.
<var><parameter></var> is
passed to the registered function create as an argument <var><parameter></var>.
</dl>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapper_addall"><code>mdn_mapper_addall</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_mapper_addall(mdn_mapper_t ctx, const char **names, int nnames)
</pre>
</blockquote>
<p>
Other than the fact that <code>mdn_mapper_addall</code> adds multiple mapping schemes at
once, it is identical to
<a href="#mdn_mapper_add"><code>mdn_mapper_add</code></a>. Each element in the array <var>names</var> of
length <var>nnames</var> is registered as a mapping scheme. If all schemes are added
successfully, it returns <code>mdn_success</code>. If registration fails, only the schemes
described prior to the failed scheme are registered to context <code>ctx</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapper_map"><code>mdn_mapper_map</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_mapper_map(mdn_mapper_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Applies the mapping scheme specified by <var>ctx</var> to the UTF-8 encoded character
string <var>from</var>, and writes the result to the area specified by <var>to</var> and <var>tolen</var>. If <var>ctx</var>
contains multiple mapping schemes, they are applied in the order added by
<a href="#mdn_mapper_add"><code>mdn_mapper_add</code></a>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapper_register"><code>mdn_mapper_register</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_mapper_register(const char *prefix,
mdn_mapper_createproc_t create,
mdn_mapper_destroyproc_t destroy,
mdn_mapper_lookupproc_t lookup)
</pre>
</blockquote>
<p>
Registers a new mapping scheme. The mapping scheme name is specified in <var>prefix</var>.
The mapping method is specified by this name when a mapping scheme is added to
the context with
<a href="#mdn_mapper_add"><code>mdn_mapper_add</code></a> or
<a href="#mdn_mapper_addall"><code>mdn_mapper_addall</code></a>.
</p>
<p>
<var>create</var>, <var>destroy</var>, and <var>lookup</var> specify the respective functions you wish to call
when
<a href="#mdn_mapper_create"><code>mdn_mapper_create</code></a>,
<a href="#mdn_mapper_destroy"><code>mdn_mapper_destroy</code></a>, or
<a href="#mdn_mapper_map"><code>mdn_mapper_map</code></a> processing is
performed. Each of these functions must have the following parameters and return
values.
</p>
<blockquote>
<pre>
typedef mdn_result_t (*mdn_mapper_createproc_t)
(const char *parameter, void **ctxp);
typedef void (*mdn_mapper_destroyproc_t)
(void *ctx);
typedef mdn_result_t (*mdn_mapper_mapproc_t)
(void *ctx, const char *utf8, const char *from, char *to,
size_t tolen);
</pre>
</blockquote>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="mapselector"><code>mapselector</code> module</a></h3>
<p>
As does the <a href="#mapper"><code>mapper</code></a> module, the <code>mapselector</code> module maps characters in domain
names. <code>mapselector</code> expands <code>mapper</code> so that it can be used with the different
mapping rules needed for the top level domain of a domain name.
<p>
The <code>mapselector</code> module uses the concept of a "map selection context." First,
before mapping, a map context is created and the mapping schemes to be used are
registered to this context. During the actual mapping process, this map context
is specified, rather than an actual mapping scheme. The mapping context is of
type <code>mdn_mapselector_t</code>, which is defined as the opaque type given below.
</p>
<blockquote>
<pre>
typedef struct mdn_mapselector *mdn_mapselector_t;
</pre>
</blockquote>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapselector_initialize"><code>mdn_mapselector_initialize</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_mapselector_initialize(void)
</pre>
</blockquote>
<p>
Initializes the module. Always call this function before calling any other API
function of this module.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapselector_create"><code>mdn_mapselector_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_mapselector_create(mdn_mapselector_t *ctxp)
</pre>
</blockquote>
<p>
Creates an empty context for map selection and stores it in the area pointed to
by <var>ctxp</var>. Since the returned context is empty, it contains no mapping schemes. To
add one or more mapping schemes, use
<a href="#mdn_mapselector_add"><code>mdn_mapselector_add</code></a> or
<a href="#mdn_mapselector_addall"><code>mdn_mapselector_addall</code></a>. When created by a context, the context reference count
becomes 1.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapselector_destroy"><code>mdn_mapselector_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn_mapselector_destroy(mdn_mapselector_t ctx)
</pre>
</blockquote>
<p>
Decrements the reference count of the map context created by
<a href="#mdn_mapselector_create"><code>mdn_mapselector_create</code></a>
by one. If, as a result, the count becomes 0, it deletes
the context, and releases the allocated memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapselector_incrref"><code>mdn_mapselector_incrref</code></a></h4>
<blockquote>
<pre>
void
mdn_mapselector_incrref(mdn_mapselector_t ctx)
</pre>
</blockquote>
<p>
Increments the reference count of the context created by
<a href="#mdn_mapselector_create"><code>mdn_mapselector_create</code></a>
by one.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapselector_mapper"><code>mdn_mapselector_mapper</code></a></h4>
<blockquote>
<pre>
mdn_mapper_t
mdn_mapselector_mapper(mdn_mapselector_t ctx, const char *tld)
</pre>
</blockquote>
<p>
The map selection context <var>ctx</var> stores and manages the mapping rules for each top
level domain in a single <code>mapper</code> module context. <var>ctx</var> maintains this function, and
extracts the <code>mapper</code> context for the corresponding top level domain <var>tld</var>.
</p>
<p>
The reference count of the extracted context becomes 2. When you have finished
using the extracted context, always be sure to call
<a href="#mdn_mapper_destroy"><code>mdn_mapper_destroy</code></a> to
decrement the reference count.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapselector_add"><code>mdn_mapselector_add</code></a></h4>
<blockquote>
<pre>
extern mdn_result_t
mdn_mapselector_add(mdn_mapselector_t ctx, const char *tld, const char *name)
</pre>
</blockquote>
<p>
Adds <var>name</var> as a mapping scheme for the <var>tld</var> domain name of a top level domain to
the context created by
<a href="#mdn_mapselector_create"><code>mdn_mapselector_create</code></a>. Multiple mapping schemes can be
added to each top level domain in a single context.
</p>
<p>
<var>tld</var> specifies the top level domain name, like <code>.jp</code> or <code>.tw</code>. (The leading dot (<code>.</code>) may be omitted.)
</p>
<p>
In addition, by specifying a dot (<code>.</code>) in <code>tld</code>, one can add default mapping rules
for top level domains whose mapping rules have not been defined. In a similar
manner, by specifying a dash (<code>-</code>), one can add mapping rules suitable for domain
names (which exclude the dot (<code>.</code>)) that do not have a top level domain.
</p>
<p>
The format of mapping scheme <var>name</var> is the same as that for
<a href="#mdn_mapper_map"><code>mdn_mapper_map</code></a>, and
mapping schemes registered with
<a href="#mdn_mapper_register"><code>mdn_mapper_register</code></a> can also be specified here.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapselector_addall"><code>mdn_mapselector_addall</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_mapselector_addall(mdn_mapselector_t ctx, const char *tld,
const char **names, int nnames)
</pre>
</blockquote>
<p>
Other than the fact that <code>mdn_mapselector_addall</code> adds multiple mapping schemes at
once, it is identical to
<a href="#mdn_mapselector_add"><code>mdn_mapselector_add</code></a>. Each element in the array <var>names</var>
of length <var>nnames</var> is registered as a mapping scheme. If all schemes are added
successfully, it returns <code>mdn_success</code>. If registration fails, only the schemes
described prior to the failed scheme are registered to context <code>ctx</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_mapselector_map"><code>mdn_mapselector_map</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_mapselector_map(mdn_mapselector_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Applies the mapping scheme specified with the <var>ctx</var> corresponding to the top level
domain of the domain name <var>from</var> to its UTF-8 encoded domain name character
string, and writes the result to the area specified by <var>to</var> and <var>tolen</var>. If <var>ctx</var>
contains multiple mapping schemes for that top level domain, they are applied in
the order added by <a href="#mdn_mapselector_add"><code>mdn_mapselector_add</code></a>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="msgheader"><code>msgheader</code> module</a></h3>
<p>
<code>msgheader</code> module analyses and assembles the DNS message header.
</p>
<p>
Analyzed header information is placed in the following structure. Since each
field corresponds to a field of DNS message header, the explanation is omitted
here.
</p>
<blockquote>
<pre>
typedef struct mdn_msgheader {
unsigned int id;
int qr;
int opcode;
int flags;
int rcode;
unsigned int qdcount;
unsigned int ancount;
unsigned int nscount;
unsigned int arcount;
} mdn_msgheader_t;
</pre>
</blockquote>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_msgheader_parse"><code>mdn_msgheader_parse</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_msgheader_parse(const char *msg, size_t msglen,
mdn_msgheader_t *parsed)
</pre>
</blockquote>
<p>
Analyzes the DNS message headers indicated by <var>msg</var> and <var>msglen</var> and stores the
information in the structure indicated by <var>parsed</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_message</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_msgheader_unparse"><code>mdn_msgheader_unparse</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_msgheader_unparse(mdn_msgheader_t *parsed,
char *msg, size_t msglen)
</pre>
</blockquote>
<p>
This function performs reverse processing of
<a href="#mdn_msgheader_parse"><code>mdn_msgheader_parse</code></a>, in which the
DNS message header is structured from the structure data specified by <var>parsed</var> ,
after which it is stored in the area specified by <var>msg</var> and <var>msglen</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_msgheader_getid"><code>mdn_msgheader_getid</code></a></h4>
<blockquote>
<pre>
unsigned int
mdn_msgheader_getid(const char *msg)
</pre>
</blockquote>
<p>
Extracts the ID from the DNS message specified by <var>msg</var> and returns it. This
function is only useful for extracting the ID without analyzing the entire
header. Since this function assumes the data indicated by <var>msg</var> is longer than the
DNS message header length, always call the function after confirmation at the
calling side.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_msgheader_setid"><code>mdn_msgheader_setid</code></a></h4>
<blockquote>
<pre>
void
mdn_msgheader_setid(char *msg, unsigned int id)
</pre>
</blockquote>
<p>
Sets the ID specified by <var>id</var> in the DNS message specified by <var>msg</var>. Since this
function also assumes that the data indicated by <var>msg</var> is longer than the DNS
message header length, always call the function after confirmation at the
calling side.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="msgtrans"><code>msgtrans</code> module</a></h3>
<p>
The <code>msgtrans</code> module provides a large portion of DNS message conversion
processing performed by the DNS proxy server. This module is implemented as a
high-order module for many other modules including the
<a href="#converter"><code>converter</code></a> module and
<a href="#normalizer"><code>normalizer</code></a> module.
</p>
<p>
Message conversion processing by the DNS proxy server is briefly explained
below.
<p>
Conversion of a message from a client to the DNS server is as follows.
</p>
<ol>
<li>Request message received from client is analyzed and encoding at the
client side are determined.
<li>Using the determination result, the encoding is converted to UTF-8.
<li>Normalization processing is performed.
<li>The encoding is converted from UTF-8 to the encoding used by the DNS server
side.
<li>The above processing is performed on all domain names included in the message
and the conversion results are collectively placed in the DNS message format and
then sent to the DNS server.
</ol>
<p>
Conversion of messages from the DNS server to the client is as follows.
</p>
<ol>
<li>The reply message received from the DNS server is analyzed and removal of ZLD
and conversion to UTF-8 encoding are performed on all domain names included in
the message.
<li>Encoding is converted to the client side encoding and ZLD are added.
<li>The conversion results are collectively placed in the DNS message format and
then sent to the client.
</ol>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_msgtrans_translate"><code>mdn_msgtrans_translate</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_msgtrans_translate(mdn_resconf_t resconf,
const char *msg, size_t msglen,
char *outbuf, size_t outbufsize,
size_t *outmsglenp)
</pre>
</blockquote>
<p>
Converts the DNS messages specified by <var>msg</var> and <var>msglen</var> according to the
conversion parameter <var>resconf</var> and stores the result in the area indicated by
<var>outbuf</var> and <var>outbufsize</var>. The message length of the conversion result is stored in
<var>outmsglenp</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_message</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_buffer_overflow</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="nameprep"><code>nameprep</code> module</a></h3>
<p>
The <code>nameprep</code> module is designed to normalize domain names according to the
descriptions provided in NAMEPREP.
</p>
<p>
The following NAMEPREP versions are currently supported:
</p>
<ul>
<li><code>nameprep-03</code>
<li><code>nameprep-05</code>
<li><code>nameprep-06</code>
<li><code>nameprep-07</code>
</ul>
<p>
The <code>nameprep</code> module uses the concept of a "NAMEPREP context." First, before
normalization, a NAMEPREP context is created and the versions to be used are
registered to this context. During the actual normalization process, the context
is specified, rather than an actual NAMEPREP version. The NAMEPREP context is of
type <code>mdn_nameprep_t</code>, which is defined as the opaque type given below.
</p>
<blockquote>
<pre>
typedef struct mdn_nameprep *mdn_nameprep_t;
</pre>
</blockquote>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_nameprep_create"><code>mdn_nameprep_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_nameprep_create(const char *version, mdn_nameprep_t *ctxp)
</pre>
</blockquote>
<p>
Creates the NAMEPREP context of the specified version <var>version</var> and stores it in
the area pointed to by <var>ctxp</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_notfound</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_nameprep_destroy"><code>mdn_nameprep_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn_nameprep_destroy(mdn_nameprep_t ctx)
</pre>
</blockquote>
<p>
Deletes the NAMEPREP context created by
<a href="#mdn_nameprep_create"><code>mdn_nameprep_create</code></a>, and releases the
allocated memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_nameprep_map"><code>mdn_nameprep_map</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_nameprep_map(mdn_nameprep_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Applies the mapping scheme specified by <var>ctx</var> to the UTF-8 encoded character
string <var>from</var>, and writes the result to the area specified by <var>to</var> and <var>tolen</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_nameprep_isprohibited"><code>mdn_nameprep_isprohibited</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_nameprep_isprohibited(mdn_nameprep_t ctx, const char *utf8,
const char **found)
</pre>
</blockquote>
<p>
Checks the UTF-8 encoded character string <var>utf8</var> using the check scheme specified
by <var>ctx</var>. If the character string includes any characters whose use is prohibited,
the offending character's start position is stored in <var>found</var>. If no prohibited
characters are included, the function returns <var>NULL</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_nameprep_isunassigned"><code>mdn_nameprep_isunassigned</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_nameprep_isunassigned(mdn_nameprep_t ctx, const char *utf8,
const char **found)
</pre>
</blockquote>
<p>
Checks the UTF-8 encoded character string <var>utf8</var> using the check scheme specified
by <var>ctx</var>. If the character string includes any unassigned codepoints, the
offending codepoint's start position is stored in <var>found</var>. If no unassigned
codepoints are included, the function returns <var>NULL</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="normalizer"><code>normalizer</code> module</a></h3>
<p>
<code>normalizer</code> module normalizes character string. The following normalization
methods are currently provided.
However, it is due to unsupport the methods marked (*) in the future release.
</p>
<ul>
<li><code>ascii-uppercase</code> (*)<br>
Converts ASCII lowercase to uppercase
<li><code>ascii-lowercase</code> (*)<br>
Converts ASCII uppercase to lowercase
<li><code>unicode-uppercase</code> (*)<br>
Converts lowercase to uppercase in accordance with the lowercase/uppercase
mapping described in
<a href="http://www.unicode.org/unicode/reports/tr21"><cite>Case Mappings</cite></a> that prescribes character properties of
Unicode.
<li><code>unicode-lowercase</code> (*)<br>
Converts uppercase to lowercase in accordance with the same above document.
<li><code>unicode-foldcase</code> (*)<br>
Converts when comparing without distinguishing between uppercase and lowercase
in accordance with the same above document.
<li><code>unicode-form-c</code> (*)<br>
<code>Normaliztion form C</code> by the latest version of Unicode which mDNkit supports.
(About <code>Normaliztion form C</code>, refer to <a href="http://www.unicode.org/unicode/reports/tr15"><cite>Unicode Normalization Forms</cite></a>.)
<li><code>unicode-form-kc</code><br>
<code>Normaliztion form KC</code> by the latest version of Unicode which mDNkit supports.
(About <code>Normaliztion form KC</code>, refer to <a href="http://www.unicode.org/unicode/reports/tr15"><cite>Unicode Normalization Forms</cite></a>.)
<li><code>unicode-form-d</code> (*)<br>
<code>Normaliztion form D</code> by the latest version of Unicode which mDNkit supports.
(About <code>Normaliztion form D</code>, refer to <a href="http://www.unicode.org/unicode/reports/tr15"><cite>Unicode Normalization Forms</cite></a>.)
<li><code>unicode-form-kd</code> (*)<br>
<code>Normaliztion form KD</code> by the latest version of Unicode which mDNkit supports.
(About <code>Normaliztion form KD</code>, refer to <a href="http://www.unicode.org/unicode/reports/tr15"><cite>Unicode Normalization Forms</cite></a>.)
<li><code>unicode-form-c/3.0.1</code> (*)<br>
Unicode normalization form C by Unicode version 3.0.1.
<li><code>unicode-form-kc/3.0.1</code><br>
Unicode normalization form KC by Unicode version 3.0.1.
<li><code>unicode-form-c/3.1.0</code> (*)<br>
Unicode normalization form C by Unicode version 3.1.0.
<li><code>unicode-form-kc/3.1.0</code><br>
Unicode normalization form KC by Unicode version 3.1.0.
<li><code>unicode-form-d/3.1.0</code> (*)<br>
Unicode normalization form D by Unicode version 3.1.0.
<li><code>unicode-form-kd/3.1.0</code> (*)<br>
Unicode normalization form KD by Unicode version 3.1.0.
<li><code>nameprep-03</code><br>
Alias of <code>unicode-form-kc/3.0.1</code>.
<li><code>nameprep-05</code><br>
Alias of <code>unicode-form-kc/3.1.0</code>.
<li><code>nameprep-06</code><br>
Alias of <code>unicode-form-kc/3.1.0</code>. As same as nameprep-05.
<li><code>nameprep-07</code><br>
Alias of <code>unicode-form-kc/3.1.0</code>. As same as nameprep-05.
</ul>
<p>
More than one normalization method can be used and they are applied in the
order they were specified.
At the same time, the APIs to regist adding another new normalization is also prepared.
</p>
<p>
<code>normalizer</code> module uses the concept "normalization context". Prior to
normalization, a normalization context is created and the normalization method
to be used is registered in the context. For actual normalization procesesing,
not the normalization method but this normalization context is specified. The
type of normalization context is <code>mdn_normalizer_t</code> type and defined as the
following opaque type.
</p>
<blockquote>
<pre>
typedef struct mdn_normalizer *mdn_normalizer_t;
</pre>
</blockquote>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_normalizer_initialize"><code>mdn_normalizer_initialize</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_normalizer_initialize(void)
</pre>
</blockquote>
<p>
Initializes module. Make sure to call this function before calling other API
function of this module.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_normalizer_create"><code>mdn_normalizer_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_normalizer_create(mdn_normalizer_t *ctxp)
</pre>
</blockquote>
<p>
Creates an empty context for normalization and stores it in the area pointed to
by <var>ctxp</var>. Since the returned context is empty, it contains no normalization
schemes. To add one or more normalization schemes, use
<a href="#mdn_normalizer_add"><code>mdn_normalizer_add</code></a> or
<a href="#mdn_normalizer_addall"><code>mdn_normalizer_addall</code></a>. When created by the context, the context reference count
becomes 1.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_normalizer_destroy"><code>mdn_normalizer_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn_normalizer_destroy(mdn_normalizer_t ctx)
</pre>
</blockquote>
<p>
Decrements the reference count of the normalization context created by
<a href="#mdn_normalizer_create"><code>mdn_normalizer_create</code></a> by one. If, as a result, the count becomes 0, it deletes
the context, and releases the allocated memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_normalizer_incrref"><code>mdn__nomalizer_incrref</code></a></h4>
<blockquote>
<pre>
void
mdn_normalizer_incrref(mdn_normalizer_t ctx)
</pre>
</blockquote>
<p>
Increments the reference count of the normalization context created by
<a href="#mdn_normalizer_create"><code>mdn_normalizer_create</code></a> by one.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_normalizer_add"><code>mdn_normalizer_add</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_normalizer_add(mdn_normalizer_t ctx, const char *scheme_name)
</pre>
</blockquote>
<p>
Adds the normalization method specified by <var>scheme_name</var> in the normalization
context created by
<a href="#mdn_normalizer_create"><code>mdn_normalizer_create</code></a>. More than one normalization method
can be specified in one context.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_name</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_normalizer_addall"><code>mdn_normalizer_addall</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_normalizer_addall(mdn_normalizer_t ctx, const char **scheme_names,
int nschemes)
</pre>
</blockquote>
<p>
Other than the fact that <code>mdn_normalizer_addall</code> adds multiple normalization
schemes at once, it is identical to
<a href="#mdn_normalizer_add"><code>mdn_normalizer_add</code></a>. Each element in the
array <var>scheme_names</var> of length <var>nschemes</var> is registered as a normalization scheme.
If all schemes are added successfully, it returns <code>mdn_success</code>. If registration
fails, only the schemes described prior to the failed scheme are registered to
context <code>ctx</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_normalizer_normalize"><code>mdn_normalizer_normalize</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_normalizer_normalize(mdn_normalizer_t ctx,
const char *from, char *to, size_t tolen)
</pre>
</blockquote>
<p>
Applies the normalization method specified by <var>ctx</var> to the character strings
encoded by UTF-8 <var>from</var> and writes the result in the area specified by <var>to</var> and
<var>tolen</var>. When more than one normalization method is included in <var>ctx</var>, they are
applied in the order they were added by <a href="#mdn_normalizer_add"><code>mdn_normalizer_add</code></a>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_normalizer_register"><code>mdn_normalizer_register</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_normalizer_register(const char *scheme_name,
mdn_normalizer_proc_t proc)
</pre>
</blockquote>
<p>
New normalization methods are registered in <var>scheme_name.</var> <var>proc</var> is a pointer to the
processing function of that normalization method.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="race"><code>race</code> module</a></h3>
<p>
The <code>race</code> module performs conversion between UTF-8 and the proposed
<a href="../../reference/draft/draft-ietf-idn-race-03.txt">RACE</a>
multilingual domain name method.
</p>
<p>
This module is implemented as a low-order
module of <a href="#converter"><code>converter</code> module</a> and is not directly called by the application. When
<a href="#converter"><code>converter</code> module</a> is requested for conversion with <code>RACE</code> encoding, this module is
indirectly called.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__race_open"><code>mdn__race_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__race_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion context with RACE encoding. Actually, this does not do
anything.
</p>
<p>
Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__race_close"><code>mdn__race_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__race_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion context with RACE encoding. Actually, this does not do
anything.
</p>
<p>
Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__race_convert"><code>mdn__race_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__race_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs bi-directional conversion between RACE-encoded and UTF-8 encoded
character strings. Converts the <var>from</var> input character string and writes the
result in the area specified by <var>to</var> and <var>tolen</var>. When <var>dir</var> is <code>mdn_converter_l2u</code>,
RACE encoding is converted to UTF-8 encoding. When it is <code>mdn_converter_u2l</code>,
UTF-8 encoding is converted to RACE encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="res"><code>res</code> module</a></h3>
<p>
The <code>res</code> module provides row level APIs used when multilingual domain names are
processed at the client side (by an application) i.e.
when domain name encoding conversion or normalization is performed. This module
is designed on the assumption that it will be used together with
<a href="#resconf"><code>resconf</code> module</a>,
which is explained below.
</p>
<p>
Using APIs provided by the module, it is not necessary to directly call
<a href="#converter"><code>converter</code> module</a> or
<a href="#normalizer"><code>normalizer</code> module</a> function.
</p>
<p>
In addition, in the case of setting <a href="../guide/resolvconfig.html#mdn_disable">environment variable MDN_DISABLE</a>, even if using the functions for string conversion which are cited in the following, conversion of strings is not performed, but returned the result as the original string.
In the case of performing conversion of strings in setting MDN_DISABLE environment, or wanting to assure constant performance whether setting MDN_DISABLE or not, <a href="#mdn_res_enable"><code>mdn_res_enable</code></a> must be used on ahead.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_enable"><code>mdn_res_enable</code></a></h4>
<blockquote>
<pre>
void
mdn_res_enable(int on_off);
</pre>
</blockquote>
<p>
Usually, in the case of defining <a href="../guide/resolvconfig.html#mdn_disable">environment variable MDN_DISABLE</a>, process of domain name conversion is not performed, but the result as the original string is returned, however this function can overrides the setting.
</p>
<p>
Whether MDN_DISABLE is set or not, if this function is used with setting a value other than 0 for <var>on_off</var>, conversion of domain name become to
perform subsequently.
If setting 0, contrary conversion of domain name is not performed, but the result as the original string is returned.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_nameconv"><code>mdn_res_nameconv</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_nameconv(mdn_resconf_t ctx, const char *insn,
const char *from, char *to, size_t tolen)
</pre>
</blockquote>
<p>
Performs conversion and checking on a multilingual domain name in the character
string <var>from</var>, and stores the result in the area specified by <var>to</var> and <var>tolen</var>. The
conversion and checking is performed according to configuration context <var>ctx</var>.
</p>
<p>
Specifically, the kind of conversions and checks that are performed, and the
order in which they are performed, is specified by the character string <var>insn</var>.
The conversion and check methods are all expressed as one character as shown
below. The methods corresponding to these characters are evaluated from
beginning to end in the order set in the character string <var>insn</var>.
</p>
<dl>
<dt><code>l</code>
<dd>Convert from local encoding to UTF-8. <br>
(It is available only in libmdn, not available in libmdnlite.)
<dt><code>L</code>
<dd>Convert from UTF-8 to local encoding. <br>
(It is available only in libmdn, not available in libmdnlite.)
<dt><code>d</code>
<dd>Perform delimiter mapping.
<dt><code>M</code>
<dd>Apply local mapping.
<dt><code>m</code>
<dd>Perform mapping.
<dt><code>n</code>
<dd>Perform normalization.
<dt><code>p</code>
<dd>Check for prohibited characters.
<dt><code>u</code>
<dd>Check unassigned codepoints.
<dt><code>N</code>
<dd>Perform NAMEPREP (mapping, normalize, check prohibit characters, check unassigned code point).
Equalize with `<code>mnpu</code>'.
<dt><code>!m</code>
<dd>Check whether the string performed mapping correctly.
If not correctly, convert IDN encoding.
<dt><code>!n</code>
<dd>Check whether the string performed normalization correctly.
If not correctly, convert IDN encoding.
<dt><code>!p</code>
<dd>Check whether the string contained prohibit character.
If contained, convert IDN encoding.
<dt><code>!u</code>
<dd>Check whether the string contained unassigned code point.
If contained, convert IDN encoding.
<dt><code>!N</code>
<dd>Check whether the string performed NAMEPREP correctly (which is the string performed mapping, normalization, and not contained prohibit character or unassigned code point).
If not correctly, convert IDN encoding.
<dt><code>I</code>
<dd>Convert from UTF-8 to IDN encoding.
<dt><code>i</code>
<dd>Convert from IDN encoding to UTF-8 encoding.
</dl>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_invalid_name</code>,
<code>mdn_invalid_action</code>,
<code>mdn_invalid_nomemory</code>,
<code>mdn_invalid_nomapping</code>,
<code>mdn_invalid_prohibited</code>,
<code>mdn_failure</code>.
</p>
<p>
In using libmdnlite, give insn includeing <code>l</code> or <code>L</code> to <code>mdn_res_nameconv()</code>, <code>mdn_invalid_action</code> is returned.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_localtoucs"><code>mdn_res_localtoucs</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_localtoucs(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Converts the character string from local encoding to UTF-8. It is equivalent to
the following process:
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "l", from, to, tolen)
</pre>
</blockquote>
<p>
This function is available in libmdn. If using in libmdnlite, <code>mdn_invalid_action</code> is returned.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_ucstolocal"><code>mdn_res_ucstolocal</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_ucstolocal(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Converts a character string from UTF-8 to local encoding. It is equivalent to
the following process:
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "L", from, to, tolen)
</pre>
</blockquote>
<p>
This function is available in libmdn. If using in libmdnlite, <code>mdn_invalid_action</code> is returned.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_delimitermap"><code>mdn_res_delimitermap</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_delimitermap(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs delimiter mapping on a character string. It is equivalent to the
following process:
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "d", from, to, tolen)
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_localmap"><code>mdn_res_localmap</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_localmap(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Applies local mapping to a character string. It is equivalent to the following
process:
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "M", from, to, tolen)
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_map"><code>mdn_res_map</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_map(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs mapping on a character string. It is equivalent to the following
process:
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "m", from, to, tolen)
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_normalize"><code>mdn_res_normalize</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_normalize(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Performs normalization on a character string. It is equivalent to the following
process:
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "n", from, to, tolen)
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_prohibitcheck"><code>mdn_res_prohibitcheck</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_prohibitcheck(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Checks a character string for prohibited characters. It is equivalent to the
following process:
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "p", from, to, tolen)
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_nameprep"><code>mdn_res_nameprep</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_nameprep(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Perform NAMEPREP for strings.
This is equivalent to the following process.
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "N", from, to, tolen)
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_nameprepcheck"><code>mdn_res_nameprepcheck</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_nameprepcheck(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Check whether the string performed NAMEPREP correctly (which is the string performed mapping, normalization, and not contained prohibit character or unassigned code point).
If not performed correctly, convert IDN encoding.
This is equivalent to the following process.
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "!N", from, to, tolen)
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_unassignedcheck"><code>mdn_res_unassignedcheck</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_unassignedcheck(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
Checks a character string for unassigned codepoints. It is equivalent to the
following process:
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "u", from, to, tolen)
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_ucstodns"><code>mdn_res_ucstodns</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_ucstodns(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen);
</pre>
</blockquote>
<p>
Converts a character string from UTF-8 to IDN encoding. It is equivalent to the
following process:
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "I", from, to, tolen)
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_res_dnstoucs"><code>mdn_res_dnstoucs</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_res_dnstoucs(mdn_resconf_t ctx, const char *from, char *to,
size_t tolen);
</pre>
</blockquote>
<p>
Converts a character string from IDN encoding to UTF-8. It is equivalent to the
following process:
</p>
<blockquote>
<pre>
mdn_res_nameconv(ctx, "i", from, to, tolen)
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="resconf"><code>resconf</code> module</a></h3>
<p>
The <code>resconf</code> module loads the <a href="clientconfig.html">mDNkit configuration file</a> referenced when a
multilingual domain name is processed at the client side (by MDN library
or application) and executes initialization in accordance with the settings
described in the file. It also provides a function to extract the setting
information.
</p>
<p>
The <code>resconf</code> module uses the concept of a "configuration context." The settings
described in a configuration file are stored in this configuration context,
which can then be used as an argument to call API functions to extract the set
values. The NAMEPREP context is of type <code>mdn_resconf_t</code>, which is defined as the
opaque type given below.
</p>
<blockquote>
<pre>
typedef struct mdn_resconf *mdn_resconf_t;
</pre>
</blockquote>
<p>
This module can be used as a single module but it is designed so that by
combining it with <a href="#res"><code>res</code> module</a> multilingual domain names can easily be processed
at the client side.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_initialize"><code>mdn_resconf_initialize</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_initialize(void)
</pre>
</blockquote>
<p>
Executes initialization required when processing multilingual domain names.
Always call this function before calling other API functions of this module.
Since this function initializes all other modules used by this module, it is not
necessary to call another initialization function.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_create"><code>mdn_resconf_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_create(mdn_resconf_t *ctxp)
</pre>
</blockquote>
<p>
Creates and initializes a configuration context and stores it in the area
pointed to by <var>ctxp</var>. In its initial state, the contents of the configuration file
are not loaded. To do so,
<a href="#mdn_resconf_loadfile"><code>mdn_resconf_loadfile</code></a> must be executed.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_destroy"><code>mdn_resconf_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn_resconf_destroy(mdn_resconf_t ctx)
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_loadfile"><code>mdn_resconf_loadfile</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_loadfile(mdn_resconf_t ctx, const char *file)
</pre>
</blockquote>
<p>
Loads the contents of the <a href="clientconfig.html">mDNkit configuration file</a> specified by <var>file</var>, and
stores the setting contents in configuration context <var>ctx</var>. When <var>file</var> is <var>NULL</var>, it
loads the contents of the default configuration file.
</p>
<p>
If another configuration is loaded into a context in which a configuration file
has already been loaded, the previous configuration file contents stored in the
configuration context are deleted and replaced with the newly loaded
configuration file contents.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nofile</code>,
<code>mdn_invalid_syntax</code>,
<code>mdn_invalid_name</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_defaultfile"><code>mdn_resconf_defaultfile</code></a></h4>
<blockquote>
<pre>
char *
mdn_resconf_defaultfile(void)
</pre>
</blockquote>
<p>
Returns the pathname of the default configuration file. This is determined by
the settings set when mDNkit is compiled. The default path is as follows:
</p>
<blockquote>
<pre>
/usr/local/etc/mdn.conf
</pre>
</blockquote>
<p>
ǒ
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_getidnconverter"><code>mdn_resconf_getidnconverter</code></a></h4>
<blockquote>
<pre>
mdn_converter_t
mdn_resconf_getidnconverter(mdn_resconf_t ctx)
</pre>
</blockquote>
<p>
Based on the information in configuration context <var>ctx</var>, this function returns the
code conversion context for performing character code conversion between IDN
encoding and UTF-8. It returns <var>NULL</var> if an IDN encoding is not specified in the
context.
</p>
<p>
For information on the code conversion context, refer to the <a href="#converter"><code>converter</code> module</a>
section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_getlocalconverter"><code>mdn_resconf_getlocalconverter</code></a></h4>
<blockquote>
<pre>
mdn_converter_t
mdn_resconf_getlocalconverter(mdn_resconf_t ctx)
</pre>
</blockquote>
<p>
Based on the information in configuration context <var>ctx</var>, this function returns the
code conversion context for performing character code conversion between local
encoding and UTF-8. <var>NULL</var> is returned if the local encoding cannot be determined.
</p>
<p>
For information on the code conversion context, refer to the
<a href="#converter"><code>converter</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_getmapper"><code>mdn_resconf_getmapper</code></a></h4>
<blockquote>
<pre>
mdn_mapper_t
mdn_resconf_getmapper(mdn_resconf_t ctx)
</pre>
</blockquote>
<p>
Based on information in information in configuration context <var>ctx</var>, this function
returns the map context for performing normalization. It returns <var>NULL</var> if a
mapping scheme is not specified in the context.
</p>
<p>
For information on the map context, refer to the <a href="#mapper"><code>mapper</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_getnormalizer"><code>mdn_resconf_getnormalizer</code></a></h4>
<blockquote>
<pre>
mdn_normalizer_t
mdn_resconf_getnormalizer(mdn_resconf_t ctx)
</pre>
</blockquote>
<p>
Based on information in configuration context <var>ctx</var>, this function returns the
normalization context for performing normalization. It returns <code>NULL</code> if a
normalization scheme is not specified in the context.
</p>
<p>
For information on the normalization context, refer to the
<a href="#normalizer"><code>normalizer</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_getprohibit"><code>mdn_resconf_getprohibit</code></a></h4>
<blockquote>
<pre>
mdn_checker_t
mdn_resconf_getprohibit(mdn_resconf_t ctx)
</pre>
</blockquote>
<p>
Based on information in configuration context <var>ctx</var>, this function returns the
check context for performing prohibited character check processing. It returns
<code>NULL</code> if a prohibited character check scheme is not specified in the context.
</p>
<p>
For information on the check context, refer to the
<a href="#checker"><code>checker</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_getunassigned"><code>mdn_resconf_getunassigned</code></a></h4>
<blockquote>
<pre>
mdn_checker_t
mdn_resconf_getunassigned(mdn_resconf_t ctx)
</pre>
</blockquote>
<p>
Based on information in configuration context <var>ctx</var>, this function returns the
normalization context for performing unassigned codepoint check processing. It
returns <code>NULL</code> if an unassigned codepoint check scheme is not specified in the
context.
</p>
<p>
For information on the check context, refer to the <a href="#checker"><code>checker</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_getdelimitermap"><code>mdn_resconf_getdelimitermap</code></a></h4>
<blockquote>
<pre>
mdn_delimitermap_t
mdn_resconf_getdelimitermap(mdn_resconf_t ctx)
</pre>
</blockquote>
<p>
Based on information in configuration context <var>ctx</var>, this function returns the
delimiter map context for performing delimiter mapping. It returns <var>NULL</var> if no
delimiters are specified in the context.
</p>
<p>
For information on the delimiter map context, refer to the
<a href="#delimitermap"><code>delimitermap</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_getmapselector"><code>mdn_resconf_getmapselector</code></a></h4>
<blockquote>
<pre>
mdn_mapselector_t
mdn_resconf_getmapselector(mdn_resconf_t ctx)
</pre>
</blockquote>
<p>
Based on information in configuration context <var>ctx</var>, this function returns the map
selection context for performing local mapping corresponding to the top level
domain. It returns <code>NULL</code> if no local mapping scheme is specified in the context.
</p>
<p>
For information on the map selection context, refer to the
<a href="#mapselector"><code>mapselector</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_setidnconverter"><code>mdn_resconf_setidnconverter</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_setidnconverter(mdn_resconf_t ctx,
mdn_converter_t idn_converter)
</pre>
</blockquote>
<p>
Based on information in code conversion context <var>idn_converter</var>, this function
sets the conversion scheme for performing character code conversion between IDN
encoding and UTF-8 into configuration context <var>ctx</var>. If <code>NULL</code> is passed to
<var>idn_converter</var>, no conversion scheme is set.
</p>
<p>
For information on the code conversion context, refer to the
<a href="#converter"><code>converter</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_setlocalconverter"><code>mdn_resconf_setlocalconverter</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_setlocalconverter(mdn_resconf_t ctx,
mdn_converter_t local_converter)
</pre>
</blockquote>
<p>
Based on information in code conversion context <var>local_converter</var>, this function
sets the conversion scheme for performing character code conversion between
local encoding and UTF-8 into configuration context <var>ctx</var>. If <code>NULL</code> is passed to
<var>local_converter</var>, no conversion scheme is set.
</p>
<p>
For information on the code conversion context, refer to the
<a href="#converter"><code>converter</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_setmapper"><code>mdn_resconf_setmapper</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_setmapper(mdn_resconf_t ctx, mdn_mapper_t mapper)
</pre>
</blockquote>
<p>
Based on information in map context <var>mapper</var>, this function sets the scheme for
performing mapping into configuration context <var>ctx</var>. If <code>NULL</code> is passed to <var>mapper</var>,
no normalization scheme is set.
</p>
<p>
For information on the map context, refer to the
<a href="#mapper"><code>mapper</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_setnormalizer"><code>mdn_resconf_setnormalizer</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_setnormalizer(mdn_resconf_t ctx,
mdn_normalizer_t normalizer)
</pre>
</blockquote>
<p>
Based on information in initialization context <var>normalizer</var>, this function sets
the normalization scheme into configuration context <var>ctx</var>. If <code>NULL</code> is passed to
<var>normalizer</var>, no initialization scheme is set.
</p>
<p>
For information on the initialization context, refer to the
<a href="#normalizer"><code>normalizer</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_setprohibit"><code>mdn_resconf_setprohibit</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_setprohibit(mdn_resconf_t ctx,
mdn_checker_t prohibit_checker)
</pre>
</blockquote>
<p>
Based on information in check context <var>prohibit_checker</var>, this function sets the
check scheme for performing prohibited character checking into configuration
context <var>ctx</var>. If <code>NULL</code> is passed to <var>prohibit_checker</var>, no check scheme is set.
</p>
<p>
For information on the check context, refer to the
<a href="#checker"><code>checker</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_setunassigned"><code>mdn_resconf_setunassigned</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_setunassigned(mdn_resconf_t ctx,
mdn_checker_t unassigned_checker)
</pre>
</blockquote>
<p>
Based on information in check context <var>unassigned_checker</var>, this function sets the
check scheme for performing unassigned codepoint checking into configuration
context <var>ctx</var>. If <code>NULL</code> is passed to <var>unassigned_checker</var>, no check scheme is set.
</p>
<p>
For information on the check context, refer to the
<a href="#checker"><code>checker</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_setdelimitermap"><code>mdn_resconf_setdelimitermap</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_setdelimitermap(mdn_resconf_t ctx,
mdn_delimitermap_t delimiter_mapper)
</pre>
</blockquote>
<p>
Based on information in delimiter map context <var>delimiter_mapper</var>, this function
sets a delimiter into configuration context <var>ctx</var>. If <code>NULL</code> is passed to
<var>delimiter_mapper</var>, no delimiter is set.
</p>
<p>
For information on the delimiter map context, refer to the
<a href="#delimitermap"><code>delimitermap</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_setmapselector"><code>mdn_resconf_setmapselector</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_setmapselector(mdn_resconf_t ctx,
mdn_mapselector_t map_selector)
</pre>
</blockquote>
<p>
Based on information in map selection context <var>map_selector</var>, this function sets
the local mapping scheme into configuration context <var>ctx</var>. If <code>NULL</code> is passed to
<var>map_selector</var>, no selection scheme is set.
</p>
<p>
For information on the map selection context, refer to the
<a href="#mapselector"><code>mapselector</code> module</a> section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_setidnconvertername"><code>mdn_resconf_setidnconvertername</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_setidnconvertername(mdn_resconf_t ctx, const char *name,
int flags)
</pre>
</blockquote>
<p>
Sets the IDN encoding into configuration context <var>ctx</var>. If <code>NULL</code> is passed to
<var>idn_converter</var>, no IDN encoding is set.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_setlocalconvertername"><code>mdn_resconf_setlocalconvertername</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_setlocalconvertername(mdn_resconf_t ctx, const char *name,
int flags)
</pre>
</blockquote>
<p>
Sets the local encoding into configuration context <var>ctx</var>. If <code>NULL</code> is passed to
<var>local_converter</var>, an automatically distinguished encoding is set.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_addallmappernames"><code>mdn_resconf_addallmappernames</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_addallmappernames(mdn_resconf_t ctx, const char **names,
int nnames)
</pre>
</blockquote>
<p>
Adds all mapping schemes described in <var>names</var> and <var>nnames</var> to configuration context
<var>ctx</var>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_addallnormalizernames"><code>mdn_resconf_addallnormalizernames</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_addallnormalizernames(mdn_resconf_t ctx, const char **names,
int nnames)
</pre>
</blockquote>
<p>
Adds all normalization schemes described in <var>names</var> and <var>nnames</var> to configuration
context <var>ctx</var>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_addallprohibitnames"><code>mdn_resconf_addallprohibitnames</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_addallprohibitnames(mdn_resconf_t ctx, const char **names,
int nnames)
</pre>
</blockquote>
<p>
Adds all prohibited character check schemes described in <var>names</var> and <var>nnames</var> to
configuration context <var>ctx</var>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_addallunassignednames"><code>mdn_resconf_addallunassignednames</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_addallunassignednames(mdn_resconf_t ctx, const char **names,
int nnames)
</pre>
</blockquote>
<p>
Adds all unassigned codepoint check schemes described in <var>names</var> and <var>nnames</var> to
configuration context <var>ctx</var>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_addalldelimitermapucs"><code>mdn_resconf_addalldelimitermapucs</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_addalldelimitermapucs(mdn_resconf_t ctx,
unsigned long *v, int nv);
</pre>
</blockquote>
<p>
Adds all delimiters represented in the codepoint array <var>v</var> of length <var>nv</var> into
configuration context <var>ctx</var>. To use a delimiter, always be sure to call
<a href="#mdn_resconf_fixdelimitermap"><code>mdn_resconf_fixdelimitermap</code></a> before using
<a href="#mdn_res_nameconv"><code>mdn_res_nameconv</code></a> to perform delimiter
mapping, and declare that a delimiter will not be subsequently added.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_fixdelimitermap"><code>mdn_resconf_fixdelimitermap</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_fixdelimitermap(mdn_resconf_t ctx)
</pre>
</blockquote>
<p>
Declares that delimiters will no longer be added. When
<a href="#mdn_resconf_addalldelimitermapucs"><code>mdn_resconf_addalldelimitermapucs</code></a> is used to add a delimiter,
<a href="#mdn_res_nameconv"><code>mdn_res_nameconv</code></a>-induced delimiter mapping will not be successful unless this
function is called.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_addallmapselectornames"><code>mdn_resconf_allallmapselectornames</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_addallmapselectornames(mdn_resconf_t ctx, const char *tld,
const char **names, int nnames)
</pre>
</blockquote>
<p>
Adds all local mapping schemes for the top level domain <var>tld</var> described in <var>names</var>
and <var>nnames</var> to configuration context <var>ctx</var>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_resconf_setnameprepversion"><code>mdn_resconf_setnameprepversion</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_resconf_setnameprepversion(mdn_resconf_t ctx,
const char *version)
</pre>
</blockquote>
<p>
Sets <var>version</var> into the NAMEPREP version of configuration context <var>ctx</var>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="result"><code>result</code> module</a></h3>
<p>
The <var>result</var> module handles the
<a href="#mdn_result_t"><code>mdn_result_t</code> type</a> value returned by each function
in the library and converts the value to the corresponding message code.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_result_tostring"><code>mdn_result_tostring</code></a></h4>
<blockquote>
<pre>
char *
mdn_result_tostring(mdn_result_t result)
</pre>
</blockquote>
<p>
Returns the message character string corresponding to the value <var>result</var> of
<code>mdn_result_t</code> type.
</p>
<p>
An <code>unknown result code</code> character string is returned for undefined code.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="selectiveencode"><code>selectiveencode</code> module</a></h3>
<p>
The <code>selectiveencode</code> module finds domain names that include non-ASCII characters
in text such as zone master files. Generally speaking it is impossible
to determine which part of the text is the domain name; in actuality, however,
the following rough assumptions are used to implement it approximately.
</p>
<ul>
<li>Non-ASCII characters appear only in domain names.
</ul>
<p>
Specifically, the following algorithm is used to detect the domain name area.
</p>
<ol>
<li>Scans the text and finds non-ASCII characters.
<li>Check characters before and after found non-ASCII characters to determine a
range consisting of only the found character and also other non-ASCII characters
or characters that can be used for conventional (not internationalized) domain
names.
<li>Returns the found range as the domain name.
</ol>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_selectiveencode_findregion"><code>mdn_selectiveencode_findregion</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_selectiveencode_findregion(const char *s,
char **startp, char **endp)
</pre>
</blockquote>
<p>
Scans <var>s</var> UTF-8 encoded character strings and finds the area in the domain that
includes the first appearance of a non-ASCII character, then stores a pointer
indicating the beginning of the area at <var>startp</var> and a pointer indicating the end
of the area in <var>endp</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_notfound</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="strhash"><code>strhash</code> module</a></h3>
<p>
The <code>strhash</code> module implements a hash table that uses a character string as a
key. The hash table is used by other modules in the library such as the
<a href="#converter"><code>converter</code> module</a> and
<a href="#normalizer"><code>normalizer</code> module</a>.
This is a very general hash table
implementation in which registration can be performed but there is no deletion
function because it is not needed with this library.
</p>
<p>
The size of the hash table increases as the total numer of elements increases.
</p>
<p>
As shown below, the hash table is expressed in opaque data of <code>mdn_strhash_t</code> type.
</p>
<blockquote>
<pre>
typedef struct mdn_strhash *mdn_strhash_t;
</pre>
</blockquote>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_strhash_create"><code>mdn_strhash_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_strhash_create(mdn_strhash_t *hashp)
</pre>
</blockquote>
<p>
Creates an empty hash table and stores the handle to the area indicated by
<code>hashp</code>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_strhash_destroy"><code>mdn_strhash_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn_strhash_destroy(mdn_strhash_t hash)
</pre>
</blockquote>
<p>
Deletes the hash table created by
<a href="#mdn_strhash_create"><code>mdn_strhash_create</code></a>
and releases the allocated memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_strhash_put"><code>mdn_strhash_put</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_strhash_put(mdn_strhash_t hash, const char *key,
void *value)
</pre>
</blockquote>
<p>
Used to register a <var>key</var> and <var>value</var> set in the hash table <var>hash</var> created by
<a href="#mdn_strhash_create"><code>mdn_strhash_create</code></a>. Since character strings <var>key</var> are copied, there is no influence
even if the memory indicated by <var>key</var> is released or the contents of the character
strings are changed after this function is called. Contrarily, the contents of
<var>value</var> are not copied, so use care when working with this item. (If you think
carefully about it, it will become obvious that this value is not copied.)
</p>
<p>
When the same key is used for registration more than once, only the most
recently registered key is effective.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_strhash_get"><code>mdn_strhash_get</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_strhash_get(mdn_strhash_t hash,
const char *key, void **valuep)
</pre>
</blockquote>
<p>
Searches for elements that have <var>key</var> in the hash table <var>hash</var>; if a corresponding
element is found, the value is stored in <var>valuep</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_noentry</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_strhash_exists"><code>mdn_strhash_exists</code></a></h4>
<blockquote>
<pre>
int
mdn_strhash_exists(mdn_strhash_t hash, const char *key)
</pre>
</blockquote>
<p>
Returns 1 if there is an element that has the <var>key</var> in the hash table <var>hash</var>, and returns
0 if no element is found.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="ucsmap"><code>ucsmap</code> module</a></h3>
<p>
The <code>ucsmap</code> module is designed to register character mapping rules.
</p>
<p>
This module is packaged as a low-order module for the
<a href="#filemapper"><code>filemapper</code> module</a>, and is
not called directly from the application.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ucsmap_create"><code>mdn__ucsmap_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__ucsmap_create(mdn_ucsmap_t *ctxp)
</pre>
</blockquote>
<p>
Creates a single UCS mapping context. However, at time of creation, no mapping
rules are registered to the context.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ucsmap_destroy"><code>mdn__ucsmap_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn__ucsmap_destroy(mdn_ucsmap_t ctx)
</pre>
</blockquote>
<p>
Deletes the context created by
<a href="#mdn__ucsmap_create"><code>mdn_ucsmap_create</code></a>, and releases the allocated
memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ucsmap_add"><code>mdn__ucsmap_add</code></a></h4>
<blockquote>
<pre>
void
mdn__ucsmap_add(mdn_ucsmap_t ctx, unsigned long v, unsigned long *map,
size_t maplen)
</pre>
</blockquote>
<p>
Registers the mapping rules of Unicode codepoint <var>v</var> to the context created by
<a href="#mdn__ucsmap_create"><code>mdn__ucsmap_create</code></a>.
The mapped sequence is specified by <var>map</var> and <var>maplen</var>. Note,
however, that mapping rules must be registered before calling <a href="#mdn__ucsmap_fix"><code>mdn__ucsmap_fix</code></a>.
<code>mdn_failure</code> is returned if this function is called once <code>mdn__ucsmap_fix</code> has been
called.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_failure</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ucsmap_fix"><code>mdn__ucsmap_fix</code></a></h4>
<blockquote>
<pre>
void
mdn__ucsmap_fix(mdn_ucsmap_t ctx)
</pre>
</blockquote>
<p>
Optimizes the arrangement of the data stored in the context. Once this function
is used,
<a href="#mdn__ucsmap_add"><code>mdn__ucsmap_add</code></a> cannot be used subsequently to register a mapping rule.
</p>
<p>
On the other hand, this function must be called in order to perform character
mapping with <a href="#mdn__ucsmap_map"><code>mdn__ucsmap_map</code></a>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ucsmap_map"><code>mdn__ucsmap_map</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_ucsmap_map(mdn_ucsmap_t ctx, unsigned long v, unsigned long *to,
size_t tolen, size_t *maplenp);
</pre>
</blockquote>
<p>
Stores the mapped sequence into Unicode codepoint <var>v</var> in <var>to</var>. It passes the size of <var>to</var> in
<var>tolen</var>, and the actual length of the mapped sequence is stored in <var>maplenp</var>.
</p>
<p>
To use this function, you must first have called <code>mdn__ucsmap_fix</code>. <code>mdn_failure</code> is
returned if this function is called without having called <code>mdn__ucsmap_fix</code>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomapping</code>,
<code>mdn_failure</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="ucsset"><code>ucsset</code> module</a></h3>
<p>
The <code>ucsset</code> module is designed to register characters.
</p>
<p>
This module is packaged as a low-order module for the
<a href="#filechecker"><code>filechecker</code> module</a> and
<a href="#delimitermap"><code>delimitermap</code> module</a>, and is not called directly from the application.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ucsset_create"><code>mdn__ucsset_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__ucsset_create(mdn_ucsset_t *ctxp)
</pre>
</blockquote>
<p>
Creates a single UCS configuration context. No characters are registered to a
context that has just been created.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ucsset_destroy"><code>mdn__ucsset_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn__ucsset_destroy(mdn_ucsset_t ctx)
</pre>
</blockquote>
<p>
Deletes the context created by <a href="#mdn__ucsset_create"><code>mdn__ucsset_create</code></a>, and releases the allocated memory.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ucsset_add"><code>mdn__ucsset_add</code></a></h4>
<blockquote>
<pre>
void
mdn__ucsset_add(mdn_ucsset_t ctx, unsigned long v)
</pre>
</blockquote>
<p>
Registers the mapping rules of Unicode codepoint <var>v</var> to the context created by
<a href="#mdn__ucsset_create"><code>mdn__ucsset_create</code></a>. Note, however, that the characters must be registered before
calling <a href="#mdn__ucsset_fix"><code>mdn__ucsset_fix</code></a>. <code>mdn_failure</code> is returned if this function is called once
<code>mdn__ucsset_fix</code> has been called.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_code</code>,
<code>mdn_nomemory</code>,
<code>mdn_failure</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ucsset_addrange"><code>mdn__ucsset_addrange</code></a></h4>
<blockquote>
<pre>
void
mdn__ucsset_addrange(mdn_ucsset_t ctx, unsigned long from, unsigned long to)
</pre>
</blockquote>
<p>
Registers all Unicode codepoints in the context created by
<a href="#mdn__ucsset_create"><code>mdn__ucsset_create</code></a>
from <var>from</var> to <var>to</var> (including both sides). Note, however, that the characters must
be registered before calling
<a href="#mdn__ucsset_fix"><code>mdn__ucsset_fix</code></a>. <code>mdn_failure</code> is returned if this
function is called once <code>mdn__ucsset_fix</code> has been called.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_code</code>,
<code>mdn_nomemory</code>,
<code>mdn_failure</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ucsset_fix"><code>mdn__ucsset_fix</code></a></h4>
<blockquote>
<pre>
void
mdn__ucsset_fix(mdn_ucsset_t ctx)
</pre>
</blockquote>
<p>
Optimizes the arrangement of the data stored in the context. Once this function
is used,
<a href="#mdn__ucsset_add"><code>mdn__ucsset_add</code></a> or
<a href="#mdn__ucsset_addrange"><code>mdn__ucsset_addrange</code></a> cannot be used subsequently to register characters.
</p>
<p>
On the other hand, this function must be called in order to determine a
character with <a href="#mdn__ucsset_lookup"><code>mdn__ucsset_lookup</code></a>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__ucsset_lookup"><code>mdn__ucsset_lookup</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__ucsset_lookup(mdn_ucsset_t ctx, unsigned long v, int *found)
</pre>
</blockquote>
<p>
Checks if Unicode codepoint <var>v</var> is included in <var>ctx</var>. If it is, the function stores
1 in *found; if not, it stores 0 in <var>*found</var>.
</p>
<p>
To use this function, you must first have called <code>mdn__ucsset_fix</code>. <code>mdn_failure</code> is
returned if this function is called without having called <code>mdn__ucsset_fix</code>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_nomemory</code>,
<code>mdn_failure</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="unicode"><code>unicode</code> module</a></h3>
<p>
The <code>unicode</code> module obtains various character properties of Unicode described in
<a href="ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.txt"><cite>UnicodeData.txt</cite></a>. For details of the data described in Unicode.txt and the file
format, refer to
<a href="ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.html"><cite>UnicodeData File Format</cite></a>.
</p>
<p>
Many modules in this library handle Unicode data as UTF-8 encoded character
strings but this module handles Unicode data as <code>unsigned long</code> type data.
Includes UCS-4 values.
</p>
<p>
The data about character attribute defined by Unicode have some version, and they are deferent each other.
So, to get the data by the specified version, API functions provided by this module can specify an argument as a key to specify a version.
The type of the key is <code>mdn__unicode_version_t</code> type, so defined as the follwoing opaque type.
</p>
<blockquote>
<pre>
typedef struct mdn__unicode_ops *mdn__unicode_version_t;
</pre>
</blockquote>
<p>
<a name="mdn__unicode_context_t">
This module provides a mutual conversion function between uppercase and
lowercase Unicode characters.</a>
This is defined by
<a href="http://www.unicode.org/unicode/reports/tr21"><cite>Unicode Technical Report #21: Case Mappings</cite></a>.
Among Unicode characters, a few characters require context
information when uppercase is converted to lowercase. This is specified by the
following enumeration type data.
</p>
<blockquote>
<pre>
typedef enum {
mdn__unicode_context_unknown,
mdn__unicode_context_final,
mdn__unicode_context_nonfinal
} mdn__unicode_context_t;
</pre>
</blockquote>
<p>
When the context is FINAL, <code>mdn__unicode_context_final</code> is specified and when it
is NON_FINAL, <code>mdn__unicode_context_nonfinal</code> is specified.
<code>mdn__unicode_context_unknown</code> indicates that the context is unknown (has not yet
been checked). For a detailed discussion of context information, refer to the
above references.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unicode_create"><code>mdn__unicode_create</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__unicode_create(const char *version, mdn__unicode_version_t *versionp)
</pre>
</blockquote>
<p>
Create the key corresponded the version specified by <var>version</var>,
and set the region <var>versionp</var> points.
In <var>version</var>, for example <code>"3.0.1"</code>, the string indicating a version.
If specified <code>NULL</code>, create the key corresponded the latest version supported by this module.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_notfound</code> (If not supported the specified version)
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unicode_destroy"><code>mdn__unicode_destroy</code></a></h4>
<blockquote>
<pre>
void
mdn__unicode_destroy(mdn__unicode_version_t version)
</pre>
</blockquote>
<p>
Destoroy the key <var>version</var> created by <a href="#mdn__unicode_create"><code>mdn__unicode_create</code></a>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unicode_canonicalclass"><code>mdn__unicode_canonicalclass</code></a></h4>
<blockquote>
<pre>
int
mdn__unicode_canonicalclass(mdn__unicode_version_t version,
unsigned long c);
</pre>
</blockquote>
<p>
By using the character attribute date of the version specified <var>version</var>, Obtains Canonical Combining Class for Unicode character <var>c</var>.
0 is returned for
characters for which <code>Canonical Combining Class</code> is not defined.
However <var>version</var> is the key created by <a href="#mdn__unicode_create"><code>mdn__unicode_create</code></a>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unicode_decompose"><code>mdn__unicode_decompose</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__unicode_decompose(mdn__unicode_version_t version,
int compat, unsigned long *v, size_t vlen,
unsigned long c, int *decomp_lenp)
</pre>
</blockquote>
<p>
Decomposes Unicode characters <var>c</var> in accordance with <code>Character Decomposition Mapping</code> of the version specified by <var>version</var> and writes the result in the area specified by <var>v</var> and
<var>vlen</var>. When the value of <var>compat</var> is true, <code>Compatibility Decomposition</code> is performed
and when false, <code>Canonical Decomposition</code> is performed.
However <var>version</var> is the key created by <a href="#mdn__unicode_create"><code>mdn__unicode_create</code></a>.
</p>
<p>
Decompose is performed recursively, i.e. each character resolved in accordance
with Character Decomposition Mapping is further decomposed.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_notfound</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unicode_compose"><code>mdn__unicode_compose</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__unicode_compose(mdn__unicode_version_t version,
unsigned long c1, unsigned long c2, unsigned long *compp)
</pre>
</blockquote>
<p>
Composes a sequence of the two Unicode characters <var>c1</var> and <var>c2</var> per the <code>Character
Decomposition Mapping</code> in the version specified by <var>version</var> and writes the result in the area
specified by <var>compp</var>. <code>Canonical Composition</code> is always peformed.
However <var>version</var> is the key created by <a href="#mdn__unicode_create"><code>mdn__unicode_create</code></a>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_notfound</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unicode_iscompositecandidate"><code>mdn__unicode_iscompositecandidate</code></a></h4>
<blockquote>
<pre>
int
mdn__unicode_iscompositecandidate(mdn__unicode_version_t version,
unsigned long c)
</pre>
</blockquote>
<p>
By using the data of Unicode character attribute of the version specified by <var>version</var>, searches whether there is a Canonical Composition that starts with a Unicode
character <var>c</var> and returns 1 if there is a possibility of its existence and returns
0 if not. This is simply hint information, in that even though 1 is returned,
the composition sometimes does not exist. On the contrary, when 0 is returned,
it definitely does not exist.
However <var>version</var> is the key created by <a href="#mdn__unicode_create"><code>mdn__unicode_create</code></a>.
</p>
<p>
As there are only a small number of Unicode characters that can begin Canonical
Composition, this can be used for pre-screening of data in order to decrease the
search overhead of
<a href="#mdn__unicode_compose"><code>mdn__unicode_compose</code></a>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unicode_toupper"><code>mdn__unicode_toupper</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__unicode_toupper(mdn__unicode_version_t version,
unsigned long c, mdn__unicode_context_t ctx,
unsigned long *v, size_t vlen, int *convlenp)
</pre>
</blockquote>
<p>
Converts Unicode characters <var>c</var> to uppercase in accordance with the <code>Uppercase
Mapping</code> information in the data of Unicode character attribute of the version specified by <var>version</var> and SpecialCasing.txt, and stores the
result in the area specified by <var>v</var>. <var>vlen</var> is the size of the area that is secured
for <var>v</var> beforehand. The number of characters in the conversion result is returned
to <var>*convlenp</var>. Note that the conversion result may be greater than one character
and that locale-dependent conversion is not performed.
However <var>version</var> is the key created by <a href="#mdn__unicode_create"><code>mdn__unicode_create</code></a>.
</p>
<p>
<var>ctx</var> is context information where character <var>c</var> appears. Since most characters do
not require
<a href="#mdn__unicode_context_t">context information</a> when they are converted, usually
<code>mdn__unicode_context_unknown</code> can be specified. When context information is
necessary, this function returns <code>mdn_context_required</code> as the return value, and
it is possible to call it again after obtaining the context information. To
obtain context information, <a href="#mdn__unicode_getcontext"><code>mdn__unicode_getcontext</code></a> is used.
</p>
<p>
If no corresponding uppercase character exists, <var>c</var> is stored in <var>v</var> as is.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_context_required</code>,
<code>mdn_buffer_overflow</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unicode_tolower"><code>mdn__unicode_tolower</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__unicode_tolower(mdn__unicode_version_t version,
unsigned long c, mdn__unicode_context_t ctx,
unsigned long *v, size_t vlen, int *convlenp)
</pre>
</blockquote>
<p>
Converts Unicode character <var>c</var> to lowercase in accordance with <code>Lowercase Mapping</code>
information of the data of Unicode character attribute and SpecialCasing.txt information.
</p>
<p>
Since the usage method is the same as
<a href="#mdn__unicode_toupper">mdn__unicode_toupper()</a>, which is used to
convert to upper case character, refer to that section.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unicode_getcontext"><code>mdn__unicode_getcontext</code></a></h4>
<blockquote>
<pre>
mdn__unicode_context_t
mdn__unicode_getcontext(mdn__unicode_version_t version,
unsigned long c)
</pre>
</blockquote>
<p>
By using the data of Unicode character attribute of the version specified by <var>version</var>, returns context information used for conversion of uppercase/lowercase
characters. To obtain context information, first the character following the
uppercase/lowercase character conversion target character is obtained and this
function is called. If the return value is <code>mdn__unicode_context_final</code> or
<code>mdn__unicode_context_nonfinal</code>, that context information is the context
information to obtain. If <code>mdn__unicode_context_unknown</code> is returned, the next
character is obtained and the function is called. In this way, processing
continues until either the value of <code>mdn__unicode_context_final</code> or
<code>mdn__unicode_context_nonfinal</code> is obtained. When processing reaches the end of
the character string, <code>mdn__unicode_context_final</code> becomes the context.
</p>
<p>
Specifically, this function does the following. Refers "General Category"
properties of Unicode character <var>c</var> and if it is "Lu", "Ll" or "Lt"
<code>mdn__unicode_context_nonfinal</code> is returned, if it is "Mn"
<code>mdn__unicode_context_unknown</code> is returned, and if it is other than the above,
<code>mdn__unicode_context_final</code> is returned.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="unormalize"><code>unormalize</code> module</a></h3>
<p>
The <code>unormalize</code> module performs the standard normalization defined by Unicode.
Normalization of Unicode is defined in
<a href="http://www.unicode.org/unicode/reports/tr15"><cite>Unicode Technical Report #15: Unicode Normalization Forms</cite></a>. This module implements the four normalization forms
mentioned in this document.
</p>
<p>
The concrete data as using normalization are deferent a little bit each other.
Then, as same as the one of <a href="#unicode"><code>unicode</code> module</a>, API functions provided by this module can specify an argument as a key to specify a version.
To create and destoroy the key, use <a href="#mdn__unicode_create"><code>mdn__unicode_create</code></a> and
<a href="#mdn__unicode_destroy"><code>mdn__unicode_destroy</code></a> of <code>unicode</code> module.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unormalize_formc"><code>mdn__unormalize_formc</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__unormalize_formc(mdn__unicode_version_t version,
const char *from, char *to, size_t tolen)
</pre>
</blockquote>
<p>
Applies <code>Unicode Normalization Form C</code> normalization which is the version specified by <var>version</var> to a UTF-8 encoded <var>from</var>
character string and writes the result in the area specified by <var>to</var> and <var>tolen</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unormalize_formd"><code>mdn__unormalize_formd</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__unormalize_formd(mdn__unicode_version_t version,
const char *from, char *to, size_t tolen)
</pre>
</blockquote>
<p>
Applies <code>Unicode Normalization Form D</code> normalization which is the version specified by <var>version</var> to a UTF-8 encoded <var>from</var>
character string and writes the result in the area specified by <var>to</var> and <var>tolen</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unormalize_formkc"><code>mdn__unormalize_formkc</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__unormalize_formkc(mdn__unicode_version_t version,
const char *from, char *to, size_t tolen)
</pre>
</blockquote>
<p>
Applies <code>Unicode Normalization Form KC</code> normalization which is the version specified by <var>version</var> to a UTF-8 encoded <var>from</var>
character string and writes the result in the area specified by <var>to</var> and <var>tolen</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__unormalize_formkd"><code>mdn__unormalize_formkd</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__unormalize_formkd(mdn__unicode_version_t version,
const char *from, char *to, size_t tolen)
</pre>
</blockquote>
<p>
Applies <code>Unicode Normalization Form KC</code> normalization which is the version specified by <var>version</var> to a UTF-8 encoded <var>from</var>
character string and writes the result in the area specified by <var>to</var> and <var>tolen</var>.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="utf5"><code>utf5</code> module</a></h3>
<p>
The <code>utf5</code> module performs basic processing for the proposed
<a href="../../reference/draft/draft-jseng-utf5-01.txt">UTF-5</a> domain name
encoding system. However, because this encoding is <a href="#historical-encodings">already outdated encoding</a>, be careful to use.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_utf5_getwc"><code>mdn_utf5_getwc</code></a></h4>
<blockquote>
<pre>
int
mdn_utf5_getwc(const char *s, size_t len,
unsigned long *vp)
</pre>
</blockquote>
<p>
Extracts the leading character of length <var>len</var> byte UTF-5 encoded character strings <var>s</var>, converts it to UCS-4 and stores it in the area specified by <var>vp</var> and also returns the number of bytes in the (UTF-5 encoded) character strintg. 0 is returned if <var>len</var> is too short and ends in the middle of a character or the encoding is invalid.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_utf5_putwc"><code>mdn_utf5_putwc</code></a></h4>
<blockquote>
<pre>
int
mdn_utf5_putwc(char *s, size_t len, unsigned long v)
</pre>
</blockquote>
<p>
Converts UCS-4 characters <var>v</var> to UTF-5 encoding, writes them in the area specified
by <var>s</var> and <var>len</var> and returns the number of bytes written. 0 is returned if <var>len</var> is
too short to write.
</p>
<p>
The written UTF-5 character string is <strong>not terminated with a NULL character</strong>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="utf6"><code>utf6</code> module</a></h3>
<p>
The <code>utf6</code> module converts between the proposed
<a href="../../reference/draft/draft-ietf-idn-utf6-00.txt">
UTF-6 encoding</a> multilingual domain name encoding method and UTF-8. However, because this encoding is <a href="#historical-encodings">already outdated encoding</a>, be careful to use.
</p>
<p>
This module is packaged as a low-order module for the <a href="#converter"><code>converter</code> module</a>, and is not called directly from the application. It is called indirectly when conversion to or from <code>UTF-6</code> encoding is requested of the <a href="#converter"><code>converter</code> module</a>.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__utf6_open"><code>mdn__utf6_open</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__utf6_open(mdn_converter_t ctx, mdn_converter_dir_t dir,
void **privdata)
</pre>
</blockquote>
<p>
Opens conversion to or from UTF-6 encoding. Actually, this does not do anything.
</p>
<p>
Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__utf6_close"><code>mdn__utf6_close</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__utf6_close(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir)
</pre>
</blockquote>
<p>
Closes conversion to or from UTF-6 encoding. Actually, this does not do
anything.
</p>
<p>
Always returns <code>mdn_success</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn__utf6_convert"><code>mdn__utf6_convert</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn__utf6_convert(mdn_converter_t ctx, void *privdata,
mdn_converter_dir_t dir, const char *from, char *to,
size_t tolen)
</pre>
</blockquote>
<p>
This performs bi-directional conversion between UTF-6 encoded character strings
and UTF-8 encoded character strings. It converts the input character string
<var>from</var>, and writes the result to the area specified by <var>to</var> and <var>tolen</var>. If <var>dir</var> is
<code>mdn_converter_l2u</code>, it converts from UTF-6 encoding to UTF-8 encoding, if dir is
<code>mdn_converter_u2l</code>, it converts from UTF-8 encoding to UTF-6 encoding.
</p>
<p>
One of the following values is returned:
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>,
<code>mdn_nomemory</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="utf8"><code>utf8</code> module</a></h3>
<p>
The <code>utf8</code> module performs the basic processing of UTF-8 encoded character
strings.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_utf8_mblen"><code>mdn_utf8_mblen</code></a></h4>
<blockquote>
<pre>
int
mdn_utf8_mblen(const char *s)
</pre>
</blockquote>
<p>
Returns the length (number of bytes) of the leading character in the UTF-8
character string <var>s</var>. 0 is returned if the leading byte indicated by <var>s</var> is not
valid for UTF-8.
</p>
<p>
This function returns the length by checking the leading byte of <var>s</var>; there is
therefore a possibility of invalid byte in the 2nd and later byte. In
particular, NULL bytes may exist in the middle, so you have to be careful when
it is not certain that <var>s</var> is a valid UTF-8 character string.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_utf8_getmb"><code>mdn_utf8_getmb</code></a></h4>
<blockquote>
<pre>
int
mdn_utf8_getmb(const char *s, size_t len, char *buf)
</pre>
</blockquote>
<p>
Copies the leading character of <var>s</var> UTF-8 character strings of length <var>len</var> and
returns the number of copied bytes.
0 is returned if <var>len</var> is too short to write or the leading character indicated by <var>s</var> is not valid for UTF-8.
</p>
<p>
<var>buf</var> must be large enough to hold any UTF-8 encoding, i.e. it must be 6 bytes or larger.
</p>
<p>
The written UTF-8 character string is <strong>not terminated with a NULL character</strong>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_utf8_getwc"><code>mdn_utf8_getwc</code></a></h4>
<blockquote>
<pre>
int
mdn_utf8_getwc(const char *s, size_t len,
unsigned long *vp)
</pre>
</blockquote>
<p>
This is almost the same as <a href="#mdn_utf8_getmb"><code>mdn_utf8_getmb</code></a> with the difference being that characters
extracted from <var>s</var> are converted to UCS-4 and stored in the area indicated by <var>vp</var>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_utf8_putwc"><code>mdn_utf8_putwc</code></a></h4>
<blockquote>
<pre>
int
mdn_utf8_putwc(char *s, size_t len, unsigned long v)
</pre>
</blockquote>
<p>
Converts UCS-4 character <var>v</var> to UTF-8 encoding, writes it in the area specified by
<var>s</var> and <var>len</var> and returns the number of written bytes. 0 is returned when the value
of <var>v</var> is invalid or <var>len</var> is too short.
</p>
<p>
The written UTF-8 character string is <strong>not terminated with a NULL character</strong>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_utf8_isvalidstring"><code>mdn_utf8_isvalidstring</code></a></h4>
<blockquote>
<pre>
int
mdn_utf8_isvalidstring(const char *s)
</pre>
</blockquote>
<p>
Checks whether the character string <var>s</var> terminated with a NULL character is
valid UTF-8 encoding and returns 1 if so and 0 if not.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_utf8_findfirstbyte"><code>mdn_utf8_findfirstbyte</code></a></h4>
<blockquote>
<pre>
char *
mdn_utf8_findfirstbyte(const char *s,
const char *known_top)
</pre>
</blockquote>
<p>
In the character string, <var>known_top</var> checks the leading byte of UTF-8 characters
including the byte indicated by <var>s</var> and returns it. <code>NULL</code> is returned if there are
any incorrectly encoded UTF-8 characters or no leading byte between
<var>known_top</var> and <var>s</var>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="util"><code>util</code> module</a></h3>
<p>
The <code>util</code> module provides utility type functions used by other modules. The only function currently provided is a character string collation function that does
not differentiate between uppercase and lowercase characters.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_util_casematch"><code>mdn_util_casematch</code></a></h4>
<blockquote>
<pre>
int
mdn_util_casematch(const char *s1, const char *s2, size_t n)
</pre>
</blockquote>
<p>
Compares the maximum <var>n</var> bytes from the beginning of character strings <var>s1</var> and <var>s2</var>
and determines whether they are identical. Uppercase and lowercase ASCII
characters (i.e. A to Z and a to z) are assumed to be the same. 1 is returned if
they are found to be identical and 0 is returned if not. With the exception of
the return value specifications, this function provides almost the same features
as <code>strcasencmp</code>, which is provided in many systems.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_util_domainspan"><code>mdn_util_domainspan</code></a></h4>
<blockquote>
<pre>
const char *
mdn_util_domainspan(const char *s, const char *end)
</pre>
</blockquote>
<p>
Obtains the range of characters that can be used as ASCII domain names.
Checking starts with <var>s</var> and ends with <var>end</var> (not including characters that are not
indicated by <var>end</var>) to find whether each character is an ASCII alphanumeric or
hyphen. If another character is found, the location of the first appearance of
such character is returned. When all characters are found alphanumerics or
hyphens, <var>end</var> is returned.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_util_validstd13"><code>mdn_util_validstd13</code></a></h4>
<blockquote>
<pre>
int
mdn_util_validstd13(const char *s, const char *end)
</pre>
</blockquote>
<p>
Checks whether the (part) character string indicated by <var>s</var> and <var>end</var> is the
correct format as the ASCII domain name label (each part delimited by period).
However, <var>end</var> indicates the character following the last character. Also, when
<var>end</var> is <var>NULL</var>, checking target is from <var>s</var> to NUL character.
</p>
<p>
Character strings that satisfy the following requirements are determined to be
the correct format.
<ol>
<li>Composed of only ASCII alphanumerics and hyphens.
<li>The first and last characters are not both hyphens.
</ol>
<p>
When the format is correct, 1 is returned and if not, 0 is returned.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_util_utf8toutf16"><code>mdn_util_utf8toutf16</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_util_utf8toutf16(const char *utf8, size_t fromlen,
unsigned short *utf16, size_t tolen, size_t *reslenp)
</pre>
</blockquote>
<p>
Converts character string <var>utf8</var> in UTF-8 format of length <var>fromlen</var> to UTF-16
format (16 bit integer arrangement) and stores the result in <var>utf16</var>. <var>tolen</var> is the field size (number of characters) indicated by <var>utf16</var>. The length of the
character string after conversion is stored in <var>*reslenp</var>.
</p>
<p>
The return value is mdn_success, mdn_buffer_overflow, or mdn_invalid_encoding.
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_util_utf16toutf8"><code>mdn_util_utf16toutf8</code></a></h4>
<blockquote>
<pre>
mdn_result_t
mdn_util_utf16toutf8(const unsigned short *utf16, size_t fromlen,
char *utf8, size_t tolen, size_t *reslenp)
</pre>
</blockquote>
<p>
Converts the data <var>utf8</var> (16 bit integer arrangement) in UTF-16 format of length
<var>fromlen</var> to the character string in UTF-8 format and stores the result in <var>utf8</var>.
<var>tolen</var> is the field size (number of bytes) indicated by <var>utf8</var>. The length of the character string after conversion is stored in <var>*reslenp</var>.
</p>
<p>
The return value is mdn_success, mdn_buffer_overflow, or mdn_invalid_encoding.
<code>mdn_success</code>,
<code>mdn_buffer_overflow</code>,
<code>mdn_invalid_encoding</code>.
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<hr>
<h3><a name="version"><code>version</code> module</a></h3>
<p>
The <code>version</code> module provides MDN library version functions.
</p>
<p>
This module provides the following API functions.
</p>
<!-- = = = = = = = = = = = = = = = -->
<h4><a name="mdn_version_getstring"><code>mdn_version_getstring</code></a></h4>
<blockquote>
<pre>
const char *
mdn_version_getstring(void);
</pre>
</blockquote>
<p>
Returns a character string representing the MDN library version number.
</p>
</body>
</html>
|
