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);
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);
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)
496 vector<AuxInfo> result;
498 result.push_back(scanAuxFile(file));
500 string const basename = removeExtension(file.absFileName());
501 for (int i = 1; i < 1000; ++i) {
502 FileName const file2(basename
503 + '.' + convert<string>(i)
507 result.push_back(scanAuxFile(file2));
513 AuxInfo const LaTeX::scanAuxFile(FileName const & file)
516 result.aux_file = file;
517 scanAuxFile(file, result);
522 void LaTeX::scanAuxFile(FileName const & file, AuxInfo & aux_info)
524 LYXERR(Debug::LATEX, "Scanning aux file: " << file);
526 ifstream ifs(file.toFilesystemEncoding().c_str());
528 static regex const reg1("\\\\citation\\{([^}]+)\\}");
529 static regex const reg2("\\\\bibdata\\{([^}]+)\\}");
530 static regex const reg3("\\\\bibstyle\\{([^}]+)\\}");
531 static regex const reg4("\\\\@input\\{([^}]+)\\}");
533 while (getline(ifs, token)) {
534 token = rtrim(token, "\r");
536 // FIXME UNICODE: We assume that citation keys and filenames
537 // in the aux file are in the file system encoding.
538 token = to_utf8(from_filesystem8bit(token));
539 if (regex_match(token, sub, reg1)) {
540 string data = sub.str(1);
541 while (!data.empty()) {
543 data = split(data, citation, ',');
544 LYXERR(Debug::LATEX, "Citation: " << citation);
545 aux_info.citations.insert(citation);
547 } else if (regex_match(token, sub, reg2)) {
548 string data = sub.str(1);
549 // data is now all the bib files separated by ','
550 // get them one by one and pass them to the helper
551 while (!data.empty()) {
553 data = split(data, database, ',');
554 database = changeExtension(database, "bib");
555 LYXERR(Debug::LATEX, "BibTeX database: `" << database << '\'');
556 aux_info.databases.insert(database);
558 } else if (regex_match(token, sub, reg3)) {
559 string style = sub.str(1);
560 // token is now the style file
561 // pass it to the helper
562 style = changeExtension(style, "bst");
563 LYXERR(Debug::LATEX, "BibTeX style: `" << style << '\'');
564 aux_info.styles.insert(style);
565 } else if (regex_match(token, sub, reg4)) {
566 string const file2 = sub.str(1);
567 scanAuxFile(makeAbsPath(file2), aux_info);
573 void LaTeX::updateBibtexDependencies(DepTable & dep,
574 vector<AuxInfo> const & bibtex_info)
576 // Since a run of Bibtex mandates more latex runs it is ok to
577 // remove all ".bib" and ".bst" files.
578 dep.remove_files_with_extension(".bib");
579 dep.remove_files_with_extension(".bst");
580 //string aux = OnlyFileName(ChangeExtension(file, ".aux"));
582 for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
583 it != bibtex_info.end(); ++it) {
584 for (set<string>::const_iterator it2 = it->databases.begin();
585 it2 != it->databases.end(); ++it2) {
586 FileName const file = findtexfile(*it2, "bib");
588 dep.insert(file, true);
591 for (set<string>::const_iterator it2 = it->styles.begin();
592 it2 != it->styles.end(); ++it2) {
593 FileName const file = findtexfile(*it2, "bst");
595 dep.insert(file, true);
599 // biber writes nothing into the aux file.
600 // Instead, we have to scan the blg file
603 scanBlgFile(dep, terr);
608 bool LaTeX::runBibTeX(vector<AuxInfo> const & bibtex_info,
609 OutputParams const & runparams)
612 for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
613 it != bibtex_info.end(); ++it) {
614 if (!biber && it->databases.empty())
618 string tmp = runparams.bibtex_command;
620 // onlyFileName() is needed for cygwin
621 tmp += quoteName(onlyFileName(removeExtension(
622 it->aux_file.absFileName())));
624 one.startscript(Systemcall::Wait, tmp, path, lpath);
626 // Return whether bibtex was run
631 int LaTeX::scanLogFile(TeXErrors & terr)
635 int retval = NO_ERRORS;
637 onlyFileName(changeExtension(file.absFileName(), ".log"));
638 LYXERR(Debug::LATEX, "Log file: " << tmp);
639 FileName const fn = FileName(makeAbsPath(tmp));
640 ifstream ifs(fn.toFilesystemEncoding().c_str());
641 bool fle_style = false;
642 static regex const file_line_error(".+\\.\\D+:[0-9]+: (.+)");
643 static regex const child_file(".*([0-9]+[A-Za-z]*_.+\\.tex).*");
644 // Flag for 'File ended while scanning' message.
645 // We need to wait for subsequent processing.
646 string wait_for_error;
649 stack <pair<string, int> > child;
652 while (getline(ifs, token)) {
653 // MikTeX sometimes inserts \0 in the log file. They can't be
654 // removed directly with the existing string utility
655 // functions, so convert them first to \r, and remove all
656 // \r's afterwards, since we need to remove them anyway.
657 token = subst(token, '\0', '\r');
658 token = subst(token, "\r", "");
661 LYXERR(Debug::LATEX, "Log line: " << token);
666 // Track child documents
667 for (size_t i = 0; i < token.length(); ++i) {
668 if (token[i] == '(') {
670 size_t j = token.find('(', i + 1);
671 size_t len = j == string::npos
672 ? token.substr(i + 1).length()
674 string const substr = token.substr(i + 1, len);
675 if (regex_match(substr, sub, child_file)) {
676 string const name = sub.str(1);
677 child.push(make_pair(name, pnest));
680 } else if (token[i] == ')') {
682 && child.top().second == pnest)
687 child_name = child.empty() ? empty_string() : child.top().first;
689 if (contains(token, "file:line:error style messages enabled"))
692 if (prefixIs(token, "LaTeX Warning:") ||
693 prefixIs(token, "! pdfTeX warning")) {
694 // Here shall we handle different
696 retval |= LATEX_WARNING;
697 LYXERR(Debug::LATEX, "LaTeX Warning.");
698 if (contains(token, "Rerun to get cross-references")) {
700 LYXERR(Debug::LATEX, "We should rerun.");
701 // package clefval needs 2 latex runs before bibtex
702 } else if (contains(token, "Value of")
703 && contains(token, "on page")
704 && contains(token, "undefined")) {
705 retval |= ERROR_RERUN;
706 LYXERR(Debug::LATEX, "Force rerun.");
708 } else if (contains(token, "Etaremune labels have changed")) {
709 retval |= ERROR_RERUN;
710 LYXERR(Debug::LATEX, "Force rerun.");
711 } else if (contains(token, "Citation")
712 && contains(token, "on page")
713 && contains(token, "undefined")) {
715 } else if (contains(token, "Citation")
716 && contains(token, "on input line")
717 && contains(token, "undefined")) {
720 } else if (prefixIs(token, "Package")) {
722 retval |= PACKAGE_WARNING;
723 if (contains(token, "natbib Warning:")) {
725 if (contains(token, "Citation")
726 && contains(token, "on page")
727 && contains(token, "undefined")) {
730 } else if (contains(token, "run BibTeX")) {
732 } else if (contains(token, "run Biber")) {
735 } else if (contains(token, "Rerun LaTeX") ||
736 contains(token, "Please rerun LaTeX") ||
737 contains(token, "Rerun to get")) {
738 // at least longtable.sty and bibtopic.sty
740 LYXERR(Debug::LATEX, "We should rerun.");
743 } else if (prefixIs(token, "LETTRE WARNING:")) {
744 if (contains(token, "veuillez recompiler")) {
746 LYXERR(Debug::LATEX, "We should rerun.");
749 } else if (token[0] == '(') {
750 if (contains(token, "Rerun LaTeX") ||
751 contains(token, "Rerun to get")) {
753 LYXERR(Debug::LATEX, "We should rerun.");
756 } else if (prefixIs(token, "! ")
758 && regex_match(token, sub, file_line_error)
759 && !contains(token, "pdfTeX warning"))) {
760 // Ok, we have something that looks like a TeX Error
761 // but what do we really have.
763 // Just get the error description:
765 if (prefixIs(token, "! "))
766 desc = string(token, 2);
769 if (contains(token, "LaTeX Error:"))
770 retval |= LATEX_ERROR;
772 if (prefixIs(token, "! File ended while scanning")){
773 if (prefixIs(token, "! File ended while scanning use of \\Hy@setref@link.")){
774 // bug 7344. We must rerun LaTeX if hyperref has been toggled.
775 retval |= ERROR_RERUN;
776 LYXERR(Debug::LATEX, "Force rerun.");
778 // bug 6445. At this point its not clear we finish with error.
779 wait_for_error = desc;
784 if (prefixIs(token, "! Paragraph ended before \\Hy@setref@link was complete.")){
785 // bug 7344. We must rerun LaTeX if hyperref has been toggled.
786 retval |= ERROR_RERUN;
787 LYXERR(Debug::LATEX, "Force rerun.");
790 if (!wait_for_error.empty() && prefixIs(token, "! Emergency stop.")){
791 retval |= LATEX_ERROR;
794 errstr = wait_for_error;
796 if (!getline(ifs, tmp))
798 tmp = rtrim(tmp, "\r");
799 errstr += "\n" + tmp;
802 } while (!contains(tmp, "(job aborted"));
805 from_local8bit("Emergency stop"),
806 from_local8bit(errstr),
814 if (!getline(ifs, tmp))
816 tmp = rtrim(tmp, "\r");
817 // 15 is somewhat arbitrarily chosen, based on practice.
818 // We used 10 for 14 years and increased it to 15 when we
822 } while (!prefixIs(tmp, "l."));
823 if (prefixIs(tmp, "l.")) {
824 // we have a latex error
827 "Package babel Error: You haven't defined the language")
829 "Package babel Error: You haven't loaded the option")
831 "Package babel Error: Unknown language"))
832 retval |= ERROR_RERUN;
833 // get the line number:
835 sscanf(tmp.c_str(), "l.%d", &line);
836 // get the rest of the message:
837 string errstr(tmp, tmp.find(' '));
840 tmp = rtrim(tmp, "\r");
841 while (!contains(errstr, "l.")
843 && !prefixIs(tmp, "! ")
844 && !contains(tmp, "(job aborted")) {
848 tmp = rtrim(tmp, "\r");
850 LYXERR(Debug::LATEX, "line: " << line << '\n'
851 << "Desc: " << desc << '\n' << "Text: " << errstr);
852 if (line == last_line)
858 if (line_count <= 5) {
860 // We have no idea what the encoding of
862 // It seems that the output from the
863 // latex compiler itself is pure ASCII,
864 // but it can include bits from the
865 // document, so whatever encoding we
866 // assume here it can be wrong.
867 terr.insertError(line,
868 from_local8bit(desc),
869 from_local8bit(errstr),
875 // information messages, TeX warnings and other
876 // warnings we have not caught earlier.
877 if (prefixIs(token, "Overfull ")) {
878 retval |= TEX_WARNING;
879 } else if (prefixIs(token, "Underfull ")) {
880 retval |= TEX_WARNING;
881 } else if (contains(token, "Rerun to get citations")) {
882 // Natbib seems to use this.
884 } else if (contains(token, "No pages of output")
885 || contains(token, "no pages of output")) {
886 // No output file (e.g. the DVI or PDF) was created
888 } else if (contains(token, "That makes 100 errors")) {
889 // More than 100 errors were reprted
890 retval |= TOO_MANY_ERRORS;
891 } else if (prefixIs(token, "!pdfTeX error:")) {
892 // otherwise we dont catch e.g.:
893 // !pdfTeX error: pdflatex (file feyn10): Font feyn10 at 600 not found
896 from_local8bit("pdfTeX Error"),
897 from_local8bit(token),
899 } else if (!ignore_missing_glyphs
900 && prefixIs(token, "Missing character: There is no ")
901 && !contains(token, "nullfont")) {
902 // Warning about missing glyph in selected font
903 // may be dataloss (bug 9610)
904 // but can be ignored for 'nullfont' (bug 10394).
905 retval |= LATEX_ERROR;
907 from_local8bit("Missing glyphs!"),
908 from_local8bit(token),
913 LYXERR(Debug::LATEX, "Log line: " << token);
920 bool insertIfExists(FileName const & absname, DepTable & head)
922 if (absname.exists() && !absname.isDirectory()) {
923 head.insert(absname, true);
930 bool handleFoundFile(string const & ff, DepTable & head)
932 // convert from native os path to unix path
933 string foundfile = os::internal_path(trim(ff));
935 LYXERR(Debug::DEPEND, "Found file: " << foundfile);
937 // Ok now we found a file.
938 // Now we should make sure that this is a file that we can
939 // access through the normal paths.
940 // We will not try any fancy search methods to
943 // (1) foundfile is an
944 // absolute path and should
947 if (FileName::isAbsolute(foundfile)) {
948 LYXERR(Debug::DEPEND, "AbsolutePath file: " << foundfile);
949 // On initial insert we want to do the update at once
950 // since this file cannot be a file generated by
952 absname.set(foundfile);
953 if (!insertIfExists(absname, head)) {
955 string strippedfile = foundfile;
956 while (contains(strippedfile, " ")) {
957 // files with spaces are often enclosed in quotation
958 // marks; those have to be removed
959 string unquoted = subst(strippedfile, "\"", "");
960 absname.set(unquoted);
961 if (insertIfExists(absname, head))
963 // strip off part after last space and try again
964 string tmp = strippedfile;
965 rsplit(tmp, strippedfile, ' ');
966 absname.set(strippedfile);
967 if (insertIfExists(absname, head))
973 string onlyfile = onlyFileName(foundfile);
974 absname = makeAbsPath(onlyfile);
977 while (contains(foundfile, ' ')) {
978 if (absname.exists())
982 // files with spaces are often enclosed in quotation
983 // marks; those have to be removed
984 string unquoted = subst(foundfile, "\"", "");
985 absname = makeAbsPath(unquoted);
986 if (absname.exists())
988 // strip off part after last space and try again
990 rsplit(foundfile, strippedfile, ' ');
991 foundfile = strippedfile;
992 onlyfile = onlyFileName(strippedfile);
993 absname = makeAbsPath(onlyfile);
997 // (2) foundfile is in the tmpdir
998 // insert it into head
999 if (absname.exists() && !absname.isDirectory()) {
1000 // FIXME: This regex contained glo, but glo is used by the old
1001 // version of nomencl.sty. Do we need to put it back?
1002 static regex const unwanted("^.*\\.(aux|log|dvi|bbl|ind)$");
1003 if (regex_match(onlyfile, unwanted)) {
1004 LYXERR(Debug::DEPEND, "We don't want " << onlyfile
1005 << " in the dep file");
1006 } else if (suffixIs(onlyfile, ".tex")) {
1007 // This is a tex file generated by LyX
1008 // and latex is not likely to change this
1010 LYXERR(Debug::DEPEND, "Tmpdir TeX file: " << onlyfile);
1011 head.insert(absname, true);
1013 LYXERR(Debug::DEPEND, "In tmpdir file:" << onlyfile);
1014 head.insert(absname);
1018 LYXERR(Debug::DEPEND, "Not a file or we are unable to find it.");
1024 bool completeFilename(string const & ff, DepTable & head)
1026 // If we do not find a dot, we suspect
1027 // a fragmental file name
1028 if (!contains(ff, '.'))
1031 // if we have a dot, we let handleFoundFile decide
1032 return handleFoundFile(ff, head);
1036 int iterateLine(string const & token, regex const & reg, string const & closing,
1037 int fragment_pos, DepTable & head)
1040 string::const_iterator first = token.begin();
1041 string::const_iterator end = token.end();
1042 bool fragment = false;
1045 while (regex_search(first, end, what, reg)) {
1046 // if we have a dot, try to handle as file
1047 if (contains(what.str(1), '.')) {
1048 first = what[0].second;
1049 if (what.str(2) == closing) {
1050 handleFoundFile(what.str(1), head);
1051 // since we had a closing bracket,
1052 // do not investigate further
1055 // if we have no closing bracket,
1056 // try to handle as file nevertheless
1057 fragment = !handleFoundFile(
1058 what.str(1) + what.str(2), head);
1060 // if we do not have a dot, check if the line has
1061 // a closing bracket (else, we suspect a line break)
1062 else if (what.str(2) != closing) {
1063 first = what[0].second;
1066 // we have a closing bracket, so the content
1067 // is not a file name.
1068 // no need to investigate further
1069 first = what[0].second;
1072 last_match = what.str(1);
1075 // We need to consider the result from previous line iterations:
1076 // We might not find a fragment here, but another one might follow
1077 // E.g.: (filename.ext) <filenam
1078 // Vice versa, we consider the search completed if a real match
1079 // follows a potential fragment from a previous iteration.
1080 // E.g. <some text we considered a fragment (filename.ext)
1081 // result = -1 means we did not find a fragment!
1083 int last_match_pos = -1;
1084 if (!last_match.empty() && token.find(last_match) != string::npos)
1085 last_match_pos = int(token.find(last_match));
1087 if (last_match_pos > fragment_pos)
1088 result = last_match_pos;
1090 result = fragment_pos;
1092 if (last_match_pos < fragment_pos)
1093 result = fragment_pos;
1101 void LaTeX::deplog(DepTable & head)
1103 // This function reads the LaTeX log file end extracts all the
1104 // external files used by the LaTeX run. The files are then
1105 // entered into the dependency file.
1107 string const logfile =
1108 onlyFileName(changeExtension(file.absFileName(), ".log"));
1110 static regex const reg1("File: (.+).*");
1111 static regex const reg2("No file (.+)(.).*");
1112 static regex const reg3("\\\\openout[0-9]+.*=.*`(.+)(..).*");
1113 // If an index should be created, MikTex does not write a line like
1114 // \openout# = 'sample.idx'.
1115 // but instead only a line like this into the log:
1116 // Writing index file sample.idx
1117 static regex const reg4("Writing index file (.+).*");
1118 static regex const regoldnomencl("Writing glossary file (.+).*");
1119 static regex const regnomencl("Writing nomenclature file (.+).*");
1120 // If a toc should be created, MikTex does not write a line like
1121 // \openout# = `sample.toc'.
1122 // but only a line like this into the log:
1124 // This line is also written by tetex.
1125 // This line is not present if no toc should be created.
1126 static regex const miktexTocReg("\\\\tf@toc=\\\\write.*");
1127 // file names can be enclosed in <...> (anywhere on the line)
1128 static regex const reg5(".*<[^>]+.*");
1129 // and also (...) anywhere on the line
1130 static regex const reg6(".*\\([^)]+.*");
1132 FileName const fn = makeAbsPath(logfile);
1133 ifstream ifs(fn.toFilesystemEncoding().c_str());
1136 // Ok, the scanning of files here is not sufficient.
1137 // Sometimes files are named by "File: xxx" only
1138 // Therefore we use some regexps to find files instead.
1139 // Note: all file names and paths might contains spaces.
1140 // Also, file names might be broken across lines. Therefore
1141 // we mark (potential) fragments and merge those lines.
1142 bool fragment = false;
1144 getline(ifs, token);
1145 // MikTeX sometimes inserts \0 in the log file. They can't be
1146 // removed directly with the existing string utility
1147 // functions, so convert them first to \r, and remove all
1148 // \r's afterwards, since we need to remove them anyway.
1149 token = subst(token, '\0', '\r');
1150 token = subst(token, "\r", "");
1151 if (token.empty() || token == ")") {
1152 lastline = string();
1156 // FIXME UNICODE: We assume that the file names in the log
1157 // file are in the file system encoding.
1158 token = to_utf8(from_filesystem8bit(token));
1160 // Sometimes, filenames are broken across lines.
1161 // We care for that and save suspicious lines.
1162 // Here we exclude some cases where we are sure
1163 // that there is no continued filename
1164 if (!lastline.empty()) {
1165 static regex const package_info("Package \\w+ Info: .*");
1166 static regex const package_warning("Package \\w+ Warning: .*");
1167 if (prefixIs(token, "File:") || prefixIs(token, "(Font)")
1168 || prefixIs(token, "Package:")
1169 || prefixIs(token, "Language:")
1170 || prefixIs(token, "LaTeX Info:")
1171 || prefixIs(token, "LaTeX Font Info:")
1172 || prefixIs(token, "\\openout[")
1173 || prefixIs(token, "))")
1174 || regex_match(token, package_info)
1175 || regex_match(token, package_warning))
1176 lastline = string();
1179 if (!lastline.empty())
1180 // probably a continued filename from last line
1181 token = lastline + token;
1182 if (token.length() > 255) {
1183 // string too long. Cut off.
1184 token.erase(0, token.length() - 251);
1189 // (1) "File: file.ext"
1190 if (regex_match(token, sub, reg1)) {
1191 // is this a fragmental file name?
1192 fragment = !completeFilename(sub.str(1), head);
1194 if (suffixIs(token, ")"))
1195 // no fragment for sure
1197 // (2) "No file file.ext"
1198 } else if (regex_match(token, sub, reg2)) {
1199 // file names must contains a dot, line ends with dot
1200 if (contains(sub.str(1), '.') && sub.str(2) == ".")
1201 fragment = !handleFoundFile(sub.str(1), head);
1203 // we suspect a line break
1205 // (3) "\openout<nr> = `file.ext'."
1206 } else if (regex_match(token, sub, reg3)) {
1207 // search for closing '. at the end of the line
1208 if (sub.str(2) == "\'.")
1209 fragment = !handleFoundFile(sub.str(1), head);
1211 // potential fragment
1213 // (4) "Writing index file file.ext"
1214 } else if (regex_match(token, sub, reg4))
1215 // fragmential file name?
1216 fragment = !completeFilename(sub.str(1), head);
1217 // (5) "Writing nomenclature file file.ext"
1218 else if (regex_match(token, sub, regnomencl) ||
1219 regex_match(token, sub, regoldnomencl))
1220 // fragmental file name?
1221 fragment= !completeFilename(sub.str(1), head);
1222 // (6) "\tf@toc=\write<nr>" (for MikTeX)
1223 else if (regex_match(token, sub, miktexTocReg))
1224 fragment = !handleFoundFile(onlyFileName(changeExtension(
1225 file.absFileName(), ".toc")), head);
1227 // not found, but we won't check further
1230 int fragment_pos = -1;
1232 // We can have several of these on one line
1233 // (and in addition to those above)
1234 if (regex_match(token, sub, reg5)) {
1235 // search for strings in <...>
1236 static regex const reg5_1("<([^>]+)(.)");
1237 fragment_pos = iterateLine(token, reg5_1, ">",
1238 fragment_pos, head);
1239 fragment = (fragment_pos != -1);
1243 // We can have several of these on one line
1244 // this must be queried separated, because of
1245 // cases such as "File: file.ext (type eps)"
1246 // where "File: file.ext" would be skipped
1247 if (regex_match(token, sub, reg6)) {
1248 // search for strings in (...)
1249 static regex const reg6_1("\\(([^()]+)(.)");
1250 fragment_pos = iterateLine(token, reg6_1, ")",
1251 fragment_pos, head);
1252 fragment = (fragment_pos != -1);
1256 // probable linebreak within file name:
1260 // no linebreak: reset
1261 lastline = string();
1264 // Make sure that the main .tex file is in the dependency file.
1265 head.insert(file, true);
1269 int LaTeX::scanBlgFile(DepTable & dep, TeXErrors & terr)
1271 FileName const blg_file(changeExtension(file.absFileName(), "blg"));
1272 LYXERR(Debug::LATEX, "Scanning blg file: " << blg_file);
1274 ifstream ifs(blg_file.toFilesystemEncoding().c_str());
1276 static regex const reg1(".*Found (bibtex|BibTeX) data (file|source) '([^']+).*");
1277 static regex const bibtexError("^(.*---line [0-9]+ of file).*$");
1278 static regex const bibtexError2("^(.*---while reading file).*$");
1279 static regex const bibtexError3("(A bad cross reference---).*");
1280 static regex const bibtexError4("(Sorry---you've exceeded BibTeX's).*");
1281 static regex const bibtexError5("\\*Please notify the BibTeX maintainer\\*");
1282 static regex const biberError("^.*> (FATAL|ERROR) - (.*)$");
1283 int retval = NO_ERRORS;
1286 while (getline(ifs, token)) {
1287 token = rtrim(token, "\r");
1289 // FIXME UNICODE: We assume that citation keys and filenames
1290 // in the aux file are in the file system encoding.
1291 token = to_utf8(from_filesystem8bit(token));
1292 if (regex_match(token, sub, reg1)) {
1293 string data = sub.str(3);
1294 if (!data.empty()) {
1295 LYXERR(Debug::LATEX, "Found bib file: " << data);
1296 handleFoundFile(data, dep);
1299 else if (regex_match(token, sub, bibtexError)
1300 || regex_match(token, sub, bibtexError2)
1301 || regex_match(token, sub, bibtexError4)
1302 || regex_match(token, sub, bibtexError5)) {
1303 retval |= BIBTEX_ERROR;
1304 string errstr = N_("BibTeX error: ") + token;
1306 if ((prefixIs(token, "while executing---line")
1307 || prefixIs(token, "---line ")
1308 || prefixIs(token, "*Please notify the BibTeX"))
1309 && !prevtoken.empty()) {
1310 errstr = N_("BibTeX error: ") + prevtoken;
1311 message = prevtoken + '\n';
1315 from_local8bit(errstr),
1316 from_local8bit(message));
1317 } else if (regex_match(prevtoken, sub, bibtexError3)) {
1318 retval |= BIBTEX_ERROR;
1319 string errstr = N_("BibTeX error: ") + prevtoken;
1320 string message = prevtoken + '\n' + token;
1322 from_local8bit(errstr),
1323 from_local8bit(message));
1324 } else if (regex_match(token, sub, biberError)) {
1325 retval |= BIBTEX_ERROR;
1326 string errstr = N_("Biber error: ") + sub.str(2);
1327 string message = token;
1329 from_local8bit(errstr),
1330 from_local8bit(message));