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}{%\n"
65 "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
66 "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}";
68 // for quotes without babel. This does not give perfect results, but
69 // anybody serious about non-english quotes should use babel (JMarc).
71 static string const quotedblbase_def =
72 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
73 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
74 " \\penalty10000\\hskip0em\\relax%\n"
77 static string const quotesinglbase_def =
78 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
79 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
80 " \\penalty10000\\hskip0em\\relax%\n"
83 static string const guillemotleft_def =
84 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
85 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
86 "\\penalty10000\\hskip0pt\\relax%\n"
89 static string const guillemotright_def =
90 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
91 " \\penalty10000\\hskip0pt%\n"
92 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
95 static string const guilsinglleft_def =
96 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
97 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
98 " \\penalty10000\\hskip0pt\\relax%\n"
101 static string const guilsinglright_def =
102 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
103 " \\penalty10000\\hskip0pt%\n"
104 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
107 static string const paragraphleftindent_def =
108 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
110 " \\begin{list}{}{%\n"
111 " \\setlength{\\topsep}{0pt}%\n"
112 " \\addtolength{\\leftmargin}{#1}\n"
113 // ho hum, yet more things commented out with no hint as to why they
114 // weren't just removed
115 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
116 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
117 // "%% \\setlength\\listparindent\\parindent%\n"
118 // "%% \\setlength\\itemindent\\parindent%\n"
119 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
125 static string const floatingfootnote_def =
126 "%% Special footnote code from the package 'stblftnt.sty'\n"
127 "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
128 "\\let\\SF@@footnote\\footnote\n"
129 "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
130 " \\expandafter\\SF@@footnote\n"
132 " \\expandafter\\SF@gobble@opt\n"
135 "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
136 " \\SF@gobble@twobracket\n"
139 "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
140 " \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
141 "\\def\\SF@gobble@twobracket[#1]#2{}\n";
143 static string const binom_def =
144 "%% Binom macro for standard LaTeX users\n"
145 "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n";
147 static string const mathcircumflex_def =
148 "%% For printing a cirumflex inside a formula\n"
149 "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n";
151 static string const tabularnewline_def =
152 "%% Because html converters don't know tabularnewline\n"
153 "\\providecommand{\\tabularnewline}{\\\\}\n";
155 static string const lyxgreyedout_def =
156 "%% The greyedout annotation environment\n"
157 "\\newenvironment{lyxgreyedout}{\\textcolor[gray]{0.8}\\bgroup}{\\egroup}\n";
159 // We want to omit the file extension for includegraphics, but this does not
160 // work when the filename contains other dots.
161 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
162 static string const lyxdot_def =
163 "%% A simple dot to overcome graphicx limitations\n"
164 "\\newcommand{\\lyxdot}{.}\n";
166 static string const changetracking_dvipost_def =
167 "%% Change tracking with dvipost\n"
169 "\\dvipost{osstart color push Red}\n"
170 "\\dvipost{osend color pop}\n"
171 "\\dvipost{cbstart color push Blue}\n"
172 "\\dvipost{cbend color pop}\n"
173 "\\newcommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
174 "\\newcommand{\\lyxdeleted}[3]{%\n"
175 "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n";
177 static string const changetracking_xcolor_soul_def =
178 "%% Change tracking with soul\n"
179 "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}#3}}\n"
180 "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\st{#3}}}\n";
182 static string const changetracking_xcolor_soul_hyperref_def =
183 "%% Change tracking with soul\n"
184 "\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}}{}#3}}\n"
185 "\\newcommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\st{#3}}{}}}\n";
187 static string const changetracking_none_def =
188 "\\newcommand{\\lyxadded}[3]{#3}\n"
189 "\\newcommand{\\lyxdeleted}[3]{}\n";
191 static string const textgreek_def =
192 "\\DeclareRobustCommand{\\greektext}{%\n"
193 " \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
194 "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
195 "\\DeclareFontEncoding{LGR}{}{}\n";
197 static string const textcyr_def =
198 "\\DeclareRobustCommand{\\cyrtext}{%\n"
199 " \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
200 "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
201 "\\AtBeginDocument{\\DeclareFontEncoding{T2A}{}{}}\n";
203 static string const lyxmathsym_def =
204 "\\DeclareRobustCommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
205 " \\def\\rmorbf##1{\\ifx\\math@version\\b@ld\\textbf{##1}\\else\\textrm{##1}\\fi}\n"
206 " \\mathchoice{\\hbox{\\rmorbf{#1}}}{\\hbox{\\rmorbf{#1}}}\n"
207 " {\\hbox{\\smaller[2]\\rmorbf{#1}}}{\\hbox{\\smaller[3]\\rmorbf{#1}}}\n"
208 " \\endgroup\\else#1\\fi}\n";
210 static string const papersizedvi_def =
211 "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n";
213 static string const papersizepdf_def =
214 "\\pdfpageheight\\paperheight\n"
215 "\\pdfpagewidth\\paperwidth\n";
217 static string const cedilla_def =
218 "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
219 "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n";
221 static string const subring_def =
222 "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
223 "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n";
225 static string const subdot_def =
226 "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
227 "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n";
229 static string const subhat_def =
230 "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
231 "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n";
233 static string const subtilde_def =
234 "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
235 "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n";
237 static string const dacute_def =
238 "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n";
240 static string const tipasymb_def =
241 "\\DeclareFontEncoding{T3}{}{}\n"
242 "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n";
244 static string const dgrave_def =
245 "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n";
247 static string const rcap_def =
248 "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n";
250 static string const ogonek_def =
251 "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
252 " \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
253 " \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
254 " \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
255 "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n";
257 /////////////////////////////////////////////////////////////////////
261 /////////////////////////////////////////////////////////////////////
263 LaTeXFeatures::Packages LaTeXFeatures::packages_;
266 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
267 OutputParams const & r)
268 : buffer_(&b), params_(p), runparams_(r)
272 bool LaTeXFeatures::useBabel() const
274 return lyxrc.language_use_babel ||
275 (bufferParams().language->lang() != lyxrc.default_language &&
276 !bufferParams().language->babel().empty()) ||
277 this->hasLanguages();
281 void LaTeXFeatures::require(string const & name)
283 features_.insert(name);
287 void LaTeXFeatures::require(set<string> const & names)
289 features_.insert(names.begin(), names.end());
293 void LaTeXFeatures::getAvailable()
296 support::FileName const real_file = libFileSearch("", "packages.lst");
298 if (real_file.empty())
301 lex.setFile(real_file);
306 // Make sure that we are clean
309 bool finished = false;
311 while (lex.isOK() && !finished) {
313 case Lexer::LEX_FEOF:
317 packages_.insert(lex.getString());
323 void LaTeXFeatures::useLayout(docstring const & layoutname)
325 // Some code to avoid loops in dependency definition
326 static int level = 0;
327 const int maxlevel = 30;
328 if (level > maxlevel) {
329 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
330 << "recursion attained by layout "
331 << to_utf8(layoutname) << endl;
335 DocumentClass const & tclass = params_.documentClass();
336 if (tclass.hasLayout(layoutname)) {
337 // Is this layout already in usedLayouts?
338 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
339 != usedLayouts_.end())
342 Layout const & layout = tclass[layoutname];
343 require(layout.requires());
345 if (!layout.depends_on().empty()) {
347 useLayout(layout.depends_on());
350 usedLayouts_.push_back(layoutname);
352 lyxerr << "LaTeXFeatures::useLayout: layout `"
353 << to_utf8(layoutname) << "' does not exist in this class"
361 bool LaTeXFeatures::isRequired(string const & name) const
363 return features_.find(name) != features_.end();
367 bool LaTeXFeatures::mustProvide(string const & name) const
369 return isRequired(name) && !params_.documentClass().provides(name);
373 bool LaTeXFeatures::isAvailable(string const & name)
375 if (packages_.empty())
378 if (suffixIs(n, ".sty"))
379 n.erase(name.length() - 4);
380 return packages_.find(n) != packages_.end();
384 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
386 SnippetList::const_iterator begin = preamble_snippets_.begin();
387 SnippetList::const_iterator end = preamble_snippets_.end();
388 if (find(begin, end, preamble) == end)
389 preamble_snippets_.push_back(preamble);
393 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
395 if (!usedFloats_[name])
396 usedFloats_[name] = subfloat;
399 // We only need float.sty if we use non builtin floats, or if we
400 // use the "H" modifier. This includes modified table and
401 // figure floats. (Lgb)
402 Floating const & fl = params_.documentClass().floats().getType(name);
403 if (!fl.type().empty() && !fl.builtin()) {
409 void LaTeXFeatures::useLanguage(Language const * lang)
411 if (!lang->babel().empty())
412 UsedLanguages_.insert(lang);
413 if (lang->lang() == "vietnamese")
414 require("vietnamese");
415 // CJK languages do not have a babel name.
416 // They use the CJK package
417 if (lang->encoding()->package() == Encoding::CJK)
419 // japanese package is special
420 if (lang->encoding()->package() == Encoding::japanese)
425 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
427 IncludedFiles_[key] = name;
431 bool LaTeXFeatures::hasLanguages() const
433 return !UsedLanguages_.empty();
437 string LaTeXFeatures::getLanguages() const
439 ostringstream languages;
441 LanguageList::const_iterator const begin = UsedLanguages_.begin();
442 for (LanguageList::const_iterator cit = begin;
443 cit != UsedLanguages_.end();
447 languages << (*cit)->babel();
449 return languages.str();
453 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
455 // This does only find encodings of languages supported by babel, but
456 // that does not matter since we don't have a language with an
457 // encoding supported by inputenc but without babel support.
458 set<string> encodings;
459 LanguageList::const_iterator it = UsedLanguages_.begin();
460 LanguageList::const_iterator end = UsedLanguages_.end();
461 for (; it != end; ++it)
462 if ((*it)->encoding()->latexName() != doc_encoding &&
463 ((*it)->encoding()->package() == Encoding::inputenc
464 || (*it)->encoding()->package() == Encoding::japanese))
465 encodings.insert((*it)->encoding()->latexName());
471 char const * simplefeatures[] = {
472 // note that the package order here will be the same in the LaTeX-output
479 // subfig is handled in BufferParams.cpp
482 /*For a successful cooperation of the `wrapfig' package with the
483 `float' package you should load the `wrapfig' package *after*
484 the `float' package. See the caption package documentation
513 // listings is handled in BufferParams.cpp
521 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
526 string const LaTeXFeatures::getColorOptions() const
528 ostringstream colors;
530 // Handling the color packages separately is needed to be able to load them
531 // before babel when hyperref is loaded with the colorlinks option
532 // for more info see Bufferparams.cpp
535 if (mustProvide("color") || mustProvide("xcolor")) {
536 string const package =
537 (mustProvide("xcolor") ? "xcolor" : "color");
538 if (params_.graphicsDriver == "default"
539 || params_.graphicsDriver == "none")
540 colors << "\\usepackage{" << package << "}\n";
542 colors << "\\usepackage["
543 << params_.graphicsDriver
544 << "]{" << package << "}\n";
547 // pdfcolmk must be loaded after color
548 if (mustProvide("pdfcolmk"))
549 colors << "\\usepackage{pdfcolmk}\n";
555 string const LaTeXFeatures::getPackages() const
557 ostringstream packages;
558 DocumentClass const & tclass = params_.documentClass();
560 // FIXME: currently, we can only load packages and macros known
562 // However, with the Require tag of layouts/custom insets,
563 // also inknown packages can be requested. They are silently
564 // swallowed now. We should change this eventually.
567 // These are all the 'simple' includes. i.e
568 // packages which we just \usepackage{package}
570 for (int i = 0; i < nb_simplefeatures; ++i) {
571 if (mustProvide(simplefeatures[i]))
572 packages << "\\usepackage{"
573 << simplefeatures[i] << "}\n";
577 // The rest of these packages are somewhat more complicated
581 // esint is preferred for esintoramsmath
582 if ((mustProvide("amsmath")
583 && params_.use_amsmath != BufferParams::package_off)
584 || (mustProvide("esintoramsmath")
585 && params_.use_esint == BufferParams::package_off
586 && params_.use_amsmath != BufferParams::package_off)) {
587 packages << "\\usepackage{amsmath}\n";
588 } else if (mustProvide("amsbsy")) {
589 // amsbsy is already provided by amsmath
590 packages << "\\usepackage{amsbsy}\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("nomencl")) {
691 // Make it work with the new and old version of the package,
692 // but don't use the compatibility option since it is
693 // incompatible to other packages.
694 packages << "\\usepackage{nomencl}\n"
695 "% the following is useful when we have the old nomencl.sty package\n"
696 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
697 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
698 "\\makenomenclature\n";
701 return packages.str();
705 string const LaTeXFeatures::getMacros() const
707 ostringstream macros;
709 if (!preamble_snippets_.empty())
711 SnippetList::const_iterator pit = preamble_snippets_.begin();
712 SnippetList::const_iterator pend = preamble_snippets_.end();
713 for (; pit != pend; ++pit)
714 macros << *pit << '\n';
716 if (mustProvide("papersize")) {
717 if (runparams_.flavor == OutputParams::LATEX)
718 macros << papersizedvi_def << '\n';
720 macros << papersizepdf_def << '\n';
723 if (mustProvide("LyX"))
724 macros << lyx_def << '\n';
726 if (mustProvide("lyxline"))
727 macros << lyxline_def << '\n';
729 if (mustProvide("noun"))
730 macros << noun_def << '\n';
732 if (mustProvide("lyxarrow"))
733 macros << lyxarrow_def << '\n';
735 if (mustProvide("textgreek"))
736 macros << textgreek_def << '\n';
738 if (mustProvide("textcyr"))
739 macros << textcyr_def << '\n';
741 if (mustProvide("lyxmathsym"))
742 macros << lyxmathsym_def << '\n';
744 if (mustProvide("cedilla"))
745 macros << cedilla_def << '\n';
747 if (mustProvide("subring"))
748 macros << subring_def << '\n';
750 if (mustProvide("subdot"))
751 macros << subdot_def << '\n';
753 if (mustProvide("subhat"))
754 macros << subhat_def << '\n';
756 if (mustProvide("subtilde"))
757 macros << subtilde_def << '\n';
759 if (mustProvide("dacute"))
760 macros << dacute_def << '\n';
762 if (mustProvide("tipasymb"))
763 macros << tipasymb_def << '\n';
765 if (mustProvide("dgrave"))
766 macros << dgrave_def << '\n';
768 if (mustProvide("rcap"))
769 macros << rcap_def << '\n';
771 if (mustProvide("ogonek"))
772 macros << ogonek_def << '\n';
775 if (mustProvide("quotesinglbase"))
776 macros << quotesinglbase_def << '\n';
777 if (mustProvide("quotedblbase"))
778 macros << quotedblbase_def << '\n';
779 if (mustProvide("guilsinglleft"))
780 macros << guilsinglleft_def << '\n';
781 if (mustProvide("guilsinglright"))
782 macros << guilsinglright_def << '\n';
783 if (mustProvide("guillemotleft"))
784 macros << guillemotleft_def << '\n';
785 if (mustProvide("guillemotright"))
786 macros << guillemotright_def << '\n';
789 if (mustProvide("binom") && !isRequired("amsmath"))
790 macros << binom_def << '\n';
791 if (mustProvide("mathcircumflex"))
792 macros << mathcircumflex_def << '\n';
795 if (mustProvide("ParagraphLeftIndent"))
796 macros << paragraphleftindent_def;
797 if (mustProvide("NeedLyXFootnoteCode"))
798 macros << floatingfootnote_def;
800 // some problems with tex->html converters
801 if (mustProvide("NeedTabularnewline"))
802 macros << tabularnewline_def;
804 // greyedout environment (note inset)
805 if (mustProvide("lyxgreyedout"))
806 macros << lyxgreyedout_def;
808 if (mustProvide("lyxdot"))
809 macros << lyxdot_def << '\n';
812 getFloatDefinitions(macros);
815 if (mustProvide("ct-dvipost"))
816 macros << changetracking_dvipost_def;
818 if (mustProvide("ct-xcolor-soul")) {
819 int const prec = macros.precision(2);
821 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
822 macros << "\\providecolor{lyxadded}{rgb}{"
823 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
825 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
826 macros << "\\providecolor{lyxdeleted}{rgb}{"
827 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
829 macros.precision(prec);
831 if (isRequired("hyperref"))
832 macros << changetracking_xcolor_soul_hyperref_def;
834 macros << changetracking_xcolor_soul_def;
837 if (mustProvide("ct-none"))
838 macros << changetracking_none_def;
844 string const LaTeXFeatures::getBabelOptions() const
848 LanguageList::const_iterator it = UsedLanguages_.begin();
849 LanguageList::const_iterator end = UsedLanguages_.end();
850 for (; it != end; ++it)
851 if (!(*it)->latex_options().empty())
852 tmp << (*it)->latex_options() << '\n';
853 if (!params_.language->latex_options().empty())
854 tmp << params_.language->latex_options() << '\n';
860 docstring const LaTeXFeatures::getTClassPreamble() const
862 // the text class specific preamble
863 DocumentClass const & tclass = params_.documentClass();
864 odocstringstream tcpreamble;
866 tcpreamble << tclass.preamble();
868 list<docstring>::const_iterator cit = usedLayouts_.begin();
869 list<docstring>::const_iterator end = usedLayouts_.end();
870 for (; cit != end; ++cit) {
871 tcpreamble << tclass[*cit].preamble();
874 return tcpreamble.str();
878 docstring const LaTeXFeatures::getLyXSGMLEntities() const
880 // Definition of entities used in the document that are LyX related.
881 odocstringstream entities;
883 if (mustProvide("lyxarrow")) {
884 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
887 return entities.str();
891 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
893 odocstringstream sgmlpreamble;
895 docstring const basename(from_utf8(onlyPath(fname)));
897 FileMap::const_iterator end = IncludedFiles_.end();
898 for (FileMap::const_iterator fi = IncludedFiles_.begin();
901 sgmlpreamble << "\n<!ENTITY " << fi->first
902 << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
903 << makeRelPath(from_utf8(fi->second), basename) << "\">";
905 return sgmlpreamble.str();
909 void LaTeXFeatures::showStruct() const
911 lyxerr << "LyX needs the following commands when LaTeXing:"
912 << "\n***** Packages:" << getPackages()
913 << "\n***** Macros:" << getMacros()
914 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
915 << "\n***** done." << endl;
919 Buffer const & LaTeXFeatures::buffer() const
925 void LaTeXFeatures::setBuffer(Buffer const & buffer)
931 BufferParams const & LaTeXFeatures::bufferParams() const
937 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
939 FloatList const & floats = params_.documentClass().floats();
941 // Here we will output the code to create the needed float styles.
942 // We will try to do this as minimal as possible.
943 // \floatstyle{ruled}
944 // \newfloat{algorithm}{htbp}{loa}
945 // \floatname{algorithm}{Algorithm}
946 UsedFloats::const_iterator cit = usedFloats_.begin();
947 UsedFloats::const_iterator end = usedFloats_.end();
948 // ostringstream floats;
949 for (; cit != end; ++cit) {
950 Floating const & fl = floats.getType((cit->first));
952 // For builtin floats we do nothing.
953 if (fl.builtin()) continue;
955 // We have to special case "table" and "figure"
956 if (fl.type() == "tabular" || fl.type() == "figure") {
957 // Output code to modify "table" or "figure"
958 // but only if builtin == false
959 // and that have to be true at this point in the
961 string const type = fl.type();
962 string const placement = fl.placement();
963 string const style = fl.style();
964 if (!style.empty()) {
965 os << "\\floatstyle{" << style << "}\n"
966 << "\\restylefloat{" << type << "}\n";
968 if (!placement.empty()) {
969 os << "\\floatplacement{" << type << "}{"
970 << placement << "}\n";
973 // The other non builtin floats.
975 string const type = fl.type();
976 string const placement = fl.placement();
977 string const ext = fl.ext();
978 string const within = fl.within();
979 string const style = fl.style();
980 string const name = fl.name();
981 os << "\\floatstyle{" << style << "}\n"
982 << "\\newfloat{" << type << "}{" << placement
983 << "}{" << ext << '}';
985 os << '[' << within << ']';
987 << "\\floatname{" << type << "}{"
990 // What missing here is to code to minimalize the code
991 // output so that the same floatstyle will not be
992 // used several times, when the same style is still in
996 os << "\n\\newsubfloat{" << fl.type() << "}\n";