/usr/share/doc/eb-doc/html/eb-cat.html is in eb-doc 4.4.3-9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<!-- #file "eb.html" -->
<html lang="ja">
<head>
<link rel="stylesheet" type="text/css" href="eb.css">
<link rev="made" href="mailto:m-kasahr@sra.co.jp">
<title>EB ライブラリ</title>
</head>
<body>
<h1><a name="toc">EB ライブラリ</a></h1>
<p>
この文書は、EB ライブラリバージョン
4.4.3
に対応しています。
</p>
<p>
目次:
</p>
<ul>
<li><a href="#introduction">はじめに</a>
<ul>
<li><a href="#electronic-book-and-epwing">電子ブックと EPWING について</a>
<li><a href="#construction-of-this-book">本書の構成について</a>
</ul>
<li><a href="#features">EB ライブラリの特徴</a>
<ul>
<li><a href="#header-files">ヘッダファイル</a>
<li><a href="#character-code">文字コード</a>
<li><a href="#compressed-book">圧縮された書籍について</a>
<li><a href="#remote-access">遠隔ホスト上の書籍について</a>
<li><a href="#system-requirements">システムの要件</a>
</ul>
<li><a href="#compilation">プログラムのコンパイル方法</a>
<ul>
<li><a href="#compilation-simple-way">てっとり早いコンパイル方法</a>
<li><a href="#compilation-with-autoconf">Autoconf を併用したコンパイル方法</a>
<li><a href="#debug-eb-library">EB ライブラリ本体のデバッグ</a>
</ul>
<li><a href="#init-and-exit">ライブラリの初期化と後始末</a>
<ul>
<li><a href="#init-and-exit-sample">サンプルプログラム</a>
<li><a href="#init-and-exit-functions">関数の詳細</a>
</ul>
<li><a href="#eb_book">CD-ROM 書籍と <code>EB_Book</code> オブジェクト</a>
<ul>
<li><a href="#eb_book-explanation"><code>EB_Book</code> オブジェクト</a>
<li><a href="#eb_bind-to-remote-host">遠隔ホストへの <code>eb_bind()</code></a>
<li><a href="#eb_book-sample">サンプルプログラム</a>
<li><a href="#eb_book-data-types">データ型の詳細</a>
<li><a href="#eb_book-functions">関数の詳細</a>
</ul>
<li><a href="#error-handling">エラー処理</a>
<ul>
<li><a href="#error-code-and-message">エラーコードとエラーメッセージ</a>
<li><a href="#tolerance-to-error">エラーに対する寛容さ</a>
<li><a href="#error-data-types">データ型の詳細</a>
<li><a href="#error-code-list">エラーコードの一覧</a>
<li><a href="#error-functions">関数の詳細</a>
</ul>
<li><a href="#subbook">副本</a>
<ul>
<li><a href="#subbook-code">副本コード</a>
<li><a href="#current-subbook">選択中の副本</a>
<li><a href="#subbook-sample">サンプルプログラム</a>
<li><a href="#subbook-data-types">データ型の詳細</a>
<li><a href="#subbook-functions">関数の詳細</a>
</ul>
<li><a href="#search">検索</a>
<ul>
<li><a href="#word-search">前方一致、後方一致、完全一致検索</a>
<li><a href="#keyword-search">条件検索</a>
<li><a href="#cross-search">クロス検索</a>
<li><a href="#multi-search">複合検索</a>
<li><a href="#eb_hit">一致エントリの情報</a>
<li><a href="#get-remained-entries">残っているエントリの取得</a>
<li><a href="#unify-duplicated-entries">重複エントリの削除</a>
<li><a href="#search-sample">サンプルプログラム</a>
<li><a href="#search-data-types">データ型の詳細</a>
<li><a href="#search-functions">関数の詳細</a>
</ul>
<li><a href="#text-data">テキストデータ</a>
<ul>
<li><a href="#seek-and-read-text-data">テキストデータのシークと読み込み</a>
<li><a href="#text-data-format">テキストデータの内部形式</a>
<li><a href="#hook">フック</a>
<li><a href="#hook-and-character-code">フックと文字コードの関係</a>
<li><a href="#cross-search-result">クロス検索の検索結果</a>
<li><a href="#copyright-notice">著作権表示</a>
<li><a href="#menu">メニュー</a>
<li><a href="#multi-candidates">複合検索の候補一覧</a>
<li><a href="#stop-code-issue">区切りコードの問題</a>
<li><a href="#text-data-sample">サンプルプログラム</a>
<li><a href="#text-data-types">データ型の詳細</a>
<li><a href="#hook-function-details">フック関数の詳細</a>
<li><a href="#hook-code-list">フックコードの一覧</a>
<li><a href="#hookset-access-functions">フックセット操作関数の詳細</a>
<li><a href="#builtin-hook-functions">組み込みフック関数の詳細</a>
<li><a href="#text-data-functions">テキストデータ操作関数の詳細</a>
</ul>
<li><a href="#local-character">外字</a>
<ul>
<li><a href="#narrow-and-wide-font">半角外字と全角外字</a>
<li><a href="#font-size-and-font-code">外字の大きさと外字コード</a>
<li><a href="#current-font-height">選択中の外字フォントの高さ</a>
<li><a href="#get-font">外字フォントの取り出し</a>
<li><a href="#convert-font">外字フォントの変換</a>
<li><a href="#local-character-in-text">テキスト中の外字</a>
<li><a href="#font-data-types">データ型の詳細</a>
<li><a href="#font-constants">定数の詳細</a>
<li><a href="#font-functions">関数の詳細</a>
<li><a href="#font-sample">サンプルプログラム</a>
</ul>
<li><a href="#binary-data">バイナリデータ</a>
<ul>
<li><a href="#monochrome-image">モノクロ図版</a>
<li><a href="#color-image">カラー図版</a>
<li><a href="#clickable-color-image">参照先付きカラー図版</a>
<li><a href="#wave-sound">WAVE (PCM) 音声</a>
<li><a href="#mpeg-movie">MPEG1 動画</a>
<li><a href="#binary-data-functions">関数の詳細</a>
</ul>
<li><a href="#appendix-data">appendix データ</a>
<ul>
<li><a href="#eb_appendix"><code>EB_Appendix</code> オブジェクト</a>
<li><a href="#appendix-subbook">副本</a>
<li><a href="#appendix-stop-code">本文の区切りコード</a>
<li><a href="#appendix-alternation-text">外字の代替文字列</a>
<li><a href="#appendix-data-types">データ型の詳細</a>
<li><a href="#appendix-functions">関数の詳細</a>
<li><a href="#appendix-sample">サンプルプログラム</a>
</ul>
<li><a href="#book-list-on-server">サーバ上の書籍一覧</a>
<ul>
<li><a href="#eb_booklist-object"><code>EB_BookList</code> オブジェクト</a>
<li><a href="#booklist-data">データ型の詳細</a>
<li><a href="#booklist-functions">関数の詳細</a>
<li><a href="#booklist-sample">サンプルプログラム</a>
</ul>
<li><a href="#indice">索引</a>
<ul>
<li><a href="#data-type-index">データ型の索引</a>
<li><a href="#function-index">関数の索引</a>
<li><a href="#const-index">定数の索引</a>
</ul>
</ul>
<p>
Copyright (c) 2001-2006 Motoyuki Kasahara
</p>
<!-- ================================================================ -->
<h2><a name="introduction">はじめに</a></h2>
<p>
EB ライブラリは CD-ROM 書籍にアクセスするための C のライブラリです。
UNIX 系 OS および Windows (2000以降) のシステム上で動作させることが
できます。
</p>
<p>
EB ライブラリは EB, EBG, EBXA, EBXA-C, S-EBXA および EPWING 形式の
CD-ROM 書籍に対応しています。
これらは、主に日本で販売されている辞書に使われています。
CD-ROM 書籍自体は ISO 9660 形式になっていますので、他の ISO 9660 形式
と同じ要領でマウントすることができます。
</p>
<p>
本書は、EB ライブラリを使ってアプリケーションプログラムを作成する
開発者向けに、ライブラリの仕様を解説した文書です。
そして、ライブラリの公式な参照マニュアルでもあります。
読み進めるにあたって、読者は EB ライブラリおよび CD-ROM 書籍の内部構造
について知っている必要はありませんが、電子ブックか EPWING を利用して、
実際に CD-ROM 書籍がどのようなものかを理解しておくことをお薦めします。
また、C 言語によるプログラミングについては、十分に理解していることを前提
とします。
</p>
<p>
本書の内容に沿って EB ライブラリを使ったアプリケーションプログラムを
作成するには、お使用いのシステムに EB ライブラリと C コンパイラを
インストールしておいて下さい。
なお、本書では主に UNIX 系 OS を使用した場合について、記述しています。
</p>
<p>
EB ライブラリはフリーソフトウェアです。ソースコードおよびバイナリを、
いわゆる Modified BSD ライセンスの下で使用することが可能です。
(バージョン 4.1 よりも前のものは、GPL を採用していました。)
詳しくは、ソースコードに付属している COPYING という英文のファイルを参照
して下さい。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="electronic-book-and-epwing">電子ブックと EPWING について</a></h3>
<p>
電子ブックと EPWING は、いずれも主に日本で使われている電子書籍の
データ形式の名称で、CD-ROM に収めた形で数々の書籍が市販されています。
CD-ROM は ISO 9660 形式 なので、CD-ROM ドライブが扱えるシステムであれば、
容易にアクセスすることができます。
電子書籍のデータ形式とはいっても、実際は辞書向けに特化した構造となって
おり、市販されている書籍も辞書の類が圧倒的に多いようです。
</p>
<p>
電子ブック、EPWING ともに、データ形式に関する規格の全容は一般公開されて
いませんが、EPWING ついては規格の一部が日本工業規格 JIS X 4081
「電子出版検索データ構造」として公開されています。
さらに、EPWING と電子ブックのデータ形式は、酷似していることが知られて
います。
</p>
<p>
EB ライブラリの開発者も、電子ブック、EPWING 規格の全容は知りません。
EB ライブラリでは JIS X 4081 の記述をもとに、電子ブック、EPWING を読める
ようにしてあります。
しかしながら、規格の全容が分からない状態で開発しているため、残念ながら
一部に正しく読めない書籍が存在します。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="construction-of-this-book">本書の構成について</a></h3>
<p>
次章「EB ライブラリの特徴」では、EB ライブラリが対応している機能、対応
していない機能について、簡単に説明します。
また、ライブラリの概略に関して、最初に知っておいたほうが良いと思われる
事柄をいくつか説明しています。
</p>
<p>
さらに次の章「プログラムのコンパイル方法」では、EB ライブラリを利用した
プログラムのコンパイル方法を説明します。
本書のサンプルプログラムをコンパイルするために必要な情報も、この章に
記してあります。
</p>
<p>
そして、その次の章「ライブラリの初期化と後始末」からが、実際の
EB ライブラリのプログラミングの解説となります。
それぞれの章は、次のような節から構成されています。
ただし、章によっては一部の節がない場合もあります。
</p>
<dl>
<dt>解説</dt>
<dd>
その章で解説する機能や概念についての基礎知識、EB ライブラリの仕様の
概要について解説しています。
<dt>サンプルプログラム</dt>
<dd>
「解説」ではプログラムの断片だけを示すことが多いので、動作可能な
プログラムのサンプルをここで示します。
<dt>データ型の詳細</dt>
<dd>
データ型や関数、定数値などについての参照マニュアルです。
</dl>
<!-- ================================================================ -->
<h2><a name="features">EB ライブラリの特徴</a></h2>
<p>
前に述べたように、EB ライブラリは、電子ブック (EB, EBG, EBXA, EBXA-C, S-EBXA)
と EPWING 形式の CD-ROM 書籍に対応しています。
</p>
<p>
EB ライブラリは、これらの CD-ROM 書籍に対して、次の処理を行うことが
できます。
</p>
<ul>
<li>前方一致検索
<li>後方一致検索
<li>完全一致検索
<li>条件検索
<li>複合検索
<li>見出しデータの取得
<li>本文データの取得
<li>メニューの取得
<li>著作権表示の取得
<li>カラー図版データの取得 (ただし EPWING のみ)
<li>モノクロ図版データの取得
<li>外字データの取得
<li>動画データの取得
</ul>
<p>
この章では、EB ライブラリの概要に関して、あらかじめ知っておいて頂いた
ほうが良いと思われるその他の事柄について、何点か説明します。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="header-files">ヘッダファイル</a></h3>
<p>
EB ライブラリには、いくつかのヘッダファイルが用意されています。
</p>
<dl>
<dt><code>appendix.h</code></dt>
<dd>
appendix (付録) に関連した宣言、定義を行う。
<dt><code>binary.h</code></dt>
<dd>
バイナリデータに関連した宣言、定義を行う。
<dt><code>eb.h</code></dt>
<dd>
EB ライブラリの基本ヘッダファイル。
<dt><code>error.h</code></dt>
<dd>
エラーコードに関連した宣言、定義を行う。
<dt><code>font.h</code></dt>
<dd>
外字に関連した宣言、定義を行う。
<dt><code>text.h</code></dt>
<dd>
テキストデータ (本文、見出しなど) に関連した宣言、定義を行う。
</dl>
<p>
これ以外にもいくつかのファイルがインストールされますが、上に挙げた
ヘッダファイルから読み込まれるもので、アプリケーションプログラムが
直接読み込む必要はありません。
</p>
<p>
アプリケーションプログラムは、EB ライブラリを使う際にこのヘッダファイル
をファイルの先頭付近で読み込みます。
</p>
<blockquote class="program">
<pre>
#include <eb/eb.h>
#include <eb/error.h>
</pre>
</blockquote>
<p>
<code>eb.h</code> ではなく、<code>eb/eb.h</code> を読み込むようにして下さい。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="character-code">文字コード</a></h3>
<p>
EB ライブラリでは、CD-ROM 書籍内のデータを文字列にしてアプリケーション
に渡す際の文字コードを規定しています。
</p>
<p>
EBG (海外の電子ブック) については、データが ISO 8859-1 (ラテン文字 1、
ただし制御文字を除く) で書かれているため、データのやり取りも ISO 8859-1
で行います。
ただし、外字だけは 2 バイトで表現し、0x0101 〜 0x1efe の領域を使用します。
(外字領域の下位 16 ビットは 0x01 〜 0xfe の範囲を使用します。)
</p>
<p>
EBG, EBXA-C を除いた電子ブック、および EPWING については、データが
JIS X 0208 (日本語のかな漢字) で書かれており、JIS X 0208 を 0x2121 〜
0x7e7e にマッピングし、0xa121 〜 0xfe7e を外字領域にしています (下図)。
</p>
<blockquote>
<pre>
上位８ビット
００ ２１ ７ｅ ａ１ ｆｅ
００┌──┬─────┬──┬─────┬┐
│ │ │ │ ││
２１├──┼─────┼──┼─────┼┤
│ │ │ │ ││
│ │ＪＩＳ Ｘ│ │ 外字 ││
│ │０２０８ │ │ ││
│ │ │ │ ││
７ｅ├──┼─────┼──┼─────┼┤
下位８ビット │ │ │ │ ││
ａ１├──┼─────┼──┼─────┼┤
│ │ │ │ ││
│ │ │ │ ││
│ │ │ │ ││
│ │ │ │ ││
ｆｅ├──┼─────┼──┼─────┼┤
└──┴─────┴──┴─────┴┘
</pre>
</blockquote>
<p>
EB ライブラリでは JIS X 0208 部分を日本語 EUC (EUC-JP) にエンコード
して、アプリケーションとのやり取りも日本語 EUC で行います。
したがって、JIS X 0208 部分は 0xa1a1 〜 0xfefe にマッピングされます。
</p>
<p>
EBXA-C (中日・日中辞書の電子ブック) については、データが JIS X 0208
(日本語のかな漢字) と GB 2312 (中国語の簡体字) で書かれており、
JIS X 0208 を 0x2121 〜 0x7e7e にマッピング、
GB 2312 を 0x21a1 〜 0x7efe にマッピングし、
0xa121 〜 0xfe7e を外字領域にしています (下図)。
</p>
<blockquote>
<pre>
上位８ビット
００ ２１ ７ｅ ａ１ ｆｅ
００┌──┬─────┬──┬─────┬┐
│ │ │ │ ││
２１├──┼─────┼──┼─────┼┤
│ │ │ │ ││
│ │ＪＩＳ Ｘ│ │ 外字 ││
│ │０２０８ │ │ ││
│ │ │ │ ││
７ｅ├──┼─────┼──┼─────┼┤
下位８ビット │ │ │ │ ││
ａ１├──┼─────┼──┼─────┼┤
│ │ │ │ ││
│ │ＧＢ │ │ ││
│ │２３１２ │ │ ││
│ │ │ │ ││
ｆｅ├──┼─────┼──┼─────┼┤
└──┴─────┴──┴─────┴┘
</pre>
</blockquote>
<p>
EB ライブラリでは、アプリケーションとのやり取りに使う文字コードは、
日本語 EUC および中国語 EUC (EUC-ZH) です。
したがって、そのままでは JIS X 0208 と GB 2312 が 0xa1a1 〜 0xfefe に
マッピングされ、衝突してしまいます。
この問題をどう回避するのかは、アプリケーション側で決める必要があります
(詳しくは、<a href="#hook-and-character-code">「フックと文字コードの関係」</a> を参照のこと)。
</p>
<p>
電子ブック、EPWING ともに、外字については、アプリケーション側でどう
扱うかを決める必要があります。
外字について詳しくは <a href="#local-character">「外字」</a> を参照のこと。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="compressed-book">圧縮された書籍について</a></h3>
<p>
EB ライブラは、データを圧縮して収録した書籍を扱うことができます。
今のところ、次の 4 種類の圧縮方法に対応しています。
</p>
<dl>
<dt><code>ebzip</code> 圧縮形式</dt>
<dd>
EB ライブラリ独自の圧縮形式です。
付属の <code>ebzip</code> コマンドを使うと、この形式で圧縮した書籍を作れます。
<dt>EPWING V4, V5 形式</dt>
<dd>
市販の EPWING V4, V5 の書籍の一部に、この形式で圧縮したものがあります。
<dt>EPWING V6 形式</dt>
<dd>
市販の EPWING V6 の書籍の一部に、この形式で圧縮したものがあります。
EPWING V4, V5 形式の改良型です。
<dt>S-EBXA 形式</dt>
<dd>
市販の S-EBXA の書籍の一部に、この形式で圧縮したものがあります。
</dl>
<p>
データの伸長は EB ライブラリ側で自動的に行われるため、
アプリケーションプログラムからは、アクセスしている書籍が圧縮されているか
どうか分かりません。
アプリケーションプログラムは、書籍が圧縮されているかどうかで処理を変える
必要はありません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="remote-access">遠隔ホスト上の書籍について</a></h3>
<p>
バージョン 4.0 から、EB ライブラリは他のホストの書籍にアクセスできる
ようになりました。
</p>
<p>
遠隔アクセスの処理はすべて EB ライブラリ側で行われますので、
アプリケーションプログラムは、書籍が自分のホスト上にあるかどうかで、
EB ライブラリの呼び出し手順を変える必要はありません。
</p>
<p>
ただし、他のホストからアクセスすると、処理速度は非常に遅くなります。
そのため、効率良く処理できるよう、アプリケーションの処理方法を工夫すべき
状況が生じることはあるかも知れません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="system-requirements">システムの要件</a></h3>
<p>
アプリケーションプログラムのコンパイルに用いるコンパイラには、
ANSI (ANSI X3.159-1989, ISO/IEC 9899-1990) 対応のものを対象としています。
また、システムには POSIX.1 (IEEE Std. 1003.2-1990, ISO/IEC 9945-1:1990)
準拠ないし互換のものを対象としています。
</p>
<p>
永らく EB ライブラリでは、古いコンパイラや UNIX 系システムへの対応も
それなりに行われていましたが、バージョン 4.1 からは対応を打ち切っています。
特に ANSI 対応のコンパイラは必須ですので、ご注意ください。
</p>
<!-- ================================================================ -->
<h2><a name="compilation">プログラムのコンパイル方法</a></h2>
<p>
本章では、EB ライブラリを利用したプログラムのコンパイルの仕方について、
2 通りの方法を説明します。
</p>
<p>
一つ目は、ごく私的な、小規模のプログラムをコンパイルする際に向いている
てっとり早くコンパイルするための方法です。
EB ライブラリの使い方を覚える目的で簡単なプログラムを組む際は、こちら
が良いでしょう。
</p>
<p>
二つ目は、EB ライブラリを組み込んだアプリケーションをフリーソフトウェア
としてリリースする際に向いている方法です。
EB ライブラリには、GNU Autoconf, Automake, Libtool を併用する仕組みを
用意してありますので、これらを使ったコンパイル方法について説明します。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="compilation-simple-way">てっとり早いコンパイル方法</a></h3>
<p>
アプリケーションプログラムをコンパイルする際は、ヘッダファイルの
ディレクトリ位置を C コンパイラに教えてやる必要があるかも知れません。
一般に UNIX の C コンパイラでは、<samp>-I</samp> オプションで位置を指定
します。
</p>
<blockquote>
<pre>
cc -I/usr/local/include -c sample.c
</pre>
</blockquote>
<p>
<code>/usr/local/include/eb</code> ではなく、その一つ上を指定します
(<a href="#header-files">「ヘッダファイル」</a> を参照のこと)。
</p>
<p>
次に、リンクして実行バイナリを生成する工程ですが、
以下に記したライブラリの一部、もしくは全部をリンクします。
括弧内は、ライブラリのファイル名です (ただし、<code>.a</code> や
<code>.so</code> といった接尾子は省略)。
</p>
<dl>
<dt>EB ライブラリ (libeb)</dt>
<dd>
EB ライブラリの本体です。このライブラリは必須です。
<dt>zlib (libz)</dt>
<dd>
圧縮と伸長を行うライブラリです
(詳しくは @url{http://www.gzip.org/zlib/})。
<code>ebzip</code> コマンドで圧縮した辞書を扱うために使います。
このライブラリは必須です。
EB ライブラリのソースコードには zlib も収録されています。
システムに zlib が インストールされていなければ、EB ライブラリを
インストールする際に、zlib も自動的にインストールされます。
<dt>gettext ライブラリ (libintl)</dt>
<dd>
メッセージの国際化機能 (NLS) を提供するライブラリです
メッセージの国際化機能を有効にして EB ライブラリをコンパイルしている
場合は、必要になるかも知れません。
gettext の実装は何種類かありますが、EB ライブラリで使用できるのは
メッセージカタログの形式が GNU gettext 互換のものだけです。
メッセージの国際化機能を有効にしている場合でも、OS の標準 C ライブラリ
として glibc を採用しているシステムでは、指定する必要はありません。
<dt>iconv ライブラリ</dt>
<dd>
文字コード変換のライブラリです。
gettext ライブラリをリンクする場合、一緒に必要となるかも知れません。
iconv の実装も何種類かあり、OS によっては最初から添付されています。
</dl>
<p>
必要なライブラリファイルの名称を、C コンパイラに指定してやります。
加えて、ファイルの置かれているディレクトリ位置を、C コンパイラに教える
必要があるかも知れません。
一般に UNIX の C コンパイラでは、<samp>-L</samp> オプションでディレクトリ
位置を指定し、<samp>-l</samp> オプションでライブラリのファイル名を指定
します。
</p>
<blockquote>
<pre>
cc sample.o -L/usr/local/lib -leb -lz -lintl -liconv
</pre>
</blockquote>
<p>
ただし、共有ライブラリをリンクする場合は、実行時におけるライブラリの
検索パスも合わせて指定する必要があるかも知れません。
</p>
<blockquote>
<pre>
cc sample.o -R/usr/local/lib -L/usr/local/lib -leb -lz -lintl -liconv
</pre>
</blockquote>
<p>
C コンパイラの使い方に関しての詳細は、C コンパイラのマニュアルを参照
して下さい。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="compilation-with-autoconf">Autoconf を併用したコンパイル方法</a></h3>
<p>
作業の前に、Autoconf, Automake, Libtool は、あらかじめインストールして
おいて下さい。
Autoconf はバージョン 2.50 以降が必要です。
</p>
<p>
まず、アプリケーションプログラムの <code>configure.ac</code>
(もしくは <code>configure.in</code>) に、次の行を加えます。
</p>
<blockquote class="program">
<pre>
eb_LIB_EB4
</pre>
</blockquote>
<p>
マクロ <code>eb_LIB_EB4</code> は、EB ライブラリの使用に必要な一切の
チェックを行い、さらに <code>configure</code> に次のオプションを追加
します。
</p>
<blockquote>
<pre>
--with-eb-conf=FILE eb.conf file is FILE [SYSCONFDIR/eb.conf]
</pre>
</blockquote>
<p>
<code>eb.conf</code> は、EB ライブラリをインストールしたときの情報を記録
したファイルで、ライブラリと一緒にインストールされます。
<code>eb_LIB_EB4</code> はこのファイルを読み込んで、C コンパイラに
渡さなければいけないオプションなどの情報を得ます。
<samp>--eb-conf-file</samp> は、<code>eb.conf</code> のファイル名を
明示的に指定するオプションです。
</p>
<p>
マクロ <code>eb_LIB_EB4</code> は、<code>eb4.m4</code> というファイルで
提供されています。
EB ライブラリを <code>/usr/local</code> にインストールし、個々のファイル
のインストール先を変更していなければ、<code>/usr/local/share/aclocal</code>
にインストールされます。
この <code>eb4.m4</code> をソースコードの適当なディレクトリの下 (たとえば
<code>m4</code>) にコピーして下さい。
</p>
<p>
<code>aclocal</code> コマンドで <code>aclocal.m4</code> を再生成する際は、
<samp>-I</samp> オプションでマクロファイルのディレクトリを指定します。
</p>
<blockquote>
<pre>
aclocal -I m4
</pre>
</blockquote>
<p>
加えて、トップディレクトリの <code>Makefile.am</code> の中にも
<code>aclocal</code> へ渡すオプションを書いておきます。
</p>
<blockquote class="program">
<pre>
ACLOCAL_AMFLAGS = -I m4
</pre>
</blockquote>
<p>
また、ソースコードのディレクトリに Libtool パッケージがまだ用意されて
いなければ、用意します。
<code>libtoolize</code> コマンドを実行して下さい。
Libtool パッケージが、ソースコードのディレクトリにコピーされます。
</p>
<blockquote>
<pre>
libtoolize
</pre>
</blockquote>
<p>
最後に、コンパイルを行うディレクトリの <code>Makefile.am</code> ファイル
の <code>_LDFLAGS</code> と <code>INCLUDES</code> に、次のような値を追加
します。
</p>
<blockquote class="program">
<pre>
program_LDFLAGS = $(EBCONF_EBLIBS) $(EBCONF_ZLIBLIBS) $(EBCONF_INTLLIBS)
INCLUDES = $(EBCONF_EBINCS)
</pre>
</blockquote>
<p>
(<code>program_LDFLAGS</code> の <code>program</code> のところは、
アプリケーションプログラムの実際のコマンド名にします。)
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="debug-eb-library">EB ライブラリ本体のデバッグ</a></h3>
<p>
「自分が作ったアプリケーションが正しく動かないのは、ひょっとすると
EB ライブラリのバグが原因ではないか?」という疑問を抱き、EB ライブラリ
の挙動を確認したいと思うことがあるかも知れません。
</p>
<p>
そのような場合は、環境変数 <code>EB_DEBUG</code> をセットした状態で
アプリケーションを実行してみて下さい。
EB ライブラリは標準エラー出力に、次のようなログを (かなり大量ですが)
出力するようになります。
</p>
<blockquote>
<pre>
[EB] in: eb_set_font(book=0, font_code=0)
[EB] in: eb_load_narrow_font(book=0)
[EB] out: eb_load_narrow_font()
[EB] in: eb_load_wide_font(book=0)
[EB] out: eb_load_wide_font()
[EB] out: eb_set_font() = EB_SUCCESS
</pre>
</blockquote>
<p>
これらのログは、関数の呼び出し時の引数列、および関数からの戻り値を
示しています。
<code>ebfixlog</code> という Perl5 スクリプトを使うと、ログを整形すること
ができます。
このスクリプトは、EB ライブラリのソースコードの <code>misc</code>
ディレクトリに収められています。
</p>
<p>
<code>ebfixlog</code> は、コマンド行の引数として与えられたファイル
(引数が指定されなければ標準入力) からメッセージデータを読み込み、
次のように字下げして出力します。
</p>
<blockquote>
<pre>
[EB] in: eb_set_font(book=0, font_code=0)
[EB] in: eb_load_narrow_font(book=0)
[EB] out: eb_load_narrow_font()
[EB] in: eb_load_wide_font(book=0)
[EB] out: eb_load_wide_font()
[EB] out: eb_set_font() = EB_SUCCESS
</pre>
</blockquote>
<p>
通常 <code>ebfixlog</code> スクリプトは、zio および ebnet と呼ばれる、
EB ライブラリでファイル入出力を受け持つ処理部のログは読み捨てるように
なっています。
これにより、ログの量がかなり減ります。
</p>
<p>
zio は EB ライブラリの低レベル入出力の処理部で、頻繁に呼び出されます。
問題の原因を調べる際も、まずは読み捨てた方がライブラリの内部動作を追跡
しやすいでしょう。
</p>
<p>
<code>ebfixlog</code> の <samp>-z</samp> オプションを使うと、zio の
メッセージを読み捨てずに出力するようになります。
</p>
<p>
ebnet は遠隔アクセスの入出力を処理する部分で、zio よりもさらに
下位レベルに位置します。
遠隔アクセスの挙動を追跡するとき以外は、読み捨てた方が良いと思います。
</p>
<p>
<code>ebfixlog</code> の <samp>-n</samp> オプションを使うと、ebnet,
zio 両方のメッセージを読み捨てずに出力するようになります。
</p>
<!-- ================================================================ -->
<h2><a name="init-and-exit">ライブラリの初期化と後始末</a></h2>
<p>
この章からは、EB ライブラリのプログラミングについての解説になります。
</p>
<p>
まず、アプリケーションプログラムから EB ライブラリを利用するには、
最初にライブラリを初期化する必要があります。
</p>
<p>
ライブラリの初期化を行うには、<code>eb_initialize_library()</code>
という関数を呼び出します。
</p>
<blockquote class="program">
<pre>
if (eb_initialize_library() != EB_SUCCESS) {
printf("eb_initialize_library() failed\n");
exit(1);
}
</pre>
</blockquote>
<p>
同様に、ライブラリを使い終わったら、<code>eb_finalize_library()</code>
という関数を呼び出して後始末をします。
</p>
<blockquote class="program">
<pre>
eb_finalize_library();
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="init-and-exit-sample">サンプルプログラム</a></h3>
<blockquote>
<pre>
/* -*- C -*-
* Copyright (c) 2001-2006 Motoyuki Kasahara
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the project nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* 使用方法:
* initexit
* 例:
* initexit
* 説明:
* EB ライブラリの初期化、後始末をしてみます。
* プログラムの外側から見れば、これは何の意味もない動作です。
*/
#include <stdio.h>
#include <stdlib.h>
#include <eb/eb.h>
#include <eb/error.h>
int
main(int argc, char *argv[])
{
EB_Error_Code error_code;
/* EB ライブラリを初期化。*/
error_code = eb_initialize_library();
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to initialize EB Library, %s: %s\n",
argv[0], eb_error_message(error_code), argv[1]);
exit(1);
}
/* EB ライブラリの利用を終了。*/
eb_finalize_library();
exit(0);
}
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="init-and-exit-functions">関数の詳細</a></h3>
<p>
この項で説明している関数を使うには、<code>eb/eb.h</code> を読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/eb.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:initialize_library"><code>EB_Error_Code eb_initialize_library ()</code></a></h4>
<p>
関数 <code>eb_initialize_library()</code> は、EB ライブラリを初期化します。
アプリケーションプログラムは、EB ライブラリの他の関数を呼ぶ前に、必ず
一回だけこの関数を呼ぶ必要があります。
</p>
<p>
メッセージの国際化機能 (NLS) を有効にして EB ライブラリをコンパイル
した場合、<code>eb_initialize_library()</code> は <code>bindtextdomain()</code> を
呼び出します。
したがって、アプリケーションプログラムが <code>setlocale()</code> を
呼び出すのは、この関数を呼び出す前である必要があります。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因を示すエラーコードを返します。
</p>
<p>
ライブラリを初期化せずに、EB ライブラリの他の関数を呼んだ場合の動作は
未定義です。
また、すでに初期化を済ませた状態で、再度 <code>eb_initialize_library()</code>
を呼んでもいけません。
呼んだ場合の動作は未定義です。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:finalize_library"><code>void eb_finalize_library ()</code></a></h4>
<p>
関数 <code>eb_finalize_library()</code> は、EB ライブラリを使い終わった
際の後始末を行います。
ただし、アプリケーションプログラム側で使用した
<code>EB_Book</code>、<code>EB_Hookset</code>、<code>EB_Appendix</code> オブジェクトの後始末は行いません。
オブジェクトを後始末するには、それぞれ専用の関数
<code>eb_finalize_book()</code>、<code>eb_finalize_hookset()</code>、
<code>eb_finalize_appendix()</code> を各オブジェクトに対して別途
呼んでやる必要があります。
</p>
<p>
ライブラリの後始末をした後は、EB ライブラリのいかなる関数も呼んでは
いけません。
呼んだ場合の動作は未定義です。
</p>
<!-- ================================================================ -->
<h2><a name="eb_book">CD-ROM 書籍と <code>EB_Book</code> オブジェクト</a></h2>
<p>
EB ライブラリでは、CD-ROM 書籍へのアクセスは、すべて <code>EB_Book</code> 型
のオブジェクトを介して行います。
したがって、ほとんどのアプリケーションプログラムは、本章で記述している
処理を必要とするはずです。
</p>
<p>
本章では <code>EB_Book</code> オブジェクトの初期化、後始末といった基本的な
取り扱い方について説明します。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="eb_book-explanation"><code>EB_Book</code> オブジェクト</a></h3>
<p>
CD-ROM 書籍へアクセスするには、まず <code>EB_Book</code> 型のオブジェクトを
用意します。
同時に複数の CD-ROM 書籍にアクセスするなら、書籍一冊毎にオブジェクトを
作る必要があります。
</p>
<blockquote class="program">
<pre>
EB_Book book;
</pre>
</blockquote>
<p>
もちろん、オブジェクトの領域は、<code>malloc()</code> で確保しても
構いません。
</p>
<blockquote class="program">
<pre>
EB_Book *book_pointer;
book_pointer = (EB_Book *) malloc(sizeof(EB_Book));
</pre>
</blockquote>
<p>
<code>EB_Book</code> オブジェクトの中身 (変数 <code>book</code> の中身
および <code>book_pointer</code> の指す領域) はまだ初期化されていませんので、
次の要領でオブジェクトを初期化します。
</p>
<blockquote class="program">
<pre>
eb_initialize_book(&book);
eb_initialize_book(book_pointer);
</pre>
</blockquote>
<p>
<code>eb_initialize()</code> へ渡す引数は <code>EB_Book</code> オブジェクト
へのポインタであって、<code>EB_Book</code> オブジェクトそのものでは
ないことに注意して下さい。
(EB ライブラリの他の関数も、すべてオブジェクトをポインタで渡します。)
</p>
<p>
CD-ROM 書籍を使うには、続いて <code>EB_Book</code> オブジェクトを
CD-ROM 書籍の実体に結び付けます。
これは、関数 <code>eb_bind()</code> によって行います。
</p>
<blockquote>
<pre>
ＥＢ＿Ｂｏｏｋ ＣＤ−ＲＯＭ書籍
オブジェクト ┌────────────┐
┌───┐ │ │
│ ┝━━━━━━━━━━━┥ ／ｍｎｔ／ｃｄｒｏｍ │
└───┘ ｅｂ＿ｂｉｎｄ（） │ │
└────────────┘
</pre>
</blockquote>
<p>
実際のプログラムでは、次のようにします。
</p>
<blockquote class="program">
<pre>
if (eb_bind(&book, "/mnt/cdrom") != EB_SUCCESS) {
printf("eb_bind() failed\n");
return;
}
</pre>
</blockquote>
<p>
<code>eb_bind()</code> に渡す書籍のパス (この例では <code>/mnt/cdrom</code>)
は書籍のトップディレクトリ、つまり <code>catalog</code> または
<code>catalogs</code> ファイルのあるディレクトリを指定します。
</p>
<p>
<code>EB_Book</code> オブジェクトを使い終わったら、
<code>eb_finalize_book()</code> を呼んで後始末をします。
オブジェクトは書籍との結び付きを解かれた状態に戻り、内部で割り当てられた
メモリは解放され、開いていたファイルもすべて閉じられます。
</p>
<blockquote class="program">
<pre>
eb_finalize_book(&book);
eb_finalize_book(book_pointer);
</pre>
</blockquote>
<p>
オブジェクトの領域を <code>malloc()</code> で確保した場合は、
<code>eb_finalize_book()</code> を呼んだ後ならば、オブジェクトの領域を
安全に解放することができます。
</p>
<blockquote class="program">
<pre>
free(book_pointer);
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="eb_bind-to-remote-host">遠隔ホストへの <code>eb_bind()</code></a></h3>
<p>
前節で説明した <code>eb_bind()</code> を用いて、<code>EB_Book</code>
オブジェクトを遠隔ホストの書籍に結びつけることができます。
これには、書籍のパスの代わりに、遠隔アクセス用の識別子を指定します。
識別子は、次のような形式をとります。
</p>
<blockquote>
<pre>
ebnet://<var>ホスト</var>:<var>ポート</var>/<var>書籍名</var>
</pre>
</blockquote>
<p>
<var>ホスト</var> は遠隔ホストの IP アドレスもしくはホスト名です。
ただし、IPv6 アドレスを指定する場合は、アドレスを <code>[</code> と
<code>]</code> で囲む必要があります。
<var>ポート</var> は、そのホストが待ち受けているポートの番号です。
ホストが待ち受けているポートが標準の 22010 番であれば、<var>:ポート</var>
の部分は省略可能です。
</p>
<p>
以下に <code>eb_bind()</code> のコード例を記します。
</p>
<blockquote class="program">
<pre>
if (eb_bind(&book, "ebnet://localhost/cdrom") != EB_SUCCESS) {
printf("eb_bind() failed\n");
return;
}
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="eb_book-sample">サンプルプログラム</a></h3>
<p>
このサンプルプログラムでは、CD-ROM 書籍の種類を調べるために、
<code>eb_disc_code()</code> という関数を使用しています。
この関数については、<a href="#eb_book-functions">「関数の詳細」</a> を参照のこと。
</p>
<blockquote>
<pre>
/* -*- C -*-
* Copyright (c) 1999-2006 Motoyuki Kasahara
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the project nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* 使用方法:
* disctype <book-path>
* 例:
* disctype /cdrom
* 説明:
* <book-path> で指定された CD-ROM 書籍の種類が、EB か EPWING か
* を調べて表示します。
*/
#include <stdio.h>
#include <stdlib.h>
#include <eb/eb.h>
#include <eb/error.h>
int
main(int argc, char *argv[])
{
EB_Error_Code error_code;
EB_Book book;
EB_Disc_Code disc_code;
/* コマンド行引数をチェック。*/
if (argc != 2) {
fprintf(stderr, "Usage: %s book-path\n", argv[0]);
exit(1);
}
/* EB ライブラリと `book' を初期化。*/
error_code = eb_initialize_library();
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to initialize EB Library, %s: %s\n",
argv[0], eb_error_message(error_code), argv[1]);
goto die;
}
eb_initialize_book(&book);
/* `book' を書籍に結び付ける。失敗したら終了。*/
error_code = eb_bind(&book, argv[1]);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to bind the book, %s: %s\n",
argv[0], eb_error_message(error_code), argv[1]);
goto die;
}
/* 書籍の種類を調べて表示。*/
error_code = eb_disc_type(&book, &disc_code);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get disc type, %s: %s\n",
argv[0], eb_error_message(error_code), argv[1]);
goto die;
}
if (disc_code == EB_DISC_EB) {
fputs("EB\n", stdout);
} else if (disc_code == EB_DISC_EPWING) {
fputs("EPWING\n", stdout);
} else {
fputs("unknown\n", stdout);
}
/* 書籍と EB ライブラリの利用を終了。*/
eb_finalize_book(&book);
eb_finalize_library();
exit(0);
/* エラー発生で終了するときの処理。*/
die:
eb_finalize_book(&book);
eb_finalize_library();
exit(1);
}
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="eb_book-data-types">データ型の詳細</a></h3>
<p>
この節で説明しているデータ型を使うには、次のようにヘッダファイルを
読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/eb.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Book"><code>EB_Book</code> 型</a></h4>
<p>
<code>EB_Book</code> 型は、一冊の CD-ROM 書籍を表します。
CD-ROM 書籍へのアクセスは、すべてこの型のオブジェクトを介して行います。
同時に複数の CD-ROM 書籍にアクセスする際は、書籍一冊毎にオブジェクトを
作る必要があります。
</p>
<p>
<code>EB_Book</code> オブジェクトの操作は、すべて EB ライブラリが用意
している関数で行います。
アプリケーションプログラムは、直接 <code>EB_Book</code> オブジェクトの
メンバを参照したり、セットしたりすべきではありません。
</p>
<p>
<code>EB_Book</code> オブジェクトを使用する際は、まずそのオブジェクトに
対して <code>eb_initialize_book()</code> を呼んで初期化しなくては
なりません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Disc_Code"><code>EB_Disc_Code</code> 型</a></h4>
<p>
データ型 <code>EB_Disc_Code</code> は、CD-ROM 書籍の形式コードを表します。
現在のところ、次の値が定義されています。
</p>
<dl>
<dt><code>EB_DISC_EB</code></dt>
<dd>
電子ブック (EB, EBG, EBXA, EBXA-C, S-EBXA) であることを表します。
<dt><code>EB_DISC_EPWING</code></dt>
<dd>
EPWING であることを表します。
<dt><code>EB_DISC_INVALID</code></dt>
<dd>
不正な形式コード値を表します。
</dl>
<p>
この型は符合付き整数型の別名として定義されていますので、2 つのコードを
2 項演算子 <code>==</code> と <code>!=</code> で一致比較することができます。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:EB_Character_Code"><code>EB_Character_Code</code> 型</a></h4>
<p>
データ型 <code>EB_Character_Code</code> は、CD-ROM 書籍で使用される
文字コードを表します。
現在のところ、次の値が定義されています。
</p>
<dl>
<dt><code>EB_CHARCODE_ISO8859_1</code></dt>
<dd>
ISO 8859-1 (ラテン文字 1) を使用していることを表します。
電子ブックの EBG はこれです。
<dt><code>EB_CHARCODE_JISX0208</code></dt>
<dd>
JIS X 0208 (日本語のかな漢字) を使用していることを表します。
EBG, EBXA-C 以外の電子ブック、および EPWING はすべてこれです。
<dt><code>EB_CHARCODE_JISX0208_GB2312</code></dt>
<dd>
JIS X 0208 (日本語のかな漢字) と GB 2312 (中国語の簡体字) を併用している
ことを表します。
電子ブックの EBXA-C はこれです。
<dt><code>EB_CHARCODE_INVALID</code></dt>
<dd>
不正な文字コード値を表します。
</dl>
<p>
この型は符合付き整数型の別名として定義されていますので、2 つのコードを
2 項演算子 <code>==</code> と <code>!=</code> で一致比較することができます。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="eb_book-functions">関数の詳細</a></h3>
<p>
この節で説明している関数を使うには、次のようにヘッダファイルを読み込んで
下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/eb.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:initialize_book"><code>void eb_initialize_book (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_initialize_book()</code> は、<var>book</var> の指す
<code>EB_Book</code> オブジェクトを初期化します。
<code>EB_Book</code> オブジェクトに対して EB ライブラリの他の関数を呼ぶ前に、
必ずそのオブジェクトを初期化しなくてはなりません。
初期化していないオブジェクトに対して、EB ライブラリの他の関数を呼んだ
場合の動作は未定義です。
また、すでに初期化したオブジェクトに対して、再度
<code>eb_initialize_book()</code> を呼んではいけません。
呼んだ場合の動作は未定義です。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:bind"><code>EB_Error_Code eb_bind (EB_Book *<var>book</var>, const char *<var>path</var>)</code></a></h4>
<p>
関数 <code>eb_bind()</code> は、<var>book</var> の指す <code>EB_Book</code>
オブジェクトを、パス <var>path</var> にある CD-ROM 書籍に結び付けます。
パスには、書籍のトップディレクトリか遠隔アクセス識別子を指定します。
書籍のトップディレクトリとは、<code>catalog</code> あるいは
<code>catalogs</code> ファイルの存在するディレクトリを指します。
</p>
<p>
オブジェクトがすでに書籍に結び付いていた場合、その書籍との結び付きを
解いてから、<var>path</var> にある書籍に結び付けます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
このとき、副本は未選択の状態になります。
失敗すると、オブジェクトを書籍との結び付きを解かれた状態にして、原因
を示すエラーコードを返します。
</p>
<p>
<var>path</var> は、<code>EB_MAX_PATH_LENGTH</code> バイトに収まていなくては
なりません。
さらに、<var>path</var> が相対パスのときは、絶対パスに変換した結果がこの長さ
に収まっていなくてはなりません。
これを超えると、<code>EB_ERR_TOO_LONG_FILE_NAME</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:finalize_book"><code>void eb_finalize_book (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_finalize_book()</code> は、<var>book</var> が指す
<code>EB_Book</code> オブジェクトの後始末を行います。
</p>
<p>
オブジェクトが割り当てて管理していたメモリはすべて解放され、
ファイルディスクリプタもすべて閉じられます。
オブジェクトが書籍と結び付いていた場合は、結び付きが解かれます。
</p>
<p>
後始末をしたオブジェクトに対して <code>eb_bind()</code> を呼ぶことで、
オブジェクトを再利用することができます。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:is_bound"><code>int eb_is_bound (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_is_bound()</code> は、<var>book</var> が書籍に結び付いているか
どうかを調べます。
結び付いていれば 1 を返し、そうでなければ 0 を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:path"><code>EB_Error_Code eb_path (EB_Book *<var>book</var> const char *<var>path</var>)</code></a></h4>
<p>
関数 <code>eb_path()</code> は、<var>book</var> に結び付いている書籍のパス
もしくは遠隔アクセス識別子を、<var>path</var> の指す領域に書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>path</var> の指す領域に空文字列を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
<var>book</var> は、あらかじめ書籍に結び付いている必要があります。
結びついていない場合は、<code>EB_ERR_UNBOUND_BOOK</code> を返します。
</p>
<p>
<var>path</var> に書き込むパス名のバイト数は、最長で
<code>EB_MAX_PATH_LENGTH</code> になります。
この長さは、末尾のナル文字を含みません。
関数が返すパスは正規化された形になっているので、<code>eb_bind()</code> に
渡したときのものと同じとは限りません。
たとえば、相対パスだった場合は、絶対パスに変換されます。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:disc_type"><code>EB_Error_Code eb_disc_type (EB_Book *<var>book</var>, EB_Disc_Code *<var>disc_code</var>)</code></a></h4>
<p>
関数 <code>eb_disc_type()</code> は、<var>book</var> のディスクの形式を
<var>disc_code</var> の指す領域に書き込みます。
書き込むディスクの形式の値は、<code>EB_Disc_Code</code> 型
(<a href="#eb_book-data-types">「[CD-ROM 書籍と <code>EB_Book</code> オブジェクト] データ型の詳細」</a> を参照のこと)
のいずれかの定数値です。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>disc_code</var> の指す領域に <code>EB_DISC_INVALID</code>
を書き込み、原因を示すエラーコードを返します。
</p>
<p>
<var>book</var> は、あらかじめ書籍に結び付いていなければなりません。
結びついていない場合は、<code>EB_ERR_UNBOUND_BOOK</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:character_code"><code>EB_Error_Code eb_character_code (EB_Book *<var>book</var>, EB_Character_Code *<var>character_code</var>)</code></a></h4>
<p>
関数 <code>eb_character_code()</code> は、<var>book</var> が書かれている
文字コードを <var>character_code</var> の指す領域に書き込みます。
書き込む文字コードの値は、<code>EB_Character_Code</code> 型
(<a href="#eb_book-data-types">「[CD-ROM 書籍と <code>EB_Book</code> オブジェクト] データ型の詳細」</a> を参照のこと)
のいずれかの定数値です。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>character_code</var> の指す領域に
<code>EB_CHARCODE_INVALID</code> を書き込み、原因を示すエラーコードを
返します。
</p>
<p>
<var>book</var> は、あらかじめ書籍に結び付いていなければなりません。
結びついていない場合は、<code>EB_ERR_UNBOUND_BOOK</code> を返します。
</p>
<!-- ================================================================ -->
<h2><a name="error-handling">エラー処理</a></h2>
<p>
EB ライブラリの関数の呼び出しは、常に成功するとは限りません。
たとえば、<code>EB_Book</code> オブジェクトを書籍に結びつける関数
<code>eb_bind()</code> には、引数として書籍のトップディレクトリを渡しますが、
存在しないディレクトリを指定した場合、処理は失敗に終わります。
</p>
<p>
一般にこうした事象は、ユーザが誤ったパスを指定したときに起こりますが、
メモリ不足のように、ユーザのミスが原因ではない失敗も起こりえます。
</p>
<p>
本章では、関数の呼び出しが失敗した場合の処理について説明します。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="error-code-and-message">エラーコードとエラーメッセージ</a></h3>
<p>
EB ライブラリの関数の多くは、戻り値として <code>EB_Error_Code</code>
型の値を返します。
処理が成功したときに返す値は <code>EB_SUCCESS</code> ですが、失敗したときは
エラーの原因に応じて様々な値を返します。
このため、EB ライブラリでは次のような <code>EB_SUCCESS</code> との比較処理
がよく行われます。
</p>
<blockquote class="program">
<pre>
EB_Error_Code error_code;
error_code = eb_bind(&book, "/mnt/cdrom");
if (error_code != EB_SUCCESS) {
printf("eb_bind() failed\n");
return;
}
</pre>
</blockquote>
<p>
エラーコードの値は、関数 <code>eb_error_message()</code> によって
エラーメッセージに変換することもできます。
こうすることで、エラーの原因をアプリケーションプログラムのユーザに
もう少し分かりやすく伝えることができます。
</p>
<blockquote class="program">
<pre>
error_code = eb_bind(&book, "/mnt/cdrom");
if (error_code != EB_SUCCESS) {
printf("eb_bind() failed, %s\n",
eb_error_message(error_code));
return;
}
</pre>
</blockquote>
<p>
<code>error_code</code> が <code>EB_ERR_TOO_LONG_FILENAME</code> に
セットされていれば、次のようなエラーメッセージが出力されます。
</p>
<blockquote>
<pre>
too long filename
</pre>
</blockquote>
<p>
あるいは、次のように日本語のメッセージかも知れません。
</p>
<blockquote>
<pre>
ファイル名が長すぎます
</pre>
</blockquote>
<p>
メッセージの国際化機能 (NLS) を無効にして EB ライブラリをコンパイル
した場合は、常に英語のメッセージが返ります。
有効にした場合は、ロケールの設定によってどちらの言語のメッセージが
返るかが決まります。
</p>
<p>
本書ではプログラムを簡潔にするために、エラー処理は最低限しか行って
いません。
けれども一般のアプリケーションプログラムでは、関数の呼び出しが成功
したかどうかを常にチェックし、処理が失敗した際はエラーメッセージを出力
して、ユーザにエラーの原因を伝えるのが望ましいといえます。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="tolerance-to-error">エラーに対する寛容さ</a></h3>
<p>
<code>EB_Book</code> オブジェクトは、状態に関するパラメタをいくつか持って
います。
オブジェクトが CD-ROM 書籍に結び付いているかどうかも、こうしたパラメタ
のうちの一つです。
</p>
<p>
引数に <code>EB_Book</code> オブジェクトへのポインタを取る関数には、
あらかじめオブジェクトの特定のパラメタがセットされていることを前提と
しているものもあります。
たとえば、<code>eb_path()</code> は、オブジェクトが書籍に結び付いていること
を前提としています。
では、もしも書籍に結び付いていないオブジェクトを <code>eb_path()</code> に
渡したらどうなるでしょうか。
</p>
<blockquote class="program">
<pre>
EB_Book book;
EB_Error_Code error_code;
char path[EB_MAX_PATH_LENGTH + 1];
eb_initialize_library();
eb_initialize(&book);
error_code = eb_path(&book, path); /* どうなる? */
</pre>
</blockquote>
<p>
この場合、<code>eb_path()</code> は <code>EB_ERR_UNBOUND_BOOK</code> を
返します。
EB ライブラリの関数は、必要なパラメタがセットされていないオブジェクトを
検知して拒絶します。
</p>
<p>
しかしながら、参照マニュアルで明示されている場合を除いて、EB ライブラリ
の関数は、与えられたポインタが <code>NULL</code> かどうかまでは調べません。
次のようなことをすると、プログラムを異常終了させてしまいます。
</p>
<blockquote class="program">
<pre>
eb_bind(NULL, "/mnt/cdrom"); /* 異常終了! */
eb_bind(&book, NULL); /* これも異常終了! */
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="error-data-types">データ型の詳細</a></h3>
<p>
この節で説明しているデータ型を使うには、次のようにヘッダファイルを
読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/error.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Error_Code"><code>EB_Error_Code</code> 型</a></h4>
<p>
データ型 <code>EB_Error_Code</code> は、EB ライブラリのエラーコードを
表します。
この型は符合付き整数型の別名として定義されていますので、2 つのコードを
2 項演算子 <code>==</code> と <code>!=</code> で一致比較することができます。
</p>
<p>
EB ライブラリでは、全部で <code>EB_NUMBER_OF_ERRORS</code> 個の
フックコードを定義しています。
エラーコードの一覧については、
次の節 (<a href="#error-code-list">「エラーコードの一覧」</a> を参照のこと)
を参照して下さい。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="error-code-list">エラーコードの一覧</a></h3>
<p>
この節で説明しているエラーコードを使うには、次のようにヘッダファイルを
読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/error.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SUCCESS">定数 <code>EB_SUCCESS</code></a></h4>
<p>
成功。
エラーは起きていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_MEMORY_EXHAUSTED">定数 <code>EB_ERR_MEMORY_EXHAUSTED</code></a></h4>
<p>
EB ライブラリが <code>malloc()</code> を呼び出したが、<code>NULL</code>
が返ってきた。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_TOO_LONG_FILE_NAME">定数 <code>EB_ERR_TOO_LONG_FILE_NAME</code></a></h4>
<p>
与えられた書籍のパス名が長すぎる。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_BAD_FILE_NAME">定数 <code>EB_ERR_BAD_FILE_NAME</code></a></h4>
<p>
書籍のパス名が不正である。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_BAD_DIR_NAME">定数 <code>EB_ERR_BAD_DIR_NAME</code></a></h4>
<p>
ディレクトリ名が不正である。
(EB ライブラリの内部処理用なので、
このエラーコードがアプリケーションプログラムに返ることはありません。)
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_TOO_LONG_WORD">定数 <code>EB_ERR_TOO_LONG_WORD</code></a></h4>
<p>
与えられた検索語は長すぎる。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_BAD_WORD">定数 <code>EB_ERR_BAD_WORD</code></a></h4>
<p>
与えられた検索語に不正な文字が含まれている。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_EMPTY_WORD">定数 <code>EB_ERR_EMPTY_WORD</code></a></h4>
<p>
与えられた検索語は空である。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_GETCWD">定数 <code>EB_ERR_FAIL_GETCWD</code></a></h4>
<p>
<code>getcwd()</code> もしくは <code>getwd()</code> が失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_OPEN_CAT">定数 <code>EB_ERR_FAIL_OPEN_CAT</code></a></h4>
<p>
EB ライブラリが、書籍のカタログファイルを開くことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_OPEN_CATAPP">定数 <code>EB_ERR_FAIL_OPEN_CATAPP</code></a></h4>
<p>
EB ライブラリが、appendix のカタログファイルを開くことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_OPEN_TEXT">定数 <code>EB_ERR_FAIL_OPEN_TEXT</code></a></h4>
<p>
EB ライブラリが、書籍の本文ファイルを開くことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_OPEN_FONT">定数 <code>EB_ERR_FAIL_OPEN_FONT</code></a></h4>
<p>
EB ライブラリが、書籍の外字ファイルを開くことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_OPEN_APP">定数 <code>EB_ERR_FAIL_OPEN_APP</code></a></h4>
<p>
EB ライブラリが、appendix ファイルを開くことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_OPEN_BINARY">定数 <code>EB_ERR_FAIL_OPEN_BINARY</code></a></h4>
<p>
EB ライブラリが、バイナリデータファイルを開くことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_READ_CAT">定数 <code>EB_ERR_FAIL_READ_CAT</code></a></h4>
<p>
EB ライブラリが、書籍のカタログファイルを読み込むことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_READ_CATAPP">定数 <code>EB_ERR_FAIL_READ_CATAPP</code></a></h4>
<p>
EB ライブラリが、appendix のカタログファイルを読み込むことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_READ_TEXT">定数 <code>EB_ERR_FAIL_READ_TEXT</code></a></h4>
<p>
EB ライブラリが、書籍の本文ファイルを読むことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_READ_FONT">定数 <code>EB_ERR_FAIL_READ_FONT</code></a></h4>
<p>
EB ライブラリが、書籍の外字ファイルを読み込むことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_READ_APP">定数 <code>EB_ERR_FAIL_READ_APP</code></a></h4>
<p>
EB ライブラリが、appendix のメインファイルを読み込むことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_READ_BINARY">定数 <code>EB_ERR_FAIL_READ_BINARY</code></a></h4>
<p>
EB ライブラリが、書籍のバイナリデータファイルを読み込むことに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_SEEK_CAT">定数 <code>EB_ERR_FAIL_SEEK_CAT</code></a></h4>
<p>
EB ライブラリが、書籍のカタログファイルのシークに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_SEEK_CATAPP">定数 <code>EB_ERR_FAIL_SEEK_CATAPP</code></a></h4>
<p>
EB ライブラリが、appendix のカタログファイルのシークに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_SEEK_TEXT">定数 <code>EB_ERR_FAIL_SEEK_TEXT</code></a></h4>
<p>
EB ライブラリが、書籍の本文ファイルのシークに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_SEEK_FONT">定数 <code>EB_ERR_FAIL_SEEK_FONT</code></a></h4>
<p>
EB ライブラリが、書籍の外字ファイルのシークに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_SEEK_APP">定数 <code>EB_ERR_FAIL_SEEK_APP</code></a></h4>
<p>
EB ライブラリが、appendix のメインファイルのシークに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_FAIL_SEEK_BINARY">定数 <code>EB_ERR_FAIL_SEEK_BINARY</code></a></h4>
<p>
EB ライブラリが、書籍のバイナリデータファイルのシークに失敗した。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_UNEXP_CAT">定数 <code>EB_ERR_UNEXP_CAT</code></a></h4>
<p>
EB ライブラリが、書籍のカタログファイル内で、期待とは異なるデータ列を
見つけた。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_UNEXP_CATAPP">定数 <code>EB_ERR_UNEXP_CATAPP</code></a></h4>
<p>
EB ライブラリが、appendix のカタログファイル内で、想定外のデータ列を
見つけた。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_UNEXP_TEXT">定数 <code>EB_ERR_UNEXP_TEXT</code></a></h4>
<p>
EB ライブラリが、書籍の本文ファイル内で、想定外のデータ列を見つけた。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_UNEXP_FONT">定数 <code>EB_ERR_UNEXP_FONT</code></a></h4>
<p>
EB ライブラリが、書籍の外字ファイル内で、想定外のデータ列を見つけた。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_UNEXP_APP">定数 <code>EB_ERR_UNEXP_APP</code></a></h4>
<p>
EB ライブラリが、appendix のメインファイル内で、想定外のデータ列を
見つけた。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_UNEXP_BINARY">定数 <code>EB_ERR_UNEXP_BINARY</code></a></h4>
<p>
EB ライブラリが、書籍のバイナリデータファイル内で、想定外のデータ列を
見つけた。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_UNBOUND_BOOK">定数 <code>EB_ERR_UNBOUND_BOOK</code></a></h4>
<p>
呼び出された EB ライブラリの関数は、書籍に結び付けられた
<code>EB_Book</code> オブジェクトを引数にとるが、与えられたオブジェクトは
書籍に結び付けられていなかった。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_UNBOUND_APP">定数 <code>EB_ERR_UNBOUND_APP</code></a></h4>
<p>
呼び出された EB ライブラリの関数は、appendix に結び付けられた
<code>EB_Appendix</code> オブジェクトを引数にとるが、与えられた
オブジェクトは appendix に結び付けられて
いなかった。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUB">定数 <code>EB_ERR_NO_SUB</code></a></h4>
<p>
書籍は副本を一つも持っていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_APPSUB">定数 <code>EB_ERR_NO_APPSUB</code></a></h4>
<p>
appendix は副本を一つも持っていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_FONT">定数 <code>EB_ERR_NO_FONT</code></a></h4>
<p>
選択中の副本は、外字を一種類も持っていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_TEXT">定数 <code>EB_ERR_NO_TEXT</code></a></h4>
<p>
選択中の副本は、本文データを持っていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_CUR_SUB">定数 <code>EB_ERR_NO_CUR_SUB</code></a></h4>
<p>
呼び出された関数は、副本が選択されている <code>EB_Book</code>
オブジェクトを引数としてとるが、与えられたオブジェクトでは選択されて
いなかった。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_CUR_APPSUB">定数 <code>EB_ERR_NO_CUR_APPSUB</code></a></h4>
<p>
呼び出された関数は、副本が選択されている <code>EB_Appendix</code>
オブジェクトを引数にとるが、与えられたオブジェクトでは選択されて
いなかった。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_CUR_FONT">定数 <code>EB_ERR_NO_CUR_FONT</code></a></h4>
<p>
呼び出された関数は、外字が選択されている <code>EB_Book</code>
オブジェクトを引数にとるが、与えられたオブジェクトでは選択されて
いなかった。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_CUR_BINARY">定数 <code>EB_ERR_NO_CUR_BINARY</code></a></h4>
<p>
呼び出された関数は、バイナリデータの読み込み要求をセットしている
<code>EB_Book</code> オブジェクトを引数にとるが、与えられたオブジェクトでは
セットされていなかった。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUCH_SUB">定数 <code>EB_ERR_NO_SUCH_SUB</code></a></h4>
<p>
<code>EB_Book</code> オブジェクトと副本コードが関数に与えられたが、
<code>EB_Book</code> オブジェクトに結び付けられている書籍は、その
副本コードに一致する副本を持っていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUCH_APPSUB">定数 <code>EB_ERR_NO_SUCH_APPSUB</code></a></h4>
<p>
<code>EB_Appendix</code> オブジェクトと副本コードが関数に与えられたが、
<code>EB_Appendix</code> オブジェクトに結び付けられている appendix は、
その副本コードに一致する副本を持っていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUCH_FONT">定数 <code>EB_ERR_NO_SUCH_FONT</code></a></h4>
<p>
<code>EB_Book</code> オブジェクトと外字の縦のサイズが関数に与えられたが、
<code>EB_Book</code> オブジェクトに結びつけられていた書籍で選択中の副本は、
そのサイズの外字を持っていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUCH_CHAR_BMP">定数 <code>EB_ERR_NO_SUCH_CHAR_BMP</code></a></h4>
<p>
<code>EB_Book</code> オブジェクトと文字番号が関数に与えられたが、
<code>EB_Book</code> オブジェクトに結び付けられていた書籍で選択中の副本は、
その番号の外字のビットマップデータを持っていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUCH_CHAR_TEXT">定数 <code>EB_ERR_NO_SUCH_CHAR_TEXT</code></a></h4>
<p>
<code>EB_Appendix</code> オブジェクトと文字番号が関数に与えられたが、
<code>EB_Appendix</code> オブジェクトに結び付けられている appendix で
選択中の副本は、その番号の外字の代替文字列を持っていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUCH_SEARCH">定数 <code>EB_ERR_NO_SUCH_SEARCH</code></a></h4>
<p>
選択中の副本は、指定された検索メソッドを持っていないので、検索は行えない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUCH_HOOK">定数 <code>EB_ERR_NO_SUCH_HOOK</code></a></h4>
<p>
不正なフックコードが関数に渡された。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUCH_BINARY">定数 <code>EB_ERR_NO_SUCH_BINARY</code></a></h4>
<p>
指定された位置に、指定された形式のバイナリデータは存在しない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_DIFF_CONTENT">定数 <code>EB_ERR_DIFF_CONTENT</code></a></h4>
<p>
アプリケーションプログラムからテキストデータの取得を要求されたが、指定
されたテキストデータの種類が、前回リクエストされたときと一致していない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_PREV_SEARCH">定数 <code>EB_ERR_NO_PREV_SEARCH</code></a></h4>
<p>
<code>eb_hit_list()</code> が呼び出されたが、アプリケーションプログラム
から前もって検索のリクエストがなされていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUCH_MULTI_ID">定数 <code>EB_ERR_NO_SUCH_MULTI_ID</code></a></h4>
<p>
<code>EB_Book</code> オブジェクトと複合検索コードが関数に渡されたが、
結び付けられた書籍で選択中の副本は、そのコードに一致する複合検索を持って
いない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUCH_ENTRY_ID">定数 <code>EB_ERR_NO_SUCH_ENTRY_ID</code></a></h4>
<p>
<code>EB_Book</code> オブジェクトと複合検索エントリコードが関数に
渡されたが、結び付けられた書籍で選択中の副本は、そのエントリコードに
一致する複合検索エントリを持っていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_TOO_MANY_WORDS">定数 <code>EB_ERR_TOO_MANY_WORDS</code></a></h4>
<p>
アプリケーションプログラムから条件検索もしくは複合検索の検索をリクエスト
されたが、検索語の個数が多すぎる。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_WORD">定数 <code>EB_ERR_NO_WORD</code></a></h4>
<p>
アプリケーションプログラムから条件検索もしくは複合検索の検索をリクエスト
されたが、検索語がすべて空である。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_CANDIDATES">定数 <code>EB_ERR_NO_CANDIDATES</code></a></h4>
<p>
<code>eb_multi_entry_candidates()</code> が呼び出されたが、
指定された複合検索エントリは、検索語の候補一覧データを持っていない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_END_OF_CONTENT">定数 <code>EB_ERR_END_OF_CONTENT</code></a></h4>
<p>
<code>eb_forward_text()</code> あるいは <code>eb_backward_text()</code>
で本文の頭出しを行おうとしたが、すでに本文の末尾ないし先頭に達していて、
それ以上先に進むことができなかった。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_PREV_SEEK">定数 <code>EB_ERR_NO_PREV_SEEK</code></a></h4>
<p>
あらかじめ <code>eb_seek_text()</code> でシークを行っていない状態で、
テキストデータの読み込みや頭出しを行おうとした。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_EBNET_UNSUPPORTED">定数 <code>EB_ERR_EBNET_UNSUPPORTED</code></a></h4>
<p>
この EB ライブラリは、遠隔ホストへのアクセスには対応していない。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_EBNET_FAIL_CONNECT">定数 <code>EB_ERR_EBNET_FAIL_CONNECT</code></a></h4>
<p>
遠隔ホストへのアクセスを試みたが、サーバ (EBNETD) に接続できなかった。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_EBNET_SERVER_BUSY">定数 <code>EB_ERR_EBNET_SERVER_BUSY</code></a></h4>
<p>
遠隔ホストへの接続を行ったが、書籍にアクセスしているクライアントの数が
すでに上限に達しているため、その書籍を利用できなかった。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_EBNET_NO_PERMISSION">定数 <code>EB_ERR_EBNET_NO_PERMISSION</code></a></h4>
<p>
遠隔ホストへの接続を行ったが、その書籍への利用権限がないため、サーバ
からアクセスを拒否された。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_UNBOUND_BOOKLIST">定数 <code>EB_ERR_UNBOUND_BOOKLIST</code></a></h4>
<p>
呼び出された EB ライブラリの関数は、遠隔ホストに結び付けられた
<code>EB_BookList</code> オブジェクトを引数にとるが、与えられたオブジェクト
は遠隔ホストに結び付けられていなかった。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:ERR_NO_SUCH_BOOK">定数 <code>EB_ERR_NO_SUCH_BOOK</code></a></h4>
<p>
<code>EB_BookList</code> オブジェクトと書籍の要素番号を関数に渡されたが、
<code>EB_BookList</code> に結び付けられた遠隔ホスト上には、その要素番号に
該当する書籍は存在しない。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="error-functions">関数の詳細</a></h3>
<p>
この節で説明している関数を使うには、次のようにヘッダファイルを読み込んで
下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/error.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:error_string"><code>const char *eb_error_string (EB_Error_Code <var>error_code</var>)</code></a></h4>
<p>
関数 <code>eb_error_string()</code> は、エラーコード <var>error_code</var>
を文字列に変換したものを返します。
文字列の文字コードは、ASCII になります。
たとえば、エラーコード値 <code>EB_SUCCESS</code> を渡すと文字列
<samp>"EB_SUCCESS"</samp> を返します。
未知のエラーコードを渡したときは、<samp>"EB_ERR_UNKNOWN"</samp> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:error_message"><code>const char *eb_error_message (EB_Error_Code <var>error_code</var>)</code></a></h4>
<p>
関数 <code>eb_error_message()</code> は、エラーコード <var>error_code</var>
に対応したメッセージを文字列にして返します。
関数の返すメッセージは、英語か日本語になります。
</p>
<p>
国際化機能を有効にして EB ライブラリをコンパイルしていない場合は、常に
英語のメッセージを返します。
このときのメッセージの文字コードは、ASCII になります。
</p>
<p>
メッセージの国際化機能 (NLS) を有効にして EB ライブラリをコンパイル
した場合は、ロケールの設定に応じてどちらの言語のメッセージを返すのか
が決まります。
また、GNU gettext バージョン 0.36 以降では iconv() と連携することにより、
メッセージの文字コードもロケールに応じて変化します。
gettext が iconv() との連携を行わなければ、英語のメッセージは ASCII、
日本語のメッセージは日本語 EUC になります。
この関数の呼び出しによって、gettext のテキストドメインの設定は変化
しません。
</p>
<p>
未知のエラーコードを渡したときに返すメッセージは、英語では
<samp>"unknown error"</samp>、日本語では <samp>"未知のエラーです"</samp>
になります。
</p>
<!-- ================================================================ -->
<h2><a name="subbook">副本</a></h2>
<p>
紙に印刷された本では別々の書籍になっているものでも、電子ブックや EPWING
では 1 枚の CD-ROM にまとめることができます。
</p>
<p>
たとえば、ある CD-ROM 書籍は、国語辞書、英々辞典、百科事典という 3 つ
の (印刷された本で言うところの) 「書籍」を持っていることもあり得ます。
紛らわしさを避けるために、EB ライブラリではここで言う「書籍」のことを
<dfn>副本 (subbook)</dfn> と呼んでいます。
</p>
<blockquote>
<pre>
ＣＤ−ＲＯＭ書籍
┌─────────────┐
│ 副本０： ［国語辞典］ │
│ 副本１： ［英々辞典］ │
│ 副本２： ［百科事典］ │
└─────────────┘
</pre>
</blockquote>
<p>
CD-ROM 書籍では、それぞれの副本はそれ自体が独立した書籍になっています。
また、副本のデータも、副本毎に別々のファイルに収められています。
したがって、EB ライブラリでも、アプリケーションプログラムの主要な処理
である単語の検索や本文データの取得などは、すべて副本単位で行うように
なっています。
</p>
<p>
本章では、EB ライブラリでの副本の扱い方について説明します。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="subbook-code">副本コード</a></h3>
<p>
EB ライブラリでは、それぞれの副本に対して <dfn>副本コード (subbook code)</dfn>
を割り当てます。
このコードは EB ライブラリが副本を識別するために用いますので、個々の
副本コードは、書籍内で同じものがないようになっています。
</p>
<p>
以下のソースコードは、<code>eb_subbook_list()</code> という関数の
使用例です。
この関数は、書籍内のすべての副本の副本コードを取得することができます。
</p>
<blockquote class="program">
<pre>
/* <code>book</code> が <code>EB_Book</code> のオブジェクトで、すでに
* 書籍に結び付けられていると仮定しています。*/
EB_Subbook_Code sub_codes[EB_MAX_SUBBOOKS];
int sub_count;
if (eb_subbook_list(&book, sub_codes, &sub_count)
!= EB_SUCCESS) {
printf("eb_subbook_list() failed\n");
return;
}
</pre>
</blockquote>
<p>
<code>eb_subbook_list()</code> が成功すると、書籍内のすべての副本コードが
配列 <code>sub_codes[]</code> に格納されます。
配列の先頭の副本コードは <code>sub_codes[0]</code> と表され、次の
コードは <code>sub_codes[1]</code>、という具合になります。
副本の個数は、<code>sub_count</code> に格納されます。
</p>
<p>
個々の副本には、必ず題名が付けられています。
先頭の副本 (<code>sub_codes[0]</code>) の題名は、次のようにして
得ることができます。
</p>
<blockquote class="program">
<pre>
char title[EB_MAX_TITLE_LENGTH + 1];
if (eb_subbook_title2(&book, sub_codes[0], title)
!= EB_SUCCESS) {
printf("eb_subbook_title2() failed\n");
return;
}
</pre>
</blockquote>
<p>
<code>eb_subbook_title2()</code> の呼び出しが成功すると、
<code>title</code> に題名を表す文字列が格納されます。
</p>
<p>
蛇足ですが、(副本ではなく) CD-ROM の題名を取得する関数はありません。
なぜなら、題名を示すデータが CD-ROM の中には何処にもないからです。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="current-subbook">選択中の副本</a></h3>
<p>
<code>EB_Book</code> オブジェクトは、結びつけられた CD-ROM 書籍の中の
任意の副本から一つ選んで、<dfn>選択中の副本 (current subbook)</dfn>
として指定することができます。
複数の副本を、同時に選択することはできません。
単語の検索や、本文データの取得など、ほとんどの操作は、選択中の副本に
対してだけ行えます。
</p>
<p>
<code>eb_bind()</code> で <code>EB_Book</code> オブジェクトを書籍に
結び付けた直後は、いずれの副本も選択されていない状態になっています。
</p>
<blockquote>
<pre>
ＥＢ＿Ｂｏｏｋ ＣＤ−ＲＯＭ書籍
オブジェクト
┌────┐ ┌─────────────┐
│選択中 │ │ 副本０： ［国語辞典］ │
│の副本 │ │ 副本１： ［英々辞典］ │
│＜なし＞│ │ 副本２： ［百科事典］ │
└────┘ └─────────────┘
</pre>
</blockquote>
<p>
副本の選択を行うには、関数 <code>eb_set_subbook()</code> を使用します。
<code>eb_set_subbook()</code> は、引数として渡された副本コードに
したがって副本を選択します。
以下は、先頭の副本 (<code>sub_codes[0]</code>) を選択する場合の例です。
</p>
<blockquote class="program">
<pre>
/* <code>book</code> が <code>EB_Book</code> のオブジェクトで、すでに
* 書籍に結び付けられていると仮定しています。*/
EB_Subbook_Code sub_codes[EB_MAX_SUBBOOKS];
int sub_count;
if (eb_subbook_list(&book, sub_codes, &sub_count)
!= EB_SUCCESS) {
printf("eb_subbook_list() failed\n");
return;
}
if (eb_set_subbook(&book, sub_codes[0]) != EB_SUCCESS) {
printf("eb_subbook_list() failed\n");
return;
}
</pre>
</blockquote>
<p>
成功すると、次のように副本が選択された状態になります。
</p>
<blockquote>
<pre>
ＥＢ＿Ｂｏｏｋ ＣＤ−ＲＯＭ書籍
オブジェクト
┌────┐ ┌─────────────┐
│選択中 │ ┏━━━━┿━副本０： ［国語辞典］ │
│の副本 │ ┃ │ 副本１： ［英々辞典］ │
│ ＊━━┿━━┛ │ 副本２： ［百科事典］ │
└────┘ └─────────────┘
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="subbook-sample">サンプルプログラム</a></h3>
<blockquote>
<pre>
/* -*- C -*-
* Copyright (c) 1999-2006 Motoyuki Kasahara
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the project nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* 使用方法:
* subbook <book-path>
* 例:
* subbook /cdrom
* 説明:
* <boook-path> で指定され CD-ROM 書籍に含まれているすべての副本の
* 題名を表示します。
*/
#include <stdio.h>
#include <stdlib.h>
#include <eb/eb.h>
#include <eb/error.h>
int
main(int argc, char *argv[])
{
EB_Error_Code error_code;
EB_Book book;
EB_Subbook_Code subbook_list[EB_MAX_SUBBOOKS];
int subbook_count;
char title[EB_MAX_TITLE_LENGTH + 1];
int i;
/* コマンド行引数をチェック。*/
if (argc != 2) {
fprintf(stderr, "Usage: %s book-path\n", argv[0]);
exit(1);
}
/* EB ライブラリと `book' を初期化。*/
error_code = eb_initialize_library();
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to initialize EB Library, %s: %s\n",
argv[0], eb_error_message(error_code), argv[1]);
goto die;
}
eb_initialize_book(&book);
/* 書籍を `book' に結び付ける。*/
error_code = eb_bind(&book, argv[1]);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to bind the book, %s: %s\n",
argv[0], eb_error_message(error_code), argv[1]);
goto die;
}
/* 副本の一覧を取得。*/
error_code = eb_subbook_list(&book, subbook_list, &subbook_count);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get the subbbook list, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* 書籍に含まれている副本の題名を出力。*/
for (i = 0; i < subbook_count; i++) {
error_code = eb_subbook_title2(&book, subbook_list[i], title);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get the title, %s\n",
argv[0], eb_error_message(error_code));
continue;
}
printf("%d: %s\n", i, title);
}
/* 書籍と EB ライブラリの利用を終了。*/
eb_finalize_book(&book);
eb_finalize_library();
exit(0);
/* エラー発生で終了するときの処理。*/
die:
eb_finalize_book(&book);
eb_finalize_library();
exit(1);
}
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="subbook-data-types">データ型の詳細</a></h3>
<p>
この節で説明しているデータ型を使うには、次のようにヘッダファイルを
読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/eb.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Subbook_Code"><code>EB_Subbook_Code</code> 型</a></h4>
<p>
データ型 <code>EB_Subbook_Code</code> は副本コードを表します。
一冊の書籍の中の副本は、それぞれ一意の副本コードを持っています。
この型は符合付き整数型の別名として定義されていますので、2 つのコードを
2 項演算子 <code>==</code> と <code>!=</code> で一致比較することが
できます。
</p>
<p>
また、不正な副本コード値を表す <code>EB_SUBBOOK_INVALID</code> という
特別な副本コードが定義されています。
利用可能な副本に対して、この副本コードが割り当てられることはありません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="subbook-functions">関数の詳細</a></h3>
<p>
この節で説明している関数を使うには、次のようにヘッダファイルを読み込んで
下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/eb.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:load_all_subbooks"><code>EB_Error_Code eb_load_all_subbooks (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_load_all_subbooks()</code> は、<var>book</var> 内のすべての
副本を初期化します。
通常、副本の初期化は、その副本が初めて選択されたときに自動的に行われますが、
この関数は初期化を前倒しで行います。
初期化の対象となるのは、この関数を呼び出した時点でまだ初期化していない
すべての副本です。
この関数は、スタンドアロンで動作するサーバアプリケーションなどで有効です。
クライアントからの接続を受ける前にこの関数を呼ぶことで、副本の初期化の
ためにクライアントを待たせなくて済みます。
</p>
<p>
初期化の対象となったすべての副本の初期化に成功すれば、関数は
<code>EB_SUCCESS</code> を返します。
一冊でも初期化に失敗した場合は、残りの副本の初期化を諦め、原因を示す
エラーコードを返します。
</p>
<p>
<var>book</var> は、あらかじめ書籍に結び付けられていなくてはなりません。
結びついていない場合は、<code>EB_ERR_UNBOUND_BOOK</code> を返します。
</p>
<p>
この関数を呼び出すと、<var>book</var> は、副本を選択していない状態になります。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:subbook_list"><code>EB_Error_Code eb_subbook_list (EB_Book *<var>book</var>, EB_Subbook_Code *<var>subbook_list</var>, int *<var>subbook_count</var>)</code></a></h4>
<p>
関数 <code>eb_subbook_list()</code> は、<var>book</var> 内のすべて副本の
副本コードを <code>EB_Subbook_Code</code> 型の配列にして、
<var>subbook_list</var> の指す領域に書き込みます。
配列は、最大で <code>EB_MAX_SUBBOOKS</code> 個の要素を持ちます。
加えて、書籍が収録している副本の個数を <var>subbook_count</var> の指す
領域に書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>subbook_count</var> の指す領域に 0 を書き込み、原因を
示すエラーコードを返します。
</p>
<p>
<var>book</var> は、あらかじめ書籍に結び付けられていなくてはなりません。
結びついていない場合は、<code>EB_ERR_UNBOUND_BOOK</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:subbook"><code>EB_Error_Code eb_subbook (EB_Book *<var>book</var>, EB_Subbook_Code *<var>subbook_code</var>)</code></a></h4>
<p>
関数 <code>eb_subbook()</code> は、<var>book</var> が選択中の副本の
副本コードを <var>subbook_code</var> の指す領域に書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>subbook_code</var> の指す領域に
<code>EB_SUBBOOK_INVALID</code> を書き込み、原因を示すエラーコードを
返します。
</p>
<p>
あらかじめ、<var>book</var> はいずれかの副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:subbook_title"><code>EB_Error_Code eb_subbook_title (EB_Book *<var>book</var>, char *<var>title</var>)</code></a></h4>
<p>
関数 <code>eb_subbook_title()</code> は、<var>book</var> が選択中の副本の
題名を <var>title</var> の指す領域に文字列として書き込みます。
題名の文字列の長さは、最長で <code>EB_MAX_TITLE_LENGTH</code> バイトです。
この長さは、末尾のナル文字を含みません。
</p>
<p>
書籍の文字コード
(<a href="#eb_book-data-types">「[CD-ROM 書籍と <code>EB_Book</code> オブジェクト] データ型の詳細」</a> を参照のこと)
が <code>EB_CHARCODE_ISO8859_1</code> なら、題名を表す文字列は ISO 8859-1
になり、それ以外の文字コードなら日本語 EUC になります。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>title</var> の指す領域に空文字列を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> 内のいずれかの副本が選択されていなくては
なりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:subbook_title2"><code>EB_Error_Code eb_subbook_title2 (EB_Book *<var>book</var>, EB_Subbook_Code <var>subbook_code</var>, char *<var>title</var>)</code></a></h4>
<p>
<code>eb_subbook_title()</code> と似ていますが、選択中の副本ではなく、
引数 <var>subbook_code</var> で指定された副本の題名を書き込む点が
異なります。
</p>
<p>
<var>book</var> は副本を選択していなくても構いませんが、あらかじめ書籍
に結び付けられていなければなりません。
結びついていない場合は、<code>EB_ERR_UNBOUND_BOOK</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:subbook_directory"><code>EB_Error_Code eb_subbook_directory (EB_Book *<var>book</var>, char *<var>directory</var>)</code></a></h4>
<p>
関数 <code>eb_subbook_directory()</code> は、<var>book</var> 内で現在
選択中の副本のデータファイルを収めたディレクトリ名を、<var>directory</var>
の指す領域に書き込みます。
</p>
<p>
ディレクトリ名の文字列の長さは、最長で
<code>EB_MAX_DIRECTORY_NAME_LENGTH</code> バイトです。
この長さに、末尾のナル文字は含みません。
ディレクトリ名は ASCII の数字、英小文字、アンダースコアで構成されます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>directory</var> の指す領域に空文字列を書き込み、原因に
を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> 内のいずれかの副本が選択されていなくては
なりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:subbook_directory2"><code>EB_Error_Code eb_subbook_directory2 (EB_Book *<var>book</var>, EB_Subbook_Code <var>subbook_code</var>, char *<var>directory</var>)</code></a></h4>
<p>
<code>eb_subbook_directory()</code> と似ていますが、選択中の副本ではなく、
引数 <var>subbook_code</var> で指定された副本のディレクトリ名を書き込む点
が異なります。
</p>
<p>
<var>book</var> は副本を選択していなくても構いませんが、あらかじめ
書籍に結び付けられていなければなりません。
結びついていない場合は、<code>EB_ERR_UNBOUND_BOOK</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:set_subbook"><code>EB_Error_Code eb_set_subbook (EB_Book *<var>book</var>, EB_Subbook_Code <var>code</var>)</code></a></h4>
<p>
関数 <code>eb_set_subbook()</code> は、<var>book</var> の副本
<var>code</var> を選択します。
すでに副本を選択していた場合は、いったん未選択の状態にしてから副本
<var>subbook_code</var> を選択します。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
このとき、外字は未選択の状態となり、検索、テキストデータの読み込み、
バイナリデータの読み込みについての状態記録は、すべてリセットされます。
失敗すると、副本を未選択の状態にして、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> は書籍に結び付けられていなければなりません。
結びついていない場合は、<code>EB_ERR_UNBOUND_BOOK</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:unset_subbook"><code>void eb_unset_subbook (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_unset_subbook()</code> は、<var>book</var> が選択している
副本を未選択の状態にします。
<var>book</var> が書籍に結び付いていないか、副本が選択されていない場合は、
何もしません。
</p>
<!-- ================================================================ -->
<h2><a name="search">検索</a></h2>
<p>
CD-ROM 書籍において、検索は非常に重要な機能です。
EB ライブラリでは、次のような検索メソッドが利用できます。
</p>
<ul>
<li>前方一致検索 (word search)
<li>後方一致検索 (end-word search)
<li>完全一致検索 (exact-word search)
<li>条件検索 (keyword search)
<li>クロス検索 (cross search)
<li>複合検索 (multi search)
</ul>
<p>
ただし、すべての CD-ROM 書籍、すべての副本で、ここに挙げたすべての
検索メソッドが利用可能なわけではありません。
副本の中には、いずれの検索メソッドも提供しないものも存在します。
</p>
<p>
EB ライブラリでは、検索を行うことができるのは、選択中の副本に対して
だけです。
</p>
<p>
この章では、それぞれの検索メソッドの簡単な説明と、EB ライブラリでの
扱い方について説明します。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="word-search">前方一致、後方一致、完全一致検索</a></h3>
<p>
前方一致、後方一致、完全一致検索は、いずれも一個の入力語に一致する
エントリを探し出す検索メソッドです。
</p>
<p>
前方一致検索は、入力語と先頭部分が一致するエントリを検索します。
たとえば、「江戸」という語は、「江戸」「江戸時代」「江戸っ子」といった
エントリに一致します。
</p>
<p>
後方一致検索は、入力語と末尾が一致するエントリを検索します。
たとえば、`bye' という語は、`bye'、`good bye'、`bye bye' といった
エントリに一致します。
</p>
<p>
完全一致検索は、一個の検索語と完全に一致するエントリだけを検索します。
</p>
<p>
以下は、前方一致検索のプログラムの例です。
選択中の副本の中から、先頭が <samp>librar</samp> で始まるエントリを探して
います。
</p>
<blockquote class="program">
<pre>
/* <code>book</code> が <code>EB_Book</code> のオブジェクトで、すでに
* 書籍に結び付けられ、副本を選択中だと仮定しています。*/
#define MAX_HITS 50
EB_Hit hits[MAX_HITS];
int hit_count;
if (eb_search_word(&book, "librar") != EB_SUCCESS) {
printf("eb_search_word() failed\n");
return;
}
if (eb_hit_list(&book, MAX_HITS, hits, &hit_count)
!= EB_SUCCESS) {
printf("eb_hit_list() failed\n");
return;
}
</pre>
</blockquote>
<p>
<code>eb_search_word()</code> は前方一致検索をリクエストする関数です。
この例では、<samp>librar</samp> という検索文字列を与えています。
ただし、この関数は一致したエントリを返すことはしません。
</p>
<p>
一致したエントリの取得は、続く <code>eb_hit_list()</code> 関数を
呼び出した際に行われます。
<code>eb_hit_list()</code> は一致したエントリの一覧を配列
<code>hits[]</code> の指す領域に書き込み、見つかった一致エントリの個数
を <code>&hit_count</code> の指す領域に書き込みます。
この例では、<code>eb_hit_list()</code> は最大で <code>MAX_HITS</code>
(= 50) 個 のエントリを探します。
(つまり、50 個見つかったら検索を止めます。)
</p>
<p>
もし、選択中の副本が英々辞典だとすると、少なくとも <samp>library</samp>
と <samp>librarian</samp> という 2 つのエントリに関する情報が得られる
でしょう。
このとき、配列 <code>hits[]</code> は次のようになっています。
(ただし、<samp>library</samp> と <samp>librarian</samp> エントリの
順序は、下の絵とは異なっているかも知れません。)
</p>
<blockquote>
<pre>
┌───────────┬───────────┬─
│ ｌｉｂｒａｒｉａｎ │ ｌｉｂｒａｒｙ │
└───────────┴───────────┴─
ｈｉｔｓ［０］ ｈｉｔｓ［１］
</pre>
</blockquote>
<p>
<code>hits[]</code> の中身については、本章の後ろの節でもう少し詳しく
説明します。
</p>
<p>
ここまでは前方一致検索を例にとりましたが、後方一致の場合は
<code>eb_search_word()</code> の代わりに <code>eb_search_endword()</code>
を呼ぶようにします。
他はすべて同じです。
</p>
<blockquote class="program">
<pre>
if (eb_search_endword(&book, "nalization") != EB_SUCCESS) {
printf("eb_search_endword() failed\n");
return;
}
</pre>
</blockquote>
<p>
完全一致の場合も同様です。
<code>eb_search_exactword()</code> を呼ぶようにする以外は、すべて同じ
です。
</p>
<blockquote class="program">
<pre>
if (eb_search_exactword(&book, "library") != EB_SUCCESS) {
printf("eb_search_exactword() failed\n");
return;
}
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="keyword-search">条件検索</a></h3>
<p>
条件検索は、複数個の入力語にすべて一致するエントリを検索します。
たとえば、英々辞典の条件検索では、入力語をすべて含んだ例文を検索する
ようになっているかも知れません。
</p>
<p>
以下は、条件検索で <samp>make</samp>, <samp>with</samp> という語の双方と
一致するエントリを、選択中の副本の中から探し出すプログラムの断片です。
</p>
<blockquote class="program">
<pre>
/* <code>book</code> が <code>EB_Book</code> のオブジェクトで、すでに
* 書籍に結び付けられ、副本を選択中だと仮定しています。*/
static const char *keywords[3] = {"make", "with", NULL};
if (eb_search_word(&book, keywords) != EB_SUCCESS) {
printf("eb_search_word() failed\n");
return;
}
</pre>
</blockquote>
<p>
条件検索を行う関数は、<code>eb_search_keyword()</code> です。
前方一致、後方一致、完全一致検索の関数と基本的に扱い方は一緒ですが、
複数の入力語を受け付けるようになっています。
関数には、入力語の文字列 (へのポインタ) を配列にしたものを渡します。
配列の最後には <code>NULL</code> を置き、配列の終端を明示する必要が
ある点に注意して下さい。
</p>
<p>
前方一致、後方一致、完全一致検索と同様に、<code>eb_search_keyword()</code>
も検索のリクエストを行うだけで、一致したエントリの取得は行いません。
エントリの取得には、やはり同様に <code>eb_hit_list()</code> 関数を
使います。
</p>
<blockquote class="program">
<pre>
EB_Hit hits[MAX_HITS];
int hit_count;
if (eb_hit_list(&book, MAX_HITS, hits, &hit_count)
!= EB_SUCCESS) {
printf("eb_hit_list() failed\n");
return;
}
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="cross-search">クロス検索</a></h3>
<p>
クロス検索は、条件検索の亜種とも言うべき検索メソッドです。
EPWING や電子ブックをみても、どういうルールで使い分けがなされているのか
分からない程、両者は実によく似ています。
</p>
<p>
EB ライブラリでクロス検索を行う関数は <code>eb_search_cross()</code>
ですが、使い方は条件検索の関数 <code>eb_search_keyword()</code> と
まったく同じです。
使い方の詳細は、<a href="#keyword-search">「条件検索」</a> をご覧下さい。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="multi-search">複合検索</a></h3>
<p>
複合検索は、条件検索と同じく、複数個の入力語にすべて一致するエントリを
検索しますが、個々の入力語にあらかじめ題目が付けられています。
</p>
<p>
また、前方一致、後方一致、完全一致、条件検索はすべて、各副本につき
一種類しかありませんが、複合検索だけは一つの副本の中で複数の種類が用意
されていることがあります。
たとえば、ある世界人名事典には、次のように人名検索用と頻出用語の検索用
の 2 種類の複合検索が用意されているかも知れません。
</p>
<blockquote>
<pre>
(複合検索その 1: 人名を検索する)
入力語 0: 国・地域
入力語 1: 時代
入力語 2: 性別
入力語 3: キーワード
入力語 4: キーワード
</pre>
</blockquote>
<blockquote>
<pre>
(複合検索その 2: 頻出用語を検索する)
入力語 0: 用語
入力語 1: キーワード
入力語 2: キーワード
</pre>
</blockquote>
<p>
この例のように、個々の複合検索は、入力語の題目だけでなく、入力語の数も
まちまちです。
また、検索する際はすべての入力語を埋める必要はなく、少なくとも一個の
入力語が空でなければ、検索は成功します。
</p>
<p>
副本内の複合検索は、種類毎に <dfn>複合検索コード (multi search code)</dfn>
によって識別されます。
関数 <code>eb_multi_search_list()</code> を使うと、選択中の副本で利用可能
な複合検索の一覧が得られます。
</p>
<blockquote class="program">
<pre>
/* <code>book</code> が <code>EB_Book</code> のオブジェクトで、すでに
* 書籍に結び付けられ、副本を選択中だと仮定しています。*/
EB_Multi_Search_Code multi_codes[EB_MAX_MULTI_SEARCHES];
int multi_count;
if (eb_multi_search_list(&book, multi_codes, &multi_count)
!= EB_SUCCESS) {
printf("eb_multi_search_list() failed\n");
return;
}
</pre>
</blockquote>
<p>
この複合検索コードは、複合検索のための関数で必要となります。
たとえば、<code>eb_multi_title()</code> は、指定した複合検索の題名
(例:「人名検索」「頻出用語検索」) を取得する関数ですが、このときの
複合検索の指定には、複合検索コードを用います。
以下の例では、一覧の先頭に載っている複合検索 (<code>multi_codes[0]</code>)
を指定しています。
</p>
<blockquote class="program">
<pre>
char title[EB_MAX_MULTI_TITLE_LENGTH + 1];
if (eb_multi_title(&book, multi_codes[0], title)
!= EB_SUCCESS) {
printf("eb_multi_title() failed\n");
return;
}
</pre>
</blockquote>
<p>
さらに関数によっては、複合検索コードに加えて、何番目の入力語かも指定
してやる必要があります。
たとえば、特定の入力語の題目を得る関数 <code>eb_multi_entry_label()</code>
が、これに該当します。
0 番目の入力語 (つまり先頭の入力語) の題目を取得するには、次のように
します。
</p>
<blockquote class="program">
<pre>
char label[EB_MAX_MULTI_LABEL_LENGTH + 1];
if (eb_multi_entry_label(&book, multi_code[0], 0, label)
!= EB_SUCCESS) {
printf("eb_multi_entry_label() failed\n");
return;
}
</pre>
</blockquote>
<p>
複合検索を行う関数は、<code>eb_search_multi()</code> です。
使い方は条件検索とほぼ同じで、入力語の文字列を配列にしたものを引数
として渡し、配列の最後には <code>NULL</code> を置いて下さい。
埋められていない入力語のところには、空文字列を置きます。
</p>
<p>
<code>eb_search_multi()</code> も検索のリクエストを行うだけで、一致した
エントリの取得は行いません。
取得するには <code>eb_hit_list()</code> を使います。
</p>
<blockquote class="program">
<pre>
EB_Hit hits[MAX_HITS];
int hit_count;
if (eb_hit_list(&book, MAX_HITS, hits, &hit_count)
!= EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
</pre>
</blockquote>
<p>
なお、複合検索の入力語によっては
<dfn>候補一覧 (candidates)</dfn> があらじめ用意されていることがあります。
これは、入力語として有効な語をあらかじめ列挙しておき、
アプリケーションプログラムのユーザに選択させる仕組みです。
候補一覧については、この章ではなく「テキストデータ」の章で説明します
(<a href="#multi-candidates">「複合検索の候補一覧」</a> を参照のこと)。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="eb_hit">一致エントリの情報</a></h3>
<p>
<code>eb_hit_list()</code> は、リクエストされた検索 (前方一致、後方一致、
完全一致、条件、複合) に一致したエントリの情報と見つかったエントリの
個数を、それぞれ <code>EB_Hit</code> 型の配列領域および <code>int</code> 型の
領域に書き込みます。
</p>
<blockquote class="program">
<pre>
/* <code>book</code> が <code>EB_Book</code> のオブジェクトで、すでに書籍に結び付け
* られ、副本を選択中だと仮定しています。*/
EB_Hit hits[MAX_HITS];
int hit_count;
if (eb_hit_list(&book, MAX_HITS, hits, &hit_count)
!= EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
</pre>
</blockquote>
<p>
<code>EB_Hit</code> 配列の個々の要素には、一致したエントリの
<dfn>見出し (heading)</dfn> と <dfn>本文 (text)</dfn> の開始位置が
書き込まれています。
</p>
<blockquote>
<pre>
見出し
┌────────────┐
ＥＢ＿Ｈｉｔ ┏━┿ｌｉｂｒａｒｉａｎ ｎ．│
┌───────┐ ┃ └────────────┘
│ｈｅａｄｉｎｇ┿━┛ 本文
│ │ ┌────────────────────┐
│ ｔｅｘｔ┿━━━┿ｌｉｂｒａｒｉａｎ │
└───────┘ │ｎ．（１）Ａ ｐｅｒｓｏｎ ｗｈｏ ｉｓ│
│ａ ｓｐｅｃｉａｌｉｓｔ ｉｎ │
│ｌｉｂｒａｒｙ ｗｏｒｋ．（２）．．． │
└────────────────────┘
</pre>
</blockquote>
<p>
見出しと本文についてのより詳しい解説と取得方法については、
<a href="#text-data">「テキストデータ」</a> を参照のこと。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="get-remained-entries">残っているエントリの取得</a></h3>
<p>
前に述べたように、<code>eb_hit_list()</code> を呼び出すときは、一致する
エントリを最大で何個まで探すのかを引数で指定します。
また、<code>eb_hit_list()</code> は処理が成功すると、実際に見つかった
エントリの数をアプリケーションプログラムに教えます。
</p>
<blockquote class="program">
<pre>
error_code = eb_hit_list(&book, MAX_HITS, hits, &hit_count);
if (error_code == EB_SUCCESS)
printf("%d entries found\n", hit_count);
</pre>
</blockquote>
<p>
指定した最大個数よりも多くの一致エントリが副本に存在している場合は、
<code>eb_hit_list()</code> を繰り返し呼び出すことで、残りのエントリを
取得することができます。
</p>
<blockquote class="program">
<pre>
for (;;) {
if (eb_hit_list(&book, MAX_HITS, hits, &hit_count)
!= EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
if (hit_count == 0)
break;
/* 取得した一致エントリの処理 */
}
</pre>
</blockquote>
<p>
一致エントリがもう残っていなければ、<code>eb_hit_list()</code> は
<code>&hit_count</code> の指す領域に 0 を書き込んで、
<code>EB_SUCCESS</code> を返します。
</p>
<p>
ただし、途中で <code>eb_hit_list()</code> が失敗すると
(<code>EB_SUCCESS</code> 以外の値を返すと)、検索リクエストに関する
状態記録はリセットされるため、一致エントリの取得をそれ以上続けることは
できません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="unify-duplicated-entries">重複エントリの削除</a></h3>
<p>
<code>eb_hit_list()</code> を用いて一致したエントリを取得すると、中身が
実質的に変わらないエントリが複数含まれていることがあります。
EB ライブラリは、こうした重複エントリの削除は行いません。
必要なら、アプリケーション側で行うことになります。
</p>
<p>
重複を完璧に取り除くなら、以下のすべての条件に一致するエントリを
重複エントリとみなし、二度目以降に出現したエントリを削除します。
</p>
<ul>
<li>エントリの指す本文の位置が同じ
<li>エントリの指す見出しの文字列 (位置ではなく文字列そのもの) が同じ
</ul>
<p>
(見出し文字列の取得方法については、
<a href="#text-data">「テキストデータ」</a> を参照のこと。)
</p>
<p>
重複は、直前のエントリに対してのみ起こるとは限りません。
たとえば、<code>eb_hit_list()</code> で一致エントリが 50 個得られた場合、
最後の 50 個目は前方の 49 個と重複検査を行う必要があります。
したがって、全体ではエントリ同士の比較を 1 + 2 + ... + 49 = 1225 回
行うことになります。
</p>
<p>
書籍によっては重複エントリが取りきれない可能性もありますが、もう少し
簡単な方法もいくつかあります。
処理を簡単にする第一の方法は、重複エントリの判定条件を次のように変える
ことです。
</p>
<ul>
<li>エントリの指す本文の位置が同じ
<li>エントリの指す見出しの文字列の位置が同じ
</ul>
<p>
さらに処理を簡単にするには、直前の 1個のエントリに対してだけ重複検査を
行うという方法もあります。
これなら、50 個の一致エントリに対して、比較は 49 回で済みます。
ただしこの方法は、書籍によってはまったく効果がありません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="search-sample">サンプルプログラム</a></h3>
<blockquote>
<pre>
/* -*- C -*-
* Copyright (c) 1999-2006 Motoyuki Kasahara
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the project nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* 使用方法:
* word <book-path> <subbook-index> <word>
* 例:
* word /cdrom 0 apple
* 説明:
* <book-path> で指定した CD-ROM 書籍の特定の副本の中から <word>
* という単語を完全一致検索で探し、ヒットしたすべてのエントリの
* 見出しを表示します。
*
* <subbook-index> には、検索対象の副本のインデックスを指定しま
* す。インデックスは、書籍の最初の副本から順に 0、1、2 ... に
* なります。
*/
#include <stdio.h>
#include <stdlib.h>
#include <eb/eb.h>
#include <eb/error.h>
#include <eb/text.h>
#define MAX_HITS 50
#define MAXLEN_HEADING 127
int
main(int argc, char *argv[])
{
EB_Error_Code error_code;
EB_Book book;
EB_Subbook_Code subbook_list[EB_MAX_SUBBOOKS];
EB_Hit hits[MAX_HITS];
char heading[MAXLEN_HEADING + 1];
int subbook_count;
int subbook_index;
int hit_count;
ssize_t heading_length;
int i;
/* コマンド行引数をチェック。*/
if (argc != 4) {
fprintf(stderr, "Usage: %s book-path subbook-index word\n",
argv[0]);
exit(1);
}
/* EB ライブラリと `book' を初期化。*/
eb_initialize_library();
eb_initialize_book(&book);
/* 書籍を `book' に結び付ける。*/
error_code = eb_bind(&book, argv[1]);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to bind the book, %s: %s\n",
argv[0], eb_error_message(error_code), argv[1]);
goto die;
}
/* 副本の一覧を取得。*/
error_code = eb_subbook_list(&book, subbook_list, &subbook_count);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get the subbbook list, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* 副本のインデックスを取得。*/
subbook_index = atoi(argv[2]);
/*「現在の副本 (current subbook)」を設定。*/
error_code = eb_set_subbook(&book, subbook_list[subbook_index]);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to set the current subbook, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* 単語検索のリクエストを送出。*/
error_code = eb_search_exactword(&book, argv[3]);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to search for the word, %s: %s\n",
argv[0], eb_error_message(error_code), argv[3]);
goto die;
}
for (;;) {
/* 残っているヒットエントリを取得。*/
error_code = eb_hit_list(&book, MAX_HITS, hits, &hit_count);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get hit entries, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
if (hit_count == 0)
break;
for (i = 0; i < hit_count; i++) {
/* 見出しの位置へ移動。*/
error_code = eb_seek_text(&book, &(hits[i].heading));
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to seek the subbook, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* 見出しを取得して表示。*/
error_code = eb_read_heading(&book, NULL, NULL, NULL,
MAXLEN_HEADING, heading, &heading_length);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to read the subbook, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
printf("%s\n", heading);
}
}
/* 書籍と EB ライブラリの利用を終了。*/
eb_finalize_book(&book);
eb_finalize_library();
exit(0);
/* エラー発生で終了するときの処理。*/
die:
eb_finalize_book(&book);
eb_finalize_library();
exit(1);
}
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="search-data-types">データ型の詳細</a></h3>
<p>
この節で説明しているデータ型を使うには、次のようにヘッダファイルを
読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/eb.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Hit"><code>EB_Hit</code> 型</a></h4>
<p>
<code>EB_Hit</code> は、検索に一致したエントリの情報を格納するための
データ型です。
内部構造は、次のように定義されています。
</p>
<blockquote class="program">
<pre>
typedef struct EB_Hit_Struct EB_Hit;
struct EB_Hit_Struct {
EB_Position heading; /* 見出しの位置 */
EB_Position text; /* 本文の位置 */
};
</pre>
</blockquote>
<p>
アプリケーションプログラムは、直接 <code>EB_Hit</code> オブジェクトの
メンバを参照したり、セットしたりしても構いません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Position"><code>EB_Position</code> 型</a></h4>
<p>
データ型 <code>EB_Position</code> は、副本のデータの位置を表します。
内部構造は、次のように定義されています。
</p>
<blockquote class="program">
<pre>
typedef struct EB_Position_Struct EB_Position;
struct EB_Position_Struct {
int page; /* ページ番号 */
int offset; /* ページ内のオフセット */
};
</pre>
</blockquote>
<p>
ページ番号は 1 から始まり、ページ内のオフセットは 0 〜 2047 の範囲と
なります。
ただし、アプリケーションプログラムを作成する上で、このことを覚えておく
必要はありません。
</p>
<p>
アプリケーションプログラムは、直接 <code>EB_Position</code> オブジェクト
のメンバを参照したり、セットしたりしても構いません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Multi_Search_Code"><code>EB_Multi_Search_Code</code> 型</a></h4>
<p>
データ型 <code>EB_Multi_Search_Code</code> は複合検索コードを表します。
副本に用意されている複合検索は、それぞれ一意の複合検索コードを
持っています。
この型は符合付き整数型の別名として定義されていますので、2 つのコードを
2 項演算子 <code>==</code> と <code>!=</code> で一致比較することが
できます。
</p>
<p>
また、不正な複合検索コード値を表す <code>EB_MULTI_INVALID</code> という
特別な副本コードが定義されています。
利用可能な複合検索に対して、この複合検索コードが割り当てられることは
ありません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="search-functions">関数の詳細</a></h3>
<p>
この節で説明している関数を使うには、次のようにヘッダファイルを読み込んで
下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/eb.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_word_search"><code>int eb_have_word_search (EB_Book *<var>book</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_endword_search"><code>int eb_have_endword_search (EB_Book *<var>book</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_exactword_search"><code>int eb_have_exactword_search (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_have_word_search()</code> は、<var>book</var> が選択中の
副本で前方一致検索メソッドが利用可能どうかを調べます。
同様に <code>eb_have_endword_search()</code> は後方一致検索メソッドに
ついて、<code>eb_have_exactword_search()</code> は完全一致検索メソッドに
ついて利用可能どうかを調べます。
</p>
<p>
利用可能なら 1 を返します。
メソッドを持っていないか、そもそも副本が選択されていない場合は 0 を
返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_keyword_search"><code>int eb_have_keyword_search (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_have_keyword_search()</code> は、<var>book</var> が選択中の
副本で条件検索メソッドが利用可能どうかを調べます。
</p>
<p>
利用可能なら 1 を返します。
メソッドを持っていないか、そもそも副本が選択されていない場合は 0 を
返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_multi_search"><code>int eb_have_multi_search (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_have_multi_search()</code> は、<var>book</var> が選択中の
副本で複合検索メソッドが利用可能どうかを調べます。
</p>
<p>
最低 1 種類でも利用可能なら 1 を返します。
メソッドを持っていないか、そもそも副本が選択されていない場合は 0 を
返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:multi_search_list"><code>EB_Error_Code eb_multi_search_list (EB_Book *<var>book</var>, EB_Multi_Search_Code *<var>multi_list</var>, int *<var>multi_count</var>)</code></a></h4>
<p>
関数 <code>eb_multi_search_list()</code> は、<var>book</var> が選択中の
副本に用意されている複合検索を調べ、複合検索コードの一覧を
<code>EB_Multi_Search_Code</code> 型の配列にして、<var>multi_list</var>
の指す領域に書き込みます。
配列は、最大で <code>EB_MAX_MULTI_SEARCHES</code> 個の要素を持ちます。
加えて、複合検索の種類数を <var>multi_count</var> の指す領域に書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>subbook_count</var> の指す領域に 0 を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> はいずれかの副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:multi_entry_count"><code>EB_Error_Code eb_multi_entry_count (EB_Book *<var>book</var>, EB_Multi_Search_Code <var>multi_id</var>, int *<var>entry_count</var>)</code></a></h4>
<p>
関数 <code>eb_multi_search_list()</code> は、<var>book</var> が選択中の
副本に用意されている複合検索 <var>multi_id</var> について調べ、入力語の
個数を <var>entry_count</var> の指す領域に書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
このとき書き込まれる入力語の個数は、1 以上 <code>EB_MAX_MULTI_ENTRIES</code>
以下になります。
失敗すると、<var>entry_count</var> の指す領域には 0 を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> はいずれかの副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:multi_title"><code>EB_Error_Code eb_multi_title (EB_Book *<var>book</var>, EB_Multi_Search_Code <var>multi_id</var>, char *<var>title</var>)</code></a></h4>
<p>
関数 <code>eb_multi_search_list()</code> は、<var>book</var> が選択中の
副本に用意されている複合検索 <var>multi_id</var> の題名を <var>title</var>
の指す領域に書き込みます。
題目は最長で <code>EB_MAX_MULTI_TITLE_LENGTH</code> バイトになります。
この長さに、ナル文字は含みません。
</p>
<p>
書籍の文字コード
(<a href="#eb_book-data-types">「[CD-ROM 書籍と <code>EB_Book</code> オブジェクト] データ型の詳細」</a> を参照のこと)
が <code>EB_CHARCODE_ISO8859_1</code> なら、題目を表す文字列は ISO 8859-1
になり、それ以外の文字コードなら日本語 EUC になります。
</p>
<p>
書籍によっては、複合検索は用意していても、複合検索の題名データを持って
いないことがあります。
その場合、EB ライブラリが代わりに付けた題名が <var>title</var> に
書き込まれます。
</p>
<p>
書籍の文字コードが <code>EB_CHARCODE_ISO8859_1</code> なら、
EB ライブラリが付ける題名は、"Multi Search 1", "Multi Search 2", ...
になります。
それ以外の文字コードであれば、題名は日本語 EUC で書かれた「複合検索 1」
「複合検索 2」... という文字列になります。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>label</var> の指す領域には空文字列を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> はいずれかの副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:multi_entry_label"><code>EB_Error_Code eb_multi_entry_label (EB_Book *<var>book</var>, EB_Multi_Search_Code <var>multi_id</var>, int <var>entry_index</var>, char *<var>label</var>)</code></a></h4>
<p>
関数 <code>eb_multi_search_list()</code> は、<var>book</var> が選択中の
副本に用意されている複合検索 <var>multi_id</var> について調べ、
<var>entry_index</var> 番目の検索語の題目を <var>label</var> の指す領域に
書き込みます。
<var>entry_index</var> は、先頭の検索語を 0 番目と数えます。
題目は最長で <code>EB_MAX_MULTI_LABEL_LENGTH</code> バイトになります。
この長さに、ナル文字は含みません。
</p>
<p>
書籍の文字コード
(<a href="#eb_book-data-types">「[CD-ROM 書籍と <code>EB_Book</code> オブジェクト] データ型の詳細」</a> を参照のこと)
が <code>EB_CHARCODE_ISO8859_1</code> なら、題目を表す文字列は ISO 8859-1
になり、それ以外の文字コードなら日本語 EUC になります。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>label</var> の指す領域には空文字列を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> はいずれかの副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:multi_entry_have_candidates"><code>int eb_multi_entry_have_candidates (EB_Book *<var>book</var>, EB_Multi_Search_Code <var>multi_id</var>, int <var>entry_index</var>)</code></a></h4>
<p>
関数 <code>eb_multi_search_list()</code> は、<var>book</var> が選択中の
副本に用意されている複合検索 <var>multi_id</var> について調べ、
<var>entry_index</var> 番目の検索語が候補一覧を持っているかどうか調べます。
<var>entry_index</var> は、先頭の検索語を 0 番目と数えます。
</p>
<p>
持っていれば 1 を返します。
持っていないか、そもそも副本が選択されていない場合、あるいは
<var>multi_id</var>, や <var>entry_index</var> が不正な値だった場合は
0 を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:multi_entry_candidates"><code>EB_Error_Code eb_multi_entry_candidates (EB_Book *<var>book</var>, EB_Multi_Search_Code <var>multi_id</var>, int <var>entry_index</var>, EB_Position *<var>position</var>)</code></a></h4>
<p>
関数 <code>eb_multi_search_list()</code> は、<var>book</var> が選択中の
副本に用意されている複合検索 <var>multi_id</var> について調べ、
<var>entry_index</var> 番目の検索語の候補一覧の位置を <var>position</var>
の指す領域に書き込みます。
先頭の検索語が 0 番目になります。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>positin</var> の指す領域には <code>eb_seek_text()</code>
が必ず失敗する位置情報を書き込み、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> はいずれかの副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:search_word"><code>EB_Error_Code eb_search_word (EB_Book *<var>book</var>, const char *<var>input_word</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:search_endword"><code>EB_Error_Code eb_search_endword (EB_Book *<var>book</var>, const char *<var>input_word</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:search_exactword"><code>EB_Error_Code eb_search_exactword (EB_Book *<var>book</var>, const char *<var>input_word</var>)</code></a></h4>
<p>
関数 <code>eb_search_word()</code> は、<var>book</var> が選択中の副本に
対する前方一致検索をリクエストします。
同様に <code>eb_search_endword()</code> は後方一致検索を、
<code>eb_search_exactword()</code> は完全一致検索をリクエストします。
</p>
<p>
検索する語は、引数 <var>input_word</var> で指定します。
ただし、これらの関数は検索をリクエストするだけで、一致したエントリの
情報を返すことはしません。
一致したエントリの取得には <code>eb_hit_list()</code> を使います。
関数は、成功すると <code>EB_SUCCESS</code> を返します。
失敗すると、原因を示すエラーコードを返します。
失敗すると、関数を呼び出す前にリクエストしていた検索の状態記録はリセット
されますので、その状態のまま <code>eb_hit_list()</code> を呼び出しても、
やはり失敗に終わります。
</p>
<p>
書籍の文字コード
(<a href="#eb_book-data-types">「[CD-ROM 書籍と <code>EB_Book</code> オブジェクト] データ型の詳細」</a> を参照のこと)
が <code>EB_CHARCODE_ISO8859_1</code> なら、関数に渡す検索語は ISO 8859-1
で書かれていなければなりません。
それ以外の文字コードの場合は、日本語 EUC で書かれていなければなりません。
不正な文字番号を含んでいた場合、関数は <code>EB_ERR_BAD_WORD</code> を
返します。
</p>
<p>
加えて、検索語は 1 バイト以上、<code>EB_MAX_WORD_LENGTH</code> (= 255)
バイト以下でなければなりません。
この長さに、ナル文字は含みません。
長すぎる場合は、<code>EB_ERR_TOO_LONG_WORD</code> を、
長さが 0 (空文字列) の場合は <code>EB_ERR_EMPTY_WORD</code> を返します。
</p>
<p>
あらかじめ、<var>book</var> はいずれかの副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
なお、一致するエントリが最低 1 個あるかどうかは、戻り値には影響しません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:search_keyword"><code>EB_Error_Code eb_search_keyword (EB_Book *<var>book</var>, const char * const <var>input_words</var>[])</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:search_cross"><code>EB_Error_Code eb_search_cross (EB_Book *<var>book</var>, const char * const <var>input_words</var>[])</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:search_multi"><code>EB_Error_Code eb_search_multi (EB_Book *<var>book</var>, EB_Multi_Search_Code <var>multi_id</var>, const char * const <var>input_words</var>[])</code></a></h4>
<p>
関数 <code>eb_search_keyword()</code> は、<var>book</var> が選択中の
副本に対する条件検索をリクエストします。
同様に <code>eb_search_cross()</code> はクロス検索を、
<code>eb_search_multi()</code> は複合検索をそれぞれリクエストします。
</p>
<p>
検索する語は、引数 <var>input_words</var> で指定します。
条件検索と複合検索はいずれも複数個の検索語を受け付けますので、検索語を
配列にして渡します。
このとき、配列の末尾の要素には <code>NULL</code> を置き、配列の終端を
明示します。
</p>
<p>
いずれの関数も検索をリクエストするだけで、一致したエントリの情報を
返すことはしません。
一致したエントリの取得には <code>eb_hit_list()</code> を使います。
関数は、成功すると <code>EB_SUCCESS</code> を返します。
失敗すると、原因を示すエラーコードを返します。
失敗すると、関数を呼び出す前にリクエストしていた検索の状態記録はリセット
されますので、その状態のまま <code>eb_hit_list()</code> を呼び出しても、
やはり失敗に終わります。
</p>
<p>
書籍の文字コード
(<a href="#eb_book-data-types">「[CD-ROM 書籍と <code>EB_Book</code> オブジェクト] データ型の詳細」</a> を参照のこと)
が <code>EB_CHARCODE_ISO8859_1</code> なら、関数に渡す検索語は ISO 8859-1
で書かれていなければなりません。
それ以外の文字コードの場合は、日本語 EUC で書かれていなければなりません。
不正な文字番号を含んでいた場合、関数は <code>EB_ERR_BAD_WORD</code> を
返します。
</p>
<p>
加えて、個々の検索語は <code>EB_MAX_WORD_LENGTH</code> (= 255) バイト以下
でなければなりません。
この長さに、ナル文字は含みません。
長すぎる場合は、<code>EB_ERR_TOO_LONG_WORD</code> を返します。
長さが 0 バイトの検索語は無視されますが、少なくとも 1 個の検索語は長さ
が 1 以上ないといけません。
長さが 1 以上の検索語が 1 つもないときは、<code>EB_ERR_NO_WORD</code> を
返します。
</p>
<p>
末尾の NULL を除いた配列の要素数は、条件検索では <code>EB_MAX_KEYWORDS</code>
以下、クロス検索では <code>EB_MAX_CROSS_ENTRIES</code> 以下、
複合検索では <code>EB_MAX_MULTI_ENTRIES</code> 以下でなくては
なりません。
個数が多すぎると <code>EB_ERRO_TOO_MANY_WORDS</code> を返します。
空文字列の要素を差し引いた個数ではなく、単純に渡された要素数が上限を
超えているとエラーになりますので、注意が必要です。
</p>
<p>
あらかじめ、<var>book</var> はいずれかの副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
なお、一致するエントリが最低 1 個あるかどうかは、戻り値には影響しません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:hit_list"><code>EB_Error_Code eb_hit_list (EB_Book *<var>book</var>, int <var>max_hit_count</var>, EB_Hit *<var>hit_list</var>, int *<var>hit_count</var>)</code></a></h4>
<p>
関数 <code>eb_hit_list()</code> は、あらかじめ以下のいずれかの関数で
リクエストされた検索を実行し、一致したエントリを取得します。
</p>
<ul>
<li><code>eb_search_word()</code> (前方一致検索)
<li><code>eb_search_endword()</code> (後方一致検索)
<li><code>eb_search_exactword()</code> (完全一致検索)
<li><code>eb_search_keyword()</code> (条件検索)
<li><code>eb_search_cross()</code> (クロス検索)
<li><code>eb_search_multi()</code> (複合検索)
</ul>
<p>
したがって、この関数を呼ぶ前に、上記のいずれかの関数の呼び出しに成功して
いなくてはなりません。
</p>
<p>
<code>eb_hit_list()</code> は最大で <var>max_hit_count</var> 個の
一致エントリを <var>hit_list</var> に書き込みます。
そして、書き込んだ一致エントリの数を <var>hit_count</var> が指す領域に
書き込みます。
それ以上の個数の一致エントリが存在する場合、残ったエントリの情報は、
この関数を繰り返し呼び出すことで得ることができます。
</p>
<p>
ただし、以下に挙げた関数を呼び出すと、リクエストした検索に関する状態記録
がリセットされますので、一致したエントリの取得は継続できなくなります。
</p>
<ul>
<li><code>eb_set_subbook()</code>
<li><code>eb_unset_subbook()</code>
<li><code>eb_load_all_subbooks()</code>
<li><code>eb_bind()</code>
<li><code>eb_finalize_book()</code>
<li><code>eb_search_word()</code>
<li><code>eb_search_endword()</code>
<li><code>eb_search_exactword()</code>
<li><code>eb_search_keyword()</code>
<li><code>eb_search_cross()</code>
<li><code>eb_search_multi()</code>
</ul>
<p>
繰り返し呼んだ場合も、一致したエントリの情報はその都度 <var>hit_list</var>
の先頭から書き込み、<var>hit_count</var> が指す領域に書き込む値も、その回
の <code>eb_hit_list()</code> の呼び出しで書き込んだ一致エントリの数に
なります。
</p>
<p>
成功すると、この関数は <code>EB_SUCCESS</code> を返します。
たとえ一致したエントリがなくても、処理が正常に終了すれば、関数は
<code>EB_SUCCESS</code> を返します。
</p>
<p>
失敗すると、<var>hit_count</var> が指す領域に 0 を書き込み、原因を示す
エラーコードを返します。
この場合、リクエストしていた検索の状態記録はリセットされますので、
これ以上 <code>eb_hit_list()</code> を呼んで、残った一致エントリを取得
することはできなくなります。
</p>
<p>
あらかじめ、<var>book</var> はいずれかの副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
また、先に挙げた検索のリクエストが成功していない状態でこの関数を呼ぶと、
<code>EB_ERR_NO_PREV_SEARCH</code> を返します。
</p>
<!-- ================================================================ -->
<h2><a name="text-data">テキストデータ</a></h2>
<p>
テキストデータの取得は、検索と並ぶ重要な機能です。
</p>
<p>
ここで言う <dfn>テキストデータ (text data)</dfn> は、
<dfn>本文 (text body)</dfn> という意味ではありません。
CD-ROM 書籍には確かに本文も存在しますが、本文と同じデータ形式を用いて
書かれたデータが数種類あります。
本書では、これらのデータをまとめてテキストデータと呼んでいます。
EB ライブラリが扱えるテキストデータの種類には、次のものがあります。
</p>
<ul>
<li>見出し
<li>本文
<li>メニュー
<li>著作権表示
<li>複合検索の入力語の候補一覧
</ul>
<p>
本章では、これらのテキストデータの取得と加工方法について説明します。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="seek-and-read-text-data">テキストデータのシークと読み込み</a></h3>
<p>
UNIX でプログラムを組んだ経験のある方には、ファイルからデータを読み込む
際に用いる <code>lseek()</code>, <code>read()</code> というシステムコール
をご存じの方も多いでしょう。
</p>
<p>
EB ライブラリでも、テキストデータの取得には、<dfn>シーク (seek)</dfn> と
<dfn>読み込み (read)</dfn> という 2 つの操作で行います。
ただし、EB ライブラリではファイルポインタやディスクリプタはなく、
<code>EB_Book</code> オブジェクトを通じてシークや読み込みの操作を行います。
</p>
<p>
また、シーク時に指定する位置も <code>off_t</code> 型ではなく、
<code>EB_Position</code> 型 (<a href="#search-data-types">「[検索] データ型の詳細」</a> を参照のこと)
のオブジェクトを用います。
たとえば、本文の先頭位置は、<code>eb_text()</code> という関数を使って
次のように取得できますが、このときも位置データは <code>EB_Position</code>
型オブジェクトに書き込まれます。
</p>
<blockquote class="program">
<pre>
EB_Position position;
/* 関数の処理が成功すると、<code>position</code> に本文の開始位置が
* 書き込まれます。 */
if (eb_text(&book, &position) != EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
</pre>
</blockquote>
<p>
参考までに、<code>EB_Position</code> 型の内部構造は、次のようになっています。
</p>
<blockquote class="program">
<pre>
typedef struct EB_Position_Struct EB_Position;
struct EB_Position_Struct {
int page; /* ページ番号 */
int offset; /* ページ内のオフセット */
};
</pre>
</blockquote>
<p>
検索して見つかった一致エントリの見出しや本文を読み込む際にも、位置情報
の指定には <code>EB_Position</code> 型が使われます。
一致したエントリの情報は、関数 <code>eb_hit_list()</code> によって
<code>EB_Hit</code> という型のオブジェクトに書き込まれますが、
<code>EB_Hit</code> 型は次のように定義されています。
(詳しくは <a href="#search-data-types">「[検索] データ型の詳細」</a> を参照のこと。)
</p>
<blockquote class="program">
<pre>
typedef struct {
EB_Position heading; /* 見出しの位置 */
EB_Position text; /* 本文の位置 */
} EB_Hit;
</pre>
</blockquote>
<p>
つまり、このときの見出しと本文の位置も、<code>EB_Position</code> 型で
表現されているのです。
</p>
<p>
では、実際のプログラムを例にして、シークと読み込みを行ってみます。
まずは、シークからです。
これには関数 <code>eb_seek_text()</code> を用います。
ここでもやはり、位置は <code>EB_Position</code> 型で渡します。
</p>
<blockquote class="program">
<pre>
if (eb_seek_text(&book, &position) != EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
</pre>
</blockquote>
<p>
データの種類 (見出し、本文 ...) によらず、テキストデータのシークは
すべて <code>eb_seek_text()</code> で行います。
</p>
<p>
ただし、<code>EB_Book</code> オブジェクトは、テキストデータの種類別に
読み込み位置を覚えているわけではなく、全種類のテキストデータで共有する
位置情報を一つ覚えているだけです。
たとえば、本文を読み込んだ後で、別の位置にシークして見出しを読み込むと、
<code>EB_Book</code> は本文の読み込み位置のことは忘れてしまいます。
</p>
<p>
さて、シークが終わったら、データを読み込みます。
読み込もうとするテキストデータの種類によって、使用する関数が異なります。
見出しだけは <code>eb_read_heading()</code> を使いますが、それ以外では
<code>eb_read_text()</code> を使います。
</p>
<p>
以下は、<code>eb_read_text()</code> の使用例です。
</p>
<blockquote class="program">
<pre>
#define MAX_LENGTH 1000
char buffer[MAX_LENGTH + 1];
ssize_t text_length;
if (eb_read_text(&book, NULL, NULL, NULL, MAX_LENGTH,
text, &text_length) != EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
</pre>
</blockquote>
<p>
成功すると、<code>text</code> にはテキストデータが、
<code>text_length</code> には実際に読み込んだバイト数が書き込まれます。
テキストは最大で <code>MAX_LENGTH</code> バイト書き込まれます。
テキストデータはさらにナル文字で終端されますので、<code>buffer</code> には
もう 1 バイト分の領域が必要になります。
</p>
<p>
<code>eb_read_heading()</code> の呼び出し方も、<code>eb_read_text()</code>
とまったく変わりません。
</p>
<blockquote class="program">
<pre>
if (eb_read_heading(&book, NULL, NULL, NULL, MAX_LENGTH,
text, &text_length) != EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
</pre>
</blockquote>
<p>
<code>eb_read_text()</code> や <code>eb_read_heading()</code> で読み込んだ
テキストデータは平文のテキストになっていて、ナル文字で終端されています。
</p>
<blockquote class="program">
<pre>
printf("%s\n", text); /* 出力してみる */
</pre>
</blockquote>
<p>
読み込みたいテキストデータが長すぎて、<code>eb_read_text()</code>
あるいは <code>eb_read_heading()</code> を一回呼び出しただけでは全部
読み込めなかった場合は、再度呼び出すことで続きのデータを読み込むことが
できます。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="text-data-format">テキストデータの内部形式</a></h3>
<p>
前節の例では、読み込んだテキストデータは、平文テキストになっていました。
けれども、CD-ROM 書籍内に平文テキストのデータが、そのまま収録されている
わけではありません。
</p>
<p>
実際のテキストデータの例を、以下に示します。
左側のブロックは 16 進数でダンプした様子で、右側はそれを基に JIS X 0208
(日本語のかな漢字) の文字を表している部分を <samp>[ ]</samp> という形に
直したものです。
</p>
<blockquote>
<pre>
(16進数によるダンプ) (可能な部分をかな漢字に変換)
1f0900011f41010026321f611f042121 1f0900011f410100[Σ]1f611f04[ ]
212721211f053e704a734a541f0a1f04 [：][ ]1f05[情][報][編]1f0a1f04
214e1f0525372530255e1f04214f2121 [［]1f05[シ][グ][マ]1f04[］][ ]
214a237323692367236d236121212370 [（][ｓ][ｉ][ｇ][ｍ][ａ][ ][ｐ]
2372236f236a236523632374214b1f05 [ｒ][ｏ][ｊ][ｅ][ｃ][ｔ][）]1f05
</pre>
</blockquote>
<p>
右側のブロックを見ると、おおよそ平文に近い形でテキストデータが収められて
いることが分かりますが、ところどころに「文字」ではないデータも含まれて
います。
</p>
<p>
文字ではない部分は、すべて「エスケープシーケンス」と呼ばれるものです。
エスケープシーケンスとは、テキストデータを出力する際に、改行の禁止や
強調修飾といった制御情報を伝えるための仕組みです。
16 進数の <samp>1f</samp> が、エスケープシーケンスの開始を意味します。
</p>
<p>
参考までに、上のテキストデータで使われているエスケープシーケンスを
すべて列挙すると、次のようになります。
</p>
<dl>
<dt><samp>1f09 0001</samp></dt>
<dd>
字下げ (インデント) の量を指定。
(引数が 0001 なので、字下げ量は 1。)
<dt><samp>1f41 0100</samp></dt>
<dd>
検索キーの開始。
(引数 0100 の意味については、JIS X 4081 に記述がないため不明。)
<dt><samp>1f61</samp></dt>
<dd>
検索キーの終了。
<dt><samp>1f04</samp></dt>
<dd>
半角表示の開始。
<dt><samp>1f05</samp></dt>
<dd>
半角表示の終了。
<dt><samp>1f0a</samp></dt>
<dd>
改行
</dl>
<p>
前節のプログラムで、読み込んだデータが平文テキストになっていたのは、
実は EB ライブラリが加工処理をしたからです。
つまり、「改行」のように平文テキストでも表現可能なエスケープシーケンス
については処理し、「検索キーの開始」のように表現できないものについては
無視するようにして、平文テキストになるように加工していたのです。
</p>
<p>
しかし、平文テキストは表現力が乏しいので、元のデータには含まれている
エスケープシーケンスの多くを無視することになってしまいます。
HTML のように、もっと表現力のある形式で出力するなら、無視せずに済む
シーケンスを増やせそうです。
では、HTML 形式でテキストデータを取得する関数が EB ライブラリに用意されて
いるかというと、残念ながらありません。
</p>
<p>
その代わりに、かなり手間はかかりますが、自由にテキストデータを加工できる
ための仕組みが用意されています。
それが、次の節で説明する <dfn>フック (hook)</dfn> です。
フックを使うことで、テキストデータを柔軟に加工することができます。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="hook">フック</a></h3>
<p>
特に何も指定しなければ、<code>eb_read_text()</code>,
<code>eb_read_heading()</code> が返すテキストデータの加工は、あらかじめ
決められた通りの方法で行われます。
たとえば、「改行」のエスケープシーケンスに対しては、<samp>\n</samp> を
書き込むようになっています。
</p>
<p>
<dfn>フック (hook)</dfn> を使うと、こうした加工方法を変えることができます。
フックは、あらかじめ決められたフック設定位置に対して、フック関数を登録
することで有効になります。
フック関数が登録されていると、<code>eb_read_text()</code> や
<code>eb_read_heading()</code> は、あらかじめ決まったやり方でデータを
書き込む代わりに、フック関数を呼び出します。
呼び出されたフック関数がデータの書き込み処理を行うことで、
<code>eb_read_text()</code> や <code>eb_read_heading()</code> から返る
テキストデータが変化するというわけです。
</p>
<p>
EB ライブラリには、多数のフック設定位置が用意されています。
各エスケープシーケンスには、それぞれ専用にフックが用意されており、
それ以外にも文字のためのフックが存在します。
(どのようなフック設定位置があるか、詳しくは
<a href="#hook-code-list">「フックコードの一覧」</a> を参照のこと。)
</p>
<p>
それぞれのフック設定位置は、<dfn>フックコード (hook code)</dfn> と
呼ばれるコード値で識別されます。
たとえば、前述の「改行」のエスケープシーケンスに対応するフックコード
は <code>EB_HOOK_NEWLINE</code> になります。
</p>
<p>
アプリケーションプログラムがフックを扱うには、フックの集合である
<dfn>フックセット (hook set)</dfn> を用意します。
これは、EB ライブラリで利用可能なすべてのフック設定位置に対して、どの
フック関数を使うのかを記録するためのオブジェクトです。
</p>
<p>
では、実際にどうやってフックセットを扱うのか、説明していきましょう。
フックセットは <code>EB_Hookset</code> 型のオブジェクトで表しますので、
まず <code>EB_Hookset</code> オブジェクトを用意します。
</p>
<blockquote class="program">
<pre>
EB_Hookset hookset;
</pre>
</blockquote>
<p>
<code>EB_Hookset</code> オブジェクトは、<code>EB_Book</code> オブジェクト
と同様に、使用前に必ず初期化する必要があります。
</p>
<blockquote class="program">
<pre>
eb_initialize_hookset(&hookset);
</pre>
</blockquote>
<p>
実際のフック関数は、次のようなものになります。
この例では、フック関数の中で <code>eb_write_text_string()</code> という
関数を呼び出して、<samp><br></samp> という文字列をテキストデータ
として書き込んでいます。
</p>
<blockquote class="program">
<pre>
EB_Error_Code
hook_newline(EB_Book *book, EB_Appendix *appendix, void *container,
EB_Hook_Code code, int argc, const unsigned int *argv) {
eb_write_text_string(book, "<br>");
return 0;
}
</pre>
</blockquote>
<p>
関数 <code>eb_set_hook()</code> を用いることで、このフック関数を
フックセットに登録することができます。
ただし、まず <code>EB_Hook</code> という型のオブジェクトにいったん
フックコードとフック関数を設定し、それを <code>eb_set_hook()</code> を
渡してやる必要があります。
ここでは、「改行」を表すエスケープシーケンスに対して、上記のフック関数
を登録してみます。
</p>
<blockquote class="program">
<pre>
EB_Hook hook;
hook.code = EB_HOOK_NEWLINE; # フックコードをセット
hook.function = hook_newline; # フック関数をセット
eb_set_hook(&hookset, &hook);
</pre>
</blockquote>
<p>
なお、同じフック設定位置 (フックコード) に複数回フック関数を登録しても、
有効になるのは最後に登録したものだけですので、注意して下さい。
フック関数として <code>NULL</code> を指定すると、登録されているフックが
解除されます。
</p>
<p>
関数 <code>eb_set_hooks()</code> (最後に <code>s</code> が付く) を使えば、
複数のフック関数を一度に登録できます。
</p>
<blockquote class="program">
<pre>
static const EB_Hook hooks[] = {
{EB_HOOK_NEWLINE, hook_newline},
{EB_HOOK_SET_INDENT, hook_set_indent},
{EB_HOOK_WIDE_JISX0208, hook_set_jisx0208},
{EB_HOOK_NULL, NULL}
};
eb_set_hooks(&hookset, &hooks);
</pre>
</blockquote>
<p>
配列の末尾を明示するために、<code>EB_HOOK_NULL</code> という特殊な
フックコードを置きます。
この点も注意して下さい。
</p>
<p>
こうしてフック関数を登録したフックセットを、<code>eb_raed_text()</code>,
<code>eb_raed_heading()</code> への引数として渡します。
前節までの例では、<code>NULL</code> を渡していましたが、代わりに
<code>&hookset</code> を渡してみます。
</p>
<blockquote class="program">
<pre>
if (eb_read_text(&book, NULL, &hookset, NULL, MAX_LENGTH,
text, &text_length) != EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
</pre>
</blockquote>
<p>
これによって、テキストデータ中に改行を表すエスケープシーケンスがあると、
<samp>\n</samp> の代わりに <samp><br></samp> という文字列が
書き込まれるようになります。
</p>
<p>
<code>EB_Hookset</code> オブジェクトを使い終わったら、
<code>eb_finalize_hookset()</code> を呼んで後始末をします。
</p>
<blockquote class="program">
<pre>
eb_finalize_hookset(&hookset);
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="hook-and-character-code">フックと文字コードの関係</a></h3>
<p>
前節では、エスケープシーケンスに対するフックを例にとりましたが、この他
にも、EB ライブラリには文字に対するフックが用意されています。
</p>
<dl>
<dt><code>EB_HOOK_ISO8859_1</code></dt>
<dd>
ISO 8859-1 (ラテン文字 1) 文字へのフック。ただし制御文字を除きます。
引数として、ISO 8859-1 の文字番号がフック関数に渡されます。
<dt><code>EB_HOOK_NARROW_JISX0208</code></dt>
<dd>
半角の JIS X 0208 (日本語のかな漢字) 文字へのフック。
引数として、日本語 EUC で表現した場合の文字番号が、フック関数に渡されます。
<dt><code>EB_HOOK_WIDE_JISX0208</code></dt>
<dd>
全角の JIS X 0208 (日本語のかな漢字) 文字へのフック。
引数として、日本語 EUC で表現した場合の文字番号が、フック関数に渡されます。
<dt><code>EB_HOOK_GB2312</code></dt>
<dd>
GB 2312 (中国語の簡体字) 文字へのフック。
引数として、中国語 EUC で表現した場合の文字番号が、フック関数に渡されます。
<dt><code>EB_HOOK_NARROW_FONT</code></dt>
<dd>
半角の外字へのフック。
引数として、外字の文字番号が、フック関数に渡されます。
<dt><code>EB_HOOK_WIDE_FONT</code></dt>
<dd>
半角の外字へのフック。
引数として、外字の文字番号が、フック関数に渡されます。
</dl>
<p>
いずれも、その文字がテキストデータ中に現れる度に、フック関数が呼び出され
ます。
</p>
<p>
上の記述を見ても分かるように、フック関数に渡される文字番号は、書籍の文字
コードに応じて、ISO 8859-1, 日本語 EUC、中国語 EUC のいずれかの文字コード
で表現されたものになります。
</p>
<p>
フック関数を登録しなければ、その文字番号がテキストデータとしてそのまま
書き込まれます。
</p>
<p>
もし、アプリケーションプログラムが、EB ライブラリの内部コードとは異なる
文字コードを使用したい場合は、これらのフックのフック関数を登録して、
コード変換処理をするのも手です。
ただし、一文字毎にフック関数が呼び出されるので、相応の負荷がかかります。
</p>
<p>
また、EBXA-C を扱うには、特別な処理が必要です。
EBXA-C では、文字コードとして GB 2312 と JIS X 0208 が使われますが
(<a href="#character-code">「文字コード」</a> を参照のこと)、EB ライブラリによる標準の処理
では、どちらも 0xa1a1 〜 0xfefe にマッピングされて衝突するため、最低
でもどちらか一方をフックして文字の表現方法を変えないと、正しく出力
できません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="cross-search-result">クロス検索の検索結果</a></h3>
<p>
すでに <a href="#search">「検索」</a> の章で述べたように、CD-ROM 書籍
には前方一致検索、後方一致検索といった複数の検索メソッドがあります。
EB ライブラリで検索を行うと、どの検索メソッドでも、一致したエントリの
情報は、以下のような <code>EB_Hit</code> 型のオブジェクトとして
受け取ります。
</p>
<blockquote class="program">
<pre>
typedef struct {
EB_Position heading; /* 見出しの位置 */
EB_Position text; /* 本文の位置 */
} EB_Hit;
</pre>
</blockquote>
<p>
しかしクロス検索では、<code>EB_Hit</code> の見出しと本文の位置は
まったく同じになります。
したがって、見出しと本文のテキストデータを読み込むには、他の検索メソッド
のようにそれぞれの位置にシークして読み込むというやり方ではうまく
いきません。
</p>
<p>
以下に、クロス検索の見出しと本文を読み込むプログラム例を示します。
</p>
<blockquote class="program">
<pre>
/* 見出し位置へのシークを行う */
if (eb_seek_text(&book, &hits[0].heading) != EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
/* 見出しの読み込みを行う */
if (eb_read_heading(&book, NULL, NULL, NULL, MAX_LENGTH,
heading, &heading_length) != EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
/* 先ほど読み込んだ見出しの、次の部分へ飛ぶ */
if (eb_forward_heading(&book) != EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
/* 本文の読み込みを行う */
if (eb_read_heading(&book, NULL, NULL, NULL, MAX_LENGTH,
text, &text_length) != EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
</pre>
</blockquote class="program">
<p>
クロス検索でも、見出しの内容を読み込む方法は他の検索メソッドと変わり
はなく、<code>eb_read_heading()</code> を使います。
変わっているのは、本文の読み込みです。
<code>eb_read_text()</code> ではなく、<code>eb_read_heading()</code>
を使います。
見出しを読み込むための関数 <code>eb_read_heading()</code> を、本文を
読み込むために呼ぶというのは奇妙な話ですが、これはクロス検索の本文が
見出しと同じ形式になっているためです。
通常、見出しは一行程度しか書かれていませんが、実際のところクロス検索
の本文も一行程度しかありません。
</p>
<p>
また、本文は見出しのすぐ後に書かれているため、上記のように見出しを
読み込んだ後で <code>eb_forward_heading()</code> という関数を呼び、
その後で本文を読み込むためにもう一度 <code>eb_read_heading()</code> を
呼ぶという変わった手順を踏みます。
</p>
<p>
本文だけが必要で見出しが要らなければ、シーク直後に
<code>eb_forward_heading()</code> を呼ぶようにします。
その後で <code>eb_read_heading()</code> を呼ぶと、本文を読み込みます。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="copyright-notice">著作権表示</a></h3>
<p>
先に記したように、テキストデータには何種類かあり、その中に
<dfn>著作権表示 (copyright notice)</dfn> というものがあります。
名前の通り、著作権表示に関するテキストデータを収めたものです。
</p>
<p>
一般に、著作権表示は本文とはまったく独立したデータとして用意されます。
したがって、本文を先頭から末尾まで読んでみても、著作権表示はどこにも
見つかりません。
</p>
<p>
選択中の副本について、著作権表示の開始位置を知るには
<code>eb_copyright()</code> を使います。
この関数は、副本が著作権表示を持っていなければ
<code>EB_ERR_NO_SUCH_SEARCH</code> を返しますので、著作権表示の有無も
同時に分かります。
(開始位置は取得せずに、有無だけを調べたいときは、
<code>eb_have_copyright()</code> という関数が使えます。)
</p>
<blockquote class="program">
<pre>
EB_Position position;
EB_Error_Code err;
err = eb_copyright(&book, &position);
if (err == EB_ERR_NO_SUCH_SEARCH) {
/* 著作権表示はない */
} else if (err != EB_SUCCESS) {
/* それ以外のエラー */
return;
}
</pre>
</blockquote>
<p>
後は、得られた位置 (<code>position</code>) にシークして、
<code>eb_read_text()</code> でテキストデータを読み込みます。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="menu">メニュー</a></h3>
<p>
本文とは独立したテキストデータとしては、著作権表示の他に
<dfn>メニュー (menu)</dfn> というものがあります。
メニューは、主に本文の補助となるデータを収録しています。
代表的なものでは、「前書き (序)」「凡例」といったものが挙げられます。
</p>
<p>
メニューでは「別項目参照」というエスケープシーケンスを多用して、階層的
な構造になっているのが一般的です。
このエスケープシーケンスには、参照先のテキストの位置が記録されています。
</p>
<p>
たとえば、ある CD-ROM 書籍のメニューが次のようになっていたとします。
この例では、メニューには 3 つの項目があります。
</p>
<blockquote>
<pre>
* 序文
* 表記について
* 奥付
</pre>
</blockquote>
<p>
メニューのそれぞれの項目には、参照先があります。
テキストデータの内部表現では、「序文」「表記について」「奥付」の
それぞれの文字列の前後に別項目参照開始および終了エスケープシーケンスが
付いた形になっています。
視覚的に分かるように記すと、次のような形になっています。
</p>
<blockquote>
<pre>
* <別項目参照開始シーケンス> "序文" <別項目参照終了シーケンス>
* <別項目参照開始シーケンス> "表記" <別項目参照終了シーケンス>
* <別項目参照開始シーケンス> "奥付" <別項目参照終了シーケンス>
</pre>
</blockquote>
<p>
HTML の書き方を知っているなら、<samp>a</samp> タグと言えば分かるのでは
ないかと思います。
</p>
<blockquote class="program">
<pre>
<a href="./index.html">EB ライブラリのホームページ</a>
</pre>
</blockquote>
<p>
ただし、参照先の位置情報は終了シーケンス側に記載されますので、この点は
HTML とは逆になります。
蛇足ですが、別位置参照はメニューだけでなく、本文でも一般的に使用されます。
</p>
<p>
別項目参照開始および終了シーケンスに対して、それぞれフック
<code>EB_HOOK_BEGIN_REFERENCE</code> と <code>EB_HOOK_END_REFERENCE</code>
が用意されています。
参照先の位置情報は、終了シーケンスへのフック関数に対して、引数として
渡されます。
たとえば、<code>EB_HOOK_END_REFERENCE</code> へのフック関数の冒頭では、
次のようにすると良いかも知れません。
</p>
<blockquote class="program">
<pre>
EB_Error_Code
hook_end_ref(EB_Book *book, EB_Appendix *appendix, void *container,
EB_Hook_Code code, int argc, const unsigned int *argv)
{
EB_Position position;
position.page = argv[1]; # 参照先のページ番号
position.offset = argv[2]; # 参照先のオフセット
</pre>
</blockquote>
<p>
参照先は、メニューの第 2 層となります。
この書籍の「奥付」の参照先を辿ったら、次のような表記になっていました。
</p>
<blockquote>
<pre>
○○堂出版社 新国語辞典 第 2 版 (EPWING 版)
第 1 版 発行 1988年 2月
第 2 版 発行 1999年 11月
第 2 版 (EPWING 版) 発行 2000年 2月
</pre>
</blockquote>
<p>
同様に「序文」「表記に付いて」の参照先についても、こうした文章データ
が用意されていました。
図示すると、メニューの階層は次のようになります。
</p>
<blockquote>
<pre>
┌─────┐
第１層 │メニュー │
└──┰──┘
┃
┏━━━━━━━╋━━━━━━━┓
┃ ┃ ┃
┌──┸──┐ ┌──┸──┐ ┌──┸──┐
第２層 │メニュー │ │メニュー │ │メニュー │
└─────┘ └─────┘ └─────┘
</pre>
</blockquote>
<p>
この辞書の例では、メニューはここで終わりになっていますが、書籍によっては
さらに第 3 層、第 4 層と続く場合もあります。
また、メニュー全体が均一の階層数になっているとは限りません。
メニューの参照先が本文や著作権表示になっていることもあります。
</p>
<p>
選択中の副本について、(第 1 層の) メニューの開始位置 を知るには
<code>eb_menu()</code> を使います。
この関数は、副本がメニューを持っていなければ
<code>EB_ERR_NO_SUCH_SEARCH</code> を返しますので、メニューの有無も同時に
分かります。
(開始位置は取得せずに、有無だけを調べたいときは、
<code>eb_have_menu()</code> という関数が使えます。)
</p>
<blockquote class="program">
<pre>
EB_Position position;
EB_Error_Code err;
err = eb_menu(&book, &position);
if (err == EB_ERR_NO_SUCH_SEARCH) {
/* メニューはない */
} else if (err != EB_SUCCESS) {
/* それ以外のエラー */
return;
}
</pre>
</blockquote>
<p>
後は、得られた位置 (<code>position</code>) にシークして、
<code>eb_read_text()</code> でテキストデータを読み込みます。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="multi-candidates">複合検索の候補一覧</a></h3>
<p>
「複合検索」(<a href="#multi-search">「複合検索」</a> を参照のこと) のところで述べたように、
複合検索では、入力語に <dfn>候補一覧 (candidates)</dfn> が用意されている
ことがあります。
これは、入力語として有効な語をあらかじめ列挙しておき、
アプリケーションプログラムのユーザに選択させる仕組みです。
</p>
<p>
たとえば、人名を検索するのために、次のような複合検索があったとします。
</p>
<blockquote>
<pre>
入力語 0: 国・地域
入力語 1: 時代
入力語 2: 性別
入力語 3: キーワード
入力語 4: キーワード
</pre>
</blockquote>
<p>
このうち、入力語 3 の「性別」には、入力語として有効な語は「男」と「女」
の 2 つしかないでしょう。
このように、入力語として有効な語が限られている場合に、候補一覧が用意
されていることがあります。
</p>
<p>
候補一覧は検索のためのデータではありますが、内部構造はテキストデータ
そのものです。
ユーザに対して候補を列記した示したテキストを示し、その中の一つを選択
してもらうようになっています。
</p>
<p>
しかも、候補一覧のデータ構造はメニューと非常に似ており、メニューの
ような階層構造を持っています
(<a href="#menu">「メニュー」</a> を参照のこと)。
たとえば、上の複合検索の入力語 2 「国・地域」にも候補の一覧を設けると
したら、最初の階層は次のようになるかも知れません。
</p>
<blockquote>
<pre>
* 日本 (→選択)
* 日本以外のアジア (→詳細)
* ヨーロッパ (→詳細)
* 北アメリカ (→詳細)
* その他 (→詳細)
</pre>
</blockquote>
<p>
「日本」を選ぶと、そこで入力語が決定されたことになります。しかし、
それ以外の項目についてはさらに細かく分類された選択肢が用意されて
います。
ここでは、「北アメリカ」を選んでみましょう。
すると、さらに次のような候補一覧のデータが提示されます。
</p>
<blockquote>
<pre>
* アメリカ (→選択)
* カナダ (→選択)
</pre>
</blockquote>
<p>
ここで、「アメリカ」「カナダ」を選ぶと、入力語が決定されます。
</p>
<p>
次に実際に、EB ライブラリを使ってこうした候補一覧を扱う方法について
説明します。
まず、アプリケーションプログラムは、複合検索の入力語が候補一覧を持って
いるかどうかを、確認する必要があるでしょう。
<code>eb_multi_entry_candidates()</code> を使うと、候補一覧データの開始位置
を取得することができます。
この関数は、候補一覧を持っていなければ <code>EB_ERR_NO_CANDIDATES</code> を
返しますので、候補一覧の有無も分かります。
(開始位置は取得せずに、有無だけを調べたいときは、
<code>eb_multi_entry_have_candidates()</code> という関数が使えます。)
</p>
<blockquote class="program">
<pre>
EB_Position position;
EB_Error_Code err;
/* <code>mulit_id</code>, <code>entry_id</code> で、どの複合検索の
* 何番目の入力語について確認するのかを指定します。*/
err = eb_multi_entry_candidates(&book, multi_id, entry_id, &position);
if (err == EB_ERR_NO_CANDIDATES) {
/* この入力語には、候補一覧が用意されていない */
return;
} else if (err != EB_SUCCESS) {
/* それ以外のエラー */
return;
}
</pre>
</blockquote>
<p>
後は、得られた位置 (<code>position</code>) にシークして、
<code>eb_read_text()</code> でテキストデータを読み込みます。
読み込んだテキストでは、候補となる語のそれぞれが候補開始と終了を表す
エスケープシーケンスに挟まれた形になっています。
</p>
<blockquote>
<pre>
* <候補開始シーケンス> "日本" <候補終了シーケンス>
* <候補開始シーケンス> "日本以外のアジア" <候補終了シーケンス>
* <候補開始シーケンス> "ヨーロッパ" <候補終了シーケンス>
* <候補開始シーケンス> "北アメリカ" <候補終了シーケンス>
* <候補開始シーケンス> "その他" <候補終了シーケンス>
</pre>
</blockquote>
<p>
候補開始シーケンスに対しては、フックとして
<code>EB_HOOK_BEGIN_CANDIDATE</code> が用意されています。
終了シーケンスに対するフックは 2 種類あって、さらに次の階層へ続く場合
に呼ばれる <code>EB_HOOK_END_CANDIDATE_GROUP</code> と、その語がそのまま
入力語の候補となる場合に呼ばれる <code>EB_HOOK_END_GROUP_LEAF</code> に
分かれています。
</p>
<p>
次の階層のデータの開始位置は、終了シーケンスのフック関数に、引数として
渡ってきます。
(この点もメニューと同様なので、メニューの解説を参考にして下さい。)
</p>
<p>
終了シーケンスに対するフック関数の中では、<code>eb_current_candidate()</code>
という関数が使えます。
この関数は、開始シーケンスと終了シーケンスの間に挟まれた「候補」の文字列
(ポインタ) を返します。
</p>
<blockquote class="program">
<pre>
const char *candidate;
candidate = eb_current_candidate(book);
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="stop-code-issue">区切りコードの問題</a></h3>
<p>
本文は、先頭から末尾まで一本の繋がったデータ列になっています。
英語辞典なら、最初の単語 `A' から最後の `zzz' までの説明が、すべて一つの
「本文」の中に書かれることになります。
</p>
<p>
一般に、アプリケーションプログラムがある単語を検索した際は、本文の中から
その単語を説明した部分だけを抜き出して出力することになるでしょう。
たとえば、`dictionary' という単語を引いた場合、次のような文章が出力される
事が期待されます。
その次や、次の次の単語の説明まで延々と表示されることを、おそらく大半の
ユーザは望まない筈です。
</p>
<blockquote>
<pre>
dictionary [名] (複: dictionaries)
辞典、事典
[類義] lexicon, glossary (用語辞典), encyclopedia (百科事典)
</pre>
</blockquote>
<p>
しかし、困ったことに CD-ROM 書籍には、単語の説明の終わりを示す印
(エスケープシーケンス) が定義されていません。
つまり、ある語の説明部分を正確に抜き出すことは、電子ブックや EPWING では
不可能なのです。
</p>
<p>
しかしながら、幸いにも市販の書籍の多くには、単語の説明の終了位置にだけ
出現する、特有のエスケープシーケンスが存在します。
もちろん、このエスケープシーケンスは本来「単語の説明の終了」を示すもの
ではなく別の用途として用いるのですが、「終了位置」として代用できる
という意味です。
</p>
<p>
EB ライブラリでは、この「終了位置」の印に使えるエスケープシーケンスの
ことを、<dfn>区切りコード (stop code)</dfn> と呼んでいます。
EB ライブラリは区切りコードを自動判定する機能を持っていますが、判定は
完璧ではないので外れることもあります。
外れると本文が途中で途切れたり、本文の続きが延々と出力されたりします。
</p>
<p>
その場合は、明示的に appendix
(詳しくは <a href="ebappendix.html">ebappendix コマンドのマニュアル</a>
の「appendix (付録) とは」を参照のこと)
で区切りコードを指定することによって回避できる書籍もありますが、
残念ながら区切りコードがまったく存在しない書籍も少数ながら存在します。
区切りコードを持たない書籍に対して、有効な対処方法は今のところありません。
</p>
<p>
<code>eb_read_text()</code> による本文の取得では、区切りコードが検出された
時点で読み込みを止めます。
さらに繰り返し <code>eb_read_text()</code> を呼んでも、区切りコードより先の
本文は読み込めません。
</p>
<p>
区切りコードを検出したかどうかの判定には、<code>eb_is_text_stopped()</code>
を使います。
この関数は、最後に読み込みを行ったテキストデータの中に、区切りコードを
検出していれば 1 を返します。
</p>
<p>
本文以外のテキストデータにも区切りコードの概念は存在しますので、
<code>eb_is_text_stopped()</code> を使って区切りコードを検出できます。
しかし、本文以外では EB ライブラリが確実に区切りを判別できますので、
誤判定の問題は起きません。
</p>
<p>
見出しにおける区切りは、それぞれの単語の見出しの終了位置となります。
メニューおよび複合検索の候補一覧では、階層化された個々のメニューデータ
の終了位置で区切りと判定されます。
(同一階層に複数個のメニューデータがあっても、個々のメニューデータで
区切られます。)
著作権表示では、全文の終了位置で区切りと判定されます。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="text-data-sample">サンプルプログラム</a></h3>
<blockquote>
<pre>
/* -*- C -*-
* Copyright (c) 1999-2006 Motoyuki Kasahara
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the project nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* 使用方法:
* text <book-path> <subbook-index> <number>
* 例:
* text /cdrom 0 10
* 説明:
* <book-path> で指定した CD-ROM 書籍から特定の副本を選び、本文
* の先頭から <number> 個分の単語の説明を出力します。
*
* <subbook-index> には、検索対象の副本のインデックスを指定しま
* す。インデックスは、書籍の最初の副本から順に 0、1、2 ... に
* なります。
*/
#include <stdio.h>
#include <stdlib.h>
#include <eb/eb.h>
#include <eb/error.h>
#include <eb/text.h>
#define MAXLEN_TEXT 1023
int
main(int argc, char *argv[])
{
EB_Error_Code error_code;
EB_Book book;
EB_Subbook_Code subbook_list[EB_MAX_SUBBOOKS];
int subbook_count;
int subbook_index;
EB_Position text_position;
char text[MAXLEN_TEXT + 1];
ssize_t text_length;
int text_count;
int i;
/* コマンド行引数をチェック。*/
if (argc != 4) {
fprintf(stderr, "Usage: %s book-path subbook-index number\n",
argv[0]);
exit(1);
}
text_count = atoi(argv[3]);
/* EB ライブラリと `book' を初期化。*/
eb_initialize_library();
eb_initialize_book(&book);
/* 書籍を `book' に結び付ける。*/
error_code = eb_bind(&book, argv[1]);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to bind the book, %s: %s\n",
argv[0], eb_error_message(error_code), argv[1]);
goto die;
}
/* 副本の一覧を取得。*/
error_code = eb_subbook_list(&book, subbook_list, &subbook_count);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get the subbbook list, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* 副本のインデックスを取得。*/
subbook_index = atoi(argv[2]);
/*「現在の副本 (current subbook)」を設定。*/
error_code = eb_set_subbook(&book, subbook_list[subbook_index]);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to set the current subbook, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* テキストの開始位置を取得。*/
error_code = eb_text(&book, &text_position);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get text information, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* テキストをシーク。*/
error_code = eb_seek_text(&book, &text_position);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to seek text, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
i = 0;
while (i < text_count) {
/* テキストを取得。*/
error_code = eb_read_text(&book, NULL, NULL, NULL, MAXLEN_TEXT,
text, &text_length);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to read text, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
fputs(text, stdout);
if (!eb_is_text_stopped(&book))
continue;
fputs("\n----------------------------------------\n", stdout);
/* 次の単語の説明へ移動。*/
error_code = eb_forward_text(&book, NULL);
if (error_code == EB_ERR_END_OF_CONTENT)
fputs("\n[END]\n", stdout);
else if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to read text, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
i++;
}
/* 書籍と EB ライブラリの利用を終了。*/
eb_finalize_book(&book);
eb_finalize_library();
exit(0);
/* エラー発生で終了するときの処理。*/
die:
eb_finalize_book(&book);
eb_finalize_library();
exit(1);
}
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="text-data-types">データ型の詳細</a></h3>
<p>
この節で説明しているデータ型を使うには、次のようにヘッダファイルを
読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/eb.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Hook_Code"><code>EB_Hook_Code</code> 型</a></h4>
<p>
データ型 <code>EB_Hook_Hook</code> は、フックの設定位置コードを表します。
</p>
<p>
この型は符合付き整数型の別名として定義されていますので、2 つのコードを
2 項演算子 <code>==</code> と <code>!=</code> で一致比較することができます。
</p>
<p>
EB ライブラリでは、全部で <code>EB_NUMBER_OF_HOOKS</code> 個のフックコード
を定義しています。
定義されている設定位置コードの一覧については、
次の節 (<a href="#hook-code-list">「フックコードの一覧」</a> を参照のこと)
を参照して下さい。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Hook"><code>EB_Hook</code> 型</a></h4>
<p>
データ型 <code>EB_Hook</code> は、フックコードとそれに対応するフック関数
の組を表します。
内部構造は、次のように定義されています。
</p>
<blockquote class="program">
<pre>
typedef struct EB_Hook_Struct EB_Hook;
struct EB_Hook_Struct {
EB_Hook_Code code;
EB_Error_Code (*FUNC)(EB_Book *, EB_Appendix *, void *,
EB_Hook_Code, int, const unsigned int *);
};
</pre>
</blockquote>
<p>
アプリケーションプログラムは、直接 <code>EB_Hook</code> オブジェクトの
メンバを参照したり、セットしたりしても構いません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Hookset"><code>EB_Hookset</code> 型</a></h4>
<p>
データ型 <code>EB_Hookset</code> は、フック一式を表します。
EB ライブラリで利用可能なすべてのフック設定位置に対して、どのような
フック関数を指定するのかを記録するための型です。
</p>
<p>
<code>EB_Hookiset</code> オブジェクトの操作は、すべて EB ライブラリが用意
している関数で行います。
アプリケーションプログラムは、直接 <code>EB_Hookset</code> オブジェクトの
メンバを参照したり、セットしたりすべきではありません。
</p>
<p>
<code>EB_Hookset</code> オブジェクトを使用する際は、まずそのオブジェクトに
対して <code>eb_initialize_hookset()</code> を呼んで初期化しなくては
なりません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="hook-function-details">フック関数の詳細</a></h3>
<p>
この節では、フック関数の仕様について記します。
</p>
<p>
まず、フック関数を呼び出す <code>eb_read_text()</code> および
<code>eb_read_heading()</code> のプロトタイプは次のようになっています。
</p>
<blockquote class="program">
<pre>
EB_Error_Code
eb_read_text(EB_Book *book, EB_Appendix *appendix,
EB_Hookset *hookset, void *container, size_t text_max_length,
char *text, ssize_t *text_length)
</pre>
</blockquote>
<p>
一方、フック関数のプロトタイプは、次のようになっています。
</p>
<blockquote class="program">
<pre>
EB_Error_Code
hook_function(EB_Book *book, EB_Appendix *appendix, void *container,
EB_Hook_Code code, int argc, const unsigned int *argv);
</pre>
</blockquote>
<p>
引数 <var>book</var>, <var>appendix</var>, <var>container</var> は、
<code>eb_read_text()</code> あるいは <code>eb_read_heading()</code> に
渡された値がそのままフック関数にも渡ってきます。
</p>
<p>
<var>appendix</var> というのは、書籍に対する補助データを提供するオブジェクト
です
(appendix (付録) について詳しくは
<a href="ebappendix.html">ebappendix コマンドのマニュアル</a>
の「appendix (付録) とは」を参照のこと)。
<p>
引数 <var>container</var> は、アプリケーションプログラムからフック関数に
何かデータを渡したいときに使います。
</p>
<p>
最後の <var>argc</var> と <var>argv</var> には、加工前のテキストデータが
渡されます。
文字に対するフックでは、文字コード番号が渡ってきます。
エスケープシーケンスに対するフックでは、そのシーケンス自体のコード
(<samp>1f</samp> で始まるコード) と、もしあればエスケープシーケンスへの
引数をが渡ってきます。
個々のフックにおいて、<var>argc</var> と <var>argv</var> にどうような値が
渡ってくるのか、詳しくは <a href="#hook-code-list">「フックコードの一覧」</a> を参照のこと。
</p>
<p>
フック関数の中から次に挙げる関数を呼び出すことで、テキストデータへの
書き込みを行うことができます。
</p>
<ul>
<li><code>eb_write_text()</code>
<li><code>eb_write_text_string()</code>
<li><code>eb_write_text_byte1()</code>
<li><code>eb_write_text_byte2()</code>
</ul>
<p>
これらの関数の仕様に関して詳しくは
<a href="#text-data-functions">「[テキストデータ] 関数の詳細」</a> を参照のこと。
</p>
<p>
フック関数が <code>EB_SUCCESS</code> 以外の値を返すと、フック関数を
呼び出した <code>eb_read_text()</code>, <code>eb_read_heading()</code>
はエラーが発生したものと見なし、そのエラーコードをそのまま
アプリケーションプログラムに返します。
</p>
<p>
フック関数の中では、<var>book</var> に対して以下の関数を呼び出しては
いけません。
呼び出したときの動作は、未定義です。
</p>
<ul>
<li><code>eb_seek_text()</code>
<li><code>eb_read_text()</code>
<li><code>eb_read_heading()</code>
<li><code>eb_read_rawtext()</code>
<li><code>eb_forward_text()</code>
<li><code>eb_backward_text()</code>
<li><code>eb_set_subbook()</code>
<li><code>eb_unset_subbook()</code>
<li><code>eb_load_all_subbook()</code>
<li><code>eb_bind()</code>
<li><code>eb_finalize_book()</code>
<li><code>eb_finalize_library()</code>
</ul>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="hook-code-list">フックコードの一覧</a></h3>
<p>
この節で説明しているフックコードを使うには、次のようにヘッダファイルを
読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/text.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_NULL">定数 <code>EB_HOOK_NULL</code></a></h4>
<p>
<code>EB_HOOK_NULL</code> は厳密にはフックではなく、
<code>eb_set_hooks()</code> で複数のフック関数を登録する際に、
<code>EB_Hook</code> 配列の末尾の要素を示すために用います。
このフックコードに対して、フック関数は登録できません。
</p>
<p>
詳しくは、<a href="#text-data-functions">「[テキストデータ] フック関数の詳細」</a> を参照のこと。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_INITIALIZE">定数 <code>EB_HOOK_INITIALIZE</code></a></h4>
<p>
<code>EB_HOOK_INITIALIZE</code> は、<code>eb_seek_text()</code> を
呼び出した直後の最初の <code>eb_read_text()</code>,
<code>eb_read_heading()</code> の呼び出し時に処理されます。
何か初期化処理をしたいときに、使うと良いでしょう。
</p>
<p>
このフックが、フック関数に渡す <code>argc</code> は 0 です。
フック関数を登録していない状態では、このフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_NARROW">定数 <code>EB_HOOK_BEGIN_NARROW</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_NARROW">定数 <code>EB_HOOK_END_NARROW</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_NARROW</code> および <code>EB_HOOK_END_NARROW</code>
は、半角表示の開始と終了を表すエスケープシーケンスに対するフックです。
</p>
<p>
どちらのフックも、フック関数に渡す <code>argc</code> は 1 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<code>EB_HOOK_BEGIN_NARROW</code> なら <samp>0x1f04</samp>、
<code>EB_HOOK_END_NARROW</code> なら <samp>0x1f05</samp> になります。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_SUBSCRIPT">定数 <code>EB_HOOK_BEGIN_SUBSCRIPT</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_SUBSCRIPT">定数 <code>EB_HOOK_END_SUBSCRIPT</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_SUBSCRIPT</code> および
<code>EB_HOOK_END_SUBSCRIPT</code> は、下付き表示の開始と終了を表す
エスケープシーケンスに対するフックです。
</p>
<p>
どちらのフックも、フック関数に渡す <code>argc</code> は 1 です。
<code>argv[0]</code> の値はエスケープシーケンスのコードそのもので、
<code>EB_HOOK_BEGIN_SUBSCRIPT</code> なら <samp>0x1f06</samp>、
<code>EB_HOOK_END_SUBSCRIPT</code> なら <samp>0x1f07</samp> になります。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに
何も書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_SET_INDENT">定数 <code>EB_HOOK_SET_INDENT</code></a></h4>
<p>
<code>EB_HOOK_SET_INDENT</code> は、テキストデータの行頭の字下げ指定を
表すエスケープシーケンスに対するフックです。
</p>
<p>
このフックが、フック関数に渡す <code>argc</code> は 2 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f09</samp> になります。
<code>argv[1]</code> が、字下げの量を表します。
</p>
<p>
字下げの量の単位が、何であるのかは不明です。
また、字下げ量の最小値は、0 の場合と 1 の場合の二通りがあります。
いずれにしろ、字下げは 1 ずつ増えたり減ったりします。
</p>
<p>
フック関数を登録していない状態では、このフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_NEWLINE">定数 <code>EB_HOOK_NEWLINE</code></a></h4>
<p>
<code>EB_HOOK_SET_NEWLINE</code> は、改行を表すエスケープシーケンスに
対するフックです。
</p>
<p>
ただし、<code>eb_read_heading()</code> (見出しの読み込み) による処理では、
改行を表すエスケープシーケンスは区切りコードとしても扱われます。
そのため、エスケープシーケンスが見つかってもこのフックの処理は行われず、
ただちに読み込み処理は終了します。
</p>
<p>
このフックが、フック関数に渡す <code>argc</code> は 1 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f0a</samp> になります。
</p>
<p>
フック関数を登録していない状態では、このフックはテキストデータに何も
書き込みませんが、<code>eb_initialize_hookset()</code> で
<code>EB_Hook</code> オブジェクトを初期化すると、フック関数として
<code>eb_hook_newline()</code> が自動的に登録されます。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_SUPERSCRIPT">定数 <code>EB_HOOK_BEGIN_SUPERSCRIPT</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_SUPERSCRIPT">定数 <code>EB_HOOK_END_SUPERSCRIPT</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_SUPERSCRIPT</code> および
<code>EB_HOOK_END_SUPERSCRIPT</code> は、上付き表示の開始と終了を表す
エスケープシーケンスに対するフックです。
</p>
<p>
どちらのフックも、フック関数に渡す <code>argc</code> は 1 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<code>EB_HOOK_BEGIN_SUPERSCRIPT</code> なら <samp>0x1f0e</samp>、
<code>EB_HOOK_END_SUPERSCRIPT</code> なら <samp>0x1f0f</samp> になります。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_NO_NEWLINE">定数 <code>EB_HOOK_BEGIN_NO_NEWLINE</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_NO_NEWLINE">定数 <code>EB_HOOK_END_NO_NEWLINE</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_NO_NEWLINE</code> および
<code>EB_HOOK_END_NO_NEWLINE</code> は、改行禁止の開始と終了を表す
エスケープシーケンスに対するフックです。
</p>
<p>
どちらのフックも、フック関数に渡す <code>argc</code> は 1 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<code>EB_HOOK_BEGIN_NO_NEWLINE</code> なら <samp>0x1f10</samp>、
<code>EB_HOOK_END_NO_NEWLINE</code> なら <samp>0x1f11</samp> になります。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_EMPHASIS">定数 <code>EB_HOOK_BEGIN_EMPHASIS</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_EMPHASIS">定数 <code>EB_HOOK_END_EMPHASIS</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_EMPHASIS</code> および <code>EB_HOOK_END_EMPHASIS</code>
は、強調表示の開始と終了を表すエスケープシーケンスに対するフックです。
</p>
<p>
どちらのフックも、フック関数に渡す <code>argc</code> は 1 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<code>EB_HOOK_BEGIN_EMPHASIS</code> なら <samp>0x1f12</samp>、
<code>EB_HOOK_END_EMPHASIS</code> なら <samp>0x1f13</samp> になります。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_CANDIDATE">定数 <code>EB_HOOK_BEGIN_CANDIDATE</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_CANDIDATE_LEAF">定数 <code>EB_HOOK_END_CANDIDATE_LEAF</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_CANDIDATE_GROUP">定数 <code>EB_HOOK_END_CANDIDATE_GROUP</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_CANDIDATE</code> は、複合検索の候補となる語の開始を
表すエスケープシーケンスに対するフックです。
</p>
<p>
それに対して、終了を表すエスケープシーケンスに対するフックは 2 種類
あります。
一つは <code>EB_HOOK_END_CANDIDATE_LEAF</code> で、候補となる語が実際に
検索の入力語として使えるものであることを示します。
もう一つは <code>EB_HOOK_END_CANDIDATE_GROUP</code> で、候補となる語は
さらに細かい選択肢に分かれていることを示します。
(したがって、候補となる語を検索の入力語として使うことはできません。)
</p>
<p>
フック <code>EB_HOOK_BEGIN_CANDIDATES</code> が、フック関数に渡す
<code>argc</code> は 1 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f43</samp> になります。
</p>
<p>
フック <code>EB_HOOK_END_CANDIDATE_LEAF</code> および
<code>EB_HOOK_END_CANDIDATE_GROUP</code> が、フック関数に渡す
<code>argc</code> は 3 です。
どちらのフックも、<code>argv[0]</code> はエスケープシーケンスのコード
そのもので、<samp>0x1f63</samp> になります。
フック <code>EB_HOOK_END_CANDIDATE_GROUP</code> の <code>argv[1]</code>
と <code>argv[2]</code> は、次の階層の候補一覧データの開始ページ番号と
オフセットです。
これは、<code>EB_Position</code> オブジェクト
(<a href="#search-data-types">「[検索] データ型の詳細」</a> を参照のこと)
の <code>page</code> および <code>offset</code> メンバの値に相当します。
フック <code>EB_HOOK_END_CANDIDATE_LEAF</code> では、<code>argv[1]</code>,
<code>argv[2]</code> は 2 つとも 0 になっています。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_REFERENCE">定数 <code>EB_HOOK_BEGIN_REFERENCE</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_REFERENCE">定数 <code>EB_HOOK_END_REFERENCE</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_REFERENCE</code> および
<code>EB_HOOK_END_REFERENCE</code> は、別位置のテキストデータの参照開始と
終了を表すエスケープシーケンスに対するフックです。
</p>
<p>
フック <code>EB_HOOK_BEGIN_REFERENCE</code> が、フック関数に渡す
<code>argc</code> は 2 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f42</samp> になります。
<code>argv[1]</code> の意味は不明です。
</p>
<p>
<code>EB_HOOK_END_REFERENCE</code> が、フック関数に渡す <code>argc</code>
は 3 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f62</samp> になります。
<code>argv[1]</code> と <code>argv[2]</code> は、参照先のページ番号と
オフセットです。
これは、<code>EB_Position</code> オブジェクト
(<a href="#search-data-types">「[検索] データ型の詳細」</a> を参照のこと)
の <code>page</code> および <code>offset</code> メンバの値に相当します。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_KEYWORD">定数 <code>EB_HOOK_BEGIN_KEYWORD</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_KEYWORD">定数 <code>EB_HOOK_END_KEYWORD</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_KEYWORD</code> および <code>EB_HOOK_END_KEYWORD</code> は、
検索キーの開始と終了を表すエスケープシーケンスに対するフックです。
</p>
<p>
フック <code>EB_HOOK_BEGIN_KEYWORD</code> が、フック関数に渡す
<code>argc</code> は 2 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f41</samp> になります。
<code>argv[1]</code> の意味は不明です。
</p>
<p>
<code>EB_HOOK_END_KEYWORD</code> は、フック関数に 1 個の引数を渡します。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f61</samp> になります。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_DECORATION">定数 <code>EB_HOOK_BEGIN_DECORATION</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_DECORATION">定数 <code>EB_HOOK_END_DECORATION</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_DECORATION</code> および
<code>EB_HOOK_END_DECORATION</code> は、文字修飾の開始と終了を表す
エスケープシーケンスに対するフックです。
</p>
<p>
フック <code>EB_HOOK_BEGIN_DECORATION</code> が、フック関数に渡す
<code>argc</code> は 2 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1fe0</samp> になります。
<code>argv[1]</code> の意味は不明です。
</p>
<p>
<code>EB_HOOK_END_KEYWORD</code> は、フック関数に 1 個の引数を渡します。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1fe1</samp> になります。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_NARROW_FONT">定数 <code>EB_HOOK_NARROW_FONT</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_WIDE_FONT">定数 <code>EB_HOOK_WIDE_FONT</code></a></h4>
<p>
<code>EB_HOOK_NARROW_FONT</code> および <code>EB_HOOK_WIDE_FONT</code> は、
それぞれ半角外字と全角外字に対するフックです。
</p>
<p>
どちらのフックも、フック関数に渡す <code>argc</code> は 1 です。
<code>argv[0]</code> は、外字の文字番号を表します。
</p>
<p>
フック関数を登録していない状態では、このフックはテキストデータに何も
書き込みませんが、<code>eb_initialize_hookset()</code> で
<code>EB_Hook</code> オブジェクトを初期化すると、フック関数として
<code>eb_hook_narrow_character_text()</code> および
<code>eb_hook_wide_character_text()</code> が自動的に登録されます。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_ISO8859_1">定数 <code>EB_HOOK_ISO8859_1</code></a></h4>
<p>
<code>EB_HOOK_ISO8859_1</code> は、ISO 8859-1 (ラテン文字 1) 文字に対する
フックです。
</p>
<p>
このフックが、フック関数に渡す <code>argc</code> は 1 です。
<code>argv[0]</code> は、ISO 8859-1 の文字番号を表します。
</p>
<p>
フック関数を登録していない状態では、<code>argv[0]</code> の値をそのまま
テキストデータに書き込みます。
つまり、文字はそのまま ISO 8859-1 として、1 バイト書き込まれます。
</p>
<p>
このフックが利用されるのは、処理中の書籍の文字コードが
<code>EB_CHARCODE_ISO8859_1</code> の場合だけです。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_NARROW_JISX0208">定数 <code>EB_HOOK_NARROW_JISX0208</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_WIDE_JISX0208">定数 <code>EB_HOOK_WIDE_JISX0208</code></a></h4>
<p>
<code>EB_HOOK_NARROW_JISX0208</code> と <code>EB_HOOK_WIDE_JISX0208</code>
は、半角および全角の JIS X 0208 (日本語のかな漢字) 文字に対するフックです。
</p>
<p>
どちらのフックも、フック関数に渡す <code>argc</code> は 1 です。
<code>argv[0]</code> は、JIS X 0208 の文字を日本語 EUC で表現したときの
文字番号を表します。
</p>
<p>
フック関数を登録していない状態では、<code>argv[0]</code> の値をそのまま
テキストデータに書き込みます。
つまり、文字はそのまま日本語 EUC として、2 バイト書き込まれます。
</p>
<p>
このフックが利用されるのは、
処理中の書籍の文字コードが <code>EB_CHARCODE_JISX0208</code> か
<code>EB_CHARCODE_JISX0208_GB2312</code> の場合だけです。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_GB2312">定数 <code>EB_HOOK_GB2312</code></a></h4>
<p>
<code>EB_HOOK_GB2312</code> は、GB 2312 (中国語の簡体字) 文字に対する
フックです。
</p>
<p>
このフックが、フック関数に渡す <code>argc</code> は 1 です。
<code>argv[0]</code> は、GB 2312 の文字を中国語 EUC で表現したときの
文字番号を表します。
</p>
<p>
フック関数を登録していない状態では、<code>argv[0]</code> の値をそのまま
テキストデータに書き込みます。
つまり、文字はそのまま中国語 EUC として、2 バイト書き込まれます。
</p>
<p>
このフックが利用されるのは、処理中の書籍の文字コードが
<code>EB_CHARCODE_JISX0208_GB2312</code> の場合だけです。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_MONO_GRAPHIC">定数 <code>EB_HOOK_BEGIN_MONO_GRAPHIC</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_MONO_GRAPHIC">定数 <code>EB_HOOK_END_MONO_GRAPHIC</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_MONO_GRAPHIC</code> および
<code>EB_HOOK_END_MONO_GRAPIHC</code> は、モノクロ図版の開始と終了を
表すエスケープシーケンスに対するフックです。
</p>
<p>
フック <code>EB_HOOK_BEGIN_MONO_GRAPHIC</code> が、フック関数に渡す
<code>argc</code> は 4 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f32</samp> か <samp>0x1f44</samp> のいずれかになります。
<code>argv[2]</code> と <code>argv[3]</code> は、図版の高さと幅
(ピクセル数) を意味します。
ただし、電子ブックのモノクロ図版 (最初の引数が <samp>0x1f32</samp> の
場合) には、図版の高さと幅の情報が欠けているので、値はどちらも 0 に
なります。
<code>argv[1]</code> の意味は不明です。
</p>
<p>
<code>EB_HOOK_END_MONO_GRAPHIC</code> が、フック関数に渡す
<code>argc</code> は 3 です。
<code>argv[0]</code> は、エスケープシーケンスのコードそのものです。
<code>EB_HOOK_BEGIN_MONO_GRAPHIC</code> の <code>argv[0]</code> が
<samp>0x1f32</samp> なら、<code>EB_HOOK_END_MONO_GRAPHIC</code> の
<code>argv[0]</code> は <samp>0x1f52</samp> になり、<samp>0x1f44</samp>
なら <samp>0x1f64</samp> になります。
<code>argv[1]</code> と <code>argv[2]</code> は、図版データのページ番号
とオフセットです。
これは、<code>EB_Position</code> オブジェクト
(<a href="#search-data-types">「[検索] データ型の詳細」</a> を参照のこと)
の <code>page</code> および <code>offset</code> メンバの値に相当します。
</p>
<p>
図版データの取り出し方については、<a href="#monochrome-image">「モノクロ図版」</a>
を参照してください。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_GRAY_GRAPHIC">定数 <code>EB_HOOK_BEGIN_GRAY_GRAPHIC</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_GRAY_GRAPHIC">定数 <code>EB_HOOK_END_GRAY_GRAPHIC</code></a></h4>
<p>
これらのフック名称は、グレースケール図版のために予約されていますが、
本バージョンの EB ライブラリではまだ対応していません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_COLOR_BMP">定数 <code>EB_HOOK_BEGIN_COLOR_BMP</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_COLOR_JPEG">定数 <code>EB_HOOK_BEGIN_COLOR_JPEG</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_COLOR_GRAPHIC">定数 <code>EB_HOOK_END_COLOR_GRAPHIC</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_COLOR_BMP</code> と <code>EB_HOOK_COLOR_JPEG</code>
は、それぞれ BMP 形式と JPEG 形式のカラー図版の開始を表す
エスケープシーケンスに対するフックです。
開始のフックは BMP と JPEG とでフックが分かれていますが、終了の
フックは共通で、<code>EB_HOOK_END_COLOR_GRAPIHC</code> になります。
</p>
<p>
フック <code>EB_HOOK_BEGIN_COLOR_BMP</code> と
<code>EB_HOOK_COLOR_JPEG</code> が、フック関数に渡す <code>argc</code> は
4 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f4d</samp> になります。
<code>argv[2]</code> と <code>argv[3]</code> は、図版の幅と高さ
(ピクセル数) を意味します。
<code>argv[1]</code> の意味は不明です。
</p>
<p>
フック <code>EB_HOOK_END_COLOR_BMP</code> が、フック関数に渡す
<code>argc</code> は 3 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f6d</samp> になります。
<code>argv[1]</code> と <code>argv[2]</code> は、図版データのページ番号
とオフセットです。
これは、<code>EB_Position</code> オブジェクト
(<a href="#search-data-types">「[検索] データ型の詳細」</a> を参照のこと)
の <code>page</code> および <code>offset</code> メンバの値に相当します。
</p>
<p>
図版データの取り出し方については、<a href="#color-image">「カラー図版」</a>
を参照してください。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_IN_COLOR_BMP">定数 <code>EB_HOOK_BEGIN_IN_COLOR_BMP</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_IN_COLOR_JPEG">定数 <code>EB_HOOK_BEGIN_IN_COLOR_JPEG</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_IN_COLOR_GRAPHIC">定数 <code>EB_HOOK_END_IN_COLOR_GRAPHIC</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_IN_COLOR_BMP</code> と <code>EB_HOOK_IN_COLOR_JPEG</code> は、
それぞれ BMP 形式と JPEG 形式のインラインカラー図版の開始を表す
エスケープシーケンスに対するフックです。
開始のフックは BMP と JPEG とでフックが分かれていますが、終了の
フックは共通で、<code>EB_HOOK_END_IN_COLOR_GRAPIHC</code> になります。
</p>
<p>
フック <code>EB_HOOK_BEGIN_IN_COLOR_BMP</code> と
<code>EB_HOOK_IN_COLOR_JPEG</code> が、フック関数に渡す <code>argc</code>
は 4 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f3c</samp> になります。
<code>argv[2]</code> と <code>argv[3]</code> は、図版の幅と高さ
(ピクセル数) を意味します。
<code>argv[1]</code> の意味は不明です。
</p>
<p>
フック <code>EB_HOOK_END_IN_COLOR_BMP</code> が、フック関数に渡す
<code>argc</code> は 3 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f5c</samp> になります。
<code>argv[1]</code> と <code>argv[2]</code> は、図版データのページ番号と
オフセットです。
これは、<code>EB_Position</code> オブジェクト
(<a href="#search-data-types">「[検索] データ型の詳細」</a> を参照のこと)
の <code>page</code> および <code>offset</code> メンバの値に相当します。
</p>
<p>
図版データの取り出し方については、<a href="#color-image">「カラー図版」</a>
を参照してください。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_CLICKABLE_AREA">定数 <code>EB_HOOK_BEGIN_CLICKABLE_AREA</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_CLICKABLE_AREA">定数 <code>EB_HOOK_END_CLICKABLE_AREA</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_CLICKABLE_AREA</code> は、カラー図版およびインラインカラー図版内の特定矩形領域に対して、参照先情報を表現した開始エスケープシーケンスに対するフックです。
同様に、<code>EB_HOOK_END_CLICKABLE_AREA</code> は終了エスケープシーケンスに対するフックです。
</p>
<p>
フック <code>EB_HOOK_BEGIN_CLICKABLE_AREA</code> が、フック関数に渡す
<code>argc</code> は 7 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f4f</samp> になります。
<code>argv[1]</code> と <code>argv[2]</code> は、それぞれ矩形領域の開始
x, y 座標を表します。
それぞれ矩形領域の開始 x, y 座標を表します。
カラー図版の左上の座標が (0, 0) です。
同様に、<code>argv[3]</code> と <code>argv[4]</code> が図版の右方向への
幅と、下方向への高さを表します。
最後の <code>argv[5]</code> と <code>argv[6]</code> が参照先のページ番号
とオフセットとなります。
</p>
<blockquote>
<pre>
参照先付きカラー図版
（０，０）
┌─────────────────────┐
│ │
│（ｘ，ｙ） │
│ ┌ ─ ─ ─ ─ ─ ─ ┐ │
│ │ 高さ↑ │ │
│ │ │
│ │ 矩形領域 │ │ │
│ │ │
│ │ │ │ │
│ 幅 │ │
│ │←──────────┼→│ │
│ ↓ │
│ └ ─ ─ ─ ─ ─ ─ ┘ │
│ │
└─────────────────────┘
</pre>
</blockquote>
<p>
<code>EB_HOOK_END_CLICKABLE_AREA</code> が、フック関数に渡す
<code>argc</code> は 1 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f6f</samp> になります。
</p>
<p>
参照先情報の取り出し方については、
<a href="#clickable-color-image">「参照先付きカラー図版」</a>
を参照して下さい。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_WAVE">定数 <code>EB_HOOK_BEGIN_WAVE</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_WAVE">定数 <code>EB_HOOK_END_WAVE</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_WAVE</code> および <code>EB_HOOK_END_WAVE</code> は、
WAVE (PCM) 形式の音声データの開始と終了を表すエスケープシーケンスに対する
フックです。
</p>
<p>
フック <code>EB_HOOK_BEGIN_WAVE</code> が、フック関数に渡す
<code>argc</code> は 6 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f4a</samp> になります。
<code>argv[2]</code> と <code>argv[3]</code> は音声データの開始位置の
ページ番号とオフセット、<code>argv[4]</code> と <code>argv[5]</code> は
終了位置のページ番号とオフセットをそれぞれ表します。
<code>argv[1]</code> の意味は不明です。
</p>
<p>
<code>EB_HOOK_END_WAVE</code> が、フック関数に渡す <code>argc</code> は
1 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f6a</samp> になります。
</p>
<p>
音声データの取り出し方については、<a href="#wave-sound">「WAVE 音声」</a>
を参照して下さい。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_BEGIN_MPEG">定数 <code>EB_HOOK_BEGIN_MPEG</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HOOK_END_MPEG">定数 <code>EB_HOOK_END_MPEG</code></a></h4>
<p>
<code>EB_HOOK_BEGIN_MPEG</code> および <code>EB_HOOK_END_MPEG</code> は、
MPEG 形式の動画データの開始と終了を表すエスケープシーケンスに対するフック
です。
</p>
<p>
フック <code>EB_HOOK_BEGIN_MPEG</code> が、フック関数に渡す
<code>argc</code> は 6 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f39</samp> になります。
<code>argv[2]</code> 〜 <code>argv[5]</code> は、動画データのファイル名を
エンコードした数値列になります。
<code>argv[1]</code> の意味は不明です。
</p>
<p>
<code>EB_HOOK_END_MPEG</code> が、フック関数に渡す <code>argc</code> は
1 です。
<code>argv[0]</code> はエスケープシーケンスのコードそのもので、
<samp>0x1f59</samp> になります。
</p>
<p>
動画データの取り出し方については、<a href="#mpeg-movie">「MPEG 動画」</a>
を参照して下さい。
</p>
<p>
フック関数を登録していない状態では、これらのフックはテキストデータに何も
書き込みません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="hookset-access-functions">フックセット操作関数の詳細</a></h3>
<p>
この節で説明している関数を使うには、次のようにヘッダファイルを読み込んで
下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/text.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:initialize_hookset"><code>void eb_initialize_hookset (EB_Hookset *<var>hookset</var>)</code></a></h4>
<p>
関数 <code>initialize_hookset()</code> は、<var>hookset</var> の指す
<code>EB_Hookset</code> オブジェクトを初期化します。
<code>EB_Hookiset</code> オブジェクトに対して EB ライブラリの他の関数を
呼ぶ前に、
必ずそのオブジェクトを初期化しなくてはなりません。
初期化していないオブジェクトに対して、EB ライブラリの他の関数を呼んだ
場合の動作は未定義です。
また、すでに初期化したオブジェクトに対して、再度
<code>eb_initialize_hookset()</code> を呼んではいけません。
呼んだ場合の動作は未定義です。
</p>
<p>
この関数は、各フックの初期値を次のようにセットします。
</p>
<table summary="各フックの初期値">
<tr>
<td>フック
<td>フック関数
</tr>
<tr>
<td><code>EB_HOOK_NARROW_JISX0208</code>
<td><code>eb_hook_euc_to_ascii()</code>
</tr>
<tr>
<td><code>EB_HOOK_NARROW_FONT</code>
<td><code>eb_hook_narrow_character_text()</code>
</tr>
<tr>
<td><code>EB_HOOK_WIDE_FONT</code>
<td><code>eb_hook_wide_character_text()</code>
</tr>
<tr>
<td><code>EB_HOOK_NEWLINE</code>
<td><code>eb_hook_newline()</code>
</tr>
<tr>
<td>上記以外のフック
<td> <code>NULL</code> (フック関数なし)
</tr>
</table>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:finalize_hookset"><code>EB_Error_Code eb_finalize_hookset (EB_Hookset *<var>hookset</var>)</code></a></h4>
<p>
関数 <code>eb_finalize_hookset()</code> は、<var>hookset</var> が指す
<code>EB_Hooksest</code> オブジェクトの後始末を行います。
</p>
<p>
オブジェクトが割り当てて管理していたメモリは、すべて解放されます。
すべてのフックには、フック関数として <code>NULL</code> がセットされます。
</p>
<p>
後始末をしたオブジェクトに対して <code>eb_set_hook()</code>, <code>eb_set_hooks()</code>
を呼ぶことで、オブジェクトを再利用することができます。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:set_hook"><code>EB_Error_Code eb_set_hook (EB_Hookset *<var>hookset</var>, const EB_Hook *<var>hook</var>)</code></a></h4>
<p>
関数 <code>eb_set_hook()</code> は、<var>hookset</var> が指す <code>EB_Hooksest</code>
オブジェクトに、フック関数を一つ登録します。
登録するフックの種類とフック関数は、<var>hook</var> で指定します。
</p>
<p>
同じフックコードに複数回フック関数を登録しても、有効になるのは最後に
登録したものだけですので、注意して下さい。
フック関数として <code>NULL</code> を指定すると、登録されているフックが
解除されます。
</p>
<p>
成功すると、この関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因を示すエラーコードを返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:set_hooks"><code>EB_Error_Code eb_set_hooks (EB_Hookset *<var>hookset</var>, const EB_Hook *<var>hooks</var>)</code></a></h4>
<p>
この関数は <code>eb_set_hook()</code> に似ていますが、任意の個数の
フック関数を一度に登録できる点が異なります。
</p>
<p>
登録するフックの種類とフック関数は、<var>hooks</var> で指定します。
<var>hooks</var> は <code>EB_Hook</code> オブジェクトの配列 (の先頭) を
指していなければなりません。
また、この配列の末尾には、フックコード <code>EB_HOOK_NULL</code> をセット
した <code>EB_Hook</code> オブジェクトを配列要素として置く必要があります。
</p>
<p>
<code>eb_set_hooks()</code> は、配列の先頭から順番に、指定されたフックコード
に対してフック関数を登録していきます。
エラーが発生すると、残りのフックの登録はせずに、原因を示すエラーコード
をただちに返します。
すべてのフック関数の登録に成功すると、<code>EB_SUCCESS</code> を返します。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="builtin-hook-functions">組み込みフック関数の詳細</a></h3>
<p>
EB ライブラリは、基本的なフック関数をいくつか用意しています。
本節では、これらのフック関数についての仕様を解説します。
</p>
<p>
この節で説明している関数を使うには、次のようにヘッダファイルを読み込んで
下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/text.h>
</pre>
</blockquote>
<p>
いずれのフック関数も、引数 <var>appendix</var> と <var>container</var> に
<code>NULL</code> を渡されても、動作に支障はないようになっています。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:hook_euc_to_ascii"><code>EB_Error_Code eb_hook_euc_to_ascii (EB_Book *<var>book</var>, EB_Appendix *<var>appendix</var>, void *<var>container</var>, EB_Hook_Code <var>code</var>, int <var>argc</var>, const unsigned int *<var>argv</var>)</code></a></h4>
<p>
<code>eb_hook_euc_to_ascii()</code> は、フックコード
<code>EB_HOOK_NARROW_JISX0208</code> (半角 JIS X 0208 文字) のための
フック関数です。
</p>
<p>
<code>EB_Hookset</code> オブジェクトを関数
<code>eb_initialiez_hookset()</code> で初期化すると、この関数が自動的に
登録されます。
</p>
<p>
このフック関数は、<code>argv[0]</code> として渡された JIS X 0208 の文字
(エンコーディングは日本語 EUC) を調べ、対応する ASCII 文字が存在すれば
その ASCII 文字をテキストデータとして書き込み、なければ JIS X 0208 の
文字をそのまま書き込みます。
</p>
<p>
常に <code>EB_SUCCESS</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:hook_narrow_character_text"><code>EB_Error_Code eb_hook_narrow_character_text (EB_Book *<var>book</var>, EB_Appendix *<var>appendix</var>, void *<var>container</var>, EB_Hook_Code <var>code</var>, int <var>argc</var>, const unsigned int *<var>argv</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:hook_wide_character_text"><code>EB_Error_Code eb_hook_wide_character_text (EB_Book *<var>book</var>, EB_Appendix *<var>appendix</var>, void *<var>container</var>, EB_Hook_Code <var>code</var>, int <var>argc</var>, const unsigned int *<var>argv</var>)</code></a></h4>
<p>
<code>eb_hook_narrow_character_text()</code> は、フックコード
<code>EB_HOOK_NARROW_FONT</code> (半角外字) のためのフック関数です。
同様に <code>eb_hook_wide_character_text()</code> は、フックコード
<code>EB_HOOK_WIDE_FONT</code> (全角外字) のためのフック関数です。
</p>
<p>
<code>EB_Hookset</code> オブジェクトを関数
<code>eb_initialiez_hookset()</code> で初期化すると、これらの関数が自動的
に登録されます。
</p>
<p>
この関数は、<var>appendix</var> の選択中している副本が、
<code>argv[0]</code> として渡された外字の代替文字列を持っているかどうか
調べます。
持っていればその文字列をテキストデータとして書き込み、持っていなければ
<samp><?></samp> という文字列を書き込みます。
</p>
<p>
<var>appendix</var> が <code>NULL</code> の場合や、付録が副本を選択中で
ない場合も、代替文字列を持っていないものとして扱います。
</p>
<p>
この関数は、常に <code>EB_SUCCESS</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:hook_newline"><code>EB_Error_Code eb_hook_newline (EB_Book *<var>book</var>, EB_Appendix *<var>appendix</var>, void *<var>container</var>, EB_Hook_Code <var>code</var>, int <var>argc</var>, const unsigned int *<var>argv</var>)</code></a></h4>
<p>
<code>eb_hook_narrow_newline()</code> は、フックコード
<code>EB_HOOK_NEWLINE</code> (改行) のためのフック関数です。
</p>
<p>
<code>EB_Hookset</code> オブジェクトを関数
<code>eb_initialiez_hookset()</code> で初期化すると、これらの関数が自動的
に登録されます。
</p>
<p>
この関数は、テキストデータに <samp>\n</samp> を書き込みます。
常に <code>EB_SUCCESS</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:hook_empty"><code>EB_Error_Code eb_hook_empty (EB_Book *<var>book</var>, EB_Appendix *<var>appendix</var>, void *<var>container</var>, EB_Hook_Code <var>code</var>, int <var>argc</var>, const unsigned int *<var>argv</var>)</code></a></h4>
<p>
<code>eb_hook_empty()</code> は、何もしないフック関数です。
常に <code>EB_SUCCESS</code> を返します。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="text-data-functions">テキストデータ操作関数の詳細</a></h3>
<p>
この節で説明している関数を使うには、次のようにヘッダファイルを読み込んで
下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/text.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_text"><code>int eb_have_text (EB_Book *<var>book</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_menu"><code>int eb_have_menu (EB_Book *<var>book</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_copyright"><code>int eb_have_copyright (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_have_text()</code> は、<var>book</var> の選択している副本が、
本文を持っているかどうかを調べます。
同様に、<code>eb_have_menu()</code> はメニューを持っているかどうか、
<code>eb_have_copyright()</code> は著作権表示を持っているかどうか調べます。
</p>
<p>
いずれの関数も、持っていれば 1 を返し、持っていなければ 0 を返します。
<var>book</var> が副本を選択していない場合も 0 を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:text"><code>EB_Error_Code eb_text (EB_Book *<var>book</var>, EB_Position *<var>position</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:menu"><code>EB_Error_Code eb_menu (EB_Book *<var>book</var>, EB_Position *<var>position</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:copyright"><code>EB_Error_Code eb_copyright (EB_Book *<var>book</var>, EB_Position *<var>position</var>)</code></a></h4>
<p>
関数 <code>eb_text()</code> は、<var>book</var> が選択している副本の本文
の開始位置を <var>position</var> の指す領域に書き込みます。
同様に、<code>eb_menu()</code> はメニューの開始位置を、
<code>eb_have_copyright()</code> は著作権表示の開始位置を書き込みます。
</p>
<p>
成功すると、これらの関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>position</var> に必ずシークが失敗する位置を書き込んで、
原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> 内のいずれかの副本が選択されていなくては
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code>
を返します。
選択中の副本が、対象となるテキストデータを持っていなければ、
<code>EB_ERR_NO_SUCH_SEARCH</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:seek_text"><code>EB_Error_Code eb_seek_text (EB_Book *<var>book</var>, const EB_Position *<var>position</var>)</code></a></h4>
<p>
関数 <code>eb_seek_text()</code> は、<var>book</var> が選択している副本の
テキストデータファイルをシークします。
シーク位置は <var>position</var> で指定します。
このとき、<var>position</var> は常にファイルの先頭からの位置として解釈
されます。
(相対位置へのシーク機能は、EB ライブラリにはありません。)
</p>
<p>
シークを行うと、それまでに行った読み込みの状態記録がリセットされます。
<code>eb_read_text()</code>, <code>eb_read_heading()</code>,
<code>eb_read_rawtext()</code> を用いてテキストデータを読み込むには、
前もってこの関数を呼び出しておく必要があります。
</p>
<p>
成功すると、この関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> 内のいずれかの副本が選択されていなくては
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code>
を返します。
選択中の副本にテキストデータが存在しないときは、<code>EB_ERR_NO_TEXT</code>
を返します。
</p>
<p>
なお、書籍によっては、テキストデータを収めたファイルには他のデータも
一緒に格納されていることがありますが、テキスト以外のデータにアクセス
しても、テキストデータの現在位置、読み込みに関する状態記録は変化しません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:tell_text"><code>EB_Error_Code eb_tell_text (EB_Book *<var>book</var>, EB_Position *<var>position</var>)</code></a></h4>
<p>
関数 <code>eb_seek_text()</code> は、<var>book</var> が選択している副本の
テキストデータファイルの現在のアクセス位置を返します。
</p>
<p>
成功すると、<var>position</var> の指す領域に現在のアクセス位置を書き込み、
<code>EB_SUCCESS</code> を返します。
失敗すると、シークが必ず失敗する位置を書き込み、原因を示すエラーコード
を返します。
</p>
<p>
あらかじめ、<var>book</var> 内のいずれかの副本が選択されていなくては
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code>
を返します。
選択中の副本にテキストデータが存在しないときは、<code>EB_ERR_NO_TEXT</code>
を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:read_text"><code>EB_Error_Code eb_read_text (EB_Book *<var>book</var>, EB_Appendix *<var>appendix</var>, EB_Hookset *<var>hookset</var>, void *<var>container</var>, size_t <var>text_max_length</var>, char *<var>text</var>, ssize_t *<var>text_length</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:read_heading"><code>EB_Error_Code eb_read_heading (EB_Book *<var>book</var>, EB_Appendix *<var>appendix</var>, EB_Hookset *<var>hookset</var>, void *<var>container</var>, size_t <var>text_max_length</var>, char *<var>text</var>, ssize_t *<var>text_length</var>)</code></a></h4>
<p>
関数 <code>eb_read_text()</code> と <code>eb_read_heading()</code> は、
<var>book</var>
が選択している副本のテキストデータファイルの現在のアクセス位置からデータ
を読み込みます。
<code>eb_read_heading()</code> は見出しの読み込みに用い、
<code>eb_read_text()</code> はそれ以外のテキストデータの読み込みに用います。
</p>
<p>
読み込まれたテキストデータは、必要に応じて文字コードの変換
(<a href="#character-code">「文字コード」</a> を参照のこと) が行われた後に、<var>hookset</var>
の指すフックセットにしたがって加工されます。
<var>hookset</var> が <code>NULL</code> のときは、代わりに EB ライブラリ側
で用意している <dfn>標準のフックセット (default hookset)</dfn> が
用いられます。
このフックセットは、<code>eb_initialize_hookset()</code> によって
初期化しただけのフックセットと等価です。
</p>
<p>
フックセットによって加工された後に、テキストデータは <var>text</var> の
指す領域に書き込まれ、書き込んだバイト数が <var>text_length</var> の指す
領域に書き込まれます。
<var>text</var> はナル文字で終端されますが、<var>text_length</var> には
ナル文字の分は勘定に入れません。
テキストデータは、<var>text_max_length</var> で指定されたバイト数を超えて
書き込むことはありません。
ただし、<var>text_max_length</var> にもナル文字の分は勘定に入っていません
ので、<var>text</var> は <var>text_max_length</var> + 1 バイト分のデータ
を格納できる大きさが必要です。
</p>
<p>
どちらの関数も、成功すれば <code>EB_SUCCESS</code> を返し、失敗すれば
<var>text_length</var> の指す領域に 0 を書き込んで原因を示すエラーコード
を返します。
</p>
<p>
あらかじめ、<var>book</var> 内のいずれかの副本が選択されていなくては
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code>
を返します。
</p>
<p>
また、<code>eb_read_text()</code> と <code>eb_read_heading()</code> を
呼び出すには、
あらかじめ <code>eb_seek_text()</code> の呼び出しを成功させ、テキストデータ
のアクセス位置がセットされた状態にしておかなくてはなりません。
シークをせずに呼び出すと、<code>EB_ERR_NO_PREV_SEEK</code> を返します。
</p>
<p>
逆に一度シークすれば、区切りコードが検出されるまでの間なら、関数を
繰り返し呼ぶことでテキストデータの続きを読み込むことができます。
区切りコードが検出されると、関数を呼び出しても読み込みは行われません。
その場合でも、他にエラーが発生しなければ <code>EB_SUCCESS</code> が返り、
<var>text</var> には空文字列が書き込まれます。
</p>
<p>
ただし、一度 <code>eb_read_text()</code> を呼び出してテキストデータを
読み込み始めたら、繰り返し呼び出す際も、<code>eb_read_text()</code> を
使わなければなりません。
途中から <code>eb_read_heading()</code> および後述の
<code>eb_read_rawtext()</code> に切り替えて呼び出すと
<code>EB_ERR_DIFF_CONTENT</code> エラーが返ります。
関数 <code>eb_read_heading()</code> についても同様です。
この制限は、再度 <code>eb_seek_text()</code> を呼び出すか、
<code>eb_set_subbook()</code> で副本を選択し直すまで続きます。
</p>
<p>
渡された <var>appendix</var> が区切りコードの情報を持った副本を選択中
であれば、本文の区切りコードとしてその値を使用します。
それ以外の場合は、<code>eb_read_text()</code> が区切りコードを自動判別を
試みます。
ただし、この判定は完璧なものではないので、書籍によっては変な位置で本文
が切れてしまうかも知れません。
(本文以外のテキストデータに関しては、このような問題は起きません。)
</p>
<p>
引数 <var>container</var> は、アプリケーションプログラムからフック関数に
データを渡すためのものです。
<code>eb_read_text()</code>, <code>eb_read_heading()</code> では、直接
この引数の値を参照することはありません。
</p>
<p>
引数 <var>appendix</var>, <var>container</var> は、そのままフック関数に
渡されます。
これらの引数は <code>NULL</code> でも構いません。
(呼び出されるフック関数で支障がなければ。)
</p>
<p>
なお、フック関数や <code>eb_read_text()</code>, <code>eb_read_heading()</code>
自身が文字ないしエスケープシーケンス一個分に対するデータを書き込もうと
したときに、<var>text</var> に十分な空き領域がないということが起こり
得ます。
その場合、関数は途中まで <var>text</var> に書き込むことはせずに、
いったん処理を終えて戻ります。
したがって、マルチバイト文字のデータが途中で切れたりすることはありません。
</p>
<p>
書き込めなかった分は、当然ながら <var>text_length</var> の勘定には
入りません。
書き込めなかったデータは <var>book</var> 内部に保存されているので、
もう一度 <code>eb_read_text()</code>, <code>eb_read_heading()</code> を
呼び出すと、前回の呼び出しで書き込めなかったデータがまず <var>text</var>
の先頭に書き込まれます。
書き込んだデータは <var>text_length</var> の勘定に入ります。
</p>
<p>
ただし、<code>book</code> が保存しているデータの長さが
<var>text_max_length</var> を超えていると、何も書き込まずに関数は終了
します。
このとき、書き込めなかったデータは引き続き保存されます。
つまり、<code>text_max_length</code> があまりに小さく、かつ保持している
データのほうが長いと、何度呼び出しても <code>text</code> への書き込みが
進みませんので、注意が必要です。
</p>
<p>
<code>eb_seek_text()</code> を呼び出すか、<code>eb_set_subbook()</code>
で副本を選択し直すと、保存していたデータは破棄されます。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:read_rawtext"><code>EB_Error_Code eb_read_rawtext (EB_Book *<var>book</var>, size_t <var>text_max_length</var>, char *<var>text</var>, ssize_t *<var>text_length</var>)</code></a></h4>
<p>
関数 <code>eb_read_rawtext()</code> は、<var>book</var> が選択している
副本のテキストデータファイルの現在のアクセス位置からデータを読み込みます。
</p>
<p>
<code>eb_read_text()</code> と似ていますが、この関数はフックセットによる
データの加工や文字コードの変換を一切行わず、データを内部表現のまま返します。
読み込むテキストデータの種類は、何であっても構いません。
</p>
<p>
読み込んだテキストデータは <var>text</var> の指す領域に書き込まれ、
書き込んだバイト数が <var>text_length</var> の指す領域に書き込まれます。
テキストデータは、<var>text_max_length</var> で指定されたバイト数を超えて
書き込むことはありません。
ただし、<code>eb_read_text()</code> と異なり、<var>text</var> はナル文字
で終端されません。
マルチバイト文字やエスケープシーケンスの途中で <var>text</var> の残り領域
が足りなくなった場合も、途中までは書き込みます。
</p>
<p>
処理が成功すれば <code>EB_SUCCESS</code> を返し、失敗すれば
<var>text_length</var> の指す領域に 0 を書き込んで原因を示すエラーコード
を返します。
</p>
<p>
あらかじめ、<var>book</var> 内のいずれかの副本が選択されていなくては
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code>
を返します。
</p>
<p>
また、この関数を呼び出すには、あらかじめ <code>eb_seek_text()</code> の
呼び出しを成功させ、テキストデータのアクセス位置がセットされた状態にして
おかなくてはなりません。
シークをせずに呼び出すと、<code>EB_ERR_NO_PREV_SEEK</code> を返します。
</p>
<p>
この関数は、繰り返し呼び出すことで、前回読み込んだテキストデータの続き
を読み込むことができます。
ただし、区切りコードの検出を行いませんので、ひたすら呼び出しを続けると、
テキストデータファイルの末尾まで行ってしまいます。
</p>
<p>
一度 <code>eb_read_rawtext()</code> を呼び出してテキストデータを読み込み
始めたら、繰り返し呼び出す際も、<code>eb_read_rawtext()</code> を
使わなければなりません。
途中から、<code>eb_read_text()</code> や <code>eb_read_heading()</code> に
切り替えると、
<code>EB_ERR_DIFF_CONTENT</code> エラーが返ります。
この制限は、再度 <code>eb_seek_text()</code> を呼び出すか、
<code>eb_set_subbook()</code> で副本を選択し直すまで続きます。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:is_text_stopped"><code>int eb_is_text_stopped (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_is_text_stopped()</code> は、最後に読み込んだテキストデータ
が末尾に達したかどうかを判定します。
</p>
<p>
<var>book</var> が選択中の副本で、最後に <code>eb_read_text()</code>
または <code>eb_read_heading()</code> でテキストデータを読み込んだ際に、
区切りコードを検出したか、テキストデータ全体の一番後ろの位置に達して
読み込みを終えていれば、この関数は 1 を返します。
それ以外のときは、0 を返します。
</p>
<p>
<var>book</var> が副本を選択していない場合や、選択中の副本にテキストデータ
が存在しない場合も 0 が返ります。
</p>
<p>
<code>eb_read_text()</code> または <code>eb_read_heading()</code> で
テキストデータを読み込んでいない場合も、同様に 0 が返ります。
テキストデータを読み込んだ後であっても、テキストデータの読み込みに関する
状態記録をリセットする関数 (eb_read_text() の項を参照) を呼んでしまうと、
読み込んでいないと見なされますので、注意して下さい。
</p>
<p>
通常はこの関数を使わなくても、<code>eb_read_text()</code> や
<code>eb_read_heading()</code> が 0 を返したら、テキストデータの末尾に
達したとみなして差し支えないでしょう。
ただしその際は、引数 <code>text_max_length</code> の値を十分大きく取って
下さい。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:write_text_byte1"><code>EB_Error_Code eb_write_text_byte1 (EB_Book *<var>book</var>, int <var>byte1</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:write_text_byte2"><code>EB_Error_Code eb_write_text_byte2 (EB_Book *<var>book</var>, int <var>byte1</var>, int <var>byte2</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:write_text_string"><code>EB_Error_Code eb_write_text_string (EB_Book *<var>book</var>, const char *<var>string</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:write_text"><code>EB_Error_Code eb_write_text (EB_Book *<var>book</var>, const char *<var>stream</var>, size_t <var>stream_length</var>)</code></a></h4>
<p>
これらの関数は、いずれもフック関数の中から、テキストデータを書き込む
ために用います。
書き込むデータの種類によって、使い分けて下さい。
</p>
<p>
<code>eb_write_text_byte1()</code> は、<var>byte1</var> で指定した
1 バイトの値を書き込みます。
<code>eb_write_text_byte2()</code> は、<var>byte1</var>, <var>byte2</var>
で指定した 2 バイトを書き込みます。
<code>eb_write_text_string()</code> は、<var>string</var> で指定した
文字列を書き込みます。
<code>eb_write_text()</code> は、<var>stream</var> から始まる長さ
<var>stream_length</var> バイトのバイト列を書き込みます。
</p>
<p>
どの関数も、成功すると <code>EB_SUCCESS</code> を返し、失敗すると原因を
示すエラーコードを返します。
</p>
<p>
最終的に、書き込んだテキストデータは、フック関数の呼び出し元である
<code>eb_read_text()</code>, <code>eb_read_heading()</code> から
アプリケーションプログラムに渡されます。
</p>
<p>
フック関数として呼び出されていないときに、これらの関数を呼び出した場合
の動作は未定義です。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:current_candidate"><code>const char *eb_current_candidate (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_current_candidate()</code> は、アクセス中のテキストデータの
現在位置に書かれている、複合検索の候補となる語を返します。
</p>
<p>
返す文字列の長さは、最長で <code>EB_MAX_WORD_LENGTH</code> バイトになります。
ただし、この長さにナル文字は含みません。
</p>
<p>
この関数は非常に特殊で、複合検索の候補となる語の終了を意味する
エスケープシーケンスへのフックである <code>EB_HOOK_END_CANDIDATE_LEAF</code>
および <code>EB_HOOK_END_CANDIDATE_GROUP</code> に対するフック関数の中で
のみ呼び出すことができます。
それ以外の場所で呼び出したときの動作は、未定義です。
</p>
<p>
この関数の呼び出し方ですが、フック関数に渡ってきた <code>EB_Book</code>
オブジェクト (へのポインタ) を、そのままこの関数に引数として渡して
やります。
</p>
<p>
<var>book</var> の文字コード
(<a href="#eb_book-data-types">「[CD-ROM 書籍と <code>EB_Book</code> オブジェクト] データ型の詳細」</a> を参照のこと)
が <code>EB_CHARCODE_ISO8859_1</code> なら、関数の返す文字列は ISO 8859-1
になり、それ以外の文字コードの場合は日本語 EUC になります。
関数の返す文字列は、他のフックによる加工処理の影響を受けません。
文字コードの変換を行う以外は、内部データをそのまま返します。
</p>
<p>
なお、この関数が返した文字列を参照できるのは、フック関数から戻るまでの
間だけですので、注意して下さい。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:forward_text"><code>EB_Error_Code eb_forward_text (EB_Book *<var>book</var>, EB_Appendix *<var>appendix</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:backward_text"><code>EB_Error_Code eb_backward_text (EB_Book *<var>book</var>, EB_Appendix *<var>appendix</var>)</code></a></h4>
<p>
関数 <code>eb_forward_text()</code> と <code>eb_backward_text()</code> は、
<var>book</var> が選択している副本の本文のアクセス位置を前後に移動させ、
本文の区切りコードを単位とした頭出しを行います。
ちょうど、音楽 CD の曲の頭出しと同じです。
</p>
<p>
<code>eb_forward_text()</code> は本文の末尾方向に向かってアクセス位置を
進め、<code>eb_backward_text()</code> は先頭方向に向かってアクセス位置を
戻します。
</p>
<p>
<code>eb_forward_text()</code> の呼び出しでは、アクセス位置は必ず次の語の
説明の開始位置まで移動します。
それに対して <code>eb_backward_text()</code> の呼び出しでは、移動先が状態
によって異なります。
もし、現在のアクセス位置がその単語の説明の先頭にあるときは、
<code>eb_backward_text()</code> の呼び出しによって、一つ前の単語の説明の
先頭にアクセス位置が移動します。
アクセス位置が単語の説明の途中や末尾にあるときは、その単語の説明の
先頭に移動します。
</p>
<p>
この関数は、成功すると <code>EB_SUCCESS</code> を返し、失敗すると原因を示す
エラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> 内のいずれかの副本が選択されていなくては
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code>
を返します。
</p>
<p>
加えて、これらの関数を呼び出すには、あらかじめ <code>eb_seek_text()</code>
か <code>eb_read_text()</code> を呼び出しが成功していないといけません。
(<code>eb_read_text()</code> の呼び出しを成功させるには、さらに前もって
<code>eb_seek_text()</code> の呼び出しを成功させることが条件となります。)
</p>
<p>
<code>eb_read_text()</code> ではなく、<code>eb_read_heading()</code> や
<code>eb_read_rawtext()</code> の呼び出しに成功した後でこの関数を
呼び出すと、<code>EB_ERR_DIFF_CONTENT</code> を返します。
また、前もって <code>eb_seek_text()</code> でシークせずにこの関数を
呼び出すと、<code>EB_ERR_NO_PREV_SEEK</code> を返します。
</p>
<p>
本文データの末尾や先頭に達してしまって、その方向にもう本文がないときは、
<code>EB_ERR_END_OF_CONTENT</code> を返します。
</p>
<p>
<var>appendix</var> が <code>NULL</code> ではなく、区切りコードの情報を
持った副本を選択中であれば、本文の区切りコードとしてその値を使用します。
それ以外の場合は、<code>eb_read_text()</code> と同じ方法で区切りコードの
自動判別を試みます。
</p>
<p>
アクセス位置上にあるのがメニューや著作権表示のように、本文以外の
テキストデータであっても構いません。
ただし、本文以外のテキストデータの内部には、頭出し位置がデータの
先頭位置にしかありませんので、この関数が役に立つ状況はほとんど
ありません。
</p>
<p>
(メニューでは、個々の階層のメニューデータが、それぞれ独立した
テキストデータになっているため、頭出しを行っても前後のメニューデータへは
移動できません。
複合検索の候補一覧も同様です。)
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:forward_heading"><code>EB_Error_Code eb_forward_heading (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_forward_heading()</code> は、<var>book</var> が選択している
副本の見出しのアクセス位置を後に移動させ、見出しの区切りを単位とした頭出し
を行います。
</p>
<p>
本文の頭出しを行う関数 <code>eb_forward_text()</code> の見出し版です。
ただし、見出しで頭出しを行う機会は、クロス検索の本文取得に限られるため、
<code>eb_backward_heading()</code> という関数は用意していません。
</p>
<p>
この関数を呼ぶと、アクセス位置が次の見出しの開始位置まで移動します。
(クロス検索では、見出し領域の中に「見出し」と「本文」が交互に書かれて
いますが、データ構造上「本文」と「見出し」は区別が付きません。
アクセス位置がクロス検索の見出し領域内の場合、この関数を呼ぶと最も近い
「見出し」もしくは「本文」の開始位置まで移動します。)
</p>
<p>
<code>eb_read_heading()</code> ではなく、<code>eb_read_text()</code> や
<code>eb_read_rawtext()</code> の呼び出しに成功した後でこの関数を
呼び出すと、<code>EB_ERR_DIFF_CONTENT</code> を返します。
また、前もって <code>eb_seek_text()</code> でシークせずにこの関数を
呼び出すと、<code>EB_ERR_NO_PREV_SEEK</code> を返します。
</p>
<p>
この関数は、成功すると <code>EB_SUCCESS</code> を返し、失敗すると原因を示す
エラーコードを返します。
</p>
<p>
クロス検索以外の検索メソッドの見出しの格納位置に対して、この関数を
呼ぶことも可能ですが、そのような必要に迫られる機会はないでしょう。
</p>
<!-- ================================================================ -->
<h2><a name="local-character">外字</a></h2>
<p>
文字コードに収録されていない、私的に定義した文字のことを、俗に「外字」
と言います。
外字として定義した個々の文字を識別するために、文字コードに収録された
文字とは重複しない位置に、各文字の文字番号に割り振るのが普通です。
(割り当てる文字番号の詳細については、<a href="#character-code">「文字コード」</a> を参照のこと。)
</p>
<p>
市販の電子ブック、EPWING でも、ほとんどが外字を使っています。
外字の定義状況は書籍同士でバラバラで、まったく統一感はありません。
つまり、同じ文字番号を使っていても、定義されている外字は書籍によって
違います。
外字は副本毎に定義することが可能ですが、一つの CD-ROM 書籍内でも副本に
よって定義が異なることも珍しくありません。
副本によっては、数百から数千の外字を定義していることもあります。
</p>
<p>
CD-ROM 書籍では、定義した外字の字形データ (つまりフォント) を用意して
います。
フォントはビットマップデータであり、書籍によっては大きさの異なる数種類
のフォントを用意しています。
</p>
<p>
逆に言えば、外字に対して提供されるデータは、フォントだけです。
ある文字番号を割り当てられた外字が、漢字なのか、発音記号なのか、
そういった補助的な情報は用意されていません。
アプリケーションプログラムが外字をサポートするためには、外字のフォント
をそのまま表示する以外に方法はないでしょう。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="narrow-and-wide-font">半角外字と全角外字</a></h3>
<p>
CD-ROM 書籍における外字には、「全角外字」「半角外字」の二種類があります。
全角外字は用意されているフォントの横と縦の長さがおよそ 1:1 になっており、
半角外字では 1:2 になっています。
</p>
<blockquote>
<pre>
全角外字 半角外字
（１６×１６） （８×１６）
□□□□□□□□□□□□□□□□ □□□□□□□□
□□□□□□□□□□□□□□□□ □□■■□■□□
□□□■■■■■■□□□■□□□ □□□□■□□□
□□□□□□□□■□■□■□□□ □□□■■□□□
□□□□■□□■□□■□■□□□ □□■□□■□□
□□□□■□□■■■■■■□□□ □■□□□■□□
□□■■■■■□□□■□■□□□ □□□■□■□□
□□□□□□□□□□■□■□□□ □□■□■■□□
□□□■□□□□□□□□■□□□ □■□□□■□□
□□□■□□□□□□□□■□□□ □■□□□■□□
□□□■■■■■■■■■■□□□ □■□□□■□□
□□□■□□□□□□□□■□□□ □■□□□■□□
□□□■□□□□□□□□■□□□ □■□□□■□□
□□□■■■■■■■■■■□□□ □■□□□■□□
□□□□□□□□□□□□□□□□ □□■■■□□□
□□□□□□□□□□□□□□□□ □□□□□□□□
</pre>
</blockquote>
<p>
テキストデータには、半角表示の開始と終了を表すエスケープシーケンスが
あり (<a href="#text-data-format">「テキストデータの内部形式」</a> を参照のこと)、
開始と終了の間に置かれたものは半角外字、それ以外のところなら全角外字に
なります。
</p>
<p>
文字番号は同じでも、字形が全角と半角ではまったく異なることもあります
ので、外字の文字番号だけから、全角と半角のどちらかを判断することは
できません。
かならず、前方に半角開始のエスケープシーケンスが出現していたかどうか
という情報に基づいて判断しないといけません。
</p>
<p>
ただし、全角か半角かの判定は EB ライブラリ側で行いますので、
アプリケーションプログラムが文脈の解析を行う必要はありません。
</p>
<p>
CD-ROM 書籍の副本には、半角外字あるいは全角外字のどちらか一方だけを
定義しているものもありますし、両方とも定義しているものもあります。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="font-size-and-font-code">外字の大きさと外字コード</a></h3>
<p>
各副本には、定義している外字のフォントがビットマップ形式で収録されて
います。
フォントの大きさは、縦のピクセル数を基準にすると 16, 24, 30, 48 の
4 種類があり、全角外字、半角外字それぞれのフォントの大きさ
(横のピクセル数×縦のピクセル数) は次の通りになります。
</p>
<table summary="フォントの大きさ">
<tr><td>縦のピクセル数 <td> 全角全角 <td> 半角外字</tr>
<tr><td>16 <td> 16x16 <td> 8x16</tr>
<tr><td>24 <td> 24x24 <td> 16x24</tr>
<tr><td>30 <td> 32x30 <td> 16x30</tr>
<tr><td>48 <td> 48x48 <td> 24x48</tr>
</table>
<p>
ただし、すべての副本でこれら 4 種類のフォントを用意しているわけでは
ありません。
縦が 16 ピクセルのものは必ず用意されていますが、それ以外はないことも
珍しくありません。
(外字がまったく定義されていなければ、16 ピクセルのフォントも用意され
ません。)
</p>
<p>
EB ライブラリでは、このように縦方向のピクセル数、つまり
<dfn>フォントの高さ (font height)</dfn> を基準に、外字フォントの大きさを
区別しています。
そして、それぞれのフォントの高さ (16, 24, 30, 48) に対して、
<dfn>外字コード (font code)</dfn> というものを割り当てています。
フォントの高さを指定する際は、必ずこの外字コードを使います。
</p>
<table summary="フォントの高さと外字コードの対応表">
<tr><td>縦のピクセル数 <td> 外字コード</tr>
<tr><td>16 <td> <code>EB_FONT_16</code></tr>
<tr><td>24 <td> <code>EB_FONT_24</code></tr>
<tr><td>30 <td> <code>EB_FONT_30</code></tr>
<tr><td>48 <td> <code>EB_FONT_48</code></tr>
</table>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="current-font-height">選択中の外字フォントの高さ</a></h3>
<p>
<code>EB_Book</code> オブジェクトで選択中の副本が用意している外字フォント
の高さの中から一つ選んで、
<dfn>選択中の外字フォントの高さ (current font height)</dfn> として指定する
ことができます。
EB ライブラリで外字のフォントデータ (ビットマップデータ) を取り出すには、
外字フォントの高さをあらかじめ選択しておく必要があります。
</p>
<p>
選択するには、関数 <code>eb_set_font()</code> を使います。
以下のプログラムは、高さ 24 ピクセルのフォントを選択する場合の例です。
</p>
<blockquote class="program">
<pre>
/* <code>book</code> が <code>EB_Book</code> のオブジェクトで、すでに
* 書籍に結び付けられ、副本を選択中だと仮定しています。*/
if (eb_set_font(&book, EB_FONT_24) != EB_SUCCESS) {
printf("eb_set_font_() failed\n");
return;
}
</pre>
</blockquote>
<p>
このプログラムでは、高さ 24 ピクセルのフォントを選択中の副本が用意して
いるものと仮定していますが、実際には用意していない副本も珍しくありません。
もし、副本が高さ 24 ピクセルのフォントを用意していなければ、
<code>eb_set_font()</code> は <code>EB_ERR_NO_SUCH_FONT</code> を返します。
</p>
<p>
しかし、外字を選択する前に、前もってその副本が用意しているフォントを
知りたいときもあります。
これには、2 通りの方法があります。
</p>
<p>
まず 1 つ目は、選択中の副本が用意しているフォントの高さの一覧を
<code>eb_font_list()</code> で取得する方法です。
これは、副本コードの一覧を取得する <code>eb_subbook_list()</code> と
使い方が良く似ています。
</p>
<blockquote class="program">
<pre>
EB_Font_Code font_list[EB_MAX_FONTS];
int font_count;
int i;
if (eb_font_list(&book, font_list, &font_count) != EB_SUCCESS) {
printf("eb_font_list() failed\n");
return;
}
for (i = 0; i < font_count; i++) {
if (font_list[i] == EB_FONT_24)
printf("this subbook has EB_FONT_24\n");
}
</pre>
</blockquote>
<p>
2 つ目は、<code>eb_have_font()</code> を使うやり方です。
この関数は、特定の高さのフォントを、選択中の副本が用意しているかどうか
調べることができます。
</p>
<blockquote class="program">
<pre>
if (eb_have_font(&book, EB_FONT_24)) {
printf("this subbook has EB_FONT_24\n");
}
</pre>
</blockquote>
<p>
また、選択中の副本が半角外字、全角外字を定義しているかどうかは、それぞれ
<code>eb_have_narrow_font()</code>, <code>eb_have_wide_font()</code>
を使って調べることができます。
</p>
<blockquote class="program">
<pre>
if (eb_have_narrow_font(&book))
printf("this subbook has narrow font\n");
if (eb_have_wide_font(&book))
printf("this subbook has wide font\n");
</pre>
</blockquote>
<p>
なお、あらかじめ副本を選択しておかないと、外字の高さは選択できないので
注意して下さい。
<code>eb_set_subbook()</code> で選択中の副本を切り替えると、外字フォント
の高さは常に未選択の状態に戻ります。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="get-font">外字フォントの取り出し</a></h3>
<p>
外字の高さを選択した状態であれば、外字のフォントデータ
(ビットマップデータ) を取り出すことができます。
</p>
<p>
フォントデータを取り出す関数は、
全角外字なら <code>eb_wide_font_character_bitmap()</code>、
半角外字なら <code>eb_narrow_font_character_bitmap()</code> です。
</p>
<p>
全角外字 <samp>0xa121</samp> のフォントデータを取り出すプログラムは、
次のようになります。
半角外字の場合は、呼び出す関数名が変わるだけです。
</p>
<blockquote class="program">
<pre>
/* <code>book</code> が <code>EB_Book</code> のオブジェクトで、すでに
* 書籍に結び付けられ、副本と外字の高さを選択中だと仮定しています。*/
char bitmap[EB_SIZE_WIDE_FONT_48];
if (eb_wide_font_character_bitmap(book, 0xa121, bitmap)
!= EB_SUCCESS) {
return;
}
</pre>
</blockquote>
<p>
ここでは、<code>bitmap</code> にフォントデータを格納しています。
<code>bitmap</code> の領域として <code>EB_SIZE_WIDE_FONT_48</code>
バイトを確保していますが、これは高さ 48 ピクセルの外字データを格納する
ために必要なサイズを表します。
</p>
<p>
フォントデータのサイズは、外字の高さに応じて一定です。
高さ 48 ピクセルは外字の中でも最大のサイズなので、このサイズの領域を
用意すれば、どの高さの外字でも格納できます。
</p>
<p>
外字データは、ビットマップ形式のデータになっています。
背景色をビット値 0, 前景色をビット値 1 として、各ピクセルの値を並べて
あります。
並び方ですが、左上からまずは右に向かってピクセルを拾っていき、左端まで
来たら一つ下の段に降りて、また右方向にピクセルを拾います。
以下、一番下の段までこれを繰り返します。
</p>
<p>
ただし、バイト内では、128, 64, 32, ...1 の桁の順にビット値を格納して
います。
つまり、128 の桁は一番左のピクセル、1 の桁は一番右のピクセルに対応
します。
</p>
<p>
以下に、16x16 の全角外字のビットマップの例と、そのバイト列を記します。
背景色が□、前景色が■です。
</p>
<blockquote>
<pre>
□□□□□□□□□□□□□□□□ 0x00, 0x00,
□□□□□□□□□□□□□□□□ 0x00, 0x00,
□□□■■■■■■□□□■□□□ 0x1f, 0x88,
□□□□□□□□■□■□■□□□ 0x00, 0xc8,
□□□□■□□■□□■□■□□□ 0x09, 0x28,
□□□□■□□■■■■■■□□□ 0x09, 0xf8,
□□■■■■■□□□■□■□□□ 0x3e, 0x28,
□□□□□□□□□□■□■□□□ 0x00, 0x28,
□□□■□□□□□□□□■□□□ 0x10, 0x08,
□□□■□□□□□□□□■□□□ 0x10, 0x08,
□□□■■■■■■■■■■□□□ 0x1f, 0xf8,
□□□■□□□□□□□□■□□□ 0x18, 0x08,
□□□■□□□□□□□□■□□□ 0x18, 0x08,
□□□■■■■■■■■■■□□□ 0x1f, 0xf8,
□□□□□□□□□□□□□□□□ 0x00, 0x00,
□□□□□□□□□□□□□□□□ 0x00, 0x00,
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="convert-font">外字フォントの変換</a></h3>
<p>
EB ライブラリには、外字のビットマップデータを XBM, XPM, GIF, BMP, PNG
の各画像形式に変換する関数が用意されています。
変換を行う関数は、次の 5 つです。
</p>
<table summary="外字のビットマップデータの変換関数">
<tr><td><code>eb_bitmap_to_xbm()</code> <td> XBM への変換</tr>
<tr><td><code>eb_bitmap_to_xpm()</code> <td> XPM への変換</tr>
<tr><td><code>eb_bitmap_to_gif()</code> <td> GIF への変換</tr>
<tr><td><code>eb_bitmap_to_bmp()</code> <td> BMP への変換</tr>
<tr><td><code>eb_bitmap_to_png()</code> <td> PNG への変換</tr>
</table>
<p>
どの関数も呼び出し方は同じですが、ここでは XBM への変換のプログラム例
を示します。
</p>
<blockquote class="program">
<pre>
/* <code>bitmap</code> に高さ 16 の全角外字のビットマップデータが格納
* されていると仮定しています。*/
char bitmap[EB_SIZE_WIDE_FONT_16];
char xbm[EB_SIZE_WIDE_FONT_16_XBM];
size_t xbmsize;
if (eb_wide_font_character_bitmap(bitmap, EB_WIDTH_WIDE_FONT_16,
EB_HEIGHT_FONT_16, xbm, &xbmsize) != EB_SUCCESS) {
return;
}
</pre>
</blockquote>
<p>
XPM, GIF, PNG への変換では、前景色は黒、背景色は透明になります。
BMP への変換では、前景色は黒、背景色は白になります。
XBM はモノクロ図版用のデータ形式なので、色の設定はありません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="local-character-in-text">テキスト中の外字</a></h3>
<p>
外字はテキストデータ (本文、メニューなど) の中で使われています。
</p>
<p>
アプリケーションプログラムが、テキストデータ中に出現する外字を識別して
処理を行うには、外字に対するフックを設定して、フック関数の中で処理する
ことになります。
</p>
<p>
外字に対するフックは、全角外字に対する <code>EB_HOOK_WIDE_FONT</code> と
半角外字に対する <code>EB_HOOK_NARROW_FONT</code> の二種類があります。
いずれも、外字が一字出現する度に、設定したフック関数を呼び出します。
</p>
<p>
フックの扱い方については、<a href="#hook-code-list">「フックコードの一覧」</a> を参照のこと。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="font-data-types">データ型の詳細</a></h3>
<p>
この節で説明しているデータ型を使うには、次のようにヘッダファイルを
読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/eb.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Font_Code"><code>EB_Font_Code</code> 型</a></h4>
<p>
外字コードは、外字の高さ (ピクセル数) を表します。
現在のところ、定義されている高さは次の通りです。
</p>
<ul>
<li><code>EB_FONT_16</code>
<li><code>EB_FONT_24</code>
<li><code>EB_FONT_30</code>
<li><code>EB_FONT_48</code>
<li><code>EB_FONT_INVALID</code>
</ul>
<p>
外字コードの実体は整数値ですが、<code>EB_FONT_16</code> の値は 16 では
ありません。
他も同様ですので、注意して下さい。
</p>
<p>
<code>EB_FONT_INVALID</code> は特別な外字コードで、不正な外字コード値を
表すために用います。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="font-constants">定数の詳細</a></h3>
<p>
この節で説明している定数を使うには、次のようにヘッダファイルを
読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/font.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:WIDTH_NARROW_FONT_16">定数 <code>EB_WIDTH_NARROW_FONT_16</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:WIDTH_NARROW_FONT_24">定数 <code>EB_WIDTH_NARROW_FONT_24</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:WIDTH_NARROW_FONT_30">定数 <code>EB_WIDTH_NARROW_FONT_30</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:WIDTH_NARROW_FONT_48">定数 <code>EB_WIDTH_NARROW_FONT_48</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:WIDTH_WIDE_FONT_16">定数 <code>EB_WIDTH_WIDE_FONT_16</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:WIDTH_WIDE_FONT_24">定数 <code>EB_WIDTH_WIDE_FONT_24</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:WIDTH_WIDE_FONT_30">定数 <code>EB_WIDTH_WIDE_FONT_30</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:WIDTH_WIDE_FONT_48">定数 <code>EB_WIDTH_WIDE_FONT_48</code></a></h4>
<p>
これらの定数は、半角、全角およびそれぞれの高さ (外字コード) の外字一個
分の幅 (横方向のピクセル数) を <code>int</code> 型で表しています。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HEIGHT_NARROW_FONT_16">定数 <code>EB_HEIGHT_NARROW_FONT_16</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HEIGHT_NARROW_FONT_24">定数 <code>EB_HEIGHT_NARROW_FONT_24</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HEIGHT_NARROW_FONT_30">定数 <code>EB_HEIGHT_NARROW_FONT_30</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HEIGHT_NARROW_FONT_48">定数 <code>EB_HEIGHT_NARROW_FONT_48</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HEIGHT_WIDE_FONT_16">定数 <code>EB_HEIGHT_WIDE_FONT_16</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HEIGHT_WIDE_FONT_24">定数 <code>EB_HEIGHT_WIDE_FONT_24</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HEIGHT_WIDE_FONT_30">定数 <code>EB_HEIGHT_WIDE_FONT_30</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:HEIGHT_WIDE_FONT_48">定数 <code>EB_HEIGHT_WIDE_FONT_48</code></a></h4>
<p>
これらの定数は、半角、全角およびそれぞれの高さ (外字コード) の外字一個分
の縦方向のピクセル数を <code>int</code> 型で表しています。
</p>
<p>
<code>EB_HEIGHT_NARROW_FONT_16</code> および
<code>EB_HEIGHT_WIDE_FONT_16</code> の実際の値は 16 です。
(外字コード <code>EB_FONT_16</code> の実際の値は 16 ではありませんので、
注意して下さい。)
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_16">定数 <code>EB_SIZE_NARROW_FONT_16</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_24">定数 <code>EB_SIZE_NARROW_FONT_24</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_30">定数 <code>EB_SIZE_NARROW_FONT_30</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_48">定数 <code>EB_SIZE_NARROW_FONT_48</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_16">定数 <code>EB_SIZE_WIDE_FONT_16</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_24">定数 <code>EB_SIZE_WIDE_FONT_24</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_30">定数 <code>EB_SIZE_WIDE_FONT_30</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_48">定数 <code>EB_SIZE_WIDE_FONT_48</code></a></h4>
<p>
これらの定数は、半角、全角およびそれぞれの高さ (外字コード) の外字一個分
のビットマップデータを格納するのに必要な領域の大きさを表しています。
値は <code>int</code> 型で、単位はバイトです。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_16_XBM">定数 <code>EB_SIZE_NARROW_FONT_16_XBM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_24_XBM">定数 <code>EB_SIZE_NARROW_FONT_24_XBM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_30_XBM">定数 <code>EB_SIZE_NARROW_FONT_30_XBM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_48_XBM">定数 <code>EB_SIZE_NARROW_FONT_48_XBM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_16_XBM">定数 <code>EB_SIZE_WIDE_FONT_16_XBM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_24_XBM">定数 <code>EB_SIZE_WIDE_FONT_24_XBM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_30_XBM">定数 <code>EB_SIZE_WIDE_FONT_30_XBM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_48_XBM">定数 <code>EB_SIZE_WIDE_FONT_48_XBM</code></a></h4>
<p>
これらの定数は、半角、全角およびそれぞれの高さ (外字コード) の外字一個分
のビットマップデータを <code>eb_bitmap_to_xbm()</code> を用いて XBM 形式
に変換する際に、変換後の XBM 形式のデータの大きさを表しています。
値は <code>int</code> 型で、単位はバイトです。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_16_XPM">定数 <code>EB_SIZE_NARROW_FONT_16_XPM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_24_XPM">定数 <code>EB_SIZE_NARROW_FONT_24_XPM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_30_XPM">定数 <code>EB_SIZE_NARROW_FONT_30_XPM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_48_XPM">定数 <code>EB_SIZE_NARROW_FONT_48_XPM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_16_XPM">定数 <code>EB_SIZE_WIDE_FONT_16_XPM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_24_XPM">定数 <code>EB_SIZE_WIDE_FONT_24_XPM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_30_XPM">定数 <code>EB_SIZE_WIDE_FONT_30_XPM</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_48_XPM">定数 <code>EB_SIZE_WIDE_FONT_48_XPM</code></a></h4>
<p>
これらの定数は、半角、全角およびそれぞれの高さ (外字コード) の外字一個分
のビットマップデータを <code>eb_bitmap_to_xpm()</code> を用いて XPM 形式
に変換する際に、変換後の XPM 形式のデータの大きさを表しています。
値は <code>int</code> 型で、単位はバイトです。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_16_GIF">定数 <code>EB_SIZE_NARROW_FONT_16_GIF</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_24_GIF">定数 <code>EB_SIZE_NARROW_FONT_24_GIF</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_30_GIF">定数 <code>EB_SIZE_NARROW_FONT_30_GIF</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_48_GIF">定数 <code>EB_SIZE_NARROW_FONT_48_GIF</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_16_GIF">定数 <code>EB_SIZE_WIDE_FONT_16_GIF</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_24_GIF">定数 <code>EB_SIZE_WIDE_FONT_24_GIF</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_30_GIF">定数 <code>EB_SIZE_WIDE_FONT_30_GIF</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_48_GIF">定数 <code>EB_SIZE_WIDE_FONT_48_GIF</code></a></h4>
<p>
これらの定数は、半角、全角およびそれぞれの高さ (外字コード) の外字一個分
のビットマップデータを <code>eb_bitmap_to_gif()</code> を用いて GIF 形式
に変換する際に、変換後の GIF 形式のデータの大きさを表しています。
値は <code>int</code> 型で、単位はバイトです。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_16_BMP">定数 <code>EB_SIZE_NARROW_FONT_16_BMP</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_24_BMP">定数 <code>EB_SIZE_NARROW_FONT_24_BMP</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_30_BMP">定数 <code>EB_SIZE_NARROW_FONT_30_BMP</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_48_BMP">定数 <code>EB_SIZE_NARROW_FONT_48_BMP</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_16_BMP">定数 <code>EB_SIZE_WIDE_FONT_16_BMP</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_24_BMP">定数 <code>EB_SIZE_WIDE_FONT_24_BMP</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_30_BMP">定数 <code>EB_SIZE_WIDE_FONT_30_BMP</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_48_BMP">定数 <code>EB_SIZE_WIDE_FONT_48_BMP</code></a></h4>
<p>
これらの定数は、半角、全角およびそれぞれの高さ (外字コード) の外字一個分
のビットマップデータを <code>eb_bitmap_to_bmp()</code> を用いて BMP 形式
に変換する際に、変換後の BMP 形式のデータの大きさを表しています。
値は <code>int</code> 型で、単位はバイトです。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_16_PNG">定数 <code>EB_SIZE_NARROW_FONT_16_PNG</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_24_PNG">定数 <code>EB_SIZE_NARROW_FONT_24_PNG</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_30_PNG">定数 <code>EB_SIZE_NARROW_FONT_30_PNG</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_NARROW_FONT_48_PNG">定数 <code>EB_SIZE_NARROW_FONT_48_PNG</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_16_PNG">定数 <code>EB_SIZE_WIDE_FONT_16_PNG</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_24_PNG">定数 <code>EB_SIZE_WIDE_FONT_24_PNG</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_30_PNG">定数 <code>EB_SIZE_WIDE_FONT_30_PNG</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="const:SIZE_WIDE_FONT_48_PNG">定数 <code>EB_SIZE_WIDE_FONT_48_PNG</code></a></h4>
<p>
これらの定数は、半角、全角およびそれぞれの高さ (外字コード) の外字一個分
のビットマップデータを <code>eb_bitmap_to_png()</code> を用いて PNG 形式
に変換する際に、変換後の PNG 形式のデータの大きさを表しています。
値は <code>int</code> 型で、単位はバイトです。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="font-functions">関数の詳細</a></h3>
<p>
この節で説明している関数を使うには、次のようにヘッダファイルを読み込んで
下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/font.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:font"><code>EB_Error_Code eb_font (EB_Book *<var>book</var>, EB_Font_Code *<var>font_code</var>)</code></a></h4>
<p>
関数 <code>eb_font()</code> は、選択している副本において、選択中の
外字フォントの高さを表す外字コードを <var>font_code</var> の指す領域に
書き込みます。
</p>
<p>
成功すると関数は <code>EB_SUCCESS</code> を返します。
失敗すると <var>font_code</var> の指す領域に <code>EB_FONT_INVALID</code>
を書き込み、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、外字フォントの高さが選択されていなければなりません。
外字が選択されていなければ、<code>EB_ERR_NO_CUR_FONT</code> を返します。
副本そのものを選択していない場合も、同様です。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:set_font"><code>EB_Error_Code eb_set_font (EB_Book *<var>book</var>, EB_Font_Code <var>font_code</var>)</code></a></h4>
<p>
関数 <code>eb_set_font()</code> は、選択中の副本における外字フォントの
高さをセットします。
セットする外字フォントの「高さ」は、対応する外字コードを引数
<var>font_code</var> で指定します。
</p>
<p>
この関数は、成功すると <code>EB_SUCCESS</code> を返し、指定した「高さ」が
「選択中の外字フォントの高さ」となります。
すでに外字フォントの高さを選択していた場合は、いったん未選択の状態に
してからあらためて <var>font_code</var> を選択します。
</p>
<p>
失敗すると原因を示すエラーコードを返し、外字フォントの高さは未選択の
状態になります。
</p>
<p>
あらかじめ、<var>book</var> 内のいずれかの副本が選択されていなくては
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code>
を返します。
また、その副本が持っていない外字フォントの高さが指定されると、
<code>EB_ERR_NO_SUCH_FONT</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:unset_font"><code>void eb_unset_font (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_unset_font()</code> は、選択中の外字フォントの高さを未選択
の状態に戻します。
<var>book</var> が書籍に結び付いていない場合や副本が選択されていない場合、
もしくは外字フォントの高さが選択されていない場合は何もしません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:font_list"><code>EB_Error_Code eb_font_list (EB_Book *<var>book</var>, EB_Font_Code *<var>font_list</var>, int *<var>font_count</var>)</code></a></h4>
<p>
関数 <code>eb_font_list()</code> は、選択中の副本が定義している外字の
高さの一覧を <code>EB_Font_Code</code> 型の配列にして、<var>font_list</var>
の指す領域に書き込みます。
</p>
<p>
配列は、最大で <code>EB_MAX_FONTS</code> 個の要素を持ちます。
加えて、書籍が収録している副本の個数を <var>font_count</var> の指す領域に
書き込みます。
(現在のバージョンでは 、<code>EB_MAX_FONTS</code> の値は 4 になっています。
高さ 16, 24, 30, 48 ピクセルの 4 種類です。)
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>font_count</var> の指す領域に 0 を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> 内のいずれかの副本が選択されていなくては
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code>
を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_font"><code>int eb_have_font (EB_Book *<var>book</var>, EB_Font_Code <var>font_code</var>)</code></a></h4>
<p>
関数 <code>eb_font()</code> は、<var>font_code</var> で指定した高さの
外字フォントを、選択中の副本が持っているかどうかを調べます。
</p>
<p>
持っていれば 1 を返し、持っていなければ 0 を返します。
<var>book</var> が副本を選択していない場合も 0 を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:font_height"><code>EB_Error_Code eb_font_height (EB_Book *<var>book</var>, int *<var>height</var>)</code></a></h4>
<p>
関数 <code>eb_font_height()</code> は、<var>book</var> が選択中の
外字フォントの高さ (縦方向のピクセル数) を <var>height</var> の指す領域に
書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>height</var> の指す領域に 0 を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> は外字フォントの高さを選択していなくては
なりません。
選択していない場合は、<code>EB_ERR_NO_CUR_FONT</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:font_height2"><code>EB_Error_Code eb_font_height2 (EB_Font_Code <var>font_code</var>, int *<var>height</var>)</code></a></h4>
<p>
<code>eb_font_height()</code> と似ていますが、選択中の副本ではなく、引数
<var>font_height</var> で指定された外字コードの高さ (縦方向のピクセル数)
を書き込む点が異なります。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_narrow_font"><code>int eb_have_narrow_font (EB_Book *<var>book</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_wide_font"><code>int eb_have_wide_font (EB_Book *<var>book</var>)</code></a></h4>
<p>
関数 <code>eb_have_narrow_font()</code> は、選択中の副本が半角外字を定義
しているかどうかを調べます。
同様に、関数 <code>eb_have_wide_font()</code> は、全角外字を定義しているか
どうかを調べます。
</p>
<p>
定義していれば 1 を、定義していなければ 0 を返します。
<var>book</var> が副本を選択していない場合も 0 を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_width"><code>EB_Error_Code eb_narrow_font_width (EB_Book *<var>book</var>, int *<var>width</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_width"><code>EB_Error_Code eb_wide_font_width (EB_Book *<var>book</var>, int *<var>width</var>)</code></a></h4>
<p>
関数 <code>eb_narrow_font_width()</code> は、<var>book</var> が選択中の
外字フォントの高さにおける半角外字の幅 (横方向のピクセル数) を、
<var>height</var> の指す領域に書き込みます。
同様に、<code>eb_wide_font_width()</code> は全角外字の幅を書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>width</var> の指す領域に 0 を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> は外字の高さを選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_FONT</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_width2"><code>EB_Error_Code eb_narrow_font_width2 (EB_Font_Code <var>font_code</var>, int *<var>width</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_width2"><code>EB_Error_Code eb_wide_font_width2 (EB_Font_Code <var>font_code</var>, int *<var>width</var>)</code></a></h4>
<p>
<code>eb_narrow_font_width()</code>, <code>eb_wide_font_width()</code> と
似ていますが、選択中の副本ではなく、引数<var>font_height</var> で指定された
外字コードの幅 (横方向のピクセル数) を書き込む点が異なります。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_size"><code>EB_Error_Code eb_narrow_font_size (EB_Book *<var>book</var>, size_t *<var>size</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_size"><code>EB_Error_Code eb_wide_font_size (EB_Book *<var>book</var>, size_t *<var>size</var>)</code></a></h4>
<p>
関数 <code>eb_narrow_font_size()</code> は、<var>book</var> が選択中の
外字フォントの高さにおける半角外字一個分のデータサイズ (バイト数) を、
<var>size</var> の指す領域に書き込みます。
同様に、<code>eb_wide_font_size()</code> は全角外字のサイズを書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>size</var> の指す領域に 0 を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> は外字フォントの高さを選択していなくては
なりません。
選択していない場合は、<code>EB_ERR_NO_CUR_FONT</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_size2"><code>EB_Error_Code eb_narrow_font_size2 (EB_Font_Code <var>font_code</var>, size_t *<var>size</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_size2"><code>EB_Error_Code eb_wide_font_size2 (EB_Font_Code <var>font_code</var>, size_t *<var>size</var>)</code></a></h4>
<p>
<code>eb_narrow_font_size()</code>, <code>eb_wide_font_size()</code> と
似ていますが、選択中の副本ではなく、引数 <var>font_height</var> で指定
された外字コードの外字一個分のデータサイズを書き込む点が異なります。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_start"><code>EB_Error_Code eb_narrow_font_start (EB_Book *<var>book</var>, int *<var>start</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_start"><code>EB_Error_Code eb_wide_font_start (EB_Book *<var>book</var>, int *<var>start</var>)</code></a></h4>
<p>
関数 <code>eb_narrow_font_start()</code> は、<var>book</var> が選択中の
副本における半角外字の先頭の文字番号 (半角外字の文字番号の中で最小のもの)
を、<var>start</var> の指す領域に書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> は副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
副本が半角外字を定義していない場合は、<code>EB_ERR_NO_CUR_FONT</code> を
返します。
</p>
<p>
関数 <code>eb_wide_font_start()</code> は、半角外字ではなく全角外字に
ついて調べるという点を除いて、<code>eb_narrow_font_start()</code> と同じ
です。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_end"><code>EB_Error_Code eb_narrow_font_end (EB_Book *<var>book</var>, int *<var>end</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_end"><code>EB_Error_Code eb_wide_font_end (EB_Book *<var>book</var>, int *<var>end</var>)</code></a></h4>
<p>
関数 <code>eb_narrow_font_end()</code> は、<var>book</var> が選択中の副本
における半角外字の最後の文字番号 (半角外字の文字番号の中で最大のもの) を、
<var>start</var> の指す領域に書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> は副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
副本が半角外字を定義していない場合は、<code>EB_ERR_NO_CUR_FONT</code> を
返します。
</p>
<p>
関数 <code>eb_wide_font_end()</code> は、半角外字ではなく全角外字について
調べるという点を除いて、<code>eb_narrow_font_end()</code> と同じです。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_character_bitmap"><code>EB_Error_Code eb_narrow_font_character_bitmap (EB_Book *<var>book</var>, int <var>character_number</var>, char *<var>bitmap</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_character_bitmap"><code>EB_Error_Code eb_wide_font_character_bitmap (EB_Book *<var>book</var>, int <var>character_number</var>, char *<var>bitmap</var>)</code></a></h4>
<p>
関数 <code>eb_narrow_font_character_bitmap()</code> は、<var>book</var>
が選択中の副本で定義している、半角外字のビットマップデータを取り出します。
取り出す外字の文字番号を、<var>character_number</var> で指定します。
</p>
<p>
成功すると、関数はビットマップデータを <var>bitmap</var> の指す領域に
書き込み、<code>EB_SUCCESS</code> を返します。
失敗すると、<var>bitmap</var> の指す領域に空文字列を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> は外字フォントの高さを選択していなくては
なりません。
選択していない場合は、<code>EB_ERR_NO_CUR_FONT</code> を返します。
副本が半角外字を定義していない場合も、やはり <code>EB_ERR_NO_CUR_FONT</code>
を返します。
文字番号 <var>character_number</var> が外字の定義範囲外にある場合は、
<code>EB_ERR_NO_SUCH_CHAR_BMP</code> を返します。
</p>
<p>
関数 <code>eb_wide_font_character_bitmap()</code> は、半角外字ではなく
全角外字のビットマップデータを取り出すという点を除いて、
<code>eb_narrow_font_character_bitmap()</code> と同じです。
</p>
<p>
ビットマップデータの形式については、
<a href="#get-font">「外字フォントの取り出し」</a> を参照のこと。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:forward_narrow_font_character"><code>EB_Error_Code eb_forward_narrow_font_character (EB_Book *<var>book</var>, int <var>n</var>, int *<var>character_number</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:forward_wide_font_character"><code>EB_Error_Code eb_forward_wide_font_character (EB_Book *<var>book</var>, int <var>n</var>, int *<var>character_number</var>)</code></a></h4>
<p>
関数 <code>eb_forward_narrow_font_character()</code> は、<var>book</var>
が選択中の副本で定義されている半角外字の文字番号 <var>character_number</var>
の<var>n</var> 個後ろに位置する外字の文字番号を取得します。
</p>
<p>
まず、関数を呼び出す際に、<var>character_number</var> の指す領域に
文字番号を書き込んでおきます。
関数の処理が成功すると、戻ったときに <var>n</var> 個分だけ後方の文字番号
に書き換わっています。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>book</var> は副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
副本が半角外字を持っていない場合は、<code>EB_ERR_NO_CUR_FONT</code> を
返します。
</p>
<p>
<var>n</var> 個後ろにもう外字がない場合や、呼び出した際に
<var>character_number</var> の指す領域に書き込んであった文字番号が外字の
定義範囲外にある場合は <code>EB_ERR_NO_SUCH_CHAR_BMP</code> を返します。
</p>
<p>
<var>n</var> には負の数を指定することもできます。
この場合、次の呼び出しと等価になります。
</p>
<blockquote class="program">
<pre>
/* n < 0 とする */
eb_backward_narrow_font_character (book, -n, character_number);
</pre>
</blockquote>
<p>
関数 <code>eb_forward_wide_font_character()</code> は、半角外字ではなく
全角外字について操作するという点を除いて、
<code>eb_forward_narrow_font_character()</code> と同じです。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:backward_narrow_font_character"><code>EB_Error_Code eb_backward_narrow_font_character (EB_Book *<var>book</var>, int <var>n</var>, int *<var>character_number</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:backward_wide_font_character"><code>EB_Error_Code eb_backward_wide_font_character (EB_Book *<var>book</var>, int <var>n</var>, int *<var>character_number</var>)</code></a></h4>
<p>
関数 <code>eb_backward_narrow_font_character()</code> は
<code>eb_forward_narrow_font_character()</code> とはちょうど逆の関数です。
<var>book</var> が選択中の副本で定義されている半角外字の文字番号
<var>character_number</var> の <var>n</var> 個前方に位置する外字の
文字番号を取得します。
</p>
<p>
同様に、<code>eb_backward_wide_font_character()</code> は、全角外字に
ついて <var>n</var> 個前方の外字の文字番号を取得する関数で、
<code>eb_forward_wide_font_character()</code> と反対の関数です。
</p>
<p>
<var>n</var> には負の数を指定することも可能で、それぞれ次の呼び出しと
等価になります。
</p>
<blockquote class="program">
<pre>
/* 半角外字の場合 (n < 0) */
eb_forward_narrow_font_character (book, -n, character_number);
/* 全角外字の場合 (n < 0) */
eb_forward_wide_font_character (book, -n, character_number);
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_xbm_size"><code>EB_Error_Code eb_narrow_font_xbm_size (EB_Font_Code <var>height</var>, size_t *<var>size</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_xpm_size"><code>EB_Error_Code eb_narrow_font_xpm_size (EB_Font_Code <var>height</var>, size_t *<var>size</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_gif_size"><code>EB_Error_Code eb_narrow_font_gif_size (EB_Font_Code <var>height</var>, size_t *<var>size</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_bmp_size"><code>EB_Error_Code eb_narrow_font_bmp_size (EB_Font_Code <var>height</var>, size_t *<var>size</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_font_png_size"><code>EB_Error_Code eb_narrow_font_png_size (EB_Font_Code <var>height</var>, size_t *<var>size</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_xbm_size"><code>EB_Error_Code eb_wide_font_xbm_size (EB_Font_Code <var>height</var>, size_t *<var>size</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_xpm_size"><code>EB_Error_Code eb_wide_font_xpm_size (EB_Font_Code <var>height</var>, size_t *<var>size</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_gif_size"><code>EB_Error_Code eb_wide_font_gif_size (EB_Font_Code <var>height</var>, size_t *<var>size</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_bmp_size"><code>EB_Error_Code eb_wide_font_bmp_size (EB_Font_Code <var>height</var>, size_t *<var>size</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_font_png_size"><code>EB_Error_Code eb_wide_font_png_size (EB_Font_Code <var>height</var>, size_t *<var>size</var>)</code></a></h4>
<p>
最初の 5 つの関数
(<code>eb_narrow_font_xbm_size()</code> 〜
<code>eb_narrow_font_png_size()</code>) は、外字コード <var>height</var>
の半角外字一個のビットマップを XBM, XPM, GIF, BMP, PNG 形式にそれぞれ変換
したときのデータサイズを <var>size</var> の指す領域に書き込みます。
</p>
<p>
同様に、後ろの 5 つの関数
(<code>eb_wide_font_xbm_size()</code> 〜
<code>eb_wide_font_png_size()</code>) は、全角外字を変換したときの
データサイズを書き込みます。
</p>
<p>
いずれの関数も、成功すると <code>EB_SUCCESS</code> を返します。
失敗すると、<var>size</var> の指す領域に 0 を書き込み、原因を示す
エラーコードを返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:bitmap_to_xbm"><code>EB_Error_Code eb_bitmap_to_xbm (const char *<var>bitmap</var>, int <var>width</var>, int <var>height</var>, char *<var>image</var>, size_t *<var>image_length</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:bitmap_to_xpm"><code>EB_Error_Code eb_bitmap_to_xpm (const char *<var>bitmap</var>, int <var>width</var>, int <var>height</var>, char *<var>image</var>, size_t *<var>image_length</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:bitmap_to_gif"><code>EB_Error_Code eb_bitmap_to_gif (const char *<var>bitmap</var>, int <var>width</var>, int <var>height</var>, char *<var>image</var>, size_t *<var>image_length</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:bitmap_to_bmp"><code>EB_Error_Code eb_bitmap_to_bmp (const char *<var>bitmap</var>, int <var>width</var>, int <var>height</var>, char *<var>image</var>, size_t *<var>image_length</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:bitmap_to_png"><code>EB_Error_Code eb_bitmap_to_png (const char *<var>bitmap</var>, int <var>width</var>, int <var>height</var>, char *<var>image</var>, size_t *<var>image_length</var>)</code></a></h4>
<p>
これら 5 つの関数は、<code>eb_narrow_font_character()</code> または
<code>eb_wide_font_character()</code> で取り出した外字のビットマップを
XBM, XPM, GIF, BMP, PNG 形式にそれぞれ変換します。
</p>
<p>
ビットマップデータの指す領域を <var>bitmap</var> で指定し、ビットマップの
高さと幅を <var>width</var>, <var>height</var> で渡します。
</p>
<p>
関数の呼び出しから戻ると、<var>image</var> の指す領域に変換後のデータが
書き込まれ、<var>image_length</var> の指す領域に変換後のデータの大きさが
書き込まれます。
</p>
<p>
XPM, GIF, PNG への変換では、前景色は黒、背景色は透明になります。
BMP への変換では、前景色は黒、背景色は白になります。
XBM はモノクロ図版用のデータ形式なので、色の設定はありません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="font-sample">サンプルプログラム</a></h3>
<blockquote>
<pre>
/* -*- C -*-
* Copyright (c) 2002-2006 Motoyuki Kasahara
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the project nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* 使用方法:
* font <book-path> <subbook-index>
* 例:
* font /cdrom 0
* 説明:
* <book-path> で指定した CD-ROM 書籍から特定の副本を選び、その
* 副本が定義している半角外字 (高さ 16 ピクセル) をすべてアスキー
* アートで表示します。
*
* その副本が、高さ 16 ピクセルの半角外字を定義していないと、エ
* ラーになります。
*
* <subbook-index> には、検索対象の副本のインデックスを指定しま
* す。インデックスは、書籍の最初の副本から順に 0、1、2 ... に
* なります。
*/
#include <stdio.h>
#include <stdlib.h>
#include <eb/eb.h>
#include <eb/error.h>
#include <eb/font.h>
int
main(int argc, char *argv[])
{
EB_Error_Code error_code;
EB_Book book;
EB_Subbook_Code subbook_list[EB_MAX_SUBBOOKS];
int subbook_count;
int subbook_index;
int font_start;
unsigned char bitmap[EB_SIZE_NARROW_FONT_16];
int i, j;
/* コマンド行引数をチェック。*/
if (argc != 3) {
fprintf(stderr, "Usage: %s book-path subbook-index\n",
argv[0]);
exit(1);
}
/* EB ライブラリと `book' を初期化。*/
eb_initialize_library();
eb_initialize_book(&book);
/* 書籍を `book' に結び付ける。*/
error_code = eb_bind(&book, argv[1]);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to bind the book, %s: %s\n",
argv[0], eb_error_message(error_code), argv[1]);
goto die;
}
/* 副本の一覧を取得。*/
error_code = eb_subbook_list(&book, subbook_list, &subbook_count);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get the subbbook list, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* 副本のインデックスを取得。*/
subbook_index = atoi(argv[2]);
/*「現在の副本 (current subbook)」を設定。*/
error_code = eb_set_subbook(&book, subbook_list[subbook_index]);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to set the current subbook, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/*「現在の外字の大きさ」を設定。*/
if (eb_set_font(&book, EB_FONT_16) < 0) {
fprintf(stderr, "%s: failed to set the font size, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* 外字の開始位置を取得。*/
error_code = eb_narrow_font_start(&book, &font_start);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get font information, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
i = font_start;
for (;;) {
/* 外字のビットマップデータを取得。*/
error_code = eb_narrow_font_character_bitmap(&book, i,
(char *)bitmap);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get font data, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* ビットマップをアスキーアートにして出力。*/
printf("code point=%04x\n", i);
for (j = 0; j < 16; j++) {
fputc((bitmap[j] & 0x80) ? '*' : ' ', stdout);
fputc((bitmap[j] & 0x40) ? '*' : ' ', stdout);
fputc((bitmap[j] & 0x20) ? '*' : ' ', stdout);
fputc((bitmap[j] & 0x10) ? '*' : ' ', stdout);
fputc((bitmap[j] & 0x08) ? '*' : ' ', stdout);
fputc((bitmap[j] & 0x04) ? '*' : ' ', stdout);
fputc((bitmap[j] & 0x02) ? '*' : ' ', stdout);
fputc((bitmap[j] & 0x01) ? '*' : ' ', stdout);
fputc('\n', stdout);
}
fputs("--------\n", stdout);
/* 外字の文字番号を一つ進める。*/
error_code = eb_forward_narrow_font_character(&book, 1, &i);
if (error_code != EB_SUCCESS)
break;
}
/* 書籍と EB ライブラリの利用を終了。*/
eb_finalize_book(&book);
eb_finalize_library();
exit(0);
/* エラー発生で終了するときの処理。*/
die:
eb_finalize_book(&book);
eb_finalize_library();
exit(1);
}
</pre>
</blockquote>
<!-- ================================================================ -->
<h2><a name="binary-data">バイナリデータ</a></h2>
<p>
<dfn>バイナリデータ (binary data)</dfn> とは、
図版や動画、音声といったマルチメディアデータのことを指します。
バイナリデータは、必ずテキストデータ
(<a href="#text-data">「テキストデータ」</a> を参照のこと)
から参照される形で利用されます。
</p>
<p>
今のところ EB ライブラリでは、全種類のバイナリデータを取り扱うことが
できるわけではありません。
電子ブックで扱えるのは、2 階調のモノクロ図版と、カラー図版 (JPEG) だけ
です。
EPWING では、モノクロ図版、カラー図版 (BMP および JPEG) に加えて、
WAVE (PCM) 音声、MPEG 動画を扱うことができます。
</p>
<p>
ただし、EB ライブラリが提供しているのは、こうしたバイナリデータを
CD-ROM 書籍から取得する機能だけです。
表示したり再生したりする機能は用意していませんので、注意して下さい。
</p>
<p>
アプリケーションは、英和辞書や国語辞書といった辞書だけを対象にするなら、
バイナリデータの表示や再生には対応しなくても支障はありません。
しかし一方では、図鑑や数式の表現にモノクロ図版を使っている数学辞典の
ように、対応しないと不便なものもあります。
バイナリデータの表示や再生の機能を実装するかどうかは、アプリケーション
の対象辞書をどの範囲までにするのかによって決めると良いでしょう。
</p>
<p>
以下、この章では種類別にバイナリデータの扱い方について説明します。
</p>
<p>
バイナリデータの種類毎にデータの取り出し方は微妙に異なりますが (これは
データの収録方法が微妙に異なっているからに他なりません)、おおよそ手順
は、次のようなものになります。
</p>
<ol>
<li>
テキストデータのフックを用いて、バイナリデータの参照情報を取得する。
<li>
<code>eb_binary_set_...()</code> 関数を呼び出して、指定した位置の
バイナリデータをこれから読み込む旨を EB ライブラリに伝える。
<li>
<code>eb_read_binary()</code> で実際にデータを読み込む。
</ol>
<p>
テキストデータと同様に、バイナリデータも副本に属するデータ
ですので、副本を選択していないと取得することはできません。
バイナリデータの読み込みには、テキストデータとは別の
ファイルディスクリプタが割り当てられます。
したがって、双方を交互に読み込んでも、動作には影響はありません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="monochrome-image">モノクロ図版</a></h3>
<p>
2 階調のモノクロ図版は、電子ブック、EPWING 双方に存在し、EB ライブラリ
ではどちらも扱うことができます。
(電子ブックに存在する 16 階調のモノクロ図版は、今のところ EB ライブラリ
では対応していません。)
</p>
<p>
モノクロ図版データの内部形式は外字と同じですが、EB ライブラリでは、
1 ピクセルに 1bit を割り当てた BMP 形式に変換してアプリケーションに
渡すようにしています。
したがって、アプリケーションからは、あたかも BMP の図版データが収録
されているようにみえます。
</p>
<p>
テキストデータ内からは、バイナリデータであるモノクロ図版を参照する形
をとります。
モノクロ図版を取り出すには、この参照情報が必要です。
参照情報の取得は、テキストデータ処理時に、モノクロ図版の開始と終了を
表すエスケープシーケンスへのフック <code>EB_HOOK_BEGIN_MONO_GRAPHIC</code>
と <code>EB_HOOK_END_MONO_GRAPHIC</code> を用いて行います。
</p>
<p>
フック <code>EB_HOOK_BEGIN_MONO_GRAPHIC</code> がフック関数に渡す引数
(<code>argv</code>) は 4 つあり、このうちの <code>argv[2]</code> と
<code>argv[3]</code> が図版の幅と高さ (ピクセル数) を意味します。
</p>
<p>
また、フック <code>EB_HOOK_END_MONO_GRAPHIC</code> がフック関数に渡す
引数は 3 つで、<code>argv[1]</code> と <code>argv[2]</code> が、
図版データのページ番号とオフセットになります。
</p>
<p>
モノクロ図版を取得するには、上記のフックから得た図版のページ番号と
オフセット、および幅と高さを記憶しておきます。
</p>
<p>
次に、<code>eb_set_binary_mono_graphic()</code> を呼び出して、これから
モノクロ図版のデータを取得することを EB ライブラリに伝えます。
<code>eb_set_binary_mono_graphic()</code> への引数には、
<code>EB_Book</code> オブジェクトと、先ほど得た図版へのページ番号、
オフセット、幅、高さを渡します。
<code>EB_Book</code> オブジェクトは、これから取り出そうとしている図版を
収録している副本をあらかじめ選択しておく必要があります。
</p>
<blockquote class="program">
<pre>
/* <code>eb_set_binary_mono_graphic()</code> の関数プロトタイプ */
EB_Error_Code
eb_set_binary_mono_graphic(EB_Book *book, EB_Position *position,
int width, int height);
</pre>
</blockquote>
<p>
電子ブックでは、フック関数に渡される幅と高さの値は 0 になっていますが、
そのまま <code>eb_set_binary_mono_graphic()</code> に渡します。
(EPWING では 0 を渡してはいけません。)
</p>
<p>
以上で図版データの取得準備ができたので、データを読み込みます。
これには、<code>eb_read_binary()</code> を使います。
</p>
<blockquote class="program">
<pre>
#define MAX_LENGTH 1000
char bitmap[MAX_LENGTH];
ssize_t bitmap_length;
if (eb_read_binary(&book, MAX_LENGTH, bitmap, &bitmap_length)
!= EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
</pre>
</blockquote>
<p>
成功すると、読み込んだ図版データが <code>bitmap</code> に書き込まれ、
何バイト書き込んだのかが <code>bitmap_length</code> に書き込まれます。
書き込まれるバイト数は、最大で <code>MAX_LENGTH</code> バイトです。
</p>
<p>
必ずしも一回の <code>eb_read_binary()</code> の呼び出しで図版データを
終端まで読み込む必要はなく、関数を繰り返し呼び出せば、前回の続きを
読み込むことができます。
<code>eb_read_binary()</code> は、図版データの終端まで来るとそれ以上
データは読み込みませんので、<code>eb_read_binary()</code> が 0 を返した
時点で図版データが終端したことを認識できます。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="color-image">カラー図版</a></h3>
<p>
カラー図版は、電子ブックでは JPEG 形式、EPWING では JPEG と BMP (DIB)
形式のものが使用されています。
EB ライブラリはこれらをすべて扱うことができますが、電子ブックへの対応
は限定的なものになっています。(詳しくは後述します。)
</p>
<p>
カラー図版のデータを取り出すには、モノクロ図版と同様にテキストデータ
からカラー図版への参照情報をフックを通じて取得し、続いて実際に
カラー図版のデータを読み込むという手順になります。
</p>
<p>
<code>eb_set_binary_color_graphic()</code> を呼び出して、これから
アプリケーションがカラー図版のデータを取得しようとしていることを
EB ライブラリに伝えます。
<code>eb_set_binary_color_graphic()</code> への引数には、
<code>EB_Book</code> オブジェクトに加えて、カラー図版のページ番号と
オフセットを渡します。
</p>
<blockquote class="program">
<pre>
/* <code>eb_set_binary_color_graphic()</code> の関数プロトタイプ */
EB_Error_Code
eb_set_binary_color_graphic(EB_Book *book, EB_Position *position);
</pre>
</blockquote>
<p>
<code>EB_Book</code> オブジェクトは、これから取り出そうとしている図版を
収録している副本をあらかじめ選択しておきます。
カラー図版のページ番号とオフセットの情報は、カラー図版の開始と終了を表す
エスケープシーケンスへのフックから得ます。
フックは、インライン表示用と非インライン用の 2 種類があり、さらに
それぞれ開始フックが JPEG 用と BMP 用に分かれています。
</p>
<dl>
<dt><code>EB_HOOK_BEGIN_COLOR_BMP</code></dt>
<dt><code>EB_HOOK_BEGIN_COLOR_JPEG</code></dt>
<dd>
非インライン用 BMP, JPEG の開始フック
<dt><code>EB_HOOK_END_COLOR_GRAPHIC</code></dt>
<dd>
非インライン用カラー図版 (BMP, JPEG 共通) の終了フック
<dt><code>EB_HOOK_BEGIN_IN_COLOR_BMP</code></dt>
<dt><code>EB_HOOK_BEGIN_IN_COLOR_JPEG</code></dt>
<dd>
インライン用 BMP, JPEG の開始フック
<dt><code>EB_HOOK_END_IN_COLOR_GRAPHIC</code></dt>
<dd>
非インライン用カラー図版 (BMP, JPEG 共通) の終了フック
</dl>
<p>
非インライン用の終了フック <code>EB_HOOK_END_GRAPHIC</code> では、
フック関数に渡す引数の <code>argv[2]</code> と <code>argv[3]</code> が、
図版データのページ番号とオフセットになりますので、これを
<code>eb_set_binary_color_graphic()</code> に渡してやります。
同様に、インライン用の終了フック <code>EB_HOOK_END_IN_GRAPHIC</code>
では、<code>argv[2]</code> と <code>argv[3]</code> がページ番号と
オフセットですので、これを渡します。
</p>
<p>
後は、実際にカラー図版のデータを取り出します。
これには、モノクロ図版と同様に <code>eb_read_binary()</code> を用います。
使い方はまったく一緒ですので、詳しくは
<a href="#monochrome-image">「モノクロ図版」</a> を参照してください。
</p>
<p>
ただし、電子ブックのカラー図版については、データの終了位置が来ても
EB ライブラリは読み込みを止めないという制限事項があります。
これは、データの大きさに関する情報が記されていないためで、データの
終端位置は、アプリケーションが JPEG のデータをデコードして割り出すしか
ありません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="clickable-color-image">参照先付きカラー図版</a></h3>
<p>
カラー図版には、画像内の特定の矩形領域に参照先の情報を付け加えたものが
あります。
HTML におけるクリッカブル・イメージ (clickable image) とほぼ同じで、その
矩形領域内にマウスポインタがある間にマウスをクリックすると、あらかじめ
決められたリンク先に画面が遷移するという仕掛けです。
リンク先となる矩形領域は、画像一つに対して複数個登録できます。
</p>
<blockquote>
<pre>
参照先付きカラー図版の例
┌────────────────────────┐
│┌ ─ ─ ─ ─ ┐ ┌ ─ ─ ─ ─ ┐│
│ │
││ 矩形領域１ │ │ 矩形領域２ ││
│ │
│└ ─ ─ ─ ─ ┘ └ ─ ─ ─ ─ ┘│
│ │
│┌ ─ ─ ─ ─ ┐ │
│ │
││ 矩形領域３ │ 図版 │
│ │
│└ ─ ─ ─ ─ ┘ │
└────────────────────────┘
</pre>
</blockquote>
<p>
参照先付きカラー図版の取り扱い方は、通常のカラー図版を拡張した形と
なります。通常のカラー図版の場合では、たとえば JPEG の非インライン
画像では、次のような順番でフックが呼び出されます。
</p>
<ol>
<li><code>EB_HOOK_BEGIN_COLOR_JPEG</code> (非インライン用 JPEG 開始)
<li><code>EB_HOOK_END_COLOR_GRAPHIC</code> (非インライン用 JPEG 終了)
</ol>
<p>
これに対して参照先付きのカラー図版では、この2つのフックの間に、矩形領域
情報に関するフックが挿入されます。
</p>
<ol>
<li><code>EB_HOOK_BEGIN_COLOR_JPEG</code> (非インライン用 JPEG 開始)
<li><code>EB_HOOK_BEGIN_CLICKABLE_AREA</code> (矩形領域1 開始)
<li><code>EB_HOOK_END_CLICKABLE_AREA</code> (矩形領域1 終了)
<li><code>EB_HOOK_BEGIN_CLICKABLE_AREA</code> (矩形領域2 開始)
<li><code>EB_HOOK_END_CLICKABLE_AREA</code> (矩形領域2 終了)<br>
以下、矩形領域3、矩形領域4 ... と矩形領域の個数分だけ続く。
<li><code>EB_HOOK_END_COLOR_GRAPHIC</code> (非インライン用 JPEG 終了)
</ol>
<p>
矩形領域に関する具体的な情報は、<code>EB_HOOK_BEGIN_CLICKABLE_AREA</code>
(開始フック) のほうで取得します。
フック関数に渡す引数の <code>argv[1]</code> と <code>argv[2]</code> が、
それぞれ矩形領域の開始 x, y 座標を表します。
カラー図版の左上の座標が (0, 0) です。
同様に、<code>argv[3]</code> と <code>argv[4]</code> が矩形領域の右方向
への幅と、下方向への高さを表します。
最後の <code>argv[5]</code> と <code>argv[6]</code> が参照先のページ番号
とオフセットとなります。
</p>
<p>
アプリケーションが参照先付きカラー図版に対応しない場合は、矩形領域の
開始情報と終了情報を無視することになります。
これにより、図版は通常の (参照先を持たない) カラー図版とまったく同じく
扱われます。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="wave-sound">WAVE (PCM) 音声</a></h3>
<p>
WAVE (PCM) 形式の音声データは EPWING にだけ存在します。
(代わりに電子ブックには CD-DA 形式の音声データがありますが、EB ライブラリ
では対応していません。)
</p>
<p>
WAVE 形式の音声データを取り出すには、まずテキストデータ中から WAVE 音声
の参照情報を得ます。
参照開始と終了を表すエスケープシーケンスへのフック
<code>EB_HOOK_BEGIN_WAVE</code> と <code>EB_HOOK_END_WAVE</code> が
それぞれありますので、これを用います。
</p>
<p>
フック <code>EB_HOOK_BEGIN_WAVE</code> がフック関数に渡す引数のうち、
<code>argv[2]</code> と <code>argv[3]</code> が音声データの開始位置の
ページ番号とオフセット、<code>argv[4]</code> と <code>argv[5]</code> が
終了位置のページ番号とオフセットとなります。
</p>
<p>
この開始位置と終了位置を関数 <code>eb_set_binary_wave()</code> に渡して、
その位置にある音声データをこれから取り出すことを EB ライブラリに伝えます。
</p>
<blockquote class="program">
<pre>
/* <code>eb_set_binary_wave()</code> の関数プロトタイプ */
EB_Error_Code
eb_set_binary_wave(EB_Book *book, EB_Position *start_position,
EB_Position *end_position);
</pre>
</blockquote>
<p>
そして後は、実際に音声データを取り出します。
これには、他のバイナリデータと同様に <code>eb_read_binary()</code> を
用います。
<code>eb_read_binary()</code> の使い方は、
<a href="#monochrome-image">「モノクロ図版」</a> を参照のこと を参照してください。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="mpeg-movie">MPEG1 動画</a></h3>
<p>
MPEG1 形式の動画データは EPWING にだけ存在します。
動画データは EPWING の CD-ROM の movie というディレクトリの下に、
動画毎に一個のファイルにした形で収められています。
</p>
<p>
テキストデータ中に存在する、MPEG データの参照開始と終了を表す
エスケープシーケンスへのフック <code>EB_HOOK_BEGIN_MPEG</code> と
<code>EB_HOOK_END_MPEG</code> を使用することで、参照先の MPEG の
ファイル名を取得できます。
</p>
<p>
具体的には、フック <code>EB_HOOK_BEGIN_MPEG</code> がフック関数に渡す
引数のうち、<code>argv[2]</code> 〜 <code>argv[5]</code> が合わせて一つ
のファイル名を表すようになっています。
</p>
<p>
MPEG 動画のデータを得るには、このファイル名を
<code>eb_set_binary_mpeg()</code> に渡して、そのファイルの動画データを
これから取り出す旨を EB ライブラリに伝えます。
ファイル名は、次のようにして <code>argv + 2</code>
(<code>&argv[2]</code> でも同じ) を渡します。
</p>
<blockquote class="program">
<pre>
if (eb_set_binary_mpeg(&book, argv + 2) != EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
</pre>
</blockquote>
<p>
後は、実際に動画データを取り出します。
これには、やはり他のバイナリデータと同様に <code>eb_read_binary()</code>
を用います。
<code>eb_read_binary()</code> の使い方については、
<a href="#monochrome-image">「モノクロ図版」</a> を参照のこと を参照してください。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="binary-data-functions">関数の詳細</a></h3>
<p>
この節で説明している関数を使うには、次のようにヘッダファイルを読み込んで
下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/binary.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:set_binary_mono_graphic"><code>EB_Error_Code eb_set_binary_mono_graphic (EB_Book *<var>book</var>, const EB_Position *<var>position</var>, int <var>width</var>, <var>height</var>)</code></a></h4>
<p>
関数 <code>eb_set_binary_mono_graphic()</code> は、モノクロ図版のデータを
これから取得しようとしていることを EB ライブラリに伝えます。
引数 <var>position</var> は図版の位置、<var>width</var>, <var>height</var>
には図版の幅と高さを渡します。
これらの情報は、図版の参照元であるテキストデータに記載されており、通常は
フック関数を通じて得るようにします。
ただし、電子ブックでは幅と高さの値の情報がテキストデータに記されていない
ため、0 を渡すことになります。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因に応じたエラーコードを返します。
</p>
<p>
あらかじめ、図版を取り出そうとしている副本を選択しておかなければ
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code>
を返します。
図版の位置、幅、高さの値が明らかにおかしいと EB ライブラリが判断した
ときは、<code>EB_ERR_NO_SUCH_BINARY</code> を返します。
</p>
<p>
この関数は、実際に図版データを読み込むことはしません。
読み込みには、<code>eb_read_binary()</code> を用います。
モノクロ図版のデータは、1 ピクセルに 1bit を割り当てた BMP 形式になって
います。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:set_binary_color_graphic"><code>EB_Error_Code eb_set_binary_color_graphic (EB_Book *<var>book</var>, const EB_Position *<var>position</var>)</code></a></h4>
<p>
関数 <code>eb_set_binary_color_graphic()</code> は、EPWING のカラー図版の
データをこれから取得しようとしていることを EB ライブラリに伝えます。
引数 <var>position</var> は図版の位置を渡します。
位置の情報は、図版の参照元であるテキストデータに記載されており、通常は
フック関数を通じて得るようにします。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
</p>
<p>
あらかじめ、図版を取り出そうとしている副本を選択しておかなければ
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code>
を返します。
図版の位置が明らかにおかしいと EB ライブラリが判断したときは、
<code>EB_ERR_NO_SUCH_BINARY</code> を返します。
</p>
<p>
この関数は、実際に図版データを読み込むことはしません。
読み込みには、<code>eb_read_binary()</code> を用います。
カラー図版データは、JPEG か BMP (DIB) のいずかの形式になっています。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:set_binary_wave"><code>EB_Error_Code eb_set_binary_wave (EB_Book *<var>book</var>, const EB_Position *<var>start_position</var>, EB_Position *<var>end_position</var>)</code></a></h4>
<p>
関数 <code>eb_set_binary_wave()</code> は、WAVE (PCM) 形式の音声のデータ
をこれから取得しようとしていることを EB ライブラリに伝えます。
引数 <var>start_position</var> と <var>end_position</var> には音声データ
の開始位置を渡します。
位置の情報は、音声データの参照元であるテキストデータに記載されており、
通常はフック関数を通じて得るようにします。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因に応じたエラーコードを返します。
</p>
<p>
あらかじめ、音声データを取り出そうとしている副本を選択しておかなければ
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code> を
返します。
音声データの位置が明らかにおかしいと EB ライブラリが判断したときは、
<code>EB_ERR_NO_SUCH_BINARY</code> を返します。
</p>
<p>
この関数は、実際に音声データを読み込むことはしません。
読み込みには、<code>eb_read_binary()</code> を用います。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:set_binary_mpeg"><code>EB_Error_Code eb_set_binary_mpeg (EB_Book *<var>book</var>, const unsigned int *<var>argv</var>)</code></a></h4>
<p>
関数 <code>eb_set_binary_mpeg()</code> は、MPEG1 形式の動画のデータを
これから取得しようとしていることを EB ライブラリに伝えます。
引数 <var>argv</var> には動画データのファイル名を渡します。
ただし、このファイル名は文字列ではなく、フック関数
<code>EB_HOOK_BEGIN_MPEG</code> に渡された引数 <code>argv[2]</code>
〜 <code>argv[5]</code> の部分を渡します。
つまり、フック関数の引数 <code>argv + 2</code> を、
<code>eb_set_binary_mpeg()</code> への引数 <var>argv</var> として
渡します。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因に応じたエラーコードを返します。
</p>
<p>
あらかじめ、動画データを取り出そうとしている副本を選択しておかなければ
なりません。
<var>book</var> が副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code>
を返します。
存在しない動画ファイル名を EB ライブラリが判断したときは、
<code>EB_ERR_NO_SUCH_BINARY</code> を返します。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
</p>
<p>
この関数は、実際に動画データを読み込むことはしません。
読み込みには、<code>eb_read_binary()</code> を用います。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:read_binary"><code>EB_Error_Code eb_read_binary (EB_Book *<var>book</var>, size_t <var>binary_max_length</var>, char *<var>binary</var>, ssize_t *<var>binary_length</var>)</code></a></h4>
<p>
関数 <code>eb_read_binary()</code> は、バイナリデータを読み込みます。
読み込もうとしているバイナリデータは、事前に
</p>
<ul>
<li><code>eb_set_binary_mono_graphic()</code>
<li><code>eb_set_binary_color_graphic()</code>
<li><code>eb_set_binary_wave()</code>
<li><code>eb_set_binary_mpeg()</code>
</ul>
<p>
のいずれかの関数で、EB ライブラリに通知しておく必要があります。
</p>
<p>
読み込んだデータは引数 <var>binary</var> の指す先の領域に書き込まれます。
また、このとき書き込まれたバイト数は、<var>binary_length</var> の指す
先の領域にセットされます。
ただし、書き込まれるバイト数は、最長でも引数 <var>binary_max_length</var>
に指定した値までとなります。
</p>
<p>
この関数は、特に読み込んだデータの終端にナル文字を付加するような事は
しません。
読み込まれるデータもバイナリ形式なので、途中にナル文字が出現する事も
あります。
</p>
<p>
この関数を一回呼び出しだだけで、バイナリデータ全体を一気に取得する
必要はありません。
繰り返し呼び出せば、前回の続きからデータが読み込まれます。
</p>
<p>
ただし、以下に挙げた関数を呼び出すと、バイナリデータの読み込みに関する
状態記録がリセットされますので、それ以上の読み込みはできなくなります。
</p>
<ul>
<li><code>eb_set_subbook()</code>
<li><code>eb_unset_subbook()</code>
<li><code>eb_load_all_subbooks()</code>
<li><code>eb_bind()</code>
<li><code>eb_finalize_book()</code>
<li><code>eb_set_binary_mono_graphic()</code>
<li><code>eb_set_binary_color_graphic()</code>
<li><code>eb_set_binary_wave()</code>
<li><code>eb_set_binary_mpeg()</code>
</ul>
<p>
<code>eb_read_binary()</code> を繰り返し呼んだ場合、バイナリデータは
その都度 <var>binary</var> の先頭から書き込まれ、*<var>binary_length</var>
の値も、その回の <code>eb_read_binary()</code> の呼び出しで書き込まれた
バイト数になります。
</p>
<p>
データの終端に来ると、それ以上この関数を呼んでも関数は <var>binary</var>
には何も書き込まず、*<var>binary_length</var> に 0 を書き込み、
<code>EB_SUCCESS</code> を返します。
</p>
<p>
成功すると、この関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>binary_length</var> が指す領域に -1 を書き込み、原因を
示すエラーコードを返します。
この場合、バイナリデータの読み込み状態の記録がリセットされますので、
データの続きを読み込むことはできなくなります。
</p>
<p>
あらかじめ、<var>book</var> はいずれかの副本を選択していなくては
なりません。
選択していない場合は、<code>EB_ERR_NO_CUR_SUB</code> を返します。
また、冒頭に挙げた関数の呼び出しが成功していない状態でこの関数を呼ぶと、
<code>EB_ERR_NO_CUR_BINARY</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:compose_movie_file_name"><code>EB_Error_Code eb_compose_movie_file_name (const unsigned int *<var>argv</var>, char *<var>composed_file_name</var>)</code></a></h4>
<p>
関数 <code>eb_compose_movie_file_name()</code> は、動画データのファイル名
を通常の文字列に変換します。
</p>
<p>
EB ライブラリでは、動画データのファイル名はフック関数
<code>EB_HOOK_BEGIN_MPEG</code> に渡された 4 つの int 型引数
(<code>argv[2]</code> 〜 <code>argv[5]</code>) によって表現されます。
</p>
<p>
動画データを読み込む際は、これをそのまま <code>eb_set_binary_mpeg()</code>
に渡せば良いのですが、ファイル名を通常の文字列で得たい場合は、この関数を
用います。
たとえば、個々の動画に一意の ID のようなものを振りたい場合は、ファイル
名を ID として使うと良いかも知れません。
なお、この関数で変換して得られるファイル名にはパスが含まれていません。
</p>
<p>
フック関数の引数 <code>argv + 2</code> をこの関数への引数 <var>argv</var>
として渡すと、<var>composed_file_name</var> が指す先の領域に、文字列形式
に変換されたファイル名が格納されます。
ファイル名は最長で <code>EB_MAX_DIRECTORY_NAME_LENGTH</code> (= 8) バイト
になります。
この長さには終端のナル文字の分を含んでいませんので、格納領域にはもう
1 バイト余裕が要ります。
</p>
<p>
なお、格納されたファイル名は、実際に存在するファイル名とは若干異なって
いる可能性があります。
たとえば、英字の大文字と小文字、接尾子の有無などの違いがこれに当たります。
この関数は、あくまで文字列に機械的に変換するだけなので、ファイルが実在
するかどうかのチェックはしません。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:compose_movie_path_name"><code>EB_Error_Code eb_compose_movie_path_name (EB_Book *<var>book</var>, const unsigned int *<var>argv</var>, char *<var>composed_path_name</var>)</code></a></h4>
<p>
関数 <code>eb_compose_movie_path_name()</code> は、動画データのファイル名
を通常の文字列に変換します。
働きは、前述の関数 <code>eb_compose_movie_file_name()</code> に良く
似ていますが、<code>eb_compose_movie_path_name()</code> が返すファイル名
は、絶対パスの形式になっている点が異なります。
</p>
<p>
また、<code>eb_compose_movie_path_name()</code> では、ファイル名が実在
するかどうかのチェックを行うという点も、大きな違いです。
ファイル名を文字列に変換した上で、英字の大文字と小文字の違いや接尾子の
有無は、実在のファイルに合わせて調整したものを返します。
したがって、パスを除いた部分で比較しても、
<code>eb_compose_movie_file_name()</code> が返すファイル名とは必ずしも
一致しません。
</p>
<p>
引数 <code>book</code> は、動画ファイルを収録している副本を選択して
おかなければなりません。
副本を選択していなければ、<code>EB_ERR_NO_CUR_SUB</code> を返します。
</p>
<p>
引数 <code>argv</code> の意味は、<code>eb_compose_movie_file_name()</code>
と同じです。
</p>
<p>
ファイル名の変換が成功すると、関数は <var>composed_path_name</var> が
指す先の領域に、文字列形式に変換された動画ファイル名を格納し、
<code>EB_SUCCESS</code> を返します。
ファイル名は最長で <code>EB_MAX_PATH_LENGTH</code> バイトになります。
この長さには終端のナル文字の分を含んでいませんので、格納領域にはもう
1 バイト余裕が要ります。
</p>
<p>
ファイル名が実在しないと、<code>EB_ERR_BAD_FILE_NAME</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:decompose_movie_file_name"><code>EB_Error_Code eb_decompose_movie_file_name (unsigned int *<var>argv</var>, const char *<var>composed_file_name</var>)</code></a></h4>
<p>
関数 <code>eb_compose_movie_file_name()</code> は、
<code>eb_compose_movie_file_name()</code> とちょうど逆の働きをします。
つまり、通常の文字列に変換された動画データのファイル名
<var>composed_file_name</var> を、4 つの int 型引数 <var>argv</var> に
戻します。
したがって、<var>argv</var> の指す領域は、少なくとも int 型の値を 4 つ
格納できる大きさが必要です。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
</p>
<!-- ================================================================ -->
<h2><a name="appendix-data">appendix データ</a></h2>
<p>
<dfn>appendix</dfn> (<dfn>付録</dfn>) とは CD-ROM 書籍の補助データの
ことです。
appendix は CD-ROM 書籍の出版社から提供されているものではなく、
EB ライブラリに固有のものです。
<code>ebappendix</code> コマンドを用いて生成します
(詳しくは <a href="ebappendix.html">ebappendix コマンドのマニュアル</a>
の「appendix (付録) とは」を参照のこと)。
</p>
<p>
appendix は以下のデータを CD-ROM 書籍に対して提供します。
</p>
<ul>
<li>本文の区切りコード
<li>外字の代替文字列
</ul>
<p>
appendix のレイアウトは CD-ROM 書籍のものとよく似ています。
トップディレクトリには <code>catalog</code> もしくは
<code>catalogs</code> ファイルが存在し、各副本のデータは対応する
サブディレクトリに配置されています。
</p>
<p>
アプリケーションは appendix に対応し、本文の区切りコードの情報を使える
ようにすることをお薦めします。
外字の代替文字列については、外字のフォントをそのまま表示できるので
あれば、対応する必要性はかなり乏しいですが、本文の区切りコードは、
扱えないと正しく本文を表示できない書籍に対応できません
(区切りコードについては、<a href="#stop-code-issue">「区切りコードの問題」</a> を参照のこと)。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="eb_appendix"><code>EB_Appendix</code> オブジェクト</a></h3>
<p>
CD-ROM 書籍本体を扱うには <code>EB_Book</code> オブジェクトを
用いましたが、appendix を扱うには <code>EB_Appendix</code> オブジェクト
を使います。
<code>EB_Appendix</code> オブジェクトを操作するための関数は、
<code>EB_Book</code> のものとは異なりますが、操作手順はよく似ています。
</p>
<p>
<code>EB_Appendix</code> オブジェクトは、個々の appendix に対して 1 個
ずつ作る必要があります。
</p>
<blockquote class="program">
<pre>
EB_Appendix app;
</pre>
</blockquote>
<p>
もちろん、オブジェクトの領域は、<code>malloc()</code> で確保しても
構いません。
</p>
<blockquote class="program">
<pre>
EB_Appendix *app_pointer;
app_pointer = (EB_Appendix *) malloc(sizeof(EB_Appendix));
</pre>
</blockquote>
<p>
オブジェクトは、使う前に必ず <code>eb_initialize_appendix()</code>
という関数で中身を初期化しなくてはなりません。
<code>EB_Book</code> オブジェクトでも <code>eb_initialize_book()</code>
で初期化する必要がありましたが、それと同じです。
</p>
<blockquote class="program">
<pre>
eb_initialize_appendix(&app);
eb_initialize_appendix(app_pointer);
</pre>
</blockquote>
<p>
続いて、オブジェクトを appendix の実体に結び付けるために、
<code>eb_bind_appendix()</code> を呼び出します。
これは、<code>EB_Book</code> オブジェクトの <code>eb_bind()</code> に
相当します。
</p>
<blockquote>
<pre>
ＥＢ＿Ａｐｐｅｎｄｉｘ ａｐｐｅｎｄｉｘ
オブジェクト ┌────────────┐
┌───┐ │ │
│ ┝━━━━━━━━━━━━━┥ ／ｍｎｔ／ｄｉｃｔ │
└───┘ ｅｂ＿ｂｉｎｄ │ │
＿ａｐｐｅｎｄｉｘ（） └────────────┘
</pre>
</blockquote>
<p>
実際のプログラムでは、次のようにします。
</p>
<blockquote class="program">
<pre>
if (eb_bind_appendix(&app, "/mnt/dict") != EB_SUCCESS) {
printf("eb_bind_appendix() failed\n");
return;
}
</pre>
</blockquote>
<p>
<code>eb_bind_appendix()</code> に渡す appendix のパス
(この例では <code>/mnt/dict</code>) は appendix のトップディレクトリ、
つまり <code>catalog</code> または <code>catalogs</code> ファイルのある
ディレクトリを指定します。
パスには、遠隔アクセス識別子 (例: <samp>ebnet://localhost/dict.app</samp>)
を指定することも可能です。
</p>
<p>
<code>EB_Appendix</code> オブジェクトを使い終わったら、
<code>eb_finalize_appendix()</code> を呼んで後始末をします。
オブジェクトは appendix との結び付きを解かれた状態に戻り、
内部で割り当てられたメモリは解放され、開いていたファイルもすべて
閉じられます。
</p>
<blockquote class="program">
<pre>
eb_finalize_appendix(&app);
eb_finalize_appendix(app_pointer);
</pre>
</blockquote>
<p>
オブジェクトの領域を <code>malloc()</code> で確保した場合は、
<code>eb_finalize_appendix()</code> を呼んだ後ならば、オブジェクトの
領域を安全に解放することができます。
</p>
<blockquote class="program">
<pre>
free(app_pointer);
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="appendix-subbook">副本</a></h3>
<p>
CD-ROM と同様に、appendix にも副本が存在します。
appendix の副本も、副本コードを使って識別します。
個々の副本コードは、appendix 内で同じものがないようになっています。
</p>
<p>
CD-ROM 書籍内のすべての副本の副本コードを取得する関数として
<code>eb_subbook_list()</code> がありましたが、appendix にも
<code>eb_appendix_subbook_list()</code> という同様の関数があります。
</p>
<blockquote class="program">
<pre>
/* <code>app</code> が <code>EB_Appendix</code> のオブジェクトで、
* すでに書籍に結び付けられていると仮定しています。*/
EB_Subbook_Code sub_codes[EB_MAX_SUBBOOKS];
int sub_count;
if (eb_appendix_subbook_list(&app, sub_codes, &sub_count)
!= EB_SUCCESS) {
printf("eb_appendix_subbook_list() failed\n");
return;
}
</pre>
</blockquote>
<p>
<code>eb_appendix_subbook_list()</code> が成功すると、書籍内のすべての
副本コードが 配列 <code>sub_codes[]</code> に格納されます。
配列の先頭の副本コードは <code>sub_codes[0]</code> と表され、次の
コードは <code>sub_codes[1]</code>、という具合になります。
副本の個数は、<code>sub_count</code> に格納されます。
</p>
<p>
<code>EB_Book</code> と同様に <code>EB_Appendix</code> オブジェクト
でも、結びつけられた CD-ROM 書籍の中の任意の副本から一つ選んで、
<dfn>選択中の副本 (current subbook)</dfn> として指定することができます。
複数の副本を、同時に選択することはできません。
区切りコードや外字の代替文字列といった appendix 内のデータへのアクセス
は、選択中の副本に対してだけ行えます。
</p>
<p>
以下は、先頭の副本 (<code>sub_codes[0]</code>) を選択する場合の例です。
</p>
<blockquote class="program">
<pre>
/* <code>app</code> が <code>EB_Appendix</code> のオブジェクトで、
* すでに書籍に結び付けられていると仮定しています。*/
if (eb_set_appendix_subbook(&app, sub_codes[0]) != EB_SUCCESS) {
printf("eb_subbook_list() failed\n");
return;
}
</pre>
</blockquote>
<p>
<code>eb_bind_appendix()</code> で <code>EB_Appendix</code> オブジェクト
を appendix に結び付けた直後は、いずれの副本も選択されていない状態に
なっています。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="appendix-stop-code">本文の区切りコード</a></h3>
<p>
CD-ROM 書籍によっては、EB ライブラリが本文の表示を正しい位置で
止められないことがあります
(詳しくは、<a href="#stop-code-issue">「区切りコードの問題」</a> を参照のこと)。
これは、本文の区切りコードの推測を EB ライブラリが誤ったために起こる
のですが、appendix データを使うことで、正しい区切りコードを EB ライブラリ
に教えてやることができます。
</p>
<p>
CD-ROM 書籍の本文を取得する関数 <code>eb_read_text()</code> は
第 2 引数に <code>EB_Appendix *</code> をとるのですが、ここに appendix
オブジェクトを渡してやるようにします。
</p>
<blockquote class="program">
<pre>
/* <code>book</code>, <code>app</code> は、それぞれ <code>EB_Book</code>
* および <code>EB_Appendix</code> のオブジェクトで、どちらもすでに
* 副本を選択中と仮定しています。*/
#define MAX_LENGTH 1000
char buffer[MAX_LENGTH + 1];
ssize_t text_length;
if (eb_read_text(&book, &app, NULL, NULL, MAX_LENGTH,
text, &text_length) != EB_SUCCESS) {
fprintf(stderr, "an error occurs.\n");
return;
}
</pre>
</blockquote>
<p>
<code>eb_read_text()</code> は、渡された appendix オブジェクトが副本を
選択済みで、かつ区切りコードの情報を持っていれば、その区切りコードを
使用します。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="appendix-alternation-text">外字の代替文字列</a></h3>
<p>
CD-ROM 書籍は、定義している外字の情報としてフォントのデータしか用意して
いません。
つまり、その外字がどのような文字なのかをユーザに分かるようにするには、
アプリケーションがフォントを表示するしかありません。
しかしこれでは、テキストインターフェースを用いたアプリケーションでは、
本文中の外字の部分がまったく分かりません。
外字を多用している書籍では、本文が解読不能に近い状態になるかも知れません。
</p>
<p>
そこで EB ライブラリでは、外字の代替となる文字列を appendix 内で定義
できるようにしています。
appendix が用意されている場合に限り、アプリケーションは外字のフォント
を描画する代わりにその代替文字列を出力することにすれば、
テキストインターフェースを用いたアプリケーションでも書籍が読み易く
なります。
</p>
<p>
appendix に定義されている代替文字列を取り出す関数は、2 つあります。
半角外字用の <code>eb_narrow_alt_character_text()</code> と全角外字用の
<code>eb_wide_alt_character_text()</code> です。
どちらも、使い方は変わりません。
</p>
<p>
以下の例では、半角外字の文字番号 0xa121 に対する代替文字列を
<samp>buffer</samp> に格納しています。
</p>
<blockquote class="program">
<pre>
/* <code>app</code> が <code>EB_Appendix</code> のオブジェクトで、
* すでに副本を選択中であると仮定しています。*/
char buffer[EB_MAX_ALTERNATION_TEXT_LENGTH + 1];
if (eb_narrow_alt_character_text(&app, buffer, 0xa121)
!= EB_SUCCESS) {
printf("eb_narrow_alt_character_text() failed\n");
return;
}
</pre>
</blockquote>
<p>
外字は個々の副本に対して定義されているので、代替文字列を取り出すには、
あらかじめ副本を選択しておく必要があります。
外字のフォントを取り出す際は、これに加えて外字の「高さ」も選択しておく
必要がありましたが、代替文字列には高さの概念がないので必要ありません。
</p>
<p>
代替文字列は最長で <code>EB_MAX_ALTERNATION_TEXT_LENGTH</code> バイト
(= 31 バイト) です。
ただし、この長さにはナル文字の分は含んでいないので、<samp>buffer</samp>
はもう 1 バイト分余裕を持たせています。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="appendix-data-types">データ型の詳細</a></h3>
<p>
この節で説明しているデータ型を使うには、次のようにヘッダファイルを
読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/appendix.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:Appendix"><code>EB_Appendix</code> 型</a></h4>
<p>
<code>EB_Appendix</code> 型は、一冊の CD-ROM 書籍を表します。
CD-ROM 書籍へのアクセスは、すべてこの型のオブジェクトを介して行います。
同時に複数の CD-ROM 書籍にアクセスする際は、書籍一冊毎にオブジェクトを
作る必要があります。
</p>
<p>
<code>EB_Appendix</code> オブジェクトの操作は、すべて EB ライブラリが
用意している関数で行います。
アプリケーションプログラムは、直接 <code>EB_Appendix</code> オブジェクト
のメンバを参照したり、セットしたりすべきではありません。
</p>
<p>
<code>EB_Appendix</code> オブジェクトを使用する際は、まずそのオブジェクト
に対して <code>eb_initialize_book()</code> を呼んで初期化しなくては
なりません。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="appendix-functions">関数の詳細</a></h3>
<p>
この節で説明している関数を使うには、次のようにヘッダファイルを読み込んで
下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/appendix.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:initialize_appendix"><code>void eb_initialize_appendix (EB_Appendix *<var>app</var>)</code></a></h4>
<p>
関数 <code>eb_initialize_appendix()</code> は、<var>app</var> の指す
<code>EB_Appendix</code> オブジェクトを初期化します。
<code>EB_Appendix</code> オブジェクトに対して EB ライブラリの他の関数を
呼ぶ前に、必ずそのオブジェクトを初期化しなくてはなりません。
初期化していないオブジェクトに対して、EB ライブラリの他の関数を呼んだ
場合の動作は未定義です。
また、すでに初期化したオブジェクトに対して、
再度 <code>eb_initialize_appendix()</code> を呼んではいけません。
呼んだ場合の動作は未定義です。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:finalize_appendix"><code>void eb_finalize_appendix (EB_Appendix *<var>app</var>)</code></a></h4>
<p>
関数 <code>eb_finalize_appendix()</code> は、<var>app</var> が指す
<code>EB_Appendix</code> オブジェクトの後始末を行います。
</p>
<p>
オブジェクトが割り当てて管理していたメモリはすべて解放され、
ファイルディスクリプタもすべて閉じられます。
オブジェクトが appendix と結び付いていた場合は、結び付きが解かれます。
</p>
<p>
後始末をしたオブジェクトに対して <code>eb_bind_appendix()</code> を呼ぶことで、
オブジェクトを再利用することができます。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:bind_appendix"><code>EB_Error_Code eb_bind_appendix (EB_Appendix *<var>app</var>, const char *<var>path</var>)</code></a></h4>
<p>
関数 <code>eb_bind_appendix()</code> は、<var>app</var> の指す
<code>EB_Appendix</code> オブジェクトを、パス <var>path</var> にある
appendix に結び付けます。
パスには、appendix のトップディレクトリか遠隔アクセス識別子を指定します。
appendix のトップディレクトリとは、<code>catalog</code> あるいは
<code>catalogs</code> ファイルの存在するディレクトリを指します。
</p>
<p>
オブジェクトがすでにappendix に結び付いていた場合、その appendix との
結び付きを解いてから、<var>path</var> にある appendix に結び付けます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
このとき、副本は未選択の状態になります。
失敗すると、オブジェクトを appendix との結び付きを解かれた状態にして、
原因を示すエラーコードを返します。
</p>
<p>
<var>path</var> は、<code>EB_MAX_PATH_LENGTH</code> バイトに収まて
いなくてはなりません。
さらに、<var>path</var> が相対パスのときは、絶対パスに変換した結果が
この長さに収まっていなくてはなりません。
これを超えると、<code>EB_ERR_TOO_LONG_FILE_NAME</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:is_appendix_bound"><code>int eb_is_appendix_bound (EB_Appendix *<var>app</var>)</code></a></h4>
<p>
関数 <code>eb_is_appendix_bound()</code> は、<var>app</var> が appendix に
結び付いているかどうかを調べます。
結び付いていれば 1 を返し、そうでなければ 0 を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:appendix_path"><code>EB_Error_Code eb_appendix_path (EB_Appendix *<var>app</var>, char *<var>path</var>)</code></a></h4>
<p>
関数 <code>eb_appendix_path()</code> は、<var>app</var> に結び付いている
appendix のパスもしくは遠隔アクセス識別子を、<var>path</var> の指す領域
に書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>path</var> の指す領域に空文字列を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
<var>app</var> は、あらかじめ書籍に結び付いている必要があります。
結びついていない場合は、<code>EB_ERR_UNBOUND_BOOK</code> を返します。
</p>
<p>
<var>path</var> に書き込むパス名のバイト数は、最長で
<code>EB_MAX_PATH_LENGTH</code> になります。
この長さは、末尾のナル文字を含みません。
関数が返すパスは正規化された形になっているので、
<code>eb_bind_appendix()</code> に渡したときのものと同じとは限りません。
たとえば、相対パスだった場合は、絶対パスに変換されます。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:load_all_appendix_subbooks"><code>EB_Error_Code eb_load_all_appendix_subbooks (EB_Appendix *<var>app</var>)</code></a></h4>
<p>
関数 <code>eb_load_all_appendix_subbooks()</code> は、<var>app</var> 内
のすべての副本を初期化します。
通常、副本の初期化は、その副本が初めて選択されたときに自動的に
行われますが、この関数は初期化を前倒しで行います。
初期化の対象となるのは、この関数を呼び出した時点でまだ初期化していない
すべての副本です。
この関数は、スタンドアロンで動作するサーバアプリケーションなどで有効です。
クライアントからの接続を受ける前にこの関数を呼ぶことで、副本の初期化の
ためにクライアントを待たせなくて済みます。
</p>
<p>
初期化の対象となったすべての副本の初期化に成功すれば、関数は
<code>EB_SUCCESS</code> を返します。
一冊でも初期化に失敗した場合は、残りの副本の初期化を諦め、原因を示す
エラーコードを返します。
</p>
<p>
<var>app</var> は、あらかじめ appendix に結び付けられていなくては
なりません。
結びついていない場合は、<code>EB_ERR_UNBOUND_APP</code> を返します。
</p>
<p>
この関数を呼び出すと、<var>app</var> は、副本を選択していない状態に
なります。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:appendix_subbook_list"><code>EB_Error_Code eb_appendix_subbook_list (EB_Book *<var>app</var>, EB_Subbook_Code *<var>subbook_list</var>, int *<var>subbook_count</var>)</code></a></h4>
<p>
関数 <code>eb_appendix_subbook_list()</code> は、<var>app</var> 内の
すべて副本の副本コードを <code>EB_Subbook_Code</code> 型の配列にして、
<var>subbook_list</var> の指す領域に書き込みます。
配列は、最大で <code>EB_MAX_SUBBOOKS</code> 個の要素を持ちます。
加えて、appendix が収録している副本の個数を <var>subbook_count</var> の
指す領域に書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>subbook_count</var> の指す領域に 0 を書き込み、原因を
示すエラーコードを返します。
</p>
<p>
<var>app</var> は、あらかじめ appendix に結び付けられていなくては
なりません。
結びついていない場合は、<code>EB_ERR_UNBOUND_APP</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:appendix_subbook"><code>EB_Error_Code eb_appendix_subbook (EB_Book *<var>app</var>, EB_Subbook_Code *<var>subbook_code</var>)</code></a></h4>
<p>
関数 <code>eb_appendix_subbook()</code> は、<var>app</var> が選択中の
副本の副本コードを <var>subbook_code</var> の指す領域に書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>subbook_code</var> の指す領域に
<code>EB_SUBBOOK_INVALID</code> を書き込み、原因を示すエラーコードを
返します。
</p>
<p>
あらかじめ、<var>app</var> はいずれかの副本を選択していなくては
なりません。
選択していない場合は、<code>EB_ERR_NO_CUR_APPSUB</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:appendix_subbook_directory"><code>EB_Error_Code eb_appendix_subbook_directory (EB_Book *<var>app</var>, char *<var>directory</var>)</code></a></h4>
<p>
関数 <code>eb_appendix_subbook_directory()</code> は、<var>app</var> 内
で現在選択中の副本のデータファイルを収めたディレクトリ名を、
<var>directory</var> の指す領域に書き込みます。
</p>
<p>
ディレクトリ名の文字列の長さは、最長で
<code>EB_MAX_DIRECTORY_NAME_LENGTH</code> バイトです。
この長さに、末尾のナル文字は含みません。
ディレクトリ名は ASCII の数字、英小文字、アンダースコアで構成されます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、<var>directory</var> の指す領域に空文字列を書き込み、原因に
を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>app</var> 内のいずれかの副本が選択されていなくては
なりません。
選択していない場合は、<code>EB_ERR_NO_CUR_APPSUB</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:appendix_subbook_directory2"><code>EB_Error_Code eb_appendix_subbook_directory2 (EB_Book *<var>app</var>, EB_Subbook_Code <var>subbook_code</var>, char *<var>directory</var>)</code></a></h4>
<p>
<code>eb_appendix_subbook_directory()</code> と似ていますが、選択中の
副本ではなく、引数 <var>subbook_code</var> で指定された副本の
ディレクトリ名を書き込む点が異なります。
</p>
<p>
<var>app</var> は副本を選択していなくても構いませんが、あらかじめ
appendix に結び付けられていなければなりません。
結びついていない場合は、<code>EB_ERR_UNBOUND_APP</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:set_appendix_subbook"><code>EB_Error_Code eb_set_appendix_subbook (EB_Book *<var>app</var>, EB_Subbook_Code <var>code</var>)</code></a></h4>
<p>
関数 <code>eb_set_appendix_subbook()</code> は、<var>app</var> の副本
<var>code</var> を選択します。
すでに副本を選択していた場合は、いったん未選択の状態にしてから副本
<var>subbook_code</var> を選択します。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
このとき、外字は未選択の状態となり、検索、テキストデータの読み込み、
バイナリデータの読み込みについての状態記録は、すべてリセットされます。
失敗すると、副本を未選択の状態にして、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>app</var> は appendix に結び付けられていなければ
なりません。
結びついていない場合は、<code>EB_ERR_UNBOUND_APP</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:unset_appendix_subbook"><code>void eb_unset_appendix_subbook (EB_Book *<var>app</var>)</code></a></h4>
<p>
関数 <code>eb_unset_appendix_subbook()</code> は、<var>app</var> が選択
している副本を未選択の状態にします。
<var>app</var> が appendix に結び付いていないか、副本が選択されていない
場合は、何もしません。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_stop_code"><code>int eb_have_stop_code (EB_Book *<var>app</var>)</code></a></h4>
<p>
関数 <code>eb_have_stop_code()</code> は、<var>app</var> が選択中の副本で
区切りコードが定義されているかどうかを調べます。
</p>
<p>
定義していれば 1 を返します。
定義していないか、そもそも副本が選択されていない場合は 0 を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:stop_code"><code>EB_Error_Code eb_stop_code (EB_Book *<var>app</var>, int *<var>stop_code</var>)</code></a></h4>
<p>
関数 <code>eb_stop_code()</code> は、<var>app</var> が選択中の副本で定義
している区切りコードを <var>stop_code</var> の指す領域に書き込みます。
<var>stop_code[0]</var>, <var>stop_code[1]</var> に、区切りコードの値
としてそれぞれ <samp>0x0000</samp> 〜 <samp>0xffff</samp> が書き込まれます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、関数は <var>stop_code[0]</var> と <var>stop_code[1]</var>
に <samp>-1</samp> を書き込み、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>app</var> は副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_APPSUB</code> を返します。
副本が区切りコードを定義していない場合は、<code>EB_ERR_NO_STOPCODE</code>
を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_narrow_alt"><code>int eb_have_narrow_alt (EB_Book *<var>app</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:have_wide_alt"><code>int eb_have_wide_alt (EB_Book *<var>app</var>)</code></a></h4>
<p>
関数 <code>eb_have_narrow_alt()</code> は、選択中の副本が半角外字に対する
代替文字列を定義しているかどうかを調べます。
同様に、関数 <code>eb_have_wide_alt()</code> は、全角外字に対する
代替文字列を定義しているかどうかを調べます。
</p>
<p>
定義していれば 1 を、定義していなければ 0 を返します。
<var>app</var> が副本を選択していない場合も 0 を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_alt_start"><code>EB_Error_Code eb_narrow_alt_start (EB_Book *<var>app</var>, int *<var>start</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_alt_start"><code>EB_Error_Code eb_wide_alt_start (EB_Book *<var>app</var>, int *<var>start</var>)</code></a></h4>
<p>
関数 <code>eb_narrow_alt_start()</code> は、<var>app</var> が選択中の副本
における半角外字に対する代替文字列の定義範囲を調べ、先頭の文字番号
(半角外字の文字番号の中で最小のもの) を <var>start</var> の指す領域に
書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>app</var> は副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_APPSUB</code> を返します。
副本が半角外字に対する代替文字列を定義していない場合は、
<code>EB_ERR_NO_ALT</code> を返します。
</p>
<p>
関数 <code>eb_wide_font_start()</code> は、半角外字ではなく全角外字に
ついて調べるという点を除いて、<code>eb_narrow_font_start()</code> と同じ
です。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_alt_end"><code>EB_Error_Code eb_narrow_alt_end (EB_Book *<var>app</var>, int *<var>end</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_alt_end"><code>EB_Error_Code eb_wide_alt_end (EB_Book *<var>app</var>, int *<var>end</var>)</code></a></h4>
<p>
関数 <code>eb_narrow_alt_end()</code> は、<var>app</var> が選択中の副本
における半角外字に対する代替文字列の定義範囲を調べ、最後の文字番号
(半角外字の文字番号の中で最大のもの) を <var>start</var> の指す領域に
書き込みます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>app</var> は副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_APPSUB</code> を返します。
副本が半角外字に対する代替文字列を定義していない場合は、
<code>EB_ERR_NO_ALT</code> を返します。
</p>
<p>
関数 <code>eb_wide_font_start()</code> は、半角外字ではなく全角外字に
ついて調べるという点を除いて、<code>eb_narrow_font_start()</code> と同じ
です。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:narrow_alt_character_text"><code>EB_Error_Code eb_narrow_alt_character_text (EB_Book *<var>app</var>, int <code>character_number</code>, char *<var>text</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:wide_alt_character_text"><code>EB_Error_Code eb_wide_alt_character_text (EB_Book *<var>app</var>, int <code>character_number</code>, char *<var>text</var>)</code></a></h4>
<p>
関数 <code>eb_narrow_alt_character_text()</code> は、<var>book</var> が
選択中の副本で定義している、半角外字の代替文字列を取り出します。
外字の文字番号を、<var>character_number</var> で指定します。
</p>
<p>
成功すると、関数は代替文字列を <var>text</var> の指す領域に書き込み、
<code>EB_SUCCESS</code> を返します。
失敗すると、<var>text</var> の指す領域に空文字列を書き込み、原因を示す
エラーコードを返します。
</p>
<p>
代替文字列は最長で <code>EB_MAX_ALTERNATION_TEXT_LENGTH</code> バイト
(= 31 バイト) です。
ただし、この長さにはナル文字の分は含んでいないので、<var>text</var> の
領域にはもう 1 バイト分必要です。
</p>
<p>
代替文字列がどの文字コードで書かれているかは、appendix の中には
記録されていません。
しかし、appendix は必ず特定の書籍に対応して作成されるものなので、書籍の
文字コードから次のように判断すれば、問題ないでしょう。
</p>
<ul>
<li>書籍が ISO 8859-1 で書かれている場合は、代替文字列も ISO 8859-1
<li>それ以外の場合、代替文字列は日本語 EUC
</ul>
<p>
あらかじめ、<var>app</var> は副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_APPSUB</code> を返します。
文字番号 <var>character_number</var> が外字の定義範囲外にある場合は、
<code>EB_ERR_NO_SUCH_CHAR_TEXT</code> を返します。
</p>
<p>
副本が半角外字に対する代替文字列を (<var>character_number</var> に限らず
まったく) 定義していない場合は、<code>EB_ERR_NO_ALT</code> を返します。
そうではなく、一部の文字番号については半角外字に対する代替文字列を
定義しているものの、<var>character_number</var> に対する代替文字列は
存在しない場合、関数は <code>EB_SUCCESS</code> を返し、<var>text</var>
の指す領域には空文字列が書き込まれます。
</p>
<p>
関数 <code>eb_wide_alt_character_text()</code> は、半角外字ではなく
全角外字に対する代替文字列を取り出すという点を除いて、
<code>eb_narrow_alt_character_text()</code> と同じです。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:backward_narrow_alt_character"><code>EB_Error_Code eb_backward_narrow_alt_character (EB_Book *<var>book</var>, int <var>n</var>, int *<var>character_number</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:backward_wide_alt_character"><code>EB_Error_Code eb_backward_wide_alt_character (EB_Book *<var>book</var>, int <var>n</var>, int *<var>character_number</var>)</code></a></h4>
<p>
関数 <code>eb_forward_narrow_alt_character()</code> は、<var>app</var>
が選択中の副本において定義されている、半角外字に対する代替文字列の
文字番号 <var>character_number</var> の <var>n</var> 個後ろに位置する
文字の文字番号を取得します。
</p>
<p>
まず、関数を呼び出す際に、<var>character_number</var> の指す領域に
文字番号を書き込んでおきます。
関数の処理が成功すると、戻ったときに <var>n</var> 個分だけ後方の文字番号
に書き換わっています。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、原因を示すエラーコードを返します。
</p>
<p>
あらかじめ、<var>app</var> は副本を選択していなくてはなりません。
選択していない場合は、<code>EB_ERR_NO_CUR_APPSUB</code> を返します。
副本が半角外字に対する代替文字列を定義していない場合は、
<code>EB_ERR_NO_ALT</code> を返します。
</p>
<p>
<var>n</var> 個後ろにもう外字がない場合や、呼び出した際に
<var>character_number</var> の指す領域に書き込んであった文字番号が外字の
定義範囲外にある場合は <code>EB_ERR_NO_SUCH_CHAR_TEXT</code> を返します。
</p>
<p>
<var>n</var> には負の数を指定することもできます。
この場合、次の呼び出しと等価になります。
</p>
<blockquote class="program">
<pre>
/* n < 0 とする */
eb_backward_narrow_font_character (book, -n, character_number);
</pre>
</blockquote>
<p>
関数 <code>eb_forward_wide_alt_character()</code> は、半角外字ではなく
全角外字について操作するという点を除いて、
<code>eb_forward_narrow_alt_character()</code> と同じです。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="appendix-sample">サンプルプログラム</a></h3>
<blockquote>
<pre>
/* -*- C -*-
* Copyright (c) 2003-2006 Motoyuki Kasahara
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the project nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* 使用方法:
* font <appendix-path> <subbook-index>
* 例:
* font /cdrom 0
* 説明:
* <appendix-path> で指定した appendix から特定の副本を選び、そ
* の副本が定義している半角外字の代替文字列をすべて表示します。
*
* その appendix が、半角外字の代替文字列を定義していないと、エ
* ラーになります。
*
* <subbook-index> には、操作対象の副本のインデックスを指定しま
* す。インデックスは、書籍の最初の副本から順に 0、1、2 ... に
* なります。
*/
#include <stdio.h>
#include <stdlib.h>
#include <eb/eb.h>
#include <eb/error.h>
#include <eb/appendix.h>
int
main(int argc, char *argv[])
{
EB_Error_Code error_code;
EB_Appendix app;
EB_Subbook_Code subbook_list[EB_MAX_SUBBOOKS];
int subbook_count;
int subbook_index;
int alt_start;
char text[EB_MAX_ALTERNATION_TEXT_LENGTH + 1];
int i;
/* コマンド行引数をチェック。*/
if (argc != 3) {
fprintf(stderr, "Usage: %s appendix-path subbook-index\n",
argv[0]);
exit(1);
}
/* EB ライブラリと `app' を初期化。*/
eb_initialize_library();
eb_initialize_appendix(&app);
/* appendix を `app' に結び付ける。*/
error_code = eb_bind_appendix(&app, argv[1]);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to bind the app, %s: %s\n",
argv[0], eb_error_message(error_code), argv[1]);
goto die;
}
/* 副本の一覧を取得。*/
error_code = eb_appendix_subbook_list(&app, subbook_list,
&subbook_count);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get the subbook list, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* 副本のインデックスを取得。*/
subbook_index = atoi(argv[2]);
/*「現在の副本 (current subbook)」を設定。*/
if (eb_set_appendix_subbook(&app, subbook_list[subbook_index])
< 0) {
fprintf(stderr, "%s: failed to set the current subbook, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* 外字の開始位置を取得。*/
error_code = eb_narrow_alt_start(&app, &alt_start);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get font information, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
i = alt_start;
for (;;) {
/* 外字の代替文字列を取得。*/
error_code = eb_narrow_alt_character_text(&app, i, text);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get font data, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
/* 取得した代替文字列を出力。*/
printf("%04x: %s\n", i, text);
/* 外字の文字番号を一つ進める。*/
error_code = eb_forward_narrow_alt_character(&app, 1, &i);
if (error_code != EB_SUCCESS)
break;
}
/* appendix と EB ライブラリの利用を終了。*/
eb_finalize_appendix(&app);
eb_finalize_library();
exit(0);
/* エラー発生で終了するときの処理。*/
die:
eb_finalize_appendix(&app);
eb_finalize_library();
exit(1);
}
</pre>
</blockquote>
<!-- ================================================================ -->
<h2><a name="book-list-on-server">サーバ上の書籍一覧</a></h2>
<p>
EBNET サーバから遠隔アクセスを行う際、サーバがそのクライアントに対して
アクセスを許可している書籍や appendix データの一覧を取得することが
できます。
</p>
<p>
このとき、EBNET サーバを指定する遠隔アクセス記述子には、特定の書籍や
appendix データに対するアクセスとは異なり、書籍名は指定しません。
すなわち、一般形は次のようになります。
</p>
<blockquote>
<pre>
ebnet://<var>ホスト</var>:<var>ポート</var>/
</pre>
</blockquote>
<p>
末尾の `/' はなくても構いません。
<samp>:</samp> とそれに続くポート番号は省略可能で、その場合は
22010 番ポートを利用することを意味します。
</p>
<p>
ebinfo コマンドの --book-list オプション指定時の挙動は、EB ライブラリ
のこの機能によって実装されています。
(ebinfo についての詳細は、
@pxref{Book list on EBNET server, , EBNET サーバの書籍一覧, ebinfo-ja, ebinfo-ja}。)
</p>
<blockquote>
<pre>
% ebinfo --book-list ebnet://localhost
名前 題名
encycl ブラウンコンサイス百科事典
encycl.app ブラウンコンサイス百科事典 (appendix)
crossword クロスワードパズル辞典
travel ワールドトラベルガイド
</pre>
</blockquote>
<p>
名前の末尾が <samp>.app</samp> になっているものは appendix データで、
その他は書籍本体です。
この例の書籍 <samp>encycl</samp> に対してアクセスするなら、
遠隔アクセス識別子は <code>ebnet://localhost/encycl</code> になります。
</p>
<p>
なお、クライアントに対してアクセスを許可していない書籍や appendix データ
は、サーが側で一覧から除外されます。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="eb_booklist-object"><code>EB_BookList</code> オブジェクト</a></h3>
<p>
EBNET サーバの提供する書籍および appendix データの一覧を取得するには、
まず <code>EB_BookList</code> 型のオブジェクトを用意する必要があります。
</p>
<blockquote class="program">
<pre>
EB_BookList bl;
</pre>
</blockquote>
<p>
オブジェクトの領域は、<code>malloc()</code> で確保しても構いません。
</p>
<blockquote class="program">
<pre>
EB_BookList *bl_pointer;
bl_pointer = (EB_BookList *) malloc(sizeof(EB_BookList));
</pre>
</blockquote>
<p>
<code>EB_Book</code> オブジェクトと同様に、<code>EB_BookList</code>
オブジェクトも使う前に中身を初期化する必要があります。
これは、<code>eb_initialize_booklist()</code> という関数で行います。
</p>
<blockquote class="program">
<pre>
eb_initialize_booklist(&bl);
eb_initialize_booklist(bl_pointer);
</pre>
</blockquote>
<p>
初期化が完了したら、特定のサーバとオブジェクトを結びつけます。
たとえば、<code>ebnet://localhost</code> で表されるサーバに対して、
オブジェクトを結びつけるには次のようにします。
</p>
<blockquote class="program">
<pre>
if (eb_bind_booklist(&bl, "ebnet://localhost") != EB_SUCCESS) {
printf("eb_bind_booklist() failed\n");
return;
}
</pre>
</blockquote>
<p>
これはちょうど、<code>EB_Book</code> オブジェクトに対して
<code>eb_bind()</code> を呼ぶのと同じです。
</p>
<p>
こうして、ようやく書籍一覧の情報を取り出すことができます。
これには <code>eb_booklist_book_count()</code>,
<code>eb_booklist_book_name()</code>, <code>eb_booklist_book_title()</code>
という 3 つの関数を使用します。
これらの関数はそれぞれ、クライアントがアクセス可能な書籍の数、各書籍
および appendix データの名称 (アクセス識別子として指定する名前)、各書籍
と appendix データの題名を得ることができます。
</p>
<blockquote class="program">
<pre>
char *name, *title;
int count, i;
count = eb_booklist_book_count(&bl);
for (i = 0; i < count; i++) {
if (eb_booklist_book_name(&bl, i, &name) != EB_SUCCESS) {
printf("eb_booklist_book_name(%d) failed\n", i);
return;
}
if (eb_booklist_book_title(&bl, i, &title) != EB_SUCCESS) {
printf("eb_booklist_book_title(%d) failed\n", i);
return;
}
printf("name = %s, title = %s\n", name, title);
}
</pre>
</blockquote>
<p>
<code>EB_BookList</code> オブジェクトを使い終わったら、必ず後始末を
行います。
</p>
<blockquote class="program">
<pre>
eb_finalize_booklist(&bl);
eb_finalize_booklist(bl_pointer);
</pre>
</blockquote>
<p>
オブジェクトの領域を <code>malloc()</code> で確保した場合は、
<code>eb_finalize_booklist()</code> を呼んだ後ならば、オブジェクトの領域
を安全に解放することができます。
</p>
<blockquote class="program">
<pre>
free(bl_pointer);
</pre>
</blockquote>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="booklist-data">データ型の詳細</a></h3>
<p>
この節で説明しているデータ型を使うには、次のようにヘッダファイルを
読み込んで下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/booklist.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="type:BookList"><code>EB_BookList</code> 型</a></h4>
<p>
<code>EB_BookList</code> 型は、EBNET サーバ上が使っている書籍および
appendix の一覧を取得する際に用いるオクジェクトの型です。
</p>
<p>
<code>EB_BookList</code> オブジェクトを使用する際は、まずそのオブジェクト
に対して <code>eb_initialize_booklist()</code> を呼んで初期化する必要が
あります。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="booklist-functions">関数の詳細</a></h3>
<p>
この節で説明している関数を使うには、次のようにヘッダファイルを読み込んで
下さい。
</p>
<blockquote class="program">
<pre>
#include <eb/booklist.h>
</pre>
</blockquote>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:initialize_booklist"><code>void eb_initialize_booklist (EB_BookList *<var>bl</var>)</code></a></h4>
<p>
関数 <code>eb_initialize_booklist()</code> は、<var>bl</var> の指す
<code>EB_BookList</code> オブジェクトを初期化します。
<code>EB_BookList</code> オブジェクトに対して EB ライブラリの他の関数を
呼ぶ前に、必ずそのオブジェクトを初期化しなくてはなりません。
初期化していないオブジェクトに対して、EB ライブラリの他の関数を呼んだ
場合の動作は未定義です。
また、すでに初期化したオブジェクトに対して、
再度 <code>eb_initialize_booklist()</code> を呼んではいけません。
呼んだ場合の動作は未定義です。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:bind_booklist"><code>EB_Error_Code eb_bind_booklist (EB_BookList *<var>bl</var>, const char *<var>path</var>)</code></a></h4>
<p>
関数 <code>eb_bind_booklist()</code> は、<var>app</var> の指す
<code>EB_BookList</code> オブジェクトを、遠隔アクセス記述子 <var>path</var>
で指定された EBNET サーバに結び付けます。
</p>
<p>
オブジェクトがすでにサーバに結び付いていた場合、そのサーバとの結び付き
を解いてから、<var>path</var> にあるサーバに結び付けます。
</p>
<p>
成功すると、関数は <code>EB_SUCCESS</code> を返します。
失敗すると、オブジェクトをサーバとの結び付きを解かれた状態にして、原因
を示すエラーコードを返します。
</p>
<p>
<var>path</var> は、<code>EB_MAX_PATH_LENGTH</code> バイトに収まて
いなくてはなりません。
これを超えると、<code>EB_ERR_TOO_LONG_FILE_NAME</code> を返します。
また、書籍名を指定していない遠隔アクセス記述子でなければなりません。
それ以外の形式だと、<code>EB_ERR_BAD_FILE_NAME</code> を返します。
</p>
<p>
使用している EB ライブラリのバイナリが、遠隔アクセスに非対応のもので
ある場合、<code>EB_ERR_EBNET_UNSUPPORTED</code> が返ります。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:finalize_booklist"><code>void eb_finalize_booklist (EB_BookList *<var>bl</var>)</code></a></h4>
<p>
関数 <code>eb_finalize_booklist()</code> は、<var>bl</var> が指す
<code>EB_BookList</code> オブジェクトの後始末を行います。
</p>
<p>
オブジェクトが割り当てて管理していたメモリはすべて解放され、
ファイルディスクリプタもすべて閉じられます。
オブジェクトが EBNET サーバと結び付いていた場合は、結び付きが解かれます。
</p>
<p>
後始末をしたオブジェクトに対して <code>eb_bind_booklist()</code> を呼ぶ
ことで、オブジェクトを再利用することができます。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:booklist_book_count"><code>int eb_booklist_book_count (EB_BookList *<var>bl</var>)</code></a></h4>
<p>
関数 <code>eb_booklist_book_count()</code> は、EBNET サーバがこの
クライアントに対してアクセスを許可している書籍および appendix データの数
を取得します。
</p>
<p>
オブジェクト <var>bl</var> の指す <code>EB_BookList</code> オブジェクトは、
あらかじめ EBNET サーバに結びついている必要があります。
結びついていない場合は、<code>EB_ERR_UNBOUND_BOOKLIST</code> を返します。
</p>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:booklist_book_name"><code>EB_Error_Code eb_booklist_book_name (EB_BookList *<var>bl</var>, int <var>i</var>, char **<var>name</var>)</code></a></h4>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<h4><a name="func:booklist_book_title"><code>EB_Error_Code eb_booklist_book_title (EB_BookList *<var>bl</var>, int <var>i</var>, char **<var>title</var>)</code></a></h4>
<p>
関数 <code>eb_booklist_book_name()</code> は、EBNET サーバの書籍や
appendix データの名称を取得します。
ここで言う「名称」とは、遠隔アクセス識別子で指定する書籍名のことです。
つまり、<samp>ebnet://localhost/dict</samp> の <samp>dict</samp> の部分
を指します。
同様に、関数 <code>eb_booklist_book_title()</code> は、書籍や appendix
の題名を取得します。
</p>
<p>
いずれの関数も、EBNET サーバ上の何番目の書籍もしくは appendix の情報を
取得するのかを、引数 <var>i</var> で指定します。
先頭は 1 番目ではなく 0 番目になります。
</p>
<p>
成功すると、関数は書籍の名称、題名へのポインタを *<var>name</var>,
*<var>title</var> に書き込み、<code>EB_SUCCESS</code> を返します。
なお、このポインタ値は オブジェクト <code>bl</code> が保持している
文字列を指すようになっています。
<code>bl</code> に対して <code>eb_finalize_booklist()</code> を呼んで
しまうと、この文字列も参照不可能になってしまいますので、注意して下さい。
</p>
<p>
オブジェクト <var>bl</var> の指す <code>EB_BookList</code> オブジェクト
は、あらかじめ EBNET サーバに結びついている必要があります。
結びついていない場合は、<code>EB_ERR_UNBOUND_BOOKLIST</code> を返します。
また、<var>i</var> は 0 以上かつサーバが提供している書籍および appendix
の総数未満でなければなりません。
これ以外の値のときは、<code>EB_ERR_NO_SUCH_BOOK</code> が返ります。
</p>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="booklist-sample">サンプルプログラム</a></h3>
<blockquote>
<pre>
/* -*- C -*-
* Copyright (c) 2003-2006 Motoyuki Kasahara
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the project nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* 使用方法:
* booklist <remote-access-ideintifier>
* 例:
* booklist ebnet://localhost
* 説明:
* <remote-access-ideintifier> で指定した EBNET サーバに接続し
* て、サーバの提供する書籍、appendix の一覧を表示します。
*/
#include <stdio.h>
#include <stdlib.h>
#include <eb/eb.h>
#include <eb/error.h>
#include <eb/booklist.h>
int
main(int argc, char *argv[])
{
EB_Error_Code error_code;
EB_BookList bl;
int book_count;
char *name, *title;
int i;
/* コマンド行引数をチェック。*/
if (argc != 2) {
fprintf(stderr, "Usage: %s book-path remote-access-identifier\n",
argv[0]);
exit(1);
}
/* EB ライブラリと `bl' を初期化。*/
eb_initialize_library();
eb_initialize_booklist(&bl);
/* EBNET サーバを `bl' に結び付ける。*/
error_code = eb_bind_booklist(&bl, argv[1]);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to bind the EBNET server, %s: %s\n",
argv[0], eb_error_message(error_code), argv[1]);
goto die;
}
/* サーバ上の書籍、appendix の個数を取得。*/
error_code = eb_booklist_book_count(&bl, &book_count);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get the number of books, %s\n",
argv[0], eb_error_message(error_code));
goto die;
}
for (i = 0; i < book_count; i++) {
/* 書籍、appendix の名称を取得。*/
error_code = eb_booklist_book_name(&bl, i, &name);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get book name #%d, %s\n",
argv[0], i, eb_error_message(error_code));
goto die;
}
/* 書籍、appendix の題名を取得。*/
error_code = eb_booklist_book_name(&bl, i, &title);
if (error_code != EB_SUCCESS) {
fprintf(stderr, "%s: failed to get book title #%d, %s\n",
argv[0], i, eb_error_message(error_code));
goto die;
}
printf("%-20s %s\n", name, title);
}
/* `bl' と EB ライブラリの利用を終了。*/
eb_finalize_booklist(&bl);
eb_finalize_library();
exit(0);
/* エラー発生で終了するときの処理。*/
die:
eb_finalize_booklist(&bl);
eb_finalize_library();
exit(1);
}
</pre>
</blockquote>
<!-- ================================================================ -->
<h2><a name="indice">索引</a></h2>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="data-type-index">データ型の索引</a></h3>
<p>
型名の先頭の <code>EB_</code> は省略しています。
</p>
<dl>
<dt>A
<dd><a href="#type:Appendix">Appendix</a>
<dt>B
<dd><a href="#type:Book">Book</a>
<dd><a href="#type:BookList">BookList</a>
<dt>D
<dd><a href="#type:Disc_Code">Disc_Code</a>
<dt>E
<dd><a href="#type:EB_Character_Code">EB_Character_Code</a>
<dd><a href="#type:Error_Code">Error_Code</a>
<dt>F
<dd><a href="#type:Font_Code">Font_Code</a>
<dt>H
<dd><a href="#type:Hit">Hit</a>
<dd><a href="#type:Hook">Hook</a>
<dd><a href="#type:Hook_Code">Hook_Code</a>
<dd><a href="#type:Hookset">Hookset</a>
<dt>M
<dd><a href="#type:Multi_Search_Code">Multi_Search_Code</a>
<dt>P
<dd><a href="#type:Position">Position</a>
<dt>S
<dd><a href="#type:Subbook_Code">Subbook_Code</a>
</dl>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="function-index">関数の索引</a></h3>
<p>
関数名の先頭の <code>eb_</code> は省略しています。
</p>
<dl>
<dt>A
<dd><a href="#func:appendix_path">appendix_path</a>
<dd><a href="#func:appendix_subbook">appendix_subbook</a>
<dd><a href="#func:appendix_subbook_directory">appendix_subbook_directory</a>
<dd><a href="#func:appendix_subbook_directory2">appendix_subbook_directory2</a>
<dd><a href="#func:appendix_subbook_list">appendix_subbook_list</a>
<dt>B
<dd><a href="#func:backward_narrow_alt_character">backward_narrow_alt_character</a>
<dd><a href="#func:backward_narrow_font_character">backward_narrow_font_character</a>
<dd><a href="#func:backward_text">backward_text</a>
<dd><a href="#func:backward_wide_alt_character">backward_wide_alt_character</a>
<dd><a href="#func:backward_wide_font_character">backward_wide_font_character</a>
<dd><a href="#func:bind">bind</a>
<dd><a href="#func:bind_appendix">bind_appendix</a>
<dd><a href="#func:bind_booklist">bind_booklist</a>
<dd><a href="#func:bitmap_to_bmp">bitmap_to_bmp</a>
<dd><a href="#func:bitmap_to_gif">bitmap_to_gif</a>
<dd><a href="#func:bitmap_to_png">bitmap_to_png</a>
<dd><a href="#func:bitmap_to_xbm">bitmap_to_xbm</a>
<dd><a href="#func:bitmap_to_xpm">bitmap_to_xpm</a>
<dd><a href="#func:booklist_book_count">booklist_book_count</a>
<dd><a href="#func:booklist_book_name">booklist_book_name</a>
<dd><a href="#func:booklist_book_title">booklist_book_title</a>
<dt>C
<dd><a href="#func:character_code">character_code</a>
<dd><a href="#func:compose_movie_file_name">compose_movie_file_name</a>
<dd><a href="#func:compose_movie_path_name">compose_movie_path_name</a>
<dd><a href="#func:copyright">copyright</a>
<dd><a href="#func:current_candidate">current_candidate</a>
<dt>D
<dd><a href="#func:decompose_movie_file_name">decompose_movie_file_name</a>
<dd><a href="#func:disc_type">disc_type</a>
<dt>E
<dd><a href="#func:error_message">error_message</a>
<dd><a href="#func:error_string">error_string</a>
<dt>F
<dd><a href="#func:finalize_appendix">finalize_appendix</a>
<dd><a href="#func:finalize_book">finalize_book</a>
<dd><a href="#func:finalize_booklist">finalize_booklist</a>
<dd><a href="#func:finalize_hookset">finalize_hookset</a>
<dd><a href="#func:finalize_library">finalize_library</a>
<dd><a href="#func:font">font</a>
<dd><a href="#func:font_height">font_height</a>
<dd><a href="#func:font_height2">font_height2</a>
<dd><a href="#func:font_list">font_list</a>
<dd><a href="#func:forward_heading">forward_heading</a>
<dd><a href="#func:forward_narrow_font_character">forward_narrow_font_character</a>
<dd><a href="#func:forward_text">forward_text</a>
<dd><a href="#func:forward_wide_font_character">forward_wide_font_character</a>
<dt>H
<dd><a href="#func:have_copyright">have_copyright</a>
<dd><a href="#func:have_endword_search">have_endword_search</a>
<dd><a href="#func:have_exactword_search">have_exactword_search</a>
<dd><a href="#func:have_font">have_font</a>
<dd><a href="#func:have_keyword_search">have_keyword_search</a>
<dd><a href="#func:have_menu">have_menu</a>
<dd><a href="#func:have_multi_search">have_multi_search</a>
<dd><a href="#func:have_narrow_alt">have_narrow_alt</a>
<dd><a href="#func:have_narrow_font">have_narrow_font</a>
<dd><a href="#func:have_stop_code">have_stop_code</a>
<dd><a href="#func:have_text">have_text</a>
<dd><a href="#func:have_wide_alt">have_wide_alt</a>
<dd><a href="#func:have_wide_font">have_wide_font</a>
<dd><a href="#func:have_word_search">have_word_search</a>
<dd><a href="#func:hit_list">hit_list</a>
<dd><a href="#func:hook_empty">hook_empty</a>
<dd><a href="#func:hook_euc_to_ascii">hook_euc_to_ascii</a>
<dd><a href="#func:hook_narrow_character_text">hook_narrow_character_text</a>
<dd><a href="#func:hook_newline">hook_newline</a>
<dd><a href="#func:hook_wide_character_text">hook_wide_character_text</a>
<dt>I
<dd><a href="#func:initialize_appendix">initialize_appendix</a>
<dd><a href="#func:initialize_book">initialize_book</a>
<dd><a href="#func:initialize_booklist">initialize_booklist</a>
<dd><a href="#func:initialize_hookset">initialize_hookset</a>
<dd><a href="#func:initialize_library">initialize_library</a>
<dd><a href="#func:is_appendix_bound">is_appendix_bound</a>
<dd><a href="#func:is_bound">is_bound</a>
<dd><a href="#func:is_text_stopped">is_text_stopped</a>
<dt>L
<dd><a href="#func:load_all_appendix_subbooks">load_all_appendix_subbooks</a>
<dd><a href="#func:load_all_subbooks">load_all_subbooks</a>
<dt>M
<dd><a href="#func:menu">menu</a>
<dd><a href="#func:multi_entry_candidates">multi_entry_candidates</a>
<dd><a href="#func:multi_entry_count">multi_entry_count</a>
<dd><a href="#func:multi_entry_have_candidates">multi_entry_have_candidates</a>
<dd><a href="#func:multi_entry_label">multi_entry_label</a>
<dd><a href="#func:multi_search_list">multi_search_list</a>
<dd><a href="#func:multi_title">multi_title</a>
<dt>N
<dd><a href="#func:narrow_alt_character_text">narrow_alt_character_text</a>
<dd><a href="#func:narrow_alt_end">narrow_alt_end</a>
<dd><a href="#func:narrow_alt_start">narrow_alt_start</a>
<dd><a href="#func:narrow_font_bmp_size">narrow_font_bmp_size</a>
<dd><a href="#func:narrow_font_character_bitmap">narrow_font_character_bitmap</a>
<dd><a href="#func:narrow_font_end">narrow_font_end</a>
<dd><a href="#func:narrow_font_gif_size">narrow_font_gif_size</a>
<dd><a href="#func:narrow_font_png_size">narrow_font_png_size</a>
<dd><a href="#func:narrow_font_size">narrow_font_size</a>
<dd><a href="#func:narrow_font_size2">narrow_font_size2</a>
<dd><a href="#func:narrow_font_start">narrow_font_start</a>
<dd><a href="#func:narrow_font_width">narrow_font_width</a>
<dd><a href="#func:narrow_font_width2">narrow_font_width2</a>
<dd><a href="#func:narrow_font_xbm_size">narrow_font_xbm_size</a>
<dd><a href="#func:narrow_font_xpm_size">narrow_font_xpm_size</a>
<dt>P
<dd><a href="#func:path">path</a>
<dt>R
<dd><a href="#func:read_binary">read_binary</a>
<dd><a href="#func:read_heading">read_heading</a>
<dd><a href="#func:read_rawtext">read_rawtext</a>
<dd><a href="#func:read_text">read_text</a>
<dt>S
<dd><a href="#func:search_cross">search_cross</a>
<dd><a href="#func:search_endword">search_endword</a>
<dd><a href="#func:search_exactword">search_exactword</a>
<dd><a href="#func:search_keyword">search_keyword</a>
<dd><a href="#func:search_multi">search_multi</a>
<dd><a href="#func:search_word">search_word</a>
<dd><a href="#func:seek_text">seek_text</a>
<dd><a href="#func:set_appendix_subbook">set_appendix_subbook</a>
<dd><a href="#func:set_binary_color_graphic">set_binary_color_graphic</a>
<dd><a href="#func:set_binary_mono_graphic">set_binary_mono_graphic</a>
<dd><a href="#func:set_binary_mpeg">set_binary_mpeg</a>
<dd><a href="#func:set_binary_wave">set_binary_wave</a>
<dd><a href="#func:set_font">set_font</a>
<dd><a href="#func:set_hook">set_hook</a>
<dd><a href="#func:set_hooks">set_hooks</a>
<dd><a href="#func:set_subbook">set_subbook</a>
<dd><a href="#func:stop_code">stop_code</a>
<dd><a href="#func:subbook">subbook</a>
<dd><a href="#func:subbook_directory">subbook_directory</a>
<dd><a href="#func:subbook_directory2">subbook_directory2</a>
<dd><a href="#func:subbook_list">subbook_list</a>
<dd><a href="#func:subbook_title">subbook_title</a>
<dd><a href="#func:subbook_title2">subbook_title2</a>
<dt>T
<dd><a href="#func:tell_text">tell_text</a>
<dd><a href="#func:text">text</a>
<dt>U
<dd><a href="#func:unset_appendix_subbook">unset_appendix_subbook</a>
<dd><a href="#func:unset_font">unset_font</a>
<dd><a href="#func:unset_subbook">unset_subbook</a>
<dt>W
<dd><a href="#func:wide_alt_character_text">wide_alt_character_text</a>
<dd><a href="#func:wide_alt_end">wide_alt_end</a>
<dd><a href="#func:wide_alt_start">wide_alt_start</a>
<dd><a href="#func:wide_font_bmp_size">wide_font_bmp_size</a>
<dd><a href="#func:wide_font_character_bitmap">wide_font_character_bitmap</a>
<dd><a href="#func:wide_font_end">wide_font_end</a>
<dd><a href="#func:wide_font_gif_size">wide_font_gif_size</a>
<dd><a href="#func:wide_font_png_size">wide_font_png_size</a>
<dd><a href="#func:wide_font_size">wide_font_size</a>
<dd><a href="#func:wide_font_size2">wide_font_size2</a>
<dd><a href="#func:wide_font_start">wide_font_start</a>
<dd><a href="#func:wide_font_width">wide_font_width</a>
<dd><a href="#func:wide_font_width2">wide_font_width2</a>
<dd><a href="#func:wide_font_xbm_size">wide_font_xbm_size</a>
<dd><a href="#func:wide_font_xpm_size">wide_font_xpm_size</a>
<dd><a href="#func:write_text">write_text</a>
<dd><a href="#func:write_text_byte1">write_text_byte1</a>
<dd><a href="#func:write_text_byte2">write_text_byte2</a>
<dd><a href="#func:write_text_string">write_text_string</a>
</dl>
<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
<h3><a name="const-index">定数の索引</a></h3>
<p>
定数名の先頭の <code>EB_</code> は省略しています。
</p>
<dl>
<dt>E
<dd><a href="#const:ERR_BAD_DIR_NAME">ERR_BAD_DIR_NAME</a>
<dd><a href="#const:ERR_BAD_FILE_NAME">ERR_BAD_FILE_NAME</a>
<dd><a href="#const:ERR_BAD_WORD">ERR_BAD_WORD</a>
<dd><a href="#const:ERR_DIFF_CONTENT">ERR_DIFF_CONTENT</a>
<dd><a href="#const:ERR_EBNET_FAIL_CONNECT">ERR_EBNET_FAIL_CONNECT</a>
<dd><a href="#const:ERR_EBNET_NO_PERMISSION">ERR_EBNET_NO_PERMISSION</a>
<dd><a href="#const:ERR_EBNET_SERVER_BUSY">ERR_EBNET_SERVER_BUSY</a>
<dd><a href="#const:ERR_EBNET_UNSUPPORTED">ERR_EBNET_UNSUPPORTED</a>
<dd><a href="#const:ERR_EMPTY_WORD">ERR_EMPTY_WORD</a>
<dd><a href="#const:ERR_END_OF_CONTENT">ERR_END_OF_CONTENT</a>
<dd><a href="#const:ERR_FAIL_GETCWD">ERR_FAIL_GETCWD</a>
<dd><a href="#const:ERR_FAIL_OPEN_APP">ERR_FAIL_OPEN_APP</a>
<dd><a href="#const:ERR_FAIL_OPEN_BINARY">ERR_FAIL_OPEN_BINARY</a>
<dd><a href="#const:ERR_FAIL_OPEN_CAT">ERR_FAIL_OPEN_CAT</a>
<dd><a href="#const:ERR_FAIL_OPEN_CATAPP">ERR_FAIL_OPEN_CATAPP</a>
<dd><a href="#const:ERR_FAIL_OPEN_FONT">ERR_FAIL_OPEN_FONT</a>
<dd><a href="#const:ERR_FAIL_OPEN_TEXT">ERR_FAIL_OPEN_TEXT</a>
<dd><a href="#const:ERR_FAIL_READ_APP">ERR_FAIL_READ_APP</a>
<dd><a href="#const:ERR_FAIL_READ_BINARY">ERR_FAIL_READ_BINARY</a>
<dd><a href="#const:ERR_FAIL_READ_CAT">ERR_FAIL_READ_CAT</a>
<dd><a href="#const:ERR_FAIL_READ_CATAPP">ERR_FAIL_READ_CATAPP</a>
<dd><a href="#const:ERR_FAIL_READ_FONT">ERR_FAIL_READ_FONT</a>
<dd><a href="#const:ERR_FAIL_READ_TEXT">ERR_FAIL_READ_TEXT</a>
<dd><a href="#const:ERR_FAIL_SEEK_APP">ERR_FAIL_SEEK_APP</a>
<dd><a href="#const:ERR_FAIL_SEEK_BINARY">ERR_FAIL_SEEK_BINARY</a>
<dd><a href="#const:ERR_FAIL_SEEK_CAT">ERR_FAIL_SEEK_CAT</a>
<dd><a href="#const:ERR_FAIL_SEEK_CATAPP">ERR_FAIL_SEEK_CATAPP</a>
<dd><a href="#const:ERR_FAIL_SEEK_FONT">ERR_FAIL_SEEK_FONT</a>
<dd><a href="#const:ERR_FAIL_SEEK_TEXT">ERR_FAIL_SEEK_TEXT</a>
<dd><a href="#const:ERR_MEMORY_EXHAUSTED">ERR_MEMORY_EXHAUSTED</a>
<dd><a href="#const:ERR_NO_APPSUB">ERR_NO_APPSUB</a>
<dd><a href="#const:ERR_NO_CANDIDATES">ERR_NO_CANDIDATES</a>
<dd><a href="#const:ERR_NO_CUR_APPSUB">ERR_NO_CUR_APPSUB</a>
<dd><a href="#const:ERR_NO_CUR_BINARY">ERR_NO_CUR_BINARY</a>
<dd><a href="#const:ERR_NO_CUR_FONT">ERR_NO_CUR_FONT</a>
<dd><a href="#const:ERR_NO_CUR_SUB">ERR_NO_CUR_SUB</a>
<dd><a href="#const:ERR_NO_FONT">ERR_NO_FONT</a>
<dd><a href="#const:ERR_NO_PREV_SEARCH">ERR_NO_PREV_SEARCH</a>
<dd><a href="#const:ERR_NO_PREV_SEEK">ERR_NO_PREV_SEEK</a>
<dd><a href="#const:ERR_NO_SUB">ERR_NO_SUB</a>
<dd><a href="#const:ERR_NO_SUCH_APPSUB">ERR_NO_SUCH_APPSUB</a>
<dd><a href="#const:ERR_NO_SUCH_BINARY">ERR_NO_SUCH_BINARY</a>
<dd><a href="#const:ERR_NO_SUCH_BOOK">ERR_NO_SUCH_BOOK</a>
<dd><a href="#const:ERR_NO_SUCH_CHAR_BMP">ERR_NO_SUCH_CHAR_BMP</a>
<dd><a href="#const:ERR_NO_SUCH_CHAR_TEXT">ERR_NO_SUCH_CHAR_TEXT</a>
<dd><a href="#const:ERR_NO_SUCH_ENTRY_ID">ERR_NO_SUCH_ENTRY_ID</a>
<dd><a href="#const:ERR_NO_SUCH_FONT">ERR_NO_SUCH_FONT</a>
<dd><a href="#const:ERR_NO_SUCH_HOOK">ERR_NO_SUCH_HOOK</a>
<dd><a href="#const:ERR_NO_SUCH_MULTI_ID">ERR_NO_SUCH_MULTI_ID</a>
<dd><a href="#const:ERR_NO_SUCH_SEARCH">ERR_NO_SUCH_SEARCH</a>
<dd><a href="#const:ERR_NO_SUCH_SUB">ERR_NO_SUCH_SUB</a>
<dd><a href="#const:ERR_NO_TEXT">ERR_NO_TEXT</a>
<dd><a href="#const:ERR_NO_WORD">ERR_NO_WORD</a>
<dd><a href="#const:ERR_TOO_LONG_FILE_NAME">ERR_TOO_LONG_FILE_NAME</a>
<dd><a href="#const:ERR_TOO_LONG_WORD">ERR_TOO_LONG_WORD</a>
<dd><a href="#const:ERR_TOO_MANY_WORDS">ERR_TOO_MANY_WORDS</a>
<dd><a href="#const:ERR_UNBOUND_APP">ERR_UNBOUND_APP</a>
<dd><a href="#const:ERR_UNBOUND_BOOK">ERR_UNBOUND_BOOK</a>
<dd><a href="#const:ERR_UNBOUND_BOOKLIST">ERR_UNBOUND_BOOKLIST</a>
<dd><a href="#const:ERR_UNEXP_APP">ERR_UNEXP_APP</a>
<dd><a href="#const:ERR_UNEXP_BINARY">ERR_UNEXP_BINARY</a>
<dd><a href="#const:ERR_UNEXP_CAT">ERR_UNEXP_CAT</a>
<dd><a href="#const:ERR_UNEXP_CATAPP">ERR_UNEXP_CATAPP</a>
<dd><a href="#const:ERR_UNEXP_FONT">ERR_UNEXP_FONT</a>
<dd><a href="#const:ERR_UNEXP_TEXT">ERR_UNEXP_TEXT</a>
<dt>H
<dd><a href="#const:HEIGHT_NARROW_FONT_16">HEIGHT_NARROW_FONT_16</a>
<dd><a href="#const:HEIGHT_NARROW_FONT_24">HEIGHT_NARROW_FONT_24</a>
<dd><a href="#const:HEIGHT_NARROW_FONT_30">HEIGHT_NARROW_FONT_30</a>
<dd><a href="#const:HEIGHT_NARROW_FONT_48">HEIGHT_NARROW_FONT_48</a>
<dd><a href="#const:HEIGHT_WIDE_FONT_16">HEIGHT_WIDE_FONT_16</a>
<dd><a href="#const:HEIGHT_WIDE_FONT_24">HEIGHT_WIDE_FONT_24</a>
<dd><a href="#const:HEIGHT_WIDE_FONT_30">HEIGHT_WIDE_FONT_30</a>
<dd><a href="#const:HEIGHT_WIDE_FONT_48">HEIGHT_WIDE_FONT_48</a>
<dd><a href="#const:HOOK_BEGIN_CANDIDATE">HOOK_BEGIN_CANDIDATE</a>
<dd><a href="#const:HOOK_BEGIN_CLICKABLE_AREA">HOOK_BEGIN_CLICKABLE_AREA</a>
<dd><a href="#const:HOOK_BEGIN_COLOR_BMP">HOOK_BEGIN_COLOR_BMP</a>
<dd><a href="#const:HOOK_BEGIN_COLOR_JPEG">HOOK_BEGIN_COLOR_JPEG</a>
<dd><a href="#const:HOOK_BEGIN_DECORATION">HOOK_BEGIN_DECORATION</a>
<dd><a href="#const:HOOK_BEGIN_EMPHASIS">HOOK_BEGIN_EMPHASIS</a>
<dd><a href="#const:HOOK_BEGIN_GRAY_GRAPHIC">HOOK_BEGIN_GRAY_GRAPHIC</a>
<dd><a href="#const:HOOK_BEGIN_IN_COLOR_BMP">HOOK_BEGIN_IN_COLOR_BMP</a>
<dd><a href="#const:HOOK_BEGIN_IN_COLOR_JPEG">HOOK_BEGIN_IN_COLOR_JPEG</a>
<dd><a href="#const:HOOK_BEGIN_KEYWORD">HOOK_BEGIN_KEYWORD</a>
<dd><a href="#const:HOOK_BEGIN_MONO_GRAPHIC">HOOK_BEGIN_MONO_GRAPHIC</a>
<dd><a href="#const:HOOK_BEGIN_MPEG">HOOK_BEGIN_MPEG</a>
<dd><a href="#const:HOOK_BEGIN_NARROW">HOOK_BEGIN_NARROW</a>
<dd><a href="#const:HOOK_BEGIN_NO_NEWLINE">HOOK_BEGIN_NO_NEWLINE</a>
<dd><a href="#const:HOOK_BEGIN_REFERENCE">HOOK_BEGIN_REFERENCE</a>
<dd><a href="#const:HOOK_BEGIN_SUBSCRIPT">HOOK_BEGIN_SUBSCRIPT</a>
<dd><a href="#const:HOOK_BEGIN_SUPERSCRIPT">HOOK_BEGIN_SUPERSCRIPT</a>
<dd><a href="#const:HOOK_BEGIN_WAVE">HOOK_BEGIN_WAVE</a>
<dd><a href="#const:HOOK_END_CANDIDATE_GROUP">HOOK_END_CANDIDATE_GROUP</a>
<dd><a href="#const:HOOK_END_CANDIDATE_LEAF">HOOK_END_CANDIDATE_LEAF</a>
<dd><a href="#const:HOOK_END_CLICKABLE_AREA">HOOK_END_CLICKABLE_AREA</a>
<dd><a href="#const:HOOK_END_COLOR_GRAPHIC">HOOK_END_COLOR_GRAPHIC</a>
<dd><a href="#const:HOOK_END_DECORATION">HOOK_END_DECORATION</a>
<dd><a href="#const:HOOK_END_EMPHASIS">HOOK_END_EMPHASIS</a>
<dd><a href="#const:HOOK_END_GRAY_GRAPHIC">HOOK_END_GRAY_GRAPHIC</a>
<dd><a href="#const:HOOK_END_IN_COLOR_GRAPHIC">HOOK_END_IN_COLOR_GRAPHIC</a>
<dd><a href="#const:HOOK_END_KEYWORD">HOOK_END_KEYWORD</a>
<dd><a href="#const:HOOK_END_MONO_GRAPHIC">HOOK_END_MONO_GRAPHIC</a>
<dd><a href="#const:HOOK_END_MPEG">HOOK_END_MPEG</a>
<dd><a href="#const:HOOK_END_NARROW">HOOK_END_NARROW</a>
<dd><a href="#const:HOOK_END_NO_NEWLINE">HOOK_END_NO_NEWLINE</a>
<dd><a href="#const:HOOK_END_REFERENCE">HOOK_END_REFERENCE</a>
<dd><a href="#const:HOOK_END_SUBSCRIPT">HOOK_END_SUBSCRIPT</a>
<dd><a href="#const:HOOK_END_SUPERSCRIPT">HOOK_END_SUPERSCRIPT</a>
<dd><a href="#const:HOOK_END_WAVE">HOOK_END_WAVE</a>
<dd><a href="#const:HOOK_GB2312">HOOK_GB2312</a>
<dd><a href="#const:HOOK_INITIALIZE">HOOK_INITIALIZE</a>
<dd><a href="#const:HOOK_ISO8859_1">HOOK_ISO8859_1</a>
<dd><a href="#const:HOOK_NARROW_FONT">HOOK_NARROW_FONT</a>
<dd><a href="#const:HOOK_NARROW_JISX0208">HOOK_NARROW_JISX0208</a>
<dd><a href="#const:HOOK_NEWLINE">HOOK_NEWLINE</a>
<dd><a href="#const:HOOK_NULL">HOOK_NULL</a>
<dd><a href="#const:HOOK_SET_INDENT">HOOK_SET_INDENT</a>
<dd><a href="#const:HOOK_WIDE_FONT">HOOK_WIDE_FONT</a>
<dd><a href="#const:HOOK_WIDE_JISX0208">HOOK_WIDE_JISX0208</a>
<dt>S
<dd><a href="#const:SIZE_NARROW_FONT_16">SIZE_NARROW_FONT_16</a>
<dd><a href="#const:SIZE_NARROW_FONT_16_BMP">SIZE_NARROW_FONT_16_BMP</a>
<dd><a href="#const:SIZE_NARROW_FONT_16_GIF">SIZE_NARROW_FONT_16_GIF</a>
<dd><a href="#const:SIZE_NARROW_FONT_16_PNG">SIZE_NARROW_FONT_16_PNG</a>
<dd><a href="#const:SIZE_NARROW_FONT_16_XBM">SIZE_NARROW_FONT_16_XBM</a>
<dd><a href="#const:SIZE_NARROW_FONT_16_XPM">SIZE_NARROW_FONT_16_XPM</a>
<dd><a href="#const:SIZE_NARROW_FONT_24">SIZE_NARROW_FONT_24</a>
<dd><a href="#const:SIZE_NARROW_FONT_24_BMP">SIZE_NARROW_FONT_24_BMP</a>
<dd><a href="#const:SIZE_NARROW_FONT_24_GIF">SIZE_NARROW_FONT_24_GIF</a>
<dd><a href="#const:SIZE_NARROW_FONT_24_PNG">SIZE_NARROW_FONT_24_PNG</a>
<dd><a href="#const:SIZE_NARROW_FONT_24_XBM">SIZE_NARROW_FONT_24_XBM</a>
<dd><a href="#const:SIZE_NARROW_FONT_24_XPM">SIZE_NARROW_FONT_24_XPM</a>
<dd><a href="#const:SIZE_NARROW_FONT_30">SIZE_NARROW_FONT_30</a>
<dd><a href="#const:SIZE_NARROW_FONT_30_BMP">SIZE_NARROW_FONT_30_BMP</a>
<dd><a href="#const:SIZE_NARROW_FONT_30_GIF">SIZE_NARROW_FONT_30_GIF</a>
<dd><a href="#const:SIZE_NARROW_FONT_30_PNG">SIZE_NARROW_FONT_30_PNG</a>
<dd><a href="#const:SIZE_NARROW_FONT_30_XBM">SIZE_NARROW_FONT_30_XBM</a>
<dd><a href="#const:SIZE_NARROW_FONT_30_XPM">SIZE_NARROW_FONT_30_XPM</a>
<dd><a href="#const:SIZE_NARROW_FONT_48">SIZE_NARROW_FONT_48</a>
<dd><a href="#const:SIZE_NARROW_FONT_48_BMP">SIZE_NARROW_FONT_48_BMP</a>
<dd><a href="#const:SIZE_NARROW_FONT_48_GIF">SIZE_NARROW_FONT_48_GIF</a>
<dd><a href="#const:SIZE_NARROW_FONT_48_PNG">SIZE_NARROW_FONT_48_PNG</a>
<dd><a href="#const:SIZE_NARROW_FONT_48_XBM">SIZE_NARROW_FONT_48_XBM</a>
<dd><a href="#const:SIZE_NARROW_FONT_48_XPM">SIZE_NARROW_FONT_48_XPM</a>
<dd><a href="#const:SIZE_WIDE_FONT_16">SIZE_WIDE_FONT_16</a>
<dd><a href="#const:SIZE_WIDE_FONT_16_BMP">SIZE_WIDE_FONT_16_BMP</a>
<dd><a href="#const:SIZE_WIDE_FONT_16_GIF">SIZE_WIDE_FONT_16_GIF</a>
<dd><a href="#const:SIZE_WIDE_FONT_16_PNG">SIZE_WIDE_FONT_16_PNG</a>
<dd><a href="#const:SIZE_WIDE_FONT_16_XBM">SIZE_WIDE_FONT_16_XBM</a>
<dd><a href="#const:SIZE_WIDE_FONT_16_XPM">SIZE_WIDE_FONT_16_XPM</a>
<dd><a href="#const:SIZE_WIDE_FONT_24">SIZE_WIDE_FONT_24</a>
<dd><a href="#const:SIZE_WIDE_FONT_24_BMP">SIZE_WIDE_FONT_24_BMP</a>
<dd><a href="#const:SIZE_WIDE_FONT_24_GIF">SIZE_WIDE_FONT_24_GIF</a>
<dd><a href="#const:SIZE_WIDE_FONT_24_PNG">SIZE_WIDE_FONT_24_PNG</a>
<dd><a href="#const:SIZE_WIDE_FONT_24_XBM">SIZE_WIDE_FONT_24_XBM</a>
<dd><a href="#const:SIZE_WIDE_FONT_24_XPM">SIZE_WIDE_FONT_24_XPM</a>
<dd><a href="#const:SIZE_WIDE_FONT_30">SIZE_WIDE_FONT_30</a>
<dd><a href="#const:SIZE_WIDE_FONT_30_BMP">SIZE_WIDE_FONT_30_BMP</a>
<dd><a href="#const:SIZE_WIDE_FONT_30_GIF">SIZE_WIDE_FONT_30_GIF</a>
<dd><a href="#const:SIZE_WIDE_FONT_30_PNG">SIZE_WIDE_FONT_30_PNG</a>
<dd><a href="#const:SIZE_WIDE_FONT_30_XBM">SIZE_WIDE_FONT_30_XBM</a>
<dd><a href="#const:SIZE_WIDE_FONT_30_XPM">SIZE_WIDE_FONT_30_XPM</a>
<dd><a href="#const:SIZE_WIDE_FONT_48">SIZE_WIDE_FONT_48</a>
<dd><a href="#const:SIZE_WIDE_FONT_48_BMP">SIZE_WIDE_FONT_48_BMP</a>
<dd><a href="#const:SIZE_WIDE_FONT_48_GIF">SIZE_WIDE_FONT_48_GIF</a>
<dd><a href="#const:SIZE_WIDE_FONT_48_PNG">SIZE_WIDE_FONT_48_PNG</a>
<dd><a href="#const:SIZE_WIDE_FONT_48_XBM">SIZE_WIDE_FONT_48_XBM</a>
<dd><a href="#const:SIZE_WIDE_FONT_48_XPM">SIZE_WIDE_FONT_48_XPM</a>
<dd><a href="#const:SUCCESS">SUCCESS</a>
<dt>W
<dd><a href="#const:WIDTH_NARROW_FONT_16">WIDTH_NARROW_FONT_16</a>
<dd><a href="#const:WIDTH_NARROW_FONT_24">WIDTH_NARROW_FONT_24</a>
<dd><a href="#const:WIDTH_NARROW_FONT_30">WIDTH_NARROW_FONT_30</a>
<dd><a href="#const:WIDTH_NARROW_FONT_48">WIDTH_NARROW_FONT_48</a>
<dd><a href="#const:WIDTH_WIDE_FONT_16">WIDTH_WIDE_FONT_16</a>
<dd><a href="#const:WIDTH_WIDE_FONT_24">WIDTH_WIDE_FONT_24</a>
<dd><a href="#const:WIDTH_WIDE_FONT_30">WIDTH_WIDE_FONT_30</a>
<dd><a href="#const:WIDTH_WIDE_FONT_48">WIDTH_WIDE_FONT_48</a>
</dl>
</body>
</html>
|