]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeX.cpp
\\spellchecker_ignore: use LyX language name rather than langcode
[lyx.git] / src / LaTeX.cpp
index 3ac59b71fddc96c1d970fcb02058c8d36b73fa41..6e7fe921b8fa6f9f30a14a6e9900dc4551f3941b 100644 (file)
 
 #include <config.h>
 
-#include "BufferList.h"
 #include "LaTeX.h"
+
+#include "Buffer.h"
+#include "BufferList.h"
+#include "BufferParams.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"
@@ -31,9 +36,8 @@
 #include "support/Systemcall.h"
 #include "support/os.h"
 
-#include "support/regex.h"
-
 #include <fstream>
+#include <regex>
 #include <stack>
 
 
@@ -131,6 +135,7 @@ LaTeX::LaTeX(string const & latex, OutputParams const & rp,
 
 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.
@@ -188,6 +193,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;
@@ -225,6 +231,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
@@ -259,16 +284,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);
        }
 
@@ -300,8 +325,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;
        }
 
@@ -313,8 +341,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;
        }
 
@@ -335,7 +363,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;
@@ -345,8 +378,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);
@@ -376,8 +409,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
@@ -391,7 +424,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;
@@ -401,8 +439,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);
@@ -424,9 +462,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.
@@ -475,6 +516,9 @@ int LaTeX::run(TeXErrors & terr)
        if (bscanres & ERRORS)
                return bscanres; // return on error
 
+       if (iscanres & ERRORS)
+               return iscanres; // return on error
+
        return scanres;
 }
 
@@ -500,27 +544,51 @@ 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)
-               string xdyopts = rp.xindy_language;
+               // 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.encoding->iconvName() == "UTF-8") {
+               if (rp.isFullUnicode() && rp.encoding->package() == Encoding::none) {
                        if (!xdyopts.empty())
                                xdyopts += " ";
-                       xdyopts += "-C utf8";
+                       // 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,
@@ -735,6 +803,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;
@@ -746,6 +815,7 @@ int LaTeX::scanLogFile(TeXErrors & terr)
        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
@@ -760,6 +830,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] == '(') {
@@ -797,12 +870,14 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                //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 (contains(token, "There were undefined citations.") ||
-                   prefixIs(token, "Package biblatex Warning: The following entry could not be found"))
+               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")) {
+               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;
@@ -825,25 +900,60 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                                retval |= RERUN;
                                LYXERR(Debug::LATEX, "We should rerun.");
                        //"Citation `cit' on page X undefined on input line X."
-                       } else if (contains(token, "Citation")
+                       } else if (!runparams.includeall && contains(token, "Citation")
                                   //&& contains(token, "on input line") //often split to newline
                                   && contains(token, "undefined")) {
                                retval |= UNDEF_CIT;
                                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.
-                       } else if (contains(token, "There were undefined references.")) {
+                       // 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")) {
@@ -851,7 +961,8 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                        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;
@@ -859,9 +970,9 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                                        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") ||
@@ -948,10 +1059,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.
@@ -973,6 +1089,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");
@@ -985,6 +1110,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)
@@ -1016,7 +1144,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")
@@ -1499,10 +1627,9 @@ int LaTeX::scanBlgFile(DepTable & dep, TeXErrors & terr)
                } 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;
        }
@@ -1510,4 +1637,40 @@ 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");
+               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);
+                       terr.insertError(0,
+                                        from_local8bit(errstr),
+                                        from_local8bit(token));
+               }
+       }
+       return retval;
+}
+
+
+
 } // namespace lyx