OSDN Git Service

[DOC][ROMAKANA] Add english document.
[csp-qt/common_source_project-fm7.git] / doc / romaji_kana.en.txt
1 * About ROMAJI-KANA conversion assitant feature.
2                                        Oct 26, 2016
3                   K.Ohta <whatisthis.sowhat _at_ gmail.com>
4
5 1.What is this?
6 Using ROMAJI-KANA conversion at a few machines,
7 regardless of lacking native ROMAJI-KANA conversion.
8 This aims to be useful for older Japanese adventure-games.
9
10 2.How to use
11  a. Check menu entry, "ROMA-KANA Conversion" at "Emulator" section.
12  b. Press [PF12] to toggle enabling ROMAJI-KANA conversion.
13     If enable , display "[R]" at head of status message.
14     ** This feature has not all of VMs, now only a few VMs have. **
15
16 3.Supported VMs
17 ・FM-8/7/77/AV/40/EX
18 ・MSX 1/2
19 ・MZ-80B/2200/2500
20 ・PC-6001/6601(But, code of Kana-key is differ, not works well)
21 ・PC-8801
22 ・X1/Turbo/Z
23
24 4.Conversion code list
25 母音
26 A : あ
27 I : い
28 U : う
29 E : え
30 O : お
31 xa : ぁ
32 xi : ぃ
33 xu : ぅ
34 xe : ぇ
35 xo : ぉ
36
37 母音
38 k  : か行
39 s  : さ行
40 t  : た行
41 n  : な行
42 h  : は行
43 m  : ま行
44 y  : や行
45 r  : ら行
46 w  : わ行
47 z  : ザ行
48 j  : ザ行
49 d  : ダ行
50 b  : バ行
51 p  : パ行
52
53 その他
54 *y* : *ャ/ィ/ュ/ェ/ョ (例: pya -> ピャ)
55 nn  : ン
56 -   : ー(音引き)
57 [   : 「
58 ]   :  」
59 ,   : 、
60 .   : 。
61 /   : ・(なかぐろ)
62
63 5.Implementation
64 At CSP, when inputting from host's keyboard, RAW key code has
65 converted to virtual keyboard code(VK_foo) of windows
66 temporally and queueing.
67 Now, snooping VK code before queueing, send to
68 alphabet_to_kana() at src/romakana.cpp to convert ROMAJI to KATAKANA,
69 result is put to array of wchar_t (UTF-8).
70
71 And, queueing this result (converted to QString, Qt native string type)
72 to ROMAJI-KANA conversion queue.
73 At emulation loop (i.e. calling emu->run()), when AUTO-KEY(Copy and Paste)
74 FIFO has empty, dequeueing from ROMAJI-KANA conversion queue and enqueue
75 these characters to AUTO-KEY fifo, then, process AUTO-KEY function.
76
77 Note:
78 "romakana.cpp" use wchar_t and use UTF-8 to process internally,
79 C++ compiler is required later than C++99?.
80 And, you need convert coding result of ROMAJI-KANA conversion to
81 internal coding EMU::auto_key_foo() (mostly Shift-JIS).
82
83 Sorry for irrational...(´・ω・`)
84
85 Ohta.