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);
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);
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 = lyxrc.index_command + ' ';
419 tmp = subst(tmp, "$$lang", runparams.document_language);
423 one.startscript(Systemcall::Wait, tmp);
428 bool LaTeX::runMakeIndexNomencl(FileName const & file,
429 string const & nlo, string const & nls)
431 LYXERR(Debug::LATEX, "Running MakeIndex for nomencl.");
432 message(_("Running MakeIndex for nomencl."));
433 string tmp = lyxrc.nomencl_command + ' ';
434 // onlyFilename() is needed for cygwin
435 tmp += quoteName(onlyFilename(changeExtension(file.absFilename(), nlo)));
437 + onlyFilename(changeExtension(file.toFilesystemEncoding(), nls));
439 one.startscript(Systemcall::Wait, tmp);
444 vector<AuxInfo> const
445 LaTeX::scanAuxFiles(FileName const & file)
447 vector<AuxInfo> result;
449 result.push_back(scanAuxFile(file));
451 string const basename = removeExtension(file.absFilename());
452 for (int i = 1; i < 1000; ++i) {
453 FileName const file2(basename
454 + '.' + convert<string>(i)
458 result.push_back(scanAuxFile(file2));
464 AuxInfo const LaTeX::scanAuxFile(FileName const & file)
467 result.aux_file = file;
468 scanAuxFile(file, result);
473 void LaTeX::scanAuxFile(FileName const & file, AuxInfo & aux_info)
475 LYXERR(Debug::LATEX, "Scanning aux file: " << file);
477 ifstream ifs(file.toFilesystemEncoding().c_str());
479 static regex const reg1("\\\\citation\\{([^}]+)\\}");
480 static regex const reg2("\\\\bibdata\\{([^}]+)\\}");
481 static regex const reg3("\\\\bibstyle\\{([^}]+)\\}");
482 static regex const reg4("\\\\@input\\{([^}]+)\\}");
484 while (getline(ifs, token)) {
485 token = rtrim(token, "\r");
487 // FIXME UNICODE: We assume that citation keys and filenames
488 // in the aux file are in the file system encoding.
489 token = to_utf8(from_filesystem8bit(token));
490 if (regex_match(token, sub, reg1)) {
491 string data = sub.str(1);
492 while (!data.empty()) {
494 data = split(data, citation, ',');
495 LYXERR(Debug::LATEX, "Citation: " << citation);
496 aux_info.citations.insert(citation);
498 } else if (regex_match(token, sub, reg2)) {
499 string data = sub.str(1);
500 // data is now all the bib files separated by ','
501 // get them one by one and pass them to the helper
502 while (!data.empty()) {
504 data = split(data, database, ',');
505 database = changeExtension(database, "bib");
506 LYXERR(Debug::LATEX, "BibTeX database: `" << database << '\'');
507 aux_info.databases.insert(database);
509 } else if (regex_match(token, sub, reg3)) {
510 string style = sub.str(1);
511 // token is now the style file
512 // pass it to the helper
513 style = changeExtension(style, "bst");
514 LYXERR(Debug::LATEX, "BibTeX style: `" << style << '\'');
515 aux_info.styles.insert(style);
516 } else if (regex_match(token, sub, reg4)) {
517 string const file2 = sub.str(1);
518 scanAuxFile(makeAbsPath(file2), aux_info);
524 void LaTeX::updateBibtexDependencies(DepTable & dep,
525 vector<AuxInfo> const & bibtex_info)
527 // Since a run of Bibtex mandates more latex runs it is ok to
528 // remove all ".bib" and ".bst" files.
529 dep.remove_files_with_extension(".bib");
530 dep.remove_files_with_extension(".bst");
531 //string aux = OnlyFilename(ChangeExtension(file, ".aux"));
533 for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
534 it != bibtex_info.end(); ++it) {
535 for (set<string>::const_iterator it2 = it->databases.begin();
536 it2 != it->databases.end(); ++it2) {
537 FileName const file = findtexfile(*it2, "bib");
539 dep.insert(file, true);
542 for (set<string>::const_iterator it2 = it->styles.begin();
543 it2 != it->styles.end(); ++it2) {
544 FileName const file = findtexfile(*it2, "bst");
546 dep.insert(file, true);
552 bool LaTeX::runBibTeX(vector<AuxInfo> const & bibtex_info)
555 for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
556 it != bibtex_info.end(); ++it) {
557 if (it->databases.empty())
561 string tmp = lyxrc.bibtex_command + " ";
562 // onlyFilename() is needed for cygwin
563 tmp += quoteName(onlyFilename(removeExtension(
564 it->aux_file.absFilename())));
566 one.startscript(Systemcall::Wait, tmp);
568 // Return whether bibtex was run
573 int LaTeX::scanLogFile(TeXErrors & terr)
577 int retval = NO_ERRORS;
579 onlyFilename(changeExtension(file.absFilename(), ".log"));
580 LYXERR(Debug::LATEX, "Log file: " << tmp);
581 FileName const fn = FileName(makeAbsPath(tmp));
582 ifstream ifs(fn.toFilesystemEncoding().c_str());
583 bool fle_style = false;
584 static regex file_line_error(".+\\.\\D+:[0-9]+: (.+)");
587 while (getline(ifs, token)) {
588 // MikTeX sometimes inserts \0 in the log file. They can't be
589 // removed directly with the existing string utility
590 // functions, so convert them first to \r, and remove all
591 // \r's afterwards, since we need to remove them anyway.
592 token = subst(token, '\0', '\r');
593 token = subst(token, "\r", "");
596 LYXERR(Debug::LATEX, "Log line: " << token);
601 if (contains(token, "file:line:error style messages enabled"))
604 if (prefixIs(token, "LaTeX Warning:") ||
605 prefixIs(token, "! pdfTeX warning")) {
606 // Here shall we handle different
608 retval |= LATEX_WARNING;
609 LYXERR(Debug::LATEX, "LaTeX Warning.");
610 if (contains(token, "Rerun to get cross-references")) {
612 LYXERR(Debug::LATEX, "We should rerun.");
613 // package clefval needs 2 latex runs before bibtex
614 } else if (contains(token, "Value of")
615 && contains(token, "on page")
616 && contains(token, "undefined")) {
617 retval |= ERROR_RERUN;
618 LYXERR(Debug::LATEX, "Force rerun.");
619 } else if (contains(token, "Citation")
620 && contains(token, "on page")
621 && contains(token, "undefined")) {
624 } else if (prefixIs(token, "Package")) {
626 retval |= PACKAGE_WARNING;
627 if (contains(token, "natbib Warning:")) {
629 if (contains(token, "Citation")
630 && contains(token, "on page")
631 && contains(token, "undefined")) {
634 } else if (contains(token, "run BibTeX")) {
636 } else if (contains(token, "Rerun LaTeX") ||
637 contains(token, "Rerun to get")) {
638 // at least longtable.sty and bibtopic.sty
640 LYXERR(Debug::LATEX, "We should rerun.");
643 } else if (prefixIs(token, "LETTRE WARNING:")) {
644 if (contains(token, "veuillez recompiler")) {
646 LYXERR(Debug::LATEX, "We should rerun.");
649 } else if (token[0] == '(') {
650 if (contains(token, "Rerun LaTeX") ||
651 contains(token, "Rerun to get")) {
653 LYXERR(Debug::LATEX, "We should rerun.");
656 } else if (prefixIs(token, "! ")
657 || (fle_style && regex_match(token, sub, file_line_error))) {
658 // Ok, we have something that looks like a TeX Error
659 // but what do we really have.
661 // Just get the error description:
663 if (prefixIs(token, "! "))
664 desc = string(token, 2);
667 if (contains(token, "LaTeX Error:"))
668 retval |= LATEX_ERROR;
673 if (!getline(ifs, tmp))
677 } while (!prefixIs(tmp, "l."));
678 if (prefixIs(tmp, "l.")) {
679 // we have a latex error
682 "Package babel Error: You haven't defined the language") ||
684 "Package babel Error: You haven't loaded the option"))
685 retval |= ERROR_RERUN;
686 // get the line number:
688 sscanf(tmp.c_str(), "l.%d", &line);
689 // get the rest of the message:
690 string errstr(tmp, tmp.find(' '));
693 while (!contains(errstr, "l.")
695 && !prefixIs(tmp, "! ")
696 && !contains(tmp, "(job aborted")) {
701 LYXERR(Debug::LATEX, "line: " << line << '\n'
702 << "Desc: " << desc << '\n' << "Text: " << errstr);
703 if (line == last_line)
709 if (line_count <= 5) {
711 // We have no idea what the encoding of
713 // It seems that the output from the
714 // latex compiler itself is pure ASCII,
715 // but it can include bits from the
716 // document, so whatever encoding we
717 // assume here it can be wrong.
718 terr.insertError(line,
719 from_local8bit(desc),
720 from_local8bit(errstr));
725 // information messages, TeX warnings and other
726 // warnings we have not caught earlier.
727 if (prefixIs(token, "Overfull ")) {
728 retval |= TEX_WARNING;
729 } else if (prefixIs(token, "Underfull ")) {
730 retval |= TEX_WARNING;
731 } else if (contains(token, "Rerun to get citations")) {
732 // Natbib seems to use this.
734 } else if (contains(token, "No pages of output")) {
735 // A dvi file was not created
737 } else if (contains(token, "That makes 100 errors")) {
738 // More than 100 errors were reprted
739 retval |= TOO_MANY_ERRORS;
743 LYXERR(Debug::LATEX, "Log line: " << token);
750 bool insertIfExists(FileName const & absname, DepTable & head)
752 if (absname.exists() && !absname.isDirectory()) {
753 head.insert(absname, true);
760 bool handleFoundFile(string const & ff, DepTable & head)
762 // convert from native os path to unix path
763 string foundfile = os::internal_path(trim(ff));
765 LYXERR(Debug::DEPEND, "Found file: " << foundfile);
767 // Ok now we found a file.
768 // Now we should make sure that this is a file that we can
769 // access through the normal paths.
770 // We will not try any fancy search methods to
773 // (1) foundfile is an
774 // absolute path and should
776 FileName absname(foundfile);
777 if (absname.isAbsolute()) {
778 LYXERR(Debug::DEPEND, "AbsolutePath file: " << foundfile);
779 // On initial insert we want to do the update at once
780 // since this file cannot be a file generated by
782 if (!insertIfExists(absname, head)) {
784 string strippedfile = foundfile;
785 while (contains(strippedfile, " ")) {
786 // files with spaces are often enclosed in quotation
787 // marks; those have to be removed
788 string unquoted = subst(strippedfile, "\"", "");
789 absname.set(unquoted);
790 if (insertIfExists(absname, head))
792 // strip off part after last space and try again
793 string tmp = strippedfile;
794 string const stripoff =
795 rsplit(tmp, strippedfile, ' ');
796 absname.set(strippedfile);
797 if (insertIfExists(absname, head))
803 string onlyfile = onlyFilename(foundfile);
804 absname = makeAbsPath(onlyfile);
807 while (contains(foundfile, ' ')) {
808 if (absname.exists())
812 // files with spaces are often enclosed in quotation
813 // marks; those have to be removed
814 string unquoted = subst(foundfile, "\"", "");
815 absname = makeAbsPath(unquoted);
816 if (absname.exists())
818 // strip off part after last space and try again
820 string const stripoff =
821 rsplit(foundfile, strippedfile, ' ');
822 foundfile = strippedfile;
823 onlyfile = onlyFilename(strippedfile);
824 absname = makeAbsPath(onlyfile);
828 // (2) foundfile is in the tmpdir
829 // insert it into head
830 if (absname.exists() && !absname.isDirectory()) {
831 // FIXME: This regex contained glo, but glo is used by the old
832 // version of nomencl.sty. Do we need to put it back?
833 static regex const unwanted("^.*\\.(aux|log|dvi|bbl|ind)$");
834 if (regex_match(onlyfile, unwanted)) {
835 LYXERR(Debug::DEPEND, "We don't want " << onlyfile
836 << " in the dep file");
837 } else if (suffixIs(onlyfile, ".tex")) {
838 // This is a tex file generated by LyX
839 // and latex is not likely to change this
841 LYXERR(Debug::DEPEND, "Tmpdir TeX file: " << onlyfile);
842 head.insert(absname, true);
844 LYXERR(Debug::DEPEND, "In tmpdir file:" << onlyfile);
845 head.insert(absname);
849 LYXERR(Debug::DEPEND, "Not a file or we are unable to find it.");
855 bool checkLineBreak(string const & ff, DepTable & head)
857 if (!contains(ff, '.'))
860 // if we have a dot, we let handleFoundFile decide
861 return handleFoundFile(ff, head);
867 void LaTeX::deplog(DepTable & head)
869 // This function reads the LaTeX log file end extracts all the
870 // external files used by the LaTeX run. The files are then
871 // entered into the dependency file.
873 string const logfile =
874 onlyFilename(changeExtension(file.absFilename(), ".log"));
876 static regex const reg1("File: (.+).*");
877 static regex const reg2("No file (.+)(.).*");
878 static regex const reg3("\\\\openout[0-9]+.*=.*`(.+)(..).*");
879 // If an index should be created, MikTex does not write a line like
880 // \openout# = 'sample.idx'.
881 // but instead only a line like this into the log:
882 // Writing index file sample.idx
883 static regex const reg4("Writing index file (.+).*");
884 // files also can be enclosed in <...>
885 static regex const reg5("<([^>]+)(.).*");
886 static regex const regoldnomencl("Writing glossary file (.+).*");
887 static regex const regnomencl("Writing nomenclature file (.+).*");
888 // If a toc should be created, MikTex does not write a line like
889 // \openout# = `sample.toc'.
890 // but only a line like this into the log:
892 // This line is also written by tetex.
893 // This line is not present if no toc should be created.
894 static regex const miktexTocReg("\\\\tf@toc=\\\\write.*");
895 static regex const reg6(".*\\([^)]+.*");
897 FileName const fn = makeAbsPath(logfile);
898 ifstream ifs(fn.toFilesystemEncoding().c_str());
901 // Ok, the scanning of files here is not sufficient.
902 // Sometimes files are named by "File: xxx" only
903 // So I think we should use some regexps to find files instead.
904 // Note: all file names and paths might contains spaces.
905 bool found_file = false;
908 // MikTeX sometimes inserts \0 in the log file. They can't be
909 // removed directly with the existing string utility
910 // functions, so convert them first to \r, and remove all
911 // \r's afterwards, since we need to remove them anyway.
912 token = subst(token, '\0', '\r');
913 token = subst(token, "\r", "");
914 if (token.empty() || token == ")") {
919 // Sometimes, filenames are broken across lines.
920 // We care for that and save suspicious lines.
921 // Here we exclude some cases where we are sure
922 // that there is no continued filename
923 if (!lastline.empty()) {
924 static regex const package_info("Package \\w+ Info: .*");
925 static regex const package_warning("Package \\w+ Warning: .*");
926 if (prefixIs(token, "File:") || prefixIs(token, "(Font)")
927 || prefixIs(token, "Package:")
928 || prefixIs(token, "Language:")
929 || prefixIs(token, "LaTeX Info:")
930 || prefixIs(token, "LaTeX Font Info:")
931 || prefixIs(token, "\\openout[")
932 || prefixIs(token, "))")
933 || regex_match(token, package_info)
934 || regex_match(token, package_warning))
938 if (!lastline.empty())
939 // probably a continued filename from last line
940 token = lastline + token;
941 if (token.length() > 255) {
942 // string too long. Cut off.
943 token.erase(0, token.length() - 251);
948 // FIXME UNICODE: We assume that the file names in the log
949 // file are in the file system encoding.
950 token = to_utf8(from_filesystem8bit(token));
952 // (1) "File: file.ext"
953 if (regex_match(token, sub, reg1)) {
955 found_file = checkLineBreak(sub.str(1), head);
957 if (suffixIs(token, ")"))
958 // no line break for sure
959 // pretend we've been succesfully searching
961 // (2) "No file file.ext"
962 } else if (regex_match(token, sub, reg2)) {
963 // file names must contains a dot, line ends with dot
964 if (contains(sub.str(1), '.') && sub.str(2) == ".")
965 found_file = handleFoundFile(sub.str(1), head);
967 // we suspect a line break
969 // (3) "\openout<nr> = `file.ext'."
970 } else if (regex_match(token, sub, reg3)) {
971 // search for closing '. at the end of the line
972 if (sub.str(2) == "\'.")
973 found_file = handleFoundFile(sub.str(1), head);
975 // probable line break
977 // (4) "Writing index file file.ext"
978 } else if (regex_match(token, sub, reg4))
980 found_file = checkLineBreak(sub.str(1), head);
982 else if (regex_match(token, sub, reg5)) {
983 // search for closing '>' and dot ('*.*>') at the eol
984 if (contains(sub.str(1), '.') && sub.str(2) == ">")
985 found_file = handleFoundFile(sub.str(1), head);
987 // probable line break
989 // (6) "Writing nomenclature file file.ext"
990 } else if (regex_match(token, sub, regnomencl) ||
991 regex_match(token, sub, regoldnomencl))
993 found_file = checkLineBreak(sub.str(1), head);
994 // (7) "\tf@toc=\write<nr>" (for MikTeX)
995 else if (regex_match(token, sub, miktexTocReg))
996 found_file = handleFoundFile(onlyFilename(changeExtension(
997 file.absFilename(), ".toc")), head);
999 // not found, but we won't check further
1000 // pretend we've been succesfully searching
1004 // note that we can have several of these on one line
1005 // this must be queried separated, because of
1006 // cases such as "File: file.ext (type eps)"
1007 // where "File: file.ext" would be skipped
1008 if (regex_match(token, sub, reg6)) {
1009 // search for strings in (...)
1010 static regex reg6_1("\\(([^()]+)(.).*");
1012 string::const_iterator first = token.begin();
1013 string::const_iterator end = token.end();
1015 while (regex_search(first, end, what, reg6_1)) {
1016 // if we have a dot, try to handle as file
1017 if (contains(what.str(1), '.')) {
1018 first = what[0].second;
1019 if (what.str(2) == ")") {
1020 handleFoundFile(what.str(1), head);
1021 // since we had a closing bracket,
1022 // do not investigate further
1025 // if we have no closing bracket,
1026 // try to handle as file nevertheless
1027 found_file = handleFoundFile(
1028 what.str(1) + what.str(2), head);
1030 // if we do not have a dot, check if the line has
1031 // a closing bracket (else, we suspect a line break)
1032 else if (what.str(2) != ")") {
1033 first = what[0].second;
1036 // we have a closing bracket, so the content
1037 // is not a file name.
1038 // no need to investigate further
1039 // pretend we've been succesfully searching
1040 first = what[0].second;
1047 // probable linebreak:
1051 // no linebreak: reset
1052 lastline = string();
1055 // Make sure that the main .tex file is in the dependency file.
1056 head.insert(file, true);