1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
5 * Copyright 1995 Matthias Ettrich
6 * Copyright 1995-2001 The LyX Team.
8 * This file is Copyright 1996-2001
11 * ======================================================
17 #include "bufferlist.h"
21 #include "funcrequest.h"
22 #include "support/filetools.h"
23 #include "support/FileInfo.h"
24 #include "support/lstrings.h"
25 #include "support/lyxlib.h"
26 #include "support/systemcall.h"
27 #include "support/os.h"
28 #include "support/path.h"
30 #include <boost/regex.hpp>
31 #include "BoostFormat.h"
34 #include <cstdio> // sscanf
36 #ifndef CXX_GLOBAL_CSTD
46 using boost::regex_match;
48 #ifndef USE_INCLUDED_STRING
54 // TODO: in no particular order
55 // - get rid of the extern BufferList and the call to
56 // BufferList::updateIncludedTeXfiles, this should either
57 // be done before calling LaTeX::funcs or in a completely
59 // - the bibtex command options should be supported.
60 // - the makeindex style files should be taken care of with
61 // the dependency mechanism.
62 // - makeindex commandline options should be supported
63 // - somewhere support viewing of bibtex and makeindex log files.
64 // - we should perhaps also scan the bibtex log file
65 // - we should perhaps also scan the bibtex log file
67 extern BufferList bufferlist;
71 void showRunMessage(LyXFunc * lf, unsigned int count)
75 str << boost::format(_("Waiting for LaTeX run number %1$d")) % count;
77 str << _("Waiting for LaTeX run number ") << count;
79 lf->dispatch(FuncRequest(LFUN_MESSAGE, STRCONV(str.str())));
88 void TeXErrors::insertError(int line, string const & error_desc,
89 string const & error_text)
91 Error newerr(line, error_desc, error_text);
92 errors.push_back(newerr);
99 LaTeX::LaTeX(string const & latex, string const & f, string const & p)
100 : cmd(latex), file(f), path(p)
103 depfile = file + ".dep";
104 if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
106 output_file = ChangeExtension(file,".pdf");
108 output_file = ChangeExtension(file,".dvi");
113 void LaTeX::deleteFilesOnError() const
115 // currently just a dummy function.
117 // What files do we have to delete?
119 // This will at least make latex do all the runs
120 lyx::unlink(depfile);
122 // but the reason for the error might be in a generated file...
124 string const ofname = OnlyFilename(file);
127 string const bbl = ChangeExtension(ofname, ".bbl");
131 string const ind = ChangeExtension(ofname, ".ind");
134 // Also remove the aux file
135 string const aux = ChangeExtension(ofname, ".aux");
140 int LaTeX::run(TeXErrors & terr, LyXFunc * lfun)
141 // We know that this function will only be run if the lyx buffer
142 // has been changed. We also know that a newly written .tex file
143 // is always different from the previous one because of the date
144 // in it. However it seems safe to run latex (at least) on time each
145 // time the .tex file changes.
147 int scanres = NO_ERRORS;
148 unsigned int count = 0; // number of times run
149 num_errors = 0; // just to make sure.
150 unsigned int const MAX_RUN = 6;
151 DepTable head; // empty head
152 bool rerun = false; // rerun requested
154 // The class LaTeX does not know the temp path.
155 bufferlist.updateIncludedTeXfiles(lyx::getcwd());
157 // Never write the depfile if an error was encountered.
160 // first check if the file dependencies exist:
161 // ->If it does exist
162 // check if any of the files mentioned in it have
163 // changed (done using a checksum).
165 // run latex once and
166 // remake the dependency file
167 // -> if not changed:
168 // just return there is nothing to do for us.
169 // ->if it doesn't exist
171 // run latex once (we need to run latex once anyway) and
172 // remake the dependency file.
175 FileInfo fi(depfile);
176 bool had_depfile = fi.exist();
177 bool run_bibtex = false;
178 string aux_file = OnlyFilename(ChangeExtension(file, "aux"));
181 lyxerr[Debug::DEPEND] << "Dependency file exists" << endl;
182 // Read the dep file:
184 // Update the checksums
186 // Can't just check if anything has changed because it might have aborted
187 // on error last time... in which cas we need to re-run latex
188 // and collect the error messages (even if they are the same).
189 if (!FileInfo(output_file).exist()) {
190 lyxerr[Debug::DEPEND]
191 << "re-running LaTeX because output file doesn't exist." << endl;
192 } else if (!head.sumchange()) {
193 lyxerr[Debug::DEPEND] << "return no_change" << endl;
196 lyxerr[Debug::DEPEND]
197 << "Dependency file has changed" << endl;
200 if (head.extchanged(".bib") || head.extchanged(".bst"))
203 lyxerr[Debug::DEPEND]
204 << "Dependency file does not exist" << endl;
206 /// We scan the aux file even when had_depfile = false,
207 /// because we can run pdflatex on the file after running latex on it,
208 /// in which case we will not need to run bibtex again.
209 vector<Aux_Info> bibtex_info_old;
211 bibtex_info_old = scanAuxFiles(aux_file);
214 lyxerr[Debug::LATEX] << "Run #" << count << endl;
216 showRunMessage(lfun, count);
220 scanres = scanLogFile(terr);
221 if (scanres & ERROR_RERUN) {
222 lyxerr[Debug::LATEX] << "Rerunning LaTeX" << endl;
224 scanres = scanLogFile(terr);
227 if (scanres & ERRORS) {
228 deleteFilesOnError();
229 return scanres; // return on error
232 vector<Aux_Info> const bibtex_info = scanAuxFiles(aux_file);
233 if (!run_bibtex && bibtex_info_old != bibtex_info)
236 // update the dependencies.
237 deplog(head); // reads the latex log
241 // At this point we must run external programs if needed.
242 // makeindex will be run if a .idx file changed or was generated.
243 // And if there were undefined citations or changes in references
244 // the .aux file is checked for signs of bibtex. Bibtex is then run
248 if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
250 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
252 lfun->dispatch(FuncRequest(LFUN_MESSAGE, _("Running MakeIndex.")));
255 rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
259 // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
260 if (scanres & UNDEF_CIT || run_bibtex) {
261 // Here we must scan the .aux file and look for
262 // "\bibdata" and/or "\bibstyle". If one of those
263 // tags is found -> run bibtex and set rerun = true;
265 lyxerr[Debug::LATEX] << "Running BibTeX." << endl;
267 lfun->dispatch(FuncRequest(LFUN_MESSAGE, _("Running BibTeX.")));
270 updateBibtexDependencies(head, bibtex_info);
271 rerun |= runBibTeX(bibtex_info);
272 } else if (!had_depfile) {
273 /// If we run pdflatex on the file after running latex on it,
274 /// then we do not need to run bibtex, but we do need to
275 /// insert the .bib and .bst files into the .dep-pdf file.
276 updateBibtexDependencies(head, bibtex_info);
280 // we know on this point that latex has been run once (or we just
281 // returned) and the question now is to decide if we need to run
282 // it any more. This is done by asking if any of the files in the
283 // dependency file has changed. (remember that the checksum for
284 // a given file is reported to have changed if it just was created)
285 // -> if changed or rerun == true:
286 // run latex once more and
287 // update the dependency structure
288 // -> if not changed:
289 // we does nothing at this point
291 if (rerun || head.sumchange()) {
294 lyxerr[Debug::DEPEND]
295 << "Dep. file has changed or rerun requested" << endl;
297 << "Run #" << count << endl;
299 showRunMessage(lfun, count);
303 scanres = scanLogFile(terr);
304 if (scanres & ERRORS) {
305 deleteFilesOnError();
306 return scanres; // return on error
309 // update the depedencies
310 deplog(head); // reads the latex log
313 lyxerr[Debug::DEPEND] << "Dep. file has NOT changed" << endl;
317 // The inclusion of files generated by external programs like
318 // makeindex or bibtex might have done changes to pagenumbereing,
319 // etc. And because of this we must run the external programs
320 // again to make sure everything is redone correctly.
321 // Also there should be no need to run the external programs any
324 // run makeindex if the <file>.idx has changed or was generated.
325 if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
327 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
329 lfun->dispatch(FuncRequest(LFUN_MESSAGE, _("Running MakeIndex.")));
332 rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
336 // we will only run latex more if the log file asks for it.
337 // or if the sumchange() is true.
338 // -> rerun asked for:
340 // remake the dependency file
341 // goto 2 or return if max runs are reached.
342 // -> rerun not asked for:
343 // just return (fall out of bottom of func)
345 while ((head.sumchange() || rerun || (scanres & RERUN))
346 && count < MAX_RUN) {
347 // Yes rerun until message goes away, or until
348 // MAX_RUNS are reached.
351 lyxerr[Debug::LATEX] << "Run #" << count << endl;
353 showRunMessage(lfun, count);
357 scanres = scanLogFile(terr);
358 if (scanres & ERRORS) {
359 deleteFilesOnError();
360 return scanres; // return on error
367 // Write the dependencies to file.
369 lyxerr[Debug::LATEX] << "Done." << endl;
374 int LaTeX::operator()()
377 string tmp = cmd + ' ' + QuoteName(file) + " > /dev/null";
378 #else // cmd.exe (OS/2) causes SYS0003 error at "/dev/null"
379 string tmp = cmd + ' ' + file + " > nul";
382 return one.startscript(Systemcall::Wait, tmp);
386 bool LaTeX::runMakeIndex(string const & f)
388 lyxerr[Debug::LATEX] << "idx file has been made,"
389 " running makeindex on file "
392 // It should be possible to set the switches for makeindex
393 // sorting style and such. It would also be very convenient
394 // to be able to make style files from within LyX. This has
395 // to come for a later time.
396 string tmp = "makeindex -c -q ";
399 one.startscript(Systemcall::Wait, tmp);
404 vector<Aux_Info> const
405 LaTeX::scanAuxFiles(string const & file)
407 vector<Aux_Info> result;
409 result.push_back(scanAuxFile(file));
411 for (int i = 1; i < 1000; ++i) {
412 string file2 = ChangeExtension(file, "") + '.' + tostr(i)
417 result.push_back(scanAuxFile(file2));
423 Aux_Info const LaTeX::scanAuxFile(string const & file)
426 result.aux_file = file;
427 scanAuxFile(file, result);
432 void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info)
434 lyxerr[Debug::LATEX] << "Scanning aux file: " << file << endl;
436 ifstream ifs(file.c_str());
438 regex reg1("\\\\citation\\{([^}]+)\\}");
439 regex reg2("\\\\bibdata\\{([^}]+)\\}");
440 regex reg3("\\\\bibstyle\\{([^}]+)\\}");
441 regex reg4("\\\\@input\\{([^}]+)\\}");
443 while (getline(ifs, token)) {
444 token = rtrim(token, "\r");
445 #ifndef USE_INCLUDED_STRING
450 if (regex_match(STRCONV(token), sub, reg1)) {
451 string data = STRCONV(sub.str(1));
452 while (!data.empty()) {
454 data = split(data, citation, ',');
455 lyxerr[Debug::LATEX] << "Citation: "
457 aux_info.citations.insert(citation);
459 } else if (regex_match(STRCONV(token), sub, reg2)) {
460 string data = sub.STRCONV(str(1));
461 // data is now all the bib files separated by ','
462 // get them one by one and pass them to the helper
463 while (!data.empty()) {
465 data = split(data, database, ',');
466 database = ChangeExtension(database, "bib");
467 lyxerr[Debug::LATEX] << "BibTeX database: `"
468 << database << '\'' << endl;
469 aux_info.databases.insert(database);
471 } else if (regex_match(STRCONV(token), sub, reg3)) {
472 string style = STRCONV(sub.str(1));
473 // token is now the style file
474 // pass it to the helper
475 style = ChangeExtension(style, "bst");
476 lyxerr[Debug::LATEX] << "BibTeX style: `"
477 << style << '\'' << endl;
478 aux_info.styles.insert(style);
479 } else if (regex_match(STRCONV(token), sub, reg4)) {
480 string const file2 = STRCONV(sub.str(1));
481 scanAuxFile(file2, aux_info);
487 void LaTeX::updateBibtexDependencies(DepTable & dep,
488 vector<Aux_Info> const & bibtex_info)
490 // Since a run of Bibtex mandates more latex runs it is ok to
491 // remove all ".bib" and ".bst" files.
492 dep.remove_files_with_extension(".bib");
493 dep.remove_files_with_extension(".bst");
494 //string aux = OnlyFilename(ChangeExtension(file, ".aux"));
496 for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
497 it != bibtex_info.end(); ++it) {
498 for (set<string>::const_iterator it2 = it->databases.begin();
499 it2 != it->databases.end(); ++it2) {
500 string file = findtexfile(*it2, "bib");
502 dep.insert(file, true);
505 for (set<string>::const_iterator it2 = it->styles.begin();
506 it2 != it->styles.end(); ++it2) {
507 string file = findtexfile(*it2, "bst");
509 dep.insert(file, true);
515 bool LaTeX::runBibTeX(vector<Aux_Info> const & bibtex_info)
518 for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
519 it != bibtex_info.end(); ++it) {
520 if (it->databases.empty())
524 string tmp = "bibtex ";
525 tmp += OnlyFilename(ChangeExtension(it->aux_file, string()));
527 one.startscript(Systemcall::Wait, tmp);
529 // Return whether bibtex was run
534 int LaTeX::scanLogFile(TeXErrors & terr)
538 int retval = NO_ERRORS;
539 string tmp = OnlyFilename(ChangeExtension(file, ".log"));
540 lyxerr[Debug::LATEX] << "Log file: " << tmp << endl;
541 ifstream ifs(tmp.c_str());
544 while (getline(ifs, token)) {
545 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
550 if (prefixIs(token, "LaTeX Warning:")) {
551 // Here shall we handle different
553 retval |= LATEX_WARNING;
554 lyxerr[Debug::LATEX] << "LaTeX Warning." << endl;
555 if (contains(token, "Rerun to get cross-references")) {
558 << "We should rerun." << endl;
559 } else if (contains(token, "Citation")
560 && contains(token, "on page")
561 && contains(token, "undefined")) {
564 } else if (prefixIs(token, "Package")) {
566 retval |= PACKAGE_WARNING;
567 if (contains(token, "natbib Warning:")) {
569 if (contains(token, "Citation")
570 && contains(token, "on page")
571 && contains(token, "undefined")) {
574 } else if (contains(token, "run BibTeX")) {
576 } else if (contains(token, "Rerun LaTeX") ||
577 contains(token, "Rerun to get")) {
578 // at least longtable.sty and bibtopic.sty
581 << "We should rerun." << endl;
584 } else if (token[0] == '(') {
585 if (contains(token, "Rerun LaTeX") ||
586 contains(token, "Rerun to get")) {
589 << "We should rerun." << endl;
592 } else if (prefixIs(token, "! ")) {
593 // Ok, we have something that looks like a TeX Error
594 // but what do we really have.
596 // Just get the error description:
597 string desc(token, 2);
598 if (contains(token, "LaTeX Error:"))
599 retval |= LATEX_ERROR;
604 if (!getline(ifs, tmp))
608 } while (!prefixIs(tmp, "l."));
609 if (prefixIs(tmp, "l.")) {
610 // we have a latex error
612 if (contains(desc, "Package babel Error: You haven't defined the language"))
613 retval |= ERROR_RERUN;
614 // get the line number:
616 sscanf(tmp.c_str(), "l.%d", &line);
617 // get the rest of the message:
618 string errstr(tmp, tmp.find(' '));
621 while (!contains(errstr, "l.")
623 && !prefixIs(tmp, "! ")
624 && !contains(tmp, "(job aborted")) {
630 << "line: " << line << '\n'
631 << "Desc: " << desc << '\n'
632 << "Text: " << errstr << endl;
633 if (line == last_line)
639 if (line_count <= 5) {
640 terr.insertError(line, desc, errstr);
645 // information messages, TeX warnings and other
646 // warnings we have not caught earlier.
647 if (prefixIs(token, "Overfull ")) {
648 retval |= TEX_WARNING;
649 } else if (prefixIs(token, "Underfull ")) {
650 retval |= TEX_WARNING;
651 } else if (contains(token, "Rerun to get citations")) {
652 // Natbib seems to use this.
654 } else if (contains(token, "No pages of output")) {
655 // A dvi file was not created
657 } else if (contains(token, "That makes 100 errors")) {
658 // More than 100 errors were reprted
659 retval |= TOO_MANY_ERRORS;
663 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
668 void LaTeX::deplog(DepTable & head)
670 // This function reads the LaTeX log file end extracts all the external
671 // files used by the LaTeX run. The files are then entered into the
674 string const logfile = OnlyFilename(ChangeExtension(file, ".log"));
676 regex reg1("\\)* *\\(([^ )]+).*");
677 regex reg2("File: ([^ ]+).*");
678 regex reg3("No file ([^ ]+)\\..*");
679 regex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*");
680 // If an index should be created, MikTex does not write a line like
681 // \openout# = 'sample,idx'.
682 // but intstead only a line like this into the log:
683 // Writing index file sample.idx
684 regex reg5("Writing index file ([^ ]+).*");
685 regex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$");
687 ifstream ifs(logfile.c_str());
689 // Ok, the scanning of files here is not sufficient.
690 // Sometimes files are named by "File: xxx" only
691 // So I think we should use some regexps to find files instead.
692 // "(\([^ ]+\)" should match the "(file " variant
693 // "File: \([^ ]+\)" should match the "File: file" variant
697 token = rtrim(token, "\r");
698 if (token.empty()) continue;
700 #ifndef USE_INCLUDED_STRING
705 if (regex_match(STRCONV(token), sub, reg1)) {
706 foundfile = STRCONV(sub.str(1));
707 } else if (regex_match(STRCONV(token), sub, reg2)) {
708 foundfile = STRCONV(sub.str(1));
709 } else if (regex_match(STRCONV(token), sub, reg3)) {
710 foundfile = STRCONV(sub.str(1));
711 } else if (regex_match(STRCONV(token), sub, reg4)) {
712 foundfile = STRCONV(sub.str(1));
713 } else if (regex_match(STRCONV(token), sub, reg5)) {
714 foundfile = STRCONV(sub.str(1));
719 // convert from native os path to unix path
720 foundfile = os::internal_path(foundfile);
722 lyxerr[Debug::DEPEND] << "Found file: "
723 << foundfile << endl;
725 // Ok now we found a file.
726 // Now we should make sure that this is a file that we can
727 // access through the normal paths.
728 // We will not try any fancy search methods to
731 // (1) foundfile is an
732 // absolute path and should
734 if (AbsolutePath(foundfile)) {
735 lyxerr[Debug::DEPEND] << "AbsolutePath file: "
736 << foundfile << endl;
737 // On initial insert we want to do the update at once
738 // since this file can not be a file generated by
740 if (FileInfo(foundfile).exist())
741 head.insert(foundfile, true);
744 // (2) foundfile is in the tmpdir
745 // insert it into head
746 else if (FileInfo(OnlyFilename(foundfile)).exist()) {
747 if (regex_match(STRCONV(foundfile), unwanted)) {
748 lyxerr[Debug::DEPEND]
750 << OnlyFilename(foundfile)
751 << " in the dep file"
753 } else if (suffixIs(foundfile, ".tex")) {
754 // This is a tex file generated by LyX
755 // and latex is not likely to change this
757 lyxerr[Debug::DEPEND]
758 << "Tmpdir TeX file: "
759 << OnlyFilename(foundfile)
761 head.insert(foundfile, true);
763 lyxerr[Debug::DEPEND]
765 << OnlyFilename(foundfile)
767 head.insert(OnlyFilename(foundfile));
770 lyxerr[Debug::DEPEND]
771 << "Not a file or we are unable to find it."
775 // Make sure that the main .tex file is in the dependancy file.
776 head.insert(OnlyFilename(file), true);