#include <config.h>
+#include "LaTeX.h"
+
#include "Buffer.h"
#include "BufferList.h"
#include "BufferParams.h"
-#include "LaTeX.h"
#include "LyXRC.h"
#include "LyX.h"
#include "DepTable.h"
#include "Encoding.h"
+#include "Language.h"
#include "support/debug.h"
+#include "support/docstring.h"
#include "support/convert.h"
#include "support/FileName.h"
#include "support/filetools.h"
#include "support/Systemcall.h"
#include "support/os.h"
-#include "support/regex.h"
-
#include <fstream>
+#include <regex>
#include <stack>
void LaTeX::removeAuxiliaryFiles() const
{
+ LYXERR(Debug::LATEX, "Removing auxiliary files");
// Note that we do not always call this function when there is an error.
// For example, if there is an error but an output file is produced we
// still would like to output (export/view) the file.
// Also remove all children which are included
Buffer const * buf = theBufferList().getBufferFromTmp(file.absFileName());
if (buf && buf->params().maintain_unincluded_children == BufferParams::CM_Mostly) {
- for (auto const incfile : buf->params().getIncludedChildren()) {
+ for (auto const & incfile : buf->params().getIncludedChildren()) {
string const incm =
DocFileName(changeExtension(makeAbsPath(incfile, path)
.absFileName(), ".tex")).mangledFileName();
message(runMessage(count));
int exit_code = startscript();
- if (exit_code == Systemcall::KILLED)
- return Systemcall::KILLED;
+ if (exit_code == Systemcall::KILLED || exit_code == Systemcall::TIMEOUT)
+ return exit_code;
scanres = scanLogFile(terr);
if (scanres & ERROR_RERUN) {
LYXERR(Debug::LATEX, "Rerunning LaTeX");
terr.clearErrors();
exit_code = startscript();
- if (exit_code == Systemcall::KILLED)
- return Systemcall::KILLED;
+ if (exit_code == Systemcall::KILLED || exit_code == Systemcall::TIMEOUT)
+ return exit_code;
scanres = scanLogFile(terr);
}
head.update();
// 1
- // At this point we must run external programs if needed.
- // makeindex will be run if a .idx file changed or was generated.
- // And if there were undefined citations or changes in references
- // the .aux file is checked for signs of bibtex. Bibtex is then run
- // if needed.
-
- // memoir (at least) writes an empty *idx file in the first place.
- // A second latex run is needed.
- FileName const idxfile(changeExtension(file.absFileName(), ".idx"));
- rerun = idxfile.exists() && idxfile.isFileEmpty();
-
- // run makeindex
- if (head.haschanged(idxfile)) {
- // no checks for now
- LYXERR(Debug::LATEX, "Running MakeIndex.");
- message(_("Running Index Processor."));
- // onlyFileName() is needed for cygwin
- int const ret =
- runMakeIndex(onlyFileName(idxfile.absFileName()), runparams);
- if (ret == Systemcall::KILLED)
- return Systemcall::KILLED;
- FileName const ilgfile(changeExtension(file.absFileName(), ".ilg"));
- if (ilgfile.exists())
- iscanres = scanIlgFile(terr);
- rerun = true;
- }
-
- FileName const nlofile(changeExtension(file.absFileName(), ".nlo"));
- // If all nomencl entries are removed, nomencl writes an empty nlo file.
- // DepTable::hasChanged() returns false in this case, since it does not
- // distinguish empty files from non-existing files. This is why we need
- // the extra checks here (to trigger a rerun). Cf. discussions in #8905.
- // FIXME: Sort out the real problem in DepTable.
- if (head.haschanged(nlofile) || (nlofile.exists() && nlofile.isFileEmpty())) {
- int const ret = runMakeIndexNomencl(file, ".nlo", ".nls");
- if (ret == Systemcall::KILLED)
- return Systemcall::KILLED;
- rerun = true;
- }
-
- FileName const glofile(changeExtension(file.absFileName(), ".glo"));
- if (head.haschanged(glofile)) {
- int const ret = runMakeIndexNomencl(file, ".glo", ".gls");
- if (ret)
- return ret;
- rerun = true;
- }
-
-
- // check if we're using biber instead of bibtex
+ // At this point we must run the bibliography processor if needed.
+ // First, check if we're using biber instead of bibtex --
// biber writes no info to the aux file, so we just check
- // if a bcf file exists (and if it was updated)
+ // if a bcf file exists (and if it was updated).
FileName const bcffile(changeExtension(file.absFileName(), ".bcf"));
biber |= head.exist(bcffile);
- // run bibtex
- // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
+ // If (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
// We do not run bibtex/biber on an "includeall" call (whose purpose is
// to set up/maintain counters and references for includeonly) since
// (1) bibliographic references will be updated on the subsequent includeonly run
// "\bibdata" and/or "\bibstyle". If one of those
// tags is found -> run bibtex and set rerun = true;
// no checks for now
- LYXERR(Debug::LATEX, "Running BibTeX.");
- message(_("Running BibTeX."));
+ LYXERR(Debug::LATEX, "Running Bibliography Processor.");
+ message(_("Running Bibliography Processor."));
updateBibtexDependencies(head, bibtex_info);
int exit_code;
rerun |= runBibTeX(bibtex_info, runparams, exit_code);
- if (exit_code == Systemcall::KILLED)
- return Systemcall::KILLED;
+ if (exit_code == Systemcall::KILLED || exit_code == Systemcall::TIMEOUT)
+ return exit_code;
FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
if (blgfile.exists())
bscanres = scanBlgFile(head, terr);
}
// 2
- // we know on this point that latex has been run once (or we just
+ // We know on this point that latex has been run once (or we just
// returned) and the question now is to decide if we need to run
// it any more. This is done by asking if any of the files in the
// dependency file has changed. (remember that the checksum for
LYXERR(Debug::LATEX, "Run #" << count);
message(runMessage(count));
int exit_code = startscript();
- if (exit_code == Systemcall::KILLED)
- return Systemcall::KILLED;
+ if (exit_code == Systemcall::KILLED || exit_code == Systemcall::TIMEOUT)
+ return exit_code;
scanres = scanLogFile(terr);
// update the depedencies
}
// 3
- // rerun bibtex?
+ // Rerun bibliography processor?
// Complex bibliography packages such as Biblatex require
// an additional bibtex cycle sometimes.
// We do not run bibtex/biber on an "includeall" call (whose purpose is
// "\bibdata" and/or "\bibstyle". If one of those
// tags is found -> run bibtex and set rerun = true;
// no checks for now
- LYXERR(Debug::LATEX, "Running BibTeX.");
- message(_("Running BibTeX."));
+ LYXERR(Debug::LATEX, "Re-Running Bibliography Processor.");
+ message(_("Re-Running Bibliography Processor."));
updateBibtexDependencies(head, bibtex_info);
int exit_code;
rerun |= runBibTeX(bibtex_info, runparams, exit_code);
- if (exit_code == Systemcall::KILLED)
- return Systemcall::KILLED;
+ if (exit_code == Systemcall::KILLED || exit_code == Systemcall::TIMEOUT)
+ return exit_code;
FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
if (blgfile.exists())
bscanres = scanBlgFile(head, terr);
}
// 4
- // The inclusion of files generated by external programs such as
- // makeindex or bibtex might have done changes to pagenumbering,
- // etc. And because of this we must run the external programs
- // again to make sure everything is redone correctly.
- // Also there should be no need to run the external programs any
- // more after this.
-
- // run makeindex if the <file>.idx has changed or was generated.
- if (head.haschanged(idxfile)) {
+ // After the bibliography was processed, we need more passes of LaTeX
+ // in order to resolve the citations. We need to do this before the index
+ // is being generated (since we need the correct pagination, see #2696).
+ // Also, memoir (at least) writes an empty *idx file in the first place.
+ // A further latex run is needed in that case as well.
+ FileName const idxfile(changeExtension(file.absFileName(), ".idx"));
+ if (run_bibtex || (idxfile.exists() && idxfile.isFileEmpty())) {
+ while ((head.sumchange() || rerun || (scanres & RERUN))
+ && count < MAX_RUN) {
+ // Yes rerun until message goes away, or until
+ // MAX_RUNS are reached.
+ rerun = false;
+ ++count;
+ LYXERR(Debug::LATEX, "Run #" << count);
+ message(runMessage(count));
+ startscript();
+ scanres = scanLogFile(terr);
+
+ // keep this updated
+ head.update();
+ }
+ }
+
+ // 5
+ // Now that we have final pagination, run the index and nomencl processors
+ if (idxfile.exists()) {
// no checks for now
- LYXERR(Debug::LATEX, "Running MakeIndex.");
+ LYXERR(Debug::LATEX, "Running Index Processor.");
message(_("Running Index Processor."));
// onlyFileName() is needed for cygwin
- int const ret = runMakeIndex(onlyFileName(changeExtension(
- file.absFileName(), ".idx")), runparams);
- if (ret == Systemcall::KILLED)
- return Systemcall::KILLED;
+ int const ret =
+ runMakeIndex(onlyFileName(idxfile.absFileName()), runparams);
+ if (ret == Systemcall::KILLED || ret == Systemcall::TIMEOUT)
+ return ret;
+ else if (ret != Systemcall::OK) {
+ iscanres |= INDEX_ERROR;
+ terr.insertError(0,
+ _("Index Processor Error"),
+ _("The index processor did not run successfully. "
+ "Please check the output of View > Messages Pane!"));
+ }
FileName const ilgfile(changeExtension(file.absFileName(), ".ilg"));
if (ilgfile.exists())
iscanres = scanIlgFile(terr);
rerun = true;
}
+ FileName const nlofile(changeExtension(file.absFileName(), ".nlo"));
+ // If all nomencl entries are removed, nomencl writes an empty nlo file.
+ // DepTable::hasChanged() returns false in this case, since it does not
+ // distinguish empty files from non-existing files. This is why we need
+ // the extra checks here (to trigger a rerun). Cf. discussions in #8905.
+ // FIXME: Sort out the real problem in DepTable.
+ if (head.haschanged(nlofile) || (nlofile.exists() && nlofile.isFileEmpty())) {
+ int const ret = runMakeIndexNomencl(file, ".nlo", ".nls");
+ if (ret == Systemcall::KILLED || ret == Systemcall::TIMEOUT)
+ return ret;
+ rerun = true;
+ }
+ FileName const glofile(changeExtension(file.absFileName(), ".glo"));
+ if (head.haschanged(glofile)) {
+ int const ret = runMakeIndexNomencl(file, ".glo", ".gls");
+ if (ret)
+ return ret;
+ rerun = true;
+ }
- // MSVC complains that bool |= int is unsafe. Not sure why.
- if (head.haschanged(nlofile))
- rerun |= (runMakeIndexNomencl(file, ".nlo", ".nls") != 0);
- if (head.haschanged(glofile))
- rerun |= (runMakeIndexNomencl(file, ".glo", ".gls") != 0);
-
- // 5
- // we will only run latex more if the log file asks for it.
+ // 6
+ // We will re-run latex if the log file asks for it,
// or if the sumchange() is true.
// -> rerun asked for:
// run latex and
if (!rp.index_command.empty())
tmp = rp.index_command;
+
+ Language const * doc_lang = languages.getLanguage(rp.document_language);
if (contains(tmp, "$$x")) {
// This adds appropriate [te]xindy options
// such as language and codepage (for the
// main document language/encoding) as well
// as input markup (latex or xelatex)
- string xdyopts = rp.xindy_language;
+ string xdyopts = doc_lang ? doc_lang->xindy() : string();
if (!xdyopts.empty())
xdyopts = "-L " + xdyopts;
if (rp.isFullUnicode() && rp.encoding->package() == Encoding::none) {
"idx file has been made, running index processor ("
<< tmp << ") on file " << f);
- tmp = subst(tmp, "$$lang", rp.document_language);
+ if (doc_lang) {
+ tmp = subst(tmp, "$$lang", doc_lang->babel());
+ tmp = subst(tmp, "$$lcode", doc_lang->code());
+ }
if (rp.use_indices) {
tmp = lyxrc.splitindex_command + " -m " + quoteName(tmp);
LYXERR(Debug::LATEX,
int LaTeX::runMakeIndexNomencl(FileName const & fname,
string const & nlo, string const & nls)
{
- LYXERR(Debug::LATEX, "Running MakeIndex for nomencl.");
- message(_("Running MakeIndex for nomencl."));
+ LYXERR(Debug::LATEX, "Running Nomenclature Processor.");
+ message(_("Running Nomenclature Processor."));
string tmp = lyxrc.nomencl_command + ' ';
// onlyFileName() is needed for cygwin
tmp += quoteName(onlyFileName(changeExtension(fname.absFileName(), nlo)));
it->aux_file.absFileName())));
Systemcall one;
Systemcall::Starttype const starttype =
- allow_cancel ? Systemcall::WaitLoop : Systemcall::Wait;
+ allow_cancel ? Systemcall::WaitLoop : Systemcall::Wait;
exit_code = one.startscript(starttype, tmp, path, lpath, true);
if (exit_code) {
return result;
string tmp =
onlyFileName(changeExtension(file.absFileName(), ".log"));
LYXERR(Debug::LATEX, "Log file: " << tmp);
- FileName const fn = FileName(makeAbsPath(tmp));
+ FileName const fn = makeAbsPath(tmp);
// FIXME we should use an ifdocstream here and a docstring for token
// below. The encoding of the log file depends on the _output_ (font)
// encoding of the TeX file (T1, TU etc.). See #10728.
bool fle_style = false;
static regex const file_line_error(".+\\.\\D+:[0-9]+: (.+)");
static regex const child_file("[^0-9]*([0-9]+[A-Za-z]*_.+\\.tex).*");
+ static regex const undef_ref(".*Reference `(\\w+)\\' on page.*");
// Flag for 'File ended while scanning' message.
// We need to wait for subsequent processing.
string wait_for_error;
terr.clearRefs();
string token;
+ string ml_token;
while (getline(ifs, token)) {
// MikTeX sometimes inserts \0 in the log file. They can't be
// removed directly with the existing string utility
if (token.empty())
continue;
+ if (!ml_token.empty())
+ ml_token += token;
+
// Track child documents
for (size_t i = 0; i < token.length(); ++i) {
if (token[i] == '(') {
prefixIs(token, "Package biblatex Warning: The following entry could not be found")))
retval |= UNDEF_CIT;
- if (prefixIs(token, "LaTeX Warning:") ||
- prefixIs(token, "! pdfTeX warning")) {
+ if (prefixIs(token, "LaTeX Warning:")
+ || prefixIs(token, "! pdfTeX warning")
+ || prefixIs(ml_token, "LaTeX Warning:")
+ || prefixIs(ml_token, "! pdfTeX warning")) {
// Here shall we handle different
// types of warnings
retval |= LATEX_WARNING;
terr.insertRef(getLineNumber(token), from_ascii("Citation undefined"),
from_utf8(token), child_name);
//"Reference `X' on page Y undefined on input line Z."
- } else if (contains(token, "Reference")
- //&& contains(token, "on input line")) //often split to new line
+ // This warning might be broken accross multiple lines with long labels.
+ // Thus we check that
+ } else if (contains(token, "Reference `") && !contains(token, "on input line")) {
+ // Rest of warning in next line(s)
+ // Save to ml_token
+ ml_token = token;
+ } else if (!ml_token.empty() && contains(ml_token, "Reference `")
+ && !contains(ml_token, "on input line")) {
+ // not finished yet. Continue with next line.
+ continue;
+ } else if (!ml_token.empty() && contains(ml_token, "Reference `")
+ && contains(ml_token, "on input line")) {
+ // We have collected the whole warning now.
+ if (!contains(ml_token, "undefined")) {
+ // Not the warning we are looking for
+ ml_token.clear();
+ continue;
+ }
+ if (regex_match(ml_token, sub, undef_ref)) {
+ string const ref = sub.str(1);
+ Buffer const * buf = theBufferList().getBufferFromTmp(file.absFileName());
+ if (!buf || !buf->masterBuffer()->activeLabel(from_utf8(ref))) {
+ terr.insertRef(getLineNumber(ml_token), from_ascii("Reference undefined"),
+ from_utf8(ml_token), child_name);
+ retval |= UNDEF_UNKNOWN_REF;
+ }
+ }
+ ml_token.clear();
+ retval |= UNDEF_REF;
+ } else if (contains(token, "Reference `")
+ && contains(token, "on input line")
&& contains(token, "undefined")) {
+ if (regex_match(token, sub, undef_ref)) {
+ string const ref = sub.str(1);
+ Buffer const * buf = theBufferList().getBufferFromTmp(file.absFileName());
+ if (!buf || !buf->masterBuffer()->activeLabel(from_utf8(ref))) {
+ terr.insertRef(getLineNumber(token), from_ascii("Reference undefined"),
+ from_utf8(token), child_name);
+ retval |= UNDEF_UNKNOWN_REF;
+ }
+ }
retval |= UNDEF_REF;
- terr.insertRef(getLineNumber(token), from_ascii("Reference undefined"),
- from_utf8(token), child_name);
-
- //If label is too long pdlaftex log line splitting will make the above fail
- //so we catch at least this generic statement occuring for both CIT & REF.
+ // In case the above checks fail we catch at least this generic statement
+ // occuring for both CIT & REF.
} else if (!runparams.includeall && contains(token, "There were undefined references.")) {
if (!(retval & UNDEF_CIT)) //if not handled already
- retval |= UNDEF_REF;
+ retval |= UNDEF_REF;
}
} else if (prefixIs(token, "Package")) {
// get the next line
int count = 0;
+ // We also collect intermediate lines
+ // This is needed for errors in preamble
+ string intermediate;
do {
if (!getline(ifs, tmp))
break;
tmp = rtrim(tmp, "\r");
+ if (!prefixIs(tmp, "l."))
+ intermediate += tmp;
// 15 is somewhat arbitrarily chosen, based on practice.
// We used 10 for 14 years and increased it to 15 when we
// saw one case.
sscanf(tmp.c_str(), "l.%d", &line);
// get the rest of the message:
string errstr(tmp, tmp.find(' '));
+ bool preamble_error = false;
+ if (suffixIs(errstr, "\\begin{document}")) {
+ // this is an error in preamble
+ // the real error is in the
+ // intermediate lines
+ errstr = intermediate;
+ tmp = intermediate;
+ preamble_error = true;
+ }
errstr += '\n';
getline(ifs, tmp);
tmp = rtrim(tmp, "\r");
getline(ifs, tmp);
tmp = rtrim(tmp, "\r");
}
+ if (preamble_error)
+ // Add a note that the error is to be found in preamble
+ errstr += "\n" + to_utf8(_("(NOTE: The erroneous command is in the preamble)"));
LYXERR(Debug::LATEX, "line: " << line << '\n'
<< "Desc: " << desc << '\n' << "Text: " << errstr);
if (line == last_line)
} else if (regex_match(token, sub, biberError)) {
retval |= BIBTEX_ERROR;
string errstr = N_("Biber error: ") + sub.str(2);
- string msg = token;
terr.insertError(0,
from_local8bit(errstr),
- from_local8bit(msg));
+ from_local8bit(token));
}
prevtoken = token;
}
string prevtoken;
while (getline(ifs, token)) {
token = rtrim(token, "\r");
- smatch sub;
if (prefixIs(token, "!! "))
prevtoken = token;
else if (!prevtoken.empty()) {
} else if (prefixIs(token, "ERROR: ")) {
retval |= BIBTEX_ERROR;
string errstr = N_("Xindy error: ") + token.substr(6);
- string msg = token;
terr.insertError(0,
from_local8bit(errstr),
- from_local8bit(msg));
+ from_local8bit(token));
}
}
return retval;