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 "support/regex.h"
39 using namespace lyx::support;
43 namespace os = support::os;
45 // TODO: in no particular order
46 // - get rid of the call to
47 // BufferList::updateIncludedTeXfiles, this should either
48 // be done before calling LaTeX::funcs or in a completely
50 // - the makeindex style files should be taken care of with
51 // the dependency mechanism.
55 docstring runMessage(unsigned int count)
57 return bformat(_("Waiting for LaTeX run number %1$d"), count);
66 void TeXErrors::insertError(int line, docstring const & error_desc,
67 docstring const & error_text,
68 string const & child_name)
70 Error newerr(line, error_desc, error_text, child_name);
71 errors.push_back(newerr);
75 bool operator==(AuxInfo const & a, AuxInfo const & o)
77 return a.aux_file == o.aux_file
78 && a.citations == o.citations
79 && a.databases == o.databases
80 && a.styles == o.styles;
84 bool operator!=(AuxInfo const & a, AuxInfo const & o)
94 LaTeX::LaTeX(string const & latex, OutputParams const & rp,
95 FileName const & f, string const & p, string const & lp,
96 bool const clean_start)
97 : cmd(latex), file(f), path(p), lpath(lp), runparams(rp), biber(false)
100 if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
101 depfile = FileName(file.absFileName() + ".dep-pdf");
103 FileName(changeExtension(file.absFileName(), ".pdf"));
105 depfile = FileName(file.absFileName() + ".dep");
107 FileName(changeExtension(file.absFileName(), ".dvi"));
110 removeAuxiliaryFiles();
114 void LaTeX::removeAuxiliaryFiles() const
116 // Note that we do not always call this function when there is an error.
117 // For example, if there is an error but an output file is produced we
118 // still would like to output (export/view) the file.
120 // What files do we have to delete?
122 // This will at least make latex do all the runs
123 depfile.removeFile();
125 // but the reason for the error might be in a generated file...
128 FileName const bbl(changeExtension(file.absFileName(), ".bbl"));
132 FileName const bcf(changeExtension(file.absFileName(), ".bcf"));
136 FileName const ind(changeExtension(file.absFileName(), ".ind"));
140 FileName const nls(changeExtension(file.absFileName(), ".nls"));
143 // nomencl file (old version of the package)
144 FileName const gls(changeExtension(file.absFileName(), ".gls"));
147 // Also remove the aux file
148 FileName const aux(changeExtension(file.absFileName(), ".aux"));
151 // Remove the output file, which is often generated even if error
152 output_file.removeFile();
156 int LaTeX::run(TeXErrors & terr)
157 // We know that this function will only be run if the lyx buffer
158 // has been changed. We also know that a newly written .tex file
159 // is always different from the previous one because of the date
160 // in it. However it seems safe to run latex (at least) one time
161 // each time the .tex file changes.
163 int scanres = NO_ERRORS;
164 int bscanres = NO_ERRORS;
165 unsigned int count = 0; // number of times run
166 num_errors = 0; // just to make sure.
167 unsigned int const MAX_RUN = 6;
168 DepTable head; // empty head
169 bool rerun = false; // rerun requested
171 // The class LaTeX does not know the temp path.
172 theBufferList().updateIncludedTeXfiles(FileName::getcwd().absFileName(),
176 // first check if the file dependencies exist:
177 // ->If it does exist
178 // check if any of the files mentioned in it have
179 // changed (done using a checksum).
181 // run latex once and
182 // remake the dependency file
183 // -> if not changed:
184 // just return there is nothing to do for us.
185 // ->if it doesn't exist
187 // run latex once (we need to run latex once anyway) and
188 // remake the dependency file.
191 bool had_depfile = depfile.exists();
192 bool run_bibtex = false;
193 FileName const aux_file(changeExtension(file.absFileName(), ".aux"));
196 LYXERR(Debug::DEPEND, "Dependency file exists");
197 // Read the dep file:
198 had_depfile = head.read(depfile);
202 // Update the checksums
204 // Can't just check if anything has changed because it might
205 // have aborted on error last time... in which cas we need
206 // to re-run latex and collect the error messages
207 // (even if they are the same).
208 if (!output_file.exists()) {
209 LYXERR(Debug::DEPEND,
210 "re-running LaTeX because output file doesn't exist.");
211 } else if (!head.sumchange()) {
212 LYXERR(Debug::DEPEND, "return no_change");
215 LYXERR(Debug::DEPEND, "Dependency file has changed");
218 if (head.extchanged(".bib") || head.extchanged(".bst"))
221 LYXERR(Debug::DEPEND,
222 "Dependency file does not exist, or has wrong format");
224 /// We scan the aux file even when had_depfile = false,
225 /// because we can run pdflatex on the file after running latex on it,
226 /// in which case we will not need to run bibtex again.
227 vector<AuxInfo> bibtex_info_old;
229 bibtex_info_old = scanAuxFiles(aux_file);
232 LYXERR(Debug::LATEX, "Run #" << count);
233 message(runMessage(count));
235 int exit_code = startscript();
237 scanres = scanLogFile(terr);
238 if (scanres & ERROR_RERUN) {
239 LYXERR(Debug::LATEX, "Rerunning LaTeX");
241 exit_code = startscript();
242 scanres = scanLogFile(terr);
245 vector<AuxInfo> const bibtex_info = scanAuxFiles(aux_file);
246 if (!run_bibtex && bibtex_info_old != bibtex_info)
249 // update the dependencies.
250 deplog(head); // reads the latex log
254 // At this point we must run external programs if needed.
255 // makeindex will be run if a .idx file changed or was generated.
256 // And if there were undefined citations or changes in references
257 // the .aux file is checked for signs of bibtex. Bibtex is then run
260 // memoir (at least) writes an empty *idx file in the first place.
261 // A second latex run is needed.
262 FileName const idxfile(changeExtension(file.absFileName(), ".idx"));
263 rerun = idxfile.exists() && idxfile.isFileEmpty();
266 if (head.haschanged(idxfile)) {
268 LYXERR(Debug::LATEX, "Running MakeIndex.");
269 message(_("Running Index Processor."));
270 // onlyFileName() is needed for cygwin
271 rerun |= runMakeIndex(onlyFileName(idxfile.absFileName()),
274 FileName const nlofile(changeExtension(file.absFileName(), ".nlo"));
275 // If all nomencl entries are removed, nomencl writes an empty nlo file.
276 // DepTable::hasChanged() returns false in this case, since it does not
277 // distinguish empty files from non-existing files. This is why we need
278 // the extra checks here (to trigger a rerun). Cf. discussions in #8905.
279 // FIXME: Sort out the real problem in DepTable.
280 if (head.haschanged(nlofile) || (nlofile.exists() && nlofile.isFileEmpty()))
281 rerun |= runMakeIndexNomencl(file, ".nlo", ".nls");
282 FileName const glofile(changeExtension(file.absFileName(), ".glo"));
283 if (head.haschanged(glofile))
284 rerun |= runMakeIndexNomencl(file, ".glo", ".gls");
286 // check if we're using biber instead of bibtex
287 // biber writes no info to the aux file, so we just check
288 // if a bcf file exists (and if it was updated)
289 FileName const bcffile(changeExtension(file.absFileName(), ".bcf"));
290 biber |= head.exist(bcffile);
293 // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
294 if (scanres & UNDEF_CIT || run_bibtex) {
295 // Here we must scan the .aux file and look for
296 // "\bibdata" and/or "\bibstyle". If one of those
297 // tags is found -> run bibtex and set rerun = true;
299 LYXERR(Debug::LATEX, "Running BibTeX.");
300 message(_("Running BibTeX."));
301 updateBibtexDependencies(head, bibtex_info);
302 rerun |= runBibTeX(bibtex_info, runparams);
303 FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
304 if (blgfile.exists())
305 bscanres = scanBlgFile(head, terr);
306 } else if (!had_depfile) {
307 /// If we run pdflatex on the file after running latex on it,
308 /// then we do not need to run bibtex, but we do need to
309 /// insert the .bib and .bst files into the .dep-pdf file.
310 updateBibtexDependencies(head, bibtex_info);
314 // we know on this point that latex has been run once (or we just
315 // returned) and the question now is to decide if we need to run
316 // it any more. This is done by asking if any of the files in the
317 // dependency file has changed. (remember that the checksum for
318 // a given file is reported to have changed if it just was created)
319 // -> if changed or rerun == true:
320 // run latex once more and
321 // update the dependency structure
322 // -> if not changed:
323 // we do nothing at this point
325 if (rerun || head.sumchange()) {
328 LYXERR(Debug::DEPEND, "Dep. file has changed or rerun requested");
329 LYXERR(Debug::LATEX, "Run #" << count);
330 message(runMessage(count));
332 scanres = scanLogFile(terr);
334 // update the depedencies
335 deplog(head); // reads the latex log
338 LYXERR(Debug::DEPEND, "Dep. file has NOT changed");
343 // Complex bibliography packages such as Biblatex require
344 // an additional bibtex cycle sometimes.
345 if (scanres & UNDEF_CIT) {
346 // Here we must scan the .aux file and look for
347 // "\bibdata" and/or "\bibstyle". If one of those
348 // tags is found -> run bibtex and set rerun = true;
350 LYXERR(Debug::LATEX, "Running BibTeX.");
351 message(_("Running BibTeX."));
352 updateBibtexDependencies(head, bibtex_info);
353 rerun |= runBibTeX(bibtex_info, runparams);
354 FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
355 if (blgfile.exists())
356 bscanres = scanBlgFile(head, terr);
360 // The inclusion of files generated by external programs such as
361 // makeindex or bibtex might have done changes to pagenumbering,
362 // etc. And because of this we must run the external programs
363 // again to make sure everything is redone correctly.
364 // Also there should be no need to run the external programs any
367 // run makeindex if the <file>.idx has changed or was generated.
368 if (head.haschanged(idxfile)) {
370 LYXERR(Debug::LATEX, "Running MakeIndex.");
371 message(_("Running Index Processor."));
372 // onlyFileName() is needed for cygwin
373 rerun = runMakeIndex(onlyFileName(changeExtension(
374 file.absFileName(), ".idx")), runparams);
377 // I am not pretty sure if need this twice.
378 if (head.haschanged(nlofile))
379 rerun |= runMakeIndexNomencl(file, ".nlo", ".nls");
380 if (head.haschanged(glofile))
381 rerun |= runMakeIndexNomencl(file, ".glo", ".gls");
384 // we will only run latex more if the log file asks for it.
385 // or if the sumchange() is true.
386 // -> rerun asked for:
388 // remake the dependency file
389 // goto 2 or return if max runs are reached.
390 // -> rerun not asked for:
391 // just return (fall out of bottom of func)
393 while ((head.sumchange() || rerun || (scanres & RERUN))
394 && count < MAX_RUN) {
395 // Yes rerun until message goes away, or until
396 // MAX_RUNS are reached.
399 LYXERR(Debug::LATEX, "Run #" << count);
400 message(runMessage(count));
402 scanres = scanLogFile(terr);
408 // Write the dependencies to file.
412 // add flag here, just before return, instead of when exit_code
413 // is defined because scanres is sometimes overwritten above
415 scanres |= NONZERO_ERROR;
418 LYXERR(Debug::LATEX, "Done.");
420 if (bscanres & ERRORS)
421 return bscanres; // return on error
427 int LaTeX::startscript()
429 // onlyFileName() is needed for cygwin
430 string tmp = cmd + ' '
431 + quoteName(onlyFileName(file.toFilesystemEncoding()))
432 + " > " + os::nulldev();
434 return one.startscript(Systemcall::Wait, tmp, path, lpath);
438 bool LaTeX::runMakeIndex(string const & f, OutputParams const & runparams,
439 string const & params)
441 string tmp = runparams.use_japanese ?
442 lyxrc.jindex_command : lyxrc.index_command;
444 if (!runparams.index_command.empty())
445 tmp = runparams.index_command;
448 "idx file has been made, running index processor ("
449 << tmp << ") on file " << f);
451 tmp = subst(tmp, "$$lang", runparams.document_language);
452 if (runparams.use_indices) {
453 tmp = lyxrc.splitindex_command + " -m " + quoteName(tmp);
455 "Multiple indices. Using splitindex command: " << tmp);
461 one.startscript(Systemcall::Wait, tmp, path, lpath);
466 bool LaTeX::runMakeIndexNomencl(FileName const & file,
467 string const & nlo, string const & nls)
469 LYXERR(Debug::LATEX, "Running MakeIndex for nomencl.");
470 message(_("Running MakeIndex for nomencl."));
471 string tmp = lyxrc.nomencl_command + ' ';
472 // onlyFileName() is needed for cygwin
473 tmp += quoteName(onlyFileName(changeExtension(file.absFileName(), nlo)));
475 + onlyFileName(changeExtension(file.toFilesystemEncoding(), nls));
477 one.startscript(Systemcall::Wait, tmp, path, lpath);
482 vector<AuxInfo> const
483 LaTeX::scanAuxFiles(FileName const & file)
485 vector<AuxInfo> result;
487 result.push_back(scanAuxFile(file));
489 string const basename = removeExtension(file.absFileName());
490 for (int i = 1; i < 1000; ++i) {
491 FileName const file2(basename
492 + '.' + convert<string>(i)
496 result.push_back(scanAuxFile(file2));
502 AuxInfo const LaTeX::scanAuxFile(FileName const & file)
505 result.aux_file = file;
506 scanAuxFile(file, result);
511 void LaTeX::scanAuxFile(FileName const & file, AuxInfo & aux_info)
513 LYXERR(Debug::LATEX, "Scanning aux file: " << file);
515 ifstream ifs(file.toFilesystemEncoding().c_str());
517 static regex const reg1("\\\\citation\\{([^}]+)\\}");
518 static regex const reg2("\\\\bibdata\\{([^}]+)\\}");
519 static regex const reg3("\\\\bibstyle\\{([^}]+)\\}");
520 static regex const reg4("\\\\@input\\{([^}]+)\\}");
522 while (getline(ifs, token)) {
523 token = rtrim(token, "\r");
525 // FIXME UNICODE: We assume that citation keys and filenames
526 // in the aux file are in the file system encoding.
527 token = to_utf8(from_filesystem8bit(token));
528 if (regex_match(token, sub, reg1)) {
529 string data = sub.str(1);
530 while (!data.empty()) {
532 data = split(data, citation, ',');
533 LYXERR(Debug::LATEX, "Citation: " << citation);
534 aux_info.citations.insert(citation);
536 } else if (regex_match(token, sub, reg2)) {
537 string data = sub.str(1);
538 // data is now all the bib files separated by ','
539 // get them one by one and pass them to the helper
540 while (!data.empty()) {
542 data = split(data, database, ',');
543 database = changeExtension(database, "bib");
544 LYXERR(Debug::LATEX, "BibTeX database: `" << database << '\'');
545 aux_info.databases.insert(database);
547 } else if (regex_match(token, sub, reg3)) {
548 string style = sub.str(1);
549 // token is now the style file
550 // pass it to the helper
551 style = changeExtension(style, "bst");
552 LYXERR(Debug::LATEX, "BibTeX style: `" << style << '\'');
553 aux_info.styles.insert(style);
554 } else if (regex_match(token, sub, reg4)) {
555 string const file2 = sub.str(1);
556 scanAuxFile(makeAbsPath(file2), aux_info);
562 void LaTeX::updateBibtexDependencies(DepTable & dep,
563 vector<AuxInfo> const & bibtex_info)
565 // Since a run of Bibtex mandates more latex runs it is ok to
566 // remove all ".bib" and ".bst" files.
567 dep.remove_files_with_extension(".bib");
568 dep.remove_files_with_extension(".bst");
569 //string aux = OnlyFileName(ChangeExtension(file, ".aux"));
571 for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
572 it != bibtex_info.end(); ++it) {
573 for (set<string>::const_iterator it2 = it->databases.begin();
574 it2 != it->databases.end(); ++it2) {
575 FileName const file = findtexfile(*it2, "bib");
577 dep.insert(file, true);
580 for (set<string>::const_iterator it2 = it->styles.begin();
581 it2 != it->styles.end(); ++it2) {
582 FileName const file = findtexfile(*it2, "bst");
584 dep.insert(file, true);
588 // biber writes nothing into the aux file.
589 // Instead, we have to scan the blg file
592 scanBlgFile(dep, terr);
597 bool LaTeX::runBibTeX(vector<AuxInfo> const & bibtex_info,
598 OutputParams const & runparams)
601 for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
602 it != bibtex_info.end(); ++it) {
603 if (!biber && it->databases.empty())
607 string tmp = runparams.use_japanese ?
608 lyxrc.jbibtex_command : lyxrc.bibtex_command;
610 if (!runparams.bibtex_command.empty())
611 tmp = runparams.bibtex_command;
613 // onlyFileName() is needed for cygwin
614 tmp += quoteName(onlyFileName(removeExtension(
615 it->aux_file.absFileName())));
617 one.startscript(Systemcall::Wait, tmp, path, lpath);
619 // Return whether bibtex was run
624 int LaTeX::scanLogFile(TeXErrors & terr)
628 int retval = NO_ERRORS;
630 onlyFileName(changeExtension(file.absFileName(), ".log"));
631 LYXERR(Debug::LATEX, "Log file: " << tmp);
632 FileName const fn = FileName(makeAbsPath(tmp));
633 ifstream ifs(fn.toFilesystemEncoding().c_str());
634 bool fle_style = false;
635 static regex const file_line_error(".+\\.\\D+:[0-9]+: (.+)");
636 static regex const child_file(".*([0-9]+[A-Za-z]*_.+\\.tex).*");
637 // Flag for 'File ended while scanning' message.
638 // We need to wait for subsequent processing.
639 string wait_for_error;
642 stack <pair<string, int> > child;
645 while (getline(ifs, token)) {
646 // MikTeX sometimes inserts \0 in the log file. They can't be
647 // removed directly with the existing string utility
648 // functions, so convert them first to \r, and remove all
649 // \r's afterwards, since we need to remove them anyway.
650 token = subst(token, '\0', '\r');
651 token = subst(token, "\r", "");
654 LYXERR(Debug::LATEX, "Log line: " << token);
659 // Track child documents
660 for (size_t i = 0; i < token.length(); ++i) {
661 if (token[i] == '(') {
663 size_t j = token.find('(', i + 1);
664 size_t len = j == string::npos
665 ? token.substr(i + 1).length()
667 string const substr = token.substr(i + 1, len);
668 if (regex_match(substr, sub, child_file)) {
669 string const name = sub.str(1);
670 child.push(make_pair(name, pnest));
673 } else if (token[i] == ')') {
675 && child.top().second == pnest)
680 child_name = child.empty() ? empty_string() : child.top().first;
682 if (contains(token, "file:line:error style messages enabled"))
685 if (prefixIs(token, "LaTeX Warning:") ||
686 prefixIs(token, "! pdfTeX warning")) {
687 // Here shall we handle different
689 retval |= LATEX_WARNING;
690 LYXERR(Debug::LATEX, "LaTeX Warning.");
691 if (contains(token, "Rerun to get cross-references")) {
693 LYXERR(Debug::LATEX, "We should rerun.");
694 // package clefval needs 2 latex runs before bibtex
695 } else if (contains(token, "Value of")
696 && contains(token, "on page")
697 && contains(token, "undefined")) {
698 retval |= ERROR_RERUN;
699 LYXERR(Debug::LATEX, "Force rerun.");
701 } else if (contains(token, "Etaremune labels have changed")) {
702 retval |= ERROR_RERUN;
703 LYXERR(Debug::LATEX, "Force rerun.");
704 } else if (contains(token, "Citation")
705 && contains(token, "on page")
706 && contains(token, "undefined")) {
708 } else if (contains(token, "Citation")
709 && contains(token, "on input line")
710 && contains(token, "undefined")) {
713 } else if (prefixIs(token, "Package")) {
715 retval |= PACKAGE_WARNING;
716 if (contains(token, "natbib Warning:")) {
718 if (contains(token, "Citation")
719 && contains(token, "on page")
720 && contains(token, "undefined")) {
723 } else if (contains(token, "run BibTeX")) {
725 } else if (contains(token, "run Biber")) {
728 } else if (contains(token, "Rerun LaTeX") ||
729 contains(token, "Please rerun LaTeX") ||
730 contains(token, "Rerun to get")) {
731 // at least longtable.sty and bibtopic.sty
733 LYXERR(Debug::LATEX, "We should rerun.");
736 } else if (prefixIs(token, "LETTRE WARNING:")) {
737 if (contains(token, "veuillez recompiler")) {
739 LYXERR(Debug::LATEX, "We should rerun.");
742 } else if (token[0] == '(') {
743 if (contains(token, "Rerun LaTeX") ||
744 contains(token, "Rerun to get")) {
746 LYXERR(Debug::LATEX, "We should rerun.");
749 } else if (prefixIs(token, "! ")
751 && regex_match(token, sub, file_line_error)
752 && !contains(token, "pdfTeX warning"))) {
753 // Ok, we have something that looks like a TeX Error
754 // but what do we really have.
756 // Just get the error description:
758 if (prefixIs(token, "! "))
759 desc = string(token, 2);
762 if (contains(token, "LaTeX Error:"))
763 retval |= LATEX_ERROR;
765 if (prefixIs(token, "! File ended while scanning")){
766 if (prefixIs(token, "! File ended while scanning use of \\Hy@setref@link.")){
767 // bug 7344. We must rerun LaTeX if hyperref has been toggled.
768 retval |= ERROR_RERUN;
769 LYXERR(Debug::LATEX, "Force rerun.");
771 // bug 6445. At this point its not clear we finish with error.
772 wait_for_error = desc;
777 if (prefixIs(token, "! Paragraph ended before \\Hy@setref@link was complete.")){
778 // bug 7344. We must rerun LaTeX if hyperref has been toggled.
779 retval |= ERROR_RERUN;
780 LYXERR(Debug::LATEX, "Force rerun.");
783 if (!wait_for_error.empty() && prefixIs(token, "! Emergency stop.")){
784 retval |= LATEX_ERROR;
787 errstr = wait_for_error;
789 if (!getline(ifs, tmp))
791 tmp = rtrim(tmp, "\r");
792 errstr += "\n" + tmp;
795 } while (!contains(tmp, "(job aborted"));
798 from_local8bit("Emergency stop"),
799 from_local8bit(errstr),
807 if (!getline(ifs, tmp))
809 tmp = rtrim(tmp, "\r");
810 // 15 is somewhat arbitrarily chosen, based on practice.
811 // We used 10 for 14 years and increased it to 15 when we
815 } while (!prefixIs(tmp, "l."));
816 if (prefixIs(tmp, "l.")) {
817 // we have a latex error
820 "Package babel Error: You haven't defined the language")
822 "Package babel Error: You haven't loaded the option")
824 "Package babel Error: Unknown language"))
825 retval |= ERROR_RERUN;
826 // get the line number:
828 sscanf(tmp.c_str(), "l.%d", &line);
829 // get the rest of the message:
830 string errstr(tmp, tmp.find(' '));
833 tmp = rtrim(tmp, "\r");
834 while (!contains(errstr, "l.")
836 && !prefixIs(tmp, "! ")
837 && !contains(tmp, "(job aborted")) {
841 tmp = rtrim(tmp, "\r");
843 LYXERR(Debug::LATEX, "line: " << line << '\n'
844 << "Desc: " << desc << '\n' << "Text: " << errstr);
845 if (line == last_line)
851 if (line_count <= 5) {
853 // We have no idea what the encoding of
855 // It seems that the output from the
856 // latex compiler itself is pure ASCII,
857 // but it can include bits from the
858 // document, so whatever encoding we
859 // assume here it can be wrong.
860 terr.insertError(line,
861 from_local8bit(desc),
862 from_local8bit(errstr),
868 // information messages, TeX warnings and other
869 // warnings we have not caught earlier.
870 if (prefixIs(token, "Overfull ")) {
871 retval |= TEX_WARNING;
872 } else if (prefixIs(token, "Underfull ")) {
873 retval |= TEX_WARNING;
874 } else if (contains(token, "Rerun to get citations")) {
875 // Natbib seems to use this.
877 } else if (contains(token, "No pages of output")) {
878 // A dvi file was not created
880 } else if (contains(token, "That makes 100 errors")) {
881 // More than 100 errors were reprted
882 retval |= TOO_MANY_ERRORS;
883 } else if (prefixIs(token, "!pdfTeX error:")) {
884 // otherwise we dont catch e.g.:
885 // !pdfTeX error: pdflatex (file feyn10): Font feyn10 at 600 not found
888 from_local8bit("pdfTeX Error"),
889 from_local8bit(token),
891 } else if (prefixIs(token, "Missing character: There is no ")) {
892 // XeTeX/LuaTeX error about missing glyph in selected font
894 retval |= LATEX_ERROR;
896 from_local8bit("Missing glyphs!"),
897 from_local8bit(token),
902 LYXERR(Debug::LATEX, "Log line: " << token);
909 bool insertIfExists(FileName const & absname, DepTable & head)
911 if (absname.exists() && !absname.isDirectory()) {
912 head.insert(absname, true);
919 bool handleFoundFile(string const & ff, DepTable & head)
921 // convert from native os path to unix path
922 string foundfile = os::internal_path(trim(ff));
924 LYXERR(Debug::DEPEND, "Found file: " << foundfile);
926 // Ok now we found a file.
927 // Now we should make sure that this is a file that we can
928 // access through the normal paths.
929 // We will not try any fancy search methods to
932 // (1) foundfile is an
933 // absolute path and should
936 if (FileName::isAbsolute(foundfile)) {
937 LYXERR(Debug::DEPEND, "AbsolutePath file: " << foundfile);
938 // On initial insert we want to do the update at once
939 // since this file cannot be a file generated by
941 absname.set(foundfile);
942 if (!insertIfExists(absname, head)) {
944 string strippedfile = foundfile;
945 while (contains(strippedfile, " ")) {
946 // files with spaces are often enclosed in quotation
947 // marks; those have to be removed
948 string unquoted = subst(strippedfile, "\"", "");
949 absname.set(unquoted);
950 if (insertIfExists(absname, head))
952 // strip off part after last space and try again
953 string tmp = strippedfile;
954 string const stripoff =
955 rsplit(tmp, strippedfile, ' ');
956 absname.set(strippedfile);
957 if (insertIfExists(absname, head))
963 string onlyfile = onlyFileName(foundfile);
964 absname = makeAbsPath(onlyfile);
967 while (contains(foundfile, ' ')) {
968 if (absname.exists())
972 // files with spaces are often enclosed in quotation
973 // marks; those have to be removed
974 string unquoted = subst(foundfile, "\"", "");
975 absname = makeAbsPath(unquoted);
976 if (absname.exists())
978 // strip off part after last space and try again
980 string const stripoff =
981 rsplit(foundfile, strippedfile, ' ');
982 foundfile = strippedfile;
983 onlyfile = onlyFileName(strippedfile);
984 absname = makeAbsPath(onlyfile);
988 // (2) foundfile is in the tmpdir
989 // insert it into head
990 if (absname.exists() && !absname.isDirectory()) {
991 // FIXME: This regex contained glo, but glo is used by the old
992 // version of nomencl.sty. Do we need to put it back?
993 static regex const unwanted("^.*\\.(aux|log|dvi|bbl|ind)$");
994 if (regex_match(onlyfile, unwanted)) {
995 LYXERR(Debug::DEPEND, "We don't want " << onlyfile
996 << " in the dep file");
997 } else if (suffixIs(onlyfile, ".tex")) {
998 // This is a tex file generated by LyX
999 // and latex is not likely to change this
1001 LYXERR(Debug::DEPEND, "Tmpdir TeX file: " << onlyfile);
1002 head.insert(absname, true);
1004 LYXERR(Debug::DEPEND, "In tmpdir file:" << onlyfile);
1005 head.insert(absname);
1009 LYXERR(Debug::DEPEND, "Not a file or we are unable to find it.");
1015 bool completeFilename(string const & ff, DepTable & head)
1017 // If we do not find a dot, we suspect
1018 // a fragmental file name
1019 if (!contains(ff, '.'))
1022 // if we have a dot, we let handleFoundFile decide
1023 return handleFoundFile(ff, head);
1027 int iterateLine(string const & token, regex const & reg, string const & closing,
1028 int fragment_pos, DepTable & head)
1031 string::const_iterator first = token.begin();
1032 string::const_iterator end = token.end();
1033 bool fragment = false;
1036 while (regex_search(first, end, what, reg)) {
1037 // if we have a dot, try to handle as file
1038 if (contains(what.str(1), '.')) {
1039 first = what[0].second;
1040 if (what.str(2) == closing) {
1041 handleFoundFile(what.str(1), head);
1042 // since we had a closing bracket,
1043 // do not investigate further
1046 // if we have no closing bracket,
1047 // try to handle as file nevertheless
1048 fragment = !handleFoundFile(
1049 what.str(1) + what.str(2), head);
1051 // if we do not have a dot, check if the line has
1052 // a closing bracket (else, we suspect a line break)
1053 else if (what.str(2) != closing) {
1054 first = what[0].second;
1057 // we have a closing bracket, so the content
1058 // is not a file name.
1059 // no need to investigate further
1060 first = what[0].second;
1063 last_match = what.str(1);
1066 // We need to consider the result from previous line iterations:
1067 // We might not find a fragment here, but another one might follow
1068 // E.g.: (filename.ext) <filenam
1069 // Vice versa, we consider the search completed if a real match
1070 // follows a potential fragment from a previous iteration.
1071 // E.g. <some text we considered a fragment (filename.ext)
1072 // result = -1 means we did not find a fragment!
1074 int last_match_pos = -1;
1075 if (!last_match.empty() && token.find(last_match) != string::npos)
1076 last_match_pos = int(token.find(last_match));
1078 if (last_match_pos > fragment_pos)
1079 result = last_match_pos;
1081 result = fragment_pos;
1083 if (last_match_pos < fragment_pos)
1084 result = fragment_pos;
1092 void LaTeX::deplog(DepTable & head)
1094 // This function reads the LaTeX log file end extracts all the
1095 // external files used by the LaTeX run. The files are then
1096 // entered into the dependency file.
1098 string const logfile =
1099 onlyFileName(changeExtension(file.absFileName(), ".log"));
1101 static regex const reg1("File: (.+).*");
1102 static regex const reg2("No file (.+)(.).*");
1103 static regex const reg3("\\\\openout[0-9]+.*=.*`(.+)(..).*");
1104 // If an index should be created, MikTex does not write a line like
1105 // \openout# = 'sample.idx'.
1106 // but instead only a line like this into the log:
1107 // Writing index file sample.idx
1108 static regex const reg4("Writing index file (.+).*");
1109 static regex const regoldnomencl("Writing glossary file (.+).*");
1110 static regex const regnomencl("Writing nomenclature file (.+).*");
1111 // If a toc should be created, MikTex does not write a line like
1112 // \openout# = `sample.toc'.
1113 // but only a line like this into the log:
1115 // This line is also written by tetex.
1116 // This line is not present if no toc should be created.
1117 static regex const miktexTocReg("\\\\tf@toc=\\\\write.*");
1118 // file names can be enclosed in <...> (anywhere on the line)
1119 static regex const reg5(".*<[^>]+.*");
1120 // and also (...) anywhere on the line
1121 static regex const reg6(".*\\([^)]+.*");
1123 FileName const fn = makeAbsPath(logfile);
1124 ifstream ifs(fn.toFilesystemEncoding().c_str());
1127 // Ok, the scanning of files here is not sufficient.
1128 // Sometimes files are named by "File: xxx" only
1129 // Therefore we use some regexps to find files instead.
1130 // Note: all file names and paths might contains spaces.
1131 // Also, file names might be broken across lines. Therefore
1132 // we mark (potential) fragments and merge those lines.
1133 bool fragment = false;
1135 getline(ifs, token);
1136 // MikTeX sometimes inserts \0 in the log file. They can't be
1137 // removed directly with the existing string utility
1138 // functions, so convert them first to \r, and remove all
1139 // \r's afterwards, since we need to remove them anyway.
1140 token = subst(token, '\0', '\r');
1141 token = subst(token, "\r", "");
1142 if (token.empty() || token == ")") {
1143 lastline = string();
1147 // FIXME UNICODE: We assume that the file names in the log
1148 // file are in the file system encoding.
1149 token = to_utf8(from_filesystem8bit(token));
1151 // Sometimes, filenames are broken across lines.
1152 // We care for that and save suspicious lines.
1153 // Here we exclude some cases where we are sure
1154 // that there is no continued filename
1155 if (!lastline.empty()) {
1156 static regex const package_info("Package \\w+ Info: .*");
1157 static regex const package_warning("Package \\w+ Warning: .*");
1158 if (prefixIs(token, "File:") || prefixIs(token, "(Font)")
1159 || prefixIs(token, "Package:")
1160 || prefixIs(token, "Language:")
1161 || prefixIs(token, "LaTeX Info:")
1162 || prefixIs(token, "LaTeX Font Info:")
1163 || prefixIs(token, "\\openout[")
1164 || prefixIs(token, "))")
1165 || regex_match(token, package_info)
1166 || regex_match(token, package_warning))
1167 lastline = string();
1170 if (!lastline.empty())
1171 // probably a continued filename from last line
1172 token = lastline + token;
1173 if (token.length() > 255) {
1174 // string too long. Cut off.
1175 token.erase(0, token.length() - 251);
1180 // (1) "File: file.ext"
1181 if (regex_match(token, sub, reg1)) {
1182 // is this a fragmental file name?
1183 fragment = !completeFilename(sub.str(1), head);
1185 if (suffixIs(token, ")"))
1186 // no fragment for sure
1188 // (2) "No file file.ext"
1189 } else if (regex_match(token, sub, reg2)) {
1190 // file names must contains a dot, line ends with dot
1191 if (contains(sub.str(1), '.') && sub.str(2) == ".")
1192 fragment = !handleFoundFile(sub.str(1), head);
1194 // we suspect a line break
1196 // (3) "\openout<nr> = `file.ext'."
1197 } else if (regex_match(token, sub, reg3)) {
1198 // search for closing '. at the end of the line
1199 if (sub.str(2) == "\'.")
1200 fragment = !handleFoundFile(sub.str(1), head);
1202 // potential fragment
1204 // (4) "Writing index file file.ext"
1205 } else if (regex_match(token, sub, reg4))
1206 // fragmential file name?
1207 fragment = !completeFilename(sub.str(1), head);
1208 // (5) "Writing nomenclature file file.ext"
1209 else if (regex_match(token, sub, regnomencl) ||
1210 regex_match(token, sub, regoldnomencl))
1211 // fragmental file name?
1212 fragment= !completeFilename(sub.str(1), head);
1213 // (6) "\tf@toc=\write<nr>" (for MikTeX)
1214 else if (regex_match(token, sub, miktexTocReg))
1215 fragment = !handleFoundFile(onlyFileName(changeExtension(
1216 file.absFileName(), ".toc")), head);
1218 // not found, but we won't check further
1221 int fragment_pos = -1;
1223 // We can have several of these on one line
1224 // (and in addition to those above)
1225 if (regex_match(token, sub, reg5)) {
1226 // search for strings in <...>
1227 static regex const reg5_1("<([^>]+)(.)");
1228 fragment_pos = iterateLine(token, reg5_1, ">",
1229 fragment_pos, head);
1230 fragment = (fragment_pos != -1);
1234 // We can have several of these on one line
1235 // this must be queried separated, because of
1236 // cases such as "File: file.ext (type eps)"
1237 // where "File: file.ext" would be skipped
1238 if (regex_match(token, sub, reg6)) {
1239 // search for strings in (...)
1240 static regex const reg6_1("\\(([^()]+)(.)");
1241 fragment_pos = iterateLine(token, reg6_1, ")",
1242 fragment_pos, head);
1243 fragment = (fragment_pos != -1);
1247 // probable linebreak within file name:
1251 // no linebreak: reset
1252 lastline = string();
1255 // Make sure that the main .tex file is in the dependency file.
1256 head.insert(file, true);
1260 int LaTeX::scanBlgFile(DepTable & dep, TeXErrors & terr)
1262 FileName const blg_file(changeExtension(file.absFileName(), "blg"));
1263 LYXERR(Debug::LATEX, "Scanning blg file: " << blg_file);
1265 ifstream ifs(blg_file.toFilesystemEncoding().c_str());
1267 static regex const reg1(".*Found (bibtex|BibTeX) data (file|source) '([^']+).*");
1268 static regex const bibtexError("^(.*---line [0-9]+ of file).*$");
1269 static regex const bibtexError2("^(.*---while reading file).*$");
1270 static regex const bibtexError3("(A bad cross reference---).*");
1271 static regex const bibtexError4("(Sorry---you've exceeded BibTeX's).*");
1272 static regex const bibtexError5("\\*Please notify the BibTeX maintainer\\*");
1273 static regex const biberError("^.*> (FATAL|ERROR) - (.*)$");
1274 int retval = NO_ERRORS;
1277 while (getline(ifs, token)) {
1278 token = rtrim(token, "\r");
1280 // FIXME UNICODE: We assume that citation keys and filenames
1281 // in the aux file are in the file system encoding.
1282 token = to_utf8(from_filesystem8bit(token));
1283 if (regex_match(token, sub, reg1)) {
1284 string data = sub.str(3);
1285 if (!data.empty()) {
1286 LYXERR(Debug::LATEX, "Found bib file: " << data);
1287 handleFoundFile(data, dep);
1290 else if (regex_match(token, sub, bibtexError)
1291 || regex_match(token, sub, bibtexError2)
1292 || regex_match(token, sub, bibtexError4)
1293 || regex_match(token, sub, bibtexError5)) {
1294 retval |= BIBTEX_ERROR;
1295 string errstr = N_("BibTeX error: ") + token;
1297 if ((prefixIs(token, "while executing---line")
1298 || prefixIs(token, "---line ")
1299 || prefixIs(token, "*Please notify the BibTeX"))
1300 && !prevtoken.empty()) {
1301 errstr = N_("BibTeX error: ") + prevtoken;
1302 message = prevtoken + '\n';
1306 from_local8bit(errstr),
1307 from_local8bit(message));
1308 } else if (regex_match(prevtoken, sub, bibtexError3)) {
1309 retval |= BIBTEX_ERROR;
1310 string errstr = N_("BibTeX error: ") + prevtoken;
1311 string message = prevtoken + '\n' + token;
1313 from_local8bit(errstr),
1314 from_local8bit(message));
1315 } else if (regex_match(token, sub, biberError)) {
1316 retval |= BIBTEX_ERROR;
1317 string errstr = N_("Biber error: ") + sub.str(2);
1318 string message = token;
1320 from_local8bit(errstr),
1321 from_local8bit(message));