]> git.lyx.org Git - features.git/blobdiff - src/LaTeX.cpp
Amend 8a0715d0bdc3
[features.git] / src / LaTeX.cpp
index 31d61441ae786b2f7af61de25d818f1bd3221940..e0df744d516114629c3cbf8363dfc126ab1312be 100644 (file)
@@ -135,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.
@@ -305,63 +306,14 @@ int LaTeX::run(TeXErrors & 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 || ret == Systemcall::TIMEOUT)
-                       return ret;
-               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;
-       }
-
-
-       // 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
@@ -372,8 +324,8 @@ int LaTeX::run(TeXErrors & terr)
                // "\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);
@@ -390,7 +342,7 @@ int LaTeX::run(TeXErrors & 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
@@ -420,7 +372,7 @@ int LaTeX::run(TeXErrors & terr)
        }
 
        // 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
@@ -433,8 +385,8 @@ int LaTeX::run(TeXErrors & terr)
                // "\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);
@@ -446,37 +398,74 @@ int LaTeX::run(TeXErrors & 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);
+               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
@@ -606,8 +595,8 @@ int LaTeX::runMakeIndex(string const & f, OutputParams const & rp,
 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)));
@@ -767,7 +756,7 @@ bool LaTeX::runBibTeX(vector<AuxInfo> const & bibtex_info,
                                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;
@@ -794,7 +783,7 @@ int LaTeX::scanLogFile(TeXErrors & terr)
        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.