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