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"
22 #include "support/filetools.h"
23 #include "support/FileInfo.h"
24 #include "support/tostr.h"
25 #include "support/lstrings.h"
26 #include "support/lyxlib.h"
27 #include "support/systemcall.h"
28 #include "support/os.h"
30 #include <boost/regex.hpp>
34 using lyx::support::AbsolutePath;
35 using lyx::support::bformat;
36 using lyx::support::ChangeExtension;
37 using lyx::support::contains;
38 using lyx::support::FileInfo;
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::suffixIs;
47 using lyx::support::Systemcall;
48 using lyx::support::unlink;
50 namespace os = lyx::support::os;
56 #ifndef CXX_GLOBAL_CSTD
67 // TODO: in no particular order
68 // - get rid of the extern BufferList and the call to
69 // BufferList::updateIncludedTeXfiles, this should either
70 // be done before calling LaTeX::funcs or in a completely
72 // - the bibtex command options should be supported.
73 // - the makeindex style files should be taken care of with
74 // the dependency mechanism.
75 // - makeindex commandline options should be supported
76 // - somewhere support viewing of bibtex and makeindex log files.
77 // - we should perhaps also scan the bibtex log file
78 // - we should perhaps also scan the bibtex log file
80 extern BufferList bufferlist;
84 string runMessage(unsigned int count)
86 return bformat(_("Waiting for LaTeX run number %1$s"), tostr(count));
95 void TeXErrors::insertError(int line, string const & error_desc,
96 string const & error_text)
98 Error newerr(line, error_desc, error_text);
99 errors.push_back(newerr);
103 bool operator==(Aux_Info const & a, Aux_Info const & o)
105 return a.aux_file == o.aux_file &&
106 a.citations == o.citations &&
107 a.databases == o.databases &&
108 a.styles == o.styles;
112 bool operator!=(Aux_Info const & a, Aux_Info const & o)
122 LaTeX::LaTeX(string const & latex, LatexRunParams const & rp,
123 string const & f, string const & p)
124 : cmd(latex), file(f), path(p), runparams(rp)
127 depfile = file + ".dep";
128 if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
130 output_file = ChangeExtension(file,".pdf");
132 output_file = ChangeExtension(file,".dvi");
137 void LaTeX::deleteFilesOnError() const
139 // currently just a dummy function.
141 // What files do we have to delete?
143 // This will at least make latex do all the runs
146 // but the reason for the error might be in a generated file...
148 string const ofname = OnlyFilename(file);
151 string const bbl = ChangeExtension(ofname, ".bbl");
155 string const ind = ChangeExtension(ofname, ".ind");
158 // Also remove the aux file
159 string const aux = ChangeExtension(ofname, ".aux");
164 int LaTeX::run(TeXErrors & terr)
165 // We know that this function will only be run if the lyx buffer
166 // has been changed. We also know that a newly written .tex file
167 // is always different from the previous one because of the date
168 // in it. However it seems safe to run latex (at least) on time each
169 // time the .tex file changes.
171 int scanres = NO_ERRORS;
172 unsigned int count = 0; // number of times run
173 num_errors = 0; // just to make sure.
174 unsigned int const MAX_RUN = 6;
175 DepTable head; // empty head
176 bool rerun = false; // rerun requested
178 // The class LaTeX does not know the temp path.
179 bufferlist.updateIncludedTeXfiles(getcwd(), runparams);
181 // Never write the depfile if an error was encountered.
184 // first check if the file dependencies exist:
185 // ->If it does exist
186 // check if any of the files mentioned in it have
187 // changed (done using a checksum).
189 // run latex once and
190 // remake the dependency file
191 // -> if not changed:
192 // just return there is nothing to do for us.
193 // ->if it doesn't exist
195 // run latex once (we need to run latex once anyway) and
196 // remake the dependency file.
199 FileInfo fi(depfile);
200 bool had_depfile = fi.exist();
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 (!FileInfo(output_file).exist()) {
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
273 if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
275 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
276 message(_("Running MakeIndex."));
277 rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
281 // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
282 if (scanres & UNDEF_CIT || run_bibtex) {
283 // Here we must scan the .aux file and look for
284 // "\bibdata" and/or "\bibstyle". If one of those
285 // tags is found -> run bibtex and set rerun = true;
287 lyxerr[Debug::LATEX] << "Running BibTeX." << endl;
288 message(_("Running BibTeX."));
289 updateBibtexDependencies(head, bibtex_info);
290 rerun |= runBibTeX(bibtex_info);
291 } else if (!had_depfile) {
292 /// If we run pdflatex on the file after running latex on it,
293 /// then we do not need to run bibtex, but we do need to
294 /// insert the .bib and .bst files into the .dep-pdf file.
295 updateBibtexDependencies(head, bibtex_info);
299 // we know on this point that latex has been run once (or we just
300 // returned) and the question now is to decide if we need to run
301 // it any more. This is done by asking if any of the files in the
302 // dependency file has changed. (remember that the checksum for
303 // a given file is reported to have changed if it just was created)
304 // -> if changed or rerun == true:
305 // run latex once more and
306 // update the dependency structure
307 // -> if not changed:
308 // we does nothing at this point
310 if (rerun || head.sumchange()) {
313 lyxerr[Debug::DEPEND]
314 << "Dep. file has changed or rerun requested" << endl;
316 << "Run #" << count << endl;
317 message(runMessage(count));
319 scanres = scanLogFile(terr);
320 if (scanres & ERRORS) {
321 deleteFilesOnError();
322 return scanres; // return on error
325 // update the depedencies
326 deplog(head); // reads the latex log
329 lyxerr[Debug::DEPEND] << "Dep. file has NOT changed" << endl;
333 // The inclusion of files generated by external programs like
334 // makeindex or bibtex might have done changes to pagenumbereing,
335 // etc. And because of this we must run the external programs
336 // again to make sure everything is redone correctly.
337 // Also there should be no need to run the external programs any
340 // run makeindex if the <file>.idx has changed or was generated.
341 if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
343 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
344 message(_("Running MakeIndex."));
345 rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
349 // we will only run latex more if the log file asks for it.
350 // or if the sumchange() is true.
351 // -> rerun asked for:
353 // remake the dependency file
354 // goto 2 or return if max runs are reached.
355 // -> rerun not asked for:
356 // just return (fall out of bottom of func)
358 while ((head.sumchange() || rerun || (scanres & RERUN))
359 && count < MAX_RUN) {
360 // Yes rerun until message goes away, or until
361 // MAX_RUNS are reached.
364 lyxerr[Debug::LATEX] << "Run #" << count << endl;
365 message(runMessage(count));
367 scanres = scanLogFile(terr);
368 if (scanres & ERRORS) {
369 deleteFilesOnError();
370 return scanres; // return on error
377 // Write the dependencies to file.
379 lyxerr[Debug::LATEX] << "Done." << endl;
384 int LaTeX::startscript()
387 string tmp = cmd + ' ' + QuoteName(file) + " > /dev/null";
388 #else // cmd.exe (OS/2) causes SYS0003 error at "/dev/null"
389 string tmp = cmd + ' ' + file + " > nul";
392 return one.startscript(Systemcall::Wait, tmp);
396 bool LaTeX::runMakeIndex(string const & f)
398 lyxerr[Debug::LATEX] << "idx file has been made,"
399 " running makeindex on file "
402 // It should be possible to set the switches for makeindex
403 // sorting style and such. It would also be very convenient
404 // to be able to make style files from within LyX. This has
405 // to come for a later time.
406 string tmp = "makeindex -c -q ";
409 one.startscript(Systemcall::Wait, tmp);
414 vector<Aux_Info> const
415 LaTeX::scanAuxFiles(string const & file)
417 vector<Aux_Info> result;
419 result.push_back(scanAuxFile(file));
421 for (int i = 1; i < 1000; ++i) {
422 string file2 = ChangeExtension(file, "") + '.' + tostr(i)
427 result.push_back(scanAuxFile(file2));
433 Aux_Info const LaTeX::scanAuxFile(string const & file)
436 result.aux_file = file;
437 scanAuxFile(file, result);
442 void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info)
444 lyxerr[Debug::LATEX] << "Scanning aux file: " << file << endl;
446 ifstream ifs(file.c_str());
448 regex reg1("\\\\citation\\{([^}]+)\\}");
449 regex reg2("\\\\bibdata\\{([^}]+)\\}");
450 regex reg3("\\\\bibstyle\\{([^}]+)\\}");
451 regex reg4("\\\\@input\\{([^}]+)\\}");
453 while (getline(ifs, token)) {
454 token = rtrim(token, "\r");
456 if (regex_match(token, sub, reg1)) {
457 string data = sub.str(1);
458 while (!data.empty()) {
460 data = split(data, citation, ',');
461 lyxerr[Debug::LATEX] << "Citation: "
463 aux_info.citations.insert(citation);
465 } else if (regex_match(token, sub, reg2)) {
466 string data = sub.str(1);
467 // data is now all the bib files separated by ','
468 // get them one by one and pass them to the helper
469 while (!data.empty()) {
471 data = split(data, database, ',');
472 database = ChangeExtension(database, "bib");
473 lyxerr[Debug::LATEX] << "BibTeX database: `"
474 << database << '\'' << endl;
475 aux_info.databases.insert(database);
477 } else if (regex_match(token, sub, reg3)) {
478 string style = sub.str(1);
479 // token is now the style file
480 // pass it to the helper
481 style = ChangeExtension(style, "bst");
482 lyxerr[Debug::LATEX] << "BibTeX style: `"
483 << style << '\'' << endl;
484 aux_info.styles.insert(style);
485 } else if (regex_match(token, sub, reg4)) {
486 string const file2 = sub.str(1);
487 scanAuxFile(file2, aux_info);
493 void LaTeX::updateBibtexDependencies(DepTable & dep,
494 vector<Aux_Info> const & bibtex_info)
496 // Since a run of Bibtex mandates more latex runs it is ok to
497 // remove all ".bib" and ".bst" files.
498 dep.remove_files_with_extension(".bib");
499 dep.remove_files_with_extension(".bst");
500 //string aux = OnlyFilename(ChangeExtension(file, ".aux"));
502 for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
503 it != bibtex_info.end(); ++it) {
504 for (set<string>::const_iterator it2 = it->databases.begin();
505 it2 != it->databases.end(); ++it2) {
506 string file = findtexfile(*it2, "bib");
508 dep.insert(file, true);
511 for (set<string>::const_iterator it2 = it->styles.begin();
512 it2 != it->styles.end(); ++it2) {
513 string file = findtexfile(*it2, "bst");
515 dep.insert(file, true);
521 bool LaTeX::runBibTeX(vector<Aux_Info> const & bibtex_info)
524 for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
525 it != bibtex_info.end(); ++it) {
526 if (it->databases.empty())
530 string tmp = "bibtex ";
531 tmp += OnlyFilename(ChangeExtension(it->aux_file, string()));
533 one.startscript(Systemcall::Wait, tmp);
535 // Return whether bibtex was run
540 int LaTeX::scanLogFile(TeXErrors & terr)
544 int retval = NO_ERRORS;
545 string tmp = OnlyFilename(ChangeExtension(file, ".log"));
546 lyxerr[Debug::LATEX] << "Log file: " << tmp << endl;
547 ifstream ifs(tmp.c_str());
550 while (getline(ifs, token)) {
551 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
556 if (prefixIs(token, "LaTeX Warning:")) {
557 // Here shall we handle different
559 retval |= LATEX_WARNING;
560 lyxerr[Debug::LATEX] << "LaTeX Warning." << endl;
561 if (contains(token, "Rerun to get cross-references")) {
564 << "We should rerun." << endl;
565 } else if (contains(token, "Citation")
566 && contains(token, "on page")
567 && contains(token, "undefined")) {
570 } else if (prefixIs(token, "Package")) {
572 retval |= PACKAGE_WARNING;
573 if (contains(token, "natbib Warning:")) {
575 if (contains(token, "Citation")
576 && contains(token, "on page")
577 && contains(token, "undefined")) {
580 } else if (contains(token, "run BibTeX")) {
582 } else if (contains(token, "Rerun LaTeX") ||
583 contains(token, "Rerun to get")) {
584 // at least longtable.sty and bibtopic.sty
587 << "We should rerun." << endl;
590 } else if (token[0] == '(') {
591 if (contains(token, "Rerun LaTeX") ||
592 contains(token, "Rerun to get")) {
595 << "We should rerun." << endl;
598 } else if (prefixIs(token, "! ")) {
599 // Ok, we have something that looks like a TeX Error
600 // but what do we really have.
602 // Just get the error description:
603 string desc(token, 2);
604 if (contains(token, "LaTeX Error:"))
605 retval |= LATEX_ERROR;
610 if (!getline(ifs, tmp))
614 } while (!prefixIs(tmp, "l."));
615 if (prefixIs(tmp, "l.")) {
616 // we have a latex error
618 if (contains(desc, "Package babel Error: You haven't defined the language"))
619 retval |= ERROR_RERUN;
620 // get the line number:
622 sscanf(tmp.c_str(), "l.%d", &line);
623 // get the rest of the message:
624 string errstr(tmp, tmp.find(' '));
627 while (!contains(errstr, "l.")
629 && !prefixIs(tmp, "! ")
630 && !contains(tmp, "(job aborted")) {
636 << "line: " << line << '\n'
637 << "Desc: " << desc << '\n'
638 << "Text: " << errstr << endl;
639 if (line == last_line)
645 if (line_count <= 5) {
646 terr.insertError(line, desc, errstr);
651 // information messages, TeX warnings and other
652 // warnings we have not caught earlier.
653 if (prefixIs(token, "Overfull ")) {
654 retval |= TEX_WARNING;
655 } else if (prefixIs(token, "Underfull ")) {
656 retval |= TEX_WARNING;
657 } else if (contains(token, "Rerun to get citations")) {
658 // Natbib seems to use this.
660 } else if (contains(token, "No pages of output")) {
661 // A dvi file was not created
663 } else if (contains(token, "That makes 100 errors")) {
664 // More than 100 errors were reprted
665 retval |= TOO_MANY_ERRORS;
669 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
674 void LaTeX::deplog(DepTable & head)
676 // This function reads the LaTeX log file end extracts all the external
677 // files used by the LaTeX run. The files are then entered into the
680 string const logfile = OnlyFilename(ChangeExtension(file, ".log"));
682 regex reg1("\\)* *\\(([^ )]+).*");
683 regex reg2("File: ([^ ]+).*");
684 regex reg3("No file ([^ ]+)\\..*");
685 regex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*");
686 // If an index should be created, MikTex does not write a line like
687 // \openout# = 'sample,idx'.
688 // but intstead only a line like this into the log:
689 // Writing index file sample.idx
690 regex reg5("Writing index file ([^ ]+).*");
691 regex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$");
693 ifstream ifs(logfile.c_str());
695 // Ok, the scanning of files here is not sufficient.
696 // Sometimes files are named by "File: xxx" only
697 // So I think we should use some regexps to find files instead.
698 // "(\([^ ]+\)" should match the "(file " variant
699 // "File: \([^ ]+\)" should match the "File: file" variant
703 token = rtrim(token, "\r");
704 if (token.empty()) continue;
708 if (regex_match(token, sub, reg1)) {
709 foundfile = sub.str(1);
710 } else if (regex_match(token, sub, reg2)) {
711 foundfile = sub.str(1);
712 } else if (regex_match(token, sub, reg3)) {
713 foundfile = sub.str(1);
714 } else if (regex_match(token, sub, reg4)) {
715 foundfile = sub.str(1);
716 } else if (regex_match(token, sub, reg5)) {
717 foundfile = sub.str(1);
722 // convert from native os path to unix path
723 foundfile = os::internal_path(foundfile);
725 lyxerr[Debug::DEPEND] << "Found file: "
726 << foundfile << endl;
728 // Ok now we found a file.
729 // Now we should make sure that this is a file that we can
730 // access through the normal paths.
731 // We will not try any fancy search methods to
734 // (1) foundfile is an
735 // absolute path and should
737 if (AbsolutePath(foundfile)) {
738 lyxerr[Debug::DEPEND] << "AbsolutePath file: "
739 << foundfile << endl;
740 // On initial insert we want to do the update at once
741 // since this file can not be a file generated by
743 if (FileInfo(foundfile).exist())
744 head.insert(foundfile, true);
747 // (2) foundfile is in the tmpdir
748 // insert it into head
749 else if (FileInfo(OnlyFilename(foundfile)).exist()) {
750 if (regex_match(foundfile, unwanted)) {
751 lyxerr[Debug::DEPEND]
753 << OnlyFilename(foundfile)
754 << " in the dep file"
756 } else if (suffixIs(foundfile, ".tex")) {
757 // This is a tex file generated by LyX
758 // and latex is not likely to change this
760 lyxerr[Debug::DEPEND]
761 << "Tmpdir TeX file: "
762 << OnlyFilename(foundfile)
764 head.insert(foundfile, true);
766 lyxerr[Debug::DEPEND]
768 << OnlyFilename(foundfile)
770 head.insert(OnlyFilename(foundfile));
773 lyxerr[Debug::DEPEND]
774 << "Not a file or we are unable to find it."
778 // Make sure that the main .tex file is in the dependancy file.
779 head.insert(OnlyFilename(file), true);