3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
11 * \author Jürgen Spitzmüller
13 * Full author contact details are available in file CREDITS.
18 #include "BufferList.h"
23 #include "support/debug.h"
24 #include "support/convert.h"
25 #include "support/FileName.h"
26 #include "support/filetools.h"
27 #include "support/gettext.h"
28 #include "support/lstrings.h"
29 #include "support/Systemcall.h"
30 #include "support/os.h"
32 #include <boost/regex.hpp>
40 using namespace lyx::support;
44 namespace os = support::os;
46 // TODO: in no particular order
47 // - get rid of the call to
48 // BufferList::updateIncludedTeXfiles, this should either
49 // be done before calling LaTeX::funcs or in a completely
51 // - the makeindex style files should be taken care of with
52 // the dependency mechanism.
53 // - makeindex commandline options should be supported
54 // - somewhere support viewing of bibtex and makeindex log files.
55 // - we should perhaps also scan the bibtex log file
59 docstring runMessage(unsigned int count)
61 return bformat(_("Waiting for LaTeX run number %1$d"), count);
70 void TeXErrors::insertError(int line, docstring const & error_desc,
71 docstring const & error_text)
73 Error newerr(line, error_desc, error_text);
74 errors.push_back(newerr);
78 bool operator==(AuxInfo const & a, AuxInfo const & o)
80 return a.aux_file == o.aux_file
81 && a.citations == o.citations
82 && a.databases == o.databases
83 && a.styles == o.styles;
87 bool operator!=(AuxInfo const & a, AuxInfo const & o)
97 LaTeX::LaTeX(string const & latex, OutputParams const & rp,
99 : cmd(latex), file(f), runparams(rp)
102 if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
103 depfile = FileName(file.absFilename() + ".dep-pdf");
105 FileName(changeExtension(file.absFilename(), ".pdf"));
107 depfile = FileName(file.absFilename() + ".dep");
109 FileName(changeExtension(file.absFilename(), ".dvi"));
114 void LaTeX::deleteFilesOnError() const
116 // currently just a dummy function.
118 // What files do we have to delete?
120 // This will at least make latex do all the runs
121 depfile.removeFile();
123 // but the reason for the error might be in a generated file...
126 FileName const bbl(changeExtension(file.absFilename(), ".bbl"));
130 FileName const ind(changeExtension(file.absFilename(), ".ind"));
134 FileName const nls(changeExtension(file.absFilename(), ".nls"));
137 // nomencl file (old version of the package)
138 FileName const gls(changeExtension(file.absFilename(), ".gls"));
141 // Also remove the aux file
142 FileName const aux(changeExtension(file.absFilename(), ".aux"));
147 int LaTeX::run(TeXErrors & terr)
148 // We know that this function will only be run if the lyx buffer
149 // has been changed. We also know that a newly written .tex file
150 // is always different from the previous one because of the date
151 // in it. However it seems safe to run latex (at least) on time
152 // each time the .tex file changes.
154 int scanres = NO_ERRORS;
155 unsigned int count = 0; // number of times run
156 num_errors = 0; // just to make sure.
157 unsigned int const MAX_RUN = 6;
158 DepTable head; // empty head
159 bool rerun = false; // rerun requested
161 // The class LaTeX does not know the temp path.
162 theBufferList().updateIncludedTeXfiles(FileName::getcwd().absFilename(),
165 // Never write the depfile if an error was encountered.
168 // first check if the file dependencies exist:
169 // ->If it does exist
170 // check if any of the files mentioned in it have
171 // changed (done using a checksum).
173 // run latex once and
174 // remake the dependency file
175 // -> if not changed:
176 // just return there is nothing to do for us.
177 // ->if it doesn't exist
179 // run latex once (we need to run latex once anyway) and
180 // remake the dependency file.
183 bool had_depfile = depfile.exists();
184 bool run_bibtex = false;
185 FileName const aux_file(changeExtension(file.absFilename(), "aux"));
188 LYXERR(Debug::DEPEND, "Dependency file exists");
189 // Read the dep file:
190 had_depfile = head.read(depfile);
194 // Update the checksums
196 // Can't just check if anything has changed because it might
197 // have aborted on error last time... in which cas we need
198 // to re-run latex and collect the error messages
199 // (even if they are the same).
200 if (!output_file.exists()) {
201 LYXERR(Debug::DEPEND,
202 "re-running LaTeX because output file doesn't exist.");
203 } else if (!head.sumchange()) {
204 LYXERR(Debug::DEPEND, "return no_change");
207 LYXERR(Debug::DEPEND, "Dependency file has changed");
210 if (head.extchanged(".bib") || head.extchanged(".bst"))
213 LYXERR(Debug::DEPEND,
214 "Dependency file does not exist, or has wrong format");
216 /// We scan the aux file even when had_depfile = false,
217 /// because we can run pdflatex on the file after running latex on it,
218 /// in which case we will not need to run bibtex again.
219 vector<AuxInfo> bibtex_info_old;
221 bibtex_info_old = scanAuxFiles(aux_file);
224 LYXERR(Debug::LATEX, "Run #" << count);
225 message(runMessage(count));
228 scanres = scanLogFile(terr);
229 if (scanres & ERROR_RERUN) {
230 LYXERR(Debug::LATEX, "Rerunning LaTeX");
232 scanres = scanLogFile(terr);
235 if (scanres & ERRORS) {
236 deleteFilesOnError();
237 return scanres; // return on error
240 vector<AuxInfo> const bibtex_info = scanAuxFiles(aux_file);
241 if (!run_bibtex && bibtex_info_old != bibtex_info)
244 // update the dependencies.
245 deplog(head); // reads the latex log
249 // At this point we must run external programs if needed.
250 // makeindex will be run if a .idx file changed or was generated.
251 // And if there were undefined citations or changes in references
252 // the .aux file is checked for signs of bibtex. Bibtex is then run
255 // memoir (at least) writes an empty *idx file in the first place.
256 // A second latex run is needed.
257 FileName const idxfile(changeExtension(file.absFilename(), ".idx"));
258 rerun = idxfile.exists() && idxfile.isFileEmpty();
261 if (head.haschanged(idxfile)) {
263 LYXERR(Debug::LATEX, "Running MakeIndex.");
264 message(_("Running Index Processor."));
265 // onlyFilename() is needed for cygwin
266 rerun |= runMakeIndex(onlyFilename(idxfile.absFilename()),
269 FileName const nlofile(changeExtension(file.absFilename(), ".nlo"));
270 if (head.haschanged(nlofile))
271 rerun |= runMakeIndexNomencl(file, ".nlo", ".nls");
272 FileName const glofile(changeExtension(file.absFilename(), ".glo"));
273 if (head.haschanged(glofile))
274 rerun |= runMakeIndexNomencl(file, ".glo", ".gls");
277 // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
278 if (scanres & UNDEF_CIT || run_bibtex) {
279 // Here we must scan the .aux file and look for
280 // "\bibdata" and/or "\bibstyle". If one of those
281 // tags is found -> run bibtex and set rerun = true;
283 LYXERR(Debug::LATEX, "Running BibTeX.");
284 message(_("Running BibTeX."));
285 updateBibtexDependencies(head, bibtex_info);
286 rerun |= runBibTeX(bibtex_info, runparams);
287 } else if (!had_depfile) {
288 /// If we run pdflatex on the file after running latex on it,
289 /// then we do not need to run bibtex, but we do need to
290 /// insert the .bib and .bst files into the .dep-pdf file.
291 updateBibtexDependencies(head, bibtex_info);
295 // we know on this point that latex has been run once (or we just
296 // returned) and the question now is to decide if we need to run
297 // it any more. This is done by asking if any of the files in the
298 // dependency file has changed. (remember that the checksum for
299 // a given file is reported to have changed if it just was created)
300 // -> if changed or rerun == true:
301 // run latex once more and
302 // update the dependency structure
303 // -> if not changed:
304 // we do nothing at this point
306 if (rerun || head.sumchange()) {
309 LYXERR(Debug::DEPEND, "Dep. file has changed or rerun requested");
310 LYXERR(Debug::LATEX, "Run #" << count);
311 message(runMessage(count));
313 scanres = scanLogFile(terr);
314 if (scanres & ERRORS) {
315 deleteFilesOnError();
316 return scanres; // return on error
319 // update the depedencies
320 deplog(head); // reads the latex log
323 LYXERR(Debug::DEPEND, "Dep. file has NOT changed");
328 // Complex bibliography packages such as Biblatex require
329 // an additional bibtex cycle sometimes.
330 if (scanres & UNDEF_CIT) {
331 // Here we must scan the .aux file and look for
332 // "\bibdata" and/or "\bibstyle". If one of those
333 // tags is found -> run bibtex and set rerun = true;
335 LYXERR(Debug::LATEX, "Running BibTeX.");
336 message(_("Running BibTeX."));
337 updateBibtexDependencies(head, bibtex_info);
338 rerun |= runBibTeX(bibtex_info, runparams);
342 // The inclusion of files generated by external programs such as
343 // makeindex or bibtex might have done changes to pagenumbering,
344 // etc. And because of this we must run the external programs
345 // again to make sure everything is redone correctly.
346 // Also there should be no need to run the external programs any
349 // run makeindex if the <file>.idx has changed or was generated.
350 if (head.haschanged(idxfile)) {
352 LYXERR(Debug::LATEX, "Running MakeIndex.");
353 message(_("Running Index Processor."));
354 // onlyFilename() is needed for cygwin
355 rerun = runMakeIndex(onlyFilename(changeExtension(
356 file.absFilename(), ".idx")), runparams);
359 // I am not pretty sure if need this twice.
360 if (head.haschanged(nlofile))
361 rerun |= runMakeIndexNomencl(file, ".nlo", ".nls");
362 if (head.haschanged(glofile))
363 rerun |= runMakeIndexNomencl(file, ".glo", ".gls");
366 // we will only run latex more if the log file asks for it.
367 // or if the sumchange() is true.
368 // -> rerun asked for:
370 // remake the dependency file
371 // goto 2 or return if max runs are reached.
372 // -> rerun not asked for:
373 // just return (fall out of bottom of func)
375 while ((head.sumchange() || rerun || (scanres & RERUN))
376 && count < MAX_RUN) {
377 // Yes rerun until message goes away, or until
378 // MAX_RUNS are reached.
381 LYXERR(Debug::LATEX, "Run #" << count);
382 message(runMessage(count));
384 scanres = scanLogFile(terr);
385 if (scanres & ERRORS) {
386 deleteFilesOnError();
387 return scanres; // return on error
394 // Write the dependencies to file.
396 LYXERR(Debug::LATEX, "Done.");
401 int LaTeX::startscript()
403 // onlyFilename() is needed for cygwin
404 string tmp = cmd + ' '
405 + quoteName(onlyFilename(file.toFilesystemEncoding()))
406 + " > " + os::nulldev();
408 return one.startscript(Systemcall::Wait, tmp);
412 bool LaTeX::runMakeIndex(string const & f, OutputParams const & runparams,
413 string const & params)
416 "idx file has been made, running makeindex on file " << f);
417 string tmp = runparams.use_japanese ?
418 lyxrc.jindex_command : lyxrc.index_command;
420 tmp = subst(tmp, "$$lang", runparams.document_language);
421 if (runparams.use_indices)
422 tmp = lyxrc.splitindex_command + " -m " + quoteName(tmp);
427 one.startscript(Systemcall::Wait, tmp);
432 bool LaTeX::runMakeIndexNomencl(FileName const & file,
433 string const & nlo, string const & nls)
435 LYXERR(Debug::LATEX, "Running MakeIndex for nomencl.");
436 message(_("Running MakeIndex for nomencl."));
437 string tmp = lyxrc.nomencl_command + ' ';
438 // onlyFilename() is needed for cygwin
439 tmp += quoteName(onlyFilename(changeExtension(file.absFilename(), nlo)));
441 + onlyFilename(changeExtension(file.toFilesystemEncoding(), nls));
443 one.startscript(Systemcall::Wait, tmp);
448 vector<AuxInfo> const
449 LaTeX::scanAuxFiles(FileName const & file)
451 vector<AuxInfo> result;
453 result.push_back(scanAuxFile(file));
455 string const basename = removeExtension(file.absFilename());
456 for (int i = 1; i < 1000; ++i) {
457 FileName const file2(basename
458 + '.' + convert<string>(i)
462 result.push_back(scanAuxFile(file2));
468 AuxInfo const LaTeX::scanAuxFile(FileName const & file)
471 result.aux_file = file;
472 scanAuxFile(file, result);
477 void LaTeX::scanAuxFile(FileName const & file, AuxInfo & aux_info)
479 LYXERR(Debug::LATEX, "Scanning aux file: " << file);
481 ifstream ifs(file.toFilesystemEncoding().c_str());
483 static regex const reg1("\\\\citation\\{([^}]+)\\}");
484 static regex const reg2("\\\\bibdata\\{([^}]+)\\}");
485 static regex const reg3("\\\\bibstyle\\{([^}]+)\\}");
486 static regex const reg4("\\\\@input\\{([^}]+)\\}");
488 while (getline(ifs, token)) {
489 token = rtrim(token, "\r");
491 // FIXME UNICODE: We assume that citation keys and filenames
492 // in the aux file are in the file system encoding.
493 token = to_utf8(from_filesystem8bit(token));
494 if (regex_match(token, sub, reg1)) {
495 string data = sub.str(1);
496 while (!data.empty()) {
498 data = split(data, citation, ',');
499 LYXERR(Debug::LATEX, "Citation: " << citation);
500 aux_info.citations.insert(citation);
502 } else if (regex_match(token, sub, reg2)) {
503 string data = sub.str(1);
504 // data is now all the bib files separated by ','
505 // get them one by one and pass them to the helper
506 while (!data.empty()) {
508 data = split(data, database, ',');
509 database = changeExtension(database, "bib");
510 LYXERR(Debug::LATEX, "BibTeX database: `" << database << '\'');
511 aux_info.databases.insert(database);
513 } else if (regex_match(token, sub, reg3)) {
514 string style = sub.str(1);
515 // token is now the style file
516 // pass it to the helper
517 style = changeExtension(style, "bst");
518 LYXERR(Debug::LATEX, "BibTeX style: `" << style << '\'');
519 aux_info.styles.insert(style);
520 } else if (regex_match(token, sub, reg4)) {
521 string const file2 = sub.str(1);
522 scanAuxFile(makeAbsPath(file2), aux_info);
528 void LaTeX::updateBibtexDependencies(DepTable & dep,
529 vector<AuxInfo> const & bibtex_info)
531 // Since a run of Bibtex mandates more latex runs it is ok to
532 // remove all ".bib" and ".bst" files.
533 dep.remove_files_with_extension(".bib");
534 dep.remove_files_with_extension(".bst");
535 //string aux = OnlyFilename(ChangeExtension(file, ".aux"));
537 for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
538 it != bibtex_info.end(); ++it) {
539 for (set<string>::const_iterator it2 = it->databases.begin();
540 it2 != it->databases.end(); ++it2) {
541 FileName const file = findtexfile(*it2, "bib");
543 dep.insert(file, true);
546 for (set<string>::const_iterator it2 = it->styles.begin();
547 it2 != it->styles.end(); ++it2) {
548 FileName const file = findtexfile(*it2, "bst");
550 dep.insert(file, true);
556 bool LaTeX::runBibTeX(vector<AuxInfo> const & bibtex_info,
557 OutputParams const & runparams)
560 for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
561 it != bibtex_info.end(); ++it) {
562 if (it->databases.empty())
566 string tmp = runparams.use_japanese ?
567 lyxrc.jbibtex_command : lyxrc.bibtex_command;
569 // onlyFilename() is needed for cygwin
570 tmp += quoteName(onlyFilename(removeExtension(
571 it->aux_file.absFilename())));
573 one.startscript(Systemcall::Wait, tmp);
575 // Return whether bibtex was run
580 int LaTeX::scanLogFile(TeXErrors & terr)
584 int retval = NO_ERRORS;
586 onlyFilename(changeExtension(file.absFilename(), ".log"));
587 LYXERR(Debug::LATEX, "Log file: " << tmp);
588 FileName const fn = FileName(makeAbsPath(tmp));
589 ifstream ifs(fn.toFilesystemEncoding().c_str());
590 bool fle_style = false;
591 static regex file_line_error(".+\\.\\D+:[0-9]+: (.+)");
594 while (getline(ifs, token)) {
595 // MikTeX sometimes inserts \0 in the log file. They can't be
596 // removed directly with the existing string utility
597 // functions, so convert them first to \r, and remove all
598 // \r's afterwards, since we need to remove them anyway.
599 token = subst(token, '\0', '\r');
600 token = subst(token, "\r", "");
603 LYXERR(Debug::LATEX, "Log line: " << token);
608 if (contains(token, "file:line:error style messages enabled"))
611 if (prefixIs(token, "LaTeX Warning:") ||
612 prefixIs(token, "! pdfTeX warning")) {
613 // Here shall we handle different
615 retval |= LATEX_WARNING;
616 LYXERR(Debug::LATEX, "LaTeX Warning.");
617 if (contains(token, "Rerun to get cross-references")) {
619 LYXERR(Debug::LATEX, "We should rerun.");
620 // package clefval needs 2 latex runs before bibtex
621 } else if (contains(token, "Value of")
622 && contains(token, "on page")
623 && contains(token, "undefined")) {
624 retval |= ERROR_RERUN;
625 LYXERR(Debug::LATEX, "Force rerun.");
626 } else if (contains(token, "Citation")
627 && contains(token, "on page")
628 && contains(token, "undefined")) {
631 } else if (prefixIs(token, "Package")) {
633 retval |= PACKAGE_WARNING;
634 if (contains(token, "natbib Warning:")) {
636 if (contains(token, "Citation")
637 && contains(token, "on page")
638 && contains(token, "undefined")) {
641 } else if (contains(token, "run BibTeX")) {
643 } else if (contains(token, "Rerun LaTeX") ||
644 contains(token, "Rerun to get")) {
645 // at least longtable.sty and bibtopic.sty
647 LYXERR(Debug::LATEX, "We should rerun.");
650 } else if (prefixIs(token, "LETTRE WARNING:")) {
651 if (contains(token, "veuillez recompiler")) {
653 LYXERR(Debug::LATEX, "We should rerun.");
656 } else if (token[0] == '(') {
657 if (contains(token, "Rerun LaTeX") ||
658 contains(token, "Rerun to get")) {
660 LYXERR(Debug::LATEX, "We should rerun.");
663 } else if (prefixIs(token, "! ")
664 || (fle_style && regex_match(token, sub, file_line_error))) {
665 // Ok, we have something that looks like a TeX Error
666 // but what do we really have.
668 // Just get the error description:
670 if (prefixIs(token, "! "))
671 desc = string(token, 2);
674 if (contains(token, "LaTeX Error:"))
675 retval |= LATEX_ERROR;
680 if (!getline(ifs, tmp))
684 } while (!prefixIs(tmp, "l."));
685 if (prefixIs(tmp, "l.")) {
686 // we have a latex error
689 "Package babel Error: You haven't defined the language") ||
691 "Package babel Error: You haven't loaded the option"))
692 retval |= ERROR_RERUN;
693 // get the line number:
695 sscanf(tmp.c_str(), "l.%d", &line);
696 // get the rest of the message:
697 string errstr(tmp, tmp.find(' '));
700 while (!contains(errstr, "l.")
702 && !prefixIs(tmp, "! ")
703 && !contains(tmp, "(job aborted")) {
708 LYXERR(Debug::LATEX, "line: " << line << '\n'
709 << "Desc: " << desc << '\n' << "Text: " << errstr);
710 if (line == last_line)
716 if (line_count <= 5) {
718 // We have no idea what the encoding of
720 // It seems that the output from the
721 // latex compiler itself is pure ASCII,
722 // but it can include bits from the
723 // document, so whatever encoding we
724 // assume here it can be wrong.
725 terr.insertError(line,
726 from_local8bit(desc),
727 from_local8bit(errstr));
732 // information messages, TeX warnings and other
733 // warnings we have not caught earlier.
734 if (prefixIs(token, "Overfull ")) {
735 retval |= TEX_WARNING;
736 } else if (prefixIs(token, "Underfull ")) {
737 retval |= TEX_WARNING;
738 } else if (contains(token, "Rerun to get citations")) {
739 // Natbib seems to use this.
741 } else if (contains(token, "No pages of output")) {
742 // A dvi file was not created
744 } else if (contains(token, "That makes 100 errors")) {
745 // More than 100 errors were reprted
746 retval |= TOO_MANY_ERRORS;
750 LYXERR(Debug::LATEX, "Log line: " << token);
757 bool insertIfExists(FileName const & absname, DepTable & head)
759 if (absname.exists() && !absname.isDirectory()) {
760 head.insert(absname, true);
767 bool handleFoundFile(string const & ff, DepTable & head)
769 // convert from native os path to unix path
770 string foundfile = os::internal_path(trim(ff));
772 LYXERR(Debug::DEPEND, "Found file: " << foundfile);
774 // Ok now we found a file.
775 // Now we should make sure that this is a file that we can
776 // access through the normal paths.
777 // We will not try any fancy search methods to
780 // (1) foundfile is an
781 // absolute path and should
783 FileName absname(foundfile);
784 if (absname.isAbsolute()) {
785 LYXERR(Debug::DEPEND, "AbsolutePath file: " << foundfile);
786 // On initial insert we want to do the update at once
787 // since this file cannot be a file generated by
789 if (!insertIfExists(absname, head)) {
791 string strippedfile = foundfile;
792 while (contains(strippedfile, " ")) {
793 // files with spaces are often enclosed in quotation
794 // marks; those have to be removed
795 string unquoted = subst(strippedfile, "\"", "");
796 absname.set(unquoted);
797 if (insertIfExists(absname, head))
799 // strip off part after last space and try again
800 string tmp = strippedfile;
801 string const stripoff =
802 rsplit(tmp, strippedfile, ' ');
803 absname.set(strippedfile);
804 if (insertIfExists(absname, head))
810 string onlyfile = onlyFilename(foundfile);
811 absname = makeAbsPath(onlyfile);
814 while (contains(foundfile, ' ')) {
815 if (absname.exists())
819 // files with spaces are often enclosed in quotation
820 // marks; those have to be removed
821 string unquoted = subst(foundfile, "\"", "");
822 absname = makeAbsPath(unquoted);
823 if (absname.exists())
825 // strip off part after last space and try again
827 string const stripoff =
828 rsplit(foundfile, strippedfile, ' ');
829 foundfile = strippedfile;
830 onlyfile = onlyFilename(strippedfile);
831 absname = makeAbsPath(onlyfile);
835 // (2) foundfile is in the tmpdir
836 // insert it into head
837 if (absname.exists() && !absname.isDirectory()) {
838 // FIXME: This regex contained glo, but glo is used by the old
839 // version of nomencl.sty. Do we need to put it back?
840 static regex const unwanted("^.*\\.(aux|log|dvi|bbl|ind)$");
841 if (regex_match(onlyfile, unwanted)) {
842 LYXERR(Debug::DEPEND, "We don't want " << onlyfile
843 << " in the dep file");
844 } else if (suffixIs(onlyfile, ".tex")) {
845 // This is a tex file generated by LyX
846 // and latex is not likely to change this
848 LYXERR(Debug::DEPEND, "Tmpdir TeX file: " << onlyfile);
849 head.insert(absname, true);
851 LYXERR(Debug::DEPEND, "In tmpdir file:" << onlyfile);
852 head.insert(absname);
856 LYXERR(Debug::DEPEND, "Not a file or we are unable to find it.");
862 bool checkLineBreak(string const & ff, DepTable & head)
864 if (!contains(ff, '.'))
867 // if we have a dot, we let handleFoundFile decide
868 return handleFoundFile(ff, head);
874 void LaTeX::deplog(DepTable & head)
876 // This function reads the LaTeX log file end extracts all the
877 // external files used by the LaTeX run. The files are then
878 // entered into the dependency file.
880 string const logfile =
881 onlyFilename(changeExtension(file.absFilename(), ".log"));
883 static regex const reg1("File: (.+).*");
884 static regex const reg2("No file (.+)(.).*");
885 static regex const reg3("\\\\openout[0-9]+.*=.*`(.+)(..).*");
886 // If an index should be created, MikTex does not write a line like
887 // \openout# = 'sample.idx'.
888 // but instead only a line like this into the log:
889 // Writing index file sample.idx
890 static regex const reg4("Writing index file (.+).*");
891 // files also can be enclosed in <...>
892 static regex const reg5("<([^>]+)(.).*");
893 static regex const regoldnomencl("Writing glossary file (.+).*");
894 static regex const regnomencl("Writing nomenclature file (.+).*");
895 // If a toc should be created, MikTex does not write a line like
896 // \openout# = `sample.toc'.
897 // but only a line like this into the log:
899 // This line is also written by tetex.
900 // This line is not present if no toc should be created.
901 static regex const miktexTocReg("\\\\tf@toc=\\\\write.*");
902 static regex const reg6(".*\\([^)]+.*");
904 FileName const fn = makeAbsPath(logfile);
905 ifstream ifs(fn.toFilesystemEncoding().c_str());
908 // Ok, the scanning of files here is not sufficient.
909 // Sometimes files are named by "File: xxx" only
910 // So I think we should use some regexps to find files instead.
911 // Note: all file names and paths might contains spaces.
912 bool found_file = false;
915 // MikTeX sometimes inserts \0 in the log file. They can't be
916 // removed directly with the existing string utility
917 // functions, so convert them first to \r, and remove all
918 // \r's afterwards, since we need to remove them anyway.
919 token = subst(token, '\0', '\r');
920 token = subst(token, "\r", "");
921 if (token.empty() || token == ")") {
926 // Sometimes, filenames are broken across lines.
927 // We care for that and save suspicious lines.
928 // Here we exclude some cases where we are sure
929 // that there is no continued filename
930 if (!lastline.empty()) {
931 static regex const package_info("Package \\w+ Info: .*");
932 static regex const package_warning("Package \\w+ Warning: .*");
933 if (prefixIs(token, "File:") || prefixIs(token, "(Font)")
934 || prefixIs(token, "Package:")
935 || prefixIs(token, "Language:")
936 || prefixIs(token, "LaTeX Info:")
937 || prefixIs(token, "LaTeX Font Info:")
938 || prefixIs(token, "\\openout[")
939 || prefixIs(token, "))")
940 || regex_match(token, package_info)
941 || regex_match(token, package_warning))
945 if (!lastline.empty())
946 // probably a continued filename from last line
947 token = lastline + token;
948 if (token.length() > 255) {
949 // string too long. Cut off.
950 token.erase(0, token.length() - 251);
955 // FIXME UNICODE: We assume that the file names in the log
956 // file are in the file system encoding.
957 token = to_utf8(from_filesystem8bit(token));
959 // (1) "File: file.ext"
960 if (regex_match(token, sub, reg1)) {
962 found_file = checkLineBreak(sub.str(1), head);
964 if (suffixIs(token, ")"))
965 // no line break for sure
966 // pretend we've been succesfully searching
968 // (2) "No file file.ext"
969 } else if (regex_match(token, sub, reg2)) {
970 // file names must contains a dot, line ends with dot
971 if (contains(sub.str(1), '.') && sub.str(2) == ".")
972 found_file = handleFoundFile(sub.str(1), head);
974 // we suspect a line break
976 // (3) "\openout<nr> = `file.ext'."
977 } else if (regex_match(token, sub, reg3)) {
978 // search for closing '. at the end of the line
979 if (sub.str(2) == "\'.")
980 found_file = handleFoundFile(sub.str(1), head);
982 // probable line break
984 // (4) "Writing index file file.ext"
985 } else if (regex_match(token, sub, reg4))
987 found_file = checkLineBreak(sub.str(1), head);
989 else if (regex_match(token, sub, reg5)) {
990 // search for closing '>' and dot ('*.*>') at the eol
991 if (contains(sub.str(1), '.') && sub.str(2) == ">")
992 found_file = handleFoundFile(sub.str(1), head);
994 // probable line break
996 // (6) "Writing nomenclature file file.ext"
997 } else if (regex_match(token, sub, regnomencl) ||
998 regex_match(token, sub, regoldnomencl))
1000 found_file = checkLineBreak(sub.str(1), head);
1001 // (7) "\tf@toc=\write<nr>" (for MikTeX)
1002 else if (regex_match(token, sub, miktexTocReg))
1003 found_file = handleFoundFile(onlyFilename(changeExtension(
1004 file.absFilename(), ".toc")), head);
1006 // not found, but we won't check further
1007 // pretend we've been succesfully searching
1011 // note that we can have several of these on one line
1012 // this must be queried separated, because of
1013 // cases such as "File: file.ext (type eps)"
1014 // where "File: file.ext" would be skipped
1015 if (regex_match(token, sub, reg6)) {
1016 // search for strings in (...)
1017 static regex reg6_1("\\(([^()]+)(.).*");
1019 string::const_iterator first = token.begin();
1020 string::const_iterator end = token.end();
1022 while (regex_search(first, end, what, reg6_1)) {
1023 // if we have a dot, try to handle as file
1024 if (contains(what.str(1), '.')) {
1025 first = what[0].second;
1026 if (what.str(2) == ")") {
1027 handleFoundFile(what.str(1), head);
1028 // since we had a closing bracket,
1029 // do not investigate further
1032 // if we have no closing bracket,
1033 // try to handle as file nevertheless
1034 found_file = handleFoundFile(
1035 what.str(1) + what.str(2), head);
1037 // if we do not have a dot, check if the line has
1038 // a closing bracket (else, we suspect a line break)
1039 else if (what.str(2) != ")") {
1040 first = what[0].second;
1043 // we have a closing bracket, so the content
1044 // is not a file name.
1045 // no need to investigate further
1046 // pretend we've been succesfully searching
1047 first = what[0].second;
1054 // probable linebreak:
1058 // no linebreak: reset
1059 lastline = string();
1062 // Make sure that the main .tex file is in the dependency file.
1063 head.insert(file, true);