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"
23 #include "FloatList.h"
28 #include "TextClass.h"
30 #include "support/debug.h"
31 #include "support/docstream.h"
32 #include "support/FileName.h"
33 #include "support/filetools.h"
34 #include "support/lstrings.h"
37 using namespace lyx::support;
42 /////////////////////////////////////////////////////////////////////
46 /////////////////////////////////////////////////////////////////////
48 //\NeedsTeXFormat{LaTeX2e}
49 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
50 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
52 static string const lyx_def =
53 "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}";
55 static string const lyxline_def =
56 "\\newcommand{\\lyxline}[1][1pt]{%\n"
58 " \\rule[.5ex]{\\linewidth}{#1}\\par}";
60 static string const noun_def = "\\newcommand{\\noun}[1]{\\textsc{#1}}";
62 static string const lyxarrow_def =
63 "\\newcommand{\\lyxarrow}{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}";
65 // for quotes without babel. This does not give perfect results, but
66 // anybody serious about non-english quotes should use babel (JMarc).
68 static string const quotedblbase_def =
69 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
70 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
71 " \\penalty10000\\hskip0em\\relax%\n"
74 static string const quotesinglbase_def =
75 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
76 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
77 " \\penalty10000\\hskip0em\\relax%\n"
80 static string const guillemotleft_def =
81 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
82 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
83 "\\penalty10000\\hskip0pt\\relax%\n"
86 static string const guillemotright_def =
87 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
88 " \\penalty10000\\hskip0pt%\n"
89 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
92 static string const guilsinglleft_def =
93 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
94 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
95 " \\penalty10000\\hskip0pt\\relax%\n"
98 static string const guilsinglright_def =
99 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
100 " \\penalty10000\\hskip0pt%\n"
101 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
104 static string const paragraphleftindent_def =
105 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
107 " \\begin{list}{}{%\n"
108 " \\setlength{\\topsep}{0pt}%\n"
109 " \\addtolength{\\leftmargin}{#1}\n"
110 // ho hum, yet more things commented out with no hint as to why they
111 // weren't just removed
112 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
113 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
114 // "%% \\setlength\\listparindent\\parindent%\n"
115 // "%% \\setlength\\itemindent\\parindent%\n"
116 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
122 static string const floatingfootnote_def =
123 "%% Special footnote code from the package 'stblftnt.sty'\n"
124 "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
125 "\\let\\SF@@footnote\\footnote\n"
126 "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
127 " \\expandafter\\SF@@footnote\n"
129 " \\expandafter\\SF@gobble@opt\n"
132 "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
133 " \\SF@gobble@twobracket\n"
136 "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
137 " \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
138 "\\def\\SF@gobble@twobracket[#1]#2{}\n";
140 static string const binom_def =
141 "%% Binom macro for standard LaTeX users\n"
142 "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n";
144 static string const mathcircumflex_def =
145 "%% For printing a cirumflex inside a formula\n"
146 "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n";
148 static string const tabularnewline_def =
149 "%% Because html converters don't know tabularnewline\n"
150 "\\providecommand{\\tabularnewline}{\\\\}\n";
152 static string const lyxgreyedout_def =
153 "%% The greyedout annotation environment\n"
154 "\\newenvironment{lyxgreyedout}{\\textcolor[gray]{0.8}\\bgroup}{\\egroup}\n";
156 // We want to omit the file extension for includegraphics, but this does not
157 // work when the filename contains other dots.
158 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
159 static string const lyxdot_def =
160 "%% A simple dot to overcome graphicx limitations\n"
161 "\\newcommand{\\lyxdot}{.}\n";
163 static string const changetracking_dvipost_def =
164 "%% Change tracking with dvipost\n"
166 "\\dvipost{osstart color push Red}\n"
167 "\\dvipost{osend color pop}\n"
168 "\\dvipost{cbstart color push Blue}\n"
169 "\\dvipost{cbend color pop}\n"
170 "\\newcommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
171 "\\newcommand{\\lyxdeleted}[3]{%\n"
172 "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n";
174 static string const changetracking_xcolor_soul_def =
175 "%% Change tracking with soul\n"
176 "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}#3}}\n"
177 "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\st{#3}}}\n";
179 static string const changetracking_xcolor_soul_hyperref_def =
180 "%% Change tracking with soul\n"
181 "\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}}{}#3}}\n"
182 "\\newcommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\st{#3}}{}}}\n";
184 static string const changetracking_none_def =
185 "\\newcommand{\\lyxadded}[3]{#3}\n"
186 "\\newcommand{\\lyxdeleted}[3]{}\n";
188 static string const textgreek_def =
189 "\\DeclareRobustCommand{\\greektext}{%\n"
190 " \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
191 "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
192 "\\DeclareFontEncoding{LGR}{}{}\n";
194 static string const textcyr_def =
195 "\\DeclareRobustCommand{\\cyrtext}{%\n"
196 " \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
197 "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
198 "\\AtBeginDocument{\\DeclareFontEncoding{T2A}{}{}}\n";
200 static string const lyxmathsym_def =
201 "\\DeclareRobustCommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
202 " \\def\\rmorbf##1{\\ifx\\math@version\\b@ld\\textbf{##1}\\else\\textrm{##1}\\fi}\n"
203 " \\mathchoice{\\hbox{\\rmorbf{#1}}}{\\hbox{\\rmorbf{#1}}}\n"
204 " {\\hbox{\\smaller[2]\\rmorbf{#1}}}{\\hbox{\\smaller[3]\\rmorbf{#1}}}\n"
205 " \\endgroup\\else#1\\fi}\n";
207 static string const papersizedvi_def =
208 "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n";
210 static string const papersizepdf_def =
211 "\\pdfpageheight\\paperheight\n"
212 "\\pdfpagewidth\\paperwidth\n";
214 static string const cedilla_def =
215 "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
216 "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n";
218 static string const subring_def =
219 "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
220 "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n";
222 static string const subdot_def =
223 "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
224 "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n";
226 static string const subhat_def =
227 "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
228 "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n";
230 static string const subtilde_def =
231 "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
232 "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n";
234 static string const dacute_def =
235 "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n";
237 static string const tipasymb_def =
238 "\\DeclareFontEncoding{T3}{}{}\n"
239 "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n";
241 static string const dgrave_def =
242 "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n";
244 static string const rcap_def =
245 "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n";
247 static string const ogonek_def =
248 "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
249 " \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
250 " \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
251 " \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
252 "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n";
254 /////////////////////////////////////////////////////////////////////
258 /////////////////////////////////////////////////////////////////////
260 LaTeXFeatures::Packages LaTeXFeatures::packages_;
263 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
264 OutputParams const & r)
265 : buffer_(&b), params_(p), runparams_(r)
269 bool LaTeXFeatures::useBabel() const
271 return lyxrc.language_use_babel ||
272 (bufferParams().language->lang() != lyxrc.default_language &&
273 !bufferParams().language->babel().empty()) ||
274 this->hasLanguages();
278 void LaTeXFeatures::require(string const & name)
280 features_.insert(name);
284 void LaTeXFeatures::require(set<string> const & names)
286 features_.insert(names.begin(), names.end());
290 void LaTeXFeatures::getAvailable()
293 support::FileName const real_file = libFileSearch("", "packages.lst");
295 if (real_file.empty())
298 lex.setFile(real_file);
303 // Make sure that we are clean
306 bool finished = false;
308 while (lex.isOK() && !finished) {
310 case Lexer::LEX_FEOF:
314 packages_.insert(lex.getString());
320 void LaTeXFeatures::useLayout(docstring const & layoutname)
322 // Some code to avoid loops in dependency definition
323 static int level = 0;
324 const int maxlevel = 30;
325 if (level > maxlevel) {
326 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
327 << "recursion attained by layout "
328 << to_utf8(layoutname) << endl;
332 DocumentClass const & tclass = params_.documentClass();
333 if (tclass.hasLayout(layoutname)) {
334 // Is this layout already in usedLayouts?
335 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
336 != usedLayouts_.end())
339 Layout const & layout = tclass[layoutname];
340 require(layout.requires());
342 if (!layout.depends_on().empty()) {
344 useLayout(layout.depends_on());
347 usedLayouts_.push_back(layoutname);
349 lyxerr << "LaTeXFeatures::useLayout: layout `"
350 << to_utf8(layoutname) << "' does not exist in this class"
358 bool LaTeXFeatures::isRequired(string const & name) const
360 return features_.find(name) != features_.end();
364 bool LaTeXFeatures::mustProvide(string const & name) const
366 return isRequired(name) && !params_.documentClass().provides(name);
370 bool LaTeXFeatures::isAvailable(string const & name)
372 if (packages_.empty())
375 if (suffixIs(n, ".sty"))
376 n.erase(name.length() - 4);
377 return packages_.find(n) != packages_.end();
381 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
383 SnippetList::const_iterator begin = preamble_snippets_.begin();
384 SnippetList::const_iterator end = preamble_snippets_.end();
385 if (find(begin, end, preamble) == end)
386 preamble_snippets_.push_back(preamble);
390 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
392 if (!usedFloats_[name])
393 usedFloats_[name] = subfloat;
396 // We only need float.sty if we use non builtin floats, or if we
397 // use the "H" modifier. This includes modified table and
398 // figure floats. (Lgb)
399 Floating const & fl = params_.documentClass().floats().getType(name);
400 if (!fl.type().empty() && !fl.builtin()) {
406 void LaTeXFeatures::useLanguage(Language const * lang)
408 if (!lang->babel().empty())
409 UsedLanguages_.insert(lang);
410 if (lang->lang() == "vietnamese")
411 require("vietnamese");
412 // CJK languages do not have a babel name.
413 // They use the CJK package
414 if (lang->encoding()->package() == Encoding::CJK)
416 // japanese package is special
417 if (lang->encoding()->package() == Encoding::japanese)
422 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
424 IncludedFiles_[key] = name;
428 bool LaTeXFeatures::hasLanguages() const
430 return !UsedLanguages_.empty();
434 bool LaTeXFeatures::hasLanguage(string const & lang) const
436 LanguageList::const_iterator cit = UsedLanguages_.begin();
437 LanguageList::const_iterator const end = UsedLanguages_.end();
438 for (; cit != end; ++cit) {
439 if ((*cit)->babel() == lang)
446 string LaTeXFeatures::getLanguages() const
448 ostringstream languages;
450 LanguageList::const_iterator const begin = UsedLanguages_.begin();
451 for (LanguageList::const_iterator cit = begin;
452 cit != UsedLanguages_.end();
456 languages << (*cit)->babel();
458 return languages.str();
462 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
464 // This does only find encodings of languages supported by babel, but
465 // that does not matter since we don't have a language with an
466 // encoding supported by inputenc but without babel support.
467 set<string> encodings;
468 LanguageList::const_iterator it = UsedLanguages_.begin();
469 LanguageList::const_iterator end = UsedLanguages_.end();
470 for (; it != end; ++it)
471 if ((*it)->encoding()->latexName() != doc_encoding &&
472 ((*it)->encoding()->package() == Encoding::inputenc
473 || (*it)->encoding()->package() == Encoding::japanese))
474 encodings.insert((*it)->encoding()->latexName());
480 char const * simplefeatures[] = {
481 // note that the package order here will be the same in the LaTeX-output
488 // subfig is handled in BufferParams.cpp
491 /*For a successful cooperation of the `wrapfig' package with the
492 `float' package you should load the `wrapfig' package *after*
493 the `float' package. See the caption package documentation
522 // listings is handled in BufferParams.cpp
530 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
535 string const LaTeXFeatures::getColorOptions() const
537 ostringstream colors;
539 // Handling the color packages separately is needed to be able to load them
540 // before babel when hyperref is loaded with the colorlinks option
541 // for more info see Bufferparams.cpp
544 if (mustProvide("color") || mustProvide("xcolor")) {
545 string const package =
546 (mustProvide("xcolor") ? "xcolor" : "color");
547 if (params_.graphicsDriver == "default"
548 || params_.graphicsDriver == "none")
549 colors << "\\usepackage{" << package << "}\n";
551 colors << "\\usepackage["
552 << params_.graphicsDriver
553 << "]{" << package << "}\n";
556 // pdfcolmk must be loaded after color
557 if (mustProvide("pdfcolmk"))
558 colors << "\\usepackage{pdfcolmk}\n";
564 string const LaTeXFeatures::getPackages() const
566 ostringstream packages;
567 DocumentClass const & tclass = params_.documentClass();
569 // FIXME: currently, we can only load packages and macros known
571 // However, with the Require tag of layouts/custom insets,
572 // also inknown packages can be requested. They are silently
573 // swallowed now. We should change this eventually.
576 // These are all the 'simple' includes. i.e
577 // packages which we just \usepackage{package}
579 for (int i = 0; i < nb_simplefeatures; ++i) {
580 if (mustProvide(simplefeatures[i]))
581 packages << "\\usepackage{"
582 << simplefeatures[i] << "}\n";
586 // The rest of these packages are somewhat more complicated
590 // esint is preferred for esintoramsmath
591 if ((mustProvide("amsmath") &&
592 params_.use_amsmath != BufferParams::package_off) ||
593 (mustProvide("esintoramsmath") &&
594 params_.use_esint == BufferParams::package_off)) {
595 packages << "\\usepackage{amsmath}\n";
596 } else if (mustProvide("amsbsy")) {
597 // amsbsy is already provided by amsmath
598 packages << "\\usepackage{amsbsy}\n";
601 // wasysym is a simple feature, but it must be after amsmath if both
603 // wasysym redefines some integrals (e.g. iint) from amsmath. That
604 // leads to inconsistent integrals. We only load this package if
605 // the document does not contain integrals (then isRequired("esint")
606 // is false) or if esint is used, since esint redefines all relevant
607 // integral symbols from wasysym and amsmath.
608 // See http://bugzilla.lyx.org/show_bug.cgi?id=1942
609 if (mustProvide("wasysym") &&
610 (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
611 packages << "\\usepackage{wasysym}\n";
613 // accents must be loaded after amsmath
614 if (mustProvide("accents"))
615 packages << "\\usepackage{accents}\n";
617 // [x]color and pdfcolmk are handled in getColorOptions() above
620 if (isRequired("makeidx")) {
621 if (!tclass.provides("makeidx"))
622 packages << "\\usepackage{makeidx}\n";
623 packages << "\\makeindex\n";
627 if (mustProvide("graphicx") && params_.graphicsDriver != "none") {
628 if (params_.graphicsDriver == "default")
629 packages << "\\usepackage{graphicx}\n";
631 packages << "\\usepackage["
632 << params_.graphicsDriver
635 // shadecolor for shaded
636 if (isRequired("framed") && mustProvide("color")) {
637 RGBColor c = rgbFromHexName(lcolor.getX11Name(Color_shadedbg));
638 //255.0 to force conversion to double
639 //NOTE As Jürgen Spitzmüller pointed out, an alternative would be
640 //to use the xcolor package instead, and then we can do
641 // \define{shadcolor}{RGB}...
642 //and not do any conversion. We'd then need to require xcolor
643 //in InsetNote::validate().
644 int const stmSize = packages.precision(2);
645 packages << "\\definecolor{shadecolor}{rgb}{"
646 << c.r / 255.0 << ',' << c.g / 255.0 << ',' << c.b / 255.0 << "}\n";
647 packages.precision(stmSize);
650 // lyxskak.sty --- newer chess support based on skak.sty
651 if (mustProvide("chess"))
652 packages << "\\usepackage[ps,mover]{lyxskak}\n";
655 if (mustProvide("setspace") && !tclass.provides("SetSpace"))
656 packages << "\\usepackage{setspace}\n";
659 if (mustProvide("amssymb")
660 || params_.use_amsmath == BufferParams::package_on)
661 packages << "\\usepackage{amssymb}\n";
663 // esint must be after amsmath and wasysym, since it will redeclare
664 // inconsistent integral symbols
665 if ((mustProvide("esint") || mustProvide("esintoramsmath")) &&
666 params_.use_esint != BufferParams::package_off)
667 packages << "\\usepackage{esint}\n";
670 // Some classes load natbib themselves, but still allow (or even require)
671 // plain numeric citations (ReVTeX is such a case, see bug 5182).
672 // This special case is indicated by the "natbib-internal" key.
673 if (mustProvide("natbib") && !tclass.provides("natbib-internal")) {
674 packages << "\\usepackage[";
675 if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
676 packages << "numbers";
678 packages << "authoryear";
679 packages << "]{natbib}\n";
682 // jurabib -- we need version 0.6 at least.
683 if (mustProvide("jurabib"))
684 packages << "\\usepackage{jurabib}[2004/01/25]\n";
686 // xargs -- we need version 1.09 at least
687 if (mustProvide("xargs"))
688 packages << "\\usepackage{xargs}[2008/03/08]\n";
690 // bibtopic -- the dot provides the aux file naming which
692 if (mustProvide("bibtopic"))
693 packages << "\\usepackage[dot]{bibtopic}\n";
695 if (mustProvide("xy"))
696 packages << "\\usepackage[all]{xy}\n";
698 if (mustProvide("nomencl")) {
699 // Make it work with the new and old version of the package,
700 // but don't use the compatibility option since it is
701 // incompatible to other packages.
702 packages << "\\usepackage{nomencl}\n"
703 "% the following is useful when we have the old nomencl.sty package\n"
704 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
705 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
706 "\\makenomenclature\n";
709 return packages.str();
713 string const LaTeXFeatures::getMacros() const
715 ostringstream macros;
717 if (!preamble_snippets_.empty())
719 SnippetList::const_iterator pit = preamble_snippets_.begin();
720 SnippetList::const_iterator pend = preamble_snippets_.end();
721 for (; pit != pend; ++pit)
722 macros << *pit << '\n';
724 if (mustProvide("papersize"))
725 if (runparams_.flavor == OutputParams::LATEX)
726 macros << papersizedvi_def << '\n';
728 macros << papersizepdf_def << '\n';
730 if (mustProvide("LyX"))
731 macros << lyx_def << '\n';
733 if (mustProvide("lyxline"))
734 macros << lyxline_def << '\n';
736 if (mustProvide("noun"))
737 macros << noun_def << '\n';
739 if (mustProvide("lyxarrow"))
740 macros << lyxarrow_def << '\n';
742 if (mustProvide("textgreek"))
743 macros << textgreek_def << '\n';
745 if (mustProvide("textcyr"))
746 macros << textcyr_def << '\n';
748 if (mustProvide("lyxmathsym"))
749 macros << lyxmathsym_def << '\n';
751 if (mustProvide("cedilla"))
752 macros << cedilla_def << '\n';
754 if (mustProvide("subring"))
755 macros << subring_def << '\n';
757 if (mustProvide("subdot"))
758 macros << subdot_def << '\n';
760 if (mustProvide("subhat"))
761 macros << subhat_def << '\n';
763 if (mustProvide("subtilde"))
764 macros << subtilde_def << '\n';
766 if (mustProvide("dacute"))
767 macros << dacute_def << '\n';
769 if (mustProvide("tipasymb"))
770 macros << tipasymb_def << '\n';
772 if (mustProvide("dgrave"))
773 macros << dgrave_def << '\n';
775 if (mustProvide("rcap"))
776 macros << rcap_def << '\n';
778 if (mustProvide("ogonek"))
779 macros << ogonek_def << '\n';
782 if (mustProvide("quotesinglbase"))
783 macros << quotesinglbase_def << '\n';
784 if (mustProvide("quotedblbase"))
785 macros << quotedblbase_def << '\n';
786 if (mustProvide("guilsinglleft"))
787 macros << guilsinglleft_def << '\n';
788 if (mustProvide("guilsinglright"))
789 macros << guilsinglright_def << '\n';
790 if (mustProvide("guillemotleft"))
791 macros << guillemotleft_def << '\n';
792 if (mustProvide("guillemotright"))
793 macros << guillemotright_def << '\n';
796 if (mustProvide("binom") && !isRequired("amsmath"))
797 macros << binom_def << '\n';
798 if (mustProvide("mathcircumflex"))
799 macros << mathcircumflex_def << '\n';
802 if (mustProvide("ParagraphLeftIndent"))
803 macros << paragraphleftindent_def;
804 if (mustProvide("NeedLyXFootnoteCode"))
805 macros << floatingfootnote_def;
807 // some problems with tex->html converters
808 if (mustProvide("NeedTabularnewline"))
809 macros << tabularnewline_def;
811 // greyedout environment (note inset)
812 if (mustProvide("lyxgreyedout"))
813 macros << lyxgreyedout_def;
815 if (mustProvide("lyxdot"))
816 macros << lyxdot_def << '\n';
819 getFloatDefinitions(macros);
822 if (mustProvide("ct-dvipost"))
823 macros << changetracking_dvipost_def;
825 if (mustProvide("ct-xcolor-soul")) {
826 int const prec = macros.precision(2);
828 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
829 macros << "\\providecolor{lyxadded}{rgb}{"
830 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
832 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
833 macros << "\\providecolor{lyxdeleted}{rgb}{"
834 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
836 macros.precision(prec);
838 if (isRequired("hyperref"))
839 macros << changetracking_xcolor_soul_hyperref_def;
841 macros << changetracking_xcolor_soul_def;
844 if (mustProvide("ct-none"))
845 macros << changetracking_none_def;
851 string const LaTeXFeatures::getBabelOptions() const
855 LanguageList::const_iterator it = UsedLanguages_.begin();
856 LanguageList::const_iterator end = UsedLanguages_.end();
857 for (; it != end; ++it)
858 if (!(*it)->latex_options().empty())
859 tmp << (*it)->latex_options() << '\n';
860 if (!params_.language->latex_options().empty())
861 tmp << params_.language->latex_options() << '\n';
867 docstring const LaTeXFeatures::getTClassPreamble() const
869 // the text class specific preamble
870 DocumentClass const & tclass = params_.documentClass();
871 odocstringstream tcpreamble;
873 tcpreamble << tclass.preamble();
875 list<docstring>::const_iterator cit = usedLayouts_.begin();
876 list<docstring>::const_iterator end = usedLayouts_.end();
877 for (; cit != end; ++cit) {
878 tcpreamble << tclass[*cit].preamble();
881 return tcpreamble.str();
885 docstring const LaTeXFeatures::getLyXSGMLEntities() const
887 // Definition of entities used in the document that are LyX related.
888 odocstringstream entities;
890 if (mustProvide("lyxarrow")) {
891 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
894 return entities.str();
898 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
900 odocstringstream sgmlpreamble;
902 docstring const basename(from_utf8(onlyPath(fname)));
904 FileMap::const_iterator end = IncludedFiles_.end();
905 for (FileMap::const_iterator fi = IncludedFiles_.begin();
908 sgmlpreamble << "\n<!ENTITY " << fi->first
909 << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
910 << makeRelPath(from_utf8(fi->second), basename) << "\">";
912 return sgmlpreamble.str();
916 void LaTeXFeatures::showStruct() const
918 lyxerr << "LyX needs the following commands when LaTeXing:"
919 << "\n***** Packages:" << getPackages()
920 << "\n***** Macros:" << getMacros()
921 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
922 << "\n***** done." << endl;
926 Buffer const & LaTeXFeatures::buffer() const
932 void LaTeXFeatures::setBuffer(Buffer const & buffer)
938 BufferParams const & LaTeXFeatures::bufferParams() const
944 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
946 FloatList const & floats = params_.documentClass().floats();
948 // Here we will output the code to create the needed float styles.
949 // We will try to do this as minimal as possible.
950 // \floatstyle{ruled}
951 // \newfloat{algorithm}{htbp}{loa}
952 // \floatname{algorithm}{Algorithm}
953 UsedFloats::const_iterator cit = usedFloats_.begin();
954 UsedFloats::const_iterator end = usedFloats_.end();
955 // ostringstream floats;
956 for (; cit != end; ++cit) {
957 Floating const & fl = floats.getType((cit->first));
959 // For builtin floats we do nothing.
960 if (fl.builtin()) continue;
962 // We have to special case "table" and "figure"
963 if (fl.type() == "tabular" || fl.type() == "figure") {
964 // Output code to modify "table" or "figure"
965 // but only if builtin == false
966 // and that have to be true at this point in the
968 string const type = fl.type();
969 string const placement = fl.placement();
970 string const style = fl.style();
971 if (!style.empty()) {
972 os << "\\floatstyle{" << style << "}\n"
973 << "\\restylefloat{" << type << "}\n";
975 if (!placement.empty()) {
976 os << "\\floatplacement{" << type << "}{"
977 << placement << "}\n";
980 // The other non builtin floats.
982 string const type = fl.type();
983 string const placement = fl.placement();
984 string const ext = fl.ext();
985 string const within = fl.within();
986 string const style = fl.style();
987 string const name = fl.name();
988 os << "\\floatstyle{" << style << "}\n"
989 << "\\newfloat{" << type << "}{" << placement
990 << "}{" << ext << '}';
992 os << '[' << within << ']';
994 << "\\floatname{" << type << "}{"
997 // What missing here is to code to minimalize the code
998 // output so that the same floatstyle will not be
999 // used several times, when the same style is still in
1003 os << "\n\\newsubfloat{" << fl.type() << "}\n";