X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeX.C;h=8908812d6fe5cf683a7300190fa033b79c6dfa6f;hb=dbef37d5223a727b860a83ff4155f05b013c97a3;hp=a8106ccf2fd5f4ff3f811f22d8e967b8834441c5;hpb=15a0218c0fbd310587456f1342f051a663a69d64;p=lyx.git diff --git a/src/LaTeX.C b/src/LaTeX.C index a8106ccf2f..8908812d6f 100644 --- a/src/LaTeX.C +++ b/src/LaTeX.C @@ -1,43 +1,55 @@ /* This file is part of - * ====================================================== - * - * LyX, The Document Processor + * ====================================================== + * + * LyX, The Document Processor * Copyright 1995 Matthias Ettrich * Copyright 1995-2001 The LyX Team. * * This file is Copyright 1996-2001 * Lars Gullik Bjønnes * - * ====================================================== + * ====================================================== */ #include -#ifdef __GNUG__ -#pragma implementation -#endif -#include - -#include "support/filetools.h" #include "LaTeX.h" -#include "support/FileInfo.h" -#include "debug.h" -#include "support/lyxlib.h" -#include "support/syscall.h" -#include "support/syscontr.h" -#include "support/path.h" -#include "support/LRegex.h" -#include "support/LSubstring.h" #include "bufferlist.h" #include "gettext.h" -#include "lyx_gui_misc.h" #include "lyxfunc.h" +#include "debug.h" +#include "funcrequest.h" +#include "support/filetools.h" +#include "support/FileInfo.h" +#include "support/tostr.h" +#include "support/lstrings.h" +#include "support/lyxlib.h" +#include "support/systemcall.h" +#include "support/os.h" +#include "support/path.h" + +#include + +#include +#include // sscanf + +#ifndef CXX_GLOBAL_CSTD +using std::sscanf; +#endif using std::ifstream; using std::getline; using std::endl; using std::vector; using std::set; +using boost::regex; +using boost::regex_match; + +#ifndef USE_INCLUDED_STRING +using boost::smatch; +#else +using boost::cmatch; +#endif // TODO: in no particular order // - get rid of the extern BufferList and the call to @@ -54,6 +66,16 @@ using std::set; extern BufferList bufferlist; +namespace { + +void showRunMessage(LyXFunc * lf, unsigned int count) +{ + string str = bformat(_("Waiting for LaTeX run number %1$s"), tostr(count)); + lf->dispatch(FuncRequest(LFUN_MESSAGE, str)); +} + + +}; /* * CLASS TEXERRORS */ @@ -61,10 +83,26 @@ extern BufferList bufferlist; void TeXErrors::insertError(int line, string const & error_desc, string const & error_text) { - Error newerr(line, error_desc, error_text); + Error newerr(line, error_desc, error_text); 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 */ @@ -74,8 +112,12 @@ LaTeX::LaTeX(string const & latex, string const & f, string const & p) { num_errors = 0; depfile = file + ".dep"; - if (prefixIs(cmd, "pdf")) // Do we use pdflatex ? + if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ? depfile += "-pdf"; + output_file = ChangeExtension(file,".pdf"); + } else { + output_file = ChangeExtension(file,".dvi"); + } } @@ -90,18 +132,18 @@ void LaTeX::deleteFilesOnError() const // 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"); + string const bbl = ChangeExtension(ofname, ".bbl"); lyx::unlink(bbl); // makeindex file - string ind = ChangeExtension(ofname, ".ind"); + string const ind = ChangeExtension(ofname, ".ind"); lyx::unlink(ind); - + // Also remove the aux file - string aux = ChangeExtension(ofname, ".aux"); + string const aux = ChangeExtension(ofname, ".aux"); lyx::unlink(aux); } @@ -116,15 +158,15 @@ 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()); - + bufferlist.updateIncludedTeXfiles(lyx::getcwd()); + // Never write the depfile if an error was encountered. - + // 0 // first check if the file dependencies exist: // ->If it does exist @@ -149,21 +191,31 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) 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(); - if (!head.sumchange()) { + // 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()) { + lyxerr[Debug::DEPEND] + << "re-running LaTeX because output file doesn't exist." << endl; + } else if (!head.sumchange()) { lyxerr[Debug::DEPEND] << "return no_change" << endl; return NO_CHANGE; + } else { + lyxerr[Debug::DEPEND] + << "Dependency file has changed" << endl; } - lyxerr[Debug::DEPEND] - << "Dependency file has changed" << endl; if (head.extchanged(".bib") || head.extchanged(".bst")) 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, @@ -175,18 +227,14 @@ 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()); + showRunMessage(lfun, count); } - - - //WriteStatus(lfun, string(_("LaTeX run number ")) + tostr(count)); - this->operator()(); + + startscript(); scanres = scanLogFile(terr); if (scanres & ERROR_RERUN) { lyxerr[Debug::LATEX] << "Rerunning LaTeX" << endl; - this->operator()(); + startscript(); scanres = scanLogFile(terr); } @@ -209,13 +257,15 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) // 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. - + // run makeindex 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.")); -// WriteStatus(minib, _("Running MakeIndex.")); + if (lfun) { + lfun->dispatch(FuncRequest(LFUN_MESSAGE, _("Running MakeIndex."))); + } + rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx"))); } @@ -227,16 +277,19 @@ 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.")); - //WriteStatus(minib, _("Running BibTeX.")); + if (lfun) { + lfun->dispatch(FuncRequest(LFUN_MESSAGE, _("Running BibTeX."))); + } + updateBibtexDependencies(head, bibtex_info); rerun |= runBibTeX(bibtex_info); - } else if (!had_depfile) + } 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 /// insert the .bib and .bst files into the .dep-pdf file. updateBibtexDependencies(head, bibtex_info); - + } + // 1 // 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 @@ -257,20 +310,16 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) lyxerr[Debug::LATEX] << "Run #" << count << endl; if (lfun) { - ostringstream str; - str << _("LaTeX run number") << ' ' << count; - lfun->Dispatch(LFUN_MESSAGE, str.str().c_str()); + showRunMessage(lfun, count); } - -// WriteStatus(minib, -// string(_("LaTeX run number ")) + tostr(count)); - this->operator()(); + + startscript(); scanres = scanLogFile(terr); if (scanres & ERRORS) { deleteFilesOnError(); return scanres; // return on error } - + // update the depedencies deplog(head); // reads the latex log head.update(); @@ -285,16 +334,18 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) // 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")))) { // no checks for now lyxerr[Debug::LATEX] << "Running MakeIndex." << endl; - if (lfun) lfun->Dispatch(LFUN_MESSAGE, _("Running MakeIndex.")); - //WriteStatus(minib, _("Running MakeIndex.")); + if (lfun) { + lfun->dispatch(FuncRequest(LFUN_MESSAGE, _("Running MakeIndex."))); + } + rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx"))); } - + // 2 // we will only run latex more if the log file asks for it. // or if the sumchange() is true. @@ -305,7 +356,7 @@ int LaTeX::run(TeXErrors & terr, LyXFunc * lfun) // -> rerun not asked for: // just return (fall out of bottom of func) // - while ((head.sumchange() || rerun || (scanres & RERUN)) + while ((head.sumchange() || rerun || (scanres & RERUN)) && count < MAX_RUN) { // Yes rerun until message goes away, or until // MAX_RUNS are reached. @@ -313,19 +364,16 @@ 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()); + showRunMessage(lfun, count); } - -// WriteStatus(minib, string(_("LaTeX run number ")) + tostr(count)); - this->operator()(); + + startscript(); scanres = scanLogFile(terr); if (scanres & ERRORS) { deleteFilesOnError(); return scanres; // return on error } - + // keep this updated head.update(); } @@ -337,15 +385,15 @@ 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 - Systemcalls one; - return one.startscript(Systemcalls::System, tmp); + Systemcall one; + return one.startscript(Systemcall::Wait, tmp); } @@ -358,11 +406,11 @@ bool LaTeX::runMakeIndex(string const & f) // 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. (0.13 perhaps?) + // to come for a later time. string tmp = "makeindex -c -q "; tmp += f; - Systemcalls one; - one.startscript(Systemcalls::System, tmp); + Systemcall one; + one.startscript(Systemcall::Wait, tmp); return true; } @@ -371,11 +419,11 @@ vector const LaTeX::scanAuxFiles(string const & file) { vector result; - + result.push_back(scanAuxFile(file)); for (int i = 1; i < 1000; ++i) { - string file2 = ChangeExtension(file, "") + "." + tostr(i) + string file2 = ChangeExtension(file, "") + '.' + tostr(i) + ".aux"; FileInfo fi(file2); if (!fi.exist()) @@ -401,16 +449,20 @@ void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info) ifstream ifs(file.c_str()); string token; - LRegex reg1("\\\\citation\\{([^}]+)\\}"); - LRegex reg2("\\\\bibdata\\{([^}]+)\\}"); - LRegex reg3("\\\\bibstyle\\{([^}]+)\\}"); - LRegex reg4("\\\\@input\\{([^}]+)\\}"); + regex reg1("\\\\citation\\{([^}]+)\\}"); + regex reg2("\\\\bibdata\\{([^}]+)\\}"); + regex reg3("\\\\bibstyle\\{([^}]+)\\}"); + regex reg4("\\\\@input\\{([^}]+)\\}"); while (getline(ifs, token)) { - if (reg1.exact_match(token)) { - LRegex::SubMatches const & sub = reg1.exec(token); - string data = LSubstring(token, sub[1].first, - sub[1].second); + token = rtrim(token, "\r"); +#ifndef USE_INCLUDED_STRING + smatch sub; +#else + cmatch sub; +#endif + if (regex_match(STRCONV(token), sub, reg1)) { + string data = STRCONV(sub.str(1)); while (!data.empty()) { string citation; data = split(data, citation, ','); @@ -418,34 +470,28 @@ void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info) << citation << endl; aux_info.citations.insert(citation); } - } else if (reg2.exact_match(token)) { - LRegex::SubMatches const & sub = reg2.exec(token); - string data = LSubstring(token, sub[1].first, - sub[1].second); + } else if (regex_match(STRCONV(token), sub, reg2)) { + string data = sub.STRCONV(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; + lyxerr[Debug::LATEX] << "BibTeX database: `" + << database << '\'' << endl; aux_info.databases.insert(database); } - } else if (reg3.exact_match(token)) { - LRegex::SubMatches const & sub = reg3.exec(token); - string style = LSubstring(token, sub[1].first, - sub[1].second); + } else if (regex_match(STRCONV(token), sub, reg3)) { + string style = STRCONV(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; + lyxerr[Debug::LATEX] << "BibTeX style: `" + << style << '\'' << endl; aux_info.styles.insert(style); - } else if (reg4.exact_match(token)) { - LRegex::SubMatches const & sub = reg4.exec(token); - string file2 = LSubstring(token, sub[1].first, - sub[1].second); + } else if (regex_match(STRCONV(token), sub, reg4)) { + string const file2 = STRCONV(sub.str(1)); scanAuxFile(file2, aux_info); } } @@ -459,7 +505,7 @@ void LaTeX::updateBibtexDependencies(DepTable & dep, // remove all ".bib" and ".bst" files. dep.remove_files_with_extension(".bib"); dep.remove_files_with_extension(".bst"); - string aux = OnlyFilename(ChangeExtension(file, ".aux")); + //string aux = OnlyFilename(ChangeExtension(file, ".aux")); for (vector::const_iterator it = bibtex_info.begin(); it != bibtex_info.end(); ++it) { @@ -475,7 +521,7 @@ void LaTeX::updateBibtexDependencies(DepTable & dep, string file = findtexfile(*it2, "bst"); if (!file.empty()) dep.insert(file, true); - } + } } } @@ -491,8 +537,8 @@ bool LaTeX::runBibTeX(vector const & bibtex_info) string tmp = "bibtex "; tmp += OnlyFilename(ChangeExtension(it->aux_file, string())); - Systemcalls one; - one.startscript(Systemcalls::System, tmp); + Systemcall one; + one.startscript(Systemcall::Wait, tmp); } // Return whether bibtex was run return result; @@ -511,7 +557,7 @@ int LaTeX::scanLogFile(TeXErrors & terr) string token; while (getline(ifs, token)) { lyxerr[Debug::LATEX] << "Log line: " << token << endl; - + if (token.empty()) continue; @@ -541,8 +587,20 @@ int LaTeX::scanLogFile(TeXErrors & terr) } } else if (contains(token, "run BibTeX")) { retval |= UNDEF_CIT; - } else if (contains(token, "Rerun LaTeX.")) { - // at least longtable.sty might use this. + } else if (contains(token, "Rerun LaTeX") || + contains(token, "Rerun to get")) { + // at least longtable.sty and bibtopic.sty + // might use this. + lyxerr[Debug::LATEX] + << "We should rerun." << endl; + retval |= RERUN; + } + } else if (token[0] == '(') { + if (contains(token, "Rerun LaTeX") || + contains(token, "Rerun to get")) { + // Used by natbib + lyxerr[Debug::LATEX] + << "We should rerun." << endl; retval |= RERUN; } } else if (prefixIs(token, "! ")) { @@ -629,12 +687,17 @@ void LaTeX::deplog(DepTable & head) string const logfile = OnlyFilename(ChangeExtension(file, ".log")); - LRegex reg1("\\)* *\\(([^ )]+).*"); - LRegex reg2("File: ([^ ]+).*"); - LRegex reg3("No file ([^ ]+)\\..*"); - LRegex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*"); - LRegex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$"); - + regex reg1("\\)* *\\(([^ )]+).*"); + regex reg2("File: ([^ ]+).*"); + regex reg3("No file ([^ ]+)\\..*"); + 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: + // Writing index file sample.idx + regex reg5("Writing index file ([^ ]+).*"); + regex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$"); + ifstream ifs(logfile.c_str()); while (ifs) { // Ok, the scanning of files here is not sufficient. @@ -645,42 +708,45 @@ void LaTeX::deplog(DepTable & head) string foundfile; string token; getline(ifs, token); + token = rtrim(token, "\r"); if (token.empty()) continue; - - if (reg1.exact_match(token)) { - LRegex::SubMatches const & sub = reg1.exec(token); - foundfile = LSubstring(token, sub[1].first, - sub[1].second); - } else if (reg2.exact_match(token)) { - LRegex::SubMatches const & sub = reg2.exec(token); - foundfile = LSubstring(token, sub[1].first, - sub[1].second); - } else if (reg3.exact_match(token)) { - LRegex::SubMatches const & sub = reg3.exec(token); - foundfile = LSubstring(token, sub[1].first, - sub[1].second); - } else if (reg4.exact_match(token)) { - LRegex::SubMatches const & sub = reg4.exec(token); - foundfile = LSubstring(token, sub[1].first, - sub[1].second); + +#ifndef USE_INCLUDED_STRING + smatch sub; +#else + cmatch sub; +#endif + if (regex_match(STRCONV(token), sub, reg1)) { + foundfile = STRCONV(sub.str(1)); + } else if (regex_match(STRCONV(token), sub, reg2)) { + foundfile = STRCONV(sub.str(1)); + } else if (regex_match(STRCONV(token), sub, reg3)) { + foundfile = STRCONV(sub.str(1)); + } else if (regex_match(STRCONV(token), sub, reg4)) { + foundfile = STRCONV(sub.str(1)); + } else if (regex_match(STRCONV(token), sub, reg5)) { + foundfile = STRCONV(sub.str(1)); } else { continue; } - lyxerr[Debug::DEPEND] << "Found file: " + // 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: " + 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 @@ -692,7 +758,7 @@ void LaTeX::deplog(DepTable & head) // (2) foundfile is in the tmpdir // insert it into head else if (FileInfo(OnlyFilename(foundfile)).exist()) { - if (unwanted.exact_match(foundfile)) { + if (regex_match(STRCONV(foundfile), unwanted)) { lyxerr[Debug::DEPEND] << "We don't want " << OnlyFilename(foundfile)