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"
22 #include "Converter.h"
25 #include "FloatList.h"
27 #include "LaTeXFonts.h"
28 #include "LaTeXPackages.h"
32 #include "TextClass.h"
34 #include "insets/InsetLayout.h"
36 #include "support/debug.h"
37 #include "support/docstream.h"
38 #include "support/FileName.h"
39 #include "support/filetools.h"
40 #include "support/gettext.h"
41 #include "support/lstrings.h"
42 #include "support/regex.h"
48 using namespace lyx::support;
53 /////////////////////////////////////////////////////////////////////
57 /////////////////////////////////////////////////////////////////////
59 //\NeedsTeXFormat{LaTeX2e}
60 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
61 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
63 static docstring const lyx_def = from_ascii(
64 "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}");
66 static docstring const lyx_hyperref_def = from_ascii(
67 "\\providecommand{\\LyX}{\\texorpdfstring%\n"
68 " {L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}\n"
71 static docstring const noun_def = from_ascii(
72 "\\newcommand{\\noun}[1]{\\textsc{#1}}");
74 static docstring const lyxarrow_def = from_ascii(
75 "\\DeclareRobustCommand*{\\lyxarrow}{%\n"
77 "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
78 "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}");
80 // for quotes without babel. This does not give perfect results, but
81 // anybody serious about non-english quotes should use babel (JMarc).
83 static docstring const quotedblbase_def = from_ascii(
84 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
85 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
86 " \\penalty10000\\hskip0em\\relax%\n"
89 static docstring const quotesinglbase_def = from_ascii(
90 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
91 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
92 " \\penalty10000\\hskip0em\\relax%\n"
95 static docstring const guillemotleft_def = from_ascii(
96 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
97 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
98 "\\penalty10000\\hskip0pt\\relax%\n"
101 static docstring const guillemotright_def = from_ascii(
102 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
103 " \\penalty10000\\hskip0pt%\n"
104 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
107 static docstring const guilsinglleft_def = from_ascii(
108 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
109 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
110 " \\penalty10000\\hskip0pt\\relax%\n"
113 static docstring const guilsinglright_def = from_ascii(
114 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
115 " \\penalty10000\\hskip0pt%\n"
116 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
119 static docstring const paragraphleftindent_def = from_ascii(
120 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
122 " \\begin{list}{}{%\n"
123 " \\setlength{\\topsep}{0pt}%\n"
124 " \\addtolength{\\leftmargin}{#1}\n"
125 // ho hum, yet more things commented out with no hint as to why they
126 // weren't just removed
127 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
128 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
129 // "%% \\setlength\\listparindent\\parindent%\n"
130 // "%% \\setlength\\itemindent\\parindent%\n"
131 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
137 static docstring const floatingfootnote_def = from_ascii(
138 "%% Special footnote code from the package 'stblftnt.sty'\n"
139 "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
140 "\\let\\SF@@footnote\\footnote\n"
141 "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
142 " \\expandafter\\SF@@footnote\n"
144 " \\expandafter\\SF@gobble@opt\n"
147 "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
148 " \\SF@gobble@twobracket\n"
151 "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
152 " \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
153 "\\def\\SF@gobble@twobracket[#1]#2{}\n");
155 static docstring const binom_def = from_ascii(
156 "%% Binom macro for standard LaTeX users\n"
157 "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n");
159 static docstring const mathcircumflex_def = from_ascii(
160 "%% For printing a cirumflex inside a formula\n"
161 "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n");
163 static docstring const tabularnewline_def = from_ascii(
164 "%% Because html converters don't know tabularnewline\n"
165 "\\providecommand{\\tabularnewline}{\\\\}\n");
167 static docstring const lyxgreyedout_def = from_ascii(
168 "%% The greyedout annotation environment\n"
169 "\\newenvironment{lyxgreyedout}\n"
170 " {\\textcolor{note_fontcolor}\\bgroup\\ignorespaces}\n"
171 " {\\ignorespacesafterend\\egroup}\n");
173 // We want to omit the file extension for includegraphics, but this does not
174 // work when the filename contains other dots.
175 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
176 static docstring const lyxdot_def = from_ascii(
177 "%% A simple dot to overcome graphicx limitations\n"
178 "\\newcommand{\\lyxdot}{.}\n");
180 static docstring const changetracking_dvipost_def = from_ascii(
181 "%% Change tracking with dvipost\n"
183 "\\dvipost{osstart color push Red}\n"
184 "\\dvipost{osend color pop}\n"
185 "\\dvipost{cbstart color push Blue}\n"
186 "\\dvipost{cbend color pop}\n"
187 "\\DeclareRobustCommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
188 "\\DeclareRobustCommand{\\lyxdeleted}[3]{%\n"
189 "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n");
191 static docstring const changetracking_xcolor_ulem_def = from_ascii(
192 "%% Change tracking with ulem\n"
193 "\\DeclareRobustCommand{\\lyxadded}[3]{{\\color{lyxadded}{}#3}}\n"
194 "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\sout{#3}}}\n");
196 static docstring const changetracking_xcolor_ulem_hyperref_def = from_ascii(
197 "%% Change tracking with ulem\n"
198 "\\DeclareRobustCommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}{}}{}#3}}\n"
199 "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\sout{#3}}{}}}\n");
201 static docstring const changetracking_none_def = from_ascii(
202 "\\newcommand{\\lyxadded}[3]{#3}\n"
203 "\\newcommand{\\lyxdeleted}[3]{}\n");
205 static docstring const textgreek_def = from_ascii(
206 "\\DeclareRobustCommand{\\greektext}{%\n"
207 " \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
208 "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
209 "\\DeclareFontEncoding{LGR}{}{}\n"
210 "\\DeclareTextSymbol{\\~}{LGR}{126}");
212 static docstring const textcyr_def = from_ascii(
213 "\\DeclareRobustCommand{\\cyrtext}{%\n"
214 " \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
215 "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
216 "\\AtBeginDocument{\\DeclareFontEncoding{T2A}{}{}}\n");
218 static docstring const lyxmathsym_def = from_ascii(
219 "\\newcommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
220 " \\text{\\ifx\\math@version\\b@ld\\bfseries\\fi#1}\\endgroup\\else#1\\fi}\n");
222 static docstring const papersizedvi_def = from_ascii(
223 "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n");
225 static docstring const papersizepdf_def = from_ascii(
226 "\\pdfpageheight\\paperheight\n"
227 "\\pdfpagewidth\\paperwidth\n");
229 static docstring const cedilla_def = from_ascii(
230 "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
231 "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n");
233 static docstring const subring_def = from_ascii(
234 "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
235 "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n");
237 static docstring const subdot_def = from_ascii(
238 "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
239 "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n");
241 static docstring const subhat_def = from_ascii(
242 "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
243 "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n");
245 static docstring const subtilde_def = from_ascii(
246 "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
247 "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n");
249 static docstring const dacute_def = from_ascii(
250 "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n");
252 static docstring const tipasymb_def = from_ascii(
253 "\\DeclareFontEncoding{T3}{}{}\n"
254 "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n");
256 static docstring const dgrave_def = from_ascii(
257 "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n");
259 static docstring const rcap_def = from_ascii(
260 "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n");
262 static docstring const ogonek_def = from_ascii(
263 "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
264 " \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
265 " \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
266 " \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
267 "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n");
269 static docstring const lyxref_def = from_ascii(
270 "\\RS@ifundefined{subref}\n"
271 " {\\def\\RSsubtxt{section~}\\newref{sub}{name = \\RSsubtxt}}\n"
273 "\\RS@ifundefined{thmref}\n"
274 " {\\def\\RSthmtxt{theorem~}\\newref{thm}{name = \\RSthmtxt}}\n"
276 "\\RS@ifundefined{lemref}\n"
277 " {\\def\\RSlemtxt{lemma~}\\newref{lem}{name = \\RSlemtxt}}\n"
280 // Make sure the columns are also outputed as rtl
281 static docstring const rtloutputdblcol_def = from_ascii(
282 "\\def\\@outputdblcol{%\n"
283 " \\if@firstcolumn\n"
284 " \\global \\@firstcolumnfalse\n"
285 " \\global \\setbox\\@leftcolumn \\box\\@outputbox\n"
287 " \\global \\@firstcolumntrue\n"
288 " \\setbox\\@outputbox \\vbox {%\n"
289 " \\hb@xt@\\textwidth {%\n"
290 " \\kern\\textwidth \\kern-\\columnwidth %**\n"
291 " \\hb@xt@\\columnwidth {%\n"
292 " \\box\\@leftcolumn \\hss}%\n"
293 " \\kern-\\textwidth %**\n"
295 " {\\normalcolor\\vrule \\@width\\columnseprule}%\n"
297 " \\kern-\\textwidth %**\n"
298 " \\hb@xt@\\columnwidth {%\n"
299 " \\box\\@outputbox \\hss}%\n"
300 " \\kern-\\columnwidth \\kern\\textwidth %**\n"
303 " \\@combinedblfloats\n"
306 " \\@dblfloatplacement\n"
307 " \\@startdblcolumn\n"
308 " \\@whilesw\\if@fcolmade \\fi\n"
310 " \\@startdblcolumn}%\n"
314 "\\@mparswitchtrue\n");
317 /////////////////////////////////////////////////////////////////////
321 /////////////////////////////////////////////////////////////////////
324 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
325 OutputParams const & r)
326 : buffer_(&b), params_(p), runparams_(r), in_float_(false)
330 LaTeXFeatures::LangPackage LaTeXFeatures::langPackage(bool englishbabel) const
332 string const local_lp = bufferParams().lang_package;
334 // Locally, custom is just stored as a string
335 // in bufferParams().lang_package.
336 if (local_lp != "auto"
337 && local_lp != "babel"
338 && local_lp != "default"
339 && local_lp != "none")
340 return LANG_PACK_CUSTOM;
342 if (local_lp == "none")
343 return LANG_PACK_NONE;
345 /* If "auto" is selected, we load polyglossia if required,
346 * else we select babel.
347 * If babel is selected (either directly or via the "auto"
348 * mechanism), we really do only require it if we have
349 * a language that needs it.
350 * English alone normally does not require babel (since it is
351 * the default language of LaTeX). However, in some cases we
352 * need to surpass this exception (see Font::validate).
354 bool const polyglossia_required =
355 isRequired("polyglossia")
356 && isAvailable("polyglossia")
357 && !isProvided("babel")
358 && this->hasOnlyPolyglossiaLanguages();
359 bool const babel_required =
360 ((englishbabel || bufferParams().language->lang() != "english")
361 && !bufferParams().language->babel().empty())
362 || !this->getBabelLanguages().empty();
364 if (local_lp == "auto") {
365 // polyglossia requirement has priority over babel
366 if (polyglossia_required)
367 return LANG_PACK_POLYGLOSSIA;
368 else if (babel_required)
369 return LANG_PACK_BABEL;
372 if (local_lp == "babel") {
374 return LANG_PACK_BABEL;
377 if (local_lp == "default") {
378 switch (lyxrc.language_package_selection) {
380 // polyglossia requirement has priority over babel
381 if (polyglossia_required)
382 return LANG_PACK_POLYGLOSSIA;
383 else if (babel_required)
384 return LANG_PACK_BABEL;
386 case LyXRC::LP_BABEL:
388 return LANG_PACK_BABEL;
390 case LyXRC::LP_CUSTOM:
391 return LANG_PACK_CUSTOM;
393 return LANG_PACK_NONE;
397 return LANG_PACK_NONE;
401 void LaTeXFeatures::require(string const & name)
403 features_.insert(name);
407 void LaTeXFeatures::require(set<string> const & names)
409 features_.insert(names.begin(), names.end());
413 void LaTeXFeatures::useLayout(docstring const & layoutname)
415 // Some code to avoid loops in dependency definition
416 static int level = 0;
417 const int maxlevel = 30;
418 if (level > maxlevel) {
419 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
420 << "recursion attained by layout "
421 << to_utf8(layoutname) << endl;
425 DocumentClass const & tclass = params_.documentClass();
426 if (tclass.hasLayout(layoutname)) {
427 // Is this layout already in usedLayouts?
428 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
429 != usedLayouts_.end())
432 Layout const & layout = tclass[layoutname];
433 require(layout.requires());
435 if (!layout.depends_on().empty()) {
437 useLayout(layout.depends_on());
440 usedLayouts_.push_back(layoutname);
442 lyxerr << "LaTeXFeatures::useLayout: layout `"
443 << to_utf8(layoutname) << "' does not exist in this class"
451 void LaTeXFeatures::useInsetLayout(InsetLayout const & lay)
453 docstring const & lname = lay.name();
454 DocumentClass const & tclass = params_.documentClass();
456 // this is a default inset layout, nothing useful here
457 if (!tclass.hasInsetLayout(lname))
459 // Is this layout already in usedInsetLayouts?
460 if (find(usedInsetLayouts_.begin(), usedInsetLayouts_.end(), lname)
461 != usedInsetLayouts_.end())
464 require(lay.requires());
465 usedInsetLayouts_.push_back(lname);
469 bool LaTeXFeatures::isRequired(string const & name) const
471 return features_.find(name) != features_.end();
475 bool LaTeXFeatures::isProvided(string const & name) const
477 if (params_.useNonTeXFonts)
478 return params_.documentClass().provides(name);
480 bool const ot1 = (params_.font_encoding() == "default"
481 || params_.font_encoding() == "OT1");
482 bool const complete = (params_.fonts_sans == "default")
483 && (params_.fonts_typewriter == "default");
484 bool const nomath = (params_.fonts_math == "default");
485 return params_.documentClass().provides(name)
486 || theLaTeXFonts().getLaTeXFont(
487 from_ascii(params_.fonts_roman)).provides(name, ot1,
490 || theLaTeXFonts().getLaTeXFont(
491 from_ascii(params_.fonts_sans)).provides(name, ot1,
494 || theLaTeXFonts().getLaTeXFont(
495 from_ascii(params_.fonts_typewriter)).provides(name, ot1,
498 || theLaTeXFonts().getLaTeXFont(
499 from_ascii(params_.fonts_math)).provides(name, ot1,
505 bool LaTeXFeatures::mustProvide(string const & name) const
507 return isRequired(name) && !isProvided(name);
511 bool LaTeXFeatures::isAvailable(string const & name)
513 string::size_type const i = name.find("->");
514 if (i != string::npos) {
515 string const from = name.substr(0,i);
516 string const to = name.substr(i+2);
517 //LYXERR0("from=[" << from << "] to=[" << to << "]");
518 return theConverters().isReachable(from, to);
520 return LaTeXPackages::isAvailable(name);
524 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
526 SnippetList::const_iterator begin = preamble_snippets_.begin();
527 SnippetList::const_iterator end = preamble_snippets_.end();
528 if (find(begin, end, preamble) == end)
529 preamble_snippets_.push_back(preamble);
533 void LaTeXFeatures::addCSSSnippet(std::string const & snippet)
535 SnippetList::const_iterator begin = css_snippets_.begin();
536 SnippetList::const_iterator end = css_snippets_.end();
537 if (find(begin, end, snippet) == end)
538 css_snippets_.push_back(snippet);
542 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
544 if (!usedFloats_[name])
545 usedFloats_[name] = subfloat;
548 // We only need float.sty if we use non builtin floats, or if we
549 // use the "H" modifier. This includes modified table and
550 // figure floats. (Lgb)
551 Floating const & fl = params_.documentClass().floats().getType(name);
552 if (!fl.floattype().empty() && fl.usesFloatPkg()) {
558 void LaTeXFeatures::useLanguage(Language const * lang)
560 if (!lang->babel().empty() || !lang->polyglossia().empty())
561 UsedLanguages_.insert(lang);
562 if (!lang->requires().empty())
563 require(lang->requires());
564 // CJK languages do not have a babel name.
565 // They use the CJK package
566 if (lang->encoding()->package() == Encoding::CJK)
568 // japanese package is special
569 if (lang->encoding()->package() == Encoding::japanese)
574 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
576 IncludedFiles_[key] = name;
580 bool LaTeXFeatures::hasLanguages() const
582 return !UsedLanguages_.empty();
586 bool LaTeXFeatures::hasOnlyPolyglossiaLanguages() const
588 LanguageList::const_iterator const begin = UsedLanguages_.begin();
589 for (LanguageList::const_iterator cit = begin;
590 cit != UsedLanguages_.end();
592 if ((*cit)->polyglossia().empty())
599 bool LaTeXFeatures::hasPolyglossiaExclusiveLanguages() const
601 LanguageList::const_iterator const begin = UsedLanguages_.begin();
602 for (LanguageList::const_iterator cit = begin;
603 cit != UsedLanguages_.end();
605 if ((*cit)->babel().empty() && !(*cit)->polyglossia().empty() && (*cit)->requires().empty())
612 string LaTeXFeatures::getBabelLanguages() const
614 ostringstream languages;
617 LanguageList::const_iterator const begin = UsedLanguages_.begin();
618 for (LanguageList::const_iterator cit = begin;
619 cit != UsedLanguages_.end();
621 if ((*cit)->babel().empty())
627 languages << (*cit)->babel();
629 return languages.str();
633 std::map<std::string, std::string> LaTeXFeatures::getPolyglossiaLanguages() const
635 std::map<std::string, std::string> languages;
637 LanguageList::const_iterator const begin = UsedLanguages_.begin();
638 for (LanguageList::const_iterator cit = begin;
639 cit != UsedLanguages_.end();
641 languages[(*cit)->polyglossia()] = (*cit)->polyglossiaOpts();
647 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
649 // This does only find encodings of languages supported by babel, but
650 // that does not matter since we don't have a language with an
651 // encoding supported by inputenc but without babel support.
652 set<string> encodings;
653 LanguageList::const_iterator it = UsedLanguages_.begin();
654 LanguageList::const_iterator end = UsedLanguages_.end();
655 for (; it != end; ++it)
656 if ((*it)->encoding()->latexName() != doc_encoding &&
657 ((*it)->encoding()->package() == Encoding::inputenc
658 || (*it)->encoding()->package() == Encoding::japanese))
659 encodings.insert((*it)->encoding()->latexName());
665 char const * simplefeatures[] = {
666 // note that the package order here will be the same in the LaTeX-output
673 // subfig is handled in BufferParams.cpp
677 /*For a successful cooperation of the `wrapfig' package with the
678 `float' package you should load the `wrapfig' package *after*
679 the `float' package. See the caption package documentation
714 // listings is handled in BufferParams.cpp
723 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
728 string const LaTeXFeatures::getColorOptions() const
730 ostringstream colors;
732 // Handling the color packages separately is needed to be able to load them
733 // before babel when hyperref is loaded with the colorlinks option
734 // for more info see Bufferparams.cpp
737 if (mustProvide("color") || mustProvide("xcolor")) {
738 string const package =
739 (mustProvide("xcolor") ? "xcolor" : "color");
740 if (params_.graphics_driver == "default"
741 || params_.graphics_driver == "none")
742 colors << "\\usepackage{" << package << "}\n";
744 colors << "\\usepackage["
745 << params_.graphics_driver
746 << "]{" << package << "}\n";
749 // pdfcolmk must be loaded after color
750 if (mustProvide("pdfcolmk"))
751 colors << "\\usepackage{pdfcolmk}\n";
753 // the following 3 color commands must be set after color
754 // is loaded and before pdfpages, therefore add the command
755 // here define the set color
756 if (mustProvide("pagecolor")) {
757 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
758 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
759 // set the page color
760 colors << "\\pagecolor{page_backgroundcolor}\n";
763 if (mustProvide("fontcolor")) {
764 colors << "\\definecolor{document_fontcolor}{rgb}{";
765 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
767 colors << "\\color{document_fontcolor}\n";
770 if (mustProvide("lyxgreyedout")) {
771 colors << "\\definecolor{note_fontcolor}{rgb}{";
772 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
773 // the color will be set together with the definition of
774 // the lyxgreyedout environment (see lyxgreyedout_def)
777 // color for shaded boxes
778 if (isRequired("framed") && mustProvide("color")) {
779 colors << "\\definecolor{shadecolor}{rgb}{";
780 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
781 // this color is automatically used by the LaTeX-package "framed"
788 string const LaTeXFeatures::getPackages() const
790 ostringstream packages;
792 // FIXME: currently, we can only load packages and macros known
794 // However, with the Require tag of layouts/custom insets,
795 // also unknown packages can be requested. They are silently
796 // swallowed now. We should change this eventually.
799 // These are all the 'simple' includes. i.e
800 // packages which we just \usepackage{package}
802 for (int i = 0; i < nb_simplefeatures; ++i) {
803 if (mustProvide(simplefeatures[i]))
804 packages << "\\usepackage{"
805 << simplefeatures[i] << "}\n";
809 // The rest of these packages are somewhat more complicated
813 // if fontspec is used, AMS packages have to be loaded before
814 // fontspec (in BufferParams)
815 string const amsPackages = loadAMSPackages();
816 if (!params_.useNonTeXFonts && !amsPackages.empty())
817 packages << amsPackages;
819 // fixltx2e must be loaded after amsthm, since amsthm produces an error with
820 // the redefined \[ command (bug 7233). Load it as early as possible, since
821 // other packages might profit from it.
822 if (mustProvide("fixltx2e"))
823 packages << "\\usepackage{fixltx2e}\n";
825 // wasysym is a simple feature, but it must be after amsmath if both
827 // wasysym redefines some integrals (e.g. iint) from amsmath. That
828 // leads to inconsistent integrals. We only load this package if
829 // the document does not contain integrals (then isRequired("esint")
830 // is false) or if esint is used, since esint redefines all relevant
831 // integral symbols from wasysym and amsmath.
832 // See http://www.lyx.org/trac/ticket/1942
833 if (mustProvide("wasysym") &&
834 params_.use_package("wasysym") != BufferParams::package_off &&
835 (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
836 packages << "\\usepackage{wasysym}\n";
838 // accents must be loaded after amsmath
839 if (mustProvide("accents") &&
840 params_.use_package("accents") != BufferParams::package_off)
841 packages << "\\usepackage{accents}\n";
843 // mathdots must be loaded after amsmath
844 if (mustProvide("mathdots") &&
845 params_.use_package("mathdots") != BufferParams::package_off)
846 packages << "\\usepackage{mathdots}\n";
848 // yhmath must be loaded after amsmath
849 if (mustProvide("yhmath") &&
850 params_.use_package("yhmath") != BufferParams::package_off)
851 packages << "\\usepackage{yhmath}\n";
853 // stmaryrd must be loaded after amsmath
854 if (mustProvide("stmaryrd") &&
855 params_.use_package("stmaryrd") != BufferParams::package_off)
856 packages << "\\usepackage{stmaryrd}\n";
858 if (mustProvide("undertilde") &&
859 params_.use_package("undertilde") != BufferParams::package_off)
860 packages << "\\usepackage{undertilde}\n";
862 // [x]color and pdfcolmk are handled in getColorOptions() above
865 if (isRequired("makeidx") || isRequired("splitidx")) {
866 if (!isProvided("makeidx") && !isRequired("splitidx"))
867 packages << "\\usepackage{makeidx}\n";
868 if (mustProvide("splitidx"))
869 packages << "\\usepackage{splitidx}\n";
870 packages << "\\makeindex\n";
874 if (mustProvide("graphicx") && params_.graphics_driver != "none") {
875 if (params_.graphics_driver == "default")
876 packages << "\\usepackage{graphicx}\n";
878 packages << "\\usepackage["
879 << params_.graphics_driver
883 // lyxskak.sty --- newer chess support based on skak.sty
884 if (mustProvide("chess"))
885 packages << "\\usepackage[ps,mover]{lyxskak}\n";
888 if (mustProvide("setspace") && !isProvided("SetSpace"))
889 packages << "\\usepackage{setspace}\n";
891 // esint must be after amsmath and wasysym, since it will redeclare
892 // inconsistent integral symbols
893 if (mustProvide("esint") &&
894 params_.use_package("esint") != BufferParams::package_off)
895 packages << "\\usepackage{esint}\n";
898 // Some classes load natbib themselves, but still allow (or even require)
899 // plain numeric citations (ReVTeX is such a case, see bug 5182).
900 // This special case is indicated by the "natbib-internal" key.
901 if (mustProvide("natbib") && !isProvided("natbib-internal")) {
902 packages << "\\usepackage[";
903 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
904 packages << "numbers";
906 packages << "authoryear";
907 packages << "]{natbib}\n";
910 // jurabib -- we need version 0.6 at least.
911 if (mustProvide("jurabib"))
912 packages << "\\usepackage{jurabib}[2004/01/25]\n";
914 // xargs -- we need version 1.09 at least
915 if (mustProvide("xargs"))
916 packages << "\\usepackage{xargs}[2008/03/08]\n";
918 if (mustProvide("xy"))
919 packages << "\\usepackage[all]{xy}\n";
921 if (mustProvide("feyn"))
922 packages << "\\usepackage{feyn}\n"; //Diagram
924 if (mustProvide("ulem"))
925 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
926 "\\usepackage{ulem}\n";
928 if (mustProvide("mhchem") &&
929 params_.use_package("mhchem") != BufferParams::package_off)
930 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
931 "\\usepackage{mhchem}\n";
933 if (mustProvide("nomencl")) {
934 // Make it work with the new and old version of the package,
935 // but don't use the compatibility option since it is
936 // incompatible to other packages.
937 packages << "\\usepackage{nomencl}\n"
938 "% the following is useful when we have the old nomencl.sty package\n"
939 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
940 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
941 "\\makenomenclature\n";
944 // fixltx2e provides subscript
945 if (mustProvide("subscript") && !isRequired("fixltx2e"))
946 packages << "\\usepackage{subscript}\n";
948 return packages.str();
952 string LaTeXFeatures::getPreambleSnippets() const
955 SnippetList::const_iterator pit = preamble_snippets_.begin();
956 SnippetList::const_iterator pend = preamble_snippets_.end();
957 for (; pit != pend; ++pit)
958 snip << *pit << '\n';
963 std::string LaTeXFeatures::getCSSSnippets() const
966 SnippetList::const_iterator pit = css_snippets_.begin();
967 SnippetList::const_iterator pend = css_snippets_.end();
968 for (; pit != pend; ++pit)
969 snip << *pit << '\n';
974 docstring const LaTeXFeatures::getMacros() const
976 odocstringstream macros;
978 if (!preamble_snippets_.empty()) {
980 macros << from_utf8(getPreambleSnippets());
983 if (mustProvide("papersize")) {
984 if (runparams_.flavor == OutputParams::LATEX)
985 macros << papersizedvi_def << '\n';
987 macros << papersizepdf_def << '\n';
990 if (mustProvide("LyX")) {
991 if (isRequired("hyperref"))
992 macros << lyx_hyperref_def << '\n';
994 macros << lyx_def << '\n';
997 if (mustProvide("noun"))
998 macros << noun_def << '\n';
1000 if (mustProvide("lyxarrow"))
1001 macros << lyxarrow_def << '\n';
1003 if (!usePolyglossia() && mustProvide("textgreek")) {
1004 // Avoid a LaTeX error if times fonts are used and the grtimes
1005 // package is installed but actual fonts are not (bug 6469).
1006 if (params_.fonts_roman == "times")
1007 macros << subst(textgreek_def,
1008 from_ascii("\\greektext #1"),
1009 from_ascii("%\n \\IfFileExists"
1010 "{grtm10.tfm}{}{\\fontfamily"
1011 "{cmr}}\\greektext #1"))
1014 macros << textgreek_def << '\n';
1017 if (!usePolyglossia() && mustProvide("textcyr"))
1018 macros << textcyr_def << '\n';
1020 if (mustProvide("lyxmathsym"))
1021 macros << lyxmathsym_def << '\n';
1023 if (mustProvide("cedilla"))
1024 macros << cedilla_def << '\n';
1026 if (mustProvide("subring"))
1027 macros << subring_def << '\n';
1029 if (mustProvide("subdot"))
1030 macros << subdot_def << '\n';
1032 if (mustProvide("subhat"))
1033 macros << subhat_def << '\n';
1035 if (mustProvide("subtilde"))
1036 macros << subtilde_def << '\n';
1038 if (mustProvide("dacute"))
1039 macros << dacute_def << '\n';
1041 if (mustProvide("tipasymb"))
1042 macros << tipasymb_def << '\n';
1044 if (mustProvide("dgrave"))
1045 macros << dgrave_def << '\n';
1047 if (mustProvide("rcap"))
1048 macros << rcap_def << '\n';
1050 if (mustProvide("ogonek"))
1051 macros << ogonek_def << '\n';
1054 if (mustProvide("quotesinglbase"))
1055 macros << quotesinglbase_def << '\n';
1056 if (mustProvide("quotedblbase"))
1057 macros << quotedblbase_def << '\n';
1058 if (mustProvide("guilsinglleft"))
1059 macros << guilsinglleft_def << '\n';
1060 if (mustProvide("guilsinglright"))
1061 macros << guilsinglright_def << '\n';
1062 if (mustProvide("guillemotleft"))
1063 macros << guillemotleft_def << '\n';
1064 if (mustProvide("guillemotright"))
1065 macros << guillemotright_def << '\n';
1068 if (mustProvide("binom") && !isRequired("amsmath"))
1069 macros << binom_def << '\n';
1070 if (mustProvide("mathcircumflex"))
1071 macros << mathcircumflex_def << '\n';
1074 if (mustProvide("ParagraphLeftIndent"))
1075 macros << paragraphleftindent_def;
1076 if (mustProvide("NeedLyXFootnoteCode"))
1077 macros << floatingfootnote_def;
1079 // some problems with tex->html converters
1080 if (mustProvide("NeedTabularnewline"))
1081 macros << tabularnewline_def;
1083 // greyed-out environment (note inset)
1084 // the color is specified in the routine
1085 // getColorOptions() to avoid LaTeX-package clashes
1086 if (mustProvide("lyxgreyedout"))
1087 macros << lyxgreyedout_def;
1089 if (mustProvide("lyxdot"))
1090 macros << lyxdot_def << '\n';
1093 getFloatDefinitions(macros);
1095 if (mustProvide("refstyle"))
1096 macros << lyxref_def << '\n';
1099 if (mustProvide("ct-dvipost"))
1100 macros << changetracking_dvipost_def;
1102 if (mustProvide("ct-xcolor-ulem")) {
1103 streamsize const prec = macros.precision(2);
1105 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1106 macros << "\\providecolor{lyxadded}{rgb}{"
1107 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1109 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1110 macros << "\\providecolor{lyxdeleted}{rgb}{"
1111 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1113 macros.precision(prec);
1115 if (isRequired("hyperref"))
1116 macros << changetracking_xcolor_ulem_hyperref_def;
1118 macros << changetracking_xcolor_ulem_def;
1121 if (mustProvide("ct-none"))
1122 macros << changetracking_none_def;
1124 if (mustProvide("rtloutputdblcol"))
1125 macros << rtloutputdblcol_def;
1127 return macros.str();
1131 string const LaTeXFeatures::getBabelPresettings() const
1135 LanguageList::const_iterator it = UsedLanguages_.begin();
1136 LanguageList::const_iterator end = UsedLanguages_.end();
1137 for (; it != end; ++it)
1138 if (!(*it)->babel_presettings().empty())
1139 tmp << (*it)->babel_presettings() << '\n';
1140 if (!params_.language->babel_presettings().empty())
1141 tmp << params_.language->babel_presettings() << '\n';
1143 if (!contains(tmp.str(), '@'))
1146 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1150 string const LaTeXFeatures::getBabelPostsettings() const
1154 LanguageList::const_iterator it = UsedLanguages_.begin();
1155 LanguageList::const_iterator end = UsedLanguages_.end();
1156 for (; it != end; ++it)
1157 if (!(*it)->babel_postsettings().empty())
1158 tmp << (*it)->babel_postsettings() << '\n';
1159 if (!params_.language->babel_postsettings().empty())
1160 tmp << params_.language->babel_postsettings() << '\n';
1162 if (!contains(tmp.str(), '@'))
1165 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1169 bool LaTeXFeatures::needBabelLangOptions() const
1171 if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1174 LanguageList::const_iterator it = UsedLanguages_.begin();
1175 LanguageList::const_iterator end = UsedLanguages_.end();
1176 for (; it != end; ++it)
1177 if ((*it)->asBabelOptions())
1184 string const LaTeXFeatures::loadAMSPackages() const
1187 if (mustProvide("amsthm"))
1188 tmp << "\\usepackage{amsthm}\n";
1190 if (mustProvide("amsmath")
1191 && params_.use_package("amsmath") != BufferParams::package_off) {
1192 tmp << "\\usepackage{amsmath}\n";
1194 // amsbsy and amstext are already provided by amsmath
1195 if (mustProvide("amsbsy"))
1196 tmp << "\\usepackage{amsbsy}\n";
1197 if (mustProvide("amstext"))
1198 tmp << "\\usepackage{amstext}\n";
1201 if (mustProvide("amssymb")
1202 && params_.use_package("amssymb") != BufferParams::package_off)
1203 tmp << "\\usepackage{amssymb}\n";
1209 docstring const LaTeXFeatures::getTClassPreamble() const
1211 // the text class specific preamble
1212 DocumentClass const & tclass = params_.documentClass();
1213 odocstringstream tcpreamble;
1215 tcpreamble << tclass.preamble();
1217 list<docstring>::const_iterator cit = usedLayouts_.begin();
1218 list<docstring>::const_iterator end = usedLayouts_.end();
1219 for (; cit != end; ++cit)
1220 tcpreamble << tclass[*cit].preamble();
1222 cit = usedInsetLayouts_.begin();
1223 end = usedInsetLayouts_.end();
1224 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1225 for (; cit != end; ++cit) {
1226 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1227 if (it == ils.end())
1229 tcpreamble << it->second.preamble();
1232 return tcpreamble.str();
1236 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1238 DocumentClass const & tclass = params_.documentClass();
1239 odocstringstream tcpreamble;
1241 tcpreamble << tclass.htmlpreamble();
1243 list<docstring>::const_iterator cit = usedLayouts_.begin();
1244 list<docstring>::const_iterator end = usedLayouts_.end();
1245 for (; cit != end; ++cit)
1246 tcpreamble << tclass[*cit].htmlpreamble();
1248 cit = usedInsetLayouts_.begin();
1249 end = usedInsetLayouts_.end();
1250 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1251 for (; cit != end; ++cit) {
1252 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1253 if (it == ils.end())
1255 tcpreamble << it->second.htmlpreamble();
1258 return tcpreamble.str();
1262 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1264 DocumentClass const & tclass = params_.documentClass();
1265 odocstringstream tcpreamble;
1267 tcpreamble << tclass.htmlstyles();
1269 list<docstring>::const_iterator cit = usedLayouts_.begin();
1270 list<docstring>::const_iterator end = usedLayouts_.end();
1271 for (; cit != end; ++cit)
1272 tcpreamble << tclass[*cit].htmlstyle();
1274 cit = usedInsetLayouts_.begin();
1275 end = usedInsetLayouts_.end();
1276 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1277 for (; cit != end; ++cit) {
1278 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1279 if (it == ils.end())
1281 tcpreamble << it->second.htmlstyle();
1284 return tcpreamble.str();
1290 docstring const getFloatI18nPreamble(docstring const & type,
1291 docstring const & name, Language const * lang,
1292 Encoding const & enc, bool const polyglossia)
1294 // Check whether name can be encoded in the buffer encoding
1295 bool encodable = true;
1296 for (size_t i = 0; i < name.size(); ++i) {
1297 if (!enc.encodable(name[i])) {
1303 docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1304 : from_ascii(lang->babel());
1305 docstring const langenc = from_ascii(lang->encoding()->iconvName());
1306 docstring const texenc = from_ascii(lang->encoding()->latexName());
1307 docstring const bufenc = from_ascii(enc.iconvName());
1308 docstring const s1 = docstring(1, 0xF0000);
1309 docstring const s2 = docstring(1, 0xF0001);
1310 docstring const translated = encodable ? name
1311 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1312 + s1 + langenc + s2 + name + s1 + bufenc + s2;
1314 odocstringstream os;
1315 os << "\\addto\\captions" << language
1316 << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1321 docstring const i18npreamble(docstring const & templ, Language const * lang,
1322 Encoding const & enc, bool const polyglossia)
1327 string preamble = polyglossia ?
1328 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
1329 subst(to_utf8(templ), "$$lang", lang->babel());
1331 string const langenc = lang->encoding()->iconvName();
1332 string const texenc = lang->encoding()->latexName();
1333 string const bufenc = enc.iconvName();
1334 // First and second character of plane 15 (Private Use Area)
1335 string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
1336 string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
1338 // lyx::regex is not unicode-safe.
1339 // Should use QRegExp or (boost::u32regex, but that requires ICU)
1340 static regex const reg("_\\(([^\\)]+)\\)");
1342 while (regex_search(preamble, sub, reg)) {
1343 string const key = sub.str(1);
1344 docstring const name = lang->translateLayout(key);
1345 // Check whether name can be encoded in the buffer encoding
1346 bool encodable = true;
1347 for (size_t i = 0; i < name.size(); ++i) {
1348 if (!enc.encodable(name[i])) {
1353 string const translated = encodable ? to_utf8(name)
1354 : "\\inputencoding{" + texenc + "}"
1355 + s1 + langenc + s2 + to_utf8(name)
1357 preamble = subst(preamble, sub.str(), translated);
1359 return from_utf8(preamble);
1365 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const
1367 DocumentClass const & tclass = params_.documentClass();
1368 // collect preamble snippets in a set to prevent multiple identical
1369 // commands (would happen if e.g. both theorem and theorem* are used)
1370 set<docstring> snippets;
1371 typedef LanguageList::const_iterator lang_it;
1372 lang_it const lbeg = UsedLanguages_.begin();
1373 lang_it const lend = UsedLanguages_.end();
1374 list<docstring>::const_iterator cit = usedLayouts_.begin();
1375 list<docstring>::const_iterator end = usedLayouts_.end();
1376 for (; cit != end; ++cit) {
1377 // language dependent commands (once per document)
1378 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
1379 buffer().language(),
1380 buffer().params().encoding(),
1382 // commands for language changing (for multilanguage documents)
1383 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1384 snippets.insert(i18npreamble(
1385 tclass[*cit].babelpreamble(),
1386 buffer().language(),
1387 buffer().params().encoding(),
1389 for (lang_it lit = lbeg; lit != lend; ++lit)
1390 snippets.insert(i18npreamble(
1391 tclass[*cit].babelpreamble(),
1393 buffer().params().encoding(),
1397 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1398 FloatList const & floats = params_.documentClass().floats();
1399 UsedFloats::const_iterator fit = usedFloats_.begin();
1400 UsedFloats::const_iterator fend = usedFloats_.end();
1401 for (; fit != fend; ++fit) {
1402 Floating const & fl = floats.getType(fit->first);
1403 // we assume builtin floats are translated
1404 if (fl.isPredefined())
1406 docstring const type = from_ascii(fl.floattype());
1407 docstring const flname = from_utf8(fl.name());
1408 docstring name = buffer().language()->translateLayout(fl.name());
1409 // only request translation if we have a real translation
1410 // (that differs from the source)
1412 snippets.insert(getFloatI18nPreamble(
1413 type, name, buffer().language(),
1414 buffer().params().encoding(),
1416 for (lang_it lit = lbeg; lit != lend; ++lit) {
1417 string const code = (*lit)->code();
1418 name = (*lit)->translateLayout(fl.name());
1419 // we assume we have a suitable translation if
1420 // either the language is English (we need to
1421 // translate into English if English is a secondary
1422 // language) or if translateIfPossible returns
1423 // something different to the English source.
1424 bool const have_translation =
1425 (flname != name || contains(code, "en"));
1426 if (have_translation)
1427 snippets.insert(getFloatI18nPreamble(
1429 buffer().params().encoding(),
1435 cit = usedInsetLayouts_.begin();
1436 end = usedInsetLayouts_.end();
1437 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1438 for (; cit != end; ++cit) {
1439 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1440 if (it == ils.end())
1442 // language dependent commands (once per document)
1443 snippets.insert(i18npreamble(it->second.langpreamble(),
1444 buffer().language(),
1445 buffer().params().encoding(),
1447 // commands for language changing (for multilanguage documents)
1448 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1449 snippets.insert(i18npreamble(
1450 it->second.babelpreamble(),
1451 buffer().language(),
1452 buffer().params().encoding(),
1454 for (lang_it lit = lbeg; lit != lend; ++lit)
1455 snippets.insert(i18npreamble(
1456 it->second.babelpreamble(),
1458 buffer().params().encoding(),
1463 odocstringstream tcpreamble;
1464 set<docstring>::const_iterator const send = snippets.end();
1465 set<docstring>::const_iterator it = snippets.begin();
1466 for (; it != send; ++it)
1468 return tcpreamble.str();
1472 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1474 // Definition of entities used in the document that are LyX related.
1475 odocstringstream entities;
1477 if (mustProvide("lyxarrow")) {
1478 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
1481 return entities.str();
1485 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1487 odocstringstream sgmlpreamble;
1489 docstring const basename(from_utf8(onlyPath(fname)));
1491 FileMap::const_iterator end = IncludedFiles_.end();
1492 for (FileMap::const_iterator fi = IncludedFiles_.begin();
1495 sgmlpreamble << "\n<!ENTITY " << fi->first
1496 << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1497 << makeRelPath(from_utf8(fi->second), basename) << "\">";
1499 return sgmlpreamble.str();
1503 void LaTeXFeatures::showStruct() const
1505 lyxerr << "LyX needs the following commands when LaTeXing:"
1506 << "\n***** Packages:" << getPackages()
1507 << "\n***** Macros:" << to_utf8(getMacros())
1508 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1509 << "\n***** done." << endl;
1513 Buffer const & LaTeXFeatures::buffer() const
1519 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1525 BufferParams const & LaTeXFeatures::bufferParams() const
1531 void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
1533 FloatList const & floats = params_.documentClass().floats();
1535 // Here we will output the code to create the needed float styles.
1536 // We will try to do this as minimal as possible.
1537 // \floatstyle{ruled}
1538 // \newfloat{algorithm}{htbp}{loa}
1539 // \providecommand{\algorithmname}{Algorithm}
1540 // \floatname{algorithm}{\protect\algorithmname}
1541 UsedFloats::const_iterator cit = usedFloats_.begin();
1542 UsedFloats::const_iterator end = usedFloats_.end();
1543 for (; cit != end; ++cit) {
1544 Floating const & fl = floats.getType(cit->first);
1546 // For builtin floats we do nothing.
1547 if (fl.isPredefined())
1550 // We have to special case "table" and "figure"
1551 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1552 // Output code to modify "table" or "figure"
1553 // but only if builtin == false
1554 // and that have to be true at this point in the
1556 docstring const type = from_ascii(fl.floattype());
1557 docstring const placement = from_ascii(fl.placement());
1558 docstring const style = from_ascii(fl.style());
1559 if (!style.empty()) {
1560 os << "\\floatstyle{" << style << "}\n"
1561 << "\\restylefloat{" << type << "}\n";
1563 if (!placement.empty()) {
1564 os << "\\floatplacement{" << type << "}{"
1565 << placement << "}\n";
1568 // The other non builtin floats.
1570 docstring const type = from_ascii(fl.floattype());
1571 docstring const placement = from_ascii(fl.placement());
1572 docstring const ext = from_ascii(fl.ext());
1573 docstring const within = from_ascii(fl.within());
1574 docstring const style = from_ascii(fl.style());
1575 docstring const name =
1576 buffer().language()->translateLayout(fl.name());
1577 os << "\\floatstyle{" << style << "}\n"
1578 << "\\newfloat{" << type << "}{" << placement
1579 << "}{" << ext << '}';
1580 if (!within.empty())
1581 os << '[' << within << ']';
1583 << "\\providecommand{\\" << type << "name}{"
1585 << "\\floatname{" << type << "}{\\protect\\"
1586 << type << "name}\n";
1588 // What missing here is to code to minimalize the code
1589 // output so that the same floatstyle will not be
1590 // used several times, when the same style is still in
1594 os << "\n\\newsubfloat{" << from_ascii(fl.floattype()) << "}\n";
1599 void LaTeXFeatures::resolveAlternatives()
1601 for (Features::iterator it = features_.begin(); it != features_.end();) {
1602 if (contains(*it, '|')) {
1603 vector<string> const alternatives = getVectorFromString(*it, "|");
1604 vector<string>::const_iterator const end = alternatives.end();
1605 vector<string>::const_iterator ita = alternatives.begin();
1606 for (; ita != end; ++ita) {
1607 if (isRequired(*ita))
1611 require(alternatives.front());
1612 features_.erase(it);
1613 it = features_.begin();