]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeX.cpp
avoid float-conversion warning and simplify size computation
[lyx.git] / src / LaTeX.cpp
index 5623bd2c1304065d1e2e0b169911fe2e1efbf70f..55e31ec1c1a849e2392db45343bdbf3ebf62f7af 100644 (file)
@@ -49,7 +49,6 @@ namespace os = support::os;
 //   different way.
 // - the makeindex style files should be taken care of with
 //   the dependency mechanism.
-// - we should perhaps also scan the bibtex log file
 
 namespace {
 
@@ -93,8 +92,9 @@ 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)
+            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 ?
@@ -106,12 +106,16 @@ 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
 {
-       // currently just a dummy function.
+       // 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?
 
@@ -143,6 +147,9 @@ void LaTeX::deleteFilesOnError() const
        // Also remove the aux file
        FileName const aux(changeExtension(file.absFileName(), ".aux"));
        aux.removeFile();
+
+       // Remove the output file, which is often generated even if error
+       output_file.removeFile();
 }
 
 
@@ -154,6 +161,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 +172,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
@@ -184,7 +190,7 @@ int LaTeX::run(TeXErrors & terr)
 
        bool had_depfile = depfile.exists();
        bool run_bibtex = false;
-       FileName const aux_file(changeExtension(file.absFileName(), "aux"));
+       FileName const aux_file(changeExtension(file.absFileName(), ".aux"));
 
        if (had_depfile) {
                LYXERR(Debug::DEPEND, "Dependency file exists");
@@ -226,7 +232,8 @@ int LaTeX::run(TeXErrors & terr)
        LYXERR(Debug::LATEX, "Run #" << count);
        message(runMessage(count));
 
-       startscript();
+       int const exit_code = startscript();
+
        scanres = scanLogFile(terr);
        if (scanres & ERROR_RERUN) {
                LYXERR(Debug::LATEX, "Rerunning LaTeX");
@@ -234,11 +241,6 @@ int LaTeX::run(TeXErrors & terr)
                scanres = scanLogFile(terr);
        }
 
-       if (scanres & ERRORS) {
-               deleteFilesOnError();
-               return scanres; // return on error
-       }
-
        vector<AuxInfo> const bibtex_info = scanAuxFiles(aux_file);
        if (!run_bibtex && bibtex_info_old != bibtex_info)
                run_bibtex = true;
@@ -269,7 +271,12 @@ int LaTeX::run(TeXErrors & terr)
                                runparams);
        }
        FileName const nlofile(changeExtension(file.absFileName(), ".nlo"));
-       if (head.haschanged(nlofile))
+       // 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()))
                rerun |= runMakeIndexNomencl(file, ".nlo", ".nls");
        FileName const glofile(changeExtension(file.absFileName(), ".glo"));
        if (head.haschanged(glofile))
@@ -292,14 +299,9 @@ int LaTeX::run(TeXErrors & terr)
                message(_("Running BibTeX."));
                updateBibtexDependencies(head, bibtex_info);
                rerun |= runBibTeX(bibtex_info, runparams);
-               if (biber) {
-                       // since biber writes no info to the aux file, we have
-                       // to parse the blg file (which only exists after biber
-                       // was first issued)
-                       FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
-                       if (blgfile.exists())
-                               scanBlgFile(head);
-               }
+               FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
+               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
@@ -327,10 +329,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
@@ -352,6 +350,9 @@ int LaTeX::run(TeXErrors & terr)
                message(_("Running BibTeX."));
                updateBibtexDependencies(head, bibtex_info);
                rerun |= runBibTeX(bibtex_info, runparams);
+               FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
+               if (blgfile.exists())
+                       bscanres = scanBlgFile(head, terr);
        }
 
        // 4
@@ -398,10 +399,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();
@@ -409,7 +406,15 @@ int LaTeX::run(TeXErrors & terr)
 
        // Write the dependencies to file.
        head.write(depfile);
+
+       if (exit_code)
+               scanres |= NONZERO_ERROR;
+
        LYXERR(Debug::LATEX, "Done.");
+
+       if (bscanres & ERRORS)
+               return bscanres; // return on error
+
        return scanres;
 }
 
@@ -421,7 +426,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);
 }
 
 
@@ -448,7 +453,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;
 }
 
@@ -464,7 +469,7 @@ 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;
 }
 
@@ -578,7 +583,8 @@ void LaTeX::updateBibtexDependencies(DepTable & dep,
        // biber writes nothing into the aux file.
        // Instead, we have to scan the blg file
        if (biber) {
-               scanBlgFile(dep);
+               TeXErrors terr;
+               scanBlgFile(dep, terr);
        }
 }
 
@@ -603,7 +609,7 @@ bool LaTeX::runBibTeX(vector<AuxInfo> const & bibtex_info,
                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;
@@ -621,8 +627,8 @@ int LaTeX::scanLogFile(TeXErrors & terr)
        FileName const fn = FileName(makeAbsPath(tmp));
        ifstream ifs(fn.toFilesystemEncoding().c_str());
        bool fle_style = false;
-       static regex file_line_error(".+\\.\\D+:[0-9]+: (.+)");
-       static regex child_file(".*([0-9]+[A-Za-z]*_.+\\.tex).*");
+       static regex const file_line_error(".+\\.\\D+:[0-9]+: (.+)");
+       static regex const child_file(".*([0-9]+[A-Za-z]*_.+\\.tex).*");
        // Flag for 'File ended while scanning' message.
        // We need to wait for subsequent processing.
        string wait_for_error;
@@ -653,8 +659,8 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                                size_t len = j == string::npos
                                                ? token.substr(i + 1).length()
                                                : j - i - 1;
-                               if (regex_match(token.substr(i + 1, len),
-                                                       sub, child_file)) {
+                               string const substr = token.substr(i + 1, len);
+                               if (regex_match(substr, sub, child_file)) {
                                        string const name = sub.str(1);
                                        child.push(make_pair(name, pnest));
                                        i += len;
@@ -694,6 +700,10 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                                   && contains(token, "on page")
                                   && contains(token, "undefined")) {
                                retval |= UNDEF_CIT;
+                       } else if (contains(token, "Citation")
+                                  && contains(token, "on input line")
+                                  && contains(token, "undefined")) {
+                               retval |= UNDEF_CIT;
                        }
                } else if (prefixIs(token, "Package")) {
                        // Package warnings
@@ -792,16 +802,21 @@ 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.")) {
                                // we have a latex error
                                retval |=  TEX_ERROR;
                                if (contains(desc,
-                                   "Package babel Error: You haven't defined the language") ||
-                                   contains(desc,
-                                   "Package babel Error: You haven't loaded the option"))
+                                       "Package babel Error: You haven't defined the language")
+                                   || contains(desc,
+                                       "Package babel Error: You haven't loaded the option")
+                                   || contains(desc,
+                                       "Package babel Error: Unknown language"))
                                        retval |= ERROR_RERUN;
                                // get the line number:
                                int line = 0;
@@ -996,7 +1011,7 @@ bool completeFilename(string const & ff, DepTable & head)
 }
 
 
-int iterateLine(string const token, regex const reg, string const closing,
+int iterateLine(string const & token, regex const & reg, string const & closing,
                int fragment_pos, DepTable & head)
 {
        smatch what;
@@ -1196,7 +1211,7 @@ void LaTeX::deplog(DepTable & head)
                // (and in addition to those above)
                if (regex_match(token, sub, reg5)) {
                        // search for strings in <...>
-                       static regex reg5_1("<([^>]+)(.)");
+                       static regex const reg5_1("<([^>]+)(.)");
                        fragment_pos = iterateLine(token, reg5_1, ">",
                                                   fragment_pos, head);
                        fragment = (fragment_pos != -1);
@@ -1209,7 +1224,7 @@ void LaTeX::deplog(DepTable & head)
                // where "File: file.ext" would be skipped
                if (regex_match(token, sub, reg6)) {
                        // search for strings in (...)
-                       static regex reg6_1("\\(([^()]+)(.)");
+                       static regex const reg6_1("\\(([^()]+)(.)");
                        fragment_pos = iterateLine(token, reg6_1, ")",
                                                   fragment_pos, head);
                        fragment = (fragment_pos != -1);
@@ -1229,7 +1244,7 @@ void LaTeX::deplog(DepTable & head)
 }
 
 
-void LaTeX::scanBlgFile(DepTable & dep)
+int LaTeX::scanBlgFile(DepTable & dep, TeXErrors & terr)
 {
        FileName const blg_file(changeExtension(file.absFileName(), "blg"));
        LYXERR(Debug::LATEX, "Scanning blg file: " << blg_file);
@@ -1237,7 +1252,15 @@ void LaTeX::scanBlgFile(DepTable & dep)
        ifstream ifs(blg_file.toFilesystemEncoding().c_str());
        string token;
        static regex const reg1(".*Found (bibtex|BibTeX) data (file|source) '([^']+).*");
+       static regex const bibtexError("^(.*---line [0-9]+ of file).*$");
+       static regex const bibtexError2("^(.*---while reading file).*$");
+       static regex const bibtexError3("(A bad cross reference---).*");
+       static regex const bibtexError4("(Sorry---you've exceeded BibTeX's).*");
+       static regex const bibtexError5("\\*Please notify the BibTeX maintainer\\*");
+       static regex const biberError("^.*> (FATAL|ERROR) - (.*)$");
+       int retval = NO_ERRORS;
 
+       string prevtoken;
        while (getline(ifs, token)) {
                token = rtrim(token, "\r");
                smatch sub;
@@ -1251,7 +1274,42 @@ void LaTeX::scanBlgFile(DepTable & dep)
                                handleFoundFile(data, dep);
                        }
                }
-       } 
+               else if (regex_match(token, sub, bibtexError)
+                        || regex_match(token, sub, bibtexError2)
+                        || regex_match(token, sub, bibtexError4)
+                        || regex_match(token, sub, bibtexError5)) {
+                       retval |= BIBTEX_ERROR;
+                       string errstr = N_("BibTeX error: ") + token;
+                       string message;
+                       if ((prefixIs(token, "while executing---line")
+                            || prefixIs(token, "---line ")
+                            || prefixIs(token, "*Please notify the BibTeX"))
+                           && !prevtoken.empty()) {
+                               errstr = N_("BibTeX error: ") + prevtoken;
+                               message = prevtoken + '\n';
+                       }
+                       message += token;
+                       terr.insertError(0,
+                                        from_local8bit(errstr),
+                                        from_local8bit(message));
+               } else if (regex_match(prevtoken, sub, bibtexError3)) {
+                       retval |= BIBTEX_ERROR;
+                       string errstr = N_("BibTeX error: ") + prevtoken;
+                       string message = prevtoken + '\n' + token;
+                       terr.insertError(0,
+                                        from_local8bit(errstr),
+                                        from_local8bit(message));
+               } else if (regex_match(token, sub, biberError)) {
+                       retval |= BIBTEX_ERROR;
+                       string errstr = N_("Biber error: ") + sub.str(2);
+                       string message = token;
+                       terr.insertError(0,
+                                        from_local8bit(errstr),
+                                        from_local8bit(message));
+               }
+               prevtoken = token;
+       }
+       return retval;
 }