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"
19 #include "BufferParams.h"
24 #include "FloatList.h"
29 #include "support/docstream.h"
30 #include "support/filetools.h"
32 #include "frontends/controllers/frontend_helpers.h"
36 using support::isSGMLFilename;
37 using support::libFileSearch;
38 using support::makeRelPath;
39 using support::onlyPath;
46 using std::ostringstream;
49 /////////////////////////////////////////////////////////////////////
53 /////////////////////////////////////////////////////////////////////
55 //\NeedsTeXFormat{LaTeX2e}
56 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
57 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
59 static string const lyx_def =
60 "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}";
62 static string const lyxline_def =
63 "\\newcommand{\\lyxline}[1][1pt]{%\n"
65 " \\rule[.5ex]{\\linewidth}{#1}\\par}";
67 static string const noun_def = "\\newcommand{\\noun}[1]{\\textsc{#1}}";
69 static string const lyxarrow_def =
70 "\\newcommand{\\lyxarrow}{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}";
72 // for quotes without babel. This does not give perfect results, but
73 // anybody serious about non-english quotes should use babel (JMarc).
75 static string const quotedblbase_def =
76 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
77 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
78 " \\penalty10000\\hskip0em\\relax%\n"
81 static string const quotesinglbase_def =
82 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
83 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
84 " \\penalty10000\\hskip0em\\relax%\n"
87 static string const guillemotleft_def =
88 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
89 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
90 "\\penalty10000\\hskip0pt\\relax%\n"
93 static string const guillemotright_def =
94 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
95 " \\penalty10000\\hskip0pt%\n"
96 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
99 static string const guilsinglleft_def =
100 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
101 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
102 " \\penalty10000\\hskip0pt\\relax%\n"
105 static string const guilsinglright_def =
106 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
107 " \\penalty10000\\hskip0pt%\n"
108 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
111 static string const paragraphleftindent_def =
112 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
114 " \\begin{list}{}{%\n"
115 " \\setlength{\\topsep}{0pt}%\n"
116 " \\addtolength{\\leftmargin}{#1}\n"
117 // ho hum, yet more things commented out with no hint as to why they
118 // weren't just removed
119 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
120 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
121 // "%% \\setlength\\listparindent\\parindent%\n"
122 // "%% \\setlength\\itemindent\\parindent%\n"
123 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
129 static string const floatingfootnote_def =
130 "%% Special footnote code from the package 'stblftnt.sty'\n"
131 "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
132 "\\let\\SF@@footnote\\footnote\n"
133 "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
134 " \\expandafter\\SF@@footnote\n"
136 " \\expandafter\\SF@gobble@opt\n"
139 "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
140 " \\SF@gobble@twobracket\n"
143 "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
144 " \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
145 "\\def\\SF@gobble@twobracket[#1]#2{}\n";
147 static string const boldsymbol_def =
148 "%% Bold symbol macro for standard LaTeX users\n"
149 "\\providecommand{\\boldsymbol}[1]{\\mbox{\\boldmath $#1$}}\n";
151 static string const binom_def =
152 "%% Binom macro for standard LaTeX users\n"
153 "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n";
155 static string const mathcircumflex_def =
156 "%% For printing a cirumflex inside a formula\n"
157 "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n";
159 static string const tabularnewline_def =
160 "%% Because html converters don't know tabularnewline\n"
161 "\\providecommand{\\tabularnewline}{\\\\}\n";
163 static string const lyxgreyedout_def =
164 "%% The greyedout annotation environment\n"
165 "\\newenvironment{lyxgreyedout}{\\textcolor[gray]{0.8}\\bgroup}{\\egroup}\n";
167 // We want to omit the file extension for includegraphics, but this does not
168 // work when the filename contains other dots.
169 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
170 static string const lyxdot_def =
171 "%% A simple dot to overcome graphicx limitations\n"
172 "\\newcommand{\\lyxdot}{.}\n";
176 /////////////////////////////////////////////////////////////////////
180 /////////////////////////////////////////////////////////////////////
182 LaTeXFeatures::PackagesList LaTeXFeatures::packages_;
185 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
186 OutputParams const & r)
187 : buffer_(&b), params_(p), runparams_(r)
191 bool LaTeXFeatures::useBabel() const
193 return lyxrc.language_use_babel ||
194 bufferParams().language->lang() != lyxrc.default_language ||
195 this->hasLanguages();
199 void LaTeXFeatures::require(string const & name)
201 if (isRequired(name))
204 features_.push_back(name);
208 void LaTeXFeatures::getAvailable()
211 support::FileName const real_file = libFileSearch("", "packages.lst");
213 if (real_file.empty())
216 lex.setFile(real_file);
221 // Make sure that we are clean
224 bool finished = false;
226 while (lex.isOK() && !finished) {
228 case Lexer::LEX_FEOF:
232 string const name = lex.getString();
233 PackagesList::const_iterator begin = packages_.begin();
234 PackagesList::const_iterator end = packages_.end();
235 if (find(begin, end, name) == end)
236 packages_.push_back(name);
242 void LaTeXFeatures::useLayout(string const & layoutname)
244 // Some code to avoid loops in dependency definition
245 static int level = 0;
246 const int maxlevel = 30;
247 if (level > maxlevel) {
248 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
249 << "recursion attained by layout "
250 << layoutname << endl;
254 TextClass const & tclass = params_.getTextClass();
255 if (tclass.hasLayout(layoutname)) {
256 // Is this layout already in usedLayouts?
257 list<string>::const_iterator cit = usedLayouts_.begin();
258 list<string>::const_iterator end = usedLayouts_.end();
259 for (; cit != end; ++cit) {
260 if (layoutname == *cit)
264 Layout_ptr const & lyt = tclass[layoutname];
265 if (!lyt->depends_on().empty()) {
267 useLayout(lyt->depends_on());
270 usedLayouts_.push_back(layoutname);
272 lyxerr << "LaTeXFeatures::useLayout: layout `"
273 << layoutname << "' does not exist in this class"
281 bool LaTeXFeatures::isRequired(string const & name) const
283 return find(features_.begin(), features_.end(), name) != features_.end();
287 bool LaTeXFeatures::mustProvide(string const & name) const
289 return isRequired(name) && !params_.getTextClass().provides(name);
293 bool LaTeXFeatures::isAvailable(string const & name)
295 if (packages_.empty())
297 return find(packages_.begin(), packages_.end(), name) != packages_.end();
301 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
303 FeaturesList::const_iterator begin = preamble_snippets_.begin();
304 FeaturesList::const_iterator end = preamble_snippets_.end();
305 if (find(begin, end, preamble) == end)
306 preamble_snippets_.push_back(preamble);
310 void LaTeXFeatures::useFloat(string const & name)
312 usedFloats_.insert(name);
313 // We only need float.sty if we use non builtin floats, or if we
314 // use the "H" modifier. This includes modified table and
315 // figure floats. (Lgb)
316 Floating const & fl = params_.getTextClass().floats().getType(name);
317 if (!fl.type().empty() && !fl.builtin()) {
323 void LaTeXFeatures::useLanguage(Language const * lang)
325 UsedLanguages_.insert(lang);
329 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
331 IncludedFiles_[key] = name;
335 bool LaTeXFeatures::hasLanguages() const
337 return !UsedLanguages_.empty();
341 string LaTeXFeatures::getLanguages() const
343 ostringstream languages;
345 for (LanguageList::const_iterator cit =
346 UsedLanguages_.begin();
347 cit != UsedLanguages_.end();
349 languages << (*cit)->babel() << ',';
350 return languages.str();
354 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
356 set<string> encodings;
357 LanguageList::const_iterator it = UsedLanguages_.begin();
358 LanguageList::const_iterator end = UsedLanguages_.end();
359 for (; it != end; ++it)
360 // thailatex does not use the inputenc package, but sets up
361 // babel directly for tis620-0 encoding, therefore we must
362 // not add tis620-0 to the encoding set.
363 if ((*it)->encoding()->latexName() != doc_encoding &&
364 (*it)->encoding()->name() != "tis620-0")
365 encodings.insert((*it)->encoding()->latexName());
371 char const * simplefeatures[] = {
393 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
398 string const LaTeXFeatures::getPackages() const
400 ostringstream packages;
401 TextClass const & tclass = params_.getTextClass();
404 // These are all the 'simple' includes. i.e
405 // packages which we just \usepackage{package}
407 for (int i = 0; i < nb_simplefeatures; ++i) {
408 if (mustProvide(simplefeatures[i]))
409 packages << "\\usepackage{"
410 << simplefeatures[i] << "}\n";
414 // The rest of these packages are somewhat more complicated
418 if (mustProvide("amsmath")
419 && params_.use_amsmath != BufferParams::package_off) {
420 packages << "\\usepackage{amsmath}\n";
423 // wasysym is a simple feature, but it must be after amsmath if both
425 // wasysym redefines some integrals (e.g. iint) from amsmath. That
426 // leads to inconsistent integrals. We only load this package if
427 // esint is used, since esint redefines all relevant integral
428 // symbols from wasysym and amsmath.
429 // See http://bugzilla.lyx.org/show_bug.cgi?id=1942
430 if (mustProvide("wasysym") && isRequired("esint") &&
431 params_.use_esint != BufferParams::package_off)
432 packages << "\\usepackage{wasysym}\n";
435 if (mustProvide("color")) {
436 if (params_.graphicsDriver == "default")
437 packages << "\\usepackage{color}\n";
439 packages << "\\usepackage["
440 << params_.graphicsDriver
445 if (isRequired("makeidx")) {
446 if (!tclass.provides("makeidx"))
447 packages << "\\usepackage{makeidx}\n";
448 packages << "\\makeindex\n";
452 if (mustProvide("graphicx") && params_.graphicsDriver != "none") {
453 if (params_.graphicsDriver == "default")
454 packages << "\\usepackage{graphicx}\n";
456 packages << "\\usepackage["
457 << params_.graphicsDriver
460 // shadecolor for shaded
461 if (mustProvide("framed")) {
462 RGBColor c = RGBColor(lcolor.getX11Name(Color::shadedbg));
463 packages << "\\definecolor{shadecolor}{rgb}{"
464 << c.r/255 << ',' << c.g/255 << ',' << c.b/255 << "}\n";
467 // lyxskak.sty --- newer chess support based on skak.sty
468 if (mustProvide("chess")) {
469 packages << "\\usepackage[ps,mover]{lyxskak}\n";
473 if ((params_.spacing().getSpace() != Spacing::Single
474 && !params_.spacing().isDefault())
475 || isRequired("setspace")) {
476 packages << "\\usepackage{setspace}\n";
478 switch (params_.spacing().getSpace()) {
479 case Spacing::Default:
480 case Spacing::Single:
481 // we dont use setspace.sty so dont print anything
482 //packages += "\\singlespacing\n";
484 case Spacing::Onehalf:
485 packages << "\\onehalfspacing\n";
487 case Spacing::Double:
488 packages << "\\doublespacing\n";
491 packages << "\\setstretch{"
492 << params_.spacing().getValue() << "}\n";
497 if (mustProvide("amssymb")
498 || params_.use_amsmath == BufferParams::package_on)
499 packages << "\\usepackage{amssymb}\n";
501 // esint must be after amsmath and wasysym, since it will redeclare
502 // inconsistent integral symbols
503 if (mustProvide("esint")
504 && params_.use_esint != BufferParams::package_off)
505 packages << "\\usepackage{esint}\n";
508 if (mustProvide("url"))
509 packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
510 " {\\newcommand{\\url}{\\texttt}}\n";
513 if (mustProvide("natbib")) {
514 packages << "\\usepackage[";
515 if (params_.getEngine() == biblio::ENGINE_NATBIB_NUMERICAL) {
516 packages << "numbers";
518 packages << "authoryear";
520 packages << "]{natbib}\n";
523 // jurabib -- we need version 0.6 at least.
524 if (mustProvide("jurabib")) {
525 packages << "\\usepackage{jurabib}[2004/01/25]\n";
528 // bibtopic -- the dot provides the aux file naming which
530 if (mustProvide("bibtopic")) {
531 packages << "\\usepackage[dot]{bibtopic}\n";
534 if (mustProvide("xy"))
535 packages << "\\usepackage[all]{xy}\n";
537 if (mustProvide("nomencl")) {
538 // Make it work with the new and old version of the package,
539 // but don't use the compatibility option since it is
540 // incompatible to other packages.
541 packages << "\\usepackage{nomencl}\n"
542 "% the following is useful when we have the old nomencl.sty package\n"
543 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
544 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
545 "\\makenomenclature\n";
548 return packages.str();
552 string const LaTeXFeatures::getMacros() const
554 ostringstream macros;
556 if (!preamble_snippets_.empty())
558 FeaturesList::const_iterator pit = preamble_snippets_.begin();
559 FeaturesList::const_iterator pend = preamble_snippets_.end();
560 for (; pit != pend; ++pit) {
561 macros << *pit << '\n';
564 if (mustProvide("LyX"))
565 macros << lyx_def << '\n';
567 if (mustProvide("lyxline"))
568 macros << lyxline_def << '\n';
570 if (mustProvide("noun"))
571 macros << noun_def << '\n';
573 if (mustProvide("lyxarrow"))
574 macros << lyxarrow_def << '\n';
577 if (mustProvide("quotesinglbase"))
578 macros << quotesinglbase_def << '\n';
579 if (mustProvide("quotedblbase"))
580 macros << quotedblbase_def << '\n';
581 if (mustProvide("guilsinglleft"))
582 macros << guilsinglleft_def << '\n';
583 if (mustProvide("guilsinglright"))
584 macros << guilsinglright_def << '\n';
585 if (mustProvide("guillemotleft"))
586 macros << guillemotleft_def << '\n';
587 if (mustProvide("guillemotright"))
588 macros << guillemotright_def << '\n';
591 if (mustProvide("boldsymbol") && !isRequired("amsmath"))
592 macros << boldsymbol_def << '\n';
593 if (mustProvide("binom") && !isRequired("amsmath"))
594 macros << binom_def << '\n';
595 if (mustProvide("mathcircumflex"))
596 macros << mathcircumflex_def << '\n';
599 if (mustProvide("ParagraphLeftIndent"))
600 macros << paragraphleftindent_def;
601 if (mustProvide("NeedLyXFootnoteCode"))
602 macros << floatingfootnote_def;
604 // some problems with tex->html converters
605 if (mustProvide("NeedTabularnewline"))
606 macros << tabularnewline_def;
608 // greyedout environment (note inset)
609 if (mustProvide("lyxgreyedout"))
610 macros << lyxgreyedout_def;
612 if (mustProvide("lyxdot"))
613 macros << lyxdot_def << '\n';
616 getFloatDefinitions(macros);
622 string const LaTeXFeatures::getBabelOptions() const
626 LanguageList::const_iterator it = UsedLanguages_.begin();
627 LanguageList::const_iterator end = UsedLanguages_.end();
628 for (; it != end; ++it)
629 if (!(*it)->latex_options().empty())
630 tmp << (*it)->latex_options() << '\n';
631 if (!params_.language->latex_options().empty())
632 tmp << params_.language->latex_options() << '\n';
638 docstring const LaTeXFeatures::getTClassPreamble() const
640 // the text class specific preamble
641 TextClass const & tclass = params_.getTextClass();
642 odocstringstream tcpreamble;
644 tcpreamble << tclass.preamble();
646 list<string>::const_iterator cit = usedLayouts_.begin();
647 list<string>::const_iterator end = usedLayouts_.end();
648 for (; cit != end; ++cit) {
649 tcpreamble << tclass[*cit]->preamble();
652 CharStyles::iterator cs = tclass.charstyles().begin();
653 CharStyles::iterator csend = tclass.charstyles().end();
654 for (; cs != csend; ++cs) {
655 if (isRequired(cs->name))
656 tcpreamble << cs->preamble;
659 return tcpreamble.str();
663 docstring const LaTeXFeatures::getLyXSGMLEntities() const
665 // Definition of entities used in the document that are LyX related.
666 odocstringstream entities;
668 if (mustProvide("lyxarrow")) {
669 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
672 return entities.str();
676 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
678 odocstringstream sgmlpreamble;
680 docstring const basename(from_utf8(onlyPath(fname)));
682 FileMap::const_iterator end = IncludedFiles_.end();
683 for (FileMap::const_iterator fi = IncludedFiles_.begin();
686 sgmlpreamble << "\n<!ENTITY " << fi->first
687 << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
688 << makeRelPath(from_utf8(fi->second), basename) << "\">";
690 return sgmlpreamble.str();
694 void LaTeXFeatures::showStruct() const {
695 lyxerr << "LyX needs the following commands when LaTeXing:"
696 << "\n***** Packages:" << getPackages()
697 << "\n***** Macros:" << getMacros()
698 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
699 << "\n***** done." << endl;
703 Buffer const & LaTeXFeatures::buffer() const
709 void LaTeXFeatures::setBuffer(Buffer const & buffer)
715 BufferParams const & LaTeXFeatures::bufferParams() const
721 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
723 FloatList const & floats = params_.getTextClass().floats();
725 // Here we will output the code to create the needed float styles.
726 // We will try to do this as minimal as possible.
727 // \floatstyle{ruled}
728 // \newfloat{algorithm}{htbp}{loa}
729 // \floatname{algorithm}{Algorithm}
730 UsedFloats::const_iterator cit = usedFloats_.begin();
731 UsedFloats::const_iterator end = usedFloats_.end();
732 // ostringstream floats;
733 for (; cit != end; ++cit) {
734 Floating const & fl = floats.getType((*cit));
736 // For builtin floats we do nothing.
737 if (fl.builtin()) continue;
739 // We have to special case "table" and "figure"
740 if (fl.type() == "tabular" || fl.type() == "figure") {
741 // Output code to modify "table" or "figure"
742 // but only if builtin == false
743 // and that have to be true at this point in the
745 string const type = fl.type();
746 string const placement = fl.placement();
747 string const style = fl.style();
748 if (!style.empty()) {
749 os << "\\floatstyle{" << style << "}\n"
750 << "\\restylefloat{" << type << "}\n";
752 if (!placement.empty()) {
753 os << "\\floatplacement{" << type << "}{"
754 << placement << "}\n";
757 // The other non builtin floats.
759 string const type = fl.type();
760 string const placement = fl.placement();
761 string const ext = fl.ext();
762 string const within = fl.within();
763 string const style = fl.style();
764 string const name = fl.name();
765 os << "\\floatstyle{" << style << "}\n"
766 << "\\newfloat{" << type << "}{" << placement
767 << "}{" << ext << '}';
769 os << '[' << within << ']';
771 << "\\floatname{" << type << "}{"
774 // What missing here is to code to minimalize the code
775 // output so that the same floatstyle will not be
776 // used several times, when the same style is still in