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
12 * Full author contact details are available in file CREDITS.
18 #include "bufferlist.h"
23 #include "support/filetools.h"
24 #include "support/convert.h"
25 #include "support/lstrings.h"
26 #include "support/lyxlib.h"
27 #include "support/systemcall.h"
28 #include "support/os.h"
30 #include <boost/filesystem/operations.hpp>
31 #include <boost/regex.hpp>
35 using lyx::support::absolutePath;
36 using lyx::support::bformat;
37 using lyx::support::changeExtension;
38 using lyx::support::contains;
39 using lyx::support::findtexfile;
40 using lyx::support::getcwd;
41 using lyx::support::onlyFilename;
42 using lyx::support::prefixIs;
43 using lyx::support::quoteName;
44 using lyx::support::rtrim;
45 using lyx::support::split;
46 using lyx::support::subst;
47 using lyx::support::suffixIs;
48 using lyx::support::Systemcall;
49 using lyx::support::unlink;
50 using lyx::support::trim;
52 namespace os = lyx::support::os;
53 namespace fs = boost::filesystem;
59 #ifndef CXX_GLOBAL_CSTD
70 // TODO: in no particular order
71 // - get rid of the extern BufferList and the call to
72 // BufferList::updateIncludedTeXfiles, this should either
73 // be done before calling LaTeX::funcs or in a completely
75 // - the makeindex style files should be taken care of with
76 // the dependency mechanism.
77 // - makeindex commandline options should be supported
78 // - somewhere support viewing of bibtex and makeindex log files.
79 // - we should perhaps also scan the bibtex log file
81 extern BufferList bufferlist;
85 string runMessage(unsigned int count)
87 return bformat(_("Waiting for LaTeX run number %1$d"), count);
96 void TeXErrors::insertError(int line, string const & error_desc,
97 string const & error_text)
99 Error newerr(line, error_desc, error_text);
100 errors.push_back(newerr);
104 bool operator==(Aux_Info const & a, Aux_Info const & o)
106 return a.aux_file == o.aux_file &&
107 a.citations == o.citations &&
108 a.databases == o.databases &&
109 a.styles == o.styles;
113 bool operator!=(Aux_Info const & a, Aux_Info const & o)
123 LaTeX::LaTeX(string const & latex, OutputParams const & rp,
124 string const & f, string const & p)
125 : cmd(latex), file(f), path(p), runparams(rp)
128 depfile = file + ".dep";
129 if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
131 output_file = changeExtension(file,".pdf");
133 output_file = changeExtension(file,".dvi");
138 void LaTeX::deleteFilesOnError() const
140 // currently just a dummy function.
142 // What files do we have to delete?
144 // This will at least make latex do all the runs
147 // but the reason for the error might be in a generated file...
149 string const ofname = onlyFilename(file);
152 string const bbl = changeExtension(ofname, ".bbl");
156 string const ind = changeExtension(ofname, ".ind");
159 // Also remove the aux file
160 string const aux = changeExtension(ofname, ".aux");
165 int LaTeX::run(TeXErrors & terr)
166 // We know that this function will only be run if the lyx buffer
167 // has been changed. We also know that a newly written .tex file
168 // is always different from the previous one because of the date
169 // in it. However it seems safe to run latex (at least) on time each
170 // time the .tex file changes.
172 int scanres = NO_ERRORS;
173 unsigned int count = 0; // number of times run
174 num_errors = 0; // just to make sure.
175 unsigned int const MAX_RUN = 6;
176 DepTable head; // empty head
177 bool rerun = false; // rerun requested
179 // The class LaTeX does not know the temp path.
180 bufferlist.updateIncludedTeXfiles(getcwd(), runparams);
182 // Never write the depfile if an error was encountered.
185 // first check if the file dependencies exist:
186 // ->If it does exist
187 // check if any of the files mentioned in it have
188 // changed (done using a checksum).
190 // run latex once and
191 // remake the dependency file
192 // -> if not changed:
193 // just return there is nothing to do for us.
194 // ->if it doesn't exist
196 // run latex once (we need to run latex once anyway) and
197 // remake the dependency file.
200 bool had_depfile = fs::exists(depfile);
201 bool run_bibtex = false;
202 string aux_file = onlyFilename(changeExtension(file, "aux"));
205 lyxerr[Debug::DEPEND] << "Dependency file exists" << endl;
206 // Read the dep file:
207 had_depfile = head.read(depfile);
211 // Update the checksums
213 // Can't just check if anything has changed because it might have aborted
214 // on error last time... in which cas we need to re-run latex
215 // and collect the error messages (even if they are the same).
216 if (!fs::exists(output_file)) {
217 lyxerr[Debug::DEPEND]
218 << "re-running LaTeX because output file doesn't exist." << endl;
219 } else if (!head.sumchange()) {
220 lyxerr[Debug::DEPEND] << "return no_change" << endl;
223 lyxerr[Debug::DEPEND]
224 << "Dependency file has changed" << endl;
227 if (head.extchanged(".bib") || head.extchanged(".bst"))
230 lyxerr[Debug::DEPEND]
231 << "Dependency file does not exist, or has wrong format" << endl;
233 /// We scan the aux file even when had_depfile = false,
234 /// because we can run pdflatex on the file after running latex on it,
235 /// in which case we will not need to run bibtex again.
236 vector<Aux_Info> bibtex_info_old;
238 bibtex_info_old = scanAuxFiles(aux_file);
241 lyxerr[Debug::LATEX] << "Run #" << count << endl;
242 message(runMessage(count));
245 scanres = scanLogFile(terr);
246 if (scanres & ERROR_RERUN) {
247 lyxerr[Debug::LATEX] << "Rerunning LaTeX" << endl;
249 scanres = scanLogFile(terr);
252 if (scanres & ERRORS) {
253 deleteFilesOnError();
254 return scanres; // return on error
257 vector<Aux_Info> const bibtex_info = scanAuxFiles(aux_file);
258 if (!run_bibtex && bibtex_info_old != bibtex_info)
261 // update the dependencies.
262 deplog(head); // reads the latex log
266 // At this point we must run external programs if needed.
267 // makeindex will be run if a .idx file changed or was generated.
268 // And if there were undefined citations or changes in references
269 // the .aux file is checked for signs of bibtex. Bibtex is then run
272 // memoir (at least) writes an empty *idx file in the first place.
273 // A second latex run is needed.
274 rerun = fs::exists(changeExtension(file, ".idx"))
275 && fs::is_empty(changeExtension(file, ".idx"));
278 if (head.haschanged(onlyFilename(changeExtension(file, ".idx")))) {
280 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
281 message(_("Running MakeIndex."));
282 rerun |= runMakeIndex(onlyFilename(changeExtension(file, ".idx")), runparams);
286 // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
287 if (scanres & UNDEF_CIT || run_bibtex) {
288 // Here we must scan the .aux file and look for
289 // "\bibdata" and/or "\bibstyle". If one of those
290 // tags is found -> run bibtex and set rerun = true;
292 lyxerr[Debug::LATEX] << "Running BibTeX." << endl;
293 message(_("Running BibTeX."));
294 updateBibtexDependencies(head, bibtex_info);
295 rerun |= runBibTeX(bibtex_info);
296 } else if (!had_depfile) {
297 /// If we run pdflatex on the file after running latex on it,
298 /// then we do not need to run bibtex, but we do need to
299 /// insert the .bib and .bst files into the .dep-pdf file.
300 updateBibtexDependencies(head, bibtex_info);
304 // we know on this point that latex has been run once (or we just
305 // returned) and the question now is to decide if we need to run
306 // it any more. This is done by asking if any of the files in the
307 // dependency file has changed. (remember that the checksum for
308 // a given file is reported to have changed if it just was created)
309 // -> if changed or rerun == true:
310 // run latex once more and
311 // update the dependency structure
312 // -> if not changed:
313 // we does nothing at this point
315 if (rerun || head.sumchange()) {
318 lyxerr[Debug::DEPEND]
319 << "Dep. file has changed or rerun requested" << endl;
321 << "Run #" << count << endl;
322 message(runMessage(count));
324 scanres = scanLogFile(terr);
325 if (scanres & ERRORS) {
326 deleteFilesOnError();
327 return scanres; // return on error
330 // update the depedencies
331 deplog(head); // reads the latex log
334 lyxerr[Debug::DEPEND] << "Dep. file has NOT changed" << endl;
338 // The inclusion of files generated by external programs like
339 // makeindex or bibtex might have done changes to pagenumbering,
340 // etc. And because of this we must run the external programs
341 // again to make sure everything is redone correctly.
342 // Also there should be no need to run the external programs any
345 // run makeindex if the <file>.idx has changed or was generated.
346 if (head.haschanged(onlyFilename(changeExtension(file, ".idx")))) {
348 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
349 message(_("Running MakeIndex."));
350 rerun = runMakeIndex(onlyFilename(changeExtension(file, ".idx")), runparams);
354 // we will only run latex more if the log file asks for it.
355 // or if the sumchange() is true.
356 // -> rerun asked for:
358 // remake the dependency file
359 // goto 2 or return if max runs are reached.
360 // -> rerun not asked for:
361 // just return (fall out of bottom of func)
363 while ((head.sumchange() || rerun || (scanres & RERUN))
364 && count < MAX_RUN) {
365 // Yes rerun until message goes away, or until
366 // MAX_RUNS are reached.
369 lyxerr[Debug::LATEX] << "Run #" << count << endl;
370 message(runMessage(count));
372 scanres = scanLogFile(terr);
373 if (scanres & ERRORS) {
374 deleteFilesOnError();
375 return scanres; // return on error
382 // Write the dependencies to file.
384 lyxerr[Debug::LATEX] << "Done." << endl;
389 int LaTeX::startscript()
391 string tmp = cmd + ' ' + quoteName(file) + " > " + os::nulldev();
393 return one.startscript(Systemcall::Wait, tmp);
397 bool LaTeX::runMakeIndex(string const & f, OutputParams const & runparams)
399 lyxerr[Debug::LATEX] << "idx file has been made,"
400 " running makeindex on file "
402 string tmp = lyxrc.index_command + " ";
403 tmp = subst(tmp, "$$lang", runparams.document_language);
406 one.startscript(Systemcall::Wait, tmp);
411 vector<Aux_Info> const
412 LaTeX::scanAuxFiles(string const & file)
414 vector<Aux_Info> result;
416 result.push_back(scanAuxFile(file));
418 for (int i = 1; i < 1000; ++i) {
419 string const file2 = changeExtension(file, "")
420 + '.' + convert<string>(i)
422 if (!fs::exists(file2))
424 result.push_back(scanAuxFile(file2));
430 Aux_Info const LaTeX::scanAuxFile(string const & file)
433 result.aux_file = file;
434 scanAuxFile(file, result);
439 void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info)
441 lyxerr[Debug::LATEX] << "Scanning aux file: " << file << endl;
443 ifstream ifs(file.c_str());
445 static regex const reg1("\\\\citation\\{([^}]+)\\}");
446 static regex const reg2("\\\\bibdata\\{([^}]+)\\}");
447 static regex const reg3("\\\\bibstyle\\{([^}]+)\\}");
448 static regex const reg4("\\\\@input\\{([^}]+)\\}");
450 while (getline(ifs, token)) {
451 token = rtrim(token, "\r");
453 if (regex_match(token, sub, reg1)) {
454 string data = sub.str(1);
455 while (!data.empty()) {
457 data = split(data, citation, ',');
458 lyxerr[Debug::LATEX] << "Citation: "
460 aux_info.citations.insert(citation);
462 } else if (regex_match(token, sub, reg2)) {
463 string data = sub.str(1);
464 // data is now all the bib files separated by ','
465 // get them one by one and pass them to the helper
466 while (!data.empty()) {
468 data = split(data, database, ',');
469 database = changeExtension(database, "bib");
470 lyxerr[Debug::LATEX] << "BibTeX database: `"
471 << database << '\'' << endl;
472 aux_info.databases.insert(database);
474 } else if (regex_match(token, sub, reg3)) {
475 string style = sub.str(1);
476 // token is now the style file
477 // pass it to the helper
478 style = changeExtension(style, "bst");
479 lyxerr[Debug::LATEX] << "BibTeX style: `"
480 << style << '\'' << endl;
481 aux_info.styles.insert(style);
482 } else if (regex_match(token, sub, reg4)) {
483 string const file2 = sub.str(1);
484 scanAuxFile(file2, aux_info);
490 void LaTeX::updateBibtexDependencies(DepTable & dep,
491 vector<Aux_Info> const & bibtex_info)
493 // Since a run of Bibtex mandates more latex runs it is ok to
494 // remove all ".bib" and ".bst" files.
495 dep.remove_files_with_extension(".bib");
496 dep.remove_files_with_extension(".bst");
497 //string aux = OnlyFilename(ChangeExtension(file, ".aux"));
499 for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
500 it != bibtex_info.end(); ++it) {
501 for (set<string>::const_iterator it2 = it->databases.begin();
502 it2 != it->databases.end(); ++it2) {
503 string file = findtexfile(*it2, "bib");
505 dep.insert(file, true);
508 for (set<string>::const_iterator it2 = it->styles.begin();
509 it2 != it->styles.end(); ++it2) {
510 string file = findtexfile(*it2, "bst");
512 dep.insert(file, true);
518 bool LaTeX::runBibTeX(vector<Aux_Info> const & bibtex_info)
521 for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
522 it != bibtex_info.end(); ++it) {
523 if (it->databases.empty())
527 string tmp = lyxrc.bibtex_command + " ";
528 tmp += quoteName(onlyFilename(changeExtension(it->aux_file, string())));
530 one.startscript(Systemcall::Wait, tmp);
532 // Return whether bibtex was run
537 int LaTeX::scanLogFile(TeXErrors & terr)
541 int retval = NO_ERRORS;
542 string tmp = onlyFilename(changeExtension(file, ".log"));
543 lyxerr[Debug::LATEX] << "Log file: " << tmp << endl;
544 ifstream ifs(tmp.c_str());
547 while (getline(ifs, token)) {
548 // MikTeX sometimes inserts \0 in the log file. They can't be
549 // removed directly with the existing string utility
550 // functions, so convert them first to \r, and remove all
551 // \r's afterwards, since we need to remove them anyway.
552 token = subst(token, '\0', '\r');
553 token = subst(token, "\r", "");
555 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
560 if (prefixIs(token, "LaTeX Warning:") ||
561 prefixIs(token, "! pdfTeX warning")) {
562 // Here shall we handle different
564 retval |= LATEX_WARNING;
565 lyxerr[Debug::LATEX] << "LaTeX Warning." << endl;
566 if (contains(token, "Rerun to get cross-references")) {
569 << "We should rerun." << endl;
570 } else if (contains(token, "Citation")
571 && contains(token, "on page")
572 && contains(token, "undefined")) {
575 } else if (prefixIs(token, "Package")) {
577 retval |= PACKAGE_WARNING;
578 if (contains(token, "natbib Warning:")) {
580 if (contains(token, "Citation")
581 && contains(token, "on page")
582 && contains(token, "undefined")) {
585 } else if (contains(token, "run BibTeX")) {
587 } else if (contains(token, "Rerun LaTeX") ||
588 contains(token, "Rerun to get")) {
589 // at least longtable.sty and bibtopic.sty
592 << "We should rerun." << endl;
595 } else if (token[0] == '(') {
596 if (contains(token, "Rerun LaTeX") ||
597 contains(token, "Rerun to get")) {
600 << "We should rerun." << endl;
603 } else if (prefixIs(token, "! ")) {
604 // Ok, we have something that looks like a TeX Error
605 // but what do we really have.
607 // Just get the error description:
608 string desc(token, 2);
609 if (contains(token, "LaTeX Error:"))
610 retval |= LATEX_ERROR;
615 if (!getline(ifs, tmp))
619 } while (!prefixIs(tmp, "l."));
620 if (prefixIs(tmp, "l.")) {
621 // we have a latex error
623 if (contains(desc, "Package babel Error: You haven't defined the language"))
624 retval |= ERROR_RERUN;
625 // get the line number:
627 sscanf(tmp.c_str(), "l.%d", &line);
628 // get the rest of the message:
629 string errstr(tmp, tmp.find(' '));
632 while (!contains(errstr, "l.")
634 && !prefixIs(tmp, "! ")
635 && !contains(tmp, "(job aborted")) {
641 << "line: " << line << '\n'
642 << "Desc: " << desc << '\n'
643 << "Text: " << errstr << endl;
644 if (line == last_line)
650 if (line_count <= 5) {
651 terr.insertError(line, desc, errstr);
656 // information messages, TeX warnings and other
657 // warnings we have not caught earlier.
658 if (prefixIs(token, "Overfull ")) {
659 retval |= TEX_WARNING;
660 } else if (prefixIs(token, "Underfull ")) {
661 retval |= TEX_WARNING;
662 } else if (contains(token, "Rerun to get citations")) {
663 // Natbib seems to use this.
665 } else if (contains(token, "No pages of output")) {
666 // A dvi file was not created
668 } else if (contains(token, "That makes 100 errors")) {
669 // More than 100 errors were reprted
670 retval |= TOO_MANY_ERRORS;
674 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
681 void handleFoundFile(string const & ff, DepTable & head)
683 // convert from native os path to unix path
684 string const foundfile = os::internal_path(trim(ff));
686 lyxerr[Debug::DEPEND] << "Found file: " << foundfile << endl;
688 // Ok now we found a file.
689 // Now we should make sure that this is a file that we can
690 // access through the normal paths.
691 // We will not try any fancy search methods to
694 // (1) foundfile is an
695 // absolute path and should
697 if (absolutePath(foundfile)) {
698 lyxerr[Debug::DEPEND] << "AbsolutePath file: "
699 << foundfile << endl;
700 // On initial insert we want to do the update at once
701 // since this file can not be a file generated by
703 if (fs::exists(foundfile) && !fs::is_directory(foundfile))
704 head.insert(foundfile, true);
709 string const onlyfile = onlyFilename(foundfile);
711 // (2) foundfile is in the tmpdir
712 // insert it into head
713 if (fs::exists(onlyfile)) {
714 static regex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$");
715 if (regex_match(onlyfile, unwanted)) {
716 lyxerr[Debug::DEPEND]
719 << " in the dep file"
721 } else if (suffixIs(onlyfile, ".tex")) {
722 // This is a tex file generated by LyX
723 // and latex is not likely to change this
725 lyxerr[Debug::DEPEND]
726 << "Tmpdir TeX file: "
729 head.insert(onlyfile, true);
731 lyxerr[Debug::DEPEND]
735 head.insert(onlyfile);
738 lyxerr[Debug::DEPEND]
739 << "Not a file or we are unable to find it."
746 void LaTeX::deplog(DepTable & head)
748 // This function reads the LaTeX log file end extracts all the external
749 // files used by the LaTeX run. The files are then entered into the
752 string const logfile = onlyFilename(changeExtension(file, ".log"));
754 static regex reg1(".*\\([^)]+.*");
755 static regex reg2("File: ([^ ]+).*");
756 static regex reg3("No file ([^ ]+)\\..*");
757 static regex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*");
758 // If an index should be created, MikTex does not write a line like
759 // \openout# = 'sample,idx'.
760 // but intstead only a line like this into the log:
761 // Writing index file sample.idx
762 static regex reg5("Writing index file ([^ ]+).*");
764 ifstream ifs(logfile.c_str());
766 // Ok, the scanning of files here is not sufficient.
767 // Sometimes files are named by "File: xxx" only
768 // So I think we should use some regexps to find files instead.
769 // "(\([^ ]+\)" should match the "(file " variant, note
770 // that we can have several of these on one line.
771 // "File: \([^ ]+\)" should match the "File: file" variant
775 // MikTeX sometimes inserts \0 in the log file. They can't be
776 // removed directly with the existing string utility
777 // functions, so convert them first to \r, and remove all
778 // \r's afterwards, since we need to remove them anyway.
779 token = subst(token, '\0', '\r');
780 token = subst(token, "\r", "");
786 if (regex_match(token, sub, reg1)) {
787 static regex reg1_1("\\(([^()]+)");
789 string::const_iterator first = token.begin();
790 string::const_iterator end = token.end();
792 while (regex_search(first, end, what, reg1_1)) {
793 first = what[0].second;
794 handleFoundFile(what.str(1), head);
796 } else if (regex_match(token, sub, reg2)) {
797 handleFoundFile(sub.str(1), head);
798 } else if (regex_match(token, sub, reg3)) {
799 handleFoundFile(sub.str(1), head);
800 } else if (regex_match(token, sub, reg4)) {
801 handleFoundFile(sub.str(1), head);
802 } else if (regex_match(token, sub, reg5)) {
803 handleFoundFile(sub.str(1), head);
807 // Make sure that the main .tex file is in the dependancy file.
808 head.insert(onlyFilename(file), true);