OSDN Git Service

Updated test14-ruby.tex (test and the manual of luatexja-ruby.sty)
[luatex-ja/luatexja.git] / src / addons / luatexja-ruby.sty
1 %
2 % luatexja-ruby.sty
3 %
4
5 % LaTeX only!
6 \NeedsTeXFormat{LaTeX2e}
7 \ProvidesPackage{luatexja-ruby}[2014/02/06 v0.1]
8 \RequirePackage{luatexja}
9
10 %%------------------
11 \newluatexattribute\ltj@rubyattr
12 \ltj@rubyattr=0
13 \RequireLuaTeXjaSubmodule{ruby}
14
15 % ltjset/getparameter への追加設定
16 % これらは段落単位の設定.
17
18 %% 引数:ルビ全角を単位とした実数
19 %% この文字への pre-, post-intrusion の許容量
20 \define@key[ltj]{japaram}{rubypreintrusion}{%
21   \expandafter\ltj@@set@stack@real#1:{RIPRE}{0}{0x7FFFFFFF}}
22 \define@key[ltj]{japaram}{rubypostintrusion}{%
23   \expandafter\ltj@@set@stack@real#1:{RIPOST}{0}{0x7FFFFFFF}}
24 \def\ltj@@set@stack@real#1,#2:#3#4#5{%
25   \directlua{luatexja.stack.set_stack_perchar(luatexja.stack_table_index.#3,
26     \ltj@safe@num@or\ltj@defnum{#1},\ltj@safe@real{#2},#4,#5)}}
27
28 % ルビ用のキー設定
29 \def\ltj@@rkeydef#1{
30   \define@key[ltj]{ruby}{#1}{\expandafter\def\csname ltj@@rubyip@#1\endcsname{##1}}
31 }
32 %% attr_ruby_mode
33 %% bit 0: intrusion を有効にするか(1: 有効)
34 %% bit 1: 前後の intrusion 許容量を小さい方に揃える (1: yes)
35 %% bit 2, 3: intrusion をどう使って親文字を配置するか
36 %%   00: intrusion なしでとりあえず計算し,左右の突出分を進入に割り当てる
37 %%   01: pre-intrusion でまかなえるだけまかない,無理なら post- も使う
38 %%   10: post を優先
39 %%   11: 2 min (pre,post) までは pre, post に均等配分しようとする
40 %%     >=01 で,intrusion で賄えきれなかった場合はいつものように伸長する.
41 %% bit 4: 熟語ルビの際の処理方法(0: 常にグループ,1: 可能な限りブロックごとに)
42 %%        ↑bit 4 は今は無効
43 \ltj@@rkeydef{mode}
44 %% intrusion 量強制固定(bit 0, bit 1 より優先,負数で「自動」)
45 %% attr は sp 単位だが,ユーザーはルビ全角単位で指定する
46 %% attr_ruby_maxprep, attr_ruby_maxpostp
47 \ltj@@rkeydef{intrusionpre}
48 \ltj@@rkeydef{intrusionpost}
49 %% 親文字伸長の際の比,{0}{1}{1} などと0--7 の数 3 つで指定
50 %% attr_ruby_stretch (head left,middle,right)(end)(middle) 27-bits 
51 \ltj@@rkeydef{stretchhead} % 行頭形
52 \ltj@@rkeydef{stretchend}  % 行末形
53 \ltj@@rkeydef{stretch}     % 行中形
54 %% ルビが伸長するときの比 {1}{2}{1} などと0--7 の数 3 つで指定
55 %% attr_ruby_mode 上位部分
56 \ltj@@rkeydef{stretchruby}
57 %% ルビ<親のとき,ルビと親文字の端の最大値 
58 %% attr_ruby_maxmargin
59 %% attr は sp 単位だが,ユーザーは親文字全角単位で指定
60 \ltj@@rkeydef{maxmargin}
61
62 \ltj@@rkeydef{kenten}%% 圏点文字
63
64 \savekeys[ltj]{ruby}{%
65   mode, intrusionpre, intrusionpost, 
66   stretchhead, stretchend, stretch, stretchruby, 
67   maxmargin, rubysize, kenten, 
68 }
69
70 %%%%%%%% setkeys の別名
71 \protected\def\ltjsetruby{\setkeys[ltj]{ruby}}
72
73 % ここからは ruby マクロ内でなんとかされる事項
74 %% ルビと親文字の大きさの比
75 \ltj@@rkeydef{rubysize}
76
77 % 中つき用簡易設定.
78 \define@key[ltj]{ruby}{kata}[none]{\setkeys[ltj]{ruby}{mode=1, stretch=121, stretchruby=121}}
79 % 肩つき用簡易設定.
80 \define@key[ltj]{ruby}{kata}[none]{\setkeys[ltj]{ruby}{mode=9, stretch=121, stretchruby=001}}
81 % 拡張肩つき用簡易設定.
82 \define@key[ltj]{ruby}{ekata}[none]{\setkeys[ltj]{ruby}{%
83   intrusionpre=0, mode=1, stretch=001,stretchruby=001}}
84
85 %%%%%%%% 補助関数
86
87 % Lua ソースに渡す table 生成
88 \def\ltj@@ruby@create@table#1{% #1: ルビ全角
89     \string{
90       rubyzw = \ltj@safe@dimen{#1}, 
91       maxmargin = \ltj@safe@dimen{\ltj@@rubyip@maxmargin\zw},
92       intrusionpre = \ltj@safe@dimen{\ltj@@rubyip@intrusionpre#1},
93       intrusionpost = \ltj@safe@dimen{\ltj@@rubyip@intrusionpost#1},
94       stretch 
95         = 262144 * \expandafter\ltj@@ruby@cts\ltj@@rubyip@stretchhead
96           + 512 * \expandafter\ltj@@ruby@cts\ltj@@rubyip@stretchend
97           + \expandafter\ltj@@ruby@cts\ltj@@rubyip@stretch,
98       mode 
99         = 2097152 * \expandafter\ltj@@ruby@cts\ltj@@rubyip@stretchruby
100           + \ltj@safe@num{\ltj@@rubyip@mode},
101     \string}
102 }
103 \def\ltj@@ruby@cts#1#2#3{%
104   ((\ltj@safe@num{#1}) * 64 + (\ltj@safe@num{#2}) * 8 + \ltj@safe@num{#3})%
105 }
106
107
108 %%%%%%%% ZR さんの PXrubrica パッケージ中のコードから引用・改変
109 % \pxrr@decompbar: a|bc -> \ltj@@ruby@mark{a}\ltj@@ruby@mark{bc}
110 \let\pxrr@res\empty
111 \def\pxrr@ifx#1{%
112   \ifx#1\expandafter\@firstoftwo
113   \else\expandafter\@secondoftwo
114   \fi
115 }
116 \def\pxrr@nil{\noexpand\pxrr@nil}
117 \def\pxrr@end{\noexpand\pxrr@end}
118 \def\pxrr@appto#1#2{%
119   \expandafter\def\expandafter#1\expandafter{#1#2}%
120 }
121 \def\pxrr@decompbar#1{%
122   \let\pxrr@res\@empty
123   \pxrr@decompbar@loopa\pxrr@nil#1|\pxrr@end|%
124 }
125 \def\pxrr@decompbar@loopa#1|{%
126   \expandafter\pxrr@decompbar@loopb\expandafter{\@gobble#1}%
127 }
128 \def\pxrr@decompbar@loopb#1{%
129   \pxrr@decompbar@loopc#1\relax\pxrr@nil{#1}%
130 }
131 \def\pxrr@decompbar@loopc#1#2\pxrr@nil#3{%
132   \pxrr@ifx{#1\pxrr@end}{}{%
133     \ifx\pxrr@res\@empty
134       \def\pxrr@res{\ltj@@ruby@mark}%
135     \else
136       \pxrr@appto\pxrr@res{\ltj@@ruby@mark}%
137     \fi
138     \pxrr@appto\pxrr@res{{#3}}%
139     \pxrr@decompbar@loopa\pxrr@nil
140   }%
141 }
142 %%%%%%%% ここまで
143
144 %%%%%%%% TeX command
145 \protected\def\ltjruby{\@ifnextchar[\ltj@@ruby{\ltj@@ruby[]}}%]
146 \let\ruby=\ltjruby
147 \def\ltj@@ruby[#1]#2#3{{% #1: option #2: 親文字群,#3: ルビ文字列群,共に| 区切り
148   \setkeys[ltj]{ruby}{#1}%
149   \directlua{ruby_tmplist_r = \string{\string}; ruby_tmplist_p = \string{\string}}%
150   \leavevmode\dimen0=\f@size pt\dimen1=\ltj@@rubyip@rubysize\dimen0%
151   % 引数展開,テーブルにセット
152   \pxrr@decompbar{#2}{\let\ltj@@ruby@mark\ltj@@ruby@sp\pxrr@res}%
153   \pxrr@decompbar{#3}{\let\ltj@@ruby@mark\ltj@@ruby@sr\pxrr@res}%
154   {\fontsize{\ltj@@rubyip@rubysize\dimen0}\z@\selectfont\global\dimen1=\zw}%
155   \directlua{%
156     luatexja.ruby.texiface(\ltj@@ruby@create@table{\dimen1},
157     ruby_tmplist_r, ruby_tmplist_p)}%
158 }}
159
160 \def\ltj@@ruby@sr#1{%
161   \setbox0=\hbox{\fontsize{\dimen1}\z@\selectfont#1}%
162   \directlua{table.insert(ruby_tmplist_r, luatexja.ruby.cpbox())}%
163 }
164 \def\ltj@@ruby@sp#1{%
165   \setbox0=\hbox{\selectfont#1}%
166   \directlua{table.insert(ruby_tmplist_p, luatexja.ruby.cpbox())}%
167 }
168
169 \protected\def\ltjkenten{\@ifnextchar[\ltj@@kenten{\ltj@@kenten[]}}%]
170 \let\kenten=\ltjkenten
171 \def\ltj@@kenten[#1]#2{{%
172   \setkeys[ltj]{ruby}{#1, stretchruby=101}%
173   \@tfor\ltj@@kenten@temp:=#2\do{\ltj@@ruby[]{\ltj@@kenten@temp}{\ltj@@rubyip@kenten}}%
174 }}
175
176 % 初期値.要調整
177 %% ひらがな
178 \count@="3040\loop\relax\ifnum \count@<"30A0
179   \ltjsetparameter{rubypreintrusion={\the\count@,1}, 
180     rubypostintrusion={\the\count@,1}}
181   \advance\count@1\repeat
182 %% 「」
183 \ltjsetparameter{rubypreintrusion={`「,1}, 
184   rubypostintrusion={`」,1}}
185 %% ,、
186 \ltjsetparameter{rubypreintrusion={`,,1}, 
187   rubypostintrusion={`,,1}}
188 \ltjsetparameter{rubypreintrusion={`、,1}, 
189   rubypostintrusion={`、,1}}
190 %% ・
191 \ltjsetparameter{rubypreintrusion={`・,1}, 
192   rubypostintrusion={`・,1}}
193
194 \setkeys[ltj]{ruby}{
195   stretchruby={1}{2}{1}, stretch = {1}{2}{1},
196   stretchhead = {0}{1}{1}, stretchend = {1}{1}{0},
197   intrusionpre = -1, intrusionpost = -1, maxmargin=0.5, 
198   mode = 1, rubysize = 0.5, kenten=\ltjalchar`•
199 }
200
201 \endinput