X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeX.C;h=934b233ffbb69ae4817754ddb870b557f2154940;hb=6c300f72a217722652dc27db9108e1050028979c;hp=b1817790ea804cc5ebe76b4024d1f224577913ee;hpb=0b8aac3f51192831f567670b128cc176570276e4;p=lyx.git diff --git a/src/LaTeX.C b/src/LaTeX.C index b1817790ea..934b233ffb 100644 --- a/src/LaTeX.C +++ b/src/LaTeX.C @@ -1,67 +1,95 @@ -/* This file is part of - * ====================================================== +/** + * \file LaTeX.C + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * LyX, The Document Processor - * Copyright 1995 Matthias Ettrich - * Copyright 1995-2001 The LyX Team. + * \author Alfredo Braunstein + * \author Lars Gullik Bjønnes + * \author Jean-Marc Lasgouttes + * \author Angus Leeming + * \author Dekel Tsur * - * This file is Copyright 1996-2001 - * Lars Gullik Bjønnes - * - * ====================================================== + * Full author contact details are available in file CREDITS. */ #include -#ifdef __GNUG__ -#pragma implementation -#endif - -#include "LaTeX.h" #include "bufferlist.h" +#include "LaTeX.h" #include "gettext.h" -#include "lyxfunc.h" +#include "lyxrc.h" #include "debug.h" +#include "DepTable.h" + #include "support/filetools.h" -#include "support/FileInfo.h" +#include "support/convert.h" #include "support/lstrings.h" #include "support/lyxlib.h" #include "support/systemcall.h" #include "support/os.h" -#include "support/path.h" +#include #include #include -#include // sscanf + + +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; +using boost::smatch; + #ifndef CXX_GLOBAL_CSTD using std::sscanf; #endif -using std::ifstream; -using std::getline; using std::endl; -using std::vector; +using std::getline; +using std::string; +using std::ifstream; using std::set; -using boost::regex; -using boost::regex_match; -using boost::smatch; +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. -// - the bibtex command options should be supported. // - the makeindex style files should be taken care of with // the dependency mechanism. // - makeindex commandline options should be supported // - somewhere support viewing of bibtex and makeindex log files. // - we should perhaps also scan the bibtex log file -// - we should perhaps also scan the bibtex log file -extern BufferList bufferlist; +namespace { + +docstring runMessage(unsigned int count) +{ + return bformat(_("Waiting for LaTeX run number %1$d"), count); +} + +} // anon namespace /* * CLASS TEXERRORS @@ -74,20 +102,37 @@ void TeXErrors::insertError(int line, string const & error_desc, errors.push_back(newerr); } + +bool operator==(Aux_Info const & a, Aux_Info const & o) +{ + return a.aux_file == o.aux_file && + a.citations == o.citations && + a.databases == o.databases && + a.styles == o.styles; +} + + +bool operator!=(Aux_Info const & a, Aux_Info const & o) +{ + return !(a == o); +} + + /* * CLASS LaTeX */ -LaTeX::LaTeX(string const & latex, string const & f, string const & p) - : cmd(latex), file(f), path(p) +LaTeX::LaTeX(string const & latex, OutputParams const & rp, + string const & f, string const & p) + : cmd(latex), file(f), path(p), runparams(rp) { num_errors = 0; 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"); } } @@ -99,27 +144,27 @@ void LaTeX::deleteFilesOnError() const // What files do we have to delete? // This will at least make latex do all the runs - lyx::unlink(depfile); + unlink(depfile); // but the reason for the error might be in a generated file... - string ofname = OnlyFilename(file); + string const ofname = onlyFilename(file); // bibtex file - string bbl = ChangeExtension(ofname, ".bbl"); - lyx::unlink(bbl); + string const bbl = changeExtension(ofname, ".bbl"); + unlink(bbl); // makeindex file - string ind = ChangeExtension(ofname, ".ind"); - lyx::unlink(ind); + string const ind = changeExtension(ofname, ".ind"); + unlink(ind); // Also remove the aux file - string aux = ChangeExtension(ofname, ".aux"); - lyx::unlink(aux); + string const aux = changeExtension(ofname, ".aux"); + unlink(aux); } -int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) +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 @@ -129,12 +174,12 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) int scanres = NO_ERRORS; unsigned int count = 0; // number of times run num_errors = 0; // just to make sure. - const unsigned int MAX_RUN = 6; + unsigned int const MAX_RUN = 6; DepTable head; // empty head bool rerun = false; // rerun requested // The class LaTeX does not know the temp path. - bufferlist.updateIncludedTeXfiles(lyx::getcwd()); //GetCWD()); + theBufferList().updateIncludedTeXfiles(getcwd(), runparams); // Never write the depfile if an error was encountered. @@ -154,21 +199,23 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) // remake the dependency file. // - FileInfo fi(depfile); - bool had_depfile = fi.exist(); + 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; // Read the dep file: - head.read(depfile); + had_depfile = head.read(depfile); + } + + 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). - if (!FileInfo(output_file).exist()) { + if (!fs::exists(output_file)) { lyxerr[Debug::DEPEND] << "re-running LaTeX because output file doesn't exist." << endl; } else if (!head.sumchange()) { @@ -183,7 +230,7 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) run_bibtex = true; } else lyxerr[Debug::DEPEND] - << "Dependency file does not exist" << 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, @@ -194,17 +241,13 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) ++count; lyxerr[Debug::LATEX] << "Run #" << count << endl; - if (lfun) { - ostringstream str; - str << _("LaTeX run number") << ' ' << count; - lfun->dispatch(LFUN_MESSAGE, str.str().c_str(), false); - } + message(runMessage(count)); - this->operator()(); + startscript(); scanres = scanLogFile(terr); if (scanres & ERROR_RERUN) { lyxerr[Debug::LATEX] << "Rerunning LaTeX" << endl; - this->operator()(); + startscript(); scanres = scanLogFile(terr); } @@ -228,15 +271,17 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) // 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; - if (lfun) { - lfun->dispatch(LFUN_MESSAGE, _("Running MakeIndex."), false); - } - - rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx"))); + message(_("Running MakeIndex.")); + rerun |= runMakeIndex(onlyFilename(changeExtension(file, ".idx")), runparams); } // run bibtex @@ -247,10 +292,7 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) // tags is found -> run bibtex and set rerun = true; // no checks for now lyxerr[Debug::LATEX] << "Running BibTeX." << endl; - if (lfun) { - lfun->dispatch(LFUN_MESSAGE, _("Running BibTeX."), false); - } - + message(_("Running BibTeX.")); updateBibtexDependencies(head, bibtex_info); rerun |= runBibTeX(bibtex_info); } else if (!had_depfile) { @@ -279,14 +321,8 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) << "Dep. file has changed or rerun requested" << endl; lyxerr[Debug::LATEX] << "Run #" << count << endl; - if (lfun) { - ostringstream str; - str << _("LaTeX run number") << ' ' << count; - // check lyxstring string stream and gcc 3.1 before fixing - lfun->dispatch(LFUN_MESSAGE, str.str().c_str(), false); - } - - this->operator()(); + message(runMessage(count)); + startscript(); scanres = scanLogFile(terr); if (scanres & ERRORS) { deleteFilesOnError(); @@ -302,21 +338,18 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) // 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 .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; - if (lfun) { - lfun->dispatch(LFUN_MESSAGE, _("Running MakeIndex."), false); - } - - rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx"))); + message(_("Running MakeIndex.")); + rerun = runMakeIndex(onlyFilename(changeExtension(file, ".idx")), runparams); } // 2 @@ -336,13 +369,8 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) rerun = false; ++count; lyxerr[Debug::LATEX] << "Run #" << count << endl; - if (lfun) { - ostringstream str; - str << _("LaTeX run number") << ' ' << count; - lfun->dispatch(LFUN_MESSAGE, str.str().c_str(), false); - } - - this->operator()(); + message(runMessage(count)); + startscript(); scanres = scanLogFile(terr); if (scanres & ERRORS) { deleteFilesOnError(); @@ -360,30 +388,21 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) } -int LaTeX::operator()() +int LaTeX::startscript() { -#ifndef __EMX__ - string tmp = cmd + ' ' + QuoteName(file) + " > /dev/null"; -#else // cmd.exe (OS/2) causes SYS0003 error at "/dev/null" - string tmp = cmd + ' ' + file + " > nul"; -#endif + string tmp = cmd + ' ' + quoteName(file) + " > " + os::nulldev(); Systemcall one; return one.startscript(Systemcall::Wait, tmp); } -bool LaTeX::runMakeIndex(string const & f) +bool LaTeX::runMakeIndex(string const & f, OutputParams const & runparams) { lyxerr[Debug::LATEX] << "idx file has been made," - " running makeindex on file " - << f << endl; - - // It should be possible to set the switches for makeindex - // sorting style and such. It would also be very convenient - // to be able to make style files from within LyX. This has - // to come for a later time. - string tmp = "makeindex -c -q "; - tmp += f; + " running makeindex on file " << f << endl; + string tmp = lyxrc.index_command + " "; + tmp = subst(tmp, "$$lang", runparams.document_language); + tmp += quoteName(f); Systemcall one; one.startscript(Systemcall::Wait, tmp); return true; @@ -398,10 +417,10 @@ LaTeX::scanAuxFiles(string const & file) result.push_back(scanAuxFile(file)); for (int i = 1; i < 1000; ++i) { - string file2 = ChangeExtension(file, "") + "." + tostr(i) + string const file2 = changeExtension(file, "") + + '.' + convert(i) + ".aux"; - FileInfo fi(file2); - if (!fi.exist()) + if (!fs::exists(file2)) break; result.push_back(scanAuxFile(file2)); } @@ -424,16 +443,16 @@ void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info) ifstream ifs(file.c_str()); string token; - regex reg1("\\\\citation\\{([^}]+)\\}"); - regex reg2("\\\\bibdata\\{([^}]+)\\}"); - regex reg3("\\\\bibstyle\\{([^}]+)\\}"); - regex reg4("\\\\@input\\{([^}]+)\\}"); + static regex const reg1("\\\\citation\\{([^}]+)\\}"); + static regex const reg2("\\\\bibdata\\{([^}]+)\\}"); + static regex const reg3("\\\\bibstyle\\{([^}]+)\\}"); + static regex const reg4("\\\\@input\\{([^}]+)\\}"); while (getline(ifs, token)) { - token = strip(token, '\r'); + token = rtrim(token, "\r"); smatch sub; if (regex_match(token, sub, reg1)) { - string data = sub[1]; + string data = sub.str(1); while (!data.empty()) { string citation; data = split(data, citation, ','); @@ -442,27 +461,27 @@ void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info) aux_info.citations.insert(citation); } } else if (regex_match(token, sub, reg2)) { - string data = sub[1]; + string data = sub.str(1); // data is now all the bib files separated by ',' // get them one by one and pass them to the helper while (!data.empty()) { string database; data = split(data, database, ','); - database = ChangeExtension(database, "bib"); - lyxerr[Debug::LATEX] << "Bibtex database: `" - << database << "'" << endl; + database = changeExtension(database, "bib"); + lyxerr[Debug::LATEX] << "BibTeX database: `" + << database << '\'' << endl; aux_info.databases.insert(database); } } else if (regex_match(token, sub, reg3)) { - string style = sub[1]; + string style = sub.str(1); // token is now the style file // pass it to the helper - style = ChangeExtension(style, "bst"); - lyxerr[Debug::LATEX] << "Bibtex style: `" - << style << "'" << endl; + style = changeExtension(style, "bst"); + lyxerr[Debug::LATEX] << "BibTeX style: `" + << style << '\'' << endl; aux_info.styles.insert(style); } else if (regex_match(token, sub, reg4)) { - string file2 = sub[1]; + string const file2 = sub.str(1); scanAuxFile(file2, aux_info); } } @@ -506,8 +525,8 @@ bool LaTeX::runBibTeX(vector const & bibtex_info) continue; result = true; - string tmp = "bibtex "; - tmp += OnlyFilename(ChangeExtension(it->aux_file, string())); + string tmp = lyxrc.bibtex_command + " "; + tmp += quoteName(onlyFilename(changeExtension(it->aux_file, string()))); Systemcall one; one.startscript(Systemcall::Wait, tmp); } @@ -521,18 +540,26 @@ 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()) continue; - if (prefixIs(token, "LaTeX Warning:")) { + if (prefixIs(token, "LaTeX Warning:") || + prefixIs(token, "! pdfTeX warning")) { // Here shall we handle different // types of warnings retval |= LATEX_WARNING; @@ -566,7 +593,7 @@ int LaTeX::scanLogFile(TeXErrors & terr) << "We should rerun." << endl; retval |= RERUN; } - } else if (prefixIs(token, "(")) { + } else if (token[0] == '(') { if (contains(token, "Rerun LaTeX") || contains(token, "Rerun to get")) { // Used by natbib @@ -650,109 +677,145 @@ int LaTeX::scanLogFile(TeXErrors & terr) } +namespace { + +void handleFoundFile(string const & ff, DepTable & head) +{ + // convert from native os path to unix path + string const foundfile = os::internal_path(trim(ff)); + + lyxerr[Debug::DEPEND] << "Found file: " << foundfile << endl; + + // Ok now we found a file. + // Now we should make sure that this is a file that we can + // access through the normal paths. + // We will not try any fancy search methods to + // find the file. + + // (1) foundfile is an + // absolute path and should + // be inserted. + if (absolutePath(foundfile)) { + lyxerr[Debug::DEPEND] << "AbsolutePath file: " + << foundfile << endl; + // On initial insert we want to do the update at once + // since this file can not be a file generated by + // the latex run. + if (fs::exists(foundfile) && !fs::is_directory(foundfile)) + head.insert(foundfile, true); + + return; + } + + string const onlyfile = onlyFilename(foundfile); + + // (2) foundfile is in the tmpdir + // insert it into head + if (fs::exists(onlyfile)) { + static regex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$"); + if (regex_match(onlyfile, unwanted)) { + lyxerr[Debug::DEPEND] + << "We don't want " + << onlyfile + << " in the dep file" + << endl; + } else if (suffixIs(onlyfile, ".tex")) { + // This is a tex file generated by LyX + // and latex is not likely to change this + // during its runs. + lyxerr[Debug::DEPEND] + << "Tmpdir TeX file: " + << onlyfile + << endl; + head.insert(onlyfile, true); + } else { + lyxerr[Debug::DEPEND] + << "In tmpdir file:" + << onlyfile + << endl; + head.insert(onlyfile); + } + } else + lyxerr[Debug::DEPEND] + << "Not a file or we are unable to find it." + << endl; +} + +} // anon namespace + + 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. - string const logfile = OnlyFilename(ChangeExtension(file, ".log")); + string const logfile = onlyFilename(changeExtension(file, ".log")); - regex reg1("\\)* *\\(([^ )]+).*"); - regex reg2("File: ([^ ]+).*"); - regex reg3("No file ([^ ]+)\\..*"); - regex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*"); + 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 - regex reg5("Writing index file ([^ ]+).*"); - regex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$"); + static regex reg5("Writing index 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) { // 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 + // "(\([^ ]+\)" should match the "(file " variant, note + // that we can have several of these on one line. // "File: \([^ ]+\)" should match the "File: file" variant - string foundfile; + string token; getline(ifs, token); - token = strip(token, '\r'); - if (token.empty()) continue; - - smatch sub; - if (regex_match(token, sub, reg1)) { - foundfile = sub[1]; - } else if (regex_match(token, sub, reg2)) { - foundfile = sub[1]; - } else if (regex_match(token, sub, reg3)) { - foundfile = sub[1]; - } else if (regex_match(token, sub, reg4)) { - foundfile = sub[1]; - } else if (regex_match(token, sub, reg5)) { - foundfile = sub[1]; - } else { + // 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; - } - - // convert from native os path to unix path - foundfile = os::internal_path(foundfile); - - lyxerr[Debug::DEPEND] << "Found file: " - << foundfile << endl; - // Ok now we found a file. - // Now we should make sure that this is a file that we can - // access through the normal paths. - // We will not try any fancy search methods to - // find the file. - - // (1) foundfile is an - // absolute path and should - // be inserted. - if (AbsolutePath(foundfile)) { - lyxerr[Debug::DEPEND] << "AbsolutePath file: " - << foundfile << endl; - // On initial insert we want to do the update at once - // since this file can not be a file generated by - // the latex run. - if (FileInfo(foundfile).exist()) - head.insert(foundfile, true); - } + smatch sub; - // (2) foundfile is in the tmpdir - // insert it into head - else if (FileInfo(OnlyFilename(foundfile)).exist()) { - if (regex_match(foundfile, unwanted)) { - lyxerr[Debug::DEPEND] - << "We don't want " - << OnlyFilename(foundfile) - << " in the dep file" - << endl; - } else if (suffixIs(foundfile, ".tex")) { - // This is a tex file generated by LyX - // and latex is not likely to change this - // during its runs. - lyxerr[Debug::DEPEND] - << "Tmpdir TeX file: " - << OnlyFilename(foundfile) - << endl; - head.insert(foundfile, true); - } else { - lyxerr[Debug::DEPEND] - << "In tmpdir file:" - << OnlyFilename(foundfile) - << endl; - head.insert(OnlyFilename(foundfile)); + if (regex_match(token, sub, reg1)) { + static regex reg1_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); } - } else - lyxerr[Debug::DEPEND] - << "Not a file or we are unable to find it." - << endl; + } 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, 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