]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeX.C
Scons: update_po target, part one: language_l10n.pot
[lyx.git] / src / LaTeX.C
index 61f2d92e3f7be97eae55eaa06fdd2319b0417cb8..a63b5604d3f5c54de40b72347b59505542538a3d 100644 (file)
@@ -8,6 +8,7 @@
  * \author Jean-Marc Lasgouttes
  * \author Angus Leeming
  * \author Dekel Tsur
+ * \author Jürgen Spitzmüller
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -29,6 +30,7 @@
 #include "support/os.h"
 
 #include <boost/filesystem/operations.hpp>
+#include <boost/filesystem/path.hpp>
 #include <boost/regex.hpp>
 
 #include <fstream>
@@ -49,6 +51,7 @@ using support::prefixIs;
 using support::quoteName;
 using support::removeExtension;
 using support::rtrim;
+using support::rsplit;
 using support::split;
 using support::subst;
 using support::suffixIs;
@@ -132,10 +135,12 @@ LaTeX::LaTeX(string const & latex, OutputParams const & rp,
        num_errors = 0;
        if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
                depfile = FileName(file.absFilename() + ".dep-pdf");
-               output_file = FileName(changeExtension(file.absFilename(), ".pdf"));
+               output_file =
+                       FileName(changeExtension(file.absFilename(), ".pdf"));
        } else {
                depfile = FileName(file.absFilename() + ".dep");
-               output_file = FileName(changeExtension(file.absFilename(), ".dvi"));
+               output_file =
+                       FileName(changeExtension(file.absFilename(), ".dvi"));
        }
 }
 
@@ -173,8 +178,8 @@ int LaTeX::run(TeXErrors & terr)
        // We know that this function will only be run if the lyx buffer
        // has been changed. We also know that a newly written .tex file
        // is always different from the previous one because of the date
-       // in it. However it seems safe to run latex (at least) on time each
-       // time the .tex file changes.
+       // in it. However it seems safe to run latex (at least) on time
+       // each time the .tex file changes.
 {
        int scanres = NO_ERRORS;
        unsigned int count = 0; // number of times run
@@ -184,7 +189,8 @@ int LaTeX::run(TeXErrors & terr)
        bool rerun = false; // rerun requested
 
        // The class LaTeX does not know the temp path.
-       theBufferList().updateIncludedTeXfiles(getcwd().absFilename(), runparams);
+       theBufferList().updateIncludedTeXfiles(getcwd().absFilename(),
+               runparams);
 
        // Never write the depfile if an error was encountered.
 
@@ -217,12 +223,14 @@ int LaTeX::run(TeXErrors & terr)
        if (had_depfile) {
                // Update the checksums
                head.update();
-               // Can't just check if anything has changed because it might have aborted
-               // on error last time... in which cas we need to re-run latex
-               // and collect the error messages (even if they are the same).
+               // Can't just check if anything has changed because it might
+               // have aborted on error last time... in which cas we need
+               // to re-run latex and collect the error messages 
+               // (even if they are the same).
                if (!fs::exists(output_file.toFilesystemEncoding())) {
                        lyxerr[Debug::DEPEND]
-                               << "re-running LaTeX because output file doesn't exist." << endl;
+                               << "re-running LaTeX because output file doesn't exist."
+                               << endl;
                } else if (!head.sumchange()) {
                        lyxerr[Debug::DEPEND] << "return no_change" << endl;
                        return NO_CHANGE;
@@ -235,7 +243,8 @@ int LaTeX::run(TeXErrors & terr)
                        run_bibtex = true;
        } else
                lyxerr[Debug::DEPEND]
-                       << "Dependency file does not exist, or has wrong format" << endl;
+                       << "Dependency file does not exist, or has wrong format"
+                       << endl;
 
        /// We scan the aux file even when had_depfile = false,
        /// because we can run pdflatex on the file after running latex on it,
@@ -288,14 +297,22 @@ int LaTeX::run(TeXErrors & terr)
                lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
                message(_("Running MakeIndex."));
                // onlyFilename() is needed for cygwin
-               rerun |= runMakeIndex(onlyFilename(idxfile.absFilename()), runparams);
+               rerun |= runMakeIndex(onlyFilename(idxfile.absFilename()),
+                               runparams);
        }
        if (head.haschanged(FileName(changeExtension(file.absFilename(), ".nlo")))) {
-               lyxerr[Debug::LATEX] << "Running MakeIndex for nomencl." << endl;
+               lyxerr[Debug::LATEX] 
+                       << "Running MakeIndex for nomencl."
+                       << endl;
                message(_("Running MakeIndex for nomencl."));
                // onlyFilename() is needed for cygwin
-               string const nomenclstr = " -s nomencl.ist -o " + onlyFilename(changeExtension(file.toFilesystemEncoding(), ".nls"));
-               rerun |= runMakeIndex(onlyFilename(changeExtension(file.absFilename(), ".nlo")), runparams, nomenclstr);
+               string const nomenclstr = " -s nomencl.ist -o " 
+                       + onlyFilename(changeExtension(
+                               file.toFilesystemEncoding(), ".nls"));
+               rerun |= runMakeIndex(onlyFilename(changeExtension(
+                               file.absFilename(), ".nlo")),
+                               runparams,
+                               nomenclstr);
        }
 
        // run bibtex
@@ -332,7 +349,8 @@ int LaTeX::run(TeXErrors & terr)
                rerun = false;
                ++count;
                lyxerr[Debug::DEPEND]
-                       << "Dep. file has changed or rerun requested" << endl;
+                       << "Dep. file has changed or rerun requested"
+                       << endl;
                lyxerr[Debug::LATEX]
                        << "Run #" << count << endl;
                message(runMessage(count));
@@ -347,7 +365,9 @@ int LaTeX::run(TeXErrors & terr)
                deplog(head); // reads the latex log
                head.update();
        } else {
-               lyxerr[Debug::DEPEND] << "Dep. file has NOT changed" << endl;
+               lyxerr[Debug::DEPEND]
+                       << "Dep. file has NOT changed"
+                       << endl;
        }
 
        // 1.5
@@ -364,16 +384,24 @@ int LaTeX::run(TeXErrors & terr)
                lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
                message(_("Running MakeIndex."));
                // onlyFilename() is needed for cygwin
-               rerun = runMakeIndex(onlyFilename(changeExtension(file.absFilename(), ".idx")), runparams);
+               rerun = runMakeIndex(onlyFilename(changeExtension(
+                               file.absFilename(), ".idx")), runparams);
        }
 
-       // I am not pretty sure if need this twice. 
+       // I am not pretty sure if need this twice.
        if (head.haschanged(FileName(changeExtension(file.absFilename(), ".nlo")))) {
-               lyxerr[Debug::LATEX] << "Running MakeIndex for nomencl." << endl;
+               lyxerr[Debug::LATEX] 
+                       << "Running MakeIndex for nomencl."
+                       << endl;
                message(_("Running MakeIndex for nomencl."));
                // onlyFilename() is needed for cygwin
-               string nomenclstr = " -s nomencl.ist -o " + onlyFilename(changeExtension(file.toFilesystemEncoding(), ".nls"));
-               rerun |= runMakeIndex(onlyFilename(changeExtension(file.absFilename(), ".nlo")), runparams, nomenclstr);
+               string nomenclstr = " -s nomencl.ist -o " 
+                       + onlyFilename(changeExtension(
+                               file.toFilesystemEncoding(), ".nls"));
+               rerun |= runMakeIndex(onlyFilename(changeExtension(
+                               file.absFilename(), ".nlo")),
+                               runparams,
+                               nomenclstr);
        }
 
        // 2
@@ -415,7 +443,9 @@ int LaTeX::run(TeXErrors & terr)
 int LaTeX::startscript()
 {
        // onlyFilename() is needed for cygwin
-       string tmp = cmd + ' ' + quoteName(onlyFilename(file.toFilesystemEncoding())) + " > " + os::nulldev();
+       string tmp = cmd + ' '
+                    + quoteName(onlyFilename(file.toFilesystemEncoding()))
+                    + " > " + os::nulldev();
        Systemcall one;
        return one.startscript(Systemcall::Wait, tmp);
 }
@@ -481,6 +511,9 @@ void LaTeX::scanAuxFile(FileName const & file, Aux_Info & aux_info)
        while (getline(ifs, token)) {
                token = rtrim(token, "\r");
                smatch sub;
+               // FIXME UNICODE: We assume that citation keys and filenames
+               // in the aux file are in the file system encoding.
+               token = to_utf8(from_filesystem8bit(token));
                if (regex_match(token, sub, reg1)) {
                        string data = sub.str(1);
                        while (!data.empty()) {
@@ -557,7 +590,8 @@ bool LaTeX::runBibTeX(vector<Aux_Info> const & bibtex_info)
 
                string tmp = lyxrc.bibtex_command + " ";
                // onlyFilename() is needed for cygwin
-               tmp += quoteName(onlyFilename(removeExtension(it->aux_file.absFilename())));
+               tmp += quoteName(onlyFilename(removeExtension(
+                               it->aux_file.absFilename())));
                Systemcall one;
                one.startscript(Systemcall::Wait, tmp);
        }
@@ -571,7 +605,8 @@ int LaTeX::scanLogFile(TeXErrors & terr)
        int last_line = -1;
        int line_count = 1;
        int retval = NO_ERRORS;
-       string tmp = onlyFilename(changeExtension(file.absFilename(), ".log"));
+       string tmp =
+               onlyFilename(changeExtension(file.absFilename(), ".log"));
        lyxerr[Debug::LATEX] << "Log file: " << tmp << endl;
        FileName const fn = FileName(makeAbsPath(tmp));
        ifstream ifs(fn.toFilesystemEncoding().c_str());
@@ -653,7 +688,8 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                        if (prefixIs(tmp, "l.")) {
                                // we have a latex error
                                retval |=  TEX_ERROR;
-                               if (contains(desc, "Package babel Error: You haven't defined the language"))
+                               if (contains(desc,
+                                   "Package babel Error: You haven't defined the language"))
                                        retval |= ERROR_RERUN;
                                // get the line number:
                                int line = 0;
@@ -683,9 +719,15 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                                if (line_count <= 5) {
                                        // FIXME UNICODE
                                        // We have no idea what the encoding of
-                                       // the log file is, but it is safe to
-                                       // assume it is the current locale one.
-                                       terr.insertError(line, from_local8bit(desc), from_local8bit(errstr));
+                                       // the log file is.
+                                       // It seems that the output from the
+                                       // latex compiler itself is pure ASCII,
+                                       // but it can include bits from the
+                                       // document, so whatever encoding we
+                                       // assume here it can be wrong.
+                                       terr.insertError(line,
+                                                        from_local8bit(desc),
+                                                        from_local8bit(errstr));
                                        ++num_errors;
                                }
                        }
@@ -715,10 +757,42 @@ int LaTeX::scanLogFile(TeXErrors & terr)
 
 namespace {
 
-void handleFoundFile(string const & ff, DepTable & head)
+/**
+ * Wrapper around fs::exists that can handle invalid file names.
+ * In theory we could test with fs::native whether a filename is valid
+ * before calling fs::exists, but in practice it is unusable: On windows it
+ * does not allow spaces, and on unix it does not allow absolute file names.
+ * This function has the disadvantage that it catches also other errors than
+ * invalid names, but for dependency checking we can live with that.
+ */
+bool exists(FileName const & possible_name) {
+       try {
+               return fs::exists(possible_name.toFilesystemEncoding());
+       }
+       catch (fs::filesystem_error const & fe) {
+               lyxerr[Debug::DEPEND] << "Got error `" << fe.what()
+                       << "' while checking whether file `" << possible_name
+                       << "' exists." << endl;
+               return false;
+       }
+}
+
+
+bool insertIfExists(FileName const & absname, DepTable & head)
+{
+       if (exists(absname) &&
+           !fs::is_directory(absname.toFilesystemEncoding())) {
+               head.insert(absname, true);
+               return true;
+       }
+       return false;
+}
+
+
+bool handleFoundFile(string const & ff, DepTable & head)
 {
        // convert from native os path to unix path
-       string const foundfile = os::internal_path(trim(ff));
+       string foundfile = os::internal_path(trim(ff));
 
        lyxerr[Debug::DEPEND] << "Found file: " << foundfile << endl;
 
@@ -737,20 +811,57 @@ void handleFoundFile(string const & ff, DepTable & head)
                // On initial insert we want to do the update at once
                // since this file cannot be a file generated by
                // the latex run.
-               FileName const absname(foundfile);
-               if (fs::exists(absname.toFilesystemEncoding()) &&
-                   !fs::is_directory(absname.toFilesystemEncoding()))
-                       head.insert(absname, true);
-
-               return;
+               FileName absname(foundfile);
+               if (!insertIfExists(absname, head)) {
+                       // check for spaces
+                       string strippedfile = foundfile;
+                       while (contains(strippedfile, " ")) {
+                               // files with spaces are often enclosed in quotation
+                               // marks; those have to be removed
+                               string unquoted = subst(strippedfile, "\"", "");
+                               absname.set(unquoted);
+                               if (insertIfExists(absname, head))
+                                       return true;
+                               // strip off part after last space and try again
+                               string tmp = strippedfile;
+                               string const stripoff =
+                                       rsplit(tmp, strippedfile, ' ');
+                               absname.set(strippedfile);
+                               if (insertIfExists(absname, head))
+                                       return true;
+                       }
+               }
        }
 
-       string const onlyfile = onlyFilename(foundfile);
-       FileName const absname(makeAbsPath(onlyfile));
+       string onlyfile = onlyFilename(foundfile);
+       FileName absname(makeAbsPath(onlyfile));
+
+       // check for spaces
+       while (contains(foundfile, ' ')) {
+               if (exists(absname))
+                       // everything o.k.
+                       break;
+               else {
+                       // files with spaces are often enclosed in quotation
+                       // marks; those have to be removed
+                       string unquoted = subst(foundfile, "\"", "");
+                       absname = makeAbsPath(unquoted);
+                       if (exists(absname))
+                               break;
+                       // strip off part after last space and try again
+                       string strippedfile;
+                       string const stripoff =
+                               rsplit(foundfile, strippedfile, ' ');
+                       foundfile = strippedfile;
+                       onlyfile = onlyFilename(strippedfile);
+                       absname = makeAbsPath(onlyfile);
+               }
+       }
 
        // (2) foundfile is in the tmpdir
        //     insert it into head
-       if (fs::exists(absname.toFilesystemEncoding())) {
+       if (exists(absname) &&
+           !fs::is_directory(absname.toFilesystemEncoding())) {
                static regex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$");
                if (regex_match(onlyfile, unwanted)) {
                        lyxerr[Debug::DEPEND]
@@ -774,10 +885,24 @@ void handleFoundFile(string const & ff, DepTable & head)
                                << endl;
                        head.insert(absname);
                }
-       } else
+               return true;
+       } else {
                lyxerr[Debug::DEPEND]
                        << "Not a file or we are unable to find it."
                        << endl;
+               return false;
+       }
+}
+
+
+bool checkLineBreak(string const & ff, DepTable & head)
+{
+       if (contains(ff, '.'))
+               // if we have a dot, we let handleFoundFile decide
+               return handleFoundFile(ff, head);
+       else
+               // else, we suspect a line break
+               return false;
 }
 
 } // anon namespace
@@ -785,22 +910,24 @@ void handleFoundFile(string const & ff, DepTable & head)
 
 void LaTeX::deplog(DepTable & head)
 {
-       // This function reads the LaTeX log file end extracts all the external
-       // files used by the LaTeX run. The files are then entered into the
-       // dependency file.
+       // This function reads the LaTeX log file end extracts all the
+       // external files used by the LaTeX run. The files are then
+       // entered into the dependency file.
 
-       string const logfile = onlyFilename(changeExtension(file.absFilename(), ".log"));
+       string const logfile =
+               onlyFilename(changeExtension(file.absFilename(), ".log"));
 
-       static regex reg1(".*\\([^)]+.*");
-       static regex reg2("File: ([^ ]+).*");
-       static regex reg3("No file ([^ ]+)\\..*");
-       static regex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*");
+       static regex reg1("File: (.+).*");
+       static regex reg2("No file (.+)(.).*");
+       static regex reg3("\\\\openout[0-9]+.*=.*`(.+)(..).*");
        // If an index should be created, MikTex does not write a line like
        //    \openout# = 'sample.idx'.
        // but instead only a line like this into the log:
        //   Writing index file sample.idx
-       static regex reg5("Writing index file ([^ ]+).*");
-       static regex regnomencl("Writing nomenclature file ([^ ]+).*");
+       static regex reg4("Writing index file (.+).*");
+       // files also can be enclosed in <...>
+       static regex reg5("<([^>]+)(.).*");
+       static regex regnomencl("Writing nomenclature file (.+).*");
        // If a toc should be created, MikTex does not write a line like
        //    \openout# = `sample.toc'.
        // but only a line like this into the log:
@@ -808,17 +935,17 @@ void LaTeX::deplog(DepTable & head)
        // This line is also written by tetex.
        // This line is not present if no toc should be created.
        static regex miktexTocReg("\\\\tf@toc=\\\\write.*");
+       static regex reg6(".*\\([^)]+.*");
 
        FileName const fn(makeAbsPath(logfile));
        ifstream ifs(fn.toFilesystemEncoding().c_str());
+       string lastline;
        while (ifs) {
                // Ok, the scanning of files here is not sufficient.
                // Sometimes files are named by "File: xxx" only
                // So I think we should use some regexps to find files instead.
-               // "(\([^ ]+\)"   should match the "(file " variant, note
-               // that we can have several of these on one line.
-               // "File: \([^ ]+\)" should match the "File: file" variant
-
+               // Note: all file names and paths might contains spaces.
+               bool found_file = false;
                string token;
                getline(ifs, token);
                // MikTeX sometimes inserts \0 in the log file. They can't be
@@ -827,36 +954,147 @@ void LaTeX::deplog(DepTable & head)
                // \r's afterwards, since we need to remove them anyway.
                token = subst(token, '\0', '\r');
                token = subst(token, "\r", "");
-               if (token.empty())
+               if (token.empty() || token == ")") {
+                       lastline = string();
                        continue;
+               }
+
+               // Sometimes, filenames are broken across lines.
+               // We care for that and save suspicious lines.
+               // Here we exclude some cases where we are sure 
+               // that there is no continued filename
+               if (!lastline.empty()) {
+                       static regex package_info("Package \\w+ Info: .*");
+                       static regex package_warning("Package \\w+ Warning: .*");
+                       if (prefixIs(token, "File:") || prefixIs(token, "(Font)")
+                           || prefixIs(token, "Package:")
+                           || prefixIs(token, "Language:")
+                           || prefixIs(token, "LaTeX Info:")
+                           || prefixIs(token, "LaTeX Font Info:")
+                           || prefixIs(token, "\\openout[")
+                           || prefixIs(token, "))")
+                           || regex_match(token, package_info)
+                           || regex_match(token, package_warning))
+                               lastline = string();
+               }
+
+               if (!lastline.empty())
+                       // probably a continued filename from last line
+                       token = lastline + token;
+               if (token.length() > 255) {
+                       // string too long. Cut off.
+                       token.erase(0, token.length() - 251);
+               }
 
                smatch sub;
 
+               // FIXME UNICODE: We assume that the file names in the log
+               // file are in the file system encoding.
+               token = to_utf8(from_filesystem8bit(token));
+
+               // (1) "File: file.ext"
                if (regex_match(token, sub, reg1)) {
-                       static regex reg1_1("\\(([^()]+)");
+                       // check for dot
+                       found_file = checkLineBreak(sub.str(1), head);
+                       // However, ...
+                       if (suffixIs(token, ")"))
+                               // no line break for sure
+                               // pretend we've been succesfully searching
+                               found_file = true;
+               // (2) "No file file.ext"
+               } else if (regex_match(token, sub, reg2)) {
+                       // file names must contains a dot, line ends with dot
+                       if (contains(sub.str(1), '.') && sub.str(2) == ".")
+                               found_file = handleFoundFile(sub.str(1), head);
+                       else
+                               // we suspect a line break
+                               found_file = false;
+               // (3) "\openout<nr> = `file.ext'."
+               } else if (regex_match(token, sub, reg3)) {
+                       // search for closing '. at the end of the line
+                       if (sub.str(2) == "\'.")
+                               found_file = handleFoundFile(sub.str(1), head);
+                       else
+                               // probable line break
+                               found_file = false;
+               // (4) "Writing index file file.ext"
+               } else if (regex_match(token, sub, reg4))
+                       // check for dot
+                       found_file = checkLineBreak(sub.str(1), head);
+               // (5) "<file.ext>"
+               else if (regex_match(token, sub, reg5)) {
+                       // search for closing '>' and dot ('*.*>') at the eol
+                       if (contains(sub.str(1), '.') && sub.str(2) == ">")
+                               found_file = handleFoundFile(sub.str(1), head);
+                       else
+                               // probable line break
+                               found_file = false;
+               // (6) "Writing nomenclature file file.ext"
+               } else if (regex_match(token, sub, regnomencl))
+                       // check for dot
+                       found_file = checkLineBreak(sub.str(1), head);
+               // (7) "\tf@toc=\write<nr>" (for MikTeX)
+               else if (regex_match(token, sub, miktexTocReg))
+                       found_file = handleFoundFile(onlyFilename(changeExtension(
+                                               file.absFilename(), ".toc")), head);
+               else
+                       // not found, but we won't check further
+                       // pretend we've been succesfully searching
+                       found_file = true;
+
+               // (8) "(file.ext"
+               // note that we can have several of these on one line
+               // this must be queried separated, because of
+               // cases such as "File: file.ext (type eps)"
+               // where "File: file.ext" would be skipped
+               if (regex_match(token, sub, reg6)) {
+                       // search for strings in (...)
+                       static regex reg6_1("\\(([^()]+)(.).*");
                        smatch what;
                        string::const_iterator first = token.begin();
                        string::const_iterator end = token.end();
 
-                       while (regex_search(first, end, what, reg1_1)) {
-                               first = what[0].second;
-                               handleFoundFile(what.str(1), head);
+                       while (regex_search(first, end, what, reg6_1)) {
+                               // if we have a dot, try to handle as file
+                               if (contains(what.str(1), '.')) {
+                                       first = what[0].second;
+                                       if (what.str(2) == ")") {
+                                               handleFoundFile(what.str(1), head);
+                                               // since we had a closing bracket,
+                                               // do not investigate further
+                                               found_file = true;
+                                       } else
+                                               // if we have no closing bracket,
+                                               // try to handle as file nevertheless
+                                               found_file = handleFoundFile(
+                                                       what.str(1) + what.str(2), head);
+                               }
+                               // if we do not have a dot, check if the line has
+                               // a closing bracket (else, we suspect a line break)
+                               else if (what.str(2) != ")") {
+                                       first = what[0].second;
+                                       found_file = false;
+                               } else {
+                                       // we have a closing bracket, so the content
+                                       // is not a file name.
+                                       // no need to investigate further
+                                       // pretend we've been succesfully searching
+                                       first = what[0].second;
+                                       found_file = true;
+                               }
                        }
-               } else if (regex_match(token, sub, reg2))
-                       handleFoundFile(sub.str(1), head);
-               else if (regex_match(token, sub, reg3))
-                       handleFoundFile(sub.str(1), head);
-               else if (regex_match(token, sub, reg4))
-                       handleFoundFile(sub.str(1), head);
-               else if (regex_match(token, sub, reg5))
-                       handleFoundFile(sub.str(1), head);
-               else if (regex_match(token, sub, regnomencl))
-                       handleFoundFile(sub.str(1), head);
-               else if (regex_match(token, sub, miktexTocReg))
-                       handleFoundFile(onlyFilename(changeExtension(file.absFilename(), ".toc")), head);
+               }
+
+               if (!found_file)
+                       // probable linebreak:
+                       // save this line
+                       lastline = token;
+               else
+                       // no linebreak: reset
+                       lastline = string();
        }
 
-       // Make sure that the main .tex file is in the dependancy file.
+       // Make sure that the main .tex file is in the dependency file.
        head.insert(file, true);
 }