src/addons/luatexja-ruby.sty

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