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 "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}");
68 static docstring const lyx_hyperref_def = from_ascii(
69 "\\providecommand{\\LyX}{\\texorpdfstring%\n"
70 " {L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}\n"
73 static docstring const noun_def = from_ascii(
74 "\\newcommand{\\noun}[1]{\\textsc{#1}}");
76 static docstring const lyxarrow_def = from_ascii(
77 "\\DeclareRobustCommand*{\\lyxarrow}{%\n"
79 "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
80 "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}");
82 // for quotes without babel. This does not give perfect results, but
83 // anybody serious about non-english quotes should use babel (JMarc).
85 static docstring const quotedblbase_def = from_ascii(
86 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
87 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
88 " \\penalty10000\\hskip0em\\relax%\n"
91 static docstring const quotesinglbase_def = from_ascii(
92 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
93 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
94 " \\penalty10000\\hskip0em\\relax%\n"
97 static docstring const guillemotleft_def = from_ascii(
98 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
99 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
100 "\\penalty10000\\hskip0pt\\relax%\n"
103 static docstring const guillemotright_def = from_ascii(
104 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
105 " \\penalty10000\\hskip0pt%\n"
106 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
109 static docstring const guilsinglleft_def = from_ascii(
110 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
111 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
112 " \\penalty10000\\hskip0pt\\relax%\n"
115 static docstring const guilsinglright_def = from_ascii(
116 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
117 " \\penalty10000\\hskip0pt%\n"
118 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
121 static docstring const textquotedbl_def = from_ascii(
122 "\\DeclareTextSymbolDefault{\\textquotedbl}{T1}");
124 static docstring const textquotedblp_xetex_def = from_ascii(
125 "\\providecommand\\textquotedblplain{%\n"
126 " \\bgroup\\addfontfeatures{Mapping=}\\char`\\\"\\egroup}");
128 static docstring const textquotedblp_luatex_def = from_ascii(
129 "\\providecommand\\textquotedblplain{%\n"
130 " \\bgroup\\addfontfeatures{RawFeature=-tlig}\\char`\\\"\\egroup}");
132 static docstring const textquotesinglep_xetex_def = from_ascii(
133 "\\providecommand\\textquotesingleplain{%\n"
134 " \\bgroup\\addfontfeatures{Mapping=}\\char`\\\'\\egroup}");
136 static docstring const textquotesinglep_luatex_def = from_ascii(
137 "\\providecommand\\textquotesingleplain{%\n"
138 " \\bgroup\\addfontfeatures{RawFeature=-tlig}\\char`\\\'\\egroup}");
140 static docstring const paragraphleftindent_def = from_ascii(
141 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
143 " \\begin{list}{}{%\n"
144 " \\setlength{\\topsep}{0pt}%\n"
145 " \\addtolength{\\leftmargin}{#1}\n"
146 // ho hum, yet more things commented out with no hint as to why they
147 // weren't just removed
148 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
149 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
150 // "%% \\setlength\\listparindent\\parindent%\n"
151 // "%% \\setlength\\itemindent\\parindent%\n"
152 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
158 static docstring const floatingfootnote_def = from_ascii(
159 "%% Special footnote code from the package 'stblftnt.sty'\n"
160 "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
161 "\\let\\SF@@footnote\\footnote\n"
162 "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
163 " \\expandafter\\SF@@footnote\n"
165 " \\expandafter\\SF@gobble@opt\n"
168 "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
169 " \\SF@gobble@twobracket\n"
172 "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
173 " \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
174 "\\def\\SF@gobble@twobracket[#1]#2{}\n");
176 static docstring const binom_def = from_ascii(
177 "%% Binom macro for standard LaTeX users\n"
178 "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n");
180 static docstring const mathcircumflex_def = from_ascii(
181 "%% For printing a cirumflex inside a formula\n"
182 "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n");
184 static docstring const tabularnewline_def = from_ascii(
185 "%% Because html converters don't know tabularnewline\n"
186 "\\providecommand{\\tabularnewline}{\\\\}\n");
188 static docstring const lyxgreyedout_def = from_ascii(
189 "%% The greyedout annotation environment\n"
190 "\\newenvironment{lyxgreyedout}\n"
191 " {\\textcolor{note_fontcolor}\\bgroup\\ignorespaces}\n"
192 " {\\ignorespacesafterend\\egroup}\n");
194 // We want to omit the file extension for includegraphics, but this does not
195 // work when the filename contains other dots.
196 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
197 static docstring const lyxdot_def = from_ascii(
198 "%% A simple dot to overcome graphicx limitations\n"
199 "\\newcommand{\\lyxdot}{.}\n");
201 static docstring const changetracking_dvipost_def = from_ascii(
202 "%% Change tracking with dvipost\n"
204 "\\dvipost{osstart color push Red}\n"
205 "\\dvipost{osend color pop}\n"
206 "\\dvipost{cbstart color push Blue}\n"
207 "\\dvipost{cbend color pop}\n"
208 "\\DeclareRobustCommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
209 "\\DeclareRobustCommand{\\lyxdeleted}[3]{%\n"
210 "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n");
212 static docstring const changetracking_xcolor_ulem_def = from_ascii(
213 "%% Change tracking with ulem\n"
214 "\\DeclareRobustCommand{\\lyxadded}[3]{{\\color{lyxadded}{}#3}}\n"
215 "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\lyxsout{#3}}}\n"
216 "\\DeclareRobustCommand{\\lyxsout}[1]{\\ifx\\\\#1\\else\\sout{#1}\\fi}\n");
218 static docstring const changetracking_xcolor_ulem_hyperref_def = from_ascii(
219 "%% Change tracking with ulem\n"
220 "\\DeclareRobustCommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}{}}{}#3}}\n"
221 "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\lyxsout{#3}}{}}}\n"
222 "\\DeclareRobustCommand{\\lyxsout}[1]{\\ifx\\\\#1\\else\\sout{#1}\\fi}\n");
224 static docstring const changetracking_tikz_math_sout_def = from_ascii(
225 "%% Strike out display math with tikz\n"
226 "\\usepackage{tikz}\n"
227 "\\usetikzlibrary{calc}\n"
228 "\\newcommand{\\lyxmathsout}[1]{%\n"
229 " \\tikz[baseline=(math.base)]{\n"
230 " \\node[inner sep=0pt,outer sep=0pt](math){#1};\n"
231 " \\draw($(math.south west)+(2em,.5em)$)--($(math.north east)-(2em,.5em)$);\n"
235 static docstring const changetracking_none_def = from_ascii(
236 "\\newcommand{\\lyxadded}[3]{#3}\n"
237 "\\newcommand{\\lyxdeleted}[3]{}\n");
239 static docstring const textgreek_LGR_def = from_ascii(
240 "\\DeclareFontEncoding{LGR}{}{}\n");
241 static docstring const textgreek_def = from_ascii(
242 "\\DeclareRobustCommand{\\greektext}{%\n"
243 " \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
244 "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
245 "\\ProvideTextCommand{\\~}{LGR}[1]{\\char126#1}\n");
247 static docstring const textcyr_T2A_def = from_ascii(
248 "\\InputIfFileExists{t2aenc.def}{}{%\n"
249 " \\errmessage{File `t2aenc.def' not found: Cyrillic script not supported}}\n");
250 static docstring const textcyr_def = from_ascii(
251 "\\DeclareRobustCommand{\\cyrtext}{%\n"
252 " \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
253 "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n");
255 static docstring const lyxmathsym_def = from_ascii(
256 "\\newcommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
257 " \\text{\\ifx\\math@version\\b@ld\\bfseries\\fi#1}\\endgroup\\else#1\\fi}\n");
259 static docstring const papersizedvi_def = from_ascii(
260 "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n");
262 static docstring const papersizepdf_def = from_ascii(
263 "\\pdfpageheight\\paperheight\n"
264 "\\pdfpagewidth\\paperwidth\n");
266 static docstring const papersizepdflua_def = from_ascii(
267 "% Backwards compatibility for LuaTeX < 0.90\n"
268 "\\@ifundefined{pageheight}{\\let\\pageheight\\pdfpageheight}{}\n"
269 "\\@ifundefined{pagewidth}{\\let\\pagewidth\\pdfpagewidth}{}\n"
270 "\\pageheight\\paperheight\n"
271 "\\pagewidth\\paperwidth\n");
273 static docstring const cedilla_def = from_ascii(
274 "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
275 "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n");
277 static docstring const subring_def = from_ascii(
278 "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
279 "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n");
281 static docstring const subdot_def = from_ascii(
282 "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
283 "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n");
285 static docstring const subhat_def = from_ascii(
286 "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
287 "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n");
289 static docstring const subtilde_def = from_ascii(
290 "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
291 "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n");
293 static docstring const dacute_def = from_ascii(
294 "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n");
296 static docstring const tipasymb_def = from_ascii(
297 "\\DeclareFontEncoding{T3}{}{}\n"
298 "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n");
300 static docstring const dgrave_def = from_ascii(
301 "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n");
303 static docstring const rcap_def = from_ascii(
304 "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n");
306 static docstring const ogonek_def = from_ascii(
307 "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
308 " \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
309 " \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
310 " \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
311 "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n");
313 static docstring const lyxaccent_def = from_ascii(
314 "%% custom text accent \\LyxTextAccent[<rise value (length)>]{<accent>}{<base>}\n"
315 "\\newcommand*{\\LyxTextAccent}[3][0ex]{%\n"
316 " \\hmode@bgroup\\ooalign{\\null#3\\crcr\\hidewidth\n"
317 " \\raise#1\\hbox{#2}\\hidewidth}\\egroup}\n"
318 "%% select a font size smaller than the current font size:\n"
319 "\\newcommand{\\LyxAccentSize}[1][\\sf@size]{%\n"
320 " \\check@mathfonts\\fontsize#1\\z@\\math@fontsfalse\\selectfont\n"
323 static docstring const textcommabelow_def = from_ascii(
324 "\\ProvideTextCommandDefault{\\textcommabelow}[1]{%%\n"
325 " \\LyxTextAccent[-.31ex]{\\LyxAccentSize,}{#1}}\n");
327 static docstring const textcommaabove_def = from_ascii(
328 "\\ProvideTextCommandDefault{\\textcommaabove}[1]{%%\n"
329 " \\LyxTextAccent[.5ex]{\\LyxAccentSize`}{#1}}\n");
331 static docstring const textcommaaboveright_def = from_ascii(
332 "\\ProvideTextCommandDefault{\\textcommaaboveright}[1]{%%\n"
333 " \\LyxTextAccent[.5ex]{\\LyxAccentSize\\ '}{#1}}\n");
335 // Baltic languages use a comma-accent instead of a cedilla
336 static docstring const textbaltic_def = from_ascii(
337 "%% use comma accent instead of cedilla for these characters:\n"
338 "\\DeclareTextCompositeCommand{\\c}{T1}{g}{\\textcommaabove{g}}\n"
339 "\\DeclareTextCompositeCommand{\\c}{T1}{G}{\\textcommabelow{G}}\n"
340 "\\DeclareTextCompositeCommand{\\c}{T1}{k}{\\textcommabelow{k}}\n"
341 "\\DeclareTextCompositeCommand{\\c}{T1}{K}{\\textcommabelow{K}}\n"
342 "\\DeclareTextCompositeCommand{\\c}{T1}{l}{\\textcommabelow{l}}\n"
343 "\\DeclareTextCompositeCommand{\\c}{T1}{L}{\\textcommabelow{L}}\n"
344 "\\DeclareTextCompositeCommand{\\c}{T1}{n}{\\textcommabelow{n}}\n"
345 "\\DeclareTextCompositeCommand{\\c}{T1}{N}{\\textcommabelow{N}}\n"
346 "\\DeclareTextCompositeCommand{\\c}{T1}{r}{\\textcommabelow{r}}\n"
347 "\\DeclareTextCompositeCommand{\\c}{T1}{R}{\\textcommabelow{R}}\n");
349 // split-level fractions
350 static docstring const xfrac_def = from_ascii(
351 "\\usepackage{xfrac}\n");
352 static docstring const smallLetterFrac_def = from_ascii(
353 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{default}{text}\n"
354 " {phantom=c, scale-factor=1.0, slash-left-kern=-.05em}\n"
355 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmr}{text}\n"
356 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
357 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmss}{text}\n"
358 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
359 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmr}{text}\n"
360 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
361 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmss}{text}\n"
362 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
363 "\\newcommand{\\smallLetterFrac}[2]{%\n"
364 " {\\UseCollection{xfrac}{smallLetterFrac}\\sfrac{#1}{#2}}}\n");
366 static docstring const lyxref_def = from_ascii(
367 "\\RS@ifundefined{subsecref}\n"
368 " {\\newref{subsec}{name = \\RSsectxt}}\n"
370 "\\RS@ifundefined{thmref}\n"
371 " {\\def\\RSthmtxt{theorem~}\\newref{thm}{name = \\RSthmtxt}}\n"
373 "\\RS@ifundefined{lemref}\n"
374 " {\\def\\RSlemtxt{lemma~}\\newref{lem}{name = \\RSlemtxt}}\n"
377 // Make sure the columns are also outputed as rtl
378 static docstring const rtloutputdblcol_def = from_ascii(
379 "\\def\\@outputdblcol{%\n"
380 " \\if@firstcolumn\n"
381 " \\global \\@firstcolumnfalse\n"
382 " \\global \\setbox\\@leftcolumn \\box\\@outputbox\n"
384 " \\global \\@firstcolumntrue\n"
385 " \\setbox\\@outputbox \\vbox {%\n"
386 " \\hb@xt@\\textwidth {%\n"
387 " \\kern\\textwidth \\kern-\\columnwidth %**\n"
388 " \\hb@xt@\\columnwidth {%\n"
389 " \\box\\@leftcolumn \\hss}%\n"
390 " \\kern-\\textwidth %**\n"
392 " {\\normalcolor\\vrule \\@width\\columnseprule}%\n"
394 " \\kern-\\textwidth %**\n"
395 " \\hb@xt@\\columnwidth {%\n"
396 " \\box\\@outputbox \\hss}%\n"
397 " \\kern-\\columnwidth \\kern\\textwidth %**\n"
400 " \\@combinedblfloats\n"
403 " \\@dblfloatplacement\n"
404 " \\@startdblcolumn\n"
405 " \\@whilesw\\if@fcolmade \\fi\n"
407 " \\@startdblcolumn}%\n"
411 "\\@mparswitchtrue\n");
414 /////////////////////////////////////////////////////////////////////
418 /////////////////////////////////////////////////////////////////////
420 static docstring const lyxnoun_style = from_ascii(
422 " font-variant: small-caps;\n"
426 // this is how it normally renders, but it might not always do so.
427 static docstring const lyxstrikeout_style = from_ascii(
429 " text-decoration: line-through;\n"
433 /////////////////////////////////////////////////////////////////////
437 /////////////////////////////////////////////////////////////////////
440 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
441 OutputParams const & r)
442 : buffer_(&b), params_(p), runparams_(r), in_float_(false),
443 in_deleted_inset_(false)
447 LaTeXFeatures::LangPackage LaTeXFeatures::langPackage() const
449 string const local_lp = bufferParams().lang_package;
451 // Locally, custom is just stored as a string
452 // in bufferParams().lang_package.
453 if (local_lp != "auto"
454 && local_lp != "babel"
455 && local_lp != "default"
456 && local_lp != "none")
457 return LANG_PACK_CUSTOM;
459 if (local_lp == "none")
460 return LANG_PACK_NONE;
462 /* If "auto" is selected, we load polyglossia with non-TeX fonts,
463 * else we select babel.
464 * If babel is selected (either directly or via the "auto"
465 * mechanism), we really do only require it if we have
466 * a language that needs it.
468 bool const polyglossia_required =
469 params_.useNonTeXFonts
470 && isAvailable("polyglossia")
471 && !isProvided("babel")
472 && this->hasOnlyPolyglossiaLanguages();
473 bool const babel_required =
474 !bufferParams().language->babel().empty()
475 || !this->getBabelLanguages().empty();
477 if (local_lp == "auto") {
478 // polyglossia requirement has priority over babel
479 if (polyglossia_required)
480 return LANG_PACK_POLYGLOSSIA;
481 else if (babel_required)
482 return LANG_PACK_BABEL;
485 if (local_lp == "babel") {
487 return LANG_PACK_BABEL;
490 if (local_lp == "default") {
491 switch (lyxrc.language_package_selection) {
493 // polyglossia requirement has priority over babel
494 if (polyglossia_required)
495 return LANG_PACK_POLYGLOSSIA;
496 else if (babel_required)
497 return LANG_PACK_BABEL;
499 case LyXRC::LP_BABEL:
501 return LANG_PACK_BABEL;
503 case LyXRC::LP_CUSTOM:
504 return LANG_PACK_CUSTOM;
506 return LANG_PACK_NONE;
510 return LANG_PACK_NONE;
514 void LaTeXFeatures::require(string const & name)
516 features_.insert(name);
520 void LaTeXFeatures::require(set<string> const & names)
522 features_.insert(names.begin(), names.end());
526 void LaTeXFeatures::useLayout(docstring const & layoutname)
528 useLayout(layoutname, 0);
532 void LaTeXFeatures::useLayout(docstring const & layoutname, int level)
534 // Some code to avoid loops in dependency definition
535 const int maxlevel = 30;
536 if (level > maxlevel) {
537 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
538 << "recursion attained by layout "
539 << to_utf8(layoutname) << endl;
543 DocumentClass const & tclass = params_.documentClass();
544 if (tclass.hasLayout(layoutname)) {
545 // Is this layout already in usedLayouts?
546 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
547 != usedLayouts_.end())
550 Layout const & layout = tclass[layoutname];
551 require(layout.requires());
553 if (!layout.depends_on().empty()) {
554 useLayout(layout.depends_on(), level + 1);
556 usedLayouts_.push_back(layoutname);
558 lyxerr << "LaTeXFeatures::useLayout: layout `"
559 << to_utf8(layoutname) << "' does not exist in this class"
565 void LaTeXFeatures::useInsetLayout(InsetLayout const & lay)
567 docstring const & lname = lay.name();
568 DocumentClass const & tclass = params_.documentClass();
570 // this is a default inset layout, nothing useful here
571 if (!tclass.hasInsetLayout(lname))
573 // Is this layout already in usedInsetLayouts?
574 if (find(usedInsetLayouts_.begin(), usedInsetLayouts_.end(), lname)
575 != usedInsetLayouts_.end())
578 require(lay.requires());
579 usedInsetLayouts_.push_back(lname);
583 bool LaTeXFeatures::isRequired(string const & name) const
585 return features_.find(name) != features_.end();
589 bool LaTeXFeatures::isProvided(string const & name) const
591 if (params_.useNonTeXFonts)
592 return params_.documentClass().provides(name);
594 bool const ot1 = (params_.font_encoding() == "default"
595 || params_.font_encoding() == "OT1");
596 bool const complete = (params_.fontsSans() == "default"
597 && params_.fontsTypewriter() == "default");
598 bool const nomath = (params_.fontsMath() == "default");
599 return params_.documentClass().provides(name)
600 || theLaTeXFonts().getLaTeXFont(
601 from_ascii(params_.fontsRoman())).provides(name, ot1,
604 || theLaTeXFonts().getLaTeXFont(
605 from_ascii(params_.fontsSans())).provides(name, ot1,
608 || theLaTeXFonts().getLaTeXFont(
609 from_ascii(params_.fontsTypewriter())).provides(name, ot1,
612 || theLaTeXFonts().getLaTeXFont(
613 from_ascii(params_.fontsMath())).provides(name, ot1,
616 // TODO: "textbaltic" provided, if the font-encoding is "L7x"
617 // "textgreek" provided, if a language with font-encoding LGR is used in the document
618 // "textcyr" provided, if a language with font-encoding T2A is used in the document
622 bool LaTeXFeatures::mustProvide(string const & name) const
624 return isRequired(name) && !isProvided(name);
628 bool LaTeXFeatures::isAvailable(string const & name)
630 string::size_type const i = name.find("->");
631 if (i != string::npos) {
632 string const from = name.substr(0,i);
633 string const to = name.substr(i+2);
634 //LYXERR0("from=[" << from << "] to=[" << to << "]");
635 return theConverters().isReachable(from, to);
637 return LaTeXPackages::isAvailable(name);
643 void addSnippet(std::list<TexString> & list, TexString ts, bool allow_dupes)
646 // test the absense of duplicates, i.e. elements with same str
647 none_of(list.begin(), list.end(), [&](TexString const & ts2){
648 return ts.str == ts2.str;
651 list.push_back(move(ts));
655 TexString getSnippets(std::list<TexString> const & list)
657 otexstringstream snip;
658 for (TexString const & ts : list)
659 snip << TexString(ts) << '\n';
660 return snip.release();
666 void LaTeXFeatures::addPreambleSnippet(TexString ts, bool allow_dupes)
668 addSnippet(preamble_snippets_, move(ts), allow_dupes);
672 void LaTeXFeatures::addPreambleSnippet(docstring const & str, bool allow_dupes)
674 addSnippet(preamble_snippets_, TexString(str), allow_dupes);
678 void LaTeXFeatures::addCSSSnippet(std::string const & snippet)
680 addSnippet(css_snippets_, TexString(from_ascii(snippet)), false);
684 TexString LaTeXFeatures::getPreambleSnippets() const
686 return getSnippets(preamble_snippets_);
690 docstring LaTeXFeatures::getCSSSnippets() const
692 return getSnippets(css_snippets_).str;
697 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
699 if (!usedFloats_[name])
700 usedFloats_[name] = subfloat;
703 // We only need float.sty if we use non builtin floats, or if we
704 // use the "H" modifier. This includes modified table and
705 // figure floats. (Lgb)
706 Floating const & fl = params_.documentClass().floats().getType(name);
707 if (!fl.floattype().empty() && fl.usesFloatPkg()) {
713 void LaTeXFeatures::useLanguage(Language const * lang)
715 if (!lang->babel().empty() || !lang->polyglossia().empty())
716 UsedLanguages_.insert(lang);
717 if (!lang->requires().empty())
718 require(lang->requires());
719 // CJK languages do not have a babel name.
720 // They use the CJK package
721 if (lang->encoding()->package() == Encoding::CJK)
723 // japanese package is special
724 if (lang->encoding()->package() == Encoding::japanese)
729 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
731 IncludedFiles_[key] = name;
735 bool LaTeXFeatures::hasLanguages() const
737 return !UsedLanguages_.empty();
741 bool LaTeXFeatures::hasOnlyPolyglossiaLanguages() const
743 // first the main language
744 if (params_.language->polyglossia().empty())
746 // now the secondary languages
747 LanguageList::const_iterator const begin = UsedLanguages_.begin();
748 for (LanguageList::const_iterator cit = begin;
749 cit != UsedLanguages_.end();
751 if ((*cit)->polyglossia().empty())
758 bool LaTeXFeatures::hasPolyglossiaExclusiveLanguages() const
760 // first the main language
761 if (params_.language->isPolyglossiaExclusive())
763 // now the secondary languages
764 LanguageList::const_iterator const begin = UsedLanguages_.begin();
765 for (LanguageList::const_iterator cit = begin;
766 cit != UsedLanguages_.end();
768 if ((*cit)->isPolyglossiaExclusive())
775 vector<string> LaTeXFeatures::getPolyglossiaExclusiveLanguages() const
777 vector<string> result;
778 // first the main language
779 if (params_.language->isPolyglossiaExclusive())
780 result.push_back(params_.language->display());
781 // now the secondary languages
782 LanguageList::const_iterator const begin = UsedLanguages_.begin();
783 for (LanguageList::const_iterator cit = begin;
784 cit != UsedLanguages_.end();
786 if ((*cit)->isPolyglossiaExclusive())
787 result.push_back((*cit)->display());
793 vector<string> LaTeXFeatures::getBabelExclusiveLanguages() const
795 vector<string> result;
796 // first the main language
797 if (params_.language->isBabelExclusive())
798 result.push_back(params_.language->display());
799 // now the secondary languages
800 LanguageList::const_iterator const begin = UsedLanguages_.begin();
801 for (LanguageList::const_iterator cit = begin;
802 cit != UsedLanguages_.end();
804 if ((*cit)->isBabelExclusive())
805 result.push_back((*cit)->display());
811 string LaTeXFeatures::getBabelLanguages() const
813 ostringstream languages;
816 LanguageList::const_iterator const begin = UsedLanguages_.begin();
817 for (LanguageList::const_iterator cit = begin;
818 cit != UsedLanguages_.end();
820 if ((*cit)->babel().empty())
826 languages << (*cit)->babel();
828 return languages.str();
832 set<string> LaTeXFeatures::getPolyglossiaLanguages() const
834 set<string> languages;
836 LanguageList::const_iterator const begin = UsedLanguages_.begin();
837 for (LanguageList::const_iterator cit = begin;
838 cit != UsedLanguages_.end();
840 // We do not need the variants here
841 languages.insert((*cit)->polyglossia());
847 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
849 // This does only find encodings of languages supported by babel, but
850 // that does not matter since we don't have a language with an
851 // encoding supported by inputenc but without babel support.
852 set<string> encodings;
853 LanguageList::const_iterator it = UsedLanguages_.begin();
854 LanguageList::const_iterator end = UsedLanguages_.end();
855 for (; it != end; ++it)
856 if ((*it)->encoding()->latexName() != doc_encoding &&
857 ((*it)->encoding()->package() == Encoding::inputenc
858 || (*it)->encoding()->package() == Encoding::japanese))
859 encodings.insert((*it)->encoding()->latexName());
864 void LaTeXFeatures::getFontEncodings(vector<string> & encodings) const
866 // these must be loaded if glyphs of this script are used
867 // unless a language providing them is used in the document
868 if (mustProvide("textgreek")
869 && find(encodings.begin(), encodings.end(), "LGR") == encodings.end())
870 encodings.insert(encodings.begin(), "LGR");
871 if (mustProvide("textcyr")
872 && find(encodings.begin(), encodings.end(), "T2A") == encodings.end())
873 encodings.insert(encodings.begin(), "T2A");
875 LanguageList::const_iterator it = UsedLanguages_.begin();
876 LanguageList::const_iterator end = UsedLanguages_.end();
877 for (; it != end; ++it)
878 if (!(*it)->fontenc().empty()
879 && ascii_lowercase((*it)->fontenc()) != "none") {
880 vector<string> extraencs = getVectorFromString((*it)->fontenc());
881 vector<string>::const_iterator fit = extraencs.begin();
882 for (; fit != extraencs.end(); ++fit) {
883 if (find(encodings.begin(), encodings.end(), *fit) == encodings.end())
884 encodings.insert(encodings.begin(), *fit);
891 char const * simplefeatures[] = {
892 // note that the package order here will be the same in the LaTeX-output
899 // subfig is handled in BufferParams.cpp
903 /*For a successful cooperation of the `wrapfig' package with the
904 `float' package you should load the `wrapfig' package *after*
905 the `float' package. See the caption package documentation
936 // listings is handled in BufferParams.cpp
957 char const * bibliofeatures[] = {
958 // Known bibliography packages (will be loaded before natbib)
974 int const nb_bibliofeatures = sizeof(bibliofeatures) / sizeof(char const *);
976 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
981 string const LaTeXFeatures::getColorOptions() const
983 ostringstream colors;
985 // Handling the color packages separately is needed to be able to load them
986 // before babel when hyperref is loaded with the colorlinks option
987 // for more info see Bufferparams.cpp
990 if (mustProvide("color") || mustProvide("xcolor")) {
991 string const package =
992 (mustProvide("xcolor") ? "xcolor" : "color");
993 if (params_.graphics_driver == "default"
994 || params_.graphics_driver == "none")
995 colors << "\\usepackage{" << package << "}\n";
997 colors << "\\usepackage["
998 << params_.graphics_driver
999 << "]{" << package << "}\n";
1002 // pdfcolmk must be loaded after color
1003 if (mustProvide("pdfcolmk"))
1004 colors << "\\usepackage{pdfcolmk}\n";
1006 // the following 3 color commands must be set after color
1007 // is loaded and before pdfpages, therefore add the command
1008 // here define the set color
1009 if (mustProvide("pagecolor")) {
1010 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
1011 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
1012 // set the page color
1013 colors << "\\pagecolor{page_backgroundcolor}\n";
1016 if (mustProvide("fontcolor")) {
1017 colors << "\\definecolor{document_fontcolor}{rgb}{";
1018 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
1020 colors << "\\color{document_fontcolor}\n";
1023 if (mustProvide("lyxgreyedout")) {
1024 colors << "\\definecolor{note_fontcolor}{rgb}{";
1025 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
1026 // the color will be set together with the definition of
1027 // the lyxgreyedout environment (see lyxgreyedout_def)
1030 // color for shaded boxes
1031 if (isRequired("framed") && mustProvide("color")) {
1032 colors << "\\definecolor{shadecolor}{rgb}{";
1033 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
1034 // this color is automatically used by the LaTeX-package "framed"
1037 return colors.str();
1041 string const LaTeXFeatures::getPackageOptions() const
1043 ostringstream packageopts;
1044 // Output all the package option stuff we have been asked to do.
1045 map<string, string>::const_iterator it =
1046 params_.documentClass().packageOptions().begin();
1047 map<string, string>::const_iterator en =
1048 params_.documentClass().packageOptions().end();
1049 for (; it != en; ++it)
1050 if (mustProvide(it->first))
1051 packageopts << "\\PassOptionsToPackage{" << it->second << "}"
1052 << "{" << it->first << "}\n";
1053 return packageopts.str();
1057 string const LaTeXFeatures::getPackages() const
1059 ostringstream packages;
1061 // FIXME: currently, we can only load packages and macros known
1063 // However, with the Require tag of layouts/custom insets,
1064 // also unknown packages can be requested. They are silently
1065 // swallowed now. We should change this eventually.
1067 // These are all the 'simple' includes. i.e
1068 // packages which we just \usepackage{package}
1069 for (int i = 0; i < nb_simplefeatures; ++i) {
1070 if (mustProvide(simplefeatures[i]))
1071 packages << "\\usepackage{" << simplefeatures[i] << "}\n";
1074 // The rest of these packages are somewhat more complicated
1075 // than those above.
1077 // The tipa package and its extensions (tipx, tone) must not
1078 // be loaded with non-TeX fonts, since fontspec includes the
1079 // respective macros
1080 if (mustProvide("tipa") && !params_.useNonTeXFonts)
1081 packages << "\\usepackage{tipa}\n";
1082 if (mustProvide("tipx") && !params_.useNonTeXFonts)
1083 packages << "\\usepackage{tipx}\n";
1084 if (mustProvide("extraipa") && !params_.useNonTeXFonts)
1085 packages << "\\usepackage{extraipa}\n";
1086 if (mustProvide("tone") && !params_.useNonTeXFonts)
1087 packages << "\\usepackage{tone}\n";
1089 // if fontspec or newtxmath is used, AMS packages have to be loaded
1090 // before fontspec (in BufferParams)
1091 string const amsPackages = loadAMSPackages();
1092 bool const ot1 = (params_.font_encoding() == "default" || params_.font_encoding() == "OT1");
1093 bool const use_newtxmath =
1094 theLaTeXFonts().getLaTeXFont(from_ascii(params_.fontsMath())).getUsedPackage(
1095 ot1, false, false) == "newtxmath";
1097 if (!params_.useNonTeXFonts && !use_newtxmath && !amsPackages.empty())
1098 packages << amsPackages;
1100 if (mustProvide("cancel") &&
1101 params_.use_package("cancel") != BufferParams::package_off)
1102 packages << "\\usepackage{cancel}\n";
1104 // marvosym and bbding both define the \Cross macro
1105 if (mustProvide("marvosym")) {
1106 if (mustProvide("bbding"))
1107 packages << "\\let\\Cross\\relax\n";
1108 packages << "\\usepackage{marvosym}\n";
1111 // accents must be loaded after amsmath
1112 if (mustProvide("accents") &&
1113 params_.use_package("accents") != BufferParams::package_off)
1114 packages << "\\usepackage{accents}\n";
1116 // mathdots must be loaded after amsmath
1117 if (mustProvide("mathdots") &&
1118 params_.use_package("mathdots") != BufferParams::package_off)
1119 packages << "\\usepackage{mathdots}\n";
1121 // yhmath must be loaded after amsmath
1122 if (mustProvide("yhmath") &&
1123 params_.use_package("yhmath") != BufferParams::package_off)
1124 packages << "\\usepackage{yhmath}\n";
1126 // stmaryrd must be loaded after amsmath
1127 if (mustProvide("stmaryrd") &&
1128 params_.use_package("stmaryrd") != BufferParams::package_off)
1129 packages << "\\usepackage{stmaryrd}\n";
1131 if (mustProvide("stackrel") &&
1132 params_.use_package("stackrel") != BufferParams::package_off)
1133 packages << "\\usepackage{stackrel}\n";
1135 if (mustProvide("undertilde") &&
1136 params_.use_package("undertilde") != BufferParams::package_off)
1137 packages << "\\usepackage{undertilde}\n";
1139 // [x]color and pdfcolmk are handled in getColorOptions() above
1142 if (isRequired("makeidx") || isRequired("splitidx")) {
1143 if (!isProvided("makeidx") && !isRequired("splitidx"))
1144 packages << "\\usepackage{makeidx}\n";
1145 if (mustProvide("splitidx"))
1146 packages << "\\usepackage{splitidx}\n";
1147 packages << "\\makeindex\n";
1151 if (mustProvide("graphicx") && params_.graphics_driver != "none") {
1152 if (params_.graphics_driver == "default")
1153 packages << "\\usepackage{graphicx}\n";
1155 packages << "\\usepackage["
1156 << params_.graphics_driver
1160 // lyxskak.sty --- newer chess support based on skak.sty
1161 if (mustProvide("chess"))
1162 packages << "\\usepackage[ps,mover]{lyxskak}\n";
1165 if (mustProvide("setspace") && !isProvided("SetSpace"))
1166 packages << "\\usepackage{setspace}\n";
1168 // we need to assure that mhchem is loaded before esint and every other
1169 // package that redefines command of amsmath because mhchem loads amlatex
1170 // (this info is from the author of mhchem from June 2013)
1171 if (mustProvide("mhchem") &&
1172 params_.use_package("mhchem") != BufferParams::package_off)
1173 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
1174 "\\usepackage{mhchem}\n";
1176 // wasysym is a simple feature, but it must be after amsmath if both
1178 // wasysym redefines some integrals (e.g. iint) from amsmath. That
1179 // leads to inconsistent integrals. We only load this package if
1180 // the document does not contain integrals (then isRequired("esint")
1181 // is false) or if esint is used, since esint redefines all relevant
1182 // integral symbols from wasysym and amsmath.
1183 // See http://www.lyx.org/trac/ticket/1942
1184 if (mustProvide("wasysym") &&
1185 params_.use_package("wasysym") != BufferParams::package_off &&
1186 (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
1187 packages << "\\usepackage{wasysym}\n";
1189 // esint must be after amsmath (and packages requiring amsmath, like mhchem)
1190 // and wasysym, since it will redeclare inconsistent integral symbols
1191 if (mustProvide("esint") &&
1192 params_.use_package("esint") != BufferParams::package_off)
1193 packages << "\\usepackage{esint}\n";
1195 // Known bibliography packages (simple \usepackage{package})
1196 for (int i = 0; i < nb_bibliofeatures; ++i) {
1197 if (mustProvide(bibliofeatures[i]))
1198 packages << "\\usepackage{"
1199 << bibliofeatures[i] << "}\n";
1202 // Compatibility between achicago and natbib
1203 if (mustProvide("achicago") && mustProvide("natbib"))
1204 packages << "\\let\\achicagobib\\thebibliography\n";
1207 // Some classes load natbib themselves, but still allow (or even require)
1208 // plain numeric citations (ReVTeX is such a case, see bug 5182).
1209 // This special case is indicated by the "natbib-internal" key.
1210 if (mustProvide("natbib") && !isProvided("natbib-internal")) {
1211 packages << "\\usepackage[";
1212 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
1213 packages << "numbers";
1215 packages << "authoryear";
1216 if (!params_.biblio_opts.empty())
1217 packages << ',' << params_.biblio_opts;
1218 packages << "]{natbib}\n";
1221 // Compatibility between achicago and natbib
1222 if (mustProvide("achicago") && mustProvide("natbib")) {
1223 packages << "\\let\\thebibliography\\achicagobib\n";
1224 packages << "\\let\\SCcite\\astroncite\n";
1225 packages << "\\let\\UnexpandableProtect\\protect\n";
1228 // jurabib -- we need version 0.6 at least.
1229 if (mustProvide("jurabib")) {
1230 packages << "\\usepackage";
1231 if (!params_.biblio_opts.empty())
1232 packages << '[' << params_.biblio_opts << ']';
1233 packages << "{jurabib}[2004/01/25]\n";
1236 // opcit -- we pass custombst as we output \bibliographystyle ourselves
1237 if (mustProvide("opcit")) {
1238 if (isRequired("hyperref"))
1239 packages << "\\usepackage[custombst,hyperref]{opcit}\n";
1241 packages << "\\usepackage[custombst]{opcit}\n";
1244 // xargs -- we need version 1.09 at least
1245 if (mustProvide("xargs"))
1246 packages << "\\usepackage{xargs}[2008/03/08]\n";
1248 if (mustProvide("xy"))
1249 packages << "\\usepackage[all]{xy}\n";
1251 if (mustProvide("feyn"))
1252 packages << "\\usepackage{feyn}\n"; //Diagram
1254 if (mustProvide("ulem"))
1255 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
1256 "\\usepackage{ulem}\n";
1258 if (mustProvide("nomencl")) {
1259 // Make it work with the new and old version of the package,
1260 // but don't use the compatibility option since it is
1261 // incompatible to other packages.
1262 packages << "\\usepackage{nomencl}\n"
1263 "% the following is useful when we have the old nomencl.sty package\n"
1264 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
1265 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
1266 "\\makenomenclature\n";
1269 // fixltx2e provides subscript
1270 if (mustProvide("subscript") && !isRequired("fixltx2e"))
1271 packages << "\\usepackage{subscript}\n";
1273 // footmisc must be loaded after setspace
1274 // Set options here, load the package after the user preamble to
1275 // avoid problems with manual loaded footmisc.
1276 if (mustProvide("footmisc"))
1277 packages << "\\PassOptionsToPackage{stable}{footmisc}\n";
1279 if (mustProvide("microtype")){
1280 packages << "\\usepackage{microtype}\n";
1283 return packages.str();
1287 TexString LaTeXFeatures::getMacros() const
1289 otexstringstream macros;
1291 if (!preamble_snippets_.empty()) {
1293 macros << getPreambleSnippets();
1296 if (mustProvide("papersize")) {
1297 if (runparams_.flavor == OutputParams::LATEX
1298 || runparams_.flavor == OutputParams::DVILUATEX)
1299 macros << papersizedvi_def << '\n';
1300 else if (runparams_.flavor == OutputParams::LUATEX)
1301 macros << papersizepdflua_def << '\n';
1303 macros << papersizepdf_def << '\n';
1306 if (mustProvide("LyX")) {
1307 if (isRequired("hyperref"))
1308 macros << lyx_hyperref_def << '\n';
1310 macros << lyx_def << '\n';
1313 if (mustProvide("noun"))
1314 macros << noun_def << '\n';
1316 if (mustProvide("lyxarrow"))
1317 macros << lyxarrow_def << '\n';
1319 if (!usePolyglossia() && mustProvide("textgreek")) {
1320 // ensure LGR font encoding is defined also if fontenc is not loaded by LyX
1321 if (params_.font_encoding() == "default")
1322 macros << textgreek_LGR_def;
1323 macros << textgreek_def << '\n';
1326 if (!usePolyglossia() && mustProvide("textcyr")) {
1327 // ensure T2A font encoding is set up also if fontenc is not loaded by LyX
1328 if (params_.font_encoding() == "default")
1329 macros << textcyr_T2A_def;
1330 macros << textcyr_def << '\n';
1333 // non-standard text accents:
1334 if (mustProvide("textcommaabove") || mustProvide("textcommaaboveright") ||
1335 mustProvide("textcommabelow") || mustProvide("textbaltic"))
1336 macros << lyxaccent_def;
1338 if (mustProvide("textcommabelow") || mustProvide("textbaltic"))
1339 macros << textcommabelow_def << '\n';
1341 if (mustProvide("textcommaabove") || mustProvide("textbaltic"))
1342 macros << textcommaabove_def << '\n';
1344 if (mustProvide("textcommaaboveright"))
1345 macros << textcommaaboveright_def << '\n';
1347 if (mustProvide("textbaltic"))
1348 macros << textbaltic_def << '\n';
1350 // split-level fractions
1351 if (mustProvide("xfrac") || mustProvide("smallLetterFrac"))
1352 macros << xfrac_def << '\n';
1354 if (mustProvide("smallLetterFrac"))
1355 macros << smallLetterFrac_def << '\n';
1357 if (mustProvide("lyxmathsym"))
1358 macros << lyxmathsym_def << '\n';
1360 if (mustProvide("cedilla"))
1361 macros << cedilla_def << '\n';
1363 if (mustProvide("subring"))
1364 macros << subring_def << '\n';
1366 if (mustProvide("subdot"))
1367 macros << subdot_def << '\n';
1369 if (mustProvide("subhat"))
1370 macros << subhat_def << '\n';
1372 if (mustProvide("subtilde"))
1373 macros << subtilde_def << '\n';
1375 if (mustProvide("dacute"))
1376 macros << dacute_def << '\n';
1378 if (mustProvide("tipasymb"))
1379 macros << tipasymb_def << '\n';
1381 if (mustProvide("dgrave"))
1382 macros << dgrave_def << '\n';
1384 if (mustProvide("rcap"))
1385 macros << rcap_def << '\n';
1387 if (mustProvide("ogonek"))
1388 macros << ogonek_def << '\n';
1391 if (mustProvide("quotesinglbase"))
1392 macros << quotesinglbase_def << '\n';
1393 if (mustProvide("quotedblbase"))
1394 macros << quotedblbase_def << '\n';
1395 if (mustProvide("guilsinglleft"))
1396 macros << guilsinglleft_def << '\n';
1397 if (mustProvide("guilsinglright"))
1398 macros << guilsinglright_def << '\n';
1399 if (mustProvide("guillemotleft"))
1400 macros << guillemotleft_def << '\n';
1401 if (mustProvide("guillemotright"))
1402 macros << guillemotright_def << '\n';
1403 if (mustProvide("textquotedbl"))
1404 macros << textquotedbl_def << '\n';
1405 if (mustProvide("textquotesinglep")) {
1406 if (runparams_.flavor == OutputParams::XETEX)
1407 macros << textquotesinglep_xetex_def << '\n';
1409 macros << textquotesinglep_luatex_def << '\n';
1411 if (mustProvide("textquotedblp")) {
1412 if (runparams_.flavor == OutputParams::XETEX)
1413 macros << textquotedblp_xetex_def << '\n';
1415 macros << textquotedblp_luatex_def << '\n';
1419 if (mustProvide("binom") && !isRequired("amsmath"))
1420 macros << binom_def << '\n';
1421 if (mustProvide("mathcircumflex"))
1422 macros << mathcircumflex_def << '\n';
1425 if (mustProvide("ParagraphLeftIndent"))
1426 macros << paragraphleftindent_def;
1427 if (mustProvide("NeedLyXFootnoteCode"))
1428 macros << floatingfootnote_def;
1430 // some problems with tex->html converters
1431 if (mustProvide("NeedTabularnewline"))
1432 macros << tabularnewline_def;
1434 // greyed-out environment (note inset)
1435 // the color is specified in the routine
1436 // getColorOptions() to avoid LaTeX-package clashes
1437 if (mustProvide("lyxgreyedout"))
1438 macros << lyxgreyedout_def;
1440 if (mustProvide("lyxdot"))
1441 macros << lyxdot_def << '\n';
1444 getFloatDefinitions(macros);
1446 if (mustProvide("refstyle"))
1447 macros << lyxref_def << '\n';
1450 if (mustProvide("ct-dvipost"))
1451 macros << changetracking_dvipost_def;
1453 if (mustProvide("ct-xcolor-ulem")) {
1454 streamsize const prec = macros.os().precision(2);
1456 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1457 macros << "\\providecolor{lyxadded}{rgb}{"
1458 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1460 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1461 macros << "\\providecolor{lyxdeleted}{rgb}{"
1462 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1464 macros.os().precision(prec);
1466 if (isRequired("hyperref"))
1467 macros << changetracking_xcolor_ulem_hyperref_def;
1469 macros << changetracking_xcolor_ulem_def;
1472 if (mustProvide("ct-tikz-math-sout"))
1473 macros << changetracking_tikz_math_sout_def;
1475 if (mustProvide("ct-none"))
1476 macros << changetracking_none_def;
1478 if (mustProvide("rtloutputdblcol"))
1479 macros << rtloutputdblcol_def;
1481 return macros.release();
1485 docstring const LaTeXFeatures::getBabelPresettings() const
1487 odocstringstream tmp;
1489 for (Language const * lang : UsedLanguages_)
1490 if (!lang->babel_presettings().empty())
1491 tmp << lang->babel_presettings() << '\n';
1492 if (!params_.language->babel_presettings().empty())
1493 tmp << params_.language->babel_presettings() << '\n';
1495 if (!contains(tmp.str(), '@'))
1498 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1502 docstring const LaTeXFeatures::getBabelPostsettings() const
1504 odocstringstream tmp;
1506 for (Language const * lang : UsedLanguages_)
1507 if (!lang->babel_postsettings().empty())
1508 tmp << lang->babel_postsettings() << '\n';
1509 if (!params_.language->babel_postsettings().empty())
1510 tmp << params_.language->babel_postsettings() << '\n';
1512 if (!contains(tmp.str(), '@'))
1515 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1519 bool LaTeXFeatures::needBabelLangOptions() const
1521 if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1524 LanguageList::const_iterator it = UsedLanguages_.begin();
1525 LanguageList::const_iterator end = UsedLanguages_.end();
1526 for (; it != end; ++it)
1527 if ((*it)->asBabelOptions())
1534 string const LaTeXFeatures::loadAMSPackages() const
1538 if (mustProvide("amsmath")
1539 && params_.use_package("amsmath") != BufferParams::package_off) {
1540 tmp << "\\usepackage{amsmath}\n";
1542 // amsbsy and amstext are already provided by amsmath
1543 if (mustProvide("amsbsy"))
1544 tmp << "\\usepackage{amsbsy}\n";
1545 if (mustProvide("amstext"))
1546 tmp << "\\usepackage{amstext}\n";
1549 if (mustProvide("amsthm"))
1550 tmp << "\\usepackage{amsthm}\n";
1552 if (mustProvide("amssymb")
1553 && params_.use_package("amssymb") != BufferParams::package_off)
1554 tmp << "\\usepackage{amssymb}\n";
1560 docstring const LaTeXFeatures::getTClassPreamble() const
1562 // the text class specific preamble
1563 DocumentClass const & tclass = params_.documentClass();
1564 odocstringstream tcpreamble;
1566 tcpreamble << tclass.preamble();
1568 list<docstring>::const_iterator cit = usedLayouts_.begin();
1569 list<docstring>::const_iterator end = usedLayouts_.end();
1570 for (; cit != end; ++cit)
1571 tcpreamble << tclass[*cit].preamble();
1573 cit = usedInsetLayouts_.begin();
1574 end = usedInsetLayouts_.end();
1575 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1576 for (; cit != end; ++cit) {
1577 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1578 if (it == ils.end())
1580 tcpreamble << it->second.preamble();
1583 return tcpreamble.str();
1587 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1589 DocumentClass const & tclass = params_.documentClass();
1590 odocstringstream tcpreamble;
1592 tcpreamble << tclass.htmlpreamble();
1594 list<docstring>::const_iterator cit = usedLayouts_.begin();
1595 list<docstring>::const_iterator end = usedLayouts_.end();
1596 for (; cit != end; ++cit)
1597 tcpreamble << tclass[*cit].htmlpreamble();
1599 cit = usedInsetLayouts_.begin();
1600 end = usedInsetLayouts_.end();
1601 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1602 for (; cit != end; ++cit) {
1603 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1604 if (it == ils.end())
1606 tcpreamble << it->second.htmlpreamble();
1609 return tcpreamble.str();
1613 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1615 DocumentClass const & tclass = params_.documentClass();
1616 odocstringstream tcpreamble;
1618 if (mustProvide("noun"))
1619 tcpreamble << lyxnoun_style;
1620 // this isn't exact, but it won't hurt that much if it
1622 if (mustProvide("ulem"))
1623 tcpreamble << lyxstrikeout_style;
1625 tcpreamble << tclass.htmlstyles();
1627 list<docstring>::const_iterator cit = usedLayouts_.begin();
1628 list<docstring>::const_iterator end = usedLayouts_.end();
1629 for (; cit != end; ++cit)
1630 tcpreamble << tclass[*cit].htmlstyle();
1632 cit = usedInsetLayouts_.begin();
1633 end = usedInsetLayouts_.end();
1634 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1635 for (; cit != end; ++cit) {
1636 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1637 if (it == ils.end())
1639 tcpreamble << it->second.htmlstyle();
1642 return tcpreamble.str();
1648 docstring const getFloatI18nPreamble(docstring const & type,
1649 docstring const & name, Language const * lang,
1650 Encoding const & enc, bool const polyglossia)
1652 // Check whether name can be encoded in the buffer encoding
1653 bool encodable = true;
1654 for (size_t i = 0; i < name.size(); ++i) {
1655 if (!enc.encodable(name[i])) {
1661 docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1662 : from_ascii(lang->babel());
1663 docstring const langenc = from_ascii(lang->encoding()->iconvName());
1664 docstring const texenc = from_ascii(lang->encoding()->latexName());
1665 docstring const bufenc = from_ascii(enc.iconvName());
1666 docstring const s1 = docstring(1, 0xF0000);
1667 docstring const s2 = docstring(1, 0xF0001);
1668 docstring const translated = encodable ? name
1669 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1670 + s1 + langenc + s2 + name + s1 + bufenc + s2;
1672 odocstringstream os;
1673 os << "\\addto\\captions" << language
1674 << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1679 docstring const i18npreamble(docstring const & templ, Language const * lang,
1680 Encoding const & enc, bool const polyglossia,
1681 bool const need_fixedwidth)
1686 string preamble = polyglossia ?
1687 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
1688 subst(to_utf8(templ), "$$lang", lang->babel());
1690 string const langenc = lang->encoding()->iconvName();
1691 string const texenc = lang->encoding()->latexName();
1692 string const bufenc = enc.iconvName();
1693 Encoding const * testenc(&enc);
1694 bool lang_fallback = false;
1695 bool ascii_fallback = false;
1696 if (need_fixedwidth && !enc.hasFixedWidth()) {
1697 if (lang->encoding()->hasFixedWidth()) {
1698 testenc = lang->encoding();
1699 lang_fallback = true;
1701 // We need a fixed width encoding, but both the buffer
1702 // encoding and the language encoding are variable
1703 // width. As a last fallback, try to convert to pure
1704 // ASCII using the LaTeX commands defined in unicodesymbols.
1705 testenc = encodings.fromLyXName("ascii");
1708 ascii_fallback = true;
1711 // First and second character of plane 15 (Private Use Area)
1712 string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
1713 string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
1715 // lyx::regex is not unicode-safe.
1716 // Should use QRegExp or (boost::u32regex, but that requires ICU)
1717 static regex const reg("_\\(([^\\)]+)\\)");
1719 while (regex_search(preamble, sub, reg)) {
1720 string const key = sub.str(1);
1721 docstring const name = lang->translateLayout(key);
1722 // Check whether name can be encoded in the buffer encoding
1723 bool encodable = true;
1724 for (size_t i = 0; i < name.size() && encodable; ++i)
1725 if (!testenc->encodable(name[i]))
1728 if (encodable && !lang_fallback)
1729 translated = to_utf8(name);
1730 else if (ascii_fallback)
1731 translated = to_ascii(testenc->latexString(name).first);
1733 translated = "\\inputencoding{" + texenc + "}"
1734 + s1 + langenc + s2 + to_utf8(name)
1736 preamble = subst(preamble, sub.str(), translated);
1738 return from_utf8(preamble);
1744 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const
1746 DocumentClass const & tclass = params_.documentClass();
1747 // collect preamble snippets in a set to prevent multiple identical
1748 // commands (would happen if e.g. both theorem and theorem* are used)
1749 set<docstring> snippets;
1750 typedef LanguageList::const_iterator lang_it;
1751 lang_it const lbeg = UsedLanguages_.begin();
1752 lang_it const lend = UsedLanguages_.end();
1753 list<docstring>::const_iterator cit = usedLayouts_.begin();
1754 list<docstring>::const_iterator end = usedLayouts_.end();
1755 for (; cit != end; ++cit) {
1756 // language dependent commands (once per document)
1757 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
1758 buffer().language(),
1759 buffer().params().encoding(),
1760 use_polyglossia, false));
1761 // commands for language changing (for multilanguage documents)
1762 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1763 snippets.insert(i18npreamble(
1764 tclass[*cit].babelpreamble(),
1765 buffer().language(),
1766 buffer().params().encoding(),
1767 use_polyglossia, false));
1768 for (lang_it lit = lbeg; lit != lend; ++lit)
1769 snippets.insert(i18npreamble(
1770 tclass[*cit].babelpreamble(),
1772 buffer().params().encoding(),
1773 use_polyglossia, false));
1776 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1777 FloatList const & floats = params_.documentClass().floats();
1778 UsedFloats::const_iterator fit = usedFloats_.begin();
1779 UsedFloats::const_iterator fend = usedFloats_.end();
1780 for (; fit != fend; ++fit) {
1781 Floating const & fl = floats.getType(fit->first);
1782 // we assume builtin floats are translated
1783 if (fl.isPredefined())
1785 docstring const type = from_ascii(fl.floattype());
1786 docstring const flname = from_utf8(fl.name());
1787 docstring name = buffer().language()->translateLayout(fl.name());
1788 // only request translation if we have a real translation
1789 // (that differs from the source)
1791 snippets.insert(getFloatI18nPreamble(
1792 type, name, buffer().language(),
1793 buffer().params().encoding(),
1795 for (lang_it lit = lbeg; lit != lend; ++lit) {
1796 string const code = (*lit)->code();
1797 name = (*lit)->translateLayout(fl.name());
1798 // we assume we have a suitable translation if
1799 // either the language is English (we need to
1800 // translate into English if English is a secondary
1801 // language) or if translateIfPossible returns
1802 // something different to the English source.
1803 bool const have_translation =
1804 (flname != name || contains(code, "en"));
1805 if (have_translation)
1806 snippets.insert(getFloatI18nPreamble(
1808 buffer().params().encoding(),
1814 cit = usedInsetLayouts_.begin();
1815 end = usedInsetLayouts_.end();
1816 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1817 for (; cit != end; ++cit) {
1818 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1819 if (it == ils.end())
1821 // The listings package does not work with variable width
1822 // encodings, only with fixed width encodings. Therefore we
1823 // need to force a fixed width encoding for
1824 // \lstlistlistingname and \lstlistingname (bug 9382).
1825 // This needs to be consistent with InsetListings::latex().
1826 bool const need_fixedwidth = !runparams_.isFullUnicode() &&
1827 it->second.fixedwidthpreambleencoding();
1828 // language dependent commands (once per document)
1829 snippets.insert(i18npreamble(it->second.langpreamble(),
1830 buffer().language(),
1831 buffer().params().encoding(),
1832 use_polyglossia, need_fixedwidth));
1833 // commands for language changing (for multilanguage documents)
1834 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1835 snippets.insert(i18npreamble(
1836 it->second.babelpreamble(),
1837 buffer().language(),
1838 buffer().params().encoding(),
1839 use_polyglossia, need_fixedwidth));
1840 for (lang_it lit = lbeg; lit != lend; ++lit)
1841 snippets.insert(i18npreamble(
1842 it->second.babelpreamble(),
1844 buffer().params().encoding(),
1845 use_polyglossia, need_fixedwidth));
1849 odocstringstream tcpreamble;
1850 set<docstring>::const_iterator const send = snippets.end();
1851 set<docstring>::const_iterator it = snippets.begin();
1852 for (; it != send; ++it)
1854 return tcpreamble.str();
1858 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1860 // Definition of entities used in the document that are LyX related.
1861 odocstringstream entities;
1863 if (mustProvide("lyxarrow")) {
1864 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
1867 return entities.str();
1871 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1873 odocstringstream sgmlpreamble;
1875 docstring const basename(from_utf8(onlyPath(fname)));
1877 FileMap::const_iterator end = IncludedFiles_.end();
1878 for (FileMap::const_iterator fi = IncludedFiles_.begin();
1881 sgmlpreamble << "\n<!ENTITY " << fi->first
1882 << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1883 << makeRelPath(from_utf8(fi->second), basename) << "\">";
1885 return sgmlpreamble.str();
1889 void LaTeXFeatures::showStruct() const
1891 lyxerr << "LyX needs the following commands when LaTeXing:"
1892 << "\n***** Packages:" << getPackages()
1893 << "\n***** Macros:" << to_utf8(getMacros().str)
1894 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1895 << "\n***** done." << endl;
1899 Buffer const & LaTeXFeatures::buffer() const
1905 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1911 BufferParams const & LaTeXFeatures::bufferParams() const
1917 void LaTeXFeatures::getFloatDefinitions(otexstream & os) const
1919 FloatList const & floats = params_.documentClass().floats();
1921 // Here we will output the code to create the needed float styles.
1922 // We will try to do this as minimal as possible.
1923 // \floatstyle{ruled}
1924 // \newfloat{algorithm}{htbp}{loa}
1925 // \providecommand{\algorithmname}{Algorithm}
1926 // \floatname{algorithm}{\protect\algorithmname}
1927 UsedFloats::const_iterator cit = usedFloats_.begin();
1928 UsedFloats::const_iterator end = usedFloats_.end();
1929 for (; cit != end; ++cit) {
1930 Floating const & fl = floats.getType(cit->first);
1932 // For builtin floats we do nothing.
1933 if (fl.isPredefined())
1936 // We have to special case "table" and "figure"
1937 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1938 // Output code to modify "table" or "figure"
1939 // but only if builtin == false
1940 // and that have to be true at this point in the
1942 docstring const type = from_ascii(fl.floattype());
1943 docstring const placement = from_ascii(fl.placement());
1944 docstring const style = from_ascii(fl.style());
1945 if (!style.empty()) {
1946 os << "\\floatstyle{" << style << "}\n"
1947 << "\\restylefloat{" << type << "}\n";
1949 if (!placement.empty()) {
1950 os << "\\floatplacement{" << type << "}{"
1951 << placement << "}\n";
1954 // The other non builtin floats.
1956 docstring const type = from_ascii(fl.floattype());
1957 docstring const placement = from_ascii(fl.placement());
1958 docstring const ext = from_ascii(fl.ext());
1959 docstring const within = from_ascii(fl.within());
1960 docstring const style = from_ascii(fl.style());
1961 docstring const name =
1962 buffer().language()->translateLayout(fl.name());
1963 os << "\\floatstyle{" << style << "}\n"
1964 << "\\newfloat{" << type << "}{" << placement
1965 << "}{" << ext << '}';
1966 if (!within.empty())
1967 os << '[' << within << ']';
1969 << "\\providecommand{\\" << type << "name}{"
1971 << "\\floatname{" << type << "}{\\protect\\"
1972 << type << "name}\n";
1974 // What missing here is to code to minimalize the code
1975 // output so that the same floatstyle will not be
1976 // used several times, when the same style is still in
1980 // The subfig package is loaded later
1981 os << "\n\\AtBeginDocument{\\newsubfloat{" << from_ascii(fl.floattype()) << "}}\n";
1986 void LaTeXFeatures::resolveAlternatives()
1988 for (Features::iterator it = features_.begin(); it != features_.end();) {
1989 if (contains(*it, '|')) {
1990 vector<string> const alternatives = getVectorFromString(*it, "|");
1991 vector<string>::const_iterator const end = alternatives.end();
1992 vector<string>::const_iterator ita = alternatives.begin();
1993 // Is any alternative already required? => use that
1994 for (; ita != end; ++ita) {
1995 if (isRequired(*ita))
1998 // Is any alternative available? => use the first one
2001 for (ita = alternatives.begin(); ita != end; ++ita) {
2002 if (isAvailable(*ita)) {
2008 // This will not work, but not requiring something
2009 // would be more confusing
2011 require(alternatives.front());
2012 features_.erase(it);
2013 it = features_.begin();
2020 void LaTeXFeatures::expandMultiples()
2022 for (Features::iterator it = features_.begin(); it != features_.end();) {
2023 if (contains(*it, ',')) {
2024 vector<string> const multiples = getVectorFromString(*it, ",");
2025 vector<string>::const_iterator const end = multiples.end();
2026 vector<string>::const_iterator itm = multiples.begin();
2027 // Do nothing if any multiple is already required
2028 for (; itm != end; ++itm) {
2029 if (!isRequired(*itm))
2032 features_.erase(it);
2033 it = features_.begin();