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 << "\\nonstopmode\n";
1101                         d->texrow.newline();
1102                 }
1103                 if (!original_path.empty()) {
1104                         // FIXME UNICODE
1105                         // We don't know the encoding of inputpath
1106                         docstring const inputpath = from_utf8(latex_path(original_path));
1107                         os << "\\makeatletter\n"
1108                            << "\\def\\input@path{{"
1109                            << inputpath << "/}}\n"
1110                            << "\\makeatother\n";
1111                         d->texrow.newline();
1112                         d->texrow.newline();
1113                         d->texrow.newline();
1114                 }
1115
1116                 // Write the preamble
1117                 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1118
1119                 if (!output_body)
1120                         return;
1121
1122                 // make the body.
1123                 os << "\\begin{document}\n";
1124                 d->texrow.newline();
1125         } // output_preamble
1126
1127         d->texrow.start(paragraphs().begin()->id(), 0);
1128
1129         LYXERR(Debug::INFO, "preamble finished, now the body.");
1130
1131         // if we are doing a real file with body, even if this is the
1132         // child of some other buffer, let's cut the link here.
1133         // This happens for example if only a child document is printed.
1134         Buffer const * save_parent = 0;
1135         if (output_preamble) {
1136                 save_parent = d->parent_buffer;
1137                 d->parent_buffer = 0;
1138         }
1139
1140         loadChildDocuments();
1141
1142         // the real stuff
1143         latexParagraphs(*this, paragraphs(), os, d->texrow, runparams);
1144
1145         // Restore the parenthood if needed
1146         if (output_preamble)
1147                 d->parent_buffer = save_parent;
1148
1149         // add this just in case after all the paragraphs
1150         os << endl;
1151         d->texrow.newline();
1152
1153         if (output_preamble) {
1154                 os << "\\end{document}\n";
1155                 d->texrow.newline();
1156                 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1157         } else {
1158                 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1159         }
1160         runparams_in.encoding = runparams.encoding;
1161
1162         // Just to be sure. (Asger)
1163         d->texrow.newline();
1164
1165         LYXERR(Debug::INFO, "Finished making LaTeX file.");
1166         LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1167 }
1168
1169
1170 bool Buffer::isLatex() const
1171 {
1172         return params().getTextClass().outputType() == LATEX;
1173 }
1174
1175
1176 bool Buffer::isLiterate() const
1177 {
1178         return params().getTextClass().outputType() == LITERATE;
1179 }
1180
1181
1182 bool Buffer::isDocBook() const
1183 {
1184         return params().getTextClass().outputType() == DOCBOOK;
1185 }
1186
1187
1188 void Buffer::makeDocBookFile(FileName const & fname,
1189                               OutputParams const & runparams,
1190                               bool const body_only) const
1191 {
1192         LYXERR(Debug::LATEX, "makeDocBookFile...");
1193
1194         //ofstream ofs;
1195         odocfstream ofs;
1196         if (!openFileWrite(ofs, fname))
1197                 return;
1198
1199         writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1200
1201         ofs.close();
1202         if (ofs.fail())
1203                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1204 }
1205
1206
1207 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1208                              OutputParams const & runparams,
1209                              bool const only_body) const
1210 {
1211         LaTeXFeatures features(*this, params(), runparams);
1212         validate(features);
1213
1214         d->texrow.reset();
1215
1216         TextClass const & tclass = params().getTextClass();
1217         string const top_element = tclass.latexname();
1218
1219         if (!only_body) {
1220                 if (runparams.flavor == OutputParams::XML)
1221                         os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1222
1223                 // FIXME UNICODE
1224                 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1225
1226                 // FIXME UNICODE
1227                 if (! tclass.class_header().empty())
1228                         os << from_ascii(tclass.class_header());
1229                 else if (runparams.flavor == OutputParams::XML)
1230                         os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1231                             << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1232                 else
1233                         os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1234
1235                 docstring preamble = from_utf8(params().preamble);
1236                 if (runparams.flavor != OutputParams::XML ) {
1237                         preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1238                         preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1239                         preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1240                         preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1241                 }
1242
1243                 string const name = runparams.nice
1244                         ? changeExtension(absFileName(), ".sgml") : fname;
1245                 preamble += features.getIncludedFiles(name);
1246                 preamble += features.getLyXSGMLEntities();
1247
1248                 if (!preamble.empty()) {
1249                         os << "\n [ " << preamble << " ]";
1250                 }
1251                 os << ">\n\n";
1252         }
1253
1254         string top = top_element;
1255         top += " lang=\"";
1256         if (runparams.flavor == OutputParams::XML)
1257                 top += params().language->code();
1258         else
1259                 top += params().language->code().substr(0,2);
1260         top += '"';
1261
1262         if (!params().options.empty()) {
1263                 top += ' ';
1264                 top += params().options;
1265         }
1266
1267         os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1268             << " file was created by LyX " << lyx_version
1269             << "\n  See http://www.lyx.org/ for more information -->\n";
1270
1271         params().getTextClass().counters().reset();
1272
1273         loadChildDocuments();
1274
1275         sgml::openTag(os, top);
1276         os << '\n';
1277         docbookParagraphs(paragraphs(), *this, os, runparams);
1278         sgml::closeTag(os, top_element);
1279 }
1280
1281
1282 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1283 // Other flags: -wall -v0 -x
1284 int Buffer::runChktex()
1285 {
1286         setBusy(true);
1287
1288         // get LaTeX-Filename
1289         FileName const path(temppath());
1290         string const name = addName(path.absFilename(), latexName());
1291         string const org_path = filePath();
1292
1293         support::PathChanger p(path); // path to LaTeX file
1294         message(_("Running chktex..."));
1295
1296         // Generate the LaTeX file if neccessary
1297         OutputParams runparams(&params().encoding());
1298         runparams.flavor = OutputParams::LATEX;
1299         runparams.nice = false;
1300         makeLaTeXFile(FileName(name), org_path, runparams);
1301
1302         TeXErrors terr;
1303         Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1304         int const res = chktex.run(terr); // run chktex
1305
1306         if (res == -1) {
1307                 Alert::error(_("chktex failure"),
1308                              _("Could not run chktex successfully."));
1309         } else if (res > 0) {
1310                 ErrorList & errlist = d->errorLists["ChkTeX"];
1311                 errlist.clear();
1312                 bufferErrors(terr, errlist);
1313         }
1314
1315         setBusy(false);
1316
1317         errors("ChkTeX");
1318
1319         return res;
1320 }
1321
1322
1323 void Buffer::validate(LaTeXFeatures & features) const
1324 {
1325         TextClass const & tclass = params().getTextClass();
1326
1327         if (params().outputChanges) {
1328                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1329                 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1330                                   LaTeXFeatures::isAvailable("xcolor");
1331
1332                 if (features.runparams().flavor == OutputParams::LATEX) {
1333                         if (dvipost) {
1334                                 features.require("ct-dvipost");
1335                                 features.require("dvipost");
1336                         } else if (xcolorsoul) {
1337                                 features.require("ct-xcolor-soul");
1338                                 features.require("soul");
1339                                 features.require("xcolor");
1340                         } else {
1341                                 features.require("ct-none");
1342                         }
1343                 } else if (features.runparams().flavor == OutputParams::PDFLATEX ) {
1344                         if (xcolorsoul) {
1345                                 features.require("ct-xcolor-soul");
1346                                 features.require("soul");
1347                                 features.require("xcolor");
1348                                 features.require("pdfcolmk"); // improves color handling in PDF output
1349                         } else {
1350                                 features.require("ct-none");
1351                         }
1352                 }
1353         }
1354
1355         // AMS Style is at document level
1356         if (params().use_amsmath == BufferParams::package_on
1357             || tclass.provides("amsmath"))
1358                 features.require("amsmath");
1359         if (params().use_esint == BufferParams::package_on)
1360                 features.require("esint");
1361
1362         loadChildDocuments();
1363
1364         for_each(paragraphs().begin(), paragraphs().end(),
1365                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1366
1367         // the bullet shapes are buffer level not paragraph level
1368         // so they are tested here
1369         for (int i = 0; i < 4; ++i) {
1370                 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1371                         int const font = params().user_defined_bullet(i).getFont();
1372                         if (font == 0) {
1373                                 int const c = params()
1374                                         .user_defined_bullet(i)
1375                                         .getCharacter();
1376                                 if (c == 16
1377                                    || c == 17
1378                                    || c == 25
1379                                    || c == 26
1380                                    || c == 31) {
1381                                         features.require("latexsym");
1382                                 }
1383                         } else if (font == 1) {
1384                                 features.require("amssymb");
1385                         } else if ((font >= 2 && font <= 5)) {
1386                                 features.require("pifont");
1387                         }
1388                 }
1389         }
1390
1391         if (lyxerr.debugging(Debug::LATEX)) {
1392                 features.showStruct();
1393         }
1394 }
1395
1396
1397 void Buffer::getLabelList(vector<docstring> & list) const
1398 {
1399         /// if this is a child document and the parent is already loaded
1400         /// Use the parent's list instead  [ale990407]
1401         Buffer const * tmp = masterBuffer();
1402         if (!tmp) {
1403                 lyxerr << "masterBuffer() failed!" << endl;
1404                 BOOST_ASSERT(tmp);
1405         }
1406         if (tmp != this) {
1407                 tmp->getLabelList(list);
1408                 return;
1409         }
1410
1411         loadChildDocuments();
1412
1413         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1414                 it.nextInset()->getLabelList(*this, list);
1415 }
1416
1417
1418 void Buffer::updateBibfilesCache() const
1419 {
1420         // if this is a child document and the parent is already loaded
1421         // update the parent's cache instead
1422         Buffer const * tmp = masterBuffer();
1423         BOOST_ASSERT(tmp);
1424         if (tmp != this) {
1425                 tmp->updateBibfilesCache();
1426                 return;
1427         }
1428
1429         d->bibfilesCache_.clear();
1430         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1431                 if (it->lyxCode() == BIBTEX_CODE) {
1432                         InsetBibtex const & inset =
1433                                 static_cast<InsetBibtex const &>(*it);
1434                         FileNameList const bibfiles = inset.getFiles(*this);
1435                         d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1436                                 bibfiles.begin(),
1437                                 bibfiles.end());
1438                 } else if (it->lyxCode() == INCLUDE_CODE) {
1439                         InsetInclude & inset =
1440                                 static_cast<InsetInclude &>(*it);
1441                         inset.updateBibfilesCache(*this);
1442                         FileNameList const & bibfiles =
1443                                         inset.getBibfilesCache(*this);
1444                         d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1445                                 bibfiles.begin(),
1446                                 bibfiles.end());
1447                 }
1448         }
1449 }
1450
1451
1452 FileNameList const & Buffer::getBibfilesCache() const
1453 {
1454         // if this is a child document and the parent is already loaded
1455         // use the parent's cache instead
1456         Buffer const * tmp = masterBuffer();
1457         BOOST_ASSERT(tmp);
1458         if (tmp != this)
1459                 return tmp->getBibfilesCache();
1460
1461         // We update the cache when first used instead of at loading time.
1462         if (d->bibfilesCache_.empty())
1463                 const_cast<Buffer *>(this)->updateBibfilesCache();
1464
1465         return d->bibfilesCache_;
1466 }
1467
1468
1469 bool Buffer::isDepClean(string const & name) const
1470 {
1471         DepClean::const_iterator const it = d->dep_clean.find(name);
1472         if (it == d->dep_clean.end())
1473                 return true;
1474         return it->second;
1475 }
1476
1477
1478 void Buffer::markDepClean(string const & name)
1479 {
1480         d->dep_clean[name] = true;
1481 }
1482
1483
1484 bool Buffer::dispatch(string const & command, bool * result)
1485 {
1486         return dispatch(lyxaction.lookupFunc(command), result);
1487 }
1488
1489
1490 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1491 {
1492         bool dispatched = true;
1493
1494         switch (func.action) {
1495                 case LFUN_BUFFER_EXPORT: {
1496                         bool const tmp = doExport(to_utf8(func.argument()), false);
1497                         if (result)
1498                                 *result = tmp;
1499                         break;
1500                 }
1501
1502                 default:
1503                         dispatched = false;
1504         }
1505         return dispatched;
1506 }
1507
1508
1509 void Buffer::changeLanguage(Language const * from, Language const * to)
1510 {
1511         BOOST_ASSERT(from);
1512         BOOST_ASSERT(to);
1513
1514         for_each(par_iterator_begin(),
1515                  par_iterator_end(),
1516                  bind(&Paragraph::changeLanguage, _1, params(), from, to));
1517 }
1518
1519
1520 bool Buffer::isMultiLingual() const
1521 {
1522         ParConstIterator end = par_iterator_end();
1523         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1524                 if (it->isMultiLingual(params()))
1525                         return true;
1526
1527         return false;
1528 }
1529
1530
1531 ParIterator Buffer::getParFromID(int const id) const
1532 {
1533         ParConstIterator it = par_iterator_begin();
1534         ParConstIterator const end = par_iterator_end();
1535
1536         if (id < 0) {
1537                 // John says this is called with id == -1 from undo
1538                 lyxerr << "getParFromID(), id: " << id << endl;
1539                 return end;
1540         }
1541
1542         for (; it != end; ++it)
1543                 if (it->id() == id)
1544                         return it;
1545
1546         return end;
1547 }
1548
1549
1550 bool Buffer::hasParWithID(int const id) const
1551 {
1552         ParConstIterator const it = getParFromID(id);
1553         return it != par_iterator_end();
1554 }
1555
1556
1557 ParIterator Buffer::par_iterator_begin()
1558 {
1559         return lyx::par_iterator_begin(inset());
1560 }
1561
1562
1563 ParIterator Buffer::par_iterator_end()
1564 {
1565         return lyx::par_iterator_end(inset());
1566 }
1567
1568
1569 ParConstIterator Buffer::par_iterator_begin() const
1570 {
1571         return lyx::par_const_iterator_begin(inset());
1572 }
1573
1574
1575 ParConstIterator Buffer::par_iterator_end() const
1576 {
1577         return lyx::par_const_iterator_end(inset());
1578 }
1579
1580
1581 Language const * Buffer::language() const
1582 {
1583         return params().language;
1584 }
1585
1586
1587 docstring const Buffer::B_(string const & l10n) const
1588 {
1589         return params().B_(l10n);
1590 }
1591
1592
1593 bool Buffer::isClean() const
1594 {
1595         return d->lyx_clean;
1596 }
1597
1598
1599 bool Buffer::isBakClean() const
1600 {
1601         return d->bak_clean;
1602 }
1603
1604
1605 bool Buffer::isExternallyModified(CheckMethod method) const
1606 {
1607         BOOST_ASSERT(d->filename.exists());
1608         // if method == timestamp, check timestamp before checksum
1609         return (method == checksum_method
1610                 || d->timestamp_ != d->filename.lastModified())
1611                 && d->checksum_ != d->filename.checksum();
1612 }
1613
1614
1615 void Buffer::saveCheckSum(FileName const & file) const
1616 {
1617         if (file.exists()) {
1618                 d->timestamp_ = file.lastModified();
1619                 d->checksum_ = file.checksum();
1620         } else {
1621                 // in the case of save to a new file.
1622                 d->timestamp_ = 0;
1623                 d->checksum_ = 0;
1624         }
1625 }
1626
1627
1628 void Buffer::markClean() const
1629 {
1630         if (!d->lyx_clean) {
1631                 d->lyx_clean = true;
1632                 updateTitles();
1633         }
1634         // if the .lyx file has been saved, we don't need an
1635         // autosave
1636         d->bak_clean = true;
1637 }
1638
1639
1640 void Buffer::markBakClean() const
1641 {
1642         d->bak_clean = true;
1643 }
1644
1645
1646 void Buffer::setUnnamed(bool flag)
1647 {
1648         d->unnamed = flag;
1649 }
1650
1651
1652 bool Buffer::isUnnamed() const
1653 {
1654         return d->unnamed;
1655 }
1656
1657
1658 // FIXME: this function should be moved to buffer_pimpl.C
1659 void Buffer::markDirty()
1660 {
1661         if (d->lyx_clean) {
1662                 d->lyx_clean = false;
1663                 updateTitles();
1664         }
1665         d->bak_clean = false;
1666
1667         DepClean::iterator it = d->dep_clean.begin();
1668         DepClean::const_iterator const end = d->dep_clean.end();
1669
1670         for (; it != end; ++it)
1671                 it->second = false;
1672 }
1673
1674
1675 FileName Buffer::fileName() const
1676 {
1677         return d->filename;
1678 }
1679
1680
1681 string Buffer::absFileName() const
1682 {
1683         return d->filename.absFilename();
1684 }
1685
1686
1687 string Buffer::filePath() const
1688 {
1689         return d->filename.onlyPath().absFilename();
1690 }
1691
1692
1693 bool Buffer::isReadonly() const
1694 {
1695         return d->read_only;
1696 }
1697
1698
1699 void Buffer::setParent(Buffer const * buffer)
1700 {
1701         // Avoids recursive include.
1702         d->parent_buffer = buffer == this ? 0 : buffer;
1703 }
1704
1705
1706 Buffer const * Buffer::parent()
1707 {
1708         return d->parent_buffer;
1709 }
1710
1711
1712 Buffer const * Buffer::masterBuffer() const
1713 {
1714         if (!d->parent_buffer)
1715                 return this;
1716
1717         return d->parent_buffer->masterBuffer();
1718 }
1719
1720
1721 bool Buffer::hasMacro(docstring const & name, Paragraph const & par) const
1722 {
1723         Impl::PositionToMacroMap::iterator it;
1724         it = d->macros[name].upper_bound(par.macrocontextPosition());
1725         if (it != d->macros[name].end())
1726                 return true;
1727
1728         // If there is a master buffer, query that
1729         Buffer const * master = masterBuffer();
1730         if (master && master != this)
1731                 return master->hasMacro(name);
1732
1733         return MacroTable::globalMacros().has(name);
1734 }
1735
1736
1737 bool Buffer::hasMacro(docstring const & name) const
1738 {
1739         if( !d->macros[name].empty() )
1740                 return true;
1741
1742         // If there is a master buffer, query that
1743         Buffer const * master = masterBuffer();
1744         if (master && master != this)
1745                 return master->hasMacro(name);
1746
1747         return MacroTable::globalMacros().has(name);
1748 }
1749
1750
1751 MacroData const & Buffer::getMacro(docstring const & name,
1752         Paragraph const & par) const
1753 {
1754         Impl::PositionToMacroMap::iterator it;
1755         it = d->macros[name].upper_bound(par.macrocontextPosition());
1756         if( it != d->macros[name].end() )
1757                 return it->second;
1758
1759         // If there is a master buffer, query that
1760         Buffer const * master = masterBuffer();
1761         if (master && master != this)
1762                 return master->getMacro(name);
1763
1764         return MacroTable::globalMacros().get(name);
1765 }
1766
1767
1768 MacroData const & Buffer::getMacro(docstring const & name) const
1769 {
1770         Impl::PositionToMacroMap::iterator it;
1771         it = d->macros[name].begin();
1772         if( it != d->macros[name].end() )
1773                 return it->second;
1774
1775         // If there is a master buffer, query that
1776         Buffer const * master = masterBuffer();
1777         if (master && master != this)
1778                 return master->getMacro(name);
1779
1780         return MacroTable::globalMacros().get(name);
1781 }
1782
1783
1784 void Buffer::updateMacros()
1785 {
1786         // start with empty table
1787         d->macros = Impl::NameToPositionMacroMap();
1788
1789         // Iterate over buffer
1790         ParagraphList & pars = text().paragraphs();
1791         for (size_t i = 0, n = pars.size(); i != n; ++i) {
1792                 // set position again
1793                 pars[i].setMacrocontextPosition(i);
1794
1795                 //lyxerr << "searching main par " << i
1796                 //      << " for macro definitions" << std::endl;
1797                 InsetList const & insets = pars[i].insetList();
1798                 InsetList::const_iterator it = insets.begin();
1799                 InsetList::const_iterator end = insets.end();
1800                 for ( ; it != end; ++it) {
1801                         if (it->inset->lyxCode() != MATHMACRO_CODE)
1802                                 continue;
1803
1804                         // get macro data
1805                         MathMacroTemplate const & macroTemplate
1806                         = static_cast<MathMacroTemplate const &>(*it->inset);
1807
1808                         // valid?
1809                         if (macroTemplate.validMacro()) {
1810                                 MacroData macro = macroTemplate.asMacroData();
1811
1812                                 // redefinition?
1813                                 // call hasMacro here instead of directly querying mc to
1814                                 // also take the master document into consideration
1815                                 macro.setRedefinition(hasMacro(macroTemplate.name()));
1816
1817                                 // register macro (possibly overwrite the previous one of this paragraph)
1818                                 d->macros[macroTemplate.name()][i] = macro;
1819                         }
1820                 }
1821         }
1822 }
1823
1824
1825 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1826         InsetCode code)
1827 {
1828         //FIXME: This does not work for child documents yet.
1829         BOOST_ASSERT(code == CITE_CODE || code == REF_CODE);
1830         // Check if the label 'from' appears more than once
1831         vector<docstring> labels;
1832
1833         string paramName;
1834         if (code == CITE_CODE) {
1835                 BiblioInfo keys;
1836                 keys.fillWithBibKeys(this);
1837                 BiblioInfo::const_iterator bit  = keys.begin();
1838                 BiblioInfo::const_iterator bend = keys.end();
1839
1840                 for (; bit != bend; ++bit)
1841                         // FIXME UNICODE
1842                         labels.push_back(bit->first);
1843                 paramName = "key";
1844         } else {
1845                 getLabelList(labels);
1846                 paramName = "reference";
1847         }
1848
1849         if (std::count(labels.begin(), labels.end(), from) > 1)
1850                 return;
1851
1852         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1853                 if (it->lyxCode() == code) {
1854                         InsetCommand & inset = static_cast<InsetCommand &>(*it);
1855                         docstring const oldValue = inset.getParam(paramName);
1856                         if (oldValue == from)
1857                                 inset.setParam(paramName, to);
1858                 }
1859         }
1860 }
1861
1862
1863 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1864         pit_type par_end, bool full_source)
1865 {
1866         OutputParams runparams(&params().encoding());
1867         runparams.nice = true;
1868         runparams.flavor = OutputParams::LATEX;
1869         runparams.linelen = lyxrc.plaintext_linelen;
1870         // No side effect of file copying and image conversion
1871         runparams.dryrun = true;
1872
1873         d->texrow.reset();
1874         if (full_source) {
1875                 os << "% " << _("Preview source code") << "\n\n";
1876                 d->texrow.newline();
1877                 d->texrow.newline();
1878                 if (isLatex())
1879                         writeLaTeXSource(os, filePath(), runparams, true, true);
1880                 else {
1881                         writeDocBookSource(os, absFileName(), runparams, false);
1882                 }
1883         } else {
1884                 runparams.par_begin = par_begin;
1885                 runparams.par_end = par_end;
1886                 if (par_begin + 1 == par_end)
1887                         os << "% "
1888                            << bformat(_("Preview source code for paragraph %1$d"), par_begin)
1889                            << "\n\n";
1890                 else
1891                         os << "% "
1892                            << bformat(_("Preview source code from paragraph %1$s to %2$s"),
1893                                         convert<docstring>(par_begin),
1894                                         convert<docstring>(par_end - 1))
1895                            << "\n\n";
1896                 d->texrow.newline();
1897                 d->texrow.newline();
1898                 // output paragraphs
1899                 if (isLatex()) {
1900                         latexParagraphs(*this, paragraphs(), os, d->texrow, runparams);
1901                 } else {
1902                         // DocBook
1903                         docbookParagraphs(paragraphs(), *this, os, runparams);
1904                 }
1905         }
1906 }
1907
1908
1909 ErrorList & Buffer::errorList(string const & type) const
1910 {
1911         static ErrorList emptyErrorList;
1912         std::map<string, ErrorList>::iterator I = d->errorLists.find(type);
1913         if (I == d->errorLists.end())
1914                 return emptyErrorList;
1915
1916         return I->second;
1917 }
1918
1919
1920 void Buffer::structureChanged() const
1921 {
1922         if (gui_)
1923                 gui_->structureChanged();
1924 }
1925
1926
1927 void Buffer::errors(std::string const & err) const
1928 {
1929         if (gui_)
1930                 gui_->errors(err);
1931 }
1932
1933
1934 void Buffer::message(docstring const & msg) const
1935 {
1936         if (gui_)
1937                 gui_->message(msg);
1938 }
1939
1940
1941 void Buffer::setBusy(bool on) const
1942 {
1943         if (gui_)
1944                 gui_->setBusy(on);
1945 }
1946
1947
1948 void Buffer::setReadOnly(bool on) const
1949 {
1950         if (d->wa_)
1951                 d->wa_->setReadOnly(on);
1952 }
1953
1954
1955 void Buffer::updateTitles() const
1956 {
1957         if (d->wa_)
1958                 d->wa_->updateTitles();
1959 }
1960
1961
1962 void Buffer::resetAutosaveTimers() const
1963 {
1964         if (gui_)
1965                 gui_->resetAutosaveTimers();
1966 }
1967
1968
1969 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
1970 {
1971         gui_ = gui;
1972 }
1973
1974
1975
1976 namespace {
1977
1978 class AutoSaveBuffer : public support::ForkedProcess {
1979 public:
1980         ///
1981         AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
1982                 : buffer_(buffer), fname_(fname) {}
1983         ///
1984         virtual boost::shared_ptr<ForkedProcess> clone() const
1985         {
1986                 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
1987         }
1988         ///
1989         int start()
1990         {
1991                 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
1992                                                  from_utf8(fname_.absFilename())));
1993                 return run(DontWait);
1994         }
1995 private:
1996         ///
1997         virtual int generateChild();
1998         ///
1999         Buffer const & buffer_;
2000         FileName fname_;
2001 };
2002
2003
2004 #if !defined (HAVE_FORK)
2005 # define fork() -1
2006 #endif
2007
2008 int AutoSaveBuffer::generateChild()
2009 {
2010         // tmp_ret will be located (usually) in /tmp
2011         // will that be a problem?
2012         pid_t const pid = fork();
2013         // If you want to debug the autosave
2014         // you should set pid to -1, and comment out the fork.
2015         if (pid == 0 || pid == -1) {
2016                 // pid = -1 signifies that lyx was unable
2017                 // to fork. But we will do the save
2018                 // anyway.
2019                 bool failed = false;
2020
2021                 FileName const tmp_ret(tempName(FileName(), "lyxauto"));
2022                 if (!tmp_ret.empty()) {
2023                         buffer_.writeFile(tmp_ret);
2024                         // assume successful write of tmp_ret
2025                         if (!rename(tmp_ret, fname_)) {
2026                                 failed = true;
2027                                 // most likely couldn't move between
2028                                 // filesystems unless write of tmp_ret
2029                                 // failed so remove tmp file (if it
2030                                 // exists)
2031                                 tmp_ret.removeFile();
2032                         }
2033                 } else {
2034                         failed = true;
2035                 }
2036
2037                 if (failed) {
2038                         // failed to write/rename tmp_ret so try writing direct
2039                         if (!buffer_.writeFile(fname_)) {
2040                                 // It is dangerous to do this in the child,
2041                                 // but safe in the parent, so...
2042                                 if (pid == -1) // emit message signal.
2043                                         buffer_.message(_("Autosave failed!"));
2044                         }
2045                 }
2046                 if (pid == 0) { // we are the child so...
2047                         _exit(0);
2048                 }
2049         }
2050         return pid;
2051 }
2052
2053 } // namespace anon
2054
2055
2056 // Perfect target for a thread...
2057 void Buffer::autoSave() const
2058 {
2059         if (isBakClean() || isReadonly()) {
2060                 // We don't save now, but we'll try again later
2061                 resetAutosaveTimers();
2062                 return;
2063         }
2064
2065         // emit message signal.
2066         message(_("Autosaving current document..."));
2067
2068         // create autosave filename
2069         string fname = filePath();
2070         fname += '#';
2071         fname += d->filename.onlyFileName();
2072         fname += '#';
2073
2074         AutoSaveBuffer autosave(*this, FileName(fname));
2075         autosave.start();
2076
2077         markBakClean();
2078         resetAutosaveTimers();
2079 }
2080
2081
2082 void Buffer::resetChildDocuments(bool close_them) const
2083 {
2084         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2085                 if (it->lyxCode() != INCLUDE_CODE)
2086                         continue;
2087                 InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
2088                 InsetCommandParams const & ip = inset.params();
2089
2090                 resetParentBuffer(this, ip, close_them);
2091         }
2092
2093         if (use_gui && masterBuffer() == this)
2094                 updateLabels(*this);
2095 }
2096
2097
2098 void Buffer::loadChildDocuments() const
2099 {
2100         bool parse_error = false;
2101
2102         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2103                 if (it->lyxCode() != INCLUDE_CODE)
2104                         continue;
2105                 InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
2106                 InsetCommandParams const & ip = inset.params();
2107                 Buffer * child = loadIfNeeded(*this, ip);
2108                 if (!child)
2109                         continue;
2110                 parse_error |= !child->errorList("Parse").empty();
2111                 child->loadChildDocuments();
2112         }
2113
2114         if (use_gui && masterBuffer() == this)
2115                 updateLabels(*this);
2116 }
2117
2118
2119 string Buffer::bufferFormat() const
2120 {
2121         if (isDocBook())
2122                 return "docbook";
2123         if (isLiterate())
2124                 return "literate";
2125         return "latex";
2126 }
2127
2128
2129 bool Buffer::doExport(string const & format, bool put_in_tempdir,
2130         string & result_file) const
2131 {
2132         string backend_format;
2133         OutputParams runparams(&params().encoding());
2134         runparams.flavor = OutputParams::LATEX;
2135         runparams.linelen = lyxrc.plaintext_linelen;
2136         vector<string> backs = backends();
2137         if (find(backs.begin(), backs.end(), format) == backs.end()) {
2138                 // Get shortest path to format
2139                 Graph::EdgePath path;
2140                 for (vector<string>::const_iterator it = backs.begin();
2141                      it != backs.end(); ++it) {
2142                         Graph::EdgePath p = theConverters().getPath(*it, format);
2143                         if (!p.empty() && (path.empty() || p.size() < path.size())) {
2144                                 backend_format = *it;
2145                                 path = p;
2146                         }
2147                 }
2148                 if (!path.empty())
2149                         runparams.flavor = theConverters().getFlavor(path);
2150                 else {
2151                         Alert::error(_("Couldn't export file"),
2152                                 bformat(_("No information for exporting the format %1$s."),
2153                                    formats.prettyName(format)));
2154                         return false;
2155                 }
2156         } else {
2157                 backend_format = format;
2158                 // FIXME: Don't hardcode format names here, but use a flag
2159                 if (backend_format == "pdflatex")
2160                         runparams.flavor = OutputParams::PDFLATEX;
2161         }
2162
2163         string filename = latexName(false);
2164         filename = addName(temppath(), filename);
2165         filename = changeExtension(filename,
2166                                    formats.extension(backend_format));
2167
2168         // Plain text backend
2169         if (backend_format == "text")
2170                 writePlaintextFile(*this, FileName(filename), runparams);
2171         // no backend
2172         else if (backend_format == "lyx")
2173                 writeFile(FileName(filename));
2174         // Docbook backend
2175         else if (isDocBook()) {
2176                 runparams.nice = !put_in_tempdir;
2177                 makeDocBookFile(FileName(filename), runparams);
2178         }
2179         // LaTeX backend
2180         else if (backend_format == format) {
2181                 runparams.nice = true;
2182                 if (!makeLaTeXFile(FileName(filename), string(), runparams))
2183                         return false;
2184         } else if (!lyxrc.tex_allows_spaces
2185                    && support::contains(filePath(), ' ')) {
2186                 Alert::error(_("File name error"),
2187                            _("The directory path to the document cannot contain spaces."));
2188                 return false;
2189         } else {
2190                 runparams.nice = false;
2191                 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
2192                         return false;
2193         }
2194
2195         string const error_type = (format == "program")
2196                 ? "Build" : bufferFormat();
2197         string const ext = formats.extension(format);
2198         FileName const tmp_result_file(changeExtension(filename, ext));
2199         bool const success = theConverters().convert(this, FileName(filename),
2200                 tmp_result_file, FileName(absFileName()), backend_format, format,
2201                 errorList(error_type));
2202         // Emit the signal to show the error list.
2203         if (format != backend_format)
2204                 errors(error_type);
2205         if (!success)
2206                 return false;
2207
2208         if (put_in_tempdir)
2209                 result_file = tmp_result_file.absFilename();
2210         else {
2211                 result_file = changeExtension(absFileName(), ext);
2212                 // We need to copy referenced files (e. g. included graphics
2213                 // if format == "dvi") to the result dir.
2214                 vector<ExportedFile> const files =
2215                         runparams.exportdata->externalFiles(format);
2216                 string const dest = onlyPath(result_file);
2217                 CopyStatus status = SUCCESS;
2218                 for (vector<ExportedFile>::const_iterator it = files.begin();
2219                                 it != files.end() && status != CANCEL; ++it) {
2220                         string const fmt =
2221                                 formats.getFormatFromFile(it->sourceName);
2222                         status = copyFile(fmt, it->sourceName,
2223                                           makeAbsPath(it->exportName, dest),
2224                                           it->exportName, status == FORCE);
2225                 }
2226                 if (status == CANCEL) {
2227                         message(_("Document export cancelled."));
2228                 } else if (tmp_result_file.exists()) {
2229                         // Finally copy the main file
2230                         status = copyFile(format, tmp_result_file,
2231                                           FileName(result_file), result_file,
2232                                           status == FORCE);
2233                         message(bformat(_("Document exported as %1$s "
2234                                                                "to file `%2$s'"),
2235                                                 formats.prettyName(format),
2236                                                 makeDisplayPath(result_file)));
2237                 } else {
2238                         // This must be a dummy converter like fax (bug 1888)
2239                         message(bformat(_("Document exported as %1$s"),
2240                                                 formats.prettyName(format)));
2241                 }
2242         }
2243
2244         return true;
2245 }
2246
2247
2248 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
2249 {
2250         string result_file;
2251         return doExport(format, put_in_tempdir, result_file);
2252 }
2253
2254
2255 bool Buffer::preview(string const & format) const
2256 {
2257         string result_file;
2258         if (!doExport(format, true, result_file))
2259                 return false;
2260         return formats.view(*this, FileName(result_file), format);
2261 }
2262
2263
2264 bool Buffer::isExportable(string const & format) const
2265 {
2266         vector<string> backs = backends();
2267         for (vector<string>::const_iterator it = backs.begin();
2268              it != backs.end(); ++it)
2269                 if (theConverters().isReachable(*it, format))
2270                         return true;
2271         return false;
2272 }
2273
2274
2275 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
2276 {
2277         vector<string> backs = backends();
2278         vector<Format const *> result =
2279                 theConverters().getReachable(backs[0], only_viewable, true);
2280         for (vector<string>::const_iterator it = backs.begin() + 1;
2281              it != backs.end(); ++it) {
2282                 vector<Format const *>  r =
2283                         theConverters().getReachable(*it, only_viewable, false);
2284                 result.insert(result.end(), r.begin(), r.end());
2285         }
2286         return result;
2287 }
2288
2289
2290 vector<string> Buffer::backends() const
2291 {
2292         vector<string> v;
2293         if (params().getTextClass().isTeXClassAvailable()) {
2294                 v.push_back(bufferFormat());
2295                 // FIXME: Don't hardcode format names here, but use a flag
2296                 if (v.back() == "latex")
2297                         v.push_back("pdflatex");
2298         }
2299         v.push_back("text");
2300         v.push_back("lyx");
2301         return v;
2302 }
2303
2304
2305 bool Buffer::readFileHelper(FileName const & s)
2306 {
2307         // File information about normal file
2308         if (!s.exists()) {
2309                 docstring const file = makeDisplayPath(s.absFilename(), 50);
2310                 docstring text = bformat(_("The specified document\n%1$s"
2311                                                      "\ncould not be read."), file);
2312                 Alert::error(_("Could not read document"), text);
2313                 return false;
2314         }
2315
2316         // Check if emergency save file exists and is newer.
2317         FileName const e(s.absFilename() + ".emergency");
2318
2319         if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
2320                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2321                 docstring const text =
2322                         bformat(_("An emergency save of the document "
2323                                   "%1$s exists.\n\n"
2324                                                "Recover emergency save?"), file);
2325                 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
2326                                       _("&Recover"),  _("&Load Original"),
2327                                       _("&Cancel")))
2328                 {
2329                 case 0:
2330                         // the file is not saved if we load the emergency file.
2331                         markDirty();
2332                         return readFile(e);
2333                 case 1:
2334                         break;
2335                 default:
2336                         return false;
2337                 }
2338         }
2339
2340         // Now check if autosave file is newer.
2341         FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
2342
2343         if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
2344                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2345                 docstring const text =
2346                         bformat(_("The backup of the document "
2347                                   "%1$s is newer.\n\nLoad the "
2348                                                "backup instead?"), file);
2349                 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
2350                                       _("&Load backup"), _("Load &original"),
2351                                       _("&Cancel") ))
2352                 {
2353                 case 0:
2354                         // the file is not saved if we load the autosave file.
2355                         markDirty();
2356                         return readFile(a);
2357                 case 1:
2358                         // Here we delete the autosave
2359                         a.removeFile();
2360                         break;
2361                 default:
2362                         return false;
2363                 }
2364         }
2365         return readFile(s);
2366 }
2367
2368
2369 bool Buffer::loadLyXFile(FileName const & s)
2370 {
2371         if (s.isReadableFile()) {
2372                 if (readFileHelper(s)) {
2373                         lyxvc().file_found_hook(s);
2374                         if (!s.isWritable())
2375                                 setReadonly(true);
2376                         return true;
2377                 }
2378         } else {
2379                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2380                 // Here we probably should run
2381                 if (LyXVC::file_not_found_hook(s)) {
2382                         docstring const text =
2383                                 bformat(_("Do you want to retrieve the document"
2384                                                        " %1$s from version control?"), file);
2385                         int const ret = Alert::prompt(_("Retrieve from version control?"),
2386                                 text, 0, 1, _("&Retrieve"), _("&Cancel"));
2387
2388                         if (ret == 0) {
2389                                 // How can we know _how_ to do the checkout?
2390                                 // With the current VC support it has to be,
2391                                 // a RCS file since CVS do not have special ,v files.
2392                                 RCS::retrieve(s);
2393                                 return loadLyXFile(s);
2394                         }
2395                 }
2396         }
2397         return false;
2398 }
2399
2400
2401 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
2402 {
2403         TeXErrors::Errors::const_iterator cit = terr.begin();
2404         TeXErrors::Errors::const_iterator end = terr.end();
2405
2406         for (; cit != end; ++cit) {
2407                 int id_start = -1;
2408                 int pos_start = -1;
2409                 int errorRow = cit->error_in_line;
2410                 bool found = d->texrow.getIdFromRow(errorRow, id_start,
2411                                                        pos_start);
2412                 int id_end = -1;
2413                 int pos_end = -1;
2414                 do {
2415                         ++errorRow;
2416                         found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
2417                 } while (found && id_start == id_end && pos_start == pos_end);
2418
2419                 errorList.push_back(ErrorItem(cit->error_desc,
2420                         cit->error_text, id_start, pos_start, pos_end));
2421         }
2422 }
2423
2424 } // namespace lyx