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"
24 #include "FloatList.h"
29 #include "TextClass.h"
31 #include "support/debug.h"
32 #include "support/docstream.h"
33 #include "support/FileName.h"
34 #include "support/filetools.h"
35 #include "support/lstrings.h"
38 using namespace lyx::support;
43 /////////////////////////////////////////////////////////////////////
47 /////////////////////////////////////////////////////////////////////
49 //\NeedsTeXFormat{LaTeX2e}
50 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
51 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
53 static string const lyx_def =
54 "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}";
56 static string const lyxline_def =
57 "\\newcommand{\\lyxline}[1][1pt]{%\n"
59 " \\rule[.5ex]{\\linewidth}{#1}\\par}";
61 static string const noun_def = "\\newcommand{\\noun}[1]{\\textsc{#1}}";
63 static string const lyxarrow_def =
64 "\\DeclareRobustCommand*{\\lyxarrow}{%\n"
66 "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
67 "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}";
69 // for quotes without babel. This does not give perfect results, but
70 // anybody serious about non-english quotes should use babel (JMarc).
72 static string const quotedblbase_def =
73 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
74 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
75 " \\penalty10000\\hskip0em\\relax%\n"
78 static string const quotesinglbase_def =
79 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
80 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
81 " \\penalty10000\\hskip0em\\relax%\n"
84 static string const guillemotleft_def =
85 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
86 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
87 "\\penalty10000\\hskip0pt\\relax%\n"
90 static string const guillemotright_def =
91 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
92 " \\penalty10000\\hskip0pt%\n"
93 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
96 static string const guilsinglleft_def =
97 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
98 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
99 " \\penalty10000\\hskip0pt\\relax%\n"
102 static string const guilsinglright_def =
103 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
104 " \\penalty10000\\hskip0pt%\n"
105 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
108 static string const paragraphleftindent_def =
109 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
111 " \\begin{list}{}{%\n"
112 " \\setlength{\\topsep}{0pt}%\n"
113 " \\addtolength{\\leftmargin}{#1}\n"
114 // ho hum, yet more things commented out with no hint as to why they
115 // weren't just removed
116 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
117 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
118 // "%% \\setlength\\listparindent\\parindent%\n"
119 // "%% \\setlength\\itemindent\\parindent%\n"
120 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
126 static string const floatingfootnote_def =
127 "%% Special footnote code from the package 'stblftnt.sty'\n"
128 "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
129 "\\let\\SF@@footnote\\footnote\n"
130 "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
131 " \\expandafter\\SF@@footnote\n"
133 " \\expandafter\\SF@gobble@opt\n"
136 "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
137 " \\SF@gobble@twobracket\n"
140 "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
141 " \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
142 "\\def\\SF@gobble@twobracket[#1]#2{}\n";
144 static string const binom_def =
145 "%% Binom macro for standard LaTeX users\n"
146 "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n";
148 static string const mathcircumflex_def =
149 "%% For printing a cirumflex inside a formula\n"
150 "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n";
152 static string const tabularnewline_def =
153 "%% Because html converters don't know tabularnewline\n"
154 "\\providecommand{\\tabularnewline}{\\\\}\n";
156 static string const lyxgreyedout_def =
157 "%% The greyedout annotation environment\n"
158 "\\newenvironment{lyxgreyedout}{\\textcolor[gray]{0.8}\\bgroup}{\\egroup}\n";
160 // We want to omit the file extension for includegraphics, but this does not
161 // work when the filename contains other dots.
162 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
163 static string const lyxdot_def =
164 "%% A simple dot to overcome graphicx limitations\n"
165 "\\newcommand{\\lyxdot}{.}\n";
167 static string const changetracking_dvipost_def =
168 "%% Change tracking with dvipost\n"
170 "\\dvipost{osstart color push Red}\n"
171 "\\dvipost{osend color pop}\n"
172 "\\dvipost{cbstart color push Blue}\n"
173 "\\dvipost{cbend color pop}\n"
174 "\\newcommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
175 "\\newcommand{\\lyxdeleted}[3]{%\n"
176 "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n";
178 static string const changetracking_xcolor_ulem_def =
179 "%% Change tracking with ulem\n"
180 "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}#3}}\n"
181 "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\sout{#3}}}\n";
183 static string const changetracking_xcolor_ulem_hyperref_def =
184 "%% Change tracking with ulem\n"
185 "\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}}{}#3}}\n"
186 "\\newcommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\sout{#3}}{}}}\n";
188 static string const changetracking_none_def =
189 "\\newcommand{\\lyxadded}[3]{#3}\n"
190 "\\newcommand{\\lyxdeleted}[3]{}\n";
192 static string const textgreek_def =
193 "\\DeclareRobustCommand{\\greektext}{%\n"
194 " \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
195 "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
196 "\\DeclareFontEncoding{LGR}{}{}\n";
198 static string const textcyr_def =
199 "\\DeclareRobustCommand{\\cyrtext}{%\n"
200 " \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
201 "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
202 "\\AtBeginDocument{\\DeclareFontEncoding{T2A}{}{}}\n";
204 static string const lyxmathsym_def =
205 "\\newcommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
206 " \\text{\\ifx\\math@version\\b@ld\\bfseries\\fi#1}\\endgroup\\else#1\\fi}\n";
208 static string const papersizedvi_def =
209 "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n";
211 static string const papersizepdf_def =
212 "\\pdfpageheight\\paperheight\n"
213 "\\pdfpagewidth\\paperwidth\n";
215 static string const cedilla_def =
216 "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
217 "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n";
219 static string const subring_def =
220 "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
221 "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n";
223 static string const subdot_def =
224 "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
225 "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n";
227 static string const subhat_def =
228 "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
229 "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n";
231 static string const subtilde_def =
232 "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
233 "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n";
235 static string const dacute_def =
236 "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n";
238 static string const tipasymb_def =
239 "\\DeclareFontEncoding{T3}{}{}\n"
240 "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n";
242 static string const dgrave_def =
243 "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n";
245 static string const rcap_def =
246 "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n";
248 static string const ogonek_def =
249 "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
250 " \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
251 " \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
252 " \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
253 "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n";
255 /////////////////////////////////////////////////////////////////////
259 /////////////////////////////////////////////////////////////////////
261 LaTeXFeatures::Packages LaTeXFeatures::packages_;
264 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
265 OutputParams const & r)
266 : buffer_(&b), params_(p), runparams_(r), in_float_(false)
270 bool LaTeXFeatures::useBabel() const
272 return lyxrc.language_use_babel ||
273 (bufferParams().language->lang() != lyxrc.default_language &&
274 !bufferParams().language->babel().empty()) ||
275 this->hasLanguages();
279 void LaTeXFeatures::require(string const & name)
281 features_.insert(name);
285 void LaTeXFeatures::require(set<string> const & names)
287 features_.insert(names.begin(), names.end());
291 void LaTeXFeatures::getAvailable()
294 support::FileName const real_file = libFileSearch("", "packages.lst");
296 if (real_file.empty())
299 lex.setFile(real_file);
304 // Make sure that we are clean
307 bool finished = false;
309 while (lex.isOK() && !finished) {
311 case Lexer::LEX_FEOF:
315 packages_.insert(lex.getString());
321 void LaTeXFeatures::useLayout(docstring const & layoutname)
323 // Some code to avoid loops in dependency definition
324 static int level = 0;
325 const int maxlevel = 30;
326 if (level > maxlevel) {
327 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
328 << "recursion attained by layout "
329 << to_utf8(layoutname) << endl;
333 DocumentClass const & tclass = params_.documentClass();
334 if (tclass.hasLayout(layoutname)) {
335 // Is this layout already in usedLayouts?
336 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
337 != usedLayouts_.end())
340 Layout const & layout = tclass[layoutname];
341 require(layout.requires());
343 if (!layout.depends_on().empty()) {
345 useLayout(layout.depends_on());
348 usedLayouts_.push_back(layoutname);
350 lyxerr << "LaTeXFeatures::useLayout: layout `"
351 << to_utf8(layoutname) << "' does not exist in this class"
359 bool LaTeXFeatures::isRequired(string const & name) const
361 return features_.find(name) != features_.end();
365 bool LaTeXFeatures::mustProvide(string const & name) const
367 return isRequired(name) && !params_.documentClass().provides(name);
371 bool LaTeXFeatures::isAvailable(string const & name)
373 if (packages_.empty())
376 if (suffixIs(n, ".sty"))
377 n.erase(name.length() - 4);
378 return packages_.find(n) != packages_.end();
382 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
384 SnippetList::const_iterator begin = preamble_snippets_.begin();
385 SnippetList::const_iterator end = preamble_snippets_.end();
386 if (find(begin, end, preamble) == end)
387 preamble_snippets_.push_back(preamble);
391 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
393 if (!usedFloats_[name])
394 usedFloats_[name] = subfloat;
397 // We only need float.sty if we use non builtin floats, or if we
398 // use the "H" modifier. This includes modified table and
399 // figure floats. (Lgb)
400 Floating const & fl = params_.documentClass().floats().getType(name);
401 if (!fl.type().empty() && !fl.builtin()) {
407 void LaTeXFeatures::useLanguage(Language const * lang)
409 if (!lang->babel().empty())
410 UsedLanguages_.insert(lang);
411 if (lang->lang() == "vietnamese")
412 require("vietnamese");
413 // CJK languages do not have a babel name.
414 // They use the CJK package
415 if (lang->encoding()->package() == Encoding::CJK)
417 // japanese package is special
418 if (lang->encoding()->package() == Encoding::japanese)
423 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
425 IncludedFiles_[key] = name;
429 bool LaTeXFeatures::hasLanguages() const
431 return !UsedLanguages_.empty();
435 string LaTeXFeatures::getLanguages() const
437 ostringstream languages;
439 LanguageList::const_iterator const begin = UsedLanguages_.begin();
440 for (LanguageList::const_iterator cit = begin;
441 cit != UsedLanguages_.end();
445 languages << (*cit)->babel();
447 return languages.str();
451 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
453 // This does only find encodings of languages supported by babel, but
454 // that does not matter since we don't have a language with an
455 // encoding supported by inputenc but without babel support.
456 set<string> encodings;
457 LanguageList::const_iterator it = UsedLanguages_.begin();
458 LanguageList::const_iterator end = UsedLanguages_.end();
459 for (; it != end; ++it)
460 if ((*it)->encoding()->latexName() != doc_encoding &&
461 ((*it)->encoding()->package() == Encoding::inputenc
462 || (*it)->encoding()->package() == Encoding::japanese))
463 encodings.insert((*it)->encoding()->latexName());
469 char const * simplefeatures[] = {
470 // note that the package order here will be the same in the LaTeX-output
477 // subfig is handled in BufferParams.cpp
480 /*For a successful cooperation of the `wrapfig' package with the
481 `float' package you should load the `wrapfig' package *after*
482 the `float' package. See the caption package documentation
511 // listings is handled in BufferParams.cpp
518 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
523 string const LaTeXFeatures::getColorOptions() const
525 ostringstream colors;
527 // Handling the color packages separately is needed to be able to load them
528 // before babel when hyperref is loaded with the colorlinks option
529 // for more info see Bufferparams.cpp
532 if (mustProvide("color") || mustProvide("xcolor")) {
533 string const package =
534 (mustProvide("xcolor") ? "xcolor" : "color");
535 if (params_.graphicsDriver == "default"
536 || params_.graphicsDriver == "none")
537 colors << "\\usepackage{" << package << "}\n";
539 colors << "\\usepackage["
540 << params_.graphicsDriver
541 << "]{" << package << "}\n";
544 // pdfcolmk must be loaded after color
545 if (mustProvide("pdfcolmk"))
546 colors << "\\usepackage{pdfcolmk}\n";
552 string const LaTeXFeatures::getPackages() const
554 ostringstream packages;
555 DocumentClass const & tclass = params_.documentClass();
557 // FIXME: currently, we can only load packages and macros known
559 // However, with the Require tag of layouts/custom insets,
560 // also inknown packages can be requested. They are silently
561 // swallowed now. We should change this eventually.
564 // These are all the 'simple' includes. i.e
565 // packages which we just \usepackage{package}
567 for (int i = 0; i < nb_simplefeatures; ++i) {
568 if (mustProvide(simplefeatures[i]))
569 packages << "\\usepackage{"
570 << simplefeatures[i] << "}\n";
574 // The rest of these packages are somewhat more complicated
578 // esint is preferred for esintoramsmath
579 if ((mustProvide("amsmath")
580 && params_.use_amsmath != BufferParams::package_off)
581 || (mustProvide("esintoramsmath")
582 && params_.use_esint == BufferParams::package_off
583 && params_.use_amsmath != BufferParams::package_off)) {
584 packages << "\\usepackage{amsmath}\n";
586 // amsbsy and amstext are already provided by amsmath
587 if (mustProvide("amsbsy"))
588 packages << "\\usepackage{amsbsy}\n";
589 if (mustProvide("amstext"))
590 packages << "\\usepackage{amstext}\n";
593 // wasysym is a simple feature, but it must be after amsmath if both
595 // wasysym redefines some integrals (e.g. iint) from amsmath. That
596 // leads to inconsistent integrals. We only load this package if
597 // the document does not contain integrals (then isRequired("esint")
598 // is false) or if esint is used, since esint redefines all relevant
599 // integral symbols from wasysym and amsmath.
600 // See http://bugzilla.lyx.org/show_bug.cgi?id=1942
601 if (mustProvide("wasysym") &&
602 (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
603 packages << "\\usepackage{wasysym}\n";
605 // accents must be loaded after amsmath
606 if (mustProvide("accents"))
607 packages << "\\usepackage{accents}\n";
609 // [x]color and pdfcolmk are handled in getColorOptions() above
612 if (isRequired("makeidx")) {
613 if (!tclass.provides("makeidx"))
614 packages << "\\usepackage{makeidx}\n";
615 packages << "\\makeindex\n";
619 if (mustProvide("graphicx") && params_.graphicsDriver != "none") {
620 if (params_.graphicsDriver == "default")
621 packages << "\\usepackage{graphicx}\n";
623 packages << "\\usepackage["
624 << params_.graphicsDriver
627 // shadecolor for shaded
628 if (isRequired("framed") && mustProvide("color")) {
629 RGBColor c = rgbFromHexName(lcolor.getX11Name(Color_shadedbg));
630 //255.0 to force conversion to double
631 //NOTE As Jürgen Spitzmüller pointed out, an alternative would be
632 //to use the xcolor package instead, and then we can do
633 // \define{shadcolor}{RGB}...
634 //and not do any conversion. We'd then need to require xcolor
635 //in InsetNote::validate().
636 int const stmSize = packages.precision(2);
637 packages << "\\definecolor{shadecolor}{rgb}{"
638 << c.r / 255.0 << ',' << c.g / 255.0 << ',' << c.b / 255.0 << "}\n";
639 packages.precision(stmSize);
642 // lyxskak.sty --- newer chess support based on skak.sty
643 if (mustProvide("chess"))
644 packages << "\\usepackage[ps,mover]{lyxskak}\n";
647 if (mustProvide("setspace") && !tclass.provides("SetSpace"))
648 packages << "\\usepackage{setspace}\n";
651 if (mustProvide("amssymb")
652 || params_.use_amsmath == BufferParams::package_on)
653 packages << "\\usepackage{amssymb}\n";
655 // esint must be after amsmath and wasysym, since it will redeclare
656 // inconsistent integral symbols
657 if ((mustProvide("esint") || mustProvide("esintoramsmath")) &&
658 params_.use_esint != BufferParams::package_off)
659 packages << "\\usepackage{esint}\n";
662 // Some classes load natbib themselves, but still allow (or even require)
663 // plain numeric citations (ReVTeX is such a case, see bug 5182).
664 // This special case is indicated by the "natbib-internal" key.
665 if (mustProvide("natbib") && !tclass.provides("natbib-internal")) {
666 packages << "\\usepackage[";
667 if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
668 packages << "numbers";
670 packages << "authoryear";
671 packages << "]{natbib}\n";
674 // jurabib -- we need version 0.6 at least.
675 if (mustProvide("jurabib"))
676 packages << "\\usepackage{jurabib}[2004/01/25]\n";
678 // xargs -- we need version 1.09 at least
679 if (mustProvide("xargs"))
680 packages << "\\usepackage{xargs}[2008/03/08]\n";
682 // bibtopic -- the dot provides the aux file naming which
684 if (mustProvide("bibtopic"))
685 packages << "\\usepackage[dot]{bibtopic}\n";
687 if (mustProvide("xy"))
688 packages << "\\usepackage[all]{xy}\n";
690 if (mustProvide("ulem"))
691 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
692 "\\usepackage{ulem}\n";
694 if (mustProvide("nomencl")) {
695 // Make it work with the new and old version of the package,
696 // but don't use the compatibility option since it is
697 // incompatible to other packages.
698 packages << "\\usepackage{nomencl}\n"
699 "% the following is useful when we have the old nomencl.sty package\n"
700 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
701 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
702 "\\makenomenclature\n";
705 return packages.str();
709 string const LaTeXFeatures::getMacros() const
711 ostringstream macros;
713 if (!preamble_snippets_.empty())
715 SnippetList::const_iterator pit = preamble_snippets_.begin();
716 SnippetList::const_iterator pend = preamble_snippets_.end();
717 for (; pit != pend; ++pit)
718 macros << *pit << '\n';
720 if (mustProvide("papersize")) {
721 if (runparams_.flavor == OutputParams::LATEX)
722 macros << papersizedvi_def << '\n';
724 macros << papersizepdf_def << '\n';
727 if (mustProvide("LyX"))
728 macros << lyx_def << '\n';
730 if (mustProvide("lyxline"))
731 macros << lyxline_def << '\n';
733 if (mustProvide("noun"))
734 macros << noun_def << '\n';
736 if (mustProvide("lyxarrow"))
737 macros << lyxarrow_def << '\n';
739 if (mustProvide("textgreek"))
740 macros << textgreek_def << '\n';
742 if (mustProvide("textcyr"))
743 macros << textcyr_def << '\n';
745 if (mustProvide("lyxmathsym"))
746 macros << lyxmathsym_def << '\n';
748 if (mustProvide("cedilla"))
749 macros << cedilla_def << '\n';
751 if (mustProvide("subring"))
752 macros << subring_def << '\n';
754 if (mustProvide("subdot"))
755 macros << subdot_def << '\n';
757 if (mustProvide("subhat"))
758 macros << subhat_def << '\n';
760 if (mustProvide("subtilde"))
761 macros << subtilde_def << '\n';
763 if (mustProvide("dacute"))
764 macros << dacute_def << '\n';
766 if (mustProvide("tipasymb"))
767 macros << tipasymb_def << '\n';
769 if (mustProvide("dgrave"))
770 macros << dgrave_def << '\n';
772 if (mustProvide("rcap"))
773 macros << rcap_def << '\n';
775 if (mustProvide("ogonek"))
776 macros << ogonek_def << '\n';
779 if (mustProvide("quotesinglbase"))
780 macros << quotesinglbase_def << '\n';
781 if (mustProvide("quotedblbase"))
782 macros << quotedblbase_def << '\n';
783 if (mustProvide("guilsinglleft"))
784 macros << guilsinglleft_def << '\n';
785 if (mustProvide("guilsinglright"))
786 macros << guilsinglright_def << '\n';
787 if (mustProvide("guillemotleft"))
788 macros << guillemotleft_def << '\n';
789 if (mustProvide("guillemotright"))
790 macros << guillemotright_def << '\n';
793 if (mustProvide("binom") && !isRequired("amsmath"))
794 macros << binom_def << '\n';
795 if (mustProvide("mathcircumflex"))
796 macros << mathcircumflex_def << '\n';
799 if (mustProvide("ParagraphLeftIndent"))
800 macros << paragraphleftindent_def;
801 if (mustProvide("NeedLyXFootnoteCode"))
802 macros << floatingfootnote_def;
804 // some problems with tex->html converters
805 if (mustProvide("NeedTabularnewline"))
806 macros << tabularnewline_def;
808 // greyedout environment (note inset)
809 if (mustProvide("lyxgreyedout"))
810 macros << lyxgreyedout_def;
812 if (mustProvide("lyxdot"))
813 macros << lyxdot_def << '\n';
816 getFloatDefinitions(macros);
819 if (mustProvide("ct-dvipost"))
820 macros << changetracking_dvipost_def;
822 if (mustProvide("ct-xcolor-ulem")) {
823 int const prec = macros.precision(2);
825 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
826 macros << "\\providecolor{lyxadded}{rgb}{"
827 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
829 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
830 macros << "\\providecolor{lyxdeleted}{rgb}{"
831 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
833 macros.precision(prec);
835 if (isRequired("hyperref"))
836 macros << changetracking_xcolor_ulem_hyperref_def;
838 macros << changetracking_xcolor_ulem_def;
841 if (mustProvide("ct-none"))
842 macros << changetracking_none_def;
848 string const LaTeXFeatures::getBabelOptions() const
852 LanguageList::const_iterator it = UsedLanguages_.begin();
853 LanguageList::const_iterator end = UsedLanguages_.end();
854 for (; it != end; ++it)
855 if (!(*it)->latex_options().empty())
856 tmp << (*it)->latex_options() << '\n';
857 if (!params_.language->latex_options().empty())
858 tmp << params_.language->latex_options() << '\n';
864 docstring const LaTeXFeatures::getTClassPreamble() const
866 // the text class specific preamble
867 DocumentClass const & tclass = params_.documentClass();
868 odocstringstream tcpreamble;
870 tcpreamble << tclass.preamble();
872 list<docstring>::const_iterator cit = usedLayouts_.begin();
873 list<docstring>::const_iterator end = usedLayouts_.end();
874 for (; cit != end; ++cit)
875 tcpreamble << tclass[*cit].preamble();
877 return tcpreamble.str();
881 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel) const
883 DocumentClass const & tclass = params_.documentClass();
884 // collect preamble snippets in a set to prevent multiple identical
885 // commands (would happen if e.g. both theorem and theorem* are used)
886 set<docstring> snippets;
887 typedef LanguageList::const_iterator lang_it;
888 lang_it const lbeg = UsedLanguages_.begin();
889 lang_it const lend = UsedLanguages_.end();
890 list<docstring>::const_iterator cit = usedLayouts_.begin();
891 list<docstring>::const_iterator end = usedLayouts_.end();
892 for (; cit != end; ++cit) {
893 // language dependent commands (once per document)
894 snippets.insert(tclass[*cit].langpreamble(buffer().language()));
895 // commands for language changing (for multilanguage documents)
896 if (use_babel && !UsedLanguages_.empty()) {
897 snippets.insert(tclass[*cit].babelpreamble(buffer().language()));
898 for (lang_it lit = lbeg; lit != lend; ++lit)
899 snippets.insert(tclass[*cit].babelpreamble(*lit));
903 odocstringstream tcpreamble;
904 set<docstring>::const_iterator const send = snippets.end();
905 set<docstring>::const_iterator it = snippets.begin();
906 for (; it != send; ++it)
908 return tcpreamble.str();
912 docstring const LaTeXFeatures::getLyXSGMLEntities() const
914 // Definition of entities used in the document that are LyX related.
915 odocstringstream entities;
917 if (mustProvide("lyxarrow")) {
918 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
921 return entities.str();
925 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
927 odocstringstream sgmlpreamble;
929 docstring const basename(from_utf8(onlyPath(fname)));
931 FileMap::const_iterator end = IncludedFiles_.end();
932 for (FileMap::const_iterator fi = IncludedFiles_.begin();
935 sgmlpreamble << "\n<!ENTITY " << fi->first
936 << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
937 << makeRelPath(from_utf8(fi->second), basename) << "\">";
939 return sgmlpreamble.str();
943 void LaTeXFeatures::showStruct() const
945 lyxerr << "LyX needs the following commands when LaTeXing:"
946 << "\n***** Packages:" << getPackages()
947 << "\n***** Macros:" << getMacros()
948 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
949 << "\n***** done." << endl;
953 Buffer const & LaTeXFeatures::buffer() const
959 void LaTeXFeatures::setBuffer(Buffer const & buffer)
965 BufferParams const & LaTeXFeatures::bufferParams() const
971 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
973 FloatList const & floats = params_.documentClass().floats();
975 // Here we will output the code to create the needed float styles.
976 // We will try to do this as minimal as possible.
977 // \floatstyle{ruled}
978 // \newfloat{algorithm}{htbp}{loa}
979 // \floatname{algorithm}{Algorithm}
980 UsedFloats::const_iterator cit = usedFloats_.begin();
981 UsedFloats::const_iterator end = usedFloats_.end();
982 // ostringstream floats;
983 for (; cit != end; ++cit) {
984 Floating const & fl = floats.getType((cit->first));
986 // For builtin floats we do nothing.
987 if (fl.builtin()) continue;
989 // We have to special case "table" and "figure"
990 if (fl.type() == "tabular" || fl.type() == "figure") {
991 // Output code to modify "table" or "figure"
992 // but only if builtin == false
993 // and that have to be true at this point in the
995 string const type = fl.type();
996 string const placement = fl.placement();
997 string const style = fl.style();
998 if (!style.empty()) {
999 os << "\\floatstyle{" << style << "}\n"
1000 << "\\restylefloat{" << type << "}\n";
1002 if (!placement.empty()) {
1003 os << "\\floatplacement{" << type << "}{"
1004 << placement << "}\n";
1007 // The other non builtin floats.
1009 string const type = fl.type();
1010 string const placement = fl.placement();
1011 string const ext = fl.ext();
1012 string const within = fl.within();
1013 string const style = fl.style();
1014 string const name = fl.name();
1015 os << "\\floatstyle{" << style << "}\n"
1016 << "\\newfloat{" << type << "}{" << placement
1017 << "}{" << ext << '}';
1018 if (!within.empty())
1019 os << '[' << within << ']';
1021 << "\\floatname{" << type << "}{"
1024 // What missing here is to code to minimalize the code
1025 // output so that the same floatstyle will not be
1026 // used several times, when the same style is still in
1030 os << "\n\\newsubfloat{" << fl.type() << "}\n";