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 "support/filetools.h"
23 #include "support/FileInfo.h"
25 #include "support/lyxlib.h"
26 #include "support/syscall.h"
27 #include "support/syscontr.h"
28 #include "support/path.h"
29 #include "support/LRegex.h"
30 #include "support/LSubstring.h"
31 #include "bufferlist.h"
33 #include "lyx_gui_misc.h"
42 // TODO: in no particular order
43 // - get rid of the extern BufferList and the call to
44 // BufferList::updateIncludedTeXfiles, this should either
45 // be done before calling LaTeX::funcs or in a completely
47 // - the bibtex command options should be supported.
48 // - the makeindex style files should be taken care of with
49 // the dependency mechanism.
50 // - makeindex commandline options should be supported
51 // - somewhere support viewing of bibtex and makeindex log files.
52 // - we should perhaps also scan the bibtex log file
53 // - we should perhaps also scan the bibtex log file
55 extern BufferList bufferlist;
61 void TeXErrors::insertError(int line, string const & error_desc,
62 string const & error_text)
64 Error newerr(line, error_desc, error_text);
65 errors.push_back(newerr);
72 LaTeX::LaTeX(string const & latex, string const & f, string const & p)
73 : cmd(latex), file(f), path(p)
76 depfile = file + ".dep";
77 if (prefixIs(cmd, "pdf")) // Do we use pdflatex ?
82 void LaTeX::deleteFilesOnError() const
84 // currently just a dummy function.
86 // What files do we have to delete?
88 // This will at least make latex do all the runs
91 // but the reason for the error might be in a generated file...
93 string ofname = OnlyFilename(file);
96 string bbl = ChangeExtension(ofname, ".bbl");
100 string ind = ChangeExtension(ofname, ".ind");
103 // Also remove the aux file
104 string aux = ChangeExtension(ofname, ".aux");
109 int LaTeX::run(TeXErrors & terr, LyXFunc * lfun)
110 // We know that this function will only be run if the lyx buffer
111 // has been changed. We also know that a newly written .tex file
112 // is always different from the previous one because of the date
113 // in it. However it seems safe to run latex (at least) on time each
114 // time the .tex file changes.
116 int scanres = NO_ERRORS;
117 unsigned int count = 0; // number of times run
118 num_errors = 0; // just to make sure.
119 const unsigned int MAX_RUN = 6;
120 DepTable head; // empty head
121 bool rerun = false; // rerun requested
123 // The class LaTeX does not know the temp path.
124 bufferlist.updateIncludedTeXfiles(lyx::getcwd()); //GetCWD());
126 // Never write the depfile if an error was encountered.
129 // first check if the file dependencies exist:
130 // ->If it does exist
131 // check if any of the files mentioned in it have
132 // changed (done using a checksum).
134 // run latex once and
135 // remake the dependency file
136 // -> if not changed:
137 // just return there is nothing to do for us.
138 // ->if it doesn't exist
140 // run latex once (we need to run latex once anyway) and
141 // remake the dependency file.
144 FileInfo fi(depfile);
145 bool had_depfile = fi.exist();
146 bool run_bibtex = false;
147 string aux_file = OnlyFilename(ChangeExtension(file, "aux"));
150 lyxerr[Debug::DEPEND] << "Dependency file exists" << endl;
151 // Read the dep file:
153 // Update the checksums
155 if (!head.sumchange()) {
156 lyxerr[Debug::DEPEND] << "return no_change" << endl;
159 lyxerr[Debug::DEPEND]
160 << "Dependency file has changed" << endl;
162 if (head.extchanged(".bib") || head.extchanged(".bst"))
165 lyxerr[Debug::DEPEND]
166 << "Dependency file does not exist" << endl;
168 /// We scan the aux file even when had_depfile = false,
169 /// because we can run pdflatex on the file after running latex on it,
170 /// in which case we will not need to run bibtex again.
171 vector<Aux_Info> bibtex_info_old;
173 bibtex_info_old = scanAuxFiles(aux_file);
176 lyxerr[Debug::LATEX] << "Run #" << count << endl;
177 if (lfun) lfun->Dispatch(LFUN_MESSAGE, _("LaTeX run number") + ' ' + tostr(count));
179 //WriteStatus(lfun, string(_("LaTeX run number ")) + tostr(count));
181 scanres = scanLogFile(terr);
182 if (scanres & ERROR_RERUN) {
183 lyxerr[Debug::LATEX] << "Rerunning LaTeX" << endl;
185 scanres = scanLogFile(terr);
188 if (scanres & ERRORS) {
189 deleteFilesOnError();
190 return scanres; // return on error
193 vector<Aux_Info> const bibtex_info = scanAuxFiles(aux_file);
194 if (!run_bibtex && bibtex_info_old != bibtex_info)
197 // update the dependencies.
198 deplog(head); // reads the latex log
202 // At this point we must run external programs if needed.
203 // makeindex will be run if a .idx file changed or was generated.
204 // And if there were undefined citations or changes in references
205 // the .aux file is checked for signs of bibtex. Bibtex is then run
209 if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
211 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
212 if (lfun) lfun->Dispatch(LFUN_MESSAGE, _("Running MakeIndex."));
213 // WriteStatus(minib, _("Running MakeIndex."));
214 rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
218 // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
219 if (scanres & UNDEF_CIT || run_bibtex) {
220 // Here we must scan the .aux file and look for
221 // "\bibdata" and/or "\bibstyle". If one of those
222 // tags is found -> run bibtex and set rerun = true;
224 lyxerr[Debug::LATEX] << "Running BibTeX." << endl;
225 if (lfun) lfun->Dispatch(LFUN_MESSAGE, _("Running BibTeX."));
226 //WriteStatus(minib, _("Running BibTeX."));
227 updateBibtexDependencies(head, bibtex_info);
228 rerun |= runBibTeX(bibtex_info);
229 } else if (!had_depfile)
230 /// If we run pdflatex on the file after running latex on it,
231 /// then we do not need to run bibtex, but we do need to
232 /// insert the .bib and .bst files into the .dep-pdf file.
233 updateBibtexDependencies(head, bibtex_info);
236 // we know on this point that latex has been run once (or we just
237 // returned) and the question now is to decide if we need to run
238 // it any more. This is done by asking if any of the files in the
239 // dependency file has changed. (remember that the checksum for
240 // a given file is reported to have changed if it just was created)
241 // -> if changed or rerun == true:
242 // run latex once more and
243 // update the dependency structure
244 // -> if not changed:
245 // we does nothing at this point
247 if (rerun || head.sumchange()) {
250 lyxerr[Debug::DEPEND]
251 << "Dep. file has changed or rerun requested" << endl;
253 << "Run #" << count << endl;
254 if (lfun) lfun->Dispatch(LFUN_MESSAGE, _("LaTeX run number") + ' ' + tostr(count));
255 // WriteStatus(minib,
256 // string(_("LaTeX run number ")) + tostr(count));
258 scanres = scanLogFile(terr);
259 if (scanres & ERRORS) {
260 deleteFilesOnError();
261 return scanres; // return on error
264 // update the depedencies
265 deplog(head); // reads the latex log
268 lyxerr[Debug::DEPEND] << "Dep. file has NOT changed" << endl;
272 // The inclusion of files generated by external programs like
273 // makeindex or bibtex might have done changes to pagenumbereing,
274 // etc. And because of this we must run the external programs
275 // again to make sure everything is redone correctly.
276 // Also there should be no need to run the external programs any
279 // run makeindex if the <file>.idx has changed or was generated.
280 if (head.haschanged(OnlyFilename(ChangeExtension(file, ".idx")))) {
282 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
283 if (lfun) lfun->Dispatch(LFUN_MESSAGE, _("Running MakeIndex."));
284 //WriteStatus(minib, _("Running MakeIndex."));
285 rerun = runMakeIndex(OnlyFilename(ChangeExtension(file, ".idx")));
289 // we will only run latex more if the log file asks for it.
290 // or if the sumchange() is true.
291 // -> rerun asked for:
293 // remake the dependency file
294 // goto 2 or return if max runs are reached.
295 // -> rerun not asked for:
296 // just return (fall out of bottom of func)
298 while ((head.sumchange() || rerun || (scanres & RERUN))
299 && count < MAX_RUN) {
300 // Yes rerun until message goes away, or until
301 // MAX_RUNS are reached.
304 lyxerr[Debug::LATEX] << "Run #" << count << endl;
305 if (lfun) lfun->Dispatch(LFUN_MESSAGE, _("LaTeX run numger") + ' ' + tostr(count));
306 // WriteStatus(minib, string(_("LaTeX run number ")) + tostr(count));
308 scanres = scanLogFile(terr);
309 if (scanres & ERRORS) {
310 deleteFilesOnError();
311 return scanres; // return on error
318 // Write the dependencies to file.
320 lyxerr[Debug::LATEX] << "Done." << endl;
325 int LaTeX::operator()()
328 string tmp = cmd + ' ' + QuoteName(file) + " > /dev/null";
329 #else // cmd.exe (OS/2) causes SYS0003 error at "/dev/null"
330 string tmp = cmd + ' ' + file + " > nul";
333 return one.startscript(Systemcalls::System, tmp);
337 bool LaTeX::runMakeIndex(string const & f)
339 lyxerr[Debug::LATEX] << "idx file has been made,"
340 " running makeindex on file "
343 // It should be possible to set the switches for makeindex
344 // sorting style and such. It would also be very convenient
345 // to be able to make style files from within LyX. This has
346 // to come for a later time. (0.13 perhaps?)
347 string tmp = "makeindex -c -q ";
350 one.startscript(Systemcalls::System, tmp);
355 vector<Aux_Info> const
356 LaTeX::scanAuxFiles(string const & file)
358 vector<Aux_Info> result;
360 result.push_back(scanAuxFile(file));
362 for (int i = 1; i < 1000; ++i) {
363 string file2 = ChangeExtension(file, "") + "." + tostr(i)
368 result.push_back(scanAuxFile(file2));
374 Aux_Info const LaTeX::scanAuxFile(string const & file)
377 result.aux_file = file;
378 scanAuxFile(file, result);
383 void LaTeX::scanAuxFile(string const & file, Aux_Info & aux_info)
385 lyxerr[Debug::LATEX] << "Scanning aux file: " << file << endl;
387 ifstream ifs(file.c_str());
389 LRegex reg1("\\\\citation\\{([^}]+)\\}");
390 LRegex reg2("\\\\bibdata\\{([^}]+)\\}");
391 LRegex reg3("\\\\bibstyle\\{([^}]+)\\}");
392 LRegex reg4("\\\\@input\\{([^}]+)\\}");
394 while (getline(ifs, token)) {
395 if (reg1.exact_match(token)) {
396 LRegex::SubMatches const & sub = reg1.exec(token);
397 string data = LSubstring(token, sub[1].first,
399 while (!data.empty()) {
401 data = split(data, citation, ',');
402 lyxerr[Debug::LATEX] << "Citation: "
404 aux_info.citations.insert(citation);
406 } else if (reg2.exact_match(token)) {
407 LRegex::SubMatches const & sub = reg2.exec(token);
408 string data = LSubstring(token, sub[1].first,
410 // data is now all the bib files separated by ','
411 // get them one by one and pass them to the helper
412 while (!data.empty()) {
414 data = split(data, database, ',');
415 database = ChangeExtension(database, "bib");
416 lyxerr[Debug::LATEX] << "Bibtex database: `"
417 << database << "'" << endl;
418 aux_info.databases.insert(database);
420 } else if (reg3.exact_match(token)) {
421 LRegex::SubMatches const & sub = reg3.exec(token);
422 string style = LSubstring(token, sub[1].first,
424 // token is now the style file
425 // pass it to the helper
426 style = ChangeExtension(style, "bst");
427 lyxerr[Debug::LATEX] << "Bibtex style: `"
428 << style << "'" << endl;
429 aux_info.styles.insert(style);
430 } else if (reg4.exact_match(token)) {
431 LRegex::SubMatches const & sub = reg4.exec(token);
432 string file2 = LSubstring(token, sub[1].first,
434 scanAuxFile(file2, aux_info);
440 void LaTeX::updateBibtexDependencies(DepTable & dep,
441 vector<Aux_Info> const & bibtex_info)
443 // Since a run of Bibtex mandates more latex runs it is ok to
444 // remove all ".bib" and ".bst" files.
445 dep.remove_files_with_extension(".bib");
446 dep.remove_files_with_extension(".bst");
447 string aux = OnlyFilename(ChangeExtension(file, ".aux"));
449 for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
450 it != bibtex_info.end(); ++it) {
451 for (set<string>::const_iterator it2 = it->databases.begin();
452 it2 != it->databases.end(); ++it2) {
453 string file = findtexfile(*it2, "bib");
455 dep.insert(file, true);
458 for (set<string>::const_iterator it2 = it->styles.begin();
459 it2 != it->styles.end(); ++it2) {
460 string file = findtexfile(*it2, "bst");
462 dep.insert(file, true);
468 bool LaTeX::runBibTeX(vector<Aux_Info> const & bibtex_info)
471 for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
472 it != bibtex_info.end(); ++it) {
473 if (it->databases.empty())
477 string tmp = "bibtex ";
478 tmp += OnlyFilename(ChangeExtension(it->aux_file, string()));
480 one.startscript(Systemcalls::System, tmp);
482 // Return whether bibtex was run
487 int LaTeX::scanLogFile(TeXErrors & terr)
491 int retval = NO_ERRORS;
492 string tmp = OnlyFilename(ChangeExtension(file, ".log"));
493 lyxerr[Debug::LATEX] << "Log file: " << tmp << endl;
494 ifstream ifs(tmp.c_str());
497 while (getline(ifs, token)) {
498 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
503 if (prefixIs(token, "LaTeX Warning:")) {
504 // Here shall we handle different
506 retval |= LATEX_WARNING;
507 lyxerr[Debug::LATEX] << "LaTeX Warning." << endl;
508 if (contains(token, "Rerun to get cross-references")) {
511 << "We should rerun." << endl;
512 } else if (contains(token, "Citation")
513 && contains(token, "on page")
514 && contains(token, "undefined")) {
517 } else if (prefixIs(token, "Package")) {
519 retval |= PACKAGE_WARNING;
520 if (contains(token, "natbib Warning:")) {
522 if (contains(token, "Citation")
523 && contains(token, "on page")
524 && contains(token, "undefined")) {
527 } else if (contains(token, "run BibTeX")) {
529 } else if (contains(token, "Rerun LaTeX.")) {
530 // at least longtable.sty might use this.
533 } else if (prefixIs(token, "! ")) {
534 // Ok, we have something that looks like a TeX Error
535 // but what do we really have.
537 // Just get the error description:
538 string desc(token, 2);
539 if (contains(token, "LaTeX Error:"))
540 retval |= LATEX_ERROR;
545 if (!getline(ifs, tmp))
549 } while (!prefixIs(tmp, "l."));
550 if (prefixIs(tmp, "l.")) {
551 // we have a latex error
553 if (contains(desc, "Package babel Error: You haven't defined the language"))
554 retval |= ERROR_RERUN;
555 // get the line number:
557 sscanf(tmp.c_str(), "l.%d", &line);
558 // get the rest of the message:
559 string errstr(tmp, tmp.find(' '));
562 while (!contains(errstr, "l.")
564 && !prefixIs(tmp, "! ")
565 && !contains(tmp, "(job aborted")) {
571 << "line: " << line << '\n'
572 << "Desc: " << desc << '\n'
573 << "Text: " << errstr << endl;
574 if (line == last_line)
580 if (line_count <= 5) {
581 terr.insertError(line, desc, errstr);
586 // information messages, TeX warnings and other
587 // warnings we have not caught earlier.
588 if (prefixIs(token, "Overfull ")) {
589 retval |= TEX_WARNING;
590 } else if (prefixIs(token, "Underfull ")) {
591 retval |= TEX_WARNING;
592 } else if (contains(token, "Rerun to get citations")) {
593 // Natbib seems to use this.
595 } else if (contains(token, "No pages of output")) {
596 // A dvi file was not created
598 } else if (contains(token, "That makes 100 errors")) {
599 // More than 100 errors were reprted
600 retval |= TOO_MANY_ERRORS;
604 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
609 void LaTeX::deplog(DepTable & head)
611 // This function reads the LaTeX log file end extracts all the external
612 // files used by the LaTeX run. The files are then entered into the
615 string const logfile = OnlyFilename(ChangeExtension(file, ".log"));
617 LRegex reg1("\\)* *\\(([^ )]+).*");
618 LRegex reg2("File: ([^ ]+).*");
619 LRegex reg3("No file ([^ ]+)\\..*");
620 LRegex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*");
621 LRegex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$");
623 ifstream ifs(logfile.c_str());
625 // Ok, the scanning of files here is not sufficient.
626 // Sometimes files are named by "File: xxx" only
627 // So I think we should use some regexps to find files instead.
628 // "(\([^ ]+\)" should match the "(file " variant
629 // "File: \([^ ]+\)" should match the "File: file" variant
633 if (token.empty()) continue;
635 if (reg1.exact_match(token)) {
636 LRegex::SubMatches const & sub = reg1.exec(token);
637 foundfile = LSubstring(token, sub[1].first,
639 } else if (reg2.exact_match(token)) {
640 LRegex::SubMatches const & sub = reg2.exec(token);
641 foundfile = LSubstring(token, sub[1].first,
643 } else if (reg3.exact_match(token)) {
644 LRegex::SubMatches const & sub = reg3.exec(token);
645 foundfile = LSubstring(token, sub[1].first,
647 } else if (reg4.exact_match(token)) {
648 LRegex::SubMatches const & sub = reg4.exec(token);
649 foundfile = LSubstring(token, sub[1].first,
655 lyxerr[Debug::DEPEND] << "Found file: "
656 << foundfile << endl;
658 // Ok now we found a file.
659 // Now we should make sure that this is a file that we can
660 // access through the normal paths.
661 // We will not try any fancy search methods to
664 // (1) foundfile is an
665 // absolute path and should
667 if (AbsolutePath(foundfile)) {
668 lyxerr[Debug::DEPEND] << "AbsolutePath file: "
669 << foundfile << endl;
670 // On initial insert we want to do the update at once
671 // since this file can not be a file generated by
673 if (FileInfo(foundfile).exist())
674 head.insert(foundfile, true);
677 // (2) foundfile is in the tmpdir
678 // insert it into head
679 else if (FileInfo(OnlyFilename(foundfile)).exist()) {
680 if (unwanted.exact_match(foundfile)) {
681 lyxerr[Debug::DEPEND]
683 << OnlyFilename(foundfile)
684 << " in the dep file"
686 } else if (suffixIs(foundfile, ".tex")) {
687 // This is a tex file generated by LyX
688 // and latex is not likely to change this
690 lyxerr[Debug::DEPEND]
691 << "Tmpdir TeX file: "
692 << OnlyFilename(foundfile)
694 head.insert(foundfile, true);
696 lyxerr[Debug::DEPEND]
698 << OnlyFilename(foundfile)
700 head.insert(OnlyFilename(foundfile));
703 lyxerr[Debug::DEPEND]
704 << "Not a file or we are unable to find it."
708 // Make sure that the main .tex file is in the dependancy file.
709 head.insert(OnlyFilename(file), true);