src/addons/luatexja-ruby.sty

   1 %
   2 % luatexja-ruby.sty
   3 %
   4
   5 % LaTeX only!
   6 \NeedsTeXFormat{LaTeX2e}
   7 \ProvidesPackage{luatexja-ruby}[2022-06-26 v0.53]
   8 \RequirePackage{luatexja}
   9
  10 %%------------------
  11 \newattribute\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   \ltj@@set@stack@real{RIPRE}{-0x7FFFFFFF}{0x7FFFFFFF}#1 }
  22 \define@key[ltj]{japaram}{rubypostintrusion}{%
  23   \ltj@@set@stack@real{RIPOST}{-0x7FFFFFFF}{0x7FFFFFFF}#1 }
  24 \def\ltj@@set@stack@real#1#2#3{%
  25   \directlua{luatexja.stack.set_stack_perchar(luatexja.stack_table_index.#1,
  26     #2, #3, token.scan_word)}}
  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{pre}
  48 \ltj@@rkeydef{post}
  49 %% 親文字伸長の際の比，{0}{1}{1} などと0--7 の数 3 つで指定
  50 %% attr_ruby_stretch (bol left,middle,right)(eol)(middle) 27-bits
  51 \ltj@@rkeydef{stretchbol} % 行頭形
  52 \ltj@@rkeydef{stretcheol}  % 行末形
  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 %% attr_ruby_intergap
  63 %% attr は sp 単位だが，ユーザーは親文字全角単位で指定
  64 \ltj@@rkeydef{intergap}
  65
  66 %% epsilon: モノルビ * n にする際に，ルビの方がどれだけ親文字より長い
  67 %% 状況を許容するか．親文字全角単位．計算誤差を想定．
  68 \ltj@@rkeydef{epsilon}
  69
  70 \ltj@@rkeydef{kenten}%% 圏点文字
  71 \ltj@@rkeydef{fontcmd}%% フォント
  72 \define@boolkey[ltj]{ruby}{rubysmash}[true]{}
  73
  74 \ltj@@rkeydef{ybaseheight} % 縦組以外 (yoko, utod, dtou)
  75 \ltj@@rkeydef{tbaseheight} % 縦組
  76 \define@key[ltj]{ruby}{baseheight}{%
  77   \expandafter\def\csname ltj@@rubyip@ybaseheight\endcsname{#1}%
  78   \expandafter\def\csname ltj@@rubyip@tbaseheight\endcsname{#1}%
  79 }
  80 %% これらの値が正のとき，親文字の高さをこの値（\zh 単位）とみなす
  81
  82 \ltj@@rkeydef{yrubydepth} % 縦組以外 (yoko, utod, dtou)
  83 \ltj@@rkeydef{trubydepth} % 縦組
  84 \define@key[ltj]{ruby}{rubydepth}{%
  85   \expandafter\def\csname ltj@@rubyip@yrubydepth\endcsname{#1}%
  86   \expandafter\def\csname ltj@@rubyip@trubydepth\endcsname{#1}%
  87 }
  88
  89 \define@boolkey[ltj]{ruby}{intrude_jfmgk}[true]{}
  90 \define@boolkey[ltj]{ruby}{intrude_xkanjiskip}[true]{}
  91 \define@boolkey[ltj]{ruby}{intrude_kanjiskip}[true]{}
  92
  93
  94 %%%%%%%% setkeys の別名
  95 \protected\def\ltjsetruby{\setkeys[ltj]{ruby}}
  96
  97 % ここからは ruby マクロ内でなんとかされる事項
  98 %% ルビと親文字の大きさの比
  99 \ltj@@rkeydef{size}
 100
 101 % 中つき用簡易設定．
 102 \define@key[ltj]{ruby}{naka}[none]{\setkeys[ltj]{ruby}{mode=1, stretch=121, stretchruby=121}}
 103 % 肩つき用簡易設定．
 104 \define@key[ltj]{ruby}{kata}[none]{\setkeys[ltj]{ruby}{mode=9, stretch=121, stretchruby=001}}
 105
 106 %%%%%%%% 補助関数
 107
 108 % Lua ソースに渡す table 生成
 109 \bgroup
 110 \catcode`\_=11
 111 \gdef\ltj@@ruby@create@table#1{% #1: ルビ全角
 112     \string{
 113       eps = \ltj@safe@dimen{\ltj@@rubyip@epsilon\zw},
 114       before_jfmgk = 0, after_jfmgk = 0,
 115       rubyzw = \ltj@safe@dimen{#1},
 116       maxmargin = \ltj@safe@dimen{\ltj@@rubyip@maxmargin\zw},
 117       pre = \ltj@safe@dimen{\ltj@@rubyip@pre#1},
 118       post = \ltj@safe@dimen{\ltj@@rubyip@post#1},
 119       intergap =  \ltj@safe@dimen{\ltj@@rubyip@intergap\zh},
 120       stretch
 121         = 262144 * \expandafter\ltj@@ruby@cts\ltj@@rubyip@stretchbol
 122           + 512 * \expandafter\ltj@@ruby@cts\ltj@@rubyip@stretcheol
 123           + \expandafter\ltj@@ruby@cts\ltj@@rubyip@stretch,
 124       mode
 125         = (2097152 * \expandafter\ltj@@ruby@cts\ltj@@rubyip@stretchruby
 126           + \ltj@safe@num{\ltj@@rubyip@mode}
 127           + 1048576 * \ifltj@ruby@rubysmash1\else0\fi),
 128       baseheight = \ltj@safe@dimen{\ifnum\ltjgetparameter{direction}=3
 129                      \ltj@@rubyip@tbaseheight\else\ltj@@rubyip@ybaseheight\fi\zh},
 130       rubydepth = \ltj@safe@dimen{\ifnum\ltjgetparameter{direction}=3
 131                      \ltj@@rubyip@trubydepth\else\ltj@@rubyip@yrubydepth\fi#1},
 132       intrude_jfmgk = \string{
 133        \ifltj@ruby@intrude_jfmgk [luatexja.icflag_table.FROM_JFM]=true,\fi
 134        \ifltj@ruby@intrude_kanjiskip
 135           [luatexja.icflag_table.KANJI_SKIP]=true,
 136           [luatexja.icflag_table.KANJI_SKIP_JFM]=true,
 137        \fi
 138        \ifltj@ruby@intrude_xkanjiskip
 139           [luatexja.icflag_table.XKANJI_SKIP]=true,
 140           [luatexja.icflag_table.XKANJI_SKIP_JFM]=true,
 141        \fi
 142        \string}
 143     \string}
 144 }
 145 \egroup
 146 %%%
 147 %%% 1098765432109876543210976543210
 148 %%%   |st_ruby|!               |--| ← mode
 149 \def\ltj@@ruby@cts#1#2#3{%
 150   ((\ltj@safe@num{#1}) * 64 + (\ltj@safe@num{#2}) * 8 + \ltj@safe@num{#3})%
 151 }
 152
 153
 154 %%%%%%%% ZR さんの PXrubrica パッケージ中のコードから引用・改変
 155 % \pxrr@decompbar: a|bc -> \ltj@@ruby@mark{a}\ltj@@ruby@mark{bc}
 156 \let\pxrr@res\empty
 157 \def\pxrr@ifx#1{%
 158   \ifx#1\expandafter\@firstoftwo
 159   \else\expandafter\@secondoftwo
 160   \fi
 161 }
 162 \def\pxrr@nil{\noexpand\pxrr@nil}
 163 \def\pxrr@end{\noexpand\pxrr@end}
 164 \def\pxrr@appto#1#2{%
 165   \expandafter\def\expandafter#1\expandafter{#1#2}%
 166 }
 167 \def\pxrr@decompbar#1{%
 168   \let\pxrr@res\@empty
 169   \pxrr@decompbar@loopa\pxrr@nil#1|\pxrr@end|%
 170 }
 171 \def\pxrr@decompbar@loopa#1|{%
 172   \expandafter\pxrr@decompbar@loopb\expandafter{\@gobble#1}%
 173 }
 174 \def\pxrr@decompbar@loopb#1{%
 175   \pxrr@decompbar@loopc#1\relax\pxrr@nil{#1}%
 176 }
 177 \def\pxrr@decompbar@loopc#1#2\pxrr@nil#3{%
 178   \pxrr@ifx{#1\pxrr@end}{}{%
 179     \ifx\pxrr@res\@empty
 180       \def\pxrr@res{\ltj@@ruby@mark}%
 181     \else
 182       \pxrr@appto\pxrr@res{\ltj@@ruby@mark}%
 183     \fi
 184     \pxrr@appto\pxrr@res{{#3}}%
 185     \pxrr@decompbar@loopa\pxrr@nil
 186   }%
 187 }
 188 %%%%%%%% ここまで
 189
 190 %%%%%%%% TeX command
 191 \protected\def\ltjruby{\@ifnextchar[\ltj@@ruby{\ltj@@ruby[]}}%]
 192 \AtBeginDocument{%
 193   \ifdefined\ruby\else\let\ruby=\ltjruby\fi
 194   \directlua{luatexja.ruby.read_old_break_info()}%
 195 }
 196 \def\ltj@@ruby[#1]#2#3{{% #1: option #2: 親文字群，#3: ルビ文字列群，共に| 区切り
 197   \setkeys[ltj]{ruby}{#1}%
 198   \directlua{luatexja.ruby.ruby_tmplist_r = \string{\string};
 199         luatexja.ruby.ruby_tmplist_p = \string{\string}}%
 200   \leavevmode\dimen0=\f@size pt\dimen1=\ltj@@rubyip@size\dimen0%
 201   % 引数展開，テーブルにセット
 202   \pxrr@decompbar{#2}{\let\ltj@@ruby@mark\ltj@@ruby@sp\pxrr@res}%
 203   \pxrr@decompbar{#3}{\let\ltj@@ruby@mark\ltj@@ruby@sr\pxrr@res}%
 204   {\fontsize{\ltj@@rubyip@size\dimen0}\z@\selectfont\ltj@@rubyip@fontcmd\global\dimen1=\zw}%
 205   \directlua{%
 206     luatexja.ruby.texiface(\ltj@@ruby@create@table{\dimen1},
 207     luatexja.ruby.ruby_tmplist_r, luatexja.ruby.ruby_tmplist_p)}%
 208 }}
 209
 210 \def\ltj@@ruby@sr#1{%
 211   \setbox0=\hbox{\fontsize{\dimen1}\z@\ltj@@rubyip@fontcmd\selectfont#1}%
 212   \directlua{table.insert(luatexja.ruby.ruby_tmplist_r, luatexja.ruby.cpbox())}%
 213 }
 214 \def\ltj@@ruby@sp#1{%
 215   \setbox0=\hbox{\selectfont#1}%
 216   \directlua{table.insert(luatexja.ruby.ruby_tmplist_p, luatexja.ruby.cpbox())}%
 217 }
 218
 219 \protected\def\ltjkenten{\@ifnextchar[\ltj@@kenten{\ltj@@kenten[]}}%]
 220 \let\kenten=\ltjkenten
 221 \def\ltj@@kenten[#1]#2{{%
 222   \setkeys[ltj]{ruby}{#1, stretchruby=101}%
 223   \@tfor\ltj@@kenten@temp:=#2\do{\ltj@@ruby[]{\ltj@@kenten@temp}{\ltj@@rubyip@kenten}}%
 224 }}
 225
 226 % 初期値．要調整
 227 %% ひらがな
 228 \count@="3040\loop\relax\ifnum \count@<"30A0
 229   \ltjsetparameter{rubypreintrusion={\the\count@,1},
 230     rubypostintrusion={\the\count@,1}}
 231   \advance\count@1\repeat
 232 %% カタカナ
 233 \count@="30A0\loop\relax\ifnum \count@<"3100
 234   \ltjsetparameter{rubypreintrusion={\the\count@,1},
 235     rubypostintrusion={\the\count@,1}}
 236   \advance\count@1\repeat
 237 %% Kana Supplement
 238 \count@="1B000\loop\relax\ifnum \count@<"1B170
 239   \ltjsetparameter{rubypreintrusion={\the\count@,1},
 240     rubypostintrusion={\the\count@,1}}
 241   \advance\count@1\repeat
 242 %% 開き括弧・閉じ括弧
 243 \@for\@tmp:=`\‘,`\“,`\〈,`\《,`\「,`\『,`\【,`\〔,`\〖,`\〘,`\〝,`\（,`\［,`\｛,`\｟ \do
 244   {\ltjsetparameter{rubypreintrusion={\@tmp,-1}}}
 245 \@for\@tmp:=`\’,`\”,`\〉,`\》,`\」,`\』,`\】,`\〕,`\〗,`\〙,`\〟,`\）,`\］,`\｝,`\｠ \do
 246   {\ltjsetparameter{rubypostintrusion={\@tmp,-1}}}
 247 %% 中点類
 248 \@for\@tmp:=`\・,`\：,`\；,`\―,`\‥,`\…,`〳,`\〴,`\〵,"2014 \do
 249   {\ltjsetparameter{rubypreintrusion={\@tmp,0.5},rubypostintrusion={\@tmp,0.5}}}
 250 %% 読点・句点
 251 \@for\@tmp:=`\、,`\，,`\。,`\． \do
 252   {\ltjsetparameter{rubypostintrusion={\@tmp,-1}}}
 253 %% 段落インデント部分
 254 \ltjsetparameter{rubypreintrusion={-1,1}}
 255
 256 \setkeys[ltj]{ruby}{
 257   pre=-1, post=-1, mode=1,
 258   stretchruby={1}{2}{1}, stretch = {1}{2}{1},
 259   stretchbol={0}{1}{1}, stretcheol={1}{1}{0},
 260   maxmargin=0.5, size=0.5, intergap=0, rubysmash=false,
 261   kenten=\textbullet, fontcmd=\relax, ybaseheight=0.88, tbaseheight=0.5,
 262   yrubydepth=0.12, trubydepth=0.5,
 263   intrude_jfmgk, intrude_kanjiskip, intrude_xkanjiskip,
 264   epsilon=0.0001,
 265 }
 266
 267 \endinput