X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeX.cpp;h=f5b6d20d3029f42add5f1207e9e3f6195c542f9b;hb=89d9334e03c311a4a7585f40ad81880304d174d4;hp=0144e1cf166cdab2e6890d6ca82652724accf989;hpb=1e1800a21aac99bb6e6044e1c1e11e3f88d198dd;p=lyx.git diff --git a/src/LaTeX.cpp b/src/LaTeX.cpp index 0144e1cf16..f5b6d20d30 100644 --- a/src/LaTeX.cpp +++ b/src/LaTeX.cpp @@ -15,11 +15,15 @@ #include +#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/convert.h" @@ -73,6 +77,15 @@ void TeXErrors::insertError(int line, docstring const & error_desc, } +void TeXErrors::insertRef(int line, docstring const & error_desc, + docstring const & error_text, + string const & child_name) +{ + Error newerr(line, error_desc, error_text, child_name); + undef_ref.push_back(newerr); +} + + bool operator==(AuxInfo const & a, AuxInfo const & o) { return a.aux_file == o.aux_file @@ -96,7 +109,7 @@ LaTeX::LaTeX(string const & latex, OutputParams const & rp, FileName const & f, string const & p, string const & lp, bool allow_cancellation, bool const clean_start) : cmd(latex), file(f), path(p), lpath(lp), runparams(rp), biber(false), - allow_cancel(allow_cancellation) + allow_cancel(allow_cancellation) { num_errors = 0; // lualatex can still produce a DVI with --output-format=dvi. However, @@ -152,6 +165,10 @@ void LaTeX::removeAuxiliaryFiles() const FileName const gls(changeExtension(file.absFileName(), ".gls")); gls.removeFile(); + // endnotes file + FileName const ent(changeExtension(file.absFileName(), ".ent")); + ent.removeFile(); + // Also remove the aux file FileName const aux(changeExtension(file.absFileName(), ".aux")); aux.removeFile(); @@ -174,6 +191,7 @@ int LaTeX::run(TeXErrors & terr) { int scanres = NO_ERRORS; int bscanres = NO_ERRORS; + int iscanres = NO_ERRORS; unsigned int count = 0; // number of times run num_errors = 0; // just to make sure. unsigned int const MAX_RUN = 6; @@ -211,6 +229,25 @@ int LaTeX::run(TeXErrors & terr) } if (had_depfile) { + if (runparams.includeall) { + // On an "includeall" call (whose purpose is to set up/maintain counters and references + // for includeonly), we remove the master from the dependency list since + // (1) it will be checked anyway on the subsequent includeonly run + // (2) the master is always changed (due to the \includeonly line), and this alone would + // trigger a complete, expensive run each time + head.remove_file(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()) { + string const incm = + DocFileName(changeExtension(makeAbsPath(incfile, path) + .absFileName(), ".tex")).mangledFileName(); + FileName inc = makeAbsPath(incm, file.onlyPath().realPath()); + head.remove_file(inc); + } + } + } // Update the checksums head.update(); // Can't just check if anything has changed because it might @@ -245,16 +282,16 @@ int LaTeX::run(TeXErrors & terr) 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); } @@ -286,8 +323,11 @@ int LaTeX::run(TeXErrors & terr) // onlyFileName() is needed for cygwin int const ret = runMakeIndex(onlyFileName(idxfile.absFileName()), runparams); - if (ret == Systemcall::KILLED) - return Systemcall::KILLED; + if (ret == Systemcall::KILLED || ret == Systemcall::TIMEOUT) + return ret; + FileName const ilgfile(changeExtension(file.absFileName(), ".ilg")); + if (ilgfile.exists()) + iscanres = scanIlgFile(terr); rerun = true; } @@ -299,8 +339,8 @@ int LaTeX::run(TeXErrors & terr) // 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; + if (ret == Systemcall::KILLED || ret == Systemcall::TIMEOUT) + return ret; rerun = true; } @@ -321,7 +361,12 @@ int LaTeX::run(TeXErrors & terr) // run bibtex // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex) - if (scanres & UNDEF_CIT || 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 + // (2) this would trigger a complete run each time (as references in non-included + // children are removed on subsequent includeonly runs) + if (!runparams.includeall && (scanres & UNDEF_CIT || run_bibtex)) { // Here we must scan the .aux file and look for // "\bibdata" and/or "\bibstyle". If one of those // tags is found -> run bibtex and set rerun = true; @@ -331,8 +376,8 @@ int LaTeX::run(TeXErrors & terr) 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); @@ -362,8 +407,8 @@ int LaTeX::run(TeXErrors & terr) 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 @@ -377,7 +422,12 @@ int LaTeX::run(TeXErrors & terr) // rerun bibtex? // Complex bibliography packages such as Biblatex require // an additional bibtex cycle sometimes. - if (scanres & UNDEF_CIT) { + // 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 + // (2) this would trigger a complete run each time (as references in non-included + // children are removed on subsequent includeonly runs) + if (!runparams.includeall && scanres & UNDEF_CIT) { // Here we must scan the .aux file and look for // "\bibdata" and/or "\bibstyle". If one of those // tags is found -> run bibtex and set rerun = true; @@ -387,8 +437,8 @@ int LaTeX::run(TeXErrors & terr) 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); @@ -410,9 +460,12 @@ int LaTeX::run(TeXErrors & terr) // onlyFileName() is needed for cygwin int const ret = runMakeIndex(onlyFileName(changeExtension( file.absFileName(), ".idx")), runparams); - if (ret == Systemcall::KILLED) - return Systemcall::KILLED; - rerun = true; + if (ret == Systemcall::KILLED || ret == Systemcall::TIMEOUT) + return ret; + FileName const ilgfile(changeExtension(file.absFileName(), ".ilg")); + if (ilgfile.exists()) + iscanres = scanIlgFile(terr); + rerun = true; } // MSVC complains that bool |= int is unsafe. Not sure why. @@ -461,6 +514,9 @@ int LaTeX::run(TeXErrors & terr) if (bscanres & ERRORS) return bscanres; // return on error + if (iscanres & ERRORS) + return iscanres; // return on error + return scanres; } @@ -487,11 +543,50 @@ int LaTeX::runMakeIndex(string const & f, OutputParams const & rp, 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 = doc_lang ? doc_lang->xindy() : string(); + if (!xdyopts.empty()) + xdyopts = "-L " + xdyopts; + if (rp.isFullUnicode() && rp.encoding->package() == Encoding::none) { + if (!xdyopts.empty()) + xdyopts += " "; + // xelatex includes lualatex + xdyopts += "-I xelatex"; + } + else if (rp.encoding->iconvName() == "UTF-8") { + if (!xdyopts.empty()) + xdyopts += " "; + // -I not really needed for texindy, but for xindy + xdyopts += "-C utf8 -I latex"; + } + else { + if (!xdyopts.empty()) + xdyopts += " "; + // not really needed for texindy, but for xindy + xdyopts += "-I latex"; + } + tmp = subst(tmp, "$$x", xdyopts); + } + + if (contains(tmp, "$$b")) { + // advise xindy to write a log file + tmp = subst(tmp, "$$b", removeExtension(f)); + } + LYXERR(Debug::LATEX, "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, @@ -682,6 +777,14 @@ bool LaTeX::runBibTeX(vector const & bibtex_info, } +//helper func for scanLogFile; gets line number X from strings "... on input line X ..." +//returns 0 if none is found +int getLineNumber(const string &token){ + string l = support::token(token, ' ', tokenPos(token,' ',"line") + 1); + return l.empty() ? 0 : convert(l); +} + + int LaTeX::scanLogFile(TeXErrors & terr) { int last_line = -1; @@ -698,6 +801,7 @@ int LaTeX::scanLogFile(TeXErrors & terr) 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; @@ -706,7 +810,10 @@ int LaTeX::scanLogFile(TeXErrors & terr) stack > child; children.clear(); + 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 @@ -721,6 +828,9 @@ int LaTeX::scanLogFile(TeXErrors & terr) 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] == '(') { @@ -752,8 +862,20 @@ int LaTeX::scanLogFile(TeXErrors & terr) if (contains(token, "file:line:error style messages enabled")) fle_style = true; - if (prefixIs(token, "LaTeX Warning:") || - prefixIs(token, "! pdfTeX warning")) { + //Handles both "LaTeX Warning:" & "Package natbib Warning:" + //Various handlers for missing citations below won't catch the problem if citation + //key is long (>~25chars), because pdflatex splits output at line length 80. + //TODO: TL 2020 engines will contain new commandline switch --cnf-line which we + //can use to set max_print_line variable for appropriate length and detect all + //errors correctly. + if (!runparams.includeall && (contains(token, "There were undefined citations.") || + prefixIs(token, "Package biblatex Warning: The following entry could not be found"))) + retval |= UNDEF_CIT; + + 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; @@ -771,28 +893,84 @@ int LaTeX::scanLogFile(TeXErrors & terr) } else if (contains(token, "Etaremune labels have changed")) { retval |= ERROR_RERUN; LYXERR(Debug::LATEX, "Force rerun."); - } else if (contains(token, "Citation") - && contains(token, "on page") + // package enotez + } else if (contains(token, "Endnotes may have changed. Rerun")) { + retval |= RERUN; + LYXERR(Debug::LATEX, "We should rerun."); + //"Citation `cit' on page X undefined on input line X." + } else if (!runparams.includeall && contains(token, "Citation") + //&& contains(token, "on input line") //often split to newline && contains(token, "undefined")) { retval |= UNDEF_CIT; - } else if (contains(token, "Citation") + terr.insertRef(getLineNumber(token), from_ascii("Citation undefined"), + from_utf8(token), child_name); + //"Reference `X' on page Y undefined on input line Z." + // 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")) { - retval |= UNDEF_CIT; + 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; + // 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; } + } else if (prefixIs(token, "Package")) { // Package warnings retval |= PACKAGE_WARNING; if (contains(token, "natbib Warning:")) { // Natbib warnings - if (contains(token, "Citation") + if (!runparams.includeall + && contains(token, "Citation") && contains(token, "on page") && contains(token, "undefined")) { retval |= UNDEF_CIT; + //Unf only keys up to ~6 chars will make it due to line splits + terr.insertRef(getLineNumber(token), from_ascii("Citation undefined"), + from_utf8(token), child_name); } - } else if (contains(token, "run BibTeX")) { + } else if (!runparams.includeall && contains(token, "run BibTeX")) { retval |= UNDEF_CIT; - } else if (contains(token, "run Biber")) { + } else if (!runparams.includeall && contains(token, "run Biber")) { retval |= UNDEF_CIT; biber = true; } else if (contains(token, "Rerun LaTeX") || @@ -879,10 +1057,15 @@ int LaTeX::scanLogFile(TeXErrors & terr) // 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. @@ -904,6 +1087,15 @@ int LaTeX::scanLogFile(TeXErrors & terr) 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"); @@ -916,6 +1108,9 @@ int LaTeX::scanLogFile(TeXErrors & terr) 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) @@ -947,7 +1142,7 @@ int LaTeX::scanLogFile(TeXErrors & terr) retval |= TEX_WARNING; } else if (prefixIs(token, "Underfull ")) { retval |= TEX_WARNING; - } else if (contains(token, "Rerun to get citations")) { + } else if (!runparams.includeall && contains(token, "Rerun to get citations")) { // Natbib seems to use this. retval |= UNDEF_CIT; } else if (contains(token, "No pages of output") @@ -1205,14 +1400,16 @@ void LaTeX::deplog(DepTable & head) static regex const reg1("File: (.+).*"); static regex const reg2("No file (.+)(.).*"); - static regex const reg3("\\\\openout[0-9]+.*=.*`(.+)(..).*"); + static regex const reg3a("\\\\openout[0-9]+.*=.*`(.+)(..).*"); + // LuaTeX has a slightly different output + static regex const reg3b("\\\\openout[0-9]+.*=\\s*(.+)"); // If an index should be created, MikTex does not write a line like // \openout# = 'sample.idx'. // but instead only a line like this into the log: // Writing index file sample.idx static regex const reg4("Writing index file (.+).*"); static regex const regoldnomencl("Writing glossary file (.+).*"); - static regex const regnomencl("Writing nomenclature file (.+).*"); + static regex const regnomencl(".*Writing nomenclature file (.+).*"); // If a toc should be created, MikTex does not write a line like // \openout# = `sample.toc'. // but only a line like this into the log: @@ -1298,14 +1495,22 @@ void LaTeX::deplog(DepTable & head) else // we suspect a line break fragment = true; - // (3) "\openout = `file.ext'." - } else if (regex_match(token, sub, reg3)) { + // (3)(a) "\openout = `file.ext'." + } else if (regex_match(token, sub, reg3a)) { // search for closing '. at the end of the line if (sub.str(2) == "\'.") fragment = !handleFoundFile(sub.str(1), head); else // potential fragment fragment = true; + // (3)(b) "\openout = file.ext" (LuaTeX) + } else if (regex_match(token, sub, reg3b)) { + // file names must contains a dot + if (contains(sub.str(1), '.')) + fragment = !handleFoundFile(sub.str(1), head); + else + // potential fragment + fragment = true; // (4) "Writing index file file.ext" } else if (regex_match(token, sub, reg4)) // fragmential file name? @@ -1431,4 +1636,42 @@ int LaTeX::scanBlgFile(DepTable & dep, TeXErrors & terr) } +int LaTeX::scanIlgFile(TeXErrors & terr) +{ + FileName const ilg_file(changeExtension(file.absFileName(), "ilg")); + LYXERR(Debug::LATEX, "Scanning ilg file: " << ilg_file); + + ifstream ifs(ilg_file.toFilesystemEncoding().c_str()); + string token; + int retval = NO_ERRORS; + + string prevtoken; + while (getline(ifs, token)) { + token = rtrim(token, "\r"); + smatch sub; + if (prefixIs(token, "!! ")) + prevtoken = token; + else if (!prevtoken.empty()) { + retval |= INDEX_ERROR; + string errstr = N_("Makeindex error: ") + prevtoken; + string msg = prevtoken + '\n'; + msg += token; + terr.insertError(0, + from_local8bit(errstr), + from_local8bit(msg)); + prevtoken.clear(); + } 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)); + } + } + return retval; +} + + + } // namespace lyx