-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
+/**
+ * \file LaTeX.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * This file is Copyright 1996-2001
- * Lars Gullik Bjønnes
+ * \author Alfredo Braunstein
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author Angus Leeming
+ * \author Dekel Tsur
*
- * ======================================================
+ * Full author contact details are available in file CREDITS.
*/
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-#include <fstream>
-
-#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 "support/lstrings.h"
#include "bufferlist.h"
#include "gettext.h"
-#include "lyx_gui_misc.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 <boost/regex.hpp>
+
+#include <fstream>
+
+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::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;
+
+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 std::vector;
// TODO: in no particular order
// - get rid of the extern BufferList and 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)
+{
+ 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)
{
- 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
*/
-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 ?
+ if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
depfile += "-pdf";
+ output_file = ChangeExtension(file,".pdf");
+ } else {
+ output_file = ChangeExtension(file,".dvi");
+ }
}
// 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
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(getcwd(), runparams);
+
// Never write the depfile if an error was encountered.
-
+
// 0
// first check if the file dependencies exist:
// ->If it does exist
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,
++count;
lyxerr[Debug::LATEX] << "Run #" << count << endl;
- if (lfun) {
- ostringstream str;
- str << _("LaTeX run number") << ' ' << count;
- lfun->dispatch(LFUN_MESSAGE, str.str().c_str());
- }
-
- this->operator()();
+ message(runMessage(count));
+
+ startscript();
scanres = scanLogFile(terr);
if (scanres & ERROR_RERUN) {
lyxerr[Debug::LATEX] << "Rerunning LaTeX" << endl;
- this->operator()();
+ startscript();
scanres = scanLogFile(terr);
}
// 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."));
- }
-
- rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
+ message(_("Running MakeIndex."));
+ rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")), runparams);
}
// run bibtex
// 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."));
- }
-
+ message(_("Running BibTeX."));
updateBibtexDependencies(head, bibtex_info);
rerun |= runBibTeX(bibtex_info);
} else if (!had_depfile) {
/// 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
<< "Dep. file has changed or rerun requested" << endl;
lyxerr[Debug::LATEX]
<< "Run #" << count << endl;
- if (lfun) {
- ostringstream str;
- str << _("LaTeX run number") << ' ' << count;
- lfun->dispatch(LFUN_MESSAGE, str.str().c_str());
- }
-
- this->operator()();
+ message(runMessage(count));
+ startscript();
scanres = scanLogFile(terr);
if (scanres & ERRORS) {
deleteFilesOnError();
return scanres; // return on error
}
-
+
// update the depedencies
deplog(head); // reads the latex log
head.update();
// 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")))) {
// no checks for now
lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
- if (lfun) {
- lfun->dispatch(LFUN_MESSAGE, _("Running MakeIndex."));
- }
-
- rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
+ message(_("Running MakeIndex."));
+ rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")), runparams);
}
-
+
// 2
// we will only run latex more if the log file asks for it.
// or if the sumchange() is true.
// -> 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.
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());
- }
-
- this->operator()();
+ message(runMessage(count));
+ startscript();
scanres = scanLogFile(terr);
if (scanres & ERRORS) {
deleteFilesOnError();
return scanres; // return on error
}
-
+
// keep this updated
head.update();
}
}
-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);
+ 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. (0.13 perhaps?)
- string tmp = "makeindex -c -q ";
- tmp += f;
- Systemcalls one;
- one.startscript(Systemcalls::System, tmp);
+ string tmp = lyxrc.index_command + " ";
+ tmp = subst(tmp, "$$lang", runparams.document_language);
+ tmp += QuoteName(f);
+ Systemcall one;
+ one.startscript(Systemcall::Wait, tmp);
return true;
}
LaTeX::scanAuxFiles(string const & file)
{
vector<Aux_Info> result;
-
+
result.push_back(scanAuxFile(file));
for (int i = 1; i < 1000; ++i) {
- string file2 = ChangeExtension(file, "") + "." + tostr(i)
+ string file2 = ChangeExtension(file, "") + '.' + convert<string>(i)
+ ".aux";
FileInfo fi(file2);
if (!fi.exist())
ifstream ifs(file.c_str());
string token;
- LRegex reg1("\\\\citation\\{([^}]+)\\}");
- LRegex reg2("\\\\bibdata\\{([^}]+)\\}");
- LRegex reg3("\\\\bibstyle\\{([^}]+)\\}");
- LRegex 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');
- 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");
+ smatch sub;
+ if (regex_match(token, sub, reg1)) {
+ string data = sub.str(1);
while (!data.empty()) {
string citation;
data = split(data, citation, ',');
<< 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(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");
- 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(token, sub, reg3)) {
+ 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;
+ 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(token, sub, reg4)) {
+ string const file2 = sub.str(1);
scanAuxFile(file2, aux_info);
}
}
string file = findtexfile(*it2, "bst");
if (!file.empty())
dep.insert(file, true);
- }
+ }
}
}
continue;
result = true;
- string tmp = "bibtex ";
- tmp += OnlyFilename(ChangeExtension(it->aux_file, string()));
- Systemcalls one;
- one.startscript(Systemcalls::System, tmp);
+ string tmp = lyxrc.bibtex_command + " ";
+ tmp += QuoteName(OnlyFilename(ChangeExtension(it->aux_file, string())));
+ Systemcall one;
+ one.startscript(Systemcall::Wait, tmp);
}
// Return whether bibtex was run
return result;
string token;
while (getline(ifs, token)) {
lyxerr[Debug::LATEX] << "Log line: " << token << endl;
-
+
if (token.empty())
continue;
<< "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
}
+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 (FileInfo(foundfile).exist())
+ head.insert(foundfile, true);
+
+ return;
+ }
+
+ string const onlyfile = OnlyFilename(foundfile);
+
+ // (2) foundfile is in the tmpdir
+ // insert it into head
+ if (FileInfo(onlyfile).exist()) {
+ 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
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)$");
-
+ 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:
+ // Writing index file sample.idx
+ static regex reg5("Writing index file ([^ ]+).*");
+
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;
-
- 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);
- } else {
+ token = rtrim(token, "\r");
+ if (token.empty())
continue;
- }
- 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;
+
+ 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 (unwanted.exact_match(foundfile)) {
- 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);
+ }
}
// Make sure that the main .tex file is in the dependancy file.