*
* LyX, The Document Processor
* Copyright 1995 Matthias Ettrich
- * Copyright 1995-2000 The LyX Team.
+ * Copyright 1995-2001 The LyX Team.
*
- * This file is Copyright 1996-2000
+ * This file is Copyright 1996-2001
* Lars Gullik Bjønnes
*
* ======================================================
#endif
#include <fstream>
-#include "support/filetools.h"
#include "LaTeX.h"
+#include "support/filetools.h"
+#include "support/os.h"
#include "support/FileInfo.h"
#include "debug.h"
#include "support/lyxlib.h"
#include "support/path.h"
#include "support/LRegex.h"
#include "support/LSubstring.h"
+#include "support/lstrings.h"
#include "bufferlist.h"
-#include "minibuffer.h"
#include "gettext.h"
#include "lyx_gui_misc.h"
+#include "lyxfunc.h"
using std::ifstream;
using std::getline;
using std::endl;
using std::vector;
+using std::set;
// TODO: in no particular order
// - get rid of the extern BufferList and the call to
{
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");
+ }
}
}
-int LaTeX::run(TeXErrors & terr, MiniBuffer * minib)
+int LaTeX::run(TeXErrors & terr, LyXFunc * lfun)
// 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
// in it. However it seems safe to run latex (at least) on time each
// time the .tex file changes.
{
- int scanres = LaTeX::NO_ERRORS;
+ 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;
// run latex once (we need to run latex once anyway) and
// remake the dependency file.
//
+
FileInfo fi(depfile);
+ bool had_depfile = fi.exist();
bool run_bibtex = false;
- if (fi.exist()) {
+ string aux_file = OnlyFilename(ChangeExtension(file, "aux"));
+
+ if (had_depfile) {
+ lyxerr[Debug::DEPEND] << "Dependency file exists" << endl;
// Read the dep file:
head.read(depfile);
// Update the checksums
head.update();
-
- lyxerr[Debug::DEPEND] << "Dependency file exists" << endl;
- if (head.sumchange()) {
- ++count;
+ // 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]
- << "Dependency file has changed" << endl;
- lyxerr[Debug::LATEX]
- << "Run #" << count << endl;
- WriteStatus(minib,
- string(_("LaTeX run number ")) + tostr(count));
- this->operator()();
- scanres = scanLogFile(terr);
- if (scanres & LaTeX::ERRORS) {
- deleteFilesOnError();
- return scanres; // return on error
- }
- run_bibtex = scanAux(head);
- if (run_bibtex)
- lyxerr[Debug::DEPEND]
- << "Bibtex demands rerun" << endl;
- } else {
+ << "re-running LaTeX because output file doesn't exist." << endl;
+ } else if (!head.sumchange()) {
lyxerr[Debug::DEPEND] << "return no_change" << endl;
- return LaTeX::NO_CHANGE;
+ return NO_CHANGE;
+ } else {
+ lyxerr[Debug::DEPEND]
+ << "Dependency file has changed" << endl;
}
- } else {
- ++count;
+
+ if (head.extchanged(".bib") || head.extchanged(".bst"))
+ run_bibtex = true;
+ } else
lyxerr[Debug::DEPEND]
<< "Dependency file does not exist" << endl;
-
- lyxerr[Debug::LATEX]
- << "Run #" << count << endl;
- head.insert(file, true);
- WriteStatus(minib,
- string(_("LaTeX run number ")) + tostr(count));
+
+ /// We scan the aux file even when had_depfile = false,
+ /// because we can run pdflatex on the file after running latex on it,
+ /// in which case we will not need to run bibtex again.
+ vector<Aux_Info> bibtex_info_old;
+ if (!run_bibtex)
+ bibtex_info_old = scanAuxFiles(aux_file);
+
+ ++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()();
+ scanres = scanLogFile(terr);
+ if (scanres & ERROR_RERUN) {
+ lyxerr[Debug::LATEX] << "Rerunning LaTeX" << endl;
this->operator()();
scanres = scanLogFile(terr);
- if (scanres & LaTeX::ERRORS) {
- deleteFilesOnError();
- return scanres; // return on error
- }
-
}
+ if (scanres & ERRORS) {
+ deleteFilesOnError();
+ return scanres; // return on error
+ }
+
+ vector<Aux_Info> const bibtex_info = scanAuxFiles(aux_file);
+ if (!run_bibtex && bibtex_info_old != bibtex_info)
+ run_bibtex = true;
+
// update the dependencies.
deplog(head); // reads the latex log
head.update();
if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
// no checks for now
lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
- WriteStatus(minib, _("Running MakeIndex."));
+ if (lfun) {
+ lfun->dispatch(LFUN_MESSAGE, _("Running MakeIndex."));
+ }
+
rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
}
// run bibtex
- if (scanres & LaTeX::UNDEF_CIT
- || scanres & LaTeX::RERUN
- || run_bibtex) {
+ // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
+ if (scanres & UNDEF_CIT || run_bibtex) {
// Here we must scan the .aux file and look for
// "\bibdata" and/or "\bibstyle". If one of those
// tags is found -> run bibtex and set rerun = true;
// no checks for now
lyxerr[Debug::LATEX] << "Running BibTeX." << endl;
- WriteStatus(minib, _("Running BibTeX."));
- rerun = runBibTeX(head);
+ if (lfun) {
+ lfun->dispatch(LFUN_MESSAGE, _("Running BibTeX."));
+ }
+
+ updateBibtexDependencies(head, bibtex_info);
+ rerun |= runBibTeX(bibtex_info);
+ } 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
<< "Dep. file has changed or rerun requested" << endl;
lyxerr[Debug::LATEX]
<< "Run #" << count << endl;
- WriteStatus(minib,
- string(_("LaTeX run number ")) + tostr(count));
+ if (lfun) {
+ ostringstream str;
+ str << _("LaTeX run number") << ' ' << count;
+ lfun->dispatch(LFUN_MESSAGE, str.str().c_str());
+ }
+
this->operator()();
scanres = scanLogFile(terr);
- if (scanres & LaTeX::ERRORS) {
+ if (scanres & ERRORS) {
deleteFilesOnError();
return scanres; // return on error
}
if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
// no checks for now
lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
- WriteStatus(minib, _("Running MakeIndex."));
+ if (lfun) {
+ lfun->dispatch(LFUN_MESSAGE, _("Running MakeIndex."));
+ }
+
rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
}
// -> rerun not asked for:
// just return (fall out of bottom of func)
//
- while ((head.sumchange() || rerun || (scanres & LaTeX::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;
- WriteStatus(minib, string(_("LaTeX run number ")) + tostr(count));
+ if (lfun) {
+ ostringstream str;
+ str << _("LaTeX run number") << ' ' << count;
+ lfun->dispatch(LFUN_MESSAGE, str.str().c_str());
+ }
+
this->operator()();
scanres = scanLogFile(terr);
- if (scanres & LaTeX::ERRORS) {
+ if (scanres & ERRORS) {
deleteFilesOnError();
return scanres; // return on error
}
return true;
}
-// scanAux may return a wrong result if there are more than two bibliographies,
-// and after LaTeX-ing the file, the user changes the order of the bibliography
-// and run LaTeX again. However, in this case, bibtopic prints a warning message which
-// is caught by scanLogFile.
-bool LaTeX::scanAux(DepTable & dep)
-{
- // if any of the bib file has changed we don't have to
- // check the .aux file.
- if (dep.extchanged(".bib")
- || dep.extchanged(".bst")) return true;
-
- string aux = OnlyFilename(ChangeExtension(file, ".aux"));
- return !scanAuxFiles(aux, dep, false).empty();
-}
-vector<string> const
-LaTeX::scanAuxFiles(string const & file, DepTable & dep, bool insert)
+vector<Aux_Info> const
+LaTeX::scanAuxFiles(string const & file)
{
- vector<string> result;
- if (scanAuxFile(file, dep, insert)) {
- result.push_back(file);
- if (!insert)
- return result;
- }
+ vector<Aux_Info> result;
+
+ result.push_back(scanAuxFile(file));
for (int i = 1; i < 1000; ++i) {
string file2 = ChangeExtension(file, "") + "." + tostr(i)
+ ".aux";
FileInfo fi(file2);
if (!fi.exist())
- return result;
- if (scanAuxFile(file2, dep, insert)) {
- result.push_back(file2);
- if (!insert)
- return result;
- }
+ break;
+ result.push_back(scanAuxFile(file2));
}
return result;
}
-// If insert = true, then scanAuxFile returns true iff the aux file contains
-// a bibtex database (i.e. a \bibdata command), or it inputs another auxfile which
-// contains a bibtex database.
-// Also the dep is updated for all bibtex databases and bibtex styles in the aux
-// file.
-// Ideally, scanAuxFile should return true iff one of the bibtex database/styles has
-// changes from previous run, or a new bibtex database/styles was added to the aux file.
-// However, it is probably not worth the effort.
-//
-// If insert = false, then scanAuxFile returns true iff the aux file contains a
-// bibtex database or a bibtex style that do not appear in dep.
-//
-bool LaTeX::scanAuxFile(string const & file, DepTable & dep, bool insert)
+Aux_Info const LaTeX::scanAuxFile(string const & file)
+{
+ Aux_Info result;
+ result.aux_file = file;
+ scanAuxFile(file, result);
+ return result;
+}
+
+
+void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info)
{
lyxerr[Debug::LATEX] << "Scanning aux file: " << file << endl;
ifstream ifs(file.c_str());
string token;
- LRegex reg1("\\\\bibdata\\{([^}]+)\\}");
- LRegex reg2("\\\\bibstyle\\{([^}]+)\\}");
- LRegex reg3("\\\\@input\\{([^}]+)\\}");
- bool result = false;
+ LRegex reg1("\\\\citation\\{([^}]+)\\}");
+ LRegex reg2("\\\\bibdata\\{([^}]+)\\}");
+ LRegex reg3("\\\\bibstyle\\{([^}]+)\\}");
+ LRegex reg4("\\\\@input\\{([^}]+)\\}");
+
while (getline(ifs, token)) {
+ token = strip(token, '\r');
if (reg1.exact_match(token)) {
- if (insert)
- result = true;
LRegex::SubMatches const & sub = reg1.exec(token);
+ string data = LSubstring(token, sub[1].first,
+ sub[1].second);
+ while (!data.empty()) {
+ string citation;
+ data = split(data, citation, ',');
+ lyxerr[Debug::LATEX] << "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);
// data is now all the bib files separated by ','
// get them one by one and pass them to the helper
while (!data.empty()) {
- string l;
- data = split(data, l, ',');
- string full_l =
- findtexfile(ChangeExtension(l, "bib"),
- "bib");
+ string database;
+ data = split(data, database, ',');
+ database = ChangeExtension(database, "bib");
lyxerr[Debug::LATEX] << "Bibtex database: `"
- << full_l << "'" << endl;
- if (!full_l.empty()) {
- if (insert)
- // add full_l to the dep file.
- dep.insert(full_l, true);
- else
- if (!dep.exist(full_l))
- return true;
- }
+ << database << "'" << endl;
+ aux_info.databases.insert(database);
}
- } else if (reg2.exact_match(token)) {
- LRegex::SubMatches const & sub = reg2.exec(token);
+ } else if (reg3.exact_match(token)) {
+ LRegex::SubMatches const & sub = reg3.exec(token);
string style = LSubstring(token, sub[1].first,
sub[1].second);
// token is now the style file
// pass it to the helper
- string full_l =
- findtexfile(ChangeExtension(style, "bst"),
- "bst");
+ style = ChangeExtension(style, "bst");
lyxerr[Debug::LATEX] << "Bibtex style: `"
- << full_l << "'" << endl;
- if (!full_l.empty()) {
- if (insert)
- // add full_l to the dep file.
- dep.insert(full_l, true);
- else
- if (!dep.exist(full_l))
- return true;
- }
- } else if (reg3.exact_match(token)) {
- LRegex::SubMatches const & sub = reg3.exec(token);
+ << 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);
- result |= scanAuxFile(file2, dep, insert);
- if (result && !insert)
- return true;
+ scanAuxFile(file2, aux_info);
}
}
- return result;
}
-bool LaTeX::runBibTeX(DepTable & dep)
+void LaTeX::updateBibtexDependencies(DepTable & dep,
+ vector<Aux_Info> const & bibtex_info)
{
// Since a run of Bibtex mandates more latex runs it is ok to
- // remove all ".bib" and ".bst" files, it is also required to
- // discover style and database changes.
+ // remove all ".bib" and ".bst" files.
dep.remove_files_with_extension(".bib");
dep.remove_files_with_extension(".bst");
- string aux = OnlyFilename(ChangeExtension(file, ".aux"));
- vector<string> const aux_files = scanAuxFiles(aux, dep, true);
- // Run bibtex on each of the aux files in
- for (vector<string>::const_iterator it = aux_files.begin();
- it != aux_files.end(); ++it) {
+ //string aux = OnlyFilename(ChangeExtension(file, ".aux"));
+
+ for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
+ it != bibtex_info.end(); ++it) {
+ for (set<string>::const_iterator it2 = it->databases.begin();
+ it2 != it->databases.end(); ++it2) {
+ string file = findtexfile(*it2, "bib");
+ if (!file.empty())
+ dep.insert(file, true);
+ }
+
+ for (set<string>::const_iterator it2 = it->styles.begin();
+ it2 != it->styles.end(); ++it2) {
+ string file = findtexfile(*it2, "bst");
+ if (!file.empty())
+ dep.insert(file, true);
+ }
+ }
+}
+
+
+bool LaTeX::runBibTeX(vector<Aux_Info> const & bibtex_info)
+{
+ bool result = false;
+ for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
+ it != bibtex_info.end(); ++it) {
+ if (it->databases.empty())
+ continue;
+ result = true;
+
string tmp = "bibtex ";
- tmp += OnlyFilename(ChangeExtension(*it, string()));
+ tmp += OnlyFilename(ChangeExtension(it->aux_file, string()));
Systemcalls one;
one.startscript(Systemcalls::System, tmp);
}
// Return whether bibtex was run
- return !aux_files.empty();
+ return result;
}
}
} 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 (prefixIs(token, "(")) {
+ 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, "! ")) {
if (prefixIs(tmp, "l.")) {
// we have a latex error
retval |= TEX_ERROR;
+ if (contains(desc, "Package babel Error: You haven't defined the language"))
+ retval |= ERROR_RERUN;
// get the line number:
int line = 0;
sscanf(tmp.c_str(), "l.%d", &line);
retval |= TEX_WARNING;
} else if (contains(token, "Rerun to get citations")) {
// Natbib seems to use this.
- retval |= RERUN;
+ retval |= UNDEF_CIT;
} else if (contains(token, "No pages of output")) {
// A dvi file was not created
retval |= NO_OUTPUT;
// files used by the LaTeX run. The files are then entered into the
// dependency file.
- string logfile = OnlyFilename(ChangeExtension(file, ".log"));
+ string const logfile = OnlyFilename(ChangeExtension(file, ".log"));
- LRegex reg1(")* *\\(([^ \\)]+).*");
+ LRegex reg1("\\)* *\\(([^ )]+).*");
LRegex reg2("File: ([^ ]+).*");
LRegex reg3("No file ([^ ]+)\\..*");
LRegex 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
+ LRegex reg5("Writing index file ([^ ]+).*");
LRegex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$");
ifstream ifs(logfile.c_str());
string foundfile;
string token;
getline(ifs, token);
+ token = strip(token, '\r');
if (token.empty()) continue;
if (reg1.exact_match(token)) {
LRegex::SubMatches const & sub = reg4.exec(token);
foundfile = LSubstring(token, sub[1].first,
sub[1].second);
+ } else if (reg5.exact_match(token)) {
+ LRegex::SubMatches const & sub = reg5.exec(token);
+ foundfile = LSubstring(token, sub[1].first,
+ sub[1].second);
} else {
continue;
}
+ // convert from native os path to unix path
+ foundfile = os::internal_path(foundfile);
+
lyxerr[Debug::DEPEND] << "Found 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.
- head.insert(foundfile, true);
- continue;
+ if (FileInfo(foundfile).exist())
+ head.insert(foundfile, true);
}
// (2) foundfile is in the tmpdir
// insert it into head
- if (FileInfo(OnlyFilename(foundfile)).exist()) {
+ else if (FileInfo(OnlyFilename(foundfile)).exist()) {
if (unwanted.exact_match(foundfile)) {
lyxerr[Debug::DEPEND]
<< "We don't want "
<< endl;
head.insert(OnlyFilename(foundfile));
}
- continue;
- }
- lyxerr[Debug::DEPEND]
- << "Not a file or we are unable to find it."
- << endl;
+ } else
+ lyxerr[Debug::DEPEND]
+ << "Not a file or we are unable to find it."
+ << endl;
}
+
+ // Make sure that the main .tex file is in the dependancy file.
+ head.insert(OnlyFilename(file), true);
}