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 "support/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:
183 had_depfile = head.read(depfile);
187 // Update the checksums
189 // Can't just check if anything has changed because it might have aborted
190 // on error last time... in which cas we need to re-run latex
191 // and collect the error messages (even if they are the same).
192 if (!FileInfo(output_file).exist()) {
193 lyxerr[Debug::DEPEND]
194 << "re-running LaTeX because output file doesn't exist." << endl;
195 } else if (!head.sumchange()) {
196 lyxerr[Debug::DEPEND] << "return no_change" << endl;
199 lyxerr[Debug::DEPEND]
200 << "Dependency file has changed" << endl;
203 if (head.extchanged(".bib") || head.extchanged(".bst"))
206 lyxerr[Debug::DEPEND]
207 << "Dependency file does not exist, or has wrong format" << endl;
209 /// We scan the aux file even when had_depfile = false,
210 /// because we can run pdflatex on the file after running latex on it,
211 /// in which case we will not need to run bibtex again.
212 vector<Aux_Info> bibtex_info_old;
214 bibtex_info_old = scanAuxFiles(aux_file);
217 lyxerr[Debug::LATEX] << "Run #" << count << endl;
219 showRunMessage(lfun, count);
223 scanres = scanLogFile(terr);
224 if (scanres & ERROR_RERUN) {
225 lyxerr[Debug::LATEX] << "Rerunning LaTeX" << endl;
227 scanres = scanLogFile(terr);
230 if (scanres & ERRORS) {
231 deleteFilesOnError();
232 return scanres; // return on error
235 vector<Aux_Info> const bibtex_info = scanAuxFiles(aux_file);
236 if (!run_bibtex && bibtex_info_old != bibtex_info)
239 // update the dependencies.
240 deplog(head); // reads the latex log
244 // At this point we must run external programs if needed.
245 // makeindex will be run if a .idx file changed or was generated.
246 // And if there were undefined citations or changes in references
247 // the .aux file is checked for signs of bibtex. Bibtex is then run
251 if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
253 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
255 lfun->dispatch(FuncRequest(LFUN_MESSAGE, _("Running MakeIndex.")));
258 rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
262 // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
263 if (scanres & UNDEF_CIT || run_bibtex) {
264 // Here we must scan the .aux file and look for
265 // "\bibdata" and/or "\bibstyle". If one of those
266 // tags is found -> run bibtex and set rerun = true;
268 lyxerr[Debug::LATEX] << "Running BibTeX." << endl;
270 lfun->dispatch(FuncRequest(LFUN_MESSAGE, _("Running BibTeX.")));
273 updateBibtexDependencies(head, bibtex_info);
274 rerun |= runBibTeX(bibtex_info);
275 } else if (!had_depfile) {
276 /// If we run pdflatex on the file after running latex on it,
277 /// then we do not need to run bibtex, but we do need to
278 /// insert the .bib and .bst files into the .dep-pdf file.
279 updateBibtexDependencies(head, bibtex_info);
283 // we know on this point that latex has been run once (or we just
284 // returned) and the question now is to decide if we need to run
285 // it any more. This is done by asking if any of the files in the
286 // dependency file has changed. (remember that the checksum for
287 // a given file is reported to have changed if it just was created)
288 // -> if changed or rerun == true:
289 // run latex once more and
290 // update the dependency structure
291 // -> if not changed:
292 // we does nothing at this point
294 if (rerun || head.sumchange()) {
297 lyxerr[Debug::DEPEND]
298 << "Dep. file has changed or rerun requested" << endl;
300 << "Run #" << count << endl;
302 showRunMessage(lfun, count);
306 scanres = scanLogFile(terr);
307 if (scanres & ERRORS) {
308 deleteFilesOnError();
309 return scanres; // return on error
312 // update the depedencies
313 deplog(head); // reads the latex log
316 lyxerr[Debug::DEPEND] << "Dep. file has NOT changed" << endl;
320 // The inclusion of files generated by external programs like
321 // makeindex or bibtex might have done changes to pagenumbereing,
322 // etc. And because of this we must run the external programs
323 // again to make sure everything is redone correctly.
324 // Also there should be no need to run the external programs any
327 // run makeindex if the <file>.idx has changed or was generated.
328 if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
330 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
332 lfun->dispatch(FuncRequest(LFUN_MESSAGE, _("Running MakeIndex.")));
335 rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
339 // we will only run latex more if the log file asks for it.
340 // or if the sumchange() is true.
341 // -> rerun asked for:
343 // remake the dependency file
344 // goto 2 or return if max runs are reached.
345 // -> rerun not asked for:
346 // just return (fall out of bottom of func)
348 while ((head.sumchange() || rerun || (scanres & RERUN))
349 && count < MAX_RUN) {
350 // Yes rerun until message goes away, or until
351 // MAX_RUNS are reached.
354 lyxerr[Debug::LATEX] << "Run #" << count << endl;
356 showRunMessage(lfun, count);
360 scanres = scanLogFile(terr);
361 if (scanres & ERRORS) {
362 deleteFilesOnError();
363 return scanres; // return on error
370 // Write the dependencies to file.
372 lyxerr[Debug::LATEX] << "Done." << endl;
377 int LaTeX::operator()()
380 string tmp = cmd + ' ' + QuoteName(file) + " > /dev/null";
381 #else // cmd.exe (OS/2) causes SYS0003 error at "/dev/null"
382 string tmp = cmd + ' ' + file + " > nul";
385 return one.startscript(Systemcall::Wait, tmp);
389 bool LaTeX::runMakeIndex(string const & f)
391 lyxerr[Debug::LATEX] << "idx file has been made,"
392 " running makeindex on file "
395 // It should be possible to set the switches for makeindex
396 // sorting style and such. It would also be very convenient
397 // to be able to make style files from within LyX. This has
398 // to come for a later time.
399 string tmp = "makeindex -c -q ";
402 one.startscript(Systemcall::Wait, tmp);
407 vector<Aux_Info> const
408 LaTeX::scanAuxFiles(string const & file)
410 vector<Aux_Info> result;
412 result.push_back(scanAuxFile(file));
414 for (int i = 1; i < 1000; ++i) {
415 string file2 = ChangeExtension(file, "") + '.' + tostr(i)
420 result.push_back(scanAuxFile(file2));
426 Aux_Info const LaTeX::scanAuxFile(string const & file)
429 result.aux_file = file;
430 scanAuxFile(file, result);
435 void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info)
437 lyxerr[Debug::LATEX] << "Scanning aux file: " << file << endl;
439 ifstream ifs(file.c_str());
441 regex reg1("\\\\citation\\{([^}]+)\\}");
442 regex reg2("\\\\bibdata\\{([^}]+)\\}");
443 regex reg3("\\\\bibstyle\\{([^}]+)\\}");
444 regex reg4("\\\\@input\\{([^}]+)\\}");
446 while (getline(ifs, token)) {
447 token = rtrim(token, "\r");
448 #ifndef USE_INCLUDED_STRING
453 if (regex_match(STRCONV(token), sub, reg1)) {
454 string data = STRCONV(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(STRCONV(token), sub, reg2)) {
463 string data = sub.STRCONV(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(STRCONV(token), sub, reg3)) {
475 string style = STRCONV(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(STRCONV(token), sub, reg4)) {
483 string const file2 = STRCONV(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 = "bibtex ";
528 tmp += 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 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
553 if (prefixIs(token, "LaTeX Warning:")) {
554 // Here shall we handle different
556 retval |= LATEX_WARNING;
557 lyxerr[Debug::LATEX] << "LaTeX Warning." << endl;
558 if (contains(token, "Rerun to get cross-references")) {
561 << "We should rerun." << endl;
562 } else if (contains(token, "Citation")
563 && contains(token, "on page")
564 && contains(token, "undefined")) {
567 } else if (prefixIs(token, "Package")) {
569 retval |= PACKAGE_WARNING;
570 if (contains(token, "natbib Warning:")) {
572 if (contains(token, "Citation")
573 && contains(token, "on page")
574 && contains(token, "undefined")) {
577 } else if (contains(token, "run BibTeX")) {
579 } else if (contains(token, "Rerun LaTeX") ||
580 contains(token, "Rerun to get")) {
581 // at least longtable.sty and bibtopic.sty
584 << "We should rerun." << endl;
587 } else if (token[0] == '(') {
588 if (contains(token, "Rerun LaTeX") ||
589 contains(token, "Rerun to get")) {
592 << "We should rerun." << endl;
595 } else if (prefixIs(token, "! ")) {
596 // Ok, we have something that looks like a TeX Error
597 // but what do we really have.
599 // Just get the error description:
600 string desc(token, 2);
601 if (contains(token, "LaTeX Error:"))
602 retval |= LATEX_ERROR;
607 if (!getline(ifs, tmp))
611 } while (!prefixIs(tmp, "l."));
612 if (prefixIs(tmp, "l.")) {
613 // we have a latex error
615 if (contains(desc, "Package babel Error: You haven't defined the language"))
616 retval |= ERROR_RERUN;
617 // get the line number:
619 sscanf(tmp.c_str(), "l.%d", &line);
620 // get the rest of the message:
621 string errstr(tmp, tmp.find(' '));
624 while (!contains(errstr, "l.")
626 && !prefixIs(tmp, "! ")
627 && !contains(tmp, "(job aborted")) {
633 << "line: " << line << '\n'
634 << "Desc: " << desc << '\n'
635 << "Text: " << errstr << endl;
636 if (line == last_line)
642 if (line_count <= 5) {
643 terr.insertError(line, desc, errstr);
648 // information messages, TeX warnings and other
649 // warnings we have not caught earlier.
650 if (prefixIs(token, "Overfull ")) {
651 retval |= TEX_WARNING;
652 } else if (prefixIs(token, "Underfull ")) {
653 retval |= TEX_WARNING;
654 } else if (contains(token, "Rerun to get citations")) {
655 // Natbib seems to use this.
657 } else if (contains(token, "No pages of output")) {
658 // A dvi file was not created
660 } else if (contains(token, "That makes 100 errors")) {
661 // More than 100 errors were reprted
662 retval |= TOO_MANY_ERRORS;
666 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
671 void LaTeX::deplog(DepTable & head)
673 // This function reads the LaTeX log file end extracts all the external
674 // files used by the LaTeX run. The files are then entered into the
677 string const logfile = OnlyFilename(ChangeExtension(file, ".log"));
679 regex reg1("\\)* *\\(([^ )]+).*");
680 regex reg2("File: ([^ ]+).*");
681 regex reg3("No file ([^ ]+)\\..*");
682 regex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*");
683 // If an index should be created, MikTex does not write a line like
684 // \openout# = 'sample,idx'.
685 // but intstead only a line like this into the log:
686 // Writing index file sample.idx
687 regex reg5("Writing index file ([^ ]+).*");
688 regex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$");
690 ifstream ifs(logfile.c_str());
692 // Ok, the scanning of files here is not sufficient.
693 // Sometimes files are named by "File: xxx" only
694 // So I think we should use some regexps to find files instead.
695 // "(\([^ ]+\)" should match the "(file " variant
696 // "File: \([^ ]+\)" should match the "File: file" variant
700 token = rtrim(token, "\r");
701 if (token.empty()) continue;
703 #ifndef USE_INCLUDED_STRING
708 if (regex_match(STRCONV(token), sub, reg1)) {
709 foundfile = STRCONV(sub.str(1));
710 } else if (regex_match(STRCONV(token), sub, reg2)) {
711 foundfile = STRCONV(sub.str(1));
712 } else if (regex_match(STRCONV(token), sub, reg3)) {
713 foundfile = STRCONV(sub.str(1));
714 } else if (regex_match(STRCONV(token), sub, reg4)) {
715 foundfile = STRCONV(sub.str(1));
716 } else if (regex_match(STRCONV(token), sub, reg5)) {
717 foundfile = STRCONV(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(STRCONV(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);