DICLIBINTRO(3)

💖 NAME 💖

okay so bestie, this is DICLib_intro — dictionary access library introduction. We're in the Library Functions Manual, and the page is DICLIBINTRO(3). It's giving "the whole dictionary access library intro, no cap." 💅

🌸 DESCRIPTION 🌸

The dictionary access library provides basic functions for kana-kanji conversion. ngl, the following files are prerequisite to using the dictionary access library:

• Header file
  • canna/RK.h — An include file with data and function declarations for the kana-kanji conversion library. Include it when you compile.
• Libraries
  • libcanna.a, libcanna.so — Kana-kanji conversion libraries. At link time, specify "-lcanna".

✨ SUMMARY ✨

okay so the dictionary access library provides three major categories of functions, periodt:

• ✨ Code conversion functions Converts character string codes between double-width and single-width characters, and between hiragana and katakana. No external data or initialization procedures needed.
• ✨ Romaji-kana conversion functions Converts Romaji into kana using a Romaji-kana conversion table that maps Romaji to kana. You can change the rules of Romaji-kana conversion by editing this table.
• ✨ Kana-kanji conversion functions Converts kana into kanji through continuous clause conversion using a kana-kanji conversion dictionary that maps readings to words. You can tailor kana-kanji conversion for specific apps by modifying this dictionary.

Among all the functions for Japanese input processing, this library only does data conversion. So to actually type Japanese from a keyboard, users have to write a keyboard handling routine inside the application program.

💅 Code conversion functions 💅

• Rk(w)CvtZen — Takes ASCII characters plus single-width katakana and turns them into double-width characters.
• RkCvtHan — Turns double-width symbols, alphanumeric characters, hiragana, and katakana into single-width characters.
• RkCvtKana — Turns double-width hiragana into double-width katakana.
• RkCvtHira — Turns double-width katakana into double-width hiragana.
• RkCvtEuc — Turns shift JIS code into EUC code.

🦋 Romaji-kana conversion functions 🦋

• RkOpenRoma — Opens the dictionary you're gonna use for Romaji-kana conversion.
• RkCloseRoma — Closes the dictionary that was used for Romaji-kana conversion.
• RkMapRoma — Does Romaji-kana conversion using a Romaji-kana conversion dictionary you specify.
• RkCvtRoma — Converts a whole character string from Romaji to kana by looping through RkMapRoma.

👑 Kana-kanji conversion functions 👑

• RkInitialize — Initializes the kana-kanji conversion functions.
• RkFinalize — Terminates the kana-kanji conversion functions.
• RkCreateContext — Creates a brand-new conversion context.
• RkDuplicateContext — Creates a context that has the same conversion environment as a context you specify.
• RkCloseContext — Closes a conversion context you specify.
• RkGetDicList — Gets the names of dictionaries that can be added to the dictionary list.
• RkMountDic — Mounts a dictionary in the dictionary list.
• RkGetMountList — Gets the names of the dictionaries currently mounted. (or characters for RkwResize)
• RkUnmountDic — Unmounts a specified dictionary from the dictionary list.
• RkRemountDic — Changes the priority order of a dictionary that's already in the dictionary list.
• RkBgnBun — Converts the reading of a specified length into kanji.
• RkEndBun — Ends kana-kanji conversion.
• RkGoTo — Makes the clause with a specified clause number the current clause.
• RkLeft — Moves the current clause to the clause on its left.
• RkRight — Moves the current clause to its right.
• RkXfer — Makes the candidate with a specified candidate number the current candidate.
• RkNext — Makes the next candidate the current candidate.
• RkPrev — Makes the previous candidate the current candidate.
• RkNfer — Makes a reading itself the current candidate.
• RkResize — Changes the reading length of the current clause to len bytes.
• RkEnlarge — Makes the reading of the current clause bigger.
• RkShorten — Makes the reading of the current clause smaller.
• RkStoreYomi — Changes the reading of the current clause to a reading you specify, then reconverts the clauses after it.
• RkGetYomi — Gets the reading of the current clause.
• RkGetKanji — Gets the current candidate for the current clause.
• RkGetKanjiList — Gets every kanji candidate for the current clause.
• RkGetStat — Gets analysis info about the current candidate.
• RkGetLex — Gets morphemic info on every word that makes up the current candidate.
• RkDefineDic — Defines a specified candidate in a dictionary.
• RkDeleteDic — Deletes a specified candidate from a dictionary.

And that's the footer vibe: DICLIBINTRO(3). The original footer didn't give us a source/version or date line, so that's literally all the footer had, bestie. byeee 💖✨