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 #pragma implementation
21 #include "bufferlist.h"
25 #include "support/filetools.h"
26 #include "support/FileInfo.h"
27 #include "support/lstrings.h"
28 #include "support/lyxlib.h"
29 #include "support/systemcall.h"
30 #include "support/os.h"
31 #include "support/path.h"
33 #include <boost/regex.hpp>
36 #include <cstdio> // sscanf
38 #ifndef CXX_GLOBAL_CSTD
48 using boost::regex_match;
51 // TODO: in no particular order
52 // - get rid of the extern BufferList and the call to
53 // BufferList::updateIncludedTeXfiles, this should either
54 // be done before calling LaTeX::funcs or in a completely
56 // - the bibtex command options should be supported.
57 // - the makeindex style files should be taken care of with
58 // the dependency mechanism.
59 // - makeindex commandline options should be supported
60 // - somewhere support viewing of bibtex and makeindex log files.
61 // - we should perhaps also scan the bibtex log file
62 // - we should perhaps also scan the bibtex log file
64 extern BufferList bufferlist;
70 void TeXErrors::insertError(int line, string const & error_desc,
71 string const & error_text)
73 Error newerr(line, error_desc, error_text);
74 errors.push_back(newerr);
81 LaTeX::LaTeX(string const & latex, string const & f, string const & p)
82 : cmd(latex), file(f), path(p)
85 depfile = file + ".dep";
86 if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
88 output_file = ChangeExtension(file,".pdf");
90 output_file = ChangeExtension(file,".dvi");
95 void LaTeX::deleteFilesOnError() const
97 // currently just a dummy function.
99 // What files do we have to delete?
101 // This will at least make latex do all the runs
102 lyx::unlink(depfile);
104 // but the reason for the error might be in a generated file...
106 string ofname = OnlyFilename(file);
109 string bbl = ChangeExtension(ofname, ".bbl");
113 string ind = ChangeExtension(ofname, ".ind");
116 // Also remove the aux file
117 string aux = ChangeExtension(ofname, ".aux");
122 int LaTeX::run(TeXErrors & terr, LyXFunc * lfun)
123 // We know that this function will only be run if the lyx buffer
124 // has been changed. We also know that a newly written .tex file
125 // is always different from the previous one because of the date
126 // in it. However it seems safe to run latex (at least) on time each
127 // time the .tex file changes.
129 int scanres = NO_ERRORS;
130 unsigned int count = 0; // number of times run
131 num_errors = 0; // just to make sure.
132 const unsigned int MAX_RUN = 6;
133 DepTable head; // empty head
134 bool rerun = false; // rerun requested
136 // The class LaTeX does not know the temp path.
137 bufferlist.updateIncludedTeXfiles(lyx::getcwd()); //GetCWD());
139 // Never write the depfile if an error was encountered.
142 // first check if the file dependencies exist:
143 // ->If it does exist
144 // check if any of the files mentioned in it have
145 // changed (done using a checksum).
147 // run latex once and
148 // remake the dependency file
149 // -> if not changed:
150 // just return there is nothing to do for us.
151 // ->if it doesn't exist
153 // run latex once (we need to run latex once anyway) and
154 // remake the dependency file.
157 FileInfo fi(depfile);
158 bool had_depfile = fi.exist();
159 bool run_bibtex = false;
160 string aux_file = OnlyFilename(ChangeExtension(file, "aux"));
163 lyxerr[Debug::DEPEND] << "Dependency file exists" << endl;
164 // Read the dep file:
166 // Update the checksums
168 // Can't just check if anything has changed because it might have aborted
169 // on error last time... in which cas we need to re-run latex
170 // and collect the error messages (even if they are the same).
171 if (!FileInfo(output_file).exist()) {
172 lyxerr[Debug::DEPEND]
173 << "re-running LaTeX because output file doesn't exist." << endl;
174 } else if (!head.sumchange()) {
175 lyxerr[Debug::DEPEND] << "return no_change" << endl;
178 lyxerr[Debug::DEPEND]
179 << "Dependency file has changed" << endl;
182 if (head.extchanged(".bib") || head.extchanged(".bst"))
185 lyxerr[Debug::DEPEND]
186 << "Dependency file does not exist" << endl;
188 /// We scan the aux file even when had_depfile = false,
189 /// because we can run pdflatex on the file after running latex on it,
190 /// in which case we will not need to run bibtex again.
191 vector<Aux_Info> bibtex_info_old;
193 bibtex_info_old = scanAuxFiles(aux_file);
196 lyxerr[Debug::LATEX] << "Run #" << count << endl;
199 str << _("LaTeX run number") << ' ' << count;
200 lfun->dispatch(LFUN_MESSAGE, str.str().c_str());
204 scanres = scanLogFile(terr);
205 if (scanres & ERROR_RERUN) {
206 lyxerr[Debug::LATEX] << "Rerunning LaTeX" << endl;
208 scanres = scanLogFile(terr);
211 if (scanres & ERRORS) {
212 deleteFilesOnError();
213 return scanres; // return on error
216 vector<Aux_Info> const bibtex_info = scanAuxFiles(aux_file);
217 if (!run_bibtex && bibtex_info_old != bibtex_info)
220 // update the dependencies.
221 deplog(head); // reads the latex log
225 // At this point we must run external programs if needed.
226 // makeindex will be run if a .idx file changed or was generated.
227 // And if there were undefined citations or changes in references
228 // the .aux file is checked for signs of bibtex. Bibtex is then run
232 if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
234 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
236 lfun->dispatch(LFUN_MESSAGE, _("Running MakeIndex."));
239 rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
243 // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
244 if (scanres & UNDEF_CIT || run_bibtex) {
245 // Here we must scan the .aux file and look for
246 // "\bibdata" and/or "\bibstyle". If one of those
247 // tags is found -> run bibtex and set rerun = true;
249 lyxerr[Debug::LATEX] << "Running BibTeX." << endl;
251 lfun->dispatch(LFUN_MESSAGE, _("Running BibTeX."));
254 updateBibtexDependencies(head, bibtex_info);
255 rerun |= runBibTeX(bibtex_info);
256 } else if (!had_depfile) {
257 /// If we run pdflatex on the file after running latex on it,
258 /// then we do not need to run bibtex, but we do need to
259 /// insert the .bib and .bst files into the .dep-pdf file.
260 updateBibtexDependencies(head, bibtex_info);
264 // we know on this point that latex has been run once (or we just
265 // returned) and the question now is to decide if we need to run
266 // it any more. This is done by asking if any of the files in the
267 // dependency file has changed. (remember that the checksum for
268 // a given file is reported to have changed if it just was created)
269 // -> if changed or rerun == true:
270 // run latex once more and
271 // update the dependency structure
272 // -> if not changed:
273 // we does nothing at this point
275 if (rerun || head.sumchange()) {
278 lyxerr[Debug::DEPEND]
279 << "Dep. file has changed or rerun requested" << endl;
281 << "Run #" << count << endl;
284 str << _("LaTeX run number") << ' ' << count;
285 lfun->dispatch(LFUN_MESSAGE, str.str().c_str());
289 scanres = scanLogFile(terr);
290 if (scanres & ERRORS) {
291 deleteFilesOnError();
292 return scanres; // return on error
295 // update the depedencies
296 deplog(head); // reads the latex log
299 lyxerr[Debug::DEPEND] << "Dep. file has NOT changed" << endl;
303 // The inclusion of files generated by external programs like
304 // makeindex or bibtex might have done changes to pagenumbereing,
305 // etc. And because of this we must run the external programs
306 // again to make sure everything is redone correctly.
307 // Also there should be no need to run the external programs any
310 // run makeindex if the <file>.idx has changed or was generated.
311 if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
313 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
315 lfun->dispatch(LFUN_MESSAGE, _("Running MakeIndex."));
318 rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
322 // we will only run latex more if the log file asks for it.
323 // or if the sumchange() is true.
324 // -> rerun asked for:
326 // remake the dependency file
327 // goto 2 or return if max runs are reached.
328 // -> rerun not asked for:
329 // just return (fall out of bottom of func)
331 while ((head.sumchange() || rerun || (scanres & RERUN))
332 && count < MAX_RUN) {
333 // Yes rerun until message goes away, or until
334 // MAX_RUNS are reached.
337 lyxerr[Debug::LATEX] << "Run #" << count << endl;
340 str << _("LaTeX run number") << ' ' << count;
341 lfun->dispatch(LFUN_MESSAGE, str.str().c_str());
345 scanres = scanLogFile(terr);
346 if (scanres & ERRORS) {
347 deleteFilesOnError();
348 return scanres; // return on error
355 // Write the dependencies to file.
357 lyxerr[Debug::LATEX] << "Done." << endl;
362 int LaTeX::operator()()
365 string tmp = cmd + ' ' + QuoteName(file) + " > /dev/null";
366 #else // cmd.exe (OS/2) causes SYS0003 error at "/dev/null"
367 string tmp = cmd + ' ' + file + " > nul";
370 return one.startscript(Systemcall::Wait, tmp);
374 bool LaTeX::runMakeIndex(string const & f)
376 lyxerr[Debug::LATEX] << "idx file has been made,"
377 " running makeindex on file "
380 // It should be possible to set the switches for makeindex
381 // sorting style and such. It would also be very convenient
382 // to be able to make style files from within LyX. This has
383 // to come for a later time.
384 string tmp = "makeindex -c -q ";
387 one.startscript(Systemcall::Wait, tmp);
392 vector<Aux_Info> const
393 LaTeX::scanAuxFiles(string const & file)
395 vector<Aux_Info> result;
397 result.push_back(scanAuxFile(file));
399 for (int i = 1; i < 1000; ++i) {
400 string file2 = ChangeExtension(file, "") + "." + tostr(i)
405 result.push_back(scanAuxFile(file2));
411 Aux_Info const LaTeX::scanAuxFile(string const & file)
414 result.aux_file = file;
415 scanAuxFile(file, result);
420 void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info)
422 lyxerr[Debug::LATEX] << "Scanning aux file: " << file << endl;
424 ifstream ifs(file.c_str());
426 regex reg1("\\\\citation\\{([^}]+)\\}");
427 regex reg2("\\\\bibdata\\{([^}]+)\\}");
428 regex reg3("\\\\bibstyle\\{([^}]+)\\}");
429 regex reg4("\\\\@input\\{([^}]+)\\}");
431 while (getline(ifs, token)) {
432 token = strip(token, '\r');
434 if (regex_match(token, sub, reg1)) {
435 string data = sub[1];
436 while (!data.empty()) {
438 data = split(data, citation, ',');
439 lyxerr[Debug::LATEX] << "Citation: "
441 aux_info.citations.insert(citation);
443 } else if (regex_match(token, sub, reg2)) {
444 string data = sub[1];
445 // data is now all the bib files separated by ','
446 // get them one by one and pass them to the helper
447 while (!data.empty()) {
449 data = split(data, database, ',');
450 database = ChangeExtension(database, "bib");
451 lyxerr[Debug::LATEX] << "Bibtex database: `"
452 << database << "'" << endl;
453 aux_info.databases.insert(database);
455 } else if (regex_match(token, sub, reg3)) {
456 string style = sub[1];
457 // token is now the style file
458 // pass it to the helper
459 style = ChangeExtension(style, "bst");
460 lyxerr[Debug::LATEX] << "Bibtex style: `"
461 << style << "'" << endl;
462 aux_info.styles.insert(style);
463 } else if (regex_match(token, sub, reg4)) {
464 string file2 = sub[1];
465 scanAuxFile(file2, aux_info);
471 void LaTeX::updateBibtexDependencies(DepTable & dep,
472 vector<Aux_Info> const & bibtex_info)
474 // Since a run of Bibtex mandates more latex runs it is ok to
475 // remove all ".bib" and ".bst" files.
476 dep.remove_files_with_extension(".bib");
477 dep.remove_files_with_extension(".bst");
478 //string aux = OnlyFilename(ChangeExtension(file, ".aux"));
480 for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
481 it != bibtex_info.end(); ++it) {
482 for (set<string>::const_iterator it2 = it->databases.begin();
483 it2 != it->databases.end(); ++it2) {
484 string file = findtexfile(*it2, "bib");
486 dep.insert(file, true);
489 for (set<string>::const_iterator it2 = it->styles.begin();
490 it2 != it->styles.end(); ++it2) {
491 string file = findtexfile(*it2, "bst");
493 dep.insert(file, true);
499 bool LaTeX::runBibTeX(vector<Aux_Info> const & bibtex_info)
502 for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
503 it != bibtex_info.end(); ++it) {
504 if (it->databases.empty())
508 string tmp = "bibtex ";
509 tmp += OnlyFilename(ChangeExtension(it->aux_file, string()));
511 one.startscript(Systemcall::Wait, tmp);
513 // Return whether bibtex was run
518 int LaTeX::scanLogFile(TeXErrors & terr)
522 int retval = NO_ERRORS;
523 string tmp = OnlyFilename(ChangeExtension(file, ".log"));
524 lyxerr[Debug::LATEX] << "Log file: " << tmp << endl;
525 ifstream ifs(tmp.c_str());
528 while (getline(ifs, token)) {
529 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
534 if (prefixIs(token, "LaTeX Warning:")) {
535 // Here shall we handle different
537 retval |= LATEX_WARNING;
538 lyxerr[Debug::LATEX] << "LaTeX Warning." << endl;
539 if (contains(token, "Rerun to get cross-references")) {
542 << "We should rerun." << endl;
543 } else if (contains(token, "Citation")
544 && contains(token, "on page")
545 && contains(token, "undefined")) {
548 } else if (prefixIs(token, "Package")) {
550 retval |= PACKAGE_WARNING;
551 if (contains(token, "natbib Warning:")) {
553 if (contains(token, "Citation")
554 && contains(token, "on page")
555 && contains(token, "undefined")) {
558 } else if (contains(token, "run BibTeX")) {
560 } else if (contains(token, "Rerun LaTeX") ||
561 contains(token, "Rerun to get")) {
562 // at least longtable.sty and bibtopic.sty
565 << "We should rerun." << endl;
568 } else if (prefixIs(token, "(")) {
569 if (contains(token, "Rerun LaTeX") ||
570 contains(token, "Rerun to get")) {
573 << "We should rerun." << endl;
576 } else if (prefixIs(token, "! ")) {
577 // Ok, we have something that looks like a TeX Error
578 // but what do we really have.
580 // Just get the error description:
581 string desc(token, 2);
582 if (contains(token, "LaTeX Error:"))
583 retval |= LATEX_ERROR;
588 if (!getline(ifs, tmp))
592 } while (!prefixIs(tmp, "l."));
593 if (prefixIs(tmp, "l.")) {
594 // we have a latex error
596 if (contains(desc, "Package babel Error: You haven't defined the language"))
597 retval |= ERROR_RERUN;
598 // get the line number:
600 sscanf(tmp.c_str(), "l.%d", &line);
601 // get the rest of the message:
602 string errstr(tmp, tmp.find(' '));
605 while (!contains(errstr, "l.")
607 && !prefixIs(tmp, "! ")
608 && !contains(tmp, "(job aborted")) {
614 << "line: " << line << '\n'
615 << "Desc: " << desc << '\n'
616 << "Text: " << errstr << endl;
617 if (line == last_line)
623 if (line_count <= 5) {
624 terr.insertError(line, desc, errstr);
629 // information messages, TeX warnings and other
630 // warnings we have not caught earlier.
631 if (prefixIs(token, "Overfull ")) {
632 retval |= TEX_WARNING;
633 } else if (prefixIs(token, "Underfull ")) {
634 retval |= TEX_WARNING;
635 } else if (contains(token, "Rerun to get citations")) {
636 // Natbib seems to use this.
638 } else if (contains(token, "No pages of output")) {
639 // A dvi file was not created
641 } else if (contains(token, "That makes 100 errors")) {
642 // More than 100 errors were reprted
643 retval |= TOO_MANY_ERRORS;
647 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
652 void LaTeX::deplog(DepTable & head)
654 // This function reads the LaTeX log file end extracts all the external
655 // files used by the LaTeX run. The files are then entered into the
658 string const logfile = OnlyFilename(ChangeExtension(file, ".log"));
660 regex reg1("\\)* *\\(([^ )]+).*");
661 regex reg2("File: ([^ ]+).*");
662 regex reg3("No file ([^ ]+)\\..*");
663 regex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*");
664 // If an index should be created, MikTex does not write a line like
665 // \openout# = 'sample,idx'.
666 // but intstead only a line like this into the log:
667 // Writing index file sample.idx
668 regex reg5("Writing index file ([^ ]+).*");
669 regex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$");
671 ifstream ifs(logfile.c_str());
673 // Ok, the scanning of files here is not sufficient.
674 // Sometimes files are named by "File: xxx" only
675 // So I think we should use some regexps to find files instead.
676 // "(\([^ ]+\)" should match the "(file " variant
677 // "File: \([^ ]+\)" should match the "File: file" variant
681 token = strip(token, '\r');
682 if (token.empty()) continue;
685 if (regex_match(token, sub, reg1)) {
687 } else if (regex_match(token, sub, reg2)) {
689 } else if (regex_match(token, sub, reg3)) {
691 } else if (regex_match(token, sub, reg4)) {
693 } else if (regex_match(token, sub, reg5)) {
699 // convert from native os path to unix path
700 foundfile = os::internal_path(foundfile);
702 lyxerr[Debug::DEPEND] << "Found file: "
703 << foundfile << endl;
705 // Ok now we found a file.
706 // Now we should make sure that this is a file that we can
707 // access through the normal paths.
708 // We will not try any fancy search methods to
711 // (1) foundfile is an
712 // absolute path and should
714 if (AbsolutePath(foundfile)) {
715 lyxerr[Debug::DEPEND] << "AbsolutePath file: "
716 << foundfile << endl;
717 // On initial insert we want to do the update at once
718 // since this file can not be a file generated by
720 if (FileInfo(foundfile).exist())
721 head.insert(foundfile, true);
724 // (2) foundfile is in the tmpdir
725 // insert it into head
726 else if (FileInfo(OnlyFilename(foundfile)).exist()) {
727 if (regex_match(foundfile, unwanted)) {
728 lyxerr[Debug::DEPEND]
730 << OnlyFilename(foundfile)
731 << " in the dep file"
733 } else if (suffixIs(foundfile, ".tex")) {
734 // This is a tex file generated by LyX
735 // and latex is not likely to change this
737 lyxerr[Debug::DEPEND]
738 << "Tmpdir TeX file: "
739 << OnlyFilename(foundfile)
741 head.insert(foundfile, true);
743 lyxerr[Debug::DEPEND]
745 << OnlyFilename(foundfile)
747 head.insert(OnlyFilename(foundfile));
750 lyxerr[Debug::DEPEND]
751 << "Not a file or we are unable to find it."
755 // Make sure that the main .tex file is in the dependancy file.
756 head.insert(OnlyFilename(file), true);