mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-11 21:49:51 +00:00
477a4da1a2
* src/LaTeXFeatures.C (LaTeXFeatures::getPackages): Do not require newest nomencl.sty, output compatibility code instead * src/LaTeX.C (LaTeX::deleteFilesOnError): delete .gls file (LaTeX::run): Check .glo and .gls files, too (handleFoundFile): do not ignore .glo files (LaTeX::deplog): add regex for old nomencl version * src/LaTeX.[Ch] (LaTeX::runMakeIndexNomencl) new method, factored out to avoid code duplication git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@17923 a592a061-630c-0410-9148-cb99ea01b6c8
653 lines
16 KiB
C
653 lines
16 KiB
C
/**
|
|
* \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>
|
|
|
|
#include "LaTeXFeatures.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 "lyxlex.h"
|
|
#include "lyx_sty.h"
|
|
#include "lyxrc.h"
|
|
|
|
#include "support/docstream.h"
|
|
#include "support/filetools.h"
|
|
|
|
#include "frontends/controllers/biblio.h"
|
|
|
|
namespace lyx {
|
|
|
|
using support::isSGMLFilename;
|
|
using support::libFileSearch;
|
|
using support::makeRelPath;
|
|
using support::onlyPath;
|
|
|
|
using std::endl;
|
|
using std::find;
|
|
using std::string;
|
|
using std::list;
|
|
using std::ostream;
|
|
using std::ostringstream;
|
|
using std::set;
|
|
|
|
LaTeXFeatures::PackagesList LaTeXFeatures::packages_;
|
|
|
|
|
|
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);
|
|
}
|
|
|
|
|
|
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);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
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();
|
|
}
|
|
|
|
|
|
bool LaTeXFeatures::mustProvide(string const & name) const
|
|
{
|
|
return isRequired(name) && !params_.getLyXTextClass().provides(name);
|
|
}
|
|
|
|
|
|
bool LaTeXFeatures::isAvailable(string const & name)
|
|
{
|
|
if (packages_.empty())
|
|
getAvailable();
|
|
return find(packages_.begin(), packages_.end(), name) != packages_.end();
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::addPreambleSnippet(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(docstring 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)
|
|
// 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;
|
|
}
|
|
|
|
namespace {
|
|
|
|
char const * simplefeatures[] = {
|
|
"array",
|
|
"verbatim",
|
|
"longtable",
|
|
"rotating",
|
|
"latexsym",
|
|
"pifont",
|
|
"subfigure",
|
|
"floatflt",
|
|
"varioref",
|
|
"prettyref",
|
|
"float",
|
|
"booktabs",
|
|
"dvipost",
|
|
"fancybox",
|
|
"calc",
|
|
"nicefrac",
|
|
"tipa",
|
|
"framed",
|
|
"textcomp",
|
|
};
|
|
|
|
int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
|
|
|
|
}
|
|
|
|
|
|
string const LaTeXFeatures::getPackages() const
|
|
{
|
|
ostringstream packages;
|
|
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 (mustProvide(simplefeatures[i]))
|
|
packages << "\\usepackage{"
|
|
<< simplefeatures[i] << "}\n";
|
|
}
|
|
|
|
//
|
|
// The rest of these packages are somewhat more complicated
|
|
// than those above.
|
|
//
|
|
|
|
if (mustProvide("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 (mustProvide("wasysym") && isRequired("esint") &&
|
|
params_.use_esint != BufferParams::package_off)
|
|
packages << "\\usepackage{wasysym}\n";
|
|
|
|
// color.sty
|
|
if (mustProvide("color")) {
|
|
if (params_.graphicsDriver == "default")
|
|
packages << "\\usepackage{color}\n";
|
|
else
|
|
packages << "\\usepackage["
|
|
<< params_.graphicsDriver
|
|
<< "]{color}\n";
|
|
}
|
|
|
|
// makeidx.sty
|
|
if (isRequired("makeidx")) {
|
|
if (!tclass.provides("makeidx"))
|
|
packages << "\\usepackage{makeidx}\n";
|
|
packages << "\\makeindex\n";
|
|
}
|
|
|
|
// graphicx.sty
|
|
if (mustProvide("graphicx") && params_.graphicsDriver != "none") {
|
|
if (params_.graphicsDriver == "default")
|
|
packages << "\\usepackage{graphicx}\n";
|
|
else
|
|
packages << "\\usepackage["
|
|
<< params_.graphicsDriver
|
|
<< "]{graphicx}\n";
|
|
}
|
|
// shadecolor for shaded
|
|
if (mustProvide("framed")) {
|
|
RGBColor c = RGBColor(lcolor.getX11Name(LColor::shadedbg));
|
|
packages << "\\definecolor{shadecolor}{rgb}{"
|
|
<< c.r/255 << ',' << c.g/255 << ',' << c.b/255 << "}\n";
|
|
}
|
|
|
|
// lyxskak.sty --- newer chess support based on skak.sty
|
|
if (mustProvide("chess")) {
|
|
packages << "\\usepackage[ps,mover]{lyxskak}\n";
|
|
}
|
|
|
|
// setspace.sty
|
|
if ((params_.spacing().getSpace() != Spacing::Single
|
|
&& !params_.spacing().isDefault())
|
|
|| isRequired("setspace")) {
|
|
packages << "\\usepackage{setspace}\n";
|
|
}
|
|
switch (params_.spacing().getSpace()) {
|
|
case Spacing::Default:
|
|
case Spacing::Single:
|
|
// we dont use setspace.sty so dont print anything
|
|
//packages += "\\singlespacing\n";
|
|
break;
|
|
case Spacing::Onehalf:
|
|
packages << "\\onehalfspacing\n";
|
|
break;
|
|
case Spacing::Double:
|
|
packages << "\\doublespacing\n";
|
|
break;
|
|
case Spacing::Other:
|
|
packages << "\\setstretch{"
|
|
<< params_.spacing().getValue() << "}\n";
|
|
break;
|
|
}
|
|
|
|
// amssymb.sty
|
|
if (mustProvide("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 (mustProvide("esint")
|
|
&& params_.use_esint != BufferParams::package_off)
|
|
packages << "\\usepackage{esint}\n";
|
|
|
|
// url.sty
|
|
if (mustProvide("url"))
|
|
packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
|
|
" {\\newcommand{\\url}{\\texttt}}\n";
|
|
|
|
// natbib.sty
|
|
if (mustProvide("natbib")) {
|
|
packages << "\\usepackage[";
|
|
if (params_.getEngine() == biblio::ENGINE_NATBIB_NUMERICAL) {
|
|
packages << "numbers";
|
|
} else {
|
|
packages << "authoryear";
|
|
}
|
|
packages << "]{natbib}\n";
|
|
}
|
|
|
|
// jurabib -- we need version 0.6 at least.
|
|
if (mustProvide("jurabib")) {
|
|
packages << "\\usepackage{jurabib}[2004/01/25]\n";
|
|
}
|
|
|
|
// bibtopic -- the dot provides the aux file naming which
|
|
// LyX can detect.
|
|
if (mustProvide("bibtopic")) {
|
|
packages << "\\usepackage[dot]{bibtopic}\n";
|
|
}
|
|
|
|
if (mustProvide("xy"))
|
|
packages << "\\usepackage[all]{xy}\n";
|
|
|
|
if (mustProvide("nomencl")) {
|
|
// Make it work with the new and old version of the package,
|
|
// but don't use the compatibility option since it is
|
|
// incompatible to other packages.
|
|
packages << "\\usepackage{nomencl}\n"
|
|
"% the following is useful when we have the old nomencl.sty package\n"
|
|
"\\providecommand{\\printnomenclature}{\\printglossary}\n"
|
|
"\\providecommand{\\makenomenclature}{\\makeglossary}\n"
|
|
"\\makenomenclature\n";
|
|
}
|
|
|
|
return packages.str();
|
|
}
|
|
|
|
|
|
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 (mustProvide("LyX"))
|
|
macros << lyx_def << '\n';
|
|
|
|
if (mustProvide("lyxline"))
|
|
macros << lyxline_def << '\n';
|
|
|
|
if (mustProvide("noun"))
|
|
macros << noun_def << '\n';
|
|
|
|
if (mustProvide("lyxarrow"))
|
|
macros << lyxarrow_def << '\n';
|
|
|
|
// quotes.
|
|
if (mustProvide("quotesinglbase"))
|
|
macros << quotesinglbase_def << '\n';
|
|
if (mustProvide("quotedblbase"))
|
|
macros << quotedblbase_def << '\n';
|
|
if (mustProvide("guilsinglleft"))
|
|
macros << guilsinglleft_def << '\n';
|
|
if (mustProvide("guilsinglright"))
|
|
macros << guilsinglright_def << '\n';
|
|
if (mustProvide("guillemotleft"))
|
|
macros << guillemotleft_def << '\n';
|
|
if (mustProvide("guillemotright"))
|
|
macros << guillemotright_def << '\n';
|
|
|
|
// Math mode
|
|
if (mustProvide("boldsymbol") && !isRequired("amsmath"))
|
|
macros << boldsymbol_def << '\n';
|
|
if (mustProvide("binom") && !isRequired("amsmath"))
|
|
macros << binom_def << '\n';
|
|
if (mustProvide("mathcircumflex"))
|
|
macros << mathcircumflex_def << '\n';
|
|
|
|
// other
|
|
if (mustProvide("ParagraphLeftIndent"))
|
|
macros << paragraphleftindent_def;
|
|
if (mustProvide("NeedLyXFootnoteCode"))
|
|
macros << floatingfootnote_def;
|
|
|
|
// some problems with tex->html converters
|
|
if (mustProvide("NeedTabularnewline"))
|
|
macros << tabularnewline_def;
|
|
|
|
// greyedout environment (note inset)
|
|
if (mustProvide("lyxgreyedout"))
|
|
macros << lyxgreyedout_def;
|
|
|
|
if (mustProvide("lyxdot"))
|
|
macros << lyxdot_def << '\n';
|
|
|
|
// floats
|
|
getFloatDefinitions(macros);
|
|
|
|
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 tmp.str();
|
|
}
|
|
|
|
|
|
docstring const LaTeXFeatures::getTClassPreamble() const
|
|
{
|
|
// the text class specific preamble
|
|
LyXTextClass const & tclass = params_.getLyXTextClass();
|
|
odocstringstream tcpreamble;
|
|
|
|
tcpreamble << tclass.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();
|
|
}
|
|
|
|
|
|
docstring const LaTeXFeatures::getLyXSGMLEntities() const
|
|
{
|
|
// Definition of entities used in the document that are LyX related.
|
|
odocstringstream entities;
|
|
|
|
if (mustProvide("lyxarrow")) {
|
|
entities << "<!ENTITY lyxarrow \"->\">" << '\n';
|
|
}
|
|
|
|
return entities.str();
|
|
}
|
|
|
|
|
|
docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
|
|
{
|
|
odocstringstream sgmlpreamble;
|
|
// FIXME UNICODE
|
|
docstring const basename(from_utf8(onlyPath(fname)));
|
|
|
|
FileMap::const_iterator end = IncludedFiles_.end();
|
|
for (FileMap::const_iterator fi = IncludedFiles_.begin();
|
|
fi != end; ++fi)
|
|
// FIXME UNICODE
|
|
sgmlpreamble << "\n<!ENTITY " << fi->first
|
|
<< (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
|
|
<< makeRelPath(from_utf8(fi->second), basename) << "\">";
|
|
|
|
return sgmlpreamble.str();
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::showStruct() const {
|
|
lyxerr << "LyX needs the following commands when LaTeXing:"
|
|
<< "\n***** Packages:" << getPackages()
|
|
<< "\n***** Macros:" << getMacros()
|
|
<< "\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_;
|
|
}
|
|
|
|
|
|
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();
|
|
// ostringstream floats;
|
|
for (; cit != end; ++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"
|
|
// but only if builtin == false
|
|
// and that have to be true at this point in the
|
|
// function.
|
|
string const type = fl.type();
|
|
string const placement = fl.placement();
|
|
string const style = fl.style();
|
|
if (!style.empty()) {
|
|
os << "\\floatstyle{" << style << "}\n"
|
|
<< "\\restylefloat{" << type << "}\n";
|
|
}
|
|
if (!placement.empty()) {
|
|
os << "\\floatplacement{" << type << "}{"
|
|
<< placement << "}\n";
|
|
}
|
|
} else {
|
|
// The other non builtin floats.
|
|
|
|
string const type = fl.type();
|
|
string const placement = fl.placement();
|
|
string const ext = fl.ext();
|
|
string const within = fl.within();
|
|
string const style = fl.style();
|
|
string const name = fl.name();
|
|
os << "\\floatstyle{" << style << "}\n"
|
|
<< "\\newfloat{" << type << "}{" << placement
|
|
<< "}{" << ext << '}';
|
|
if (!within.empty())
|
|
os << '[' << within << ']';
|
|
os << '\n'
|
|
<< "\\floatname{" << type << "}{"
|
|
<< name << "}\n";
|
|
|
|
// What missing here is to code to minimalize the code
|
|
// output so that the same floatstyle will not be
|
|
// used several times, when the same style is still in
|
|
// effect. (Lgb)
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
} // namespace lyx
|