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"
20 #include "bufferparams.h"
22 #include "FloatList.h"
25 #include "support/std_sstream.h"
27 #include "support/filetools.h"
29 using namespace lyx::support;
31 using lyx::textclass_type;
38 using std::ostringstream;
41 LaTeXFeatures::LaTeXFeatures(BufferParams const & p)
46 bool LaTeXFeatures::useBabel() const
48 return lyxrc.language_use_babel ||
49 bufferParams().language->lang() != lyxrc.default_language ||
54 void LaTeXFeatures::require(string const & name)
59 features.push_back(name);
63 void LaTeXFeatures::useLayout(string const & layoutname)
65 // Some code to avoid loops in dependency definition
67 const int maxlevel = 30;
68 if (level > maxlevel) {
69 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
70 << "recursion attained by layout "
71 << layoutname << endl;
75 LyXTextClass const & tclass = params.getLyXTextClass();
76 if (tclass.hasLayout(layoutname)) {
77 // Is this layout already in usedLayouts?
78 list<string>::const_iterator cit = usedLayouts.begin();
79 list<string>::const_iterator end = usedLayouts.end();
80 for (; cit != end; ++cit) {
81 if (layoutname == *cit)
85 LyXLayout_ptr const & lyt = tclass[layoutname];
86 if (!lyt->depends_on().empty()) {
88 useLayout(lyt->depends_on());
91 usedLayouts.push_back(layoutname);
93 lyxerr << "LaTeXFeatures::useLayout: layout `"
94 << layoutname << "' does not exist in this class"
102 bool LaTeXFeatures::isRequired(string const & name) const
104 return find(features.begin(), features.end(), name) != features.end();
108 void LaTeXFeatures::addExternalPreamble(string const & preamble)
110 FeaturesList::const_iterator begin = preamble_snippets.begin();
111 FeaturesList::const_iterator end = preamble_snippets.end();
112 if (find(begin, end, preamble) == end)
113 preamble_snippets.push_back(preamble);
117 void LaTeXFeatures::useFloat(string const & name)
119 usedFloats.insert(name);
120 // We only need float.sty if we use non builtin floats, or if we
121 // use the "H" modifier. This includes modified table and
122 // figure floats. (Lgb)
123 Floating const & fl = params.getLyXTextClass().floats().getType(name);
124 if (!fl.type().empty() && !fl.builtin()) {
130 void LaTeXFeatures::useLanguage(Language const * lang)
132 UsedLanguages.insert(lang);
136 void LaTeXFeatures::includeFile(string const & key, string const & name)
138 IncludedFiles[key] = name;
142 bool LaTeXFeatures::hasLanguages() const
144 return !UsedLanguages.empty();
148 string LaTeXFeatures::getLanguages() const
150 ostringstream languages;
152 for (LanguageList::const_iterator cit =
153 UsedLanguages.begin();
154 cit != UsedLanguages.end();
156 languages << (*cit)->babel() << ',';
158 return STRCONV(languages.str());
162 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
164 set<string> encodings;
165 for (LanguageList::const_iterator it =
166 UsedLanguages.begin();
167 it != UsedLanguages.end(); ++it)
168 if ((*it)->encoding()->LatexName() != doc_encoding)
169 encodings.insert((*it)->encoding()->LatexName());
175 char const * simplefeatures[] = {
191 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
196 string const LaTeXFeatures::getPackages() const
198 ostringstream packages;
199 LyXTextClass const & tclass = params.getLyXTextClass();
202 // These are all the 'simple' includes. i.e
203 // packages which we just \usepackage{package}
205 for (int i = 0; i < nb_simplefeatures; ++i) {
206 if (isRequired(simplefeatures[i]))
207 packages << "\\usepackage{"
208 << simplefeatures[i] << "}\n";
212 // The rest of these packages are somewhat more complicated
216 if (isRequired("amsmath")
217 && !tclass.provides(LyXTextClass::amsmath)
218 && params.use_amsmath != BufferParams::AMS_OFF) {
219 packages << "\\usepackage{amsmath}\n";
223 if (isRequired("color")) {
224 if (params.graphicsDriver == "default")
225 packages << "\\usepackage[usenames]{color}\n";
227 packages << "\\usepackage["
228 << params.graphicsDriver
234 if (isRequired("makeidx")) {
235 if (! tclass.provides(LyXTextClass::makeidx))
236 packages << "\\usepackage{makeidx}\n";
237 packages << "\\makeindex\n";
241 if (isRequired("graphicx") && params.graphicsDriver != "none") {
242 if (params.graphicsDriver == "default")
243 packages << "\\usepackage{graphicx}\n";
245 packages << "\\usepackage["
246 << params.graphicsDriver
251 // packages << "\\usepackage{algorithm}\n";
254 // lyxskak.sty --- newer chess support based on skak.sty
255 if (isRequired("chess")) {
256 packages << "\\usepackage[ps,mover]{lyxskak}\n";
260 if ((params.spacing.getSpace() != Spacing::Single
261 && !params.spacing.isDefault())
262 || isRequired("setspace")) {
263 packages << "\\usepackage{setspace}\n";
265 switch (params.spacing.getSpace()) {
266 case Spacing::Default:
267 case Spacing::Single:
268 // we dont use setspace.sty so dont print anything
269 //packages += "\\singlespacing\n";
271 case Spacing::Onehalf:
272 packages << "\\onehalfspacing\n";
274 case Spacing::Double:
275 packages << "\\doublespacing\n";
278 packages << "\\setstretch{"
279 << params.spacing.getValue() << "}\n";
284 if (isRequired("amssymb") || params.use_amsmath == BufferParams::AMS_ON)
285 packages << "\\usepackage{amssymb}\n";
287 if (isRequired("url") && ! tclass.provides(LyXTextClass::url))
288 packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
289 " {\\newcommand{\\url}{\\texttt}}\n";
293 if (isRequired("natbib") && ! tclass.provides(LyXTextClass::natbib)) {
294 packages << "\\usepackage[";
295 if (params.use_numerical_citations) {
296 packages << "numbers";
298 packages << "authoryear";
300 packages << "]{natbib}\n";
303 return STRCONV(packages.str());
307 string const LaTeXFeatures::getMacros() const
309 ostringstream macros;
311 if (!preamble_snippets.empty())
313 FeaturesList::const_iterator pit = preamble_snippets.begin();
314 FeaturesList::const_iterator pend = preamble_snippets.end();
315 for (; pit != pend; ++pit) {
316 macros << *pit << '\n';
319 if (isRequired("LyX"))
320 macros << lyx_def << '\n';
322 if (isRequired("lyxline"))
323 macros << lyxline_def << '\n';
325 if (isRequired("noun"))
326 macros << noun_def << '\n';
328 if (isRequired("lyxarrow"))
329 macros << lyxarrow_def << '\n';
332 if (isRequired("quotesinglbase"))
333 macros << quotesinglbase_def << '\n';
334 if (isRequired("quotedblbase"))
335 macros << quotedblbase_def << '\n';
336 if (isRequired("guilsinglleft"))
337 macros << guilsinglleft_def << '\n';
338 if (isRequired("guilsinglright"))
339 macros << guilsinglright_def << '\n';
340 if (isRequired("guillemotleft"))
341 macros << guillemotleft_def << '\n';
342 if (isRequired("guillemotright"))
343 macros << guillemotright_def << '\n';
346 if (isRequired("boldsymbol") && !isRequired("amsmath"))
347 macros << boldsymbol_def << '\n';
348 if (isRequired("binom") && !isRequired("amsmath"))
349 macros << binom_def << '\n';
350 if (isRequired("mathcircumflex"))
351 macros << mathcircumflex_def << '\n';
354 if (isRequired("NeedLyXMinipageIndent"))
355 macros << minipageindent_def;
356 if (isRequired("ParagraphLeftIndent"))
357 macros << paragraphleftindent_def;
358 if (isRequired("NeedLyXFootnoteCode"))
359 macros << floatingfootnote_def;
361 // some problems with tex->html converters
362 if (isRequired("NeedTabularnewline"))
363 macros << tabularnewline_def;
365 // greyedout environment (note inset)
366 if (isRequired("lyxgreyedout"))
367 macros << lyxgreyedout_def;
370 getFloatDefinitions(macros);
372 return STRCONV(macros.str());
376 string const LaTeXFeatures::getBabelOptions() const
380 for (LanguageList::const_iterator cit = UsedLanguages.begin();
381 cit != UsedLanguages.end(); ++cit)
382 if (!(*cit)->latex_options().empty())
383 tmp << (*cit)->latex_options() << '\n';
384 if (!params.language->latex_options().empty())
385 tmp << params.language->latex_options() << '\n';
387 return STRCONV(tmp.str());
391 string const LaTeXFeatures::getTClassPreamble() const
393 // the text class specific preamble
394 LyXTextClass const & tclass = params.getLyXTextClass();
395 ostringstream tcpreamble;
397 tcpreamble << tclass.preamble();
399 list<string>::const_iterator cit = usedLayouts.begin();
400 list<string>::const_iterator end = usedLayouts.end();
401 for (; cit != end; ++cit) {
402 tcpreamble << tclass[*cit]->preamble();
405 return STRCONV(tcpreamble.str());
409 string const LaTeXFeatures::getLyXSGMLEntities() const
411 // Definition of entities used in the document that are LyX related.
412 ostringstream entities;
414 if (isRequired("lyxarrow")) {
415 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
418 return STRCONV(entities.str());
422 string const LaTeXFeatures::getIncludedFiles(string const & fname) const
424 ostringstream sgmlpreamble;
425 string const basename = OnlyPath(fname);
427 FileMap::const_iterator end = IncludedFiles.end();
428 for (FileMap::const_iterator fi = IncludedFiles.begin();
430 sgmlpreamble << "\n<!ENTITY " << fi->first
431 << (IsSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
432 << MakeRelPath(fi->second, basename) << "\">";
434 return STRCONV(sgmlpreamble.str());
438 void LaTeXFeatures::showStruct() const {
439 lyxerr << "LyX needs the following commands when LaTeXing:"
440 << "\n***** Packages:" << getPackages()
441 << "\n***** Macros:" << getMacros()
442 << "\n***** Textclass stuff:" << getTClassPreamble()
443 << "\n***** done." << endl;
447 BufferParams const & LaTeXFeatures::bufferParams() const
453 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
455 FloatList const & floats = params.getLyXTextClass().floats();
457 // Here we will output the code to create the needed float styles.
458 // We will try to do this as minimal as possible.
459 // \floatstyle{ruled}
460 // \newfloat{algorithm}{htbp}{loa}
461 // \floatname{algorithm}{Algorithm}
462 UsedFloats::const_iterator cit = usedFloats.begin();
463 UsedFloats::const_iterator end = usedFloats.end();
464 // ostringstream floats;
465 for (; cit != end; ++cit) {
466 Floating const & fl = floats.getType((*cit));
468 // For builtin floats we do nothing.
469 if (fl.builtin()) continue;
471 // We have to special case "table" and "figure"
472 if (fl.type() == "tabular" || fl.type() == "figure") {
473 // Output code to modify "table" or "figure"
474 // but only if builtin == false
475 // and that have to be true at this point in the
477 string const type = fl.type();
478 string const placement = fl.placement();
479 string const style = fl.style();
480 if (!style.empty()) {
481 os << "\\floatstyle{" << style << "}\n"
482 << "\\restylefloat{" << type << "}\n";
484 if (!placement.empty()) {
485 os << "\\floatplacement{" << type << "}{"
486 << placement << "}\n";
489 // The other non builtin floats.
491 string const type = fl.type();
492 string const placement = fl.placement();
493 string const ext = fl.ext();
494 string const within = fl.within();
495 string const style = fl.style();
496 string const name = fl.name();
497 os << "\\floatstyle{" << style << "}\n"
498 << "\\newfloat{" << type << "}{" << placement
499 << "}{" << ext << '}';
501 os << '[' << within << ']';
503 << "\\floatname{" << type << "}{"
506 // What missing here is to code to minimalize the code
507 // output so that the same floatstyle will not be
508 // used several times, when the same style is still in