-/* 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
+ * \author Jürgen Spitzmüller
*
- * ======================================================
+ * Full author contact details are available in file CREDITS.
*/
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-#include <fstream>
-
+#include "bufferlist.h"
#include "LaTeX.h"
-#include "support/filetools.h"
-#include "support/os.h"
-#include "support/FileInfo.h"
+#include "gettext.h"
+#include "lyxrc.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 "DepTable.h"
+
+#include "support/filetools.h"
+#include "support/convert.h"
#include "support/lstrings.h"
-#include "bufferlist.h"
-#include "gettext.h"
-#include "lyx_gui_misc.h"
-#include "lyxfunc.h"
+#include "support/lyxlib.h"
+#include "support/systemcall.h"
+#include "support/os.h"
+
+#include <boost/filesystem/operations.hpp>
+#include <boost/filesystem/path.hpp>
+#include <boost/regex.hpp>
+
+#include <fstream>
+
+
+namespace lyx {
+
+using support::absolutePath;
+using support::bformat;
+using support::changeExtension;
+using support::contains;
+using support::FileName;
+using support::findtexfile;
+using support::getcwd;
+using support::makeAbsPath;
+using support::onlyFilename;
+using support::prefixIs;
+using support::quoteName;
+using support::removeExtension;
+using support::rtrim;
+using support::rsplit;
+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 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
*/
-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);
+ 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,
+ FileName const & f)
+ : cmd(latex), file(f), runparams(rp)
{
num_errors = 0;
- depfile = file + ".dep";
if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
- depfile += "-pdf";
- output_file = ChangeExtension(file,".pdf");
+ depfile = FileName(file.absFilename() + ".dep-pdf");
+ output_file =
+ FileName(changeExtension(file.absFilename(), ".pdf"));
} else {
- output_file = ChangeExtension(file,".dvi");
+ depfile = FileName(file.absFilename() + ".dep");
+ output_file =
+ FileName(changeExtension(file.absFilename(), ".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);
-
// bibtex file
- string bbl = ChangeExtension(ofname, ".bbl");
- lyx::unlink(bbl);
+ FileName const bbl(changeExtension(file.absFilename(), ".bbl"));
+ unlink(bbl);
// makeindex file
- string ind = ChangeExtension(ofname, ".ind");
- lyx::unlink(ind);
-
+ FileName const ind(changeExtension(file.absFilename(), ".ind"));
+ unlink(ind);
+
+ // nomencl file
+ FileName const nls(changeExtension(file.absFilename(), ".nls"));
+ unlink(nls);
+
// Also remove the aux file
- string aux = ChangeExtension(ofname, ".aux");
- lyx::unlink(aux);
+ FileName const aux(changeExtension(file.absFilename(), ".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
- // in it. However it seems safe to run latex (at least) on time each
- // time the .tex file changes.
+ // in it. However it seems safe to run latex (at least) on time
+ // each time the .tex file changes.
{
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().absFilename(),
+ runparams);
+
// Never write the depfile if an error was encountered.
-
+
// 0
// first check if the file dependencies exist:
// ->If it does exist
// remake the dependency file.
//
- FileInfo fi(depfile);
- bool had_depfile = fi.exist();
+ bool had_depfile = fs::exists(depfile.toFilesystemEncoding());
bool run_bibtex = false;
- string aux_file = OnlyFilename(ChangeExtension(file, "aux"));
+ FileName const aux_file(changeExtension(file.absFilename(), "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()) {
+ // 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 (!fs::exists(output_file.toFilesystemEncoding())) {
lyxerr[Debug::DEPEND]
- << "re-running LaTeX because output file doesn't exist." << endl;
+ << "re-running LaTeX because output file doesn't exist."
+ << endl;
} else if (!head.sumchange()) {
lyxerr[Debug::DEPEND] << "return no_change" << endl;
return NO_CHANGE;
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.
-
+
+ // memoir (at least) writes an empty *idx file in the first place.
+ // A second latex run is needed.
+ FileName const idxfile(changeExtension(file.absFilename(), ".idx"));
+ rerun = fs::exists(idxfile.toFilesystemEncoding()) &&
+ fs::is_empty(idxfile.toFilesystemEncoding());
+
// run makeindex
- if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
+ if (head.haschanged(idxfile)) {
// 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."));
+ // onlyFilename() is needed for cygwin
+ rerun |= runMakeIndex(onlyFilename(idxfile.absFilename()),
+ runparams);
+ }
+ if (head.haschanged(FileName(changeExtension(file.absFilename(), ".nlo")))) {
+ lyxerr[Debug::LATEX]
+ << "Running MakeIndex for nomencl."
+ << endl;
+ message(_("Running MakeIndex for nomencl."));
+ // onlyFilename() is needed for cygwin
+ string const nomenclstr = " -s nomencl.ist -o "
+ + onlyFilename(changeExtension(
+ file.toFilesystemEncoding(), ".nls"));
+ rerun |= runMakeIndex(onlyFilename(changeExtension(
+ file.absFilename(), ".nlo")),
+ runparams,
+ nomenclstr);
}
// 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
rerun = false;
++count;
lyxerr[Debug::DEPEND]
- << "Dep. file has changed or rerun requested" << endl;
+ << "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();
} else {
- lyxerr[Debug::DEPEND] << "Dep. file has NOT changed" << endl;
+ lyxerr[Debug::DEPEND]
+ << "Dep. file has NOT changed"
+ << endl;
}
// 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 <file>.idx has changed or was generated.
- if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
+ if (head.haschanged(FileName(changeExtension(file.absFilename(), ".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."));
+ // onlyFilename() is needed for cygwin
+ rerun = runMakeIndex(onlyFilename(changeExtension(
+ file.absFilename(), ".idx")), runparams);
}
-
+
+ // I am not pretty sure if need this twice.
+ if (head.haschanged(FileName(changeExtension(file.absFilename(), ".nlo")))) {
+ lyxerr[Debug::LATEX]
+ << "Running MakeIndex for nomencl."
+ << endl;
+ message(_("Running MakeIndex for nomencl."));
+ // onlyFilename() is needed for cygwin
+ string nomenclstr = " -s nomencl.ist -o "
+ + onlyFilename(changeExtension(
+ file.toFilesystemEncoding(), ".nls"));
+ rerun |= runMakeIndex(onlyFilename(changeExtension(
+ file.absFilename(), ".nlo")),
+ runparams,
+ nomenclstr);
+ }
+
// 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);
+ // onlyFilename() is needed for cygwin
+ string tmp = cmd + ' '
+ + quoteName(onlyFilename(file.toFilesystemEncoding()))
+ + " > " + 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. (0.13 perhaps?)
- string tmp = "makeindex -c -q ";
- tmp += f;
- Systemcalls one;
- one.startscript(Systemcalls::System, tmp);
+ 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;
}
vector<Aux_Info> const
-LaTeX::scanAuxFiles(string const & file)
+LaTeX::scanAuxFiles(FileName const & file)
{
vector<Aux_Info> result;
-
+
result.push_back(scanAuxFile(file));
+ string const basename = removeExtension(file.absFilename());
for (int i = 1; i < 1000; ++i) {
- string file2 = ChangeExtension(file, "") + "." + tostr(i)
- + ".aux";
- FileInfo fi(file2);
- if (!fi.exist())
+ FileName const file2(basename
+ + '.' + convert<string>(i)
+ + ".aux");
+ if (!fs::exists(file2.toFilesystemEncoding()))
break;
result.push_back(scanAuxFile(file2));
}
}
-Aux_Info const LaTeX::scanAuxFile(string const & file)
+Aux_Info const LaTeX::scanAuxFile(FileName const & file)
{
Aux_Info result;
result.aux_file = file;
}
-void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info)
+void LaTeX::scanAuxFile(FileName const & file, Aux_Info & aux_info)
{
lyxerr[Debug::LATEX] << "Scanning aux file: " << file << endl;
- ifstream ifs(file.c_str());
+ ifstream ifs(file.toFilesystemEncoding().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;
+ // FIXME UNICODE: We assume that citation keys and filenames
+ // in the aux file are in the file system encoding.
+ token = to_utf8(from_filesystem8bit(token));
+ 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;
+ database = changeExtension(database, "bib");
+ 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;
+ style = changeExtension(style, "bst");
+ 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);
- scanAuxFile(file2, aux_info);
+ } else if (regex_match(token, sub, reg4)) {
+ string const file2 = sub.str(1);
+ scanAuxFile(makeAbsPath(file2), aux_info);
}
}
}
it != bibtex_info.end(); ++it) {
for (set<string>::const_iterator it2 = it->databases.begin();
it2 != it->databases.end(); ++it2) {
- string file = findtexfile(*it2, "bib");
+ FileName const 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");
+ FileName const 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 + " ";
+ // onlyFilename() is needed for cygwin
+ tmp += quoteName(onlyFilename(removeExtension(
+ it->aux_file.absFilename())));
+ Systemcall one;
+ one.startscript(Systemcall::Wait, tmp);
}
// Return whether bibtex was run
return result;
int last_line = -1;
int line_count = 1;
int retval = NO_ERRORS;
- string tmp = OnlyFilename(ChangeExtension(file, ".log"));
+ string tmp =
+ onlyFilename(changeExtension(file.absFilename(), ".log"));
lyxerr[Debug::LATEX] << "Log file: " << tmp << endl;
- ifstream ifs(tmp.c_str());
+ FileName const fn = FileName(makeAbsPath(tmp));
+ ifstream ifs(fn.toFilesystemEncoding().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;
<< "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
if (prefixIs(tmp, "l.")) {
// we have a latex error
retval |= TEX_ERROR;
- if (contains(desc, "Package babel Error: You haven't defined the language"))
+ if (contains(desc,
+ "Package babel Error: You haven't defined the language"))
retval |= ERROR_RERUN;
// get the line number:
int line = 0;
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.
+ // It seems that the output from the
+ // latex compiler itself is pure ASCII,
+ // but it can include bits from the
+ // document, so whatever encoding we
+ // assume here it can be wrong.
+ terr.insertError(line,
+ from_local8bit(desc),
+ from_local8bit(errstr));
++num_errors;
}
}
}
+namespace {
+
+/**
+ * Wrapper around fs::exists that can handle invalid file names.
+ * In theory we could test with fs::native whether a filename is valid
+ * before calling fs::exists, but in practice it is unusable: On windows it
+ * does not allow spaces, and on unix it does not allow absolute file names.
+ * This function has the disadvantage that it catches also other errors than
+ * invalid names, but for dependency checking we can live with that.
+ */
+bool exists(FileName const & possible_name) {
+ try {
+ return fs::exists(possible_name.toFilesystemEncoding());
+ }
+ catch (fs::filesystem_error const & fe) {
+ lyxerr[Debug::DEPEND] << "Got error `" << fe.what()
+ << "' while checking whether file `" << possible_name
+ << "' exists." << endl;
+ return false;
+ }
+}
+
+
+bool insertIfExists(FileName const & absname, DepTable & head)
+{
+ if (exists(absname) &&
+ !fs::is_directory(absname.toFilesystemEncoding())) {
+ head.insert(absname, true);
+ return true;
+ }
+ return false;
+}
+
+
+bool handleFoundFile(string const & ff, DepTable & head)
+{
+ // convert from native os path to unix path
+ string 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 cannot be a file generated by
+ // the latex run.
+ FileName absname(foundfile);
+ if (!insertIfExists(absname, head)) {
+ // check for spaces
+ string strippedfile = foundfile;
+ while (contains(strippedfile, " ")) {
+ // files with spaces are often enclosed in quotation
+ // marks; those have to be removed
+ string unquoted = subst(strippedfile, "\"", "");
+ absname.set(unquoted);
+ if (insertIfExists(absname, head))
+ return true;
+ // strip off part after last space and try again
+ string tmp = strippedfile;
+ string const stripoff =
+ rsplit(tmp, strippedfile, ' ');
+ absname.set(strippedfile);
+ if (insertIfExists(absname, head))
+ return true;
+ }
+ }
+ }
+
+ string onlyfile = onlyFilename(foundfile);
+ FileName absname(makeAbsPath(onlyfile));
+
+ // check for spaces
+ while (contains(foundfile, ' ')) {
+ if (exists(absname))
+ // everything o.k.
+ break;
+ else {
+ // files with spaces are often enclosed in quotation
+ // marks; those have to be removed
+ string unquoted = subst(foundfile, "\"", "");
+ absname = makeAbsPath(unquoted);
+ if (exists(absname))
+ break;
+ // strip off part after last space and try again
+ string strippedfile;
+ string const stripoff =
+ rsplit(foundfile, strippedfile, ' ');
+ foundfile = strippedfile;
+ onlyfile = onlyFilename(strippedfile);
+ absname = makeAbsPath(onlyfile);
+ }
+ }
+
+ // (2) foundfile is in the tmpdir
+ // insert it into head
+ if (exists(absname) &&
+ !fs::is_directory(absname.toFilesystemEncoding())) {
+ 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(absname, true);
+ } else {
+ lyxerr[Debug::DEPEND]
+ << "In tmpdir file:"
+ << onlyfile
+ << endl;
+ head.insert(absname);
+ }
+ return true;
+ } else {
+ lyxerr[Debug::DEPEND]
+ << "Not a file or we are unable to find it."
+ << endl;
+ return false;
+ }
+}
+
+
+bool checkLineBreak(string const & ff, DepTable & head)
+{
+ if (contains(ff, '.'))
+ // if we have a dot, we let handleFoundFile decide
+ return handleFoundFile(ff, head);
+ else
+ // else, we suspect a line break
+ return false;
+}
+
+} // 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.
+ // 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.absFilename(), ".log"));
- LRegex reg1("\\)* *\\(([^ )]+).*");
- LRegex reg2("File: ([^ ]+).*");
- LRegex reg3("No file ([^ ]+)\\..*");
- LRegex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*");
+ static regex reg1("File: (.+).*");
+ static regex reg2("No file (.+)(.).*");
+ static regex reg3("\\\\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
- LRegex reg5("Writing index file ([^ ]+).*");
- LRegex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$");
-
- ifstream ifs(logfile.c_str());
+ static regex reg4("Writing index file (.+).*");
+ // files also can be enclosed in <...>
+ static regex reg5("<([^>]+)(.).*");
+ 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.*");
+ static regex reg6(".*\\([^)]+.*");
+
+ FileName const fn(makeAbsPath(logfile));
+ ifstream ifs(fn.toFilesystemEncoding().c_str());
+ string lastline;
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
- // "File: \([^ ]+\)" should match the "File: file" variant
- string foundfile;
+ // Note: all file names and paths might contains spaces.
+ bool found_file = false;
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 if (reg5.exact_match(token)) {
- LRegex::SubMatches const & sub = reg5.exec(token);
- foundfile = LSubstring(token, sub[1].first,
- sub[1].second);
- } 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() || token == ")") {
+ lastline = string();
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);
+ // Sometimes, filenames are broken across lines.
+ // We care for that and save suspicious lines.
+ // Here we exclude some cases where we are sure
+ // that there is no continued filename
+ if (!lastline.empty()) {
+ static regex package_info("Package \\w+ Info: .*");
+ static regex package_warning("Package \\w+ Warning: .*");
+ if (prefixIs(token, "File:") || prefixIs(token, "(Font)")
+ || prefixIs(token, "Package:")
+ || prefixIs(token, "Language:")
+ || prefixIs(token, "LaTeX Info:")
+ || prefixIs(token, "LaTeX Font Info:")
+ || prefixIs(token, "\\openout[")
+ || prefixIs(token, "))")
+ || regex_match(token, package_info)
+ || regex_match(token, package_warning))
+ lastline = string();
+ }
+
+ if (!lastline.empty())
+ // probably a continued filename from last line
+ token = lastline + token;
+ if (token.length() > 255) {
+ // string too long. Cut off.
+ token.erase(0, token.length() - 251);
}
- // (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));
+ smatch sub;
+
+ // FIXME UNICODE: We assume that the file names in the log
+ // file are in the file system encoding.
+ token = to_utf8(from_filesystem8bit(token));
+
+ // (1) "File: file.ext"
+ if (regex_match(token, sub, reg1)) {
+ // check for dot
+ found_file = checkLineBreak(sub.str(1), head);
+ // However, ...
+ if (suffixIs(token, ")"))
+ // no line break for sure
+ // pretend we've been succesfully searching
+ found_file = true;
+ // (2) "No file file.ext"
+ } else if (regex_match(token, sub, reg2)) {
+ // file names must contains a dot, line ends with dot
+ if (contains(sub.str(1), '.') && sub.str(2) == ".")
+ found_file = handleFoundFile(sub.str(1), head);
+ else
+ // we suspect a line break
+ found_file = false;
+ // (3) "\openout<nr> = `file.ext'."
+ } else if (regex_match(token, sub, reg3)) {
+ // search for closing '. at the end of the line
+ if (sub.str(2) == "\'.")
+ found_file = handleFoundFile(sub.str(1), head);
+ else
+ // probable line break
+ found_file = false;
+ // (4) "Writing index file file.ext"
+ } else if (regex_match(token, sub, reg4))
+ // check for dot
+ found_file = checkLineBreak(sub.str(1), head);
+ // (5) "<file.ext>"
+ else if (regex_match(token, sub, reg5)) {
+ // search for closing '>' and dot ('*.*>') at the eol
+ if (contains(sub.str(1), '.') && sub.str(2) == ">")
+ found_file = handleFoundFile(sub.str(1), head);
+ else
+ // probable line break
+ found_file = false;
+ // (6) "Writing nomenclature file file.ext"
+ } else if (regex_match(token, sub, regnomencl))
+ // check for dot
+ found_file = checkLineBreak(sub.str(1), head);
+ // (7) "\tf@toc=\write<nr>" (for MikTeX)
+ else if (regex_match(token, sub, miktexTocReg))
+ found_file = handleFoundFile(onlyFilename(changeExtension(
+ file.absFilename(), ".toc")), head);
+ else
+ // not found, but we won't check further
+ // pretend we've been succesfully searching
+ found_file = true;
+
+ // (8) "(file.ext"
+ // note that we can have several of these on one line
+ // this must be queried separated, because of
+ // cases such as "File: file.ext (type eps)"
+ // where "File: file.ext" would be skipped
+ if (regex_match(token, sub, reg6)) {
+ // search for strings in (...)
+ static regex reg6_1("\\(([^()]+)(.).*");
+ smatch what;
+ string::const_iterator first = token.begin();
+ string::const_iterator end = token.end();
+
+ while (regex_search(first, end, what, reg6_1)) {
+ // if we have a dot, try to handle as file
+ if (contains(what.str(1), '.')) {
+ first = what[0].second;
+ if (what.str(2) == ")") {
+ handleFoundFile(what.str(1), head);
+ // since we had a closing bracket,
+ // do not investigate further
+ found_file = true;
+ } else
+ // if we have no closing bracket,
+ // try to handle as file nevertheless
+ found_file = handleFoundFile(
+ what.str(1) + what.str(2), head);
+ }
+ // if we do not have a dot, check if the line has
+ // a closing bracket (else, we suspect a line break)
+ else if (what.str(2) != ")") {
+ first = what[0].second;
+ found_file = false;
+ } else {
+ // we have a closing bracket, so the content
+ // is not a file name.
+ // no need to investigate further
+ // pretend we've been succesfully searching
+ first = what[0].second;
+ found_file = true;
+ }
}
- } else
- lyxerr[Debug::DEPEND]
- << "Not a file or we are unable to find it."
- << endl;
+ }
+
+ if (!found_file)
+ // probable linebreak:
+ // save this line
+ lastline = token;
+ else
+ // no linebreak: reset
+ lastline = string();
}
- // Make sure that the main .tex file is in the dependancy file.
- head.insert(OnlyFilename(file), true);
+ // Make sure that the main .tex file is in the dependency file.
+ head.insert(file, true);
}
+
+
+} // namespace lyx
projects / lyx.git / blobdiff