]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeX.C
hopefully fix tex2lyx linking.
[lyx.git] / src / LaTeX.C
index e748be39c8d8bf988b5e316598283ebecfa81a80..8c8091fe4fc13e68c3f258821e07f82d49cc5472 100644 (file)
 
 #include <config.h>
 
-#include "LaTeX.h"
 #include "bufferlist.h"
+#include "LaTeX.h"
 #include "gettext.h"
 #include "lyxrc.h"
 #include "debug.h"
 #include "DepTable.h"
+
 #include "support/filetools.h"
 #include "support/convert.h"
 #include "support/lstrings.h"
 
 #include <fstream>
 
-using lyx::support::AbsolutePath;
-using lyx::support::bformat;
-using lyx::support::ChangeExtension;
-using lyx::support::contains;
-using lyx::support::findtexfile;
-using lyx::support::getcwd;
-using lyx::support::OnlyFilename;
-using lyx::support::prefixIs;
-using lyx::support::QuoteName;
-using lyx::support::rtrim;
-using lyx::support::split;
-using lyx::support::subst;
-using lyx::support::suffixIs;
-using lyx::support::Systemcall;
-using lyx::support::unlink;
-using lyx::support::trim;
-
-namespace os = lyx::support::os;
+
+namespace lyx {
+
+using support::absolutePath;
+using support::bformat;
+using support::changeExtension;
+using support::contains;
+using support::findtexfile;
+using support::getcwd;
+using support::onlyFilename;
+using support::prefixIs;
+using support::quoteName;
+using support::rtrim;
+using support::split;
+using support::subst;
+using support::suffixIs;
+using support::Systemcall;
+using support::unlink;
+using support::trim;
+
+namespace os = support::os;
 namespace fs = boost::filesystem;
 
 using boost::regex;
@@ -68,7 +72,7 @@ using std::set;
 using std::vector;
 
 // TODO: in no particular order
-// - get rid of the extern BufferList and the call to
+// - get rid of the call to
 //   BufferList::updateIncludedTeXfiles, this should either
 //   be done before calling LaTeX::funcs or in a completely
 //   different way.
@@ -78,11 +82,9 @@ using std::vector;
 // - somewhere support viewing of bibtex and makeindex log files.
 // - we should perhaps also scan the bibtex log file
 
-extern BufferList bufferlist;
-
 namespace {
 
-string runMessage(unsigned int count)
+docstring runMessage(unsigned int count)
 {
        return bformat(_("Waiting for LaTeX run number %1$d"), count);
 }
@@ -93,8 +95,8 @@ string runMessage(unsigned int count)
  * CLASS TEXERRORS
  */
 
-void TeXErrors::insertError(int line, string const & error_desc,
-                           string const & error_text)
+void TeXErrors::insertError(int line, docstring const & error_desc,
+                           docstring const & error_text)
 {
        Error newerr(line, error_desc, error_text);
        errors.push_back(newerr);
@@ -128,9 +130,9 @@ LaTeX::LaTeX(string const & latex, OutputParams const & rp,
        depfile = file + ".dep";
        if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
                depfile += "-pdf";
-               output_file = ChangeExtension(file,".pdf");
+               output_file = changeExtension(file,".pdf");
        } else {
-               output_file = ChangeExtension(file,".dvi");
+               output_file = changeExtension(file,".dvi");
        }
 }
 
@@ -146,18 +148,22 @@ void LaTeX::deleteFilesOnError() const
 
        // but the reason for the error might be in a generated file...
 
-       string const ofname = OnlyFilename(file);
+       string const ofname = onlyFilename(file);
 
        // bibtex file
-       string const bbl = ChangeExtension(ofname, ".bbl");
+       string const bbl = changeExtension(ofname, ".bbl");
        unlink(bbl);
 
        // makeindex file
-       string const ind = ChangeExtension(ofname, ".ind");
+       string const ind = changeExtension(ofname, ".ind");
        unlink(ind);
 
+       // nomencl file
+       string const nls = changeExtension(ofname, ".nls");
+       unlink(nls);
+
        // Also remove the aux file
-       string const aux = ChangeExtension(ofname, ".aux");
+       string const aux = changeExtension(ofname, ".aux");
        unlink(aux);
 }
 
@@ -177,7 +183,7 @@ int LaTeX::run(TeXErrors & terr)
        bool rerun = false; // rerun requested
 
        // The class LaTeX does not know the temp path.
-       bufferlist.updateIncludedTeXfiles(getcwd(), runparams);
+       theBufferList().updateIncludedTeXfiles(getcwd(), runparams);
 
        // Never write the depfile if an error was encountered.
 
@@ -199,7 +205,7 @@ int LaTeX::run(TeXErrors & terr)
 
        bool had_depfile = fs::exists(depfile);
        bool run_bibtex = false;
-       string aux_file = OnlyFilename(ChangeExtension(file, "aux"));
+       string aux_file = onlyFilename(changeExtension(file, "aux"));
 
        if (had_depfile) {
                lyxerr[Debug::DEPEND] << "Dependency file exists" << endl;
@@ -269,12 +275,23 @@ int LaTeX::run(TeXErrors & terr)
        // 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.
+       rerun = fs::exists(changeExtension(file, ".idx"))
+               && fs::is_empty(changeExtension(file, ".idx"));
+
        // run makeindex
-       if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
+       if (head.haschanged(onlyFilename(changeExtension(file, ".idx")))) {
                // no checks for now
                lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
                message(_("Running MakeIndex."));
-               rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")), runparams);
+               rerun |= runMakeIndex(onlyFilename(changeExtension(file, ".idx")), runparams);
+       }
+       if (head.haschanged(onlyFilename(changeExtension(file, ".nlo")))) {
+               lyxerr[Debug::LATEX] << "Running MakeIndex for nomencl." << endl;
+               message(_("Running MakeIndex for nomencl."));
+               string const nomenclstr = " -s nomencl.ist -o " + changeExtension(file, ".nls");
+               rerun |= runMakeIndex(onlyFilename(changeExtension(file, ".nlo")), runparams, nomenclstr);
        }
 
        // run bibtex
@@ -331,18 +348,26 @@ int LaTeX::run(TeXErrors & terr)
 
        // 1.5
        // The inclusion of files generated by external programs like
-       // makeindex or bibtex might have done changes to pagenumbereing,
+       // 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(OnlyFilename(ChangeExtension(file, ".idx")))) {
+       if (head.haschanged(onlyFilename(changeExtension(file, ".idx")))) {
                // no checks for now
                lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
                message(_("Running MakeIndex."));
-               rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")), runparams);
+               rerun = runMakeIndex(onlyFilename(changeExtension(file, ".idx")), runparams);
+       }
+
+       // I am not pretty sure if need this twice. 
+       if (head.haschanged(onlyFilename(changeExtension(file, ".nlo")))) {
+               lyxerr[Debug::LATEX] << "Running MakeIndex for nomencl." << endl;
+               message(_("Running MakeIndex for nomencl."));
+               string nomenclstr = " -s nomencl.ist -o " + changeExtension(file, ".nls");
+               rerun |= runMakeIndex(onlyFilename(changeExtension(file, ".nlo")), runparams, nomenclstr);
        }
 
        // 2
@@ -383,20 +408,23 @@ int LaTeX::run(TeXErrors & terr)
 
 int LaTeX::startscript()
 {
-       string tmp = cmd + ' ' + QuoteName(file) + " > " + os::nulldev();
+       string tmp = cmd + ' ' + quoteName(file) + " > " + os::nulldev();
        Systemcall one;
        return one.startscript(Systemcall::Wait, tmp);
 }
 
 
-bool LaTeX::runMakeIndex(string const & f, OutputParams const & runparams)
+bool LaTeX::runMakeIndex(string const & f, OutputParams const & runparams,
+                         string const & params)
 {
-       lyxerr[Debug::LATEX] << "idx file has been made,"
-               " running makeindex on file "
-                            <<  f << endl;
-       string tmp = lyxrc.index_command + " ";
+       lyxerr[Debug::LATEX]
+               << "idx file has been made, running makeindex on file "
+               << f << endl;
+       string tmp = lyxrc.index_command + ' ';
+       
        tmp = subst(tmp, "$$lang", runparams.document_language);
-       tmp += QuoteName(f);
+       tmp += quoteName(f);
+       tmp += params;
        Systemcall one;
        one.startscript(Systemcall::Wait, tmp);
        return true;
@@ -411,7 +439,7 @@ LaTeX::scanAuxFiles(string const & file)
        result.push_back(scanAuxFile(file));
 
        for (int i = 1; i < 1000; ++i) {
-               string const file2 = ChangeExtension(file, "")
+               string const file2 = changeExtension(file, "")
                        + '.' + convert<string>(i)
                        + ".aux";
                if (!fs::exists(file2))
@@ -461,7 +489,7 @@ void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info)
                        while (!data.empty()) {
                                string database;
                                data = split(data, database, ',');
-                               database = ChangeExtension(database, "bib");
+                               database = changeExtension(database, "bib");
                                lyxerr[Debug::LATEX] << "BibTeX database: `"
                                                     << database << '\'' << endl;
                                aux_info.databases.insert(database);
@@ -470,7 +498,7 @@ void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info)
                        string style = sub.str(1);
                        // token is now the style file
                        // pass it to the helper
-                       style = ChangeExtension(style, "bst");
+                       style = changeExtension(style, "bst");
                        lyxerr[Debug::LATEX] << "BibTeX style: `"
                                             << style << '\'' << endl;
                        aux_info.styles.insert(style);
@@ -520,7 +548,7 @@ bool LaTeX::runBibTeX(vector<Aux_Info> const & bibtex_info)
                result = true;
 
                string tmp = lyxrc.bibtex_command + " ";
-               tmp += QuoteName(OnlyFilename(ChangeExtension(it->aux_file, string())));
+               tmp += quoteName(onlyFilename(changeExtension(it->aux_file, string())));
                Systemcall one;
                one.startscript(Systemcall::Wait, tmp);
        }
@@ -534,12 +562,19 @@ int LaTeX::scanLogFile(TeXErrors & terr)
        int last_line = -1;
        int line_count = 1;
        int retval = NO_ERRORS;
-       string tmp = OnlyFilename(ChangeExtension(file, ".log"));
+       string tmp = onlyFilename(changeExtension(file, ".log"));
        lyxerr[Debug::LATEX] << "Log file: " << tmp << endl;
        ifstream ifs(tmp.c_str());
 
        string token;
        while (getline(ifs, token)) {
+               // MikTeX sometimes inserts \0 in the log file. They can't be
+               // removed directly with the existing string utility
+               // functions, so convert them first to \r, and remove all
+               // \r's afterwards, since we need to remove them anyway.
+               token = subst(token, '\0', '\r');
+               token = subst(token, "\r", "");
+
                lyxerr[Debug::LATEX] << "Log line: " << token << endl;
 
                if (token.empty())
@@ -636,7 +671,11 @@ int LaTeX::scanLogFile(TeXErrors & terr)
                                        last_line = line;
                                }
                                if (line_count <= 5) {
-                                       terr.insertError(line, desc, errstr);
+                                       // FIXME UNICODE
+                                       // We have no idea what the encoding of the log file is
+                                       // (probably pure ascii, but maybe some localized
+                                       // latex compilers or packages exist)
+                                       terr.insertError(line, from_utf8(desc), from_utf8(errstr));
                                        ++num_errors;
                                }
                        }
@@ -682,7 +721,7 @@ void handleFoundFile(string const & ff, DepTable & head)
        // (1) foundfile is an
        //     absolute path and should
        //     be inserted.
-       if (AbsolutePath(foundfile)) {
+       if (absolutePath(foundfile)) {
                lyxerr[Debug::DEPEND] << "AbsolutePath file: "
                                      << foundfile << endl;
                // On initial insert we want to do the update at once
@@ -694,7 +733,7 @@ void handleFoundFile(string const & ff, DepTable & head)
                return;
        }
 
-       string const onlyfile = OnlyFilename(foundfile);
+       string const onlyfile = onlyFilename(foundfile);
 
        // (2) foundfile is in the tmpdir
        //     insert it into head
@@ -737,17 +776,25 @@ void LaTeX::deplog(DepTable & head)
        // files used by the LaTeX run. The files are then entered into the
        // dependency file.
 
-       string const logfile = OnlyFilename(ChangeExtension(file, ".log"));
+       string const logfile = onlyFilename(changeExtension(file, ".log"));
 
        static regex reg1(".*\\([^)]+.*");
        static regex reg2("File: ([^ ]+).*");
        static regex reg3("No file ([^ ]+)\\..*");
        static regex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*");
        // If an index should be created, MikTex does not write a line like
-       //    \openout# = 'sample,idx'.
-       // but intstead only a line like this into the log:
+       //    \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 ([^ ]+).*");
+       // 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:
+       //    \tf@toc=\write#
+       // This line is also written by tetex.
+       // This line is not present if no toc should be created.
+       static regex miktexTocReg("\\\\tf@toc=\\\\write.*");
 
        ifstream ifs(logfile.c_str());
        while (ifs) {
@@ -760,7 +807,12 @@ void LaTeX::deplog(DepTable & head)
 
                string token;
                getline(ifs, token);
-               token = rtrim(token, "\r");
+               // MikTeX sometimes inserts \0 in the log file. They can't be
+               // removed directly with the existing string utility
+               // functions, so convert them first to \r, and remove all
+               // \r's afterwards, since we need to remove them anyway.
+               token = subst(token, '\0', '\r');
+               token = subst(token, "\r", "");
                if (token.empty())
                        continue;
 
@@ -776,17 +828,23 @@ void LaTeX::deplog(DepTable & head)
                                first = what[0].second;
                                handleFoundFile(what.str(1), head);
                        }
-               } else if (regex_match(token, sub, reg2)) {
+               } else if (regex_match(token, sub, reg2))
                        handleFoundFile(sub.str(1), head);
-               } else if (regex_match(token, sub, reg3)) {
+               else if (regex_match(token, sub, reg3))
                        handleFoundFile(sub.str(1), head);
-               } else if (regex_match(token, sub, reg4)) {
+               else if (regex_match(token, sub, reg4))
                        handleFoundFile(sub.str(1), head);
-               } else if (regex_match(token, sub, reg5)) {
+               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(changeExtension(file, ".toc"), head);
        }
 
        // Make sure that the main .tex file is in the dependancy file.
-       head.insert(OnlyFilename(file), true);
+       head.insert(onlyFilename(file), true);
 }
+
+
+} // namespace lyx