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"
30 #include "TextClass.h"
32 #include "insets/InsetLayout.h"
34 #include "support/debug.h"
35 #include "support/docstream.h"
36 #include "support/FileName.h"
37 #include "support/filetools.h"
38 #include "support/gettext.h"
39 #include "support/lstrings.h"
45 using namespace lyx::support;
50 /////////////////////////////////////////////////////////////////////
54 /////////////////////////////////////////////////////////////////////
56 //\NeedsTeXFormat{LaTeX2e}
57 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
58 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
60 static docstring const lyx_def = from_ascii(
61 "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}");
63 static docstring const lyx_hyperref_def = from_ascii(
64 "\\providecommand{\\LyX}{\\texorpdfstring%\n"
65 " {L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}\n"
68 static docstring const noun_def = from_ascii(
69 "\\newcommand{\\noun}[1]{\\textsc{#1}}");
71 static docstring const lyxarrow_def = from_ascii(
72 "\\DeclareRobustCommand*{\\lyxarrow}{%\n"
74 "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
75 "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}");
77 // for quotes without babel. This does not give perfect results, but
78 // anybody serious about non-english quotes should use babel (JMarc).
80 static docstring const quotedblbase_def = from_ascii(
81 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
82 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
83 " \\penalty10000\\hskip0em\\relax%\n"
86 static docstring const quotesinglbase_def = from_ascii(
87 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
88 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
89 " \\penalty10000\\hskip0em\\relax%\n"
92 static docstring const guillemotleft_def = from_ascii(
93 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
94 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
95 "\\penalty10000\\hskip0pt\\relax%\n"
98 static docstring const guillemotright_def = from_ascii(
99 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
100 " \\penalty10000\\hskip0pt%\n"
101 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
104 static docstring const guilsinglleft_def = from_ascii(
105 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
106 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
107 " \\penalty10000\\hskip0pt\\relax%\n"
110 static docstring const guilsinglright_def = from_ascii(
111 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
112 " \\penalty10000\\hskip0pt%\n"
113 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
116 static docstring const paragraphleftindent_def = from_ascii(
117 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
119 " \\begin{list}{}{%\n"
120 " \\setlength{\\topsep}{0pt}%\n"
121 " \\addtolength{\\leftmargin}{#1}\n"
122 // ho hum, yet more things commented out with no hint as to why they
123 // weren't just removed
124 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
125 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
126 // "%% \\setlength\\listparindent\\parindent%\n"
127 // "%% \\setlength\\itemindent\\parindent%\n"
128 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
134 static docstring const floatingfootnote_def = from_ascii(
135 "%% Special footnote code from the package 'stblftnt.sty'\n"
136 "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
137 "\\let\\SF@@footnote\\footnote\n"
138 "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
139 " \\expandafter\\SF@@footnote\n"
141 " \\expandafter\\SF@gobble@opt\n"
144 "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
145 " \\SF@gobble@twobracket\n"
148 "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
149 " \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
150 "\\def\\SF@gobble@twobracket[#1]#2{}\n");
152 static docstring const binom_def = from_ascii(
153 "%% Binom macro for standard LaTeX users\n"
154 "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n");
156 static docstring const mathcircumflex_def = from_ascii(
157 "%% For printing a cirumflex inside a formula\n"
158 "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n");
160 static docstring const tabularnewline_def = from_ascii(
161 "%% Because html converters don't know tabularnewline\n"
162 "\\providecommand{\\tabularnewline}{\\\\}\n");
164 static docstring const lyxgreyedout_def = from_ascii(
165 "%% The greyedout annotation environment\n"
166 "\\newenvironment{lyxgreyedout}\n"
167 " {\\textcolor{note_fontcolor}\\bgroup\\ignorespaces}\n"
168 " {\\ignorespacesafterend\\egroup}\n");
170 // We want to omit the file extension for includegraphics, but this does not
171 // work when the filename contains other dots.
172 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
173 static docstring const lyxdot_def = from_ascii(
174 "%% A simple dot to overcome graphicx limitations\n"
175 "\\newcommand{\\lyxdot}{.}\n");
177 static docstring const changetracking_dvipost_def = from_ascii(
178 "%% Change tracking with dvipost\n"
180 "\\dvipost{osstart color push Red}\n"
181 "\\dvipost{osend color pop}\n"
182 "\\dvipost{cbstart color push Blue}\n"
183 "\\dvipost{cbend color pop}\n"
184 "\\newcommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
185 "\\newcommand{\\lyxdeleted}[3]{%\n"
186 "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n");
188 static docstring const changetracking_xcolor_ulem_def = from_ascii(
189 "%% Change tracking with ulem\n"
190 "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}{}#3}}\n"
191 "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\sout{#3}}}\n");
193 static docstring const changetracking_xcolor_ulem_hyperref_def = from_ascii(
194 "%% Change tracking with ulem\n"
195 "\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}{}}{}#3}}\n"
196 "\\newcommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\sout{#3}}{}}}\n");
198 static docstring const changetracking_none_def = from_ascii(
199 "\\newcommand{\\lyxadded}[3]{#3}\n"
200 "\\newcommand{\\lyxdeleted}[3]{}\n");
202 static docstring const textgreek_def = from_ascii(
203 "\\DeclareRobustCommand{\\greektext}{%\n"
204 " \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
205 "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
206 "\\DeclareFontEncoding{LGR}{}{}\n"
207 "\\DeclareTextSymbol{\\~}{LGR}{126}");
209 static docstring const textcyr_def = from_ascii(
210 "\\DeclareRobustCommand{\\cyrtext}{%\n"
211 " \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
212 "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
213 "\\AtBeginDocument{\\DeclareFontEncoding{T2A}{}{}}\n");
215 static docstring const lyxmathsym_def = from_ascii(
216 "\\newcommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
217 " \\text{\\ifx\\math@version\\b@ld\\bfseries\\fi#1}\\endgroup\\else#1\\fi}\n");
219 static docstring const papersizedvi_def = from_ascii(
220 "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n");
222 static docstring const papersizepdf_def = from_ascii(
223 "\\pdfpageheight\\paperheight\n"
224 "\\pdfpagewidth\\paperwidth\n");
226 static docstring const cedilla_def = from_ascii(
227 "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
228 "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n");
230 static docstring const subring_def = from_ascii(
231 "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
232 "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n");
234 static docstring const subdot_def = from_ascii(
235 "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
236 "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n");
238 static docstring const subhat_def = from_ascii(
239 "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
240 "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n");
242 static docstring const subtilde_def = from_ascii(
243 "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
244 "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n");
246 static docstring const dacute_def = from_ascii(
247 "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n");
249 static docstring const tipasymb_def = from_ascii(
250 "\\DeclareFontEncoding{T3}{}{}\n"
251 "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n");
253 static docstring const dgrave_def = from_ascii(
254 "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n");
256 static docstring const rcap_def = from_ascii(
257 "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n");
259 static docstring const ogonek_def = from_ascii(
260 "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
261 " \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
262 " \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
263 " \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
264 "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n");
266 static docstring const lyxref_def = from_ascii(
267 "\\RS@ifundefined{subref}\n"
268 " {\\def\\RSsubtxt{section~}\\newref{sub}{name = \\RSsubtxt}}\n"
270 "\\RS@ifundefined{thmref}\n"
271 " {\\def\\RSthmtxt{theorem~}\\newref{thm}{name = \\RSthmtxt}}\n"
273 "\\RS@ifundefined{lemref}\n"
274 " {\\def\\RSlemtxt{lemma~}\\newref{lem}{name = \\RSlemtxt}}\n"
278 /////////////////////////////////////////////////////////////////////
282 /////////////////////////////////////////////////////////////////////
284 LaTeXFeatures::Packages LaTeXFeatures::packages_;
287 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
288 OutputParams const & r)
289 : buffer_(&b), params_(p), runparams_(r), in_float_(false)
293 bool LaTeXFeatures::useBabel() const
295 if (usePolyglossia())
297 if (bufferParams().lang_package == "default")
298 return (lyxrc.language_package_selection != LyXRC::LP_NONE)
299 || (bufferParams().language->lang() != lyxrc.default_language
300 && !bufferParams().language->babel().empty())
301 || this->hasLanguages();
302 return (bufferParams().lang_package != "none")
303 || (bufferParams().language->lang() != lyxrc.default_language
304 && !bufferParams().language->babel().empty())
305 || this->hasLanguages();
309 bool LaTeXFeatures::usePolyglossia() const
311 if (bufferParams().lang_package == "default")
312 return (lyxrc.language_package_selection == LyXRC::LP_AUTO)
313 && isRequired("polyglossia")
314 && isAvailable("polyglossia")
315 && !params_.documentClass().provides("babel")
316 && this->hasPolyglossiaLanguages();
317 return (bufferParams().lang_package == "auto")
318 && isRequired("polyglossia")
319 && isAvailable("polyglossia")
320 && !params_.documentClass().provides("babel")
321 && this->hasPolyglossiaLanguages();
325 void LaTeXFeatures::require(string const & name)
327 features_.insert(name);
331 void LaTeXFeatures::require(set<string> const & names)
333 features_.insert(names.begin(), names.end());
337 void LaTeXFeatures::getAvailable()
340 support::FileName const real_file = libFileSearch("", "packages.lst");
342 if (real_file.empty())
345 lex.setFile(real_file);
350 // Make sure that we are clean
353 bool finished = false;
355 while (lex.isOK() && !finished) {
357 case Lexer::LEX_FEOF:
361 packages_.insert(lex.getString());
367 void LaTeXFeatures::useLayout(docstring const & layoutname)
369 // Some code to avoid loops in dependency definition
370 static int level = 0;
371 const int maxlevel = 30;
372 if (level > maxlevel) {
373 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
374 << "recursion attained by layout "
375 << to_utf8(layoutname) << endl;
379 DocumentClass const & tclass = params_.documentClass();
380 if (tclass.hasLayout(layoutname)) {
381 // Is this layout already in usedLayouts?
382 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
383 != usedLayouts_.end())
386 Layout const & layout = tclass[layoutname];
387 require(layout.requires());
389 if (!layout.depends_on().empty()) {
391 useLayout(layout.depends_on());
394 usedLayouts_.push_back(layoutname);
396 lyxerr << "LaTeXFeatures::useLayout: layout `"
397 << to_utf8(layoutname) << "' does not exist in this class"
405 void LaTeXFeatures::useInsetLayout(InsetLayout const & lay)
407 docstring const & lname = lay.name();
408 DocumentClass const & tclass = params_.documentClass();
410 // this is a default inset layout, nothing useful here
411 if (!tclass.hasInsetLayout(lname))
413 // Is this layout already in usedInsetLayouts?
414 if (find(usedInsetLayouts_.begin(), usedInsetLayouts_.end(), lname)
415 != usedInsetLayouts_.end())
418 require(lay.requires());
419 usedInsetLayouts_.push_back(lname);
423 bool LaTeXFeatures::isRequired(string const & name) const
425 return features_.find(name) != features_.end();
429 bool LaTeXFeatures::mustProvide(string const & name) const
431 return isRequired(name) && !params_.documentClass().provides(name);
435 bool LaTeXFeatures::isAvailable(string const & name)
437 string::size_type const i = name.find("->");
438 if (i != string::npos) {
439 string const from = name.substr(0,i);
440 string const to = name.substr(i+2);
441 //LYXERR0("from=[" << from << "] to=[" << to << "]");
442 return theConverters().isReachable(from, to);
445 if (packages_.empty())
448 if (suffixIs(n, ".sty"))
449 n.erase(name.length() - 4);
450 return packages_.find(n) != packages_.end();
454 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
456 SnippetList::const_iterator begin = preamble_snippets_.begin();
457 SnippetList::const_iterator end = preamble_snippets_.end();
458 if (find(begin, end, preamble) == end)
459 preamble_snippets_.push_back(preamble);
463 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
465 if (!usedFloats_[name])
466 usedFloats_[name] = subfloat;
469 // We only need float.sty if we use non builtin floats, or if we
470 // use the "H" modifier. This includes modified table and
471 // figure floats. (Lgb)
472 Floating const & fl = params_.documentClass().floats().getType(name);
473 if (!fl.floattype().empty() && fl.usesFloatPkg()) {
479 void LaTeXFeatures::useLanguage(Language const * lang)
481 if (!lang->babel().empty())
482 UsedLanguages_.insert(lang);
483 if (lang->lang() == "vietnamese")
484 require("vietnamese");
485 // CJK languages do not have a babel name.
486 // They use the CJK package
487 if (lang->encoding()->package() == Encoding::CJK)
489 // japanese package is special
490 if (lang->encoding()->package() == Encoding::japanese)
495 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
497 IncludedFiles_[key] = name;
501 bool LaTeXFeatures::hasLanguages() const
503 return !UsedLanguages_.empty();
507 bool LaTeXFeatures::hasPolyglossiaLanguages() const
509 LanguageList::const_iterator const begin = UsedLanguages_.begin();
510 for (LanguageList::const_iterator cit = begin;
511 cit != UsedLanguages_.end();
513 if ((*cit)->polyglossia().empty())
520 string LaTeXFeatures::getLanguages() const
522 ostringstream languages;
524 LanguageList::const_iterator const begin = UsedLanguages_.begin();
525 for (LanguageList::const_iterator cit = begin;
526 cit != UsedLanguages_.end();
530 languages << (*cit)->babel();
532 return languages.str();
536 std::map<std::string, std::string> LaTeXFeatures::getPolyglossiaLanguages() const
538 std::map<std::string, std::string> languages;
540 LanguageList::const_iterator const begin = UsedLanguages_.begin();
541 for (LanguageList::const_iterator cit = begin;
542 cit != UsedLanguages_.end();
544 languages[(*cit)->polyglossia()] = (*cit)->polyglossiaOpts();
550 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
552 // This does only find encodings of languages supported by babel, but
553 // that does not matter since we don't have a language with an
554 // encoding supported by inputenc but without babel support.
555 set<string> encodings;
556 LanguageList::const_iterator it = UsedLanguages_.begin();
557 LanguageList::const_iterator end = UsedLanguages_.end();
558 for (; it != end; ++it)
559 if ((*it)->encoding()->latexName() != doc_encoding &&
560 ((*it)->encoding()->package() == Encoding::inputenc
561 || (*it)->encoding()->package() == Encoding::japanese))
562 encodings.insert((*it)->encoding()->latexName());
568 char const * simplefeatures[] = {
569 // note that the package order here will be the same in the LaTeX-output
576 // subfig is handled in BufferParams.cpp
580 /*For a successful cooperation of the `wrapfig' package with the
581 `float' package you should load the `wrapfig' package *after*
582 the `float' package. See the caption package documentation
611 // listings is handled in BufferParams.cpp
620 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
625 string const LaTeXFeatures::getColorOptions() const
627 ostringstream colors;
629 // Handling the color packages separately is needed to be able to load them
630 // before babel when hyperref is loaded with the colorlinks option
631 // for more info see Bufferparams.cpp
634 if (mustProvide("color") || mustProvide("xcolor")) {
635 string const package =
636 (mustProvide("xcolor") ? "xcolor" : "color");
637 if (params_.graphics_driver == "default"
638 || params_.graphics_driver == "none")
639 colors << "\\usepackage{" << package << "}\n";
641 colors << "\\usepackage["
642 << params_.graphics_driver
643 << "]{" << package << "}\n";
646 // pdfcolmk must be loaded after color
647 if (mustProvide("pdfcolmk"))
648 colors << "\\usepackage{pdfcolmk}\n";
650 // the following 3 color commands must be set after color
651 // is loaded and before pdfpages, therefore add the command
652 // here define the set color
653 if (mustProvide("pagecolor")) {
654 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
655 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
656 // set the page color
657 colors << "\\pagecolor{page_backgroundcolor}\n";
660 if (mustProvide("fontcolor")) {
661 colors << "\\definecolor{document_fontcolor}{rgb}{";
662 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
664 colors << "\\color{document_fontcolor}\n";
667 if (mustProvide("lyxgreyedout")) {
668 colors << "\\definecolor{note_fontcolor}{rgb}{";
669 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
670 // the color will be set together with the definition of
671 // the lyxgreyedout environment (see lyxgreyedout_def)
674 // color for shaded boxes
675 if (isRequired("framed") && mustProvide("color")) {
676 colors << "\\definecolor{shadecolor}{rgb}{";
677 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
678 // this color is automatically used by the LaTeX-package "framed"
685 string const LaTeXFeatures::getPackages() const
687 ostringstream packages;
688 DocumentClass const & tclass = params_.documentClass();
690 // FIXME: currently, we can only load packages and macros known
692 // However, with the Require tag of layouts/custom insets,
693 // also unknown packages can be requested. They are silently
694 // swallowed now. We should change this eventually.
697 // These are all the 'simple' includes. i.e
698 // packages which we just \usepackage{package}
700 for (int i = 0; i < nb_simplefeatures; ++i) {
701 if (mustProvide(simplefeatures[i]))
702 packages << "\\usepackage{"
703 << simplefeatures[i] << "}\n";
707 // The rest of these packages are somewhat more complicated
711 // if fontspec is used, AMS packages have to be loaded before
712 // fontspec (in BufferParams)
713 if (!params_.useNonTeXFonts && !loadAMSPackages().empty())
714 packages << loadAMSPackages();
716 // fixltx2e must be loaded after amsthm, since amsthm produces an error with
717 // the redefined \[ command (bug 7233). Load is as early as possible, since
718 // other packages might profit from it.
719 if (mustProvide("fixltx2e"))
720 packages << "\\usepackage{fixltx2e}\n";
722 // wasysym is a simple feature, but it must be after amsmath if both
724 // wasysym redefines some integrals (e.g. iint) from amsmath. That
725 // leads to inconsistent integrals. We only load this package if
726 // the document does not contain integrals (then isRequired("esint")
727 // is false) or if esint is used, since esint redefines all relevant
728 // integral symbols from wasysym and amsmath.
729 // See http://www.lyx.org/trac/ticket/1942
730 if (mustProvide("wasysym") &&
731 (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
732 packages << "\\usepackage{wasysym}\n";
734 // accents must be loaded after amsmath
735 if (mustProvide("accents"))
736 packages << "\\usepackage{accents}\n";
738 // mathdots must be loaded after amsmath
739 if (mustProvide("mathdots") &&
740 params_.use_mathdots != BufferParams::package_off)
741 packages << "\\usepackage{mathdots}\n";
743 // yhmath must be loaded after amsmath
744 if (mustProvide("yhmath"))
745 packages << "\\usepackage{yhmath}\n";
747 // [x]color and pdfcolmk are handled in getColorOptions() above
750 if (isRequired("makeidx") || isRequired("splitidx")) {
751 if (!tclass.provides("makeidx") && !isRequired("splitidx"))
752 packages << "\\usepackage{makeidx}\n";
753 if (!tclass.provides("splitidx") && isRequired("splitidx"))
754 packages << "\\usepackage{splitidx}\n";
755 packages << "\\makeindex\n";
759 if (mustProvide("graphicx") && params_.graphics_driver != "none") {
760 if (params_.graphics_driver == "default")
761 packages << "\\usepackage{graphicx}\n";
763 packages << "\\usepackage["
764 << params_.graphics_driver
768 // lyxskak.sty --- newer chess support based on skak.sty
769 if (mustProvide("chess"))
770 packages << "\\usepackage[ps,mover]{lyxskak}\n";
773 if (mustProvide("setspace") && !tclass.provides("SetSpace"))
774 packages << "\\usepackage{setspace}\n";
776 // esint must be after amsmath and wasysym, since it will redeclare
777 // inconsistent integral symbols
778 if ((mustProvide("esint") || mustProvide("esintoramsmath")) &&
779 params_.use_esint != BufferParams::package_off)
780 packages << "\\usepackage{esint}\n";
783 // Some classes load natbib themselves, but still allow (or even require)
784 // plain numeric citations (ReVTeX is such a case, see bug 5182).
785 // This special case is indicated by the "natbib-internal" key.
786 if (mustProvide("natbib") && !tclass.provides("natbib-internal")) {
787 packages << "\\usepackage[";
788 if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
789 packages << "numbers";
791 packages << "authoryear";
792 packages << "]{natbib}\n";
795 // jurabib -- we need version 0.6 at least.
796 if (mustProvide("jurabib"))
797 packages << "\\usepackage{jurabib}[2004/01/25]\n";
799 // xargs -- we need version 1.09 at least
800 if (mustProvide("xargs"))
801 packages << "\\usepackage{xargs}[2008/03/08]\n";
803 // bibtopic -- the dot provides the aux file naming which
805 if (mustProvide("bibtopic"))
806 packages << "\\usepackage[dot]{bibtopic}\n";
808 if (mustProvide("xy"))
809 packages << "\\usepackage[all]{xy}\n";
811 if (mustProvide("feyn"))
812 packages << "\\usepackage{feyn}\n"; //Diagram
814 if (mustProvide("ulem"))
815 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
816 "\\usepackage{ulem}\n";
818 if (params_.use_mhchem == BufferParams::package_on ||
819 (mustProvide("mhchem") &&
820 params_.use_mhchem != BufferParams::package_off))
821 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
822 "\\usepackage{mhchem}\n";
824 if (mustProvide("nomencl")) {
825 // Make it work with the new and old version of the package,
826 // but don't use the compatibility option since it is
827 // incompatible to other packages.
828 packages << "\\usepackage{nomencl}\n"
829 "% the following is useful when we have the old nomencl.sty package\n"
830 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
831 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
832 "\\makenomenclature\n";
835 // fixltx2e provides subscript
836 if (mustProvide("subscript") && !isRequired("fixltx2e"))
837 packages << "\\usepackage{subscript}\n";
839 return packages.str();
843 string LaTeXFeatures::getPreambleSnippets() const
846 SnippetList::const_iterator pit = preamble_snippets_.begin();
847 SnippetList::const_iterator pend = preamble_snippets_.end();
848 for (; pit != pend; ++pit)
849 snip << *pit << '\n';
854 docstring const LaTeXFeatures::getMacros() const
856 odocstringstream macros;
858 if (!preamble_snippets_.empty()) {
860 macros << from_utf8(getPreambleSnippets());
863 if (mustProvide("papersize")) {
864 if (runparams_.flavor == OutputParams::LATEX)
865 macros << papersizedvi_def << '\n';
867 macros << papersizepdf_def << '\n';
870 if (mustProvide("LyX")) {
871 if (isRequired("hyperref"))
872 macros << lyx_hyperref_def << '\n';
874 macros << lyx_def << '\n';
877 if (mustProvide("noun"))
878 macros << noun_def << '\n';
880 if (mustProvide("lyxarrow"))
881 macros << lyxarrow_def << '\n';
883 if (!usePolyglossia() && mustProvide("textgreek")) {
884 // Avoid a LaTeX error if times fonts are used and the grtimes
885 // package is installed but actual fonts are not (bug 6469).
886 if (params_.fonts_roman == "times")
887 macros << subst(textgreek_def,
888 from_ascii("\\greektext #1"),
889 from_ascii("%\n \\IfFileExists"
890 "{grtm10.tfm}{}{\\fontfamily"
891 "{cmr}}\\greektext #1"))
894 macros << textgreek_def << '\n';
897 if (!usePolyglossia() && mustProvide("textcyr"))
898 macros << textcyr_def << '\n';
900 if (mustProvide("lyxmathsym"))
901 macros << lyxmathsym_def << '\n';
903 if (mustProvide("cedilla"))
904 macros << cedilla_def << '\n';
906 if (mustProvide("subring"))
907 macros << subring_def << '\n';
909 if (mustProvide("subdot"))
910 macros << subdot_def << '\n';
912 if (mustProvide("subhat"))
913 macros << subhat_def << '\n';
915 if (mustProvide("subtilde"))
916 macros << subtilde_def << '\n';
918 if (mustProvide("dacute"))
919 macros << dacute_def << '\n';
921 if (mustProvide("tipasymb"))
922 macros << tipasymb_def << '\n';
924 if (mustProvide("dgrave"))
925 macros << dgrave_def << '\n';
927 if (mustProvide("rcap"))
928 macros << rcap_def << '\n';
930 if (mustProvide("ogonek"))
931 macros << ogonek_def << '\n';
934 if (mustProvide("quotesinglbase"))
935 macros << quotesinglbase_def << '\n';
936 if (mustProvide("quotedblbase"))
937 macros << quotedblbase_def << '\n';
938 if (mustProvide("guilsinglleft"))
939 macros << guilsinglleft_def << '\n';
940 if (mustProvide("guilsinglright"))
941 macros << guilsinglright_def << '\n';
942 if (mustProvide("guillemotleft"))
943 macros << guillemotleft_def << '\n';
944 if (mustProvide("guillemotright"))
945 macros << guillemotright_def << '\n';
948 if (mustProvide("binom") && !isRequired("amsmath"))
949 macros << binom_def << '\n';
950 if (mustProvide("mathcircumflex"))
951 macros << mathcircumflex_def << '\n';
954 if (mustProvide("ParagraphLeftIndent"))
955 macros << paragraphleftindent_def;
956 if (mustProvide("NeedLyXFootnoteCode"))
957 macros << floatingfootnote_def;
959 // some problems with tex->html converters
960 if (mustProvide("NeedTabularnewline"))
961 macros << tabularnewline_def;
963 // greyed-out environment (note inset)
964 // the color is specified in the routine
965 // getColorOptions() to avoid LaTeX-package clashes
966 if (mustProvide("lyxgreyedout"))
967 macros << lyxgreyedout_def;
969 if (mustProvide("lyxdot"))
970 macros << lyxdot_def << '\n';
973 getFloatDefinitions(macros);
975 if (mustProvide("refstyle"))
976 macros << lyxref_def << '\n';
979 if (mustProvide("ct-dvipost"))
980 macros << changetracking_dvipost_def;
982 if (mustProvide("ct-xcolor-ulem")) {
983 streamsize const prec = macros.precision(2);
985 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
986 macros << "\\providecolor{lyxadded}{rgb}{"
987 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
989 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
990 macros << "\\providecolor{lyxdeleted}{rgb}{"
991 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
993 macros.precision(prec);
995 if (isRequired("hyperref"))
996 macros << changetracking_xcolor_ulem_hyperref_def;
998 macros << changetracking_xcolor_ulem_def;
1001 if (mustProvide("ct-none"))
1002 macros << changetracking_none_def;
1004 return macros.str();
1008 string const LaTeXFeatures::getBabelPresettings() const
1012 LanguageList::const_iterator it = UsedLanguages_.begin();
1013 LanguageList::const_iterator end = UsedLanguages_.end();
1014 for (; it != end; ++it)
1015 if (!(*it)->babel_presettings().empty())
1016 tmp << (*it)->babel_presettings() << '\n';
1017 if (!params_.language->babel_presettings().empty())
1018 tmp << params_.language->babel_presettings() << '\n';
1024 string const LaTeXFeatures::getBabelPostsettings() const
1028 LanguageList::const_iterator it = UsedLanguages_.begin();
1029 LanguageList::const_iterator end = UsedLanguages_.end();
1030 for (; it != end; ++it)
1031 if (!(*it)->babel_postsettings().empty())
1032 tmp << (*it)->babel_postsettings() << '\n';
1033 if (!params_.language->babel_postsettings().empty())
1034 tmp << params_.language->babel_postsettings() << '\n';
1040 bool LaTeXFeatures::needBabelLangOptions() const
1042 if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1045 LanguageList::const_iterator it = UsedLanguages_.begin();
1046 LanguageList::const_iterator end = UsedLanguages_.end();
1047 for (; it != end; ++it)
1048 if ((*it)->asBabelOptions())
1055 string const LaTeXFeatures::loadAMSPackages() const
1058 if (mustProvide("amsthm"))
1059 tmp << "\\usepackage{amsthm}\n";
1061 // esint is preferred for esintoramsmath
1062 if ((mustProvide("amsmath")
1063 && params_.use_amsmath != BufferParams::package_off)
1064 || (mustProvide("esintoramsmath")
1065 && params_.use_esint == BufferParams::package_off
1066 && params_.use_amsmath != BufferParams::package_off)) {
1067 tmp << "\\usepackage{amsmath}\n";
1069 // amsbsy and amstext are already provided by amsmath
1070 if (mustProvide("amsbsy"))
1071 tmp << "\\usepackage{amsbsy}\n";
1072 if (mustProvide("amstext"))
1073 tmp << "\\usepackage{amstext}\n";
1076 if (mustProvide("amssymb")
1077 || params_.use_amsmath == BufferParams::package_on)
1078 tmp << "\\usepackage{amssymb}\n";
1084 docstring const LaTeXFeatures::getTClassPreamble() const
1086 // the text class specific preamble
1087 DocumentClass const & tclass = params_.documentClass();
1088 odocstringstream tcpreamble;
1090 tcpreamble << tclass.preamble();
1092 list<docstring>::const_iterator cit = usedLayouts_.begin();
1093 list<docstring>::const_iterator end = usedLayouts_.end();
1094 for (; cit != end; ++cit)
1095 tcpreamble << tclass[*cit].preamble();
1097 cit = usedInsetLayouts_.begin();
1098 end = usedInsetLayouts_.end();
1099 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1100 for (; cit != end; ++cit) {
1101 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1102 if (it == ils.end())
1104 tcpreamble << it->second.preamble();
1107 return tcpreamble.str();
1111 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1113 DocumentClass const & tclass = params_.documentClass();
1114 odocstringstream tcpreamble;
1116 tcpreamble << tclass.htmlpreamble();
1118 list<docstring>::const_iterator cit = usedLayouts_.begin();
1119 list<docstring>::const_iterator end = usedLayouts_.end();
1120 for (; cit != end; ++cit)
1121 tcpreamble << tclass[*cit].htmlpreamble();
1123 cit = usedInsetLayouts_.begin();
1124 end = usedInsetLayouts_.end();
1125 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1126 for (; cit != end; ++cit) {
1127 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1128 if (it == ils.end())
1130 tcpreamble << it->second.htmlpreamble();
1133 return tcpreamble.str();
1137 docstring const LaTeXFeatures::getTClassHTMLStyles() const {
1138 DocumentClass const & tclass = params_.documentClass();
1139 odocstringstream tcpreamble;
1141 list<docstring>::const_iterator cit = usedLayouts_.begin();
1142 list<docstring>::const_iterator end = usedLayouts_.end();
1143 for (; cit != end; ++cit)
1144 tcpreamble << tclass[*cit].htmlstyle();
1146 cit = usedInsetLayouts_.begin();
1147 end = usedInsetLayouts_.end();
1148 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1149 for (; cit != end; ++cit) {
1150 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1151 if (it == ils.end())
1153 tcpreamble << it->second.htmlstyle();
1156 return tcpreamble.str();
1161 docstring const getFloatI18nPreamble(docstring const & type, docstring const & name, docstring const & lang)
1163 odocstringstream os;
1164 os << "\\addto\\captions" << lang
1165 << "{\\renewcommand{\\" << type << "name}{" << name << "}}\n";
1171 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const
1173 DocumentClass const & tclass = params_.documentClass();
1174 // collect preamble snippets in a set to prevent multiple identical
1175 // commands (would happen if e.g. both theorem and theorem* are used)
1176 set<docstring> snippets;
1177 typedef LanguageList::const_iterator lang_it;
1178 lang_it const lbeg = UsedLanguages_.begin();
1179 lang_it const lend = UsedLanguages_.end();
1180 list<docstring>::const_iterator cit = usedLayouts_.begin();
1181 list<docstring>::const_iterator end = usedLayouts_.end();
1182 for (; cit != end; ++cit) {
1183 // language dependent commands (once per document)
1184 snippets.insert(tclass[*cit].langpreamble(buffer().language(),
1186 // commands for language changing (for multilanguage documents)
1187 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1188 snippets.insert(tclass[*cit].babelpreamble(buffer().language(),
1190 for (lang_it lit = lbeg; lit != lend; ++lit)
1191 snippets.insert(tclass[*cit].babelpreamble(*lit, use_polyglossia));
1194 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1195 FloatList const & floats = params_.documentClass().floats();
1196 UsedFloats::const_iterator fit = usedFloats_.begin();
1197 UsedFloats::const_iterator fend = usedFloats_.end();
1198 for (; fit != fend; ++fit) {
1199 Floating const & fl = floats.getType(fit->first);
1200 // we assume builtin floats are translated
1201 if (fl.isPredefined())
1203 docstring const type = from_ascii(fl.floattype());
1204 docstring const flname = from_utf8(fl.name());
1205 docstring name = buffer().language()->translateLayout(fl.name());
1206 // only request translation if we have a real translation
1207 // (that differs from the source)
1208 if (use_polyglossia && flname != name)
1209 snippets.insert(getFloatI18nPreamble(
1211 from_ascii(buffer().language()->polyglossia())));
1212 else if (flname != name)
1213 snippets.insert(getFloatI18nPreamble(
1215 from_ascii(buffer().language()->babel())));
1216 for (lang_it lit = lbeg; lit != lend; ++lit) {
1217 string const code = (*lit)->code();
1218 name = (*lit)->translateLayout(fl.name());
1219 // we assume we have a suitable translation if
1220 // either the language is English (we need to
1221 // translate into English if English is a secondary
1222 // language) or if translateIfPossible returns
1223 // something different to the English source.
1224 bool const have_translation =
1225 (flname != name || contains(code, "en"));
1226 if (use_polyglossia && have_translation)
1227 snippets.insert(getFloatI18nPreamble(
1229 from_ascii((*lit)->polyglossia())));
1230 else if (have_translation)
1231 snippets.insert(getFloatI18nPreamble(
1233 from_ascii((*lit)->babel())));
1238 odocstringstream tcpreamble;
1239 set<docstring>::const_iterator const send = snippets.end();
1240 set<docstring>::const_iterator it = snippets.begin();
1241 for (; it != send; ++it)
1243 return tcpreamble.str();
1247 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1249 // Definition of entities used in the document that are LyX related.
1250 odocstringstream entities;
1252 if (mustProvide("lyxarrow")) {
1253 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
1256 return entities.str();
1260 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1262 odocstringstream sgmlpreamble;
1264 docstring const basename(from_utf8(onlyPath(fname)));
1266 FileMap::const_iterator end = IncludedFiles_.end();
1267 for (FileMap::const_iterator fi = IncludedFiles_.begin();
1270 sgmlpreamble << "\n<!ENTITY " << fi->first
1271 << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1272 << makeRelPath(from_utf8(fi->second), basename) << "\">";
1274 return sgmlpreamble.str();
1278 void LaTeXFeatures::showStruct() const
1280 lyxerr << "LyX needs the following commands when LaTeXing:"
1281 << "\n***** Packages:" << getPackages()
1282 << "\n***** Macros:" << to_utf8(getMacros())
1283 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1284 << "\n***** done." << endl;
1288 Buffer const & LaTeXFeatures::buffer() const
1294 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1300 BufferParams const & LaTeXFeatures::bufferParams() const
1306 void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
1308 FloatList const & floats = params_.documentClass().floats();
1310 // Here we will output the code to create the needed float styles.
1311 // We will try to do this as minimal as possible.
1312 // \floatstyle{ruled}
1313 // \newfloat{algorithm}{htbp}{loa}
1314 // \providecommand{\algorithmname}{Algorithm}
1315 // \floatname{algorithm}{\protect\algorithmname}
1316 UsedFloats::const_iterator cit = usedFloats_.begin();
1317 UsedFloats::const_iterator end = usedFloats_.end();
1318 for (; cit != end; ++cit) {
1319 Floating const & fl = floats.getType(cit->first);
1321 // For builtin floats we do nothing.
1322 if (fl.isPredefined())
1325 // We have to special case "table" and "figure"
1326 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1327 // Output code to modify "table" or "figure"
1328 // but only if builtin == false
1329 // and that have to be true at this point in the
1331 docstring const type = from_ascii(fl.floattype());
1332 docstring const placement = from_ascii(fl.placement());
1333 docstring const style = from_ascii(fl.style());
1334 if (!style.empty()) {
1335 os << "\\floatstyle{" << style << "}\n"
1336 << "\\restylefloat{" << type << "}\n";
1338 if (!placement.empty()) {
1339 os << "\\floatplacement{" << type << "}{"
1340 << placement << "}\n";
1343 // The other non builtin floats.
1345 docstring const type = from_ascii(fl.floattype());
1346 docstring const placement = from_ascii(fl.placement());
1347 docstring const ext = from_ascii(fl.ext());
1348 docstring const within = from_ascii(fl.within());
1349 docstring const style = from_ascii(fl.style());
1350 docstring const name =
1351 buffer().language()->translateLayout(fl.name());
1352 os << "\\floatstyle{" << style << "}\n"
1353 << "\\newfloat{" << type << "}{" << placement
1354 << "}{" << ext << '}';
1355 if (!within.empty())
1356 os << '[' << within << ']';
1358 << "\\providecommand{\\" << type << "name}{"
1360 << "\\floatname{" << type << "}{\\protect\\"
1361 << type << "name}\n";
1363 // What missing here is to code to minimalize the code
1364 // output so that the same floatstyle will not be
1365 // used several times, when the same style is still in
1369 os << "\n\\newsubfloat{" << from_ascii(fl.floattype()) << "}\n";