-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 the LyX Team.
+/**
+ * \file LaTeXFeatures.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * ====================================================== */
+ * \author José Matos
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author Jürgen Vigna
+ * \author André Pönitz
+ *
+ * Full author contact details are available in file CREDITS.
+ */
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation "LaTeXFeatures.h"
-#endif
+#include "LaTeXFeatures.h"
-#include "LString.h"
+#include "bufferparams.h"
#include "debug.h"
+#include "encoding.h"
+#include "Floating.h"
+#include "FloatList.h"
+#include "language.h"
#include "lyx_sty.h"
#include "lyxrc.h"
-#include "LaTeXFeatures.h"
-#include "bufferparams.h"
-#include "layout.h"
+
#include "support/filetools.h"
-#include "support/lstrings.h"
-#include "FloatList.h"
-#include "language.h"
+
+#include <sstream>
+
+using lyx::support::IsSGMLFilename;
+using lyx::support::MakeRelPath;
+using lyx::support::OnlyPath;
using std::endl;
+using std::find;
+using std::string;
+using std::list;
+using std::ostream;
+using std::ostringstream;
+using std::set;
-LaTeXFeatures::LaTeXFeatures(BufferParams const & p, LyXTextClass::size_type n)
- : layout(n, false), params(p)
-{
- // packages
- array = false;
- color = false;
- graphics = false; // INSET_GRAPHICS: remove this when InsetFig is thrown.
- graphicx = false;
- setspace = false;
- makeidx = false;
- verbatim = false;
- longtable = false;
- //algorithm = false;
- rotating = false;
- amssymb = false;
- latexsym = false;
- pifont = false;
- subfigure = false;
- floatflt = false;
- url = false;
- varioref = false;
- prettyref = false;
- chess = false;
- natbib = false;
-
- // commands
- lyx = false;
- lyxline = false;
- noun = false;
- lyxarrow = false;
-
- // quotes
- quotesinglbase = false;
- quotedblbase = false;
- guilsinglleft = false;
- guilsinglright = false;
- guillemotleft = false;
- guillemotright = false;
+namespace biblio = lyx::biblio;
- // Math mode
- amsstyle = false;
- binom = false;
- boldsymbol = false;
-
- // special features
- ParagraphIndent = false;
- NeedLyXFootnoteCode = false;
- NeedLyXMinipageIndent = false;
+
+LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p, bool n)
+ : buffer_(&b), params_(p), nice_(n)
+{}
+
+
+bool LaTeXFeatures::useBabel() const
+{
+ return lyxrc.language_use_babel ||
+ bufferParams().language->lang() != lyxrc.default_language ||
+ this->hasLanguages();
}
void LaTeXFeatures::require(string const & name)
{
- if (name == "array") {
- array = true;
- } else if (name == "color") {
- color = true;
- } else if (name == "graphics") {
- graphicx = true;
- graphics = true;// INSET_GRAPHICS: remove this when InsetFig is thrown.
- } else if (name == "setspace") {
- setspace = true;
- } else if (name == "makeidx") {
- makeidx = true;
- } else if (name == "verbatim") {
- verbatim = true;
- } else if (name == "longtable") {
- longtable = true;
- //} else if (name == "algorithm") {
- //algorithm = true;
- } else if (name == "rotating") {
- rotating = true;
- } else if (name == "amssymb") {
- amssymb = true;
- } else if (name == "latexsym") {
- latexsym = true;
- } else if (name == "pifont") {
- pifont = true;
- } else if (name == "subfigure") {
- subfigure = true;
- } else if (name == "floatflt") {
- floatflt = true;
- } else if (name == "url") {
- url = true;
- } else if (name == "varioref") {
- varioref = true;
- } else if (name == "prettyref") {
- prettyref = true;
- } else if (name == "chess") {
- chess = true;
- } else if (name == "amsstyle") {
- amsstyle = true;
- } else if (name == "boldsymbol") {
- boldsymbol = true;
- } else if (name == "binom") {
- binom = true;
- } else if (name == "natbib") {
- natbib = true;
+ if (isRequired(name))
+ return;
+
+ features_.push_back(name);
+}
+
+
+void LaTeXFeatures::useLayout(string const & layoutname)
+{
+ // Some code to avoid loops in dependency definition
+ static int level = 0;
+ const int maxlevel = 30;
+ if (level > maxlevel) {
+ lyxerr << "LaTeXFeatures::useLayout: maximum level of "
+ << "recursion attained by layout "
+ << layoutname << endl;
+ return;
+ }
+
+ LyXTextClass const & tclass = params_.getLyXTextClass();
+ if (tclass.hasLayout(layoutname)) {
+ // Is this layout already in usedLayouts?
+ list<string>::const_iterator cit = usedLayouts_.begin();
+ list<string>::const_iterator end = usedLayouts_.end();
+ for (; cit != end; ++cit) {
+ if (layoutname == *cit)
+ return;
+ }
+
+ LyXLayout_ptr const & lyt = tclass[layoutname];
+ if (!lyt->depends_on().empty()) {
+ ++level;
+ useLayout(lyt->depends_on());
+ --level;
+ }
+ usedLayouts_.push_back(layoutname);
+ } else {
+ lyxerr << "LaTeXFeatures::useLayout: layout `"
+ << layoutname << "' does not exist in this class"
+ << endl;
}
+
+ --level;
+}
+
+
+bool LaTeXFeatures::isRequired(string const & name) const
+{
+ return find(features_.begin(), features_.end(), name) != features_.end();
+}
+
+
+void LaTeXFeatures::addExternalPreamble(string const & preamble)
+{
+ FeaturesList::const_iterator begin = preamble_snippets_.begin();
+ FeaturesList::const_iterator end = preamble_snippets_.end();
+ if (find(begin, end, preamble) == end)
+ preamble_snippets_.push_back(preamble);
+}
+
+
+void LaTeXFeatures::useFloat(string const & name)
+{
+ usedFloats_.insert(name);
+ // We only need float.sty if we use non builtin floats, or if we
+ // use the "H" modifier. This includes modified table and
+ // figure floats. (Lgb)
+ Floating const & fl = params_.getLyXTextClass().floats().getType(name);
+ if (!fl.type().empty() && !fl.builtin()) {
+ require("float");
+ }
+}
+
+
+void LaTeXFeatures::useLanguage(Language const * lang)
+{
+ UsedLanguages_.insert(lang);
+}
+
+
+void LaTeXFeatures::includeFile(string const & key, string const & name)
+{
+ IncludedFiles_[key] = name;
+}
+
+
+bool LaTeXFeatures::hasLanguages() const
+{
+ return !UsedLanguages_.empty();
+}
+
+
+string LaTeXFeatures::getLanguages() const
+{
+ ostringstream languages;
+
+ for (LanguageList::const_iterator cit =
+ UsedLanguages_.begin();
+ cit != UsedLanguages_.end();
+ ++cit)
+ languages << (*cit)->babel() << ',';
+ return languages.str();
+}
+
+
+set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
+{
+ set<string> encodings;
+ LanguageList::const_iterator it = UsedLanguages_.begin();
+ LanguageList::const_iterator end = UsedLanguages_.end();
+ for (; it != end; ++it)
+ if ((*it)->encoding()->LatexName() != doc_encoding)
+ encodings.insert((*it)->encoding()->LatexName());
+ return encodings;
+}
+
+namespace {
+
+char const * simplefeatures[] = {
+ "array",
+ "verbatim",
+ "longtable",
+ "rotating",
+ "latexsym",
+ "pifont",
+ "subfigure",
+ "floatflt",
+ "varioref",
+ "prettyref",
+ "float",
+ "wasysym",
+ "dvipost",
+ "fancybox",
+ "calc",
+};
+
+int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
+
}
string const LaTeXFeatures::getPackages() const
{
ostringstream packages;
- LyXTextClass const & tclass =
- textclasslist.TextClass(params.textclass);
+ LyXTextClass const & tclass = params_.getLyXTextClass();
+
+ //
+ // These are all the 'simple' includes. i.e
+ // packages which we just \usepackage{package}
+ //
+ for (int i = 0; i < nb_simplefeatures; ++i) {
+ if (isRequired(simplefeatures[i]))
+ packages << "\\usepackage{"
+ << simplefeatures[i] << "}\n";
+ }
+
+ //
+ // The rest of these packages are somewhat more complicated
+ // than those above.
+ //
- // array-package
- if (array)
- packages << "\\usepackage{array}\n";
+ if (isRequired("amsmath")
+ && !tclass.provides(LyXTextClass::amsmath)
+ && params_.use_amsmath != BufferParams::AMS_OFF) {
+ packages << "\\usepackage{amsmath}\n";
+ }
// color.sty
- if (color) {
- if (params.graphicsDriver == "default")
- packages << "\\usepackage{color}\n";
+ if (isRequired("color")) {
+ if (params_.graphicsDriver == "default")
+ packages << "\\usepackage[usenames]{color}\n";
else
- packages << "\\usepackage["
- << params.graphicsDriver
+ packages << "\\usepackage["
+ << params_.graphicsDriver
+ << ",usenames"
<< "]{color}\n";
}
-
+
// makeidx.sty
- if (makeidx) {
- if (! tclass.provides(LyXTextClass::makeidx)
- && params.language->babel() != "french") // french provides
- // \index !
- // French should not be hardcoded. (Lgb)
+ if (isRequired("makeidx")) {
+ if (! tclass.provides(LyXTextClass::makeidx))
packages << "\\usepackage{makeidx}\n";
packages << "\\makeindex\n";
}
// graphicx.sty
- if (graphicx && params.graphicsDriver != "none") {
- if (params.graphicsDriver == "default")
+ if (isRequired("graphicx") && params_.graphicsDriver != "none") {
+ if (params_.graphicsDriver == "default")
packages << "\\usepackage{graphicx}\n";
else
- packages << "\\usepackage["
- << params.graphicsDriver
+ packages << "\\usepackage["
+ << params_.graphicsDriver
<< "]{graphicx}\n";
}
- // INSET_GRAPHICS: remove this when InsetFig is thrown.
- // graphics.sty
- if (graphics && params.graphicsDriver != "none") {
- if (params.graphicsDriver == "default")
- packages << "\\usepackage{graphics}\n";
- else
- packages << "\\usepackage["
- << params.graphicsDriver
- << "]{graphics}\n";
- }
-
- // verbatim.sty
- if (verbatim)
- packages << "\\usepackage{verbatim}\n";
-
//if (algorithm) {
// packages << "\\usepackage{algorithm}\n";
//}
- // lyxchess.sty
- if (chess) {
- packages << "\\usepackage{lyxchess}\n";
+ // lyxskak.sty --- newer chess support based on skak.sty
+ if (isRequired("chess")) {
+ packages << "\\usepackage[ps,mover]{lyxskak}\n";
}
// setspace.sty
- if ((params.spacing.getSpace() != Spacing::Single
- && !params.spacing.isDefault())
- || setspace) {
+ if ((params_.spacing().getSpace() != Spacing::Single
+ && !params_.spacing().isDefault())
+ || isRequired("setspace")) {
packages << "\\usepackage{setspace}\n";
}
- switch (params.spacing.getSpace()) {
+ switch (params_.spacing().getSpace()) {
case Spacing::Default:
case Spacing::Single:
// we dont use setspace.sty so dont print anything
break;
case Spacing::Other:
packages << "\\setstretch{"
- << params.spacing.getValue() << "}\n";
+ << params_.spacing().getValue() << "}\n";
break;
}
- //longtable.sty
- if (longtable)
- packages << "\\usepackage{longtable}\n";
-
- //rotating.sty
- if (rotating)
- packages << "\\usepackage{rotating}\n";
-
// amssymb.sty
- if (amssymb || params.use_amsmath)
+ if (isRequired("amssymb") || params_.use_amsmath == BufferParams::AMS_ON)
packages << "\\usepackage{amssymb}\n";
-
- // latexsym.sty
- if (latexsym)
- packages << "\\usepackage{latexsym}\n";
-
- // pifont.sty
- if (pifont)
- packages << "\\usepackage{pifont}\n";
-
- // subfigure.sty
- if (subfigure)
- packages << "\\usepackage{subfigure}\n";
-
- // floatflt.sty
- if (floatflt)
- packages << "\\usepackage{floatflt}\n";
-
// url.sty
- if (url && ! tclass.provides(LyXTextClass::url))
+ if (isRequired("url") && ! tclass.provides(LyXTextClass::url))
packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
" {\\newcommand{\\url}{\\texttt}}\n";
- // varioref.sty
- if (varioref)
- packages << "\\usepackage{varioref}\n";
-
- // prettyref.sty
- if (prettyref)
- packages << "\\usepackage{prettyref}\n";
-
// float.sty
- // We only need float.sty if we use non builtin floats. This includes
- // modified table and figure floats. (Lgb)
- if (!usedFloats.empty()) {
- bool use_float = false;
- UsedFloats::const_iterator beg = usedFloats.begin();
- UsedFloats::const_iterator end = usedFloats.end();
- for (; beg != end; ++beg) {
- Floating const & fl = floatList.getType((*beg));
- if (!fl.type().empty() && !fl.builtin()) {
- use_float = true;
- break;
- }
- }
- if (use_float)
- packages << "\\usepackage{float}\n";
- }
-
// natbib.sty
- if (natbib) {
+ if (isRequired("natbib") && ! tclass.provides(LyXTextClass::natbib)) {
packages << "\\usepackage[";
- if (params.use_numerical_citations) {
+ if (params_.cite_engine == biblio::ENGINE_NATBIB_NUMERICAL) {
packages << "numbers";
} else {
packages << "authoryear";
}
packages << "]{natbib}\n";
}
-
- packages << externalPreambles;
- return packages.str().c_str();
+ // jurabib -- we need version 0.6 at least.
+ if (isRequired("jurabib")) {
+ packages << "\\usepackage{jurabib}[2004/01/25]\n";
+ }
+
+ // bibtopic -- the dot provides the aux file naming which
+ // LyX can detect.
+ if (isRequired("bibtopic")) {
+ packages << "\\usepackage[dot]{bibtopic}\n";
+ }
+
+ return packages.str();
}
{
ostringstream macros;
- // always include this
- if (true || lyx)
+ if (!preamble_snippets_.empty())
+ macros << '\n';
+ FeaturesList::const_iterator pit = preamble_snippets_.begin();
+ FeaturesList::const_iterator pend = preamble_snippets_.end();
+ for (; pit != pend; ++pit) {
+ macros << *pit << '\n';
+ }
+
+ if (isRequired("LyX"))
macros << lyx_def << '\n';
- if (lyxline)
+ if (isRequired("lyxline"))
macros << lyxline_def << '\n';
- if (noun) {
+ if (isRequired("noun"))
macros << noun_def << '\n';
- }
- if (lyxarrow) {
+ if (isRequired("lyxarrow"))
macros << lyxarrow_def << '\n';
- }
- // quotes.
- if (quotesinglbase)
+ // quotes.
+ if (isRequired("quotesinglbase"))
macros << quotesinglbase_def << '\n';
- if (quotedblbase)
+ if (isRequired("quotedblbase"))
macros << quotedblbase_def << '\n';
- if (guilsinglleft)
+ if (isRequired("guilsinglleft"))
macros << guilsinglleft_def << '\n';
- if (guilsinglright)
+ if (isRequired("guilsinglright"))
macros << guilsinglright_def << '\n';
- if (guillemotleft)
+ if (isRequired("guillemotleft"))
macros << guillemotleft_def << '\n';
- if (guillemotright)
+ if (isRequired("guillemotright"))
macros << guillemotright_def << '\n';
-
- // Math mode
- if (boldsymbol && !amsstyle)
+
+ // Math mode
+ if (isRequired("boldsymbol") && !isRequired("amsmath"))
macros << boldsymbol_def << '\n';
- if (binom && !amsstyle)
+ if (isRequired("binom") && !isRequired("amsmath"))
macros << binom_def << '\n';
+ if (isRequired("mathcircumflex"))
+ macros << mathcircumflex_def << '\n';
// other
- if (NeedLyXMinipageIndent)
- macros << minipageindent_def;
- if (ParagraphIndent)
- macros << paragraphindent_def;
- if (NeedLyXFootnoteCode)
+ if (isRequired("ParagraphLeftIndent"))
+ macros << paragraphleftindent_def;
+ if (isRequired("NeedLyXFootnoteCode"))
macros << floatingfootnote_def;
+ // some problems with tex->html converters
+ if (isRequired("NeedTabularnewline"))
+ macros << tabularnewline_def;
+
+ // greyedout environment (note inset)
+ if (isRequired("lyxgreyedout"))
+ macros << lyxgreyedout_def;
+
+ if (isRequired("lyxdot"))
+ macros << lyxdot_def << '\n';
+
// floats
getFloatDefinitions(macros);
- for (LanguageList::const_iterator cit = UsedLanguages.begin();
- cit != UsedLanguages.end(); ++cit)
- if (!(*cit)->latex_options().empty())
- macros << (*cit)->latex_options() << '\n';
- if (!params.language->latex_options().empty())
- macros << params.language->latex_options() << '\n';
+ return macros.str();
+}
+
+
+string const LaTeXFeatures::getBabelOptions() const
+{
+ ostringstream tmp;
+
+ LanguageList::const_iterator it = UsedLanguages_.begin();
+ LanguageList::const_iterator end = UsedLanguages_.end();
+ for (; it != end; ++it)
+ if (!(*it)->latex_options().empty())
+ tmp << (*it)->latex_options() << '\n';
+ if (!params_.language->latex_options().empty())
+ tmp << params_.language->latex_options() << '\n';
- return macros.str().c_str();
+ return tmp.str();
}
string const LaTeXFeatures::getTClassPreamble() const
{
- // the text class specific preamble
- LyXTextClass const & tclass =
- textclasslist.TextClass(params.textclass);
+ // the text class specific preamble
+ LyXTextClass const & tclass = params_.getLyXTextClass();
ostringstream tcpreamble;
-
+
tcpreamble << tclass.preamble();
- for (unsigned int i = 0; i < tclass.numLayouts(); ++i) {
- if (layout[i]) {
- tcpreamble << tclass[i].preamble();
- }
+ list<string>::const_iterator cit = usedLayouts_.begin();
+ list<string>::const_iterator end = usedLayouts_.end();
+ for (; cit != end; ++cit) {
+ tcpreamble << tclass[*cit]->preamble();
+ }
+
+ CharStyles::iterator cs = tclass.charstyles().begin();
+ CharStyles::iterator csend = tclass.charstyles().end();
+ for (; cs != csend; ++cs) {
+ if (isRequired(cs->name))
+ tcpreamble << cs->preamble;
+ }
+
+ return tcpreamble.str();
+}
+
+
+string const LaTeXFeatures::getLyXSGMLEntities() const
+{
+ // Definition of entities used in the document that are LyX related.
+ ostringstream entities;
+
+ if (isRequired("lyxarrow")) {
+ entities << "<!ENTITY lyxarrow \"->\">" << '\n';
}
- return tcpreamble.str().c_str();
-}
+ return entities.str();
+}
string const LaTeXFeatures::getIncludedFiles(string const & fname) const
ostringstream sgmlpreamble;
string const basename = OnlyPath(fname);
- FileMap::const_iterator end = IncludedFiles.end();
- for (FileMap::const_iterator fi = IncludedFiles.begin();
+ FileMap::const_iterator end = IncludedFiles_.end();
+ for (FileMap::const_iterator fi = IncludedFiles_.begin();
fi != end; ++fi)
sgmlpreamble << "\n<!ENTITY " << fi->first
- << (IsSGMLFilename(fi->second) ? " SYSTEM \"" : " \"" )
+ << (IsSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
<< MakeRelPath(fi->second, basename) << "\">";
- return sgmlpreamble.str().c_str();
+ return sgmlpreamble.str();
}
}
+Buffer const & LaTeXFeatures::buffer() const
+{
+ return *buffer_;
+}
+
+
+void LaTeXFeatures::setBuffer(Buffer const & buffer)
+{
+ buffer_ = &buffer;
+}
+
+
BufferParams const & LaTeXFeatures::bufferParams() const
{
- return params;
+ return params_;
}
-void LaTeXFeatures::getFloatDefinitions(std::ostream & os) const
+void LaTeXFeatures::getFloatDefinitions(ostream & os) const
{
+ FloatList const & floats = params_.getLyXTextClass().floats();
+
// Here we will output the code to create the needed float styles.
// We will try to do this as minimal as possible.
// \floatstyle{ruled}
// \newfloat{algorithm}{htbp}{loa}
// \floatname{algorithm}{Algorithm}
- UsedFloats::const_iterator cit = usedFloats.begin();
- UsedFloats::const_iterator end = usedFloats.end();
+ UsedFloats::const_iterator cit = usedFloats_.begin();
+ UsedFloats::const_iterator end = usedFloats_.end();
// ostringstream floats;
for (; cit != end; ++cit) {
- Floating const & fl = floatList.getType((*cit));
-
+ Floating const & fl = floats.getType((*cit));
+
// For builtin floats we do nothing.
if (fl.builtin()) continue;
-
+
// We have to special case "table" and "figure"
if (fl.type() == "tabular" || fl.type() == "figure") {
// Output code to modify "table" or "figure"
}
} else {
// The other non builtin floats.
-
+
string const type = fl.type();
string const placement = fl.placement();
string const ext = fl.ext();
string const name = fl.name();
os << "\\floatstyle{" << style << "}\n"
<< "\\newfloat{" << type << "}{" << placement
- << "}{" << ext << "}";
+ << "}{" << ext << '}';
if (!within.empty())
- os << "[" << within << "]";
- os << "\n"
+ os << '[' << within << ']';
+ os << '\n'
<< "\\floatname{" << type << "}{"
<< name << "}\n";
-
+
// What missing here is to code to minimalize the code
- // outputted so that the same flotastyle will not be
- // used several times. when the same style is still in
+ // output so that the same floatstyle will not be
+ // used several times, when the same style is still in
// effect. (Lgb)
}
}