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;
41 /////////////////////////////////////////////////////////////////////
45 /////////////////////////////////////////////////////////////////////
47 //\NeedsTeXFormat{LaTeX2e}
48 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
49 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
51 static string const lyx_def =
52 "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}";
54 static string const lyxline_def =
55 "\\newcommand{\\lyxline}[1][1pt]{%\n"
57 " \\rule[.5ex]{\\linewidth}{#1}\\par}";
59 static string const noun_def = "\\newcommand{\\noun}[1]{\\textsc{#1}}";
61 static string const lyxarrow_def =
62 "\\newcommand{\\lyxarrow}{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}";
64 // for quotes without babel. This does not give perfect results, but
65 // anybody serious about non-english quotes should use babel (JMarc).
67 static string const quotedblbase_def =
68 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
69 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
70 " \\penalty10000\\hskip0em\\relax%\n"
73 static string const quotesinglbase_def =
74 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
75 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
76 " \\penalty10000\\hskip0em\\relax%\n"
79 static string const guillemotleft_def =
80 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
81 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
82 "\\penalty10000\\hskip0pt\\relax%\n"
85 static string const guillemotright_def =
86 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
87 " \\penalty10000\\hskip0pt%\n"
88 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
91 static string const guilsinglleft_def =
92 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
93 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
94 " \\penalty10000\\hskip0pt\\relax%\n"
97 static string const guilsinglright_def =
98 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
99 " \\penalty10000\\hskip0pt%\n"
100 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
103 static string const paragraphleftindent_def =
104 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
106 " \\begin{list}{}{%\n"
107 " \\setlength{\\topsep}{0pt}%\n"
108 " \\addtolength{\\leftmargin}{#1}\n"
109 // ho hum, yet more things commented out with no hint as to why they
110 // weren't just removed
111 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
112 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
113 // "%% \\setlength\\listparindent\\parindent%\n"
114 // "%% \\setlength\\itemindent\\parindent%\n"
115 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
121 static string const floatingfootnote_def =
122 "%% Special footnote code from the package 'stblftnt.sty'\n"
123 "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
124 "\\let\\SF@@footnote\\footnote\n"
125 "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
126 " \\expandafter\\SF@@footnote\n"
128 " \\expandafter\\SF@gobble@opt\n"
131 "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
132 " \\SF@gobble@twobracket\n"
135 "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
136 " \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
137 "\\def\\SF@gobble@twobracket[#1]#2{}\n";
139 static string const boldsymbol_def =
140 "%% Bold symbol macro for standard LaTeX users\n"
141 "\\providecommand{\\boldsymbol}[1]{\\mbox{\\boldmath $#1$}}\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\n"
194 " \\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\n"
201 " \\def\\encodingdefault{T2A}}\n"
202 "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
203 "\\DeclareFontEncoding{T2A}{}{}\n";
205 /////////////////////////////////////////////////////////////////////
209 /////////////////////////////////////////////////////////////////////
211 LaTeXFeatures::Packages LaTeXFeatures::packages_;
214 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
215 OutputParams const & r)
216 : buffer_(&b), params_(p), runparams_(r)
220 bool LaTeXFeatures::useBabel() const
222 return lyxrc.language_use_babel ||
223 (bufferParams().language->lang() != lyxrc.default_language &&
224 !bufferParams().language->babel().empty()) ||
225 this->hasLanguages();
229 void LaTeXFeatures::require(string const & name)
231 features_.insert(name);
235 void LaTeXFeatures::require(set<string> const & names)
237 features_.insert(names.begin(), names.end());
241 void LaTeXFeatures::getAvailable()
244 support::FileName const real_file = libFileSearch("", "packages.lst");
246 if (real_file.empty())
249 lex.setFile(real_file);
254 // Make sure that we are clean
257 bool finished = false;
259 while (lex.isOK() && !finished) {
261 case Lexer::LEX_FEOF:
265 packages_.insert(lex.getString());
271 void LaTeXFeatures::useLayout(docstring const & layoutname)
273 // Some code to avoid loops in dependency definition
274 static int level = 0;
275 const int maxlevel = 30;
276 if (level > maxlevel) {
277 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
278 << "recursion attained by layout "
279 << to_utf8(layoutname) << endl;
283 DocumentClass const & tclass = params_.documentClass();
284 if (tclass.hasLayout(layoutname)) {
285 // Is this layout already in usedLayouts?
286 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
287 != usedLayouts_.end())
290 Layout const & layout = tclass[layoutname];
291 require(layout.requires());
293 if (!layout.depends_on().empty()) {
295 useLayout(layout.depends_on());
298 usedLayouts_.push_back(layoutname);
300 lyxerr << "LaTeXFeatures::useLayout: layout `"
301 << to_utf8(layoutname) << "' does not exist in this class"
309 bool LaTeXFeatures::isRequired(string const & name) const
311 return features_.find(name) != features_.end();
315 bool LaTeXFeatures::mustProvide(string const & name) const
317 return isRequired(name) && !params_.documentClass().provides(name);
321 bool LaTeXFeatures::isAvailable(string const & name)
323 if (packages_.empty())
326 if (suffixIs(n, ".sty"))
327 n.erase(name.length() - 4);
328 return packages_.find(n) != packages_.end();
332 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
334 SnippetList::const_iterator begin = preamble_snippets_.begin();
335 SnippetList::const_iterator end = preamble_snippets_.end();
336 if (find(begin, end, preamble) == end)
337 preamble_snippets_.push_back(preamble);
341 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
343 if (!usedFloats_[name])
344 usedFloats_[name] = subfloat;
347 // We only need float.sty if we use non builtin floats, or if we
348 // use the "H" modifier. This includes modified table and
349 // figure floats. (Lgb)
350 Floating const & fl = params_.documentClass().floats().getType(name);
351 if (!fl.type().empty() && !fl.builtin()) {
357 void LaTeXFeatures::useLanguage(Language const * lang)
359 if (!lang->babel().empty())
360 UsedLanguages_.insert(lang);
361 // CJK languages do not have a babel name.
362 // They use the CJK package
363 if (lang->encoding()->package() == Encoding::CJK)
368 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
370 IncludedFiles_[key] = name;
374 bool LaTeXFeatures::hasLanguages() const
376 return !UsedLanguages_.empty();
380 string LaTeXFeatures::getLanguages() const
382 ostringstream languages;
384 LanguageList::const_iterator const begin = UsedLanguages_.begin();
385 for (LanguageList::const_iterator cit = begin;
386 cit != UsedLanguages_.end();
390 languages << (*cit)->babel();
392 return languages.str();
396 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
398 // This does only find encodings of languages supported by babel, but
399 // that does not matter since we don't have a language with an
400 // encoding supported by inputenc but without babel support.
401 set<string> encodings;
402 LanguageList::const_iterator it = UsedLanguages_.begin();
403 LanguageList::const_iterator end = UsedLanguages_.end();
404 for (; it != end; ++it)
405 if ((*it)->encoding()->latexName() != doc_encoding &&
406 (*it)->encoding()->package() == Encoding::inputenc)
407 encodings.insert((*it)->encoding()->latexName());
413 char const * simplefeatures[] = {
414 // note that the package order here will be the same in the LaTeX-output
424 /*For a successful cooperation of the `wrapfig' package with the
425 `float' package you should load the `wrapfig' package *after*
426 the `float' package. See the caption package documentation
459 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
464 string const LaTeXFeatures::getPackages() const
466 ostringstream packages;
467 DocumentClass const & tclass = params_.documentClass();
469 // FIXME: currently, we can only load packages and macros known
471 // However, with the Require tag of layouts/custom insets,
472 // also inknown packages can be requested. They are silently
473 // swallowed now. We should change this eventually.
476 // These are all the 'simple' includes. i.e
477 // packages which we just \usepackage{package}
479 for (int i = 0; i < nb_simplefeatures; ++i) {
480 if (mustProvide(simplefeatures[i]))
481 packages << "\\usepackage{"
482 << simplefeatures[i] << "}\n";
486 // The rest of these packages are somewhat more complicated
490 // esint is preferred for esintoramsmath
491 if ((mustProvide("amsmath") &&
492 params_.use_amsmath != BufferParams::package_off) ||
493 (mustProvide("esintoramsmath") &&
494 params_.use_esint == BufferParams::package_off)) {
495 packages << "\\usepackage{amsmath}\n";
498 // wasysym is a simple feature, but it must be after amsmath if both
500 // wasysym redefines some integrals (e.g. iint) from amsmath. That
501 // leads to inconsistent integrals. We only load this package if
502 // the document does not contain integrals (then isRequired("esint")
503 // is false) or if esint is used, since esint redefines all relevant
504 // integral symbols from wasysym and amsmath.
505 // See http://bugzilla.lyx.org/show_bug.cgi?id=1942
506 if (mustProvide("wasysym") &&
507 (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
508 packages << "\\usepackage{wasysym}\n";
511 if (mustProvide("color") || mustProvide("xcolor")) {
512 string const package =
513 (mustProvide("xcolor") ? "xcolor" : "color");
514 if (params_.graphicsDriver == "default")
515 packages << "\\usepackage{" << package << "}\n";
517 packages << "\\usepackage["
518 << params_.graphicsDriver
519 << "]{" << package << "}\n";
522 // pdfcolmk must be loaded after color
523 if (mustProvide("pdfcolmk")) {
524 packages << "\\usepackage{pdfcolmk}\n";
528 if (isRequired("makeidx")) {
529 if (!tclass.provides("makeidx"))
530 packages << "\\usepackage{makeidx}\n";
531 packages << "\\makeindex\n";
535 if (mustProvide("graphicx") && params_.graphicsDriver != "none") {
536 if (params_.graphicsDriver == "default")
537 packages << "\\usepackage{graphicx}\n";
539 packages << "\\usepackage["
540 << params_.graphicsDriver
543 // shadecolor for shaded
544 if (isRequired("framed") && mustProvide("color")) {
545 RGBColor c = rgbFromHexName(lcolor.getX11Name(Color_shadedbg));
546 //255.0 to force conversion to double
547 //NOTE As Jürgen Spitzmüller pointed out, an alternative would be
548 //to use the xcolor package instead, and then we can do
549 // \define{shadcolor}{RGB}...
550 //and not do any conversion. We'd then need to require xcolor
551 //in InsetNote::validate().
552 int const stmSize = packages.precision(2);
553 packages << "\\definecolor{shadecolor}{rgb}{"
554 << c.r / 255.0 << ',' << c.g / 255.0 << ',' << c.b / 255.0 << "}\n";
555 packages.precision(stmSize);
558 // lyxskak.sty --- newer chess support based on skak.sty
559 if (mustProvide("chess")) {
560 packages << "\\usepackage[ps,mover]{lyxskak}\n";
564 if (mustProvide("setspace") && !tclass.provides("SetSpace"))
565 packages << "\\usepackage{setspace}\n";
568 if (mustProvide("amssymb")
569 || params_.use_amsmath == BufferParams::package_on)
570 packages << "\\usepackage{amssymb}\n";
572 // esint must be after amsmath and wasysym, since it will redeclare
573 // inconsistent integral symbols
574 if ((mustProvide("esint") || mustProvide("esintoramsmath")) &&
575 params_.use_esint != BufferParams::package_off)
576 packages << "\\usepackage{esint}\n";
579 if (mustProvide("natbib")) {
580 packages << "\\usepackage[";
581 if (params_.getEngine() == biblio::ENGINE_NATBIB_NUMERICAL) {
582 packages << "numbers";
584 packages << "authoryear";
586 packages << "]{natbib}\n";
589 // jurabib -- we need version 0.6 at least.
590 if (mustProvide("jurabib")) {
591 packages << "\\usepackage{jurabib}[2004/01/25]\n";
594 // xargs -- we need version 1.09 at least
595 if (mustProvide("xargs")) {
596 packages << "\\usepackage{xargs}[2008/03/08]\n";
599 // bibtopic -- the dot provides the aux file naming which
601 if (mustProvide("bibtopic")) {
602 packages << "\\usepackage[dot]{bibtopic}\n";
605 if (mustProvide("xy"))
606 packages << "\\usepackage[all]{xy}\n";
608 if (mustProvide("nomencl")) {
609 // Make it work with the new and old version of the package,
610 // but don't use the compatibility option since it is
611 // incompatible to other packages.
612 packages << "\\usepackage{nomencl}\n"
613 "% the following is useful when we have the old nomencl.sty package\n"
614 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
615 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
616 "\\makenomenclature\n";
619 return packages.str();
623 string const LaTeXFeatures::getMacros() const
625 ostringstream macros;
627 if (!preamble_snippets_.empty())
629 SnippetList::const_iterator pit = preamble_snippets_.begin();
630 SnippetList::const_iterator pend = preamble_snippets_.end();
631 for (; pit != pend; ++pit)
632 macros << *pit << '\n';
634 if (mustProvide("LyX"))
635 macros << lyx_def << '\n';
637 if (mustProvide("lyxline"))
638 macros << lyxline_def << '\n';
640 if (mustProvide("noun"))
641 macros << noun_def << '\n';
643 if (mustProvide("lyxarrow"))
644 macros << lyxarrow_def << '\n';
646 if (mustProvide("textgreek"))
647 macros << textgreek_def << '\n';
649 if (mustProvide("textcyr"))
650 macros << textcyr_def << '\n';
653 if (mustProvide("quotesinglbase"))
654 macros << quotesinglbase_def << '\n';
655 if (mustProvide("quotedblbase"))
656 macros << quotedblbase_def << '\n';
657 if (mustProvide("guilsinglleft"))
658 macros << guilsinglleft_def << '\n';
659 if (mustProvide("guilsinglright"))
660 macros << guilsinglright_def << '\n';
661 if (mustProvide("guillemotleft"))
662 macros << guillemotleft_def << '\n';
663 if (mustProvide("guillemotright"))
664 macros << guillemotright_def << '\n';
667 if (mustProvide("boldsymbol") && !isRequired("amsmath"))
668 macros << boldsymbol_def << '\n';
669 if (mustProvide("binom") && !isRequired("amsmath"))
670 macros << binom_def << '\n';
671 if (mustProvide("mathcircumflex"))
672 macros << mathcircumflex_def << '\n';
675 if (mustProvide("ParagraphLeftIndent"))
676 macros << paragraphleftindent_def;
677 if (mustProvide("NeedLyXFootnoteCode"))
678 macros << floatingfootnote_def;
680 // some problems with tex->html converters
681 if (mustProvide("NeedTabularnewline"))
682 macros << tabularnewline_def;
684 // greyedout environment (note inset)
685 if (mustProvide("lyxgreyedout"))
686 macros << lyxgreyedout_def;
688 if (mustProvide("lyxdot"))
689 macros << lyxdot_def << '\n';
692 getFloatDefinitions(macros);
695 if (mustProvide("ct-dvipost"))
696 macros << changetracking_dvipost_def;
698 if (mustProvide("ct-xcolor-soul")) {
699 int const prec = macros.precision(2);
701 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
702 macros << "\\providecolor{lyxadded}{rgb}{"
703 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
705 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
706 macros << "\\providecolor{lyxdeleted}{rgb}{"
707 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
709 macros.precision(prec);
711 if (isRequired("hyperref"))
712 macros << changetracking_xcolor_soul_hyperref_def;
714 macros << changetracking_xcolor_soul_def;
717 if (mustProvide("ct-none"))
718 macros << changetracking_none_def;
724 string const LaTeXFeatures::getBabelOptions() const
728 LanguageList::const_iterator it = UsedLanguages_.begin();
729 LanguageList::const_iterator end = UsedLanguages_.end();
730 for (; it != end; ++it)
731 if (!(*it)->latex_options().empty())
732 tmp << (*it)->latex_options() << '\n';
733 if (!params_.language->latex_options().empty())
734 tmp << params_.language->latex_options() << '\n';
740 docstring const LaTeXFeatures::getTClassPreamble() const
742 // the text class specific preamble
743 DocumentClass const & tclass = params_.documentClass();
744 odocstringstream tcpreamble;
746 tcpreamble << tclass.preamble();
748 list<docstring>::const_iterator cit = usedLayouts_.begin();
749 list<docstring>::const_iterator end = usedLayouts_.end();
750 for (; cit != end; ++cit) {
751 tcpreamble << tclass[*cit].preamble();
754 return tcpreamble.str();
758 docstring const LaTeXFeatures::getLyXSGMLEntities() const
760 // Definition of entities used in the document that are LyX related.
761 odocstringstream entities;
763 if (mustProvide("lyxarrow")) {
764 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
767 return entities.str();
771 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
773 odocstringstream sgmlpreamble;
775 docstring const basename(from_utf8(onlyPath(fname)));
777 FileMap::const_iterator end = IncludedFiles_.end();
778 for (FileMap::const_iterator fi = IncludedFiles_.begin();
781 sgmlpreamble << "\n<!ENTITY " << fi->first
782 << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
783 << makeRelPath(from_utf8(fi->second), basename) << "\">";
785 return sgmlpreamble.str();
789 void LaTeXFeatures::showStruct() const {
790 lyxerr << "LyX needs the following commands when LaTeXing:"
791 << "\n***** Packages:" << getPackages()
792 << "\n***** Macros:" << getMacros()
793 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
794 << "\n***** done." << endl;
798 Buffer const & LaTeXFeatures::buffer() const
804 void LaTeXFeatures::setBuffer(Buffer const & buffer)
810 BufferParams const & LaTeXFeatures::bufferParams() const
816 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
818 FloatList const & floats = params_.documentClass().floats();
820 // Here we will output the code to create the needed float styles.
821 // We will try to do this as minimal as possible.
822 // \floatstyle{ruled}
823 // \newfloat{algorithm}{htbp}{loa}
824 // \floatname{algorithm}{Algorithm}
825 UsedFloats::const_iterator cit = usedFloats_.begin();
826 UsedFloats::const_iterator end = usedFloats_.end();
827 // ostringstream floats;
828 for (; cit != end; ++cit) {
829 Floating const & fl = floats.getType((cit->first));
831 // For builtin floats we do nothing.
832 if (fl.builtin()) continue;
834 // We have to special case "table" and "figure"
835 if (fl.type() == "tabular" || fl.type() == "figure") {
836 // Output code to modify "table" or "figure"
837 // but only if builtin == false
838 // and that have to be true at this point in the
840 string const type = fl.type();
841 string const placement = fl.placement();
842 string const style = fl.style();
843 if (!style.empty()) {
844 os << "\\floatstyle{" << style << "}\n"
845 << "\\restylefloat{" << type << "}\n";
847 if (!placement.empty()) {
848 os << "\\floatplacement{" << type << "}{"
849 << placement << "}\n";
852 // The other non builtin floats.
854 string const type = fl.type();
855 string const placement = fl.placement();
856 string const ext = fl.ext();
857 string const within = fl.within();
858 string const style = fl.style();
859 string const name = fl.name();
860 os << "\\floatstyle{" << style << "}\n"
861 << "\\newfloat{" << type << "}{" << placement
862 << "}{" << ext << '}';
864 os << '[' << within << ']';
866 << "\\floatname{" << type << "}{"
869 // What missing here is to code to minimalize the code
870 // output so that the same floatstyle will not be
871 // used several times, when the same style is still in
875 os << "\n\\newsubfloat{" << fl.type() << "}\n";