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 "LayoutFile.h"
  18 #include "BiblioInfo.h"
  19 #include "BranchList.h"
  20 #include "buffer_funcs.h"
  21 #include "BufferList.h"
  22 #include "BufferParams.h"
  23 #include "Bullet.h"
  24 #include "Chktex.h"
  25 #include "Converter.h"
  26 #include "Counters.h"
  27 #include "Cursor.h"
  28 #include "CutAndPaste.h"
  29 #include "DispatchResult.h"
  30 #include "DocIterator.h"
  31 #include "Encoding.h"
  32 #include "ErrorList.h"
  33 #include "Exporter.h"
  34 #include "Format.h"
  35 #include "FuncRequest.h"
  36 #include "FuncStatus.h"
  37 #include "IndicesList.h"
  38 #include "InsetIterator.h"
  39 #include "InsetList.h"
  40 #include "Language.h"
  41 #include "LaTeXFeatures.h"
  42 #include "LaTeX.h"
  43 #include "Layout.h"
  44 #include "Lexer.h"
  45 #include "LyXAction.h"
  46 #include "LyX.h"
  47 #include "LyXRC.h"
  48 #include "LyXVC.h"
  49 #include "output_docbook.h"
  50 #include "output.h"
  51 #include "output_latex.h"
  52 #include "output_xhtml.h"
  53 #include "output_plaintext.h"
  54 #include "Paragraph.h"
  55 #include "ParagraphParameters.h"
  56 #include "ParIterator.h"
  57 #include "PDFOptions.h"
  58 #include "SpellChecker.h"
  59 #include "sgml.h"
  60 #include "TexRow.h"
  61 #include "TexStream.h"
  62 #include "Text.h"
  63 #include "TextClass.h"
  64 #include "TocBackend.h"
  65 #include "Undo.h"
  66 #include "VCBackend.h"
  67 #include "version.h"
  68 #include "WordLangTuple.h"
  69 #include "WordList.h"
  70
  71 #include "insets/InsetBibtex.h"
  72 #include "insets/InsetBranch.h"
  73 #include "insets/InsetInclude.h"
  74 #include "insets/InsetTabular.h"
  75 #include "insets/InsetText.h"
  76
  77 #include "mathed/InsetMathHull.h"
  78 #include "mathed/MacroTable.h"
  79 #include "mathed/MathMacroTemplate.h"
  80 #include "mathed/MathSupport.h"
  81
  82 #include "graphics/PreviewLoader.h"
  83
  84 #include "frontends/alert.h"
  85 #include "frontends/Delegates.h"
  86 #include "frontends/WorkAreaManager.h"
  87
  88 #include "support/lassert.h"
  89 #include "support/convert.h"
  90 #include "support/debug.h"
  91 #include "support/docstring_list.h"
  92 #include "support/ExceptionMessage.h"
  93 #include "support/FileName.h"
  94 #include "support/FileNameList.h"
  95 #include "support/filetools.h"
  96 #include "support/ForkedCalls.h"
  97 #include "support/gettext.h"
  98 #include "support/gzstream.h"
  99 #include "support/lstrings.h"
 100 #include "support/lyxalgo.h"
 101 #include "support/os.h"
 102 #include "support/Package.h"
 103 #include "support/PathChanger.h"
 104 #include "support/Systemcall.h"
 105 #include "support/TempFile.h"
 106 #include "support/textutils.h"
 107 #include "support/types.h"
 108
 109 #include "support/bind.h"
 110 #include "support/shared_ptr.h"
 111
 112 #include <algorithm>
 113 #include <fstream>
 114 #include <iomanip>
 115 #include <map>
 116 #include <set>
 117 #include <sstream>
 118 #include <vector>
 119
 120 using namespace std;
 121 using namespace lyx::support;
 122 using namespace lyx::graphics;
 123
 124 namespace lyx {
 125
 126 namespace Alert = frontend::Alert;
 127 namespace os = support::os;
 128
 129 namespace {
 130
 131 int const LYX_FORMAT = LYX_FORMAT_LYX;
 132
 133 typedef map<string, bool> DepClean;
 134 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
 135
 136 void showPrintError(string const & name)
 137 {
 138         docstring str = bformat(_("Could not print the document %1$s.\n"
 139                                             "Check that your printer is set up correctly."),
 140                              makeDisplayPath(name, 50));
 141         Alert::error(_("Print document failed"), str);
 142 }
 143
 144 } // namespace anon
 145
 146
 147 // A storehouse for the cloned buffers.
 148 list<CloneList *> cloned_buffers;
 149
 150
 151 class Buffer::Impl
 152 {
 153 public:
 154         Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
 155
 156         ~Impl()
 157         {
 158                 delete preview_loader_;
 159                 if (wa_) {
 160                         wa_->closeAll();
 161                         delete wa_;
 162                 }
 163                 delete inset;
 164         }
 165
 166         /// search for macro in local (buffer) table or in children
 167         MacroData const * getBufferMacro(docstring const & name,
 168                 DocIterator const & pos) const;
 169
 170         /// Update macro table starting with position of it \param it in some
 171         /// text inset.
 172         void updateMacros(DocIterator & it, DocIterator & scope);
 173         ///
 174         void setLabel(ParIterator & it, UpdateType utype) const;
 175
 176         /** If we have branches that use the file suffix
 177             feature, return the file name with suffix appended.
 178         */
 179         support::FileName exportFileName() const;
 180
 181         Buffer * owner_;
 182
 183         BufferParams params;
 184         LyXVC lyxvc;
 185         FileName temppath;
 186         mutable TexRow texrow;
 187
 188         /// need to regenerate .tex?
 189         DepClean dep_clean;
 190
 191         /// is save needed?
 192         mutable bool lyx_clean;
 193
 194         /// is autosave needed?
 195         mutable bool bak_clean;
 196
 197         /// is this an unnamed file (New...)?
 198         bool unnamed;
 199
 200         /// is this an internal bufffer?
 201         bool internal_buffer;
 202
 203         /// buffer is r/o
 204         bool read_only;
 205
 206         /// name of the file the buffer is associated with.
 207         FileName filename;
 208
 209         /** Set to true only when the file is fully loaded.
 210          *  Used to prevent the premature generation of previews
 211          *  and by the citation inset.
 212          */
 213         bool file_fully_loaded;
 214
 215         /// Ignore the parent (e.g. when exporting a child standalone)?
 216         bool ignore_parent;
 217
 218         ///
 219         mutable TocBackend toc_backend;
 220
 221         /// macro tables
 222         typedef pair<DocIterator, MacroData> ScopeMacro;
 223         typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
 224         typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
 225         /// map from the macro name to the position map,
 226         /// which maps the macro definition position to the scope and the MacroData.
 227         NamePositionScopeMacroMap macros;
 228         /// This seem to change the way Buffer::getMacro() works
 229         mutable bool macro_lock;
 230
 231         /// positions of child buffers in the buffer
 232         typedef map<Buffer const * const, DocIterator> BufferPositionMap;
 233         typedef pair<DocIterator, Buffer const *> ScopeBuffer;
 234         typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
 235         /// position of children buffers in this buffer
 236         BufferPositionMap children_positions;
 237         /// map from children inclusion positions to their scope and their buffer
 238         PositionScopeBufferMap position_to_children;
 239
 240         /// Container for all sort of Buffer dependant errors.
 241         map<string, ErrorList> errorLists;
 242
 243         /// timestamp and checksum used to test if the file has been externally
 244         /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
 245         time_t timestamp_;
 246         unsigned long checksum_;
 247
 248         ///
 249         frontend::WorkAreaManager * wa_;
 250         ///
 251         frontend::GuiBufferDelegate * gui_;
 252
 253         ///
 254         Undo undo_;
 255
 256         /// A cache for the bibfiles (including bibfiles of loaded child
 257         /// documents), needed for appropriate update of natbib labels.
 258         mutable support::FileNameList bibfiles_cache_;
 259
 260         // FIXME The caching mechanism could be improved. At present, we have a
 261         // cache for each Buffer, that caches all the bibliography info for that
 262         // Buffer. A more efficient solution would be to have a global cache per
 263         // file, and then to construct the Buffer's bibinfo from that.
 264         /// A cache for bibliography info
 265         mutable BiblioInfo bibinfo_;
 266         /// whether the bibinfo cache is valid
 267         mutable bool bibinfo_cache_valid_;
 268         /// whether the bibfile cache is valid
 269         mutable bool bibfile_cache_valid_;
 270         /// Cache of timestamps of .bib files
 271         map<FileName, time_t> bibfile_status_;
 272         /// Indicates whether the bibinfo has changed since the last time
 273         /// we ran updateBuffer(), i.e., whether citation labels may need
 274         /// to be updated.
 275         mutable bool cite_labels_valid_;
 276
 277         mutable RefCache ref_cache_;
 278
 279         /// our Text that should be wrapped in an InsetText
 280         InsetText * inset;
 281
 282         ///
 283         PreviewLoader * preview_loader_;
 284
 285         /// This is here to force the test to be done whenever parent_buffer
 286         /// is accessed.
 287         Buffer const * parent() const
 288         {
 289                 // ignore_parent temporarily "orphans" a buffer
 290                 // (e.g. if a child is compiled standalone)
 291                 if (ignore_parent)
 292                         return 0;
 293                 // if parent_buffer is not loaded, then it has been unloaded,
 294                 // which means that parent_buffer is an invalid pointer. So we
 295                 // set it to null in that case.
 296                 // however, the BufferList doesn't know about cloned buffers, so
 297                 // they will always be regarded as unloaded. in that case, we hope
 298                 // for the best.
 299                 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
 300                         parent_buffer = 0;
 301                 return parent_buffer;
 302         }
 303
 304         ///
 305         void setParent(Buffer const * pb)
 306         {
 307                 if (parent_buffer == pb)
 308                         // nothing to do
 309                         return;
 310                 if (!cloned_buffer_ && parent_buffer && pb)
 311                         LYXERR0("Warning: a buffer should not have two parents!");
 312                 parent_buffer = pb;
 313                 if (!cloned_buffer_ && parent_buffer) {
 314                         parent_buffer->invalidateBibfileCache();
 315                         parent_buffer->invalidateBibinfoCache();
 316                 }
 317         }
 318
 319         /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
 320         /// This one is useful for preview detached in a thread.
 321         Buffer const * cloned_buffer_;
 322         ///
 323         CloneList * clone_list_;
 324         /// are we in the process of exporting this buffer?
 325         mutable bool doing_export;
 326
 327         /// compute statistics
 328         /// \p from initial position
 329         /// \p to points to the end position
 330         void updateStatistics(DocIterator & from, DocIterator & to,
 331                               bool skipNoOutput = true);
 332         /// statistics accessor functions
 333         int wordCount() const
 334         {
 335                 return word_count_;
 336         }
 337         int charCount(bool with_blanks) const
 338         {
 339                 return char_count_
 340                 + (with_blanks ? blank_count_ : 0);
 341         }
 342
 343 private:
 344         /// So we can force access via the accessors.
 345         mutable Buffer const * parent_buffer;
 346
 347         int word_count_;
 348         int char_count_;
 349         int blank_count_;
 350
 351 };
 352
 353
 354 /// Creates the per buffer temporary directory
 355 static FileName createBufferTmpDir()
 356 {
 357         static int count;
 358         // We are in our own directory.  Why bother to mangle name?
 359         // In fact I wrote this code to circumvent a problematic behaviour
 360         // (bug?) of EMX mkstemp().
 361         FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
 362                 convert<string>(count++));
 363
 364         if (!tmpfl.createDirectory(0777)) {
 365                 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
 366                         _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
 367                         from_utf8(tmpfl.absFileName())));
 368         }
 369         return tmpfl;
 370 }
 371
 372
 373 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
 374         Buffer const * cloned_buffer)
 375         : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
 376           internal_buffer(false), read_only(readonly_), filename(file),
 377           file_fully_loaded(false), ignore_parent(false), toc_backend(owner),
 378           macro_lock(false), timestamp_(0), checksum_(0), wa_(0), gui_(0),
 379           undo_(*owner), bibinfo_cache_valid_(false), bibfile_cache_valid_(false),
 380           cite_labels_valid_(false), preview_loader_(0),
 381           cloned_buffer_(cloned_buffer), clone_list_(0),
 382           doing_export(false), parent_buffer(0)
 383 {
 384         if (!cloned_buffer_) {
 385                 temppath = createBufferTmpDir();
 386                 lyxvc.setBuffer(owner_);
 387                 if (use_gui)
 388                         wa_ = new frontend::WorkAreaManager;
 389                 return;
 390         }
 391         temppath = cloned_buffer_->d->temppath;
 392         file_fully_loaded = true;
 393         params = cloned_buffer_->d->params;
 394         bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
 395         bibinfo_ = cloned_buffer_->d->bibinfo_;
 396         bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
 397         bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
 398         bibfile_status_ = cloned_buffer_->d->bibfile_status_;
 399         cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
 400         unnamed = cloned_buffer_->d->unnamed;
 401         internal_buffer = cloned_buffer_->d->internal_buffer;
 402 }
 403
 404
 405 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
 406         : d(new Impl(this, FileName(file), readonly, cloned_buffer))
 407 {
 408         LYXERR(Debug::INFO, "Buffer::Buffer()");
 409         if (cloned_buffer) {
 410                 d->inset = new InsetText(*cloned_buffer->d->inset);
 411                 d->inset->setBuffer(*this);
 412                 // FIXME: optimize this loop somewhat, maybe by creating a new
 413                 // general recursive Inset::setId().
 414                 DocIterator it = doc_iterator_begin(this);
 415                 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
 416                 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
 417                         it.paragraph().setId(cloned_it.paragraph().id());
 418         } else
 419                 d->inset = new InsetText(this);
 420         d->inset->setAutoBreakRows(true);
 421         d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
 422 }
 423
 424
 425 Buffer::~Buffer()
 426 {
 427         LYXERR(Debug::INFO, "Buffer::~Buffer()");
 428         // here the buffer should take care that it is
 429         // saved properly, before it goes into the void.
 430
 431         // GuiView already destroyed
 432         d->gui_ = 0;
 433
 434         if (isInternal()) {
 435                 // No need to do additional cleanups for internal buffer.
 436                 delete d;
 437                 return;
 438         }
 439
 440         if (isClone()) {
 441                 // this is in case of recursive includes: we won't try to delete
 442                 // ourselves as a child.
 443                 d->clone_list_->erase(this);
 444                 // loop over children
 445                 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
 446                 Impl::BufferPositionMap::iterator end = d->children_positions.end();
 447                 for (; it != end; ++it) {
 448                         Buffer * child = const_cast<Buffer *>(it->first);
 449                                 if (d->clone_list_->erase(child))
 450                                         delete child;
 451                 }
 452                 // if we're the master buffer, then we should get rid of the list
 453                 // of clones
 454                 if (!parent()) {
 455                         // If this is not empty, we have leaked something. Worse, one of the
 456                         // children still has a reference to this list. But we will try to
 457                         // continue, rather than shut down.
 458                         LATTEST(d->clone_list_->empty());
 459                         list<CloneList *>::iterator it =
 460                                 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
 461                         if (it == cloned_buffers.end()) {
 462                                 // We will leak in this case, but it is safe to continue.
 463                                 LATTEST(false);
 464                         } else
 465                                 cloned_buffers.erase(it);
 466                         delete d->clone_list_;
 467                 }
 468                 // FIXME Do we really need to do this right before we delete d?
 469                 // clear references to children in macro tables
 470                 d->children_positions.clear();
 471                 d->position_to_children.clear();
 472         } else {
 473                 // loop over children
 474                 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
 475                 Impl::BufferPositionMap::iterator end = d->children_positions.end();
 476                 for (; it != end; ++it) {
 477                         Buffer * child = const_cast<Buffer *>(it->first);
 478                         if (theBufferList().isLoaded(child))
 479                                 theBufferList().releaseChild(this, child);
 480                 }
 481
 482                 if (!isClean()) {
 483                         docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
 484                         msg += emergencyWrite();
 485                         Alert::warning(_("Attempting to close changed document!"), msg);
 486                 }
 487
 488                 // FIXME Do we really need to do this right before we delete d?
 489                 // clear references to children in macro tables
 490                 d->children_positions.clear();
 491                 d->position_to_children.clear();
 492
 493                 if (!d->temppath.destroyDirectory()) {
 494                         Alert::warning(_("Could not remove temporary directory"),
 495                                 bformat(_("Could not remove the temporary directory %1$s"),
 496                                 from_utf8(d->temppath.absFileName())));
 497                 }
 498                 removePreviews();
 499         }
 500
 501         delete d;
 502 }
 503
 504
 505 Buffer * Buffer::cloneFromMaster() const
 506 {
 507         BufferMap bufmap;
 508         cloned_buffers.push_back(new CloneList);
 509         CloneList * clones = cloned_buffers.back();
 510
 511         masterBuffer()->cloneWithChildren(bufmap, clones);
 512
 513         // make sure we got cloned
 514         BufferMap::const_iterator bit = bufmap.find(this);
 515         LASSERT(bit != bufmap.end(), return 0);
 516         Buffer * cloned_buffer = bit->second;
 517
 518         return cloned_buffer;
 519 }
 520
 521
 522 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
 523 {
 524         // have we already been cloned?
 525         if (bufmap.find(this) != bufmap.end())
 526                 return;
 527
 528         Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
 529
 530         // The clone needs its own DocumentClass, since running updateBuffer() will
 531         // modify it, and we would otherwise be sharing it with the original Buffer.
 532         buffer_clone->params().makeDocumentClass();
 533         ErrorList el;
 534         cap::switchBetweenClasses(
 535                         params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
 536                         static_cast<InsetText &>(buffer_clone->inset()), el);
 537
 538         bufmap[this] = buffer_clone;
 539         clones->insert(buffer_clone);
 540         buffer_clone->d->clone_list_ = clones;
 541         buffer_clone->d->macro_lock = true;
 542         buffer_clone->d->children_positions.clear();
 543
 544         // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
 545         // math macro caches need to be rethought and simplified.
 546         // I am not sure wether we should handle Buffer cloning here or in BufferList.
 547         // Right now BufferList knows nothing about buffer clones.
 548         Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
 549         Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
 550         for (; it != end; ++it) {
 551                 DocIterator dit = it->first.clone(buffer_clone);
 552                 dit.setBuffer(buffer_clone);
 553                 Buffer * child = const_cast<Buffer *>(it->second.second);
 554
 555                 child->cloneWithChildren(bufmap, clones);
 556                 BufferMap::iterator const bit = bufmap.find(child);
 557                 LASSERT(bit != bufmap.end(), continue);
 558                 Buffer * child_clone = bit->second;
 559
 560                 Inset * inset = dit.nextInset();
 561                 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
 562                 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
 563                 inset_inc->setChildBuffer(child_clone);
 564                 child_clone->d->setParent(buffer_clone);
 565                 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
 566                 buffer_clone->setChild(dit, child_clone);
 567         }
 568         buffer_clone->d->macro_lock = false;
 569         return;
 570 }
 571
 572
 573 Buffer * Buffer::cloneBufferOnly() const {
 574         cloned_buffers.push_back(new CloneList);
 575         CloneList * clones = cloned_buffers.back();
 576         Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
 577
 578         // The clone needs its own DocumentClass, since running updateBuffer() will
 579         // modify it, and we would otherwise be sharing it with the original Buffer.
 580         buffer_clone->params().makeDocumentClass();
 581         ErrorList el;
 582         cap::switchBetweenClasses(
 583                         params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
 584                         static_cast<InsetText &>(buffer_clone->inset()), el);
 585
 586         clones->insert(buffer_clone);
 587         buffer_clone->d->clone_list_ = clones;
 588
 589         // we won't be cloning the children
 590         buffer_clone->d->children_positions.clear();
 591         return buffer_clone;
 592 }
 593
 594
 595 bool Buffer::isClone() const
 596 {
 597         return d->cloned_buffer_;
 598 }
 599
 600
 601 void Buffer::changed(bool update_metrics) const
 602 {
 603         if (d->wa_)
 604                 d->wa_->redrawAll(update_metrics);
 605 }
 606
 607
 608 frontend::WorkAreaManager & Buffer::workAreaManager() const
 609 {
 610         LBUFERR(d->wa_);
 611         return *d->wa_;
 612 }
 613
 614
 615 Text & Buffer::text() const
 616 {
 617         return d->inset->text();
 618 }
 619
 620
 621 Inset & Buffer::inset() const
 622 {
 623         return *d->inset;
 624 }
 625
 626
 627 BufferParams & Buffer::params()
 628 {
 629         return d->params;
 630 }
 631
 632
 633 BufferParams const & Buffer::params() const
 634 {
 635         return d->params;
 636 }
 637
 638
 639 ParagraphList & Buffer::paragraphs()
 640 {
 641         return text().paragraphs();
 642 }
 643
 644
 645 ParagraphList const & Buffer::paragraphs() const
 646 {
 647         return text().paragraphs();
 648 }
 649
 650
 651 LyXVC & Buffer::lyxvc()
 652 {
 653         return d->lyxvc;
 654 }
 655
 656
 657 LyXVC const & Buffer::lyxvc() const
 658 {
 659         return d->lyxvc;
 660 }
 661
 662
 663 string const Buffer::temppath() const
 664 {
 665         return d->temppath.absFileName();
 666 }
 667
 668
 669 TexRow & Buffer::texrow()
 670 {
 671         return d->texrow;
 672 }
 673
 674
 675 TexRow const & Buffer::texrow() const
 676 {
 677         return d->texrow;
 678 }
 679
 680
 681 TocBackend & Buffer::tocBackend() const
 682 {
 683         return d->toc_backend;
 684 }
 685
 686
 687 Undo & Buffer::undo()
 688 {
 689         return d->undo_;
 690 }
 691
 692
 693 void Buffer::setChild(DocIterator const & dit, Buffer * child)
 694 {
 695         d->children_positions[child] = dit;
 696 }
 697
 698
 699 string Buffer::latexName(bool const no_path) const
 700 {
 701         FileName latex_name =
 702                 makeLatexName(d->exportFileName());
 703         return no_path ? latex_name.onlyFileName()
 704                 : latex_name.absFileName();
 705 }
 706
 707
 708 FileName Buffer::Impl::exportFileName() const
 709 {
 710         docstring const branch_suffix =
 711                 params.branchlist().getFileNameSuffix();
 712         if (branch_suffix.empty())
 713                 return filename;
 714
 715         string const name = filename.onlyFileNameWithoutExt()
 716                 + to_utf8(branch_suffix);
 717         FileName res(filename.onlyPath().absFileName() + "/" + name);
 718         res.changeExtension(filename.extension());
 719
 720         return res;
 721 }
 722
 723
 724 string Buffer::logName(LogType * type) const
 725 {
 726         string const filename = latexName(false);
 727
 728         if (filename.empty()) {
 729                 if (type)
 730                         *type = latexlog;
 731                 return string();
 732         }
 733
 734         string const path = temppath();
 735
 736         FileName const fname(addName(temppath(),
 737                                      onlyFileName(changeExtension(filename,
 738                                                                   ".log"))));
 739
 740         // FIXME: how do we know this is the name of the build log?
 741         FileName const bname(
 742                 addName(path, onlyFileName(
 743                         changeExtension(filename,
 744                                         formats.extension(params().bufferFormat()) + ".out"))));
 745
 746         // Also consider the master buffer log file
 747         FileName masterfname = fname;
 748         LogType mtype;
 749         if (masterBuffer() != this) {
 750                 string const mlogfile = masterBuffer()->logName(&mtype);
 751                 masterfname = FileName(mlogfile);
 752         }
 753
 754         // If no Latex log or Build log is newer, show Build log
 755         if (bname.exists() &&
 756             ((!fname.exists() && !masterfname.exists())
 757              || (fname.lastModified() < bname.lastModified()
 758                  && masterfname.lastModified() < bname.lastModified()))) {
 759                 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
 760                 if (type)
 761                         *type = buildlog;
 762                 return bname.absFileName();
 763         // If we have a newer master file log or only a master log, show this
 764         } else if (fname != masterfname
 765                    && (!fname.exists() && (masterfname.exists()
 766                    || fname.lastModified() < masterfname.lastModified()))) {
 767                 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
 768                 if (type)
 769                         *type = mtype;
 770                 return masterfname.absFileName();
 771         }
 772         LYXERR(Debug::FILES, "Log name calculated as: " << fname);
 773         if (type)
 774                         *type = latexlog;
 775         return fname.absFileName();
 776 }
 777
 778
 779 void Buffer::setReadonly(bool const flag)
 780 {
 781         if (d->read_only != flag) {
 782                 d->read_only = flag;
 783                 changed(false);
 784         }
 785 }
 786
 787
 788 void Buffer::setFileName(FileName const & fname)
 789 {
 790         bool const changed = fname != d->filename;
 791         d->filename = fname;
 792         if (changed)
 793                 lyxvc().file_found_hook(fname);
 794         setReadonly(d->filename.isReadOnly());
 795         saveCheckSum();
 796         updateTitles();
 797 }
 798
 799
 800 int Buffer::readHeader(Lexer & lex)
 801 {
 802         int unknown_tokens = 0;
 803         int line = -1;
 804         int begin_header_line = -1;
 805
 806         // Initialize parameters that may be/go lacking in header:
 807         params().branchlist().clear();
 808         params().preamble.erase();
 809         params().options.erase();
 810         params().master.erase();
 811         params().float_placement.erase();
 812         params().paperwidth.erase();
 813         params().paperheight.erase();
 814         params().leftmargin.erase();
 815         params().rightmargin.erase();
 816         params().topmargin.erase();
 817         params().bottommargin.erase();
 818         params().headheight.erase();
 819         params().headsep.erase();
 820         params().footskip.erase();
 821         params().columnsep.erase();
 822         params().fonts_cjk.erase();
 823         params().listings_params.clear();
 824         params().clearLayoutModules();
 825         params().clearRemovedModules();
 826         params().clearIncludedChildren();
 827         params().pdfoptions().clear();
 828         params().indiceslist().clear();
 829         params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
 830         params().isbackgroundcolor = false;
 831         params().fontcolor = RGBColor(0, 0, 0);
 832         params().isfontcolor = false;
 833         params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
 834         params().boxbgcolor = RGBColor(0xFF, 0, 0);
 835         params().html_latex_start.clear();
 836         params().html_latex_end.clear();
 837         params().html_math_img_scale = 1.0;
 838         params().output_sync_macro.erase();
 839         params().setLocalLayout(string(), false);
 840         params().setLocalLayout(string(), true);
 841
 842         for (int i = 0; i < 4; ++i) {
 843                 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
 844                 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
 845         }
 846
 847         ErrorList & errorList = d->errorLists["Parse"];
 848
 849         while (lex.isOK()) {
 850                 string token;
 851                 lex >> token;
 852
 853                 if (token.empty())
 854                         continue;
 855
 856                 if (token == "\\end_header")
 857                         break;
 858
 859                 ++line;
 860                 if (token == "\\begin_header") {
 861                         begin_header_line = line;
 862                         continue;
 863                 }
 864
 865                 LYXERR(Debug::PARSER, "Handling document header token: `"
 866                                       << token << '\'');
 867
 868                 string unknown = params().readToken(lex, token, d->filename.onlyPath());
 869                 if (!unknown.empty()) {
 870                         if (unknown[0] != '\\' && token == "\\textclass") {
 871                                 Alert::warning(_("Unknown document class"),
 872                        bformat(_("Using the default document class, because the "
 873                                               "class %1$s is unknown."), from_utf8(unknown)));
 874                         } else {
 875                                 ++unknown_tokens;
 876                                 docstring const s = bformat(_("Unknown token: "
 877                                                                         "%1$s %2$s\n"),
 878                                                          from_utf8(token),
 879                                                          lex.getDocString());
 880                                 errorList.push_back(ErrorItem(_("Document header error"),
 881                                         s, -1, 0, 0));
 882                         }
 883                 }
 884         }
 885         if (begin_header_line) {
 886                 docstring const s = _("\\begin_header is missing");
 887                 errorList.push_back(ErrorItem(_("Document header error"),
 888                         s, -1, 0, 0));
 889         }
 890
 891         params().makeDocumentClass();
 892
 893         return unknown_tokens;
 894 }
 895
 896
 897 // Uwe C. Schroeder
 898 // changed to be public and have one parameter
 899 // Returns true if "\end_document" is not read (Asger)
 900 bool Buffer::readDocument(Lexer & lex)
 901 {
 902         ErrorList & errorList = d->errorLists["Parse"];
 903         errorList.clear();
 904
 905         // remove dummy empty par
 906         paragraphs().clear();
 907
 908         if (!lex.checkFor("\\begin_document")) {
 909                 docstring const s = _("\\begin_document is missing");
 910                 errorList.push_back(ErrorItem(_("Document header error"),
 911                         s, -1, 0, 0));
 912         }
 913
 914         readHeader(lex);
 915
 916         if (params().outputChanges) {
 917                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
 918                 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
 919                                   LaTeXFeatures::isAvailable("xcolor");
 920
 921                 if (!dvipost && !xcolorulem) {
 922                         Alert::warning(_("Changes not shown in LaTeX output"),
 923                                        _("Changes will not be highlighted in LaTeX output, "
 924                                          "because neither dvipost nor xcolor/ulem are installed.\n"
 925                                          "Please install these packages or redefine "
 926                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 927                 } else if (!xcolorulem) {
 928                         Alert::warning(_("Changes not shown in LaTeX output"),
 929                                        _("Changes will not be highlighted in LaTeX output "
 930                                          "when using pdflatex, because xcolor and ulem are not installed.\n"
 931                                          "Please install both packages or redefine "
 932                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 933                 }
 934         }
 935
 936         if (!params().master.empty()) {
 937                 FileName const master_file = makeAbsPath(params().master,
 938                            onlyPath(absFileName()));
 939                 if (isLyXFileName(master_file.absFileName())) {
 940                         Buffer * master =
 941                                 checkAndLoadLyXFile(master_file, true);
 942                         if (master) {
 943                                 // necessary e.g. after a reload
 944                                 // to re-register the child (bug 5873)
 945                                 // FIXME: clean up updateMacros (here, only
 946                                 // child registering is needed).
 947                                 master->updateMacros();
 948                                 // set master as master buffer, but only
 949                                 // if we are a real child
 950                                 if (master->isChild(this))
 951                                         setParent(master);
 952                                 // if the master is not fully loaded
 953                                 // it is probably just loading this
 954                                 // child. No warning needed then.
 955                                 else if (master->isFullyLoaded())
 956                                         LYXERR0("The master '"
 957                                                 << params().master
 958                                                 << "' assigned to this document ("
 959                                                 << absFileName()
 960                                                 << ") does not include "
 961                                                 "this document. Ignoring the master assignment.");
 962                         }
 963                 }
 964         }
 965
 966         // assure we have a default index
 967         params().indiceslist().addDefault(B_("Index"));
 968
 969         // read main text
 970         bool const res = text().read(lex, errorList, d->inset);
 971
 972         // inform parent buffer about local macros
 973         if (parent()) {
 974                 Buffer const * pbuf = parent();
 975                 UserMacroSet::const_iterator cit = usermacros.begin();
 976                 UserMacroSet::const_iterator end = usermacros.end();
 977                 for (; cit != end; ++cit)
 978                         pbuf->usermacros.insert(*cit);
 979         }
 980         usermacros.clear();
 981         updateMacros();
 982         updateMacroInstances(InternalUpdate);
 983         return res;
 984 }
 985
 986
 987 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
 988 {
 989         Format const * fmt = formats.getFormat(format);
 990         if (!fmt)
 991                 return false;
 992         // It is important to use the correct extension here, since some
 993         // converters create a wrong output file otherwise (e.g. html2latex)
 994         TempFile const tempfile("Buffer_importStringXXXXXX." + fmt->extension());
 995         FileName const name(tempfile.name());
 996         ofdocstream os(name.toFilesystemEncoding().c_str());
 997         bool const success = (os << contents);
 998         os.close();
 999
1000         bool converted = false;
1001         if (success) {
1002                 params().compressed = false;
1003
1004                 // remove dummy empty par
1005                 paragraphs().clear();
1006
1007                 converted = importFile(format, name, errorList);
1008         }
1009
1010         if (name.exists())
1011                 name.removeFile();
1012         return converted;
1013 }
1014
1015
1016 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1017 {
1018         if (!theConverters().isReachable(format, "lyx"))
1019                 return false;
1020
1021         TempFile const tempfile("Buffer_importFileXXXXXX.lyx");
1022         FileName const lyx(tempfile.name());
1023         if (theConverters().convert(0, name, lyx, name, format, "lyx", errorList))
1024                 return readFile(lyx) == ReadSuccess;
1025
1026         return false;
1027 }
1028
1029
1030 bool Buffer::readString(string const & s)
1031 {
1032         params().compressed = false;
1033
1034         Lexer lex;
1035         istringstream is(s);
1036         lex.setStream(is);
1037         FileName const fn = FileName::tempName("Buffer_readString");
1038
1039         int file_format;
1040         bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1041
1042         if (success && file_format != LYX_FORMAT) {
1043                 // We need to call lyx2lyx, so write the input to a file
1044                 ofstream os(fn.toFilesystemEncoding().c_str());
1045                 os << s;
1046                 os.close();
1047                 // lyxvc in readFile
1048                 if (readFile(fn) != ReadSuccess)
1049                         success = false;
1050         }
1051         else if (success)
1052                 if (readDocument(lex))
1053                         success = false;
1054         if (fn.exists())
1055                 fn.removeFile();
1056         return success;
1057 }
1058
1059
1060 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1061 {
1062         FileName fname(fn);
1063         Lexer lex;
1064         if (!lex.setFile(fname)) {
1065                 Alert::error(_("File Not Found"),
1066                         bformat(_("Unable to open file `%1$s'."),
1067                                 from_utf8(fn.absFileName())));
1068                 return ReadFileNotFound;
1069         }
1070
1071         int file_format;
1072         ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1073         if (ret_plf != ReadSuccess)
1074                 return ret_plf;
1075
1076         if (file_format != LYX_FORMAT) {
1077                 FileName tmpFile;
1078                 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1079                 if (ret_clf != ReadSuccess)
1080                         return ret_clf;
1081                 return readFile(tmpFile);
1082         }
1083
1084         // FIXME: InsetInfo needs to know whether the file is under VCS
1085         // during the parse process, so this has to be done before.
1086         lyxvc().file_found_hook(d->filename);
1087
1088         if (readDocument(lex)) {
1089                 Alert::error(_("Document format failure"),
1090                         bformat(_("%1$s ended unexpectedly, which means"
1091                                 " that it is probably corrupted."),
1092                                         from_utf8(fn.absFileName())));
1093                 return ReadDocumentFailure;
1094         }
1095
1096         d->file_fully_loaded = true;
1097         d->read_only = !d->filename.isWritable();
1098         params().compressed = formats.isZippedFile(d->filename);
1099         saveCheckSum();
1100         return ReadSuccess;
1101 }
1102
1103
1104 bool Buffer::isFullyLoaded() const
1105 {
1106         return d->file_fully_loaded;
1107 }
1108
1109
1110 void Buffer::setFullyLoaded(bool value)
1111 {
1112         d->file_fully_loaded = value;
1113 }
1114
1115
1116 PreviewLoader * Buffer::loader() const
1117 {
1118         if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1119                 return 0;
1120         if (!d->preview_loader_)
1121                 d->preview_loader_ = new PreviewLoader(*this);
1122         return d->preview_loader_;
1123 }
1124
1125
1126 void Buffer::removePreviews() const
1127 {
1128         delete d->preview_loader_;
1129         d->preview_loader_ = 0;
1130 }
1131
1132
1133 void Buffer::updatePreviews() const
1134 {
1135         PreviewLoader * ploader = loader();
1136         if (!ploader)
1137                 return;
1138
1139         InsetIterator it = inset_iterator_begin(*d->inset);
1140         InsetIterator const end = inset_iterator_end(*d->inset);
1141         for (; it != end; ++it)
1142                 it->addPreview(it, *ploader);
1143
1144         ploader->startLoading();
1145 }
1146
1147
1148 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1149         FileName const & fn, int & file_format) const
1150 {
1151         if(!lex.checkFor("\\lyxformat")) {
1152                 Alert::error(_("Document format failure"),
1153                         bformat(_("%1$s is not a readable LyX document."),
1154                                 from_utf8(fn.absFileName())));
1155                 return ReadNoLyXFormat;
1156         }
1157
1158         string tmp_format;
1159         lex >> tmp_format;
1160
1161         // LyX formats 217 and earlier were written as 2.17. This corresponds
1162         // to files from LyX versions < 1.1.6.3. We just remove the dot in
1163         // these cases. See also: www.lyx.org/trac/changeset/1313.
1164         size_t dot = tmp_format.find_first_of(".,");
1165         if (dot != string::npos)
1166                 tmp_format.erase(dot, 1);
1167
1168         file_format = convert<int>(tmp_format);
1169         return ReadSuccess;
1170 }
1171
1172
1173 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1174         FileName & tmpfile, int from_format)
1175 {
1176         tmpfile = FileName::tempName("Buffer_convertLyXFormatXXXXXX.lyx");
1177         if(tmpfile.empty()) {
1178                 Alert::error(_("Conversion failed"),
1179                         bformat(_("%1$s is from a different"
1180                                 " version of LyX, but a temporary"
1181                                 " file for converting it could"
1182                                 " not be created."),
1183                                 from_utf8(fn.absFileName())));
1184                 return LyX2LyXNoTempFile;
1185         }
1186
1187         FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1188         if (lyx2lyx.empty()) {
1189                 Alert::error(_("Conversion script not found"),
1190                      bformat(_("%1$s is from a different"
1191                                " version of LyX, but the"
1192                                " conversion script lyx2lyx"
1193                                " could not be found."),
1194                                from_utf8(fn.absFileName())));
1195                 return LyX2LyXNotFound;
1196         }
1197
1198         // Run lyx2lyx:
1199         //   $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1200         ostringstream command;
1201         command << os::python()
1202                 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1203                 << " -t " << convert<string>(LYX_FORMAT)
1204                 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1205                 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1206         string const command_str = command.str();
1207
1208         LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1209
1210         cmd_ret const ret = runCommand(command_str);
1211         if (ret.first != 0) {
1212                 if (from_format < LYX_FORMAT) {
1213                         Alert::error(_("Conversion script failed"),
1214                                 bformat(_("%1$s is from an older version"
1215                                         " of LyX and the lyx2lyx script"
1216                                         " failed to convert it."),
1217                                         from_utf8(fn.absFileName())));
1218                         return LyX2LyXOlderFormat;
1219                 } else {
1220                         Alert::error(_("Conversion script failed"),
1221                                 bformat(_("%1$s is from a newer version"
1222                                         " of LyX and the lyx2lyx script"
1223                                         " failed to convert it."),
1224                                         from_utf8(fn.absFileName())));
1225                         return LyX2LyXNewerFormat;
1226                 }
1227         }
1228         return ReadSuccess;
1229 }
1230
1231
1232 // Should probably be moved to somewhere else: BufferView? GuiView?
1233 bool Buffer::save() const
1234 {
1235         docstring const file = makeDisplayPath(absFileName(), 20);
1236         d->filename.refresh();
1237
1238         // check the read-only status before moving the file as a backup
1239         if (d->filename.exists()) {
1240                 bool const read_only = !d->filename.isWritable();
1241                 if (read_only) {
1242                         Alert::warning(_("File is read-only"),
1243                                 bformat(_("The file %1$s cannot be written because it "
1244                                 "is marked as read-only."), file));
1245                         return false;
1246                 }
1247         }
1248
1249         // ask if the disk file has been externally modified (use checksum method)
1250         if (fileName().exists() && isExternallyModified(checksum_method)) {
1251                 docstring text =
1252                         bformat(_("Document %1$s has been externally modified. "
1253                                 "Are you sure you want to overwrite this file?"), file);
1254                 int const ret = Alert::prompt(_("Overwrite modified file?"),
1255                         text, 1, 1, _("&Overwrite"), _("&Cancel"));
1256                 if (ret == 1)
1257                         return false;
1258         }
1259
1260         // We don't need autosaves in the immediate future. (Asger)
1261         resetAutosaveTimers();
1262
1263         FileName backupName;
1264         bool madeBackup = false;
1265
1266         // make a backup if the file already exists
1267         if (lyxrc.make_backup && fileName().exists()) {
1268                 backupName = FileName(absFileName() + '~');
1269                 if (!lyxrc.backupdir_path.empty()) {
1270                         string const mangledName =
1271                                 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1272                         backupName = FileName(addName(lyxrc.backupdir_path,
1273                                                       mangledName));
1274                 }
1275
1276                 // Except file is symlink do not copy because of #6587.
1277                 // Hard links have bad luck.
1278                 if (fileName().isSymLink())
1279                         madeBackup = fileName().copyTo(backupName);
1280                 else
1281                         madeBackup = fileName().moveTo(backupName);
1282
1283                 if (!madeBackup) {
1284                         Alert::error(_("Backup failure"),
1285                                      bformat(_("Cannot create backup file %1$s.\n"
1286                                                "Please check whether the directory exists and is writable."),
1287                                              from_utf8(backupName.absFileName())));
1288                         //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1289                 }
1290         }
1291
1292         if (writeFile(d->filename)) {
1293                 markClean();
1294                 return true;
1295         } else {
1296                 // Saving failed, so backup is not backup
1297                 if (madeBackup)
1298                         backupName.moveTo(d->filename);
1299                 return false;
1300         }
1301 }
1302
1303
1304 bool Buffer::writeFile(FileName const & fname) const
1305 {
1306         if (d->read_only && fname == d->filename)
1307                 return false;
1308
1309         bool retval = false;
1310
1311         docstring const str = bformat(_("Saving document %1$s..."),
1312                 makeDisplayPath(fname.absFileName()));
1313         message(str);
1314
1315         string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1316
1317         if (params().compressed) {
1318                 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1319                 retval = ofs && write(ofs);
1320         } else {
1321                 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1322                 retval = ofs && write(ofs);
1323         }
1324
1325         if (!retval) {
1326                 message(str + _(" could not write file!"));
1327                 return false;
1328         }
1329
1330         // see bug 6587
1331         // removeAutosaveFile();
1332
1333         saveCheckSum();
1334         message(str + _(" done."));
1335
1336         return true;
1337 }
1338
1339
1340 docstring Buffer::emergencyWrite()
1341 {
1342         // No need to save if the buffer has not changed.
1343         if (isClean())
1344                 return docstring();
1345
1346         string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1347
1348         docstring user_message = bformat(
1349                 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1350
1351         // We try to save three places:
1352         // 1) Same place as document. Unless it is an unnamed doc.
1353         if (!isUnnamed()) {
1354                 string s = absFileName();
1355                 s += ".emergency";
1356                 LYXERR0("  " << s);
1357                 if (writeFile(FileName(s))) {
1358                         markClean();
1359                         user_message += "  " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1360                         return user_message;
1361                 } else {
1362                         user_message += "  " + _("Save failed! Trying again...\n");
1363                 }
1364         }
1365
1366         // 2) In HOME directory.
1367         string s = addName(Package::get_home_dir().absFileName(), absFileName());
1368         s += ".emergency";
1369         lyxerr << ' ' << s << endl;
1370         if (writeFile(FileName(s))) {
1371                 markClean();
1372                 user_message += "  " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1373                 return user_message;
1374         }
1375
1376         user_message += "  " + _("Save failed! Trying yet again...\n");
1377
1378         // 3) In "/tmp" directory.
1379         // MakeAbsPath to prepend the current
1380         // drive letter on OS/2
1381         s = addName(package().temp_dir().absFileName(), absFileName());
1382         s += ".emergency";
1383         lyxerr << ' ' << s << endl;
1384         if (writeFile(FileName(s))) {
1385                 markClean();
1386                 user_message += "  " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1387                 return user_message;
1388         }
1389
1390         user_message += "  " + _("Save failed! Bummer. Document is lost.");
1391         // Don't try again.
1392         markClean();
1393         return user_message;
1394 }
1395
1396
1397 bool Buffer::write(ostream & ofs) const
1398 {
1399 #ifdef HAVE_LOCALE
1400         // Use the standard "C" locale for file output.
1401         ofs.imbue(locale::classic());
1402 #endif
1403
1404         // The top of the file should not be written by params().
1405
1406         // write out a comment in the top of the file
1407         ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1408             << " created this file. For more info see http://www.lyx.org/\n"
1409             << "\\lyxformat " << LYX_FORMAT << "\n"
1410             << "\\begin_document\n";
1411
1412         /// For each author, set 'used' to true if there is a change
1413         /// by this author in the document; otherwise set it to 'false'.
1414         AuthorList::Authors::const_iterator a_it = params().authors().begin();
1415         AuthorList::Authors::const_iterator a_end = params().authors().end();
1416         for (; a_it != a_end; ++a_it)
1417                 a_it->setUsed(false);
1418
1419         ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1420         ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1421         for ( ; it != end; ++it)
1422                 it->checkAuthors(params().authors());
1423
1424         // now write out the buffer parameters.
1425         ofs << "\\begin_header\n";
1426         params().writeFile(ofs);
1427         ofs << "\\end_header\n";
1428
1429         // write the text
1430         ofs << "\n\\begin_body\n";
1431         text().write(ofs);
1432         ofs << "\n\\end_body\n";
1433
1434         // Write marker that shows file is complete
1435         ofs << "\\end_document" << endl;
1436
1437         // Shouldn't really be needed....
1438         //ofs.close();
1439
1440         // how to check if close went ok?
1441         // Following is an attempt... (BE 20001011)
1442
1443         // good() returns false if any error occured, including some
1444         //        formatting error.
1445         // bad()  returns true if something bad happened in the buffer,
1446         //        which should include file system full errors.
1447
1448         bool status = true;
1449         if (!ofs) {
1450                 status = false;
1451                 lyxerr << "File was not closed properly." << endl;
1452         }
1453
1454         return status;
1455 }
1456
1457
1458 bool Buffer::makeLaTeXFile(FileName const & fname,
1459                            string const & original_path,
1460                            OutputParams const & runparams_in,
1461                            OutputWhat output) const
1462 {
1463         OutputParams runparams = runparams_in;
1464
1465         // This is necessary for LuaTeX/XeTeX with tex fonts.
1466         // See FIXME in BufferParams::encoding()
1467         if (runparams.isFullUnicode())
1468                 runparams.encoding = encodings.fromLyXName("utf8-plain");
1469
1470         string const encoding = runparams.encoding->iconvName();
1471         LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1472
1473         ofdocstream ofs;
1474         try { ofs.reset(encoding); }
1475         catch (iconv_codecvt_facet_exception const & e) {
1476                 lyxerr << "Caught iconv exception: " << e.what() << endl;
1477                 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1478                         "verify that the support software for your encoding (%1$s) is "
1479                         "properly installed"), from_ascii(encoding)));
1480                 return false;
1481         }
1482         if (!openFileWrite(ofs, fname))
1483                 return false;
1484
1485         //TexStream ts(ofs.rdbuf(), &texrow());
1486         ErrorList & errorList = d->errorLists["Export"];
1487         errorList.clear();
1488         bool failed_export = false;
1489         otexstream os(ofs, d->texrow);
1490
1491         // make sure we are ready to export
1492         // this needs to be done before we validate
1493         // FIXME Do we need to do this all the time? I.e., in children
1494         // of a master we are exporting?
1495         updateBuffer();
1496         updateMacroInstances(OutputUpdate);
1497
1498         try {
1499                 os.texrow().reset();
1500                 writeLaTeXSource(os, original_path, runparams, output);
1501         }
1502         catch (EncodingException const & e) {
1503                 odocstringstream ods;
1504                 ods.put(e.failed_char);
1505                 ostringstream oss;
1506                 oss << "0x" << hex << e.failed_char << dec;
1507                 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1508                                           " (code point %2$s)"),
1509                                           ods.str(), from_utf8(oss.str()));
1510                 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1511                                 "representable in the chosen encoding.\n"
1512                                 "Changing the document encoding to utf8 could help."),
1513                                 e.par_id, e.pos, e.pos + 1));
1514                 failed_export = true;
1515         }
1516         catch (iconv_codecvt_facet_exception const & e) {
1517                 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1518                         _(e.what()), -1, 0, 0));
1519                 failed_export = true;
1520         }
1521         catch (exception const & e) {
1522                 errorList.push_back(ErrorItem(_("conversion failed"),
1523                         _(e.what()), -1, 0, 0));
1524                 failed_export = true;
1525         }
1526         catch (...) {
1527                 lyxerr << "Caught some really weird exception..." << endl;
1528                 lyx_exit(1);
1529         }
1530
1531         ofs.close();
1532         if (ofs.fail()) {
1533                 failed_export = true;
1534                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1535         }
1536
1537         errors("Export");
1538         return !failed_export;
1539 }
1540
1541
1542 void Buffer::writeLaTeXSource(otexstream & os,
1543                            string const & original_path,
1544                            OutputParams const & runparams_in,
1545                            OutputWhat output) const
1546 {
1547         // The child documents, if any, shall be already loaded at this point.
1548
1549         OutputParams runparams = runparams_in;
1550
1551         // If we are compiling a file standalone, even if this is the
1552         // child of some other buffer, let's cut the link here, so the
1553         // file is really independent and no concurring settings from
1554         // the master (e.g. branch state) interfere (see #8100).
1555         if (!runparams.is_child)
1556                 d->ignore_parent = true;
1557
1558         // Classify the unicode characters appearing in math insets
1559         Encodings::initUnicodeMath(*this);
1560
1561         // validate the buffer.
1562         LYXERR(Debug::LATEX, "  Validating buffer...");
1563         LaTeXFeatures features(*this, params(), runparams);
1564         validate(features);
1565         runparams.use_polyglossia = features.usePolyglossia();
1566         LYXERR(Debug::LATEX, "  Buffer validation done.");
1567
1568         bool const output_preamble =
1569                 output == FullSource || output == OnlyPreamble;
1570         bool const output_body =
1571                 output == FullSource || output == OnlyBody;
1572
1573         // The starting paragraph of the coming rows is the
1574         // first paragraph of the document. (Asger)
1575         if (output_preamble && runparams.nice) {
1576                 os << "%% LyX " << lyx_version << " created this file.  "
1577                         "For more info, see http://www.lyx.org/.\n"
1578                         "%% Do not edit unless you really know what "
1579                         "you are doing.\n";
1580         }
1581         LYXERR(Debug::INFO, "lyx document header finished");
1582
1583         // There are a few differences between nice LaTeX and usual files:
1584         // usual files have \batchmode and special input@path to allow
1585         // inclusion of figures specified by an explicitly relative path
1586         // (i.e., a path starting with './' or '../') with either \input or
1587         // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1588         // input@path is set when the actual parameter original_path is set.
1589         // This is done for usual tex-file, but not for nice-latex-file.
1590         // (Matthias 250696)
1591         // Note that input@path is only needed for something the user does
1592         // in the preamble, included .tex files or ERT, files included by
1593         // LyX work without it.
1594         if (output_preamble) {
1595                 if (!runparams.nice) {
1596                         // code for usual, NOT nice-latex-file
1597                         os << "\\batchmode\n"; // changed from \nonstopmode
1598                 }
1599                 if (!original_path.empty()) {
1600                         // FIXME UNICODE
1601                         // We don't know the encoding of inputpath
1602                         docstring const inputpath = from_utf8(original_path);
1603                         docstring uncodable_glyphs;
1604                         Encoding const * const enc = runparams.encoding;
1605                         if (enc) {
1606                                 for (size_t n = 0; n < inputpath.size(); ++n) {
1607                                         if (!enc->encodable(inputpath[n])) {
1608                                                 docstring const glyph(1, inputpath[n]);
1609                                                 LYXERR0("Uncodable character '"
1610                                                         << glyph
1611                                                         << "' in input path!");
1612                                                 uncodable_glyphs += glyph;
1613                                         }
1614                                 }
1615                         }
1616
1617                         // warn user if we found uncodable glyphs.
1618                         if (!uncodable_glyphs.empty()) {
1619                                 frontend::Alert::warning(
1620                                         _("Uncodable character in file path"),
1621                                         support::bformat(
1622                                           _("The path of your document\n"
1623                                             "(%1$s)\n"
1624                                             "contains glyphs that are unknown "
1625                                             "in the current document encoding "
1626                                             "(namely %2$s). This may result in "
1627                                             "incomplete output, unless "
1628                                             "TEXINPUTS contains the document "
1629                                             "directory and you don't use "
1630                                             "explicitly relative paths (i.e., "
1631                                             "paths starting with './' or "
1632                                             "'../') in the preamble or in ERT."
1633                                             "\n\nIn case of problems, choose "
1634                                             "an appropriate document encoding\n"
1635                                             "(such as utf8) or change the "
1636                                             "file path name."),
1637                                           inputpath, uncodable_glyphs));
1638                         } else {
1639                                 string docdir =
1640                                         support::latex_path(original_path);
1641                                 if (contains(docdir, '#')) {
1642                                         docdir = subst(docdir, "#", "\\#");
1643                                         os << "\\catcode`\\#=11"
1644                                               "\\def\\#{#}\\catcode`\\#=6\n";
1645                                 }
1646                                 if (contains(docdir, '%')) {
1647                                         docdir = subst(docdir, "%", "\\%");
1648                                         os << "\\catcode`\\%=11"
1649                                               "\\def\\%{%}\\catcode`\\%=14\n";
1650                                 }
1651                                 os << "\\makeatletter\n"
1652                                    << "\\def\\input@path{{"
1653                                    << docdir << "/}}\n"
1654                                    << "\\makeatother\n";
1655                         }
1656                 }
1657
1658                 // get parent macros (if this buffer has a parent) which will be
1659                 // written at the document begin further down.
1660                 MacroSet parentMacros;
1661                 listParentMacros(parentMacros, features);
1662
1663                 // Write the preamble
1664                 runparams.use_babel = params().writeLaTeX(os, features,
1665                                                           d->filename.onlyPath());
1666
1667                 runparams.use_japanese = features.isRequired("japanese");
1668
1669                 if (!output_body) {
1670                         // Restore the parenthood if needed
1671                         if (!runparams.is_child)
1672                                 d->ignore_parent = false;
1673                         return;
1674                 }
1675
1676                 // make the body.
1677                 os << "\\begin{document}\n";
1678
1679                 // output the parent macros
1680                 MacroSet::iterator it = parentMacros.begin();
1681                 MacroSet::iterator end = parentMacros.end();
1682                 for (; it != end; ++it) {
1683                         int num_lines = (*it)->write(os.os(), true);
1684                         os.texrow().newlines(num_lines);
1685                 }
1686
1687         } // output_preamble
1688
1689         os.texrow().start(paragraphs().begin()->id(), 0);
1690
1691         LYXERR(Debug::INFO, "preamble finished, now the body.");
1692
1693         // the real stuff
1694         latexParagraphs(*this, text(), os, runparams);
1695
1696         // Restore the parenthood if needed
1697         if (!runparams.is_child)
1698                 d->ignore_parent = false;
1699
1700         // add this just in case after all the paragraphs
1701         os << endl;
1702
1703         if (output_preamble) {
1704                 os << "\\end{document}\n";
1705                 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1706         } else {
1707                 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1708         }
1709         runparams_in.encoding = runparams.encoding;
1710
1711         // Just to be sure. (Asger)
1712         os.texrow().newline();
1713
1714         //for (int i = 0; i<d->texrow.rows(); i++) {
1715         // int id,pos;
1716         // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1717         //      lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1718         //}
1719
1720         LYXERR(Debug::INFO, "Finished making LaTeX file.");
1721         LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1722 }
1723
1724
1725 void Buffer::makeDocBookFile(FileName const & fname,
1726                               OutputParams const & runparams,
1727                               OutputWhat output) const
1728 {
1729         LYXERR(Debug::LATEX, "makeDocBookFile...");
1730
1731         ofdocstream ofs;
1732         if (!openFileWrite(ofs, fname))
1733                 return;
1734
1735         // make sure we are ready to export
1736         // this needs to be done before we validate
1737         updateBuffer();
1738         updateMacroInstances(OutputUpdate);
1739
1740         writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1741
1742         ofs.close();
1743         if (ofs.fail())
1744                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1745 }
1746
1747
1748 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1749                              OutputParams const & runparams,
1750                              OutputWhat output) const
1751 {
1752         LaTeXFeatures features(*this, params(), runparams);
1753         validate(features);
1754
1755         d->texrow.reset();
1756
1757         DocumentClass const & tclass = params().documentClass();
1758         string const top_element = tclass.latexname();
1759
1760         bool const output_preamble =
1761                 output == FullSource || output == OnlyPreamble;
1762         bool const output_body =
1763           output == FullSource || output == OnlyBody;
1764
1765         if (output_preamble) {
1766                 if (runparams.flavor == OutputParams::XML)
1767                         os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1768
1769                 // FIXME UNICODE
1770                 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1771
1772                 // FIXME UNICODE
1773                 if (! tclass.class_header().empty())
1774                         os << from_ascii(tclass.class_header());
1775                 else if (runparams.flavor == OutputParams::XML)
1776                         os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1777                             << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1778                 else
1779                         os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1780
1781                 docstring preamble = from_utf8(params().preamble);
1782                 if (runparams.flavor != OutputParams::XML ) {
1783                         preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1784                         preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1785                         preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1786                         preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1787                 }
1788
1789                 string const name = runparams.nice
1790                         ? changeExtension(absFileName(), ".sgml") : fname;
1791                 preamble += features.getIncludedFiles(name);
1792                 preamble += features.getLyXSGMLEntities();
1793
1794                 if (!preamble.empty()) {
1795                         os << "\n [ " << preamble << " ]";
1796                 }
1797                 os << ">\n\n";
1798         }
1799
1800         if (output_body) {
1801                 string top = top_element;
1802                 top += " lang=\"";
1803                 if (runparams.flavor == OutputParams::XML)
1804                         top += params().language->code();
1805                 else
1806                         top += params().language->code().substr(0, 2);
1807                 top += '"';
1808
1809                 if (!params().options.empty()) {
1810                         top += ' ';
1811                         top += params().options;
1812                 }
1813
1814                 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1815                                 << " file was created by LyX " << lyx_version
1816                                 << "\n  See http://www.lyx.org/ for more information -->\n";
1817
1818                 params().documentClass().counters().reset();
1819
1820                 sgml::openTag(os, top);
1821                 os << '\n';
1822                 docbookParagraphs(text(), *this, os, runparams);
1823                 sgml::closeTag(os, top_element);
1824         }
1825 }
1826
1827
1828 void Buffer::makeLyXHTMLFile(FileName const & fname,
1829                               OutputParams const & runparams) const
1830 {
1831         LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1832
1833         ofdocstream ofs;
1834         if (!openFileWrite(ofs, fname))
1835                 return;
1836
1837         // make sure we are ready to export
1838         // this has to be done before we validate
1839         updateBuffer(UpdateMaster, OutputUpdate);
1840         updateMacroInstances(OutputUpdate);
1841
1842         writeLyXHTMLSource(ofs, runparams, FullSource);
1843
1844         ofs.close();
1845         if (ofs.fail())
1846                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1847 }
1848
1849
1850 void Buffer::writeLyXHTMLSource(odocstream & os,
1851                              OutputParams const & runparams,
1852                              OutputWhat output) const
1853 {
1854         LaTeXFeatures features(*this, params(), runparams);
1855         validate(features);
1856         d->bibinfo_.makeCitationLabels(*this);
1857
1858         bool const output_preamble =
1859                 output == FullSource || output == OnlyPreamble;
1860         bool const output_body =
1861           output == FullSource || output == OnlyBody || output == IncludedFile;
1862
1863         if (output_preamble) {
1864                 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1865                    << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN\" \"http://www.w3.org/TR/2001/REC-MathML2-20010221/dtd/xhtml-math11-f.dtd\">\n"
1866                    // FIXME Language should be set properly.
1867                    << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1868                    << "<head>\n"
1869                    << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1870                    // FIXME Presumably need to set this right
1871                    << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1872
1873                 docstring const & doctitle = features.htmlTitle();
1874                 os << "<title>"
1875                    << (doctitle.empty() ?
1876                          from_ascii("LyX Document") :
1877                          html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
1878                    << "</title>\n";
1879
1880                 docstring styles = features.getTClassHTMLPreamble();
1881                 if (!styles.empty())
1882                         os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
1883
1884                 styles = from_utf8(features.getPreambleSnippets());
1885                 if (!styles.empty())
1886                         os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
1887
1888                 // we will collect CSS information in a stream, and then output it
1889                 // either here, as part of the header, or else in a separate file.
1890                 odocstringstream css;
1891                 styles = from_utf8(features.getCSSSnippets());
1892                 if (!styles.empty())
1893                         css << "/* LyX Provided Styles */\n" << styles << '\n';
1894
1895                 styles = features.getTClassHTMLStyles();
1896                 if (!styles.empty())
1897                         css << "/* Layout-provided Styles */\n" << styles << '\n';
1898
1899                 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
1900                 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
1901                 if (needfg || needbg) {
1902                                 css << "\nbody {\n";
1903                                 if (needfg)
1904                                    css << "  color: "
1905                                             << from_ascii(X11hexname(params().fontcolor))
1906                                             << ";\n";
1907                                 if (needbg)
1908                                    css << "  background-color: "
1909                                             << from_ascii(X11hexname(params().backgroundcolor))
1910                                             << ";\n";
1911                                 css << "}\n";
1912                 }
1913
1914                 docstring const dstyles = css.str();
1915                 if (!dstyles.empty()) {
1916                         bool written = false;
1917                         if (params().html_css_as_file) {
1918                                 // open a file for CSS info
1919                                 ofdocstream ocss;
1920                                 string const fcssname = addName(temppath(), "docstyle.css");
1921                                 FileName const fcssfile = FileName(fcssname);
1922                                 if (openFileWrite(ocss, fcssfile)) {
1923                                         ocss << dstyles;
1924                                         ocss.close();
1925                                         written = true;
1926                                         // write link to header
1927                                         os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
1928                                         // register file
1929                                         runparams.exportdata->addExternalFile("xhtml", fcssfile);
1930                                 }
1931                         }
1932                         // we are here if the CSS is supposed to be written to the header
1933                         // or if we failed to write it to an external file.
1934                         if (!written) {
1935                                 os << "<style type='text/css'>\n"
1936                                          << dstyles
1937                                          << "\n</style>\n";
1938                         }
1939                 }
1940                 os << "</head>\n";
1941         }
1942
1943         if (output_body) {
1944                 bool const output_body_tag = (output != IncludedFile);
1945                 if (output_body_tag)
1946                         os << "<body>\n";
1947                 XHTMLStream xs(os);
1948                 if (output != IncludedFile)
1949                         // if we're an included file, the counters are in the master.
1950                         params().documentClass().counters().reset();
1951                 xhtmlParagraphs(text(), *this, xs, runparams);
1952                 if (output_body_tag)
1953                         os << "</body>\n";
1954         }
1955
1956         if (output_preamble)
1957                 os << "</html>\n";
1958 }
1959
1960
1961 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1962 // Other flags: -wall -v0 -x
1963 int Buffer::runChktex()
1964 {
1965         setBusy(true);
1966
1967         // get LaTeX-Filename
1968         FileName const path(temppath());
1969         string const name = addName(path.absFileName(), latexName());
1970         string const org_path = filePath();
1971
1972         PathChanger p(path); // path to LaTeX file
1973         message(_("Running chktex..."));
1974
1975         // Generate the LaTeX file if neccessary
1976         OutputParams runparams(&params().encoding());
1977         runparams.flavor = OutputParams::LATEX;
1978         runparams.nice = false;
1979         runparams.linelen = lyxrc.plaintext_linelen;
1980         makeLaTeXFile(FileName(name), org_path, runparams);
1981
1982         TeXErrors terr;
1983         Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1984         int const res = chktex.run(terr); // run chktex
1985
1986         if (res == -1) {
1987                 Alert::error(_("chktex failure"),
1988                              _("Could not run chktex successfully."));
1989         } else {
1990                 ErrorList & errlist = d->errorLists["ChkTeX"];
1991                 errlist.clear();
1992                 bufferErrors(terr, errlist);
1993         }
1994
1995         setBusy(false);
1996
1997         errors("ChkTeX");
1998
1999         return res;
2000 }
2001
2002
2003 void Buffer::validate(LaTeXFeatures & features) const
2004 {
2005         // Validate the buffer params, but not for included
2006         // files, since they also use the parent buffer's
2007         // params (# 5941)
2008         if (!features.runparams().is_child)
2009                 params().validate(features);
2010
2011         for_each(paragraphs().begin(), paragraphs().end(),
2012                  bind(&Paragraph::validate, _1, ref(features)));
2013
2014         if (lyxerr.debugging(Debug::LATEX)) {
2015                 features.showStruct();
2016         }
2017 }
2018
2019
2020 void Buffer::getLabelList(vector<docstring> & list) const
2021 {
2022         // If this is a child document, use the master's list instead.
2023         if (parent()) {
2024                 masterBuffer()->getLabelList(list);
2025                 return;
2026         }
2027
2028         list.clear();
2029         Toc & toc = d->toc_backend.toc("label");
2030         TocIterator toc_it = toc.begin();
2031         TocIterator end = toc.end();
2032         for (; toc_it != end; ++toc_it) {
2033                 if (toc_it->depth() == 0)
2034                         list.push_back(toc_it->str());
2035         }
2036 }
2037
2038
2039 void Buffer::updateBibfilesCache(UpdateScope scope) const
2040 {
2041         // FIXME This is probably unnecssary, given where we call this.
2042         // If this is a child document, use the parent's cache instead.
2043         if (parent() && scope != UpdateChildOnly) {
2044                 masterBuffer()->updateBibfilesCache();
2045                 return;
2046         }
2047
2048         d->bibfiles_cache_.clear();
2049         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2050                 if (it->lyxCode() == BIBTEX_CODE) {
2051                         InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
2052                         support::FileNameList const bibfiles = inset.getBibFiles();
2053                         d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2054                                 bibfiles.begin(),
2055                                 bibfiles.end());
2056                 } else if (it->lyxCode() == INCLUDE_CODE) {
2057                         InsetInclude & inset = static_cast<InsetInclude &>(*it);
2058                         Buffer const * const incbuf = inset.getChildBuffer();
2059                         if (!incbuf)
2060                                 continue;
2061                         support::FileNameList const & bibfiles =
2062                                         incbuf->getBibfilesCache(UpdateChildOnly);
2063                         if (!bibfiles.empty()) {
2064                                 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2065                                         bibfiles.begin(),
2066                                         bibfiles.end());
2067                         }
2068                 }
2069         }
2070         d->bibfile_cache_valid_ = true;
2071         d->bibinfo_cache_valid_ = false;
2072         d->cite_labels_valid_ = false;
2073 }
2074
2075
2076 void Buffer::invalidateBibinfoCache() const
2077 {
2078         d->bibinfo_cache_valid_ = false;
2079         d->cite_labels_valid_ = false;
2080         // also invalidate the cache for the parent buffer
2081         Buffer const * const pbuf = d->parent();
2082         if (pbuf)
2083                 pbuf->invalidateBibinfoCache();
2084 }
2085
2086
2087 void Buffer::invalidateBibfileCache() const
2088 {
2089         d->bibfile_cache_valid_ = false;
2090         d->bibinfo_cache_valid_ = false;
2091         d->cite_labels_valid_ = false;
2092         // also invalidate the cache for the parent buffer
2093         Buffer const * const pbuf = d->parent();
2094         if (pbuf)
2095                 pbuf->invalidateBibfileCache();
2096 }
2097
2098
2099 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
2100 {
2101         // FIXME This is probably unnecessary, given where we call this.
2102         // If this is a child document, use the master's cache instead.
2103         Buffer const * const pbuf = masterBuffer();
2104         if (pbuf != this && scope != UpdateChildOnly)
2105                 return pbuf->getBibfilesCache();
2106
2107         if (!d->bibfile_cache_valid_)
2108                 this->updateBibfilesCache(scope);
2109
2110         return d->bibfiles_cache_;
2111 }
2112
2113
2114 BiblioInfo const & Buffer::masterBibInfo() const
2115 {
2116         Buffer const * const tmp = masterBuffer();
2117         if (tmp != this)
2118                 return tmp->masterBibInfo();
2119         return d->bibinfo_;
2120 }
2121
2122
2123 void Buffer::checkIfBibInfoCacheIsValid() const
2124 {
2125         // use the master's cache
2126         Buffer const * const tmp = masterBuffer();
2127         if (tmp != this) {
2128                 tmp->checkIfBibInfoCacheIsValid();
2129                 return;
2130         }
2131
2132         // compare the cached timestamps with the actual ones.
2133         FileNameList const & bibfiles_cache = getBibfilesCache();
2134         FileNameList::const_iterator ei = bibfiles_cache.begin();
2135         FileNameList::const_iterator en = bibfiles_cache.end();
2136         for (; ei != en; ++ ei) {
2137                 time_t lastw = ei->lastModified();
2138                 time_t prevw = d->bibfile_status_[*ei];
2139                 if (lastw != prevw) {
2140                         d->bibinfo_cache_valid_ = false;
2141                         d->cite_labels_valid_ = false;
2142                         d->bibfile_status_[*ei] = lastw;
2143                 }
2144         }
2145 }
2146
2147
2148 void Buffer::reloadBibInfoCache() const
2149 {
2150         // use the master's cache
2151         Buffer const * const tmp = masterBuffer();
2152         if (tmp != this) {
2153                 tmp->reloadBibInfoCache();
2154                 return;
2155         }
2156
2157         checkIfBibInfoCacheIsValid();
2158         if (d->bibinfo_cache_valid_)
2159                 return;
2160
2161         d->bibinfo_.clear();
2162         collectBibKeys();
2163         d->bibinfo_cache_valid_ = true;
2164 }
2165
2166
2167 void Buffer::collectBibKeys() const
2168 {
2169         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2170                 it->collectBibKeys(it);
2171 }
2172
2173
2174 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2175 {
2176         Buffer const * tmp = masterBuffer();
2177         BiblioInfo & masterbi = (tmp == this) ?
2178                 d->bibinfo_ : tmp->d->bibinfo_;
2179         masterbi.mergeBiblioInfo(bi);
2180 }
2181
2182
2183 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2184 {
2185         Buffer const * tmp = masterBuffer();
2186         BiblioInfo & masterbi = (tmp == this) ?
2187                 d->bibinfo_ : tmp->d->bibinfo_;
2188         masterbi[key] = bi;
2189 }
2190
2191
2192 void Buffer::makeCitationLabels() const
2193 {
2194         Buffer const * const master = masterBuffer();
2195         return d->bibinfo_.makeCitationLabels(*master);
2196 }
2197
2198
2199 bool Buffer::citeLabelsValid() const
2200 {
2201         return masterBuffer()->d->cite_labels_valid_;
2202 }
2203
2204
2205 void Buffer::removeBiblioTempFiles() const
2206 {
2207         // We remove files that contain LaTeX commands specific to the
2208         // particular bibliographic style being used, in order to avoid
2209         // LaTeX errors when we switch style.
2210         FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2211         FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2212         LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2213         aux_file.removeFile();
2214         LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2215         bbl_file.removeFile();
2216         // Also for the parent buffer
2217         Buffer const * const pbuf = parent();
2218         if (pbuf)
2219                 pbuf->removeBiblioTempFiles();
2220 }
2221
2222
2223 bool Buffer::isDepClean(string const & name) const
2224 {
2225         DepClean::const_iterator const it = d->dep_clean.find(name);
2226         if (it == d->dep_clean.end())
2227                 return true;
2228         return it->second;
2229 }
2230
2231
2232 void Buffer::markDepClean(string const & name)
2233 {
2234         d->dep_clean[name] = true;
2235 }
2236
2237
2238 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2239 {
2240         if (isInternal()) {
2241                 // FIXME? if there is an Buffer LFUN that can be dispatched even
2242                 // if internal, put a switch '(cmd.action)' here.
2243                 return false;
2244         }
2245
2246         bool enable = true;
2247
2248         switch (cmd.action()) {
2249
2250         case LFUN_BUFFER_TOGGLE_READ_ONLY:
2251                 flag.setOnOff(isReadonly());
2252                 break;
2253
2254                 // FIXME: There is need for a command-line import.
2255                 //case LFUN_BUFFER_IMPORT:
2256
2257         case LFUN_BUFFER_AUTO_SAVE:
2258                 break;
2259
2260         case LFUN_BUFFER_EXPORT_CUSTOM:
2261                 // FIXME: Nothing to check here?
2262                 break;
2263
2264         case LFUN_BUFFER_EXPORT: {
2265                 docstring const arg = cmd.argument();
2266                 if (arg == "custom") {
2267                         enable = true;
2268                         break;
2269                 }
2270                 string format = to_utf8(arg);
2271                 size_t pos = format.find(' ');
2272                 if (pos != string::npos)
2273                         format = format.substr(0, pos);
2274                 enable = params().isExportable(format);
2275                 if (!enable)
2276                         flag.message(bformat(
2277                                              _("Don't know how to export to format: %1$s"), arg));
2278                 break;
2279         }
2280
2281         case LFUN_BUFFER_CHKTEX:
2282                 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2283                 break;
2284
2285         case LFUN_BUILD_PROGRAM:
2286                 enable = params().isExportable("program");
2287                 break;
2288
2289         case LFUN_BRANCH_ACTIVATE:
2290         case LFUN_BRANCH_DEACTIVATE:
2291         case LFUN_BRANCH_MASTER_ACTIVATE:
2292         case LFUN_BRANCH_MASTER_DEACTIVATE: {
2293                 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2294                                      || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2295                 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2296                         : params().branchlist();
2297                 docstring const branchName = cmd.argument();
2298                 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2299                 break;
2300         }
2301
2302         case LFUN_BRANCH_ADD:
2303         case LFUN_BRANCHES_RENAME:
2304         case LFUN_BUFFER_PRINT:
2305                 // if no Buffer is present, then of course we won't be called!
2306                 break;
2307
2308         case LFUN_BUFFER_LANGUAGE:
2309                 enable = !isReadonly();
2310                 break;
2311
2312         default:
2313                 return false;
2314         }
2315         flag.setEnabled(enable);
2316         return true;
2317 }
2318
2319
2320 void Buffer::dispatch(string const & command, DispatchResult & result)
2321 {
2322         return dispatch(lyxaction.lookupFunc(command), result);
2323 }
2324
2325
2326 // NOTE We can end up here even if we have no GUI, because we are called
2327 // by LyX::exec to handled command-line requests. So we may need to check
2328 // whether we have a GUI or not. The boolean use_gui holds this information.
2329 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2330 {
2331         if (isInternal()) {
2332                 // FIXME? if there is an Buffer LFUN that can be dispatched even
2333                 // if internal, put a switch '(cmd.action())' here.
2334                 dr.dispatched(false);
2335                 return;
2336         }
2337         string const argument = to_utf8(func.argument());
2338         // We'll set this back to false if need be.
2339         bool dispatched = true;
2340         undo().beginUndoGroup();
2341
2342         switch (func.action()) {
2343         case LFUN_BUFFER_TOGGLE_READ_ONLY:
2344                 if (lyxvc().inUse()) {
2345                         string log = lyxvc().toggleReadOnly();
2346                         if (!log.empty())
2347                                 dr.setMessage(log);
2348                 }
2349                 else
2350                         setReadonly(!isReadonly());
2351                 break;
2352
2353         case LFUN_BUFFER_EXPORT: {
2354                 ExportStatus const status = doExport(argument, false);
2355                 dr.setError(status != ExportSuccess);
2356                 if (status != ExportSuccess)
2357                         dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2358                                               func.argument()));
2359                 break;
2360         }
2361
2362         case LFUN_BUILD_PROGRAM:
2363                 doExport("program", true);
2364                 break;
2365
2366         case LFUN_BUFFER_CHKTEX:
2367                 runChktex();
2368                 break;
2369
2370         case LFUN_BUFFER_EXPORT_CUSTOM: {
2371                 string format_name;
2372                 string command = split(argument, format_name, ' ');
2373                 Format const * format = formats.getFormat(format_name);
2374                 if (!format) {
2375                         lyxerr << "Format \"" << format_name
2376                                 << "\" not recognized!"
2377                                 << endl;
2378                         break;
2379                 }
2380
2381                 // The name of the file created by the conversion process
2382                 string filename;
2383
2384                 // Output to filename
2385                 if (format->name() == "lyx") {
2386                         string const latexname = latexName(false);
2387                         filename = changeExtension(latexname,
2388                                 format->extension());
2389                         filename = addName(temppath(), filename);
2390
2391                         if (!writeFile(FileName(filename)))
2392                                 break;
2393
2394                 } else {
2395                         doExport(format_name, true, filename);
2396                 }
2397
2398                 // Substitute $$FName for filename
2399                 if (!contains(command, "$$FName"))
2400                         command = "( " + command + " ) < $$FName";
2401                 command = subst(command, "$$FName", filename);
2402
2403                 // Execute the command in the background
2404                 Systemcall call;
2405                 call.startscript(Systemcall::DontWait, command, filePath());
2406                 break;
2407         }
2408
2409         // FIXME: There is need for a command-line import.
2410         /*
2411         case LFUN_BUFFER_IMPORT:
2412                 doImport(argument);
2413                 break;
2414         */
2415
2416         case LFUN_BUFFER_AUTO_SAVE:
2417                 autoSave();
2418                 resetAutosaveTimers();
2419                 break;
2420
2421         case LFUN_BRANCH_ACTIVATE:
2422         case LFUN_BRANCH_DEACTIVATE:
2423         case LFUN_BRANCH_MASTER_ACTIVATE:
2424         case LFUN_BRANCH_MASTER_DEACTIVATE: {
2425                 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2426                                      || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2427                 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2428                                       : this;
2429
2430                 docstring const branch_name = func.argument();
2431                 // the case without a branch name is handled elsewhere
2432                 if (branch_name.empty()) {
2433                         dispatched = false;
2434                         break;
2435                 }
2436                 Branch * branch = buf->params().branchlist().find(branch_name);
2437                 if (!branch) {
2438                         LYXERR0("Branch " << branch_name << " does not exist.");
2439                         dr.setError(true);
2440                         docstring const msg =
2441                                 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2442                         dr.setMessage(msg);
2443                         break;
2444                 }
2445                 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2446                                        || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2447                 if (branch->isSelected() != activate) {
2448                         buf->undo().recordUndoFullDocument(CursorData());
2449                         branch->setSelected(activate);
2450                         dr.setError(false);
2451                         dr.screenUpdate(Update::Force);
2452                         dr.forceBufferUpdate();
2453                 }
2454                 break;
2455         }
2456
2457         case LFUN_BRANCH_ADD: {
2458                 docstring branch_name = func.argument();
2459                 if (branch_name.empty()) {
2460                         dispatched = false;
2461                         break;
2462                 }
2463                 BranchList & branch_list = params().branchlist();
2464                 vector<docstring> const branches =
2465                         getVectorFromString(branch_name, branch_list.separator());
2466                 docstring msg;
2467                 for (vector<docstring>::const_iterator it = branches.begin();
2468                      it != branches.end(); ++it) {
2469                         branch_name = *it;
2470                         Branch * branch = branch_list.find(branch_name);
2471                         if (branch) {
2472                                 LYXERR0("Branch " << branch_name << " already exists.");
2473                                 dr.setError(true);
2474                                 if (!msg.empty())
2475                                         msg += ("\n");
2476                                 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2477                         } else {
2478                                 branch_list.add(branch_name);
2479                                 branch = branch_list.find(branch_name);
2480                                 string const x11hexname = X11hexname(branch->color());
2481                                 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2482                                 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2483                                 dr.setError(false);
2484                                 dr.screenUpdate(Update::Force);
2485                         }
2486                 }
2487                 if (!msg.empty())
2488                         dr.setMessage(msg);
2489                 break;
2490         }
2491
2492         case LFUN_BRANCHES_RENAME: {
2493                 if (func.argument().empty())
2494                         break;
2495
2496                 docstring const oldname = from_utf8(func.getArg(0));
2497                 docstring const newname = from_utf8(func.getArg(1));
2498                 InsetIterator it  = inset_iterator_begin(inset());
2499                 InsetIterator const end = inset_iterator_end(inset());
2500                 bool success = false;
2501                 for (; it != end; ++it) {
2502                         if (it->lyxCode() == BRANCH_CODE) {
2503                                 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2504                                 if (ins.branch() == oldname) {
2505                                         undo().recordUndo(CursorData(it));
2506                                         ins.rename(newname);
2507                                         success = true;
2508                                         continue;
2509                                 }
2510                         }
2511                         if (it->lyxCode() == INCLUDE_CODE) {
2512                                 // get buffer of external file
2513                                 InsetInclude const & ins =
2514                                         static_cast<InsetInclude const &>(*it);
2515                                 Buffer * child = ins.getChildBuffer();
2516                                 if (!child)
2517                                         continue;
2518                                 child->dispatch(func, dr);
2519                         }
2520                 }
2521
2522                 if (success) {
2523                         dr.screenUpdate(Update::Force);
2524                         dr.forceBufferUpdate();
2525                 }
2526                 break;
2527         }
2528
2529         case LFUN_BUFFER_PRINT: {
2530                 // we'll assume there's a problem until we succeed
2531                 dr.setError(true);
2532                 string target = func.getArg(0);
2533                 string target_name = func.getArg(1);
2534                 string command = func.getArg(2);
2535
2536                 if (target.empty()
2537                     || target_name.empty()
2538                     || command.empty()) {
2539                         LYXERR0("Unable to parse " << func.argument());
2540                         docstring const msg =
2541                                 bformat(_("Unable to parse \"%1$s\""), func.argument());
2542                         dr.setMessage(msg);
2543                         break;
2544                 }
2545                 if (target != "printer" && target != "file") {
2546                         LYXERR0("Unrecognized target \"" << target << '"');
2547                         docstring const msg =
2548                                 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2549                         dr.setMessage(msg);
2550                         break;
2551                 }
2552
2553                 if (!doExport("dvi", true)) {
2554                         showPrintError(absFileName());
2555                         dr.setMessage(_("Error exporting to DVI."));
2556                         break;
2557                 }
2558
2559                 // Push directory path.
2560                 string const path = temppath();
2561                 // Prevent the compiler from optimizing away p
2562                 FileName pp(path);
2563                 PathChanger p(pp);
2564
2565                 // there are three cases here:
2566                 // 1. we print to a file
2567                 // 2. we print directly to a printer
2568                 // 3. we print using a spool command (print to file first)
2569                 Systemcall one;
2570                 int res = 0;
2571                 string const dviname = changeExtension(latexName(true), "dvi");
2572
2573                 if (target == "printer") {
2574                         if (!lyxrc.print_spool_command.empty()) {
2575                                 // case 3: print using a spool
2576                                 string const psname = changeExtension(dviname,".ps");
2577                                 command += ' ' + lyxrc.print_to_file
2578                                         + quoteName(psname)
2579                                         + ' '
2580                                         + quoteName(dviname);
2581
2582                                 string command2 = lyxrc.print_spool_command + ' ';
2583                                 if (target_name != "default") {
2584                                         command2 += lyxrc.print_spool_printerprefix
2585                                                 + target_name
2586                                                 + ' ';
2587                                 }
2588                                 command2 += quoteName(psname);
2589                                 // First run dvips.
2590                                 // If successful, then spool command
2591                                 res = one.startscript(Systemcall::Wait, command,
2592                                                       filePath());
2593
2594                                 if (res == 0) {
2595                                         // If there's no GUI, we have to wait on this command. Otherwise,
2596                                         // LyX deletes the temporary directory, and with it the spooled
2597                                         // file, before it can be printed!!
2598                                         Systemcall::Starttype stype = use_gui ?
2599                                                 Systemcall::DontWait : Systemcall::Wait;
2600                                         res = one.startscript(stype, command2,
2601                                                               filePath());
2602                                 }
2603                         } else {
2604                                 // case 2: print directly to a printer
2605                                 if (target_name != "default")
2606                                         command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2607                                 // as above....
2608                                 Systemcall::Starttype stype = use_gui ?
2609                                         Systemcall::DontWait : Systemcall::Wait;
2610                                 res = one.startscript(stype, command +
2611                                                 quoteName(dviname), filePath());
2612                         }
2613
2614                 } else {
2615                         // case 1: print to a file
2616                         FileName const filename(makeAbsPath(target_name, filePath()));
2617                         FileName const dvifile(makeAbsPath(dviname, path));
2618                         if (filename.exists()) {
2619                                 docstring text = bformat(
2620                                         _("The file %1$s already exists.\n\n"
2621                                           "Do you want to overwrite that file?"),
2622                                         makeDisplayPath(filename.absFileName()));
2623                                 if (Alert::prompt(_("Overwrite file?"),
2624                                                   text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2625                                         break;
2626                         }
2627                         command += ' ' + lyxrc.print_to_file
2628                                 + quoteName(filename.toFilesystemEncoding())
2629                                 + ' '
2630                                 + quoteName(dvifile.toFilesystemEncoding());
2631                         // as above....
2632                         Systemcall::Starttype stype = use_gui ?
2633                                 Systemcall::DontWait : Systemcall::Wait;
2634                         res = one.startscript(stype, command, filePath());
2635                 }
2636
2637                 if (res == 0)
2638                         dr.setError(false);
2639                 else {
2640                         dr.setMessage(_("Error running external commands."));
2641                         showPrintError(absFileName());
2642                 }
2643                 break;
2644         }
2645
2646         default:
2647                 dispatched = false;
2648                 break;
2649         }
2650         dr.dispatched(dispatched);
2651         undo().endUndoGroup();
2652 }
2653
2654
2655 void Buffer::changeLanguage(Language const * from, Language const * to)
2656 {
2657         LASSERT(from, return);
2658         LASSERT(to, return);
2659
2660         for_each(par_iterator_begin(),
2661                  par_iterator_end(),
2662                  bind(&Paragraph::changeLanguage, _1, params(), from, to));
2663 }
2664
2665
2666 bool Buffer::isMultiLingual() const
2667 {
2668         ParConstIterator end = par_iterator_end();
2669         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2670                 if (it->isMultiLingual(params()))
2671                         return true;
2672
2673         return false;
2674 }
2675
2676
2677 std::set<Language const *> Buffer::getLanguages() const
2678 {
2679         std::set<Language const *> languages;
2680         getLanguages(languages);
2681         return languages;
2682 }
2683
2684
2685 void Buffer::getLanguages(std::set<Language const *> & languages) const
2686 {
2687         ParConstIterator end = par_iterator_end();
2688         // add the buffer language, even if it's not actively used
2689         languages.insert(language());
2690         // iterate over the paragraphs
2691         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2692                 it->getLanguages(languages);
2693         // also children
2694         ListOfBuffers clist = getDescendents();
2695         ListOfBuffers::const_iterator cit = clist.begin();
2696         ListOfBuffers::const_iterator const cen = clist.end();
2697         for (; cit != cen; ++cit)
2698                 (*cit)->getLanguages(languages);
2699 }
2700
2701
2702 DocIterator Buffer::getParFromID(int const id) const
2703 {
2704         Buffer * buf = const_cast<Buffer *>(this);
2705         if (id < 0) {
2706                 // John says this is called with id == -1 from undo
2707                 lyxerr << "getParFromID(), id: " << id << endl;
2708                 return doc_iterator_end(buf);
2709         }
2710
2711         for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2712                 if (it.paragraph().id() == id)
2713                         return it;
2714
2715         return doc_iterator_end(buf);
2716 }
2717
2718
2719 bool Buffer::hasParWithID(int const id) const
2720 {
2721         return !getParFromID(id).atEnd();
2722 }
2723
2724
2725 ParIterator Buffer::par_iterator_begin()
2726 {
2727         return ParIterator(doc_iterator_begin(this));
2728 }
2729
2730
2731 ParIterator Buffer::par_iterator_end()
2732 {
2733         return ParIterator(doc_iterator_end(this));
2734 }
2735
2736
2737 ParConstIterator Buffer::par_iterator_begin() const
2738 {
2739         return ParConstIterator(doc_iterator_begin(this));
2740 }
2741
2742
2743 ParConstIterator Buffer::par_iterator_end() const
2744 {
2745         return ParConstIterator(doc_iterator_end(this));
2746 }
2747
2748
2749 Language const * Buffer::language() const
2750 {
2751         return params().language;
2752 }
2753
2754
2755 docstring const Buffer::B_(string const & l10n) const
2756 {
2757         return params().B_(l10n);
2758 }
2759
2760
2761 bool Buffer::isClean() const
2762 {
2763         return d->lyx_clean;
2764 }
2765
2766
2767 bool Buffer::isExternallyModified(CheckMethod method) const
2768 {
2769         LASSERT(d->filename.exists(), return false);
2770         // if method == timestamp, check timestamp before checksum
2771         return (method == checksum_method
2772                 || d->timestamp_ != d->filename.lastModified())
2773                 && d->checksum_ != d->filename.checksum();
2774 }
2775
2776
2777 void Buffer::saveCheckSum() const
2778 {
2779         FileName const & file = d->filename;
2780
2781         file.refresh();
2782         if (file.exists()) {
2783                 d->timestamp_ = file.lastModified();
2784                 d->checksum_ = file.checksum();
2785         } else {
2786                 // in the case of save to a new file.
2787                 d->timestamp_ = 0;
2788                 d->checksum_ = 0;
2789         }
2790 }
2791
2792
2793 void Buffer::markClean() const
2794 {
2795         if (!d->lyx_clean) {
2796                 d->lyx_clean = true;
2797                 updateTitles();
2798         }
2799         // if the .lyx file has been saved, we don't need an
2800         // autosave
2801         d->bak_clean = true;
2802         d->undo_.markDirty();
2803 }
2804
2805
2806 void Buffer::setUnnamed(bool flag)
2807 {
2808         d->unnamed = flag;
2809 }
2810
2811
2812 bool Buffer::isUnnamed() const
2813 {
2814         return d->unnamed;
2815 }
2816
2817
2818 /// \note
2819 /// Don't check unnamed, here: isInternal() is used in
2820 /// newBuffer(), where the unnamed flag has not been set by anyone
2821 /// yet. Also, for an internal buffer, there should be no need for
2822 /// retrieving fileName() nor for checking if it is unnamed or not.
2823 bool Buffer::isInternal() const
2824 {
2825         return d->internal_buffer;
2826 }
2827
2828
2829 void Buffer::setInternal(bool flag)
2830 {
2831         d->internal_buffer = flag;
2832 }
2833
2834
2835 void Buffer::markDirty()
2836 {
2837         if (d->lyx_clean) {
2838                 d->lyx_clean = false;
2839                 updateTitles();
2840         }
2841         d->bak_clean = false;
2842
2843         DepClean::iterator it = d->dep_clean.begin();
2844         DepClean::const_iterator const end = d->dep_clean.end();
2845
2846         for (; it != end; ++it)
2847                 it->second = false;
2848 }
2849
2850
2851 FileName Buffer::fileName() const
2852 {
2853         return d->filename;
2854 }
2855
2856
2857 string Buffer::absFileName() const
2858 {
2859         return d->filename.absFileName();
2860 }
2861
2862
2863 string Buffer::filePath() const
2864 {
2865         string const abs = d->filename.onlyPath().absFileName();
2866         if (abs.empty())
2867                 return abs;
2868         int last = abs.length() - 1;
2869
2870         return abs[last] == '/' ? abs : abs + '/';
2871 }
2872
2873
2874 bool Buffer::isReadonly() const
2875 {
2876         return d->read_only;
2877 }
2878
2879
2880 void Buffer::setParent(Buffer const * buffer)
2881 {
2882         // Avoids recursive include.
2883         d->setParent(buffer == this ? 0 : buffer);
2884         updateMacros();
2885 }
2886
2887
2888 Buffer const * Buffer::parent() const
2889 {
2890         return d->parent();
2891 }
2892
2893
2894 ListOfBuffers Buffer::allRelatives() const
2895 {
2896         ListOfBuffers lb = masterBuffer()->getDescendents();
2897         lb.push_front(const_cast<Buffer *>(masterBuffer()));
2898         return lb;
2899 }
2900
2901
2902 Buffer const * Buffer::masterBuffer() const
2903 {
2904         // FIXME Should be make sure we are not in some kind
2905         // of recursive include? A -> B -> A will crash this.
2906         Buffer const * const pbuf = d->parent();
2907         if (!pbuf)
2908                 return this;
2909
2910         return pbuf->masterBuffer();
2911 }
2912
2913
2914 bool Buffer::isChild(Buffer * child) const
2915 {
2916         return d->children_positions.find(child) != d->children_positions.end();
2917 }
2918
2919
2920 DocIterator Buffer::firstChildPosition(Buffer const * child)
2921 {
2922         Impl::BufferPositionMap::iterator it;
2923         it = d->children_positions.find(child);
2924         if (it == d->children_positions.end())
2925                 return DocIterator(this);
2926         return it->second;
2927 }
2928
2929
2930 bool Buffer::hasChildren() const
2931 {
2932         return !d->children_positions.empty();
2933 }
2934
2935
2936 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2937 {
2938         // loop over children
2939         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2940         Impl::BufferPositionMap::iterator end = d->children_positions.end();
2941         for (; it != end; ++it) {
2942                 Buffer * child = const_cast<Buffer *>(it->first);
2943                 // No duplicates
2944                 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2945                 if (bit != clist.end())
2946                         continue;
2947                 clist.push_back(child);
2948                 if (grand_children)
2949                         // there might be grandchildren
2950                         child->collectChildren(clist, true);
2951         }
2952 }
2953
2954
2955 ListOfBuffers Buffer::getChildren() const
2956 {
2957         ListOfBuffers v;
2958         collectChildren(v, false);
2959         // Make sure we have not included ourselves.
2960         ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2961         if (bit != v.end()) {
2962                 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2963                 v.erase(bit);
2964         }
2965         return v;
2966 }
2967
2968
2969 ListOfBuffers Buffer::getDescendents() const
2970 {
2971         ListOfBuffers v;
2972         collectChildren(v, true);
2973         // Make sure we have not included ourselves.
2974         ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2975         if (bit != v.end()) {
2976                 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2977                 v.erase(bit);
2978         }
2979         return v;
2980 }
2981
2982
2983 template<typename M>
2984 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2985 {
2986         if (m.empty())
2987                 return m.end();
2988
2989         typename M::const_iterator it = m.lower_bound(x);
2990         if (it == m.begin())
2991                 return m.end();
2992
2993         it--;
2994         return it;
2995 }
2996
2997
2998 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2999                                          DocIterator const & pos) const
3000 {
3001         LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3002
3003         // if paragraphs have no macro context set, pos will be empty
3004         if (pos.empty())
3005                 return 0;
3006
3007         // we haven't found anything yet
3008         DocIterator bestPos = owner_->par_iterator_begin();
3009         MacroData const * bestData = 0;
3010
3011         // find macro definitions for name
3012         NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3013         if (nameIt != macros.end()) {
3014                 // find last definition in front of pos or at pos itself
3015                 PositionScopeMacroMap::const_iterator it
3016                         = greatest_below(nameIt->second, pos);
3017                 if (it != nameIt->second.end()) {
3018                         while (true) {
3019                                 // scope ends behind pos?
3020                                 if (pos < it->second.first) {
3021                                         // Looks good, remember this. If there
3022                                         // is no external macro behind this,
3023                                         // we found the right one already.
3024                                         bestPos = it->first;
3025                                         bestData = &it->second.second;
3026                                         break;
3027                                 }
3028
3029                                 // try previous macro if there is one
3030                                 if (it == nameIt->second.begin())
3031                                         break;
3032                                 --it;
3033                         }
3034                 }
3035         }
3036
3037         // find macros in included files
3038         PositionScopeBufferMap::const_iterator it
3039                 = greatest_below(position_to_children, pos);
3040         if (it == position_to_children.end())
3041                 // no children before
3042                 return bestData;
3043
3044         while (true) {
3045                 // do we know something better (i.e. later) already?
3046                 if (it->first < bestPos )
3047                         break;
3048
3049                 // scope ends behind pos?
3050                 if (pos < it->second.first
3051                         && (cloned_buffer_ ||
3052                             theBufferList().isLoaded(it->second.second))) {
3053                         // look for macro in external file
3054                         macro_lock = true;
3055                         MacroData const * data
3056                                 = it->second.second->getMacro(name, false);
3057                         macro_lock = false;
3058                         if (data) {
3059                                 bestPos = it->first;
3060                                 bestData = data;
3061                                 break;
3062                         }
3063                 }
3064
3065                 // try previous file if there is one
3066                 if (it == position_to_children.begin())
3067                         break;
3068                 --it;
3069         }
3070
3071         // return the best macro we have found
3072         return bestData;
3073 }
3074
3075
3076 MacroData const * Buffer::getMacro(docstring const & name,
3077         DocIterator const & pos, bool global) const
3078 {
3079         if (d->macro_lock)
3080                 return 0;
3081
3082         // query buffer macros
3083         MacroData const * data = d->getBufferMacro(name, pos);
3084         if (data != 0)
3085                 return data;
3086
3087         // If there is a master buffer, query that
3088         Buffer const * const pbuf = d->parent();
3089         if (pbuf) {
3090                 d->macro_lock = true;
3091                 MacroData const * macro = pbuf->getMacro(
3092                         name, *this, false);
3093                 d->macro_lock = false;
3094                 if (macro)
3095                         return macro;
3096         }
3097
3098         if (global) {
3099                 data = MacroTable::globalMacros().get(name);
3100                 if (data != 0)
3101                         return data;
3102         }
3103
3104         return 0;
3105 }
3106
3107
3108 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3109 {
3110         // set scope end behind the last paragraph
3111         DocIterator scope = par_iterator_begin();
3112         scope.pit() = scope.lastpit() + 1;
3113
3114         return getMacro(name, scope, global);
3115 }
3116
3117
3118 MacroData const * Buffer::getMacro(docstring const & name,
3119         Buffer const & child, bool global) const
3120 {
3121         // look where the child buffer is included first
3122         Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3123         if (it == d->children_positions.end())
3124                 return 0;
3125
3126         // check for macros at the inclusion position
3127         return getMacro(name, it->second, global);
3128 }
3129
3130
3131 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3132 {
3133         pit_type const lastpit = it.lastpit();
3134
3135         // look for macros in each paragraph
3136         while (it.pit() <= lastpit) {
3137                 Paragraph & par = it.paragraph();
3138
3139                 // iterate over the insets of the current paragraph
3140                 InsetList const & insets = par.insetList();
3141                 InsetList::const_iterator iit = insets.begin();
3142                 InsetList::const_iterator end = insets.end();
3143                 for (; iit != end; ++iit) {
3144                         it.pos() = iit->pos;
3145
3146                         // is it a nested text inset?
3147                         if (iit->inset->asInsetText()) {
3148                                 // Inset needs its own scope?
3149                                 InsetText const * itext = iit->inset->asInsetText();
3150                                 bool newScope = itext->isMacroScope();
3151
3152                                 // scope which ends just behind the inset
3153                                 DocIterator insetScope = it;
3154                                 ++insetScope.pos();
3155
3156                                 // collect macros in inset
3157                                 it.push_back(CursorSlice(*iit->inset));
3158                                 updateMacros(it, newScope ? insetScope : scope);
3159                                 it.pop_back();
3160                                 continue;
3161                         }
3162
3163                         if (iit->inset->asInsetTabular()) {
3164                                 CursorSlice slice(*iit->inset);
3165                                 size_t const numcells = slice.nargs();
3166                                 for (; slice.idx() < numcells; slice.forwardIdx()) {
3167                                         it.push_back(slice);
3168                                         updateMacros(it, scope);
3169                                         it.pop_back();
3170                                 }
3171                                 continue;
3172                         }
3173
3174                         // is it an external file?
3175                         if (iit->inset->lyxCode() == INCLUDE_CODE) {
3176                                 // get buffer of external file
3177                                 InsetInclude const & inset =
3178                                         static_cast<InsetInclude const &>(*iit->inset);
3179                                 macro_lock = true;
3180                                 Buffer * child = inset.getChildBuffer();
3181                                 macro_lock = false;
3182                                 if (!child)
3183                                         continue;
3184
3185                                 // register its position, but only when it is
3186                                 // included first in the buffer
3187                                 if (children_positions.find(child) ==
3188                                         children_positions.end())
3189                                                 children_positions[child] = it;
3190
3191                                 // register child with its scope
3192                                 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3193                                 continue;
3194                         }
3195
3196                         InsetMath * im = iit->inset->asInsetMath();
3197                         if (doing_export && im)  {
3198                                 InsetMathHull * hull = im->asHullInset();
3199                                 if (hull)
3200                                         hull->recordLocation(it);
3201                         }
3202
3203                         if (iit->inset->lyxCode() != MATHMACRO_CODE)
3204                                 continue;
3205
3206                         // get macro data
3207                         MathMacroTemplate & macroTemplate =
3208                                 *iit->inset->asInsetMath()->asMacroTemplate();
3209                         MacroContext mc(owner_, it);
3210                         macroTemplate.updateToContext(mc);
3211
3212                         // valid?
3213                         bool valid = macroTemplate.validMacro();
3214                         // FIXME: Should be fixNameAndCheckIfValid() in fact,
3215                         // then the BufferView's cursor will be invalid in
3216                         // some cases which leads to crashes.
3217                         if (!valid)
3218                                 continue;
3219
3220                         // register macro
3221                         // FIXME (Abdel), I don't understandt why we pass 'it' here
3222                         // instead of 'macroTemplate' defined above... is this correct?
3223                         macros[macroTemplate.name()][it] =
3224                                 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3225                 }
3226
3227                 // next paragraph
3228                 it.pit()++;
3229                 it.pos() = 0;
3230         }
3231 }
3232
3233
3234 void Buffer::updateMacros() const
3235 {
3236         if (d->macro_lock)
3237                 return;
3238
3239         LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3240
3241         // start with empty table
3242         d->macros.clear();
3243         d->children_positions.clear();
3244         d->position_to_children.clear();
3245
3246         // Iterate over buffer, starting with first paragraph
3247         // The scope must be bigger than any lookup DocIterator
3248         // later. For the global lookup, lastpit+1 is used, hence
3249         // we use lastpit+2 here.
3250         DocIterator it = par_iterator_begin();
3251         DocIterator outerScope = it;
3252         outerScope.pit() = outerScope.lastpit() + 2;
3253         d->updateMacros(it, outerScope);
3254 }
3255
3256
3257 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3258 {
3259         InsetIterator it  = inset_iterator_begin(inset());
3260         InsetIterator const end = inset_iterator_end(inset());
3261         for (; it != end; ++it) {
3262                 if (it->lyxCode() == BRANCH_CODE) {
3263                         InsetBranch & br = static_cast<InsetBranch &>(*it);
3264                         docstring const name = br.branch();
3265                         if (!from_master && !params().branchlist().find(name))
3266                                 result.push_back(name);
3267                         else if (from_master && !masterBuffer()->params().branchlist().find(name))
3268                                 result.push_back(name);
3269                         continue;
3270                 }
3271                 if (it->lyxCode() == INCLUDE_CODE) {
3272                         // get buffer of external file
3273                         InsetInclude const & ins =
3274                                 static_cast<InsetInclude const &>(*it);
3275                         Buffer * child = ins.getChildBuffer();
3276                         if (!child)
3277                                 continue;
3278                         child->getUsedBranches(result, true);
3279                 }
3280         }
3281         // remove duplicates
3282         result.unique();
3283 }
3284
3285
3286 void Buffer::updateMacroInstances(UpdateType utype) const
3287 {
3288         LYXERR(Debug::MACROS, "updateMacroInstances for "
3289                 << d->filename.onlyFileName());
3290         DocIterator it = doc_iterator_begin(this);
3291         it.forwardInset();
3292         DocIterator const end = doc_iterator_end(this);
3293         for (; it != end; it.forwardInset()) {
3294                 // look for MathData cells in InsetMathNest insets
3295                 InsetMath * minset = it.nextInset()->asInsetMath();
3296                 if (!minset)
3297                         continue;
3298
3299                 // update macro in all cells of the InsetMathNest
3300                 DocIterator::idx_type n = minset->nargs();
3301                 MacroContext mc = MacroContext(this, it);
3302                 for (DocIterator::idx_type i = 0; i < n; ++i) {
3303                         MathData & data = minset->cell(i);
3304                         data.updateMacros(0, mc, utype);
3305                 }
3306         }
3307 }
3308
3309
3310 void Buffer::listMacroNames(MacroNameSet & macros) const
3311 {
3312         if (d->macro_lock)
3313                 return;
3314
3315         d->macro_lock = true;
3316
3317         // loop over macro names
3318         Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3319         Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3320         for (; nameIt != nameEnd; ++nameIt)
3321                 macros.insert(nameIt->first);
3322
3323         // loop over children
3324         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3325         Impl::BufferPositionMap::iterator end = d->children_positions.end();
3326         for (; it != end; ++it)
3327                 it->first->listMacroNames(macros);
3328
3329         // call parent
3330         Buffer const * const pbuf = d->parent();
3331         if (pbuf)
3332                 pbuf->listMacroNames(macros);
3333
3334         d->macro_lock = false;
3335 }
3336
3337
3338 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3339 {
3340         Buffer const * const pbuf = d->parent();
3341         if (!pbuf)
3342                 return;
3343
3344         MacroNameSet names;
3345         pbuf->listMacroNames(names);
3346
3347         // resolve macros
3348         MacroNameSet::iterator it = names.begin();
3349         MacroNameSet::iterator end = names.end();
3350         for (; it != end; ++it) {
3351                 // defined?
3352                 MacroData const * data =
3353                 pbuf->getMacro(*it, *this, false);
3354                 if (data) {
3355                         macros.insert(data);
3356
3357                         // we cannot access the original MathMacroTemplate anymore
3358                         // here to calls validate method. So we do its work here manually.
3359                         // FIXME: somehow make the template accessible here.
3360                         if (data->optionals() > 0)
3361                                 features.require("xargs");
3362                 }
3363         }
3364 }
3365
3366
3367 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3368 {
3369         if (d->parent())
3370                 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3371
3372         RefCache::iterator it = d->ref_cache_.find(label);
3373         if (it != d->ref_cache_.end())
3374                 return it->second.second;
3375
3376         static InsetLabel const * dummy_il = 0;
3377         static References const dummy_refs;
3378         it = d->ref_cache_.insert(
3379                 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3380         return it->second.second;
3381 }
3382
3383
3384 Buffer::References const & Buffer::references(docstring const & label) const
3385 {
3386         return const_cast<Buffer *>(this)->getReferenceCache(label);
3387 }
3388
3389
3390 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3391 {
3392         References & refs = getReferenceCache(label);
3393         refs.push_back(make_pair(inset, it));
3394 }
3395
3396
3397 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3398 {
3399         masterBuffer()->d->ref_cache_[label].first = il;
3400 }
3401
3402
3403 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3404 {
3405         return masterBuffer()->d->ref_cache_[label].first;
3406 }
3407
3408
3409 void Buffer::clearReferenceCache() const
3410 {
3411         if (!d->parent())
3412                 d->ref_cache_.clear();
3413 }
3414
3415
3416 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3417 {
3418         //FIXME: This does not work for child documents yet.
3419         reloadBibInfoCache();
3420
3421         // Check if the label 'from' appears more than once
3422         BiblioInfo const & keys = masterBibInfo();
3423         BiblioInfo::const_iterator bit  = keys.begin();
3424         BiblioInfo::const_iterator bend = keys.end();
3425         vector<docstring> labels;
3426
3427         for (; bit != bend; ++bit)
3428                 // FIXME UNICODE
3429                 labels.push_back(bit->first);
3430
3431         if (count(labels.begin(), labels.end(), from) > 1)
3432                 return;
3433
3434         string const paramName = "key";
3435         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3436                 if (it->lyxCode() != CITE_CODE)
3437                         continue;
3438                 InsetCommand * inset = it->asInsetCommand();
3439                 docstring const oldValue = inset->getParam(paramName);
3440                 if (oldValue == from)
3441                         inset->setParam(paramName, to);
3442         }
3443 }
3444
3445
3446 void Buffer::getSourceCode(odocstream & os, string const format,
3447                            pit_type par_begin, pit_type par_end,
3448                            OutputWhat output, bool master) const
3449 {
3450         OutputParams runparams(&params().encoding());
3451         runparams.nice = true;
3452         runparams.flavor = params().getOutputFlavor(format);
3453         runparams.linelen = lyxrc.plaintext_linelen;
3454         // No side effect of file copying and image conversion
3455         runparams.dryrun = true;
3456
3457         if (output == CurrentParagraph) {
3458                 runparams.par_begin = par_begin;
3459                 runparams.par_end = par_end;
3460                 if (par_begin + 1 == par_end) {
3461                         os << "% "
3462                            << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3463                            << "\n\n";
3464                 } else {
3465                         os << "% "
3466                            << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3467                                         convert<docstring>(par_begin),
3468                                         convert<docstring>(par_end - 1))
3469                            << "\n\n";
3470                 }
3471                 // output paragraphs
3472                 if (runparams.flavor == OutputParams::LYX) {
3473                         Paragraph const & par = text().paragraphs()[par_begin];
3474                         ostringstream ods;
3475                         depth_type dt = par.getDepth();
3476                         par.write(ods, params(), dt);
3477                         os << from_utf8(ods.str());
3478                 } else if (runparams.flavor == OutputParams::HTML) {
3479                         XHTMLStream xs(os);
3480                         setMathFlavor(runparams);
3481                         xhtmlParagraphs(text(), *this, xs, runparams);
3482                 } else if (runparams.flavor == OutputParams::TEXT) {
3483                         bool dummy;
3484                         // FIXME Handles only one paragraph, unlike the others.
3485                         // Probably should have some routine with a signature like them.
3486                         writePlaintextParagraph(*this,
3487                                 text().paragraphs()[par_begin], os, runparams, dummy);
3488                 } else if (params().isDocBook()) {
3489                         docbookParagraphs(text(), *this, os, runparams);
3490                 } else {
3491                         // If we are previewing a paragraph, even if this is the
3492                         // child of some other buffer, let's cut the link here,
3493                         // so that no concurring settings from the master
3494                         // (e.g. branch state) interfere (see #8101).
3495                         if (!master)
3496                                 d->ignore_parent = true;
3497                         // We need to validate the Buffer params' features here
3498                         // in order to know if we should output polyglossia
3499                         // macros (instead of babel macros)
3500                         LaTeXFeatures features(*this, params(), runparams);
3501                         params().validate(features);
3502                         runparams.use_polyglossia = features.usePolyglossia();
3503                         TexRow texrow;
3504                         texrow.reset();
3505                         texrow.newline();
3506                         texrow.newline();
3507                         // latex or literate
3508                         otexstream ots(os, texrow);
3509
3510                         // the real stuff
3511                         latexParagraphs(*this, text(), ots, runparams);
3512
3513                         // Restore the parenthood
3514                         if (!master)
3515                                 d->ignore_parent = false;
3516                 }
3517         } else {
3518                 os << "% ";
3519                 if (output == FullSource)
3520                         os << _("Preview source code");
3521                 else if (output == OnlyPreamble)
3522                         os << _("Preview preamble");
3523                 else if (output == OnlyBody)
3524                         os << _("Preview body");
3525                 os << "\n\n";
3526                 if (runparams.flavor == OutputParams::LYX) {
3527                         ostringstream ods;
3528                         if (output == FullSource)
3529                                 write(ods);
3530                         else if (output == OnlyPreamble)
3531                                 params().writeFile(ods);
3532                         else if (output == OnlyBody)
3533                                 text().write(ods);
3534                         os << from_utf8(ods.str());
3535                 } else if (runparams.flavor == OutputParams::HTML) {
3536                         writeLyXHTMLSource(os, runparams, output);
3537                 } else if (runparams.flavor == OutputParams::TEXT) {
3538                         if (output == OnlyPreamble) {
3539                                 os << "% "<< _("Plain text does not have a preamble.");
3540                         } else
3541                                 writePlaintextFile(*this, os, runparams);
3542                 } else if (params().isDocBook()) {
3543                                 writeDocBookSource(os, absFileName(), runparams, output);
3544                 } else {
3545                         // latex or literate
3546                         d->texrow.reset();
3547                         d->texrow.newline();
3548                         d->texrow.newline();
3549                         otexstream ots(os, d->texrow);
3550                         if (master)
3551                                 runparams.is_child = true;
3552                         writeLaTeXSource(ots, string(), runparams, output);
3553                 }
3554         }
3555 }
3556
3557
3558 ErrorList & Buffer::errorList(string const & type) const
3559 {
3560         return d->errorLists[type];
3561 }
3562
3563
3564 void Buffer::updateTocItem(std::string const & type,
3565         DocIterator const & dit) const
3566 {
3567         if (d->gui_)
3568                 d->gui_->updateTocItem(type, dit);
3569 }
3570
3571
3572 void Buffer::structureChanged() const
3573 {
3574         if (d->gui_)
3575                 d->gui_->structureChanged();
3576 }
3577
3578
3579 void Buffer::errors(string const & err, bool from_master) const
3580 {
3581         if (d->gui_)
3582                 d->gui_->errors(err, from_master);
3583 }
3584
3585
3586 void Buffer::message(docstring const & msg) const
3587 {
3588         if (d->gui_)
3589                 d->gui_->message(msg);
3590 }
3591
3592
3593 void Buffer::setBusy(bool on) const
3594 {
3595         if (d->gui_)
3596                 d->gui_->setBusy(on);
3597 }
3598
3599
3600 void Buffer::updateTitles() const
3601 {
3602         if (d->wa_)
3603                 d->wa_->updateTitles();
3604 }
3605
3606
3607 void Buffer::resetAutosaveTimers() const
3608 {
3609         if (d->gui_)
3610                 d->gui_->resetAutosaveTimers();
3611 }
3612
3613
3614 bool Buffer::hasGuiDelegate() const
3615 {
3616         return d->gui_;
3617 }
3618
3619
3620 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3621 {
3622         d->gui_ = gui;
3623 }
3624
3625
3626
3627 namespace {
3628
3629 class AutoSaveBuffer : public ForkedProcess {
3630 public:
3631         ///
3632         AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3633                 : buffer_(buffer), fname_(fname) {}
3634         ///
3635         virtual shared_ptr<ForkedProcess> clone() const
3636         {
3637                 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3638         }
3639         ///
3640         int start()
3641         {
3642                 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3643                                                  from_utf8(fname_.absFileName())));
3644                 return run(DontWait);
3645         }
3646 private:
3647         ///
3648         virtual int generateChild();
3649         ///
3650         Buffer const & buffer_;
3651         FileName fname_;
3652 };
3653
3654
3655 int AutoSaveBuffer::generateChild()
3656 {
3657 #if defined(__APPLE__)
3658         /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3659          *   We should use something else like threads.
3660          *
3661          * Since I do not know how to determine at run time what is the OS X
3662          * version, I just disable forking altogether for now (JMarc)
3663          */
3664         pid_t const pid = -1;
3665 #else
3666         // tmp_ret will be located (usually) in /tmp
3667         // will that be a problem?
3668         // Note that this calls ForkedCalls::fork(), so it's
3669         // ok cross-platform.
3670         pid_t const pid = fork();
3671         // If you want to debug the autosave
3672         // you should set pid to -1, and comment out the fork.
3673         if (pid != 0 && pid != -1)
3674                 return pid;
3675 #endif
3676
3677         // pid = -1 signifies that lyx was unable
3678         // to fork. But we will do the save
3679         // anyway.
3680         bool failed = false;
3681         FileName const tmp_ret = FileName::tempName("lyxauto");
3682         if (!tmp_ret.empty()) {
3683                 buffer_.writeFile(tmp_ret);
3684                 // assume successful write of tmp_ret
3685                 if (!tmp_ret.moveTo(fname_))
3686                         failed = true;
3687         } else
3688                 failed = true;
3689
3690         if (failed) {
3691                 // failed to write/rename tmp_ret so try writing direct
3692                 if (!buffer_.writeFile(fname_)) {
3693                         // It is dangerous to do this in the child,
3694                         // but safe in the parent, so...
3695                         if (pid == -1) // emit message signal.
3696                                 buffer_.message(_("Autosave failed!"));
3697                 }
3698         }
3699
3700         if (pid == 0) // we are the child so...
3701                 _exit(0);
3702
3703         return pid;
3704 }
3705
3706 } // namespace anon
3707
3708
3709 FileName Buffer::getEmergencyFileName() const
3710 {
3711         return FileName(d->filename.absFileName() + ".emergency");
3712 }
3713
3714
3715 FileName Buffer::getAutosaveFileName() const
3716 {
3717         // if the document is unnamed try to save in the backup dir, else
3718         // in the default document path, and as a last try in the filePath,
3719         // which will most often be the temporary directory
3720         string fpath;
3721         if (isUnnamed())
3722                 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3723                         : lyxrc.backupdir_path;
3724         if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3725                 fpath = filePath();
3726
3727         string const fname = "#" + d->filename.onlyFileName() + "#";
3728
3729         return makeAbsPath(fname, fpath);
3730 }
3731
3732
3733 void Buffer::removeAutosaveFile() const
3734 {
3735         FileName const f = getAutosaveFileName();
3736         if (f.exists())
3737                 f.removeFile();
3738 }
3739
3740
3741 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3742 {
3743         FileName const newauto = getAutosaveFileName();
3744         oldauto.refresh();
3745         if (newauto != oldauto && oldauto.exists())
3746                 if (!oldauto.moveTo(newauto))
3747                         LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3748 }
3749
3750
3751 bool Buffer::autoSave() const
3752 {
3753         Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3754         if (buf->d->bak_clean || isReadonly())
3755                 return true;
3756
3757         message(_("Autosaving current document..."));
3758         buf->d->bak_clean = true;
3759
3760         FileName const fname = getAutosaveFileName();
3761         LASSERT(d->cloned_buffer_, return false);
3762
3763         // If this buffer is cloned, we assume that
3764         // we are running in a separate thread already.
3765         FileName const tmp_ret = FileName::tempName("lyxauto");
3766         if (!tmp_ret.empty()) {
3767                 writeFile(tmp_ret);
3768                 // assume successful write of tmp_ret
3769                 if (tmp_ret.moveTo(fname))
3770                         return true;
3771         }
3772         // failed to write/rename tmp_ret so try writing direct
3773         return writeFile(fname);
3774 }
3775
3776
3777 void Buffer::setExportStatus(bool e) const
3778 {
3779         d->doing_export = e;
3780         ListOfBuffers clist = getDescendents();
3781         ListOfBuffers::const_iterator cit = clist.begin();
3782         ListOfBuffers::const_iterator const cen = clist.end();
3783         for (; cit != cen; ++cit)
3784                 (*cit)->d->doing_export = e;
3785 }
3786
3787
3788 bool Buffer::isExporting() const
3789 {
3790         return d->doing_export;
3791 }
3792
3793
3794 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
3795         const
3796 {
3797         string result_file;
3798         return doExport(target, put_in_tempdir, result_file);
3799 }
3800
3801 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3802         string & result_file) const
3803 {
3804         bool const update_unincluded =
3805                         params().maintain_unincluded_children
3806                         && !params().getIncludedChildren().empty();
3807
3808         // (1) export with all included children (omit \includeonly)
3809         if (update_unincluded) {
3810                 ExportStatus const status =
3811                         doExport(target, put_in_tempdir, true, result_file);
3812                 if (status != ExportSuccess)
3813                         return status;
3814         }
3815         // (2) export with included children only
3816         return doExport(target, put_in_tempdir, false, result_file);
3817 }
3818
3819
3820 void Buffer::setMathFlavor(OutputParams & op) const
3821 {
3822         switch (params().html_math_output) {
3823         case BufferParams::MathML:
3824                 op.math_flavor = OutputParams::MathAsMathML;
3825                 break;
3826         case BufferParams::HTML:
3827                 op.math_flavor = OutputParams::MathAsHTML;
3828                 break;
3829         case BufferParams::Images:
3830                 op.math_flavor = OutputParams::MathAsImages;
3831                 break;
3832         case BufferParams::LaTeX:
3833                 op.math_flavor = OutputParams::MathAsLaTeX;
3834                 break;
3835         }
3836 }
3837
3838
3839 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3840         bool includeall, string & result_file) const
3841 {
3842         LYXERR(Debug::FILES, "target=" << target);
3843         OutputParams runparams(&params().encoding());
3844         string format = target;
3845         string dest_filename;
3846         size_t pos = target.find(' ');
3847         if (pos != string::npos) {
3848                 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
3849                 format = target.substr(0, pos);
3850                 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
3851                 FileName(dest_filename).onlyPath().createPath();
3852                 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
3853         }
3854         MarkAsExporting exporting(this);
3855         string backend_format;
3856         runparams.flavor = OutputParams::LATEX;
3857         runparams.linelen = lyxrc.plaintext_linelen;
3858         runparams.includeall = includeall;
3859         vector<string> backs = params().backends();
3860         Converters converters = theConverters();
3861         bool need_nice_file = false;
3862         if (find(backs.begin(), backs.end(), format) == backs.end()) {
3863                 // Get shortest path to format
3864                 converters.buildGraph();
3865                 Graph::EdgePath path;
3866                 for (vector<string>::const_iterator it = backs.begin();
3867                      it != backs.end(); ++it) {
3868                         Graph::EdgePath p = converters.getPath(*it, format);
3869                         if (!p.empty() && (path.empty() || p.size() < path.size())) {
3870                                 backend_format = *it;
3871                                 path = p;
3872                         }
3873                 }
3874                 if (path.empty()) {
3875                         if (!put_in_tempdir) {
3876                                 // Only show this alert if this is an export to a non-temporary
3877                                 // file (not for previewing).
3878                                 Alert::error(_("Couldn't export file"), bformat(
3879                                         _("No information for exporting the format %1$s."),
3880                                         formats.prettyName(format)));
3881                         }
3882                         return ExportNoPathToFormat;
3883                 }
3884                 runparams.flavor = converters.getFlavor(path, this);
3885                 Graph::EdgePath::const_iterator it = path.begin();
3886                 Graph::EdgePath::const_iterator en = path.end();
3887                 for (; it != en; ++it)
3888                         if (theConverters().get(*it).nice) {
3889                                 need_nice_file = true;
3890                                 break;
3891                         }
3892
3893         } else {
3894                 backend_format = format;
3895                 LYXERR(Debug::FILES, "backend_format=" << backend_format);
3896                 // FIXME: Don't hardcode format names here, but use a flag
3897                 if (backend_format == "pdflatex")
3898                         runparams.flavor = OutputParams::PDFLATEX;
3899                 else if (backend_format == "luatex")
3900                         runparams.flavor = OutputParams::LUATEX;
3901                 else if (backend_format == "dviluatex")
3902                         runparams.flavor = OutputParams::DVILUATEX;
3903                 else if (backend_format == "xetex")
3904                         runparams.flavor = OutputParams::XETEX;
3905         }
3906
3907         string filename = latexName(false);
3908         filename = addName(temppath(), filename);
3909         filename = changeExtension(filename,
3910                                    formats.extension(backend_format));
3911         LYXERR(Debug::FILES, "filename=" << filename);
3912
3913         // Plain text backend
3914         if (backend_format == "text") {
3915                 runparams.flavor = OutputParams::TEXT;
3916                 writePlaintextFile(*this, FileName(filename), runparams);
3917         }
3918         // HTML backend
3919         else if (backend_format == "xhtml") {
3920                 runparams.flavor = OutputParams::HTML;
3921                 setMathFlavor(runparams);
3922                 makeLyXHTMLFile(FileName(filename), runparams);
3923         } else if (backend_format == "lyx")
3924                 writeFile(FileName(filename));
3925         // Docbook backend
3926         else if (params().isDocBook()) {
3927                 runparams.nice = !put_in_tempdir;
3928                 makeDocBookFile(FileName(filename), runparams);
3929         }
3930         // LaTeX backend
3931         else if (backend_format == format || need_nice_file) {
3932                 runparams.nice = true;
3933                 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
3934                 if (d->cloned_buffer_)
3935                         d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
3936                 if (!success)
3937                         return ExportError;
3938         } else if (!lyxrc.tex_allows_spaces
3939                    && contains(filePath(), ' ')) {
3940                 Alert::error(_("File name error"),
3941                            _("The directory path to the document cannot contain spaces."));
3942                 return ExportTexPathHasSpaces;
3943         } else {
3944                 runparams.nice = false;
3945                 bool const success = makeLaTeXFile(
3946                         FileName(filename), filePath(), runparams);
3947                 if (d->cloned_buffer_)
3948                         d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
3949                 if (!success)
3950                         return ExportError;
3951         }
3952
3953         string const error_type = (format == "program")
3954                 ? "Build" : params().bufferFormat();
3955         ErrorList & error_list = d->errorLists[error_type];
3956         string const ext = formats.extension(format);
3957         FileName const tmp_result_file(changeExtension(filename, ext));
3958         bool const success = converters.convert(this, FileName(filename),
3959                 tmp_result_file, FileName(absFileName()), backend_format, format,
3960                 error_list);
3961
3962         // Emit the signal to show the error list or copy it back to the
3963         // cloned Buffer so that it can be emitted afterwards.
3964         if (format != backend_format) {
3965                 if (d->cloned_buffer_) {
3966                         d->cloned_buffer_->d->errorLists[error_type] =
3967                                 d->errorLists[error_type];
3968                 } else
3969                         errors(error_type);
3970                 // also to the children, in case of master-buffer-view
3971                 ListOfBuffers clist = getDescendents();
3972                 ListOfBuffers::const_iterator cit = clist.begin();
3973                 ListOfBuffers::const_iterator const cen = clist.end();
3974                 for (; cit != cen; ++cit) {
3975                         if (d->cloned_buffer_) {
3976                                 // Enable reverse search by copying back the
3977                                 // texrow object to the cloned buffer.
3978                                 // FIXME: this is not thread safe.
3979                                 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
3980                                 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3981                                         (*cit)->d->errorLists[error_type];
3982                         } else
3983                                 (*cit)->errors(error_type, true);
3984                 }
3985         }
3986
3987         if (d->cloned_buffer_) {
3988                 // Enable reverse dvi or pdf to work by copying back the texrow
3989                 // object to the cloned buffer.
3990                 // FIXME: There is a possibility of concurrent access to texrow
3991                 // here from the main GUI thread that should be securized.
3992                 d->cloned_buffer_->d->texrow = d->texrow;
3993                 string const error_type = params().bufferFormat();
3994                 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3995         }
3996
3997         if (!success)
3998                 return ExportConverterError;
3999
4000         if (put_in_tempdir) {
4001                 result_file = tmp_result_file.absFileName();
4002                 return ExportSuccess;
4003         }
4004
4005         if (dest_filename.empty())
4006                 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4007         else
4008                 result_file = dest_filename;
4009         // We need to copy referenced files (e. g. included graphics
4010         // if format == "dvi") to the result dir.
4011         vector<ExportedFile> const files =
4012                 runparams.exportdata->externalFiles(format);
4013         string const dest = runparams.export_folder.empty() ?
4014                 onlyPath(result_file) : runparams.export_folder;
4015         bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4016                                  : force_overwrite == ALL_FILES;
4017         CopyStatus status = use_force ? FORCE : SUCCESS;
4018
4019         vector<ExportedFile>::const_iterator it = files.begin();
4020         vector<ExportedFile>::const_iterator const en = files.end();
4021         for (; it != en && status != CANCEL; ++it) {
4022                 string const fmt = formats.getFormatFromFile(it->sourceName);
4023                 string fixedName = it->exportName;
4024                 if (!runparams.export_folder.empty()) {
4025                         // Relative pathnames starting with ../ will be sanitized
4026                         // if exporting to a different folder
4027                         while (fixedName.substr(0, 3) == "../")
4028                                 fixedName = fixedName.substr(3, fixedName.length() - 3);
4029                 }
4030                 FileName fixedFileName = makeAbsPath(fixedName, dest);
4031                 fixedFileName.onlyPath().createPath();
4032                 status = copyFile(fmt, it->sourceName,
4033                         fixedFileName,
4034                         it->exportName, status == FORCE,
4035                         runparams.export_folder.empty());
4036         }
4037
4038         if (status == CANCEL) {
4039                 message(_("Document export cancelled."));
4040                 return ExportCancel;
4041         }
4042
4043         if (tmp_result_file.exists()) {
4044                 // Finally copy the main file
4045                 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4046                                     : force_overwrite != NO_FILES;
4047                 if (status == SUCCESS && use_force)
4048                         status = FORCE;
4049                 status = copyFile(format, tmp_result_file,
4050                         FileName(result_file), result_file,
4051                         status == FORCE);
4052                 if (status == CANCEL) {
4053                         message(_("Document export cancelled."));
4054                         return ExportCancel;
4055                 } else {
4056                         message(bformat(_("Document exported as %1$s "
4057                                 "to file `%2$s'"),
4058                                 formats.prettyName(format),
4059                                 makeDisplayPath(result_file)));
4060                 }
4061         } else {
4062                 // This must be a dummy converter like fax (bug 1888)
4063                 message(bformat(_("Document exported as %1$s"),
4064                         formats.prettyName(format)));
4065         }
4066
4067         return ExportSuccess;
4068 }
4069
4070
4071 Buffer::ExportStatus Buffer::preview(string const & format) const
4072 {
4073         bool const update_unincluded =
4074                         params().maintain_unincluded_children
4075                         && !params().getIncludedChildren().empty();
4076         return preview(format, update_unincluded);
4077 }
4078
4079 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4080 {
4081         MarkAsExporting exporting(this);
4082         string result_file;
4083         // (1) export with all included children (omit \includeonly)
4084         if (includeall) {
4085                 ExportStatus const status = doExport(format, true, true, result_file);
4086                 if (status != ExportSuccess)
4087                         return status;
4088         }
4089         // (2) export with included children only
4090         ExportStatus const status = doExport(format, true, false, result_file);
4091         if (status != ExportSuccess)
4092                 return status;
4093         if (!formats.view(*this, FileName(result_file), format))
4094                 return PreviewError;
4095         return PreviewSuccess;
4096 }
4097
4098
4099 Buffer::ReadStatus Buffer::extractFromVC()
4100 {
4101         bool const found = LyXVC::file_not_found_hook(d->filename);
4102         if (!found)
4103                 return ReadFileNotFound;
4104         if (!d->filename.isReadableFile())
4105                 return ReadVCError;
4106         return ReadSuccess;
4107 }
4108
4109
4110 Buffer::ReadStatus Buffer::loadEmergency()
4111 {
4112         FileName const emergencyFile = getEmergencyFileName();
4113         if (!emergencyFile.exists()
4114                   || emergencyFile.lastModified() <= d->filename.lastModified())
4115                 return ReadFileNotFound;
4116
4117         docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4118         docstring const text = bformat(_("An emergency save of the document "
4119                 "%1$s exists.\n\nRecover emergency save?"), file);
4120
4121         int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4122                 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4123
4124         switch (load_emerg)
4125         {
4126         case 0: {
4127                 docstring str;
4128                 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4129                 bool const success = (ret_llf == ReadSuccess);
4130                 if (success) {
4131                         if (isReadonly()) {
4132                                 Alert::warning(_("File is read-only"),
4133                                         bformat(_("An emergency file is successfully loaded, "
4134                                         "but the original file %1$s is marked read-only. "
4135                                         "Please make sure to save the document as a different "
4136                                         "file."), from_utf8(d->filename.absFileName())));
4137                         }
4138                         markDirty();
4139                         lyxvc().file_found_hook(d->filename);
4140                         str = _("Document was successfully recovered.");
4141                 } else
4142                         str = _("Document was NOT successfully recovered.");
4143                 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4144                         makeDisplayPath(emergencyFile.absFileName()));
4145
4146                 int const del_emerg =
4147                         Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4148                                 _("&Remove"), _("&Keep"));
4149                 if (del_emerg == 0) {
4150                         emergencyFile.removeFile();
4151                         if (success)
4152                                 Alert::warning(_("Emergency file deleted"),
4153                                         _("Do not forget to save your file now!"), true);
4154                         }
4155                 return success ? ReadSuccess : ReadEmergencyFailure;
4156         }
4157         case 1: {
4158                 int const del_emerg =
4159                         Alert::prompt(_("Delete emergency file?"),
4160                                 _("Remove emergency file now?"), 1, 1,
4161                                 _("&Remove"), _("&Keep"));
4162                 if (del_emerg == 0)
4163                         emergencyFile.removeFile();
4164                 return ReadOriginal;
4165         }
4166
4167         default:
4168                 break;
4169         }
4170         return ReadCancel;
4171 }
4172
4173
4174 Buffer::ReadStatus Buffer::loadAutosave()
4175 {
4176         // Now check if autosave file is newer.
4177         FileName const autosaveFile = getAutosaveFileName();
4178         if (!autosaveFile.exists()
4179                   || autosaveFile.lastModified() <= d->filename.lastModified())
4180                 return ReadFileNotFound;
4181
4182         docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4183         docstring const text = bformat(_("The backup of the document %1$s "
4184                 "is newer.\n\nLoad the backup instead?"), file);
4185         int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4186                 _("&Load backup"), _("Load &original"), _("&Cancel"));
4187
4188         switch (ret)
4189         {
4190         case 0: {
4191                 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4192                 // the file is not saved if we load the autosave file.
4193                 if (ret_llf == ReadSuccess) {
4194                         if (isReadonly()) {
4195                                 Alert::warning(_("File is read-only"),
4196                                         bformat(_("A backup file is successfully loaded, "
4197                                         "but the original file %1$s is marked read-only. "
4198                                         "Please make sure to save the document as a "
4199                                         "different file."),
4200                                         from_utf8(d->filename.absFileName())));
4201                         }
4202                         markDirty();
4203                         lyxvc().file_found_hook(d->filename);
4204                         return ReadSuccess;
4205                 }
4206                 return ReadAutosaveFailure;
4207         }
4208         case 1:
4209                 // Here we delete the autosave
4210                 autosaveFile.removeFile();
4211                 return ReadOriginal;
4212         default:
4213                 break;
4214         }
4215         return ReadCancel;
4216 }
4217
4218
4219 Buffer::ReadStatus Buffer::loadLyXFile()
4220 {
4221         if (!d->filename.isReadableFile()) {
4222                 ReadStatus const ret_rvc = extractFromVC();
4223                 if (ret_rvc != ReadSuccess)
4224                         return ret_rvc;
4225         }
4226
4227         ReadStatus const ret_re = loadEmergency();
4228         if (ret_re == ReadSuccess || ret_re == ReadCancel)
4229                 return ret_re;
4230
4231         ReadStatus const ret_ra = loadAutosave();
4232         if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4233                 return ret_ra;
4234
4235         return loadThisLyXFile(d->filename);
4236 }
4237
4238
4239 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4240 {
4241         return readFile(fn);
4242 }
4243
4244
4245 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4246 {
4247         TeXErrors::Errors::const_iterator it = terr.begin();
4248         TeXErrors::Errors::const_iterator end = terr.end();
4249         ListOfBuffers clist = getDescendents();
4250         ListOfBuffers::const_iterator cen = clist.end();
4251
4252         for (; it != end; ++it) {
4253                 int id_start = -1;
4254                 int pos_start = -1;
4255                 int errorRow = it->error_in_line;
4256                 Buffer const * buf = 0;
4257                 Impl const * p = d;
4258                 if (it->child_name.empty())
4259                     p->texrow.getIdFromRow(errorRow, id_start, pos_start);
4260                 else {
4261                         // The error occurred in a child
4262                         ListOfBuffers::const_iterator cit = clist.begin();
4263                         for (; cit != cen; ++cit) {
4264                                 string const child_name =
4265                                         DocFileName(changeExtension(
4266                                                 (*cit)->absFileName(), "tex")).
4267                                                         mangledFileName();
4268                                 if (it->child_name != child_name)
4269                                         continue;
4270                                 (*cit)->d->texrow.getIdFromRow(errorRow,
4271                                                         id_start, pos_start);
4272                                 if (id_start != -1) {
4273                                         buf = d->cloned_buffer_
4274                                                 ? (*cit)->d->cloned_buffer_->d->owner_
4275                                                 : (*cit)->d->owner_;
4276                                         p = (*cit)->d;
4277                                         break;
4278                                 }
4279                         }
4280                 }
4281                 int id_end = -1;
4282                 int pos_end = -1;
4283                 bool found;
4284                 do {
4285                         ++errorRow;
4286                         found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
4287                 } while (found && id_start == id_end && pos_start == pos_end);
4288
4289                 if (id_start != id_end) {
4290                         // Next registered position is outside the inset where
4291                         // the error occurred, so signal end-of-paragraph
4292                         pos_end = 0;
4293                 }
4294
4295                 errorList.push_back(ErrorItem(it->error_desc,
4296                         it->error_text, id_start, pos_start, pos_end, buf));
4297         }
4298 }
4299
4300
4301 void Buffer::setBuffersForInsets() const
4302 {
4303         inset().setBuffer(const_cast<Buffer &>(*this));
4304 }
4305
4306
4307 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4308 {
4309         LBUFERR(!text().paragraphs().empty());
4310
4311         // Use the master text class also for child documents
4312         Buffer const * const master = masterBuffer();
4313         DocumentClass const & textclass = master->params().documentClass();
4314
4315         // do this only if we are the top-level Buffer
4316         if (master == this)
4317                 reloadBibInfoCache();
4318
4319         // keep the buffers to be children in this set. If the call from the
4320         // master comes back we can see which of them were actually seen (i.e.
4321         // via an InsetInclude). The remaining ones in the set need still be updated.
4322         static std::set<Buffer const *> bufToUpdate;
4323         if (scope == UpdateMaster) {
4324                 // If this is a child document start with the master
4325                 if (master != this) {
4326                         bufToUpdate.insert(this);
4327                         master->updateBuffer(UpdateMaster, utype);
4328                         // Do this here in case the master has no gui associated with it. Then,
4329                         // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
4330                         if (!master->d->gui_)
4331                                 structureChanged();
4332
4333                         // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4334                         if (bufToUpdate.find(this) == bufToUpdate.end())
4335                                 return;
4336                 }
4337
4338                 // start over the counters in the master
4339                 textclass.counters().reset();
4340         }
4341
4342         // update will be done below for this buffer
4343         bufToUpdate.erase(this);
4344
4345         // update all caches
4346         clearReferenceCache();
4347         updateMacros();
4348
4349         Buffer & cbuf = const_cast<Buffer &>(*this);
4350
4351         // do the real work
4352         ParIterator parit = cbuf.par_iterator_begin();
4353         updateBuffer(parit, utype);
4354
4355         if (master != this)
4356                 // TocBackend update will be done later.
4357                 return;
4358
4359         d->bibinfo_cache_valid_ = true;
4360         d->cite_labels_valid_ = true;
4361         cbuf.tocBackend().update(utype == OutputUpdate);
4362         if (scope == UpdateMaster)
4363                 cbuf.structureChanged();
4364 }
4365
4366
4367 static depth_type getDepth(DocIterator const & it)
4368 {
4369         depth_type depth = 0;
4370         for (size_t i = 0 ; i < it.depth() ; ++i)
4371                 if (!it[i].inset().inMathed())
4372                         depth += it[i].paragraph().getDepth() + 1;
4373         // remove 1 since the outer inset does not count
4374         return depth - 1;
4375 }
4376
4377 static depth_type getItemDepth(ParIterator const & it)
4378 {
4379         Paragraph const & par = *it;
4380         LabelType const labeltype = par.layout().labeltype;
4381
4382         if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4383                 return 0;
4384
4385         // this will hold the lowest depth encountered up to now.
4386         depth_type min_depth = getDepth(it);
4387         ParIterator prev_it = it;
4388         while (true) {
4389                 if (prev_it.pit())
4390                         --prev_it.top().pit();
4391                 else {
4392                         // start of nested inset: go to outer par
4393                         prev_it.pop_back();
4394                         if (prev_it.empty()) {
4395                                 // start of document: nothing to do
4396                                 return 0;
4397                         }
4398                 }
4399
4400                 // We search for the first paragraph with same label
4401                 // that is not more deeply nested.
4402                 Paragraph & prev_par = *prev_it;
4403                 depth_type const prev_depth = getDepth(prev_it);
4404                 if (labeltype == prev_par.layout().labeltype) {
4405                         if (prev_depth < min_depth)
4406                                 return prev_par.itemdepth + 1;
4407                         if (prev_depth == min_depth)
4408                                 return prev_par.itemdepth;
4409                 }
4410                 min_depth = min(min_depth, prev_depth);
4411                 // small optimization: if we are at depth 0, we won't
4412                 // find anything else
4413                 if (prev_depth == 0)
4414                         return 0;
4415         }
4416 }
4417
4418
4419 static bool needEnumCounterReset(ParIterator const & it)
4420 {
4421         Paragraph const & par = *it;
4422         LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
4423         depth_type const cur_depth = par.getDepth();
4424         ParIterator prev_it = it;
4425         while (prev_it.pit()) {
4426                 --prev_it.top().pit();
4427                 Paragraph const & prev_par = *prev_it;
4428                 if (prev_par.getDepth() <= cur_depth)
4429                         return  prev_par.layout().labeltype != LABEL_ENUMERATE;
4430         }
4431         // start of nested inset: reset
4432         return true;
4433 }
4434
4435
4436 // set the label of a paragraph. This includes the counters.
4437 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4438 {
4439         BufferParams const & bp = owner_->masterBuffer()->params();
4440         DocumentClass const & textclass = bp.documentClass();
4441         Paragraph & par = it.paragraph();
4442         Layout const & layout = par.layout();
4443         Counters & counters = textclass.counters();
4444
4445         if (par.params().startOfAppendix()) {
4446                 // We want to reset the counter corresponding to toplevel sectioning
4447                 Layout const & lay = textclass.getTOCLayout();
4448                 docstring const cnt = lay.counter;
4449                 if (!cnt.empty())
4450                         counters.reset(cnt);
4451                 counters.appendix(true);
4452         }
4453         par.params().appendix(counters.appendix());
4454
4455         // Compute the item depth of the paragraph
4456         par.itemdepth = getItemDepth(it);
4457
4458         if (layout.margintype == MARGIN_MANUAL) {
4459                 if (par.params().labelWidthString().empty())
4460                         par.params().labelWidthString(par.expandLabel(layout, bp));
4461         } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4462                 // we do not need to do anything here, since the empty case is
4463                 // handled during export.
4464         } else {
4465                 par.params().labelWidthString(docstring());
4466         }
4467
4468         switch(layout.labeltype) {
4469         case LABEL_ITEMIZE: {
4470                 // At some point of time we should do something more
4471                 // clever here, like:
4472                 //   par.params().labelString(
4473                 //    bp.user_defined_bullet(par.itemdepth).getText());
4474                 // for now, use a simple hardcoded label
4475                 docstring itemlabel;
4476                 switch (par.itemdepth) {
4477                 case 0:
4478                         itemlabel = char_type(0x2022);
4479                         break;
4480                 case 1:
4481                         itemlabel = char_type(0x2013);
4482                         break;
4483                 case 2:
4484                         itemlabel = char_type(0x2217);
4485                         break;
4486                 case 3:
4487                         itemlabel = char_type(0x2219); // or 0x00b7
4488                         break;
4489                 }
4490                 par.params().labelString(itemlabel);
4491                 break;
4492         }
4493
4494         case LABEL_ENUMERATE: {
4495                 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4496
4497                 switch (par.itemdepth) {
4498                 case 2:
4499                         enumcounter += 'i';
4500                 case 1:
4501                         enumcounter += 'i';
4502                 case 0:
4503                         enumcounter += 'i';
4504                         break;
4505                 case 3:
4506                         enumcounter += "iv";
4507                         break;
4508                 default:
4509                         // not a valid enumdepth...
4510                         break;
4511                 }
4512
4513                 // Maybe we have to reset the enumeration counter.
4514                 if (needEnumCounterReset(it))
4515                         counters.reset(enumcounter);
4516                 counters.step(enumcounter, utype);
4517
4518                 string const & lang = par.getParLanguage(bp)->code();
4519                 par.params().labelString(counters.theCounter(enumcounter, lang));
4520
4521                 break;
4522         }
4523
4524         case LABEL_SENSITIVE: {
4525                 string const & type = counters.current_float();
4526                 docstring full_label;
4527                 if (type.empty())
4528                         full_label = owner_->B_("Senseless!!! ");
4529                 else {
4530                         docstring name = owner_->B_(textclass.floats().getType(type).name());
4531                         if (counters.hasCounter(from_utf8(type))) {
4532                                 string const & lang = par.getParLanguage(bp)->code();
4533                                 counters.step(from_utf8(type), utype);
4534                                 full_label = bformat(from_ascii("%1$s %2$s:"),
4535                                                      name,
4536                                                      counters.theCounter(from_utf8(type), lang));
4537                         } else
4538                                 full_label = bformat(from_ascii("%1$s #:"), name);
4539                 }
4540                 par.params().labelString(full_label);
4541                 break;
4542         }
4543
4544         case LABEL_NO_LABEL:
4545                 par.params().labelString(docstring());
4546                 break;
4547
4548         case LABEL_ABOVE:
4549         case LABEL_CENTERED:
4550         case LABEL_STATIC: {
4551                 docstring const & lcounter = layout.counter;
4552                 if (!lcounter.empty()) {
4553                         if (layout.toclevel <= bp.secnumdepth
4554                                                 && (layout.latextype != LATEX_ENVIRONMENT
4555                                         || it.text()->isFirstInSequence(it.pit()))) {
4556                                 if (counters.hasCounter(lcounter))
4557                                         counters.step(lcounter, utype);
4558                                 par.params().labelString(par.expandLabel(layout, bp));
4559                         } else
4560                                 par.params().labelString(docstring());
4561                 } else
4562                         par.params().labelString(par.expandLabel(layout, bp));
4563                 break;
4564         }
4565
4566         case LABEL_MANUAL:
4567         case LABEL_BIBLIO:
4568                 par.params().labelString(par.expandLabel(layout, bp));
4569         }
4570 }
4571
4572
4573 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4574 {
4575         // LASSERT: Is it safe to continue here, or should we just return?
4576         LASSERT(parit.pit() == 0, /**/);
4577
4578         // Set the position of the text in the buffer to be able
4579         // to resolve macros in it.
4580         parit.text()->setMacrocontextPosition(parit);
4581
4582         depth_type maxdepth = 0;
4583         pit_type const lastpit = parit.lastpit();
4584         for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4585                 // reduce depth if necessary
4586                 if (parit->params().depth() > maxdepth) {
4587                         /** FIXME: this function is const, but
4588                          * nevertheless it modifies the buffer. To be
4589                          * cleaner, one should modify the buffer in
4590                          * another function, which is actually
4591                          * non-const. This would however be costly in
4592                          * terms of code duplication.
4593                          */
4594                         const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
4595                         parit->params().depth(maxdepth);
4596                 }
4597                 maxdepth = parit->getMaxDepthAfter();
4598
4599                 if (utype == OutputUpdate) {
4600                         // track the active counters
4601                         // we have to do this for the master buffer, since the local
4602                         // buffer isn't tracking anything.
4603                         masterBuffer()->params().documentClass().counters().
4604                                         setActiveLayout(parit->layout());
4605                 }
4606
4607                 // set the counter for this paragraph
4608                 d->setLabel(parit, utype);
4609
4610                 // now the insets
4611                 InsetList::const_iterator iit = parit->insetList().begin();
4612                 InsetList::const_iterator end = parit->insetList().end();
4613                 for (; iit != end; ++iit) {
4614                         parit.pos() = iit->pos;
4615                         iit->inset->updateBuffer(parit, utype);
4616                 }
4617         }
4618 }
4619
4620
4621 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4622         WordLangTuple & word_lang, docstring_list & suggestions) const
4623 {
4624         int progress = 0;
4625         WordLangTuple wl;
4626         suggestions.clear();
4627         word_lang = WordLangTuple();
4628         bool const to_end = to.empty();
4629         DocIterator const end = to_end ? doc_iterator_end(this) : to;
4630         // OK, we start from here.
4631         for (; from != end; from.forwardPos()) {
4632                 // We are only interested in text so remove the math CursorSlice.
4633                 while (from.inMathed()) {
4634                         from.pop_back();
4635                         from.pos()++;
4636                 }
4637                 // If from is at the end of the document (which is possible
4638                 // when leaving the mathed) LyX will crash later otherwise.
4639                 if (from.atEnd() || (!to_end && from >= end))
4640                         break;
4641                 to = from;
4642                 from.paragraph().spellCheck();
4643                 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4644                 if (SpellChecker::misspelled(res)) {
4645                         word_lang = wl;
4646                         break;
4647                 }
4648
4649                 // Do not increase progress when from == to, otherwise the word
4650                 // count will be wrong.
4651                 if (from != to) {
4652                         from = to;
4653                         ++progress;
4654                 }
4655         }
4656         return progress;
4657 }
4658
4659
4660 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
4661 {
4662         bool inword = false;
4663         word_count_ = 0;
4664         char_count_ = 0;
4665         blank_count_ = 0;
4666
4667         for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
4668                 if (!dit.inTexted()) {
4669                         dit.forwardPos();
4670                         continue;
4671                 }
4672
4673                 Paragraph const & par = dit.paragraph();
4674                 pos_type const pos = dit.pos();
4675
4676                 // Copied and adapted from isWordSeparator() in Paragraph
4677                 if (pos == dit.lastpos()) {
4678                         inword = false;
4679                 } else {
4680                         Inset const * ins = par.getInset(pos);
4681                         if (ins && skipNoOutput && !ins->producesOutput()) {
4682                                 // skip this inset
4683                                 ++dit.top().pos();
4684                                 // stop if end of range was skipped
4685                                 if (!to.atEnd() && dit >= to)
4686                                         break;
4687                                 continue;
4688                         } else if (!par.isDeleted(pos)) {
4689                                 if (par.isWordSeparator(pos))
4690                                         inword = false;
4691                                 else if (!inword) {
4692                                         ++word_count_;
4693                                         inword = true;
4694                                 }
4695                                 if (ins && ins->isLetter())
4696                                         ++char_count_;
4697                                 else if (ins && ins->isSpace())
4698                                         ++blank_count_;
4699                                 else {
4700                                         char_type const c = par.getChar(pos);
4701                                         if (isPrintableNonspace(c))
4702                                                 ++char_count_;
4703                                         else if (isSpace(c))
4704                                                 ++blank_count_;
4705                                 }
4706                         }
4707                 }
4708                 dit.forwardPos();
4709         }
4710 }
4711
4712
4713 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
4714 {
4715         d->updateStatistics(from, to, skipNoOutput);
4716 }
4717
4718
4719 int Buffer::wordCount() const
4720 {
4721         return d->wordCount();
4722 }
4723
4724
4725 int Buffer::charCount(bool with_blanks) const
4726 {
4727         return d->charCount(with_blanks);
4728 }
4729
4730
4731 Buffer::ReadStatus Buffer::reload(bool clearUndo)
4732 {
4733         setBusy(true);
4734         // c.f. bug http://www.lyx.org/trac/ticket/6587
4735         removeAutosaveFile();
4736         // e.g., read-only status could have changed due to version control
4737         d->filename.refresh();
4738         docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4739
4740         // clear parent. this will get reset if need be.
4741         d->setParent(0);
4742         ReadStatus const status = loadLyXFile();
4743         if (status == ReadSuccess) {
4744                 updateBuffer();
4745                 changed(true);
4746                 updateTitles();
4747                 markClean();
4748                 message(bformat(_("Document %1$s reloaded."), disp_fn));
4749                 if (clearUndo)
4750                         d->undo_.clear();
4751         } else {
4752                 message(bformat(_("Could not reload document %1$s."), disp_fn));
4753         }
4754         setBusy(false);
4755         removePreviews();
4756         updatePreviews();
4757         errors("Parse");
4758         return status;
4759 }
4760
4761
4762 bool Buffer::saveAs(FileName const & fn)
4763 {
4764         FileName const old_name = fileName();
4765         FileName const old_auto = getAutosaveFileName();
4766         bool const old_unnamed = isUnnamed();
4767
4768         setFileName(fn);
4769         markDirty();
4770         setUnnamed(false);
4771
4772         if (save()) {
4773                 // bring the autosave file with us, just in case.
4774                 moveAutosaveFile(old_auto);
4775                 // validate version control data and
4776                 // correct buffer title
4777                 lyxvc().file_found_hook(fileName());
4778                 updateTitles();
4779                 // the file has now been saved to the new location.
4780                 // we need to check that the locations of child buffers
4781                 // are still valid.
4782                 checkChildBuffers();
4783                 checkMasterBuffer();
4784                 return true;
4785         } else {
4786                 // save failed
4787                 // reset the old filename and unnamed state
4788                 setFileName(old_name);
4789                 setUnnamed(old_unnamed);
4790                 return false;
4791         }
4792 }
4793
4794
4795 // FIXME We could do better here, but it is complicated. What would be
4796 // nice is to offer either (a) to save the child buffer to an appropriate
4797 // location, so that it would "move with the master", or else (b) to update
4798 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4799 // complicated, because the code for this lives in GuiView.
4800 void Buffer::checkChildBuffers()
4801 {
4802         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4803         Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4804         for (; it != en; ++it) {
4805                 DocIterator dit = it->second;
4806                 Buffer * cbuf = const_cast<Buffer *>(it->first);
4807                 if (!cbuf || !theBufferList().isLoaded(cbuf))
4808                         continue;
4809                 Inset * inset = dit.nextInset();
4810                 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4811                 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4812                 docstring const & incfile = inset_inc->getParam("filename");
4813                 string oldloc = cbuf->absFileName();
4814                 string newloc = makeAbsPath(to_utf8(incfile),
4815                                 onlyPath(absFileName())).absFileName();
4816                 if (oldloc == newloc)
4817                         continue;
4818                 // the location of the child file is incorrect.
4819                 Alert::warning(_("Included File Invalid"),
4820                                 bformat(_("Saving this document to a new location has made the file:\n"
4821                                 "  %1$s\n"
4822                                 "inaccessible. You will need to update the included filename."),
4823                                 from_utf8(oldloc)));
4824                 cbuf->setParent(0);
4825                 inset_inc->setChildBuffer(0);
4826         }
4827         // invalidate cache of children
4828         d->children_positions.clear();
4829         d->position_to_children.clear();
4830 }
4831
4832
4833 // If a child has been saved under a different name/path, it might have been
4834 // orphaned. Therefore the master needs to be reset (bug 8161).
4835 void Buffer::checkMasterBuffer()
4836 {
4837         Buffer const * const master = masterBuffer();
4838         if (master == this)
4839                 return;
4840
4841         // necessary to re-register the child (bug 5873)
4842         // FIXME: clean up updateMacros (here, only
4843         // child registering is needed).
4844         master->updateMacros();
4845         // (re)set master as master buffer, but only
4846         // if we are a real child
4847         if (master->isChild(this))
4848                 setParent(master);
4849         else
4850                 setParent(0);
4851 }
4852
4853 } // namespace lyx