X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeX.C;h=8c8091fe4fc13e68c3f258821e07f82d49cc5472;hb=35204f8f33d7400a5fefeffea533fb4cb4097211;hp=0de75eb78641c1f99f2e7b6bff7a4f92ef8d81bc;hpb=57a24ea9124812ddc5108ff1ad304ff61acc826a;p=lyx.git diff --git a/src/LaTeX.C b/src/LaTeX.C index 0de75eb786..8c8091fe4f 100644 --- a/src/LaTeX.C +++ b/src/LaTeX.C @@ -14,39 +14,51 @@ #include -#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/FileInfo.h" -#include "support/tostr.h" +#include "support/convert.h" #include "support/lstrings.h" #include "support/lyxlib.h" #include "support/systemcall.h" #include "support/os.h" +#include #include #include -using lyx::support::AbsolutePath; -using lyx::support::bformat; -using lyx::support::ChangeExtension; -using lyx::support::contains; -using lyx::support::FileInfo; -using lyx::support::findtexfile; -using lyx::support::getcwd; -using lyx::support::OnlyFilename; -using lyx::support::os; -using lyx::support::prefixIs; -using lyx::support::QuoteName; -using lyx::support::rtrim; -using lyx::support::split; -using lyx::support::suffixIs; -using lyx::support::Systemcall; -using lyx::support::unlink; + +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; @@ -54,50 +66,37 @@ using std::sscanf; using std::endl; using std::getline; - +using std::string; using std::ifstream; using std::set; using std::vector; -using boost::regex; - -#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 +// - 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 { -string runMessage(unsigned int count) +docstring runMessage(unsigned int count) { - return bformat(_("Waiting for LaTeX run number %1$s"), tostr(count)); + return bformat(_("Waiting for LaTeX run number %1$d"), count); } -}; +} // anon namespace /* * 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); @@ -123,7 +122,7 @@ bool operator!=(Aux_Info const & a, Aux_Info const & o) * CLASS LaTeX */ -LaTeX::LaTeX(string const & latex, LatexRunParams const & rp, +LaTeX::LaTeX(string const & latex, OutputParams const & rp, string const & f, string const & p) : cmd(latex), file(f), path(p), runparams(rp) { @@ -131,9 +130,9 @@ LaTeX::LaTeX(string const & latex, LatexRunParams 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"); } } @@ -149,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); } @@ -180,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. @@ -200,10 +203,9 @@ int LaTeX::run(TeXErrors & terr) // 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; @@ -217,7 +219,7 @@ int LaTeX::run(TeXErrors & terr) // 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()) { @@ -273,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"))); + 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 @@ -335,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 .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"))); + 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 @@ -387,28 +408,23 @@ int LaTeX::run(TeXErrors & terr) 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, + string const & params) { - 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; + 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 += params; Systemcall one; one.startscript(Systemcall::Wait, tmp); return true; @@ -423,10 +439,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)); } @@ -449,20 +465,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 = 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)); + if (regex_match(token, sub, reg1)) { + string data = sub.str(1); while (!data.empty()) { string citation; data = split(data, citation, ','); @@ -470,28 +482,28 @@ void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info) << citation << endl; aux_info.citations.insert(citation); } - } else if (regex_match(STRCONV(token), sub, reg2)) { - string data = sub.STRCONV(str(1)); + } else if (regex_match(token, sub, reg2)) { + 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"); + database = changeExtension(database, "bib"); lyxerr[Debug::LATEX] << "BibTeX database: `" << database << '\'' << endl; aux_info.databases.insert(database); } - } else if (regex_match(STRCONV(token), sub, reg3)) { - string style = STRCONV(sub.str(1)); + } else if (regex_match(token, sub, reg3)) { + 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); - } else if (regex_match(STRCONV(token), sub, reg4)) { - string const file2 = STRCONV(sub.str(1)); + } else if (regex_match(token, sub, reg4)) { + string const file2 = sub.str(1); scanAuxFile(file2, aux_info); } } @@ -535,8 +547,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); } @@ -550,18 +562,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; @@ -651,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; } } @@ -679,113 +703,148 @@ 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 ([^ ]+).*"); + 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) { // 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 = rtrim(token, "\r"); - if (token.empty()) continue; - -#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 { + // 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; + smatch sub; - // 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); - } + if (regex_match(token, sub, reg1)) { + static regex reg1_1("\\(([^()]+)"); + smatch what; + string::const_iterator first = token.begin(); + string::const_iterator end = token.end(); - // (2) foundfile is in the tmpdir - // insert it into head - else if (FileInfo(OnlyFilename(foundfile)).exist()) { - if (regex_match(STRCONV(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)); + 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, 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