]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeX.cpp
Format and reversion code for new counter inset.
[lyx.git] / src / LaTeX.cpp
index 4606ed3f4571c05c36c4dcc26d3f6c788af52861..a34db97de1d759e014a229ac9ce4c6e9111f311b 100644 (file)
 
 #include <config.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 "support/debug.h"
 #include "support/convert.h"
@@ -105,7 +108,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,
@@ -161,6 +164,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();
@@ -183,6 +190,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;
@@ -220,6 +228,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
@@ -297,6 +324,9 @@ int LaTeX::run(TeXErrors & terr)
                                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;
        }
 
@@ -330,7 +360,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;
@@ -386,7 +421,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;
@@ -421,7 +461,10 @@ int LaTeX::run(TeXErrors & terr)
                                file.absFileName(), ".idx")), runparams);
                if (ret == Systemcall::KILLED)
                        return Systemcall::KILLED;
-               rerun = true;
+               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.
@@ -470,6 +513,9 @@ int LaTeX::run(TeXErrors & terr)
        if (bscanres & ERRORS)
                return bscanres; // return on error
 
+       if (iscanres & ERRORS)
+               return iscanres; // return on error
+
        return scanres;
 }
 
@@ -495,6 +541,40 @@ int LaTeX::runMakeIndex(string const & f, OutputParams const & rp,
 
        if (!rp.index_command.empty())
                tmp = rp.index_command;
+       
+       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;
+               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 ("
@@ -715,6 +795,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;
@@ -726,6 +807,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
@@ -740,6 +822,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] == '(') {
@@ -777,11 +862,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."))
+               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;
@@ -804,25 +892,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")) {
@@ -830,7 +953,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;
@@ -838,9 +962,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") ||
@@ -927,10 +1051,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.
@@ -952,6 +1081,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");
@@ -964,6 +1102,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)
@@ -995,7 +1136,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")
@@ -1489,4 +1630,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