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 "\\newcommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
188 "\\newcommand{\\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 "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}{}#3}}\n"
194 "\\newcommand{\\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 "\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}{}}{}#3}}\n"
199 "\\newcommand{\\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 bool const ot1 = (params_.font_encoding() == "default"
478 || params_.font_encoding() == "OT1");
479 bool const complete = (params_.fonts_sans == "default")
480 && (params_.fonts_typewriter == "default");
481 bool const nomath = (params_.fonts_math == "default");
482 return params_.documentClass().provides(name)
483 || theLaTeXFonts().getLaTeXFont(
484 from_ascii(params_.fonts_roman)).provides(name, ot1,
487 || theLaTeXFonts().getLaTeXFont(
488 from_ascii(params_.fonts_sans)).provides(name, ot1,
491 || theLaTeXFonts().getLaTeXFont(
492 from_ascii(params_.fonts_typewriter)).provides(name, ot1,
495 || theLaTeXFonts().getLaTeXFont(
496 from_ascii(params_.fonts_math)).provides(name, ot1,
501 bool LaTeXFeatures::mustProvide(string const & name) const
503 return isRequired(name) && !isProvided(name);
507 bool LaTeXFeatures::isAvailable(string const & name)
509 string::size_type const i = name.find("->");
510 if (i != string::npos) {
511 string const from = name.substr(0,i);
512 string const to = name.substr(i+2);
513 //LYXERR0("from=[" << from << "] to=[" << to << "]");
514 return theConverters().isReachable(from, to);
516 return LaTeXPackages::isAvailable(name);
520 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
522 SnippetList::const_iterator begin = preamble_snippets_.begin();
523 SnippetList::const_iterator end = preamble_snippets_.end();
524 if (find(begin, end, preamble) == end)
525 preamble_snippets_.push_back(preamble);
529 void LaTeXFeatures::addCSSSnippet(std::string const & snippet)
531 SnippetList::const_iterator begin = css_snippets_.begin();
532 SnippetList::const_iterator end = css_snippets_.end();
533 if (find(begin, end, snippet) == end)
534 css_snippets_.push_back(snippet);
538 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
540 if (!usedFloats_[name])
541 usedFloats_[name] = subfloat;
544 // We only need float.sty if we use non builtin floats, or if we
545 // use the "H" modifier. This includes modified table and
546 // figure floats. (Lgb)
547 Floating const & fl = params_.documentClass().floats().getType(name);
548 if (!fl.floattype().empty() && fl.usesFloatPkg()) {
554 void LaTeXFeatures::useLanguage(Language const * lang)
556 if (!lang->babel().empty() || !lang->polyglossia().empty())
557 UsedLanguages_.insert(lang);
558 if (!lang->requires().empty())
559 require(lang->requires());
560 // CJK languages do not have a babel name.
561 // They use the CJK package
562 if (lang->encoding()->package() == Encoding::CJK)
564 // japanese package is special
565 if (lang->encoding()->package() == Encoding::japanese)
570 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
572 IncludedFiles_[key] = name;
576 bool LaTeXFeatures::hasLanguages() const
578 return !UsedLanguages_.empty();
582 bool LaTeXFeatures::hasOnlyPolyglossiaLanguages() const
584 LanguageList::const_iterator const begin = UsedLanguages_.begin();
585 for (LanguageList::const_iterator cit = begin;
586 cit != UsedLanguages_.end();
588 if ((*cit)->polyglossia().empty())
595 bool LaTeXFeatures::hasPolyglossiaExclusiveLanguages() const
597 LanguageList::const_iterator const begin = UsedLanguages_.begin();
598 for (LanguageList::const_iterator cit = begin;
599 cit != UsedLanguages_.end();
601 if ((*cit)->babel().empty() && !(*cit)->polyglossia().empty() && (*cit)->requires().empty())
608 string LaTeXFeatures::getBabelLanguages() const
610 ostringstream languages;
613 LanguageList::const_iterator const begin = UsedLanguages_.begin();
614 for (LanguageList::const_iterator cit = begin;
615 cit != UsedLanguages_.end();
617 if ((*cit)->babel().empty())
623 languages << (*cit)->babel();
625 return languages.str();
629 std::map<std::string, std::string> LaTeXFeatures::getPolyglossiaLanguages() const
631 std::map<std::string, std::string> languages;
633 LanguageList::const_iterator const begin = UsedLanguages_.begin();
634 for (LanguageList::const_iterator cit = begin;
635 cit != UsedLanguages_.end();
637 languages[(*cit)->polyglossia()] = (*cit)->polyglossiaOpts();
643 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
645 // This does only find encodings of languages supported by babel, but
646 // that does not matter since we don't have a language with an
647 // encoding supported by inputenc but without babel support.
648 set<string> encodings;
649 LanguageList::const_iterator it = UsedLanguages_.begin();
650 LanguageList::const_iterator end = UsedLanguages_.end();
651 for (; it != end; ++it)
652 if ((*it)->encoding()->latexName() != doc_encoding &&
653 ((*it)->encoding()->package() == Encoding::inputenc
654 || (*it)->encoding()->package() == Encoding::japanese))
655 encodings.insert((*it)->encoding()->latexName());
661 char const * simplefeatures[] = {
662 // note that the package order here will be the same in the LaTeX-output
669 // subfig is handled in BufferParams.cpp
673 /*For a successful cooperation of the `wrapfig' package with the
674 `float' package you should load the `wrapfig' package *after*
675 the `float' package. See the caption package documentation
710 // listings is handled in BufferParams.cpp
719 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
724 string const LaTeXFeatures::getColorOptions() const
726 ostringstream colors;
728 // Handling the color packages separately is needed to be able to load them
729 // before babel when hyperref is loaded with the colorlinks option
730 // for more info see Bufferparams.cpp
733 if (mustProvide("color") || mustProvide("xcolor")) {
734 string const package =
735 (mustProvide("xcolor") ? "xcolor" : "color");
736 if (params_.graphics_driver == "default"
737 || params_.graphics_driver == "none")
738 colors << "\\usepackage{" << package << "}\n";
740 colors << "\\usepackage["
741 << params_.graphics_driver
742 << "]{" << package << "}\n";
745 // pdfcolmk must be loaded after color
746 if (mustProvide("pdfcolmk"))
747 colors << "\\usepackage{pdfcolmk}\n";
749 // the following 3 color commands must be set after color
750 // is loaded and before pdfpages, therefore add the command
751 // here define the set color
752 if (mustProvide("pagecolor")) {
753 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
754 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
755 // set the page color
756 colors << "\\pagecolor{page_backgroundcolor}\n";
759 if (mustProvide("fontcolor")) {
760 colors << "\\definecolor{document_fontcolor}{rgb}{";
761 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
763 colors << "\\color{document_fontcolor}\n";
766 if (mustProvide("lyxgreyedout")) {
767 colors << "\\definecolor{note_fontcolor}{rgb}{";
768 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
769 // the color will be set together with the definition of
770 // the lyxgreyedout environment (see lyxgreyedout_def)
773 // color for shaded boxes
774 if (isRequired("framed") && mustProvide("color")) {
775 colors << "\\definecolor{shadecolor}{rgb}{";
776 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
777 // this color is automatically used by the LaTeX-package "framed"
784 string const LaTeXFeatures::getPackages() const
786 ostringstream packages;
788 // FIXME: currently, we can only load packages and macros known
790 // However, with the Require tag of layouts/custom insets,
791 // also unknown packages can be requested. They are silently
792 // swallowed now. We should change this eventually.
795 // These are all the 'simple' includes. i.e
796 // packages which we just \usepackage{package}
798 for (int i = 0; i < nb_simplefeatures; ++i) {
799 if (mustProvide(simplefeatures[i]))
800 packages << "\\usepackage{"
801 << simplefeatures[i] << "}\n";
805 // The rest of these packages are somewhat more complicated
809 // if fontspec is used, AMS packages have to be loaded before
810 // fontspec (in BufferParams)
811 string const amsPackages = loadAMSPackages();
812 if (!params_.useNonTeXFonts && !amsPackages.empty())
813 packages << amsPackages;
815 // fixltx2e must be loaded after amsthm, since amsthm produces an error with
816 // the redefined \[ command (bug 7233). Load it as early as possible, since
817 // other packages might profit from it.
818 if (mustProvide("fixltx2e"))
819 packages << "\\usepackage{fixltx2e}\n";
821 // wasysym is a simple feature, but it must be after amsmath if both
823 // wasysym redefines some integrals (e.g. iint) from amsmath. That
824 // leads to inconsistent integrals. We only load this package if
825 // the document does not contain integrals (then isRequired("esint")
826 // is false) or if esint is used, since esint redefines all relevant
827 // integral symbols from wasysym and amsmath.
828 // See http://www.lyx.org/trac/ticket/1942
829 if (mustProvide("wasysym") &&
830 params_.use_package("wasysym") != BufferParams::package_off &&
831 (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
832 packages << "\\usepackage{wasysym}\n";
834 // accents must be loaded after amsmath
835 if (mustProvide("accents") &&
836 params_.use_package("accents") != BufferParams::package_off)
837 packages << "\\usepackage{accents}\n";
839 // mathdots must be loaded after amsmath
840 if (mustProvide("mathdots") &&
841 params_.use_package("mathdots") != BufferParams::package_off)
842 packages << "\\usepackage{mathdots}\n";
844 // yhmath must be loaded after amsmath
845 if (mustProvide("yhmath") &&
846 params_.use_package("yhmath") != BufferParams::package_off)
847 packages << "\\usepackage{yhmath}\n";
849 if (mustProvide("undertilde") &&
850 params_.use_package("undertilde") != BufferParams::package_off)
851 packages << "\\usepackage{undertilde}\n";
853 // [x]color and pdfcolmk are handled in getColorOptions() above
856 if (isRequired("makeidx") || isRequired("splitidx")) {
857 if (!isProvided("makeidx") && !isRequired("splitidx"))
858 packages << "\\usepackage{makeidx}\n";
859 if (mustProvide("splitidx"))
860 packages << "\\usepackage{splitidx}\n";
861 packages << "\\makeindex\n";
865 if (mustProvide("graphicx") && params_.graphics_driver != "none") {
866 if (params_.graphics_driver == "default")
867 packages << "\\usepackage{graphicx}\n";
869 packages << "\\usepackage["
870 << params_.graphics_driver
874 // lyxskak.sty --- newer chess support based on skak.sty
875 if (mustProvide("chess"))
876 packages << "\\usepackage[ps,mover]{lyxskak}\n";
879 if (mustProvide("setspace") && !isProvided("SetSpace"))
880 packages << "\\usepackage{setspace}\n";
882 // esint must be after amsmath and wasysym, since it will redeclare
883 // inconsistent integral symbols
884 if (mustProvide("esint") &&
885 params_.use_package("esint") != BufferParams::package_off)
886 packages << "\\usepackage{esint}\n";
889 // Some classes load natbib themselves, but still allow (or even require)
890 // plain numeric citations (ReVTeX is such a case, see bug 5182).
891 // This special case is indicated by the "natbib-internal" key.
892 if (mustProvide("natbib") && !isProvided("natbib-internal")) {
893 packages << "\\usepackage[";
894 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
895 packages << "numbers";
897 packages << "authoryear";
898 packages << "]{natbib}\n";
901 // jurabib -- we need version 0.6 at least.
902 if (mustProvide("jurabib"))
903 packages << "\\usepackage{jurabib}[2004/01/25]\n";
905 // xargs -- we need version 1.09 at least
906 if (mustProvide("xargs"))
907 packages << "\\usepackage{xargs}[2008/03/08]\n";
909 if (mustProvide("xy"))
910 packages << "\\usepackage[all]{xy}\n";
912 if (mustProvide("feyn"))
913 packages << "\\usepackage{feyn}\n"; //Diagram
915 if (mustProvide("ulem"))
916 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
917 "\\usepackage{ulem}\n";
919 if (mustProvide("mhchem") &&
920 params_.use_package("mhchem") != BufferParams::package_off)
921 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
922 "\\usepackage{mhchem}\n";
924 if (mustProvide("nomencl")) {
925 // Make it work with the new and old version of the package,
926 // but don't use the compatibility option since it is
927 // incompatible to other packages.
928 packages << "\\usepackage{nomencl}\n"
929 "% the following is useful when we have the old nomencl.sty package\n"
930 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
931 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
932 "\\makenomenclature\n";
935 // fixltx2e provides subscript
936 if (mustProvide("subscript") && !isRequired("fixltx2e"))
937 packages << "\\usepackage{subscript}\n";
939 return packages.str();
943 string LaTeXFeatures::getPreambleSnippets() const
946 SnippetList::const_iterator pit = preamble_snippets_.begin();
947 SnippetList::const_iterator pend = preamble_snippets_.end();
948 for (; pit != pend; ++pit)
949 snip << *pit << '\n';
954 std::string LaTeXFeatures::getCSSSnippets() const
957 SnippetList::const_iterator pit = css_snippets_.begin();
958 SnippetList::const_iterator pend = css_snippets_.end();
959 for (; pit != pend; ++pit)
960 snip << *pit << '\n';
965 docstring const LaTeXFeatures::getMacros() const
967 odocstringstream macros;
969 if (!preamble_snippets_.empty()) {
971 macros << from_utf8(getPreambleSnippets());
974 if (mustProvide("papersize")) {
975 if (runparams_.flavor == OutputParams::LATEX)
976 macros << papersizedvi_def << '\n';
978 macros << papersizepdf_def << '\n';
981 if (mustProvide("LyX")) {
982 if (isRequired("hyperref"))
983 macros << lyx_hyperref_def << '\n';
985 macros << lyx_def << '\n';
988 if (mustProvide("noun"))
989 macros << noun_def << '\n';
991 if (mustProvide("lyxarrow"))
992 macros << lyxarrow_def << '\n';
994 if (!usePolyglossia() && mustProvide("textgreek")) {
995 // Avoid a LaTeX error if times fonts are used and the grtimes
996 // package is installed but actual fonts are not (bug 6469).
997 if (params_.fonts_roman == "times")
998 macros << subst(textgreek_def,
999 from_ascii("\\greektext #1"),
1000 from_ascii("%\n \\IfFileExists"
1001 "{grtm10.tfm}{}{\\fontfamily"
1002 "{cmr}}\\greektext #1"))
1005 macros << textgreek_def << '\n';
1008 if (!usePolyglossia() && mustProvide("textcyr"))
1009 macros << textcyr_def << '\n';
1011 if (mustProvide("lyxmathsym"))
1012 macros << lyxmathsym_def << '\n';
1014 if (mustProvide("cedilla"))
1015 macros << cedilla_def << '\n';
1017 if (mustProvide("subring"))
1018 macros << subring_def << '\n';
1020 if (mustProvide("subdot"))
1021 macros << subdot_def << '\n';
1023 if (mustProvide("subhat"))
1024 macros << subhat_def << '\n';
1026 if (mustProvide("subtilde"))
1027 macros << subtilde_def << '\n';
1029 if (mustProvide("dacute"))
1030 macros << dacute_def << '\n';
1032 if (mustProvide("tipasymb"))
1033 macros << tipasymb_def << '\n';
1035 if (mustProvide("dgrave"))
1036 macros << dgrave_def << '\n';
1038 if (mustProvide("rcap"))
1039 macros << rcap_def << '\n';
1041 if (mustProvide("ogonek"))
1042 macros << ogonek_def << '\n';
1045 if (mustProvide("quotesinglbase"))
1046 macros << quotesinglbase_def << '\n';
1047 if (mustProvide("quotedblbase"))
1048 macros << quotedblbase_def << '\n';
1049 if (mustProvide("guilsinglleft"))
1050 macros << guilsinglleft_def << '\n';
1051 if (mustProvide("guilsinglright"))
1052 macros << guilsinglright_def << '\n';
1053 if (mustProvide("guillemotleft"))
1054 macros << guillemotleft_def << '\n';
1055 if (mustProvide("guillemotright"))
1056 macros << guillemotright_def << '\n';
1059 if (mustProvide("binom") && !isRequired("amsmath"))
1060 macros << binom_def << '\n';
1061 if (mustProvide("mathcircumflex"))
1062 macros << mathcircumflex_def << '\n';
1065 if (mustProvide("ParagraphLeftIndent"))
1066 macros << paragraphleftindent_def;
1067 if (mustProvide("NeedLyXFootnoteCode"))
1068 macros << floatingfootnote_def;
1070 // some problems with tex->html converters
1071 if (mustProvide("NeedTabularnewline"))
1072 macros << tabularnewline_def;
1074 // greyed-out environment (note inset)
1075 // the color is specified in the routine
1076 // getColorOptions() to avoid LaTeX-package clashes
1077 if (mustProvide("lyxgreyedout"))
1078 macros << lyxgreyedout_def;
1080 if (mustProvide("lyxdot"))
1081 macros << lyxdot_def << '\n';
1084 getFloatDefinitions(macros);
1086 if (mustProvide("refstyle"))
1087 macros << lyxref_def << '\n';
1090 if (mustProvide("ct-dvipost"))
1091 macros << changetracking_dvipost_def;
1093 if (mustProvide("ct-xcolor-ulem")) {
1094 streamsize const prec = macros.precision(2);
1096 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1097 macros << "\\providecolor{lyxadded}{rgb}{"
1098 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1100 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1101 macros << "\\providecolor{lyxdeleted}{rgb}{"
1102 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1104 macros.precision(prec);
1106 if (isRequired("hyperref"))
1107 macros << changetracking_xcolor_ulem_hyperref_def;
1109 macros << changetracking_xcolor_ulem_def;
1112 if (mustProvide("ct-none"))
1113 macros << changetracking_none_def;
1115 if (mustProvide("rtloutputdblcol"))
1116 macros << rtloutputdblcol_def;
1118 return macros.str();
1122 string const LaTeXFeatures::getBabelPresettings() const
1126 LanguageList::const_iterator it = UsedLanguages_.begin();
1127 LanguageList::const_iterator end = UsedLanguages_.end();
1128 for (; it != end; ++it)
1129 if (!(*it)->babel_presettings().empty())
1130 tmp << (*it)->babel_presettings() << '\n';
1131 if (!params_.language->babel_presettings().empty())
1132 tmp << params_.language->babel_presettings() << '\n';
1134 if (!contains(tmp.str(), '@'))
1137 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1141 string const LaTeXFeatures::getBabelPostsettings() const
1145 LanguageList::const_iterator it = UsedLanguages_.begin();
1146 LanguageList::const_iterator end = UsedLanguages_.end();
1147 for (; it != end; ++it)
1148 if (!(*it)->babel_postsettings().empty())
1149 tmp << (*it)->babel_postsettings() << '\n';
1150 if (!params_.language->babel_postsettings().empty())
1151 tmp << params_.language->babel_postsettings() << '\n';
1153 if (!contains(tmp.str(), '@'))
1156 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1160 bool LaTeXFeatures::needBabelLangOptions() const
1162 if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1165 LanguageList::const_iterator it = UsedLanguages_.begin();
1166 LanguageList::const_iterator end = UsedLanguages_.end();
1167 for (; it != end; ++it)
1168 if ((*it)->asBabelOptions())
1175 string const LaTeXFeatures::loadAMSPackages() const
1178 if (mustProvide("amsthm"))
1179 tmp << "\\usepackage{amsthm}\n";
1181 if (mustProvide("amsmath")
1182 && params_.use_package("amsmath") != BufferParams::package_off) {
1183 tmp << "\\usepackage{amsmath}\n";
1185 // amsbsy and amstext are already provided by amsmath
1186 if (mustProvide("amsbsy"))
1187 tmp << "\\usepackage{amsbsy}\n";
1188 if (mustProvide("amstext"))
1189 tmp << "\\usepackage{amstext}\n";
1192 if (mustProvide("amssymb")
1193 && params_.use_package("amssymb") != BufferParams::package_off)
1194 tmp << "\\usepackage{amssymb}\n";
1200 docstring const LaTeXFeatures::getTClassPreamble() const
1202 // the text class specific preamble
1203 DocumentClass const & tclass = params_.documentClass();
1204 odocstringstream tcpreamble;
1206 tcpreamble << tclass.preamble();
1208 list<docstring>::const_iterator cit = usedLayouts_.begin();
1209 list<docstring>::const_iterator end = usedLayouts_.end();
1210 for (; cit != end; ++cit)
1211 tcpreamble << tclass[*cit].preamble();
1213 cit = usedInsetLayouts_.begin();
1214 end = usedInsetLayouts_.end();
1215 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1216 for (; cit != end; ++cit) {
1217 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1218 if (it == ils.end())
1220 tcpreamble << it->second.preamble();
1223 return tcpreamble.str();
1227 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1229 DocumentClass const & tclass = params_.documentClass();
1230 odocstringstream tcpreamble;
1232 tcpreamble << tclass.htmlpreamble();
1234 list<docstring>::const_iterator cit = usedLayouts_.begin();
1235 list<docstring>::const_iterator end = usedLayouts_.end();
1236 for (; cit != end; ++cit)
1237 tcpreamble << tclass[*cit].htmlpreamble();
1239 cit = usedInsetLayouts_.begin();
1240 end = usedInsetLayouts_.end();
1241 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1242 for (; cit != end; ++cit) {
1243 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1244 if (it == ils.end())
1246 tcpreamble << it->second.htmlpreamble();
1249 return tcpreamble.str();
1253 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1255 DocumentClass const & tclass = params_.documentClass();
1256 odocstringstream tcpreamble;
1258 tcpreamble << tclass.htmlstyles();
1260 list<docstring>::const_iterator cit = usedLayouts_.begin();
1261 list<docstring>::const_iterator end = usedLayouts_.end();
1262 for (; cit != end; ++cit)
1263 tcpreamble << tclass[*cit].htmlstyle();
1265 cit = usedInsetLayouts_.begin();
1266 end = usedInsetLayouts_.end();
1267 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1268 for (; cit != end; ++cit) {
1269 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1270 if (it == ils.end())
1272 tcpreamble << it->second.htmlstyle();
1275 return tcpreamble.str();
1280 docstring const getFloatI18nPreamble(docstring const & type,
1281 docstring const & name, Language const * lang,
1282 Encoding const & enc, bool const polyglossia)
1284 // Check whether name can be encoded in the buffer encoding
1285 bool encodable = true;
1286 for (size_t i = 0; i < name.size(); ++i) {
1287 if (!enc.encodable(name[i])) {
1293 docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1294 : from_ascii(lang->babel());
1295 docstring const langenc = from_ascii(lang->encoding()->iconvName());
1296 docstring const texenc = from_ascii(lang->encoding()->latexName());
1297 docstring const bufenc = from_ascii(enc.iconvName());
1298 docstring const s1 = docstring(1, 0xF0000);
1299 docstring const s2 = docstring(1, 0xF0001);
1300 docstring const translated = encodable ? name
1301 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1302 + s1 + langenc + s2 + name + s1 + bufenc + s2;
1304 odocstringstream os;
1305 os << "\\addto\\captions" << language
1306 << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1311 docstring const i18npreamble(docstring const & templ, Language const * lang,
1312 Encoding const & enc, bool const polyglossia)
1317 string preamble = polyglossia ?
1318 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
1319 subst(to_utf8(templ), "$$lang", lang->babel());
1321 string const langenc = lang->encoding()->iconvName();
1322 string const texenc = lang->encoding()->latexName();
1323 string const bufenc = enc.iconvName();
1324 // First and second character of plane 15 (Private Use Area)
1325 string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
1326 string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
1328 // lyx::regex is not unicode-safe.
1329 // Should use QRegExp or (boost::u32regex, but that requires ICU)
1330 static regex const reg("_\\(([^\\)]+)\\)");
1332 while (regex_search(preamble, sub, reg)) {
1333 string const key = sub.str(1);
1334 docstring const name = lang->translateLayout(key);
1335 // Check whether name can be encoded in the buffer encoding
1336 bool encodable = true;
1337 for (size_t i = 0; i < name.size(); ++i) {
1338 if (!enc.encodable(name[i])) {
1343 string const translated = encodable ? to_utf8(name)
1344 : "\\inputencoding{" + texenc + "}"
1345 + s1 + langenc + s2 + to_utf8(name)
1347 preamble = subst(preamble, sub.str(), translated);
1349 return from_utf8(preamble);
1355 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const
1357 DocumentClass const & tclass = params_.documentClass();
1358 // collect preamble snippets in a set to prevent multiple identical
1359 // commands (would happen if e.g. both theorem and theorem* are used)
1360 set<docstring> snippets;
1361 typedef LanguageList::const_iterator lang_it;
1362 lang_it const lbeg = UsedLanguages_.begin();
1363 lang_it const lend = UsedLanguages_.end();
1364 list<docstring>::const_iterator cit = usedLayouts_.begin();
1365 list<docstring>::const_iterator end = usedLayouts_.end();
1366 for (; cit != end; ++cit) {
1367 // language dependent commands (once per document)
1368 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
1369 buffer().language(),
1370 buffer().params().encoding(),
1372 // commands for language changing (for multilanguage documents)
1373 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1374 snippets.insert(i18npreamble(
1375 tclass[*cit].babelpreamble(),
1376 buffer().language(),
1377 buffer().params().encoding(),
1379 for (lang_it lit = lbeg; lit != lend; ++lit)
1380 snippets.insert(i18npreamble(
1381 tclass[*cit].babelpreamble(),
1383 buffer().params().encoding(),
1387 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1388 FloatList const & floats = params_.documentClass().floats();
1389 UsedFloats::const_iterator fit = usedFloats_.begin();
1390 UsedFloats::const_iterator fend = usedFloats_.end();
1391 for (; fit != fend; ++fit) {
1392 Floating const & fl = floats.getType(fit->first);
1393 // we assume builtin floats are translated
1394 if (fl.isPredefined())
1396 docstring const type = from_ascii(fl.floattype());
1397 docstring const flname = from_utf8(fl.name());
1398 docstring name = buffer().language()->translateLayout(fl.name());
1399 // only request translation if we have a real translation
1400 // (that differs from the source)
1402 snippets.insert(getFloatI18nPreamble(
1403 type, name, buffer().language(),
1404 buffer().params().encoding(),
1406 for (lang_it lit = lbeg; lit != lend; ++lit) {
1407 string const code = (*lit)->code();
1408 name = (*lit)->translateLayout(fl.name());
1409 // we assume we have a suitable translation if
1410 // either the language is English (we need to
1411 // translate into English if English is a secondary
1412 // language) or if translateIfPossible returns
1413 // something different to the English source.
1414 bool const have_translation =
1415 (flname != name || contains(code, "en"));
1416 if (have_translation)
1417 snippets.insert(getFloatI18nPreamble(
1419 buffer().params().encoding(),
1425 cit = usedInsetLayouts_.begin();
1426 end = usedInsetLayouts_.end();
1427 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1428 for (; cit != end; ++cit) {
1429 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1430 if (it == ils.end())
1432 // language dependent commands (once per document)
1433 snippets.insert(i18npreamble(it->second.langpreamble(),
1434 buffer().language(),
1435 buffer().params().encoding(),
1437 // commands for language changing (for multilanguage documents)
1438 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1439 snippets.insert(i18npreamble(
1440 it->second.babelpreamble(),
1441 buffer().language(),
1442 buffer().params().encoding(),
1444 for (lang_it lit = lbeg; lit != lend; ++lit)
1445 snippets.insert(i18npreamble(
1446 it->second.babelpreamble(),
1448 buffer().params().encoding(),
1453 odocstringstream tcpreamble;
1454 set<docstring>::const_iterator const send = snippets.end();
1455 set<docstring>::const_iterator it = snippets.begin();
1456 for (; it != send; ++it)
1458 return tcpreamble.str();
1462 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1464 // Definition of entities used in the document that are LyX related.
1465 odocstringstream entities;
1467 if (mustProvide("lyxarrow")) {
1468 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
1471 return entities.str();
1475 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1477 odocstringstream sgmlpreamble;
1479 docstring const basename(from_utf8(onlyPath(fname)));
1481 FileMap::const_iterator end = IncludedFiles_.end();
1482 for (FileMap::const_iterator fi = IncludedFiles_.begin();
1485 sgmlpreamble << "\n<!ENTITY " << fi->first
1486 << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1487 << makeRelPath(from_utf8(fi->second), basename) << "\">";
1489 return sgmlpreamble.str();
1493 void LaTeXFeatures::showStruct() const
1495 lyxerr << "LyX needs the following commands when LaTeXing:"
1496 << "\n***** Packages:" << getPackages()
1497 << "\n***** Macros:" << to_utf8(getMacros())
1498 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1499 << "\n***** done." << endl;
1503 Buffer const & LaTeXFeatures::buffer() const
1509 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1515 BufferParams const & LaTeXFeatures::bufferParams() const
1521 void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
1523 FloatList const & floats = params_.documentClass().floats();
1525 // Here we will output the code to create the needed float styles.
1526 // We will try to do this as minimal as possible.
1527 // \floatstyle{ruled}
1528 // \newfloat{algorithm}{htbp}{loa}
1529 // \providecommand{\algorithmname}{Algorithm}
1530 // \floatname{algorithm}{\protect\algorithmname}
1531 UsedFloats::const_iterator cit = usedFloats_.begin();
1532 UsedFloats::const_iterator end = usedFloats_.end();
1533 for (; cit != end; ++cit) {
1534 Floating const & fl = floats.getType(cit->first);
1536 // For builtin floats we do nothing.
1537 if (fl.isPredefined())
1540 // We have to special case "table" and "figure"
1541 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1542 // Output code to modify "table" or "figure"
1543 // but only if builtin == false
1544 // and that have to be true at this point in the
1546 docstring const type = from_ascii(fl.floattype());
1547 docstring const placement = from_ascii(fl.placement());
1548 docstring const style = from_ascii(fl.style());
1549 if (!style.empty()) {
1550 os << "\\floatstyle{" << style << "}\n"
1551 << "\\restylefloat{" << type << "}\n";
1553 if (!placement.empty()) {
1554 os << "\\floatplacement{" << type << "}{"
1555 << placement << "}\n";
1558 // The other non builtin floats.
1560 docstring const type = from_ascii(fl.floattype());
1561 docstring const placement = from_ascii(fl.placement());
1562 docstring const ext = from_ascii(fl.ext());
1563 docstring const within = from_ascii(fl.within());
1564 docstring const style = from_ascii(fl.style());
1565 docstring const name =
1566 buffer().language()->translateLayout(fl.name());
1567 os << "\\floatstyle{" << style << "}\n"
1568 << "\\newfloat{" << type << "}{" << placement
1569 << "}{" << ext << '}';
1570 if (!within.empty())
1571 os << '[' << within << ']';
1573 << "\\providecommand{\\" << type << "name}{"
1575 << "\\floatname{" << type << "}{\\protect\\"
1576 << type << "name}\n";
1578 // What missing here is to code to minimalize the code
1579 // output so that the same floatstyle will not be
1580 // used several times, when the same style is still in
1584 os << "\n\\newsubfloat{" << from_ascii(fl.floattype()) << "}\n";
1589 void LaTeXFeatures::resolveAlternatives()
1591 for (Features::iterator it = features_.begin(); it != features_.end();) {
1592 if (contains(*it, '|')) {
1593 vector<string> const alternatives = getVectorFromString(*it, "|");
1594 vector<string>::const_iterator const end = alternatives.end();
1595 vector<string>::const_iterator ita = alternatives.begin();
1596 for (; ita != end; ++ita) {
1597 if (isRequired(*ita))
1601 require(alternatives.front());
1602 features_.erase(it);
1603 it = features_.begin();