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\n"
191 " \\def\\encodingdefault{LGR}}\n"
192 "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
193 "\\DeclareFontEncoding{LGR}{}{}\n";
195 static string const textcyr_def =
196 "\\DeclareRobustCommand{\\cyrtext}{%\n"
197 " \\fontencoding{T2A}\\selectfont\n"
198 " \\def\\encodingdefault{T2A}}\n"
199 "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
200 "\\DeclareFontEncoding{T2A}{}{}\n";
202 static string const mathsym_def =
203 "\\DeclareRobustCommand{\\mathsym}[1]{%\n"
204 " \\mathchoice{\\hbox{\\normalsize\\textrm{#1}}}%\n"
205 " {\\hbox{\\normalsize\\textrm{#1}}}%\n"
206 " {\\hbox{\\scriptsize\\textrm{#1}}}%\n"
207 " {\\hbox{\\tiny\\textrm{#1}}}}\n";
209 /////////////////////////////////////////////////////////////////////
213 /////////////////////////////////////////////////////////////////////
215 LaTeXFeatures::Packages LaTeXFeatures::packages_;
218 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
219 OutputParams const & r)
220 : buffer_(&b), params_(p), runparams_(r)
224 bool LaTeXFeatures::useBabel() const
226 return lyxrc.language_use_babel ||
227 (bufferParams().language->lang() != lyxrc.default_language &&
228 !bufferParams().language->babel().empty()) ||
229 this->hasLanguages();
233 void LaTeXFeatures::require(string const & name)
235 features_.insert(name);
239 void LaTeXFeatures::require(set<string> const & names)
241 features_.insert(names.begin(), names.end());
245 void LaTeXFeatures::getAvailable()
248 support::FileName const real_file = libFileSearch("", "packages.lst");
250 if (real_file.empty())
253 lex.setFile(real_file);
258 // Make sure that we are clean
261 bool finished = false;
263 while (lex.isOK() && !finished) {
265 case Lexer::LEX_FEOF:
269 packages_.insert(lex.getString());
275 void LaTeXFeatures::useLayout(docstring const & layoutname)
277 // Some code to avoid loops in dependency definition
278 static int level = 0;
279 const int maxlevel = 30;
280 if (level > maxlevel) {
281 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
282 << "recursion attained by layout "
283 << to_utf8(layoutname) << endl;
287 DocumentClass const & tclass = params_.documentClass();
288 if (tclass.hasLayout(layoutname)) {
289 // Is this layout already in usedLayouts?
290 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
291 != usedLayouts_.end())
294 Layout const & layout = tclass[layoutname];
295 require(layout.requires());
297 if (!layout.depends_on().empty()) {
299 useLayout(layout.depends_on());
302 usedLayouts_.push_back(layoutname);
304 lyxerr << "LaTeXFeatures::useLayout: layout `"
305 << to_utf8(layoutname) << "' does not exist in this class"
313 bool LaTeXFeatures::isRequired(string const & name) const
315 return features_.find(name) != features_.end();
319 bool LaTeXFeatures::mustProvide(string const & name) const
321 return isRequired(name) && !params_.documentClass().provides(name);
325 bool LaTeXFeatures::isAvailable(string const & name)
327 if (packages_.empty())
330 if (suffixIs(n, ".sty"))
331 n.erase(name.length() - 4);
332 return packages_.find(n) != packages_.end();
336 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
338 SnippetList::const_iterator begin = preamble_snippets_.begin();
339 SnippetList::const_iterator end = preamble_snippets_.end();
340 if (find(begin, end, preamble) == end)
341 preamble_snippets_.push_back(preamble);
345 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
347 if (!usedFloats_[name])
348 usedFloats_[name] = subfloat;
351 // We only need float.sty if we use non builtin floats, or if we
352 // use the "H" modifier. This includes modified table and
353 // figure floats. (Lgb)
354 Floating const & fl = params_.documentClass().floats().getType(name);
355 if (!fl.type().empty() && !fl.builtin()) {
361 void LaTeXFeatures::useLanguage(Language const * lang)
363 if (!lang->babel().empty())
364 UsedLanguages_.insert(lang);
365 // CJK languages do not have a babel name.
366 // They use the CJK package
367 if (lang->encoding()->package() == Encoding::CJK)
372 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
374 IncludedFiles_[key] = name;
378 bool LaTeXFeatures::hasLanguages() const
380 return !UsedLanguages_.empty();
384 string LaTeXFeatures::getLanguages() const
386 ostringstream languages;
388 LanguageList::const_iterator const begin = UsedLanguages_.begin();
389 for (LanguageList::const_iterator cit = begin;
390 cit != UsedLanguages_.end();
394 languages << (*cit)->babel();
396 return languages.str();
400 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
402 // This does only find encodings of languages supported by babel, but
403 // that does not matter since we don't have a language with an
404 // encoding supported by inputenc but without babel support.
405 set<string> encodings;
406 LanguageList::const_iterator it = UsedLanguages_.begin();
407 LanguageList::const_iterator end = UsedLanguages_.end();
408 for (; it != end; ++it)
409 if ((*it)->encoding()->latexName() != doc_encoding &&
410 (*it)->encoding()->package() == Encoding::inputenc)
411 encodings.insert((*it)->encoding()->latexName());
417 char const * simplefeatures[] = {
418 // note that the package order here will be the same in the LaTeX-output
425 // subfig is handled in BufferParams.cpp
428 /*For a successful cooperation of the `wrapfig' package with the
429 `float' package you should load the `wrapfig' package *after*
430 the `float' package. See the caption package documentation
464 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
469 string const LaTeXFeatures::getPackages() const
471 ostringstream packages;
472 DocumentClass const & tclass = params_.documentClass();
474 // FIXME: currently, we can only load packages and macros known
476 // However, with the Require tag of layouts/custom insets,
477 // also inknown packages can be requested. They are silently
478 // swallowed now. We should change this eventually.
481 // These are all the 'simple' includes. i.e
482 // packages which we just \usepackage{package}
484 for (int i = 0; i < nb_simplefeatures; ++i) {
485 if (mustProvide(simplefeatures[i]))
486 packages << "\\usepackage{"
487 << simplefeatures[i] << "}\n";
491 // The rest of these packages are somewhat more complicated
495 // esint is preferred for esintoramsmath
496 if ((mustProvide("amsmath") &&
497 params_.use_amsmath != BufferParams::package_off) ||
498 (mustProvide("esintoramsmath") &&
499 params_.use_esint == BufferParams::package_off)) {
500 packages << "\\usepackage{amsmath}\n";
501 } else if (mustProvide("amsbsy")) {
502 // amsbsy is already provided by amsmath
503 packages << "\\usepackage{amsbsy}\n";
506 // wasysym is a simple feature, but it must be after amsmath if both
508 // wasysym redefines some integrals (e.g. iint) from amsmath. That
509 // leads to inconsistent integrals. We only load this package if
510 // the document does not contain integrals (then isRequired("esint")
511 // is false) or if esint is used, since esint redefines all relevant
512 // integral symbols from wasysym and amsmath.
513 // See http://bugzilla.lyx.org/show_bug.cgi?id=1942
514 if (mustProvide("wasysym") &&
515 (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
516 packages << "\\usepackage{wasysym}\n";
519 if (mustProvide("color") || mustProvide("xcolor")) {
520 string const package =
521 (mustProvide("xcolor") ? "xcolor" : "color");
522 if (params_.graphicsDriver == "default")
523 packages << "\\usepackage{" << package << "}\n";
525 packages << "\\usepackage["
526 << params_.graphicsDriver
527 << "]{" << package << "}\n";
530 // pdfcolmk must be loaded after color
531 if (mustProvide("pdfcolmk"))
532 packages << "\\usepackage{pdfcolmk}\n";
535 if (isRequired("makeidx")) {
536 if (!tclass.provides("makeidx"))
537 packages << "\\usepackage{makeidx}\n";
538 packages << "\\makeindex\n";
542 if (mustProvide("graphicx") && params_.graphicsDriver != "none") {
543 if (params_.graphicsDriver == "default")
544 packages << "\\usepackage{graphicx}\n";
546 packages << "\\usepackage["
547 << params_.graphicsDriver
550 // shadecolor for shaded
551 if (isRequired("framed") && mustProvide("color")) {
552 RGBColor c = rgbFromHexName(lcolor.getX11Name(Color_shadedbg));
553 //255.0 to force conversion to double
554 //NOTE As Jürgen Spitzmüller pointed out, an alternative would be
555 //to use the xcolor package instead, and then we can do
556 // \define{shadcolor}{RGB}...
557 //and not do any conversion. We'd then need to require xcolor
558 //in InsetNote::validate().
559 int const stmSize = packages.precision(2);
560 packages << "\\definecolor{shadecolor}{rgb}{"
561 << c.r / 255.0 << ',' << c.g / 255.0 << ',' << c.b / 255.0 << "}\n";
562 packages.precision(stmSize);
565 // lyxskak.sty --- newer chess support based on skak.sty
566 if (mustProvide("chess"))
567 packages << "\\usepackage[ps,mover]{lyxskak}\n";
570 if (mustProvide("setspace") && !tclass.provides("SetSpace"))
571 packages << "\\usepackage{setspace}\n";
574 if (mustProvide("amssymb")
575 || params_.use_amsmath == BufferParams::package_on)
576 packages << "\\usepackage{amssymb}\n";
578 // esint must be after amsmath and wasysym, since it will redeclare
579 // inconsistent integral symbols
580 if ((mustProvide("esint") || mustProvide("esintoramsmath")) &&
581 params_.use_esint != BufferParams::package_off)
582 packages << "\\usepackage{esint}\n";
585 if (mustProvide("natbib")) {
586 packages << "\\usepackage[";
587 if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
588 packages << "numbers";
590 packages << "authoryear";
591 packages << "]{natbib}\n";
594 // jurabib -- we need version 0.6 at least.
595 if (mustProvide("jurabib"))
596 packages << "\\usepackage{jurabib}[2004/01/25]\n";
598 // xargs -- we need version 1.09 at least
599 if (mustProvide("xargs"))
600 packages << "\\usepackage{xargs}[2008/03/08]\n";
602 // bibtopic -- the dot provides the aux file naming which
604 if (mustProvide("bibtopic"))
605 packages << "\\usepackage[dot]{bibtopic}\n";
607 if (mustProvide("xy"))
608 packages << "\\usepackage[all]{xy}\n";
610 if (mustProvide("nomencl")) {
611 // Make it work with the new and old version of the package,
612 // but don't use the compatibility option since it is
613 // incompatible to other packages.
614 packages << "\\usepackage{nomencl}\n"
615 "% the following is useful when we have the old nomencl.sty package\n"
616 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
617 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
618 "\\makenomenclature\n";
621 return packages.str();
625 string const LaTeXFeatures::getMacros() const
627 ostringstream macros;
629 if (!preamble_snippets_.empty())
631 SnippetList::const_iterator pit = preamble_snippets_.begin();
632 SnippetList::const_iterator pend = preamble_snippets_.end();
633 for (; pit != pend; ++pit)
634 macros << *pit << '\n';
636 if (mustProvide("LyX"))
637 macros << lyx_def << '\n';
639 if (mustProvide("lyxline"))
640 macros << lyxline_def << '\n';
642 if (mustProvide("noun"))
643 macros << noun_def << '\n';
645 if (mustProvide("lyxarrow"))
646 macros << lyxarrow_def << '\n';
648 if (mustProvide("textgreek"))
649 macros << textgreek_def << '\n';
651 if (mustProvide("textcyr"))
652 macros << textcyr_def << '\n';
654 if (mustProvide("mathsym"))
655 macros << mathsym_def << '\n';
658 if (mustProvide("quotesinglbase"))
659 macros << quotesinglbase_def << '\n';
660 if (mustProvide("quotedblbase"))
661 macros << quotedblbase_def << '\n';
662 if (mustProvide("guilsinglleft"))
663 macros << guilsinglleft_def << '\n';
664 if (mustProvide("guilsinglright"))
665 macros << guilsinglright_def << '\n';
666 if (mustProvide("guillemotleft"))
667 macros << guillemotleft_def << '\n';
668 if (mustProvide("guillemotright"))
669 macros << guillemotright_def << '\n';
672 if (mustProvide("binom") && !isRequired("amsmath"))
673 macros << binom_def << '\n';
674 if (mustProvide("mathcircumflex"))
675 macros << mathcircumflex_def << '\n';
678 if (mustProvide("ParagraphLeftIndent"))
679 macros << paragraphleftindent_def;
680 if (mustProvide("NeedLyXFootnoteCode"))
681 macros << floatingfootnote_def;
683 // some problems with tex->html converters
684 if (mustProvide("NeedTabularnewline"))
685 macros << tabularnewline_def;
687 // greyedout environment (note inset)
688 if (mustProvide("lyxgreyedout"))
689 macros << lyxgreyedout_def;
691 if (mustProvide("lyxdot"))
692 macros << lyxdot_def << '\n';
695 getFloatDefinitions(macros);
698 if (mustProvide("ct-dvipost"))
699 macros << changetracking_dvipost_def;
701 if (mustProvide("ct-xcolor-soul")) {
702 int const prec = macros.precision(2);
704 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
705 macros << "\\providecolor{lyxadded}{rgb}{"
706 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
708 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
709 macros << "\\providecolor{lyxdeleted}{rgb}{"
710 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
712 macros.precision(prec);
714 if (isRequired("hyperref"))
715 macros << changetracking_xcolor_soul_hyperref_def;
717 macros << changetracking_xcolor_soul_def;
720 if (mustProvide("ct-none"))
721 macros << changetracking_none_def;
727 string const LaTeXFeatures::getBabelOptions() const
731 LanguageList::const_iterator it = UsedLanguages_.begin();
732 LanguageList::const_iterator end = UsedLanguages_.end();
733 for (; it != end; ++it)
734 if (!(*it)->latex_options().empty())
735 tmp << (*it)->latex_options() << '\n';
736 if (!params_.language->latex_options().empty())
737 tmp << params_.language->latex_options() << '\n';
743 docstring const LaTeXFeatures::getTClassPreamble() const
745 // the text class specific preamble
746 DocumentClass const & tclass = params_.documentClass();
747 odocstringstream tcpreamble;
749 tcpreamble << tclass.preamble();
751 list<docstring>::const_iterator cit = usedLayouts_.begin();
752 list<docstring>::const_iterator end = usedLayouts_.end();
753 for (; cit != end; ++cit) {
754 tcpreamble << tclass[*cit].preamble();
757 return tcpreamble.str();
761 docstring const LaTeXFeatures::getLyXSGMLEntities() const
763 // Definition of entities used in the document that are LyX related.
764 odocstringstream entities;
766 if (mustProvide("lyxarrow")) {
767 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
770 return entities.str();
774 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
776 odocstringstream sgmlpreamble;
778 docstring const basename(from_utf8(onlyPath(fname)));
780 FileMap::const_iterator end = IncludedFiles_.end();
781 for (FileMap::const_iterator fi = IncludedFiles_.begin();
784 sgmlpreamble << "\n<!ENTITY " << fi->first
785 << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
786 << makeRelPath(from_utf8(fi->second), basename) << "\">";
788 return sgmlpreamble.str();
792 void LaTeXFeatures::showStruct() const
794 lyxerr << "LyX needs the following commands when LaTeXing:"
795 << "\n***** Packages:" << getPackages()
796 << "\n***** Macros:" << getMacros()
797 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
798 << "\n***** done." << endl;
802 Buffer const & LaTeXFeatures::buffer() const
808 void LaTeXFeatures::setBuffer(Buffer const & buffer)
814 BufferParams const & LaTeXFeatures::bufferParams() const
820 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
822 FloatList const & floats = params_.documentClass().floats();
824 // Here we will output the code to create the needed float styles.
825 // We will try to do this as minimal as possible.
826 // \floatstyle{ruled}
827 // \newfloat{algorithm}{htbp}{loa}
828 // \floatname{algorithm}{Algorithm}
829 UsedFloats::const_iterator cit = usedFloats_.begin();
830 UsedFloats::const_iterator end = usedFloats_.end();
831 // ostringstream floats;
832 for (; cit != end; ++cit) {
833 Floating const & fl = floats.getType((cit->first));
835 // For builtin floats we do nothing.
836 if (fl.builtin()) continue;
838 // We have to special case "table" and "figure"
839 if (fl.type() == "tabular" || fl.type() == "figure") {
840 // Output code to modify "table" or "figure"
841 // but only if builtin == false
842 // and that have to be true at this point in the
844 string const type = fl.type();
845 string const placement = fl.placement();
846 string const style = fl.style();
847 if (!style.empty()) {
848 os << "\\floatstyle{" << style << "}\n"
849 << "\\restylefloat{" << type << "}\n";
851 if (!placement.empty()) {
852 os << "\\floatplacement{" << type << "}{"
853 << placement << "}\n";
856 // The other non builtin floats.
858 string const type = fl.type();
859 string const placement = fl.placement();
860 string const ext = fl.ext();
861 string const within = fl.within();
862 string const style = fl.style();
863 string const name = fl.name();
864 os << "\\floatstyle{" << style << "}\n"
865 << "\\newfloat{" << type << "}{" << placement
866 << "}{" << ext << '}';
868 os << '[' << within << ']';
870 << "\\floatname{" << type << "}{"
873 // What missing here is to code to minimalize the code
874 // output so that the same floatstyle will not be
875 // used several times, when the same style is still in
879 os << "\n\\newsubfloat{" << fl.type() << "}\n";