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