1DICLIBINTRO(3) Library Functions Manual DICLIBINTRO(3)
2
6 DICLib intro - dictionary access library introduction
7
9 The dictionary access library provides basic functions for kana-kanji
10 conversion. The following files are prerequisite to using the dictio‐
11 nary access library:
12 Header file
14 canna/RK.h
15 An include file that contains data and function declarations for
16 use by the kana-kanji conversion library. Include this file at
17 compile time.
18 Libraries
20 libcanna.a, libcanna.so
21 Kana-kanji conversion libraries. Specify "-lcanna" at link
22 time.
23
25 The dictionary access library provides three major categories of func‐
26 tions:
27 ・ Code conversion functions
29 Convert character string codes between double-width and single-width
31 characters and between hiragana and katakana. External data and
32 initialization procedures are not required.
33 ・ Romaji-kana conversion functions
35 Convert Romaji to kana by using a Romaji-kana conversion table that
37 defines the correspondence between Romaji and kana. The rules of
38 Romaji-kana conversion can be altered by making modifications to
39 this table.
40 ・ Kana-kanji conversion functions
42 Convert kana to kanji through continuous clause conversion by using
44 a kana-kanji conversion dictionary that defines the correspondence
45 between readings and words. Kana-kanji conversion can be performed
46 to meet specific applications by making modifications to this dic‐
47 tionary.
48 Among all the functions of Japanese input processing, this library per‐
50 forms only data conversion. To be able to enter Japanese text from a
51 keyboard, therefore, it is necessary for users to write a keyboard han‐
52 dling routine within the application program.
53 ・ Code conversion functions
55 Rk(w)CvtZen Convert ASCII characters and single-width
57 katakana to double-width characters.
58 RkCvtHan Convert double-width symbols, alphanumeric
60 characters, hiragana, and katakana to single-
61 width characters.
62 RkCvtKana Convert double-width hiragana to double-width
64 katakana.
65 RkCvtHira Convert double-width katakana to double-width
67 hiragana.
68 RkCvtEuc Convert shift JIS code to EUC code.
70 ・ Romaji-kana conversion functions
72 RkOpenRoma Open the dictionary to use for Romaji-kana
74 conversion.
75 RkCloseRoma Close the dictionary used for Romaji-kana con‐
77 version.
78 RkMapRoma Perform Romaji-kana conversion by using a
80 specified Romaji-kana conversion dictionary.
81 RkCvtRoma Convert an entire character string from Romaji
83 to kana by iteratively using RkMapRoma.
84 ・ Kana-kanji conversion functions
86 RkInitialize Initialize the kana-kanji conversion func‐
88 tions.
89 RkFinalize Terminate the kana-kanji conversion functions.
91 RkCreateContext Create a new conversion context.
93 RkDuplicateContext Create a context having the same conversion
95 environment as a specified context.
96 RkCloseContext Close a specified conversion context.
98 RkGetDicList Get the names of dictionaries that can be
100 added to the dictionary list.
101 RkMountDic Mount a dictionary in the dictionary list.
103 RkGetMountList Get the names of the currently mounted dictio‐
105 naries. (or characters for RkwResize)
106 RkUnmountDic Unmount a specified dictionary from the dic‐
108 tionary list.
109 RkRemountDic Alter the priority order of a dictionary
111 already in the dictionary list.
112 RkBgnBun Convert the reading of a specified length to
114 kanji.
115 RkEndBun Terminate kana-kanji conversion.
117 RkGoTo Set the clause with a specified clause number
119 as the current clause.
120 RkLeft Move the current clause to the clause to its
122 left.
123 RkRight Move the current clause to its right.
125 RkXfer Set the candidate with a specified candidate
127 number as the current candidate.
128 RkNext Set the next candidate as the current candi‐
130 date.
131 RkPrev Set the previous candidate as the current can‐
133 didate.
134 RkNfer Set a reading itself as the current candidate.
136 RkResize Change the reading length of the current
138 clause to len bytes.
139 RkEnlarge Enlarge the reading of the current clause.
141 RkShorten Shorten the reading of the current clause.
143 RkStoreYomi Change the reading of the current clause to a
145 specified reading, reconverting the subsequent
146 clauses.
147 RkGetYomi Get the reading of the current clause.
149 RkGetKanji Get the current candidate for the current
151 clause.
152 RkGetKanjiList Get all kanji candidates for the current
154 clause.
155 RkGetStat Get analysis information about the current
157 candidate.
158 RkGetLex Get morphemic information on each word that
160 makes up the current candidate.
161 RkDefineDic Define a specified candidate in a dictionary.
163 RkDeleteDic Delete a specified candidate from a dictio‐
165 nary.
166 DICLIBINTRO(3)