src/LaTeX.cpp

   1 /**
   2  * \file LaTeX.cpp
   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  * \author Jürgen Spitzmüller
  12  *
  13  * Full author contact details are available in file CREDITS.
  14  */
  15
  16 #include <config.h>
  17
  18 #include "BufferList.h"
  19 #include "LaTeX.h"
  20 #include "LyXRC.h"
  21 #include "LyX.h"
  22 #include "DepTable.h"
  23
  24 #include "support/debug.h"
  25 #include "support/convert.h"
  26 #include "support/FileName.h"
  27 #include "support/filetools.h"
  28 #include "support/gettext.h"
  29 #include "support/lstrings.h"
  30 #include "support/Systemcall.h"
  31 #include "support/os.h"
  32
  33 #include "support/regex.h"
  34
  35 #include <fstream>
  36 #include <stack>
  37
  38
  39 using namespace std;
  40 using namespace lyx::support;
  41
  42 namespace lyx {
  43
  44 namespace os = support::os;
  45
  46 // TODO: in no particular order
  47 // - get rid of the call to
  48 //   BufferList::updateIncludedTeXfiles, this should either
  49 //   be done before calling LaTeX::funcs or in a completely
  50 //   different way.
  51 // - the makeindex style files should be taken care of with
  52 //   the dependency mechanism.
  53
  54 namespace {
  55
  56 docstring runMessage(unsigned int count)
  57 {
  58         return bformat(_("Waiting for LaTeX run number %1$d"), count);
  59 }
  60
  61 } // namespace
  62
  63 /*
  64  * CLASS TEXERRORS
  65  */
  66
  67 void TeXErrors::insertError(int line, docstring const & error_desc,
  68                             docstring const & error_text,
  69                             string const & child_name)
  70 {
  71         Error newerr(line, error_desc, error_text, child_name);
  72         errors.push_back(newerr);
  73 }
  74
  75
  76 bool operator==(AuxInfo const & a, AuxInfo const & o)
  77 {
  78         return a.aux_file == o.aux_file
  79                 && a.citations == o.citations
  80                 && a.databases == o.databases
  81                 && a.styles == o.styles;
  82 }
  83
  84
  85 bool operator!=(AuxInfo const & a, AuxInfo const & o)
  86 {
  87         return !(a == o);
  88 }
  89
  90
  91 /*
  92  * CLASS LaTeX
  93  */
  94
  95 LaTeX::LaTeX(string const & latex, OutputParams const & rp,
  96              FileName const & f, string const & p, string const & lp,
  97              bool const clean_start)
  98         : cmd(latex), file(f), path(p), lpath(lp), runparams(rp), biber(false)
  99 {
 100         num_errors = 0;
 101         // lualatex can still produce a DVI with --output-format=dvi. However,
 102         // we do not use that internally (we use the "dvilualatex" command) so
 103         // it would only happen from a custom converter. Thus, it is better to
 104         // guess that lualatex produces a PDF than to guess a DVI.
 105         // FIXME we should base the extension on the output format, which we should
 106         // get in a robust way, e.g. from the converter.
 107         if (prefixIs(cmd, "pdf") || prefixIs(cmd, "lualatex") || prefixIs(cmd, "xelatex")) {
 108                 depfile = FileName(file.absFileName() + ".dep-pdf");
 109                 output_file =
 110                         FileName(changeExtension(file.absFileName(), ".pdf"));
 111         } else {
 112                 depfile = FileName(file.absFileName() + ".dep");
 113                 output_file =
 114                         FileName(changeExtension(file.absFileName(), ".dvi"));
 115         }
 116         if (clean_start)
 117                 removeAuxiliaryFiles();
 118 }
 119
 120
 121 void LaTeX::removeAuxiliaryFiles() const
 122 {
 123         // Note that we do not always call this function when there is an error.
 124         // For example, if there is an error but an output file is produced we
 125         // still would like to output (export/view) the file.
 126
 127         // What files do we have to delete?
 128
 129         // This will at least make latex do all the runs
 130         depfile.removeFile();
 131
 132         // but the reason for the error might be in a generated file...
 133
 134         // bibtex file
 135         FileName const bbl(changeExtension(file.absFileName(), ".bbl"));
 136         bbl.removeFile();
 137
 138         // biber file
 139         FileName const bcf(changeExtension(file.absFileName(), ".bcf"));
 140         bcf.removeFile();
 141
 142         // makeindex file
 143         FileName const ind(changeExtension(file.absFileName(), ".ind"));
 144         ind.removeFile();
 145
 146         // nomencl file
 147         FileName const nls(changeExtension(file.absFileName(), ".nls"));
 148         nls.removeFile();
 149
 150         // nomencl file (old version of the package)
 151         FileName const gls(changeExtension(file.absFileName(), ".gls"));
 152         gls.removeFile();
 153
 154         // Also remove the aux file
 155         FileName const aux(changeExtension(file.absFileName(), ".aux"));
 156         aux.removeFile();
 157
 158         // Also remove the .out file (e.g. hyperref bookmarks) (#9963)
 159         FileName const out(changeExtension(file.absFileName(), ".out"));
 160         out.removeFile();
 161
 162         // Remove the output file, which is often generated even if error
 163         output_file.removeFile();
 164 }
 165
 166
 167 int LaTeX::run(TeXErrors & terr)
 168         // We know that this function will only be run if the lyx buffer
 169         // has been changed. We also know that a newly written .tex file
 170         // is always different from the previous one because of the date
 171         // in it. However it seems safe to run latex (at least) one time
 172         // each time the .tex file changes.
 173 {
 174         int scanres = NO_ERRORS;
 175         int bscanres = NO_ERRORS;
 176         unsigned int count = 0; // number of times run
 177         num_errors = 0; // just to make sure.
 178         unsigned int const MAX_RUN = 6;
 179         DepTable head; // empty head
 180         bool rerun = false; // rerun requested
 181
 182         // The class LaTeX does not know the temp path.
 183         theBufferList().updateIncludedTeXfiles(FileName::getcwd().absFileName(),
 184                 runparams);
 185
 186         // 0
 187         // first check if the file dependencies exist:
 188         //     ->If it does exist
 189         //             check if any of the files mentioned in it have
 190         //             changed (done using a checksum).
 191         //                 -> if changed:
 192         //                        run latex once and
 193         //                        remake the dependency file
 194         //                 -> if not changed:
 195         //                        just return there is nothing to do for us.
 196         //     ->if it doesn't exist
 197         //             make it and
 198         //             run latex once (we need to run latex once anyway) and
 199         //             remake the dependency file.
 200         //
 201
 202         bool had_depfile = depfile.exists();
 203         bool run_bibtex = false;
 204         FileName const aux_file(changeExtension(file.absFileName(), ".aux"));
 205
 206         if (had_depfile) {
 207                 LYXERR(Debug::DEPEND, "Dependency file exists");
 208                 // Read the dep file:
 209                 had_depfile = head.read(depfile);
 210         }
 211
 212         if (had_depfile) {
 213                 // Update the checksums
 214                 head.update();
 215                 // Can't just check if anything has changed because it might
 216                 // have aborted on error last time... in which cas we need
 217                 // to re-run latex and collect the error messages
 218                 // (even if they are the same).
 219                 if (!output_file.exists()) {
 220                         LYXERR(Debug::DEPEND,
 221                                 "re-running LaTeX because output file doesn't exist.");
 222                 } else if (!head.sumchange()) {
 223                         LYXERR(Debug::DEPEND, "return no_change");
 224                         return NO_CHANGE;
 225                 } else {
 226                         LYXERR(Debug::DEPEND, "Dependency file has changed");
 227                 }
 228
 229                 if (head.extchanged(".bib") || head.extchanged(".bst"))
 230                         run_bibtex = true;
 231         } else
 232                 LYXERR(Debug::DEPEND,
 233                         "Dependency file does not exist, or has wrong format");
 234
 235         /// We scan the aux file even when had_depfile = false,
 236         /// because we can run pdflatex on the file after running latex on it,
 237         /// in which case we will not need to run bibtex again.
 238         vector<AuxInfo> bibtex_info_old;
 239         if (!run_bibtex)
 240                 bibtex_info_old = scanAuxFiles(aux_file, runparams.only_childbibs);
 241
 242         ++count;
 243         LYXERR(Debug::LATEX, "Run #" << count);
 244         message(runMessage(count));
 245
 246         int exit_code = startscript();
 247
 248         scanres = scanLogFile(terr);
 249         if (scanres & ERROR_RERUN) {
 250                 LYXERR(Debug::LATEX, "Rerunning LaTeX");
 251                 terr.clearErrors();
 252                 exit_code = startscript();
 253                 scanres = scanLogFile(terr);
 254         }
 255
 256         vector<AuxInfo> const bibtex_info = scanAuxFiles(aux_file, runparams.only_childbibs);
 257         if (!run_bibtex && bibtex_info_old != bibtex_info)
 258                 run_bibtex = true;
 259
 260         // update the dependencies.
 261         deplog(head); // reads the latex log
 262         head.update();
 263
 264         // 1
 265         // At this point we must run external programs if needed.
 266         // makeindex will be run if a .idx file changed or was generated.
 267         // And if there were undefined citations or changes in references
 268         // the .aux file is checked for signs of bibtex. Bibtex is then run
 269         // if needed.
 270
 271         // memoir (at least) writes an empty *idx file in the first place.
 272         // A second latex run is needed.
 273         FileName const idxfile(changeExtension(file.absFileName(), ".idx"));
 274         rerun = idxfile.exists() && idxfile.isFileEmpty();
 275
 276         // run makeindex
 277         if (head.haschanged(idxfile)) {
 278                 // no checks for now
 279                 LYXERR(Debug::LATEX, "Running MakeIndex.");
 280                 message(_("Running Index Processor."));
 281                 // onlyFileName() is needed for cygwin
 282                 rerun |= runMakeIndex(onlyFileName(idxfile.absFileName()),
 283                                 runparams);
 284         }
 285         FileName const nlofile(changeExtension(file.absFileName(), ".nlo"));
 286         // If all nomencl entries are removed, nomencl writes an empty nlo file.
 287         // DepTable::hasChanged() returns false in this case, since it does not
 288         // distinguish empty files from non-existing files. This is why we need
 289         // the extra checks here (to trigger a rerun). Cf. discussions in #8905.
 290         // FIXME: Sort out the real problem in DepTable.
 291         if (head.haschanged(nlofile) || (nlofile.exists() && nlofile.isFileEmpty()))
 292                 rerun |= runMakeIndexNomencl(file, ".nlo", ".nls");
 293         FileName const glofile(changeExtension(file.absFileName(), ".glo"));
 294         if (head.haschanged(glofile))
 295                 rerun |= runMakeIndexNomencl(file, ".glo", ".gls");
 296
 297         // check if we're using biber instead of bibtex
 298         // biber writes no info to the aux file, so we just check
 299         // if a bcf file exists (and if it was updated)
 300         FileName const bcffile(changeExtension(file.absFileName(), ".bcf"));
 301         biber |= head.exist(bcffile);
 302
 303         // run bibtex
 304         // if (scanres & UNDEF_CIT || scanres & RERUN || run_bibtex)
 305         if (scanres & UNDEF_CIT || run_bibtex) {
 306                 // Here we must scan the .aux file and look for
 307                 // "\bibdata" and/or "\bibstyle". If one of those
 308                 // tags is found -> run bibtex and set rerun = true;
 309                 // no checks for now
 310                 LYXERR(Debug::LATEX, "Running BibTeX.");
 311                 message(_("Running BibTeX."));
 312                 updateBibtexDependencies(head, bibtex_info);
 313                 rerun |= runBibTeX(bibtex_info, runparams);
 314                 FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
 315                 if (blgfile.exists())
 316                         bscanres = scanBlgFile(head, terr);
 317         } else if (!had_depfile) {
 318                 /// If we run pdflatex on the file after running latex on it,
 319                 /// then we do not need to run bibtex, but we do need to
 320                 /// insert the .bib and .bst files into the .dep-pdf file.
 321                 updateBibtexDependencies(head, bibtex_info);
 322         }
 323
 324         // 2
 325         // we know on this point that latex has been run once (or we just
 326         // returned) and the question now is to decide if we need to run
 327         // it any more. This is done by asking if any of the files in the
 328         // dependency file has changed. (remember that the checksum for
 329         // a given file is reported to have changed if it just was created)
 330         //     -> if changed or rerun == true:
 331         //             run latex once more and
 332         //             update the dependency structure
 333         //     -> if not changed:
 334         //             we do nothing at this point
 335         //
 336         if (rerun || head.sumchange()) {
 337                 rerun = false;
 338                 ++count;
 339                 LYXERR(Debug::DEPEND, "Dep. file has changed or rerun requested");
 340                 LYXERR(Debug::LATEX, "Run #" << count);
 341                 message(runMessage(count));
 342                 startscript();
 343                 scanres = scanLogFile(terr);
 344
 345                 // update the depedencies
 346                 deplog(head); // reads the latex log
 347                 head.update();
 348         } else {
 349                 LYXERR(Debug::DEPEND, "Dep. file has NOT changed");
 350         }
 351
 352         // 3
 353         // rerun bibtex?
 354         // Complex bibliography packages such as Biblatex require
 355         // an additional bibtex cycle sometimes.
 356         if (scanres & UNDEF_CIT) {
 357                 // Here we must scan the .aux file and look for
 358                 // "\bibdata" and/or "\bibstyle". If one of those
 359                 // tags is found -> run bibtex and set rerun = true;
 360                 // no checks for now
 361                 LYXERR(Debug::LATEX, "Running BibTeX.");
 362                 message(_("Running BibTeX."));
 363                 updateBibtexDependencies(head, bibtex_info);
 364                 rerun |= runBibTeX(bibtex_info, runparams);
 365                 FileName const blgfile(changeExtension(file.absFileName(), ".blg"));
 366                 if (blgfile.exists())
 367                         bscanres = scanBlgFile(head, terr);
 368         }
 369
 370         // 4
 371         // The inclusion of files generated by external programs such as
 372         // makeindex or bibtex might have done changes to pagenumbering,
 373         // etc. And because of this we must run the external programs
 374         // again to make sure everything is redone correctly.
 375         // Also there should be no need to run the external programs any
 376         // more after this.
 377
 378         // run makeindex if the <file>.idx has changed or was generated.
 379         if (head.haschanged(idxfile)) {
 380                 // no checks for now
 381                 LYXERR(Debug::LATEX, "Running MakeIndex.");
 382                 message(_("Running Index Processor."));
 383                 // onlyFileName() is needed for cygwin
 384                 rerun = runMakeIndex(onlyFileName(changeExtension(
 385                                 file.absFileName(), ".idx")), runparams);
 386         }
 387
 388         // I am not pretty sure if need this twice.
 389         if (head.haschanged(nlofile))
 390                 rerun |= runMakeIndexNomencl(file, ".nlo", ".nls");
 391         if (head.haschanged(glofile))
 392                 rerun |= runMakeIndexNomencl(file, ".glo", ".gls");
 393
 394         // 5
 395         // we will only run latex more if the log file asks for it.
 396         // or if the sumchange() is true.
 397         //     -> rerun asked for:
 398         //             run latex and
 399         //             remake the dependency file
 400         //             goto 2 or return if max runs are reached.
 401         //     -> rerun not asked for:
 402         //             just return (fall out of bottom of func)
 403         //
 404         while ((head.sumchange() || rerun || (scanres & RERUN))
 405                && count < MAX_RUN) {
 406                 // Yes rerun until message goes away, or until
 407                 // MAX_RUNS are reached.
 408                 rerun = false;
 409                 ++count;
 410                 LYXERR(Debug::LATEX, "Run #" << count);
 411                 message(runMessage(count));
 412                 startscript();
 413                 scanres = scanLogFile(terr);
 414
 415                 // keep this updated
 416                 head.update();
 417         }
 418
 419         // Write the dependencies to file.
 420         head.write(depfile);
 421
 422         if (exit_code) {
 423                 // add flag here, just before return, instead of when exit_code
 424                 // is defined because scanres is sometimes overwritten above
 425                 // (e.g. rerun)
 426                 scanres |= NONZERO_ERROR;
 427         }
 428
 429         LYXERR(Debug::LATEX, "Done.");
 430
 431         if (bscanres & ERRORS)
 432                 return bscanres; // return on error
 433
 434         return scanres;
 435 }
 436
 437
 438 int LaTeX::startscript()
 439 {
 440         // onlyFileName() is needed for cygwin
 441         string tmp = cmd + ' '
 442                      + quoteName(onlyFileName(file.toFilesystemEncoding()))
 443                      + " > " + os::nulldev();
 444         Systemcall one;
 445         return one.startscript(Systemcall::Wait, tmp, path, lpath);
 446 }
 447
 448
 449 bool LaTeX::runMakeIndex(string const & f, OutputParams const & runparams,
 450                          string const & params)
 451 {
 452         string tmp = runparams.use_japanese ?
 453                 lyxrc.jindex_command : lyxrc.index_command;
 454
 455         if (!runparams.index_command.empty())
 456                 tmp = runparams.index_command;
 457
 458         LYXERR(Debug::LATEX,
 459                 "idx file has been made, running index processor ("
 460                 << tmp << ") on file " << f);
 461
 462         tmp = subst(tmp, "$$lang", runparams.document_language);
 463         if (runparams.use_indices) {
 464                 tmp = lyxrc.splitindex_command + " -m " + quoteName(tmp);
 465                 LYXERR(Debug::LATEX,
 466                 "Multiple indices. Using splitindex command: " << tmp);
 467         }
 468         tmp += ' ';
 469         tmp += quoteName(f);
 470         tmp += params;
 471         Systemcall one;
 472         one.startscript(Systemcall::Wait, tmp, path, lpath);
 473         return true;
 474 }
 475
 476
 477 bool LaTeX::runMakeIndexNomencl(FileName const & file,
 478                 string const & nlo, string const & nls)
 479 {
 480         LYXERR(Debug::LATEX, "Running MakeIndex for nomencl.");
 481         message(_("Running MakeIndex for nomencl."));
 482         string tmp = lyxrc.nomencl_command + ' ';
 483         // onlyFileName() is needed for cygwin
 484         tmp += quoteName(onlyFileName(changeExtension(file.absFileName(), nlo)));
 485         tmp += " -o "
 486                 + onlyFileName(changeExtension(file.toFilesystemEncoding(), nls));
 487         Systemcall one;
 488         one.startscript(Systemcall::Wait, tmp, path, lpath);
 489         return true;
 490 }
 491
 492
 493 vector<AuxInfo> const
 494 LaTeX::scanAuxFiles(FileName const & file, bool const only_childbibs)
 495 {
 496         vector<AuxInfo> result;
 497
 498         // With chapterbib, we have to bibtex all children's aux files
 499         // but _not_ the master's!
 500         if (only_childbibs) {
 501                 for (string const &s: children) {
 502                         FileName fn =
 503                                 makeAbsPath(s, file.onlyPath().realPath());
 504                         fn.changeExtension("aux");
 505                         if (fn.exists())
 506                                 result.push_back(scanAuxFile(fn));
 507                 }
 508                 return result;
 509         }
 510
 511         result.push_back(scanAuxFile(file));
 512
 513         // This is for bibtopic
 514         string const basename = removeExtension(file.absFileName());
 515         for (int i = 1; i < 1000; ++i) {
 516                 FileName const file2(basename
 517                         + '.' + convert<string>(i)
 518                         + ".aux");
 519                 if (!file2.exists())
 520                         break;
 521                 result.push_back(scanAuxFile(file2));
 522         }
 523         return result;
 524 }
 525
 526
 527 AuxInfo const LaTeX::scanAuxFile(FileName const & file)
 528 {
 529         AuxInfo result;
 530         result.aux_file = file;
 531         scanAuxFile(file, result);
 532         return result;
 533 }
 534
 535
 536 void LaTeX::scanAuxFile(FileName const & file, AuxInfo & aux_info)
 537 {
 538         LYXERR(Debug::LATEX, "Scanning aux file: " << file);
 539
 540         ifstream ifs(file.toFilesystemEncoding().c_str());
 541         string token;
 542         static regex const reg1("\\\\citation\\{([^}]+)\\}");
 543         static regex const reg2("\\\\bibdata\\{([^}]+)\\}");
 544         static regex const reg3("\\\\bibstyle\\{([^}]+)\\}");
 545         static regex const reg4("\\\\@input\\{([^}]+)\\}");
 546
 547         while (getline(ifs, token)) {
 548                 token = rtrim(token, "\r");
 549                 smatch sub;
 550                 // FIXME UNICODE: We assume that citation keys and filenames
 551                 // in the aux file are in the file system encoding.
 552                 token = to_utf8(from_filesystem8bit(token));
 553                 if (regex_match(token, sub, reg1)) {
 554                         string data = sub.str(1);
 555                         while (!data.empty()) {
 556                                 string citation;
 557                                 data = split(data, citation, ',');
 558                                 LYXERR(Debug::LATEX, "Citation: " << citation);
 559                                 aux_info.citations.insert(citation);
 560                         }
 561                 } else if (regex_match(token, sub, reg2)) {
 562                         string data = sub.str(1);
 563                         // data is now all the bib files separated by ','
 564                         // get them one by one and pass them to the helper
 565                         while (!data.empty()) {
 566                                 string database;
 567                                 data = split(data, database, ',');
 568                                 database = changeExtension(database, "bib");
 569                                 LYXERR(Debug::LATEX, "BibTeX database: `" << database << '\'');
 570                                 aux_info.databases.insert(database);
 571                         }
 572                 } else if (regex_match(token, sub, reg3)) {
 573                         string style = sub.str(1);
 574                         // token is now the style file
 575                         // pass it to the helper
 576                         style = changeExtension(style, "bst");
 577                         LYXERR(Debug::LATEX, "BibTeX style: `" << style << '\'');
 578                         aux_info.styles.insert(style);
 579                 } else if (regex_match(token, sub, reg4)) {
 580                         string const file2 = sub.str(1);
 581                         scanAuxFile(makeAbsPath(file2), aux_info);
 582                 }
 583         }
 584 }
 585
 586
 587 void LaTeX::updateBibtexDependencies(DepTable & dep,
 588                                      vector<AuxInfo> const & bibtex_info)
 589 {
 590         // Since a run of Bibtex mandates more latex runs it is ok to
 591         // remove all ".bib" and ".bst" files.
 592         dep.remove_files_with_extension(".bib");
 593         dep.remove_files_with_extension(".bst");
 594         //string aux = OnlyFileName(ChangeExtension(file, ".aux"));
 595
 596         for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
 597              it != bibtex_info.end(); ++it) {
 598                 for (set<string>::const_iterator it2 = it->databases.begin();
 599                      it2 != it->databases.end(); ++it2) {
 600                         FileName const file = findtexfile(*it2, "bib");
 601                         if (!file.empty())
 602                                 dep.insert(file, true);
 603                 }
 604
 605                 for (set<string>::const_iterator it2 = it->styles.begin();
 606                      it2 != it->styles.end(); ++it2) {
 607                         FileName const file = findtexfile(*it2, "bst");
 608                         if (!file.empty())
 609                                 dep.insert(file, true);
 610                 }
 611         }
 612
 613         // biber writes nothing into the aux file.
 614         // Instead, we have to scan the blg file
 615         if (biber) {
 616                 TeXErrors terr;
 617                 scanBlgFile(dep, terr);
 618         }
 619 }
 620
 621
 622 bool LaTeX::runBibTeX(vector<AuxInfo> const & bibtex_info,
 623                       OutputParams const & runparams)
 624 {
 625         bool result = false;
 626         for (vector<AuxInfo>::const_iterator it = bibtex_info.begin();
 627              it != bibtex_info.end(); ++it) {
 628                 if (!biber && it->databases.empty())
 629                         continue;
 630                 result = true;
 631
 632                 string tmp = runparams.bibtex_command;
 633                 tmp += " ";
 634                 // onlyFileName() is needed for cygwin
 635                 tmp += quoteName(onlyFileName(removeExtension(
 636                                 it->aux_file.absFileName())));
 637                 Systemcall one;
 638                 one.startscript(Systemcall::Wait, tmp, path, lpath);
 639         }
 640         // Return whether bibtex was run
 641         return result;
 642 }
 643
 644
 645 int LaTeX::scanLogFile(TeXErrors & terr)
 646 {
 647         int last_line = -1;
 648         int line_count = 1;
 649         int retval = NO_ERRORS;
 650         string tmp =
 651                 onlyFileName(changeExtension(file.absFileName(), ".log"));
 652         LYXERR(Debug::LATEX, "Log file: " << tmp);
 653         FileName const fn = FileName(makeAbsPath(tmp));
 654         // FIXME we should use an ifdocstream here and a docstring for token
 655         // below. The encoding of the log file depends on the _output_ (font)
 656         // encoding of the TeX file (T1, TU etc.). See #10728.
 657         ifstream ifs(fn.toFilesystemEncoding().c_str());
 658         bool fle_style = false;
 659         static regex const file_line_error(".+\\.\\D+:[0-9]+: (.+)");
 660         static regex const child_file(".*([0-9]+[A-Za-z]*_.+\\.tex).*");
 661         // Flag for 'File ended while scanning' message.
 662         // We need to wait for subsequent processing.
 663         string wait_for_error;
 664         string child_name;
 665         int pnest = 0;
 666         stack <pair<string, int> > child;
 667         children.clear();
 668
 669         string token;
 670         while (getline(ifs, token)) {
 671                 // MikTeX sometimes inserts \0 in the log file. They can't be
 672                 // removed directly with the existing string utility
 673                 // functions, so convert them first to \r, and remove all
 674                 // \r's afterwards, since we need to remove them anyway.
 675                 token = subst(token, '\0', '\r');
 676                 token = subst(token, "\r", "");
 677                 smatch sub;
 678
 679                 LYXERR(Debug::LATEX, "Log line: " << token);
 680
 681                 if (token.empty())
 682                         continue;
 683
 684                 // Track child documents
 685                 for (size_t i = 0; i < token.length(); ++i) {
 686                         if (token[i] == '(') {
 687                                 ++pnest;
 688                                 size_t j = token.find('(', i + 1);
 689                                 size_t len = j == string::npos
 690                                                 ? token.substr(i + 1).length()
 691                                                 : j - i - 1;
 692                                 string const substr = token.substr(i + 1, len);
 693                                 if (regex_match(substr, sub, child_file)) {
 694                                         string const name = sub.str(1);
 695                                         child.push(make_pair(name, pnest));
 696                                         children.push_back(name);
 697                                         i += len;
 698                                 }
 699                         } else if (token[i] == ')') {
 700                                 if (!child.empty()
 701                                     && child.top().second == pnest)
 702                                         child.pop();
 703                                 --pnest;
 704                         }
 705                 }
 706                 child_name = child.empty() ? empty_string() : child.top().first;
 707
 708                 if (contains(token, "file:line:error style messages enabled"))
 709                         fle_style = true;
 710
 711                 if (prefixIs(token, "LaTeX Warning:") ||
 712                     prefixIs(token, "! pdfTeX warning")) {
 713                         // Here shall we handle different
 714                         // types of warnings
 715                         retval |= LATEX_WARNING;
 716                         LYXERR(Debug::LATEX, "LaTeX Warning.");
 717                         if (contains(token, "Rerun to get cross-references")) {
 718                                 retval |= RERUN;
 719                                 LYXERR(Debug::LATEX, "We should rerun.");
 720                         // package clefval needs 2 latex runs before bibtex
 721                         } else if (contains(token, "Value of")
 722                                    && contains(token, "on page")
 723                                    && contains(token, "undefined")) {
 724                                 retval |= ERROR_RERUN;
 725                                 LYXERR(Debug::LATEX, "Force rerun.");
 726                         // package etaremune
 727                         } else if (contains(token, "Etaremune labels have changed")) {
 728                                 retval |= ERROR_RERUN;
 729                                 LYXERR(Debug::LATEX, "Force rerun.");
 730                         } else if (contains(token, "Citation")
 731                                    && contains(token, "on page")
 732                                    && contains(token, "undefined")) {
 733                                 retval |= UNDEF_CIT;
 734                         } else if (contains(token, "Citation")
 735                                    && contains(token, "on input line")
 736                                    && contains(token, "undefined")) {
 737                                 retval |= UNDEF_CIT;
 738                         }
 739                 } else if (prefixIs(token, "Package")) {
 740                         // Package warnings
 741                         retval |= PACKAGE_WARNING;
 742                         if (contains(token, "natbib Warning:")) {
 743                                 // Natbib warnings
 744                                 if (contains(token, "Citation")
 745                                     && contains(token, "on page")
 746                                     && contains(token, "undefined")) {
 747                                         retval |= UNDEF_CIT;
 748                                 }
 749                         } else if (contains(token, "run BibTeX")) {
 750                                 retval |= UNDEF_CIT;
 751                         } else if (contains(token, "run Biber")) {
 752                                 retval |= UNDEF_CIT;
 753                                 biber = true;
 754                         } else if (contains(token, "Rerun LaTeX") ||
 755                                    contains(token, "Please rerun LaTeX") ||
 756                                    contains(token, "Rerun to get")) {
 757                                 // at least longtable.sty and bibtopic.sty
 758                                 // might use this.
 759                                 LYXERR(Debug::LATEX, "We should rerun.");
 760                                 retval |= RERUN;
 761                         }
 762                 } else if (prefixIs(token, "LETTRE WARNING:")) {
 763                         if (contains(token, "veuillez recompiler")) {
 764                                 // lettre.cls
 765                                 LYXERR(Debug::LATEX, "We should rerun.");
 766                                 retval |= RERUN;
 767                         }
 768                 } else if (token[0] == '(') {
 769                         if (contains(token, "Rerun LaTeX") ||
 770                             contains(token, "Rerun to get")) {
 771                                 // Used by natbib
 772                                 LYXERR(Debug::LATEX, "We should rerun.");
 773                                 retval |= RERUN;
 774                         }
 775                 } else if (prefixIs(token, "! ")
 776                             || (fle_style
 777                                 && regex_match(token, sub, file_line_error)
 778                                 && !contains(token, "pdfTeX warning"))) {
 779                            // Ok, we have something that looks like a TeX Error
 780                            // but what do we really have.
 781
 782                         // Just get the error description:
 783                         string desc;
 784                         if (prefixIs(token, "! "))
 785                                 desc = string(token, 2);
 786                         else if (fle_style)
 787                                 desc = sub.str();
 788                         if (contains(token, "LaTeX Error:"))
 789                                 retval |= LATEX_ERROR;
 790
 791                         if (prefixIs(token, "! File ended while scanning")) {
 792                                 if (prefixIs(token, "! File ended while scanning use of \\Hy@setref@link.")){
 793                                         // bug 7344. We must rerun LaTeX if hyperref has been toggled.
 794                                         retval |= ERROR_RERUN;
 795                                         LYXERR(Debug::LATEX, "Force rerun.");
 796                                 } else {
 797                                         // bug 6445. At this point its not clear we finish with error.
 798                                         wait_for_error = desc;
 799                                         continue;
 800                                 }
 801                         }
 802
 803                         if (prefixIs(token, "! Incomplete \\if")) {
 804                                 // bug 10666. At this point its not clear we finish with error.
 805                                 wait_for_error = desc;
 806                                 continue;
 807                         }
 808
 809                         if (prefixIs(token, "! Paragraph ended before \\Hy@setref@link was complete.")){
 810                                         // bug 7344. We must rerun LaTeX if hyperref has been toggled.
 811                                         retval |= ERROR_RERUN;
 812                                         LYXERR(Debug::LATEX, "Force rerun.");
 813                         }
 814
 815                         if (!wait_for_error.empty() && prefixIs(token, "! Emergency stop.")){
 816                                 retval |= LATEX_ERROR;
 817                                 string errstr;
 818                                 int count = 0;
 819                                 errstr = wait_for_error;
 820                                 wait_for_error.clear();
 821                                 do {
 822                                         if (!getline(ifs, tmp))
 823                                                 break;
 824                                         tmp = rtrim(tmp, "\r");
 825                                         errstr += "\n" + tmp;
 826                                         if (++count > 5)
 827                                                 break;
 828                                 } while (!contains(tmp, "(job aborted"));
 829
 830                                 terr.insertError(0,
 831                                                  from_ascii("Emergency stop"),
 832                                                  from_local8bit(errstr),
 833                                                  child_name);
 834                         }
 835
 836                         // get the next line
 837                         string tmp;
 838                         int count = 0;
 839                         do {
 840                                 if (!getline(ifs, tmp))
 841                                         break;
 842                                 tmp = rtrim(tmp, "\r");
 843                                 // 15 is somewhat arbitrarily chosen, based on practice.
 844                                 // We used 10 for 14 years and increased it to 15 when we
 845                                 // saw one case.
 846                                 if (++count > 15)
 847                                         break;
 848                         } while (!prefixIs(tmp, "l."));
 849                         if (prefixIs(tmp, "l.")) {
 850                                 // we have a latex error
 851                                 retval |=  TEX_ERROR;
 852                                 if (contains(desc,
 853                                         "Package babel Error: You haven't defined the language")
 854                                     || contains(desc,
 855                                         "Package babel Error: You haven't loaded the option")
 856                                     || contains(desc,
 857                                         "Package babel Error: Unknown language"))
 858                                         retval |= ERROR_RERUN;
 859                                 // get the line number:
 860                                 int line = 0;
 861                                 sscanf(tmp.c_str(), "l.%d", &line);
 862                                 // get the rest of the message:
 863                                 string errstr(tmp, tmp.find(' '));
 864                                 errstr += '\n';
 865                                 getline(ifs, tmp);
 866                                 tmp = rtrim(tmp, "\r");
 867                                 while (!contains(errstr, "l.")
 868                                        && !tmp.empty()
 869                                        && !prefixIs(tmp, "! ")
 870                                        && !contains(tmp, "(job aborted")) {
 871                                         errstr += tmp;
 872                                         errstr += "\n";
 873                                         getline(ifs, tmp);
 874                                         tmp = rtrim(tmp, "\r");
 875                                 }
 876                                 LYXERR(Debug::LATEX, "line: " << line << '\n'
 877                                         << "Desc: " << desc << '\n' << "Text: " << errstr);
 878                                 if (line == last_line)
 879                                         ++line_count;
 880                                 else {
 881                                         line_count = 1;
 882                                         last_line = line;
 883                                 }
 884                                 if (line_count <= 5) {
 885                                         // FIXME UNICODE
 886                                         // We have no idea what the encoding of
 887                                         // the log file is.
 888                                         // It seems that the output from the
 889                                         // latex compiler itself is pure ASCII,
 890                                         // but it can include bits from the
 891                                         // document, so whatever encoding we
 892                                         // assume here it can be wrong.
 893                                         terr.insertError(line,
 894                                                          from_local8bit(desc),
 895                                                          from_local8bit(errstr),
 896                                                          child_name);
 897                                         ++num_errors;
 898                                 }
 899                         }
 900                 } else {
 901                         // information messages, TeX warnings and other
 902                         // warnings we have not caught earlier.
 903                         if (prefixIs(token, "Overfull ")) {
 904                                 retval |= TEX_WARNING;
 905                         } else if (prefixIs(token, "Underfull ")) {
 906                                 retval |= TEX_WARNING;
 907                         } else if (contains(token, "Rerun to get citations")) {
 908                                 // Natbib seems to use this.
 909                                 retval |= UNDEF_CIT;
 910                         } else if (contains(token, "No pages of output")
 911                                 || contains(token, "no pages of output")) {
 912                                 // No output file (e.g. the DVI or PDF) was created
 913                                 retval |= NO_OUTPUT;
 914                         } else if (contains(token, "Error 256 (driver return code)")) {
 915                                 // This is a xdvipdfmx driver error reported by XeTeX.
 916                                 // We have to check whether an output PDF file was created.
 917                                 FileName pdffile = file;
 918                                 pdffile.changeExtension("pdf");
 919                                 if (!pdffile.exists())
 920                                         // No output PDF file was created (see #10076)
 921                                         retval |= NO_OUTPUT;
 922                         } else if (contains(token, "That makes 100 errors")) {
 923                                 // More than 100 errors were reported
 924                                 retval |= TOO_MANY_ERRORS;
 925                         } else if (prefixIs(token, "!pdfTeX error:")) {
 926                                 // otherwise we dont catch e.g.:
 927                                 // !pdfTeX error: pdflatex (file feyn10): Font feyn10 at 600 not found
 928                                 retval |= ERRORS;
 929                                 terr.insertError(0,
 930                                                  from_ascii("pdfTeX Error"),
 931                                                  from_local8bit(token),
 932                                                  child_name);
 933                         } else if (!ignore_missing_glyphs
 934                                    && prefixIs(token, "Missing character: There is no ")
 935                                    && !contains(token, "nullfont")) {
 936                                 // Warning about missing glyph in selected font
 937                                 // may be dataloss (bug 9610)
 938                                 // but can be ignored for 'nullfont' (bug 10394).
 939                                 retval |= LATEX_ERROR;
 940                                 terr.insertError(0,
 941                                                  from_local8bit("Missing glyphs!"),
 942                                                  from_local8bit(token),
 943                                                  child_name);
 944                         } else if (!wait_for_error.empty()) {
 945                                 // We collect information until we know we have an error.
 946                                 wait_for_error += token + '\n';
 947                         }
 948                 }
 949         }
 950         LYXERR(Debug::LATEX, "Log line: " << token);
 951         return retval;
 952 }
 953
 954
 955 namespace {
 956
 957 bool insertIfExists(FileName const & absname, DepTable & head)
 958 {
 959         if (absname.exists() && !absname.isDirectory()) {
 960                 head.insert(absname, true);
 961                 return true;
 962         }
 963         return false;
 964 }
 965
 966
 967 bool handleFoundFile(string const & ff, DepTable & head)
 968 {
 969         // convert from native os path to unix path
 970         string foundfile = os::internal_path(trim(ff));
 971
 972         LYXERR(Debug::DEPEND, "Found file: " << foundfile);
 973
 974         // Ok now we found a file.
 975         // Now we should make sure that this is a file that we can
 976         // access through the normal paths.
 977         // We will not try any fancy search methods to
 978         // find the file.
 979
 980         // (1) foundfile is an
 981         //     absolute path and should
 982         //     be inserted.
 983         FileName absname;
 984         if (FileName::isAbsolute(foundfile)) {
 985                 LYXERR(Debug::DEPEND, "AbsolutePath file: " << foundfile);
 986                 // On initial insert we want to do the update at once
 987                 // since this file cannot be a file generated by
 988                 // the latex run.
 989                 absname.set(foundfile);
 990                 if (!insertIfExists(absname, head)) {
 991                         // check for spaces
 992                         string strippedfile = foundfile;
 993                         while (contains(strippedfile, " ")) {
 994                                 // files with spaces are often enclosed in quotation
 995                                 // marks; those have to be removed
 996                                 string unquoted = subst(strippedfile, "\"", "");
 997                                 absname.set(unquoted);
 998                                 if (insertIfExists(absname, head))
 999                                         return true;
1000                                 // strip off part after last space and try again
1001                                 string tmp = strippedfile;
1002                                 rsplit(tmp, strippedfile, ' ');
1003                                 absname.set(strippedfile);
1004                                 if (insertIfExists(absname, head))
1005                                         return true;
1006                         }
1007                 }
1008         }
1009
1010         string onlyfile = onlyFileName(foundfile);
1011         absname = makeAbsPath(onlyfile);
1012
1013         // check for spaces
1014         while (contains(foundfile, ' ')) {
1015                 if (absname.exists())
1016                         // everything o.k.
1017                         break;
1018                 else {
1019                         // files with spaces are often enclosed in quotation
1020                         // marks; those have to be removed
1021                         string unquoted = subst(foundfile, "\"", "");
1022                         absname = makeAbsPath(unquoted);
1023                         if (absname.exists())
1024                                 break;
1025                         // strip off part after last space and try again
1026                         string strippedfile;
1027                         rsplit(foundfile, strippedfile, ' ');
1028                         foundfile = strippedfile;
1029                         onlyfile = onlyFileName(strippedfile);
1030                         absname = makeAbsPath(onlyfile);
1031                 }
1032         }
1033
1034         // (2) foundfile is in the tmpdir
1035         //     insert it into head
1036         if (absname.exists() && !absname.isDirectory()) {
1037                 // FIXME: This regex contained glo, but glo is used by the old
1038                 // version of nomencl.sty. Do we need to put it back?
1039                 static regex const unwanted("^.*\\.(aux|log|dvi|bbl|ind)$");
1040                 if (regex_match(onlyfile, unwanted)) {
1041                         LYXERR(Debug::DEPEND, "We don't want " << onlyfile
1042                                 << " in the dep file");
1043                 } else if (suffixIs(onlyfile, ".tex")) {
1044                         // This is a tex file generated by LyX
1045                         // and latex is not likely to change this
1046                         // during its runs.
1047                         LYXERR(Debug::DEPEND, "Tmpdir TeX file: " << onlyfile);
1048                         head.insert(absname, true);
1049                 } else {
1050                         LYXERR(Debug::DEPEND, "In tmpdir file:" << onlyfile);
1051                         head.insert(absname);
1052                 }
1053                 return true;
1054         } else {
1055                 LYXERR(Debug::DEPEND, "Not a file or we are unable to find it.");
1056                 return false;
1057         }
1058 }
1059
1060
1061 bool completeFilename(string const & ff, DepTable & head)
1062 {
1063         // If we do not find a dot, we suspect
1064         // a fragmental file name
1065         if (!contains(ff, '.'))
1066                 return false;
1067
1068         // if we have a dot, we let handleFoundFile decide
1069         return handleFoundFile(ff, head);
1070 }
1071
1072
1073 int iterateLine(string const & token, regex const & reg, string const & closing,
1074                 int fragment_pos, DepTable & head)
1075 {
1076         smatch what;
1077         string::const_iterator first = token.begin();
1078         string::const_iterator end = token.end();
1079         bool fragment = false;
1080         string last_match;
1081
1082         while (regex_search(first, end, what, reg)) {
1083                 // if we have a dot, try to handle as file
1084                 if (contains(what.str(1), '.')) {
1085                         first = what[0].second;
1086                         if (what.str(2) == closing) {
1087                                 handleFoundFile(what.str(1), head);
1088                                 // since we had a closing bracket,
1089                                 // do not investigate further
1090                                 fragment = false;
1091                         } else
1092                                 // if we have no closing bracket,
1093                                 // try to handle as file nevertheless
1094                                 fragment = !handleFoundFile(
1095                                         what.str(1) + what.str(2), head);
1096                 }
1097                 // if we do not have a dot, check if the line has
1098                 // a closing bracket (else, we suspect a line break)
1099                 else if (what.str(2) != closing) {
1100                         first = what[0].second;
1101                         fragment = true;
1102                 } else {
1103                         // we have a closing bracket, so the content
1104                         // is not a file name.
1105                         // no need to investigate further
1106                         first = what[0].second;
1107                         fragment = false;
1108                 }
1109                 last_match = what.str(1);
1110         }
1111
1112         // We need to consider the result from previous line iterations:
1113         // We might not find a fragment here, but another one might follow
1114         // E.g.: (filename.ext) <filenam
1115         // Vice versa, we consider the search completed if a real match
1116         // follows a potential fragment from a previous iteration.
1117         // E.g. <some text we considered a fragment (filename.ext)
1118         // result = -1 means we did not find a fragment!
1119         int result = -1;
1120         int last_match_pos = -1;
1121         if (!last_match.empty() && token.find(last_match) != string::npos)
1122                 last_match_pos = int(token.find(last_match));
1123         if (fragment) {
1124                 if (last_match_pos > fragment_pos)
1125                         result = last_match_pos;
1126                 else
1127                         result = fragment_pos;
1128         } else
1129                 if (last_match_pos < fragment_pos)
1130                         result = fragment_pos;
1131
1132         return result;
1133 }
1134
1135 } // namespace
1136
1137
1138 void LaTeX::deplog(DepTable & head)
1139 {
1140         // This function reads the LaTeX log file end extracts all the
1141         // external files used by the LaTeX run. The files are then
1142         // entered into the dependency file.
1143
1144         string const logfile =
1145                 onlyFileName(changeExtension(file.absFileName(), ".log"));
1146
1147         static regex const reg1("File: (.+).*");
1148         static regex const reg2("No file (.+)(.).*");
1149         static regex const reg3("\\\\openout[0-9]+.*=.*`(.+)(..).*");
1150         // If an index should be created, MikTex does not write a line like
1151         //    \openout# = 'sample.idx'.
1152         // but instead only a line like this into the log:
1153         //   Writing index file sample.idx
1154         static regex const reg4("Writing index file (.+).*");
1155         static regex const regoldnomencl("Writing glossary file (.+).*");
1156         static regex const regnomencl("Writing nomenclature file (.+).*");
1157         // If a toc should be created, MikTex does not write a line like
1158         //    \openout# = `sample.toc'.
1159         // but only a line like this into the log:
1160         //    \tf@toc=\write#
1161         // This line is also written by tetex.
1162         // This line is not present if no toc should be created.
1163         static regex const miktexTocReg("\\\\tf@toc=\\\\write.*");
1164         // file names can be enclosed in <...> (anywhere on the line)
1165         static regex const reg5(".*<[^>]+.*");
1166         // and also (...) anywhere on the line
1167         static regex const reg6(".*\\([^)]+.*");
1168
1169         FileName const fn = makeAbsPath(logfile);
1170         ifstream ifs(fn.toFilesystemEncoding().c_str());
1171         string lastline;
1172         while (ifs) {
1173                 // Ok, the scanning of files here is not sufficient.
1174                 // Sometimes files are named by "File: xxx" only
1175                 // Therefore we use some regexps to find files instead.
1176                 // Note: all file names and paths might contains spaces.
1177                 // Also, file names might be broken across lines. Therefore
1178                 // we mark (potential) fragments and merge those lines.
1179                 bool fragment = false;
1180                 string token;
1181                 getline(ifs, token);
1182                 // MikTeX sometimes inserts \0 in the log file. They can't be
1183                 // removed directly with the existing string utility
1184                 // functions, so convert them first to \r, and remove all
1185                 // \r's afterwards, since we need to remove them anyway.
1186                 token = subst(token, '\0', '\r');
1187                 token = subst(token, "\r", "");
1188                 if (token.empty() || token == ")") {
1189                         lastline = string();
1190                         continue;
1191                 }
1192
1193                 // FIXME UNICODE: We assume that the file names in the log
1194                 // file are in the file system encoding.
1195                 token = to_utf8(from_filesystem8bit(token));
1196
1197                 // Sometimes, filenames are broken across lines.
1198                 // We care for that and save suspicious lines.
1199                 // Here we exclude some cases where we are sure
1200                 // that there is no continued filename
1201                 if (!lastline.empty()) {
1202                         static regex const package_info("Package \\w+ Info: .*");
1203                         static regex const package_warning("Package \\w+ Warning: .*");
1204                         if (prefixIs(token, "File:") || prefixIs(token, "(Font)")
1205                             || prefixIs(token, "Package:")
1206                             || prefixIs(token, "Language:")
1207                             || prefixIs(token, "LaTeX Info:")
1208                             || prefixIs(token, "LaTeX Font Info:")
1209                             || prefixIs(token, "\\openout[")
1210                             || prefixIs(token, "))")
1211                             || regex_match(token, package_info)
1212                             || regex_match(token, package_warning))
1213                                 lastline = string();
1214                 }
1215
1216                 if (!lastline.empty())
1217                         // probably a continued filename from last line
1218                         token = lastline + token;
1219                 if (token.length() > 255) {
1220                         // string too long. Cut off.
1221                         token.erase(0, token.length() - 251);
1222                 }
1223
1224                 smatch sub;
1225
1226                 // (1) "File: file.ext"
1227                 if (regex_match(token, sub, reg1)) {
1228                         // is this a fragmental file name?
1229                         fragment = !completeFilename(sub.str(1), head);
1230                         // However, ...
1231                         if (suffixIs(token, ")"))
1232                                 // no fragment for sure
1233                                 fragment = false;
1234                 // (2) "No file file.ext"
1235                 } else if (regex_match(token, sub, reg2)) {
1236                         // file names must contains a dot, line ends with dot
1237                         if (contains(sub.str(1), '.') && sub.str(2) == ".")
1238                                 fragment = !handleFoundFile(sub.str(1), head);
1239                         else
1240                                 // we suspect a line break
1241                                 fragment = true;
1242                 // (3) "\openout<nr> = `file.ext'."
1243                 } else if (regex_match(token, sub, reg3)) {
1244                         // search for closing '. at the end of the line
1245                         if (sub.str(2) == "\'.")
1246                                 fragment = !handleFoundFile(sub.str(1), head);
1247                         else
1248                                 // potential fragment
1249                                 fragment = true;
1250                 // (4) "Writing index file file.ext"
1251                 } else if (regex_match(token, sub, reg4))
1252                         // fragmential file name?
1253                         fragment = !completeFilename(sub.str(1), head);
1254                 // (5) "Writing nomenclature file file.ext"
1255                 else if (regex_match(token, sub, regnomencl) ||
1256                            regex_match(token, sub, regoldnomencl))
1257                         // fragmental file name?
1258                         fragment= !completeFilename(sub.str(1), head);
1259                 // (6) "\tf@toc=\write<nr>" (for MikTeX)
1260                 else if (regex_match(token, sub, miktexTocReg))
1261                         fragment = !handleFoundFile(onlyFileName(changeExtension(
1262                                                 file.absFileName(), ".toc")), head);
1263                 else
1264                         // not found, but we won't check further
1265                         fragment = false;
1266
1267                 int fragment_pos = -1;
1268                 // (7) "<file.ext>"
1269                 // We can have several of these on one line
1270                 // (and in addition to those above)
1271                 if (regex_match(token, sub, reg5)) {
1272                         // search for strings in <...>
1273                         static regex const reg5_1("<([^>]+)(.)");
1274                         fragment_pos = iterateLine(token, reg5_1, ">",
1275                                                    fragment_pos, head);
1276                         fragment = (fragment_pos != -1);
1277                 }
1278
1279                 // (8) "(file.ext)"
1280                 // We can have several of these on one line
1281                 // this must be queried separated, because of
1282                 // cases such as "File: file.ext (type eps)"
1283                 // where "File: file.ext" would be skipped
1284                 if (regex_match(token, sub, reg6)) {
1285                         // search for strings in (...)
1286                         static regex const reg6_1("\\(([^()]+)(.)");
1287                         fragment_pos = iterateLine(token, reg6_1, ")",
1288                                                    fragment_pos, head);
1289                         fragment = (fragment_pos != -1);
1290                 }
1291
1292                 if (fragment)
1293                         // probable linebreak within file name:
1294                         // save this line
1295                         lastline = token;
1296                 else
1297                         // no linebreak: reset
1298                         lastline = string();
1299         }
1300
1301         // Make sure that the main .tex file is in the dependency file.
1302         head.insert(file, true);
1303 }
1304
1305
1306 int LaTeX::scanBlgFile(DepTable & dep, TeXErrors & terr)
1307 {
1308         FileName const blg_file(changeExtension(file.absFileName(), "blg"));
1309         LYXERR(Debug::LATEX, "Scanning blg file: " << blg_file);
1310
1311         ifstream ifs(blg_file.toFilesystemEncoding().c_str());
1312         string token;
1313         static regex const reg1(".*Found (bibtex|BibTeX) data (file|source) '([^']+).*");
1314         static regex const bibtexError("^(.*---line [0-9]+ of file).*$");
1315         static regex const bibtexError2("^(.*---while reading file).*$");
1316         static regex const bibtexError3("(A bad cross reference---).*");
1317         static regex const bibtexError4("(Sorry---you've exceeded BibTeX's).*");
1318         static regex const bibtexError5("\\*Please notify the BibTeX maintainer\\*");
1319         static regex const biberError("^.*> (FATAL|ERROR) - (.*)$");
1320         int retval = NO_ERRORS;
1321
1322         string prevtoken;
1323         while (getline(ifs, token)) {
1324                 token = rtrim(token, "\r");
1325                 smatch sub;
1326                 // FIXME UNICODE: We assume that citation keys and filenames
1327                 // in the aux file are in the file system encoding.
1328                 token = to_utf8(from_filesystem8bit(token));
1329                 if (regex_match(token, sub, reg1)) {
1330                         string data = sub.str(3);
1331                         if (!data.empty()) {
1332                                 LYXERR(Debug::LATEX, "Found bib file: " << data);
1333                                 handleFoundFile(data, dep);
1334                         }
1335                 }
1336                 else if (regex_match(token, sub, bibtexError)
1337                          || regex_match(token, sub, bibtexError2)
1338                          || regex_match(token, sub, bibtexError4)
1339                          || regex_match(token, sub, bibtexError5)) {
1340                         retval |= BIBTEX_ERROR;
1341                         string errstr = N_("BibTeX error: ") + token;
1342                         string message;
1343                         if ((prefixIs(token, "while executing---line")
1344                              || prefixIs(token, "---line ")
1345                              || prefixIs(token, "*Please notify the BibTeX"))
1346                             && !prevtoken.empty()) {
1347                                 errstr = N_("BibTeX error: ") + prevtoken;
1348                                 message = prevtoken + '\n';
1349                         }
1350                         message += token;
1351                         terr.insertError(0,
1352                                          from_local8bit(errstr),
1353                                          from_local8bit(message));
1354                 } else if (regex_match(prevtoken, sub, bibtexError3)) {
1355                         retval |= BIBTEX_ERROR;
1356                         string errstr = N_("BibTeX error: ") + prevtoken;
1357                         string message = prevtoken + '\n' + token;
1358                         terr.insertError(0,
1359                                          from_local8bit(errstr),
1360                                          from_local8bit(message));
1361                 } else if (regex_match(token, sub, biberError)) {
1362                         retval |= BIBTEX_ERROR;
1363                         string errstr = N_("Biber error: ") + sub.str(2);
1364                         string message = token;
1365                         terr.insertError(0,
1366                                          from_local8bit(errstr),
1367                                          from_local8bit(message));
1368                 }
1369                 prevtoken = token;
1370         }
1371         return retval;
1372 }
1373
1374
1375 } // namespace lyx