X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.C;h=46df0fec7c3b51ddfd857e97df6c106e4be37daa;hb=0da3d53269a49c66b24615d24e20e441dcf7c07e;hp=7174eb91c86d7566456b86ad3ce281ea3fe6bdc1;hpb=a0d71b53fea6dfb12489f937de0eb7218b0d20ea;p=lyx.git diff --git a/src/LaTeXFeatures.C b/src/LaTeXFeatures.C index 7174eb91c8..46df0fec7c 100644 --- a/src/LaTeXFeatures.C +++ b/src/LaTeXFeatures.C @@ -1,52 +1,109 @@ -/* This file is part of - * ====================================================== +/** + * \file LaTeXFeatures.C + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * LyX, The Document Processor + * \author José Matos + * \author Lars Gullik Bjønnes + * \author Jean-Marc Lasgouttes + * \author Jürgen Vigna + * \author André Pönitz * - * Copyright 1995 Matthias Ettrich - * Copyright 1995-2001 the LyX Team. - * - * ====================================================== */ + * Full author contact details are available in file CREDITS. + */ #include -#ifdef __GNUG__ -#pragma implementation -#endif - #include "LaTeXFeatures.h" -#include "debug.h" -#include "lyx_sty.h" -#include "lyxrc.h" + #include "bufferparams.h" +#include "Color.h" +#include "debug.h" +#include "encoding.h" +#include "Floating.h" #include "FloatList.h" +#include "LColor.h" #include "language.h" -#include "encoding.h" -#include "LString.h" +#include "lyxlex.h" +#include "lyx_sty.h" +#include "lyxrc.h" +#include "support/docstream.h" #include "support/filetools.h" -#include "support/lstrings.h" -using lyx::textclass_type; + +namespace lyx { + +using support::isSGMLFilename; +using support::libFileSearch; +using support::makeRelPath; +using support::onlyPath; using std::endl; -using std::list; -using std::set; using std::find; +using std::string; +using std::list; using std::ostream; +using std::ostringstream; +using std::set; + +LaTeXFeatures::PackagesList LaTeXFeatures::packages_; -LaTeXFeatures::LaTeXFeatures(BufferParams const & p) - : params(p) +LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p, + OutputParams const & r) + : buffer_(&b), params_(p), runparams_(r) {} +bool LaTeXFeatures::useBabel() const +{ + return lyxrc.language_use_babel || + bufferParams().language->lang() != lyxrc.default_language || + this->hasLanguages(); +} + + void LaTeXFeatures::require(string const & name) { if (isRequired(name)) return; - features.push_back(name); + features_.push_back(name); +} + + +void LaTeXFeatures::getAvailable() +{ + LyXLex lex(0, 0); + support::FileName const real_file = libFileSearch("", "packages.lst"); + + if (real_file.empty()) + return; + + lex.setFile(real_file); + + if (!lex.isOK()) + return; + + // Make sure that we are clean + packages_.clear(); + + bool finished = false; + // Parse config-file + while (lex.isOK() && !finished) { + switch (lex.lex()) { + case LyXLex::LEX_FEOF: + finished = true; + break; + default: + string const name = lex.getString(); + PackagesList::const_iterator begin = packages_.begin(); + PackagesList::const_iterator end = packages_.end(); + if (find(begin, end, name) == end) + packages_.push_back(name); + } + } } @@ -61,56 +118,64 @@ void LaTeXFeatures::useLayout(string const & layoutname) << layoutname << endl; return; } - - LyXTextClass tclass = params.getLyXTextClass(); + + LyXTextClass const & tclass = params_.getLyXTextClass(); if (tclass.hasLayout(layoutname)) { // Is this layout already in usedLayouts? - list::const_iterator cit = usedLayouts.begin(); - list::const_iterator end = usedLayouts.end(); + list::const_iterator cit = usedLayouts_.begin(); + list::const_iterator end = usedLayouts_.end(); for (; cit != end; ++cit) { if (layoutname == *cit) return; } - - LyXLayout_ptr lyt = tclass[layoutname]; + + LyXLayout_ptr const & lyt = tclass[layoutname]; if (!lyt->depends_on().empty()) { ++level; useLayout(lyt->depends_on()); --level; } - usedLayouts.push_back(layoutname); + usedLayouts_.push_back(layoutname); } else { lyxerr << "LaTeXFeatures::useLayout: layout `" << layoutname << "' does not exist in this class" - << endl; + << endl; } - + --level; } bool LaTeXFeatures::isRequired(string const & name) const { - FeaturesList::const_iterator i = find(features.begin(), - features.end(), - name); - return i != features.end(); + return find(features_.begin(), features_.end(), name) != features_.end(); +} + + +bool LaTeXFeatures::isAvailable(string const & name) const +{ + if (packages_.empty()) + getAvailable(); + return find(packages_.begin(), packages_.end(), name) != packages_.end(); } -void LaTeXFeatures::addExternalPreamble(string const & pream) +void LaTeXFeatures::addPreambleSnippet(string const & preamble) { - externalPreambles += pream; + 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); + 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); + Floating const & fl = params_.getLyXTextClass().floats().getType(name); if (!fl.type().empty() && !fl.builtin()) { require("float"); } @@ -119,19 +184,19 @@ void LaTeXFeatures::useFloat(string const & name) void LaTeXFeatures::useLanguage(Language const * lang) { - UsedLanguages.insert(lang); + UsedLanguages_.insert(lang); } -void LaTeXFeatures::includeFile(string const & key, string const & name) +void LaTeXFeatures::includeFile(docstring const & key, string const & name) { - IncludedFiles[key] = name; + IncludedFiles_[key] = name; } -bool LaTeXFeatures::hasLanguages() +bool LaTeXFeatures::hasLanguages() const { - return !UsedLanguages.empty(); + return !UsedLanguages_.empty(); } @@ -140,23 +205,26 @@ string LaTeXFeatures::getLanguages() const ostringstream languages; for (LanguageList::const_iterator cit = - UsedLanguages.begin(); - cit != UsedLanguages.end(); + UsedLanguages_.begin(); + cit != UsedLanguages_.end(); ++cit) languages << (*cit)->babel() << ','; - - return languages.str().c_str(); + return languages.str(); } -set LaTeXFeatures::getEncodingSet(string const & doc_encoding) +set LaTeXFeatures::getEncodingSet(string const & doc_encoding) const { set encodings; - for (LanguageList::const_iterator it = - UsedLanguages.begin(); - it != UsedLanguages.end(); ++it) - if ((*it)->encoding()->LatexName() != doc_encoding) - encodings.insert((*it)->encoding()->LatexName()); + LanguageList::const_iterator it = UsedLanguages_.begin(); + LanguageList::const_iterator end = UsedLanguages_.end(); + for (; it != end; ++it) + // thailatex does not use the inputenc package, but sets up + // babel directly for tis620-0 encoding, therefore we must + // not add tis620-0 to the encoding set. + if ((*it)->encoding()->latexName() != doc_encoding && + (*it)->encoding()->name() != "tis620-0") + encodings.insert((*it)->encoding()->latexName()); return encodings; } @@ -174,18 +242,25 @@ char const * simplefeatures[] = { "varioref", "prettyref", "float", - "wasy" + "booktabs", + "dvipost", + "fancybox", + "calc", + "nicefrac", + "tipa", + "framed", + "textcomp", }; -const int nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *); +int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *); } + string const LaTeXFeatures::getPackages() const { ostringstream packages; - LyXTextClass const & tclass = params.getLyXTextClass(); - + LyXTextClass const & tclass = params_.getLyXTextClass(); // // These are all the 'simple' includes. i.e @@ -194,7 +269,7 @@ string const LaTeXFeatures::getPackages() const for (int i = 0; i < nb_simplefeatures; ++i) { if (isRequired(simplefeatures[i])) packages << "\\usepackage{" - << simplefeatures[i] << "}\n"; + << simplefeatures[i] << "}\n"; } // @@ -203,36 +278,54 @@ string const LaTeXFeatures::getPackages() const // if (isRequired("amsmath") - && ! tclass.provides(LyXTextClass::amsmath)) { + && !tclass.provides(LyXTextClass::amsmath) + && params_.use_amsmath != BufferParams::package_off) { packages << "\\usepackage{amsmath}\n"; } + // wasysym is a simple feature, but it must be after amsmath if both + // are used + // wasysym redefines some integrals (e.g. iint) from amsmath. That + // leads to inconsistent integrals. We only load this package if + // esint is used, since esint redefines all relevant integral + // symbols from wasysym and amsmath. + // See http://bugzilla.lyx.org/show_bug.cgi?id=1942 + if (isRequired("wasysym") && isRequired("esint") && + params_.use_esint != BufferParams::package_off) + packages << "\\usepackage{wasysym}\n"; + // color.sty if (isRequired("color")) { - if (params.graphicsDriver == "default") + if (params_.graphicsDriver == "default") packages << "\\usepackage{color}\n"; else packages << "\\usepackage[" - << params.graphicsDriver + << params_.graphicsDriver << "]{color}\n"; } // makeidx.sty if (isRequired("makeidx")) { - if (! tclass.provides(LyXTextClass::makeidx)) + if (!tclass.provides(LyXTextClass::makeidx)) packages << "\\usepackage{makeidx}\n"; packages << "\\makeindex\n"; } // graphicx.sty - if (isRequired("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 + << params_.graphicsDriver << "]{graphicx}\n"; } + // shadecolor for shaded + if (isRequired("framed")) { + RGBColor c = RGBColor(lcolor.getX11Name(LColor::shadedbg)); + packages << "\\definecolor{shadecolor}{rgb}{" + << c.r/255 << ',' << c.g/255 << ',' << c.b/255 << "}\n"; + } //if (algorithm) { // packages << "\\usepackage{algorithm}\n"; @@ -244,12 +337,12 @@ string const LaTeXFeatures::getPackages() const } // setspace.sty - if ((params.spacing.getSpace() != Spacing::Single - && !params.spacing.isDefault()) + 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 @@ -263,13 +356,19 @@ string const LaTeXFeatures::getPackages() const break; case Spacing::Other: packages << "\\setstretch{" - << params.spacing.getValue() << "}\n"; + << params_.spacing().getValue() << "}\n"; break; } // amssymb.sty - if (isRequired("amssymb") || params.use_amsmath) + if (isRequired("amssymb") || params_.use_amsmath == BufferParams::package_on) packages << "\\usepackage{amssymb}\n"; + + // esint must be after amsmath and wasysym, since it will redeclare + // inconsistent integral symbols + if (isRequired("esint") && params_.use_esint != BufferParams::package_off) + packages << "\\usepackage{esint}\n"; + // url.sty if (isRequired("url") && ! tclass.provides(LyXTextClass::url)) packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n" @@ -279,7 +378,7 @@ string const LaTeXFeatures::getPackages() const // natbib.sty 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"; @@ -287,9 +386,26 @@ string const LaTeXFeatures::getPackages() const packages << "]{natbib}\n"; } - packages << externalPreambles; + // jurabib -- we need version 0.6 at least. + if (isRequired("jurabib")) { + packages << "\\usepackage{jurabib}[2004/01/25]\n"; + } - return packages.str().c_str(); + // bibtopic -- the dot provides the aux file naming which + // LyX can detect. + if (isRequired("bibtopic")) { + packages << "\\usepackage[dot]{bibtopic}\n"; + } + + if (isRequired("xy")) + packages << "\\usepackage[all]{xy}\n"; + + if (isRequired("nomencl")) { + packages << "\\usepackage{nomencl}[2005/09/22]\n" + << "\\makenomenclature\n"; + } + + return packages.str(); } @@ -297,6 +413,14 @@ string const LaTeXFeatures::getMacros() const { ostringstream macros; + 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'; @@ -332,17 +456,26 @@ string const LaTeXFeatures::getMacros() const macros << mathcircumflex_def << '\n'; // other - if (isRequired("NeedLyXMinipageIndent")) - macros << minipageindent_def; 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); - return macros.str().c_str(); + return macros.str(); } @@ -350,61 +483,69 @@ string const LaTeXFeatures::getBabelOptions() const { ostringstream tmp; - for (LanguageList::const_iterator cit = UsedLanguages.begin(); - cit != UsedLanguages.end(); ++cit) - if (!(*cit)->latex_options().empty()) - tmp << (*cit)->latex_options() << '\n'; - if (!params.language->latex_options().empty()) - tmp << params.language->latex_options() << '\n'; + 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 tmp.str().c_str(); + return tmp.str(); } -string const LaTeXFeatures::getTClassPreamble() const +docstring const LaTeXFeatures::getTClassPreamble() const { // the text class specific preamble - LyXTextClass const & tclass = params.getLyXTextClass(); - ostringstream tcpreamble; + LyXTextClass const & tclass = params_.getLyXTextClass(); + odocstringstream tcpreamble; tcpreamble << tclass.preamble(); - list::const_iterator cit = usedLayouts.begin(); - list::const_iterator end = usedLayouts.end(); + list::const_iterator cit = usedLayouts_.begin(); + list::const_iterator end = usedLayouts_.end(); for (; cit != end; ++cit) { tcpreamble << tclass[*cit]->preamble(); } - return tcpreamble.str().c_str(); + 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 +docstring const LaTeXFeatures::getLyXSGMLEntities() const { // Definition of entities used in the document that are LyX related. - ostringstream entities; + odocstringstream entities; if (isRequired("lyxarrow")) { entities << "" << '\n'; } - return entities.str().c_str(); + return entities.str(); } -string const LaTeXFeatures::getIncludedFiles(string const & fname) const +docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const { - ostringstream sgmlpreamble; - string const basename = OnlyPath(fname); + odocstringstream 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 << "\nfirst - << (IsSGMLFilename(fi->second) ? " SYSTEM \"" : " \"") - << MakeRelPath(fi->second, basename) << "\">"; + << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"") + << from_ascii(makeRelPath(fi->second, basename)) << "\">"; - return sgmlpreamble.str().c_str(); + return sgmlpreamble.str(); } @@ -412,28 +553,40 @@ void LaTeXFeatures::showStruct() const { lyxerr << "LyX needs the following commands when LaTeXing:" << "\n***** Packages:" << getPackages() << "\n***** Macros:" << getMacros() - << "\n***** Textclass stuff:" << getTClassPreamble() + << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble()) << "\n***** done." << endl; } +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(ostream & os) const { - FloatList const & floats = params.getLyXTextClass().floats(); - + 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 = floats.getType((*cit)); @@ -469,10 +622,10 @@ void LaTeXFeatures::getFloatDefinitions(ostream & os) const 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"; @@ -483,3 +636,6 @@ void LaTeXFeatures::getFloatDefinitions(ostream & os) const } } } + + +} // namespace lyx