]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeX.cpp
Account for old versions of Pygments
[lyx.git] / src / LaTeX.cpp
index 22e32d35c33569fe20d647cefb6e55350b9eedf9..8597e6db6062aa0758ad76cbcee3166a94060be0 100644 (file)
@@ -18,6 +18,7 @@
 #include "BufferList.h"
 #include "LaTeX.h"
 #include "LyXRC.h"
+#include "LyX.h"
 #include "DepTable.h"
 
 #include "support/debug.h"
@@ -92,11 +93,18 @@ bool operator!=(AuxInfo const & a, AuxInfo const & o)
  */
 
 LaTeX::LaTeX(string const & latex, OutputParams const & rp,
-            FileName const & f, string const & p)
-       : cmd(latex), file(f), path(p), runparams(rp), biber(false)
+            FileName const & f, string const & p, string const & lp,
+            bool const clean_start)
+       : cmd(latex), file(f), path(p), lpath(lp), runparams(rp), biber(false)
 {
        num_errors = 0;
-       if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
+       // lualatex can still produce a DVI with --output-format=dvi. However,
+       // we do not use that internally (we use the "dvilualatex" command) so
+       // it would only happen from a custom converter. Thus, it is better to
+       // guess that lualatex produces a PDF than to guess a DVI.
+       // FIXME we should base the extension on the output format, which we should
+       // get in a robust way, e.g. from the converter.
+       if (prefixIs(cmd, "pdf") || prefixIs(cmd, "lualatex") || prefixIs(cmd, "xelatex")) {
                depfile = FileName(file.absFileName() + ".dep-pdf");
                output_file =
                        FileName(changeExtension(file.absFileName(), ".pdf"));
@@ -105,11 +113,17 @@ LaTeX::LaTeX(string const & latex, OutputParams const & rp,
                output_file =
                        FileName(changeExtension(file.absFileName(), ".dvi"));
        }
+       if (clean_start)
+               removeAuxiliaryFiles();
 }
 
 
-void LaTeX::deleteFilesOnError() const
+void LaTeX::removeAuxiliaryFiles() const
 {
+       // 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.
+
        // What files do we have to delete?
 
        // This will at least make latex do all the runs
@@ -141,6 +155,10 @@ void LaTeX::deleteFilesOnError() const
        FileName const aux(changeExtension(file.absFileName(), ".aux"));
        aux.removeFile();
 
+       // Also remove the .out file (e.g. hyperref bookmarks) (#9963)
+       FileName const out(changeExtension(file.absFileName(), ".out"));
+       out.removeFile();
+
        // Remove the output file, which is often generated even if error
        output_file.removeFile();
 }
@@ -154,6 +172,7 @@ int LaTeX::run(TeXErrors & terr)
        // each time the .tex file changes.
 {
        int scanres = NO_ERRORS;
+       int bscanres = NO_ERRORS;
        unsigned int count = 0; // number of times run
        num_errors = 0; // just to make sure.
        unsigned int const MAX_RUN = 6;
@@ -164,8 +183,6 @@ int LaTeX::run(TeXErrors & terr)
        theBufferList().updateIncludedTeXfiles(FileName::getcwd().absFileName(),
                runparams);
 
-       // Never write the depfile if an error was encountered.
-
        // 0
        // first check if the file dependencies exist:
        //     ->If it does exist
@@ -220,26 +237,23 @@ int LaTeX::run(TeXErrors & terr)
        /// in which case we will not need to run bibtex again.
        vector<AuxInfo> bibtex_info_old;
        if (!run_bibtex)
-               bibtex_info_old = scanAuxFiles(aux_file);
+               bibtex_info_old = scanAuxFiles(aux_file, runparams.only_childbibs);
 
        ++count;
        LYXERR(Debug::LATEX, "Run #" << count);
        message(runMessage(count));
 
-       startscript();
+       int exit_code = startscript();
+
        scanres = scanLogFile(terr);
        if (scanres & ERROR_RERUN) {
                LYXERR(Debug::LATEX, "Rerunning LaTeX");
-               startscript();
+               terr.clearErrors();
+               exit_code = startscript();
                scanres = scanLogFile(terr);
        }
 
-       if (scanres & ERRORS) {
-               deleteFilesOnError();
-               return scanres; // return on error
-       }
-
-       vector<AuxInfo> const bibtex_info = scanAuxFiles(aux_file);
+       vector<AuxInfo> const bibtex_info = scanAuxFiles(aux_file, runparams.only_childbibs);
        if (!run_bibtex && bibtex_info_old != bibtex_info)
                run_bibtex = true;
 
@@ -298,13 +312,8 @@ int LaTeX::run(TeXErrors & terr)
                updateBibtexDependencies(head, bibtex_info);
                rerun |= runBibTeX(bibtex_info, runparams);
                FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
-               if (blgfile.exists()) {
-                       int bscanres = scanBlgFile(head, terr);
-                       if (bscanres & ERRORS) {
-                               deleteFilesOnError();
-                               return bscanres; // return on error
-                       }
-               }
+               if (blgfile.exists())
+                       bscanres = scanBlgFile(head, terr);
        } else if (!had_depfile) {
                /// If we run pdflatex on the file after running latex on it,
                /// then we do not need to run bibtex, but we do need to
@@ -332,10 +341,6 @@ int LaTeX::run(TeXErrors & terr)
                message(runMessage(count));
                startscript();
                scanres = scanLogFile(terr);
-               if (scanres & ERRORS) {
-                       deleteFilesOnError();
-                       return scanres; // return on error
-               }
 
                // update the depedencies
                deplog(head); // reads the latex log
@@ -358,13 +363,8 @@ int LaTeX::run(TeXErrors & terr)
                updateBibtexDependencies(head, bibtex_info);
                rerun |= runBibTeX(bibtex_info, runparams);
                FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
-               if (blgfile.exists()) {
-                       int bscanres = scanBlgFile(head, terr);
-                       if (bscanres & ERRORS) {
-                               deleteFilesOnError();
-                               return bscanres; // return on error
-                       }
-               }
+               if (blgfile.exists())
+                       bscanres = scanBlgFile(head, terr);
        }
 
        // 4
@@ -411,10 +411,6 @@ int LaTeX::run(TeXErrors & terr)
                message(runMessage(count));
                startscript();
                scanres = scanLogFile(terr);
-               if (scanres & ERRORS) {
-                       deleteFilesOnError();
-                       return scanres; // return on error
-               }
 
                // keep this updated
                head.update();
@@ -422,16 +418,19 @@ int LaTeX::run(TeXErrors & terr)
 
        // Write the dependencies to file.
        head.write(depfile);
-       if (scanres & NO_OUTPUT) {
-               // A previous run could have left a PDF and since
-               // no PDF is created if NO_OUTPUT, we remove any
-               // existing PDF and temporary files so that an
-               // incorrect PDF is not displayed, which could otherwise
-               // happen if View is run again because the checksum will
-               // be the same so any lingering PDF will be viewed.
-               deleteFilesOnError();
+
+       if (exit_code) {
+               // add flag here, just before return, instead of when exit_code
+               // is defined because scanres is sometimes overwritten above
+               // (e.g. rerun)
+               scanres |= NONZERO_ERROR;
        }
+
        LYXERR(Debug::LATEX, "Done.");
+
+       if (bscanres & ERRORS)
+               return bscanres; // return on error
+
        return scanres;
 }
 
@@ -443,7 +442,7 @@ int LaTeX::startscript()
                     + quoteName(onlyFileName(file.toFilesystemEncoding()))
                     + " > " + os::nulldev();
        Systemcall one;
-       return one.startscript(Systemcall::Wait, tmp, path);
+       return one.startscript(Systemcall::Wait, tmp, path, lpath);
 }
 
 
@@ -470,7 +469,7 @@ bool LaTeX::runMakeIndex(string const & f, OutputParams const & runparams,
        tmp += quoteName(f);
        tmp += params;
        Systemcall one;
-       one.startscript(Systemcall::Wait, tmp, path);
+       one.startscript(Systemcall::Wait, tmp, path, lpath);
        return true;
 }
 
@@ -486,18 +485,32 @@ bool LaTeX::runMakeIndexNomencl(FileName const & file,
        tmp += " -o "
                + onlyFileName(changeExtension(file.toFilesystemEncoding(), nls));
        Systemcall one;
-       one.startscript(Systemcall::Wait, tmp, path);
+       one.startscript(Systemcall::Wait, tmp, path, lpath);
        return true;
 }
 
 
 vector<AuxInfo> const
-LaTeX::scanAuxFiles(FileName const & file)
+LaTeX::scanAuxFiles(FileName const & file, bool const only_childbibs)
 {
        vector<AuxInfo> result;
 
+       // With chapterbib, we have to bibtex all children's aux files
+       // but _not_ the master's!
+       if (only_childbibs) {
+               for (string const &s: children) {
+                       FileName fn =
+                               makeAbsPath(s, file.onlyPath().realPath());
+                       fn.changeExtension("aux");
+                       if (fn.exists())
+                               result.push_back(scanAuxFile(fn));
+               }
+               return result;
+       }
+
        result.push_back(scanAuxFile(file));
 
+       // This is for bibtopic
        string const basename = removeExtension(file.absFileName());
        for (int i = 1; i < 1000; ++i) {
                FileName const file2(basename
@@ -616,17 +629,13 @@ bool LaTeX::runBibTeX(vector<AuxInfo> const & bibtex_info,
                        continue;
                result = true;
 
-               string tmp = runparams.use_japanese ?
-                       lyxrc.jbibtex_command : lyxrc.bibtex_command;
-
-               if (!runparams.bibtex_command.empty())
-                       tmp = runparams.bibtex_command;
+               string tmp = runparams.bibtex_command;
                tmp += " ";
                // onlyFileName() is needed for cygwin
                tmp += quoteName(onlyFileName(removeExtension(
                                it->aux_file.absFileName())));
                Systemcall one;
-               one.startscript(Systemcall::Wait, tmp, path);
+               one.startscript(Systemcall::Wait, tmp, path, lpath);
        }
        // Return whether bibtex was run
        return result;
@@ -652,6 +661,7 @@ int LaTeX::scanLogFile(TeXErrors & terr)
        string child_name;
        int pnest = 0;
        stack <pair<string, int> > child;
+       children.clear();
 
        string token;
        while (getline(ifs, token)) {
@@ -680,6 +690,7 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                                if (regex_match(substr, sub, child_file)) {
                                        string const name = sub.str(1);
                                        child.push(make_pair(name, pnest));
+                                       children.push_back(name);
                                        i += len;
                                }
                        } else if (token[i] == ')') {
@@ -774,7 +785,7 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                        if (contains(token, "LaTeX Error:"))
                                retval |= LATEX_ERROR;
 
-                       if (prefixIs(token, "! File ended while scanning")){
+                       if (prefixIs(token, "! File ended while scanning")) {
                                if (prefixIs(token, "! File ended while scanning use of \\Hy@setref@link.")){
                                        // bug 7344. We must rerun LaTeX if hyperref has been toggled.
                                        retval |= ERROR_RERUN;
@@ -786,6 +797,12 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                                }
                        }
 
+                       if (prefixIs(token, "! Incomplete \\if")) {
+                               // bug 10666. At this point its not clear we finish with error.
+                               wait_for_error = desc;
+                               continue;
+                       }
+
                        if (prefixIs(token, "! Paragraph ended before \\Hy@setref@link was complete.")){
                                        // bug 7344. We must rerun LaTeX if hyperref has been toggled.
                                        retval |= ERROR_RERUN;
@@ -797,6 +814,7 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                                string errstr;
                                int count = 0;
                                errstr = wait_for_error;
+                               wait_for_error.clear();
                                do {
                                        if (!getline(ifs, tmp))
                                                break;
@@ -819,7 +837,10 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                                if (!getline(ifs, tmp))
                                        break;
                                tmp = rtrim(tmp, "\r");
-                               if (++count > 10)
+                               // 15 is somewhat arbitrarily chosen, based on practice.
+                               // We used 10 for 14 years and increased it to 15 when we
+                               // saw one case.
+                               if (++count > 15)
                                        break;
                        } while (!prefixIs(tmp, "l."));
                        if (prefixIs(tmp, "l.")) {
@@ -883,20 +904,43 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                        } else if (contains(token, "Rerun to get citations")) {
                                // Natbib seems to use this.
                                retval |= UNDEF_CIT;
-                       } else if (contains(token, "No pages of output")) {
-                               // A dvi file was not created
+                       } else if (contains(token, "No pages of output")
+                               || contains(token, "no pages of output")) {
+                               // No output file (e.g. the DVI or PDF) was created
                                retval |= NO_OUTPUT;
+                       } else if (contains(token, "Error 256 (driver return code)")) {
+                               // This is a xdvipdfmx driver error reported by XeTeX.
+                               // We have to check whether an output PDF file was created.
+                               FileName pdffile = file;
+                               pdffile.changeExtension("pdf");
+                               if (!pdffile.exists())
+                                       // No output PDF file was created (see #10076)
+                                       retval |= NO_OUTPUT;
                        } else if (contains(token, "That makes 100 errors")) {
-                               // More than 100 errors were reprted
+                               // More than 100 errors were reported
                                retval |= TOO_MANY_ERRORS;
-                       } else if (prefixIs(token, "!pdfTeX error:")){
+                       } else if (prefixIs(token, "!pdfTeX error:")) {
                                // otherwise we dont catch e.g.:
                                // !pdfTeX error: pdflatex (file feyn10): Font feyn10 at 600 not found
                                retval |= ERRORS;
-                                       terr.insertError(0,
-                                                        from_local8bit("pdfTeX Error"),
-                                                        from_local8bit(token),
-                                                        child_name);
+                               terr.insertError(0,
+                                                from_local8bit("pdfTeX Error"),
+                                                from_local8bit(token),
+                                                child_name);
+                       } else if (!ignore_missing_glyphs
+                                  && prefixIs(token, "Missing character: There is no ")
+                                  && !contains(token, "nullfont")) {
+                               // Warning about missing glyph in selected font
+                               // may be dataloss (bug 9610)
+                               // but can be ignored for 'nullfont' (bug 10394).
+                               retval |= LATEX_ERROR;
+                               terr.insertError(0,
+                                                from_local8bit("Missing glyphs!"),
+                                                from_local8bit(token),
+                                                child_name);
+                       } else if (!wait_for_error.empty()) {
+                               // We collect information until we know we have an error.
+                               wait_for_error += token + '\n';
                        }
                }
        }
@@ -952,8 +996,7 @@ bool handleFoundFile(string const & ff, DepTable & head)
                                        return true;
                                // strip off part after last space and try again
                                string tmp = strippedfile;
-                               string const stripoff =
-                                       rsplit(tmp, strippedfile, ' ');
+                               rsplit(tmp, strippedfile, ' ');
                                absname.set(strippedfile);
                                if (insertIfExists(absname, head))
                                        return true;
@@ -978,8 +1021,7 @@ bool handleFoundFile(string const & ff, DepTable & head)
                                break;
                        // strip off part after last space and try again
                        string strippedfile;
-                       string const stripoff =
-                               rsplit(foundfile, strippedfile, ' ');
+                       rsplit(foundfile, strippedfile, ' ');
                        foundfile = strippedfile;
                        onlyfile = onlyFileName(strippedfile);
                        absname = makeAbsPath(onlyfile);