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, bool n)
53 : buffer_(&b), params_(p), nice_(n)
57 bool LaTeXFeatures::useBabel() const
59 return lyxrc.language_use_babel ||
60 bufferParams().language->lang() != lyxrc.default_language ||
65 void LaTeXFeatures::require(string const & name)
70 features_.push_back(name);
74 void LaTeXFeatures::getAvailable()
77 string real_file = LibFileSearch("", "packages.lst");
79 if (real_file.empty())
82 lex.setFile(real_file);
87 // Make sure that we are clean
90 bool finished = false;
92 while (lex.isOK() && !finished) {
94 case LyXLex::LEX_FEOF:
98 string const name = lex.getString();
99 PackagesList::const_iterator begin = packages_.begin();
100 PackagesList::const_iterator end = packages_.end();
101 if (find(begin, end, name) == end)
102 packages_.push_back(name);
110 void LaTeXFeatures::useLayout(string const & layoutname)
112 // Some code to avoid loops in dependency definition
113 static int level = 0;
114 const int maxlevel = 30;
115 if (level > maxlevel) {
116 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
117 << "recursion attained by layout "
118 << layoutname << endl;
122 LyXTextClass const & tclass = params_.getLyXTextClass();
123 if (tclass.hasLayout(layoutname)) {
124 // Is this layout already in usedLayouts?
125 list<string>::const_iterator cit = usedLayouts_.begin();
126 list<string>::const_iterator end = usedLayouts_.end();
127 for (; cit != end; ++cit) {
128 if (layoutname == *cit)
132 LyXLayout_ptr const & lyt = tclass[layoutname];
133 if (!lyt->depends_on().empty()) {
135 useLayout(lyt->depends_on());
138 usedLayouts_.push_back(layoutname);
140 lyxerr << "LaTeXFeatures::useLayout: layout `"
141 << layoutname << "' does not exist in this class"
149 bool LaTeXFeatures::isRequired(string const & name) const
151 return find(features_.begin(), features_.end(), name) != features_.end();
155 bool LaTeXFeatures::isAvailable(string const & name) const
157 if (packages_.empty())
159 return find(packages_.begin(), packages_.end(), name) != packages_.end();
163 void LaTeXFeatures::addExternalPreamble(string const & preamble)
165 FeaturesList::const_iterator begin = preamble_snippets_.begin();
166 FeaturesList::const_iterator end = preamble_snippets_.end();
167 if (find(begin, end, preamble) == end)
168 preamble_snippets_.push_back(preamble);
172 void LaTeXFeatures::useFloat(string const & name)
174 usedFloats_.insert(name);
175 // We only need float.sty if we use non builtin floats, or if we
176 // use the "H" modifier. This includes modified table and
177 // figure floats. (Lgb)
178 Floating const & fl = params_.getLyXTextClass().floats().getType(name);
179 if (!fl.type().empty() && !fl.builtin()) {
185 void LaTeXFeatures::useLanguage(Language const * lang)
187 UsedLanguages_.insert(lang);
191 void LaTeXFeatures::includeFile(string const & key, string const & name)
193 IncludedFiles_[key] = name;
197 bool LaTeXFeatures::hasLanguages() const
199 return !UsedLanguages_.empty();
203 string LaTeXFeatures::getLanguages() const
205 ostringstream languages;
207 for (LanguageList::const_iterator cit =
208 UsedLanguages_.begin();
209 cit != UsedLanguages_.end();
211 languages << (*cit)->babel() << ',';
212 return languages.str();
216 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
218 set<string> encodings;
219 LanguageList::const_iterator it = UsedLanguages_.begin();
220 LanguageList::const_iterator end = UsedLanguages_.end();
221 for (; it != end; ++it)
222 if ((*it)->encoding()->LatexName() != doc_encoding)
223 encodings.insert((*it)->encoding()->LatexName());
229 char const * simplefeatures[] = {
246 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
251 string const LaTeXFeatures::getPackages() const
253 ostringstream packages;
254 LyXTextClass const & tclass = params_.getLyXTextClass();
257 // These are all the 'simple' includes. i.e
258 // packages which we just \usepackage{package}
260 for (int i = 0; i < nb_simplefeatures; ++i) {
261 if (isRequired(simplefeatures[i]))
262 packages << "\\usepackage{"
263 << simplefeatures[i] << "}\n";
267 // The rest of these packages are somewhat more complicated
271 if (isRequired("amsmath")
272 && !tclass.provides(LyXTextClass::amsmath)
273 && params_.use_amsmath != BufferParams::AMS_OFF) {
274 packages << "\\usepackage{amsmath}\n";
277 // wasysym is a simple feature, but it must be after amsmath if both
279 if (isRequired("wasysym"))
280 packages << "\\usepackage{wasysym}\n";
283 if (isRequired("color")) {
284 if (params_.graphicsDriver == "default")
285 packages << "\\usepackage[usenames]{color}\n";
287 packages << "\\usepackage["
288 << params_.graphicsDriver
294 if (isRequired("makeidx")) {
295 if (! tclass.provides(LyXTextClass::makeidx))
296 packages << "\\usepackage{makeidx}\n";
297 packages << "\\makeindex\n";
301 if (isRequired("graphicx") && params_.graphicsDriver != "none") {
302 if (params_.graphicsDriver == "default")
303 packages << "\\usepackage{graphicx}\n";
305 packages << "\\usepackage["
306 << params_.graphicsDriver
311 // packages << "\\usepackage{algorithm}\n";
314 // lyxskak.sty --- newer chess support based on skak.sty
315 if (isRequired("chess")) {
316 packages << "\\usepackage[ps,mover]{lyxskak}\n";
320 if ((params_.spacing().getSpace() != Spacing::Single
321 && !params_.spacing().isDefault())
322 || isRequired("setspace")) {
323 packages << "\\usepackage{setspace}\n";
325 switch (params_.spacing().getSpace()) {
326 case Spacing::Default:
327 case Spacing::Single:
328 // we dont use setspace.sty so dont print anything
329 //packages += "\\singlespacing\n";
331 case Spacing::Onehalf:
332 packages << "\\onehalfspacing\n";
334 case Spacing::Double:
335 packages << "\\doublespacing\n";
338 packages << "\\setstretch{"
339 << params_.spacing().getValue() << "}\n";
344 if (isRequired("amssymb") || params_.use_amsmath == BufferParams::AMS_ON)
345 packages << "\\usepackage{amssymb}\n";
347 if (isRequired("url") && ! tclass.provides(LyXTextClass::url))
348 packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
349 " {\\newcommand{\\url}{\\texttt}}\n";
353 if (isRequired("natbib") && ! tclass.provides(LyXTextClass::natbib)) {
354 packages << "\\usepackage[";
355 if (params_.cite_engine == biblio::ENGINE_NATBIB_NUMERICAL) {
356 packages << "numbers";
358 packages << "authoryear";
360 packages << "]{natbib}\n";
363 // jurabib -- we need version 0.6 at least.
364 if (isRequired("jurabib")) {
365 packages << "\\usepackage{jurabib}[2004/01/25]\n";
368 // bibtopic -- the dot provides the aux file naming which
370 if (isRequired("bibtopic")) {
371 packages << "\\usepackage[dot]{bibtopic}\n";
374 return packages.str();
378 string const LaTeXFeatures::getMacros() const
380 ostringstream macros;
382 if (!preamble_snippets_.empty())
384 FeaturesList::const_iterator pit = preamble_snippets_.begin();
385 FeaturesList::const_iterator pend = preamble_snippets_.end();
386 for (; pit != pend; ++pit) {
387 macros << *pit << '\n';
390 if (isRequired("LyX"))
391 macros << lyx_def << '\n';
393 if (isRequired("lyxline"))
394 macros << lyxline_def << '\n';
396 if (isRequired("noun"))
397 macros << noun_def << '\n';
399 if (isRequired("lyxarrow"))
400 macros << lyxarrow_def << '\n';
403 if (isRequired("quotesinglbase"))
404 macros << quotesinglbase_def << '\n';
405 if (isRequired("quotedblbase"))
406 macros << quotedblbase_def << '\n';
407 if (isRequired("guilsinglleft"))
408 macros << guilsinglleft_def << '\n';
409 if (isRequired("guilsinglright"))
410 macros << guilsinglright_def << '\n';
411 if (isRequired("guillemotleft"))
412 macros << guillemotleft_def << '\n';
413 if (isRequired("guillemotright"))
414 macros << guillemotright_def << '\n';
417 if (isRequired("boldsymbol") && !isRequired("amsmath"))
418 macros << boldsymbol_def << '\n';
419 if (isRequired("binom") && !isRequired("amsmath"))
420 macros << binom_def << '\n';
421 if (isRequired("mathcircumflex"))
422 macros << mathcircumflex_def << '\n';
425 if (isRequired("ParagraphLeftIndent"))
426 macros << paragraphleftindent_def;
427 if (isRequired("NeedLyXFootnoteCode"))
428 macros << floatingfootnote_def;
430 // some problems with tex->html converters
431 if (isRequired("NeedTabularnewline"))
432 macros << tabularnewline_def;
434 // greyedout environment (note inset)
435 if (isRequired("lyxgreyedout"))
436 macros << lyxgreyedout_def;
438 if (isRequired("lyxdot"))
439 macros << lyxdot_def << '\n';
442 getFloatDefinitions(macros);
448 string const LaTeXFeatures::getBabelOptions() const
452 LanguageList::const_iterator it = UsedLanguages_.begin();
453 LanguageList::const_iterator end = UsedLanguages_.end();
454 for (; it != end; ++it)
455 if (!(*it)->latex_options().empty())
456 tmp << (*it)->latex_options() << '\n';
457 if (!params_.language->latex_options().empty())
458 tmp << params_.language->latex_options() << '\n';
464 string const LaTeXFeatures::getTClassPreamble() const
466 // the text class specific preamble
467 LyXTextClass const & tclass = params_.getLyXTextClass();
468 ostringstream tcpreamble;
470 tcpreamble << tclass.preamble();
472 list<string>::const_iterator cit = usedLayouts_.begin();
473 list<string>::const_iterator end = usedLayouts_.end();
474 for (; cit != end; ++cit) {
475 tcpreamble << tclass[*cit]->preamble();
478 CharStyles::iterator cs = tclass.charstyles().begin();
479 CharStyles::iterator csend = tclass.charstyles().end();
480 for (; cs != csend; ++cs) {
481 if (isRequired(cs->name))
482 tcpreamble << cs->preamble;
485 return tcpreamble.str();
489 string const LaTeXFeatures::getLyXSGMLEntities() const
491 // Definition of entities used in the document that are LyX related.
492 ostringstream entities;
494 if (isRequired("lyxarrow")) {
495 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
498 return entities.str();
502 string const LaTeXFeatures::getIncludedFiles(string const & fname) const
504 ostringstream sgmlpreamble;
505 string const basename = OnlyPath(fname);
507 FileMap::const_iterator end = IncludedFiles_.end();
508 for (FileMap::const_iterator fi = IncludedFiles_.begin();
510 sgmlpreamble << "\n<!ENTITY " << fi->first
511 << (IsSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
512 << MakeRelPath(fi->second, basename) << "\">";
514 return sgmlpreamble.str();
518 void LaTeXFeatures::showStruct() const {
519 lyxerr << "LyX needs the following commands when LaTeXing:"
520 << "\n***** Packages:" << getPackages()
521 << "\n***** Macros:" << getMacros()
522 << "\n***** Textclass stuff:" << getTClassPreamble()
523 << "\n***** done." << endl;
527 Buffer const & LaTeXFeatures::buffer() const
533 void LaTeXFeatures::setBuffer(Buffer const & buffer)
539 BufferParams const & LaTeXFeatures::bufferParams() const
545 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
547 FloatList const & floats = params_.getLyXTextClass().floats();
549 // Here we will output the code to create the needed float styles.
550 // We will try to do this as minimal as possible.
551 // \floatstyle{ruled}
552 // \newfloat{algorithm}{htbp}{loa}
553 // \floatname{algorithm}{Algorithm}
554 UsedFloats::const_iterator cit = usedFloats_.begin();
555 UsedFloats::const_iterator end = usedFloats_.end();
556 // ostringstream floats;
557 for (; cit != end; ++cit) {
558 Floating const & fl = floats.getType((*cit));
560 // For builtin floats we do nothing.
561 if (fl.builtin()) continue;
563 // We have to special case "table" and "figure"
564 if (fl.type() == "tabular" || fl.type() == "figure") {
565 // Output code to modify "table" or "figure"
566 // but only if builtin == false
567 // and that have to be true at this point in the
569 string const type = fl.type();
570 string const placement = fl.placement();
571 string const style = fl.style();
572 if (!style.empty()) {
573 os << "\\floatstyle{" << style << "}\n"
574 << "\\restylefloat{" << type << "}\n";
576 if (!placement.empty()) {
577 os << "\\floatplacement{" << type << "}{"
578 << placement << "}\n";
581 // The other non builtin floats.
583 string const type = fl.type();
584 string const placement = fl.placement();
585 string const ext = fl.ext();
586 string const within = fl.within();
587 string const style = fl.style();
588 string const name = fl.name();
589 os << "\\floatstyle{" << style << "}\n"
590 << "\\newfloat{" << type << "}{" << placement
591 << "}{" << ext << '}';
593 os << '[' << within << ']';
595 << "\\floatname{" << type << "}{"
598 // What missing here is to code to minimalize the code
599 // output so that the same floatstyle will not be
600 // used several times, when the same style is still in