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