summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/autotype/autotype.sty
blob: 245098ff204f20d60d42d9d6ca71ecc72701fe41 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
%% autotype.sty
%% Copyright 2020-2024 Stephan Hennig and Keno Wehr
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in
% http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions of LaTeX
% version 2005/12/01 or later.
\ProvidesExplPackage {autotype} {2024-01-05} {0.5} {automatic language-specific typography}

% Variables
\str_new:N \l_autotype_lang_str % for storing a language name
\str_new:N \l_autotype_font_str % font name given by the user

% Error messages
\msg_new:nnn {autotype} {bad-engine}
  {
    LuaTeX~engine~required.~You~could~try~with~the~'lualatex'~command.
  }
\msg_new:nnn {autotype} {undefined-language} {Language~'#1'~is~not~loaded.}

\msg_new:nnn {autotype} {strange-noligbreak}
  {
    The~ligbreak~option~is~not~active~for~\languagename.~
    The~\noligbreak~command~is~useless~\msg_line_context: .
  }

% Test for the LuaTeX engine
\sys_if_engine_luatex:F { \msg_fatal:nn {autotype} {bad-engine} }

% Load autotype's Lua module
\directlua { autotype = require('autotype') }

% To be able to switch the node list manipulation on and off even within a
% paragraph, we define a LuaTeX attribute for every language and autotype
% option requested be the user. E.g., for breaking up ligatures in language
% 'ngerman' we create an attribute \autotype_ngerman_ligbreak_attr.

% Check if a LuaTeX attribute exists
% #1: language name, #2: autotype option
\prg_new_conditional:Npnn \autotype_attribute_if_exist:nn #1#2 {T,F,TF}
  {
    \cs_if_exist:cTF {autotype_#1_#2_attr} {\prg_return_true:} {\prg_return_false:}
  }

\cs_generate_variant:Nn \autotype_attribute_if_exist:nnT {V}
\cs_generate_variant:Nn \autotype_attribute_if_exist:nnF {V}

% Command for creating LuaTeX attributes
% #1: language name, #2: autotype option
\cs_new:Npn \autotype_new_attribute:nn #1#2
  {
    \exp_after:wN \newattribute \cs:w autotype_#1_#2_attr \cs_end:
  }

\cs_generate_variant:Nn \autotype_new_attribute:nn {Vn}

% Command for setting LuaTeX attributes
% #1: language name, #2: autotype option
\cs_new:Npn \autotype_set_attribute:nn #1#2
  {
    \exp_after:wN \setattribute \cs:w autotype_#1_#2_attr \cs_end: {1}
  }

\cs_generate_variant:Nn \autotype_set_attribute:nn {Vn}

% Command for unsetting LuaTeX attributes
% #1: language name, #2: autotype option
\cs_new:Npn \autotype_unset_attribute:nn #1#2
  {
    \exp_after:wN \unsetattribute \cs:w autotype_#1_#2_attr \cs_end:
  }

\cs_generate_variant:Nn \autotype_unset_attribute:nn {Vn}

% Check if a LuaTeX attribute is set
% #1: language name, #2: autotype option
\prg_new_conditional:Npnn \autotype_attribute_if_set:nn #1#2 {TF}
  {
    \int_compare:nNnTF { \cs:w autotype_#1_#2_attr \cs_end: } = {1}
      {
        \prg_return_true:
      }
      {
        \prg_return_false:
      }
  }

% #1: language name, #2: Lua function name
\cs_new:Npn \autotype_activate_lang_option:nn #1#2
  {
    \@ifpackageloaded {polyglossia}
      {
        \begin {#1} % invoke polyglossia language environment
        \directlua { autotype.#2 ('#1', tex.language) }
        \end {#1}
      }
      {
        \directlua { autotype.#2 ('#1') }
      }
  }

\cs_generate_variant:Nn \autotype_activate_lang_option:nn {Vn}

% #1: attribute name
\cs_new:Npn \autotype_activate_lang_option_with_attribute:n #1
  {
    % Create attribute if not already existing
    \autotype_attribute_if_exist:VnF \l_autotype_lang_str {#1}
      {
        \autotype_new_attribute:Vn \l_autotype_lang_str {#1}
        % Register callback
        \autotype_activate_lang_option:Vn \l_autotype_lang_str {#1}
      }
    % Set attribute
    \autotype_set_attribute:Vn \l_autotype_lang_str {#1}
  }

% #1: attribute name
\cs_new:Npn \autotype_deactivate_lang_option_with_attribute:n #1
  {
    % Unset attribute if existing
    \autotype_attribute_if_exist:VnT \l_autotype_lang_str {#1}
      {
        \autotype_unset_attribute:Vn \l_autotype_lang_str {#1}
      }
  }

% Command for executing language options
% #1: language name, #2: option
\cs_new:Npn \autotype_execute_lang_option:nn #1#2
  {
    \str_set:Nn \l_autotype_lang_str {#1}
    \keys_set:nn {autotype-lang} {#2}
  }

\keys_define:nn {autotype-lang}
  {
    hyphenation .choices:nn = {default, primary, weighted}
      {
        \str_case:nn {#1}
          {
            {default} { \autotype_activate_lang_option:Vn \l_autotype_lang_str {default_hyph} }
            {primary} { \autotype_activate_lang_option:Vn \l_autotype_lang_str {primary_hyph} }
            {weighted} { \autotype_activate_lang_option:Vn \l_autotype_lang_str {weighted_hyph} }
          }
      } ,
    hyphenation .value_required:n = true ,
    mark-hyph. choices:nn = {on, off}
      {
        \str_case:nn {#1}
          {
            {on}  { \autotype_activate_lang_option_with_attribute:n {mark_hyph} }
            {off} { \autotype_deactivate_lang_option_with_attribute:n {mark_hyph} }
          }
      } ,
    mark-hyph .default:n = {on} ,
    ligbreak .choices:nn = {on, off}
      {
        \str_case:nn {#1}
          {
            {on}  { \autotype_activate_lang_option_with_attribute:n {ligbreak} }
            {off} { \autotype_deactivate_lang_option_with_attribute:n {ligbreak} }
          }
      } ,
    ligbreak .default:n = {on} ,
    long-s .choices:nn = {on, off}
      {
        \str_case:nn {#1}
          {
            {on}  { \autotype_activate_lang_option_with_attribute:n {long_s} }
            {off} { \autotype_deactivate_lang_option_with_attribute:n {long_s} }
          }
      } ,
    long-s .default:n = {on}
  }

\keys_define:nn {autotype-font}
  {
    long-s-codepoint .code:n = { \directlua { autotype.set_long_s_codepoint ( "\l_autotype_font_str" , #1 ) } } ,
    round-s-codepoint .code:n = { \directlua { autotype.set_round_s_codepoint ( "\l_autotype_font_str" , #1 ) } } ,
    final-round-s-codepoint .code:n = { \directlua { autotype.set_final_round_s_codepoint ( "\l_autotype_font_str" , #1 ) } }
  }

% Command for executing font options
% #1: font name, #2: option
\cs_new:Npn \autotype_execute_font_option:nn #1#2
  {
    \str_set:Nn \l_autotype_font_str {#1}
    \keys_set:nn {autotype-font} {#2}
  }


%%%%% Document commands

% Command for setting autotype language options
% #1: language name, #2: a comma-separated list of options
\NewDocumentCommand \autotypelangoptions {mm}
  {
    % Test if language #1 is defined and iterate over options.
    \@ifpackageloaded {polyglossia}
      {
        \iflanguageloaded {#1}
          {
            \clist_map_inline:nn {#2} { \autotype_execute_lang_option:nn {#1} {##1} }
          }
          {
            \msg_error:nnn {autotype} {undefined-language} {#1}
          }
      }
      {
        \cs_if_exist:cTF {l@#1}
          {
            \clist_map_inline:nn {#2} { \autotype_execute_lang_option:nn {#1} {##1} }
          }
          {
            \msg_error:nnn {autotype} {undefined-language} {#1}
          }
      }
  }

% Command for setting autotype font options
% #1: font name, #2: a comma-separated list of options
\NewDocumentCommand \autotypefontoptions {mm}
  {
    \clist_map_inline:nn {#2} { \autotype_execute_font_option:nn {#1} {##1} }
  }

% Command for temporarily switching off the breaking up of ligatures
% #1: text for which no ligatures are broken up
% Note: This command may fail, if the language is changed within the argument.
\NewDocumentCommand \noligbreak {m}
  {
    % Check if the current language's ligbreak attribute exists
    \autotype_attribute_if_exist:nnTF {\languagename} {ligbreak}
      {
        % Check if the current language's ligbreak attribute is set
        \autotype_attribute_if_set:nnTF {\languagename} {ligbreak}
          {
            % Store the current language name (just in case it is changed
            % within the command argument)
            \str_set_eq:NN \l_autotype_lang_str \languagename
            % Unset the attribute
            \autotype_unset_attribute:nn {\languagename} {ligbreak}
            % Insert the argument
            #1
            % Reset the attribute
            \autotype_set_attribute:nn {\l_autotype_lang_str} {ligbreak}
          }
          {
            % Issue a warning
            \msg_warning:nn {autotype} {strange-noligbreak}
            % Insert the argument
            #1
          }
      }
      {
        % Issue a warning
        \msg_warning:nn {autotype} {strange-noligbreak}
        % Insert the argument
        #1
      }
  }

% Command for inserting a long s
\NewDocumentCommand \autotypelongs { }
  {
    % Check if the current language's long_s attribute exists
    \autotype_attribute_if_exist:nnTF {\languagename} {long_s}
      {
        % Check if the current language's long_s attribute is set
        \autotype_attribute_if_set:nnTF {\languagename} {long_s}
          {
            % Unset the attribute
            \autotype_unset_attribute:nn {\languagename} {long_s}
            % Insert a long s
            \symbol { \directlua { tex.write(autotype.get_current_long_s_codepoint()) } }
            % Reset the attribute
            \autotype_set_attribute:nn {\languagename} {long_s}
          }
          {
            % Insert a long s
            \symbol { \directlua { tex.write(autotype.get_current_long_s_codepoint()) } }
          }
      }
      {
        % Insert a long s
        \symbol { \directlua { tex.write(autotype.get_current_long_s_codepoint()) } }
      }
  }

% Command for inserting a round s
\NewDocumentCommand \autotyperounds { }
  {
    % Check if the current language's long_s attribute exists
    \autotype_attribute_if_exist:nnTF {\languagename} {long_s}
      {
        % Check if the current language's long_s attribute is set
        \autotype_attribute_if_set:nnTF {\languagename} {long_s}
          {
            % Unset the attribute
            \autotype_unset_attribute:nn {\languagename} {long_s}
            % Insert a round s
            \symbol { \directlua { tex.write(autotype.get_current_round_s_codepoint()) } }
            % Reset the attribute
            \autotype_set_attribute:nn {\languagename} {long_s}
          }
          {
            % Insert a long s
            \symbol { \directlua { tex.write(autotype.get_current_round_s_codepoint()) } }
          }
      }
      {
        % Insert a long s
        \symbol { \directlua { tex.write(autotype.get_current_round_s_codepoint()) } }
      }
  }