src/LaTeX.C

   1 /**
   2  * \file LaTeX.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alfredo Braunstein
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author Angus Leeming
  10  * \author Dekel Tsur
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "bufferlist.h"
  18 #include "LaTeX.h"
  19 #include "gettext.h"
  20 #include "lyxrc.h"
  21 #include "debug.h"
  22 #include "DepTable.h"
  23
  24 #include "support/filetools.h"
  25 #include "support/convert.h"
  26 #include "support/lstrings.h"
  27 #include "support/lyxlib.h"
  28 #include "support/systemcall.h"
  29 #include "support/os.h"
  30
  31 #include <boost/filesystem/operations.hpp>
  32 #include <boost/regex.hpp>
  33
  34 #include <fstream>
  35
  36
  37 namespace lyx {
  38
  39 using support::absolutePath;
  40 using support::bformat;
  41 using support::changeExtension;
  42 using support::contains;
  43 using support::FileName;
  44 using support::findtexfile;
  45 using support::getcwd;
  46 using support::makeAbsPath;
  47 using support::onlyFilename;
  48 using support::prefixIs;
  49 using support::quoteName;
  50 using support::removeExtension;
  51 using support::rtrim;
  52 using support::split;
  53 using support::subst;
  54 using support::suffixIs;
  55 using support::Systemcall;
  56 using support::unlink;
  57 using support::trim;
  58
  59 namespace os = support::os;
  60 namespace fs = boost::filesystem;
  61
  62 using boost::regex;
  63 using boost::smatch;
  64
  65
  66 #ifndef CXX_GLOBAL_CSTD
  67 using std::sscanf;
  68 #endif
  69
  70 using std::endl;
  71 using std::getline;
  72 using std::string;
  73 using std::ifstream;
  74 using std::set;
  75 using std::vector;
  76
  77 // TODO: in no particular order
  78 // - get rid of the call to
  79 //   BufferList::updateIncludedTeXfiles, this should either
  80 //   be done before calling LaTeX::funcs or in a completely
  81 //   different way.
  82 // - the makeindex style files should be taken care of with
  83 //   the dependency mechanism.
  84 // - makeindex commandline options should be supported
  85 // - somewhere support viewing of bibtex and makeindex log files.
  86 // - we should perhaps also scan the bibtex log file
  87
  88 namespace {
  89
  90 docstring runMessage(unsigned int count)
  91 {
  92         return bformat(_("Waiting for LaTeX run number %1$d"), count);
  93 }
  94
  95 } // anon namespace
  96
  97 /*
  98  * CLASS TEXERRORS
  99  */
 100
 101 void TeXErrors::insertError(int line, docstring const & error_desc,
 102                             docstring const & error_text)
 103 {
 104         Error newerr(line, error_desc, error_text);
 105         errors.push_back(newerr);
 106 }
 107
 108
 109 bool operator==(Aux_Info const & a, Aux_Info const & o)
 110 {
 111         return a.aux_file == o.aux_file &&
 112                 a.citations == o.citations &&
 113                 a.databases == o.databases &&
 114                 a.styles == o.styles;
 115 }
 116
 117
 118 bool operator!=(Aux_Info const & a, Aux_Info const & o)
 119 {
 120         return !(a == o);
 121 }
 122
 123
 124 /*
 125  * CLASS LaTeX
 126  */
 127
 128 LaTeX::LaTeX(string const & latex, OutputParams const & rp,
 129              FileName const & f)
 130         : cmd(latex), file(f), runparams(rp)
 131 {
 132         num_errors = 0;
 133         if (prefixIs(cmd, "pdf")) { // Do we use pdflatex ?
 134                 depfile = FileName(file.absFilename() + ".dep-pdf");
 135                 output_file = FileName(changeExtension(file.absFilename(), ".pdf"));
 136         } else {
 137                 depfile = FileName(file.absFilename() + ".dep");
 138                 output_file = FileName(changeExtension(file.absFilename(), ".dvi"));
 139         }
 140 }
 141
 142
 143 void LaTeX::deleteFilesOnError() const
 144 {
 145         // currently just a dummy function.
 146
 147         // What files do we have to delete?
 148
 149         // This will at least make latex do all the runs
 150         unlink(depfile);
 151
 152         // but the reason for the error might be in a generated file...
 153
 154         // bibtex file
 155         FileName const bbl(changeExtension(file.absFilename(), ".bbl"));
 156         unlink(bbl);
 157
 158         // makeindex file
 159         FileName const ind(changeExtension(file.absFilename(), ".ind"));
 160         unlink(ind);
 161
 162         // nomencl file
 163         FileName const nls(changeExtension(file.absFilename(), ".nls"));
 164         unlink(nls);
 165
 166         // Also remove the aux file
 167         FileName const aux(changeExtension(file.absFilename(), ".aux"));
 168         unlink(aux);
 169 }
 170
 171
 172 int LaTeX::run(TeXErrors & terr)
 173         // We know that this function will only be run if the lyx buffer
 174         // has been changed. We also know that a newly written .tex file
 175         // is always different from the previous one because of the date
 176         // in it. However it seems safe to run latex (at least) on time each
 177         // time the .tex file changes.
 178 {
 179         int scanres = NO_ERRORS;
 180         unsigned int count = 0; // number of times run
 181         num_errors = 0; // just to make sure.
 182         unsigned int const MAX_RUN = 6;
 183         DepTable head; // empty head
 184         bool rerun = false; // rerun requested
 185
 186         // The class LaTeX does not know the temp path.
 187         theBufferList().updateIncludedTeXfiles(getcwd(), runparams);
 188
 189         // Never write the depfile if an error was encountered.
 190
 191         // 0
 192         // first check if the file dependencies exist:
 193         //     ->If it does exist
 194         //             check if any of the files mentioned in it have
 195         //             changed (done using a checksum).
 196         //                 -> if changed:
 197         //                        run latex once and
 198         //                        remake the dependency file
 199         //                 -> if not changed:
 200         //                        just return there is nothing to do for us.
 201         //     ->if it doesn't exist
 202         //             make it and
 203         //             run latex once (we need to run latex once anyway) and
 204         //             remake the dependency file.
 205         //
 206
 207         bool had_depfile = fs::exists(depfile.toFilesystemEncoding());
 208         bool run_bibtex = false;
 209         FileName const aux_file(changeExtension(file.absFilename(), "aux"));
 210
 211         if (had_depfile) {
 212                 lyxerr[Debug::DEPEND] << "Dependency file exists" << endl;
 213                 // Read the dep file:
 214                 had_depfile = head.read(depfile);
 215         }
 216
 217         if (had_depfile) {
 218                 // Update the checksums
 219                 head.update();
 220                 // Can't just check if anything has changed because it might have aborted
 221                 // on error last time... in which cas we need to re-run latex
 222                 // and collect the error messages (even if they are the same).
 223                 if (!fs::exists(output_file.toFilesystemEncoding())) {
 224                         lyxerr[Debug::DEPEND]
 225                                 << "re-running LaTeX because output file doesn't exist." << endl;
 226                 } else if (!head.sumchange()) {
 227                         lyxerr[Debug::DEPEND] << "return no_change" << endl;
 228                         return NO_CHANGE;
 229                 } else {
 230                         lyxerr[Debug::DEPEND]
 231                                 << "Dependency file has changed" << endl;
 232                 }
 233
 234                 if (head.extchanged(".bib") || head.extchanged(".bst"))
 235                         run_bibtex = true;
 236         } else
 237                 lyxerr[Debug::DEPEND]
 238                         << "Dependency file does not exist, or has wrong format" << endl;
 239
 240         /// We scan the aux file even when had_depfile = false,
 241         /// because we can run pdflatex on the file after running latex on it,
 242         /// in which case we will not need to run bibtex again.
 243         vector<Aux_Info> bibtex_info_old;
 244         if (!run_bibtex)
 245                 bibtex_info_old = scanAuxFiles(aux_file);
 246
 247         ++count;
 248         lyxerr[Debug::LATEX] << "Run #" << count << endl;
 249         message(runMessage(count));
 250
 251         startscript();
 252         scanres = scanLogFile(terr);
 253         if (scanres & ERROR_RERUN) {
 254                 lyxerr[Debug::LATEX] << "Rerunning LaTeX" << endl;
 255                 startscript();
 256                 scanres = scanLogFile(terr);
 257         }
 258
 259         if (scanres & ERRORS) {
 260                 deleteFilesOnError();
 261                 return scanres; // return on error
 262         }
 263
 264         vector<Aux_Info> const bibtex_info = scanAuxFiles(aux_file);
 265         if (!run_bibtex && bibtex_info_old != bibtex_info)
 266                 run_bibtex = true;
 267
 268         // update the dependencies.
 269         deplog(head); // reads the latex log
 270         head.update();
 271
 272         // 0.5
 273         // At this point we must run external programs if needed.
 274         // makeindex will be run if a .idx file changed or was generated.
 275         // And if there were undefined citations or changes in references
 276         // the .aux file is checked for signs of bibtex. Bibtex is then run
 277         // if needed.
 278
 279         // memoir (at least) writes an empty *idx file in the first place.
 280         // A second latex run is needed.
 281         FileName const idxfile(changeExtension(file.absFilename(), ".idx"));
 282         rerun = fs::exists(idxfile.toFilesystemEncoding()) &&
 283                 fs::is_empty(idxfile.toFilesystemEncoding());
 284
 285         // run makeindex
 286         if (head.haschanged(idxfile)) {
 287                 // no checks for now
 288                 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
 289                 message(_("Running MakeIndex."));
 290                 // onlyFilename() is needed for cygwin
 291                 rerun |= runMakeIndex(onlyFilename(idxfile.absFilename()), runparams);
 292         }
 293         if (head.haschanged(FileName(changeExtension(file.absFilename(), ".nlo")))) {
 294                 lyxerr[Debug::LATEX] << "Running MakeIndex for nomencl." << endl;
 295                 message(_("Running MakeIndex for nomencl."));
 296                 // onlyFilename() is needed for cygwin
 297                 string const nomenclstr = " -s nomencl.ist -o " + onlyFilename(changeExtension(file.toFilesystemEncoding(), ".nls"));
 298                 rerun |= runMakeIndex(onlyFilename(changeExtension(file.absFilename(), ".nlo")), runparams, nomenclstr);
 299         }
 300
 301         // run bibtex
 302         // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
 303         if (scanres & UNDEF_CIT || run_bibtex) {
 304                 // Here we must scan the .aux file and look for
 305                 // "\bibdata" and/or "\bibstyle". If one of those
 306                 // tags is found -> run bibtex and set rerun = true;
 307                 // no checks for now
 308                 lyxerr[Debug::LATEX] << "Running BibTeX." << endl;
 309                 message(_("Running BibTeX."));
 310                 updateBibtexDependencies(head, bibtex_info);
 311                 rerun |= runBibTeX(bibtex_info);
 312         } else if (!had_depfile) {
 313                 /// If we run pdflatex on the file after running latex on it,
 314                 /// then we do not need to run bibtex, but we do need to
 315                 /// insert the .bib and .bst files into the .dep-pdf file.
 316                 updateBibtexDependencies(head, bibtex_info);
 317         }
 318
 319         // 1
 320         // we know on this point that latex has been run once (or we just
 321         // returned) and the question now is to decide if we need to run
 322         // it any more. This is done by asking if any of the files in the
 323         // dependency file has changed. (remember that the checksum for
 324         // a given file is reported to have changed if it just was created)
 325         //     -> if changed or rerun == true:
 326         //             run latex once more and
 327         //             update the dependency structure
 328         //     -> if not changed:
 329         //             we does nothing at this point
 330         //
 331         if (rerun || head.sumchange()) {
 332                 rerun = false;
 333                 ++count;
 334                 lyxerr[Debug::DEPEND]
 335                         << "Dep. file has changed or rerun requested" << endl;
 336                 lyxerr[Debug::LATEX]
 337                         << "Run #" << count << endl;
 338                 message(runMessage(count));
 339                 startscript();
 340                 scanres = scanLogFile(terr);
 341                 if (scanres & ERRORS) {
 342                         deleteFilesOnError();
 343                         return scanres; // return on error
 344                 }
 345
 346                 // update the depedencies
 347                 deplog(head); // reads the latex log
 348                 head.update();
 349         } else {
 350                 lyxerr[Debug::DEPEND] << "Dep. file has NOT changed" << endl;
 351         }
 352
 353         // 1.5
 354         // The inclusion of files generated by external programs like
 355         // makeindex or bibtex might have done changes to pagenumbering,
 356         // etc. And because of this we must run the external programs
 357         // again to make sure everything is redone correctly.
 358         // Also there should be no need to run the external programs any
 359         // more after this.
 360
 361         // run makeindex if the <file>.idx has changed or was generated.
 362         if (head.haschanged(FileName(changeExtension(file.absFilename(), ".idx")))) {
 363                 // no checks for now
 364                 lyxerr[Debug::LATEX] << "Running MakeIndex." << endl;
 365                 message(_("Running MakeIndex."));
 366                 // onlyFilename() is needed for cygwin
 367                 rerun = runMakeIndex(onlyFilename(changeExtension(file.absFilename(), ".idx")), runparams);
 368         }
 369
 370         // I am not pretty sure if need this twice.
 371         if (head.haschanged(FileName(changeExtension(file.absFilename(), ".nlo")))) {
 372                 lyxerr[Debug::LATEX] << "Running MakeIndex for nomencl." << endl;
 373                 message(_("Running MakeIndex for nomencl."));
 374                 // onlyFilename() is needed for cygwin
 375                 string nomenclstr = " -s nomencl.ist -o " + onlyFilename(changeExtension(file.toFilesystemEncoding(), ".nls"));
 376                 rerun |= runMakeIndex(onlyFilename(changeExtension(file.absFilename(), ".nlo")), runparams, nomenclstr);
 377         }
 378
 379         // 2
 380         // we will only run latex more if the log file asks for it.
 381         // or if the sumchange() is true.
 382         //     -> rerun asked for:
 383         //             run latex and
 384         //             remake the dependency file
 385         //             goto 2 or return if max runs are reached.
 386         //     -> rerun not asked for:
 387         //             just return (fall out of bottom of func)
 388         //
 389         while ((head.sumchange() || rerun || (scanres & RERUN))
 390                && count < MAX_RUN) {
 391                 // Yes rerun until message goes away, or until
 392                 // MAX_RUNS are reached.
 393                 rerun = false;
 394                 ++count;
 395                 lyxerr[Debug::LATEX] << "Run #" << count << endl;
 396                 message(runMessage(count));
 397                 startscript();
 398                 scanres = scanLogFile(terr);
 399                 if (scanres & ERRORS) {
 400                         deleteFilesOnError();
 401                         return scanres; // return on error
 402                 }
 403
 404                 // keep this updated
 405                 head.update();
 406         }
 407
 408         // Write the dependencies to file.
 409         head.write(depfile);
 410         lyxerr[Debug::LATEX] << "Done." << endl;
 411         return scanres;
 412 }
 413
 414
 415 int LaTeX::startscript()
 416 {
 417         // onlyFilename() is needed for cygwin
 418         string tmp = cmd + ' ' + quoteName(onlyFilename(file.toFilesystemEncoding())) + " > " + os::nulldev();
 419         Systemcall one;
 420         return one.startscript(Systemcall::Wait, tmp);
 421 }
 422
 423
 424 bool LaTeX::runMakeIndex(string const & f, OutputParams const & runparams,
 425                          string const & params)
 426 {
 427         lyxerr[Debug::LATEX]
 428                 << "idx file has been made, running makeindex on file "
 429                 << f << endl;
 430         string tmp = lyxrc.index_command + ' ';
 431
 432         tmp = subst(tmp, "$$lang", runparams.document_language);
 433         tmp += quoteName(f);
 434         tmp += params;
 435         Systemcall one;
 436         one.startscript(Systemcall::Wait, tmp);
 437         return true;
 438 }
 439
 440
 441 vector<Aux_Info> const
 442 LaTeX::scanAuxFiles(FileName const & file)
 443 {
 444         vector<Aux_Info> result;
 445
 446         result.push_back(scanAuxFile(file));
 447
 448         string const basename = removeExtension(file.absFilename());
 449         for (int i = 1; i < 1000; ++i) {
 450                 FileName const file2(basename
 451                         + '.' + convert<string>(i)
 452                         + ".aux");
 453                 if (!fs::exists(file2.toFilesystemEncoding()))
 454                         break;
 455                 result.push_back(scanAuxFile(file2));
 456         }
 457         return result;
 458 }
 459
 460
 461 Aux_Info const LaTeX::scanAuxFile(FileName const & file)
 462 {
 463         Aux_Info result;
 464         result.aux_file = file;
 465         scanAuxFile(file, result);
 466         return result;
 467 }
 468
 469
 470 void LaTeX::scanAuxFile(FileName const & file, Aux_Info & aux_info)
 471 {
 472         lyxerr[Debug::LATEX] << "Scanning aux file: " << file << endl;
 473
 474         ifstream ifs(file.toFilesystemEncoding().c_str());
 475         string token;
 476         static regex const reg1("\\\\citation\\{([^}]+)\\}");
 477         static regex const reg2("\\\\bibdata\\{([^}]+)\\}");
 478         static regex const reg3("\\\\bibstyle\\{([^}]+)\\}");
 479         static regex const reg4("\\\\@input\\{([^}]+)\\}");
 480
 481         while (getline(ifs, token)) {
 482                 token = rtrim(token, "\r");
 483                 smatch sub;
 484                 if (regex_match(token, sub, reg1)) {
 485                         string data = sub.str(1);
 486                         while (!data.empty()) {
 487                                 string citation;
 488                                 data = split(data, citation, ',');
 489                                 lyxerr[Debug::LATEX] << "Citation: "
 490                                                      << citation << endl;
 491                                 aux_info.citations.insert(citation);
 492                         }
 493                 } else if (regex_match(token, sub, reg2)) {
 494                         string data = sub.str(1);
 495                         // data is now all the bib files separated by ','
 496                         // get them one by one and pass them to the helper
 497                         while (!data.empty()) {
 498                                 string database;
 499                                 data = split(data, database, ',');
 500                                 database = changeExtension(database, "bib");
 501                                 lyxerr[Debug::LATEX] << "BibTeX database: `"
 502                                                      << database << '\'' << endl;
 503                                 aux_info.databases.insert(database);
 504                         }
 505                 } else if (regex_match(token, sub, reg3)) {
 506                         string style = sub.str(1);
 507                         // token is now the style file
 508                         // pass it to the helper
 509                         style = changeExtension(style, "bst");
 510                         lyxerr[Debug::LATEX] << "BibTeX style: `"
 511                                              << style << '\'' << endl;
 512                         aux_info.styles.insert(style);
 513                 } else if (regex_match(token, sub, reg4)) {
 514                         string const file2 = sub.str(1);
 515                         scanAuxFile(FileName(makeAbsPath(file2)), aux_info);
 516                 }
 517         }
 518 }
 519
 520
 521 void LaTeX::updateBibtexDependencies(DepTable & dep,
 522                                      vector<Aux_Info> const & bibtex_info)
 523 {
 524         // Since a run of Bibtex mandates more latex runs it is ok to
 525         // remove all ".bib" and ".bst" files.
 526         dep.remove_files_with_extension(".bib");
 527         dep.remove_files_with_extension(".bst");
 528         //string aux = OnlyFilename(ChangeExtension(file, ".aux"));
 529
 530         for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
 531              it != bibtex_info.end(); ++it) {
 532                 for (set<string>::const_iterator it2 = it->databases.begin();
 533                      it2 != it->databases.end(); ++it2) {
 534                         FileName const file = findtexfile(*it2, "bib");
 535                         if (!file.empty())
 536                                 dep.insert(file, true);
 537                 }
 538
 539                 for (set<string>::const_iterator it2 = it->styles.begin();
 540                      it2 != it->styles.end(); ++it2) {
 541                         FileName const file = findtexfile(*it2, "bst");
 542                         if (!file.empty())
 543                                 dep.insert(file, true);
 544                 }
 545         }
 546 }
 547
 548
 549 bool LaTeX::runBibTeX(vector<Aux_Info> const & bibtex_info)
 550 {
 551         bool result = false;
 552         for (vector<Aux_Info>::const_iterator it = bibtex_info.begin();
 553              it != bibtex_info.end(); ++it) {
 554                 if (it->databases.empty())
 555                         continue;
 556                 result = true;
 557
 558                 string tmp = lyxrc.bibtex_command + " ";
 559                 // onlyFilename() is needed for cygwin
 560                 tmp += quoteName(onlyFilename(removeExtension(it->aux_file.absFilename())));
 561                 Systemcall one;
 562                 one.startscript(Systemcall::Wait, tmp);
 563         }
 564         // Return whether bibtex was run
 565         return result;
 566 }
 567
 568
 569 int LaTeX::scanLogFile(TeXErrors & terr)
 570 {
 571         int last_line = -1;
 572         int line_count = 1;
 573         int retval = NO_ERRORS;
 574         string tmp = onlyFilename(changeExtension(file.absFilename(), ".log"));
 575         lyxerr[Debug::LATEX] << "Log file: " << tmp << endl;
 576         FileName const fn = FileName(makeAbsPath(tmp));
 577         ifstream ifs(fn.toFilesystemEncoding().c_str());
 578
 579         string token;
 580         while (getline(ifs, token)) {
 581                 // MikTeX sometimes inserts \0 in the log file. They can't be
 582                 // removed directly with the existing string utility
 583                 // functions, so convert them first to \r, and remove all
 584                 // \r's afterwards, since we need to remove them anyway.
 585                 token = subst(token, '\0', '\r');
 586                 token = subst(token, "\r", "");
 587
 588                 lyxerr[Debug::LATEX] << "Log line: " << token << endl;
 589
 590                 if (token.empty())
 591                         continue;
 592
 593                 if (prefixIs(token, "LaTeX Warning:") ||
 594                     prefixIs(token, "! pdfTeX warning")) {
 595                         // Here shall we handle different
 596                         // types of warnings
 597                         retval |= LATEX_WARNING;
 598                         lyxerr[Debug::LATEX] << "LaTeX Warning." << endl;
 599                         if (contains(token, "Rerun to get cross-references")) {
 600                                 retval |= RERUN;
 601                                 lyxerr[Debug::LATEX]
 602                                         << "We should rerun." << endl;
 603                         } else if (contains(token, "Citation")
 604                                    && contains(token, "on page")
 605                                    && contains(token, "undefined")) {
 606                                 retval |= UNDEF_CIT;
 607                         }
 608                 } else if (prefixIs(token, "Package")) {
 609                         // Package warnings
 610                         retval |= PACKAGE_WARNING;
 611                         if (contains(token, "natbib Warning:")) {
 612                                 // Natbib warnings
 613                                 if (contains(token, "Citation")
 614                                     && contains(token, "on page")
 615                                     && contains(token, "undefined")) {
 616                                         retval |= UNDEF_CIT;
 617                                 }
 618                         } else if (contains(token, "run BibTeX")) {
 619                                 retval |= UNDEF_CIT;
 620                         } else if (contains(token, "Rerun LaTeX") ||
 621                                    contains(token, "Rerun to get")) {
 622                                 // at least longtable.sty and bibtopic.sty
 623                                 // might use this.
 624                                 lyxerr[Debug::LATEX]
 625                                         << "We should rerun." << endl;
 626                                 retval |= RERUN;
 627                         }
 628                 } else if (token[0] == '(') {
 629                         if (contains(token, "Rerun LaTeX") ||
 630                             contains(token, "Rerun to get")) {
 631                                 // Used by natbib
 632                                 lyxerr[Debug::LATEX]
 633                                         << "We should rerun." << endl;
 634                                 retval |= RERUN;
 635                         }
 636                 } else if (prefixIs(token, "! ")) {
 637                         // Ok, we have something that looks like a TeX Error
 638                         // but what do we really have.
 639
 640                         // Just get the error description:
 641                         string desc(token, 2);
 642                         if (contains(token, "LaTeX Error:"))
 643                                 retval |= LATEX_ERROR;
 644                         // get the next line
 645                         string tmp;
 646                         int count = 0;
 647                         do {
 648                                 if (!getline(ifs, tmp))
 649                                         break;
 650                                 if (++count > 10)
 651                                         break;
 652                         } while (!prefixIs(tmp, "l."));
 653                         if (prefixIs(tmp, "l.")) {
 654                                 // we have a latex error
 655                                 retval |=  TEX_ERROR;
 656                                 if (contains(desc, "Package babel Error: You haven't defined the language"))
 657                                         retval |= ERROR_RERUN;
 658                                 // get the line number:
 659                                 int line = 0;
 660                                 sscanf(tmp.c_str(), "l.%d", &line);
 661                                 // get the rest of the message:
 662                                 string errstr(tmp, tmp.find(' '));
 663                                 errstr += '\n';
 664                                 getline(ifs, tmp);
 665                                 while (!contains(errstr, "l.")
 666                                        && !tmp.empty()
 667                                        && !prefixIs(tmp, "! ")
 668                                        && !contains(tmp, "(job aborted")) {
 669                                         errstr += tmp;
 670                                         errstr += "\n";
 671                                         getline(ifs, tmp);
 672                                 }
 673                                 lyxerr[Debug::LATEX]
 674                                         << "line: " << line << '\n'
 675                                         << "Desc: " << desc << '\n'
 676                                         << "Text: " << errstr << endl;
 677                                 if (line == last_line)
 678                                         ++line_count;
 679                                 else {
 680                                         line_count = 1;
 681                                         last_line = line;
 682                                 }
 683                                 if (line_count <= 5) {
 684                                         // FIXME UNICODE
 685                                         // We have no idea what the encoding of the log file is
 686                                         // (probably pure ascii, but maybe some localized
 687                                         // latex compilers or packages exist)
 688                                         terr.insertError(line, from_utf8(desc), from_utf8(errstr));
 689                                         ++num_errors;
 690                                 }
 691                         }
 692                 } else {
 693                         // information messages, TeX warnings and other
 694                         // warnings we have not caught earlier.
 695                         if (prefixIs(token, "Overfull ")) {
 696                                 retval |= TEX_WARNING;
 697                         } else if (prefixIs(token, "Underfull ")) {
 698                                 retval |= TEX_WARNING;
 699                         } else if (contains(token, "Rerun to get citations")) {
 700                                 // Natbib seems to use this.
 701                                 retval |= UNDEF_CIT;
 702                         } else if (contains(token, "No pages of output")) {
 703                                 // A dvi file was not created
 704                                 retval |= NO_OUTPUT;
 705                         } else if (contains(token, "That makes 100 errors")) {
 706                                 // More than 100 errors were reprted
 707                                 retval |= TOO_MANY_ERRORS;
 708                         }
 709                 }
 710         }
 711         lyxerr[Debug::LATEX] << "Log line: " << token << endl;
 712         return retval;
 713 }
 714
 715
 716 namespace {
 717
 718 void handleFoundFile(string const & ff, DepTable & head)
 719 {
 720         // convert from native os path to unix path
 721         string const foundfile = os::internal_path(trim(ff));
 722
 723         lyxerr[Debug::DEPEND] << "Found file: " << foundfile << endl;
 724
 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
 729         // find the file.
 730
 731         // (1) foundfile is an
 732         //     absolute path and should
 733         //     be inserted.
 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 cannot be a file generated by
 739                 // the latex run.
 740                 FileName const absname(foundfile);
 741                 if (fs::exists(absname.toFilesystemEncoding()) &&
 742                     !fs::is_directory(absname.toFilesystemEncoding()))
 743                         head.insert(absname, true);
 744
 745                 return;
 746         }
 747
 748         string const onlyfile = onlyFilename(foundfile);
 749         FileName const absname(makeAbsPath(onlyfile));
 750
 751         // (2) foundfile is in the tmpdir
 752         //     insert it into head
 753         if (fs::exists(absname.toFilesystemEncoding())) {
 754                 static regex unwanted("^.*\\.(aux|log|dvi|bbl|ind|glo)$");
 755                 if (regex_match(onlyfile, unwanted)) {
 756                         lyxerr[Debug::DEPEND]
 757                                 << "We don't want "
 758                                 << onlyfile
 759                                 << " in the dep file"
 760                                 << endl;
 761                 } else if (suffixIs(onlyfile, ".tex")) {
 762                         // This is a tex file generated by LyX
 763                         // and latex is not likely to change this
 764                         // during its runs.
 765                         lyxerr[Debug::DEPEND]
 766                                 << "Tmpdir TeX file: "
 767                                 << onlyfile
 768                                 << endl;
 769                         head.insert(absname, true);
 770                 } else {
 771                         lyxerr[Debug::DEPEND]
 772                                 << "In tmpdir file:"
 773                                 << onlyfile
 774                                 << endl;
 775                         head.insert(absname);
 776                 }
 777         } else
 778                 lyxerr[Debug::DEPEND]
 779                         << "Not a file or we are unable to find it."
 780                         << endl;
 781 }
 782
 783 } // anon namespace
 784
 785
 786 void LaTeX::deplog(DepTable & head)
 787 {
 788         // This function reads the LaTeX log file end extracts all the external
 789         // files used by the LaTeX run. The files are then entered into the
 790         // dependency file.
 791
 792         string const logfile = onlyFilename(changeExtension(file.absFilename(), ".log"));
 793
 794         static regex reg1(".*\\([^)]+.*");
 795         static regex reg2("File: ([^ ]+).*");
 796         static regex reg3("No file ([^ ]+)\\..*");
 797         static regex reg4("\\\\openout[0-9]+.*=.*`([^ ]+)'\\..*");
 798         // If an index should be created, MikTex does not write a line like
 799         //    \openout# = 'sample.idx'.
 800         // but instead only a line like this into the log:
 801         //   Writing index file sample.idx
 802         static regex reg5("Writing index file ([^ ]+).*");
 803         static regex regnomencl("Writing nomenclature file ([^ ]+).*");
 804         // If a toc should be created, MikTex does not write a line like
 805         //    \openout# = `sample.toc'.
 806         // but only a line like this into the log:
 807         //    \tf@toc=\write#
 808         // This line is also written by tetex.
 809         // This line is not present if no toc should be created.
 810         static regex miktexTocReg("\\\\tf@toc=\\\\write.*");
 811
 812         FileName const fn = FileName(makeAbsPath(logfile));
 813         ifstream ifs(fn.toFilesystemEncoding().c_str());
 814         while (ifs) {
 815                 // Ok, the scanning of files here is not sufficient.
 816                 // Sometimes files are named by "File: xxx" only
 817                 // So I think we should use some regexps to find files instead.
 818                 // "(\([^ ]+\)"   should match the "(file " variant, note
 819                 // that we can have several of these on one line.
 820                 // "File: \([^ ]+\)" should match the "File: file" variant
 821
 822                 string token;
 823                 getline(ifs, token);
 824                 // MikTeX sometimes inserts \0 in the log file. They can't be
 825                 // removed directly with the existing string utility
 826                 // functions, so convert them first to \r, and remove all
 827                 // \r's afterwards, since we need to remove them anyway.
 828                 token = subst(token, '\0', '\r');
 829                 token = subst(token, "\r", "");
 830                 if (token.empty())
 831                         continue;
 832
 833                 smatch sub;
 834
 835                 if (regex_match(token, sub, reg1)) {
 836                         static regex reg1_1("\\(([^()]+)");
 837                         smatch what;
 838                         string::const_iterator first = token.begin();
 839                         string::const_iterator end = token.end();
 840
 841                         while (regex_search(first, end, what, reg1_1)) {
 842                                 first = what[0].second;
 843                                 handleFoundFile(what.str(1), head);
 844                         }
 845                 } else if (regex_match(token, sub, reg2))
 846                         handleFoundFile(sub.str(1), head);
 847                 else if (regex_match(token, sub, reg3))
 848                         handleFoundFile(sub.str(1), head);
 849                 else if (regex_match(token, sub, reg4))
 850                         handleFoundFile(sub.str(1), head);
 851                 else if (regex_match(token, sub, reg5))
 852                         handleFoundFile(sub.str(1), head);
 853                 else if (regex_match(token, sub, regnomencl))
 854                         handleFoundFile(sub.str(1), head);
 855                 else if (regex_match(token, sub, miktexTocReg))
 856                         handleFoundFile(onlyFilename(changeExtension(file.absFilename(), ".toc")), head);
 857         }
 858
 859         // Make sure that the main .tex file is in the dependancy file.
 860         head.insert(file, true);
 861 }
 862
 863
 864 } // namespace lyx