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"
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/FileName.h"
41 #include "support/filetools.h"
42 #include "support/gettext.h"
43 #include "support/lstrings.h"
44 #include "support/regex.h"
50 using namespace lyx::support;
55 /////////////////////////////////////////////////////////////////////
59 /////////////////////////////////////////////////////////////////////
61 //\NeedsTeXFormat{LaTeX2e}
62 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
63 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
65 static docstring const lyx_def = from_ascii(
66 "{%\n L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}");
68 static docstring const noun_def = from_ascii(
69 "\\newcommand{\\noun}[1]{\\textsc{#1}}");
71 static docstring const lyxarrow_def = from_ascii(
72 "\\DeclareRobustCommand*{\\lyxarrow}{%\n"
74 "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
75 "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}");
77 // ZERO WIDTH SPACE (ZWSP) is actually not a space character
78 // but marks a line break opportunity. Several commands provide a
79 // line break opportunity. They differ in side-effects:
80 // \allowbreak prevents hyphenation after hyphen or dash + ZWSP
81 // \linebreak[<n>] takes an optional argument denoting "urgency".
82 // The \LyXZeroWidthSpace wrapper allows customization in the preamble.
83 static docstring const lyxZWSP_def = from_ascii(
84 "\\newcommand*\\LyXZeroWidthSpace{\\hspace{0pt}}");
86 // for quotes without babel. This does not give perfect results, but
87 // anybody serious about non-english quotes should use babel (JMarc).
89 static docstring const quotedblbase_def = from_ascii(
90 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
91 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
92 " \\penalty10000\\hskip0em\\relax%\n"
95 static docstring const quotesinglbase_def = from_ascii(
96 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
97 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
98 " \\penalty10000\\hskip0em\\relax%\n"
101 static docstring const guillemotleft_def = from_ascii(
102 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
103 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
104 "\\penalty10000\\hskip0pt\\relax%\n"
107 static docstring const guillemotright_def = from_ascii(
108 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
109 " \\penalty10000\\hskip0pt%\n"
110 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
113 static docstring const guilsinglleft_def = from_ascii(
114 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
115 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
116 " \\penalty10000\\hskip0pt\\relax%\n"
119 static docstring const guilsinglright_def = from_ascii(
120 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
121 " \\penalty10000\\hskip0pt%\n"
122 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
125 static docstring const textquotedbl_def = from_ascii(
126 "\\DeclareTextSymbolDefault{\\textquotedbl}{T1}");
128 static docstring const textquotedblp_xetex_def = from_ascii(
129 "\\providecommand\\textquotedblplain{%\n"
130 " \\bgroup\\addfontfeatures{Mapping=}\\char34\\egroup}");
132 static docstring const textquotedblp_luatex_def = from_ascii(
133 "\\providecommand\\textquotedblplain{%\n"
134 " \\bgroup\\addfontfeatures{RawFeature=-tlig}\\char34\\egroup}");
136 static docstring const textquotesinglep_xetex_def = from_ascii(
137 "\\providecommand\\textquotesingleplain{%\n"
138 " \\bgroup\\addfontfeatures{Mapping=}\\char39\\egroup}");
140 static docstring const textquotesinglep_luatex_def = from_ascii(
141 "\\providecommand\\textquotesingleplain{%\n"
142 " \\bgroup\\addfontfeatures{RawFeature=-tlig}\\char39\\egroup}");
144 static docstring const paragraphleftindent_def = from_ascii(
145 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
147 " \\begin{list}{}{%\n"
148 " \\setlength{\\topsep}{0pt}%\n"
149 " \\addtolength{\\leftmargin}{#1}\n"
150 // ho hum, yet more things commented out with no hint as to why they
151 // weren't just removed
152 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
153 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
154 // "%% \\setlength\\listparindent\\parindent%\n"
155 // "%% \\setlength\\itemindent\\parindent%\n"
156 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
162 static docstring const floatingfootnote_def = from_ascii(
163 "%% Special footnote code from the package 'stblftnt.sty'\n"
164 "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
165 "\\let\\SF@@footnote\\footnote\n"
166 "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
167 " \\expandafter\\SF@@footnote\n"
169 " \\expandafter\\SF@gobble@opt\n"
172 "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
173 " \\SF@gobble@twobracket\n"
176 "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
177 " \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
178 "\\def\\SF@gobble@twobracket[#1]#2{}\n");
180 static docstring const binom_def = from_ascii(
181 "%% Binom macro for standard LaTeX users\n"
182 "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n");
184 static docstring const mathcircumflex_def = from_ascii(
185 "%% For printing a cirumflex inside a formula\n"
186 "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n");
188 static docstring const tabularnewline_def = from_ascii(
189 "%% Because html converters don't know tabularnewline\n"
190 "\\providecommand{\\tabularnewline}{\\\\}\n");
192 static docstring const lyxgreyedout_def = from_ascii(
193 "%% The greyedout annotation environment\n"
194 "\\newenvironment{lyxgreyedout}\n"
195 " {\\textcolor{note_fontcolor}\\bgroup\\ignorespaces}\n"
196 " {\\ignorespacesafterend\\egroup}\n");
198 static docstring const lyxgreyedout_rtl_def = from_ascii(
199 "%% The greyedout annotation environment (with RTL support)\n"
200 "\\NewEnviron{lyxgreyedout}{%\n"
202 "\\everypar{\\textcolor{note_fontcolor}\\beginL\\ignorespaces}%\n"
203 "\\BODY\\everypar{\\ignorespacesafterend\\endL}\n"
205 "\\textcolor{note_fontcolor}\\bgroup\\ignorespaces%\n"
206 "\\BODY\\ignorespacesafterend\\egroup\n"
209 static docstring const lyxgreyedout_luartl_def = from_ascii(
210 "%% The greyedout annotation environment (with RTL support)\n"
211 "\\NewEnviron{lyxgreyedout}{%\n"
213 "\\everypar{\\color{note_fontcolor}\\pardir TRT \\textdir TRT\\ignorespaces}%\n"
214 "\\BODY\\everypar{\\ignorespacesafterend}\n"
216 "\\textcolor{note_fontcolor}\\bgroup\\ignorespaces%\n"
217 "\\BODY\\ignorespacesafterend\\egroup\n"
220 static docstring const lyxgreyedout_luartl_babel_def = from_ascii(
221 "%% The greyedout annotation environment (with RTL support)\n"
222 "\\NewEnviron{lyxgreyedout}{%\n"
224 "\\everypar{\\color{note_fontcolor}\\pardir TRT \\textdir TRT\\ignorespaces}%\n"
225 "\\BODY\\everypar{\\ignorespacesafterend}\n"
227 "\\textcolor{note_fontcolor}\\bgroup\\ignorespaces%\n"
228 "\\BODY\\ignorespacesafterend\\egroup\n"
231 // We want to omit the file extension for includegraphics, but this does not
232 // work when the filename contains other dots.
233 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
234 static docstring const lyxdot_def = from_ascii(
235 "%% A simple dot to overcome graphicx limitations\n"
236 "\\newcommand{\\lyxdot}{.}\n");
238 static docstring const changetracking_dvipost_def = from_ascii(
239 "%% Change tracking with dvipost\n"
241 "\\dvipost{osstart color push Red}\n"
242 "\\dvipost{osend color pop}\n"
243 "\\dvipost{cbstart color push Blue}\n"
244 "\\dvipost{cbrule 0pt}\n"
245 "\\dvipost{cbend color pop}\n"
246 "\\DeclareRobustCommand{\\lyxadded}[4][]{\\changestart#4\\changeend}\n"
247 "\\DeclareRobustCommand{\\lyxdeleted}[4][]{%\n"
248 "\\changestart\\overstrikeon#4\\overstrikeoff\\changeend}\n");
250 static docstring const changetracking_dvipost_cb_def = from_ascii(
251 "%% Change tracking with dvipost\n"
253 "\\dvipost{osstart color push Red}\n"
254 "\\dvipost{osend color pop}\n"
255 "\\dvipost{cbstart color push Blue}\n"
256 "\\dvipost{cbend color pop}\n"
257 "\\DeclareRobustCommand{\\lyxadded}[4][]{\\changestart#4\\changeend}\n"
258 "\\DeclareRobustCommand{\\lyxdeleted}[4][]{%\n"
259 "\\changestart\\overstrikeon#4\\overstrikeoff\\changeend}\n");
261 static docstring const changetracking_xcolor_ulem_base_def = from_ascii(
262 "%% Change tracking with ulem and xcolor: base macros\n"
263 "\\DeclareRobustCommand{\\mklyxadded}[1]{\\bgroup\\color{lyxadded}{}#1\\egroup}\n"
264 "\\DeclareRobustCommand{\\mklyxdeleted}[1]{\\bgroup\\color{lyxdeleted}\\mklyxsout{#1}\\egroup}\n"
265 "\\DeclareRobustCommand{\\mklyxsout}[1]{\\ifx\\\\#1\\else\\sout{#1}\\fi}\n");
267 static docstring const changetracking_xcolor_ulem_def = from_ascii(
268 "%% Change tracking with ulem and xcolor: ct markup\n"
269 "\\DeclareRobustCommand{\\lyxadded}[4][]{\\mklyxadded{#4}}\n"
270 "\\DeclareRobustCommand{\\lyxdeleted}[4][]{\\mklyxdeleted{#4}}\n");
272 static docstring const changetracking_xcolor_ulem_cb_def = from_ascii(
273 "%% Change tracking with ulem, xcolor and changebars: ct markup\n"
274 "\\DeclareRobustCommand{\\lyxadded}[4][]{%\n"
275 " \\protect\\cbstart\\mklyxadded{#4}%\n"
276 " \\protect\\cbend%\n"
278 "\\DeclareRobustCommand{\\lyxdeleted}[4][]{%\n"
279 " \\protect\\cbstart\\mklyxdeleted{#4}%\n"
280 " \\protect\\cbend%\n"
283 static docstring const changetracking_xcolor_ulem_hyperref_def = from_ascii(
284 "%% Change tracking with ulem, xcolor, and hyperref: ct markup\n"
285 "\\DeclareRobustCommand{\\lyxadded}[4][]{\\texorpdfstring{\\mklyxadded{#4}}{#4}}\n"
286 "\\DeclareRobustCommand{\\lyxdeleted}[4][]{\\texorpdfstring{\\mklyxdeleted{#4}}{}}\n");
288 static docstring const changetracking_xcolor_ulem_hyperref_cb_def = from_ascii(
289 "%% Change tracking with ulem, xcolor, hyperref and changebars: ct markup\n"
290 "\\DeclareRobustCommand{\\lyxadded}[4][]{%\n"
291 " \\texorpdfstring{\\protect\\cbstart\\mklyxadded{#4}%\n"
292 " \\protect\\cbend}{#4}%\n"
294 "\\DeclareRobustCommand{\\lyxdeleted}[4][]{%\n"
295 " \\texorpdfstring{\\protect\\cbstart\\mklyxdeleted{#4}%\n"
296 " \\protect\\cbend}{}%\n"
299 static docstring const changetracking_tikz_object_sout_def = from_ascii(
300 "%% Strike out display math and text objects with tikz\n"
301 "\\usetikzlibrary{calc}\n"
302 "\\newcommand{\\lyxobjectsout}[1]{%\n"
304 " \\color{lyxdeleted}%\n"
306 " \\node[inner sep=0pt,outer sep=0pt](lyxdelobj){#1};\n"
307 " \\draw($(lyxdelobj.south west)+(2em,.5em)$)--($(lyxdelobj.north east)-(2em,.5em)$);\n"
312 static docstring const changetracking_xcolor_ulem_object_def = from_ascii(
313 "%% Change tracking with ulem and xcolor: ct markup for complex objects\n"
314 "\\DeclareRobustCommand{\\lyxobjdeleted}[4][]{\\lyxobjectsout{#4}}\n"
315 "\\DeclareRobustCommand{\\lyxdisplayobjdeleted}[4][]{%\n"
316 " \\leavevmode\\\\%\n"
317 " \\lyxobjectsout{\\parbox{\\linewidth}{#4}}%\n"
319 "\\DeclareRobustCommand{\\lyxudisplayobjdeleted}[4][]{%\n"
320 " \\leavevmode\\\\%\n"
321 " \\raisebox{-\\belowdisplayshortskip}{%\n"
322 " \\lyxobjectsout{\\parbox[b]{\\linewidth}{#4}}}%\n"
325 static docstring const changetracking_xcolor_ulem_cb_object_def = from_ascii(
326 "%% Change tracking with ulem, xcolor and changebars:ct markup for complex objects\n"
327 "\\DeclareRobustCommand{\\lyxobjdeleted}[4][]{%\n"
328 " \\protect\\cbstart\\lyxobjectsout{#4}%\n"
329 " \\protect\\cbend%\n"
331 "\\DeclareRobustCommand{\\lyxdisplayobjdeleted}[4][]{%\n"
332 " \\leavevmode\\\\%\n"
333 " \\protect\\cbstart%\n"
334 " \\lyxobjectsout{\\parbox{\\linewidth}{#4}}%\n"
335 " \\protect\\cbend%\n"
337 "\\DeclareRobustCommand{\\lyxudisplayobjdeleted}[4][]{%\n"
338 " \\leavevmode\\\\%\n"
339 " \\raisebox{-\\belowdisplayshortskip}{%\n"
340 " \\protect\\cbstart%\n"
341 " \\lyxobjectsout{\\parbox[b]{\\linewidth}{#4}}}%\n"
342 " \\protect\\cbend%\n"
345 static docstring const changetracking_xcolor_ulem_hyperref_object_def = from_ascii(
346 "%% Change tracking with ulem, xcolor, and hyperref: ct markup for complex objects\n"
347 "\\DeclareRobustCommand{\\lyxobjdeleted}[4][]{\\texorpdfstring{\\lyxobjectsout{#4}}{}}\n"
348 "\\DeclareRobustCommand{\\lyxdisplayobjdeleted}[4][]{%\n"
349 " \\texorpdfstring{\\leavevmode\\\\\\lyxobjectsout{\\parbox{\\linewidth}{#4}}}{}%\n"
351 "\\DeclareRobustCommand{\\lyxudisplayobjdeleted}[4][]{%\n"
352 " \\texorpdfstring{\\leavevmode\\\\\\raisebox{-\\belowdisplayshortskip}{%\n"
353 " \\lyxobjectsout{\\parbox[b]{\\linewidth}{#4}}}}{}%\n"
356 static docstring const changetracking_xcolor_ulem_hyperref_cb_object_def = from_ascii(
357 "%% Change tracking with ulem, xcolor, hyperref and changebars:\n"
358 "%% ct markup for complex objects\n"
359 "\\DeclareRobustCommand{\\lyxobjdeleted}[4][]{%\n"
360 " \\texorpdfstring{\\protect\\cbstart\\lyxobjectsout{#4}%\n"
361 " \\protect\\cbend}{}%\n"
363 "\\DeclareRobustCommand{\\lyxdisplayobjdeleted}[4][]{%\n"
364 " \\texorpdfstring{\\leavevmode\\\\\\protect\\cbstart%\n"
365 " \\lyxobjectsout{\\parbox{\\linewidth}{#4}}%\n"
366 " \\protect\\cbend%\n"
369 "\\DeclareRobustCommand{\\lyxudisplayobjdeleted}[4][]{%\n"
370 " \\texorpdfstring{\\leavevmode\\\\\\protect\\cbstart%\n"
371 " \\raisebox{-\\belowdisplayshortskip}{%\n"
372 " \\lyxobjectsout{\\parbox[b]{\\linewidth}{#4}}%\n"
377 static docstring const changetracking_none_def = from_ascii(
378 "%% Change tracking: Disable markup in output\n"
379 "\\newcommand{\\lyxadded}[3]{#3}\n"
380 "\\newcommand{\\lyxdeleted}[3]{}\n"
381 "\\newcommand{\\lyxobjdeleted}[3]{}\n"
382 "\\newcommand{\\lyxdisplayobjdeleted}[3]{}\n"
383 "\\newcommand{\\lyxudisplayobjdeleted}[3]{}\n");
385 static docstring const textgreek_LGR_def = from_ascii(
386 "\\DeclareFontEncoding{LGR}{}{}\n");
387 static docstring const textgreek_def = from_ascii(
388 "\\DeclareRobustCommand{\\greektext}{%\n"
389 " \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
390 "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n");
392 static docstring const textcyr_T2A_def = from_ascii(
393 "\\InputIfFileExists{t2aenc.def}{}{%\n"
394 " \\errmessage{File `t2aenc.def' not found: Cyrillic script not supported}}\n");
395 static docstring const textcyr_def = from_ascii(
396 "\\DeclareRobustCommand{\\cyrtext}{%\n"
397 " \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
398 "\\DeclareRobustCommand{\\textcyrillic}[1]{\\leavevmode{\\cyrtext #1}}\n");
400 static docstring const lyxmathsym_def = from_ascii(
401 "\\newcommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
402 " \\text{\\ifx\\math@version\\b@ld\\bfseries\\fi#1}\\endgroup\\else#1\\fi}\n");
404 static docstring const papersizedvi_def = from_ascii(
405 "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n");
407 static docstring const papersizepdf_def = from_ascii(
408 "\\pdfpageheight\\paperheight\n"
409 "\\pdfpagewidth\\paperwidth\n");
411 static docstring const papersizepdflua_def = from_ascii(
412 "% Backwards compatibility for LuaTeX < 0.90\n"
413 "\\@ifundefined{pageheight}{\\let\\pageheight\\pdfpageheight}{}\n"
414 "\\@ifundefined{pagewidth}{\\let\\pagewidth\\pdfpagewidth}{}\n"
415 "\\pageheight\\paperheight\n"
416 "\\pagewidth\\paperwidth\n");
418 static docstring const cedilla_def = from_ascii(
419 "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
420 "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n");
422 static docstring const subring_def = from_ascii(
423 "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
424 "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n");
426 static docstring const subdot_def = from_ascii(
427 "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
428 "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n");
430 static docstring const subhat_def = from_ascii(
431 "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
432 "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n");
434 static docstring const subtilde_def = from_ascii(
435 "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
436 "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n");
438 static docstring const dacute_def = from_ascii(
439 "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n");
441 static docstring const tipasymb_def = from_ascii(
442 "\\DeclareFontEncoding{T3}{}{}\n"
443 "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n");
445 static docstring const dgrave_def = from_ascii(
446 "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n");
448 static docstring const rcap_def = from_ascii(
449 "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n");
451 static docstring const ogonek_def = from_ascii(
452 "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
453 " \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
454 " \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
455 " \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
456 "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n");
458 static docstring const lyxaccent_def = from_ascii(
459 "%% custom text accent \\LyxTextAccent[<rise value (length)>]{<accent>}{<base>}\n"
460 "\\newcommand*{\\LyxTextAccent}[3][0ex]{%\n"
461 " \\hmode@bgroup\\ooalign{\\null#3\\crcr\\hidewidth\n"
462 " \\raise#1\\hbox{#2}\\hidewidth}\\egroup}\n"
463 "%% select a font size smaller than the current font size:\n"
464 "\\newcommand{\\LyxAccentSize}[1][\\sf@size]{%\n"
465 " \\check@mathfonts\\fontsize#1\\z@\\math@fontsfalse\\selectfont\n"
468 static docstring const textcommabelow_def = from_ascii(
469 "\\ProvideTextCommandDefault{\\textcommabelow}[1]{%%\n"
470 " \\LyxTextAccent[-.31ex]{\\LyxAccentSize,}{#1}}\n");
472 static docstring const textcommaabove_def = from_ascii(
473 "\\ProvideTextCommandDefault{\\textcommaabove}[1]{%%\n"
474 " \\LyxTextAccent[.5ex]{\\LyxAccentSize`}{#1}}\n");
476 static docstring const textcommaaboveright_def = from_ascii(
477 "\\ProvideTextCommandDefault{\\textcommaaboveright}[1]{%%\n"
478 " \\LyxTextAccent[.5ex]{\\LyxAccentSize\\ '}{#1}}\n");
480 // Baltic languages use a comma-accent instead of a cedilla
481 static docstring const textbaltic_def = from_ascii(
482 "%% use comma accent instead of cedilla for these characters:\n"
483 "\\DeclareTextCompositeCommand{\\c}{T1}{g}{\\textcommaabove{g}}\n"
484 "\\DeclareTextCompositeCommand{\\c}{T1}{G}{\\textcommabelow{G}}\n"
485 "\\DeclareTextCompositeCommand{\\c}{T1}{k}{\\textcommabelow{k}}\n"
486 "\\DeclareTextCompositeCommand{\\c}{T1}{K}{\\textcommabelow{K}}\n"
487 "\\DeclareTextCompositeCommand{\\c}{T1}{l}{\\textcommabelow{l}}\n"
488 "\\DeclareTextCompositeCommand{\\c}{T1}{L}{\\textcommabelow{L}}\n"
489 "\\DeclareTextCompositeCommand{\\c}{T1}{n}{\\textcommabelow{n}}\n"
490 "\\DeclareTextCompositeCommand{\\c}{T1}{N}{\\textcommabelow{N}}\n"
491 "\\DeclareTextCompositeCommand{\\c}{T1}{r}{\\textcommabelow{r}}\n"
492 "\\DeclareTextCompositeCommand{\\c}{T1}{R}{\\textcommabelow{R}}\n");
494 // Use cyrillic fonts to provide letter schwa in text (see #11062)
495 static docstring const textschwa_def = from_ascii(
496 "%% letter schwa missing in Latin fonts, use Cyrillic schwa\n"
497 "\\DeclareTextSymbolDefault{\\CYRSCHWA}{T2A}\n"
498 "\\DeclareTextSymbolDefault{\\cyrschwa}{T2A}\n"
499 "\\ProvideTextCommandDefault{\\textSchwa}{\\CYRSCHWA}\n"
500 "\\ProvideTextCommandDefault{\\textschwa}{\\cyrschwa}\n");
502 // split-level fractions
503 static docstring const xfrac_def = from_ascii(
504 "\\usepackage{xfrac}\n");
505 static docstring const smallLetterFrac_def = from_ascii(
506 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{default}{text}\n"
507 " {phantom=c, scale-factor=1.0, slash-left-kern=-.05em}\n"
508 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmr}{text}\n"
509 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
510 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmss}{text}\n"
511 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
512 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmr}{text}\n"
513 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
514 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmss}{text}\n"
515 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
516 "\\newcommand{\\smallLetterFrac}[2]{%\n"
517 " {\\UseCollection{xfrac}{smallLetterFrac}\\sfrac{#1}{#2}}}\n");
519 static docstring const lyxref_def = from_ascii(
520 "\\RS@ifundefined{subsecref}\n"
521 " {\\newref{subsec}{name = \\RSsectxt}}\n"
523 "\\RS@ifundefined{thmref}\n"
524 " {\\def\\RSthmtxt{theorem~}\\newref{thm}{name = \\RSthmtxt}}\n"
526 "\\RS@ifundefined{lemref}\n"
527 " {\\def\\RSlemtxt{lemma~}\\newref{lem}{name = \\RSlemtxt}}\n"
530 // Make sure the columns are also outputed as rtl
531 static docstring const rtloutputdblcol_def = from_ascii(
532 "\\def\\@outputdblcol{%\n"
533 " \\if@firstcolumn\n"
534 " \\global \\@firstcolumnfalse\n"
535 " \\global \\setbox\\@leftcolumn \\box\\@outputbox\n"
537 " \\global \\@firstcolumntrue\n"
538 " \\setbox\\@outputbox \\vbox {%\n"
539 " \\hb@xt@\\textwidth {%\n"
540 " \\kern\\textwidth \\kern-\\columnwidth %**\n"
541 " \\hb@xt@\\columnwidth {%\n"
542 " \\box\\@leftcolumn \\hss}%\n"
543 " \\kern-\\textwidth %**\n"
545 " {\\normalcolor\\vrule \\@width\\columnseprule}%\n"
547 " \\kern-\\textwidth %**\n"
548 " \\hb@xt@\\columnwidth {%\n"
549 " \\box\\@outputbox \\hss}%\n"
550 " \\kern-\\columnwidth \\kern\\textwidth %**\n"
553 " \\@combinedblfloats\n"
556 " \\@dblfloatplacement\n"
557 " \\@startdblcolumn\n"
558 " \\@whilesw\\if@fcolmade \\fi\n"
560 " \\@startdblcolumn}%\n"
564 "\\@mparswitchtrue\n");
566 static docstring const lyxmintcaption_def = from_ascii(
567 "\\long\\def\\lyxmintcaption[#1]#2{%\n"
568 " \\ifx#1t\\vskip\\baselineskip\\fi%\n"
569 " \\refstepcounter{listing}\\noindent%\n"
570 " \\addcontentsline{lol}{listing}%\n"
571 " {\\protect\\numberline{\\thelisting}{\\ignorespaces #2}}%\n"
572 " \\setbox\\@tempboxa\\hbox{\\listingscaption~\\thelisting: #2}%\n"
573 " \\ifdim \\wd\\@tempboxa >\\linewidth%\n"
574 " \\parbox[t]{\\linewidth}{\\unhbox\\@tempboxa}\\else%\n"
575 " \\hbox to\\linewidth{\\hfil\\box\\@tempboxa\\hfil}\\fi%\n"
576 " \\ifx#1b\\vskip\\baselineskip\\fi\n"
580 /////////////////////////////////////////////////////////////////////
584 /////////////////////////////////////////////////////////////////////
586 static docstring const lyxnoun_style = from_ascii(
588 " font-variant: small-caps;\n"
592 // this is how it normally renders, but it might not always do so.
593 static docstring const lyxstrikeout_style = from_ascii(
595 " text-decoration: line-through;\n"
599 /////////////////////////////////////////////////////////////////////
603 /////////////////////////////////////////////////////////////////////
606 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
607 OutputParams const & r)
608 : buffer_(&b), params_(p), runparams_(r), in_float_(false),
609 in_deleted_inset_(false)
613 LaTeXFeatures::LangPackage LaTeXFeatures::langPackage() const
615 string const local_lp = bufferParams().lang_package;
617 // Locally, custom is just stored as a string
618 // in bufferParams().lang_package.
619 if (local_lp != "auto"
620 && local_lp != "babel"
621 && local_lp != "default"
622 && local_lp != "none")
623 return LANG_PACK_CUSTOM;
625 if (local_lp == "none")
626 return LANG_PACK_NONE;
628 /* If "auto" is selected, we load polyglossia with non-TeX fonts,
629 * else we select babel.
630 * If babel is selected (either directly or via the "auto"
631 * mechanism), we really do only require it if we have
632 * a language that needs it.
634 bool const polyglossia_required =
635 params_.useNonTeXFonts
636 && isAvailable("polyglossia")
637 && !isProvided("babel")
638 && this->hasOnlyPolyglossiaLanguages();
639 bool const babel_required =
640 !bufferParams().language->babel().empty()
641 || !this->getBabelLanguages().empty();
643 if (local_lp == "auto") {
644 // polyglossia requirement has priority over babel
645 if (polyglossia_required)
646 return LANG_PACK_POLYGLOSSIA;
647 else if (babel_required)
648 return LANG_PACK_BABEL;
651 if (local_lp == "babel") {
653 return LANG_PACK_BABEL;
656 if (local_lp == "default") {
657 switch (lyxrc.language_package_selection) {
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;
665 case LyXRC::LP_BABEL:
667 return LANG_PACK_BABEL;
669 case LyXRC::LP_CUSTOM:
670 return LANG_PACK_CUSTOM;
672 return LANG_PACK_NONE;
676 return LANG_PACK_NONE;
680 void LaTeXFeatures::require(string const & name)
682 features_.insert(name);
686 void LaTeXFeatures::require(set<string> const & names)
688 features_.insert(names.begin(), names.end());
692 void LaTeXFeatures::provide(string const & name)
694 provides_.insert(name);
698 void LaTeXFeatures::useLayout(docstring const & layoutname)
700 useLayout(layoutname, 0);
704 void LaTeXFeatures::useLayout(docstring const & layoutname, int level)
706 // Some code to avoid loops in dependency definition
707 const int maxlevel = 30;
708 if (level > maxlevel) {
709 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
710 << "recursion attained by layout "
711 << to_utf8(layoutname) << endl;
715 DocumentClass const & tclass = params_.documentClass();
716 if (tclass.hasLayout(layoutname)) {
717 // Is this layout already in usedLayouts?
718 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
719 != usedLayouts_.end())
722 Layout const & layout = tclass[layoutname];
723 require(layout.requires());
725 if (!layout.depends_on().empty()) {
726 useLayout(layout.depends_on(), level + 1);
728 usedLayouts_.push_back(layoutname);
730 lyxerr << "LaTeXFeatures::useLayout: layout `"
731 << to_utf8(layoutname) << "' does not exist in this class"
737 void LaTeXFeatures::useInsetLayout(InsetLayout const & lay)
739 docstring const & lname = lay.name();
740 DocumentClass const & tclass = params_.documentClass();
742 // this is a default inset layout, nothing useful here
743 if (!tclass.hasInsetLayout(lname))
745 // Is this layout already in usedInsetLayouts?
746 if (find(usedInsetLayouts_.begin(), usedInsetLayouts_.end(), lname)
747 != usedInsetLayouts_.end())
750 require(lay.requires());
751 usedInsetLayouts_.push_back(lname);
755 bool LaTeXFeatures::isRequired(string const & name) const
757 return features_.find(name) != features_.end();
761 bool LaTeXFeatures::isProvided(string const & name) const
763 // Currently, this is only features provided by babel languages
764 // (such as textgreek)
765 if (provides_.find(name) != provides_.end())
768 if (params_.useNonTeXFonts)
769 return params_.documentClass().provides(name);
771 bool const ot1 = (params_.main_font_encoding() == "default"
772 || params_.main_font_encoding() == "OT1");
773 bool const complete = (params_.fontsSans() == "default"
774 && params_.fontsTypewriter() == "default");
775 bool const nomath = (params_.fontsMath() == "default");
776 return params_.documentClass().provides(name)
777 || theLaTeXFonts().getLaTeXFont(
778 from_ascii(params_.fontsRoman())).provides(name, ot1,
781 || theLaTeXFonts().getLaTeXFont(
782 from_ascii(params_.fontsSans())).provides(name, ot1,
785 || theLaTeXFonts().getLaTeXFont(
786 from_ascii(params_.fontsTypewriter())).provides(name, ot1,
789 || theLaTeXFonts().getLaTeXFont(
790 from_ascii(params_.fontsMath())).provides(name, ot1,
796 bool LaTeXFeatures::mustProvide(string const & name) const
798 return isRequired(name) && !isProvided(name);
802 bool LaTeXFeatures::isAvailable(string const & name)
804 string::size_type const i = name.find("->");
805 if (i != string::npos) {
806 string const from = name.substr(0,i);
807 string const to = name.substr(i+2);
808 //LYXERR0("from=[" << from << "] to=[" << to << "]");
809 return theConverters().isReachable(from, to);
811 return LaTeXPackages::isAvailable(name);
817 void addSnippet(std::list<TexString> & list, TexString ts, bool allow_dupes)
820 // test the absense of duplicates, i.e. elements with same str
821 none_of(list.begin(), list.end(), [&](TexString const & ts2){
822 return ts.str == ts2.str;
825 list.push_back(move(ts));
829 TexString getSnippets(std::list<TexString> const & list)
831 otexstringstream snip;
832 for (TexString const & ts : list)
833 snip << TexString(ts) << '\n';
834 return snip.release();
840 void LaTeXFeatures::addPreambleSnippet(TexString ts, bool allow_dupes)
842 addSnippet(preamble_snippets_, move(ts), allow_dupes);
846 void LaTeXFeatures::addPreambleSnippet(docstring const & str, bool allow_dupes)
848 addSnippet(preamble_snippets_, TexString(str), allow_dupes);
852 void LaTeXFeatures::addCSSSnippet(std::string const & snippet)
854 addSnippet(css_snippets_, TexString(from_ascii(snippet)), false);
858 TexString LaTeXFeatures::getPreambleSnippets() const
860 return getSnippets(preamble_snippets_);
864 docstring LaTeXFeatures::getCSSSnippets() const
866 return getSnippets(css_snippets_).str;
871 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
873 if (!usedFloats_[name])
874 usedFloats_[name] = subfloat;
877 // We only need float.sty if we use non builtin floats, or if we
878 // use the "H" modifier. This includes modified table and
879 // figure floats. (Lgb)
880 Floating const & fl = params_.documentClass().floats().getType(name);
881 if (!fl.floattype().empty()) {
882 if (fl.usesFloatPkg())
884 if (!fl.requires().empty()) {
885 vector<string> reqs = getVectorFromString(fl.requires());
886 for (auto const req : reqs)
893 void LaTeXFeatures::useLanguage(Language const * lang)
895 if (!lang->babel().empty() || !lang->polyglossia().empty())
896 UsedLanguages_.insert(lang);
897 if (!lang->requires().empty())
898 require(lang->requires());
899 // currently only supported for Babel
900 if (!lang->provides().empty() && useBabel())
901 provide(lang->provides());
902 // CJK languages do not have a babel name.
903 // They use the CJK package
904 if (lang->encoding()->package() == Encoding::CJK)
906 // japanese babel language is special (tied to the pLaTeX engine).
907 if (lang->encoding()->package() == Encoding::japanese)
912 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
914 IncludedFiles_[key] = name;
918 bool LaTeXFeatures::hasLanguages() const
920 return !UsedLanguages_.empty();
924 bool LaTeXFeatures::hasOnlyPolyglossiaLanguages() const
926 // first the main language
927 if (params_.language->polyglossia().empty())
929 // now the secondary languages
930 LanguageList::const_iterator const begin = UsedLanguages_.begin();
931 for (LanguageList::const_iterator cit = begin;
932 cit != UsedLanguages_.end();
934 if ((*cit)->polyglossia().empty())
941 bool LaTeXFeatures::hasPolyglossiaExclusiveLanguages() const
943 // first the main language
944 if (params_.language->isPolyglossiaExclusive())
946 // now the secondary languages
947 LanguageList::const_iterator const begin = UsedLanguages_.begin();
948 for (LanguageList::const_iterator cit = begin;
949 cit != UsedLanguages_.end();
951 if ((*cit)->isPolyglossiaExclusive())
958 vector<string> LaTeXFeatures::getPolyglossiaExclusiveLanguages() const
960 vector<string> result;
961 // first the main language
962 if (params_.language->isPolyglossiaExclusive())
963 result.push_back(params_.language->display());
964 // now the secondary languages
965 LanguageList::const_iterator const begin = UsedLanguages_.begin();
966 for (LanguageList::const_iterator cit = begin;
967 cit != UsedLanguages_.end();
969 if ((*cit)->isPolyglossiaExclusive())
970 result.push_back((*cit)->display());
976 vector<string> LaTeXFeatures::getBabelExclusiveLanguages() const
978 vector<string> result;
979 // first the main language
980 if (params_.language->isBabelExclusive())
981 result.push_back(params_.language->display());
982 // now the secondary languages
983 LanguageList::const_iterator const begin = UsedLanguages_.begin();
984 for (LanguageList::const_iterator cit = begin;
985 cit != UsedLanguages_.end();
987 if ((*cit)->isBabelExclusive())
988 result.push_back((*cit)->display());
994 string LaTeXFeatures::getBabelLanguages() const
999 LanguageList::const_iterator const begin = UsedLanguages_.begin();
1000 for (LanguageList::const_iterator cit = begin;
1001 cit != UsedLanguages_.end();
1003 if ((*cit)->babel().empty())
1009 langs << (*cit)->babel();
1015 set<string> LaTeXFeatures::getPolyglossiaLanguages() const
1019 LanguageList::const_iterator const begin = UsedLanguages_.begin();
1020 for (LanguageList::const_iterator cit = begin;
1021 cit != UsedLanguages_.end();
1023 // We do not need the variants here
1024 langs.insert((*cit)->polyglossia());
1030 string LaTeXFeatures::getActiveChars() const
1033 // first the main language
1034 res += params_.language->activeChars();
1035 // now the secondary languages
1036 LanguageList::const_iterator const begin = UsedLanguages_.begin();
1037 for (LanguageList::const_iterator cit = begin;
1038 cit != UsedLanguages_.end(); ++cit)
1039 res += ((*cit)->activeChars());
1044 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
1046 // This does only find encodings of languages supported by babel, but
1047 // that does not matter since we don't have a language with an
1048 // encoding supported by inputenc but without babel support.
1050 for (auto const & lang : UsedLanguages_)
1051 if (lang->encoding()->latexName() != doc_encoding &&
1052 lang->encoding()->package() == Encoding::inputenc)
1053 encs.insert(lang->encoding()->latexName());
1058 void LaTeXFeatures::getFontEncodings(vector<string> & encs, bool const onlylangs) const
1061 // these must be loaded if glyphs of this script are used
1062 // unless a language providing them is used in the document
1063 if (mustProvide("textgreek")
1064 && find(encs.begin(), encs.end(), "LGR") == encs.end())
1065 encs.insert(encs.begin(), "LGR");
1066 if ((mustProvide("textcyrillic") || mustProvide("textschwa"))
1067 && find(encs.begin(), encs.end(), "T2A") == encs.end())
1068 encs.insert(encs.begin(), "T2A");
1071 for (auto const & lang : UsedLanguages_) {
1072 vector<string> extraencs =
1073 getVectorFromString(lang->fontenc(buffer().masterParams()));
1074 for (auto const & extra : extraencs) {
1075 if (extra != "none" && find(encs.begin(), encs.end(), extra) == encs.end())
1076 encs.insert(encs.begin(), extra);
1082 bool LaTeXFeatures::hasRTLLanguage() const
1084 if (params_.language->rightToLeft())
1086 for (auto const & lang : UsedLanguages_)
1087 if (lang->rightToLeft())
1095 char const * simplefeatures[] = {
1096 // note that the package order here will be the same in the LaTeX-output
1103 // subfig is handled in BufferParams.cpp
1107 /*For a successful cooperation of the `wrapfig' package with the
1108 `float' package you should load the `wrapfig' package *after*
1109 the `float' package. See the caption package documentation
1138 // listings is handled in BufferParams.cpp
1169 char const * bibliofeatures[] = {
1170 // Known bibliography packages (will be loaded before natbib)
1186 int const nb_bibliofeatures = sizeof(bibliofeatures) / sizeof(char const *);
1188 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
1193 string const LaTeXFeatures::getColorOptions() const
1195 ostringstream colors;
1197 // Handling the color packages separately is needed to be able to load them
1198 // before babel when hyperref is loaded with the colorlinks option
1199 // for more info see Bufferparams.cpp
1202 if (mustProvide("color") || mustProvide("xcolor")) {
1203 string const package =
1204 (mustProvide("xcolor") ? "xcolor" : "color");
1205 if (params_.graphics_driver == "default"
1206 || params_.graphics_driver == "none")
1207 colors << "\\usepackage{" << package << "}\n";
1209 colors << "\\usepackage["
1210 << params_.graphics_driver
1211 << "]{" << package << "}\n";
1214 // pdfcolmk must be loaded after color
1215 if (mustProvide("pdfcolmk"))
1216 colors << "\\usepackage{pdfcolmk}\n";
1218 // the following 3 color commands must be set after color
1219 // is loaded and before pdfpages, therefore add the command
1220 // here define the set color
1221 if (mustProvide("pagecolor")) {
1222 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
1223 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
1224 // set the page color
1225 colors << "\\pagecolor{page_backgroundcolor}\n";
1228 if (mustProvide("fontcolor")) {
1229 colors << "\\definecolor{document_fontcolor}{rgb}{";
1230 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
1232 colors << "\\color{document_fontcolor}\n";
1235 if (mustProvide("lyxgreyedout")) {
1236 colors << "\\definecolor{note_fontcolor}{rgb}{";
1237 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
1238 // the color will be set together with the definition of
1239 // the lyxgreyedout environment (see lyxgreyedout_def)
1242 // color for shaded boxes
1243 if (isRequired("framed") && mustProvide("color")) {
1244 colors << "\\definecolor{shadecolor}{rgb}{";
1245 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
1246 // this color is automatically used by the LaTeX-package "framed"
1249 return colors.str();
1253 string const LaTeXFeatures::getPackageOptions() const
1255 ostringstream packageopts;
1256 // Output all the package option stuff we have been asked to do.
1257 map<string, string>::const_iterator it =
1258 params_.documentClass().packageOptions().begin();
1259 map<string, string>::const_iterator en =
1260 params_.documentClass().packageOptions().end();
1261 for (; it != en; ++it)
1262 if (mustProvide(it->first))
1263 packageopts << "\\PassOptionsToPackage{" << it->second << "}"
1264 << "{" << it->first << "}\n";
1265 return packageopts.str();
1269 string const LaTeXFeatures::getPackages() const
1271 ostringstream packages;
1273 // FIXME: currently, we can only load packages and macros known
1275 // However, with the Require tag of layouts/custom insets,
1276 // also unknown packages can be requested. They are silently
1277 // swallowed now. We should change this eventually.
1279 // These are all the 'simple' includes. i.e
1280 // packages which we just \usepackage{package}
1281 for (int i = 0; i < nb_simplefeatures; ++i) {
1282 if (mustProvide(simplefeatures[i]))
1283 packages << "\\usepackage{" << simplefeatures[i] << "}\n";
1286 // The rest of these packages are somewhat more complicated
1287 // than those above.
1289 if (mustProvide("changebar") && !mustProvide("ct-dvipost")) {
1290 packages << "\\usepackage{changebar}\n";
1293 if (mustProvide("footnote")) {
1294 if (isRequired("hyperref"))
1295 packages << "\\usepackage{footnotehyper}\n";
1297 packages << "\\usepackage{footnote}\n";
1300 // [pdf]lscape is used to rotate longtables
1301 if (mustProvide("lscape")) {
1302 if (runparams_.flavor == OutputParams::LATEX
1303 || runparams_.flavor == OutputParams::DVILUATEX)
1304 packages << "\\usepackage{lscape}\n";
1306 packages << "\\usepackage{pdflscape}\n";
1309 // The tipa package and its extensions (tipx, tone) must not
1310 // be loaded with non-TeX fonts, since fontspec includes the
1311 // respective macros
1312 if (mustProvide("tipa") && !params_.useNonTeXFonts)
1313 packages << "\\usepackage{tipa}\n";
1314 if (mustProvide("tipx") && !params_.useNonTeXFonts)
1315 packages << "\\usepackage{tipx}\n";
1316 if (mustProvide("extraipa") && !params_.useNonTeXFonts)
1317 packages << "\\usepackage{extraipa}\n";
1318 if (mustProvide("tone") && !params_.useNonTeXFonts)
1319 packages << "\\usepackage{tone}\n";
1321 // if fontspec or newtxmath is used, AMS packages have to be loaded
1322 // before fontspec (in BufferParams)
1323 string const amsPackages = loadAMSPackages();
1324 bool const ot1 = (params_.main_font_encoding() == "default"
1325 || params_.main_font_encoding() == "OT1");
1326 bool const use_newtxmath =
1327 theLaTeXFonts().getLaTeXFont(from_ascii(params_.fontsMath())).getUsedPackage(
1328 ot1, false, false) == "newtxmath";
1330 if (!params_.useNonTeXFonts && !use_newtxmath && !amsPackages.empty())
1331 packages << amsPackages;
1333 if (mustProvide("cancel") &&
1334 params_.use_package("cancel") != BufferParams::package_off)
1335 packages << "\\usepackage{cancel}\n";
1337 // marvosym and bbding both define the \Cross macro
1338 if (mustProvide("marvosym")) {
1339 if (mustProvide("bbding"))
1340 packages << "\\let\\Cross\\relax\n";
1341 packages << "\\usepackage{marvosym}\n";
1344 // accents must be loaded after amsmath
1345 if (mustProvide("accents") &&
1346 params_.use_package("accents") != BufferParams::package_off)
1347 packages << "\\usepackage{accents}\n";
1349 // mathdots must be loaded after amsmath
1350 if (mustProvide("mathdots") &&
1351 params_.use_package("mathdots") != BufferParams::package_off)
1352 packages << "\\usepackage{mathdots}\n";
1354 // yhmath must be loaded after amsmath
1355 if (mustProvide("yhmath") &&
1356 params_.use_package("yhmath") != BufferParams::package_off)
1357 packages << "\\usepackage{yhmath}\n";
1359 // stmaryrd must be loaded after amsmath
1360 if (mustProvide("stmaryrd") &&
1361 params_.use_package("stmaryrd") != BufferParams::package_off)
1362 packages << "\\usepackage{stmaryrd}\n";
1364 if (mustProvide("stackrel") &&
1365 params_.use_package("stackrel") != BufferParams::package_off)
1366 packages << "\\usepackage{stackrel}\n";
1368 if (mustProvide("undertilde") &&
1369 params_.use_package("undertilde") != BufferParams::package_off)
1370 packages << "\\usepackage{undertilde}\n";
1372 // [x]color and pdfcolmk are handled in getColorOptions() above
1375 if (isRequired("makeidx") || isRequired("splitidx")) {
1376 if (!isProvided("makeidx") && !isRequired("splitidx"))
1377 packages << "\\usepackage{makeidx}\n";
1378 if (mustProvide("splitidx"))
1379 packages << "\\usepackage{splitidx}\n";
1380 packages << "\\makeindex\n";
1384 if (mustProvide("graphicx") && params_.graphics_driver != "none") {
1385 if (params_.graphics_driver == "default")
1386 packages << "\\usepackage{graphicx}\n";
1388 packages << "\\usepackage["
1389 << params_.graphics_driver
1393 // These must be loaded after graphicx, since they try
1394 // to load graphicx without options
1395 if (mustProvide("rotating"))
1396 packages << "\\usepackage{rotating}\n";
1397 if (mustProvide("rotfloat"))
1398 packages << "\\usepackage{rotfloat}\n";
1400 // lyxskak.sty --- newer chess support based on skak.sty
1401 if (mustProvide("chess"))
1402 packages << "\\usepackage[ps,mover]{lyxskak}\n";
1405 if (mustProvide("setspace") && !isProvided("SetSpace"))
1406 packages << "\\usepackage{setspace}\n";
1408 // we need to assure that mhchem is loaded before esint and every other
1409 // package that redefines command of amsmath because mhchem loads amlatex
1410 // (this info is from the author of mhchem from June 2013)
1411 if (mustProvide("mhchem") &&
1412 params_.use_package("mhchem") != BufferParams::package_off)
1413 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
1414 "\\usepackage{mhchem}\n";
1416 // wasysym is a simple feature, but it must be after amsmath if both
1418 // wasysym redefines some integrals (e.g. iint) from amsmath. That
1419 // leads to inconsistent integrals. We only load this package if
1420 // the document does not contain integrals (then isRequired("esint")
1421 // is false) or if esint is used, since esint redefines all relevant
1422 // integral symbols from wasysym and amsmath.
1423 // See http://www.lyx.org/trac/ticket/1942
1424 if (mustProvide("wasysym") &&
1425 params_.use_package("wasysym") != BufferParams::package_off &&
1426 (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
1427 packages << "\\usepackage{wasysym}\n";
1429 // esint must be after amsmath (and packages requiring amsmath, like mhchem)
1430 // and wasysym, since it will redeclare inconsistent integral symbols
1431 if (mustProvide("esint") &&
1432 params_.use_package("esint") != BufferParams::package_off)
1433 packages << "\\usepackage{esint}\n";
1435 // Known bibliography packages (simple \usepackage{package})
1436 for (int i = 0; i < nb_bibliofeatures; ++i) {
1437 if (mustProvide(bibliofeatures[i]))
1438 packages << "\\usepackage{"
1439 << bibliofeatures[i] << "}\n";
1442 // Compatibility between achicago and natbib
1443 if (mustProvide("achicago") && mustProvide("natbib"))
1444 packages << "\\let\\achicagobib\\thebibliography\n";
1447 // Some classes load natbib themselves, but still allow (or even require)
1448 // plain numeric citations (ReVTeX is such a case, see bug 5182).
1449 // This special case is indicated by the "natbib-internal" key.
1450 if (mustProvide("natbib")
1451 && !isProvided("natbib-internal")
1452 && !isProvided("biblatex")
1453 && !isProvided("biblatex-natbib")
1454 && !isProvided("jurabib")) {
1455 packages << "\\usepackage[";
1456 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
1457 packages << "numbers";
1459 packages << "authoryear";
1460 if (!params_.biblio_opts.empty())
1461 packages << ',' << params_.biblio_opts;
1462 packages << "]{natbib}\n";
1465 // Compatibility between achicago and natbib
1466 if (mustProvide("achicago") && mustProvide("natbib")) {
1467 packages << "\\let\\thebibliography\\achicagobib\n";
1468 packages << "\\let\\SCcite\\astroncite\n";
1469 packages << "\\let\\UnexpandableProtect\\protect\n";
1472 // jurabib -- we need version 0.6 at least.
1473 if (mustProvide("jurabib")
1474 && !isProvided("natbib-internal")
1475 && !isProvided("natbib")
1476 && !isProvided("biblatex")
1477 && !isProvided("biblatex-natbib")) {
1478 packages << "\\usepackage";
1479 if (!params_.biblio_opts.empty())
1480 packages << '[' << params_.biblio_opts << ']';
1481 packages << "{jurabib}[2004/01/25]\n";
1484 // opcit -- we pass custombst as we output \bibliographystyle ourselves
1485 if (mustProvide("opcit")) {
1486 if (isRequired("hyperref"))
1487 packages << "\\usepackage[custombst,hyperref]{opcit}\n";
1489 packages << "\\usepackage[custombst]{opcit}\n";
1492 // xargs -- we need version 1.09 at least
1493 if (mustProvide("xargs"))
1494 packages << "\\usepackage{xargs}[2008/03/08]\n";
1496 if (mustProvide("xy"))
1497 packages << "\\usepackage[all]{xy}\n";
1499 if (mustProvide("feyn"))
1500 packages << "\\usepackage{feyn}\n"; //Diagram
1502 if (mustProvide("ulem"))
1503 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
1504 "\\usepackage{ulem}\n";
1506 if (mustProvide("nomencl")) {
1507 // Make it work with the new and old version of the package,
1508 // but don't use the compatibility option since it is
1509 // incompatible to other packages.
1510 packages << "\\usepackage{nomencl}\n"
1511 "% the following is useful when we have the old nomencl.sty package\n"
1512 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
1513 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
1514 "\\makenomenclature\n";
1517 // fixltx2e provides subscript
1518 if (mustProvide("subscript") && !isRequired("fixltx2e"))
1519 packages << "\\usepackage{subscript}\n";
1521 // footmisc must be loaded after setspace
1522 // Set options here, load the package after the user preamble to
1523 // avoid problems with manual loaded footmisc.
1524 if (mustProvide("footmisc"))
1525 packages << "\\PassOptionsToPackage{stable}{footmisc}\n";
1527 if (mustProvide("microtype")){
1528 packages << "\\usepackage{microtype}\n";
1531 return packages.str();
1535 TexString LaTeXFeatures::getMacros() const
1537 otexstringstream macros;
1539 if (!preamble_snippets_.empty()) {
1541 macros << getPreambleSnippets();
1544 if (mustProvide("xetexdashbreakstate"))
1545 macros << "\\XeTeXdashbreakstate 0" << '\n';
1547 if (mustProvide("papersize")) {
1548 if (runparams_.flavor == OutputParams::LATEX
1549 || runparams_.flavor == OutputParams::DVILUATEX)
1550 macros << papersizedvi_def << '\n';
1551 else if (runparams_.flavor == OutputParams::LUATEX)
1552 macros << papersizepdflua_def << '\n';
1554 macros << papersizepdf_def << '\n';
1557 if (mustProvide("LyX")) {
1558 macros << "\\providecommand{\\LyX}";
1559 // open conditional wrappers
1560 if (runparams_.use_polyglossia && hasRTLLanguage())
1561 macros << "{\\@ensure@LTR";
1562 if (isRequired("hyperref"))
1563 macros << "{\\texorpdfstring";
1565 macros << "{\\ensureascii";
1568 // close conditional wrappers
1571 if (isRequired("hyperref"))
1573 if (runparams_.use_polyglossia && hasRTLLanguage())
1578 if (mustProvide("noun"))
1579 macros << noun_def << '\n';
1581 if (mustProvide("lyxarrow"))
1582 macros << lyxarrow_def << '\n';
1584 if (mustProvide("lyxzerowidthspace"))
1585 macros << lyxZWSP_def << '\n';
1587 if (!usePolyglossia() && mustProvide("textgreek")) {
1588 // ensure LGR font encoding is defined also if fontenc is not loaded by LyX
1589 if (params_.main_font_encoding() == "default")
1590 macros << textgreek_LGR_def;
1591 macros << textgreek_def << '\n';
1594 if (!usePolyglossia() && mustProvide("textcyrillic")) {
1595 // ensure T2A font encoding is set up also if fontenc is not loaded by LyX
1596 if (params_.main_font_encoding() == "default")
1597 macros << textcyr_T2A_def;
1598 macros << textcyr_def << '\n';
1601 // non-standard text accents:
1602 if (mustProvide("textcommaabove") || mustProvide("textcommaaboveright") ||
1603 mustProvide("textcommabelow") || mustProvide("textbaltic"))
1604 macros << lyxaccent_def;
1606 if (mustProvide("textcommabelow") || mustProvide("textbaltic"))
1607 macros << textcommabelow_def << '\n';
1609 if (mustProvide("textcommaabove") || mustProvide("textbaltic"))
1610 macros << textcommaabove_def << '\n';
1612 if (mustProvide("textcommaaboveright"))
1613 macros << textcommaaboveright_def << '\n';
1615 if (mustProvide("textbaltic"))
1616 macros << textbaltic_def << '\n';
1618 if (mustProvide("textschwa"))
1619 macros << textschwa_def << '\n';
1621 // split-level fractions
1622 if (mustProvide("xfrac") || mustProvide("smallLetterFrac"))
1623 macros << xfrac_def << '\n';
1625 if (mustProvide("smallLetterFrac"))
1626 macros << smallLetterFrac_def << '\n';
1628 if (mustProvide("lyxmathsym"))
1629 macros << lyxmathsym_def << '\n';
1631 if (mustProvide("cedilla"))
1632 macros << cedilla_def << '\n';
1634 if (mustProvide("subring"))
1635 macros << subring_def << '\n';
1637 if (mustProvide("subdot"))
1638 macros << subdot_def << '\n';
1640 if (mustProvide("subhat"))
1641 macros << subhat_def << '\n';
1643 if (mustProvide("subtilde"))
1644 macros << subtilde_def << '\n';
1646 if (mustProvide("dacute"))
1647 macros << dacute_def << '\n';
1649 if (mustProvide("tipasymb"))
1650 macros << tipasymb_def << '\n';
1652 if (mustProvide("dgrave"))
1653 macros << dgrave_def << '\n';
1655 if (mustProvide("rcap"))
1656 macros << rcap_def << '\n';
1658 if (mustProvide("ogonek"))
1659 macros << ogonek_def << '\n';
1662 if (mustProvide("quotesinglbase"))
1663 macros << quotesinglbase_def << '\n';
1664 if (mustProvide("quotedblbase"))
1665 macros << quotedblbase_def << '\n';
1666 if (mustProvide("guilsinglleft"))
1667 macros << guilsinglleft_def << '\n';
1668 if (mustProvide("guilsinglright"))
1669 macros << guilsinglright_def << '\n';
1670 if (mustProvide("guillemotleft"))
1671 macros << guillemotleft_def << '\n';
1672 if (mustProvide("guillemotright"))
1673 macros << guillemotright_def << '\n';
1674 if (mustProvide("textquotedbl"))
1675 macros << textquotedbl_def << '\n';
1676 if (mustProvide("textquotesinglep")) {
1677 if (runparams_.flavor == OutputParams::XETEX)
1678 macros << textquotesinglep_xetex_def << '\n';
1680 macros << textquotesinglep_luatex_def << '\n';
1682 if (mustProvide("textquotedblp")) {
1683 if (runparams_.flavor == OutputParams::XETEX)
1684 macros << textquotedblp_xetex_def << '\n';
1686 macros << textquotedblp_luatex_def << '\n';
1690 if (mustProvide("binom") && !isRequired("amsmath"))
1691 macros << binom_def << '\n';
1692 if (mustProvide("mathcircumflex"))
1693 macros << mathcircumflex_def << '\n';
1696 if (mustProvide("ParagraphLeftIndent"))
1697 macros << paragraphleftindent_def;
1698 if (mustProvide("NeedLyXFootnoteCode"))
1699 macros << floatingfootnote_def;
1701 // some problems with tex->html converters
1702 if (mustProvide("NeedTabularnewline"))
1703 macros << tabularnewline_def;
1705 // greyed-out environment (note inset)
1706 // the color is specified in the routine
1707 // getColorOptions() to avoid LaTeX-package clashes
1708 if (mustProvide("lyxgreyedout")) {
1709 // We need different version for RTL (#8647)
1710 if (hasRTLLanguage()) {
1711 if (runparams_.flavor == OutputParams::LUATEX)
1713 macros << lyxgreyedout_luartl_babel_def;
1715 macros << lyxgreyedout_luartl_def;
1717 macros << lyxgreyedout_rtl_def;
1719 macros << lyxgreyedout_def;
1722 if (mustProvide("lyxdot"))
1723 macros << lyxdot_def << '\n';
1726 getFloatDefinitions(macros);
1728 if (mustProvide("refstyle"))
1729 macros << lyxref_def << '\n';
1732 if (mustProvide("ct-dvipost")) {
1733 if (isRequired("changebar"))
1734 macros << changetracking_dvipost_cb_def;
1736 macros << changetracking_dvipost_def;
1739 if (mustProvide("ct-xcolor-ulem")) {
1740 streamsize const prec = macros.os().precision(2);
1742 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1743 macros << "\\providecolor{lyxadded}{rgb}{"
1744 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1746 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1747 macros << "\\providecolor{lyxdeleted}{rgb}{"
1748 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1750 macros.os().precision(prec);
1752 macros << changetracking_xcolor_ulem_base_def;
1754 if (isRequired("changebar")) {
1755 if (isRequired("hyperref"))
1756 macros << changetracking_xcolor_ulem_hyperref_cb_def;
1758 macros << changetracking_xcolor_ulem_cb_def;
1760 if (isRequired("hyperref"))
1761 macros << changetracking_xcolor_ulem_hyperref_def;
1763 macros << changetracking_xcolor_ulem_def;
1767 if (mustProvide("ct-tikz-object-sout")) {
1768 if (!mustProvide("ct-xcolor-ulem")) {
1769 streamsize const prec = macros.os().precision(2);
1771 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1772 macros << "\\providecolor{lyxadded}{rgb}{"
1773 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1775 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1776 macros << "\\providecolor{lyxdeleted}{rgb}{"
1777 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1779 macros.os().precision(prec);
1782 macros << changetracking_tikz_object_sout_def;
1784 if (isRequired("changebar")) {
1785 if (isRequired("hyperref"))
1786 macros << changetracking_xcolor_ulem_hyperref_cb_object_def;
1788 macros << changetracking_xcolor_ulem_cb_object_def;
1790 if (isRequired("hyperref"))
1791 macros << changetracking_xcolor_ulem_hyperref_object_def;
1793 macros << changetracking_xcolor_ulem_object_def;
1797 if (mustProvide("ct-none"))
1798 macros << changetracking_none_def;
1800 if (mustProvide("rtloutputdblcol"))
1801 macros << rtloutputdblcol_def;
1803 if (mustProvide("lyxmintcaption"))
1804 macros << lyxmintcaption_def;
1806 return macros.release();
1810 docstring const LaTeXFeatures::getBabelPresettings() const
1812 odocstringstream tmp;
1814 for (Language const * lang : UsedLanguages_)
1815 if (!lang->babel_presettings().empty())
1816 tmp << lang->babel_presettings() << '\n';
1817 if (!params_.language->babel_presettings().empty())
1818 tmp << params_.language->babel_presettings() << '\n';
1820 if (!contains(tmp.str(), '@'))
1823 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1827 docstring const LaTeXFeatures::getBabelPostsettings() const
1829 odocstringstream tmp;
1831 for (Language const * lang : UsedLanguages_)
1832 if (!lang->babel_postsettings().empty())
1833 tmp << lang->babel_postsettings() << '\n';
1834 if (!params_.language->babel_postsettings().empty())
1835 tmp << params_.language->babel_postsettings() << '\n';
1837 if (!contains(tmp.str(), '@'))
1840 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1844 string const LaTeXFeatures::loadAMSPackages() const
1848 if (mustProvide("amsmath")
1849 && params_.use_package("amsmath") != BufferParams::package_off) {
1850 tmp << "\\usepackage{amsmath}\n";
1852 // amsbsy and amstext are already provided by amsmath
1853 if (mustProvide("amsbsy"))
1854 tmp << "\\usepackage{amsbsy}\n";
1855 if (mustProvide("amstext"))
1856 tmp << "\\usepackage{amstext}\n";
1859 if (mustProvide("amsthm"))
1860 tmp << "\\usepackage{amsthm}\n";
1862 if (mustProvide("amssymb")
1863 && params_.use_package("amssymb") != BufferParams::package_off)
1864 tmp << "\\usepackage{amssymb}\n";
1870 docstring const LaTeXFeatures::getTClassPreamble() const
1872 // the text class specific preamble
1873 DocumentClass const & tclass = params_.documentClass();
1874 odocstringstream tcpreamble;
1876 tcpreamble << tclass.preamble();
1878 list<docstring>::const_iterator cit = usedLayouts_.begin();
1879 list<docstring>::const_iterator end = usedLayouts_.end();
1880 for (; cit != end; ++cit)
1881 // For InPreamble layouts, we output the preamble stuff earlier
1882 // (before the layouts). See Paragraph::Private::validate.
1883 if (!tclass[*cit].inpreamble)
1884 tcpreamble << tclass[*cit].preamble();
1886 cit = usedInsetLayouts_.begin();
1887 end = usedInsetLayouts_.end();
1888 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1889 for (; cit != end; ++cit) {
1890 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1891 if (it == ils.end())
1893 tcpreamble << it->second.preamble();
1896 return tcpreamble.str();
1900 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1902 DocumentClass const & tclass = params_.documentClass();
1903 odocstringstream tcpreamble;
1905 tcpreamble << tclass.htmlpreamble();
1907 list<docstring>::const_iterator cit = usedLayouts_.begin();
1908 list<docstring>::const_iterator end = usedLayouts_.end();
1909 for (; cit != end; ++cit)
1910 tcpreamble << tclass[*cit].htmlpreamble();
1912 cit = usedInsetLayouts_.begin();
1913 end = usedInsetLayouts_.end();
1914 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1915 for (; cit != end; ++cit) {
1916 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1917 if (it == ils.end())
1919 tcpreamble << it->second.htmlpreamble();
1922 return tcpreamble.str();
1926 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1928 DocumentClass const & tclass = params_.documentClass();
1929 odocstringstream tcpreamble;
1931 if (mustProvide("noun"))
1932 tcpreamble << lyxnoun_style;
1933 // this isn't exact, but it won't hurt that much if it
1935 if (mustProvide("ulem"))
1936 tcpreamble << lyxstrikeout_style;
1938 tcpreamble << tclass.htmlstyles();
1940 list<docstring>::const_iterator cit = usedLayouts_.begin();
1941 list<docstring>::const_iterator end = usedLayouts_.end();
1942 for (; cit != end; ++cit)
1943 tcpreamble << tclass[*cit].htmlstyle();
1945 cit = usedInsetLayouts_.begin();
1946 end = usedInsetLayouts_.end();
1947 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1948 for (; cit != end; ++cit) {
1949 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1950 if (it == ils.end())
1952 tcpreamble << it->second.htmlstyle();
1955 return tcpreamble.str();
1961 docstring const getFloatI18nPreamble(docstring const & type,
1962 docstring const & name, Language const * lang,
1963 Encoding const & enc, bool const polyglossia)
1965 // Check whether name can be encoded in the buffer encoding
1966 bool encodable = true;
1967 for (size_t i = 0; i < name.size(); ++i) {
1968 if (!enc.encodable(name[i])) {
1974 docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1975 : from_ascii(lang->babel());
1976 docstring const langenc = from_ascii(lang->encoding()->iconvName());
1977 docstring const texenc = from_ascii(lang->encoding()->latexName());
1978 docstring const bufenc = from_ascii(enc.iconvName());
1979 docstring const s1 = docstring(1, 0xF0000);
1980 docstring const s2 = docstring(1, 0xF0001);
1981 docstring const translated = encodable ? name
1982 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1983 + s1 + langenc + s2 + name + s1 + bufenc + s2;
1985 odocstringstream os;
1986 os << "\\addto\\captions" << language
1987 << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1992 docstring const i18npreamble(docstring const & templ, Language const * lang,
1993 Encoding const & enc, bool const polyglossia,
1994 bool const need_fixedwidth)
1999 string preamble = polyglossia ?
2000 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
2001 subst(to_utf8(templ), "$$lang", lang->babel());
2003 string const langenc = lang->encoding()->iconvName();
2004 string const texenc = lang->encoding()->latexName();
2005 string const bufenc = enc.iconvName();
2006 Encoding const * testenc(&enc);
2007 bool lang_fallback = false;
2008 bool ascii_fallback = false;
2009 if (need_fixedwidth && !enc.hasFixedWidth()) {
2010 if (lang->encoding()->hasFixedWidth()) {
2011 testenc = lang->encoding();
2012 lang_fallback = true;
2014 // We need a fixed width encoding, but both the buffer
2015 // encoding and the language encoding are variable
2016 // width. As a last fallback, try to convert to pure
2017 // ASCII using the LaTeX commands defined in unicodesymbols.
2018 testenc = encodings.fromLyXName("ascii");
2021 ascii_fallback = true;
2024 // First and second character of plane 15 (Private Use Area)
2025 string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
2026 string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
2028 // lyx::regex is not unicode-safe.
2029 // Should use QRegExp or (boost::u32regex, but that requires ICU)
2030 static regex const reg("_\\(([^\\)]+)\\)");
2032 while (regex_search(preamble, sub, reg)) {
2033 string const key = sub.str(1);
2034 docstring const name = lang->translateLayout(key);
2035 // Check whether name can be encoded in the buffer encoding
2036 bool encodable = true;
2037 for (size_t i = 0; i < name.size() && encodable; ++i)
2038 if (!testenc->encodable(name[i]))
2041 if (encodable && !lang_fallback)
2042 translated = to_utf8(name);
2043 else if (ascii_fallback)
2044 translated = to_ascii(testenc->latexString(name).first);
2046 translated = "\\inputencoding{" + texenc + "}"
2047 + s1 + langenc + s2 + to_utf8(name)
2049 preamble = subst(preamble, sub.str(), translated);
2051 return from_utf8(preamble);
2057 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel,
2058 bool use_polyglossia, bool use_minted) const
2060 DocumentClass const & tclass = params_.documentClass();
2061 // collect preamble snippets in a set to prevent multiple identical
2062 // commands (would happen if e.g. both theorem and theorem* are used)
2063 set<docstring> snippets;
2064 typedef LanguageList::const_iterator lang_it;
2065 lang_it const lbeg = UsedLanguages_.begin();
2066 lang_it const lend = UsedLanguages_.end();
2067 list<docstring>::const_iterator cit = usedLayouts_.begin();
2068 list<docstring>::const_iterator end = usedLayouts_.end();
2069 for (; cit != end; ++cit) {
2070 // language dependent commands (once per document)
2071 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
2072 buffer().language(),
2073 buffer().params().encoding(),
2074 use_polyglossia, false));
2075 // commands for language changing (for multilanguage documents)
2076 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
2077 snippets.insert(i18npreamble(
2078 tclass[*cit].babelpreamble(),
2079 buffer().language(),
2080 buffer().params().encoding(),
2081 use_polyglossia, false));
2082 for (lang_it lit = lbeg; lit != lend; ++lit)
2083 snippets.insert(i18npreamble(
2084 tclass[*cit].babelpreamble(),
2086 buffer().params().encoding(),
2087 use_polyglossia, false));
2090 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
2091 FloatList const & floats = params_.documentClass().floats();
2092 UsedFloats::const_iterator fit = usedFloats_.begin();
2093 UsedFloats::const_iterator fend = usedFloats_.end();
2094 for (; fit != fend; ++fit) {
2095 Floating const & fl = floats.getType(fit->first);
2096 // we assume builtin floats are translated
2097 if (fl.isPredefined())
2099 docstring const type = from_ascii(fl.floattype());
2100 docstring const flname = from_utf8(fl.name());
2101 docstring name = buffer().language()->translateLayout(fl.name());
2102 // only request translation if we have a real translation
2103 // (that differs from the source)
2105 snippets.insert(getFloatI18nPreamble(
2106 type, name, buffer().language(),
2107 buffer().params().encoding(),
2109 for (lang_it lit = lbeg; lit != lend; ++lit) {
2110 string const code = (*lit)->code();
2111 name = (*lit)->translateLayout(fl.name());
2112 // we assume we have a suitable translation if
2113 // either the language is English (we need to
2114 // translate into English if English is a secondary
2115 // language) or if translateIfPossible returns
2116 // something different to the English source.
2117 bool const have_translation =
2118 (flname != name || contains(code, "en"));
2119 if (have_translation)
2120 snippets.insert(getFloatI18nPreamble(
2122 buffer().params().encoding(),
2128 cit = usedInsetLayouts_.begin();
2129 end = usedInsetLayouts_.end();
2130 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
2131 for (; cit != end; ++cit) {
2132 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
2133 if (it == ils.end())
2135 // The listings package does not work with variable width
2136 // encodings, only with fixed width encodings. Therefore we
2137 // need to force a fixed width encoding for
2138 // \lstlistlistingname and \lstlistingname (bug 9382).
2139 // This needs to be consistent with InsetListings::latex()
2140 // rsp. InsetListings::forcedEncoding().
2141 bool const need_fixedwidth = !use_minted &&
2142 !runparams_.isFullUnicode() &&
2143 buffer().params().encoding().package() != Encoding::japanese &&
2144 it->second.fixedwidthpreambleencoding();
2145 // language dependent commands (once per document)
2146 snippets.insert(i18npreamble(it->second.langpreamble(),
2147 buffer().language(),
2148 buffer().params().encoding(),
2149 use_polyglossia, need_fixedwidth));
2150 // commands for language changing (for multilanguage documents)
2151 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
2152 snippets.insert(i18npreamble(
2153 it->second.babelpreamble(),
2154 buffer().language(),
2155 buffer().params().encoding(),
2156 use_polyglossia, need_fixedwidth));
2157 for (lang_it lit = lbeg; lit != lend; ++lit)
2158 snippets.insert(i18npreamble(
2159 it->second.babelpreamble(),
2161 buffer().params().encoding(),
2162 use_polyglossia, need_fixedwidth));
2166 odocstringstream tcpreamble;
2167 set<docstring>::const_iterator const send = snippets.end();
2168 set<docstring>::const_iterator it = snippets.begin();
2169 for (; it != send; ++it)
2171 return tcpreamble.str();
2175 docstring const LaTeXFeatures::getLyXSGMLEntities() const
2177 // Definition of entities used in the document that are LyX related.
2178 odocstringstream entities;
2180 if (mustProvide("lyxarrow")) {
2181 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
2184 return entities.str();
2188 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
2190 odocstringstream sgmlpreamble;
2192 docstring const basename(from_utf8(onlyPath(fname)));
2194 FileMap::const_iterator end = IncludedFiles_.end();
2195 for (FileMap::const_iterator fi = IncludedFiles_.begin();
2198 sgmlpreamble << "\n<!ENTITY " << fi->first
2199 << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
2200 << makeRelPath(from_utf8(fi->second), basename) << "\">";
2202 return sgmlpreamble.str();
2206 void LaTeXFeatures::showStruct() const
2208 lyxerr << "LyX needs the following commands when LaTeXing:"
2209 << "\n***** Packages:" << getPackages()
2210 << "\n***** Macros:" << to_utf8(getMacros().str)
2211 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
2212 << "\n***** done." << endl;
2216 Buffer const & LaTeXFeatures::buffer() const
2222 void LaTeXFeatures::setBuffer(Buffer const & buffer)
2228 BufferParams const & LaTeXFeatures::bufferParams() const
2234 void LaTeXFeatures::getFloatDefinitions(otexstream & os) const
2236 FloatList const & floats = params_.documentClass().floats();
2238 // Here we will output the code to create the needed float styles.
2239 // We will try to do this as minimal as possible.
2240 // \floatstyle{ruled}
2241 // \newfloat{algorithm}{htbp}{loa}
2242 // \providecommand{\algorithmname}{Algorithm}
2243 // \floatname{algorithm}{\protect\algorithmname}
2244 UsedFloats::const_iterator cit = usedFloats_.begin();
2245 UsedFloats::const_iterator end = usedFloats_.end();
2246 for (; cit != end; ++cit) {
2247 Floating const & fl = floats.getType(cit->first);
2249 // For builtin floats we do nothing.
2250 if (fl.isPredefined())
2253 // We have to special case "table" and "figure"
2254 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
2255 // Output code to modify "table" or "figure"
2256 // but only if builtin == false
2257 // and that have to be true at this point in the
2259 docstring const type = from_ascii(fl.floattype());
2260 docstring const placement = from_ascii(fl.placement());
2261 docstring const style = from_ascii(fl.style());
2262 if (!style.empty()) {
2263 os << "\\floatstyle{" << style << "}\n"
2264 << "\\restylefloat{" << type << "}\n";
2266 if (!placement.empty()) {
2267 os << "\\floatplacement{" << type << "}{"
2268 << placement << "}\n";
2271 // The other non builtin floats.
2273 docstring const type = from_ascii(fl.floattype());
2274 docstring const placement = from_ascii(fl.placement());
2275 docstring const ext = from_ascii(fl.ext());
2276 docstring const within = from_ascii(fl.within());
2277 docstring const style = from_ascii(fl.style());
2278 docstring const name =
2279 buffer().language()->translateLayout(fl.name());
2280 os << "\\floatstyle{" << style << "}\n"
2281 << "\\newfloat{" << type << "}{" << placement
2282 << "}{" << ext << '}';
2283 if (!within.empty())
2284 os << '[' << within << ']';
2286 << "\\providecommand{\\" << type << "name}{"
2288 << "\\floatname{" << type << "}{\\protect\\"
2289 << type << "name}\n";
2291 // What missing here is to code to minimalize the code
2292 // output so that the same floatstyle will not be
2293 // used several times, when the same style is still in
2297 // The subfig package is loaded later
2298 os << "\n\\AtBeginDocument{\\newsubfloat{" << from_ascii(fl.floattype()) << "}}\n";
2303 void LaTeXFeatures::resolveAlternatives()
2305 for (Features::iterator it = features_.begin(); it != features_.end();) {
2306 if (contains(*it, '|')) {
2307 vector<string> const alternatives = getVectorFromString(*it, "|");
2308 vector<string>::const_iterator const end = alternatives.end();
2309 vector<string>::const_iterator ita = alternatives.begin();
2310 // Is any alternative already required? => use that
2311 for (; ita != end; ++ita) {
2312 if (isRequired(*ita))
2315 // Is any alternative available? => use the first one
2318 for (ita = alternatives.begin(); ita != end; ++ita) {
2319 if (isAvailable(*ita)) {
2325 // This will not work, but not requiring something
2326 // would be more confusing
2328 require(alternatives.front());
2329 features_.erase(it);
2330 it = features_.begin();
2337 void LaTeXFeatures::expandMultiples()
2339 for (Features::iterator it = features_.begin(); it != features_.end();) {
2340 if (contains(*it, ',')) {
2341 vector<string> const multiples = getVectorFromString(*it, ",");
2342 vector<string>::const_iterator const end = multiples.end();
2343 vector<string>::const_iterator itm = multiples.begin();
2344 // Do nothing if any multiple is already required
2345 for (; itm != end; ++itm) {
2346 if (!isRequired(*itm))
2349 features_.erase(it);
2350 it = features_.begin();