2 * \file LaTeXFeatures.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * Full author contact details are available in file CREDITS.
17 #include "LaTeXFeatures.h"
20 #include "BufferParams.h"
22 #include "Converter.h"
25 #include "FloatList.h"
27 #include "LaTeXFonts.h"
28 #include "LaTeXPackages.h"
31 #include "OutputParams.h"
32 #include "TextClass.h"
34 #include "texstream.h"
36 #include "insets/InsetLayout.h"
38 #include "support/debug.h"
39 #include "support/docstream.h"
40 #include "support/docstring.h"
41 #include "support/filetools.h"
42 #include "support/lstrings.h"
49 using namespace lyx::support;
54 /////////////////////////////////////////////////////////////////////
58 /////////////////////////////////////////////////////////////////////
60 //\NeedsTeXFormat{LaTeX2e}
61 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
62 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
64 static docstring const lyx_def = from_ascii(
65 "{%\n L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}");
67 static docstring const noun_def = from_ascii(
68 "\\newcommand{\\noun}[1]{\\textsc{#1}}");
70 static docstring const lyxarrow_def = from_ascii(
71 "\\DeclareRobustCommand*{\\lyxarrow}{%\n"
73 "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
74 "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}");
76 static docstring const aastex_case_def = from_ascii(
77 "\\providecommand\\case[2]{\\mbox{$\\frac{#1}{#2}$}}%");
78 // Copied from https://github.com/AASJournals/AASTeX60/blob/master/cls/aastex63.cls#L1645
79 // Adapted to providecommand for compatibility reasons.
81 // ZERO WIDTH SPACE (ZWSP) is actually not a space character
82 // but marks a line break opportunity. Several commands provide a
83 // line break opportunity. They differ in side-effects:
84 // \allowbreak prevents hyphenation after hyphen or dash + ZWSP
85 // \linebreak[<n>] takes an optional argument denoting "urgency".
86 // The \LyXZeroWidthSpace wrapper allows customization in the preamble.
87 static docstring const lyxZWSP_def = from_ascii(
88 "\\newcommand*\\LyXZeroWidthSpace{\\hspace{0pt}}");
90 // for quotes without babel. This does not give perfect results, but
91 // anybody serious about non-english quotes should use babel (JMarc).
93 static docstring const quotedblbase_def = from_ascii(
94 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
95 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
96 " \\penalty10000\\hskip0em\\relax%\n"
99 static docstring const quotesinglbase_def = from_ascii(
100 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
101 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
102 " \\penalty10000\\hskip0em\\relax%\n"
105 static docstring const guillemotleft_def = from_ascii(
106 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
107 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
108 "\\penalty10000\\hskip0pt\\relax%\n"
111 static docstring const guillemotright_def = from_ascii(
112 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
113 " \\penalty10000\\hskip0pt%\n"
114 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
117 static docstring const guilsinglleft_def = from_ascii(
118 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
119 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
120 " \\penalty10000\\hskip0pt\\relax%\n"
123 static docstring const guilsinglright_def = from_ascii(
124 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
125 " \\penalty10000\\hskip0pt%\n"
126 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
129 static docstring const textquotedbl_def = from_ascii(
130 "\\DeclareTextSymbolDefault{\\textquotedbl}{T1}");
132 static docstring const textquotedblp_xetex_def = from_ascii(
133 "\\providecommand\\textquotedblplain{%\n"
134 " \\bgroup\\addfontfeatures{Mapping=}\\char34\\egroup}");
136 static docstring const textquotedblp_luatex_def = from_ascii(
137 "\\providecommand\\textquotedblplain{%\n"
138 " \\bgroup\\addfontfeatures{RawFeature=-tlig}\\char34\\egroup}");
140 static docstring const textquotesinglep_xetex_def = from_ascii(
141 "\\providecommand\\textquotesingleplain{%\n"
142 " \\bgroup\\addfontfeatures{Mapping=}\\char39\\egroup}");
144 static docstring const textquotesinglep_luatex_def = from_ascii(
145 "\\providecommand\\textquotesingleplain{%\n"
146 " \\bgroup\\addfontfeatures{RawFeature=-tlig}\\char39\\egroup}");
148 static docstring const paragraphleftindent_def = from_ascii(
149 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
151 " \\begin{list}{}{%\n"
152 " \\setlength{\\topsep}{0pt}%\n"
153 " \\addtolength{\\leftmargin}{#1}\n"
154 // ho hum, yet more things commented out with no hint as to why they
155 // weren't just removed
156 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
157 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
158 // "%% \\setlength\\listparindent\\parindent%\n"
159 // "%% \\setlength\\itemindent\\parindent%\n"
160 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
166 static docstring const floatingfootnote_def = from_ascii(
167 "%% Special footnote code from the package 'stblftnt.sty'\n"
168 "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
169 "\\let\\SF@@footnote\\footnote\n"
170 "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
171 " \\expandafter\\SF@@footnote\n"
173 " \\expandafter\\SF@gobble@opt\n"
176 "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
177 " \\SF@gobble@twobracket\n"
180 "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
181 " \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
182 "\\def\\SF@gobble@twobracket[#1]#2{}\n");
184 static docstring const binom_def = from_ascii(
185 "%% Binom macro for standard LaTeX users\n"
186 "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n");
188 static docstring const mathcircumflex_def = from_ascii(
189 "%% For printing a cirumflex inside a formula\n"
190 "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n");
192 static docstring const tabularnewline_def = from_ascii(
193 "%% Because html converters don't know tabularnewline\n"
194 "\\providecommand{\\tabularnewline}{\\\\}\n");
196 static docstring const cellvarwidth_def = from_ascii(
197 "%% Variable width box for table cells\n"
198 "\\newenvironment{cellvarwidth}[1][t]\n"
199 " {\\begin{varwidth}[#1]{\\linewidth}}\n"
200 " {\\@finalstrut\\@arstrutbox\\end{varwidth}}\n");
202 // We want to omit the file extension for includegraphics, but this does not
203 // work when the filename contains other dots.
204 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
205 static docstring const lyxdot_def = from_ascii(
206 "%% A simple dot to overcome graphicx limitations\n"
207 "\\newcommand{\\lyxdot}{.}\n");
209 static docstring const changetracking_xcolor_ulem_base_def = from_ascii(
210 "%% Change tracking with ulem and xcolor: base macros\n"
211 "\\DeclareRobustCommand{\\mklyxadded}[1]{\\bgroup\\color{lyxadded}{}#1\\egroup}\n"
212 "\\DeclareRobustCommand{\\mklyxdeleted}[1]{\\bgroup\\color{lyxdeleted}\\mklyxsout{#1}\\egroup}\n"
213 "\\DeclareRobustCommand{\\mklyxsout}[1]{\\ifx\\\\#1\\else\\sout{#1}\\fi}\n");
215 static docstring const changetracking_xcolor_ulem_def = from_ascii(
216 "%% Change tracking with ulem and xcolor: ct markup\n"
217 "\\DeclareRobustCommand{\\lyxadded}[4][]{\\mklyxadded{#4}}\n"
218 "\\DeclareRobustCommand{\\lyxdeleted}[4][]{\\mklyxdeleted{#4}}\n");
220 static docstring const changetracking_xcolor_ulem_cb_def = from_ascii(
221 "%% Change tracking with ulem, xcolor and changebars: ct markup\n"
222 "\\DeclareRobustCommand{\\lyxadded}[4][]{%\n"
223 " \\protect\\cbstart\\mklyxadded{#4}%\n"
224 " \\protect\\cbend%\n"
226 "\\DeclareRobustCommand{\\lyxdeleted}[4][]{%\n"
227 " \\protect\\cbstart\\mklyxdeleted{#4}%\n"
228 " \\protect\\cbend%\n"
231 static docstring const changetracking_xcolor_ulem_hyperref_def = from_ascii(
232 "%% Change tracking with ulem, xcolor, and hyperref: ct markup\n"
233 "\\DeclareRobustCommand{\\lyxadded}[4][]{\\texorpdfstring{\\mklyxadded{#4}}{#4}}\n"
234 "\\DeclareRobustCommand{\\lyxdeleted}[4][]{\\texorpdfstring{\\mklyxdeleted{#4}}{}}\n");
236 static docstring const changetracking_xcolor_ulem_hyperref_cb_def = from_ascii(
237 "%% Change tracking with ulem, xcolor, hyperref and changebars: ct markup\n"
238 "\\DeclareRobustCommand{\\lyxadded}[4][]{%\n"
239 " \\texorpdfstring{\\protect\\cbstart\\mklyxadded{#4}%\n"
240 " \\protect\\cbend}{#4}%\n"
242 "\\DeclareRobustCommand{\\lyxdeleted}[4][]{%\n"
243 " \\texorpdfstring{\\protect\\cbstart\\mklyxdeleted{#4}%\n"
244 " \\protect\\cbend}{}%\n"
247 static docstring const changetracking_tikz_object_sout_def = from_ascii(
248 "%% Strike out display math and text objects with tikz\n"
249 "\\usetikzlibrary{calc}\n"
250 "\\newcommand{\\lyxobjectsout}[1]{%\n"
252 " \\color{lyxdeleted}%\n"
254 " \\node[inner sep=0pt,outer sep=0pt](lyxdelobj){#1};\n"
255 " \\draw($(lyxdelobj.south west)+(2em,.5em)$)--($(lyxdelobj.north east)-(2em,.5em)$);\n"
260 static docstring const changetracking_xcolor_ulem_object_def = from_ascii(
261 "%% Change tracking with ulem and xcolor: ct markup for complex objects\n"
262 "\\DeclareRobustCommand{\\lyxobjdeleted}[4][]{\\lyxobjectsout{#4}}\n"
263 "\\DeclareRobustCommand{\\lyxdisplayobjdeleted}[4][]{%\n"
264 " \\ifx#4\\empty\\else%\n"
265 " \\leavevmode\\\\%\n"
266 " \\lyxobjectsout{\\parbox{\\linewidth}{#4}}%\n"
269 "\\DeclareRobustCommand{\\lyxudisplayobjdeleted}[4][]{%\n"
270 " \\ifx#4\\empty\\else%\n"
271 " \\leavevmode\\\\%\n"
272 " \\raisebox{-\\belowdisplayshortskip}{%\n"
273 " \\lyxobjectsout{\\parbox[b]{\\linewidth}{#4}}}%\n"
274 " \\leavevmode\\\\%\n"
278 static docstring const changetracking_xcolor_ulem_cb_object_def = from_ascii(
279 "%% Change tracking with ulem, xcolor and changebars:ct markup for complex objects\n"
280 "\\DeclareRobustCommand{\\lyxobjdeleted}[4][]{%\n"
281 " \\protect\\cbstart\\lyxobjectsout{#4}%\n"
282 " \\protect\\cbend%\n"
284 "\\DeclareRobustCommand{\\lyxdisplayobjdeleted}[4][]{%\n"
285 " \\ifx#4\\empty\\else%\n"
286 " \\leavevmode\\\\%\n"
287 " \\protect\\cbstart%\n"
288 " \\lyxobjectsout{\\parbox{\\linewidth}{#4}}%\n"
289 " \\protect\\cbend%\n"
292 "\\DeclareRobustCommand{\\lyxudisplayobjdeleted}[4][]{%\n"
293 " \\ifx#4\\empty\\else%\n"
294 " \\leavevmode\\\\%\n"
295 " \\raisebox{-\\belowdisplayshortskip}{%\n"
296 " \\protect\\cbstart%\n"
297 " \\lyxobjectsout{\\parbox[b]{\\linewidth}{#4}}}%\n"
298 " \\protect\\cbend%\n"
299 " \\leavevmode\\\\%\n"
303 static docstring const changetracking_xcolor_ulem_hyperref_object_def = from_ascii(
304 "%% Change tracking with ulem, xcolor, and hyperref: ct markup for complex objects\n"
305 "\\DeclareRobustCommand{\\lyxobjdeleted}[4][]{\\texorpdfstring{\\lyxobjectsout{#4}}{}}\n"
306 "\\DeclareRobustCommand{\\lyxdisplayobjdeleted}[4][]{%\n"
307 " \\ifx#4\\empty\\else%\n"
308 " \\texorpdfstring{\\leavevmode\\\\\\lyxobjectsout{\\parbox{\\linewidth}{#4}}}{}%\n"
311 "\\DeclareRobustCommand{\\lyxudisplayobjdeleted}[4][]{%\n"
312 " \\ifx#4\\empty\\else%\n"
313 " \\texorpdfstring{\\leavevmode\\\\\\raisebox{-\\belowdisplayshortskip}{%\n"
314 " \\lyxobjectsout{\\parbox[b]{\\linewidth}{#4}}}}{}%\n"
315 " \\leavevmode\\\\%\n"
319 static docstring const changetracking_xcolor_ulem_hyperref_cb_object_def = from_ascii(
320 "%% Change tracking with ulem, xcolor, hyperref and changebars:\n"
321 "%% ct markup for complex objects\n"
322 "\\DeclareRobustCommand{\\lyxobjdeleted}[4][]{%\n"
323 " \\texorpdfstring{\\protect\\cbstart\\lyxobjectsout{#4}%\n"
324 " \\protect\\cbend}{}%\n"
326 "\\DeclareRobustCommand{\\lyxdisplayobjdeleted}[4][]{%\n"
327 " \\ifx#4\\empty\\else%\n"
328 " \\texorpdfstring{\\leavevmode\\\\\\protect\\cbstart%\n"
329 " \\lyxobjectsout{\\parbox{\\linewidth}{#4}}%\n"
330 " \\protect\\cbend%\n"
334 "\\DeclareRobustCommand{\\lyxudisplayobjdeleted}[4][]{%\n"
335 " \\ifx#4\\empty\\else%\n"
336 " \\texorpdfstring{\\leavevmode\\\\\\protect\\cbstart%\n"
337 " \\raisebox{-\\belowdisplayshortskip}{%\n"
338 " \\lyxobjectsout{\\parbox[b]{\\linewidth}{#4}}%\n"
340 " \\leavevmode\\\\%\n"
345 static docstring const changetracking_none_def = from_ascii(
346 "%% Change tracking: Disable markup in output\n"
347 "\\newcommand{\\lyxadded}[3]{#3}\n"
348 "\\newcommand{\\lyxdeleted}[3]{}\n"
349 "\\newcommand{\\lyxobjdeleted}[3]{}\n"
350 "\\newcommand{\\lyxdisplayobjdeleted}[3]{}\n"
351 "\\newcommand{\\lyxudisplayobjdeleted}[3]{}\n");
353 static docstring const textgreek_LGR_def = from_ascii(
354 "\\DeclareFontEncoding{LGR}{}{}\n");
355 static docstring const textgreek_def = from_ascii(
356 "\\DeclareRobustCommand{\\greektext}{%\n"
357 " \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
358 "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n");
360 static docstring const textcyr_T2A_def = from_ascii(
361 "\\InputIfFileExists{t2aenc.def}{}{%\n"
362 " \\errmessage{File `t2aenc.def' not found: Cyrillic script not supported}}\n");
363 static docstring const textcyr_def = from_ascii(
364 "\\DeclareRobustCommand{\\cyrtext}{%\n"
365 " \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
366 "\\DeclareRobustCommand{\\textcyrillic}[1]{\\leavevmode{\\cyrtext #1}}\n");
368 static docstring const lyxmathsym_def = from_ascii(
369 "\\newcommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
370 " \\text{\\ifx\\math@version\\b@ld\\bfseries\\fi#1}\\endgroup\\else#1\\fi}\n");
372 static docstring const papersizedvi_def = from_ascii(
373 "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n");
375 static docstring const papersizepdf_def = from_ascii(
376 "\\pdfpageheight\\paperheight\n"
377 "\\pdfpagewidth\\paperwidth\n");
379 static docstring const papersizepdflua_def = from_ascii(
380 "% Backwards compatibility for LuaTeX < 0.90\n"
381 "\\@ifundefined{pageheight}{\\let\\pageheight\\pdfpageheight}{}\n"
382 "\\@ifundefined{pagewidth}{\\let\\pagewidth\\pdfpagewidth}{}\n"
383 "\\pageheight\\paperheight\n"
384 "\\pagewidth\\paperwidth\n");
386 static docstring const cedilla_def = from_ascii(
387 "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
388 "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n");
390 static docstring const subring_def = from_ascii(
391 "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
392 "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n");
394 static docstring const subdot_def = from_ascii(
395 "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
396 "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n");
398 static docstring const subhat_def = from_ascii(
399 "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
400 "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n");
402 static docstring const subtilde_def = from_ascii(
403 "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
404 "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n");
406 static docstring const dacute_def = from_ascii(
407 "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n");
409 static docstring const tipasymb_def = from_ascii(
410 "\\DeclareFontEncoding{T3}{}{}\n"
411 "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n");
413 static docstring const dgrave_def = from_ascii(
414 "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n");
416 static docstring const rcap_def = from_ascii(
417 "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n");
419 static docstring const ogonek_def = from_ascii(
420 "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
421 " \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
422 " \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
423 " \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
424 "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n");
426 static docstring const lyxaccent_def = from_ascii(
427 "%% custom text accent \\LyxTextAccent[<rise value (length)>]{<accent>}{<base>}\n"
428 "\\newcommand*{\\LyxTextAccent}[3][0ex]{%\n"
429 " \\hmode@bgroup\\ooalign{\\null#3\\crcr\\hidewidth\n"
430 " \\raise#1\\hbox{#2}\\hidewidth}\\egroup}\n"
431 "%% select a font size smaller than the current font size:\n"
432 "\\newcommand{\\LyxAccentSize}[1][\\sf@size]{%\n"
433 " \\check@mathfonts\\fontsize#1\\z@\\math@fontsfalse\\selectfont\n"
436 static docstring const textcommabelow_def = from_ascii(
437 "\\ProvideTextCommandDefault{\\textcommabelow}[1]{%%\n"
438 " \\LyxTextAccent[-.31ex]{\\LyxAccentSize,}{#1}}\n");
440 static docstring const textcommaabove_def = from_ascii(
441 "\\ProvideTextCommandDefault{\\textcommaabove}[1]{%%\n"
442 " \\LyxTextAccent[.5ex]{\\LyxAccentSize`}{#1}}\n");
444 static docstring const textcommaaboveright_def = from_ascii(
445 "\\ProvideTextCommandDefault{\\textcommaaboveright}[1]{%%\n"
446 " \\LyxTextAccent[.5ex]{\\LyxAccentSize\\ '}{#1}}\n");
448 // Baltic languages use a comma-accent instead of a cedilla
449 static docstring const textbaltic_def = from_ascii(
450 "%% use comma accent instead of cedilla for these characters:\n"
451 "\\DeclareTextCompositeCommand{\\c}{T1}{g}{\\textcommaabove{g}}\n"
452 "\\DeclareTextCompositeCommand{\\c}{T1}{G}{\\textcommabelow{G}}\n"
453 "\\DeclareTextCompositeCommand{\\c}{T1}{k}{\\textcommabelow{k}}\n"
454 "\\DeclareTextCompositeCommand{\\c}{T1}{K}{\\textcommabelow{K}}\n"
455 "\\DeclareTextCompositeCommand{\\c}{T1}{l}{\\textcommabelow{l}}\n"
456 "\\DeclareTextCompositeCommand{\\c}{T1}{L}{\\textcommabelow{L}}\n"
457 "\\DeclareTextCompositeCommand{\\c}{T1}{n}{\\textcommabelow{n}}\n"
458 "\\DeclareTextCompositeCommand{\\c}{T1}{N}{\\textcommabelow{N}}\n"
459 "\\DeclareTextCompositeCommand{\\c}{T1}{r}{\\textcommabelow{r}}\n"
460 "\\DeclareTextCompositeCommand{\\c}{T1}{R}{\\textcommabelow{R}}\n");
462 // Use cyrillic fonts to provide letter schwa in text (see #11062)
463 static docstring const textschwa_def = from_ascii(
464 "%% letter schwa missing in Latin fonts, use Cyrillic schwa\n"
465 "\\DeclareTextSymbolDefault{\\CYRSCHWA}{T2A}\n"
466 "\\DeclareTextSymbolDefault{\\cyrschwa}{T2A}\n"
467 "\\ProvideTextCommandDefault{\\textSchwa}{\\CYRSCHWA}\n"
468 "\\ProvideTextCommandDefault{\\textschwa}{\\cyrschwa}\n");
470 // split-level fractions
471 static docstring const xfrac_def = from_ascii(
472 "\\usepackage{xfrac}\n");
474 static docstring const smallLetterFrac_def = from_ascii(
475 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{default}{text}\n"
476 " {phantom=c, scale-factor=1.0, slash-left-kern=-.05em}\n"
477 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmr}{text}\n"
478 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
479 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmss}{text}\n"
480 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
481 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmr}{text}\n"
482 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
483 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmss}{text}\n"
484 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
485 "\\newcommand{\\smallLetterFrac}[2]{%\n"
486 " {\\UseCollection{xfrac}{smallLetterFrac}\\sfrac{#1}{#2}}}\n");
488 static docstring const lyxref_def = from_ascii(
489 "\\RS@ifundefined{subsecref}\n"
490 " {\\newref{subsec}{name = \\RSsectxt}}\n"
492 "\\RS@ifundefined{thmref}\n"
493 " {\\def\\RSthmtxt{theorem~}\\newref{thm}{name = \\RSthmtxt}}\n"
495 "\\RS@ifundefined{lemref}\n"
496 " {\\def\\RSlemtxt{lemma~}\\newref{lem}{name = \\RSlemtxt}}\n"
499 // Make sure the columns are also outputed as rtl
500 static docstring const rtloutputdblcol_def = from_ascii(
501 "\\def\\@outputdblcol{%\n"
502 " \\if@firstcolumn\n"
503 " \\global \\@firstcolumnfalse\n"
504 " \\global \\setbox\\@leftcolumn \\box\\@outputbox\n"
506 " \\global \\@firstcolumntrue\n"
507 " \\setbox\\@outputbox \\vbox {%\n"
508 " \\hb@xt@\\textwidth {%\n"
509 " \\kern\\textwidth \\kern-\\columnwidth %**\n"
510 " \\hb@xt@\\columnwidth {%\n"
511 " \\box\\@leftcolumn \\hss}%\n"
512 " \\kern-\\textwidth %**\n"
514 " {\\normalcolor\\vrule \\@width\\columnseprule}%\n"
516 " \\kern-\\textwidth %**\n"
517 " \\hb@xt@\\columnwidth {%\n"
518 " \\box\\@outputbox \\hss}%\n"
519 " \\kern-\\columnwidth \\kern\\textwidth %**\n"
522 " \\@combinedblfloats\n"
525 " \\@dblfloatplacement\n"
526 " \\@startdblcolumn\n"
527 " \\@whilesw\\if@fcolmade \\fi\n"
529 " \\@startdblcolumn}%\n"
533 "\\@mparswitchtrue\n");
535 static docstring const lyxmintcaption_def = from_ascii(
536 "\\long\\def\\lyxmintcaption[#1]#2{%\n"
537 " \\ifx#1t\\vskip\\baselineskip\\fi%\n"
538 " \\refstepcounter{listing}\\noindent%\n"
539 " \\addcontentsline{lol}{listing}%\n"
540 " {\\protect\\numberline{\\thelisting}{\\ignorespaces #2}}%\n"
541 " \\setbox\\@tempboxa\\hbox{\\listingscaption~\\thelisting: #2}%\n"
542 " \\ifdim \\wd\\@tempboxa >\\linewidth%\n"
543 " \\parbox[t]{\\linewidth}{\\unhbox\\@tempboxa}\\else%\n"
544 " \\hbox to\\linewidth{\\hfil\\box\\@tempboxa\\hfil}\\fi%\n"
545 " \\ifx#1b\\vskip\\baselineskip\\fi\n"
549 docstring const lyxgreyedoutDef(bool const rtl, bool const ct, bool const lua, bool const babel)
551 odocstringstream ods;
554 ods << "%% The greyedout annotation environment (with RTL support)\n"
555 << "\\NewEnviron{lyxgreyedout}{%\n";
557 // luabidi uses this switch
558 ods << " \\if@RTL%\n";
560 ods << " \\if@rl%\n";
561 ods << " \\everypar{%\n";
563 ods << " \\pardir TRT \\textdir TRT\\normalfont\\normalsize\\textcolor{note_fontcolor}\\ignorespaces%\n";
565 ods << " \\normalfont\\normalsize\\textcolor{note_fontcolor}\\beginL\\ignorespaces%\n";
568 ods << " \\colorlet{lyxadded}{lyxadded!30}\\colorlet{lyxdeleted}{lyxdeleted!30}%\n";
570 ods << " \\BODY\\everypar{\\ignorespacesafterend}%\n";
572 ods << " \\BODY\\everypar{\\ignorespacesafterend\\endL}%\n";
575 ods << " \\colorlet{lyxadded}{lyxadded!30}\\colorlet{lyxdeleted}{lyxdeleted!30}%\n";
576 ods << " \\normalfont\\normalsize\\textcolor{note_fontcolor}\\bgroup\\ignorespaces%\n"
577 << " \\BODY\\ignorespacesafterend\\egroup%\n"
581 ods << "%% The greyedout annotation environment\n"
582 << "\\newenvironment{lyxgreyedout}\n"
585 ods << "\\colorlet{lyxadded}{lyxadded!30}\\colorlet{lyxdeleted}{lyxdeleted!30}%\n ";
586 ods << "\\normalfont\\normalsize\\textcolor{note_fontcolor}\\bgroup\\ignorespaces}\n"
587 << "{\\ignorespacesafterend\\egroup}\n";
595 /////////////////////////////////////////////////////////////////////
599 /////////////////////////////////////////////////////////////////////
601 static docstring const lyxnoun_style = from_ascii(
603 " font-variant: small-caps;\n"
607 // this is how it normally renders, but it might not always do so.
608 static docstring const lyxstrikeout_style = from_ascii(
610 " text-decoration: line-through;\n"
614 /////////////////////////////////////////////////////////////////////
618 /////////////////////////////////////////////////////////////////////
621 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
622 OutputParams const & r)
623 : buffer_(&b), params_(p), runparams_(r), in_float_(false),
624 in_deleted_inset_(false)
628 LaTeXFeatures::LangPackage LaTeXFeatures::langPackage() const
630 string const local_lp = bufferParams().lang_package;
632 // Locally, custom is just stored as a string
633 // in bufferParams().lang_package.
634 if (local_lp != "auto"
635 && local_lp != "babel"
636 && local_lp != "default"
637 && local_lp != "none")
638 return LANG_PACK_CUSTOM;
640 if (local_lp == "none")
641 return LANG_PACK_NONE;
643 /* If "auto" is selected, we load polyglossia with non-TeX fonts,
644 * else we select babel.
645 * If babel is selected (either directly or via the "auto"
646 * mechanism), we really do only require it if we have
647 * a language that needs it.
649 bool const polyglossia_required =
650 params_.useNonTeXFonts
651 && isAvailable("polyglossia")
652 && !isProvided("babel")
653 && this->hasOnlyPolyglossiaLanguages();
654 bool const babel_required =
655 !bufferParams().language->babel().empty()
656 || !this->getBabelLanguages().empty();
658 if (local_lp == "auto") {
659 // polyglossia requirement has priority over babel
660 if (polyglossia_required)
661 return LANG_PACK_POLYGLOSSIA;
662 else if (babel_required)
663 return LANG_PACK_BABEL;
666 if (local_lp == "babel") {
668 return LANG_PACK_BABEL;
671 if (local_lp == "default") {
672 switch (lyxrc.language_package_selection) {
674 // polyglossia requirement has priority over babel
675 if (polyglossia_required)
676 return LANG_PACK_POLYGLOSSIA;
677 else if (babel_required)
678 return LANG_PACK_BABEL;
680 case LyXRC::LP_BABEL:
682 return LANG_PACK_BABEL;
684 case LyXRC::LP_CUSTOM:
685 return LANG_PACK_CUSTOM;
687 return LANG_PACK_NONE;
691 return LANG_PACK_NONE;
695 void LaTeXFeatures::require(string const & name)
697 features_.insert(name);
701 void LaTeXFeatures::require(set<string> const & names)
703 features_.insert(names.begin(), names.end());
707 void LaTeXFeatures::provide(string const & name)
709 provides_.insert(name);
713 void LaTeXFeatures::useLayout(docstring const & layoutname)
715 useLayout(layoutname, 0);
719 void LaTeXFeatures::useLayout(docstring const & layoutname, int level)
721 // Some code to avoid loops in dependency definition
722 const int maxlevel = 30;
723 if (level > maxlevel) {
724 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
725 << "recursion attained by layout "
726 << to_utf8(layoutname) << endl;
730 DocumentClass const & tclass = params_.documentClass();
731 if (tclass.hasLayout(layoutname)) {
732 // Is this layout already in usedLayouts?
733 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
734 != usedLayouts_.end())
737 Layout const & layout = tclass[layoutname];
738 require(layout.required());
740 if (!layout.depends_on().empty()) {
741 useLayout(layout.depends_on(), level + 1);
743 usedLayouts_.push_back(layoutname);
745 lyxerr << "LaTeXFeatures::useLayout: layout `"
746 << to_utf8(layoutname) << "' does not exist in this class"
752 void LaTeXFeatures::useInsetLayout(InsetLayout const & lay)
754 docstring const & lname = lay.name();
755 DocumentClass const & tclass = params_.documentClass();
757 // this is a default inset layout, nothing useful here
758 if (!tclass.hasInsetLayout(lname))
760 // Is this layout already in usedInsetLayouts?
761 if (find(usedInsetLayouts_.begin(), usedInsetLayouts_.end(), lname)
762 != usedInsetLayouts_.end())
765 require(lay.required());
766 usedInsetLayouts_.push_back(lname);
770 bool LaTeXFeatures::isRequired(string const & name) const
772 return features_.find(name) != features_.end();
776 bool LaTeXFeatures::isProvided(string const & name) const
778 // Currently, this is only features provided by babel languages
779 // (such as textgreek)
780 if (provides_.find(name) != provides_.end())
783 if (params_.useNonTeXFonts)
784 return params_.documentClass().provides(name);
786 bool const ot1 = (runparams().main_fontenc == "default"
787 || runparams().main_fontenc == "OT1");
788 bool const complete = (params_.fontsSans() == "default"
789 && params_.fontsTypewriter() == "default");
790 bool const nomath = (params_.fontsMath() == "default");
791 return params_.documentClass().provides(name)
792 || theLaTeXFonts().getLaTeXFont(
793 from_ascii(params_.fontsRoman())).provides(name, ot1,
796 || theLaTeXFonts().getLaTeXFont(
797 from_ascii(params_.fontsSans())).provides(name, ot1,
800 || theLaTeXFonts().getLaTeXFont(
801 from_ascii(params_.fontsTypewriter())).provides(name, ot1,
804 || theLaTeXFonts().getLaTeXFont(
805 from_ascii(params_.fontsMath())).provides(name, ot1,
811 bool LaTeXFeatures::mustProvide(string const & name) const
813 return isRequired(name) && !isProvided(name);
817 bool LaTeXFeatures::isAvailable(string const & name)
819 string::size_type const i = name.find("->");
820 if (i != string::npos) {
821 string const from = name.substr(0,i);
822 string const to = name.substr(i+2);
823 //LYXERR0("from=[" << from << "] to=[" << to << "]");
824 return theConverters().isReachable(from, to);
826 return LaTeXPackages::isAvailable(name);
830 bool LaTeXFeatures::isAvailableAtLeastFrom(string const & name, int const y, int const m, int const d)
832 return LaTeXPackages::isAvailableAtLeastFrom(name, y, m, d);
838 void addSnippet(std::list<TexString> & list, TexString ts, bool allow_dupes)
841 // test the absense of duplicates, i.e. elements with same str
842 none_of(list.begin(), list.end(), [&](TexString const & ts2){
843 return ts.str == ts2.str;
846 list.push_back(std::move(ts));
850 TexString getSnippets(std::list<TexString> const & list)
852 otexstringstream snip;
853 for (TexString const & ts : list)
854 snip << TexString(ts) << '\n';
855 return snip.release();
861 void LaTeXFeatures::addPreambleSnippet(TexString snippet, bool allow_dupes)
863 addSnippet(preamble_snippets_, std::move(snippet), allow_dupes);
867 void LaTeXFeatures::addPreambleSnippet(docstring const & snippet, bool allow_dupes)
869 addSnippet(preamble_snippets_, TexString(snippet), allow_dupes);
873 void LaTeXFeatures::addCSSSnippet(std::string const & snippet)
875 addSnippet(css_snippets_, TexString(from_ascii(snippet)), false);
879 TexString LaTeXFeatures::getPreambleSnippets() const
881 return getSnippets(preamble_snippets_);
885 docstring LaTeXFeatures::getCSSSnippets() const
887 return getSnippets(css_snippets_).str;
892 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
894 if (!usedFloats_[name])
895 usedFloats_[name] = subfloat;
898 // We only need float.sty if we use non builtin floats, or if we
899 // use the "H" modifier. This includes modified table and
900 // figure floats. (Lgb)
901 Floating const & fl = params_.documentClass().floats().getType(name);
902 if (!fl.floattype().empty()) {
903 if (fl.usesFloatPkg())
905 if (!fl.required().empty()) {
906 vector<string> reqs = getVectorFromString(fl.required());
907 for (auto const & req : reqs)
914 void LaTeXFeatures::useLanguage(Language const * lang)
916 if (!lang->babel().empty() || !lang->polyglossia().empty())
917 UsedLanguages_.insert(lang);
918 if (!lang->required().empty())
919 require(lang->required());
920 // currently only supported for Babel
921 if (!lang->provides().empty() && useBabel())
922 provide(lang->provides());
923 // CJK languages do not have a babel name.
924 // They use the CJK package
925 if (lang->encoding()->package() == Encoding::CJK)
927 // japanese babel language is special (tied to the pLaTeX engine).
928 if (lang->encoding()->package() == Encoding::japanese)
933 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
935 IncludedFiles_[key] = name;
939 bool LaTeXFeatures::hasLanguages() const
941 return !UsedLanguages_.empty();
945 bool LaTeXFeatures::hasOnlyPolyglossiaLanguages() const
947 // first the main language
948 if (params_.language->polyglossia().empty())
950 // now the secondary languages
951 for (auto const & lang : UsedLanguages_)
953 if (lang->polyglossia().empty())
960 bool LaTeXFeatures::hasPolyglossiaExclusiveLanguages() const
962 // first the main language
963 if (params_.language->isPolyglossiaExclusive())
965 // now the secondary languages
966 for (auto const & lang : UsedLanguages_)
968 if (lang->isPolyglossiaExclusive())
975 vector<string> LaTeXFeatures::getPolyglossiaExclusiveLanguages() const
977 vector<string> result;
978 // first the main language
979 if (params_.language->isPolyglossiaExclusive())
980 result.push_back(params_.language->display());
981 // now the secondary languages
982 for (auto const & lang : UsedLanguages_)
984 if (lang->isPolyglossiaExclusive())
985 result.push_back(lang->display());
991 vector<string> LaTeXFeatures::getBabelExclusiveLanguages() const
993 vector<string> result;
994 // first the main language
995 if (params_.language->isBabelExclusive())
996 result.push_back(params_.language->display());
997 // now the secondary languages
998 for (auto const & lang : UsedLanguages_)
1000 if (lang->isBabelExclusive())
1001 result.push_back(lang->display());
1007 string LaTeXFeatures::getBabelLanguages() const
1009 vector<string> blangs;
1010 for (auto const & lang : UsedLanguages_) {
1011 if (!lang->babel().empty())
1012 blangs.push_back(lang->babel());
1015 // Sort alphabetically to assure consistent order
1016 // (the order itself does not matter apart from
1017 // some exceptions, e.g. hebrew must come after
1018 // arabic and farsi)
1019 sort(blangs.begin(), blangs.end());
1021 return getStringFromVector(blangs);
1025 set<string> LaTeXFeatures::getPolyglossiaLanguages() const
1029 for (auto const & lang : UsedLanguages_)
1030 // We do not need the variants here
1031 langs.insert(lang->polyglossia());
1036 string LaTeXFeatures::getActiveChars() const
1039 // first the main language
1040 res += params_.language->activeChars();
1041 // now the secondary languages
1042 for (auto const & lang : UsedLanguages_)
1043 res += (lang->activeChars());
1048 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
1050 // This does only find encodings of languages supported by babel, but
1051 // that does not matter since we don't have a language with an
1052 // encoding supported by inputenc but without babel support.
1054 for (auto const & lang : UsedLanguages_)
1055 if (lang->encoding()->latexName() != doc_encoding &&
1056 lang->encoding()->package() == Encoding::inputenc)
1057 encs.insert(lang->encoding()->latexName());
1062 void LaTeXFeatures::getFontEncodings(vector<string> & encs, bool const onlylangs) const
1065 // these must be loaded if glyphs of this script are used
1066 // unless a language providing them is used in the document
1067 if (mustProvide("textgreek")
1068 && find(encs.begin(), encs.end(), "LGR") == encs.end())
1069 encs.insert(encs.begin(), "LGR");
1070 if ((mustProvide("textcyrillic") || mustProvide("textschwa"))
1071 && find(encs.begin(), encs.end(), "T2A") == encs.end())
1072 encs.insert(encs.begin(), "T2A");
1075 for (auto const & lang : UsedLanguages_)
1077 vector<string> extraencs =
1078 getVectorFromString(lang->fontenc(buffer().masterParams()));
1079 for (auto const & extra : extraencs) {
1080 if (extra != "none" && find(encs.begin(), encs.end(), extra) == encs.end())
1081 encs.insert(encs.begin(), extra);
1087 bool LaTeXFeatures::hasRTLLanguage() const
1089 if (params_.language->rightToLeft())
1091 for (auto const & lang : UsedLanguages_)
1092 if (lang->rightToLeft())
1100 char const * simplefeatures[] = {
1101 // note that the package order here will be the same in the LaTeX-output
1108 // subfig is handled in BufferParams.cpp
1112 /*For a successful cooperation of the `wrapfig' package with the
1113 `float' package you should load the `wrapfig' package *after*
1114 the `float' package. See the caption package documentation
1142 // listings is handled in BufferParams.cpp
1175 char const * bibliofeatures[] = {
1176 // Known bibliography packages (will be loaded before natbib)
1195 string const LaTeXFeatures::getColorOptions() const
1197 ostringstream colors;
1199 // Handling the color packages separately is needed to be able to load them
1200 // before babel when hyperref is loaded with the colorlinks option
1201 // for more info see Bufferparams.cpp
1204 if (mustProvide("color") || mustProvide("xcolor")) {
1205 string const package =
1206 (mustProvide("xcolor") ? "xcolor" : "color");
1207 if (params_.graphics_driver == "default"
1208 || params_.graphics_driver == "none")
1209 colors << "\\usepackage{" << package << "}\n";
1211 colors << "\\usepackage["
1212 << params_.graphics_driver
1213 << "]{" << package << "}\n";
1216 // pdfcolmk must be loaded after color
1217 if (mustProvide("pdfcolmk"))
1218 colors << "\\usepackage{pdfcolmk}\n";
1220 // the following 3 color commands must be set after color
1221 // is loaded and before pdfpages, therefore add the command
1222 // here define the set color
1223 if (mustProvide("pagecolor")) {
1224 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
1225 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
1226 // set the page color
1227 colors << "\\pagecolor{page_backgroundcolor}\n";
1230 if (mustProvide("fontcolor")) {
1231 colors << "\\definecolor{document_fontcolor}{rgb}{";
1232 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
1234 colors << "\\color{document_fontcolor}\n";
1237 if (mustProvide("lyxgreyedout")) {
1238 colors << "\\definecolor{note_fontcolor}{rgb}{";
1239 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
1240 // the color will be set together with the definition of
1241 // the lyxgreyedout environment (see lyxgreyedout_def)
1244 // color for shaded boxes
1245 if (isRequired("framed") && mustProvide("color")) {
1246 colors << "\\definecolor{shadecolor}{rgb}{";
1247 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
1248 // this color is automatically used by the LaTeX-package "framed"
1251 return colors.str();
1255 string const LaTeXFeatures::getPackageOptions() const
1257 ostringstream packageopts;
1258 // Output all the package option stuff we have been asked to do.
1259 for (auto const & p : params_.documentClass().packageOptions())
1260 if (mustProvide(p.first))
1261 packageopts << "\\PassOptionsToPackage{" << p.second << "}"
1262 << "{" << p.first << "}\n";
1263 return packageopts.str();
1267 string const LaTeXFeatures::getPackages() const
1269 ostringstream packages;
1271 // FIXME: currently, we can only load packages and macros known
1273 // However, with the Require tag of layouts/custom insets,
1274 // also unknown packages can be requested. They are silently
1275 // swallowed now. We should change this eventually.
1277 // These are all the 'simple' includes. i.e
1278 // packages which we just \usepackage{package}
1279 for (char const * feature : simplefeatures) {
1280 if (mustProvide(feature))
1281 packages << "\\usepackage{" << feature << "}\n";
1284 // The rest of these packages are somewhat more complicated
1285 // than those above.
1287 if (mustProvide("changebar")) {
1288 packages << "\\usepackage";
1289 if (runparams_.flavor == Flavor::LaTeX
1290 || runparams_.flavor == Flavor::DviLuaTeX)
1291 packages << "[dvips]";
1292 packages << "{changebar}\n";
1295 if (mustProvide("footnote")) {
1296 if (isRequired("hyperref"))
1297 packages << "\\usepackage{footnotehyper}\n";
1299 packages << "\\usepackage{footnote}\n";
1302 // [pdf]lscape is used to rotate longtables
1303 if (mustProvide("lscape")) {
1304 if (runparams_.flavor == Flavor::LaTeX
1305 || runparams_.flavor == Flavor::DviLuaTeX)
1306 packages << "\\usepackage{lscape}\n";
1308 packages << "\\usepackage{pdflscape}\n";
1311 // The tipa package and its extensions (tipx, tone) must not
1312 // be loaded with non-TeX fonts, since fontspec includes the
1313 // respective macros
1314 if (mustProvide("tipa") && !params_.useNonTeXFonts)
1315 packages << "\\usepackage{tipa}\n";
1316 if (mustProvide("tipx") && !params_.useNonTeXFonts)
1317 packages << "\\usepackage{tipx}\n";
1318 if (mustProvide("extraipa") && !params_.useNonTeXFonts)
1319 packages << "\\usepackage{extraipa}\n";
1320 if (mustProvide("tone") && !params_.useNonTeXFonts)
1321 packages << "\\usepackage{tone}\n";
1323 // if fontspec or newtxmath is used, AMS packages have to be loaded
1324 // before fontspec (in BufferParams)
1325 string const amsPackages = loadAMSPackages();
1326 bool const ot1 = (runparams().main_fontenc == "default"
1327 || runparams().main_fontenc == "OT1");
1328 bool const use_newtxmath =
1329 theLaTeXFonts().getLaTeXFont(from_ascii(params_.fontsMath())).getUsedPackage(
1330 ot1, false, false) == "newtxmath";
1332 if (!params_.useNonTeXFonts && !use_newtxmath && !amsPackages.empty())
1333 packages << amsPackages;
1335 if (mustProvide("cancel") &&
1336 params_.use_package("cancel") != BufferParams::package_off)
1337 packages << "\\usepackage{cancel}\n";
1339 // marvosym and bbding both define the \Cross macro
1340 if (mustProvide("marvosym")) {
1341 if (mustProvide("bbding"))
1342 packages << "\\let\\Cross\\relax\n";
1343 packages << "\\usepackage{marvosym}\n";
1346 // accents must be loaded after amsmath
1347 if (mustProvide("accents") &&
1348 params_.use_package("accents") != BufferParams::package_off)
1349 packages << "\\usepackage{accents}\n";
1351 // mathdots must be loaded after amsmath
1352 if (mustProvide("mathdots") &&
1353 params_.use_package("mathdots") != BufferParams::package_off)
1354 packages << "\\usepackage{mathdots}\n";
1356 // yhmath must be loaded after amsmath
1357 if (mustProvide("yhmath") &&
1358 params_.use_package("yhmath") != BufferParams::package_off)
1359 packages << "\\usepackage{yhmath}\n";
1361 // stmaryrd must be loaded after amsmath
1362 if (mustProvide("stmaryrd") &&
1363 params_.use_package("stmaryrd") != BufferParams::package_off)
1364 packages << "\\usepackage{stmaryrd}\n";
1366 if (mustProvide("stackrel") &&
1367 params_.use_package("stackrel") != BufferParams::package_off)
1368 packages << "\\usepackage{stackrel}\n";
1370 if (mustProvide("undertilde") &&
1371 params_.use_package("undertilde") != BufferParams::package_off)
1372 packages << "\\usepackage{undertilde}\n";
1374 // [x]color and pdfcolmk are handled in getColorOptions() above
1377 if (isRequired("makeidx") || isRequired("splitidx")) {
1378 if (!isProvided("makeidx") && !isRequired("splitidx"))
1379 packages << "\\usepackage{makeidx}\n";
1380 if (mustProvide("splitidx"))
1381 packages << "\\usepackage{splitidx}\n";
1382 packages << "\\makeindex\n";
1386 if (mustProvide("graphicx") && params_.graphics_driver != "none") {
1387 if (params_.graphics_driver == "default")
1388 packages << "\\usepackage{graphicx}\n";
1390 packages << "\\usepackage["
1391 << params_.graphics_driver
1395 // These must be loaded after graphicx, since they try
1396 // to load graphicx without options
1397 if (mustProvide("rotating"))
1398 packages << "\\usepackage{rotating}\n";
1399 if (mustProvide("rotfloat"))
1400 packages << "\\usepackage{rotfloat}\n";
1401 // and this must be loaded after rotating
1402 if (mustProvide("tablefootnote"))
1403 packages << "\\usepackage{tablefootnote}\n";
1405 // lyxskak.sty --- newer chess support based on skak.sty
1406 if (mustProvide("chess"))
1407 packages << "\\usepackage[ps,mover]{lyxskak}\n";
1410 if (mustProvide("setspace") && !isProvided("SetSpace"))
1411 packages << "\\usepackage{setspace}\n";
1413 // we need to assure that mhchem is loaded before esint and every other
1414 // package that redefines command of amsmath because mhchem loads amlatex
1415 // (this info is from the author of mhchem from June 2013)
1416 if (mustProvide("mhchem") &&
1417 params_.use_package("mhchem") != BufferParams::package_off)
1418 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
1419 "\\usepackage{mhchem}\n";
1421 // wasysym is a simple feature, but it must be after amsmath if both
1423 // wasysym redefines some integrals (e.g. iint) from amsmath. That
1424 // leads to inconsistent integrals. We only load this package if
1425 // the document does not contain integrals (then isRequired("esint")
1426 // is false) or if esint is used, since esint redefines all relevant
1427 // integral symbols from wasysym and amsmath.
1428 // See http://www.lyx.org/trac/ticket/1942
1429 if (mustProvide("wasysym") &&
1430 params_.use_package("wasysym") != BufferParams::package_off &&
1431 (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
1432 packages << "\\usepackage{wasysym}\n";
1434 // esint must be after amsmath (and packages requiring amsmath, like mhchem)
1435 // and wasysym, since it will redeclare inconsistent integral symbols
1436 if (mustProvide("esint") &&
1437 params_.use_package("esint") != BufferParams::package_off)
1438 packages << "\\usepackage{esint}\n";
1440 // Known bibliography packages (simple \usepackage{package})
1441 for (char const * feature : bibliofeatures) {
1442 if (mustProvide(feature))
1443 packages << "\\usepackage{" << feature << "}\n";
1446 // Compatibility between achicago and natbib
1447 if (mustProvide("achicago") && mustProvide("natbib"))
1448 packages << "\\let\\achicagobib\\thebibliography\n";
1451 // Some classes load natbib themselves, but still allow (or even require)
1452 // plain numeric citations (ReVTeX is such a case, see bug 5182).
1453 // This special case is indicated by the "natbib-internal" key.
1454 if (mustProvide("natbib")
1455 && !isProvided("natbib-internal")
1456 && !isProvided("biblatex")
1457 && !isProvided("biblatex-natbib")
1458 && !isProvided("jurabib")) {
1459 packages << "\\usepackage[";
1460 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
1461 packages << "numbers";
1463 packages << "authoryear";
1464 if (!params_.biblio_opts.empty())
1465 packages << ',' << params_.biblio_opts;
1466 packages << "]{natbib}\n";
1469 // Compatibility between achicago and natbib
1470 if (mustProvide("achicago") && mustProvide("natbib")) {
1471 packages << "\\let\\thebibliography\\achicagobib\n";
1472 packages << "\\let\\SCcite\\astroncite\n";
1473 packages << "\\let\\UnexpandableProtect\\protect\n";
1476 // jurabib -- we need version 0.6 at least.
1477 if (mustProvide("jurabib")
1478 && !isProvided("natbib-internal")
1479 && !isProvided("natbib")
1480 && !isProvided("biblatex")
1481 && !isProvided("biblatex-natbib")) {
1482 packages << "\\usepackage";
1483 if (!params_.biblio_opts.empty())
1484 packages << '[' << params_.biblio_opts << ']';
1485 packages << "{jurabib}[2004/01/25]\n";
1488 // opcit -- we pass custombst as we output \bibliographystyle ourselves
1489 if (mustProvide("opcit")) {
1490 if (isRequired("hyperref"))
1491 packages << "\\usepackage[custombst,hyperref]{opcit}\n";
1493 packages << "\\usepackage[custombst]{opcit}\n";
1496 // xargs -- we need version 1.09 at least
1497 if (mustProvide("xargs"))
1498 packages << "\\usepackage{xargs}[2008/03/08]\n";
1500 if (mustProvide("xy"))
1501 packages << "\\usepackage[all]{xy}\n";
1503 if (mustProvide("feyn"))
1504 packages << "\\usepackage{feyn}\n"; //Diagram
1506 if (mustProvide("ulem"))
1507 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
1508 "\\usepackage{ulem}\n";
1510 if (mustProvide("nomencl")) {
1511 // Make it work with the new and old version of the package,
1512 // but don't use the compatibility option since it is
1513 // incompatible to other packages.
1514 packages << "\\usepackage{nomencl}\n"
1515 "% the following is useful when we have the old nomencl.sty package\n"
1516 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
1517 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
1518 "\\makenomenclature\n";
1521 // fixltx2e provides subscript
1522 if (mustProvide("subscript") && !isRequired("fixltx2e")
1523 && !isAvailableAtLeastFrom("LaTeX", 2005, 12))
1524 packages << "\\usepackage{subscript}\n";
1526 // footmisc must be loaded after setspace
1527 // Set options here, load the package after the user preamble to
1528 // avoid problems with manual loaded footmisc.
1529 if (mustProvide("footmisc"))
1530 packages << "\\PassOptionsToPackage{stable}{footmisc}\n";
1532 if (mustProvide("microtype")){
1533 packages << "\\usepackage{microtype}\n";
1536 return packages.str();
1540 TexString LaTeXFeatures::getMacros() const
1542 otexstringstream macros;
1544 if (!preamble_snippets_.empty()) {
1546 macros << getPreambleSnippets();
1549 if (mustProvide("xetexdashbreakstate"))
1550 macros << "\\XeTeXdashbreakstate 0" << '\n';
1552 if (mustProvide("papersize")) {
1553 if (runparams_.flavor == Flavor::LaTeX
1554 || runparams_.flavor == Flavor::DviLuaTeX)
1555 macros << papersizedvi_def << '\n';
1556 else if (runparams_.flavor == Flavor::LuaTeX)
1557 macros << papersizepdflua_def << '\n';
1559 macros << papersizepdf_def << '\n';
1562 if (mustProvide("LyX")) {
1563 macros << "\\providecommand{\\LyX}";
1564 // open conditional wrappers
1565 if (runparams_.use_polyglossia && hasRTLLanguage())
1566 macros << "{\\@ensure@LTR";
1567 if (isRequired("hyperref"))
1568 macros << "{\\texorpdfstring";
1570 macros << "{\\ensureascii";
1573 // close conditional wrappers
1576 if (isRequired("hyperref"))
1578 if (runparams_.use_polyglossia && hasRTLLanguage())
1583 if (mustProvide("noun"))
1584 macros << noun_def << '\n';
1586 if (mustProvide("lyxarrow"))
1587 macros << lyxarrow_def << '\n';
1589 if (mustProvide("aastex_case"))
1590 macros << aastex_case_def << '\n';
1592 if (mustProvide("lyxzerowidthspace"))
1593 macros << lyxZWSP_def << '\n';
1595 if (!usePolyglossia() && mustProvide("textgreek")) {
1596 // ensure LGR font encoding is defined also if fontenc is not loaded by LyX
1597 if (runparams().main_fontenc == "default")
1598 macros << textgreek_LGR_def;
1599 macros << textgreek_def << '\n';
1602 if (!usePolyglossia() && mustProvide("textcyrillic")) {
1603 // ensure T2A font encoding is set up also if fontenc is not loaded by LyX
1604 if (runparams().main_fontenc == "default")
1605 macros << textcyr_T2A_def;
1606 macros << textcyr_def << '\n';
1609 // non-standard text accents:
1610 if (mustProvide("textcommaabove") || mustProvide("textcommaaboveright") ||
1611 mustProvide("textcommabelow") || mustProvide("textbaltic"))
1612 macros << lyxaccent_def;
1614 if (mustProvide("textcommabelow") || mustProvide("textbaltic"))
1615 macros << textcommabelow_def << '\n';
1617 if (mustProvide("textcommaabove") || mustProvide("textbaltic"))
1618 macros << textcommaabove_def << '\n';
1620 if (mustProvide("textcommaaboveright"))
1621 macros << textcommaaboveright_def << '\n';
1623 if (mustProvide("textbaltic"))
1624 macros << textbaltic_def << '\n';
1626 if (mustProvide("textschwa"))
1627 macros << textschwa_def << '\n';
1629 // split-level fractions
1630 if (mustProvide("xfrac") || mustProvide("smallLetterFrac"))
1631 macros << xfrac_def << '\n';
1633 if (mustProvide("smallLetterFrac"))
1634 macros << smallLetterFrac_def << '\n';
1636 if (mustProvide("lyxmathsym"))
1637 macros << lyxmathsym_def << '\n';
1639 if (mustProvide("cedilla"))
1640 macros << cedilla_def << '\n';
1642 if (mustProvide("subring"))
1643 macros << subring_def << '\n';
1645 if (mustProvide("subdot"))
1646 macros << subdot_def << '\n';
1648 if (mustProvide("subhat"))
1649 macros << subhat_def << '\n';
1651 if (mustProvide("subtilde"))
1652 macros << subtilde_def << '\n';
1654 if (mustProvide("dacute"))
1655 macros << dacute_def << '\n';
1657 if (mustProvide("tipasymb"))
1658 macros << tipasymb_def << '\n';
1660 if (mustProvide("dgrave"))
1661 macros << dgrave_def << '\n';
1663 if (mustProvide("rcap"))
1664 macros << rcap_def << '\n';
1666 if (mustProvide("ogonek"))
1667 macros << ogonek_def << '\n';
1670 if (mustProvide("quotesinglbase"))
1671 macros << quotesinglbase_def << '\n';
1672 if (mustProvide("quotedblbase"))
1673 macros << quotedblbase_def << '\n';
1674 if (mustProvide("guilsinglleft"))
1675 macros << guilsinglleft_def << '\n';
1676 if (mustProvide("guilsinglright"))
1677 macros << guilsinglright_def << '\n';
1678 if (mustProvide("guillemotleft"))
1679 macros << guillemotleft_def << '\n';
1680 if (mustProvide("guillemotright"))
1681 macros << guillemotright_def << '\n';
1682 if (mustProvide("textquotedbl"))
1683 macros << textquotedbl_def << '\n';
1684 if (mustProvide("textquotesinglep")) {
1685 if (runparams_.flavor == Flavor::XeTeX)
1686 macros << textquotesinglep_xetex_def << '\n';
1688 macros << textquotesinglep_luatex_def << '\n';
1690 if (mustProvide("textquotedblp")) {
1691 if (runparams_.flavor == Flavor::XeTeX)
1692 macros << textquotedblp_xetex_def << '\n';
1694 macros << textquotedblp_luatex_def << '\n';
1698 if (mustProvide("binom") && !isRequired("amsmath"))
1699 macros << binom_def << '\n';
1700 if (mustProvide("mathcircumflex"))
1701 macros << mathcircumflex_def << '\n';
1704 if (mustProvide("ParagraphLeftIndent"))
1705 macros << paragraphleftindent_def;
1706 if (mustProvide("NeedLyXFootnoteCode"))
1707 macros << floatingfootnote_def;
1709 // some problems with tex->html converters
1710 if (mustProvide("NeedTabularnewline"))
1711 macros << tabularnewline_def;
1713 if (mustProvide("cellvarwidth"))
1714 macros << cellvarwidth_def;
1716 // greyed-out environment (note inset)
1717 // the color is specified in the routine
1718 // getColorOptions() to avoid LaTeX-package clashes
1719 if (mustProvide("lyxgreyedout"))
1720 // We need different version for RTL (#8647), with change tracking (#12025)
1721 // and for some specific engine/language package combinations
1722 macros << lyxgreyedoutDef(hasRTLLanguage(), mustProvide("ct-xcolor-ulem"),
1723 (runparams_.flavor == Flavor::LuaTeX), useBabel());
1725 if (mustProvide("lyxdot"))
1726 macros << lyxdot_def << '\n';
1729 getFloatDefinitions(macros);
1731 if (mustProvide("refstyle"))
1732 macros << lyxref_def << '\n';
1735 if (mustProvide("ct-xcolor-ulem")) {
1736 streamsize const prec = macros.os().precision(2);
1738 RGBColor cadd = rgbFromHexName(lcolor.getX11HexName(Color_addedtext_output));
1739 macros << "\\providecolor{lyxadded}{rgb}{"
1740 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1742 RGBColor cdel = rgbFromHexName(lcolor.getX11HexName(Color_deletedtext_output));
1743 macros << "\\providecolor{lyxdeleted}{rgb}{"
1744 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1746 macros.os().precision(prec);
1748 macros << changetracking_xcolor_ulem_base_def;
1750 if (isRequired("changebar")) {
1751 if (isRequired("hyperref"))
1752 macros << changetracking_xcolor_ulem_hyperref_cb_def;
1754 macros << changetracking_xcolor_ulem_cb_def;
1756 if (isRequired("hyperref"))
1757 macros << changetracking_xcolor_ulem_hyperref_def;
1759 macros << changetracking_xcolor_ulem_def;
1763 if (mustProvide("ct-tikz-object-sout")) {
1764 if (!mustProvide("ct-xcolor-ulem")) {
1765 streamsize const prec = macros.os().precision(2);
1767 RGBColor cadd = rgbFromHexName(lcolor.getX11HexName(Color_addedtext_output));
1768 macros << "\\providecolor{lyxadded}{rgb}{"
1769 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1771 RGBColor cdel = rgbFromHexName(lcolor.getX11HexName(Color_deletedtext_output));
1772 macros << "\\providecolor{lyxdeleted}{rgb}{"
1773 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1775 macros.os().precision(prec);
1778 macros << changetracking_tikz_object_sout_def;
1780 if (isRequired("changebar")) {
1781 if (isRequired("hyperref"))
1782 macros << changetracking_xcolor_ulem_hyperref_cb_object_def;
1784 macros << changetracking_xcolor_ulem_cb_object_def;
1786 if (isRequired("hyperref"))
1787 macros << changetracking_xcolor_ulem_hyperref_object_def;
1789 macros << changetracking_xcolor_ulem_object_def;
1793 if (mustProvide("ct-none"))
1794 macros << changetracking_none_def;
1796 if (mustProvide("rtloutputdblcol"))
1797 macros << rtloutputdblcol_def;
1799 if (mustProvide("lyxmintcaption"))
1800 macros << lyxmintcaption_def;
1802 return macros.release();
1806 docstring const LaTeXFeatures::getBabelPresettings() const
1808 odocstringstream tmp;
1810 for (auto const & lang : UsedLanguages_)
1811 if (!lang->babel_presettings().empty())
1812 tmp << lang->babel_presettings() << '\n';
1813 if (!params_.language->babel_presettings().empty())
1814 tmp << params_.language->babel_presettings() << '\n';
1816 if (!contains(tmp.str(), '@'))
1819 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1823 docstring const LaTeXFeatures::getBabelPostsettings() const
1825 odocstringstream tmp;
1827 for (auto const & lang : UsedLanguages_)
1828 if (!lang->babel_postsettings().empty())
1829 tmp << lang->babel_postsettings() << '\n';
1830 if (!params_.language->babel_postsettings().empty())
1831 tmp << params_.language->babel_postsettings() << '\n';
1833 if (!contains(tmp.str(), '@'))
1836 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1840 string const LaTeXFeatures::loadAMSPackages() const
1844 if (mustProvide("amsmath")
1845 && params_.use_package("amsmath") != BufferParams::package_off) {
1846 tmp << "\\usepackage{amsmath}\n";
1848 // amsbsy and amstext are already provided by amsmath
1849 if (mustProvide("amsbsy"))
1850 tmp << "\\usepackage{amsbsy}\n";
1851 if (mustProvide("amstext"))
1852 tmp << "\\usepackage{amstext}\n";
1855 if (mustProvide("amsthm"))
1856 tmp << "\\usepackage{amsthm}\n";
1858 if (mustProvide("amssymb")
1859 && params_.use_package("amssymb") != BufferParams::package_off)
1860 tmp << "\\usepackage{amssymb}\n";
1866 docstring const LaTeXFeatures::getTClassPreamble() const
1868 // the text class specific preamble
1869 DocumentClass const & tclass = params_.documentClass();
1870 odocstringstream tcpreamble;
1872 tcpreamble << tclass.preamble();
1874 list<docstring>::const_iterator cit = usedLayouts_.begin();
1875 list<docstring>::const_iterator end = usedLayouts_.end();
1876 for (; cit != end; ++cit)
1877 // For InPreamble layouts, we output the preamble stuff earlier
1878 // (before the layouts). See Paragraph::Private::validate.
1879 if (!tclass[*cit].inpreamble)
1880 tcpreamble << tclass[*cit].preamble();
1882 cit = usedInsetLayouts_.begin();
1883 end = usedInsetLayouts_.end();
1884 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1885 for (; cit != end; ++cit) {
1886 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1887 if (it == ils.end())
1889 tcpreamble << it->second.preamble();
1892 return tcpreamble.str();
1896 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1898 DocumentClass const & tclass = params_.documentClass();
1899 odocstringstream tcpreamble;
1901 tcpreamble << tclass.htmlpreamble();
1903 list<docstring>::const_iterator cit = usedLayouts_.begin();
1904 list<docstring>::const_iterator end = usedLayouts_.end();
1905 for (; cit != end; ++cit)
1906 tcpreamble << tclass[*cit].htmlpreamble();
1908 cit = usedInsetLayouts_.begin();
1909 end = usedInsetLayouts_.end();
1910 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1911 for (; cit != end; ++cit) {
1912 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1913 if (it == ils.end())
1915 tcpreamble << it->second.htmlpreamble();
1918 return tcpreamble.str();
1922 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1924 DocumentClass const & tclass = params_.documentClass();
1925 odocstringstream tcpreamble;
1927 if (mustProvide("noun"))
1928 tcpreamble << lyxnoun_style;
1929 // this isn't exact, but it won't hurt that much if it
1931 if (mustProvide("ulem"))
1932 tcpreamble << lyxstrikeout_style;
1934 tcpreamble << tclass.htmlstyles();
1936 for (auto const & c : usedLayouts_)
1937 tcpreamble << tclass[c].htmlstyle();
1939 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1940 for (auto const & c : usedInsetLayouts_) {
1941 TextClass::InsetLayouts::const_iterator it = ils.find(c);
1942 if (it == ils.end())
1944 tcpreamble << it->second.htmlstyle();
1947 return tcpreamble.str();
1953 docstring const getFloatI18nPreamble(docstring const & type,
1954 docstring const & name, Language const * lang,
1955 Encoding const & enc, bool const polyglossia)
1957 // Check whether name can be encoded in the buffer encoding
1958 bool encodable = true;
1959 for (char_type c : name) {
1960 if (!enc.encodable(c)) {
1966 docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1967 : from_ascii(lang->babel());
1968 docstring const langenc = from_ascii(lang->encoding()->iconvName());
1969 docstring const texenc = from_ascii(lang->encoding()->latexName());
1970 docstring const bufenc = from_ascii(enc.iconvName());
1971 docstring const s1 = docstring(1, 0xF0000);
1972 docstring const s2 = docstring(1, 0xF0001);
1973 docstring const translated = encodable ? name
1974 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1975 + s1 + langenc + s2 + name + s1 + bufenc + s2;
1977 odocstringstream os;
1978 os << "\\addto\\captions" << language
1979 << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1984 docstring const i18npreamble(docstring const & templ, Language const * lang,
1985 Encoding const & enc, bool const polyglossia,
1986 bool const need_fixedwidth)
1991 string preamble = polyglossia ?
1992 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
1993 subst(to_utf8(templ), "$$lang", lang->babel());
1995 string const langenc = lang->encoding()->iconvName();
1996 string const texenc = lang->encoding()->latexName();
1997 string const bufenc = enc.iconvName();
1998 Encoding const * testenc(&enc);
1999 bool lang_fallback = false;
2000 bool ascii_fallback = false;
2001 if (need_fixedwidth && !enc.hasFixedWidth()) {
2002 if (lang->encoding()->hasFixedWidth()) {
2003 testenc = lang->encoding();
2004 lang_fallback = true;
2006 // We need a fixed width encoding, but both the buffer
2007 // encoding and the language encoding are variable
2008 // width. As a last fallback, try to convert to pure
2009 // ASCII using the LaTeX commands defined in unicodesymbols.
2010 testenc = encodings.fromLyXName("ascii");
2013 ascii_fallback = true;
2016 // First and second character of plane 15 (Private Use Area)
2017 string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
2018 string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
2020 // lyx::regex is not unicode-safe.
2021 // Should use QRegExp or (boost::u32regex, but that requires ICU)
2022 static regex const reg("_\\(([^\\)]+)\\)");
2024 while (regex_search(preamble, sub, reg)) {
2025 string const key = sub.str(1);
2026 docstring const name = lang->translateLayout(key);
2027 // Check whether name can be encoded in the buffer encoding
2028 bool encodable = true;
2029 for (size_t i = 0; i < name.size() && encodable; ++i)
2030 if (!testenc->encodable(name[i]))
2033 if (encodable && !lang_fallback)
2034 translated = to_utf8(name);
2035 else if (ascii_fallback)
2036 translated = to_ascii(testenc->latexString(name).first);
2038 translated = "\\inputencoding{" + texenc + "}"
2039 + s1 + langenc + s2 + to_utf8(name)
2041 preamble = subst(preamble, sub.str(), translated);
2043 return from_utf8(preamble);
2049 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel,
2050 bool use_polyglossia, bool use_minted) const
2052 DocumentClass const & tclass = params_.documentClass();
2053 // collect preamble snippets in a set to prevent multiple identical
2054 // commands (would happen if e.g. both theorem and theorem* are used)
2055 set<docstring> snippets;
2056 typedef LanguageList::const_iterator lang_it;
2057 lang_it const lbeg = UsedLanguages_.begin();
2058 lang_it const lend = UsedLanguages_.end();
2059 list<docstring>::const_iterator cit = usedLayouts_.begin();
2060 list<docstring>::const_iterator end = usedLayouts_.end();
2061 for (; cit != end; ++cit) {
2062 // language dependent commands (once per document)
2063 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
2064 buffer().language(),
2065 buffer().params().encoding(),
2066 use_polyglossia, false));
2067 // commands for language changing (for multilanguage documents)
2068 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
2069 snippets.insert(i18npreamble(
2070 tclass[*cit].babelpreamble(),
2071 buffer().language(),
2072 buffer().params().encoding(),
2073 use_polyglossia, false));
2074 for (lang_it lit = lbeg; lit != lend; ++lit)
2075 snippets.insert(i18npreamble(
2076 tclass[*cit].babelpreamble(),
2078 buffer().params().encoding(),
2079 use_polyglossia, false));
2082 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
2083 FloatList const & floats = params_.documentClass().floats();
2084 UsedFloats::const_iterator fit = usedFloats_.begin();
2085 UsedFloats::const_iterator fend = usedFloats_.end();
2086 for (; fit != fend; ++fit) {
2087 Floating const & fl = floats.getType(fit->first);
2088 // we assume builtin floats are translated
2089 if (fl.isPredefined())
2091 docstring const type = from_ascii(fl.floattype());
2092 docstring const flname = from_utf8(fl.name());
2093 docstring name = buffer().language()->translateLayout(fl.name());
2094 // only request translation if we have a real translation
2095 // (that differs from the source)
2097 snippets.insert(getFloatI18nPreamble(
2098 type, name, buffer().language(),
2099 buffer().params().encoding(),
2101 for (lang_it lit = lbeg; lit != lend; ++lit) {
2102 string const code = (*lit)->code();
2103 name = (*lit)->translateLayout(fl.name());
2104 // we assume we have a suitable translation if
2105 // either the language is English (we need to
2106 // translate into English if English is a secondary
2107 // language) or if translateIfPossible returns
2108 // something different to the English source.
2109 bool const have_translation =
2110 (flname != name || contains(code, "en"));
2111 if (have_translation)
2112 snippets.insert(getFloatI18nPreamble(
2114 buffer().params().encoding(),
2120 cit = usedInsetLayouts_.begin();
2121 end = usedInsetLayouts_.end();
2122 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
2123 for (; cit != end; ++cit) {
2124 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
2125 if (it == ils.end())
2127 // The listings package does not work with variable width
2128 // encodings, only with fixed width encodings. Therefore we
2129 // need to force a fixed width encoding for
2130 // \lstlistlistingname and \lstlistingname (bug 9382).
2131 // This needs to be consistent with InsetListings::latex()
2132 // rsp. InsetListings::forcedEncoding().
2133 bool const need_fixedwidth = !use_minted &&
2134 !runparams_.isFullUnicode() &&
2135 buffer().params().encoding().package() != Encoding::japanese &&
2136 it->second.fixedwidthpreambleencoding();
2137 // language dependent commands (once per document)
2138 snippets.insert(i18npreamble(it->second.langpreamble(),
2139 buffer().language(),
2140 buffer().params().encoding(),
2141 use_polyglossia, need_fixedwidth));
2142 // commands for language changing (for multilanguage documents)
2143 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
2144 snippets.insert(i18npreamble(
2145 it->second.babelpreamble(),
2146 buffer().language(),
2147 buffer().params().encoding(),
2148 use_polyglossia, need_fixedwidth));
2149 for (lang_it lit = lbeg; lit != lend; ++lit)
2150 snippets.insert(i18npreamble(
2151 it->second.babelpreamble(),
2153 buffer().params().encoding(),
2154 use_polyglossia, need_fixedwidth));
2158 odocstringstream tcpreamble;
2159 set<docstring>::const_iterator const send = snippets.end();
2160 set<docstring>::const_iterator it = snippets.begin();
2161 for (; it != send; ++it)
2163 return tcpreamble.str();
2167 void LaTeXFeatures::showStruct() const
2169 lyxerr << "LyX needs the following commands when LaTeXing:"
2170 << "\n***** Packages:" << getPackages()
2171 << "\n***** Macros:" << to_utf8(getMacros().str)
2172 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
2173 << "\n***** done." << endl;
2177 Buffer const & LaTeXFeatures::buffer() const
2183 void LaTeXFeatures::setBuffer(Buffer const & buffer)
2189 BufferParams const & LaTeXFeatures::bufferParams() const
2195 void LaTeXFeatures::getFloatDefinitions(otexstream & os) const
2197 FloatList const & floats = params_.documentClass().floats();
2199 // Here we will output the code to create the needed float styles.
2200 // We will try to do this as minimal as possible.
2201 // \floatstyle{ruled}
2202 // \newfloat{algorithm}{htbp}{loa}
2203 // \providecommand{\algorithmname}{Algorithm}
2204 // \floatname{algorithm}{\protect\algorithmname}
2205 for (auto const & cit : usedFloats_) {
2206 Floating const & fl = floats.getType(cit.first);
2208 // For builtin floats we do nothing.
2209 if (fl.isPredefined())
2212 // We have to special case "table" and "figure"
2213 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
2214 // Output code to modify "table" or "figure"
2215 // but only if builtin == false
2216 // and that have to be true at this point in the
2218 docstring const type = from_ascii(fl.floattype());
2219 docstring const placement = from_ascii(fl.placement());
2220 docstring const style = from_ascii(fl.style());
2221 if (!style.empty()) {
2222 os << "\\floatstyle{" << style << "}\n"
2223 << "\\restylefloat{" << type << "}\n";
2225 if (!placement.empty()) {
2226 os << "\\floatplacement{" << type << "}{"
2227 << placement << "}\n";
2230 // The other non builtin floats.
2232 docstring const type = from_ascii(fl.floattype());
2233 docstring const placement = from_ascii(fl.placement());
2234 docstring const ext = from_ascii(fl.ext());
2235 docstring const within = from_ascii(fl.within());
2236 docstring const style = from_ascii(fl.style());
2237 docstring const name =
2238 buffer().language()->translateLayout(fl.name());
2239 os << "\\floatstyle{" << style << "}\n"
2240 << "\\newfloat{" << type << "}{" << placement
2241 << "}{" << ext << '}';
2242 if (!within.empty())
2243 os << '[' << within << ']';
2245 << "\\providecommand{\\" << type << "name}{"
2247 << "\\floatname{" << type << "}{\\protect\\"
2248 << type << "name}\n";
2250 // What missing here is to code to minimalize the code
2251 // output so that the same floatstyle will not be
2252 // used several times, when the same style is still in
2256 // The subfig package is loaded later
2257 os << "\n\\AtBeginDocument{\\newsubfloat{" << from_ascii(fl.floattype()) << "}}\n";
2262 void LaTeXFeatures::resolveAlternatives()
2264 for (Features::iterator it = features_.begin(); it != features_.end();) {
2265 if (contains(*it, '|')) {
2266 vector<string> const alternatives = getVectorFromString(*it, "|");
2267 vector<string>::const_iterator const end = alternatives.end();
2268 vector<string>::const_iterator ita = alternatives.begin();
2269 // Is any alternative already required? => use that
2270 for (; ita != end; ++ita) {
2271 if (isRequired(*ita))
2274 // Is any alternative available? => use the first one
2277 for (ita = alternatives.begin(); ita != end; ++ita) {
2278 if (isAvailable(*ita)) {
2284 // This will not work, but not requiring something
2285 // would be more confusing
2287 require(alternatives.front());
2288 features_.erase(it);
2289 it = features_.begin();
2296 void LaTeXFeatures::expandMultiples()
2298 for (Features::iterator it = features_.begin(); it != features_.end();) {
2299 if (contains(*it, ',')) {
2300 // Do nothing if any multiple is already required
2301 for (string const & pkg : getVectorFromString(*it, ",")) {
2302 if (!isRequired(pkg))
2305 features_.erase(it);
2306 it = features_.begin();