src/Buffer.cpp

   1 /**
   2  * \file Buffer.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Stefan Schimanski
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "Buffer.h"
  15
  16 #include "Author.h"
  17 #include "BiblioInfo.h"
  18 #include "BranchList.h"
  19 #include "buffer_funcs.h"
  20 #include "BufferList.h"
  21 #include "BufferParams.h"
  22 #include "Bullet.h"
  23 #include "Chktex.h"
  24 #include "Converter.h"
  25 #include "Counters.h"
  26 #include "DocIterator.h"
  27 #include "EmbeddedFiles.h"
  28 #include "Encoding.h"
  29 #include "ErrorList.h"
  30 #include "Exporter.h"
  31 #include "Format.h"
  32 #include "FuncRequest.h"
  33 #include "InsetIterator.h"
  34 #include "InsetList.h"
  35 #include "Language.h"
  36 #include "LaTeXFeatures.h"
  37 #include "LaTeX.h"
  38 #include "Layout.h"
  39 #include "Lexer.h"
  40 #include "LyXAction.h"
  41 #include "LyX.h"
  42 #include "LyXRC.h"
  43 #include "LyXVC.h"
  44 #include "output_docbook.h"
  45 #include "output.h"
  46 #include "output_latex.h"
  47 #include "output_plaintext.h"
  48 #include "paragraph_funcs.h"
  49 #include "Paragraph.h"
  50 #include "ParagraphParameters.h"
  51 #include "ParIterator.h"
  52 #include "PDFOptions.h"
  53 #include "Session.h"
  54 #include "sgml.h"
  55 #include "TexRow.h"
  56 #include "TexStream.h"
  57 #include "TextClassList.h"
  58 #include "Text.h"
  59 #include "TocBackend.h"
  60 #include "Undo.h"
  61 #include "VCBackend.h"
  62 #include "version.h"
  63
  64 #include "insets/InsetBibitem.h"
  65 #include "insets/InsetBibtex.h"
  66 #include "insets/InsetInclude.h"
  67 #include "insets/InsetText.h"
  68
  69 #include "mathed/MacroTable.h"
  70 #include "mathed/MathMacroTemplate.h"
  71 #include "mathed/MathSupport.h"
  72
  73 #include "frontends/alert.h"
  74 #include "frontends/Delegates.h"
  75 #include "frontends/WorkAreaManager.h"
  76
  77 #include "graphics/Previews.h"
  78
  79 #include "support/convert.h"
  80 #include "support/debug.h"
  81 #include "support/FileFilterList.h"
  82 #include "support/FileNameList.h"
  83 #include "support/filetools.h"
  84 #include "support/ForkedCalls.h"
  85 #include "support/gettext.h"
  86 #include "support/gzstream.h"
  87 #include "support/lstrings.h"
  88 #include "support/lyxalgo.h"
  89 #include "support/lyxlib.h"
  90 #include "support/os.h"
  91 #include "support/Path.h"
  92 #include "support/textutils.h"
  93 #include "support/types.h"
  94 #include "support/FileZipListDir.h"
  95
  96 #if !defined (HAVE_FORK)
  97 # define fork() -1
  98 #endif
  99
 100 #include <boost/bind.hpp>
 101 #include <boost/shared_ptr.hpp>
 102
 103 #include <algorithm>
 104 #include <iomanip>
 105 #include <stack>
 106 #include <sstream>
 107 #include <fstream>
 108
 109 using std::endl;
 110 using std::for_each;
 111 using std::make_pair;
 112
 113 using std::ios;
 114 using std::map;
 115 using std::ostream;
 116 using std::ostringstream;
 117 using std::ofstream;
 118 using std::ifstream;
 119 using std::pair;
 120 using std::stack;
 121 using std::vector;
 122 using std::string;
 123 using std::time_t;
 124
 125 namespace lyx {
 126
 127 using support::addName;
 128 using support::bformat;
 129 using support::changeExtension;
 130 using support::cmd_ret;
 131 using support::createBufferTmpDir;
 132 using support::FileName;
 133 using support::FileNameList;
 134 using support::libFileSearch;
 135 using support::latex_path;
 136 using support::ltrim;
 137 using support::makeAbsPath;
 138 using support::makeDisplayPath;
 139 using support::makeLatexName;
 140 using support::onlyFilename;
 141 using support::onlyPath;
 142 using support::quoteName;
 143 using support::removeAutosaveFile;
 144 using support::rename;
 145 using support::runCommand;
 146 using support::split;
 147 using support::subst;
 148 using support::tempName;
 149 using support::trim;
 150 using support::suffixIs;
 151
 152 namespace Alert = frontend::Alert;
 153 namespace os = support::os;
 154
 155 namespace {
 156
 157 int const LYX_FORMAT = 307; // JSpitzm: support for \slash
 158
 159 } // namespace anon
 160
 161
 162 typedef std::map<string, bool> DepClean;
 163
 164 class Buffer::Impl
 165 {
 166 public:
 167         Impl(Buffer & parent, FileName const & file, bool readonly);
 168
 169         ~Impl()
 170         {
 171                 if (wa_) {
 172                         wa_->closeAll();
 173                         delete wa_;
 174                 }
 175         }
 176
 177         BufferParams params;
 178         LyXVC lyxvc;
 179         string temppath;
 180         mutable TexRow texrow;
 181         Buffer const * parent_buffer;
 182
 183         /// need to regenerate .tex?
 184         DepClean dep_clean;
 185
 186         /// is save needed?
 187         mutable bool lyx_clean;
 188
 189         /// is autosave needed?
 190         mutable bool bak_clean;
 191
 192         /// is this a unnamed file (New...)?
 193         bool unnamed;
 194
 195         /// buffer is r/o
 196         bool read_only;
 197
 198         /// name of the file the buffer is associated with.
 199         FileName filename;
 200
 201         /** Set to true only when the file is fully loaded.
 202          *  Used to prevent the premature generation of previews
 203          *  and by the citation inset.
 204          */
 205         bool file_fully_loaded;
 206
 207         /// our Text that should be wrapped in an InsetText
 208         InsetText inset;
 209
 210         ///
 211         mutable TocBackend toc_backend;
 212
 213         /// macro table
 214         typedef std::map<unsigned int, MacroData, std::greater<int> > PositionToMacroMap;
 215         typedef std::map<docstring, PositionToMacroMap> NameToPositionMacroMap;
 216         NameToPositionMacroMap macros;
 217
 218         /// Container for all sort of Buffer dependant errors.
 219         map<string, ErrorList> errorLists;
 220
 221         /// all embedded files of this buffer
 222         EmbeddedFiles embedded_files;
 223
 224         /// timestamp and checksum used to test if the file has been externally
 225         /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
 226         time_t timestamp_;
 227         unsigned long checksum_;
 228
 229         ///
 230         frontend::WorkAreaManager * wa_;
 231
 232         ///
 233         Undo undo_;
 234
 235         /// A cache for the bibfiles (including bibfiles of loaded child
 236         /// documents), needed for appropriate update of natbib labels.
 237         mutable FileNameList bibfilesCache_;
 238 };
 239
 240
 241 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
 242         : parent_buffer(0), lyx_clean(true), bak_clean(true), unnamed(false),
 243           read_only(readonly_), filename(file), file_fully_loaded(false),
 244           inset(params), toc_backend(&parent), embedded_files(&parent),
 245           timestamp_(0), checksum_(0), wa_(0), undo_(parent)
 246 {
 247         inset.setAutoBreakRows(true);
 248         lyxvc.setBuffer(&parent);
 249         temppath = createBufferTmpDir();
 250
 251         // FIXME: And now do something if temppath == string(), because we
 252         // assume from now on that temppath points to a valid temp dir.
 253         // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
 254
 255         if (use_gui)
 256                 wa_ = new frontend::WorkAreaManager;
 257 }
 258
 259
 260 Buffer::Buffer(string const & file, bool readonly)
 261         : d(new Impl(*this, FileName(file), readonly)), gui_(0)
 262 {
 263         LYXERR(Debug::INFO, "Buffer::Buffer()");
 264 }
 265
 266
 267 Buffer::~Buffer()
 268 {
 269         LYXERR(Debug::INFO, "Buffer::~Buffer()");
 270         // here the buffer should take care that it is
 271         // saved properly, before it goes into the void.
 272
 273         // GuiView already destroyed
 274         gui_ = 0;
 275
 276         Buffer const * master = masterBuffer();
 277         if (master != this && use_gui)
 278                 // We are closing buf which was a child document so we
 279                 // must update the labels and section numbering of its master
 280                 // Buffer.
 281                 updateLabels(*master);
 282
 283         resetChildDocuments(false);
 284
 285         if (!temppath().empty() && !FileName(temppath()).destroyDirectory()) {
 286                 Alert::warning(_("Could not remove temporary directory"),
 287                         bformat(_("Could not remove the temporary directory %1$s"),
 288                         from_utf8(temppath())));
 289         }
 290
 291         // Remove any previewed LaTeX snippets associated with this buffer.
 292         graphics::Previews::get().removeLoader(*this);
 293
 294         delete d;
 295 }
 296
 297
 298 void Buffer::changed() const
 299 {
 300         if (d->wa_)
 301                 d->wa_->redrawAll();
 302 }
 303
 304
 305 frontend::WorkAreaManager & Buffer::workAreaManager() const
 306 {
 307         BOOST_ASSERT(d->wa_);
 308         return *d->wa_;
 309 }
 310
 311
 312 Text & Buffer::text() const
 313 {
 314         return const_cast<Text &>(d->inset.text_);
 315 }
 316
 317
 318 Inset & Buffer::inset() const
 319 {
 320         return const_cast<InsetText &>(d->inset);
 321 }
 322
 323
 324 BufferParams & Buffer::params()
 325 {
 326         return d->params;
 327 }
 328
 329
 330 BufferParams const & Buffer::params() const
 331 {
 332         return d->params;
 333 }
 334
 335
 336 ParagraphList & Buffer::paragraphs()
 337 {
 338         return text().paragraphs();
 339 }
 340
 341
 342 ParagraphList const & Buffer::paragraphs() const
 343 {
 344         return text().paragraphs();
 345 }
 346
 347
 348 LyXVC & Buffer::lyxvc()
 349 {
 350         return d->lyxvc;
 351 }
 352
 353
 354 LyXVC const & Buffer::lyxvc() const
 355 {
 356         return d->lyxvc;
 357 }
 358
 359
 360 string const & Buffer::temppath() const
 361 {
 362         return d->temppath;
 363 }
 364
 365
 366 TexRow const & Buffer::texrow() const
 367 {
 368         return d->texrow;
 369 }
 370
 371
 372 TocBackend & Buffer::tocBackend() const
 373 {
 374         return d->toc_backend;
 375 }
 376
 377
 378 EmbeddedFiles & Buffer::embeddedFiles()
 379 {
 380         return d->embedded_files;
 381 }
 382
 383
 384 EmbeddedFiles const & Buffer::embeddedFiles() const
 385 {
 386         return d->embedded_files;
 387 }
 388
 389
 390 Undo & Buffer::undo()
 391 {
 392         return d->undo_;
 393 }
 394
 395
 396 string Buffer::latexName(bool const no_path) const
 397 {
 398         FileName latex_name = makeLatexName(d->filename);
 399         return no_path ? latex_name.onlyFileName()
 400                 : latex_name.absFilename();
 401 }
 402
 403
 404 string Buffer::logName(LogType * type) const
 405 {
 406         string const filename = latexName(false);
 407
 408         if (filename.empty()) {
 409                 if (type)
 410                         *type = latexlog;
 411                 return string();
 412         }
 413
 414         string const path = temppath();
 415
 416         FileName const fname(addName(temppath(),
 417                                      onlyFilename(changeExtension(filename,
 418                                                                   ".log"))));
 419         FileName const bname(
 420                 addName(path, onlyFilename(
 421                         changeExtension(filename,
 422                                         formats.extension("literate") + ".out"))));
 423
 424         // If no Latex log or Build log is newer, show Build log
 425
 426         if (bname.exists() &&
 427             (!fname.exists() || fname.lastModified() < bname.lastModified())) {
 428                 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
 429                 if (type)
 430                         *type = buildlog;
 431                 return bname.absFilename();
 432         }
 433         LYXERR(Debug::FILES, "Log name calculated as: " << fname);
 434         if (type)
 435                         *type = latexlog;
 436         return fname.absFilename();
 437 }
 438
 439
 440 void Buffer::setReadonly(bool const flag)
 441 {
 442         if (d->read_only != flag) {
 443                 d->read_only = flag;
 444                 setReadOnly(flag);
 445         }
 446 }
 447
 448
 449 void Buffer::setFileName(string const & newfile)
 450 {
 451         d->filename = makeAbsPath(newfile);
 452         setReadonly(d->filename.isReadOnly());
 453         updateTitles();
 454 }
 455
 456
 457 int Buffer::readHeader(Lexer & lex)
 458 {
 459         int unknown_tokens = 0;
 460         int line = -1;
 461         int begin_header_line = -1;
 462
 463         // Initialize parameters that may be/go lacking in header:
 464         params().branchlist().clear();
 465         params().preamble.erase();
 466         params().options.erase();
 467         params().float_placement.erase();
 468         params().paperwidth.erase();
 469         params().paperheight.erase();
 470         params().leftmargin.erase();
 471         params().rightmargin.erase();
 472         params().topmargin.erase();
 473         params().bottommargin.erase();
 474         params().headheight.erase();
 475         params().headsep.erase();
 476         params().footskip.erase();
 477         params().listings_params.clear();
 478         params().clearLayoutModules();
 479         params().pdfoptions().clear();
 480
 481         for (int i = 0; i < 4; ++i) {
 482                 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
 483                 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
 484         }
 485
 486         ErrorList & errorList = d->errorLists["Parse"];
 487
 488         while (lex.isOK()) {
 489                 lex.next();
 490                 string const token = lex.getString();
 491
 492                 if (token.empty())
 493                         continue;
 494
 495                 if (token == "\\end_header")
 496                         break;
 497
 498                 ++line;
 499                 if (token == "\\begin_header") {
 500                         begin_header_line = line;
 501                         continue;
 502                 }
 503
 504                 LYXERR(Debug::PARSER, "Handling document header token: `"
 505                                       << token << '\'');
 506
 507                 string unknown = params().readToken(lex, token, d->filename.onlyPath());
 508                 if (!unknown.empty()) {
 509                         if (unknown[0] != '\\' && token == "\\textclass") {
 510                                 Alert::warning(_("Unknown document class"),
 511                        bformat(_("Using the default document class, because the "
 512                                               "class %1$s is unknown."), from_utf8(unknown)));
 513                         } else {
 514                                 ++unknown_tokens;
 515                                 docstring const s = bformat(_("Unknown token: "
 516                                                                         "%1$s %2$s\n"),
 517                                                          from_utf8(token),
 518                                                          lex.getDocString());
 519                                 errorList.push_back(ErrorItem(_("Document header error"),
 520                                         s, -1, 0, 0));
 521                         }
 522                 }
 523         }
 524         if (begin_header_line) {
 525                 docstring const s = _("\\begin_header is missing");
 526                 errorList.push_back(ErrorItem(_("Document header error"),
 527                         s, -1, 0, 0));
 528         }
 529
 530         return unknown_tokens;
 531 }
 532
 533
 534 // Uwe C. Schroeder
 535 // changed to be public and have one parameter
 536 // Returns false if "\end_document" is not read (Asger)
 537 bool Buffer::readDocument(Lexer & lex)
 538 {
 539         ErrorList & errorList = d->errorLists["Parse"];
 540         errorList.clear();
 541
 542         lex.next();
 543         string const token = lex.getString();
 544         if (token != "\\begin_document") {
 545                 docstring const s = _("\\begin_document is missing");
 546                 errorList.push_back(ErrorItem(_("Document header error"),
 547                         s, -1, 0, 0));
 548         }
 549
 550         // we are reading in a brand new document
 551         BOOST_ASSERT(paragraphs().empty());
 552
 553         readHeader(lex);
 554         TextClass const & baseClass = textclasslist[params().getBaseClass()];
 555         if (!baseClass.load(filePath())) {
 556                 string theclass = baseClass.name();
 557                 Alert::error(_("Can't load document class"), bformat(
 558                         _("Using the default document class, because the "
 559                                      "class %1$s could not be loaded."), from_utf8(theclass)));
 560                 params().setBaseClass(defaultTextclass());
 561         }
 562
 563         if (params().outputChanges) {
 564                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
 565                 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
 566                                   LaTeXFeatures::isAvailable("xcolor");
 567
 568                 if (!dvipost && !xcolorsoul) {
 569                         Alert::warning(_("Changes not shown in LaTeX output"),
 570                                        _("Changes will not be highlighted in LaTeX output, "
 571                                          "because neither dvipost nor xcolor/soul are installed.\n"
 572                                          "Please install these packages or redefine "
 573                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 574                 } else if (!xcolorsoul) {
 575                         Alert::warning(_("Changes not shown in LaTeX output"),
 576                                        _("Changes will not be highlighted in LaTeX output "
 577                                          "when using pdflatex, because xcolor and soul are not installed.\n"
 578                                          "Please install both packages or redefine "
 579                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 580                 }
 581         }
 582
 583         // read main text
 584         bool const res = text().read(*this, lex, errorList);
 585         for_each(text().paragraphs().begin(),
 586                  text().paragraphs().end(),
 587                  bind(&Paragraph::setInsetOwner, _1, &inset()));
 588
 589         return res;
 590 }
 591
 592
 593 // needed to insert the selection
 594 void Buffer::insertStringAsLines(ParagraphList & pars,
 595         pit_type & pit, pos_type & pos,
 596         Font const & fn, docstring const & str, bool autobreakrows)
 597 {
 598         Font font = fn;
 599
 600         // insert the string, don't insert doublespace
 601         bool space_inserted = true;
 602         for (docstring::const_iterator cit = str.begin();
 603             cit != str.end(); ++cit) {
 604                 Paragraph & par = pars[pit];
 605                 if (*cit == '\n') {
 606                         if (autobreakrows && (!par.empty() || par.allowEmpty())) {
 607                                 breakParagraph(params(), pars, pit, pos,
 608                                                par.layout()->isEnvironment());
 609                                 ++pit;
 610                                 pos = 0;
 611                                 space_inserted = true;
 612                         } else {
 613                                 continue;
 614                         }
 615                         // do not insert consecutive spaces if !free_spacing
 616                 } else if ((*cit == ' ' || *cit == '\t') &&
 617                            space_inserted && !par.isFreeSpacing()) {
 618                         continue;
 619                 } else if (*cit == '\t') {
 620                         if (!par.isFreeSpacing()) {
 621                                 // tabs are like spaces here
 622                                 par.insertChar(pos, ' ', font, params().trackChanges);
 623                                 ++pos;
 624                                 space_inserted = true;
 625                         } else {
 626                                 const pos_type n = 8 - pos % 8;
 627                                 for (pos_type i = 0; i < n; ++i) {
 628                                         par.insertChar(pos, ' ', font, params().trackChanges);
 629                                         ++pos;
 630                                 }
 631                                 space_inserted = true;
 632                         }
 633                 } else if (!isPrintable(*cit)) {
 634                         // Ignore unprintables
 635                         continue;
 636                 } else {
 637                         // just insert the character
 638                         par.insertChar(pos, *cit, font, params().trackChanges);
 639                         ++pos;
 640                         space_inserted = (*cit == ' ');
 641                 }
 642
 643         }
 644 }
 645
 646
 647 bool Buffer::readString(std::string const & s)
 648 {
 649         params().compressed = false;
 650
 651         // remove dummy empty par
 652         paragraphs().clear();
 653         Lexer lex(0, 0);
 654         std::istringstream is(s);
 655         lex.setStream(is);
 656         FileName const name(tempName());
 657         switch (readFile(lex, name, true)) {
 658         case failure:
 659                 return false;
 660         case wrongversion: {
 661                 // We need to call lyx2lyx, so write the input to a file
 662                 std::ofstream os(name.toFilesystemEncoding().c_str());
 663                 os << s;
 664                 os.close();
 665                 return readFile(name);
 666         }
 667         case success:
 668                 break;
 669         }
 670
 671         return true;
 672 }
 673
 674
 675 bool Buffer::readFile(FileName const & filename)
 676 {
 677         FileName fname(filename);
 678         // Check if the file is compressed.
 679         string format = filename.guessFormatFromContents();
 680         if (format == "zip") {
 681                 // decompress to a temp directory
 682                 LYXERR(Debug::FILES, filename << " is in zip format. Unzip to " << temppath());
 683                 ::unzipToDir(filename.toFilesystemEncoding(), temppath());
 684                 //
 685                 FileName lyxfile(addName(temppath(), "content.lyx"));
 686                 // if both manifest.txt and file.lyx exist, this is am embedded file
 687                 if (lyxfile.exists()) {
 688                         params().embedded = true;
 689                         fname = lyxfile;
 690                 }
 691         }
 692         // The embedded lyx file can also be compressed, for backward compatibility
 693         format = fname.guessFormatFromContents();
 694         if (format == "gzip" || format == "zip" || format == "compress")
 695                 params().compressed = true;
 696
 697         // remove dummy empty par
 698         paragraphs().clear();
 699         Lexer lex(0, 0);
 700         lex.setFile(fname);
 701         if (readFile(lex, fname) != success)
 702                 return false;
 703
 704         return true;
 705 }
 706
 707
 708 bool Buffer::isFullyLoaded() const
 709 {
 710         return d->file_fully_loaded;
 711 }
 712
 713
 714 void Buffer::setFullyLoaded(bool value)
 715 {
 716         d->file_fully_loaded = value;
 717 }
 718
 719
 720 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
 721                 bool fromstring)
 722 {
 723         BOOST_ASSERT(!filename.empty());
 724
 725         if (!lex.isOK()) {
 726                 Alert::error(_("Document could not be read"),
 727                              bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
 728                 return failure;
 729         }
 730
 731         lex.next();
 732         string const token = lex.getString();
 733
 734         if (!lex) {
 735                 Alert::error(_("Document could not be read"),
 736                              bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
 737                 return failure;
 738         }
 739
 740         // the first token _must_ be...
 741         if (token != "\\lyxformat") {
 742                 lyxerr << "Token: " << token << endl;
 743
 744                 Alert::error(_("Document format failure"),
 745                              bformat(_("%1$s is not a LyX document."),
 746                                        from_utf8(filename.absFilename())));
 747                 return failure;
 748         }
 749
 750         lex.next();
 751         string tmp_format = lex.getString();
 752         //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
 753         // if present remove ".," from string.
 754         string::size_type dot = tmp_format.find_first_of(".,");
 755         //lyxerr << "           dot found at " << dot << endl;
 756         if (dot != string::npos)
 757                         tmp_format.erase(dot, 1);
 758         int const file_format = convert<int>(tmp_format);
 759         //lyxerr << "format: " << file_format << endl;
 760
 761         // save timestamp and checksum of the original disk file, making sure
 762         // to not overwrite them with those of the file created in the tempdir
 763         // when it has to be converted to the current format.
 764         if (!d->checksum_) {
 765                 // Save the timestamp and checksum of disk file. If filename is an
 766                 // emergency file, save the timestamp and checksum of the original lyx file
 767                 // because isExternallyModified will check for this file. (BUG4193)
 768                 string diskfile = filename.absFilename();
 769                 if (suffixIs(diskfile, ".emergency"))
 770                         diskfile = diskfile.substr(0, diskfile.size() - 10);
 771                 saveCheckSum(FileName(diskfile));
 772         }
 773
 774         if (file_format != LYX_FORMAT) {
 775
 776                 if (fromstring)
 777                         // lyx2lyx would fail
 778                         return wrongversion;
 779
 780                 FileName const tmpfile(tempName());
 781                 if (tmpfile.empty()) {
 782                         Alert::error(_("Conversion failed"),
 783                                      bformat(_("%1$s is from a different"
 784                                               " version of LyX, but a temporary"
 785                                               " file for converting it could"
 786                                                             " not be created."),
 787                                               from_utf8(filename.absFilename())));
 788                         return failure;
 789                 }
 790                 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
 791                 if (lyx2lyx.empty()) {
 792                         Alert::error(_("Conversion script not found"),
 793                                      bformat(_("%1$s is from a different"
 794                                                " version of LyX, but the"
 795                                                " conversion script lyx2lyx"
 796                                                             " could not be found."),
 797                                                from_utf8(filename.absFilename())));
 798                         return failure;
 799                 }
 800                 ostringstream command;
 801                 command << os::python()
 802                         << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
 803                         << " -t " << convert<string>(LYX_FORMAT)
 804                         << " -o " << quoteName(tmpfile.toFilesystemEncoding())
 805                         << ' ' << quoteName(filename.toFilesystemEncoding());
 806                 string const command_str = command.str();
 807
 808                 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
 809
 810                 cmd_ret const ret = runCommand(command_str);
 811                 if (ret.first != 0) {
 812                         Alert::error(_("Conversion script failed"),
 813                                      bformat(_("%1$s is from a different version"
 814                                               " of LyX, but the lyx2lyx script"
 815                                                             " failed to convert it."),
 816                                               from_utf8(filename.absFilename())));
 817                         return failure;
 818                 } else {
 819                         bool const ret = readFile(tmpfile);
 820                         // Do stuff with tmpfile name and buffer name here.
 821                         return ret ? success : failure;
 822                 }
 823
 824         }
 825
 826         if (readDocument(lex)) {
 827                 Alert::error(_("Document format failure"),
 828                              bformat(_("%1$s ended unexpectedly, which means"
 829                                                     " that it is probably corrupted."),
 830                                        from_utf8(filename.absFilename())));
 831         }
 832
 833         d->file_fully_loaded = true;
 834         return success;
 835 }
 836
 837
 838 // Should probably be moved to somewhere else: BufferView? LyXView?
 839 bool Buffer::save() const
 840 {
 841         // We don't need autosaves in the immediate future. (Asger)
 842         resetAutosaveTimers();
 843
 844         string const encodedFilename = d->filename.toFilesystemEncoding();
 845
 846         FileName backupName;
 847         bool madeBackup = false;
 848
 849         // make a backup if the file already exists
 850         if (lyxrc.make_backup && fileName().exists()) {
 851                 backupName = FileName(absFileName() + '~');
 852                 if (!lyxrc.backupdir_path.empty()) {
 853                         string const mangledName =
 854                                 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
 855                         backupName = FileName(addName(lyxrc.backupdir_path,
 856                                                       mangledName));
 857                 }
 858                 if (fileName().copyTo(backupName, true)) {
 859                         madeBackup = true;
 860                 } else {
 861                         Alert::error(_("Backup failure"),
 862                                      bformat(_("Cannot create backup file %1$s.\n"
 863                                                "Please check whether the directory exists and is writeable."),
 864                                              from_utf8(backupName.absFilename())));
 865                         //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
 866                 }
 867         }
 868
 869         // ask if the disk file has been externally modified (use checksum method)
 870         if (fileName().exists() && isExternallyModified(checksum_method)) {
 871                 docstring const file = makeDisplayPath(absFileName(), 20);
 872                 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
 873                                                              "you want to overwrite this file?"), file);
 874                 int const ret = Alert::prompt(_("Overwrite modified file?"),
 875                         text, 1, 1, _("&Overwrite"), _("&Cancel"));
 876                 if (ret == 1)
 877                         return false;
 878         }
 879
 880         if (writeFile(d->filename)) {
 881                 markClean();
 882                 return true;
 883         } else {
 884                 // Saving failed, so backup is not backup
 885                 if (madeBackup)
 886                         rename(backupName, d->filename);
 887                 return false;
 888         }
 889 }
 890
 891
 892 bool Buffer::writeFile(FileName const & fname) const
 893 {
 894         if (d->read_only && fname == d->filename)
 895                 return false;
 896
 897         bool retval = false;
 898
 899         FileName content;
 900         if (params().embedded)
 901                 // first write the .lyx file to the temporary directory
 902                 content = FileName(addName(temppath(), "content.lyx"));
 903         else
 904                 content = fname;
 905
 906         docstring const str = bformat(_("Saving document %1$s..."),
 907                 makeDisplayPath(content.absFilename()));
 908         message(str);
 909
 910         if (params().compressed) {
 911                 gz::ogzstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 912                 retval = ofs && write(ofs);
 913         } else {
 914                 ofstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 915                 retval = ofs && write(ofs);
 916         }
 917
 918         if (!retval) {
 919                 message(str + _(" could not write file!."));
 920                 return false;
 921         }
 922
 923         removeAutosaveFile(d->filename.absFilename());
 924         saveCheckSum(d->filename);
 925         message(str + _(" done."));
 926
 927         if (!params().embedded)
 928                 return true;
 929
 930         message(str + _(" writing embedded files!."));
 931         // if embedding is enabled, write file.lyx and all the embedded files
 932         // to the zip file fname.
 933         if (!d->embedded_files.writeFile(fname)) {
 934                 message(str + _(" could not write embedded files!."));
 935                 return false;
 936         }
 937         message(str + _(" error while writing embedded files."));
 938         return true;
 939 }
 940
 941
 942 bool Buffer::write(ostream & ofs) const
 943 {
 944 #ifdef HAVE_LOCALE
 945         // Use the standard "C" locale for file output.
 946         ofs.imbue(std::locale::classic());
 947 #endif
 948
 949         // The top of the file should not be written by params().
 950
 951         // write out a comment in the top of the file
 952         ofs << "#LyX " << lyx_version
 953             << " created this file. For more info see http://www.lyx.org/\n"
 954             << "\\lyxformat " << LYX_FORMAT << "\n"
 955             << "\\begin_document\n";
 956
 957
 958         /// For each author, set 'used' to true if there is a change
 959         /// by this author in the document; otherwise set it to 'false'.
 960         AuthorList::Authors::const_iterator a_it = params().authors().begin();
 961         AuthorList::Authors::const_iterator a_end = params().authors().end();
 962         for (; a_it != a_end; ++a_it)
 963                 a_it->second.setUsed(false);
 964
 965         ParIterator const end = par_iterator_end();
 966         ParIterator it = par_iterator_begin();
 967         for ( ; it != end; ++it)
 968                 it->checkAuthors(params().authors());
 969
 970         // now write out the buffer parameters.
 971         ofs << "\\begin_header\n";
 972         params().writeFile(ofs);
 973         ofs << "\\end_header\n";
 974
 975         // write the text
 976         ofs << "\n\\begin_body\n";
 977         text().write(*this, ofs);
 978         ofs << "\n\\end_body\n";
 979
 980         // Write marker that shows file is complete
 981         ofs << "\\end_document" << endl;
 982
 983         // Shouldn't really be needed....
 984         //ofs.close();
 985
 986         // how to check if close went ok?
 987         // Following is an attempt... (BE 20001011)
 988
 989         // good() returns false if any error occured, including some
 990         //        formatting error.
 991         // bad()  returns true if something bad happened in the buffer,
 992         //        which should include file system full errors.
 993
 994         bool status = true;
 995         if (!ofs) {
 996                 status = false;
 997                 lyxerr << "File was not closed properly." << endl;
 998         }
 999
1000         return status;
1001 }
1002
1003
1004 bool Buffer::makeLaTeXFile(FileName const & fname,
1005                            string const & original_path,
1006                            OutputParams const & runparams,
1007                            bool output_preamble, bool output_body) const
1008 {
1009         string const encoding = runparams.encoding->iconvName();
1010         LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1011
1012         odocfstream ofs;
1013         try { ofs.reset(encoding); }
1014         catch (iconv_codecvt_facet_exception & e) {
1015                 lyxerr << "Caught iconv exception: " << e.what() << endl;
1016                 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1017                         "verify that the support software for your encoding (%1$s) is "
1018                         "properly installed"), from_ascii(encoding)));
1019                 return false;
1020         }
1021         if (!openFileWrite(ofs, fname))
1022                 return false;
1023
1024         //TexStream ts(ofs.rdbuf(), &texrow());
1025
1026         bool failed_export = false;
1027         try {
1028                 d->texrow.reset();
1029                 writeLaTeXSource(ofs, original_path,
1030                       runparams, output_preamble, output_body);
1031         }
1032         catch (iconv_codecvt_facet_exception & e) {
1033                 lyxerr << "Caught iconv exception: " << e.what() << endl;
1034                 failed_export = true;
1035         }
1036         catch (std::exception const & e) {
1037                 lyxerr << "Caught \"normal\" exception: " << e.what() << endl;
1038                 failed_export = true;
1039         }
1040         catch (...) {
1041                 lyxerr << "Caught some really weird exception..." << endl;
1042                 LyX::cref().emergencyCleanup();
1043                 abort();
1044         }
1045
1046         ofs.close();
1047         if (ofs.fail()) {
1048                 failed_export = true;
1049                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1050         }
1051
1052         if (failed_export) {
1053                 Alert::error(_("Encoding error"),
1054                         _("Some characters of your document are probably not "
1055                         "representable in the chosen encoding.\n"
1056                         "Changing the document encoding to utf8 could help."));
1057                 return false;
1058         }
1059         return true;
1060 }
1061
1062
1063 void Buffer::writeLaTeXSource(odocstream & os,
1064                            string const & original_path,
1065                            OutputParams const & runparams_in,
1066                            bool const output_preamble, bool const output_body) const
1067 {
1068         OutputParams runparams = runparams_in;
1069
1070         // validate the buffer.
1071         LYXERR(Debug::LATEX, "  Validating buffer...");
1072         LaTeXFeatures features(*this, params(), runparams);
1073         validate(features);
1074         LYXERR(Debug::LATEX, "  Buffer validation done.");
1075
1076         // The starting paragraph of the coming rows is the
1077         // first paragraph of the document. (Asger)
1078         if (output_preamble && runparams.nice) {
1079                 os << "%% LyX " << lyx_version << " created this file.  "
1080                         "For more info, see http://www.lyx.org/.\n"
1081                         "%% Do not edit unless you really know what "
1082                         "you are doing.\n";
1083                 d->texrow.newline();
1084                 d->texrow.newline();
1085         }
1086         LYXERR(Debug::INFO, "lyx document header finished");
1087         // There are a few differences between nice LaTeX and usual files:
1088         // usual is \batchmode and has a
1089         // special input@path to allow the including of figures
1090         // with either \input or \includegraphics (what figinsets do).
1091         // input@path is set when the actual parameter
1092         // original_path is set. This is done for usual tex-file, but not
1093         // for nice-latex-file. (Matthias 250696)
1094         // Note that input@path is only needed for something the user does
1095         // in the preamble, included .tex files or ERT, files included by
1096         // LyX work without it.
1097         if (output_preamble) {
1098                 if (!runparams.nice) {
1099                         // code for usual, NOT nice-latex-file
1100                         os << "\\batchmode\n"; // changed
1101                         // from \nonstopmode
1102                         d->texrow.newline();
1103                 }
1104                 if (!original_path.empty()) {
1105                         // FIXME UNICODE
1106                         // We don't know the encoding of inputpath
1107                         docstring const inputpath = from_utf8(latex_path(original_path));
1108                         os << "\\makeatletter\n"
1109                            << "\\def\\input@path{{"
1110                            << inputpath << "/}}\n"
1111                            << "\\makeatother\n";
1112                         d->texrow.newline();
1113                         d->texrow.newline();
1114                         d->texrow.newline();
1115                 }
1116
1117                 // Write the preamble
1118                 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1119
1120                 if (!output_body)
1121                         return;
1122
1123                 // make the body.
1124                 os << "\\begin{document}\n";
1125                 d->texrow.newline();
1126         } // output_preamble
1127
1128         d->texrow.start(paragraphs().begin()->id(), 0);
1129
1130         LYXERR(Debug::INFO, "preamble finished, now the body.");
1131
1132         // if we are doing a real file with body, even if this is the
1133         // child of some other buffer, let's cut the link here.
1134         // This happens for example if only a child document is printed.
1135         Buffer const * save_parent = 0;
1136         if (output_preamble) {
1137                 save_parent = d->parent_buffer;
1138                 d->parent_buffer = 0;
1139         }
1140
1141         loadChildDocuments();
1142
1143         // the real stuff
1144         latexParagraphs(*this, paragraphs(), os, d->texrow, runparams);
1145
1146         // Restore the parenthood if needed
1147         if (output_preamble)
1148                 d->parent_buffer = save_parent;
1149
1150         // add this just in case after all the paragraphs
1151         os << endl;
1152         d->texrow.newline();
1153
1154         if (output_preamble) {
1155                 os << "\\end{document}\n";
1156                 d->texrow.newline();
1157                 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1158         } else {
1159                 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1160         }
1161         runparams_in.encoding = runparams.encoding;
1162
1163         // Just to be sure. (Asger)
1164         d->texrow.newline();
1165
1166         LYXERR(Debug::INFO, "Finished making LaTeX file.");
1167         LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1168 }
1169
1170
1171 bool Buffer::isLatex() const
1172 {
1173         return params().getTextClass().outputType() == LATEX;
1174 }
1175
1176
1177 bool Buffer::isLiterate() const
1178 {
1179         return params().getTextClass().outputType() == LITERATE;
1180 }
1181
1182
1183 bool Buffer::isDocBook() const
1184 {
1185         return params().getTextClass().outputType() == DOCBOOK;
1186 }
1187
1188
1189 void Buffer::makeDocBookFile(FileName const & fname,
1190                               OutputParams const & runparams,
1191                               bool const body_only) const
1192 {
1193         LYXERR(Debug::LATEX, "makeDocBookFile...");
1194
1195         //ofstream ofs;
1196         odocfstream ofs;
1197         if (!openFileWrite(ofs, fname))
1198                 return;
1199
1200         writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1201
1202         ofs.close();
1203         if (ofs.fail())
1204                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1205 }
1206
1207
1208 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1209                              OutputParams const & runparams,
1210                              bool const only_body) const
1211 {
1212         LaTeXFeatures features(*this, params(), runparams);
1213         validate(features);
1214
1215         d->texrow.reset();
1216
1217         TextClass const & tclass = params().getTextClass();
1218         string const top_element = tclass.latexname();
1219
1220         if (!only_body) {
1221                 if (runparams.flavor == OutputParams::XML)
1222                         os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1223
1224                 // FIXME UNICODE
1225                 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1226
1227                 // FIXME UNICODE
1228                 if (! tclass.class_header().empty())
1229                         os << from_ascii(tclass.class_header());
1230                 else if (runparams.flavor == OutputParams::XML)
1231                         os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1232                             << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1233                 else
1234                         os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1235
1236                 docstring preamble = from_utf8(params().preamble);
1237                 if (runparams.flavor != OutputParams::XML ) {
1238                         preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1239                         preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1240                         preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1241                         preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1242                 }
1243
1244                 string const name = runparams.nice
1245                         ? changeExtension(absFileName(), ".sgml") : fname;
1246                 preamble += features.getIncludedFiles(name);
1247                 preamble += features.getLyXSGMLEntities();
1248
1249                 if (!preamble.empty()) {
1250                         os << "\n [ " << preamble << " ]";
1251                 }
1252                 os << ">\n\n";
1253         }
1254
1255         string top = top_element;
1256         top += " lang=\"";
1257         if (runparams.flavor == OutputParams::XML)
1258                 top += params().language->code();
1259         else
1260                 top += params().language->code().substr(0,2);
1261         top += '"';
1262
1263         if (!params().options.empty()) {
1264                 top += ' ';
1265                 top += params().options;
1266         }
1267
1268         os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1269             << " file was created by LyX " << lyx_version
1270             << "\n  See http://www.lyx.org/ for more information -->\n";
1271
1272         params().getTextClass().counters().reset();
1273
1274         loadChildDocuments();
1275
1276         sgml::openTag(os, top);
1277         os << '\n';
1278         docbookParagraphs(paragraphs(), *this, os, runparams);
1279         sgml::closeTag(os, top_element);
1280 }
1281
1282
1283 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1284 // Other flags: -wall -v0 -x
1285 int Buffer::runChktex()
1286 {
1287         setBusy(true);
1288
1289         // get LaTeX-Filename
1290         FileName const path(temppath());
1291         string const name = addName(path.absFilename(), latexName());
1292         string const org_path = filePath();
1293
1294         support::PathChanger p(path); // path to LaTeX file
1295         message(_("Running chktex..."));
1296
1297         // Generate the LaTeX file if neccessary
1298         OutputParams runparams(&params().encoding());
1299         runparams.flavor = OutputParams::LATEX;
1300         runparams.nice = false;
1301         makeLaTeXFile(FileName(name), org_path, runparams);
1302
1303         TeXErrors terr;
1304         Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1305         int const res = chktex.run(terr); // run chktex
1306
1307         if (res == -1) {
1308                 Alert::error(_("chktex failure"),
1309                              _("Could not run chktex successfully."));
1310         } else if (res > 0) {
1311                 ErrorList & errlist = d->errorLists["ChkTeX"];
1312                 errlist.clear();
1313                 bufferErrors(terr, errlist);
1314         }
1315
1316         setBusy(false);
1317
1318         errors("ChkTeX");
1319
1320         return res;
1321 }
1322
1323
1324 void Buffer::validate(LaTeXFeatures & features) const
1325 {
1326         TextClass const & tclass = params().getTextClass();
1327
1328         if (params().outputChanges) {
1329                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1330                 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1331                                   LaTeXFeatures::isAvailable("xcolor");
1332
1333                 if (features.runparams().flavor == OutputParams::LATEX) {
1334                         if (dvipost) {
1335                                 features.require("ct-dvipost");
1336                                 features.require("dvipost");
1337                         } else if (xcolorsoul) {
1338                                 features.require("ct-xcolor-soul");
1339                                 features.require("soul");
1340                                 features.require("xcolor");
1341                         } else {
1342                                 features.require("ct-none");
1343                         }
1344                 } else if (features.runparams().flavor == OutputParams::PDFLATEX ) {
1345                         if (xcolorsoul) {
1346                                 features.require("ct-xcolor-soul");
1347                                 features.require("soul");
1348                                 features.require("xcolor");
1349                                 features.require("pdfcolmk"); // improves color handling in PDF output
1350                         } else {
1351                                 features.require("ct-none");
1352                         }
1353                 }
1354         }
1355
1356         // AMS Style is at document level
1357         if (params().use_amsmath == BufferParams::package_on
1358             || tclass.provides("amsmath"))
1359                 features.require("amsmath");
1360         if (params().use_esint == BufferParams::package_on)
1361                 features.require("esint");
1362
1363         loadChildDocuments();
1364
1365         for_each(paragraphs().begin(), paragraphs().end(),
1366                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1367
1368         // the bullet shapes are buffer level not paragraph level
1369         // so they are tested here
1370         for (int i = 0; i < 4; ++i) {
1371                 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1372                         int const font = params().user_defined_bullet(i).getFont();
1373                         if (font == 0) {
1374                                 int const c = params()
1375                                         .user_defined_bullet(i)
1376                                         .getCharacter();
1377                                 if (c == 16
1378                                    || c == 17
1379                                    || c == 25
1380                                    || c == 26
1381                                    || c == 31) {
1382                                         features.require("latexsym");
1383                                 }
1384                         } else if (font == 1) {
1385                                 features.require("amssymb");
1386                         } else if ((font >= 2 && font <= 5)) {
1387                                 features.require("pifont");
1388                         }
1389                 }
1390         }
1391
1392         if (lyxerr.debugging(Debug::LATEX)) {
1393                 features.showStruct();
1394         }
1395 }
1396
1397
1398 void Buffer::getLabelList(vector<docstring> & list) const
1399 {
1400         /// if this is a child document and the parent is already loaded
1401         /// Use the parent's list instead  [ale990407]
1402         Buffer const * tmp = masterBuffer();
1403         if (!tmp) {
1404                 lyxerr << "masterBuffer() failed!" << endl;
1405                 BOOST_ASSERT(tmp);
1406         }
1407         if (tmp != this) {
1408                 tmp->getLabelList(list);
1409                 return;
1410         }
1411
1412         loadChildDocuments();
1413
1414         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1415                 it.nextInset()->getLabelList(*this, list);
1416 }
1417
1418
1419 void Buffer::updateBibfilesCache() const
1420 {
1421         // if this is a child document and the parent is already loaded
1422         // update the parent's cache instead
1423         Buffer const * tmp = masterBuffer();
1424         BOOST_ASSERT(tmp);
1425         if (tmp != this) {
1426                 tmp->updateBibfilesCache();
1427                 return;
1428         }
1429
1430         d->bibfilesCache_.clear();
1431         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1432                 if (it->lyxCode() == BIBTEX_CODE) {
1433                         InsetBibtex const & inset =
1434                                 static_cast<InsetBibtex const &>(*it);
1435                         FileNameList const bibfiles = inset.getFiles(*this);
1436                         d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1437                                 bibfiles.begin(),
1438                                 bibfiles.end());
1439                 } else if (it->lyxCode() == INCLUDE_CODE) {
1440                         InsetInclude & inset =
1441                                 static_cast<InsetInclude &>(*it);
1442                         inset.updateBibfilesCache(*this);
1443                         FileNameList const & bibfiles =
1444                                         inset.getBibfilesCache(*this);
1445                         d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1446                                 bibfiles.begin(),
1447                                 bibfiles.end());
1448                 }
1449         }
1450 }
1451
1452
1453 FileNameList const & Buffer::getBibfilesCache() const
1454 {
1455         // if this is a child document and the parent is already loaded
1456         // use the parent's cache instead
1457         Buffer const * tmp = masterBuffer();
1458         BOOST_ASSERT(tmp);
1459         if (tmp != this)
1460                 return tmp->getBibfilesCache();
1461
1462         // We update the cache when first used instead of at loading time.
1463         if (d->bibfilesCache_.empty())
1464                 const_cast<Buffer *>(this)->updateBibfilesCache();
1465
1466         return d->bibfilesCache_;
1467 }
1468
1469
1470 bool Buffer::isDepClean(string const & name) const
1471 {
1472         DepClean::const_iterator const it = d->dep_clean.find(name);
1473         if (it == d->dep_clean.end())
1474                 return true;
1475         return it->second;
1476 }
1477
1478
1479 void Buffer::markDepClean(string const & name)
1480 {
1481         d->dep_clean[name] = true;
1482 }
1483
1484
1485 bool Buffer::dispatch(string const & command, bool * result)
1486 {
1487         return dispatch(lyxaction.lookupFunc(command), result);
1488 }
1489
1490
1491 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1492 {
1493         bool dispatched = true;
1494
1495         switch (func.action) {
1496                 case LFUN_BUFFER_EXPORT: {
1497                         bool const tmp = doExport(to_utf8(func.argument()), false);
1498                         if (result)
1499                                 *result = tmp;
1500                         break;
1501                 }
1502
1503                 default:
1504                         dispatched = false;
1505         }
1506         return dispatched;
1507 }
1508
1509
1510 void Buffer::changeLanguage(Language const * from, Language const * to)
1511 {
1512         BOOST_ASSERT(from);
1513         BOOST_ASSERT(to);
1514
1515         for_each(par_iterator_begin(),
1516                  par_iterator_end(),
1517                  bind(&Paragraph::changeLanguage, _1, params(), from, to));
1518 }
1519
1520
1521 bool Buffer::isMultiLingual() const
1522 {
1523         ParConstIterator end = par_iterator_end();
1524         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1525                 if (it->isMultiLingual(params()))
1526                         return true;
1527
1528         return false;
1529 }
1530
1531
1532 ParIterator Buffer::getParFromID(int const id) const
1533 {
1534         ParConstIterator it = par_iterator_begin();
1535         ParConstIterator const end = par_iterator_end();
1536
1537         if (id < 0) {
1538                 // John says this is called with id == -1 from undo
1539                 lyxerr << "getParFromID(), id: " << id << endl;
1540                 return end;
1541         }
1542
1543         for (; it != end; ++it)
1544                 if (it->id() == id)
1545                         return it;
1546
1547         return end;
1548 }
1549
1550
1551 bool Buffer::hasParWithID(int const id) const
1552 {
1553         ParConstIterator const it = getParFromID(id);
1554         return it != par_iterator_end();
1555 }
1556
1557
1558 ParIterator Buffer::par_iterator_begin()
1559 {
1560         return lyx::par_iterator_begin(inset());
1561 }
1562
1563
1564 ParIterator Buffer::par_iterator_end()
1565 {
1566         return lyx::par_iterator_end(inset());
1567 }
1568
1569
1570 ParConstIterator Buffer::par_iterator_begin() const
1571 {
1572         return lyx::par_const_iterator_begin(inset());
1573 }
1574
1575
1576 ParConstIterator Buffer::par_iterator_end() const
1577 {
1578         return lyx::par_const_iterator_end(inset());
1579 }
1580
1581
1582 Language const * Buffer::language() const
1583 {
1584         return params().language;
1585 }
1586
1587
1588 docstring const Buffer::B_(string const & l10n) const
1589 {
1590         return params().B_(l10n);
1591 }
1592
1593
1594 bool Buffer::isClean() const
1595 {
1596         return d->lyx_clean;
1597 }
1598
1599
1600 bool Buffer::isBakClean() const
1601 {
1602         return d->bak_clean;
1603 }
1604
1605
1606 bool Buffer::isExternallyModified(CheckMethod method) const
1607 {
1608         BOOST_ASSERT(d->filename.exists());
1609         // if method == timestamp, check timestamp before checksum
1610         return (method == checksum_method
1611                 || d->timestamp_ != d->filename.lastModified())
1612                 && d->checksum_ != d->filename.checksum();
1613 }
1614
1615
1616 void Buffer::saveCheckSum(FileName const & file) const
1617 {
1618         if (file.exists()) {
1619                 d->timestamp_ = file.lastModified();
1620                 d->checksum_ = file.checksum();
1621         } else {
1622                 // in the case of save to a new file.
1623                 d->timestamp_ = 0;
1624                 d->checksum_ = 0;
1625         }
1626 }
1627
1628
1629 void Buffer::markClean() const
1630 {
1631         if (!d->lyx_clean) {
1632                 d->lyx_clean = true;
1633                 updateTitles();
1634         }
1635         // if the .lyx file has been saved, we don't need an
1636         // autosave
1637         d->bak_clean = true;
1638 }
1639
1640
1641 void Buffer::markBakClean() const
1642 {
1643         d->bak_clean = true;
1644 }
1645
1646
1647 void Buffer::setUnnamed(bool flag)
1648 {
1649         d->unnamed = flag;
1650 }
1651
1652
1653 bool Buffer::isUnnamed() const
1654 {
1655         return d->unnamed;
1656 }
1657
1658
1659 // FIXME: this function should be moved to buffer_pimpl.C
1660 void Buffer::markDirty()
1661 {
1662         if (d->lyx_clean) {
1663                 d->lyx_clean = false;
1664                 updateTitles();
1665         }
1666         d->bak_clean = false;
1667
1668         DepClean::iterator it = d->dep_clean.begin();
1669         DepClean::const_iterator const end = d->dep_clean.end();
1670
1671         for (; it != end; ++it)
1672                 it->second = false;
1673 }
1674
1675
1676 FileName Buffer::fileName() const
1677 {
1678         return d->filename;
1679 }
1680
1681
1682 string Buffer::absFileName() const
1683 {
1684         return d->filename.absFilename();
1685 }
1686
1687
1688 string Buffer::filePath() const
1689 {
1690         return d->filename.onlyPath().absFilename();
1691 }
1692
1693
1694 bool Buffer::isReadonly() const
1695 {
1696         return d->read_only;
1697 }
1698
1699
1700 void Buffer::setParent(Buffer const * buffer)
1701 {
1702         // Avoids recursive include.
1703         d->parent_buffer = buffer == this ? 0 : buffer;
1704 }
1705
1706
1707 Buffer const * Buffer::parent()
1708 {
1709         return d->parent_buffer;
1710 }
1711
1712
1713 Buffer const * Buffer::masterBuffer() const
1714 {
1715         if (!d->parent_buffer)
1716                 return this;
1717
1718         return d->parent_buffer->masterBuffer();
1719 }
1720
1721
1722 bool Buffer::hasMacro(docstring const & name, Paragraph const & par) const
1723 {
1724         Impl::PositionToMacroMap::iterator it;
1725         it = d->macros[name].upper_bound(par.macrocontextPosition());
1726         if (it != d->macros[name].end())
1727                 return true;
1728
1729         // If there is a master buffer, query that
1730         Buffer const * master = masterBuffer();
1731         if (master && master != this)
1732                 return master->hasMacro(name);
1733
1734         return MacroTable::globalMacros().has(name);
1735 }
1736
1737
1738 bool Buffer::hasMacro(docstring const & name) const
1739 {
1740         if( !d->macros[name].empty() )
1741                 return true;
1742
1743         // If there is a master buffer, query that
1744         Buffer const * master = masterBuffer();
1745         if (master && master != this)
1746                 return master->hasMacro(name);
1747
1748         return MacroTable::globalMacros().has(name);
1749 }
1750
1751
1752 MacroData const & Buffer::getMacro(docstring const & name,
1753         Paragraph const & par) const
1754 {
1755         Impl::PositionToMacroMap::iterator it;
1756         it = d->macros[name].upper_bound(par.macrocontextPosition());
1757         if( it != d->macros[name].end() )
1758                 return it->second;
1759
1760         // If there is a master buffer, query that
1761         Buffer const * master = masterBuffer();
1762         if (master && master != this)
1763                 return master->getMacro(name);
1764
1765         return MacroTable::globalMacros().get(name);
1766 }
1767
1768
1769 MacroData const & Buffer::getMacro(docstring const & name) const
1770 {
1771         Impl::PositionToMacroMap::iterator it;
1772         it = d->macros[name].begin();
1773         if( it != d->macros[name].end() )
1774                 return it->second;
1775
1776         // If there is a master buffer, query that
1777         Buffer const * master = masterBuffer();
1778         if (master && master != this)
1779                 return master->getMacro(name);
1780
1781         return MacroTable::globalMacros().get(name);
1782 }
1783
1784
1785 void Buffer::updateMacros()
1786 {
1787         // start with empty table
1788         d->macros = Impl::NameToPositionMacroMap();
1789
1790         // Iterate over buffer
1791         ParagraphList & pars = text().paragraphs();
1792         for (size_t i = 0, n = pars.size(); i != n; ++i) {
1793                 // set position again
1794                 pars[i].setMacrocontextPosition(i);
1795
1796                 //lyxerr << "searching main par " << i
1797                 //      << " for macro definitions" << std::endl;
1798                 InsetList const & insets = pars[i].insetList();
1799                 InsetList::const_iterator it = insets.begin();
1800                 InsetList::const_iterator end = insets.end();
1801                 for ( ; it != end; ++it) {
1802                         if (it->inset->lyxCode() != MATHMACRO_CODE)
1803                                 continue;
1804
1805                         // get macro data
1806                         MathMacroTemplate const & macroTemplate
1807                         = static_cast<MathMacroTemplate const &>(*it->inset);
1808
1809                         // valid?
1810                         if (macroTemplate.validMacro()) {
1811                                 MacroData macro = macroTemplate.asMacroData();
1812
1813                                 // redefinition?
1814                                 // call hasMacro here instead of directly querying mc to
1815                                 // also take the master document into consideration
1816                                 macro.setRedefinition(hasMacro(macroTemplate.name()));
1817
1818                                 // register macro (possibly overwrite the previous one of this paragraph)
1819                                 d->macros[macroTemplate.name()][i] = macro;
1820                         }
1821                 }
1822         }
1823 }
1824
1825
1826 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1827         InsetCode code)
1828 {
1829         //FIXME: This does not work for child documents yet.
1830         BOOST_ASSERT(code == CITE_CODE || code == REF_CODE);
1831         // Check if the label 'from' appears more than once
1832         vector<docstring> labels;
1833
1834         string paramName;
1835         if (code == CITE_CODE) {
1836                 BiblioInfo keys;
1837                 keys.fillWithBibKeys(this);
1838                 BiblioInfo::const_iterator bit  = keys.begin();
1839                 BiblioInfo::const_iterator bend = keys.end();
1840
1841                 for (; bit != bend; ++bit)
1842                         // FIXME UNICODE
1843                         labels.push_back(bit->first);
1844                 paramName = "key";
1845         } else {
1846                 getLabelList(labels);
1847                 paramName = "reference";
1848         }
1849
1850         if (std::count(labels.begin(), labels.end(), from) > 1)
1851                 return;
1852
1853         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1854                 if (it->lyxCode() == code) {
1855                         InsetCommand & inset = static_cast<InsetCommand &>(*it);
1856                         docstring const oldValue = inset.getParam(paramName);
1857                         if (oldValue == from)
1858                                 inset.setParam(paramName, to);
1859                 }
1860         }
1861 }
1862
1863
1864 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1865         pit_type par_end, bool full_source)
1866 {
1867         OutputParams runparams(&params().encoding());
1868         runparams.nice = true;
1869         runparams.flavor = OutputParams::LATEX;
1870         runparams.linelen = lyxrc.plaintext_linelen;
1871         // No side effect of file copying and image conversion
1872         runparams.dryrun = true;
1873
1874         d->texrow.reset();
1875         if (full_source) {
1876                 os << "% " << _("Preview source code") << "\n\n";
1877                 d->texrow.newline();
1878                 d->texrow.newline();
1879                 if (isLatex())
1880                         writeLaTeXSource(os, filePath(), runparams, true, true);
1881                 else {
1882                         writeDocBookSource(os, absFileName(), runparams, false);
1883                 }
1884         } else {
1885                 runparams.par_begin = par_begin;
1886                 runparams.par_end = par_end;
1887                 if (par_begin + 1 == par_end)
1888                         os << "% "
1889                            << bformat(_("Preview source code for paragraph %1$d"), par_begin)
1890                            << "\n\n";
1891                 else
1892                         os << "% "
1893                            << bformat(_("Preview source code from paragraph %1$s to %2$s"),
1894                                         convert<docstring>(par_begin),
1895                                         convert<docstring>(par_end - 1))
1896                            << "\n\n";
1897                 d->texrow.newline();
1898                 d->texrow.newline();
1899                 // output paragraphs
1900                 if (isLatex()) {
1901                         latexParagraphs(*this, paragraphs(), os, d->texrow, runparams);
1902                 } else {
1903                         // DocBook
1904                         docbookParagraphs(paragraphs(), *this, os, runparams);
1905                 }
1906         }
1907 }
1908
1909
1910 ErrorList & Buffer::errorList(string const & type) const
1911 {
1912         static ErrorList emptyErrorList;
1913         std::map<string, ErrorList>::iterator I = d->errorLists.find(type);
1914         if (I == d->errorLists.end())
1915                 return emptyErrorList;
1916
1917         return I->second;
1918 }
1919
1920
1921 void Buffer::structureChanged() const
1922 {
1923         if (gui_)
1924                 gui_->structureChanged();
1925 }
1926
1927
1928 void Buffer::errors(std::string const & err) const
1929 {
1930         if (gui_)
1931                 gui_->errors(err);
1932 }
1933
1934
1935 void Buffer::message(docstring const & msg) const
1936 {
1937         if (gui_)
1938                 gui_->message(msg);
1939 }
1940
1941
1942 void Buffer::setBusy(bool on) const
1943 {
1944         if (gui_)
1945                 gui_->setBusy(on);
1946 }
1947
1948
1949 void Buffer::setReadOnly(bool on) const
1950 {
1951         if (d->wa_)
1952                 d->wa_->setReadOnly(on);
1953 }
1954
1955
1956 void Buffer::updateTitles() const
1957 {
1958         if (d->wa_)
1959                 d->wa_->updateTitles();
1960 }
1961
1962
1963 void Buffer::resetAutosaveTimers() const
1964 {
1965         if (gui_)
1966                 gui_->resetAutosaveTimers();
1967 }
1968
1969
1970 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
1971 {
1972         gui_ = gui;
1973 }
1974
1975
1976
1977 namespace {
1978
1979 class AutoSaveBuffer : public support::ForkedProcess {
1980 public:
1981         ///
1982         AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
1983                 : buffer_(buffer), fname_(fname) {}
1984         ///
1985         virtual boost::shared_ptr<ForkedProcess> clone() const
1986         {
1987                 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
1988         }
1989         ///
1990         int start()
1991         {
1992                 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
1993                                                  from_utf8(fname_.absFilename())));
1994                 return run(DontWait);
1995         }
1996 private:
1997         ///
1998         virtual int generateChild();
1999         ///
2000         Buffer const & buffer_;
2001         FileName fname_;
2002 };
2003
2004
2005 #if !defined (HAVE_FORK)
2006 # define fork() -1
2007 #endif
2008
2009 int AutoSaveBuffer::generateChild()
2010 {
2011         // tmp_ret will be located (usually) in /tmp
2012         // will that be a problem?
2013         pid_t const pid = fork();
2014         // If you want to debug the autosave
2015         // you should set pid to -1, and comment out the fork.
2016         if (pid == 0 || pid == -1) {
2017                 // pid = -1 signifies that lyx was unable
2018                 // to fork. But we will do the save
2019                 // anyway.
2020                 bool failed = false;
2021
2022                 FileName const tmp_ret(tempName(FileName(), "lyxauto"));
2023                 if (!tmp_ret.empty()) {
2024                         buffer_.writeFile(tmp_ret);
2025                         // assume successful write of tmp_ret
2026                         if (!rename(tmp_ret, fname_)) {
2027                                 failed = true;
2028                                 // most likely couldn't move between
2029                                 // filesystems unless write of tmp_ret
2030                                 // failed so remove tmp file (if it
2031                                 // exists)
2032                                 tmp_ret.removeFile();
2033                         }
2034                 } else {
2035                         failed = true;
2036                 }
2037
2038                 if (failed) {
2039                         // failed to write/rename tmp_ret so try writing direct
2040                         if (!buffer_.writeFile(fname_)) {
2041                                 // It is dangerous to do this in the child,
2042                                 // but safe in the parent, so...
2043                                 if (pid == -1) // emit message signal.
2044                                         buffer_.message(_("Autosave failed!"));
2045                         }
2046                 }
2047                 if (pid == 0) { // we are the child so...
2048                         _exit(0);
2049                 }
2050         }
2051         return pid;
2052 }
2053
2054 } // namespace anon
2055
2056
2057 // Perfect target for a thread...
2058 void Buffer::autoSave() const
2059 {
2060         if (isBakClean() || isReadonly()) {
2061                 // We don't save now, but we'll try again later
2062                 resetAutosaveTimers();
2063                 return;
2064         }
2065
2066         // emit message signal.
2067         message(_("Autosaving current document..."));
2068
2069         // create autosave filename
2070         string fname = filePath();
2071         fname += '#';
2072         fname += d->filename.onlyFileName();
2073         fname += '#';
2074
2075         AutoSaveBuffer autosave(*this, FileName(fname));
2076         autosave.start();
2077
2078         markBakClean();
2079         resetAutosaveTimers();
2080 }
2081
2082
2083 void Buffer::resetChildDocuments(bool close_them) const
2084 {
2085         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2086                 if (it->lyxCode() != INCLUDE_CODE)
2087                         continue;
2088                 InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
2089                 InsetCommandParams const & ip = inset.params();
2090
2091                 resetParentBuffer(this, ip, close_them);
2092         }
2093
2094         if (use_gui && masterBuffer() == this)
2095                 updateLabels(*this);
2096 }
2097
2098
2099 void Buffer::loadChildDocuments() const
2100 {
2101         bool parse_error = false;
2102
2103         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2104                 if (it->lyxCode() != INCLUDE_CODE)
2105                         continue;
2106                 InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
2107                 InsetCommandParams const & ip = inset.params();
2108                 Buffer * child = loadIfNeeded(*this, ip);
2109                 if (!child)
2110                         continue;
2111                 parse_error |= !child->errorList("Parse").empty();
2112                 child->loadChildDocuments();
2113         }
2114
2115         if (use_gui && masterBuffer() == this)
2116                 updateLabels(*this);
2117 }
2118
2119
2120 string Buffer::bufferFormat() const
2121 {
2122         if (isDocBook())
2123                 return "docbook";
2124         if (isLiterate())
2125                 return "literate";
2126         return "latex";
2127 }
2128
2129
2130 bool Buffer::doExport(string const & format, bool put_in_tempdir,
2131         string & result_file) const
2132 {
2133         string backend_format;
2134         OutputParams runparams(&params().encoding());
2135         runparams.flavor = OutputParams::LATEX;
2136         runparams.linelen = lyxrc.plaintext_linelen;
2137         vector<string> backs = backends();
2138         if (find(backs.begin(), backs.end(), format) == backs.end()) {
2139                 // Get shortest path to format
2140                 Graph::EdgePath path;
2141                 for (vector<string>::const_iterator it = backs.begin();
2142                      it != backs.end(); ++it) {
2143                         Graph::EdgePath p = theConverters().getPath(*it, format);
2144                         if (!p.empty() && (path.empty() || p.size() < path.size())) {
2145                                 backend_format = *it;
2146                                 path = p;
2147                         }
2148                 }
2149                 if (!path.empty())
2150                         runparams.flavor = theConverters().getFlavor(path);
2151                 else {
2152                         Alert::error(_("Couldn't export file"),
2153                                 bformat(_("No information for exporting the format %1$s."),
2154                                    formats.prettyName(format)));
2155                         return false;
2156                 }
2157         } else {
2158                 backend_format = format;
2159                 // FIXME: Don't hardcode format names here, but use a flag
2160                 if (backend_format == "pdflatex")
2161                         runparams.flavor = OutputParams::PDFLATEX;
2162         }
2163
2164         string filename = latexName(false);
2165         filename = addName(temppath(), filename);
2166         filename = changeExtension(filename,
2167                                    formats.extension(backend_format));
2168
2169         // Plain text backend
2170         if (backend_format == "text")
2171                 writePlaintextFile(*this, FileName(filename), runparams);
2172         // no backend
2173         else if (backend_format == "lyx")
2174                 writeFile(FileName(filename));
2175         // Docbook backend
2176         else if (isDocBook()) {
2177                 runparams.nice = !put_in_tempdir;
2178                 makeDocBookFile(FileName(filename), runparams);
2179         }
2180         // LaTeX backend
2181         else if (backend_format == format) {
2182                 runparams.nice = true;
2183                 if (!makeLaTeXFile(FileName(filename), string(), runparams))
2184                         return false;
2185         } else if (!lyxrc.tex_allows_spaces
2186                    && support::contains(filePath(), ' ')) {
2187                 Alert::error(_("File name error"),
2188                            _("The directory path to the document cannot contain spaces."));
2189                 return false;
2190         } else {
2191                 runparams.nice = false;
2192                 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
2193                         return false;
2194         }
2195
2196         string const error_type = (format == "program")
2197                 ? "Build" : bufferFormat();
2198         string const ext = formats.extension(format);
2199         FileName const tmp_result_file(changeExtension(filename, ext));
2200         bool const success = theConverters().convert(this, FileName(filename),
2201                 tmp_result_file, FileName(absFileName()), backend_format, format,
2202                 errorList(error_type));
2203         // Emit the signal to show the error list.
2204         if (format != backend_format)
2205                 errors(error_type);
2206         if (!success)
2207                 return false;
2208
2209         if (put_in_tempdir)
2210                 result_file = tmp_result_file.absFilename();
2211         else {
2212                 result_file = changeExtension(absFileName(), ext);
2213                 // We need to copy referenced files (e. g. included graphics
2214                 // if format == "dvi") to the result dir.
2215                 vector<ExportedFile> const files =
2216                         runparams.exportdata->externalFiles(format);
2217                 string const dest = onlyPath(result_file);
2218                 CopyStatus status = SUCCESS;
2219                 for (vector<ExportedFile>::const_iterator it = files.begin();
2220                                 it != files.end() && status != CANCEL; ++it) {
2221                         string const fmt =
2222                                 formats.getFormatFromFile(it->sourceName);
2223                         status = copyFile(fmt, it->sourceName,
2224                                           makeAbsPath(it->exportName, dest),
2225                                           it->exportName, status == FORCE);
2226                 }
2227                 if (status == CANCEL) {
2228                         message(_("Document export cancelled."));
2229                 } else if (tmp_result_file.exists()) {
2230                         // Finally copy the main file
2231                         status = copyFile(format, tmp_result_file,
2232                                           FileName(result_file), result_file,
2233                                           status == FORCE);
2234                         message(bformat(_("Document exported as %1$s "
2235                                                                "to file `%2$s'"),
2236                                                 formats.prettyName(format),
2237                                                 makeDisplayPath(result_file)));
2238                 } else {
2239                         // This must be a dummy converter like fax (bug 1888)
2240                         message(bformat(_("Document exported as %1$s"),
2241                                                 formats.prettyName(format)));
2242                 }
2243         }
2244
2245         return true;
2246 }
2247
2248
2249 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
2250 {
2251         string result_file;
2252         return doExport(format, put_in_tempdir, result_file);
2253 }
2254
2255
2256 bool Buffer::preview(string const & format) const
2257 {
2258         string result_file;
2259         if (!doExport(format, true, result_file))
2260                 return false;
2261         return formats.view(*this, FileName(result_file), format);
2262 }
2263
2264
2265 bool Buffer::isExportable(string const & format) const
2266 {
2267         vector<string> backs = backends();
2268         for (vector<string>::const_iterator it = backs.begin();
2269              it != backs.end(); ++it)
2270                 if (theConverters().isReachable(*it, format))
2271                         return true;
2272         return false;
2273 }
2274
2275
2276 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
2277 {
2278         vector<string> backs = backends();
2279         vector<Format const *> result =
2280                 theConverters().getReachable(backs[0], only_viewable, true);
2281         for (vector<string>::const_iterator it = backs.begin() + 1;
2282              it != backs.end(); ++it) {
2283                 vector<Format const *>  r =
2284                         theConverters().getReachable(*it, only_viewable, false);
2285                 result.insert(result.end(), r.begin(), r.end());
2286         }
2287         return result;
2288 }
2289
2290
2291 vector<string> Buffer::backends() const
2292 {
2293         vector<string> v;
2294         if (params().getTextClass().isTeXClassAvailable()) {
2295                 v.push_back(bufferFormat());
2296                 // FIXME: Don't hardcode format names here, but use a flag
2297                 if (v.back() == "latex")
2298                         v.push_back("pdflatex");
2299         }
2300         v.push_back("text");
2301         v.push_back("lyx");
2302         return v;
2303 }
2304
2305
2306 bool Buffer::readFileHelper(FileName const & s)
2307 {
2308         // File information about normal file
2309         if (!s.exists()) {
2310                 docstring const file = makeDisplayPath(s.absFilename(), 50);
2311                 docstring text = bformat(_("The specified document\n%1$s"
2312                                                      "\ncould not be read."), file);
2313                 Alert::error(_("Could not read document"), text);
2314                 return false;
2315         }
2316
2317         // Check if emergency save file exists and is newer.
2318         FileName const e(s.absFilename() + ".emergency");
2319
2320         if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
2321                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2322                 docstring const text =
2323                         bformat(_("An emergency save of the document "
2324                                   "%1$s exists.\n\n"
2325                                                "Recover emergency save?"), file);
2326                 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
2327                                       _("&Recover"),  _("&Load Original"),
2328                                       _("&Cancel")))
2329                 {
2330                 case 0:
2331                         // the file is not saved if we load the emergency file.
2332                         markDirty();
2333                         return readFile(e);
2334                 case 1:
2335                         break;
2336                 default:
2337                         return false;
2338                 }
2339         }
2340
2341         // Now check if autosave file is newer.
2342         FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
2343
2344         if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
2345                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2346                 docstring const text =
2347                         bformat(_("The backup of the document "
2348                                   "%1$s is newer.\n\nLoad the "
2349                                                "backup instead?"), file);
2350                 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
2351                                       _("&Load backup"), _("Load &original"),
2352                                       _("&Cancel") ))
2353                 {
2354                 case 0:
2355                         // the file is not saved if we load the autosave file.
2356                         markDirty();
2357                         return readFile(a);
2358                 case 1:
2359                         // Here we delete the autosave
2360                         a.removeFile();
2361                         break;
2362                 default:
2363                         return false;
2364                 }
2365         }
2366         return readFile(s);
2367 }
2368
2369
2370 bool Buffer::loadLyXFile(FileName const & s)
2371 {
2372         if (s.isReadableFile()) {
2373                 if (readFileHelper(s)) {
2374                         lyxvc().file_found_hook(s);
2375                         if (!s.isWritable())
2376                                 setReadonly(true);
2377                         return true;
2378                 }
2379         } else {
2380                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2381                 // Here we probably should run
2382                 if (LyXVC::file_not_found_hook(s)) {
2383                         docstring const text =
2384                                 bformat(_("Do you want to retrieve the document"
2385                                                        " %1$s from version control?"), file);
2386                         int const ret = Alert::prompt(_("Retrieve from version control?"),
2387                                 text, 0, 1, _("&Retrieve"), _("&Cancel"));
2388
2389                         if (ret == 0) {
2390                                 // How can we know _how_ to do the checkout?
2391                                 // With the current VC support it has to be,
2392                                 // a RCS file since CVS do not have special ,v files.
2393                                 RCS::retrieve(s);
2394                                 return loadLyXFile(s);
2395                         }
2396                 }
2397         }
2398         return false;
2399 }
2400
2401
2402 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
2403 {
2404         TeXErrors::Errors::const_iterator cit = terr.begin();
2405         TeXErrors::Errors::const_iterator end = terr.end();
2406
2407         for (; cit != end; ++cit) {
2408                 int id_start = -1;
2409                 int pos_start = -1;
2410                 int errorRow = cit->error_in_line;
2411                 bool found = d->texrow.getIdFromRow(errorRow, id_start,
2412                                                        pos_start);
2413                 int id_end = -1;
2414                 int pos_end = -1;
2415                 do {
2416                         ++errorRow;
2417                         found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
2418                 } while (found && id_start == id_end && pos_start == pos_end);
2419
2420                 errorList.push_back(ErrorItem(cit->error_desc,
2421                         cit->error_text, id_start, pos_start, pos_end));
2422         }
2423 }
2424
2425 } // namespace lyx