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 "insets/InsetLayout.h"
36 #include "support/debug.h"
37 #include "support/docstream.h"
38 #include "support/FileName.h"
39 #include "support/filetools.h"
40 #include "support/gettext.h"
41 #include "support/lstrings.h"
42 #include "support/regex.h"
48 using namespace lyx::support;
53 /////////////////////////////////////////////////////////////////////
57 /////////////////////////////////////////////////////////////////////
59 //\NeedsTeXFormat{LaTeX2e}
60 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
61 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
63 static docstring const lyx_def = from_ascii(
64 "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}");
66 static docstring const lyx_hyperref_def = from_ascii(
67 "\\providecommand{\\LyX}{\\texorpdfstring%\n"
68 " {L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}\n"
71 static docstring const noun_def = from_ascii(
72 "\\newcommand{\\noun}[1]{\\textsc{#1}}");
74 static docstring const lyxarrow_def = from_ascii(
75 "\\DeclareRobustCommand*{\\lyxarrow}{%\n"
77 "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
78 "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}");
80 // for quotes without babel. This does not give perfect results, but
81 // anybody serious about non-english quotes should use babel (JMarc).
83 static docstring const quotedblbase_def = from_ascii(
84 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
85 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
86 " \\penalty10000\\hskip0em\\relax%\n"
89 static docstring const quotesinglbase_def = from_ascii(
90 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
91 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
92 " \\penalty10000\\hskip0em\\relax%\n"
95 static docstring const guillemotleft_def = from_ascii(
96 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
97 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
98 "\\penalty10000\\hskip0pt\\relax%\n"
101 static docstring const guillemotright_def = from_ascii(
102 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
103 " \\penalty10000\\hskip0pt%\n"
104 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
107 static docstring const guilsinglleft_def = from_ascii(
108 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
109 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
110 " \\penalty10000\\hskip0pt\\relax%\n"
113 static docstring const guilsinglright_def = from_ascii(
114 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
115 " \\penalty10000\\hskip0pt%\n"
116 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
119 static docstring const paragraphleftindent_def = from_ascii(
120 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
122 " \\begin{list}{}{%\n"
123 " \\setlength{\\topsep}{0pt}%\n"
124 " \\addtolength{\\leftmargin}{#1}\n"
125 // ho hum, yet more things commented out with no hint as to why they
126 // weren't just removed
127 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
128 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
129 // "%% \\setlength\\listparindent\\parindent%\n"
130 // "%% \\setlength\\itemindent\\parindent%\n"
131 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
137 static docstring const binom_def = from_ascii(
138 "%% Binom macro for standard LaTeX users\n"
139 "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n");
141 static docstring const mathcircumflex_def = from_ascii(
142 "%% For printing a cirumflex inside a formula\n"
143 "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n");
145 static docstring const tabularnewline_def = from_ascii(
146 "%% Because html converters don't know tabularnewline\n"
147 "\\providecommand{\\tabularnewline}{\\\\}\n");
149 static docstring const lyxgreyedout_def = from_ascii(
150 "%% The greyedout annotation environment\n"
151 "\\newenvironment{lyxgreyedout}\n"
152 " {\\textcolor{note_fontcolor}\\bgroup\\ignorespaces}\n"
153 " {\\ignorespacesafterend\\egroup}\n");
155 // We want to omit the file extension for includegraphics, but this does not
156 // work when the filename contains other dots.
157 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
158 static docstring const lyxdot_def = from_ascii(
159 "%% A simple dot to overcome graphicx limitations\n"
160 "\\newcommand{\\lyxdot}{.}\n");
162 static docstring const changetracking_dvipost_def = from_ascii(
163 "%% Change tracking with dvipost\n"
165 "\\dvipost{osstart color push Red}\n"
166 "\\dvipost{osend color pop}\n"
167 "\\dvipost{cbstart color push Blue}\n"
168 "\\dvipost{cbend color pop}\n"
169 "\\DeclareRobustCommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
170 "\\DeclareRobustCommand{\\lyxdeleted}[3]{%\n"
171 "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n");
173 static docstring const changetracking_xcolor_ulem_def = from_ascii(
174 "%% Change tracking with ulem\n"
175 "\\DeclareRobustCommand{\\lyxadded}[3]{{\\color{lyxadded}{}#3}}\n"
176 "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\sout{#3}}}\n");
178 static docstring const changetracking_xcolor_ulem_hyperref_def = from_ascii(
179 "%% Change tracking with ulem\n"
180 "\\DeclareRobustCommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}{}}{}#3}}\n"
181 "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\sout{#3}}{}}}\n");
183 static docstring const changetracking_none_def = from_ascii(
184 "\\newcommand{\\lyxadded}[3]{#3}\n"
185 "\\newcommand{\\lyxdeleted}[3]{}\n");
187 static docstring const textgreek_def = from_ascii(
188 "\\DeclareRobustCommand{\\greektext}{%\n"
189 " \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
190 "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
191 "\\DeclareFontEncoding{LGR}{}{}\n"
192 "\\DeclareTextSymbol{\\~}{LGR}{126}");
194 static docstring const textcyr_def = from_ascii(
195 "\\DeclareRobustCommand{\\cyrtext}{%\n"
196 " \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
197 "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
198 "\\AtBeginDocument{\\DeclareFontEncoding{T2A}{}{}}\n");
200 static docstring const lyxmathsym_def = from_ascii(
201 "\\newcommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
202 " \\text{\\ifx\\math@version\\b@ld\\bfseries\\fi#1}\\endgroup\\else#1\\fi}\n");
204 static docstring const papersizedvi_def = from_ascii(
205 "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n");
207 static docstring const papersizepdf_def = from_ascii(
208 "\\pdfpageheight\\paperheight\n"
209 "\\pdfpagewidth\\paperwidth\n");
211 static docstring const cedilla_def = from_ascii(
212 "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
213 "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n");
215 static docstring const subring_def = from_ascii(
216 "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
217 "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n");
219 static docstring const subdot_def = from_ascii(
220 "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
221 "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n");
223 static docstring const subhat_def = from_ascii(
224 "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
225 "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n");
227 static docstring const subtilde_def = from_ascii(
228 "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
229 "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n");
231 static docstring const dacute_def = from_ascii(
232 "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n");
234 static docstring const tipasymb_def = from_ascii(
235 "\\DeclareFontEncoding{T3}{}{}\n"
236 "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n");
238 static docstring const dgrave_def = from_ascii(
239 "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n");
241 static docstring const rcap_def = from_ascii(
242 "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n");
244 static docstring const ogonek_def = from_ascii(
245 "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
246 " \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
247 " \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
248 " \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
249 "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n");
251 static docstring const lyxref_def = from_ascii(
252 "\\RS@ifundefined{subsecref}\n"
253 " {\\newref{subsec}{name = \\RSsectxt}}\n"
255 "\\RS@ifundefined{thmref}\n"
256 " {\\def\\RSthmtxt{theorem~}\\newref{thm}{name = \\RSthmtxt}}\n"
258 "\\RS@ifundefined{lemref}\n"
259 " {\\def\\RSlemtxt{lemma~}\\newref{lem}{name = \\RSlemtxt}}\n"
262 // Make sure the columns are also outputed as rtl
263 static docstring const rtloutputdblcol_def = from_ascii(
264 "\\def\\@outputdblcol{%\n"
265 " \\if@firstcolumn\n"
266 " \\global \\@firstcolumnfalse\n"
267 " \\global \\setbox\\@leftcolumn \\box\\@outputbox\n"
269 " \\global \\@firstcolumntrue\n"
270 " \\setbox\\@outputbox \\vbox {%\n"
271 " \\hb@xt@\\textwidth {%\n"
272 " \\kern\\textwidth \\kern-\\columnwidth %**\n"
273 " \\hb@xt@\\columnwidth {%\n"
274 " \\box\\@leftcolumn \\hss}%\n"
275 " \\kern-\\textwidth %**\n"
277 " {\\normalcolor\\vrule \\@width\\columnseprule}%\n"
279 " \\kern-\\textwidth %**\n"
280 " \\hb@xt@\\columnwidth {%\n"
281 " \\box\\@outputbox \\hss}%\n"
282 " \\kern-\\columnwidth \\kern\\textwidth %**\n"
285 " \\@combinedblfloats\n"
288 " \\@dblfloatplacement\n"
289 " \\@startdblcolumn\n"
290 " \\@whilesw\\if@fcolmade \\fi\n"
292 " \\@startdblcolumn}%\n"
296 "\\@mparswitchtrue\n");
299 /////////////////////////////////////////////////////////////////////
303 /////////////////////////////////////////////////////////////////////
305 static docstring const lyxnoun_style = from_ascii(
307 " font-variant: small-caps;\n"
311 // this is how it normally renders, but it might not always do so.
312 static docstring const lyxstrikeout_style = from_ascii(
314 " text-decoration: line-through;\n"
318 /////////////////////////////////////////////////////////////////////
322 /////////////////////////////////////////////////////////////////////
325 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
326 OutputParams const & r)
327 : buffer_(&b), params_(p), runparams_(r), in_float_(false)
331 LaTeXFeatures::LangPackage LaTeXFeatures::langPackage() const
333 string const local_lp = bufferParams().lang_package;
335 // Locally, custom is just stored as a string
336 // in bufferParams().lang_package.
337 if (local_lp != "auto"
338 && local_lp != "babel"
339 && local_lp != "default"
340 && local_lp != "none")
341 return LANG_PACK_CUSTOM;
343 if (local_lp == "none")
344 return LANG_PACK_NONE;
346 /* If "auto" is selected, we load polyglossia if required,
347 * else we select babel.
348 * If babel is selected (either directly or via the "auto"
349 * mechanism), we really do only require it if we have
350 * a language that needs it.
352 bool const polyglossia_required =
353 isRequired("polyglossia")
354 && isAvailable("polyglossia")
355 && !isProvided("babel")
356 && this->hasOnlyPolyglossiaLanguages();
357 bool const babel_required =
358 !bufferParams().language->babel().empty()
359 || !this->getBabelLanguages().empty();
361 if (local_lp == "auto") {
362 // polyglossia requirement has priority over babel
363 if (polyglossia_required)
364 return LANG_PACK_POLYGLOSSIA;
365 else if (babel_required)
366 return LANG_PACK_BABEL;
369 if (local_lp == "babel") {
371 return LANG_PACK_BABEL;
374 if (local_lp == "default") {
375 switch (lyxrc.language_package_selection) {
377 // polyglossia requirement has priority over babel
378 if (polyglossia_required)
379 return LANG_PACK_POLYGLOSSIA;
380 else if (babel_required)
381 return LANG_PACK_BABEL;
383 case LyXRC::LP_BABEL:
385 return LANG_PACK_BABEL;
387 case LyXRC::LP_CUSTOM:
388 return LANG_PACK_CUSTOM;
390 return LANG_PACK_NONE;
394 return LANG_PACK_NONE;
398 void LaTeXFeatures::require(string const & name)
400 features_.insert(name);
404 void LaTeXFeatures::require(set<string> const & names)
406 features_.insert(names.begin(), names.end());
410 void LaTeXFeatures::useLayout(docstring const & layoutname)
412 useLayout(layoutname, 0);
416 void LaTeXFeatures::useLayout(docstring const & layoutname, int level)
418 // Some code to avoid loops in dependency definition
419 const int maxlevel = 30;
420 if (level > maxlevel) {
421 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
422 << "recursion attained by layout "
423 << to_utf8(layoutname) << endl;
427 DocumentClass const & tclass = params_.documentClass();
428 if (tclass.hasLayout(layoutname)) {
429 // Is this layout already in usedLayouts?
430 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
431 != usedLayouts_.end())
434 Layout const & layout = tclass[layoutname];
435 require(layout.requires());
437 if (!layout.depends_on().empty()) {
438 useLayout(layout.depends_on(), level + 1);
440 usedLayouts_.push_back(layoutname);
442 lyxerr << "LaTeXFeatures::useLayout: layout `"
443 << to_utf8(layoutname) << "' does not exist in this class"
449 void LaTeXFeatures::useInsetLayout(InsetLayout const & lay)
451 docstring const & lname = lay.name();
452 DocumentClass const & tclass = params_.documentClass();
454 // this is a default inset layout, nothing useful here
455 if (!tclass.hasInsetLayout(lname))
457 // Is this layout already in usedInsetLayouts?
458 if (find(usedInsetLayouts_.begin(), usedInsetLayouts_.end(), lname)
459 != usedInsetLayouts_.end())
462 require(lay.requires());
463 usedInsetLayouts_.push_back(lname);
467 bool LaTeXFeatures::isRequired(string const & name) const
469 return features_.find(name) != features_.end();
473 bool LaTeXFeatures::isProvided(string const & name) const
475 if (params_.useNonTeXFonts)
476 return params_.documentClass().provides(name);
478 bool const ot1 = (params_.font_encoding() == "default"
479 || params_.font_encoding() == "OT1");
480 bool const complete = (params_.fonts_sans == "default")
481 && (params_.fonts_typewriter == "default");
482 bool const nomath = (params_.fonts_math == "default");
483 return params_.documentClass().provides(name)
484 || theLaTeXFonts().getLaTeXFont(
485 from_ascii(params_.fonts_roman)).provides(name, ot1,
488 || theLaTeXFonts().getLaTeXFont(
489 from_ascii(params_.fonts_sans)).provides(name, ot1,
492 || theLaTeXFonts().getLaTeXFont(
493 from_ascii(params_.fonts_typewriter)).provides(name, ot1,
496 || theLaTeXFonts().getLaTeXFont(
497 from_ascii(params_.fonts_math)).provides(name, ot1,
503 bool LaTeXFeatures::mustProvide(string const & name) const
505 return isRequired(name) && !isProvided(name);
509 bool LaTeXFeatures::isAvailable(string const & name)
511 string::size_type const i = name.find("->");
512 if (i != string::npos) {
513 string const from = name.substr(0,i);
514 string const to = name.substr(i+2);
515 //LYXERR0("from=[" << from << "] to=[" << to << "]");
516 return theConverters().isReachable(from, to);
518 return LaTeXPackages::isAvailable(name);
522 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
524 SnippetList::const_iterator begin = preamble_snippets_.begin();
525 SnippetList::const_iterator end = preamble_snippets_.end();
526 if (find(begin, end, preamble) == end)
527 preamble_snippets_.push_back(preamble);
531 void LaTeXFeatures::addCSSSnippet(std::string const & snippet)
533 SnippetList::const_iterator begin = css_snippets_.begin();
534 SnippetList::const_iterator end = css_snippets_.end();
535 if (find(begin, end, snippet) == end)
536 css_snippets_.push_back(snippet);
540 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
542 if (!usedFloats_[name])
543 usedFloats_[name] = subfloat;
546 // We only need float.sty if we use non builtin floats, or if we
547 // use the "H" modifier. This includes modified table and
548 // figure floats. (Lgb)
549 Floating const & fl = params_.documentClass().floats().getType(name);
550 if (!fl.floattype().empty() && fl.usesFloatPkg()) {
556 void LaTeXFeatures::useLanguage(Language const * lang)
558 if (!lang->babel().empty() || !lang->polyglossia().empty())
559 UsedLanguages_.insert(lang);
560 if (!lang->requires().empty())
561 require(lang->requires());
562 // CJK languages do not have a babel name.
563 // They use the CJK package
564 if (lang->encoding()->package() == Encoding::CJK)
566 // japanese package is special
567 if (lang->encoding()->package() == Encoding::japanese)
572 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
574 IncludedFiles_[key] = name;
578 bool LaTeXFeatures::hasLanguages() const
580 return !UsedLanguages_.empty();
584 bool LaTeXFeatures::hasOnlyPolyglossiaLanguages() const
586 // first the main language
587 if (params_.language->polyglossia().empty())
589 // now the secondary languages
590 LanguageList::const_iterator const begin = UsedLanguages_.begin();
591 for (LanguageList::const_iterator cit = begin;
592 cit != UsedLanguages_.end();
594 if ((*cit)->polyglossia().empty())
601 bool LaTeXFeatures::hasPolyglossiaExclusiveLanguages() const
603 // first the main language
604 if (params_.language->isPolyglossiaExclusive())
606 // now the secondary languages
607 LanguageList::const_iterator const begin = UsedLanguages_.begin();
608 for (LanguageList::const_iterator cit = begin;
609 cit != UsedLanguages_.end();
611 if ((*cit)->isPolyglossiaExclusive())
618 string LaTeXFeatures::getBabelLanguages() const
620 ostringstream languages;
623 LanguageList::const_iterator const begin = UsedLanguages_.begin();
624 for (LanguageList::const_iterator cit = begin;
625 cit != UsedLanguages_.end();
627 if ((*cit)->babel().empty())
633 languages << (*cit)->babel();
635 return languages.str();
639 std::map<std::string, std::string> LaTeXFeatures::getPolyglossiaLanguages() const
641 std::map<std::string, std::string> languages;
643 LanguageList::const_iterator const begin = UsedLanguages_.begin();
644 for (LanguageList::const_iterator cit = begin;
645 cit != UsedLanguages_.end();
647 languages[(*cit)->polyglossia()] = (*cit)->polyglossiaOpts();
653 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
655 // This does only find encodings of languages supported by babel, but
656 // that does not matter since we don't have a language with an
657 // encoding supported by inputenc but without babel support.
658 set<string> encodings;
659 LanguageList::const_iterator it = UsedLanguages_.begin();
660 LanguageList::const_iterator end = UsedLanguages_.end();
661 for (; it != end; ++it)
662 if ((*it)->encoding()->latexName() != doc_encoding &&
663 ((*it)->encoding()->package() == Encoding::inputenc
664 || (*it)->encoding()->package() == Encoding::japanese))
665 encodings.insert((*it)->encoding()->latexName());
670 void LaTeXFeatures::getFontEncodings(vector<string> & encodings) const
672 // these must be loaded if glyphs of this script
673 // are used (notwithstanding the language)
674 if (mustProvide("textgreek"))
675 encodings.insert(encodings.begin(), "LGR");
676 if (mustProvide("textcyr"))
677 encodings.insert(encodings.begin(), "T2A");
679 LanguageList::const_iterator it = UsedLanguages_.begin();
680 LanguageList::const_iterator end = UsedLanguages_.end();
681 for (; it != end; ++it)
682 if (!(*it)->fontenc().empty()
683 && ascii_lowercase((*it)->fontenc()) != "none") {
684 vector<string> extraencs = getVectorFromString((*it)->fontenc());
685 vector<string>::const_iterator fit = extraencs.begin();
686 for (; fit != extraencs.end(); ++fit) {
687 if (find(encodings.begin(), encodings.end(), *fit) == encodings.end())
688 encodings.insert(encodings.begin(), *fit);
695 char const * simplefeatures[] = {
696 // note that the package order here will be the same in the LaTeX-output
703 // subfig is handled in BufferParams.cpp
707 /*For a successful cooperation of the `wrapfig' package with the
708 `float' package you should load the `wrapfig' package *after*
709 the `float' package. See the caption package documentation
740 // listings is handled in BufferParams.cpp
760 char const * bibliofeatures[] = {
761 // Known bibliography packages (will be loaded before natbib)
776 int const nb_bibliofeatures = sizeof(bibliofeatures) / sizeof(char const *);
778 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
783 string const LaTeXFeatures::getColorOptions() const
785 ostringstream colors;
787 // Handling the color packages separately is needed to be able to load them
788 // before babel when hyperref is loaded with the colorlinks option
789 // for more info see Bufferparams.cpp
792 if (mustProvide("color") || mustProvide("xcolor")) {
793 string const package =
794 (mustProvide("xcolor") ? "xcolor" : "color");
795 if (params_.graphics_driver == "default"
796 || params_.graphics_driver == "none")
797 colors << "\\usepackage{" << package << "}\n";
799 colors << "\\usepackage["
800 << params_.graphics_driver
801 << "]{" << package << "}\n";
804 // pdfcolmk must be loaded after color
805 if (mustProvide("pdfcolmk"))
806 colors << "\\usepackage{pdfcolmk}\n";
808 // the following 3 color commands must be set after color
809 // is loaded and before pdfpages, therefore add the command
810 // here define the set color
811 if (mustProvide("pagecolor")) {
812 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
813 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
814 // set the page color
815 colors << "\\pagecolor{page_backgroundcolor}\n";
818 if (mustProvide("fontcolor")) {
819 colors << "\\definecolor{document_fontcolor}{rgb}{";
820 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
822 colors << "\\color{document_fontcolor}\n";
825 if (mustProvide("lyxgreyedout")) {
826 colors << "\\definecolor{note_fontcolor}{rgb}{";
827 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
828 // the color will be set together with the definition of
829 // the lyxgreyedout environment (see lyxgreyedout_def)
832 // color for shaded boxes
833 if (isRequired("framed") && mustProvide("color")) {
834 colors << "\\definecolor{shadecolor}{rgb}{";
835 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
836 // this color is automatically used by the LaTeX-package "framed"
843 string const LaTeXFeatures::getPackageOptions() const
845 ostringstream packageopts;
846 // Output all the package option stuff we have been asked to do.
847 map<string, string>::const_iterator it =
848 params_.documentClass().packageOptions().begin();
849 map<string, string>::const_iterator en =
850 params_.documentClass().packageOptions().end();
851 for (; it != en; ++it)
852 if (mustProvide(it->first))
853 packageopts << "\\PassOptionsToPackage{" << it->second << "}"
854 << "{" << it->first << "}\n";
855 return packageopts.str();
859 string const LaTeXFeatures::getPackages() const
861 ostringstream packages;
863 // FIXME: currently, we can only load packages and macros known
865 // However, with the Require tag of layouts/custom insets,
866 // also unknown packages can be requested. They are silently
867 // swallowed now. We should change this eventually.
869 // These are all the 'simple' includes. i.e
870 // packages which we just \usepackage{package}
871 for (int i = 0; i < nb_simplefeatures; ++i) {
872 if (mustProvide(simplefeatures[i]))
873 packages << "\\usepackage{" << simplefeatures[i] << "}\n";
876 // The rest of these packages are somewhat more complicated
879 // The tipa package and its extensions (tipx, tone) must not
880 // be loaded with non-TeX fonts, since fontspec includes the
882 if (mustProvide("tipa") && !params_.useNonTeXFonts)
883 packages << "\\usepackage{tipa}\n";
884 if (mustProvide("tipx") && !params_.useNonTeXFonts)
885 packages << "\\usepackage{tipx}\n";
886 if (mustProvide("tone") && !params_.useNonTeXFonts)
887 packages << "\\usepackage{tone}\n";
889 // if fontspec or newtxmath is used, AMS packages have to be loaded
890 // before fontspec (in BufferParams)
891 string const amsPackages = loadAMSPackages();
892 bool const ot1 = (params_.font_encoding() == "default" || params_.font_encoding() == "OT1");
893 bool const use_newtxmath =
894 theLaTeXFonts().getLaTeXFont(from_ascii(params_.fonts_math)).getUsedPackage(
895 ot1, false, false) == "newtxmath";
897 if (!params_.useNonTeXFonts && !use_newtxmath && !amsPackages.empty())
898 packages << amsPackages;
900 if (mustProvide("cancel") &&
901 params_.use_package("cancel") != BufferParams::package_off)
902 packages << "\\usepackage{cancel}\n";
904 // marvosym and bbding both define the \Cross macro
905 if (mustProvide("marvosym")) {
906 if (mustProvide("bbding"))
907 packages << "\\let\\Cross\\relax\n";
908 packages << "\\usepackage{marvosym}\n";
911 // accents must be loaded after amsmath
912 if (mustProvide("accents") &&
913 params_.use_package("accents") != BufferParams::package_off)
914 packages << "\\usepackage{accents}\n";
916 // mathdots must be loaded after amsmath
917 if (mustProvide("mathdots") &&
918 params_.use_package("mathdots") != BufferParams::package_off)
919 packages << "\\usepackage{mathdots}\n";
921 // yhmath must be loaded after amsmath
922 if (mustProvide("yhmath") &&
923 params_.use_package("yhmath") != BufferParams::package_off)
924 packages << "\\usepackage{yhmath}\n";
926 // stmaryrd must be loaded after amsmath
927 if (mustProvide("stmaryrd") &&
928 params_.use_package("stmaryrd") != BufferParams::package_off)
929 packages << "\\usepackage{stmaryrd}\n";
931 if (mustProvide("stackrel") &&
932 params_.use_package("stackrel") != BufferParams::package_off)
933 packages << "\\usepackage{stackrel}\n";
935 if (mustProvide("undertilde") &&
936 params_.use_package("undertilde") != BufferParams::package_off)
937 packages << "\\usepackage{undertilde}\n";
939 // [x]color and pdfcolmk are handled in getColorOptions() above
942 if (isRequired("makeidx") || isRequired("splitidx")) {
943 if (!isProvided("makeidx") && !isRequired("splitidx"))
944 packages << "\\usepackage{makeidx}\n";
945 if (mustProvide("splitidx"))
946 packages << "\\usepackage{splitidx}\n";
947 packages << "\\makeindex\n";
951 if (mustProvide("graphicx") && params_.graphics_driver != "none") {
952 if (params_.graphics_driver == "default")
953 packages << "\\usepackage{graphicx}\n";
955 packages << "\\usepackage["
956 << params_.graphics_driver
960 // lyxskak.sty --- newer chess support based on skak.sty
961 if (mustProvide("chess"))
962 packages << "\\usepackage[ps,mover]{lyxskak}\n";
965 if (mustProvide("setspace") && !isProvided("SetSpace"))
966 packages << "\\usepackage{setspace}\n";
968 // we need to assure that mhchem is loaded before esint and every other
969 // package that redefines command of amsmath because mhchem loads amlatex
970 // (this info is from the author of mhchem from June 2013)
971 if (mustProvide("mhchem") &&
972 params_.use_package("mhchem") != BufferParams::package_off)
973 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
974 "\\usepackage{mhchem}\n";
976 // wasysym is a simple feature, but it must be after amsmath if both
978 // wasysym redefines some integrals (e.g. iint) from amsmath. That
979 // leads to inconsistent integrals. We only load this package if
980 // the document does not contain integrals (then isRequired("esint")
981 // is false) or if esint is used, since esint redefines all relevant
982 // integral symbols from wasysym and amsmath.
983 // See http://www.lyx.org/trac/ticket/1942
984 if (mustProvide("wasysym") &&
985 params_.use_package("wasysym") != BufferParams::package_off &&
986 (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
987 packages << "\\usepackage{wasysym}\n";
989 // esint must be after amsmath (and packages requiring amsmath, like mhchem)
990 // and wasysym, since it will redeclare inconsistent integral symbols
991 if (mustProvide("esint") &&
992 params_.use_package("esint") != BufferParams::package_off)
993 packages << "\\usepackage{esint}\n";
995 // Known bibliography packages (simple \usepackage{package})
996 for (int i = 0; i < nb_bibliofeatures; ++i) {
997 if (mustProvide(bibliofeatures[i]))
998 packages << "\\usepackage{"
999 << bibliofeatures[i] << "}\n";
1002 // Compatibility between achicago and natbib
1003 if (mustProvide("achicago") && mustProvide("natbib"))
1004 packages << "\\let\\achicagobib\\thebibliography\n";
1007 // Some classes load natbib themselves, but still allow (or even require)
1008 // plain numeric citations (ReVTeX is such a case, see bug 5182).
1009 // This special case is indicated by the "natbib-internal" key.
1010 if (mustProvide("natbib") && !isProvided("natbib-internal")) {
1011 packages << "\\usepackage[";
1012 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
1013 packages << "numbers";
1015 packages << "authoryear";
1016 packages << "]{natbib}\n";
1019 // Compatibility between achicago and natbib
1020 if (mustProvide("achicago") && mustProvide("natbib")) {
1021 packages << "\\let\\thebibliography\\achicagobib\n";
1022 packages << "\\let\\SCcite\\astroncite\n";
1023 packages << "\\let\\UnexpandableProtect\\protect\n";
1026 // jurabib -- we need version 0.6 at least.
1027 if (mustProvide("jurabib"))
1028 packages << "\\usepackage{jurabib}[2004/01/25]\n";
1030 // opcit -- we pass custombst as we output \bibliographystyle ourselves
1031 if (mustProvide("opcit")) {
1032 if (isRequired("hyperref"))
1033 packages << "\\usepackage[custombst,hyperref]{opcit}\n";
1035 packages << "\\usepackage[custombst]{opcit}\n";
1038 // xargs -- we need version 1.09 at least
1039 if (mustProvide("xargs"))
1040 packages << "\\usepackage{xargs}[2008/03/08]\n";
1042 if (mustProvide("xy"))
1043 packages << "\\usepackage[all]{xy}\n";
1045 if (mustProvide("feyn"))
1046 packages << "\\usepackage{feyn}\n"; //Diagram
1048 if (mustProvide("ulem"))
1049 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
1050 "\\usepackage{ulem}\n";
1052 if (mustProvide("nomencl")) {
1053 // Make it work with the new and old version of the package,
1054 // but don't use the compatibility option since it is
1055 // incompatible to other packages.
1056 packages << "\\usepackage{nomencl}\n"
1057 "% the following is useful when we have the old nomencl.sty package\n"
1058 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
1059 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
1060 "\\makenomenclature\n";
1063 // fixltx2e provides subscript
1064 if (mustProvide("subscript") && !isRequired("fixltx2e"))
1065 packages << "\\usepackage{subscript}\n";
1067 // footmisc must be loaded after setspace
1068 // Set options here, load the package after the user preamble to
1069 // avoid problems with manual loaded footmisc.
1070 if (mustProvide("footmisc"))
1071 packages << "\\PassOptionsToPackage{stable}{footmisc}\n";
1073 return packages.str();
1077 string LaTeXFeatures::getPreambleSnippets() const
1080 SnippetList::const_iterator pit = preamble_snippets_.begin();
1081 SnippetList::const_iterator pend = preamble_snippets_.end();
1082 for (; pit != pend; ++pit)
1083 snip << *pit << '\n';
1088 std::string LaTeXFeatures::getCSSSnippets() const
1091 SnippetList::const_iterator pit = css_snippets_.begin();
1092 SnippetList::const_iterator pend = css_snippets_.end();
1093 for (; pit != pend; ++pit)
1094 snip << *pit << '\n';
1099 docstring const LaTeXFeatures::getMacros() const
1101 odocstringstream macros;
1103 if (!preamble_snippets_.empty()) {
1105 macros << from_utf8(getPreambleSnippets());
1108 if (mustProvide("papersize")) {
1109 if (runparams_.flavor == OutputParams::LATEX)
1110 macros << papersizedvi_def << '\n';
1112 macros << papersizepdf_def << '\n';
1115 if (mustProvide("LyX")) {
1116 if (isRequired("hyperref"))
1117 macros << lyx_hyperref_def << '\n';
1119 macros << lyx_def << '\n';
1122 if (mustProvide("noun"))
1123 macros << noun_def << '\n';
1125 if (mustProvide("lyxarrow"))
1126 macros << lyxarrow_def << '\n';
1128 if (!usePolyglossia() && mustProvide("textgreek")) {
1129 // Avoid a LaTeX error if times fonts are used and the grtimes
1130 // package is installed but actual fonts are not (bug 6469).
1131 if (params_.fonts_roman == "times")
1132 macros << subst(textgreek_def,
1133 from_ascii("\\greektext #1"),
1134 from_ascii("%\n \\IfFileExists"
1135 "{grtm10.tfm}{}{\\fontfamily"
1136 "{cmr}}\\greektext #1"))
1139 macros << textgreek_def << '\n';
1142 if (!usePolyglossia() && mustProvide("textcyr"))
1143 macros << textcyr_def << '\n';
1145 if (mustProvide("lyxmathsym"))
1146 macros << lyxmathsym_def << '\n';
1148 if (mustProvide("cedilla"))
1149 macros << cedilla_def << '\n';
1151 if (mustProvide("subring"))
1152 macros << subring_def << '\n';
1154 if (mustProvide("subdot"))
1155 macros << subdot_def << '\n';
1157 if (mustProvide("subhat"))
1158 macros << subhat_def << '\n';
1160 if (mustProvide("subtilde"))
1161 macros << subtilde_def << '\n';
1163 if (mustProvide("dacute"))
1164 macros << dacute_def << '\n';
1166 if (mustProvide("tipasymb"))
1167 macros << tipasymb_def << '\n';
1169 if (mustProvide("dgrave"))
1170 macros << dgrave_def << '\n';
1172 if (mustProvide("rcap"))
1173 macros << rcap_def << '\n';
1175 if (mustProvide("ogonek"))
1176 macros << ogonek_def << '\n';
1179 if (mustProvide("quotesinglbase"))
1180 macros << quotesinglbase_def << '\n';
1181 if (mustProvide("quotedblbase"))
1182 macros << quotedblbase_def << '\n';
1183 if (mustProvide("guilsinglleft"))
1184 macros << guilsinglleft_def << '\n';
1185 if (mustProvide("guilsinglright"))
1186 macros << guilsinglright_def << '\n';
1187 if (mustProvide("guillemotleft"))
1188 macros << guillemotleft_def << '\n';
1189 if (mustProvide("guillemotright"))
1190 macros << guillemotright_def << '\n';
1193 if (mustProvide("binom") && !isRequired("amsmath"))
1194 macros << binom_def << '\n';
1195 if (mustProvide("mathcircumflex"))
1196 macros << mathcircumflex_def << '\n';
1199 if (mustProvide("ParagraphLeftIndent"))
1200 macros << paragraphleftindent_def;
1202 // some problems with tex->html converters
1203 if (mustProvide("NeedTabularnewline"))
1204 macros << tabularnewline_def;
1206 // greyed-out environment (note inset)
1207 // the color is specified in the routine
1208 // getColorOptions() to avoid LaTeX-package clashes
1209 if (mustProvide("lyxgreyedout"))
1210 macros << lyxgreyedout_def;
1212 if (mustProvide("lyxdot"))
1213 macros << lyxdot_def << '\n';
1216 getFloatDefinitions(macros);
1218 if (mustProvide("refstyle"))
1219 macros << lyxref_def << '\n';
1222 if (mustProvide("ct-dvipost"))
1223 macros << changetracking_dvipost_def;
1225 if (mustProvide("ct-xcolor-ulem")) {
1226 streamsize const prec = macros.precision(2);
1228 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1229 macros << "\\providecolor{lyxadded}{rgb}{"
1230 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1232 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1233 macros << "\\providecolor{lyxdeleted}{rgb}{"
1234 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1236 macros.precision(prec);
1238 if (isRequired("hyperref"))
1239 macros << changetracking_xcolor_ulem_hyperref_def;
1241 macros << changetracking_xcolor_ulem_def;
1244 if (mustProvide("ct-none"))
1245 macros << changetracking_none_def;
1247 if (mustProvide("rtloutputdblcol"))
1248 macros << rtloutputdblcol_def;
1250 return macros.str();
1254 string const LaTeXFeatures::getBabelPresettings() const
1258 LanguageList::const_iterator it = UsedLanguages_.begin();
1259 LanguageList::const_iterator end = UsedLanguages_.end();
1260 for (; it != end; ++it)
1261 if (!(*it)->babel_presettings().empty())
1262 tmp << (*it)->babel_presettings() << '\n';
1263 if (!params_.language->babel_presettings().empty())
1264 tmp << params_.language->babel_presettings() << '\n';
1266 if (!contains(tmp.str(), '@'))
1269 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1273 string const LaTeXFeatures::getBabelPostsettings() const
1277 LanguageList::const_iterator it = UsedLanguages_.begin();
1278 LanguageList::const_iterator end = UsedLanguages_.end();
1279 for (; it != end; ++it)
1280 if (!(*it)->babel_postsettings().empty())
1281 tmp << (*it)->babel_postsettings() << '\n';
1282 if (!params_.language->babel_postsettings().empty())
1283 tmp << params_.language->babel_postsettings() << '\n';
1285 if (!contains(tmp.str(), '@'))
1288 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1292 bool LaTeXFeatures::needBabelLangOptions() const
1294 if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1297 LanguageList::const_iterator it = UsedLanguages_.begin();
1298 LanguageList::const_iterator end = UsedLanguages_.end();
1299 for (; it != end; ++it)
1300 if ((*it)->asBabelOptions())
1307 string const LaTeXFeatures::loadAMSPackages() const
1311 if (mustProvide("amsmath")
1312 && params_.use_package("amsmath") != BufferParams::package_off) {
1313 tmp << "\\usepackage{amsmath}\n";
1315 // amsbsy and amstext are already provided by amsmath
1316 if (mustProvide("amsbsy"))
1317 tmp << "\\usepackage{amsbsy}\n";
1318 if (mustProvide("amstext"))
1319 tmp << "\\usepackage{amstext}\n";
1322 if (mustProvide("amsthm"))
1323 tmp << "\\usepackage{amsthm}\n";
1325 if (mustProvide("amssymb")
1326 && params_.use_package("amssymb") != BufferParams::package_off)
1327 tmp << "\\usepackage{amssymb}\n";
1333 docstring const LaTeXFeatures::getTClassPreamble() const
1335 // the text class specific preamble
1336 DocumentClass const & tclass = params_.documentClass();
1337 odocstringstream tcpreamble;
1339 tcpreamble << tclass.preamble();
1341 list<docstring>::const_iterator cit = usedLayouts_.begin();
1342 list<docstring>::const_iterator end = usedLayouts_.end();
1343 for (; cit != end; ++cit)
1344 tcpreamble << tclass[*cit].preamble();
1346 cit = usedInsetLayouts_.begin();
1347 end = usedInsetLayouts_.end();
1348 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1349 for (; cit != end; ++cit) {
1350 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1351 if (it == ils.end())
1353 tcpreamble << it->second.preamble();
1356 return tcpreamble.str();
1360 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1362 DocumentClass const & tclass = params_.documentClass();
1363 odocstringstream tcpreamble;
1365 tcpreamble << tclass.htmlpreamble();
1367 list<docstring>::const_iterator cit = usedLayouts_.begin();
1368 list<docstring>::const_iterator end = usedLayouts_.end();
1369 for (; cit != end; ++cit)
1370 tcpreamble << tclass[*cit].htmlpreamble();
1372 cit = usedInsetLayouts_.begin();
1373 end = usedInsetLayouts_.end();
1374 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1375 for (; cit != end; ++cit) {
1376 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1377 if (it == ils.end())
1379 tcpreamble << it->second.htmlpreamble();
1382 return tcpreamble.str();
1386 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1388 DocumentClass const & tclass = params_.documentClass();
1389 odocstringstream tcpreamble;
1391 if (mustProvide("noun"))
1392 tcpreamble << lyxnoun_style;
1393 // this isn't exact, but it won't hurt that much if it
1395 if (mustProvide("ulem"))
1396 tcpreamble << lyxstrikeout_style;
1398 tcpreamble << tclass.htmlstyles();
1400 list<docstring>::const_iterator cit = usedLayouts_.begin();
1401 list<docstring>::const_iterator end = usedLayouts_.end();
1402 for (; cit != end; ++cit)
1403 tcpreamble << tclass[*cit].htmlstyle();
1405 cit = usedInsetLayouts_.begin();
1406 end = usedInsetLayouts_.end();
1407 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1408 for (; cit != end; ++cit) {
1409 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1410 if (it == ils.end())
1412 tcpreamble << it->second.htmlstyle();
1415 return tcpreamble.str();
1421 docstring const getFloatI18nPreamble(docstring const & type,
1422 docstring const & name, Language const * lang,
1423 Encoding const & enc, bool const polyglossia)
1425 // Check whether name can be encoded in the buffer encoding
1426 bool encodable = true;
1427 for (size_t i = 0; i < name.size(); ++i) {
1428 if (!enc.encodable(name[i])) {
1434 docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1435 : from_ascii(lang->babel());
1436 docstring const langenc = from_ascii(lang->encoding()->iconvName());
1437 docstring const texenc = from_ascii(lang->encoding()->latexName());
1438 docstring const bufenc = from_ascii(enc.iconvName());
1439 docstring const s1 = docstring(1, 0xF0000);
1440 docstring const s2 = docstring(1, 0xF0001);
1441 docstring const translated = encodable ? name
1442 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1443 + s1 + langenc + s2 + name + s1 + bufenc + s2;
1445 odocstringstream os;
1446 os << "\\addto\\captions" << language
1447 << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1452 docstring const i18npreamble(docstring const & templ, Language const * lang,
1453 Encoding const & enc, bool const polyglossia,
1454 bool const need_fixedwidth)
1459 string preamble = polyglossia ?
1460 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
1461 subst(to_utf8(templ), "$$lang", lang->babel());
1463 string const langenc = lang->encoding()->iconvName();
1464 string const texenc = lang->encoding()->latexName();
1465 string const bufenc = enc.iconvName();
1466 Encoding const * testenc(&enc);
1467 bool lang_fallback = false;
1468 bool ascii_fallback = false;
1469 if (need_fixedwidth && !enc.hasFixedWidth()) {
1470 if (lang->encoding()->hasFixedWidth()) {
1471 testenc = lang->encoding();
1472 lang_fallback = true;
1474 // We need a fixed width encoding, but both the buffer
1475 // encoding and the language encoding are variable
1476 // width. As a last fallback, try to convert to pure
1477 // ASCII using the LaTeX commands defined in unicodesymbols.
1478 testenc = encodings.fromLyXName("ascii");
1481 ascii_fallback = true;
1484 // First and second character of plane 15 (Private Use Area)
1485 string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
1486 string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
1488 // lyx::regex is not unicode-safe.
1489 // Should use QRegExp or (boost::u32regex, but that requires ICU)
1490 static regex const reg("_\\(([^\\)]+)\\)");
1492 while (regex_search(preamble, sub, reg)) {
1493 string const key = sub.str(1);
1494 docstring const name = lang->translateLayout(key);
1495 // Check whether name can be encoded in the buffer encoding
1496 bool encodable = true;
1497 for (size_t i = 0; i < name.size() && encodable; ++i)
1498 if (!testenc->encodable(name[i]))
1501 if (encodable && !lang_fallback)
1502 translated = to_utf8(name);
1503 else if (ascii_fallback)
1504 translated = to_ascii(testenc->latexString(name).first);
1506 translated = "\\inputencoding{" + texenc + "}"
1507 + s1 + langenc + s2 + to_utf8(name)
1509 preamble = subst(preamble, sub.str(), translated);
1511 return from_utf8(preamble);
1517 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const
1519 DocumentClass const & tclass = params_.documentClass();
1520 // collect preamble snippets in a set to prevent multiple identical
1521 // commands (would happen if e.g. both theorem and theorem* are used)
1522 set<docstring> snippets;
1523 typedef LanguageList::const_iterator lang_it;
1524 lang_it const lbeg = UsedLanguages_.begin();
1525 lang_it const lend = UsedLanguages_.end();
1526 list<docstring>::const_iterator cit = usedLayouts_.begin();
1527 list<docstring>::const_iterator end = usedLayouts_.end();
1528 for (; cit != end; ++cit) {
1529 // language dependent commands (once per document)
1530 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
1531 buffer().language(),
1532 buffer().params().encoding(),
1533 use_polyglossia, false));
1534 // commands for language changing (for multilanguage documents)
1535 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1536 snippets.insert(i18npreamble(
1537 tclass[*cit].babelpreamble(),
1538 buffer().language(),
1539 buffer().params().encoding(),
1540 use_polyglossia, false));
1541 for (lang_it lit = lbeg; lit != lend; ++lit)
1542 snippets.insert(i18npreamble(
1543 tclass[*cit].babelpreamble(),
1545 buffer().params().encoding(),
1546 use_polyglossia, false));
1549 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1550 FloatList const & floats = params_.documentClass().floats();
1551 UsedFloats::const_iterator fit = usedFloats_.begin();
1552 UsedFloats::const_iterator fend = usedFloats_.end();
1553 for (; fit != fend; ++fit) {
1554 Floating const & fl = floats.getType(fit->first);
1555 // we assume builtin floats are translated
1556 if (fl.isPredefined())
1558 docstring const type = from_ascii(fl.floattype());
1559 docstring const flname = from_utf8(fl.name());
1560 docstring name = buffer().language()->translateLayout(fl.name());
1561 // only request translation if we have a real translation
1562 // (that differs from the source)
1564 snippets.insert(getFloatI18nPreamble(
1565 type, name, buffer().language(),
1566 buffer().params().encoding(),
1568 for (lang_it lit = lbeg; lit != lend; ++lit) {
1569 string const code = (*lit)->code();
1570 name = (*lit)->translateLayout(fl.name());
1571 // we assume we have a suitable translation if
1572 // either the language is English (we need to
1573 // translate into English if English is a secondary
1574 // language) or if translateIfPossible returns
1575 // something different to the English source.
1576 bool const have_translation =
1577 (flname != name || contains(code, "en"));
1578 if (have_translation)
1579 snippets.insert(getFloatI18nPreamble(
1581 buffer().params().encoding(),
1587 cit = usedInsetLayouts_.begin();
1588 end = usedInsetLayouts_.end();
1589 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1590 for (; cit != end; ++cit) {
1591 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1592 if (it == ils.end())
1594 // The listings package does not work with variable width
1595 // encodings, only with fixed width encodings. Therefore we
1596 // need to force a fixed width encoding for
1597 // \lstlistlistingname and \lstlistingname (bug 9382).
1598 // This needs to be consistent with InsetListings::latex().
1599 bool const need_fixedwidth = !runparams_.isFullUnicode() &&
1600 it->second.fixedwidthpreambleencoding();
1601 // language dependent commands (once per document)
1602 snippets.insert(i18npreamble(it->second.langpreamble(),
1603 buffer().language(),
1604 buffer().params().encoding(),
1605 use_polyglossia, need_fixedwidth));
1606 // commands for language changing (for multilanguage documents)
1607 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1608 snippets.insert(i18npreamble(
1609 it->second.babelpreamble(),
1610 buffer().language(),
1611 buffer().params().encoding(),
1612 use_polyglossia, need_fixedwidth));
1613 for (lang_it lit = lbeg; lit != lend; ++lit)
1614 snippets.insert(i18npreamble(
1615 it->second.babelpreamble(),
1617 buffer().params().encoding(),
1618 use_polyglossia, need_fixedwidth));
1622 odocstringstream tcpreamble;
1623 set<docstring>::const_iterator const send = snippets.end();
1624 set<docstring>::const_iterator it = snippets.begin();
1625 for (; it != send; ++it)
1627 return tcpreamble.str();
1631 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1633 // Definition of entities used in the document that are LyX related.
1634 odocstringstream entities;
1636 if (mustProvide("lyxarrow")) {
1637 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
1640 return entities.str();
1644 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1646 odocstringstream sgmlpreamble;
1648 docstring const basename(from_utf8(onlyPath(fname)));
1650 FileMap::const_iterator end = IncludedFiles_.end();
1651 for (FileMap::const_iterator fi = IncludedFiles_.begin();
1654 sgmlpreamble << "\n<!ENTITY " << fi->first
1655 << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1656 << makeRelPath(from_utf8(fi->second), basename) << "\">";
1658 return sgmlpreamble.str();
1662 void LaTeXFeatures::showStruct() const
1664 lyxerr << "LyX needs the following commands when LaTeXing:"
1665 << "\n***** Packages:" << getPackages()
1666 << "\n***** Macros:" << to_utf8(getMacros())
1667 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1668 << "\n***** done." << endl;
1672 Buffer const & LaTeXFeatures::buffer() const
1678 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1684 BufferParams const & LaTeXFeatures::bufferParams() const
1690 void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
1692 FloatList const & floats = params_.documentClass().floats();
1694 // Here we will output the code to create the needed float styles.
1695 // We will try to do this as minimal as possible.
1696 // \floatstyle{ruled}
1697 // \newfloat{algorithm}{htbp}{loa}
1698 // \providecommand{\algorithmname}{Algorithm}
1699 // \floatname{algorithm}{\protect\algorithmname}
1700 UsedFloats::const_iterator cit = usedFloats_.begin();
1701 UsedFloats::const_iterator end = usedFloats_.end();
1702 for (; cit != end; ++cit) {
1703 Floating const & fl = floats.getType(cit->first);
1705 // For builtin floats we do nothing.
1706 if (fl.isPredefined())
1709 // We have to special case "table" and "figure"
1710 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1711 // Output code to modify "table" or "figure"
1712 // but only if builtin == false
1713 // and that have to be true at this point in the
1715 docstring const type = from_ascii(fl.floattype());
1716 docstring const placement = from_ascii(fl.placement());
1717 docstring const style = from_ascii(fl.style());
1718 if (!style.empty()) {
1719 os << "\\floatstyle{" << style << "}\n"
1720 << "\\restylefloat{" << type << "}\n";
1722 if (!placement.empty()) {
1723 os << "\\floatplacement{" << type << "}{"
1724 << placement << "}\n";
1727 // The other non builtin floats.
1729 docstring const type = from_ascii(fl.floattype());
1730 docstring const placement = from_ascii(fl.placement());
1731 docstring const ext = from_ascii(fl.ext());
1732 docstring const within = from_ascii(fl.within());
1733 docstring const style = from_ascii(fl.style());
1734 docstring const name =
1735 buffer().language()->translateLayout(fl.name());
1736 os << "\\floatstyle{" << style << "}\n"
1737 << "\\newfloat{" << type << "}{" << placement
1738 << "}{" << ext << '}';
1739 if (!within.empty())
1740 os << '[' << within << ']';
1742 << "\\providecommand{\\" << type << "name}{"
1744 << "\\floatname{" << type << "}{\\protect\\"
1745 << type << "name}\n";
1747 // What missing here is to code to minimalize the code
1748 // output so that the same floatstyle will not be
1749 // used several times, when the same style is still in
1753 // The subfig package is loaded later
1754 os << "\n\\AtBeginDocument{\\newsubfloat{" << from_ascii(fl.floattype()) << "}}\n";
1759 void LaTeXFeatures::resolveAlternatives()
1761 for (Features::iterator it = features_.begin(); it != features_.end();) {
1762 if (contains(*it, '|')) {
1763 vector<string> const alternatives = getVectorFromString(*it, "|");
1764 vector<string>::const_iterator const end = alternatives.end();
1765 vector<string>::const_iterator ita = alternatives.begin();
1766 // Is any alternative already required? => use that
1767 for (; ita != end; ++ita) {
1768 if (isRequired(*ita))
1771 // Is any alternative available? => use the first one
1774 for (ita = alternatives.begin(); ita != end; ++ita) {
1775 if (isAvailable(*ita)) {
1781 // This will not work, but not requiring something
1782 // would be more confusing
1784 require(alternatives.front());
1785 features_.erase(it);
1786 it = features_.begin();