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"
24 #include "support/debug.h"
25 #include "support/convert.h"
26 #include "support/FileName.h"
27 #include "support/filetools.h"
28 #include "support/gettext.h"
29 #include "support/lstrings.h"
30 #include "support/Systemcall.h"
31 #include "support/os.h"
33 #include "support/regex.h"
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.
56 docstring runMessage(unsigned int count)
58 return bformat(_("Waiting for LaTeX run number %1$d"), count);
67 void TeXErrors::insertError(int line, docstring const & error_desc,
68 docstring const & error_text,
69 string const & child_name)
71 Error newerr(line, error_desc, error_text, child_name);
72 errors.push_back(newerr);
76 bool operator==(AuxInfo const & a, AuxInfo const & o)
78 return a.aux_file == o.aux_file
79 && a.citations == o.citations
80 && a.databases == o.databases
81 && a.styles == o.styles;
85 bool operator!=(AuxInfo const & a, AuxInfo const & o)
95 LaTeX::LaTeX(string const & latex, OutputParams const & rp,
96 FileName const & f, string const & p, string const & lp,
97 bool const clean_start)
98 : cmd(latex), file(f), path(p), lpath(lp), runparams(rp), biber(false)
101 // lualatex can still produce a DVI with --output-format=dvi. However,
102 // we do not use that internally (we use the "dvilualatex" command) so
103 // it would only happen from a custom converter. Thus, it is better to
104 // guess that lualatex produces a PDF than to guess a DVI.
105 // FIXME we should base the extension on the output format, which we should
106 // get in a robust way, e.g. from the converter.
107 if (prefixIs(cmd, "pdf") || prefixIs(cmd, "lualatex") || prefixIs(cmd, "xelatex")) {
108 depfile = FileName(file.absFileName() + ".dep-pdf");
110 FileName(changeExtension(file.absFileName(), ".pdf"));
112 depfile = FileName(file.absFileName() + ".dep");
114 FileName(changeExtension(file.absFileName(), ".dvi"));
117 removeAuxiliaryFiles();
121 void LaTeX::removeAuxiliaryFiles() const
123 // Note that we do not always call this function when there is an error.
124 // For example, if there is an error but an output file is produced we
125 // still would like to output (export/view) the file.
127 // What files do we have to delete?
129 // This will at least make latex do all the runs
130 depfile.removeFile();
132 // but the reason for the error might be in a generated file...
135 FileName const bbl(changeExtension(file.absFileName(), ".bbl"));
139 FileName const bcf(changeExtension(file.absFileName(), ".bcf"));
143 FileName const ind(changeExtension(file.absFileName(), ".ind"));
147 FileName const nls(changeExtension(file.absFileName(), ".nls"));
150 // nomencl file (old version of the package)
151 FileName const gls(changeExtension(file.absFileName(), ".gls"));
154 // Also remove the aux file
155 FileName const aux(changeExtension(file.absFileName(), ".aux"));
158 // Also remove the .out file (e.g. hyperref bookmarks) (#9963)
159 FileName const out(changeExtension(file.absFileName(), ".out"));
162 // Remove the output file, which is often generated even if error
163 output_file.removeFile();
167 int LaTeX::run(TeXErrors & terr)
168 // We know that this function will only be run if the lyx buffer
169 // has been changed. We also know that a newly written .tex file
170 // is always different from the previous one because of the date
171 // in it. However it seems safe to run latex (at least) one time
172 // each time the .tex file changes.
174 int scanres = NO_ERRORS;
175 int bscanres = NO_ERRORS;
176 unsigned int count = 0; // number of times run
177 num_errors = 0; // just to make sure.
178 unsigned int const MAX_RUN = 6;
179 DepTable head; // empty head
180 bool rerun = false; // rerun requested
182 // The class LaTeX does not know the temp path.
183 theBufferList().updateIncludedTeXfiles(FileName::getcwd().absFileName(),
187 // first check if the file dependencies exist:
188 // ->If it does exist
189 // check if any of the files mentioned in it have
190 // changed (done using a checksum).
192 // run latex once and
193 // remake the dependency file
194 // -> if not changed:
195 // just return there is nothing to do for us.
196 // ->if it doesn't exist
198 // run latex once (we need to run latex once anyway) and
199 // remake the dependency file.
202 bool had_depfile = depfile.exists();
203 bool run_bibtex = false;
204 FileName const aux_file(changeExtension(file.absFileName(), ".aux"));
207 LYXERR(Debug::DEPEND, "Dependency file exists");
208 // Read the dep file:
209 had_depfile = head.read(depfile);
213 // Update the checksums
215 // Can't just check if anything has changed because it might
216 // have aborted on error last time... in which cas we need
217 // to re-run latex and collect the error messages
218 // (even if they are the same).
219 if (!output_file.exists()) {
220 LYXERR(Debug::DEPEND,
221 "re-running LaTeX because output file doesn't exist.");
222 } else if (!head.sumchange()) {
223 LYXERR(Debug::DEPEND, "return no_change");
226 LYXERR(Debug::DEPEND, "Dependency file has changed");
229 if (head.extchanged(".bib") || head.extchanged(".bst"))
232 LYXERR(Debug::DEPEND,
233 "Dependency file does not exist, or has wrong format");
235 /// We scan the aux file even when had_depfile = false,
236 /// because we can run pdflatex on the file after running latex on it,
237 /// in which case we will not need to run bibtex again.
238 vector<AuxInfo> bibtex_info_old;
240 bibtex_info_old = scanAuxFiles(aux_file, runparams.only_childbibs);
243 LYXERR(Debug::LATEX, "Run #" << count);
244 message(runMessage(count));
246 int exit_code = startscript();
248 scanres = scanLogFile(terr);
249 if (scanres & ERROR_RERUN) {
250 LYXERR(Debug::LATEX, "Rerunning LaTeX");
252 exit_code = startscript();
253 scanres = scanLogFile(terr);
256 vector<AuxInfo> const bibtex_info = scanAuxFiles(aux_file, runparams.only_childbibs);
257 if (!run_bibtex && bibtex_info_old != bibtex_info)
260 // update the dependencies.
261 deplog(head); // reads the latex log
265 // At this point we must run external programs if needed.
266 // makeindex will be run if a .idx file changed or was generated.
267 // And if there were undefined citations or changes in references
268 // the .aux file is checked for signs of bibtex. Bibtex is then run
271 // memoir (at least) writes an empty *idx file in the first place.
272 // A second latex run is needed.
273 FileName const idxfile(changeExtension(file.absFileName(), ".idx"));
274 rerun = idxfile.exists() && idxfile.isFileEmpty();
277 if (head.haschanged(idxfile)) {
279 LYXERR(Debug::LATEX, "Running MakeIndex.");
280 message(_("Running Index Processor."));
281 // onlyFileName() is needed for cygwin
282 rerun |= runMakeIndex(onlyFileName(idxfile.absFileName()),
285 FileName const nlofile(changeExtension(file.absFileName(), ".nlo"));
286 // If all nomencl entries are removed, nomencl writes an empty nlo file.
287 // DepTable::hasChanged() returns false in this case, since it does not
288 // distinguish empty files from non-existing files. This is why we need
289 // the extra checks here (to trigger a rerun). Cf. discussions in #8905.
290 // FIXME: Sort out the real problem in DepTable.
291 if (head.haschanged(nlofile) || (nlofile.exists() && nlofile.isFileEmpty()))
292 rerun |= runMakeIndexNomencl(file, ".nlo", ".nls");
293 FileName const glofile(changeExtension(file.absFileName(), ".glo"));
294 if (head.haschanged(glofile))
295 rerun |= runMakeIndexNomencl(file, ".glo", ".gls");
297 // check if we're using biber instead of bibtex
298 // biber writes no info to the aux file, so we just check
299 // if a bcf file exists (and if it was updated)
300 FileName const bcffile(changeExtension(file.absFileName(), ".bcf"));
301 biber |= head.exist(bcffile);
304 // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
305 if (scanres & UNDEF_CIT || run_bibtex) {
306 // Here we must scan the .aux file and look for
307 // "\bibdata" and/or "\bibstyle". If one of those
308 // tags is found -> run bibtex and set rerun = true;
310 LYXERR(Debug::LATEX, "Running BibTeX.");
311 message(_("Running BibTeX."));
312 updateBibtexDependencies(head, bibtex_info);
313 rerun |= runBibTeX(bibtex_info, runparams);
314 FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
315 if (blgfile.exists())
316 bscanres = scanBlgFile(head, terr);
317 } else if (!had_depfile) {
318 /// If we run pdflatex on the file after running latex on it,
319 /// then we do not need to run bibtex, but we do need to
320 /// insert the .bib and .bst files into the .dep-pdf file.
321 updateBibtexDependencies(head, bibtex_info);
325 // we know on this point that latex has been run once (or we just
326 // returned) and the question now is to decide if we need to run
327 // it any more. This is done by asking if any of the files in the
328 // dependency file has changed. (remember that the checksum for
329 // a given file is reported to have changed if it just was created)
330 // -> if changed or rerun == true:
331 // run latex once more and
332 // update the dependency structure
333 // -> if not changed:
334 // we do nothing at this point
336 if (rerun || head.sumchange()) {
339 LYXERR(Debug::DEPEND, "Dep. file has changed or rerun requested");
340 LYXERR(Debug::LATEX, "Run #" << count);
341 message(runMessage(count));
343 scanres = scanLogFile(terr);
345 // update the depedencies
346 deplog(head); // reads the latex log
349 LYXERR(Debug::DEPEND, "Dep. file has NOT changed");
354 // Complex bibliography packages such as Biblatex require
355 // an additional bibtex cycle sometimes.
356 if (scanres & UNDEF_CIT) {
357 // Here we must scan the .aux file and look for
358 // "\bibdata" and/or "\bibstyle". If one of those
359 // tags is found -> run bibtex and set rerun = true;
361 LYXERR(Debug::LATEX, "Running BibTeX.");
362 message(_("Running BibTeX."));
363 updateBibtexDependencies(head, bibtex_info);
364 rerun |= runBibTeX(bibtex_info, runparams);
365 FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
366 if (blgfile.exists())
367 bscanres = scanBlgFile(head, terr);
371 // The inclusion of files generated by external programs such as
372 // makeindex or bibtex might have done changes to pagenumbering,
373 // etc. And because of this we must run the external programs
374 // again to make sure everything is redone correctly.
375 // Also there should be no need to run the external programs any
378 // run makeindex if the <file>.idx has changed or was generated.
379 if (head.haschanged(idxfile)) {
381 LYXERR(Debug::LATEX, "Running MakeIndex.");
382 message(_("Running Index Processor."));
383 // onlyFileName() is needed for cygwin
384 rerun = runMakeIndex(onlyFileName(changeExtension(
385 file.absFileName(), ".idx")), runparams);
388 // I am not pretty sure if need this twice.
389 if (head.haschanged(nlofile))
390 rerun |= runMakeIndexNomencl(file, ".nlo", ".nls");
391 if (head.haschanged(glofile))
392 rerun |= runMakeIndexNomencl(file, ".glo", ".gls");
395 // we will only run latex more if the log file asks for it.
396 // or if the sumchange() is true.
397 // -> rerun asked for:
399 // remake the dependency file
400 // goto 2 or return if max runs are reached.
401 // -> rerun not asked for:
402 // just return (fall out of bottom of func)
404 while ((head.sumchange() || rerun || (scanres & RERUN))
405 && count < MAX_RUN) {
406 // Yes rerun until message goes away, or until
407 // MAX_RUNS are reached.
410 LYXERR(Debug::LATEX, "Run #" << count);
411 message(runMessage(count));
413 scanres = scanLogFile(terr);
419 // Write the dependencies to file.
423 // add flag here, just before return, instead of when exit_code
424 // is defined because scanres is sometimes overwritten above
426 scanres |= NONZERO_ERROR;
429 LYXERR(Debug::LATEX, "Done.");
431 if (bscanres & ERRORS)
432 return bscanres; // return on error
438 int LaTeX::startscript()
440 // onlyFileName() is needed for cygwin
441 string tmp = cmd + ' '
442 + quoteName(onlyFileName(file.toFilesystemEncoding()))
443 + " > " + os::nulldev();
445 return one.startscript(Systemcall::Wait, tmp, path, lpath);
449 bool LaTeX::runMakeIndex(string const & f, OutputParams const & runparams,
450 string const & params)
452 string tmp = runparams.use_japanese ?
453 lyxrc.jindex_command : lyxrc.index_command;
455 if (!runparams.index_command.empty())
456 tmp = runparams.index_command;
459 "idx file has been made, running index processor ("
460 << tmp << ") on file " << f);
462 tmp = subst(tmp, "$$lang", runparams.document_language);
463 if (runparams.use_indices) {
464 tmp = lyxrc.splitindex_command + " -m " + quoteName(tmp);
466 "Multiple indices. Using splitindex command: " << tmp);
472 one.startscript(Systemcall::Wait, tmp, path, lpath);
477 bool LaTeX::runMakeIndexNomencl(FileName const & file,
478 string const & nlo, string const & nls)
480 LYXERR(Debug::LATEX, "Running MakeIndex for nomencl.");
481 message(_("Running MakeIndex for nomencl."));
482 string tmp = lyxrc.nomencl_command + ' ';
483 // onlyFileName() is needed for cygwin
484 tmp += quoteName(onlyFileName(changeExtension(file.absFileName(), nlo)));
486 + onlyFileName(changeExtension(file.toFilesystemEncoding(), nls));
488 one.startscript(Systemcall::Wait, tmp, path, lpath);
493 vector<AuxInfo> const
494 LaTeX::scanAuxFiles(FileName const & file, bool const only_childbibs)
496 vector<AuxInfo> result;
498 // With chapterbib, we have to bibtex all children's aux files
499 // but _not_ the master's!
500 if (only_childbibs) {
501 for (string const &s: children) {
503 makeAbsPath(s, file.onlyPath().realPath());
504 fn.changeExtension("aux");
506 result.push_back(scanAuxFile(fn));
511 result.push_back(scanAuxFile(file));
513 // This is for bibtopic
514 string const basename = removeExtension(file.absFileName());
515 for (int i = 1; i < 1000; ++i) {
516 FileName const file2(basename
517 + '.' + convert<string>(i)
521 result.push_back(scanAuxFile(file2));
527 AuxInfo const LaTeX::scanAuxFile(FileName const & file)
530 result.aux_file = file;
531 scanAuxFile(file, result);
536 void LaTeX::scanAuxFile(FileName const & file, AuxInfo & aux_info)
538 LYXERR(Debug::LATEX, "Scanning aux file: " << file);
540 ifstream ifs(file.toFilesystemEncoding().c_str());
542 static regex const reg1("\\\\citation\\{([^}]+)\\}");
543 static regex const reg2("\\\\bibdata\\{([^}]+)\\}");
544 static regex const reg3("\\\\bibstyle\\{([^}]+)\\}");
545 static regex const reg4("\\\\@input\\{([^}]+)\\}");
547 while (getline(ifs, token)) {
548 token = rtrim(token, "\r");
550 // FIXME UNICODE: We assume that citation keys and filenames
551 // in the aux file are in the file system encoding.
552 token = to_utf8(from_filesystem8bit(token));
553 if (regex_match(token, sub, reg1)) {
554 string data = sub.str(1);
555 while (!data.empty()) {
557 data = split(data, citation, ',');
558 LYXERR(Debug::LATEX, "Citation: " << citation);
559 aux_info.citations.insert(citation);
561 } else if (regex_match(token, sub, reg2)) {
562 string data = sub.str(1);
563 // data is now all the bib files separated by ','
564 // get them one by one and pass them to the helper
565 while (!data.empty()) {
567 data = split(data, database, ',');
568 database = changeExtension(database, "bib");
569 LYXERR(Debug::LATEX, "BibTeX database: `" << database << '\'');
570 aux_info.databases.insert(database);
572 } else if (regex_match(token, sub, reg3)) {
573 string style = sub.str(1);
574 // token is now the style file
575 // pass it to the helper
576 style = changeExtension(style, "bst");
577 LYXERR(Debug::LATEX, "BibTeX style: `" << style << '\'');
578 aux_info.styles.insert(style);
579 } else if (regex_match(token, sub, reg4)) {
580 string const file2 = sub.str(1);
581 scanAuxFile(makeAbsPath(file2), aux_info);
587 void LaTeX::updateBibtexDependencies(DepTable & dep,
588 vector<AuxInfo> const & bibtex_info)
590 // Since a run of Bibtex mandates more latex runs it is ok to
591 // remove all ".bib" and ".bst" files.
592 dep.remove_files_with_extension(".bib");
593 dep.remove_files_with_extension(".bst");
594 //string aux = OnlyFileName(ChangeExtension(file, ".aux"));
596 for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
597 it != bibtex_info.end(); ++it) {
598 for (set<string>::const_iterator it2 = it->databases.begin();
599 it2 != it->databases.end(); ++it2) {
600 FileName const file = findtexfile(*it2, "bib");
602 dep.insert(file, true);
605 for (set<string>::const_iterator it2 = it->styles.begin();
606 it2 != it->styles.end(); ++it2) {
607 FileName const file = findtexfile(*it2, "bst");
609 dep.insert(file, true);
613 // biber writes nothing into the aux file.
614 // Instead, we have to scan the blg file
617 scanBlgFile(dep, terr);
622 bool LaTeX::runBibTeX(vector<AuxInfo> const & bibtex_info,
623 OutputParams const & runparams)
626 for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
627 it != bibtex_info.end(); ++it) {
628 if (!biber && it->databases.empty())
632 string tmp = runparams.bibtex_command;
634 // onlyFileName() is needed for cygwin
635 tmp += quoteName(onlyFileName(removeExtension(
636 it->aux_file.absFileName())));
638 one.startscript(Systemcall::Wait, tmp, path, lpath);
640 // Return whether bibtex was run
645 int LaTeX::scanLogFile(TeXErrors & terr)
649 int retval = NO_ERRORS;
651 onlyFileName(changeExtension(file.absFileName(), ".log"));
652 LYXERR(Debug::LATEX, "Log file: " << tmp);
653 FileName const fn = FileName(makeAbsPath(tmp));
654 // FIXME we should use an ifdocstream here and a docstring for token
655 // below. The encoding of the log file depends on the _output_ (font)
656 // encoding of the TeX file (T1, TU etc.). See #10728.
657 ifstream ifs(fn.toFilesystemEncoding().c_str());
658 bool fle_style = false;
659 static regex const file_line_error(".+\\.\\D+:[0-9]+: (.+)");
660 static regex const child_file("[^0-9]*([0-9]+[A-Za-z]*_.+\\.tex).*");
661 // Flag for 'File ended while scanning' message.
662 // We need to wait for subsequent processing.
663 string wait_for_error;
666 stack <pair<string, int> > child;
670 while (getline(ifs, token)) {
671 // MikTeX sometimes inserts \0 in the log file. They can't be
672 // removed directly with the existing string utility
673 // functions, so convert them first to \r, and remove all
674 // \r's afterwards, since we need to remove them anyway.
675 token = subst(token, '\0', '\r');
676 token = subst(token, "\r", "");
679 LYXERR(Debug::LATEX, "Log line: " << token);
684 // Track child documents
685 for (size_t i = 0; i < token.length(); ++i) {
686 if (token[i] == '(') {
688 size_t j = token.find('(', i + 1);
689 size_t len = j == string::npos
690 ? token.substr(i + 1).length()
692 string const substr = token.substr(i + 1, len);
693 if (regex_match(substr, sub, child_file)) {
694 string const name = sub.str(1);
695 // Sometimes also masters have a name that matches
696 // (if their name starts with a number and _)
697 if (name != file.onlyFileName()) {
698 child.push(make_pair(name, pnest));
699 children.push_back(name);
703 } else if (token[i] == ')') {
705 && child.top().second == pnest)
710 child_name = child.empty() ? empty_string() : child.top().first;
712 if (contains(token, "file:line:error style messages enabled"))
715 if (prefixIs(token, "LaTeX Warning:") ||
716 prefixIs(token, "! pdfTeX warning")) {
717 // Here shall we handle different
719 retval |= LATEX_WARNING;
720 LYXERR(Debug::LATEX, "LaTeX Warning.");
721 if (contains(token, "Rerun to get cross-references")) {
723 LYXERR(Debug::LATEX, "We should rerun.");
724 // package clefval needs 2 latex runs before bibtex
725 } else if (contains(token, "Value of")
726 && contains(token, "on page")
727 && contains(token, "undefined")) {
728 retval |= ERROR_RERUN;
729 LYXERR(Debug::LATEX, "Force rerun.");
731 } else if (contains(token, "Etaremune labels have changed")) {
732 retval |= ERROR_RERUN;
733 LYXERR(Debug::LATEX, "Force rerun.");
734 } else if (contains(token, "Citation")
735 && contains(token, "on page")
736 && contains(token, "undefined")) {
738 } else if (contains(token, "Citation")
739 && contains(token, "on input line")
740 && contains(token, "undefined")) {
743 } else if (prefixIs(token, "Package")) {
745 retval |= PACKAGE_WARNING;
746 if (contains(token, "natbib Warning:")) {
748 if (contains(token, "Citation")
749 && contains(token, "on page")
750 && contains(token, "undefined")) {
753 } else if (contains(token, "run BibTeX")) {
755 } else if (contains(token, "run Biber")) {
758 } else if (contains(token, "Rerun LaTeX") ||
759 contains(token, "Please rerun LaTeX") ||
760 contains(token, "Rerun to get")) {
761 // at least longtable.sty and bibtopic.sty
763 LYXERR(Debug::LATEX, "We should rerun.");
766 } else if (prefixIs(token, "LETTRE WARNING:")) {
767 if (contains(token, "veuillez recompiler")) {
769 LYXERR(Debug::LATEX, "We should rerun.");
772 } else if (token[0] == '(') {
773 if (contains(token, "Rerun LaTeX") ||
774 contains(token, "Rerun to get")) {
776 LYXERR(Debug::LATEX, "We should rerun.");
779 } else if (prefixIs(token, "! ")
781 && regex_match(token, sub, file_line_error)
782 && !contains(token, "pdfTeX warning"))) {
783 // Ok, we have something that looks like a TeX Error
784 // but what do we really have.
786 // Just get the error description:
788 if (prefixIs(token, "! "))
789 desc = string(token, 2);
792 if (contains(token, "LaTeX Error:"))
793 retval |= LATEX_ERROR;
795 if (prefixIs(token, "! File ended while scanning")) {
796 if (prefixIs(token, "! File ended while scanning use of \\Hy@setref@link.")){
797 // bug 7344. We must rerun LaTeX if hyperref has been toggled.
798 retval |= ERROR_RERUN;
799 LYXERR(Debug::LATEX, "Force rerun.");
801 // bug 6445. At this point its not clear we finish with error.
802 wait_for_error = desc;
807 if (prefixIs(token, "! Incomplete \\if")) {
808 // bug 10666. At this point its not clear we finish with error.
809 wait_for_error = desc;
813 if (prefixIs(token, "! Paragraph ended before \\Hy@setref@link was complete.")){
814 // bug 7344. We must rerun LaTeX if hyperref has been toggled.
815 retval |= ERROR_RERUN;
816 LYXERR(Debug::LATEX, "Force rerun.");
819 if (!wait_for_error.empty() && prefixIs(token, "! Emergency stop.")){
820 retval |= LATEX_ERROR;
823 errstr = wait_for_error;
824 wait_for_error.clear();
826 if (!getline(ifs, tmp))
828 tmp = rtrim(tmp, "\r");
829 errstr += "\n" + tmp;
832 } while (!contains(tmp, "(job aborted"));
835 from_ascii("Emergency stop"),
836 from_local8bit(errstr),
844 if (!getline(ifs, tmp))
846 tmp = rtrim(tmp, "\r");
847 // 15 is somewhat arbitrarily chosen, based on practice.
848 // We used 10 for 14 years and increased it to 15 when we
852 } while (!prefixIs(tmp, "l."));
853 if (prefixIs(tmp, "l.")) {
854 // we have a latex error
857 "Package babel Error: You haven't defined the language")
859 "Package babel Error: You haven't loaded the option")
861 "Package babel Error: Unknown language"))
862 retval |= ERROR_RERUN;
863 // get the line number:
865 sscanf(tmp.c_str(), "l.%d", &line);
866 // get the rest of the message:
867 string errstr(tmp, tmp.find(' '));
870 tmp = rtrim(tmp, "\r");
871 while (!contains(errstr, "l.")
873 && !prefixIs(tmp, "! ")
874 && !contains(tmp, "(job aborted")) {
878 tmp = rtrim(tmp, "\r");
880 LYXERR(Debug::LATEX, "line: " << line << '\n'
881 << "Desc: " << desc << '\n' << "Text: " << errstr);
882 if (line == last_line)
888 if (line_count <= 5) {
890 // We have no idea what the encoding of
892 // It seems that the output from the
893 // latex compiler itself is pure ASCII,
894 // but it can include bits from the
895 // document, so whatever encoding we
896 // assume here it can be wrong.
897 terr.insertError(line,
898 from_local8bit(desc),
899 from_local8bit(errstr),
905 // information messages, TeX warnings and other
906 // warnings we have not caught earlier.
907 if (prefixIs(token, "Overfull ")) {
908 retval |= TEX_WARNING;
909 } else if (prefixIs(token, "Underfull ")) {
910 retval |= TEX_WARNING;
911 } else if (contains(token, "Rerun to get citations")) {
912 // Natbib seems to use this.
914 } else if (contains(token, "No pages of output")
915 || contains(token, "no pages of output")) {
916 // No output file (e.g. the DVI or PDF) was created
918 } else if (contains(token, "Error 256 (driver return code)")) {
919 // This is a xdvipdfmx driver error reported by XeTeX.
920 // We have to check whether an output PDF file was created.
921 FileName pdffile = file;
922 pdffile.changeExtension("pdf");
923 if (!pdffile.exists())
924 // No output PDF file was created (see #10076)
926 } else if (contains(token, "That makes 100 errors")) {
927 // More than 100 errors were reported
928 retval |= TOO_MANY_ERRORS;
929 } else if (prefixIs(token, "!pdfTeX error:")) {
930 // otherwise we dont catch e.g.:
931 // !pdfTeX error: pdflatex (file feyn10): Font feyn10 at 600 not found
934 from_ascii("pdfTeX Error"),
935 from_local8bit(token),
937 } else if (!ignore_missing_glyphs
938 && prefixIs(token, "Missing character: There is no ")
939 && !contains(token, "nullfont")) {
940 // Warning about missing glyph in selected font
941 // may be dataloss (bug 9610)
942 // but can be ignored for 'nullfont' (bug 10394).
943 // as well as for ZERO WIDTH NON-JOINER (0x200C) which is
944 // missing in many fonts and output for ligature break (bug 10727).
945 // Since this error only occurs with utf8 output, we can safely assume
946 // that the log file is utf8-encoded
947 docstring const utoken = from_utf8(token);
948 if (!contains(utoken, 0x200C)) {
949 retval |= LATEX_ERROR;
951 from_ascii("Missing glyphs!"),
955 } else if (!wait_for_error.empty()) {
956 // We collect information until we know we have an error.
957 wait_for_error += token + '\n';
961 LYXERR(Debug::LATEX, "Log line: " << token);
968 bool insertIfExists(FileName const & absname, DepTable & head)
970 if (absname.exists() && !absname.isDirectory()) {
971 head.insert(absname, true);
978 bool handleFoundFile(string const & ff, DepTable & head)
980 // convert from native os path to unix path
981 string foundfile = os::internal_path(trim(ff));
983 LYXERR(Debug::DEPEND, "Found file: " << foundfile);
985 // Ok now we found a file.
986 // Now we should make sure that this is a file that we can
987 // access through the normal paths.
988 // We will not try any fancy search methods to
991 // (1) foundfile is an
992 // absolute path and should
995 if (FileName::isAbsolute(foundfile)) {
996 LYXERR(Debug::DEPEND, "AbsolutePath file: " << foundfile);
997 // On initial insert we want to do the update at once
998 // since this file cannot be a file generated by
1000 absname.set(foundfile);
1001 if (!insertIfExists(absname, head)) {
1003 string strippedfile = foundfile;
1004 while (contains(strippedfile, " ")) {
1005 // files with spaces are often enclosed in quotation
1006 // marks; those have to be removed
1007 string unquoted = subst(strippedfile, "\"", "");
1008 absname.set(unquoted);
1009 if (insertIfExists(absname, head))
1011 // strip off part after last space and try again
1012 string tmp = strippedfile;
1013 rsplit(tmp, strippedfile, ' ');
1014 absname.set(strippedfile);
1015 if (insertIfExists(absname, head))
1021 string onlyfile = onlyFileName(foundfile);
1022 absname = makeAbsPath(onlyfile);
1025 while (contains(foundfile, ' ')) {
1026 if (absname.exists())
1030 // files with spaces are often enclosed in quotation
1031 // marks; those have to be removed
1032 string unquoted = subst(foundfile, "\"", "");
1033 absname = makeAbsPath(unquoted);
1034 if (absname.exists())
1036 // strip off part after last space and try again
1037 string strippedfile;
1038 rsplit(foundfile, strippedfile, ' ');
1039 foundfile = strippedfile;
1040 onlyfile = onlyFileName(strippedfile);
1041 absname = makeAbsPath(onlyfile);
1045 // (2) foundfile is in the tmpdir
1046 // insert it into head
1047 if (absname.exists() && !absname.isDirectory()) {
1048 // FIXME: This regex contained glo, but glo is used by the old
1049 // version of nomencl.sty. Do we need to put it back?
1050 static regex const unwanted("^.*\\.(aux|log|dvi|bbl|ind)$");
1051 if (regex_match(onlyfile, unwanted)) {
1052 LYXERR(Debug::DEPEND, "We don't want " << onlyfile
1053 << " in the dep file");
1054 } else if (suffixIs(onlyfile, ".tex")) {
1055 // This is a tex file generated by LyX
1056 // and latex is not likely to change this
1058 LYXERR(Debug::DEPEND, "Tmpdir TeX file: " << onlyfile);
1059 head.insert(absname, true);
1061 LYXERR(Debug::DEPEND, "In tmpdir file:" << onlyfile);
1062 head.insert(absname);
1066 LYXERR(Debug::DEPEND, "Not a file or we are unable to find it.");
1072 bool completeFilename(string const & ff, DepTable & head)
1074 // If we do not find a dot, we suspect
1075 // a fragmental file name
1076 if (!contains(ff, '.'))
1079 // if we have a dot, we let handleFoundFile decide
1080 return handleFoundFile(ff, head);
1084 int iterateLine(string const & token, regex const & reg, string const & closing,
1085 int fragment_pos, DepTable & head)
1088 string::const_iterator first = token.begin();
1089 string::const_iterator end = token.end();
1090 bool fragment = false;
1093 while (regex_search(first, end, what, reg)) {
1094 // if we have a dot, try to handle as file
1095 if (contains(what.str(1), '.')) {
1096 first = what[0].second;
1097 if (what.str(2) == closing) {
1098 handleFoundFile(what.str(1), head);
1099 // since we had a closing bracket,
1100 // do not investigate further
1103 // if we have no closing bracket,
1104 // try to handle as file nevertheless
1105 fragment = !handleFoundFile(
1106 what.str(1) + what.str(2), head);
1108 // if we do not have a dot, check if the line has
1109 // a closing bracket (else, we suspect a line break)
1110 else if (what.str(2) != closing) {
1111 first = what[0].second;
1114 // we have a closing bracket, so the content
1115 // is not a file name.
1116 // no need to investigate further
1117 first = what[0].second;
1120 last_match = what.str(1);
1123 // We need to consider the result from previous line iterations:
1124 // We might not find a fragment here, but another one might follow
1125 // E.g.: (filename.ext) <filenam
1126 // Vice versa, we consider the search completed if a real match
1127 // follows a potential fragment from a previous iteration.
1128 // E.g. <some text we considered a fragment (filename.ext)
1129 // result = -1 means we did not find a fragment!
1131 int last_match_pos = -1;
1132 if (!last_match.empty() && token.find(last_match) != string::npos)
1133 last_match_pos = int(token.find(last_match));
1135 if (last_match_pos > fragment_pos)
1136 result = last_match_pos;
1138 result = fragment_pos;
1140 if (last_match_pos < fragment_pos)
1141 result = fragment_pos;
1149 void LaTeX::deplog(DepTable & head)
1151 // This function reads the LaTeX log file end extracts all the
1152 // external files used by the LaTeX run. The files are then
1153 // entered into the dependency file.
1155 string const logfile =
1156 onlyFileName(changeExtension(file.absFileName(), ".log"));
1158 static regex const reg1("File: (.+).*");
1159 static regex const reg2("No file (.+)(.).*");
1160 static regex const reg3("\\\\openout[0-9]+.*=.*`(.+)(..).*");
1161 // If an index should be created, MikTex does not write a line like
1162 // \openout# = 'sample.idx'.
1163 // but instead only a line like this into the log:
1164 // Writing index file sample.idx
1165 static regex const reg4("Writing index file (.+).*");
1166 static regex const regoldnomencl("Writing glossary file (.+).*");
1167 static regex const regnomencl("Writing nomenclature file (.+).*");
1168 // If a toc should be created, MikTex does not write a line like
1169 // \openout# = `sample.toc'.
1170 // but only a line like this into the log:
1172 // This line is also written by tetex.
1173 // This line is not present if no toc should be created.
1174 static regex const miktexTocReg("\\\\tf@toc=\\\\write.*");
1175 // file names can be enclosed in <...> (anywhere on the line)
1176 static regex const reg5(".*<[^>]+.*");
1177 // and also (...) anywhere on the line
1178 static regex const reg6(".*\\([^)]+.*");
1180 FileName const fn = makeAbsPath(logfile);
1181 ifstream ifs(fn.toFilesystemEncoding().c_str());
1184 // Ok, the scanning of files here is not sufficient.
1185 // Sometimes files are named by "File: xxx" only
1186 // Therefore we use some regexps to find files instead.
1187 // Note: all file names and paths might contains spaces.
1188 // Also, file names might be broken across lines. Therefore
1189 // we mark (potential) fragments and merge those lines.
1190 bool fragment = false;
1192 getline(ifs, token);
1193 // MikTeX sometimes inserts \0 in the log file. They can't be
1194 // removed directly with the existing string utility
1195 // functions, so convert them first to \r, and remove all
1196 // \r's afterwards, since we need to remove them anyway.
1197 token = subst(token, '\0', '\r');
1198 token = subst(token, "\r", "");
1199 if (token.empty() || token == ")") {
1200 lastline = string();
1204 // FIXME UNICODE: We assume that the file names in the log
1205 // file are in the file system encoding.
1206 token = to_utf8(from_filesystem8bit(token));
1208 // Sometimes, filenames are broken across lines.
1209 // We care for that and save suspicious lines.
1210 // Here we exclude some cases where we are sure
1211 // that there is no continued filename
1212 if (!lastline.empty()) {
1213 static regex const package_info("Package \\w+ Info: .*");
1214 static regex const package_warning("Package \\w+ Warning: .*");
1215 if (prefixIs(token, "File:") || prefixIs(token, "(Font)")
1216 || prefixIs(token, "Package:")
1217 || prefixIs(token, "Language:")
1218 || prefixIs(token, "LaTeX Info:")
1219 || prefixIs(token, "LaTeX Font Info:")
1220 || prefixIs(token, "\\openout[")
1221 || prefixIs(token, "))")
1222 || regex_match(token, package_info)
1223 || regex_match(token, package_warning))
1224 lastline = string();
1227 if (!lastline.empty())
1228 // probably a continued filename from last line
1229 token = lastline + token;
1230 if (token.length() > 255) {
1231 // string too long. Cut off.
1232 token.erase(0, token.length() - 251);
1237 // (1) "File: file.ext"
1238 if (regex_match(token, sub, reg1)) {
1239 // is this a fragmental file name?
1240 fragment = !completeFilename(sub.str(1), head);
1242 if (suffixIs(token, ")"))
1243 // no fragment for sure
1245 // (2) "No file file.ext"
1246 } else if (regex_match(token, sub, reg2)) {
1247 // file names must contains a dot, line ends with dot
1248 if (contains(sub.str(1), '.') && sub.str(2) == ".")
1249 fragment = !handleFoundFile(sub.str(1), head);
1251 // we suspect a line break
1253 // (3) "\openout<nr> = `file.ext'."
1254 } else if (regex_match(token, sub, reg3)) {
1255 // search for closing '. at the end of the line
1256 if (sub.str(2) == "\'.")
1257 fragment = !handleFoundFile(sub.str(1), head);
1259 // potential fragment
1261 // (4) "Writing index file file.ext"
1262 } else if (regex_match(token, sub, reg4))
1263 // fragmential file name?
1264 fragment = !completeFilename(sub.str(1), head);
1265 // (5) "Writing nomenclature file file.ext"
1266 else if (regex_match(token, sub, regnomencl) ||
1267 regex_match(token, sub, regoldnomencl))
1268 // fragmental file name?
1269 fragment= !completeFilename(sub.str(1), head);
1270 // (6) "\tf@toc=\write<nr>" (for MikTeX)
1271 else if (regex_match(token, sub, miktexTocReg))
1272 fragment = !handleFoundFile(onlyFileName(changeExtension(
1273 file.absFileName(), ".toc")), head);
1275 // not found, but we won't check further
1278 int fragment_pos = -1;
1280 // We can have several of these on one line
1281 // (and in addition to those above)
1282 if (regex_match(token, sub, reg5)) {
1283 // search for strings in <...>
1284 static regex const reg5_1("<([^>]+)(.)");
1285 fragment_pos = iterateLine(token, reg5_1, ">",
1286 fragment_pos, head);
1287 fragment = (fragment_pos != -1);
1291 // We can have several of these on one line
1292 // this must be queried separated, because of
1293 // cases such as "File: file.ext (type eps)"
1294 // where "File: file.ext" would be skipped
1295 if (regex_match(token, sub, reg6)) {
1296 // search for strings in (...)
1297 static regex const reg6_1("\\(([^()]+)(.)");
1298 fragment_pos = iterateLine(token, reg6_1, ")",
1299 fragment_pos, head);
1300 fragment = (fragment_pos != -1);
1304 // probable linebreak within file name:
1308 // no linebreak: reset
1309 lastline = string();
1312 // Make sure that the main .tex file is in the dependency file.
1313 head.insert(file, true);
1317 int LaTeX::scanBlgFile(DepTable & dep, TeXErrors & terr)
1319 FileName const blg_file(changeExtension(file.absFileName(), "blg"));
1320 LYXERR(Debug::LATEX, "Scanning blg file: " << blg_file);
1322 ifstream ifs(blg_file.toFilesystemEncoding().c_str());
1324 static regex const reg1(".*Found (bibtex|BibTeX) data (file|source) '([^']+).*");
1325 static regex const bibtexError("^(.*---line [0-9]+ of file).*$");
1326 static regex const bibtexError2("^(.*---while reading file).*$");
1327 static regex const bibtexError3("(A bad cross reference---).*");
1328 static regex const bibtexError4("(Sorry---you've exceeded BibTeX's).*");
1329 static regex const bibtexError5("\\*Please notify the BibTeX maintainer\\*");
1330 static regex const biberError("^.*> (FATAL|ERROR) - (.*)$");
1331 int retval = NO_ERRORS;
1334 while (getline(ifs, token)) {
1335 token = rtrim(token, "\r");
1337 // FIXME UNICODE: We assume that citation keys and filenames
1338 // in the aux file are in the file system encoding.
1339 token = to_utf8(from_filesystem8bit(token));
1340 if (regex_match(token, sub, reg1)) {
1341 string data = sub.str(3);
1342 if (!data.empty()) {
1343 LYXERR(Debug::LATEX, "Found bib file: " << data);
1344 handleFoundFile(data, dep);
1347 else if (regex_match(token, sub, bibtexError)
1348 || regex_match(token, sub, bibtexError2)
1349 || regex_match(token, sub, bibtexError4)
1350 || regex_match(token, sub, bibtexError5)) {
1351 retval |= BIBTEX_ERROR;
1352 string errstr = N_("BibTeX error: ") + token;
1354 if ((prefixIs(token, "while executing---line")
1355 || prefixIs(token, "---line ")
1356 || prefixIs(token, "*Please notify the BibTeX"))
1357 && !prevtoken.empty()) {
1358 errstr = N_("BibTeX error: ") + prevtoken;
1359 message = prevtoken + '\n';
1363 from_local8bit(errstr),
1364 from_local8bit(message));
1365 } else if (regex_match(prevtoken, sub, bibtexError3)) {
1366 retval |= BIBTEX_ERROR;
1367 string errstr = N_("BibTeX error: ") + prevtoken;
1368 string message = prevtoken + '\n' + token;
1370 from_local8bit(errstr),
1371 from_local8bit(message));
1372 } else if (regex_match(token, sub, biberError)) {
1373 retval |= BIBTEX_ERROR;
1374 string errstr = N_("Biber error: ") + sub.str(2);
1375 string message = token;
1377 from_local8bit(errstr),
1378 from_local8bit(message));