summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/biblatex/latex/blx-case-expl3.sty
blob: e90a4a7c11d5884501755568fca0c915514c7f83 (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
\RequirePackage{expl3}[2020/04/06]
\RequirePackage{xparse}
\ProvidesExplPackage {blx-case-expl3} {\abx@date} {\abx@version}
  {expl3 case changing code for biblatex}


% helper macros to work around babel \languagename catcode weirdness
\cs_new:Npn \__biblatex_clist_put_detokenized_left:Nn #1 #2
  {
    \clist_put_left:No #1 { \detokenize{#2} }
  }

\cs_generate_variant:Nn \__biblatex_clist_put_detokenized_left:Nn { Ne }


\prg_new_conditional:Npnn \__biblatex_clist_if_detokenized_in:Nn #1#2 { TF }
  {
    \clist_if_in:NoTF #1 { \detokenize{#2} }
      {\prg_return_true:}
      {\prg_return_false:}
  }

\prg_generate_conditional_variant:Nnn \__biblatex_clist_if_detokenized_in:Nn {Ne} {TF}



% Map for babel/polyglossia names
% to BCP-47-like l3text names.
% We only need maps for l3text names that do something
% as of 2020/04/06 those names are
% az, de-alt, el, lt, nl, tr.
% biblatex currently only supports dutch, greek and turkish
% so we only map those.
% de-alt is optional and still unusual, so *we* don't map it,
% but a user could map it themselves.

\prop_new:N \l__biblatex_babel_to_pseudobcp_prop

\cs_generate_variant:Nn \msg_info:nnnnn  { nnnxn }

\cs_new_protected:Npn \biblatex_maplang_babel_to_pseudobcp:nn #1 #2
  {
    \prop_if_in:NnT \l__biblatex_babel_to_pseudobcp_prop {#1}
      {
        \msg_info:nnnxn { biblatex }
          { overwrite-babel-to-pseudobcp-map }
          {#1}
          {\prop_item:Nn \l__biblatex_babel_to_pseudobcp_prop {#1}}
          {#2}
      }
    \prop_put:Nnn \l__biblatex_babel_to_pseudobcp_prop {#1} {#2}
  }

\NewDocumentCommand \DeclareBabelToExplLanguageMapping {mm}
  {
    \biblatex_maplang_babel_to_pseudobcp:nn {#1} {#2}
  }

\cs_generate_variant:Nn \msg_info:nnnn  { nnnx }

\cs_new_protected:Npn \biblatex_unmaplang_babel_to_pseudobcp:n #1
  {
    \prop_if_in:NnT \l__biblatex_babel_to_pseudobcp_prop {#1}
      {
        \msg_info:nnnx { biblatex }
          { remove-babel-to-pseudobcp-map }
          {#1}
          { \prop_item:Nn \l__biblatex_babel_to_pseudobcp_prop {#1} }
      }
    \prop_remove:Nn \l__biblatex_babel_to_pseudobcp_prop {#1}
  }

\NewDocumentCommand \UndeclareBabelToExplLanguageMapping {m}
  {
    \str_if_eq:nnTF {#1} {*}
      { \prop_clear:N  \l__biblatex_babel_to_pseudobcp_prop }
      { \biblatex_unmaplang_babel_to_pseudobcp:n {#1} }
  }

% Don't put this into biblatex.sty, since
% \DeclareBabelToExplLanguageMapping has no equivalent in the LaTeX2e
% code.
\DeclareBabelToExplLanguageMapping{dutch}{nl}
\DeclareBabelToExplLanguageMapping{greek}{el}
\DeclareBabelToExplLanguageMapping{turkish}{tr}

% Our copy of \l_text_titlecase_check_letter_bool
\bool_new:N \l_biblatex_titlecase_check_letter_bool
% Just to be clear: unlike l3text our default is "false"
\bool_set_false:N \l_biblatex_titlecase_check_letter_bool

% Helper macro to avoid unnecessary repetition of the same structure
% {<case [lowercase|uppercase|titlecase|titlecase_first]>}
% {<babel language>}{<text>}
% We use that \prop_item:Nn is empty if the item is not present
% and that \text_...:nn becomes \text_...:n if the first argument
% is empty.
\cs_new_protected:Npn \__biblatex_text_makeconverter:nnn #1 #2 #3
  {
    \group_begin:
      \bool_if_exist:NTF \l_text_titlecase_check_letter_bool
        {
          \bool_set_eq:NN \l_text_titlecase_check_letter_bool
                          \l_biblatex_titlecase_check_letter_bool
        }
        {
          % should we raise an error or at least issue a warning here?
        }
      \use:c { text_#1:nn }
        { \prop_item:Nn \l__biblatex_babel_to_pseudobcp_prop {#2} } {#3}
    \group_end:
  }


\cs_new:Npn \biblatex_text_lowercase:nn #1 #2
  {
    \__biblatex_text_makeconverter:nnn {lowercase} {#1} {#2}
  }

\cs_generate_variant:Nn \biblatex_text_lowercase:nn { Vn }

\cs_new:Npn \biblatex_text_lowercase:n #1
  {
    \biblatex_text_lowercase:Vn \blx@languagename {#1}
  }

\cs_set_eq:NN \blx@maketext@lowercase \biblatex_text_lowercase:n


\cs_new:Npn \biblatex_text_uppercase:nn #1 #2
  {
    \__biblatex_text_makeconverter:nnn {uppercase} {#1} {#2}
  }

\cs_generate_variant:Nn \biblatex_text_uppercase:nn { Vn }

\cs_new:Npn \biblatex_text_uppercase:n #1
  {
    \biblatex_text_uppercase:Vn \blx@languagename {#1}
  }

\cs_set_eq:NN \blx@maketext@uppercase \biblatex_text_uppercase:n


\cs_new:Npn \biblatex_text_makecapital:nn #1 #2
  {
    \__biblatex_text_makeconverter:nnn {titlecase_first} {#1} {#2}
  }

\cs_generate_variant:Nn \biblatex_text_makecapital:nn { Vn }

\cs_new:Npn \biblatex_text_makecapital:n #1
  {
    \biblatex_text_makecapital:Vn \blx@languagename {#1}
  }

\cs_set_eq:NN \blx@maketext@makecapital \biblatex_text_makecapital:n

\NewDocumentCommand \MakeCapital {m}
  {
    \biblatex_text_makecapital:n {#1}
  }



% BibTeX to expl3 case protection code by Joseph Wright
% https://github.com/plk/biblatex/issues/960#issuecomment-578435859
% and Bruno Le Floch
% https://github.com/moewew/biblatex/commit/c485f1b8079d56497b17343d7883b8fcd42f961a#r39225533
\tl_put_right:Nn \l_text_expand_exclude_tl { \NoCaseChange }

\tl_put_right:Nn \l_text_case_exclude_arg_tl { \NoCaseChange }

\cs_new:Npn \biblatex_text_bibtex_to_expl:n #1
  {
    \__biblatex_text_bibtex_loop:w #1
    { \q_recursion_tail } \q_recursion_stop
  }

\cs_new:Npn \__biblatex_text_bibtex_loop:w #1 #
  {
    \exp_not:n {#1}
    \__biblatex_text_bibtex_group:n
  }

\cs_new:Npn \__biblatex_text_bibtex_group:n #1
  {
    \quark_if_recursion_tail_stop:n {#1}
    {
      \bool_lazy_and:nnTF
        { \tl_if_head_is_N_type_p:n {#1} }
        { \exp_after:wN \token_if_cs_p:N \tl_head:w #1 \q_stop }
        { \exp_not:n {#1} }
        { \exp_not:n { \NoCaseChange {#1} } }
      }
    \__biblatex_text_bibtex_loop:w
  }

\cs_new_eq:NN \biblatex_text_sentencecase_preprocess:n
              \biblatex_text_bibtex_to_expl:n


% By default we emulate BibTeX's brace case protection rules
% but the user can turn that off for a more sane behaviour
% that only relies on \NoCaseChange.
\DeclareBiblatexOption{global,type,entry}[boolean]{bibtexcaseprotection}[true]{%
  \str_case:nnF {#1}
    {
      { true }
      {
        \cs_set_eq:NN \biblatex_text_sentencecase_preprocess:n
                      \biblatex_text_bibtex_to_expl:n
      }
      { false }
      {
        \cs_set_eq:NN \biblatex_text_sentencecase_preprocess:n
                      \use:n
      }
    }
    {
      \msg_error:nnn { biblatex } { invalid-value-bibtexcaseprotection }
                     {#1}
    }
}


\cs_new:Npn \biblatex_text_sentencecase:nn #1 #2
  {
    \__biblatex_text_makeconverter:nnn {titlecase} {#1} {#2}
  }


\cs_generate_variant:Nn \biblatex_text_sentencecase:nn { Vo, xo }

% If \DeclareCaseLangs says we should apply sentence casing,
% we go for it and pass the language along to the sentence casing macro.
% Preprocess is either the BibTeX-to-expl3 brace translator
% or \@firstofone (do nothing),
% we need to expand once to get rid of the latter.
\NewDocumentCommand \MakeSentenceCase {sm}
  {
    \IfBooleanTF {#1}
      {
        \__biblatex_clist_if_detokenized_in:NeTF
          \l__biblatex_caselangs_clist { \blx@mksc@lang }
          {
            \biblatex_text_sentencecase:xo { \blx@mksc@lang }
              { \biblatex_text_sentencecase_preprocess:n {#2} }
          }
          {#2}
      }
      {
        \biblatex_text_sentencecase:Vo \blx@languagename
          { \biblatex_text_sentencecase_preprocess:n {#2} }
      }
  }


\clist_new:N \l__biblatex_caselangs_clist

% {<language,language,...>}
\NewDocumentCommand \DeclareCaseLangs {sm}
  {
    \IfBooleanF {#1}
      { \clist_clear:N \l__biblatex_caselangs_clist }
    \__biblatex_clist_put_detokenized_left:Ne
      \l__biblatex_caselangs_clist {#2}
  }

% \DeclareCaseLangs invocation is in biblatex.sty

\NewDocumentCommand \ifcaselang {O{\blx@languagename}}
  {
    \__biblatex_clist_if_detokenized_in:NeTF \l__biblatex_caselangs_clist {#1}
  }


\msg_new:nnnn { biblatex } { invalid-value-bibtexcaseprotection }
  { Invalid~value~'#1'~for~option~'bibtexcaseprotection'. }
  { Valid~values~for~'bibtexcaseprotection'~are~'true'~and~'false'. }

\msg_new:nnn { biblatex } { remove-babel-to-pseudobcp-map }
  { Removing~babel->l3text~language~mapping~for~'#1'~to~'#2'. }

\msg_new:nnn { biblatex } { overwrite-babel-to-pseudobcp-map }
  { Overwriting~babel->l3text~language~mapping~for~'#1'~from~
    '#2'~to~'#3'. }

\endinput