2 * \file LaTeXFeatures.C
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"
31 #include "support/filetools.h"
35 using lyx::support::isSGMLFilename;
36 using lyx::support::libFileSearch;
37 using lyx::support::makeRelPath;
38 using lyx::support::onlyPath;
45 using std::ostringstream;
48 namespace biblio = lyx::biblio;
51 LaTeXFeatures::PackagesList LaTeXFeatures::packages_;
54 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
55 OutputParams const & r)
56 : buffer_(&b), params_(p), runparams_(r)
60 bool LaTeXFeatures::useBabel() const
62 return lyxrc.language_use_babel ||
63 bufferParams().language->lang() != lyxrc.default_language ||
68 void LaTeXFeatures::require(string const & name)
73 features_.push_back(name);
77 void LaTeXFeatures::getAvailable()
80 string real_file = libFileSearch("", "packages.lst");
82 if (real_file.empty())
85 lex.setFile(real_file);
90 // Make sure that we are clean
93 bool finished = false;
95 while (lex.isOK() && !finished) {
97 case LyXLex::LEX_FEOF:
101 string const name = lex.getString();
102 PackagesList::const_iterator begin = packages_.begin();
103 PackagesList::const_iterator end = packages_.end();
104 if (find(begin, end, name) == end)
105 packages_.push_back(name);
113 void LaTeXFeatures::useLayout(string const & layoutname)
115 // Some code to avoid loops in dependency definition
116 static int level = 0;
117 const int maxlevel = 30;
118 if (level > maxlevel) {
119 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
120 << "recursion attained by layout "
121 << layoutname << endl;
125 LyXTextClass const & tclass = params_.getLyXTextClass();
126 if (tclass.hasLayout(layoutname)) {
127 // Is this layout already in usedLayouts?
128 list<string>::const_iterator cit = usedLayouts_.begin();
129 list<string>::const_iterator end = usedLayouts_.end();
130 for (; cit != end; ++cit) {
131 if (layoutname == *cit)
135 LyXLayout_ptr const & lyt = tclass[layoutname];
136 if (!lyt->depends_on().empty()) {
138 useLayout(lyt->depends_on());
141 usedLayouts_.push_back(layoutname);
143 lyxerr << "LaTeXFeatures::useLayout: layout `"
144 << layoutname << "' does not exist in this class"
152 bool LaTeXFeatures::isRequired(string const & name) const
154 return find(features_.begin(), features_.end(), name) != features_.end();
158 bool LaTeXFeatures::isAvailable(string const & name) const
160 if (packages_.empty())
162 return find(packages_.begin(), packages_.end(), name) != packages_.end();
166 void LaTeXFeatures::addExternalPreamble(string const & preamble)
168 FeaturesList::const_iterator begin = preamble_snippets_.begin();
169 FeaturesList::const_iterator end = preamble_snippets_.end();
170 if (find(begin, end, preamble) == end)
171 preamble_snippets_.push_back(preamble);
175 void LaTeXFeatures::useFloat(string const & name)
177 usedFloats_.insert(name);
178 // We only need float.sty if we use non builtin floats, or if we
179 // use the "H" modifier. This includes modified table and
180 // figure floats. (Lgb)
181 Floating const & fl = params_.getLyXTextClass().floats().getType(name);
182 if (!fl.type().empty() && !fl.builtin()) {
188 void LaTeXFeatures::useLanguage(Language const * lang)
190 UsedLanguages_.insert(lang);
194 void LaTeXFeatures::includeFile(string const & key, string const & name)
196 IncludedFiles_[key] = name;
200 bool LaTeXFeatures::hasLanguages() const
202 return !UsedLanguages_.empty();
206 string LaTeXFeatures::getLanguages() const
208 ostringstream languages;
210 for (LanguageList::const_iterator cit =
211 UsedLanguages_.begin();
212 cit != UsedLanguages_.end();
214 languages << (*cit)->babel() << ',';
215 return languages.str();
219 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
221 set<string> encodings;
222 LanguageList::const_iterator it = UsedLanguages_.begin();
223 LanguageList::const_iterator end = UsedLanguages_.end();
224 for (; it != end; ++it)
225 if ((*it)->encoding()->latexName() != doc_encoding)
226 encodings.insert((*it)->encoding()->latexName());
232 char const * simplefeatures[] = {
252 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
257 string const LaTeXFeatures::getPackages() const
259 ostringstream packages;
260 LyXTextClass const & tclass = params_.getLyXTextClass();
263 // These are all the 'simple' includes. i.e
264 // packages which we just \usepackage{package}
266 for (int i = 0; i < nb_simplefeatures; ++i) {
267 if (isRequired(simplefeatures[i]))
268 packages << "\\usepackage{"
269 << simplefeatures[i] << "}\n";
273 // The rest of these packages are somewhat more complicated
277 if (isRequired("amsmath")
278 && !tclass.provides(LyXTextClass::amsmath)
279 && params_.use_amsmath != BufferParams::AMS_OFF) {
280 packages << "\\usepackage{amsmath}\n";
283 // wasysym is a simple feature, but it must be after amsmath if both
285 if (isRequired("wasysym"))
286 packages << "\\usepackage{wasysym}\n";
289 if (isRequired("color")) {
290 if (params_.graphicsDriver == "default")
291 packages << "\\usepackage{color}\n";
293 packages << "\\usepackage["
294 << params_.graphicsDriver
299 if (isRequired("makeidx")) {
300 if (!tclass.provides(LyXTextClass::makeidx))
301 packages << "\\usepackage{makeidx}\n";
302 packages << "\\makeindex\n";
306 if (isRequired("graphicx") && params_.graphicsDriver != "none") {
307 if (params_.graphicsDriver == "default")
308 packages << "\\usepackage{graphicx}\n";
310 packages << "\\usepackage["
311 << params_.graphicsDriver
314 // shadecolor for shaded
315 if (isRequired("framed")) {
316 lyx::RGBColor c = lyx::RGBColor(lcolor.getX11Name(LColor::shadedbg));
317 packages << "\\definecolor{shadecolor}{rgb}{"
318 << c.r/255 << ',' << c.g/255 << ',' << c.b/255 << "}\n";
322 // packages << "\\usepackage{algorithm}\n";
325 // lyxskak.sty --- newer chess support based on skak.sty
326 if (isRequired("chess")) {
327 packages << "\\usepackage[ps,mover]{lyxskak}\n";
331 if ((params_.spacing().getSpace() != Spacing::Single
332 && !params_.spacing().isDefault())
333 || isRequired("setspace")) {
334 packages << "\\usepackage{setspace}\n";
336 switch (params_.spacing().getSpace()) {
337 case Spacing::Default:
338 case Spacing::Single:
339 // we dont use setspace.sty so dont print anything
340 //packages += "\\singlespacing\n";
342 case Spacing::Onehalf:
343 packages << "\\onehalfspacing\n";
345 case Spacing::Double:
346 packages << "\\doublespacing\n";
349 packages << "\\setstretch{"
350 << params_.spacing().getValue() << "}\n";
355 if (isRequired("amssymb") || params_.use_amsmath == BufferParams::AMS_ON)
356 packages << "\\usepackage{amssymb}\n";
358 if (isRequired("url") && ! tclass.provides(LyXTextClass::url))
359 packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
360 " {\\newcommand{\\url}{\\texttt}}\n";
364 if (isRequired("natbib") && ! tclass.provides(LyXTextClass::natbib)) {
365 packages << "\\usepackage[";
366 if (params_.cite_engine == biblio::ENGINE_NATBIB_NUMERICAL) {
367 packages << "numbers";
369 packages << "authoryear";
371 packages << "]{natbib}\n";
374 // jurabib -- we need version 0.6 at least.
375 if (isRequired("jurabib")) {
376 packages << "\\usepackage{jurabib}[2004/01/25]\n";
379 // bibtopic -- the dot provides the aux file naming which
381 if (isRequired("bibtopic")) {
382 packages << "\\usepackage[dot]{bibtopic}\n";
385 return packages.str();
389 string const LaTeXFeatures::getMacros() const
391 ostringstream macros;
393 if (!preamble_snippets_.empty())
395 FeaturesList::const_iterator pit = preamble_snippets_.begin();
396 FeaturesList::const_iterator pend = preamble_snippets_.end();
397 for (; pit != pend; ++pit) {
398 macros << *pit << '\n';
401 if (isRequired("LyX"))
402 macros << lyx_def << '\n';
404 if (isRequired("lyxline"))
405 macros << lyxline_def << '\n';
407 if (isRequired("noun"))
408 macros << noun_def << '\n';
410 if (isRequired("lyxarrow"))
411 macros << lyxarrow_def << '\n';
414 if (isRequired("quotesinglbase"))
415 macros << quotesinglbase_def << '\n';
416 if (isRequired("quotedblbase"))
417 macros << quotedblbase_def << '\n';
418 if (isRequired("guilsinglleft"))
419 macros << guilsinglleft_def << '\n';
420 if (isRequired("guilsinglright"))
421 macros << guilsinglright_def << '\n';
422 if (isRequired("guillemotleft"))
423 macros << guillemotleft_def << '\n';
424 if (isRequired("guillemotright"))
425 macros << guillemotright_def << '\n';
428 if (isRequired("boldsymbol") && !isRequired("amsmath"))
429 macros << boldsymbol_def << '\n';
430 if (isRequired("binom") && !isRequired("amsmath"))
431 macros << binom_def << '\n';
432 if (isRequired("mathcircumflex"))
433 macros << mathcircumflex_def << '\n';
436 if (isRequired("ParagraphLeftIndent"))
437 macros << paragraphleftindent_def;
438 if (isRequired("NeedLyXFootnoteCode"))
439 macros << floatingfootnote_def;
441 // some problems with tex->html converters
442 if (isRequired("NeedTabularnewline"))
443 macros << tabularnewline_def;
445 // greyedout environment (note inset)
446 if (isRequired("lyxgreyedout"))
447 macros << lyxgreyedout_def;
449 if (isRequired("lyxdot"))
450 macros << lyxdot_def << '\n';
453 getFloatDefinitions(macros);
459 string const LaTeXFeatures::getBabelOptions() const
463 LanguageList::const_iterator it = UsedLanguages_.begin();
464 LanguageList::const_iterator end = UsedLanguages_.end();
465 for (; it != end; ++it)
466 if (!(*it)->latex_options().empty())
467 tmp << (*it)->latex_options() << '\n';
468 if (!params_.language->latex_options().empty())
469 tmp << params_.language->latex_options() << '\n';
475 string const LaTeXFeatures::getTClassPreamble() const
477 // the text class specific preamble
478 LyXTextClass const & tclass = params_.getLyXTextClass();
479 ostringstream tcpreamble;
481 tcpreamble << tclass.preamble();
483 list<string>::const_iterator cit = usedLayouts_.begin();
484 list<string>::const_iterator end = usedLayouts_.end();
485 for (; cit != end; ++cit) {
486 tcpreamble << tclass[*cit]->preamble();
489 CharStyles::iterator cs = tclass.charstyles().begin();
490 CharStyles::iterator csend = tclass.charstyles().end();
491 for (; cs != csend; ++cs) {
492 if (isRequired(cs->name))
493 tcpreamble << cs->preamble;
496 return tcpreamble.str();
500 string const LaTeXFeatures::getLyXSGMLEntities() const
502 // Definition of entities used in the document that are LyX related.
503 ostringstream entities;
505 if (isRequired("lyxarrow")) {
506 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
509 return entities.str();
513 string const LaTeXFeatures::getIncludedFiles(string const & fname) const
515 ostringstream sgmlpreamble;
516 string const basename = onlyPath(fname);
518 FileMap::const_iterator end = IncludedFiles_.end();
519 for (FileMap::const_iterator fi = IncludedFiles_.begin();
521 sgmlpreamble << "\n<!ENTITY " << fi->first
522 << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
523 << makeRelPath(fi->second, basename) << "\">";
525 return sgmlpreamble.str();
529 void LaTeXFeatures::showStruct() const {
530 lyxerr << "LyX needs the following commands when LaTeXing:"
531 << "\n***** Packages:" << getPackages()
532 << "\n***** Macros:" << getMacros()
533 << "\n***** Textclass stuff:" << getTClassPreamble()
534 << "\n***** done." << endl;
538 Buffer const & LaTeXFeatures::buffer() const
544 void LaTeXFeatures::setBuffer(Buffer const & buffer)
550 BufferParams const & LaTeXFeatures::bufferParams() const
556 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
558 FloatList const & floats = params_.getLyXTextClass().floats();
560 // Here we will output the code to create the needed float styles.
561 // We will try to do this as minimal as possible.
562 // \floatstyle{ruled}
563 // \newfloat{algorithm}{htbp}{loa}
564 // \floatname{algorithm}{Algorithm}
565 UsedFloats::const_iterator cit = usedFloats_.begin();
566 UsedFloats::const_iterator end = usedFloats_.end();
567 // ostringstream floats;
568 for (; cit != end; ++cit) {
569 Floating const & fl = floats.getType((*cit));
571 // For builtin floats we do nothing.
572 if (fl.builtin()) continue;
574 // We have to special case "table" and "figure"
575 if (fl.type() == "tabular" || fl.type() == "figure") {
576 // Output code to modify "table" or "figure"
577 // but only if builtin == false
578 // and that have to be true at this point in the
580 string const type = fl.type();
581 string const placement = fl.placement();
582 string const style = fl.style();
583 if (!style.empty()) {
584 os << "\\floatstyle{" << style << "}\n"
585 << "\\restylefloat{" << type << "}\n";
587 if (!placement.empty()) {
588 os << "\\floatplacement{" << type << "}{"
589 << placement << "}\n";
592 // The other non builtin floats.
594 string const type = fl.type();
595 string const placement = fl.placement();
596 string const ext = fl.ext();
597 string const within = fl.within();
598 string const style = fl.style();
599 string const name = fl.name();
600 os << "\\floatstyle{" << style << "}\n"
601 << "\\newfloat{" << type << "}{" << placement
602 << "}{" << ext << '}';
604 os << '[' << within << ']';
606 << "\\floatname{" << type << "}{"
609 // What missing here is to code to minimalize the code
610 // output so that the same floatstyle will not be
611 // used several times, when the same style is still in