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"
23 #include "FloatList.h"
29 #include "support/filetools.h"
33 using lyx::support::IsSGMLFilename;
34 using lyx::support::LibFileSearch;
35 using lyx::support::MakeRelPath;
36 using lyx::support::OnlyPath;
43 using std::ostringstream;
46 namespace biblio = lyx::biblio;
49 LaTeXFeatures::PackagesList LaTeXFeatures::packages_;
52 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
53 OutputParams const & r)
54 : buffer_(&b), params_(p), runparams_(r)
58 bool LaTeXFeatures::useBabel() const
60 return lyxrc.language_use_babel ||
61 bufferParams().language->lang() != lyxrc.default_language ||
66 void LaTeXFeatures::require(string const & name)
71 features_.push_back(name);
75 void LaTeXFeatures::getAvailable()
78 string real_file = LibFileSearch("", "packages.lst");
80 if (real_file.empty())
83 lex.setFile(real_file);
88 // Make sure that we are clean
91 bool finished = false;
93 while (lex.isOK() && !finished) {
95 case LyXLex::LEX_FEOF:
99 string const name = lex.getString();
100 PackagesList::const_iterator begin = packages_.begin();
101 PackagesList::const_iterator end = packages_.end();
102 if (find(begin, end, name) == end)
103 packages_.push_back(name);
111 void LaTeXFeatures::useLayout(string const & layoutname)
113 // Some code to avoid loops in dependency definition
114 static int level = 0;
115 const int maxlevel = 30;
116 if (level > maxlevel) {
117 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
118 << "recursion attained by layout "
119 << layoutname << endl;
123 LyXTextClass const & tclass = params_.getLyXTextClass();
124 if (tclass.hasLayout(layoutname)) {
125 // Is this layout already in usedLayouts?
126 list<string>::const_iterator cit = usedLayouts_.begin();
127 list<string>::const_iterator end = usedLayouts_.end();
128 for (; cit != end; ++cit) {
129 if (layoutname == *cit)
133 LyXLayout_ptr const & lyt = tclass[layoutname];
134 if (!lyt->depends_on().empty()) {
136 useLayout(lyt->depends_on());
139 usedLayouts_.push_back(layoutname);
141 lyxerr << "LaTeXFeatures::useLayout: layout `"
142 << layoutname << "' does not exist in this class"
150 bool LaTeXFeatures::isRequired(string const & name) const
152 return find(features_.begin(), features_.end(), name) != features_.end();
156 bool LaTeXFeatures::isAvailable(string const & name) const
158 if (packages_.empty())
160 return find(packages_.begin(), packages_.end(), name) != packages_.end();
164 void LaTeXFeatures::addExternalPreamble(string const & preamble)
166 FeaturesList::const_iterator begin = preamble_snippets_.begin();
167 FeaturesList::const_iterator end = preamble_snippets_.end();
168 if (find(begin, end, preamble) == end)
169 preamble_snippets_.push_back(preamble);
173 void LaTeXFeatures::useFloat(string const & name)
175 usedFloats_.insert(name);
176 // We only need float.sty if we use non builtin floats, or if we
177 // use the "H" modifier. This includes modified table and
178 // figure floats. (Lgb)
179 Floating const & fl = params_.getLyXTextClass().floats().getType(name);
180 if (!fl.type().empty() && !fl.builtin()) {
186 void LaTeXFeatures::useLanguage(Language const * lang)
188 UsedLanguages_.insert(lang);
192 void LaTeXFeatures::includeFile(string const & key, string const & name)
194 IncludedFiles_[key] = name;
198 bool LaTeXFeatures::hasLanguages() const
200 return !UsedLanguages_.empty();
204 string LaTeXFeatures::getLanguages() const
206 ostringstream languages;
208 for (LanguageList::const_iterator cit =
209 UsedLanguages_.begin();
210 cit != UsedLanguages_.end();
212 languages << (*cit)->babel() << ',';
213 return languages.str();
217 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
219 set<string> encodings;
220 LanguageList::const_iterator it = UsedLanguages_.begin();
221 LanguageList::const_iterator end = UsedLanguages_.end();
222 for (; it != end; ++it)
223 if ((*it)->encoding()->LatexName() != doc_encoding)
224 encodings.insert((*it)->encoding()->LatexName());
230 char const * simplefeatures[] = {
248 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
253 string const LaTeXFeatures::getPackages() const
255 ostringstream packages;
256 LyXTextClass const & tclass = params_.getLyXTextClass();
259 // These are all the 'simple' includes. i.e
260 // packages which we just \usepackage{package}
262 for (int i = 0; i < nb_simplefeatures; ++i) {
263 if (isRequired(simplefeatures[i]))
264 packages << "\\usepackage{"
265 << simplefeatures[i] << "}\n";
269 // The rest of these packages are somewhat more complicated
273 if (isRequired("amsmath")
274 && !tclass.provides(LyXTextClass::amsmath)
275 && params_.use_amsmath != BufferParams::AMS_OFF) {
276 packages << "\\usepackage{amsmath}\n";
279 // wasysym is a simple feature, but it must be after amsmath if both
281 if (isRequired("wasysym"))
282 packages << "\\usepackage{wasysym}\n";
285 if (isRequired("color")) {
286 if (params_.graphicsDriver == "default")
287 packages << "\\usepackage{color}\n";
289 packages << "\\usepackage["
290 << params_.graphicsDriver
295 if (isRequired("makeidx")) {
296 if (! tclass.provides(LyXTextClass::makeidx))
297 packages << "\\usepackage{makeidx}\n";
298 packages << "\\makeindex\n";
302 if (isRequired("graphicx") && params_.graphicsDriver != "none") {
303 if (params_.graphicsDriver == "default")
304 packages << "\\usepackage{graphicx}\n";
306 packages << "\\usepackage["
307 << params_.graphicsDriver
312 // packages << "\\usepackage{algorithm}\n";
315 // lyxskak.sty --- newer chess support based on skak.sty
316 if (isRequired("chess")) {
317 packages << "\\usepackage[ps,mover]{lyxskak}\n";
321 if ((params_.spacing().getSpace() != Spacing::Single
322 && !params_.spacing().isDefault())
323 || isRequired("setspace")) {
324 packages << "\\usepackage{setspace}\n";
326 switch (params_.spacing().getSpace()) {
327 case Spacing::Default:
328 case Spacing::Single:
329 // we dont use setspace.sty so dont print anything
330 //packages += "\\singlespacing\n";
332 case Spacing::Onehalf:
333 packages << "\\onehalfspacing\n";
335 case Spacing::Double:
336 packages << "\\doublespacing\n";
339 packages << "\\setstretch{"
340 << params_.spacing().getValue() << "}\n";
345 if (isRequired("amssymb") || params_.use_amsmath == BufferParams::AMS_ON)
346 packages << "\\usepackage{amssymb}\n";
348 if (isRequired("url") && ! tclass.provides(LyXTextClass::url))
349 packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
350 " {\\newcommand{\\url}{\\texttt}}\n";
354 if (isRequired("natbib") && ! tclass.provides(LyXTextClass::natbib)) {
355 packages << "\\usepackage[";
356 if (params_.cite_engine == biblio::ENGINE_NATBIB_NUMERICAL) {
357 packages << "numbers";
359 packages << "authoryear";
361 packages << "]{natbib}\n";
364 // jurabib -- we need version 0.6 at least.
365 if (isRequired("jurabib")) {
366 packages << "\\usepackage{jurabib}[2004/01/25]\n";
369 // bibtopic -- the dot provides the aux file naming which
371 if (isRequired("bibtopic")) {
372 packages << "\\usepackage[dot]{bibtopic}\n";
375 return packages.str();
379 string const LaTeXFeatures::getMacros() const
381 ostringstream macros;
383 if (!preamble_snippets_.empty())
385 FeaturesList::const_iterator pit = preamble_snippets_.begin();
386 FeaturesList::const_iterator pend = preamble_snippets_.end();
387 for (; pit != pend; ++pit) {
388 macros << *pit << '\n';
391 if (isRequired("LyX"))
392 macros << lyx_def << '\n';
394 if (isRequired("lyxline"))
395 macros << lyxline_def << '\n';
397 if (isRequired("noun"))
398 macros << noun_def << '\n';
400 if (isRequired("lyxarrow"))
401 macros << lyxarrow_def << '\n';
404 if (isRequired("quotesinglbase"))
405 macros << quotesinglbase_def << '\n';
406 if (isRequired("quotedblbase"))
407 macros << quotedblbase_def << '\n';
408 if (isRequired("guilsinglleft"))
409 macros << guilsinglleft_def << '\n';
410 if (isRequired("guilsinglright"))
411 macros << guilsinglright_def << '\n';
412 if (isRequired("guillemotleft"))
413 macros << guillemotleft_def << '\n';
414 if (isRequired("guillemotright"))
415 macros << guillemotright_def << '\n';
418 if (isRequired("boldsymbol") && !isRequired("amsmath"))
419 macros << boldsymbol_def << '\n';
420 if (isRequired("binom") && !isRequired("amsmath"))
421 macros << binom_def << '\n';
422 if (isRequired("mathcircumflex"))
423 macros << mathcircumflex_def << '\n';
426 if (isRequired("ParagraphLeftIndent"))
427 macros << paragraphleftindent_def;
428 if (isRequired("NeedLyXFootnoteCode"))
429 macros << floatingfootnote_def;
431 // some problems with tex->html converters
432 if (isRequired("NeedTabularnewline"))
433 macros << tabularnewline_def;
435 // greyedout environment (note inset)
436 if (isRequired("lyxgreyedout"))
437 macros << lyxgreyedout_def;
439 if (isRequired("lyxdot"))
440 macros << lyxdot_def << '\n';
443 getFloatDefinitions(macros);
449 string const LaTeXFeatures::getBabelOptions() const
453 LanguageList::const_iterator it = UsedLanguages_.begin();
454 LanguageList::const_iterator end = UsedLanguages_.end();
455 for (; it != end; ++it)
456 if (!(*it)->latex_options().empty())
457 tmp << (*it)->latex_options() << '\n';
458 if (!params_.language->latex_options().empty())
459 tmp << params_.language->latex_options() << '\n';
465 string const LaTeXFeatures::getTClassPreamble() const
467 // the text class specific preamble
468 LyXTextClass const & tclass = params_.getLyXTextClass();
469 ostringstream tcpreamble;
471 tcpreamble << tclass.preamble();
473 list<string>::const_iterator cit = usedLayouts_.begin();
474 list<string>::const_iterator end = usedLayouts_.end();
475 for (; cit != end; ++cit) {
476 tcpreamble << tclass[*cit]->preamble();
479 CharStyles::iterator cs = tclass.charstyles().begin();
480 CharStyles::iterator csend = tclass.charstyles().end();
481 for (; cs != csend; ++cs) {
482 if (isRequired(cs->name))
483 tcpreamble << cs->preamble;
486 return tcpreamble.str();
490 string const LaTeXFeatures::getLyXSGMLEntities() const
492 // Definition of entities used in the document that are LyX related.
493 ostringstream entities;
495 if (isRequired("lyxarrow")) {
496 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
499 return entities.str();
503 string const LaTeXFeatures::getIncludedFiles(string const & fname) const
505 ostringstream sgmlpreamble;
506 string const basename = OnlyPath(fname);
508 FileMap::const_iterator end = IncludedFiles_.end();
509 for (FileMap::const_iterator fi = IncludedFiles_.begin();
511 sgmlpreamble << "\n<!ENTITY " << fi->first
512 << (IsSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
513 << MakeRelPath(fi->second, basename) << "\">";
515 return sgmlpreamble.str();
519 void LaTeXFeatures::showStruct() const {
520 lyxerr << "LyX needs the following commands when LaTeXing:"
521 << "\n***** Packages:" << getPackages()
522 << "\n***** Macros:" << getMacros()
523 << "\n***** Textclass stuff:" << getTClassPreamble()
524 << "\n***** done." << endl;
528 Buffer const & LaTeXFeatures::buffer() const
534 void LaTeXFeatures::setBuffer(Buffer const & buffer)
540 BufferParams const & LaTeXFeatures::bufferParams() const
546 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
548 FloatList const & floats = params_.getLyXTextClass().floats();
550 // Here we will output the code to create the needed float styles.
551 // We will try to do this as minimal as possible.
552 // \floatstyle{ruled}
553 // \newfloat{algorithm}{htbp}{loa}
554 // \floatname{algorithm}{Algorithm}
555 UsedFloats::const_iterator cit = usedFloats_.begin();
556 UsedFloats::const_iterator end = usedFloats_.end();
557 // ostringstream floats;
558 for (; cit != end; ++cit) {
559 Floating const & fl = floats.getType((*cit));
561 // For builtin floats we do nothing.
562 if (fl.builtin()) continue;
564 // We have to special case "table" and "figure"
565 if (fl.type() == "tabular" || fl.type() == "figure") {
566 // Output code to modify "table" or "figure"
567 // but only if builtin == false
568 // and that have to be true at this point in the
570 string const type = fl.type();
571 string const placement = fl.placement();
572 string const style = fl.style();
573 if (!style.empty()) {
574 os << "\\floatstyle{" << style << "}\n"
575 << "\\restylefloat{" << type << "}\n";
577 if (!placement.empty()) {
578 os << "\\floatplacement{" << type << "}{"
579 << placement << "}\n";
582 // The other non builtin floats.
584 string const type = fl.type();
585 string const placement = fl.placement();
586 string const ext = fl.ext();
587 string const within = fl.within();
588 string const style = fl.style();
589 string const name = fl.name();
590 os << "\\floatstyle{" << style << "}\n"
591 << "\\newfloat{" << type << "}{" << placement
592 << "}{" << ext << '}';
594 os << '[' << within << ']';
596 << "\\floatname{" << type << "}{"
599 // What missing here is to code to minimalize the code
600 // output so that the same floatstyle will not be
601 // used several times, when the same style is still in