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}{\\@ifstar{\\lyxm@thsym\\textit}{\\lyxm@thsym\\textrm}}\n"
206 "\\newcommand{\\lyxm@thsym}[2]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
207 " #1{\\ifx\\math@version\\b@ld\\bfseries\\fi#2}\\endgroup\\else#2\\fi}\n";
209 static string const papersizedvi_def =
210 "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n";
212 static string const papersizepdf_def =
213 "\\pdfpageheight\\paperheight\n"
214 "\\pdfpagewidth\\paperwidth\n";
216 static string const cedilla_def =
217 "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
218 "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n";
220 static string const subring_def =
221 "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
222 "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n";
224 static string const subdot_def =
225 "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
226 "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n";
228 static string const subhat_def =
229 "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
230 "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n";
232 static string const subtilde_def =
233 "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
234 "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n";
236 static string const dacute_def =
237 "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n";
239 static string const tipasymb_def =
240 "\\DeclareFontEncoding{T3}{}{}\n"
241 "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n";
243 static string const dgrave_def =
244 "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n";
246 static string const rcap_def =
247 "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n";
249 static string const ogonek_def =
250 "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
251 " \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
252 " \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
253 " \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
254 "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n";
256 /////////////////////////////////////////////////////////////////////
260 /////////////////////////////////////////////////////////////////////
262 LaTeXFeatures::Packages LaTeXFeatures::packages_;
265 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
266 OutputParams const & r)
267 : buffer_(&b), params_(p), runparams_(r), in_float_(false)
271 bool LaTeXFeatures::useBabel() const
273 return lyxrc.language_use_babel ||
274 (bufferParams().language->lang() != lyxrc.default_language &&
275 !bufferParams().language->babel().empty()) ||
276 this->hasLanguages();
280 void LaTeXFeatures::require(string const & name)
282 features_.insert(name);
286 void LaTeXFeatures::require(set<string> const & names)
288 features_.insert(names.begin(), names.end());
292 void LaTeXFeatures::getAvailable()
295 support::FileName const real_file = libFileSearch("", "packages.lst");
297 if (real_file.empty())
300 lex.setFile(real_file);
305 // Make sure that we are clean
308 bool finished = false;
310 while (lex.isOK() && !finished) {
312 case Lexer::LEX_FEOF:
316 packages_.insert(lex.getString());
322 void LaTeXFeatures::useLayout(docstring const & layoutname)
324 // Some code to avoid loops in dependency definition
325 static int level = 0;
326 const int maxlevel = 30;
327 if (level > maxlevel) {
328 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
329 << "recursion attained by layout "
330 << to_utf8(layoutname) << endl;
334 DocumentClass const & tclass = params_.documentClass();
335 if (tclass.hasLayout(layoutname)) {
336 // Is this layout already in usedLayouts?
337 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
338 != usedLayouts_.end())
341 Layout const & layout = tclass[layoutname];
342 require(layout.requires());
344 if (!layout.depends_on().empty()) {
346 useLayout(layout.depends_on());
349 usedLayouts_.push_back(layoutname);
351 lyxerr << "LaTeXFeatures::useLayout: layout `"
352 << to_utf8(layoutname) << "' does not exist in this class"
360 bool LaTeXFeatures::isRequired(string const & name) const
362 return features_.find(name) != features_.end();
366 bool LaTeXFeatures::mustProvide(string const & name) const
368 return isRequired(name) && !params_.documentClass().provides(name);
372 bool LaTeXFeatures::isAvailable(string const & name)
374 if (packages_.empty())
377 if (suffixIs(n, ".sty"))
378 n.erase(name.length() - 4);
379 return packages_.find(n) != packages_.end();
383 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
385 SnippetList::const_iterator begin = preamble_snippets_.begin();
386 SnippetList::const_iterator end = preamble_snippets_.end();
387 if (find(begin, end, preamble) == end)
388 preamble_snippets_.push_back(preamble);
392 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
394 if (!usedFloats_[name])
395 usedFloats_[name] = subfloat;
398 // We only need float.sty if we use non builtin floats, or if we
399 // use the "H" modifier. This includes modified table and
400 // figure floats. (Lgb)
401 Floating const & fl = params_.documentClass().floats().getType(name);
402 if (!fl.type().empty() && !fl.builtin()) {
408 void LaTeXFeatures::useLanguage(Language const * lang)
410 if (!lang->babel().empty())
411 UsedLanguages_.insert(lang);
412 if (lang->lang() == "vietnamese")
413 require("vietnamese");
414 // CJK languages do not have a babel name.
415 // They use the CJK package
416 if (lang->encoding()->package() == Encoding::CJK)
418 // japanese package is special
419 if (lang->encoding()->package() == Encoding::japanese)
424 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
426 IncludedFiles_[key] = name;
430 bool LaTeXFeatures::hasLanguages() const
432 return !UsedLanguages_.empty();
436 string LaTeXFeatures::getLanguages() const
438 ostringstream languages;
440 LanguageList::const_iterator const begin = UsedLanguages_.begin();
441 for (LanguageList::const_iterator cit = begin;
442 cit != UsedLanguages_.end();
446 languages << (*cit)->babel();
448 return languages.str();
452 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
454 // This does only find encodings of languages supported by babel, but
455 // that does not matter since we don't have a language with an
456 // encoding supported by inputenc but without babel support.
457 set<string> encodings;
458 LanguageList::const_iterator it = UsedLanguages_.begin();
459 LanguageList::const_iterator end = UsedLanguages_.end();
460 for (; it != end; ++it)
461 if ((*it)->encoding()->latexName() != doc_encoding &&
462 ((*it)->encoding()->package() == Encoding::inputenc
463 || (*it)->encoding()->package() == Encoding::japanese))
464 encodings.insert((*it)->encoding()->latexName());
470 char const * simplefeatures[] = {
471 // note that the package order here will be the same in the LaTeX-output
478 // subfig is handled in BufferParams.cpp
481 /*For a successful cooperation of the `wrapfig' package with the
482 `float' package you should load the `wrapfig' package *after*
483 the `float' package. See the caption package documentation
512 // listings is handled in BufferParams.cpp
519 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
524 string const LaTeXFeatures::getColorOptions() const
526 ostringstream colors;
528 // Handling the color packages separately is needed to be able to load them
529 // before babel when hyperref is loaded with the colorlinks option
530 // for more info see Bufferparams.cpp
533 if (mustProvide("color") || mustProvide("xcolor")) {
534 string const package =
535 (mustProvide("xcolor") ? "xcolor" : "color");
536 if (params_.graphicsDriver == "default"
537 || params_.graphicsDriver == "none")
538 colors << "\\usepackage{" << package << "}\n";
540 colors << "\\usepackage["
541 << params_.graphicsDriver
542 << "]{" << package << "}\n";
545 // pdfcolmk must be loaded after color
546 if (mustProvide("pdfcolmk"))
547 colors << "\\usepackage{pdfcolmk}\n";
553 string const LaTeXFeatures::getPackages() const
555 ostringstream packages;
556 DocumentClass const & tclass = params_.documentClass();
558 // FIXME: currently, we can only load packages and macros known
560 // However, with the Require tag of layouts/custom insets,
561 // also inknown packages can be requested. They are silently
562 // swallowed now. We should change this eventually.
565 // These are all the 'simple' includes. i.e
566 // packages which we just \usepackage{package}
568 for (int i = 0; i < nb_simplefeatures; ++i) {
569 if (mustProvide(simplefeatures[i]))
570 packages << "\\usepackage{"
571 << simplefeatures[i] << "}\n";
575 // The rest of these packages are somewhat more complicated
579 // esint is preferred for esintoramsmath
580 if ((mustProvide("amsmath")
581 && params_.use_amsmath != BufferParams::package_off)
582 || (mustProvide("esintoramsmath")
583 && params_.use_esint == BufferParams::package_off
584 && params_.use_amsmath != BufferParams::package_off)) {
585 packages << "\\usepackage{amsmath}\n";
587 // amsbsy and amstext are already provided by amsmath
588 if (mustProvide("amsbsy"))
589 packages << "\\usepackage{amsbsy}\n";
590 if (mustProvide("amstext"))
591 packages << "\\usepackage{amstext}\n";
594 // wasysym is a simple feature, but it must be after amsmath if both
596 // wasysym redefines some integrals (e.g. iint) from amsmath. That
597 // leads to inconsistent integrals. We only load this package if
598 // the document does not contain integrals (then isRequired("esint")
599 // is false) or if esint is used, since esint redefines all relevant
600 // integral symbols from wasysym and amsmath.
601 // See http://bugzilla.lyx.org/show_bug.cgi?id=1942
602 if (mustProvide("wasysym") &&
603 (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
604 packages << "\\usepackage{wasysym}\n";
606 // accents must be loaded after amsmath
607 if (mustProvide("accents"))
608 packages << "\\usepackage{accents}\n";
610 // [x]color and pdfcolmk are handled in getColorOptions() above
613 if (isRequired("makeidx")) {
614 if (!tclass.provides("makeidx"))
615 packages << "\\usepackage{makeidx}\n";
616 packages << "\\makeindex\n";
620 if (mustProvide("graphicx") && params_.graphicsDriver != "none") {
621 if (params_.graphicsDriver == "default")
622 packages << "\\usepackage{graphicx}\n";
624 packages << "\\usepackage["
625 << params_.graphicsDriver
628 // shadecolor for shaded
629 if (isRequired("framed") && mustProvide("color")) {
630 RGBColor c = rgbFromHexName(lcolor.getX11Name(Color_shadedbg));
631 //255.0 to force conversion to double
632 //NOTE As Jürgen Spitzmüller pointed out, an alternative would be
633 //to use the xcolor package instead, and then we can do
634 // \define{shadcolor}{RGB}...
635 //and not do any conversion. We'd then need to require xcolor
636 //in InsetNote::validate().
637 int const stmSize = packages.precision(2);
638 packages << "\\definecolor{shadecolor}{rgb}{"
639 << c.r / 255.0 << ',' << c.g / 255.0 << ',' << c.b / 255.0 << "}\n";
640 packages.precision(stmSize);
643 // lyxskak.sty --- newer chess support based on skak.sty
644 if (mustProvide("chess"))
645 packages << "\\usepackage[ps,mover]{lyxskak}\n";
648 if (mustProvide("setspace") && !tclass.provides("SetSpace"))
649 packages << "\\usepackage{setspace}\n";
652 if (mustProvide("amssymb")
653 || params_.use_amsmath == BufferParams::package_on)
654 packages << "\\usepackage{amssymb}\n";
656 // esint must be after amsmath and wasysym, since it will redeclare
657 // inconsistent integral symbols
658 if ((mustProvide("esint") || mustProvide("esintoramsmath")) &&
659 params_.use_esint != BufferParams::package_off)
660 packages << "\\usepackage{esint}\n";
663 // Some classes load natbib themselves, but still allow (or even require)
664 // plain numeric citations (ReVTeX is such a case, see bug 5182).
665 // This special case is indicated by the "natbib-internal" key.
666 if (mustProvide("natbib") && !tclass.provides("natbib-internal")) {
667 packages << "\\usepackage[";
668 if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
669 packages << "numbers";
671 packages << "authoryear";
672 packages << "]{natbib}\n";
675 // jurabib -- we need version 0.6 at least.
676 if (mustProvide("jurabib"))
677 packages << "\\usepackage{jurabib}[2004/01/25]\n";
679 // xargs -- we need version 1.09 at least
680 if (mustProvide("xargs"))
681 packages << "\\usepackage{xargs}[2008/03/08]\n";
683 // bibtopic -- the dot provides the aux file naming which
685 if (mustProvide("bibtopic"))
686 packages << "\\usepackage[dot]{bibtopic}\n";
688 if (mustProvide("xy"))
689 packages << "\\usepackage[all]{xy}\n";
691 if (mustProvide("ulem"))
692 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
693 "\\usepackage{ulem}\n";
695 if (mustProvide("nomencl")) {
696 // Make it work with the new and old version of the package,
697 // but don't use the compatibility option since it is
698 // incompatible to other packages.
699 packages << "\\usepackage{nomencl}\n"
700 "% the following is useful when we have the old nomencl.sty package\n"
701 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
702 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
703 "\\makenomenclature\n";
706 return packages.str();
710 string const LaTeXFeatures::getMacros() const
712 ostringstream macros;
714 if (!preamble_snippets_.empty())
716 SnippetList::const_iterator pit = preamble_snippets_.begin();
717 SnippetList::const_iterator pend = preamble_snippets_.end();
718 for (; pit != pend; ++pit)
719 macros << *pit << '\n';
721 if (mustProvide("papersize")) {
722 if (runparams_.flavor == OutputParams::LATEX)
723 macros << papersizedvi_def << '\n';
725 macros << papersizepdf_def << '\n';
728 if (mustProvide("LyX"))
729 macros << lyx_def << '\n';
731 if (mustProvide("lyxline"))
732 macros << lyxline_def << '\n';
734 if (mustProvide("noun"))
735 macros << noun_def << '\n';
737 if (mustProvide("lyxarrow"))
738 macros << lyxarrow_def << '\n';
740 if (mustProvide("textgreek"))
741 macros << textgreek_def << '\n';
743 if (mustProvide("textcyr"))
744 macros << textcyr_def << '\n';
746 if (mustProvide("lyxmathsym"))
747 macros << lyxmathsym_def << '\n';
749 if (mustProvide("cedilla"))
750 macros << cedilla_def << '\n';
752 if (mustProvide("subring"))
753 macros << subring_def << '\n';
755 if (mustProvide("subdot"))
756 macros << subdot_def << '\n';
758 if (mustProvide("subhat"))
759 macros << subhat_def << '\n';
761 if (mustProvide("subtilde"))
762 macros << subtilde_def << '\n';
764 if (mustProvide("dacute"))
765 macros << dacute_def << '\n';
767 if (mustProvide("tipasymb"))
768 macros << tipasymb_def << '\n';
770 if (mustProvide("dgrave"))
771 macros << dgrave_def << '\n';
773 if (mustProvide("rcap"))
774 macros << rcap_def << '\n';
776 if (mustProvide("ogonek"))
777 macros << ogonek_def << '\n';
780 if (mustProvide("quotesinglbase"))
781 macros << quotesinglbase_def << '\n';
782 if (mustProvide("quotedblbase"))
783 macros << quotedblbase_def << '\n';
784 if (mustProvide("guilsinglleft"))
785 macros << guilsinglleft_def << '\n';
786 if (mustProvide("guilsinglright"))
787 macros << guilsinglright_def << '\n';
788 if (mustProvide("guillemotleft"))
789 macros << guillemotleft_def << '\n';
790 if (mustProvide("guillemotright"))
791 macros << guillemotright_def << '\n';
794 if (mustProvide("binom") && !isRequired("amsmath"))
795 macros << binom_def << '\n';
796 if (mustProvide("mathcircumflex"))
797 macros << mathcircumflex_def << '\n';
800 if (mustProvide("ParagraphLeftIndent"))
801 macros << paragraphleftindent_def;
802 if (mustProvide("NeedLyXFootnoteCode"))
803 macros << floatingfootnote_def;
805 // some problems with tex->html converters
806 if (mustProvide("NeedTabularnewline"))
807 macros << tabularnewline_def;
809 // greyedout environment (note inset)
810 if (mustProvide("lyxgreyedout"))
811 macros << lyxgreyedout_def;
813 if (mustProvide("lyxdot"))
814 macros << lyxdot_def << '\n';
817 getFloatDefinitions(macros);
820 if (mustProvide("ct-dvipost"))
821 macros << changetracking_dvipost_def;
823 if (mustProvide("ct-xcolor-ulem")) {
824 int const prec = macros.precision(2);
826 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
827 macros << "\\providecolor{lyxadded}{rgb}{"
828 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
830 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
831 macros << "\\providecolor{lyxdeleted}{rgb}{"
832 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
834 macros.precision(prec);
836 if (isRequired("hyperref"))
837 macros << changetracking_xcolor_ulem_hyperref_def;
839 macros << changetracking_xcolor_ulem_def;
842 if (mustProvide("ct-none"))
843 macros << changetracking_none_def;
849 string const LaTeXFeatures::getBabelOptions() const
853 LanguageList::const_iterator it = UsedLanguages_.begin();
854 LanguageList::const_iterator end = UsedLanguages_.end();
855 for (; it != end; ++it)
856 if (!(*it)->latex_options().empty())
857 tmp << (*it)->latex_options() << '\n';
858 if (!params_.language->latex_options().empty())
859 tmp << params_.language->latex_options() << '\n';
865 docstring const LaTeXFeatures::getTClassPreamble() const
867 // the text class specific preamble
868 DocumentClass const & tclass = params_.documentClass();
869 odocstringstream tcpreamble;
871 tcpreamble << tclass.preamble();
873 list<docstring>::const_iterator cit = usedLayouts_.begin();
874 list<docstring>::const_iterator end = usedLayouts_.end();
875 for (; cit != end; ++cit)
876 tcpreamble << tclass[*cit].preamble();
878 return tcpreamble.str();
882 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel) const
884 DocumentClass const & tclass = params_.documentClass();
885 // collect preamble snippets in a set to prevent multiple identical
886 // commands (would happen if e.g. both theorem and theorem* are used)
887 set<docstring> snippets;
888 typedef LanguageList::const_iterator lang_it;
889 lang_it const lbeg = UsedLanguages_.begin();
890 lang_it const lend = UsedLanguages_.end();
891 list<docstring>::const_iterator cit = usedLayouts_.begin();
892 list<docstring>::const_iterator end = usedLayouts_.end();
893 for (; cit != end; ++cit) {
894 // language dependent commands (once per document)
895 snippets.insert(tclass[*cit].langpreamble(buffer().language()));
896 // commands for language changing (for multilanguage documents)
897 if (use_babel && !UsedLanguages_.empty()) {
898 snippets.insert(tclass[*cit].babelpreamble(buffer().language()));
899 for (lang_it lit = lbeg; lit != lend; ++lit)
900 snippets.insert(tclass[*cit].babelpreamble(*lit));
904 odocstringstream tcpreamble;
905 set<docstring>::const_iterator const send = snippets.end();
906 set<docstring>::const_iterator it = snippets.begin();
907 for (; it != send; ++it)
909 return tcpreamble.str();
913 docstring const LaTeXFeatures::getLyXSGMLEntities() const
915 // Definition of entities used in the document that are LyX related.
916 odocstringstream entities;
918 if (mustProvide("lyxarrow")) {
919 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
922 return entities.str();
926 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
928 odocstringstream sgmlpreamble;
930 docstring const basename(from_utf8(onlyPath(fname)));
932 FileMap::const_iterator end = IncludedFiles_.end();
933 for (FileMap::const_iterator fi = IncludedFiles_.begin();
936 sgmlpreamble << "\n<!ENTITY " << fi->first
937 << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
938 << makeRelPath(from_utf8(fi->second), basename) << "\">";
940 return sgmlpreamble.str();
944 void LaTeXFeatures::showStruct() const
946 lyxerr << "LyX needs the following commands when LaTeXing:"
947 << "\n***** Packages:" << getPackages()
948 << "\n***** Macros:" << getMacros()
949 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
950 << "\n***** done." << endl;
954 Buffer const & LaTeXFeatures::buffer() const
960 void LaTeXFeatures::setBuffer(Buffer const & buffer)
966 BufferParams const & LaTeXFeatures::bufferParams() const
972 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
974 FloatList const & floats = params_.documentClass().floats();
976 // Here we will output the code to create the needed float styles.
977 // We will try to do this as minimal as possible.
978 // \floatstyle{ruled}
979 // \newfloat{algorithm}{htbp}{loa}
980 // \floatname{algorithm}{Algorithm}
981 UsedFloats::const_iterator cit = usedFloats_.begin();
982 UsedFloats::const_iterator end = usedFloats_.end();
983 // ostringstream floats;
984 for (; cit != end; ++cit) {
985 Floating const & fl = floats.getType((cit->first));
987 // For builtin floats we do nothing.
988 if (fl.builtin()) continue;
990 // We have to special case "table" and "figure"
991 if (fl.type() == "tabular" || fl.type() == "figure") {
992 // Output code to modify "table" or "figure"
993 // but only if builtin == false
994 // and that have to be true at this point in the
996 string const type = fl.type();
997 string const placement = fl.placement();
998 string const style = fl.style();
999 if (!style.empty()) {
1000 os << "\\floatstyle{" << style << "}\n"
1001 << "\\restylefloat{" << type << "}\n";
1003 if (!placement.empty()) {
1004 os << "\\floatplacement{" << type << "}{"
1005 << placement << "}\n";
1008 // The other non builtin floats.
1010 string const type = fl.type();
1011 string const placement = fl.placement();
1012 string const ext = fl.ext();
1013 string const within = fl.within();
1014 string const style = fl.style();
1015 string const name = fl.name();
1016 os << "\\floatstyle{" << style << "}\n"
1017 << "\\newfloat{" << type << "}{" << placement
1018 << "}{" << ext << '}';
1019 if (!within.empty())
1020 os << '[' << within << ']';
1022 << "\\floatname{" << type << "}{"
1025 // What missing here is to code to minimalize the code
1026 // output so that the same floatstyle will not be
1027 // used several times, when the same style is still in
1031 os << "\n\\newsubfloat{" << fl.type() << "}\n";